From 288b7a34a38e9ddb9e922faa48c3efddbde0a944 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 8 Mar 2014 00:35:57 +0000 Subject: glossaries (7mar14) git-svn-id: svn://tug.org/texlive/trunk@33119 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/glossaries/CHANGES | 36 + Master/texmf-dist/doc/latex/glossaries/README | 4 +- .../doc/latex/glossaries/glossaries-code.pdf | Bin 900568 -> 933361 bytes .../doc/latex/glossaries/glossaries-user.html | 17684 ++++++++++--------- .../doc/latex/glossaries/glossaries-user.pdf | Bin 610821 -> 649668 bytes .../doc/latex/glossaries/glossaries-user.tex | 1176 +- .../doc/latex/glossaries/glossariesbegin.html | 2221 ++- .../doc/latex/glossaries/glossariesbegin.pdf | Bin 93190 -> 137324 bytes .../doc/latex/glossaries/glossariesbegin.tex | 1192 +- .../doc/latex/glossaries/glossary2glossaries.html | 2316 +-- .../doc/latex/glossaries/glossary2glossaries.pdf | Bin 140904 -> 140901 bytes .../doc/latex/glossaries/glossary2glossaries.tex | 6 +- .../doc/latex/glossaries/mfirstuc-manual.html | 359 +- .../doc/latex/glossaries/mfirstuc-manual.pdf | Bin 145369 -> 145369 bytes .../doc/latex/glossaries/mfirstuc-manual.tex | 3 + .../doc/latex/glossaries/samples/minimalgls.pdf | Bin 49406 -> 49406 bytes .../doc/latex/glossaries/samples/sample-FnDesc.pdf | Bin 58845 -> 58845 bytes .../latex/glossaries/samples/sample-crossref.pdf | Bin 53480 -> 53480 bytes .../glossaries/samples/sample-custom-acronym.pdf | Bin 82221 -> 82221 bytes .../doc/latex/glossaries/samples/sample-dual.pdf | Bin 36474 -> 36474 bytes .../latex/glossaries/samples/sample-entryfmt.pdf | Bin 34915 -> 34915 bytes .../doc/latex/glossaries/samples/sample-index.pdf | Bin 43398 -> 43398 bytes .../doc/latex/glossaries/samples/sample-inline.pdf | Bin 147250 -> 147088 bytes .../latex/glossaries/samples/sample-langdict.pdf | Bin 38853 -> 38853 bytes .../latex/glossaries/samples/sample-mfirstuc.pdf | Bin 23740 -> 23740 bytes .../latex/glossaries/samples/sample-newkeys.pdf | Bin 35496 -> 35496 bytes .../glossaries/samples/sample-noidxapp-utf8.pdf | Bin 0 -> 96008 bytes .../glossaries/samples/sample-noidxapp-utf8.tex | 146 + .../latex/glossaries/samples/sample-noidxapp.pdf | Bin 0 -> 67101 bytes .../latex/glossaries/samples/sample-noidxapp.tex | 143 + .../glossaries/samples/sample-nomathhyper.pdf | Bin 40532 -> 40532 bytes .../latex/glossaries/samples/sample-numberlist.pdf | Bin 41998 -> 41998 bytes .../doc/latex/glossaries/samples/sample-prefix.pdf | Bin 43275 -> 43275 bytes .../doc/latex/glossaries/samples/sample-si.pdf | Bin 21716 -> 21716 bytes .../doc/latex/glossaries/samples/sample.pdf | Bin 102883 -> 102721 bytes .../doc/latex/glossaries/samples/sample.tex | 14 +- .../doc/latex/glossaries/samples/sample4col.pdf | Bin 43335 -> 43335 bytes .../doc/latex/glossaries/samples/sampleAcr.pdf | Bin 65684 -> 65684 bytes .../doc/latex/glossaries/samples/sampleAcrDesc.pdf | Bin 65541 -> 65541 bytes .../latex/glossaries/samples/sampleCustomAcr.pdf | Bin 93546 -> 93546 bytes .../doc/latex/glossaries/samples/sampleDB.pdf | Bin 47058 -> 47058 bytes .../doc/latex/glossaries/samples/sampleDesc.pdf | Bin 48456 -> 48456 bytes .../doc/latex/glossaries/samples/sampleEq.pdf | Bin 155816 -> 155677 bytes .../doc/latex/glossaries/samples/sampleEq.tex | 4 +- .../doc/latex/glossaries/samples/sampleEqPg.pdf | Bin 169306 -> 169141 bytes .../latex/glossaries/samples/sampleFnAcrDesc.pdf | Bin 91282 -> 91282 bytes .../doc/latex/glossaries/samples/sampleNtn.pdf | Bin 98845 -> 98691 bytes .../doc/latex/glossaries/samples/samplePeople.pdf | Bin 47464 -> 47464 bytes .../doc/latex/glossaries/samples/sampleSec.pdf | Bin 65965 -> 65965 bytes .../doc/latex/glossaries/samples/sampleSort.pdf | Bin 95236 -> 95075 bytes .../doc/latex/glossaries/samples/sampleaccsupp.pdf | Bin 41173 -> 41173 bytes .../latex/glossaries/samples/sampleacronyms.pdf | Bin 64417 -> 64417 bytes .../doc/latex/glossaries/samples/sampletree.pdf | Bin 66946 -> 66946 bytes .../doc/latex/glossaries/samples/sampleutf8.pdf | Bin 44942 -> 44942 bytes .../doc/latex/glossaries/samples/sampleutf8.tex | 1 + .../doc/latex/glossaries/samples/samplexdy.pdf | Bin 178756 -> 178604 bytes .../doc/latex/glossaries/samples/samplexdy2.pdf | Bin 67872 -> 67872 bytes 57 files changed, 15160 insertions(+), 10145 deletions(-) create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.tex create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.tex (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 bd8dc9e5316..e106ef91880 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,41 @@ glossaries change log: +v4.04: + + * glossaries.sty: + + - new commands: \makenoidxglossaries, \printnoidxglossary + and \printnoidxglossaries that use TeX to sort entries + instead of makeindex/xindy + + - new command: \glsnumberlistloop (for use with + \makenoidxglossaries) + + - new package option: noredefwarn + + - moved definition of \glswrite to \makeglossaries so that write + register is only allocated if required. + + - fixed bug in \defglsdisplayfirst + + * glossary-tree.sty: + + - fixed bug in alttree style + + + * glossaries-accsupp.sty: + + - \compatibleglossentry and \compatiblesubglossentry: + changed \newcommand to \def as they may or may not be + defined depending on whether user has loaded glossaries + separately from glossaries-accsupp + + * makeglossaries: + + - added -Q and -k switches + + - added extra diagnostics + v4.03: glossaries.sty: diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index fa376f5bcd1..a6ad875b23b 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.03 +LaTeX Package : glossaries v4.04 -Last Modified : 2014-01-20 +Last Modified : 2014-03-06 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 306bb9a781d..61436fcee14 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 61e8b320194..72369e5e0a6 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html @@ -1,17 +1,16 @@ - + -User Manual for glossaries.sty v4.03 +User Manual for glossaries.sty v4.04 - + -
+
-

User Manual for glossaries.sty v4.03

+

User Manual for glossaries.sty v4.04

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

2014-01-20
+class="cmr-12">2014-03-06
-

+

-

-

+

Abstract

-

The

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

+

-

Documents have various styles when it comes to presenting glossaries or lists of +

Documents have various styles when it comes to presenting glossaries or lists of terms or notation. People have their own preferences and to a large extent this is determined by the kind of information that needs to go in the glossary. They may just have symbols with terse descriptions or they may have long technical words @@ -271,15 +273,15 @@ 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

😱 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

+

The glossaries bundle comes with the following documentation:

glossaries-_code.pdf
Advanced users wishing to know more about the inner workings of all the packages provided in the glossaries bundle should read - “Documented Code for glossaries v4.03”. This includes the documented + “Documented Code for glossaries v4.04”. This includes the documented code for the mfirstuc package. @@ -339,7 +341,7 @@ class="description">Package summary.
-

If you use

If you use hyperref and glossaries, you must load .glg2doc’s changes glossary.) -

If you are using

If you are using hyperref, it’s best to use pdflatexglossaries.

-

-

Other documents that describe using the

+

Other documents that describe using the glossaries package include: Using LaTeX to Write a PhD Thesis and .

Contents

Glossary +href="#glossary">Glossary
1 Introduction
 1.1 Sample Documents +href="#sec:samples" id="QQ2-1-7">Sample Documents
 1.2 Multi-Lingual Support +href="#sec:languages" id="QQ2-1-8">Multi-Lingual Support
  1.2.1 Changing the Fixed Names +href="#sec:fixednames" id="QQ2-1-9">Changing the Fixed Names
 1.3 Generating the Associated Glossary Files +href="#sec:makeglossaries" id="QQ2-1-12">Generating the Associated Glossary Files
  1.3.1 Using the makeglossaries Perl Script +href="#sec:makeglossariesapp" id="QQ2-1-14">Using the makeglossaries Perl Script
  1.3.2 Using xindy explicitly +href="#sec:xindyapp" id="QQ2-1-15">Using xindy explicitly (Option 3)
  1.3.3 Using makeindex explicitly +href="#sec:makeindexapp" id="QQ2-1-16">Using makeindex explicitly (Option 2)
  1.3.4 Note to Front-End and Script Developers +href="#sec:notedev" id="QQ2-1-17">Note to Front-End and Script Developers
2 Package Options +href="#sec:pkgopts" id="QQ2-1-18">Package Options
 2.1 General Options +href="#generaloptions" id="QQ2-1-19">General Options
 2.2 Sectioning, Headings and TOC Options +href="#sectioningheadingsandtocoptions" id="QQ2-1-20">Sectioning, Headings and TOC Options
 2.3 Glossary Appearance Options +href="#glossaryappearanceoptions" id="QQ2-1-21">Glossary Appearance Options
 2.4 Sorting Options +href="#sortingoptions" id="QQ2-1-22">Sorting Options
 2.5 Acronym Options +href="#acronymoptions" id="QQ2-1-23">Acronym Options
  2.5.1 Deprecated Acronym Style Options +href="#deprecatedacronymstyleoptions" id="QQ2-1-24">Deprecated Acronym Style Options
 2.6 Other Options +href="#otheroptions" id="QQ2-1-25">Other Options
 2.7 Setting Options After the Package is Loaded +href="#sec:setupglossaries" id="QQ2-1-26">Setting Options After the Package is Loaded
3 Setting Up +href="#sec:setup" id="QQ2-1-27">Setting Up +
 3.1 Option 1 +
 3.2 Options 2 and 3
4 Defining Glossary Entries +href="#sec:newglosentry" id="QQ2-1-30">Defining Glossary Entries
 4.1 Plurals +href="#sec:plurals" id="QQ2-1-31">Plurals
 4.2 Other Grammatical Constructs +href="#sec:grammar" id="QQ2-1-32">Other Grammatical Constructs
 4.3 Additional Keys +href="#sec:addkey" id="QQ2-1-33">Additional Keys
 4.4 Expansion +href="#sec:expansion" id="QQ2-1-34">Expansion
 4.5 Sub-Entries +href="#sec:subentries" id="QQ2-1-36">Sub-Entries
  4.5.1 Hierarchical Categories +href="#sec:hierarchical" id="QQ2-1-37">Hierarchical Categories
  4.5.2 Homographs +href="#sec:homographs" id="QQ2-1-38">Homographs
 4.6 Loading Entries From a File +href="#sec:loadglsentries" id="QQ2-1-39">Loading Entries From a File
 4.7 Moving Entries to Another Glossary +href="#sec:moveentry" id="QQ2-1-40">Moving Entries to Another Glossary
 4.8 Drawbacks With Defining Entries in the Document Environment +href="#sec:docdefs" id="QQ2-1-41">Drawbacks With Defining Entries in the Document Environment
  4.8.1 Technical Issues +href="#sec:techissues" id="QQ2-1-42">Technical Issues
  4.8.2 Good Practice Issues +href="#sec:goodpractice" id="QQ2-1-43">Good Practice Issues
5 Number lists -
6 Links to Glossary Entries -
 6.1 Changing the format of the link text +href="#sec:numberlists" id="QQ2-1-44">Number lists +
6 Links to Glossary Entries +
 6.1 Changing the format of the link text
 6.2 Enabling and disabling hyperlinks to glossary entries +href="#sec:disablehyperlinks" id="QQ2-1-48">Enabling and disabling hyperlinks to glossary entries
7 Adding an Entry to the Glossary Without Generating Text +href="#sec:glsadd" id="QQ2-1-49">Adding an Entry to the Glossary Without Generating Text
8 Cross-Referencing Entries +href="#sec:crossref" id="QQ2-1-50">Cross-Referencing Entries
 8.1 Customising Cross-reference Text +href="#sec:customxr" id="QQ2-1-51">Customising Cross-reference Text
9 Using Glossary Terms Without Links +href="#sec:glsnolink" id="QQ2-1-52">Using Glossary Terms Without Links
10 Displaying a glossary +href="#sec:printglossary" id="QQ2-1-53">Displaying a glossary
11 Xindy +href="#sec:xindy" id="QQ2-1-54">Xindy (Option 3)
 11.1 Language and Encodings +href="#sec:langenc" id="QQ2-1-55">Language and Encodings
 11.2 Locations and Number lists +href="#sec:xindyloc" id="QQ2-1-56">Locations and Number lists
 11.3 Glossary Groups +href="#sec:groups" id="QQ2-1-57">Glossary Groups
12 Defining New Glossaries +href="#sec:newglossary" id="QQ2-1-58">Defining New Glossaries
13 Acronyms +href="#sec:acronyms" id="QQ2-1-59">Acronyms
 13.1 Changing the Acronym Style +href="#sec:setacronymstyle" id="QQ2-1-61">Changing the Acronym Style
  13.1.1 Predefined Acronym Styles +href="#sec:predefinedacrstyles" id="QQ2-1-62">Predefined Acronym Styles
  13.1.2 Defining A Custom Acronym Style +href="#sec:customacronym" id="QQ2-1-63">Defining A Custom Acronym Style
 13.2 Displaying the List of Acronyms +href="#sec:disploa" id="QQ2-1-64">Displaying the List of Acronyms
 13.3 Upgrading From the glossary Package +href="#sec:oldacronym" id="QQ2-1-65">Upgrading From the glossary Package
14 Unsetting and Resetting Entry Flags +href="#sec:glsunset" id="QQ2-1-67">Unsetting and Resetting Entry Flags
15 Glossary Styles +href="#sec:styles" id="QQ2-1-68">Glossary Styles
 15.1 Predefined Styles +href="#sec:predefinedstyles" id="QQ2-1-69">Predefined Styles
  15.1.1 List Styles +href="#sec:liststyles" id="QQ2-1-71">List Styles
  15.1.2 Longtable Styles +href="#sec:longstyles" id="QQ2-1-72">Longtable Styles
  15.1.3 Longtable Styles (Ragged Right) +href="#sec:longraggedstyles" id="QQ2-1-73">Longtable Styles (Ragged Right)
  15.1.4 Supertabular Styles +href="#sec:superstyles" id="QQ2-1-74">Supertabular Styles
  15.1.5 Supertabular Styles (Ragged Right) +href="#sec:superraggedstyles" id="QQ2-1-75">Supertabular Styles (Ragged Right)
  15.1.6 Tree-Like Styles +href="#sec:treestyles" id="QQ2-1-76">Tree-Like Styles
  15.1.7 Multicols Style +href="#sec:mcolstyles" id="QQ2-1-77">Multicols Style
  15.1.8 In-Line Style +href="#sec:inline" id="QQ2-1-79">In-Line Style
 15.2 Defining your own glossary style +href="#sec:newglossarystyle" id="QQ2-1-80">Defining your own glossary style
16 Utilities +href="#sec:utilities" id="QQ2-1-81">Utilities
17 Prefixes or Determiners +href="#sec:prefix" id="QQ2-1-82">Prefixes or Determiners
18 Accessibility Support +href="#sec:accsupp" id="QQ2-1-83">Accessibility Support
19 Troubleshooting +href="#sec:trouble" id="QQ2-1-84">Troubleshooting
Index +href="#index">Index
@@ -540,22 +546,22 @@ href="#sec:index">Index

List of Tables

1.1 Supported Languages
1.2 Customised Text
1.3 Commands -and package options that have no effect when using xindy or makeindex -explicitly
4.1 Key to Field Mappings
6.1 Predefined Hyperlinked Location -Formats
13.1 Synonyms provided by the package option shortcuts
13.2 The -effect of using xspace
15.1 Glossary Styles
15.2 Multicolumn Styles
+ id="x1-2000">List of Tables
1.1 Glossary Options: Pros and Cons
1.2 Supported +Languages
1.3 Customised Text
1.4 Commands and package options that have no effect +when using xindy or makeindex explicitly
4.1 Key to Field Mappings
6.1 Predefined +Hyperlinked Location Formats
13.1 Synonyms provided by the package option +shortcuts
13.2 The effect of using xspace
15.1 Glossary Styles
15.2 Multicolumn Styles
@@ -563,7 +569,7 @@ href="#x1-650122">Multicolumn Styles

+ id="glossary">

@@ -586,20 +592,20 @@ style="vertical-align:baseline;" class="tabbing"> nonumberlist, -

seeautonumberlist,
-

toc,
+

toc,
+class="cmtt-10">nopostdot,

The location of the entry in the document. This defaults to th on which the entry appears. An entry may have multiple locations.
+Extended Latin Alphabet

An alphabet consisting of Latin characters and extended Latin characters. +
+
+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 non-Latin character.
+
First use

The first time a glossary entry is used (from the start of the document or after a reset) with one of the following commands: \gls, , \Gls, , \GLS, + id="dx1-3021">, \glspl, , \Glspl, , \GLSpl or or \glsdisp. (See . (See first use flag & first use text.)
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 §14 §14 Unsetting and Resetting Entry Flags.
First use text

The text that is displayed on first use, which is governed by the first and + id="dx1-3030"> and firstplural keys of keys of \newglossaryentry. (May be overridden by . (May be overridden by \glsdisp.) + id="dx1-3033">.)
@@ -738,55 +779,75 @@ class="E">EX that is a glossary entry. There are two main indexing applications that are used with TEX: makeindex and and xindy. These are both . These are both command line interface (CLI) applications.
+Latin Alphabet

The alphabet consisting of Latin characters. See also extended Latin + alphabet.
+
+Latin Character

One of the letters a, …, z, A, …, Z. See also extended Latin character.
+
Link text

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

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

A custom designed Perl script interface to xindy and and makeindex provided + id="dx1-3052"> provided with the glossaries package.
@@ -794,45 +855,68 @@ class="newline" /> makeglossariesgui

A Java GUI alternative to makeglossaries that also provides diagnostic + id="dx1-3055"> that also provides diagnostic tools. Available separately on CTAN.
makeindex

An indexing application.
- - +
+Non-Latin Alphabet

An alphabet consisting of non-Latin characters.
+
+Non-Latin Character

An extended Latin character or a character from a non-Latin alphabet.
Number list

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

Converts command names into character sequences. That is, a command called, say, 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

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

+Standard LATEX Extended Latin Character

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

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

1.

1. Introduction

-

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

The glossaries package is provided to assist generating 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 +entries. There is provision for loading a database of glossary terms. Only those terms used1.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 +

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

The glossaries package comes with a Perl script called

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 makeglossaries. This -provides a convenient interface to the 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: +

+
Option 1: +

This is the simplest option but it’s slow and if you want a sorted list, it + doesn’t work well for indexing applications extended Latin alphabets or non-Latin alphabets. + However, if you use the sanitizesort=false 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 {\’e}lite then the sort will default to elite + if sanitizesort=false is used and will default to \’elite if sanitizesort=true + is used. +

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

    \printnoidxglossary
    +

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

    3. +
  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 + “PDFLATEX” button in your editor.
+
+
Option 2: +

This option uses a command line interface (CLI) application called makeindex or + 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 + 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. +

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

    \printglossary
    +

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

    3. +
  3. Run LATEX 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. +
    4. +
  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 + command: + + +
    + makeindex -s myDoc.ist -o myDoc.gls myDoc.glo +
    +

    (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 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 -l switch: + + +

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

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

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

+
Option 3: +

This option uses a CLI application called xindy to sort the entries. This + application is more flexible than makeindex and is able to sort extended Latin + alphabets or non-Latin alphabets. The xindy 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 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. LATEX then reads this file in on the next + run. +

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

    +

    2. +
  2. Add \makeglossaries to your preamble (before you start defining your + entries, as described in §4 Defining Glossary Entries). +
    3. +
  3. Run LATEX 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. +
    4. +
  4. Run xindy. It is -strongly recommended that you use this script, but it is not essential. If you -are reluctant to install Perl, or for any other reason you don’t want to use + id="dx1-4074"> 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 + 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 +
    +

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

    (See §1.3.2 Using xindy explicitly (Option 3) for further details on using + xindy explicitly.) +

    5. +
  5. Once you have successfully completed the previous step, you can now run + LATEX on your document again. +
+
+

For Options 2 and 3, it can be difficult to remember all the parameters required +for makeindex or xindy, so the glossaries package provides a script called makeglossaries, you can call that reads the .aux file to determine what settings you have used +and will then run makeindex or or xindy explicitly. See . 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 myDoc with the base name of your LATEX document file. Avoid spaces in +the file name.) This is described in more detail in §1.3 Generating the -Associated Glossary Files for further details.

-

-This document uses the §1.3 Generating the Associated +Glossary Files. +

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

+
+ + +

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

+ + + + + + + + + + + + +

 Option 1 Option 2 Option 3

Requires + an + external + application?

✘ ✔ ✔

Requires + Perl?

✘ ✘ ✔

Can + sort + extended + Latin + alphabets + or + non-Latin + alphabets?

✘† ✘ ✔

Efficient + sort + algorithm?

✘ ✔ ✔

Can + use + a + different + sort + algorithm + for + each + glossary?

✔ ✘ ✘

Can + form + ranges + in + the + location + lists?

✘ ✔ ✔

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

✔ ✘ ✔

Maximum + hierarchical + depth

Unlimited 3 Unlimited

\glsdisplaynumberlist + reliable?

✔ ✘ ✘

\newglossaryentry + restricted + to + preamble?

✔ ✘ ✘

Requires + additional + write + registers?

✘ ✔ ✔

Default + value + of + sanitizesort + package + option

false true true
+ +
+

† Strips standard LATEX 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 “xindy” you’ll be taken to -the entry in the glossary where there’s a brief description of what “” you’ll be taken +to the entry in the glossary where there’s a brief description of the term +“xindy” -is. -

The remainder of this introductory section covers the following:

+ id="dx1-4104">”. +

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 @@ -969,21 +1676,19 @@ class="cmss-10">glossaries documentation directory. This location varies operating system and TEX distribution. You can use texdoc to locate the main - - glossaries documentation. For example, in a terminal or command prompt, type:
texdoc -l glossaries -

+

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

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

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 +

The sample documents are as follows1.2: @@ -994,6 +1699,8 @@ class="description"> This document is a minimal working example. You can test your installation using this file. To create the complete document you will need to do the following steps: + +

  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

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

    +

    or by typing
    perl makeglossaries minimalgls     -

    +

    If your system doesn’t recognise the command perl then it’s likely you don’t have Perl installed. In which case you will need to use makeindexmakeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo -

    +

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

    Note that if you need to specify the full path and the path contains + id="dx1-5013"> explicitly (Option 2) for further details on + using makeindex explicitly.) +

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

  2. Run Run minimalgls.tex through LATEX again (as step 1)
-

You should now have a complete document. The number following each entry in +

You should now have a complete document. The number following each entry in the glossary is the location number. By default, this is the page number where the entry was referenced.

sample4col.tex
sample-noidx.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 + id="x1-5018r2"> This document illustrates how to use the glossaries package + without an external indexing application (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 + inputenc 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:
latex sample4col
makeglossaries sample4col
latex sample4col -

+

As before, if you don’t have Perl installed, you will need to use makeindex + id="dx1-5024"> directly instead of using makeglossaries. The vertical gap between entries is + id="dx1-5026">. 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-5027"> package option.

sampleAcr.tex
This document has some sample acronyms. It also adds the glossary + id="x1-5028r5"> 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: @@ -1124,16 +1865,18 @@ class="cmtt-10">makeglossaries sampleAcr class="cmtt-10">latex sampleAcr
latex sampleAcr -

+

sampleAcrDesc.tex
This is similar to the previous example, except that the + id="x1-5029r6"> 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 class="cmtt-10">latex sampleAcrDesc
latex sampleAcrDesc -

+

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

- - +

sampleCustomAcr.tex
This document has some sample acronyms with a custom + id="x1-5033r8"> 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: @@ -1183,17 +1924,17 @@ class="cmtt-10">makeglossaries sampleCustomAcr class="cmtt-10">latex sampleCustomAcr
latex sampleCustomAcr -

+

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

+

+ +

sample-FnDesc.tex
This example defines a custom display format that puts the + id="x1-5036r10"> This example defines a custom display format that puts the description in a footnote on first use.
latex sample-FnDesc @@ -1218,12 +1961,12 @@ class="cmtt-10">latex sample-FnDesc class="cmtt-10">makeglossaries sample-FnDesc
latex sample-FnDesc -

+

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

- - +

sample-crossref.tex
This document illustrates how to cross-reference entries in the + id="x1-5038r12"> This document illustrates how to cross-reference entries in the glossary.
latex sample-crossref @@ -1247,19 +1988,19 @@ class="cmtt-10">latex sample-crossref class="cmtt-10">makeglossaries sample-crossref
latex sample-crossref -

+

sampleDB.tex
This document illustrates how to load external files containing the + id="x1-5039r13"> 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 suppressed and uses \glsaddall to add all the + id="dx1-5042"> to add all the entries to the glossaries without referencing each one explicitly. To create the document do:
latex sampleDB class="cmtt-10">makeglossaries sampleDB
latex sampleDB -

+

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

  1. Create the main glossary (all on one line): + class="enumerate" id="x1-5048x1">Create the main glossary (all on one line):
    makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo     -

    +

  2. Create the secondary glossary (all on one line): + class="enumerate" id="x1-5050x2">Create the secondary glossary (all on one line):
    makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn     -

    +

sampleEq.tex
This document illustrates how to change the location to something + id="x1-5051r14"> 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 + id="dx1-5052"> environment. To create the document do:
latex sampleEq
makeglossaries sampleEq - -
latex sampleEq -

+

sampleEqPg.tex
This is similar to the previous example, but the This is similar to the previous example, but the number lists are a + id="dx1-5056">s 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: @@ -1340,12 +2081,12 @@ class="cmtt-10">makeglossaries sampleEqPg class="cmtt-10">latex sampleEqPg
latex sampleEqPg -

+

sampleSec.tex
This document also illustrates how to change the location to + id="x1-5057r16"> 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 @@ -1355,16 +2096,18 @@ class="E">EX run is required: latex sampleSec
makeglossaries sampleSec + +
latex sampleSec
latex sampleSec -

+

sampleNtn.tex
This document illustrates how to create an additional glossary type. + id="x1-5058r17"> 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: @@ -1376,45 +2119,43 @@ class="cmtt-10">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 + id="dx1-5060"> twice instead of a single call to makeglossaries: + id="dx1-5062">:

  1. Create the main glossary (all on one line): - - + class="enumerate" id="x1-5064x1">Create the main glossary (all on one line):
    makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo     -

    +

  2. Create the secondary glossary (all on one line): + class="enumerate" id="x1-5066x2">Create the secondary glossary (all on one line):
    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 + id="x1-5067r18"> 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 + id="dx1-5068">, so an extra LATEX run is required:
makeglossaries sample class="cmtt-10">latex sample
latex sample -

+

You can see the difference between word and letter ordering if you substitute order=word with with order=letter. (Note that this will only have an effect if you use + id="dx1-5070">. (Note that this will only have an effect if you use makeglossaries. If you use . If you use makeindex explicitly, you will need to use the explicitly, you will need to use the -l switch to indicate letter ordering.) + +

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

+

sample-dual.tex
This document illustrates how to define an entry that both + id="x1-5078r21"> 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 + id="x1-5079r22"> This document illustrates how to use the glossaries package to create English to French and French to English dictionaries. To create the document do:
latex sample-langdict class="cmtt-10">makeglossaries sample-langdict
latex sample-langdict -

+

samplexdy.tex
This document illustrates how to use the This document illustrates how to use the glossaries package with xindy instead of instead of makeindex. The document uses UTF8 encoding (with the + id="dx1-5084">. 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, + id="dx1-5087">. By default, this document will create a xindy style file called style file called samplexdy.xdy, but if you uncomment the lines -
+
\setStyleFile{samplexdy-mc}  
\noist  
\GlsSetXdyLanguage{}
-

it will set the style file to

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 + id="dx1-5091">, you don’t need to supply any additional information. If you don’t use makeglossaries, you will need to specify the required information. + id="dx1-5093">, 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 , otherwise the glossaries package will overwrite samplexdy-mc.xdy and you will lose the “Mc” letter group. -

To create the document do: +

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 + id="dx1-5096"> explicitly instead of using makeglossaries. If you are using the default style file . If you are using the default style file samplexdy.xdy, then do (no line breaks):
xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo -

+

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

+

samplexdy2.tex
This document illustrates how to use the 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 xindy. To create the document do: + id="dx1-5101">. To create the document do:
pdflatex samplexdy2
makeglossaries samplexdy2
pdflatex samplexdy2 -

+

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

+

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

sampleutf8.tex
This is another example that uses This is another example that uses xindy. Unlike . Unlike makeindex, , xindy - can cope with accented or non-Latin characters. This document uses UTF8 - encoding. To create the document do: + id="dx1-5110"> + can cope with non-Latin characters. 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 + id="dx1-5114"> explicitly instead of using makeglossaries (no line breaks): + id="dx1-5116"> (no line breaks):
xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo -

-

If you remove the

+

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

- you will see that the entries that start with a non-Latin character now appear in +

+ you will see that the entries that start with a non-Latin character now appear in the symbols group, and the word “manœuvre” is now after “manor” instead of before it. If you are unable to use makeglossaries, the call to , the call to makeindex is as + id="dx1-5123"> 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 This document uses the glossaries package to create both a glossary and an index. This requires two makeglossaries calls to ensure the + id="dx1-5126"> calls to ensure the document is up to date:
latex sample-index @@ -1714,21 +2461,21 @@ class="cmtt-10">makeglossaries sample-index
latex sample-index -

+

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

+

samplePeople.tex
This document illustrates how you can hook into the + id="x1-5131r29"> 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: @@ -1756,12 +2503,12 @@ class="cmtt-10">makeglossaries samplePeople class="cmtt-10">latex samplePeople
latex samplePeople -

+

sampleSort.tex
This is another document that illustrates how to hook into the + id="x1-5132r30"> 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:
makeglossaries sampleSort class="cmtt-10">latex sampleSort
latex sampleSort -

+

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

+

sampleaccsupp.tex
This document uses the experimental This document uses the experimental glossaries-accsupp package. + id="dx1-5139"> 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 §18 Accessibility Support.
-

+

-

Top

1.2 Multi-Lingual Support

-

As from version 1.17, the

As from version 1.17, the glossaries package can now be used with xindymakeindex. If you are writing in a language that uses accented characters or -non-Latin characters it is recommended that you use xindy as . If you are writing in a language that uses an extended Latin alphabet or +non-Latin alphabet it is recommended that you use makeindex is -hard-coded for Latin languages. This means that you are not restricted to the A, …, Z -letter groups. If you want to use xindy as makeindex 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 xindy, remember to use the , remember to use the xindy package option. For -example: + id="dx1-6015"> package +option. For example:

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

-

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

+

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

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

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. \Gls) due to expansion issues. For -example: - - -

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

-

-

If you use the ) due to expansion issues. For +example:

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

+

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

+

-

Top

1.2.1 Changing the Fixed Names

-

As from version 1.08, the

As from version 1.08, the glossaries package now has limited multi-lingual support, thanks to all the people who have sent me the relevant translations either via email or via -

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

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

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

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

-

If you want to use

+

If you want to use ngerman or germantranslator -

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

-

The languages are currently supported by the

+

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

If you want to add a language not currently supported, you can +post the contents of your .dict file on my feature request form at +http://www.dickimaw-_books.com/feature-_request.html. Please use +LATEX commands for non-Latin characters as the file must be independent of the +input encoding otherwise it won’t be of any use to people who use a different +encoding to yourself.

-

Table 1.1: Supported Languages
-
-

-

-
Table 1.2: Supported Languages +
Language Language As from version
Brazilian Portuguese Brazilian Portuguese 1.17
Danish Danish 1.08
Dutch Dutch 1.08
English English 1.08
French French 1.08
German German 1.08
Irish Irish 1.08
Italian Italian 1.08
Hungarian Hungarian 1.08
Polish Polish 1.13
Serbian Serbian 2.06
Spanish Spanish 1.08
-
+
-

The language dependent commands and

The language dependent commands and translator keys used by the glossaries + id="dx1-7016"> keys used by the glossaries package are listed in table 1.2. +href="#tab:predefinednames">table 1.3.

-

Table 1.2: Customised Text
+>Table 1.3: Customised Text
-
+ id="dx1-7020">).

Command Name

Command Name

Translator Key Word

Word

Purpose

\glossaryname

Glossary

Title + id="dx1-7018">

Glossary

Title of the main glossary.

\acronymname

Acronyms

Title + id="dx1-7019">

Acronyms

Title of the list @@ -2129,17 +2903,17 @@ class="td10">

Title option acronym).

\entryname

Notation (glossaries)

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

Header for first column @@ -2157,15 +2931,15 @@ class="td10">

Header support headers).

\descriptionname

Description (glossaries)

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

Header for second column @@ -2183,15 +2957,15 @@ class="td10">

Header support headers).

\symbolname

Symbol (glossaries)

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

Header for symbol column @@ -2206,17 +2980,17 @@ class="td10">

Header this option.

\pagelistname

Page List (glossaries)

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

Header for page list @@ -2231,15 +3005,15 @@ class="td10">

Header this option.

\glssymbolsgroupname

Symbols (glossaries)

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

Header for symbols section @@ -2254,15 +3028,15 @@ class="td10">

Header this option.

\glsnumbersgroupname

Numbers (glossaries)

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

Header for numbers section @@ -2283,34 +3057,34 @@ class="td10">

Header

-

Due to the varied nature of glossaries, it’s likely that the predefined translations +

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

Note that the dictionaries are loaded at the beginning of the document, so it +

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

-

Your custom dictionary doesn’t have to be just a translation from English to +

+

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”, @@ -2318,43 +3092,43 @@ 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

(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 and don’t want to use the translator interface, you can use + id="dx1-7033"> interface, you can use the package option translate=babel. For example: + id="dx1-7034">. For example:

-
+
\documentclass[british]{article}  
\usepackage{babel}  
\usepackage[translate=babel]{glossaries} @@ -2363,55 +3137,65 @@ class="cmss-10">translate=babel    \renewcommand*{\acronymname}{List of Acronyms}%  
}
-

-

If you are using

+

If you are using polyglossia instead of instead of babel, , glossaries-polyglossia will automatically + id="dx1-7037"> will automatically be loaded unless you specify the package option translate=false. -

Note that . +

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

-

Top

1.3 Generating the Associated Glossary Files

-

In order to generate a sorted glossary with compact

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

+

In order to generate a sorted glossary with compact number lists, it is necessary to use an external indexing application as an intermediate step. It is this application -that creates the file containing the code that typesets the glossary. If this -step is omitted, the glossaries will not appear in your document. The two +href="#glo:indexingapp">indexing application as an intermediate step (unless you have chosen Option 1). 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 EX are +makeindex -and and xindymakeindex only. Note that xindy has much better multi-lingual support -than has much better multi-lingual support than +makeindex, so xindy is recommended if you’re not writing in English. -Commands that only have an effect when is recommended if you’re not writing in English. Commands that +only have an effect when xindy is used are described in §11 -Xindy. -

This is a multi-stage process, but there are methods of automating +class="cmsy-10">§11 Xindy (Option +3). +

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

-

The

+ + +

The glossaries package comes with the Perl script \makeglossaries). See §1.3.1 §1.3.1 Using the makeglossaries Perl Script for -further details. Perl is stable, cross-platform, open source software that is used by -a number of TEX-related applications. Further information is available at - - +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 user you will need to +install Perl if you want to use makeglossaries. Further information is available at http://www.perl.org/about.html. The advantages of using http://www.perl.org/about.html and MiKTeX and Perl scripts (and one Python +script). +

The advantages of using makeglossaries: -

+ id="dx1-8031">:

  • It automatically detects whether to use makeindex or makeindex or xindy and sets the + id="dx1-8035"> and sets the relevant application switches.
  • One call of makeglossaries will run makeindex/makeglossaries will run makeindex/xindy for each glossary + id="dx1-8041"> for each glossary type.
  • If things go wrong, makeglossaries will scan the messages from will scan the messages from makeindex + id="dx1-8045"> or xindy and attempt to diagnose the problem in relation to 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 makeindex or xindy messages. + id="dx1-8051"> messages.
-

There is also a Java GUI alternative called

There is also a Java GUI alternative called makeglossariesgui, distributed + id="dx1-8053">, distributed separately, that has diagnostic tools. -

Whilst it is strongly recommended that you use the

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

If you are choosing not to use table 1.4. +

If you are choosing not to use makeglossaries because you don’t want to install + id="dx1-8063"> because you don’t want to install Perl, you will only be able to use makeindex as makeindex as xindy also requires Perl. + id="dx1-8067"> also requires Perl.
-

-

Note that if any of your entries use an entry that is not referenced outside the +

+

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 + id="dx1-8073"> run, as appropriate. For example, suppose you have defined the following entries:1.3 + id="x1-8074f3">

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

and suppose you have

and suppose you have \gls{citrusfruit} in your document but don’t reference the orange entry, then the orange entry won’t appear in your glossary until you first create the glossary and then do another run of makeglossaries, , makeindex or + id="dx1-8079"> 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

+

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 number lists in the glossary may need updating. -

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

The examples in this document assume that you are accessing makeglossaries, + id="dx1-8087">, xindy or or makeindex via a terminal. Windows users can use the MSDOS Prompt + id="dx1-8091"> via a terminal. Windows users can use the MSDOS Prompt which is usually accessed via the Start->All class="cmss-10">Programs->Accessories menu. -

Alternatively, your text editor may have the facility to create a function that will +

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

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

-

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

Top

1.3.1 Using the makeglossaries Perl Script

-

The

The makeglossarieslatex myDoc class="cmtt-10">makeglossaries myDoc
latex myDoc -

+

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

-There is a batch file called makeglossaries.bat which does this for -Windows users, but you must have Perl installed to be able to use -it.1.4 -You can specify in which directory the

+

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 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 glossaries package). If you move 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 +makeglossaries.) +

The makeglossaries script attempts to fork the makeindex/xindy process using +open() on the piped redirection 2>&1 | 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 makeglossaries 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 +makeglossaries 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 .aux, , .glo etc files are located using the etc files are located using the -d switch. For example:
pdflatex -output-directory myTmpDir myDoc
makeglossaries -d myTmpDir myDoc -

+ + +

Note that makeglossaries assumes by default that assumes by default that makeindex//xindy is on your + id="dx1-9039"> 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 or -x <path/to/xindy> for xindy. -

The . +

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

When upgrading the

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

-

+ id="dx1-9050">. The current version is 2.14.

+

+

-

Top

1.3.2 Using xindy explicitly

-

Using xindy explicitly (Option 3) +

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

If you want to use

If you want to use xindyxindy -

+
\usepackage[xindy]{glossaries}
-

This is required regardless of whether you use

This is required regardless of whether you use xindy-I class="cmtt-10">xindy not -I tex. -

To run

To run xindy<base>.glo -

+

where <language}. 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

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 @@ -3067,12 +3949,12 @@ 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 \newglossary. -

Note that if you use

Note that if you use makeglossariesmakeglossaries:
makeglossaries myDoc -

+

Note also that some commands and package options have no effect if you use xindymakeglossaries. These are listed in table 1.3. +href="#tab:makeglossariesCmds">table 1.4. -

+

-

Top

1.3.3 Using makeindex explicitly

-

If you want to use Using makeindex explicitly (Option 2) +

If you want to use makeindex<base>.glo -

+

where <base-l (letter ordering). See the makeindex manual for further details. -

For example, if your document is called

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 acronymacronym
makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn -

+

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

Note that if you use

Note that if you use makeglossariesmakeglossaries:
makeglossaries myDoc -

+

Note also that some commands and package options have no effect if you use makeglossaries. These are listed in table 1.3. -

+href="#tab:makeglossariesCmds">table 1.4. +

-

Top

1.3.4 Note to Front-End and Script Developers

-

The information needed to determine whether to use

The information needed to determine whether to use xindy

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

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

-

+

where <in-ext -

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

-

The

+

The indexing application’s style file is specified by -

\@istfilename  <filename>}
-

+

The file extension indicates whether to use 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  <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 <code>}
-

+

where <labelmakeindex should be used. +

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

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

Note that

Note that <key>=> (such as makeindex) may be passed via the document class options.
-

+

-

Top

2.1 General Options

+ id="generaloptions">General Options
nowarn\makeglossaries).
nomainnoredefwarn
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 nowarn option described above. +
+nomain
This suppresses the creation of the main glossary and associated .glo file, if unrequired. Note that if you use this option, you must create another glossary in which to put all your entries (either via the acronym + id="dx1-14006"> (or acronyms) package option described in §2.5 Acronym Options or via the + id="dx1-14007">) package option described in §2.5 Acronym Options or via the symbols, , numbers or or index options described in §2.6 Other Options or via + id="dx1-14010"> options described in §2.6 Other Options or via \newglossary described in described in §12 §12 Defining New Glossaries). -

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

If you don’t use the main glossary and you don’t use this option, makeglossaries + id="dx1-14013"> will produce the following warning:

filename.glo’ is empty. + +
Have you glossary. check that you have referenced the entries in that glossary via commands such as \gls.
- - -

+ id="dx1-14014">.

+

sanitizesort
This is a boolean option that determines whether or not to sanitize the + id="dx1-14017"> 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 (

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 @@ -3573,71 +4491,80 @@ class="E">EX will try to interpret it as a parameter

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

and you actually want

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

The default for Options 2 and 3 is sanitizesort=true.) + id="dx1-14019">, 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 glossaries package. (Default is savewrites=false.) There are only a + id="dx1-14022">.) 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 + id="dx1-14023"> 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 + id="dx1-14024">. +

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 + id="dx1-14025"> package (part of the KOMA-Script bundle) and not use this option.
-

-

If you want to use T

+

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 mechanism to call makeindex or or xindy + id="dx1-14030"> from your document and use savewrites, you must create the external files with + id="dx1-14031">, you must create the external files with \glswritefiles before you call makeindex//xindy. Also set . Also set \glswritefiles to nothing or \relax before the end of the document to avoid rewriting the files. @@ -3645,42 +4572,42 @@ class="cmtt-10">\relax before the end of the document to avoid rewriting

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

-

+

+

translate
This can take the following values:
translate=true
If babel has been loaded and the has been loaded and the translator package is + id="dx1-14039"> package is installed, translator will be loaded and the translations will be + id="dx1-14040"> will be loaded and the translations will be provided by the translator package interface. You can modify the + id="dx1-14041"> package interface. You can modify the translations by providing your own dictionary. If the translator + id="dx1-14042"> package isn’t installed and babel is loaded, the is loaded, the glossaries-babel + id="dx1-14044"> package will be loaded and the translations will be provided using babel’s <language> mechanism. If polyglossia has + id="dx1-14045"> has been loaded, glossaries-polyglossia will be loaded. + id="dx1-14046"> will be loaded.
translate=false
Don’t provide translations, even if babel or or polyglossia has + id="dx1-14049"> has been loaded. (Note that babel provides the command provides the command \glossaryname + id="dx1-14051"> so that will still be translated if you have loaded babel.) + id="dx1-14052">.)
translate=babel
Don’t load the translator package. Instead load + id="dx1-14054"> package. Instead load glossaries-babel. -

I recommend you use . +

I recommend you use translate=babel if you have any problems with the + id="dx1-14056"> 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 has been loaded the default is translate=true. + id="dx1-14058">.
-

+

-

If

If translate is specified without a value, is specified without a value, translate=true is assumed. If is assumed. If translate + id="dx1-14061"> isn’t specified, translate=true is assumed if is assumed if babel, , polyglossia or or translator have + id="dx1-14065"> have been loaded. Otherwise translate=false is assumed. + id="dx1-14066"> is assumed. -

See

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

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

+

nohypertypes
Use this option if you have multiple glossaries and you want to suppress the entry hyperlinks for a particular glossary or glossaries. The value of this option should be a comma-separated list of glossary types where \gls etc + id="dx1-14076"> 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. + id="dx1-14077">. You may also use -

\GlsDeclareNoHyperList{<list>}
-

+

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

savenumberlist
This is a boolean option that specifies whether or not to gather and store the number list for each entry. The default is for each entry. The default is savenumberlist=false. (See + id="dx1-14082">. (See \glsentrynumberlist and and \glsdisplaynumberlist in in §9 §9 Using Glossary - Terms Without Links.) + Terms Without Links.) This is always true if you use Option 1.
-

+

-

Top

2.2 Sectioning, Headings and TOC Options

+ id="sectioningheadingsandtocoptions">Sectioning, Headings and TOC Options
tocAdd 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
-

+

numberline> option. Its value should be the name of a sectio 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 +

-

+

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

+

By default this uses \@mkboth2.12.1 -

+
\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 ucmark option described below. -

Occasionally you may find that another package defines +

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 @@ -4005,10 +4933,10 @@ class="cmtt-10">\glsclearpage:

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

+

ucmark\MakeTextUppercase2.2. You can test whether this option has been set or not using -

\ifglsucmark  false part>\fi
-

+

For example:

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

If

If memoir has been loaded and ucfirst\section) and is assigned a label (via \label). The label is formed from -

\glsautoprefix  \glsautoprefix <type>
-

+

where <typeglossaries

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

then each glossary will appear in a numbered section, and can be +

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

-
-

+

-

Top

2.3 Glossary Appearance Options

+ id="glossaryappearanceoptions">Glossary Appearance Options
entrycounter 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  <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 xindy to ensure the cross-references are up-to-date.
-

+

counterwithinglossaryentry<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 @@ -4290,38 +5218,38 @@ class="cmss-10">glossaryentrycounterwithin 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 +

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. @@ -4331,7 +5259,7 @@ class="cmtt-10">\setglossarypreamble  The preamble text here for the main glossary.  
}
-

+

subentrycounterglossary-superglossary-tree. Alternatively, you can set the style using -

\setglossarystyle{<style name>}
-

+

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

\printglossary. Example: -
+
\usepackage[nostyles]{glossaries}  
\usepackage{glossary-mcols}  
\setglossarystyle{mcoltree}
-

+

nonumberlistnumber lists in the glossaries (see also §5 §5 Number lists).
nonumberlist=false\glssee.) For further details see §8 §8 Cross-Referencing Entries.
@@ -4562,7 +5490,7 @@ class="cmss-10">counter=pagenumber lists (see §5 +class="cmsy-10">§5 Number lists).
@@ -4589,86 +5517,108 @@ class="cmtt-10">true, this option suppresses the default vertical gap bet class="cmss-10">nogroupskip=false.
-

+

-

Top

2.4 Sorting Options

+ id="sortingoptions">Sorting Options
sort
This is a 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 sort key in the optional argument of + \printnoidxglossary. If you have multiple glossaries in your document + and you are using Option 1, only use sort=def or sort=use if you want to + set this sort method for all your glossaries. +

This is a <key>=<value> option where the option can only have one of - the following values: +class="cmmi-10">> option where <value> may be one of the following: +

  • standard : entries are sorted according to the value of the : entries are sorted according to the value of the sort key + id="dx1-17007"> key used in \newglossaryentry (if present) or the (if present) or the name key (if key (if sort key + id="dx1-17010"> key is missing);
  • def : entries are sorted in the order in which they were defined (the + id="dx1-17011"> : 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 + id="dx1-17013"> : entries are sorted according to the order in which they are used in the document (the sort key in key in \newglossaryentry is ignored). -

    Both

    Both sort=def and and sort=use set the sort key to a six digit number + id="dx1-17016"> set the sort key to a six digit number via -

    \glssortnumberfmt  \glssortnumberfmt{<number>}
    -

    +

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

-

The default is ).

+

The default is sort=standard. When the standard sort option is in use, you can + id="dx1-17020">. When the standard sort option is in use, you can hook into the sort mechanism by redefining: -

\glsprestandardsort  \glsprestandardsort{<sort cslabel>}
-

+

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

\glsdosanitizesort  \glsdosanitizesort
-

- which sanitizes

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

The other arguments, is used). +

The other arguments, <type> and label> will be in the form used in the first argument of \newglossaryentry. -

Redefining . + + +

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 or sort=use. + id="dx1-17035">.
- - -

+

-

+

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 main and acronym glossaries to be sorted alphabetically, - but the notation type should be sorted in order of definition. I can - set the sort to standard (which is the default, but can be explicitly - set via the package option 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 2 or 3, I can set the sort to standard (which is the default, but can + be explicitly set via the package option sort=standard), and I can either define all + id="dx1-17040">), and I can either define all my main and acronym entries, then redefine 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}% @@ -4817,24 +5789,26 @@ class="cmtt-10">notation.  
  }%  
}
-

(

(\ifdefstring is defined by the etoolbox package.) For a complete document, + id="dx1-17041"> package.) For a complete document, see the sample file sampleSort.tex.

-

-

____________________________

+

+

____________________________

-

+

Example 2 (Customizing Standard Sort) -

Suppose you want a glossary of people and you want the names listed as +class="cmbx-12"> (Customizing Standard Sort (Options 2 or + 3)) +

Suppose you want a glossary of people and you want the names listed as <first-name>} that you can use in the name key when you define the entry, but hook into the standard sort + id="dx1-17044"> 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: +

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

-
+
\renewcommand{\glsprestandardsort}[3]{%  
 \let\name\sortname  
 \edef#1{\expandafter\expandonce\expandafter{#1}}% @@ -4906,109 +5880,140 @@ class="cmmi-10">> in the  
 \glsdosanitizesort  
}
-

(The somewhat complicate use of

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

Now the entries can be defined: +

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.

-

-

____________________________

+

+

____________________________

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

Note that the . The default is word ordering. +

Note that the order option has no effect if you don’t use option has no effect if you don’t use makeglossaries. + id="dx1-17050">.
-

+

+

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

+
+ \printnoidxglossary[sort=standard] +
+

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

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

makeindex
(Default) 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 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 . If you don’t use makeglossaries, you need to - remember to use , you + need to remember to use makeindex not not xindy. The indexing style file will been given a - . The indexing style file will been + given a .ist extension. -
+ id="dx1-17066"> 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. +

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

This package option may additionally have a value that is a

This package option may additionally have a value that is a <key>=>

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

You can also specify whether you want a number group in the glossary. This +

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

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

xindygloss
This is equivalent to
(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 (see §11.1 - §11.1 Language and Encodings.)
xindynoglsnumbers
This is equivalent to xindy={glsnumbers=false} and may be - used as a document class option. + id="dx1-17088">
(Option 3) This is equivalent to xindy={glsnumbers=false} + and may be used as a document class option.
-

+

-

Top

2.5 Acronym Options

+ id="acronymoptions">Acronym Options
acronymacronym. This is equivalent to: -
+
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
-

It will also define -

It will also define +

\printacronyms  <options>]
-

+

that’s equivalent to

] or the package option compatible-3.07 is used). -

If the

If you are using Option 1, you need to use

+
+ \printnoidxglossary[type=acronym,<options>] +
+
to display the list of acronyms. +

If the acronym package option is used, package option is used, \acronymtype is set to is set to acronym otherwise it is set to main.2.3 + id="x1-18008f3"> Entries that are defined using \newacronym are placed in the glossary whose + id="dx1-18014"> are placed in the glossary whose label is given by \acronymtype, unless another glossary is explicitly + id="dx1-18015">, unless another glossary is explicitly specified. -

Remember to use the

Remember to use the nomain package option if you’re only interested in using + id="dx1-18016"> package option if you’re only interested in using this acronym glossary.
-

+

acronyms
This is equivalent to acronym=true and may be used in the document class + id="dx1-18018"> and may be used in the document class option list.
acronymlists
By default, only the \acronymtype glossary is considered to be a list of acronyms. If you have other lists of acronyms, you can specify them as a comma-separated list in the value of acronymlists. For example, if you use the + id="dx1-18020">. For example, if you use the acronym package option but you also want the 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 + id="dx1-18023"> 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  \glsIfListOfAcronyms{<label<false part>}
-

+

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

\DefineAcronymShortcuts  \DefineAcronymShortcuts
-

+

-

+

-

Top

2.5.1 Deprecated Acronym Style Options

-

The package options listed in this section are now deprecated but are kept for + id="deprecatedacronymstyleoptions">Deprecated Acronym Style Options +

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

-

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

+
\setacronymstyle{footnote-sc-desc}
-

or (with

or (with footnote and smallersmaller -

+
\setacronymstyle{footnote-sm-desc}
-

or (with

or (with dua)

-
+
\setacronymstyle{dua-desc}
-

+

smallcaps\newacronym +
\setacronymstyle{long-sc-short}
-

or (with

or (with description)

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

or (with

or (with description and footnotefootnote -

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

If you use this option, you will need to include the

If you use this option, you will need to include the relsize 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 footnotefootnote -

footnote\newacronym +
\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 descriptiondescription -

dua\newacronym +
\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: + id="otheroptions">Other Options +

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

symbolssymbols via -
+
\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
-

It also defines -

It also defines +

\printsymbols  <options>]
-

- which is a synonym for

+ which is a synonym for

+
+ \printglossary[type=symbols,<options>]. -

Remember to use the ] +
+
+

If you use Option 1, you need to use:

+
+ \printnoidxglossary[type=symbols,<options>] +
+
to display the list of symbols. +

Remember to use the nomain package option if you’re only interested in using + id="dx1-20005"> package option if you’re only interested in using this symbols glossary.
-

+

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

It also defines -

It also defines +

\printnumbers  \printnumbers[<options>]
-

- which is a synonym for

+ which is a synonym for

+
+ \printglossary[type=numbers,<options>]. -

Remember to use the ] +
+
+

If you use Option 1, you need to use:

+
+ \printnoidxglossary[type=numbers,<options>] +
+
to display the list of numbers. +

Remember to use the nomain package option if you’re only interested in using + id="dx1-20010"> package option if you’re only interested in using this numbers glossary.
-

+

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

It also defines -

\printindex  \printindex[<options>]
-

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

It also defines +

\newterm  <term>}
-

+

which is a synonym for

<options>] +
+
and +

\printindex  \printindex[<options>]
+

+ which is a synonym for

+
+ \printglossary[type=index,<options>]
-

Remember to use the

If you use Option 1, you need to use:

+
+ \printnoidxglossary[type=index,<options>] +
+
to display this glossary. +

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

-

Since the index isn’t designed for terms with descriptions, you might also want +

+ + +

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-20024"> or the command
\GlsDeclareNoHyperList{index}
-

The example file

The example file sample-index.tex illustrates the use of the index package + id="dx1-20026"> package option.

compatible-2.07
Compatibility mode for old documents created using version 2.07 or below. - -
compatible-3.07
Compatibility 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

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

\setupglossaries  <key-val list>}
-

+

The following package options can’t be used in \setupglossaries: translatenotranslate, 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 §11 Xindy for further +class="cmsy-10">§11 Xindy (Option 3) for further details). -

I recommend you use this command as soon as possible after loading

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 -

+

-

-

+

Top

3. Setting Up

-

The command -

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

+

Top

3.1 Option 1

+

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

+

+

Top

3.2 Options 2 and 3

+

The command +

\makeglossaries  \makeglossaries
-

+

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

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

Similarly, there are some commands that must be used after \makeglossaries +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 or makeindex style file + id="dx1-24011"> style file using -

\noist  \noist
-

-Note that this command must be used before

+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 file created when using glossaries version 2.07 or below, you will need to use the compatible-2.07 package option with it. + id="dx1-24014"> package option with it.
-

-

The default name for the customised style file is given by

+ + +

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

(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 be used before \makeglossaries. -

Each glossary entry is assigned a

Each glossary entry is assigned a number list that lists all the locations in the + id="dx1-24021"> 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 + id="dx1-24022"> 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{-}
-

Note that this command must be used before

This command must not be used after \makeglossaries. -

If you use xindy, you can have a different compositor for page numbers starting +

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

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

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

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

See

See §5 §5 Number lists for further information about number lists. + id="dx1-24028">s.

-

-

+

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.4.1 -However only those entries that occur in the document (using any of the commands -described in

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.8 Drawbacks With +Defining Entries in the Document Environment for a discussion of the problems with +defining entries within the document instead of in the preamble. +

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 §6 §6 Links to Glossary Entries, §7 Adding an Entry to the Glossary -Without Generating Text or §7 Adding an Entry to the +Glossary Without Generating Text or §8 Cross-Referencing Entries) will appear in the glossary. -Each time an entry is used in this way, a line is added to an associated glossary -file (.glo), which then needs to be converted into a corresponding .gls file -which contains the typeset glossary which is input by \printglossary or -\printglossaries. The Perl script makeglossaries can be used to call -makeindex or xindy, using a customised indexing style file, for each of the -glossaries that are defined in the document. Note that there should be -no need for you to explicitly edit or input any of these external -files.4.2 -See §1.3 Generating the Associated Glossary Files for further details. -

New glossary entries are defined using the command: -

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

\newglossaryentry  \newglossaryentry{<labelkey=value list>}
-

+

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

\longnewglossaryentry  \longnewglossaryentry{<label<long description>}
-

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

+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  \provideglossaryentry{<labelkey=value class="cmitt-10">list>}
-

+

and -

\longprovideglossaryentry  -

+

\longprovideglossaryentry{<labellong class="cmitt-10">description>}
-

+

(These are both preamble-only commands.) -

For all the above commands, the first argument,

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

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

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. 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 information about this entry. There are two required fields: > list that +supplies the relevant information about this entry. There are two required fields: +description -and either and either name or or parent. Available fields are listed below: + id="dx1-25013">. The description is set in the third argument +of \longnewglossaryentry and \longprovideglossaryentry. With the +other commands it’s set via the description key. 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 parent key is supplied, this value will be the same as the + id="dx1-25016"> key is supplied, this value will be the same as the parent’s name.
description
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 \newline not 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 §4.5 §4.5 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 description key. + id="dx1-25023"> key.
text
How this entry will appear in the document text when using \gls (or one of its + id="dx1-25025"> (or one of its upper case variants). If this field is omitted, the value of the name key is + id="dx1-25026"> key is used. + +
first
How the entry will appear in the document text on first use with \gls (or + id="dx1-25029"> (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, + id="dx1-25033">, \glsdisp before using before using \gls, the , the firstplural value won’t be used with + id="dx1-25036"> value won’t be used with \gls. + id="dx1-25037">.
plural
How the entry will appear in the document text when using \glspl (or one of + id="dx1-25039"> (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-25041"> field. The default value of \glspluralsuffix is the letter “s”. + id="dx1-25042"> is the letter “s”.
firstplural
How the entry will appear in the document text on first use with \glspl + id="dx1-25045"> (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 + id="dx1-25047"> 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 + id="dx1-25050"> field is present. Note that if you use \gls, , \Gls, , \GLS, , \glsdisp before using \glspl, the , the firstplural + id="dx1-25055"> value won’t be used with \glspl. -

. +

Note: prior to version 1.13, the default value of firstplural was always + id="dx1-25057"> was always taken by appending “s” to the first key, which meant that you had + id="dx1-25058"> 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 + id="dx1-25061"> 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 @@ -6313,133 +7392,296 @@ 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-25064"> and \glsdisplayfirst by by \glspl, , \Glspl and and \GLSpl). If omitted, the value is set + id="dx1-25068">). If omitted, the value is set to the same as the symbol key. + id="dx1-25069"> key.
sort
This value indicates how makeindex or
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 sort=def and + sort=use have been used. In general, it’s best to use the sort key if the + name contains commands (e.g. \ensuremath{\alpha}). You can also + override the sort key by redefining \glsprestandardsort (see §2.4 Sorting + Options). +

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

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

This is equivalent to: + + +

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

Unless you use the package option sanitizesort=true, 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 inputenc package:

+
+ \newglossaryentry{elite}{% +
  name={{é}lite}, +
  description={select group of people} +
} +
+
This is equivalent to
+
+ \newglossaryentry{elite}{% +
  name={{é}lite}, +
  description={select group of people}, +
  sort=elite +
} +
+
Unless you use the package option sanitizesort=true, in which case it’s equivalent + to:
+
+ \newglossaryentry{elite}{% +
  name={{é}lite}, +
  description={select group of people}, +
  sort=élite +
} +
+
Again, this will place the entry before the “A” group. + + +

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

Take care with xindy should sort this entry. If omitted, - the value is given by the name field unless one of the package options sort=def - and sort=use have been used. In general, it’s best to use the (Option 3): if you have entries with the same sort key if the - value + they will be treated as the same entry. +

Take care if you use Option 1 and the name contains commands (e.g. \ensuremath{\alpha}). You can also - override the contains fragile commands. You will + either need to explicitly set the sort key by redefining \glsprestandardsort (see §2.4 Sorting - Options). -

+ id="dx1-25093"> key or use the sanitizesort=true 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 \newacronym is used (see is used (see §13 +class="cmsy-10">§13 Acronyms).
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 \glsaddkey (see (see §4.3 §4.3 Additional Keys). Other keys are also provided by the glossaries-prefix ( (§17 §17 Prefixes or Determiners) and glossaries-accsupp ( (§18 +class="cmsy-10">§18 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 + id="dx1-25108"> just for this entry. Conversely, if you have used the package option nonumberlist, you can activate the number list just for this entry with + id="dx1-25109">, you can activate the number list just for this entry with nonumberlist=false. (See . (See §5 §5 Number lists.)
see
Cross-reference another entry. Using the see key will automatically add this entry + id="dx1-25114"> 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 @@ -6449,155 +7691,175 @@ class="cmtt-10"> also]{anotherlabel}. Note that if you have suppressed the number list, the cross-referencing information won’t appear in the glossary, as it 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-25119"> (see above). Alternatively, you can use the seeautonumberlist package option. For further details, see package option. For further details, see §8 §8 Cross-Referencing Entries. -

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

+ id="dx1-25123"> key.

+

+ +

-

The following keys are reserved for

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

Note that if the name starts with an accented letter or other non-Latin character, -you must group the character, otherwise it will cause a problem for commands like -

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

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

Note that in both of the above examples, you will also need to supply the package:

+
+\newglossaryentry{elite}{name={{é}lite}, +
description={select group or class}} +
+
Note that in both of the above examples, you will also need to supply the sort key if + id="dx1-25136"> key if you are using makeindex whereas Option 2 whereas xindy is usually able to sort accented letters -correctly. -

-

(Option 3) is usually able to sort non-Latin +characters correctly. Option 1 discards accents from standard LATEX extended Latin +characters unless you use the sanitizesort=true. +

Top

4.1 Plurals

-

You may have noticed from above that you can specify the plural form when you +

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

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

+

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 + id="dx1-26002"> 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 @@ -6605,18 +7867,18 @@ 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 , described in §4.3 +class="cmsy-10">§4.3 Additional Keys. -

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

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

+

-

Top

4.2 Other Grammatical Constructs

-

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

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

-
+
\let\glsing\glsuseri  
\let\glsd\glsuserii  
\newcommand*{\ingkey}{user1} @@ -6652,42 +7914,42 @@ 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 + id="dx1-27001">, described below in §4.3 §4.3 Additional Keys. -

+

-

Top

4.3 Additional Keys

-

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

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

\glsaddkey  \glsaddkey{<keylink allcaps cs>}
-

+

where:

key>
is the new key to use in \newglossaryentry (or similar commands such + id="dx1-28002"> (or similar commands such as \longnewglossaryentry); + id="dx1-28003">);
<>
is the control sequence to use analogous to commands like \glsentrytext; + id="dx1-28004">;
<>
is the control sequence to use analogous to commands like \Glsentrytext; + id="dx1-28005">;
<link cs>
is the control sequence to use analogous to commands like \glstext; + id="dx1-28006">;
<>
is the control sequence to use analogous to commands like \Glstext; + id="dx1-28007">;
@@ -6789,17 +8051,17 @@ class="cmmib-10">>
is the control sequence to use analogous to commands like \GLStext.
-

The starred version of . +

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 @@ -6807,7 +8069,7 @@ both cases, so I need to use the starred form:

-
+
 % Define "ed" key:  
 \glsaddkey*  
  {ed}% key @@ -6827,11 +8089,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: @@ -6844,175 +8106,175 @@ 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.4 Expansion

-

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

When you define new glossary entries expansion is performed by default, except for the name, , description, , descriptionplural, , symbol, , symbolplural and and sort keys (these keys + id="dx1-29006"> 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 table 4.1. +href="#tab:fieldmap">table 4.1.

-

Table 4.1: Key to Field Mappings
-
Key to Field Mappings +
Key Key Field
sort sortvalue
firstplural firstpl
description desc
descriptionplural descplural
user1 useri
user2 userii
user3 useriii
user4 useriv
user5 userv
user6 uservi
longplural longpl
shortplural shortpl
@@ -7020,32 +8282,32 @@ class="cmtt-10">shortpl
-

Any keys that haven’t had the expansion explicitly set using

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 +

+

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

-

Top

4.5 Sub-Entries

-

As from version 1.17, it is possible to specify sub-entries. These may be used to +

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 @@ -7054,70 +8316,70 @@ hierarchical entries and may display all the entries in a flat format. Of the st 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 +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 + id="dx1-30001"> 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 +

Note that the parent entry will automatically be added to the glossary if any of its child entries are used in the document. If the parent entry is not referenced in the document, it will not have a number list. Note also that . Note also that makeindex has a restriction + id="dx1-30005"> has a restriction on the maximum sub-entry depth. -

+

-

Top

4.5.1 Hierarchical Categories

-

To arrange a glossary with hierarchical categories, you need to first define the category +

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-31001"> key. -

+

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

Suppose I want a glossary of mathematical symbols that are divided into Greek + id="x1-31003"> +

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 +

+

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 + id="dx1-31004">. This gives a blank description and suppresses the description terminator. -

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

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}, @@ -7126,41 +8388,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.5.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 + id="dx1-32001"> 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: + id="dx1-32002">. +

Now define the two different meanings of the word:

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

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

Note that if I reference the parent entry, the location will be added to the parent’s number list, whereas if I reference any of the child entries, the location will be added + id="dx1-32004">, 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 or sort=def package + id="dx1-32007"> package options (see §2.4 Sorting Options). You can use the §2.4 Sorting Options). You can use the subentrycounter package option to + id="dx1-32008"> package option to automatically number the first-level child entries. See §2.3 Glossary Appearance +href="#glossaryappearanceoptions">§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 +

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, + id="dx1-32009"> 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 @@ -7217,17 +8479,17 @@ example:  
plural={bravoes},  
parent=bravo}
-

-

+

+

-

Top

4.6 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  \loadglsentries[<type<filename>}
-

+

where <filename> is the name of the file containing all the \newglossaryentry or + id="dx1-33002"> or \longnewglossaryentry commands. The optional argument commands. The optional argument <type> is the name of the glossary to which those entries should belong, for those entries where the type key + id="dx1-33004"> 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 + id="dx1-33006"> uses by default). +

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

+

Example 5 (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}} @@ -7281,14 +8549,14 @@ 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 main.

-

-

____________________________

-

+

____________________________

+

Note: if you use \newacronym (see (see §13 §13 Acronyms) the type is set as type=\acronymtype unless you explicitly override it. For example, if my file @@ -7314,75 +8582,75 @@ class="cmtt-10">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 acronym has been specified, + id="dx1-33012"> has been specified, or will add aca to the glossary type altacronym, if the package option acronym is not + id="dx1-33013"> is not specified.4.3 -

If you have used the 4.1 +

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

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

+

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

Remember that you can use \provideglossaryentry rather than + id="dx1-33023"> rather than \newglossaryentry. Suppose you want to maintain a large database of acronyms or + id="dx1-33024">. 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 @@ -7395,36 +8663,36 @@ class="cmtt-10">terms.tex) contains:

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

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

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.7 Moving Entries to Another Glossary

-

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

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

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

+

where <labeltarget class="cmti-10">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. +

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

If you move an entry to an undefined glossary and you have hyperlinked entries, +

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

-

+

+

-

Top

4.8 Drawbacks With Defining Entries in the Document Environment

-

Originally,

Originally, \newglossaryentry (and (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. -

-

-

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

+

+

Top

4.8.1 Technical Issues

-

+

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

To overcome these problems, as from version 4.0 the Entry information is required when displaying the glossary. If this occur at + the start of the document, the entry details are being looked up before the + entry has been defined. +

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

There are drawbacks to this mechanism: if you modify an entry definition, you +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; if you have very long -entries, you could find unexpected line breaks have been written to the temporary -file. -

The last reason is why EX’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, + id="dx1-36010"> has the preamble-only restriction, which I don’t intend to lift. -

+

-

Top

4.8.2 Good Practice Issues

-

The above section covers technical issues that can cause your document to have +

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

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. +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 + id="dx1-38002">. 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 §7 Adding an Entry to the Glossary Without Generating Text). The number list can be suppressed using the nonumberlist package option, or an alternative counter can be set as the default using + id="dx1-38003"> package option, or an alternative counter can be set as the default using the counter package option. The number list is also referred to as the location + id="dx1-38004"> package option. The number list is also referred to as the location list. -

Both . +

Both makeindex and and xindy concatenate a sequence of 3 or more consecutive pages -into a range. With (Options 2 and 3) concatenate a sequence of 3 or +more consecutive pages into a range. With xindy 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 > 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 + id="dx1-38013"> and has no effect if \noist is used.
-

-

With both is used.

+

+

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

(Options 2 and 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:

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

Note that if you use

Note that if you use xindy, you will also need to set the minimum range length to 1 if -you want to change these suffixes: + id="dx1-38022"> (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 + id="dx1-38024"> 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 \makeglossaries and have no effect if and have no effect if \noist is used.
-

+ id="dx1-38026"> is used.

+

+

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

\glsnumberlistloop  \glsnumberlistloop{<label>}{<handler cs>}{<xr +handler cs>}
+

+where <label> is the entry’s label and <handler cs> is a handler control sequence of +the form: +

<handler cs>{<prefix>}{<counter>}{<format>}{<location>} +
+

+where <prefix> is the hyperref 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: +

<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 Option 1.) +

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

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

and on page 18 I have used + + +

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

then + + +

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

will be equivalent to: + + +

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

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

\glsnoidxdisplayloc  \glsnoidxdisplayloc{<prefix>}{<counter>}{<format>}{<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, you can refer to + id="dx1-39001">, you can refer to that entry in the document using one of the commands listed in this section. The text which appears at that point in the document when using one of these commands is referred to as the link text (even if there are no hyperlinks). The commands in this -section also add a line to an external file that is used by makeindex or xindy to -generate the relevant entry in the glossary. This information includes an associated -location that is added to the (even if there are no hyperlinks). The commands in this +section 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 for that entry. By default, the location refers to +the page number. For further information on number lists, see §5 §5 Number lists. -

It is strongly recommended that you don’t use the commands defined in this +

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

-

The above warning is particularly important if you are using the

+

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

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

-

If you want the

+

If you want the link text to produce a hyperlink to the corresponding entry details + id="dx1-39010"> 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 + id="dx1-39013">, 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

If you use the hyperref package, I strongly recommend you use package, I strongly recommend you use pdflatex rather + id="dx1-39015"> rather than latex to compile your document, if possible. The DVI format of LAT 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 @@ -7792,15 +9247,15 @@ DVI format doesn’t correctly size hyperlinks in subscripts or superscripts This means that if you define a term that may be used as a subscript or superscript, if you use the DVI format, it won’t come out the correct size.
-

-

It may be that you only want terms in a certain glossary to have links, -but not for another glossary. In which case, you can use the package option +

+

It may be that you only want terms in certain glossaries to have links, +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. + id="dx1-39019">. For example, suppose your document contains lots of technical acronyms that the reader might not know, but it also contains some very common acronyms that most readers will recognise. So you might want two acronym @@ -7809,41 +9264,41 @@ technical acronyms can be hyperlinked to that list, but common acronyms shouldn’t have hyperlinks as there’s no target for them. In this case, identify the common acronym list as having non-hyperlinked entries using nohypertypes. + id="dx1-39020">. Example:

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

Alternatively, you can use -

Alternatively, you can use +

\GlsDeclareNoHyperList  \GlsDeclareNoHyperList{<type>}
-

+

For example:

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

Note that no check is performed to see if the glossary types listed in

Note that no check is performed to see if the glossary types listed in nohypertypes or + id="dx1-39022"> or \GlsDeclareNoHyperList have been defined. -

The values must be fully expanded, so

The values must be fully expanded, so don’t try nohypertypes=\acronymtype or -
+
\usepackage[nohypertypes={acronym,common}]{glossaries}
-

is correct, but

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

-

-

You can override the effect of

+

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

The way the

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-39029"> 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 + id="dx1-39030"> or by redefining \glsentryfmt. See . See §6.1 §6.1 Changing the format of the link text for further details. -

Each entry has an associated conditional referred to as the

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

The command: -

The command: +

\glslink  \glslink[<options<text>}
-

+

will place \glstextformat{<<text> will be a hyperlink to the relevant line in the glossary. (Note that this command doesn’t affect the first use flag: use \glsdisp instead.) The optional + id="dx1-39042"> instead.) The optional argument <options

format
This specifies how to format the associated location number for this entry in the glossary. This value is equivalent to the makeindex encap value, and (as with + id="dx1-39045"> encap value, and (as with \index) the value needs to be the name of a command ) 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 \index, the command should be the name of a command which takes an + id="dx1-39048">, 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 @@ -8014,153 +9469,153 @@ class="cmti-10">italic) you will need to create a command that applies bo e.g.  -
+
\newcommand*{\textbfem}[1]{\textbf{\emph{#1}}}
-

and use that command. -

In this document, the standard formats refer to the standard text block +

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 + id="dx1-39050"> or any of the commands listed in table 6.1. -

If you use table 6.1. +

If you use xindy instead of instead of makeindex, you must specify any non-standard formats + id="dx1-39054">, 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 xindy with the above example, you would need to add: + id="dx1-39058"> with the above example, you would need to add:

-
+
\GlsAddXdyAttribute{textbfem}
-

See

See §11 Xindy for further details.

-

-

Note that unlike §11 Xindy (Option 3) for further details.

+

+

Note that unlike \index, you can’t have anything following the command name, + id="dx1-39059">, 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 key when you define the entry or use \glssee (described in (described in §8 +class="cmsy-10">§8 Cross-Referencing Entries). -

If you are using hyperlinks and you want to change the font of the hyperlinked +

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 + id="dx1-39063"> package) as the locations may not refer to a page number. Instead, the glossaries package provides number formats listed in table 6.1. +href="#tab:hyperxx">table 6.1.

-

Table 6.1: Predefined Hyperlinked Location Formats
-
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 hyper<xxemph). If you want to make a new format, you will if you want the location number to be in a bold sans-serif font, you can define a command called, say, \hyperbsf: + id="dx1-39076">:

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

and then use

and then use hyperbsf as the value for the format key. (See also “Displaying + id="dx1-39077"> 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 + id="dx1-39079">, you will need to add this to the list of location attributes:

-
+
\GlsAddXdyAttribute{hyperbsf}
-

+

counter
This specifies which counter to use for this location. This overrides the default counter used by this entry. (See also §5 §5 Number lists.)
hyper
This is a boolean key which can be used to enable/disable the hyperlink to the relevant entry in the glossary. (Note that setting hyper=true will have no effect if \hyperlink has not been defined.) The default value is has not been defined.) The default value is hyper=true, unless the entry belongs to a glossary that either has been listed in the package option nohypertypes or has been identified using or has been identified using \GlsDeclareNoHyperList in which + id="dx1-39084"> in which case the default is hyper=false.
local
This is a boolean key that only makes a different when used with commands that change the entry’s first use flag (such as \gls). If ). If local=true, the change to the first use flag will be localised to the current scope. The default is + id="dx1-39088">first use flag will be localised to the current scope. The default is local=false.
-

There is also a starred version: -

There is also a starred version: +

\glslink*  \glslink*[<options<text>}
-

+

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

Don’t use commands like

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

-

The command: -

+

The command: +

\gls  \gls[<options<insert>]
-

+

is the same as \glslink, except that the link text is determined from the values of the + id="dx1-39092"> is determined from the values of the text and and first keys supplied when the entry was defined using keys supplied when the entry was defined using \newglossaryentry. If + id="dx1-39095">. If the entry has been marked as having been used, the value of the , the value of the text key will be used, + id="dx1-39097"> key will be used, otherwise the value of the first key will be used. On completion, key will be used. On completion, \gls will mark the entry’s first use flag as used. -

There are two upper case variants: +

There are two upper case variants: -

\Gls  \Gls[<options<insert>]
-

+

and -

\GLS  \GLS[<options<insert>]
-

+

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

The final optional argument

The final optional argument <insert>, allows you to insert some additional text @@ -8374,20 +9829,20 @@ class="cmti-10">insert> at the end of the link text, but this can be changed (see §6.1 §6.1 Changing the format of the link text). -

The first optional argument

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

Don’t use commands like

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

-

There are also analogous plural forms: -

+

There are also analogous plural forms: +

\glspl  \glspl[<options<insert>]
-

-

+

\Glspl  \Glspl[<options<insert>]
-

-

+

\GLSpl  \GLSpl[<options<insert>]
-

+

These determine the link text from the plural and and firstplural keys supplied when the + id="dx1-39108"> keys supplied when the entry was first defined. As before, these commands also have a starred version that disable the hyperlink. -

Be careful when you use glossary entries in math mode especially if you are using +

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, + id="dx1-39109"> 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 > optional argument:

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

-

-

Note that

+

+

Note that \glslink doesn’t use or affect the doesn’t use or affect the first use flag, nor does it use \glsentryfmt or the equivalent definition provided by or the equivalent definition provided by \defglsentryfmt (see (see §6.1 +class="cmsy-10">§6.1 Changing the format of the link text). Instead, you can use: -

\glsdisp  \glsdisp[<options<link text>}
-

+

This behaves in the same way as \gls, except that it uses , except that it uses <link text> instead of the value of the first or or text key. (Note that this command always sets key. (Note that this command always sets <insert> to nothing.) This command affects the first use flag, and uses \glsentryfmt or the + id="dx1-39119"> or the equivalent definition provided by \defglsentryfmt. -

The command: -

. +

The command: +

\glstext  \glstext[<options<insert>]
-

+

is similar to \gls except that it always uses the value of the except that it always uses the value of the text key and does not + id="dx1-39123"> key and does not affect the first use flag. Unlike \gls, the inserted text <> is always appended to the link text since \glstext doesn’t use \glsentryfmt or the equivalent definition + id="dx1-39125"> or the equivalent definition provided by \defglsentryfmt. (The same is true for all the following commands + id="dx1-39126">. (The same is true for all the following commands described in the rest of this section.) -

There are also analogous commands: -

There are also analogous commands: +

\Glstext  \Glstext[<options<insert>]
-

-

+

\GLStext  \GLStext[<options<insert>]
-

+

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

The command: -

The command: +

\glsfirst  \glsfirst[<options<insert>]
-

+

is similar to \glstext except that it always uses the value of the first key. Again, + id="dx1-39130"> key. Again, <insert> is always appended to the end of the link text and does not affect the first use flag. -

There are also analogous commands: -

There are also analogous commands: +

\Glsfirst  \Glsfirst[<options<insert>]
-

-

+

\GLSfirst  \GLSfirst[<options<insert>]
-

+

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

The command: +

The command: -

\glsplural  \glsplural[<options<insert>]
-

+

is similar to \glstext except that it always uses the value of the except that it always uses the value of the plural key. Again, + id="dx1-39136"> key. Again, <insert> is always appended to the end of the link text and does not mark the entry as having been used. -

There are also analogous commands: -

There are also analogous commands: +

\Glsplural  \Glsplural[<options<insert>]
-

-

+

\GLSplural  \GLSplural[<options<insert>]
-

+

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

The command: -

The command: +

\glsfirstplural  \glsfirstplural[<optionsinsert>]
-

+

is similar to \glstext except that it always uses the value of the except that it always uses the value of the firstplural key. Again, + id="dx1-39141"> key. Again, <insert> is always appended to the end of the link text and does not mark the entry as having been used. -

There are also analogous commands: -

There are also analogous commands: +

\Glsfirstplural  \Glsfirstplural[<optionsinsert>]
-

-

+

\GLSfirstplural  \GLSfirstplural[<optionsinsert>]
-

+

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

The command: -

The command: +

\glsname  \glsname[<options<insert>]
-

+

is similar to \glstext except that it always uses the value of the except that it always uses the value of the name key. Again, + id="dx1-39146"> key. Again, <insert> is always appended to the end of the link text and does not mark the entry as having been used. -

There are also analogous commands: -

There are also analogous commands: +

\Glsname  \Glsname[<options<insert>]
-

-

+

\GLSname  \GLSname[<options<insert>]
-

+

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

The command: -

The command: +

\glssymbol  \glssymbol[<options<insert>]
-

+

is similar to \glstext except that it always uses the value of the except that it always uses the value of the symbol key. Again, + id="dx1-39151"> key. Again, <insert> is always appended to the end of the link text a as having been used. -

There are also analogous commands: -

There are also analogous commands: +

\Glssymbol  \Glssymbol[<options<insert>]
-

-

+

\GLSsymbol  \GLSsymbol[<options<insert>]
-

+

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

The command: -

The command: +

\glsdesc  \glsdesc[<options<insert>]
-

+

is similar to \glstext except that it always uses the value of the except that it always uses the value of the description key. + id="dx1-39156"> key. Again, <insert> is always appended to the end of the link text and does not mark the entry as having been used. -

There are also analogous commands: -

There are also analogous commands: +

\Glsdesc  \Glsdesc[<options<insert>]
-

-

+

\GLSdesc  \GLSdesc[<options<insert>]
-

+

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

The command: -

The command: +

\glsuseri  \glsuseri[<options<insert>]
-

+

is similar to \glstext except that it always uses the value of the except that it always uses the value of the user1 key. Again, + id="dx1-39161"> key. Again, <insert> is always appended to the end of the link text and does not mark the entry as having been used. -

There are also analogous commands: -

There are also analogous commands: +

\Glsuseri  \Glsuseri[<options<insert>]
-

-

+

\GLSuseri  \GLSuseri[<options<insert>]
-

+

As before, these commands also have a starred version that disable the hyperlink. Similarly for the other user keys: -

\glsuserii  \glsuserii[<options<insert>]
-

-

+

\Glsuserii  \Glsuserii[<options<insert>]
-

-

+

\GLSuserii  \GLSuserii[<options<insert>]
-

-

+

\glsuseriii  \glsuseriii[<options>]
-

-

+

\Glsuseriii  \Glsuseriii[<options<insert>]
-

-

+

\GLSuseriii  \GLSuseriii[<options<insert>]
-

-

+

\glsuseriv  \glsuseriv[<options<insert>]
-

-

+

\Glsuseriv  \Glsuseriv[<options<insert>]
-

-

+

\GLSuseriv  \GLSuseriv[<options<insert>]
-

-

+

\glsuserv  \glsuserv[<options<insert>]
-

-

+

\Glsuserv  \Glsuserv[<options<insert>]
-

-

+

\GLSuserv  \GLSuserv[<options<insert>]
-

-

+

\glsuservi  \glsuservi[<options<insert>]
-

-

+

\Glsuservi  \Glsuservi[<options<insert>]
-

-

+

\GLSuservi  \GLSuservi[<options<insert>]
-

+

-

Top

6.1 Changing the format of the link text

-

The default format of the

The default format of the link text for for \gls, , \glspl and + id="dx1-40004"> and their upper case variants and also for \glsdisp is governed + id="dx1-40005"> is governed by6.1: -

: +

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

\defglsentryfmt  \defglsentryfmt[<type>}
-

+

instead of redefining \glsentryfmt. The optional first argument <type> is the glossary type. This defaults to \glsdefaulttype if omitted. The second argument is + id="dx1-40012"> if omitted. The second argument is the entry format definition. -

Note that

Note that \glsentryfmt is the default display format for entries. Once the display format has been changed for an individual glossary using \defglsentryfmt, + id="dx1-40013">, redefining \glsentryfmt won’t have an effect on that glossary, you must instead us \defglsentryfmt again. Note that glossaries that have been identified as lists of acronyms (via the package option acronymlists or the command + id="dx1-40014"> or the command \DeclareAcronymList, see §2.5 Acronym Options) use , see §2.5 Acronym Options) use \defglsentryfmt to set their display style.
-

-

Within the

+

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

\glscustomtext  \glscustomtext
-

+

This is the custom text supplied in \glsdisp. It’s always empty for \gls, , \glspl and + id="dx1-40019"> and their upper case variants. (You can use etoolbox’s ’s \ifdefempty to determine if \glscustomtext is empty.) -

\glsinsert  \glsinsert
-

+

The custom text supplied in the final optional argument to \gls, \glspl and their upper case variants. -

\glsifplural  \glsifplural{<true text<false text>}
-

+

If \glspl, \Glspl or <false text>. -

\glscapscase  \glscapscase{<no caseall caps>}
-

+

If \gls, \glspl or all caps>. -

Note that you can also use commands such as

Note that you can also use commands such as \ifglsused within the definition of + id="dx1-40024"> within the definition of \glsentryfmt (see §14 §14 Unsetting and Resetting Entry Flags). -

If you only want to make minor modifications to

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 or firstplural keys + id="dx1-40029"> keys (or the custom text) with the insert text appended. -

Alternatively, if want to change the entry format for acronyms (defined via +

Alternatively, if want to change the entry format for acronyms (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-40035"> keys, rather than using the text, , plural, , first and and firstplural keys. The first use singular text is obtained + id="dx1-40039"> 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{<labelinsert>}
-

+

instead of from the firstplural key. In both cases, key. In both cases, <label> is the entry’s label and @@ -9657,19 +11112,19 @@ class="cmti-10">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 + id="dx1-40044">. 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 + id="dx1-40045">. There are also first letter upper case versions: -

\Genacrfullformat  \Genacrfullformat{<label<insert>}
-

+

and -

\Genplacrfullformat  \Genplacrfullformat{<labelinsert>}
-

+

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 + id="dx1-40048"> 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 + id="dx1-40049"> (which is what the predefined acronym styles, such as long-short, do). Otherwise, you only need to redefine + id="dx1-40050">, do). Otherwise, you only need to redefine \genacrfullformat and and \genplacrfullformat to change the behaviour of + id="dx1-40052"> to change the behaviour of \glsgenacfmt. See . See §13 §13 Acronyms for further details on changing the style of acronyms. -

Note that

Note that \glsentryfmt is not used by \glslink or any of the other commands, + id="dx1-40054"> or any of the other commands, such as \glstext.
-

+ id="dx1-40055">.

+

-

+

Example 6 (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 + id="dx1-40058"> 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 \glsentryfmt as follows: + id="dx1-40060"> 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-40062"> 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-40065"> (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.

-

-

____________________________

+

+

____________________________

-

+

Example 7 (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 \gls was used). -

Alternatively, if you expect all the symbols to be set in math mode, you can + id="dx1-40070"> 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 + id="dx1-40071"> key, you need to use a glossary style that displays the symbol, as many of the styles ignore it. -

+

-

Top

6.2 Enabling and disabling hyperlinks to glossary entries

-

If you load the

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

\glsdisablehyper  \glsdisablehyper
-

+

and -

\glsenablehyper  \glsenablehyper
-

+

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

You can disable just the

You can disable just the first use links using the package option hyperfirst=false. + id="dx1-41012">. Note that this option only affects commands that recognise the first use flag, for example \gls, , \glspl and and \glsdisp but not but not \glslink. + id="dx1-41017">. -

+

Example 8 (First Use With Hyperlinked Footnote Description) -

Suppose I want the first use to have a hyperlink to the description in a footnote + id="x1-41019"> +

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

-
+
\usepackage[hyperfirst=false]{glossaries}
-

Now I need to redefine

Now I need to redefine \glsentryfmt (see (see §6.1 §6.1 Changing the format of the link text):

-
+
\renewcommand*{\glsentryfmt}{%  
  \glsgenentryfmt  
  \ifglsused{\glslabel}{}{\footnote{\glsentrydesc{\glslabel}}}%  
}
-

-

Now the first use won’t have hyperlinked text, but will be followed by a +

+

Now the first use won’t have hyperlinked text, but will be followed by a footnote. See the sample file sample-FnDesc.tex for a complete document.

-

-

____________________________

-

Note that the

+

____________________________

+

Note that the hyperfirst option applies to all defined glossaries. It may be that you + id="dx1-41023"> 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 + id="dx1-41025">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 §14 Unsetting and Resetting Entry Flags) so that the hyperfirst option doesn’t get applied. + id="dx1-41027"> option doesn’t get applied. -

+

Example 9 (Suppressing Hyperlinks on First Use Just For Acronyms) -

Suppose I want to suppress the hyperlink on +

Suppose I want to suppress the hyperlink on first use for acronyms but not for entries in the main glossary. I can load the glossaries package using:

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

+

____________________________

+

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 + id="dx1-41031"> and put the hyperlinks (where required) within the definition of \glsentryfmt (see (see §6.1 §6.1 Changing the format of the link text) via \glshyperlink + id="dx1-41033"> (see §9 §9 Using Glossary Terms Without Links). -

+

Example 10 (Only Hyperlink in Text Mode Not Math Mode) -

This is a bit of a contrived example, but suppose, for some reason, I only want + id="x1-41035"> +

This is a bit of a contrived example, but suppose, for some reason, I only want commands like \gls and and \glsdisp to have hyperlinks when used in text mode, but + id="dx1-41037"> to have hyperlinks when used in text mode, but not in math mode. I can do this by disabling all hyperlinks and redefining \glsentryfmt: + id="dx1-41038">:

-
+
\glsdisablehyper  
\renewcommand*{\glsentryfmt}{%  
  \ifmmode @@ -10071,38 +11526,38 @@ class="cmtt-10">\glsentryfmt  \fi  
}
-

To ensure the target exists, the hyperlinks must be enabled again when the glossary +

To ensure the target exists, the hyperlinks must be enabled again when the glossary is displayed:

-
+
\renewcommand{\glossarypreamble}{\glsenablehyper}  
\renewcommand{\glossarypostamble}{\glsdisablehyper}
-

(The redefinition of

(The redefinition of \glossarypostamble is only necessary if the glossary is + id="dx1-41039"> is only necessary if the glossary is displayed at the start of the document instead of at the end.) See the sample file sample-nomathhyper.tex for a complete document.

-

-

____________________________

+

+

____________________________

-

-

+

Top

7. Adding an Entry to the Glossary Without Generating Text

-

It is possible to add a line in the glossary file without generating any text at that +

It is possible to add a line in the glossary file without generating any text at that point in the document using: -

\glsadd  \glsadd[<options<label>}
-

+

This is similar to \glslink, only it doesn’t produce any text (so therefore, there + id="dx1-42002">, only it doesn’t produce any text (so therefore, there is no hyper key available in key available in <options> but all the other options that can be used with \glslink can be passed to 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 + id="dx1-42006"> 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 + id="dx1-42007">) 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. + id="dx1-42009">. In the case of \glsaddall, all entries in the glossary will have the same location in the number list. If you want to use \glsaddall, it’s best to suppress the number list with the nonumberlist package option. (See sections 2.3 and  package option. (See sections 2.3 and 5.)
-

-

There is now a variation of

+

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

+

Example 11 (Dual Entries) -

The example file +

The example file sample-dual.tex makes use of \glsadd to allow for an entry that should appear both in the main glossary and in the list of acronyms. This example sets up the list of acronyms using the acronym package + id="dx1-42014"> package option:

-
+
\usepackage[acronym]{glossaries}
-

A new command is then defined to make it easier to define dual entries: +

A new command is then defined to make it easier to define dual entries:

-
+
\newcommand*{\newdualentry}[5][]{%  
  \newglossaryentry{main-#2}{name={#4},%  
  text={#3\glsadd{#2}},% @@ -10240,11 +11695,11 @@ option:  
  \newacronym{#2}{#3\glsadd{main-#2}}{#4}%  
}
-

This has the following syntax:

+

This has the following syntax:

\newdualentry[<options}
You can then define a new dual entry: -
+
\newdualentry{svm}% label  
  {SVM}% abbreviation  
  {support vector machine}% long form  
  {Statistical pattern recognition technique}% description
-

Now you can reference the acronym with

Now you can reference the acronym with \gls{svm} or you can reference the entry in the main glossary with \gls{main-svm}.

-

-

____________________________

+

+

____________________________

-

-

+

Top

8. Cross-Referencing Entries

-

You must use

You must use \makeglossaries before defining any cross-referenced -entries. If any of the terms that you have cross-referenced don’t appear in the -glossary, check that you have put \makeglossaries before all entry definitions. -
-

-

There are several ways of cross-referencing entries in the glossary: + id="dx1-43001"> (Options 2 or 3) 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 \makeglossaries/\makenoidxglossaries before all entry definitions. +

+

+

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

  1. You can use commands such as You can use commands such as \gls in the entries description. For + id="dx1-43005"> 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 +

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

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

    +

  2. As described in As described in §4 §4 Defining Glossary Entries, you can use the see key when you + id="dx1-43010"> 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 + id="dx1-43011"> 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 §6 Links to Glossary Entries or §7 §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 + id="dx1-43012">, but can be overridden in specific instances using square brackets at the start of the see value. For + id="dx1-43013"> 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 + \newacronym or \newterm 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: + + +

    +
    + \glossaryentry{lemon}{ +  
      name={lemon}, +  
      description={Yellow citrus fruit} +  
    } +  
    \glossaryentry{lime} +  
    { +  
      name={lime}, +  
      description={Green citrus fruit} +  
    } +  
    \glossaryentry{citrus} +  
    { +  
      name={citrus}, +  
      description={Plant in the Rutaceae family}, +  
      see={lemon,lime} +  
    } +
    +

  3. After you have defined the entry, use -

    After you have defined the entry, use +

    \glssee  \glssee[<tag<xr label list>}
    -

    +

    where <xr label list<tag> is \seename.) For + id="dx1-43019">.) For example:

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

    Note that this automatically adds the entry given by

    Note that this automatically adds the entry given by <label> to the glossary @@ -10430,58 +11927,47 @@ class="cmmi-10"><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 + id="dx1-43021">, 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 + id="dx1-43022">number list. In this case, you will need to activate the number list for the given entries using + id="dx1-43024">number list for the given entries using nonumberlist=false. Alternatively, if you just use the . Alternatively, if you just use the see key instead of key instead of \glssee, you + id="dx1-43028">, you can automatically activate the number list using the number list using the seeautonumberlist package + id="dx1-43031"> package option. -

You must use \makeglossaries before the entry definitions containing the see key -and before any instances of \glssee or the entry won’t be automatically added to the -glossary.
-

-

Top

8.1 Customising Cross-reference Text

-

When you use either the

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

\glsseeformat  \glsseeformat[<taglocation>}
-

+

The default definition of \glsseeformat is:
} Note that the location is always ignored.8.1 + id="x1-44003f1"> For example, if you want the tag to appear in bold, you can do:8.2 + id="x1-44006f2">

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

\glsseeitemformat  \glsseeitemformat{<label>}
-

+

This defaults to \glsentrytext{<label>}.8.3 + id="x1-44014f3"> 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 and \glsseelist in the main body of the text, but + id="dx1-44019"> 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 + id="dx1-45001">, 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 + id="dx1-45004">’s \texorpdfstring if you want to use +them in sectioning commands. (This isn’t specific to the glossaries package.) See the glossaries package.) See the hyperref documentation for further details. All -the commands that convert the first letter to upper case aren’t expandable. + id="dx1-45005"> 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.
-

-

+

\glsentryname  \glsentryname{<label>}
-

-

+

\Glsentryname  \Glsentryname{<label>}
-

+

These commands display the name of the glossary entry given by <label>, as specified by the name key. key. \Glsentryname makes the first letter upper case. Neither of these commands check for the existence of <>. The first form \glsentryname is expandable (unless the name contains unexpandable commands). -

\glossentryname  \glossentryname{<label>}
-

+

This is like \glsnamefont{ -

+
\renewcommand*{\glsnamefont}[1]{\textmd{\sffamily #1}}
-

-

+

\Glossentryname  \Glossentryname{<label>}
-

+

This is like \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 text key. 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 @@ -10741,33 +12228,33 @@ commands). The second form is not expandable. Neither checks for the existence o class="cmmi-10"><label>. -

\glsentryplural  \glsentryplural{<label>}
-

-

+

\Glsentryplural  \Glsentryplural{<label>}
-

+

These commands display the subsequent use plural text for the glossary entry given by <label>, as specified by the plural key. key. \Glsentryplural makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of @@ -10775,35 +12262,35 @@ commands). The second form is not expandable. Neither checks for the existence o class="cmmi-10"><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 first key. key. \Glsentryfirst makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of @@ -10811,28 +12298,28 @@ commands). The second form is not expandable. Neither checks for the existence o class="cmmi-10"><label>. -

\glsentryfirstplural  \glsentryfirstplural{<label>}
-

-

+

\Glsentryfirstplural  \Glsentryfirstplural{<label>}
-

+

These commands display the plural form of the first use text for the glossary entry @@ -10841,7 +12328,7 @@ class="cmmi-10"><label>, as specified by the firstplural key. 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 @@ -10849,26 +12336,26 @@ checks for the existence of <label>. -

\glsentrydesc  \glsentrydesc{<label>}
-

-

+

\Glsentrydesc  \Glsentrydesc{<label>}
-

+

These commands display the description for the glossary entry given by <label<label>. -

\glossentrydesc  \glossentrydesc{<label>}
-

+

This is like \glsentrydesc{<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. -

\glsentrydescplural  \glsentrydescplural{<label>}
-

-

+

\Glsentrydescplural  \Glsentrydescplural{<label>}
-

+

These commands display the plural description for the glossary entry given by <<label>. -

\glsentrysymbol  \glsentrysymbol{<label>}
-

-

+

\Glsentrysymbol  \Glsentrysymbol{<label>}
-

+

These commands display the symbol for the glossary entry given by <label<label>. -

\glossentrysymbol  \glossentrysymbol{<label>}
-

+

This is like \glsentrysymbol{<

\Glossentrysymbol  \Glossentrysymbol{<label>}
-

+

This is like \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>. -

\glsentryuseri  \glsentryuseri{<label>}
-

-

+

\Glsentryuseri  \Glsentryuseri{<label>}
-

-

+

\glsentryuserii  \glsentryuserii{<label>}
-

-

+

\Glsentryuserii  \Glsentryuserii{<label>}
-

-

+

\glsentryuseriii  \glsentryuseriii{<label>}
-

-

+

\Glsentryuseriii  \Glsentryuseriii{<label>}
-

-

+

\glsentryuseriv  \glsentryuseriv{<label>}
-

-

+

\Glsentryuseriv  \Glsentryuseriv{<label>}
-

-

+

\glsentryuserv  \glsentryuserv{<label>}
-

-

+

\Glsentryuserv  \Glsentryuserv{<label>}
-

-

+

\glsentryuservi  \glsentryuservi{<label>}
-

-

+

\Glsentryuservi  \Glsentryuservi{<label>}
-

+

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

\glshyperlink  \glshyperlink[<link text<label>}
-

+

This command provides a hyperlink to the glossary entry given by <labelbut does not add any information to the glossary file. The link text is given by \glsentrytext{<label>} by default9.1, + id="x1-45051f1">, but can be overridden using the optional argument. -

If you use

If you use \glshyperlink, you need to ensure that the relevant entry has been added to the glossary using any of the commands described in §6 §6 Links to Glossary Entries or §7 §7 Adding an Entry to the Glossary Without Generating Text otherwise you will end up with an undefined link.
-

-

The next two commands are only available with the

+

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 for the entry given by <label> and require a run of +class="cmmi-10">>. When used with Option 1 a rerun is required to ensure this list is up-to-date, when used with +Options 2 or 3 a run of makeglossaries (or xindy or (or makeindex) followed by one or two runs of LATEX. The first -command, /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, \glsdisplaynumberlist, formats the list using: -

\glsnumlistsep  \glsnumlistsep
-

+

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

\glsnumlistlastsep  \glsnumlistlastsep
-

+

between the final two elements. The defaults are ,␣ and ␣\&␣, respectively. -

\glsdisplaynumberlist is fairly experimental. It only works when the default -counter format is used (that is, when the

\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 format key is set to glsnumberformat). This -command also doesn’t work with key is set to glsnumberformat). This command will only work +with hyperref. If you try using it with that package, -\glsentrynumberlist will be used instead.
-

-

For further information see “Displaying entry details without adding information + id="dx1-45070"> 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 (glossaries-code.pdf).

-

-

+

Top

10. Displaying a glossary

-

The command -

+Option 1:
+

\printnoidxglossaries  \printnoidxglossaries
+

+ (Must be used with \makenoidxglossaries in the preamble.) +

+Options 2 and 3:
+

\printglossaries  \printglossaries
-

-will display all the glossaries in the order in which they were defined. Note that no -glossaries will appear until you have either used the Perl script

+ (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 2 and 3, no glossaries will appear until you +have either used the Perl script makeglossaries or -have directly used or have directly used makeindex or or +xindy (as described in (as described in §1.3 Generating the -Associated Glossary Files). If the glossary still does not appear after you -re-LATEX your document, check the §1.3 Generating the Associated Glossary Files). If the +glossary still does not appear after you re-LATEX your document, check the +makeindex//xindy log files to see if there is a -problem. Remember that you also need to use the command \makeglossaries in the -preamble to enable the glossaries. -

An individual glossary can be displayed using: -

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

+Option 1:
+

\printnoidxglossary  \printnoidxglossary[<options>]
+

+ (Must be used with \makenoidxglossaries in the preamble.) +

+Options 2 and 3:
+

\printglossary  \printglossary[<options>]
-

-where

+ (Must be used with \makeglossaries in the preamble.)

+

where <options> is a

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

+

title
This is the glossary’s title (overriding the title specified when the glossary was defined).
toctitle
This is the title to use for the table of contents (if the toc package option has + id="dx1-46024"> 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-46025"> is used.
style
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-46028">.
numberedsection
This specifies whether to use a numbered section for this glossary, overriding the effect of the numberedsection package option. This key has the + id="dx1-46030"> package option. This key has the same syntax as the numberedsection package option, described in §2.2 Sectioning, + id="dx1-46031"> package option, described in §2.2 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. If no value is supplied, true is assumed. -
-

By default, the glossary is started either by

+printnoidxglossarysort
This key is only available for Option 1. Possible values are: + word (word order), letter (letter order), standard (word or letter ordering + taken from the order package option), use (order of use), def (order of + definition) nocase (case-insensitive) or case (case-sensitive). +

The word and letter order sort methods use datatool’s \dtlwordindexcompare + and \dtlletterindexcompare handlers. The case-insensitive sort method uses + datatool’s \dtlicompare handler. The case-sensitive sort method uses + datatool’s \dtlcompare handler. See the datatool documentation for further + details. +

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 + sanitizesort=true package option or make sure none of the entries have fragile + commands in their sort field.

+ + +

By default, the glossary is started either by \chapter* or by or by \section*, depending on + id="dx1-46046">, 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 + id="dx1-46048"> package option or the \setglossarysection command. Numbered sectional units can be obtained using the + id="dx1-46049"> command. Numbered sectional units can be obtained using the numberedsection package option. Each glossary sets the page header via the + id="dx1-46050"> 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 \glsglossarymark. Further information about these options and + id="dx1-46053">. 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 +href="#sectioningheadingsandtocoptions">§2.2 Sectioning, Headings and TOC Options. +

Information can be added to the start of the glossary (after the title and before the main body of the glossary) by redefining -

\glossarypreamble  \glossarypreamble
-

+

For example:

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

This needs to be done before the glossary is displayed using -\printglossaries or \printglossary. -

If you want a different preamble per glossary you can use -

This needs to be done before the glossary is displayed. +

If you want a different preamble per glossary you can use +

\setglossarypreamble  \setglossarypreamble[<typepreamble text>}
-

+

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 +

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

There is an analogous command to \glossarypreamble called -

\glossarypostamble  \glossarypostamble
-

+

which is placed at the end of each glossary. -

+

Example 12 (Switch to Two Column Mode for Glossary) -

Suppose you are using the +

Suppose you are using the superheaderborder + id="dx1-46059"> style10.1, + id="x1-46060f1">, 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}% @@ -11559,138 +13181,138 @@ switch back to one column mode, you could do:  
}  
\renewcommand*{\glossarypostamble}{\onecolumn}
-

+

-

-

____________________________

-

Within each glossary, each entry name is formatted according to -

+

____________________________

+

Within each glossary, each entry name is formatted according to +

\glsnamefont  \glsnamefont{<name>}
-

+

which takes one argument: the entry name. This command is always used regardless of the glossary style. By default, \glsnamefont simply displays its argument in whatever the surrounding font happens to be. This means that in the list-like glossary styles (defined in the glossary-list style file) the name will appear in bold, since the name is + id="dx1-46065"> 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. + id="dx1-46067"> style files) the name will appear in the normal font. The hierarchical glossary styles (defined in the glossary-tree style file) also set the + id="dx1-46068"> style file) also set the name in bold. -

+

Example 13 (Changing the Font Used to Display Entry Names in the Glossary) -

Suppose you want all the entry names to appear in medium weight small caps in + id="x1-46070"> +

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

-

If you want to use Xindy (Option 3) +

If you want to use xindy to sort the glossary, you must use the package option + id="dx1-47002"> to sort the glossary, you must use the package option xindy: + id="dx1-47003">:

-
+
\usepackage[xindy]{glossaries}
-

This ensures that the glossary information is written in

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

syntax. +

§1.3 §1.3 Generating the Associated Glossary Files covers how to use the external indexing application. This section covers the commands provided by the glossaries package that allow you to adjust the xindy style file ( style file (.xdy) and parameters. -

To assist writing information to the ) and parameters. +

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

\glsopenbrace  \glsopenbrace
-

-

+

\glsclosebrace  \glsclosebrace
-

+

which produce an open and closing brace. (This is needed because \{ and \} don’t expand to a simple brace character when written to a file.) -

In addition, if you are using a package that makes the double quote character +

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

) you can use: +

\glsquote  \glsquote{<text>}
-

+

which will produce "<\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 + id="dx1-47017"> style file than is available through the LATEX commands provided by the glossaries package, you will need to edit the xindy + id="dx1-47019"> style file. In which case, you must use \noist to prevent the style file from being + id="dx1-47020"> to prevent the style file from being overwritten by the glossaries package. For additional information about xindy, read + id="dx1-47022">, 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 + id="dx1-47026"> style files. If you need help, I recommend you ask on the xindy mailing list + id="dx1-47028"> 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 + id="dx1-48002">, 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 + id="dx1-48004"> style file that defines the relevant alphabet and sort rules). If you use makeglossaries, this information is obtained from the + id="dx1-48006">, this information is obtained from the document’s auxiliary (.aux) file. The ) file. The makeglossaries script attempts to find the root + id="dx1-48009"> script attempts to find the root language given your document settings, but in the event that it gets it wrong or if xindy doesn’t support that language, then you can specify the required language + id="dx1-48011"> doesn’t support that language, then you can specify the required language using: -

\GlsSetXdyLanguage  \GlsSetXdyLanguage[<glossary typelanguage>}
-

+

where <glossary type>. -

If the

If the inputenc package is used, the encoding will be obtained from the + id="dx1-48013"> package is used, the encoding will be obtained from the value of \inputencodingname. Alternatively, you can specify the encoding + id="dx1-48014">. 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=<}. 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, + id="dx1-48017"> 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 to prevent the style file from being overwritten). +

The commands \GlsSetXdyLanguage and \GlsSetXdyCodePage have no effect if you don’t use makeglossaries. If you call . If you call xindy without without makeglossaries you need + id="dx1-48024"> 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 , the glossaries package needs to know which counters you will be using in the number list in order to correctly format the in order to correctly format the xindy style file. Counters specified + id="dx1-49005"> style file. Counters specified using the counter package option or the package option or the <counter> option of \newglossary are + id="dx1-49007"> are automatically taken care of, but if you plan to use a different counter in the counter + id="dx1-49008"> key for commands like \glslink, then you need to identify these counters , then you need to identify these counters 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 ( key (textrm, , hyperrm etc) are + id="dx1-49014"> etc) are automatically added to the xindy style file, but if you want to use another attribute, + id="dx1-49016"> 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. + id="dx1-49018"> key. -

+

Example 14 (Custom Font for Displaying a Location) -

Suppose I want a bold, italic, hyperlinked location. I first need to define a + id="x1-49020"> +

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: + id="dx1-49022">, 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: + id="dx1-49023">:

-
+
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 + id="dx1-49024"> is used or if \makeglossaries is omitted. is omitted. \GlsAddXdyAttribute must be used before \makeglossaries. Additionally, . Additionally, \GlsAddXdyCounters must come before \GlsAddXdyAttribute.
-

-

If the location numbers don’t get expanded to a simple Arabic or Roman number +

+

If the location numbers don’t get expanded to a simple Arabic or Roman number or a letter from a, …, z or A, …, Z, then you need to add a location style in the appropriate format using -

\GlsAddXdyLocation  \GlsAddXdyLocation[<prefix-locationdefinition>}
-

+

where <name<definition> is the xindy definition. The optional argument definition. The optional argument <prefix-location> is needed if @@ -12055,114 +13677,114 @@ class="cmtt-10">\the<counter>. -

Note that

Note that \GlsAddXdyLocation has no effect if \noist is used or if + id="dx1-49030"> is used or if \makeglossaries is omitted. is omitted. \GlsAddXdyLocation must be used before \makeglossaries.
-

+ id="dx1-49032">.

+

-

+

Example 15 (Custom Numbering System for Locations) -

Suppose I decide to use a somewhat eccentric numbering system for sections where + id="x1-49034"> +

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

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 + id="dx1-49035"> 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 + id="dx1-49036"> 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 16 (Locations as Words not Digits) -

Suppose I want the page numbers written as words rather than digits and I use + id="x1-49038"> +

Suppose I want the page numbers written as words rather than digits and I use the fmtcount package to do this. I can redefine package to do this. I can redefine \thepage as follows: + id="dx1-49040"> as follows:

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

This gets expanded to

This gets expanded to \protect \Numberstringnum  -

+
\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space  
  \string\Numberstringnum\space\glsopenbrace"  
  "arabic-numbers" :sep "\glsclosebrace"}
-

Note that it’s necessary to use

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 + id="dx1-49042"> doesn’t ignore spaces after control sequences. -

Note that

Note that \GlsAddXdyLocation{<namedefinition>} will define commands in the form: -

\glsX<counter<location>}
-

+

for each counter that has been identified either by the counter package option, the + id="dx1-49043"> package option, the <counter> option for \newglossary or in the argument of or in the argument of \GlsAddXdyCounters. -

The first argument . +

The first argument <Hprefix> is only relevant when used with the hyperref + id="dx1-49046"> package and indicates that \the<<counter>. The sample file samplexdy.tex, which comes with the glossaries package, uses the default page counter for locations, and it uses the default counter for locations, and it uses the default \glsnumberformat and a + id="dx1-49048"> and a custom \hyperbfit format. A new xindy location called 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 @@ -12281,7 +13903,7 @@ class="cmmi-10">> commands:

-
+
\renewcommand{\glsXpageXglsnumberformat}[2]{%  
 \linkpagenumber#2%  
} @@ -12290,15 +13912,15 @@ class="cmmi-10">> commands:  
}  
\newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}}
-

+

-

-

____________________________

-

In the

+

____________________________

+

In the number list, the locations are sorted according to type. The default ordering is: + id="dx1-49052">, 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 hyphen11.1), + id="x1-49053f1">), alpha-page-numbers (e.g. a), Roman-page-numbers (e.g. I), @@ -12316,30 +13938,30 @@ class="cmtt-10">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.2), + id="x1-49055f2">), user defined location names (as specified by \GlsAddXdyLocation in the order in + id="dx1-49057"> in the order in which they were defined), see (cross-referenced entries). This ordering can be changed using: -

\GlsSetXdyLocationClassOrder  -

+

\GlsSetXdyLocationClassOrder{<location names>}
-

+

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

-
+
\GlsSetXdyLocationClassOrder{  
  "arabic-page-numbers"  
  "arabic-section-numbers" @@ -12351,126 +13973,126 @@ space. For example:  
  "see"  
}
-

-

Note that

+

Note that \GlsSetXdyLocationClassOrder has no effect if \noist is used or if + id="dx1-49059"> is used or if \makeglossaries is omitted. is omitted. \GlsSetXdyLocationClassOrder must be used before \makeglossaries.
-

-

If a .

+

+

If a number list consists of a sequence of consecutive numbers, the range will be + id="dx1-49063"> 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

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 + id="dx1-49066"> manual for further details on range formations. -

Note that

Note that \GlsSetXdyMinRangeLength has no effect if \noist is used or if + id="dx1-49067"> is used or if \makeglossaries is omitted. is omitted. \GlsSetXdyMinRangeLength must be used before \makeglossaries.
-

-

See .

+

+

See §5 §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 +

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

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

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 + id="dx1-50003"> is used or if \makeglossaries is omitted. is omitted. \GlsSetXdyFirstLetterAfterDigits must be used before \makeglossaries. + id="dx1-50005">.
-

+

-

-

+

Top

12. Defining New Glossaries

-

A new glossary can be defined using: -

A new glossary can be defined using: +

\newglossary  \newglossary[<log-ext<counter>]
-

+

where <name<counter> specifies which counter to use for the associated number -lists (see also 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 or (Option 2) or xindy transcript file (this information is only + id="dx1-51007"> (Option 3) transcript file (this information is only used by makeglossaries which picks up the information from the auxiliary -file). -

The glossary label which picks up the information from the auxiliary file). If +you use Option 1, the <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 a, …, z and A, -…, Z).
-

-

You can also use: -

+

+

You can also use: +

\altnewglossary  \altnewglossary{<namecounter>]
-

+

This is equivalent to

>]
-

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). + id="dx1-51013"> package option is used). Using the acronym package option is equivalent to: + id="dx1-51014"> 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 + id="dx1-51015"> option has been used, you can identify the list of acronyms by the command \acronymtype \acronymtype which is set to acronym, if the acronym option has been + id="dx1-51017"> 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 package option creates a new glossary with the label symbols using:

-
+
\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
-

and the

The numbers package option creates a new glossary with the label package option creates a new glossary with the label numbers using:

-
+
\newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
-

-

All glossaries must be defined before

The index package option creates a new glossary with the label index using: + + +

+
+\newglossary[ilg]{index}{ind}{idx}{\indexname} +
+

+

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.2.1 §1.2.1 Changing the Fixed Names if you want to redefine \glossaryname, especially if you are using babel or or translator. (Similarly for . (Similarly for \glssymbolsgroupname and \glsnumbersgroupname.)

-

+class="cmtt-10">\glsnumbersgroupname.) If you want to redefine \indexname, just follow the +advice in How to change LaTeX’s “fixed names”.

+

-

-

+

Top

13. Acronyms

-

You may have noticed in

You may have noticed in §4 §4 Defining Glossary Entries that when you specify a new entry, you can specify alternate text to use when the term is first used in the document. This provides a useful means to define acronyms. For convenience, the glossaries package defines the command: -

\newacronym  \newacronym[<key-val listlong>}
-

-

This uses

+

This uses \newglossaryentry to create an entry with the given label in the + id="dx1-52003"> to create an entry with the given label in the glossary given by \acronymtype. You can specify a different glossary using the . You can specify a different glossary using the type + id="dx1-52005"> key within the optional argument. The \newacronym command also uses the long, + id="dx1-52006">, longplural, , short and and shortplural keys in 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 +

If you haven’t identified the specified glossary type as a list of acronyms (via the package option acronymlists or the command or the command \DeclareAcronymList, see §2.5 Acronym + id="dx1-52011">, see §2.5 Acronym Options) \newacronym will add it to the list and reset the display style for that glossary via \defglsentryfmt. If you have a mixture of acronyms and regular entries + id="dx1-52012">. 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 (not redefine \glsentryfmt) before defining your entries. + id="dx1-52014">) 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, + id="dx1-52015"> (when used with one of the styles that require a description, described in §13.1 §13.1 Changing the Acronym Style) or you can override plural forms of <<long> using the shortplural or or longplural keys. For + id="dx1-52017"> 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 longplural or or shortplural keys, I recommend you use + id="dx1-52020"> keys, I recommend you use \setacronymstyle to set the display style rather than using one of the pre-version + id="dx1-52021"> to set the display style rather than using one of the pre-version 4.02 acronym styles. -

Since

Since \newacronym uses uses \newglossaryentry, you can use commands like , you can use commands like \gls + id="dx1-52024"> and \glsreset as with any other glossary entry. -

Since as with any other glossary entry. +

Since \newacronym sets type=\acronymtype, if you want to load a file containing acronym definitions using \loadglsentries[<type> will not have an effect unless you explicitly se type=\glsdefaulttype in the optional argument to \newacronym. See . See §4.6 §4.6 Loading Entries From a File.
-

+

-

+

Example 17 (Defining an Acronym) -

The following defines the acronym IDN: + id="x1-52029"> +

The following defines the acronym IDN:

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

\gls{idn} will produce “identification number (IDN)” on first use and “IDN” on subsequent uses. If you want to use one of the smallcaps acronym styles, described in §13.1 §13.1 Changing the Acronym 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 (idn)” on first use and “in” on subsequent uses.

-

-

____________________________

-

There are commands similar to

+

____________________________

+

There are commands similar to \glstext (described in (described in §6 §6 Links to Glossary Entries) that allow you to access just the short form, just the long form or the full form, without affecting the first use flag. (Note that the full form isn’t necessarily the same as the text produced on first use.) -

Although these commands are similar to commands such as

Although these commands are similar to commands such as \glstext, they + id="dx1-52035">, they behave more like \glsdisp (except for the first use behaviour) in that the + id="dx1-52036"> (except for the first use behaviour) in that the display is governed by \defentryfmt with with \glscustomtext set as appropriate. + id="dx1-52039"> set as appropriate.
-

-

+

\acrshort  \acrshort[<options<insert>]
-

+

This displays the short form (within the argument of \acronymfont) for the entry + id="dx1-52041">) for the entry given by <label>. The optional arguments are the same as those for \glstext. There + id="dx1-52042">. There is also a starred version to suppress the hyperlink. There are also analogous upper case variants: -

\Acrshort  \Acrshort[<options<insert>]
-

-

+

\ACRshort  \ACRshort[<options<insert>]
-

+

There are also plural versions: -

\acrshortpl  \acrshortpl[<options<insert>]
-

-

+

\Acrshortpl  \Acrshortpl[<options<insert>]
-

-

+

\ACRshortpl  \ACRshortpl[<options<insert>]
-

-

Similarly for the long form: -

+

Similarly for the long form: +

\acrlong  \acrlong[<options>]
-

+

This displays the long form for the entry given by <label>. The optional arguments are the same as before. There is also a starred version to suppress the hyperlink. There are also analogous upper case variants: -

\Acrlong  \Acrlong[<options<insert>]
-

-

+

\ACRlong  \ACRlong[<options<insert>]
-

+

Again there are also plural versions: -

\acrlongpl  \acrlongpl[<options<insert>]
-

-

+

\Acrlongpl  \Acrlongpl[<options<insert>]
-

-

+

\ACRlongpl  \ACRlongpl[<options<insert>]
-

-

And for the full form: -

+

And for the full form: +

\acrfull  \acrfull[<options<insert>]
-

+

This defaults to <long> (\acronymfont{<short>}). The format (including hyperlinks) can be modified by redefining: -

\acrfullfmt  \acrfullfmt{<options<insert>}
-

-

There are also analogous upper case variants: -

+

There are also analogous upper case variants: +

\Acrfull  \Acrfull[<options<insert>]
-

-

+

\ACRfull  \ACRfull[<options<insert>]
-

+

The formats (including hyperlinks) can be modified by redefining: -

\Acrfullfmt  \Acrfullfmt{<options<insert>}
-

-

+

\ACRfullfmt  \ACRfullfmt{<options<insert>}
-

-

As before there are also plural versions: -

+

As before there are also plural versions: +

\acrfullpl  \acrfullpl[<options<insert>]
-

-

+

\Acrfullpl  \Acrfullpl[<options>]
-

-

+

\ACRfullpl  \ACRfullpl[<options<insert>]
-

+

The formats (including hyperlinks) can be modified by redefining: -

\acrfullplfmt  \acrfullplfmt{<optionsinsert>}
-

-

+

\Acrfullplfmt  \Acrfullplfmt{<optionsinsert>}
-

-

+

\ACRfullplfmt  \ACRfullplfmt{<optionsinsert>}
-

-

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 + id="dx1-52067"> package option to activate the shorter command names listed in table 13.1. +href="#tab:shortcuts">table 13.1.

-

Table 13.1: Synonyms provided by the package option shortcuts
-
shortcuts +
+ id="dx1-52070"> + id="dx1-52072"> + id="dx1-52074"> + id="dx1-52076"> + id="dx1-52078"> + id="dx1-52080"> + id="dx1-52082"> + id="dx1-52084"> + id="dx1-52086"> + id="dx1-52088"> + id="dx1-52090"> + id="dx1-52092"> + id="dx1-52094"> + id="dx1-52096"> + id="dx1-52098">
Shortcut Command Shortcut Command Equivalent Command
\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-52100">
-

It is also possible to access the long and short forms without adding information 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 §9 Using Glossary Terms Without Links). -

The commands that convert the first letter to upper case come with the same +

The commands that convert the first letter to upper case come with the same caveats as those for analogous commands like \Glsentrytext (non-expandable, + id="dx1-52102"> (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 §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,

+

And the full form, <long> (<short>), can be obtained using: -

\glsentryfull  \glsentryfull{<label>}
-

-

+

\Glsentryfull  \Glsentryfull{<label>}
-

-

+

\glsentryfullpl  \glsentryfullpl{<label>}
-

-

+

\Glsentryfullpl  \Glsentryfullpl{<label>}
-

+

(These may be redefined by the acronym style.)

-

Top

13.1 Changing the Acronym Style

-

It may be that the default style doesn’t suit your requirements in which case you can +

It may be that the default style doesn’t suit your requirements in which case you can switch to another styles via -

\setacronymstyle  \setacronymstyle{<style name>}
-

+

where <style name> is the name of the required style. -

You must use

You must use \setacronymstyle before you define the acronyms with \setacronymstyle after using \DeclareAcronymList.
-

-

Note that unlike the default behaviour of

+

Note that unlike the default behaviour of \newacronym, the styles used via \setacronymstyle don’t use the first or or text keys, but instead they use + id="dx1-53003"> keys, but instead they use \defglsentryfmt to set a custom format that uses the to set a custom format that uses the long and and short keys (or their + id="dx1-53006"> 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 + id="dx1-53007"> 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 -

key is set to +

\acronymentry  \acronymentry{<label>}
-

+

and the sort key is set to -

key is set to +

\acronymsort  \acronymsort{<short<long>}
-

+

These commands are redefined by the acronym styles. However, you can redefine them again after the style has been set but before you use \newacronym. Protected expansion is performed on \acronymsort when the entry is defined. -

+

-

Top

13.1.1 Predefined Acronym Styles

-

The

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 \firstacronymfont is only set once by the package when it’s loaded. By default + id="dx1-54003"> is only set once by the package when it’s loaded. By default \firstacronymfont{<text>} is the same as \acronymfont{<text>}. If you want the short form displayed differently on first use, you can redefine \firstacronymfont + id="dx1-54006"> independently of the acronym style. -

The predefined styles that contain

The predefined styles that contain sc in their name (for example long-sc-short) + id="dx1-54007">) redefine \acronymfont to use \textsc (so the short form needs to be specified in + id="dx1-54008"> (so the short form needs to be specified in lower case). -

-

Some fonts don’t support bold smallcaps, so you may need to redefine +

Some fonts don’t support bold smallcaps, so you may need to redefine \glsnamefont (see (see §10 §10 Displaying a glossary) to switch to medium weight if you are using a glossary style that displays entry names in bold and you have chosen an acronym style that uses \textsc.
-

-

The predefined styles that contain .

+

+

The predefined styles that contain sm in their name (for example long-sm-short) + id="dx1-54011">) 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 . If you use one of the acronym styles that set \acronymfont to + id="dx1-54014"> to \textsmaller you must explicitly load the relsize package or otherwise define + id="dx1-54015"> package or otherwise define \textsmaller.
-

-

The remaining predefined styles redefine

+

The remaining predefined styles redefine \acronymfont{<text<text>. -

In most cases, the predefined styles adjust

In most cases, the predefined styles adjust \acrfull and and \glsentryfull (and + id="dx1-54017"> (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 styles (and their variants).

+

+

The following styles are supplied by the glossaries package:

  • long-short, , long-sc-short, , long-sm-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{<} is set to just the short form (enclosed in \acronymfont) and the description key is set to the long + id="dx1-54025"> key is set to the long form.

  • short-long, , sc-short-long, , sm-short-long: -

    These three styles are analogous to the above three styles, except the display + id="dx1-54028">: +

    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 and \acronymentry are the same as for the + id="dx1-54031"> are the same as for the <long>) styles above, so the acronyms are still sorted

  • long-short-desc, , long-sc-short-desc, , long-sm-short-desc: -

    These are like the : +

    These are like the long-short, , long-sc-short and and long-sm-short styles described + id="dx1-54037"> styles described above, except that the description key must be supplied in the optional + id="dx1-54038"> key must be supplied in the optional argument of \newacronym. They also redefine . They also redefine \acronymentry to to {<longshort>}) and redefine \acronymsort{<short>. This means that the acronyms are sorted accordi 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 + id="dx1-54042"> with these acronym styles to allow for the long name field.

  • short-long-desc, , sc-short-long-desc, , sm-short-long-desc: -

    These styles are analogous to the above three styles, but the first use display + id="dx1-54045">: +

    These styles are analogous to the above three styles, but the first use display style is: -

    \firstacronymfont{<short<long>)
    -

    +

    The definitions of \acronymsort and \acronymentry are the same as those for long-short-desc etc. + id="dx1-54046"> etc.

  • dua, , dua-desc: -

    These styles always display (via : +

    These styles always display (via \gls) the long form regardless of whether the + id="dx1-54049">) the long form regardless of whether the entry has been used or not. However, \acrfull and and \glsentryfull will display + id="dx1-54051"> will display <longshort>}). In the case of dua, the , the name and and sort + id="dx1-54054"> 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 and sort keys are set to the + id="dx1-54057"> keys are set to the long form and the description is supplied in the optional argument of \newacronym. + id="dx1-54058">.

  • footnote, , footnote-sc, , footnote-sm: -

    These three styles set the first use display to: -

    : +

    These three styles set the first use display to: +

    \firstacronymfont{<short>}\footnote{<long>}
    -

    +

    However, \acrfull and and \glsentryfull are set to are set to \acronymfont{<short<long>). (And similarly for plural and upper case forms.) On subsequent use the display is: -

    \acronymfont{<short>}
    -

    +

    The sort and and name keys are set to the short form, and the keys are set to the short form, and the description is set to the + id="dx1-54067"> is set to the long form. -

    In order to avoid nested hyperlinks on

    In order to avoid nested hyperlinks on first use the footnote styles automatically implement hyperfirst=false.
    -

    + id="dx1-54069">.

    +

  • footnote-desc, , footnote-sc-desc, , footnote-sm-desc: -

    These three styles are similar to the previous three styles, but the description + id="dx1-54072">: +

    These three styles are similar to the previous three styles, but the description has to be supplied in the optional argument of \newacronym. The . The name key is + id="dx1-54074"> key is set to the long form followed by the short form in parentheses and the sort key is + id="dx1-54075"> 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 + id="dx1-54076"> will typically be quite wide it’s best to choose a glossary style that can accommodate this, such as altlist. + id="dx1-54077">.

-

+

Example 18 (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 style, but I want the name + id="dx1-54081"> 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 + id="dx1-54083"> style:

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

and then redefine

and then redefine \acronymsort and and \acronymentry: + id="dx1-54085">:

-
+
\renewcommand*{\acronymsort}[2]{#1}% sort by short form  
\renewcommand*{\acronymentry}[1]{%  
  \acronymfont{\glsentryshort{#1}}\space (\glsentrylong{#1})}%
-

(I’ve used

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

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 + id="dx1-54086"> 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  \newacronymstyle{<style namedefinitions>}
-

+

where <style namedisplay>, is equivalent to the mandatory argument of \defglsentryfmt. You can simply use . You can simply use \glsgenacfmt or you can customize the + id="dx1-55003"> or you can customize the display using commands like \ifglsused, , \glsifplural and and \glscapscase. (See . (See §6.1 +class="cmsy-10">§6.1 Changing the format of the link text for further details.) If the style is likely to be used with a mixed glossary (that is entries in that glossary are defined both with \newacronym and and \newglossaryentry) then you can test if the entry is an acronym + id="dx1-55008">) 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 + id="dx1-55010"> if it isn’t. For example, the long-short style sets style sets <display> as

-
+
\ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
-

(You can use

(You can use \ifglshasshort instead of instead of \ifglshaslong to test if the entry is an + id="dx1-55013"> to test if the entry is an acronym if you prefer.) -

The third argument,

The third argument, <definitions>, can be used to redefine the commands that affect the display style, such as \acronymfont or, if or, if <display> uses \glsgenacfmt, \genacrfullformat and its variants. -

Note that and its variants. +

Note that \setacronymstyle redefines redefines \glsentryfull and and \acrfullfmt to use + id="dx1-55018"> to use \genacrfullformat (and similarly for the plural and upper case variants). If this + id="dx1-55019"> (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 and dua) + id="dx1-55021">) \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 + id="dx1-55023">. You can use the following token registers to access the entry label, long form and short form: \glslabeltok \glslabeltok, \glslongtok \glslongtok and \glsshorttok \glsshorttok. As with all TEX registers, you can access their values by preceding the register with \the. For example, the . For example, the long-short style does: + id="dx1-55028"> style does:

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

which sets the

which sets the description field to the long form of the acronym whereas the + id="dx1-55029"> field to the long form of the acronym whereas the long-short-desc style does: + id="dx1-55030"> 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 +

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>. Within class="cmmi-10"><definitions> you can use -

\GlsUseAcrStyleDefs  \GlsUseAcrStyleDefs{<style name>}
-

+

to use the <definitionsstyle 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 + id="dx1-55034"> style with minor modifications (remember to use ## instead of # within >):

-
+
\newacronymstyle{long-sc-short}%  
{% use the same display as "long-short"  
  \GlsUseAcrEntryDispStyle{long-short}% @@ -14544,18 +16193,18 @@ class="cmmi-10">>):  
  \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%  
}
-

(

(\glstextup \glstextup is used to cancel the effect of \textsc. This defaults to + id="dx1-55036">. This defaults to \textulc, if defined, otherwise , if defined, otherwise \textup. For example, the plural of . For example, the plural of svvms.) -

+

Example 19 (Defining a Custom Acronym Style) -

Suppose I want my acronym on +

Suppose I want my acronym on first use to have the short form in the text and the long form with the description in a footnote. Suppose also that I want the short form to be put in small caps in the main body of the document, but I @@ -14585,13 +16234,13 @@ 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 on first use to display:
\textsc{<abbrv} on subsequent use:
\textsc{<abbrv<description>
-

Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the +

Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the second argument of \newacronymstyle using: + id="dx1-55046"> using:

-
+
\ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
-

This will use

This will use \glsgenentryfmt if the entry isn’t an acronym, otherwise it will use + id="dx1-55047"> if the entry isn’t an acronym, otherwise it will use \glsgenacfmt. The third argument (. The third argument (<definitions>) of \newacronymstyle needs to + id="dx1-55049"> needs to redefine \genacrfullformat etc so that the 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 #):

-
+
 % No case change, singular first use:  
  \renewcommand*{\genacrfullformat}[2]{%  
   \firstacronymfont{\glsentryshort{##1}}##2% @@ -14683,12 +16332,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 +

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% @@ -14702,21 +16351,21 @@ 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 and \Glsentrylongpl in the footnote + id="dx1-55053"> in the footnote instead of \glsentrylong and and \glsentrylongpl. -

Now let’s suppose that commands such as . +

Now let’s suppose that commands such as \glsentryfull and and \acrfull shouldn’t + id="dx1-55057"> shouldn’t use a footnote, but instead use the format: <long>). This means that the style needs to redefine \glsentryfull, \acrfullfmt and their plural and upper case + id="dx1-55058"> 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}})% @@ -14751,11 +16400,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 @@ -14797,105 +16446,105 @@ variants.  
    }%  
  }%
-

(This may cause problems with long hyperlinks, in which case adjust the +

(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 + id="dx1-55060"> 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 + id="dx1-55061"> 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 +

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 + id="dx1-55062"> 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 instead of \glsentrylong to capitalise the name in the + id="dx1-55064"> 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 + id="dx1-55065"> to just the long form and redefine \GenericAcronymFields to set the to set the symbol key to the short form and use a + id="dx1-55067"> key to the short form and use a glossary style that displays the symbol in parentheses after the name (such as the (such as the tree + id="dx1-55069"> 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 + id="dx1-55070"> 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}% @@ -14985,30 +16634,30 @@ 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: + id="dx1-55071">:

-
+
\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} @@ -15016,84 +16665,136 @@ 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.

-

-

____________________________

-

+

+

____________________________

+

-

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

+Option 1:
+
+ \printnoidxglossary[type=\acronymtype] +
+
+
Options 2 and 3:
+
+ \printglossary[type=\acronymtype] + +
-
or with all the other glossaries using \printglossaries. (If you use the +

(If you use the acronym -package option you can also use

-
- package option you can also use

+
+ \printacronyms[<options>]
-
as a synonym for
-
- as a synonym for
+
+ \printglossary[type=\acronymtype,<options>] - -
-
See §2.5 Acronym Options.) -

However, care must be taken to choose a glossary style that’s appropriate to your +

See §2.5 Acronym Options.) +
+

Alternatively the list of acronyms can be displayed with all the other glossaries +using: +

+Option 1:
\printnoidxglossaries +
+Options 2 and 3:
\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 §15.2 §15.2 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 + id="dx1-57001"> package may recall that the syntax used to define new acronyms has changed with the replacement glossaries package. In addition, the old glossary package created the command package created the command \<acr-name> when defining the acronym class="cmmi-10"><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.1 + id="x1-57003f1"> provides the command: -

\oldacronym  \oldacronym[<labelkey-val list>}
-

+

This uses the same syntax as the glossary package’s method of defining acronyms. It is + id="dx1-57005"> package’s method of defining acronyms. It is equivalent to: + +
\newacronym[<key-val list}
In addition, \oldacronym also defines the commands also defines the commands \<label>, which is equivalent to \gls{<labellabel>*, which is equivalent to \Gls{<labellabel> doesn’t allow you to use the first optional argument of \gls or or \Gls — you will need to explicitly use — you will need to explicitly use \gls or or \Gls to change the + id="dx1-57013"> to change the settings. -

Recall that, in general, LAT

Recall that, in general, LATEX ignores spaces following command names consisting of alphabetical characters. This is also true for \label> unless you additionally load the xspace package, but be aware that there are some issues with + id="dx1-57014"> package, but be aware that there are some issues with using xspace..13.2
-

+

-

The +

The glossaries package doesn’t load the xspace package since there are both + id="dx1-57017"> package since there are both advantages and disadvantages to using \xspace in in \<label>. If you don’t use the xspace package you need to explicitly force a space using 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 ). If you use the xspace package you don’t need to escape the spaces + id="dx1-57021"> 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: + id="dx1-57022">). +

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 +href="#tab:xspace">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 + id="dx1-57023"> package has been loaded. As can be seen from the final row in the table, the xspace package prevents the optional argument from being + id="dx1-57024"> package prevents the optional argument from being recognised.

-

@@ -15288,55 +16991,55 @@ recognised. >Table 13.2: The effect of using xspace with \oldacronym
-
\oldacronym +
Code Code With xspace xspace Without xspace
\abc. abc. \abc. abc. abc.
\abc xyz abc xyz  xyz abc xyz abcxyz
\abc\ xyz abc xyz  xyz abc xyz abc xyz
\abc* xyz Abc xyz  xyz Abc xyz Abc xyz
\abc[’s] xyz abc [’s] xyz  xyz abc [’s] xyz abc’s xyz
@@ -15345,108 +17048,108 @@ class="td11"> abc’s xyz
-

-

+

Top

14. Unsetting and Resetting Entry Flags

-

When using

When using \gls, , \glspl and their upper case variants it is possible that you may + id="dx1-58002"> and their upper case variants it is possible that you may want to use the value given by the first key, even though you have already key, even though you have already used the glossary entry. Conversely, you may want to use the value given by the text key, even + id="dx1-58005"> 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: -

\glsresetall  \glsresetall[<glossary list>]
-

-

+

\glslocalresetall  \glslocalresetall[<glossary list>]
-

-

+

\glsunsetall  \glsunsetall[<glossary list>]
-

-

+

\glslocalunsetall  \glslocalunsetall[<glossary list>]
-

+

where <glossary list -

+
\glsresetall[main,acronym]
-

-

You can determine whether an entry’s

+

You can determine whether an entry’s first use flag is set using: -

\ifglsused  \ifglsused{<labelfalse part>}
-

+

where <label> will be done, otherwise <false part> will be done. -

Be careful when using commands such as

Be careful when using commands such as \gls within an environment or + id="dx1-58016"> 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

+

For example, the frame environment in environment in beamer processes its argument for each + id="dx1-58019"> 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: +

Consider the following example:

-
+
\documentclass{beamer}  
\usepackage{glossaries}  
\newacronym{svm}{SVM}{support vector machine} @@ -15529,11 +17232,11 @@ subsequent overlays will use the non-first use form.  
\end{frame}  
\end{document}
-

-

On the first overlay,

+

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 @@ -15542,7 +17245,7 @@ first use:

-
+
\begin{frame}  
 \frametitle{Frame 1}  
 \begin{itemize} @@ -15551,87 +17254,93 @@ first use:  
 \end{itemize}  
\end{frame}
-

This is non-optimal, but the

This is non-optimal, but the beamer class is too complex for me to suggest an + id="dx1-58022"> class is too complex for me to suggest an alternative solution. -

The

The amsmath environments, such as environments, such as align, also process their contents multiple + id="dx1-58024">, also process their contents multiple times, but the glossaries package now checks for this.

-

-

+

Top

15. Glossary Styles

-

Glossaries vary from lists that simply contain a symbol with a terse description to +

Glossaries vary from lists that simply contain a symbol with a terse description to lists of terms or phrases with lengthy descriptions. Some glossaries may have terms with associated symbols. Some may have hierarchical entries. There is therefore no single style that fits every type of glossary. The glossaries package comes with a number of pre-defined glossary styles, described in §15.1 §15.1 Predefined Styles. You can choose one of these that best suits your type of glossary or, if none of them suit your document, you can defined your own style (see §15.2 §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 + id="dx1-59001"> key in the optional argument to \printnoidxglossary (Option 1) or \printglossary or using the command: -

(Options 2 and 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 + id="dx1-59005"> package option, it depends if the package in which they are defined is automatically loaded by the glossaries package.

-

Top

15.1 Predefined Styles

-

The predefined styles can accommodate numbered level 0 (main) and level 1 entries. +

The predefined styles can accommodate numbered level 0 (main) and level 1 entries. See the package options entrycounter, , counterwithin and and subentrycounter described in + id="dx1-60003"> described in §2.3 Glossary Appearance Options. There is a summary of available styles in +href="#glossaryappearanceoptions">§2.3 Glossary Appearance Options. There is a summary of available styles in table 15.1. +href="#tab:styles">table 15.1.

-

@@ -15642,343 +17351,349 @@ that matches that doesn’t match any previously listed style (e.g. < class="cmtt-10">long3col* matches long3col, , long3colheader, , long3colborder and and long3colheaderborder). A + id="dx1-60008">). A maximum level of 0 indicates a flat glossary (sub-entries are displayed in the same way as main entries). Where the maximum level is given as — there is no limit, but note that makeindex imposes a limit of 2 sub-levels. If the homograph -column is checked, then the name is not displayed for sub-entries. If the symbol -column is checked, then the symbol will be displayed.
-
(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. +
Style Style Maximum Level Maximum Level Homograph Homograph Symbol
listdotted 0 listdotted 0
sublistdotted 1 sublistdotted 1
list* 1 list* 1 ✓ ✓
altlist* 1 altlist* 1 ✓ ✓
long*3col* 1 long*3col* 1 ✓ ✓
long4col* 1 long4col* 1 ✓ ✓ ✓
altlong*4col* 1 altlong*4col* 1 ✓ ✓ ✓
long* 1 long* 1 ✓ ✓
super*3col* 1 super*3col* 1 ✓ ✓
super4col* 1 super4col* 1 ✓ ✓ ✓
altsuper*4col* 1 altsuper*4col* 1 ✓ ✓ ✓
super* 1 super* 1 ✓ ✓
*index* 2 *index* 2 ✓
treenoname* — treenoname* — ✓ ✓ ✓
*tree* — *tree* — ✓
*alttree* — *alttree* — ✓
inline 1 inline 1 ✓ ✓
-

The tabular-like styles that allow multi-line descriptions and page lists use the +

The tabular-like styles that allow multi-line descriptions and page lists use the length \glsdescwidth \glsdescwidth to set the width of the description column and the length \glspagelistwidth \glspagelistwidth to set the width of the page list column.15.1 + id="x1-60013f1"> These will need to be changed using \setlength if the glossary is too wide. Note that the long4col and and super4col styles (and their header and border variations) don’t use + id="dx1-60018"> 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 and altsuper4col styles. If you want to explicitly create a + id="dx1-60020"> 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 key in the optional argument to \printnoidxglossary +(Option 1) or \printglossary, it -will override any previous style settings for the given glossary, so if, for example, you -do + id="dx1-60024"> (Options 2 and 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 + id="dx1-60025"> will not have an affect for this glossary, as \glsgroupskip is redefined by style=long. Likewise, \setglossarystyle will also + id="dx1-60026"> 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 in this case). If you want to modify the styles, either use in this case). If you want to modify the styles, either use \newglossarystyle + id="dx1-60028"> (described in the next section) or make the modifications after \setglossarystyle, + id="dx1-60029">, 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 + id="dx1-60030"> 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 + id="dx1-60031"> style use the command -

\glspostdescription  \glspostdescription
-

+

after the description. This simply displays a full stop by default. To eliminate this full stop (or replace it with something else, say, a comma) you will need to redefine \glspostdescription before the glossary is displayed. Alternatively, you can suppress it for a given entry by placing \nopostdesc in the entry’s + id="dx1-60033"> in the entry’s description. -

As from version 3.03 you can now use the package option

As from version 3.03 you can now use the package option nopostdot to suppress + id="dx1-60034"> 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 + id="dx1-61001">. Since they all use the description environment, they are governed by the same parameters as + id="dx1-61002"> 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 or nostyles package + id="dx1-61005"> package options.

list
The list style uses the style uses the description environment. The entry name is placed in + id="dx1-61007"> environment. The entry name is placed in the optional argument of the \item command (so it will usually appear in + id="dx1-61009"> 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 + id="dx1-61011"> 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. + id="dx1-61012">.
listgroup
The listgroup style is like style is like list but the glossary groups have headings. + id="dx1-61014"> but the glossary groups have headings.
listhypergroup
The listhypergroup style is like style is like listgroup but has a navigation line at + id="dx1-61016"> 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 @@ -15986,28 +17701,28 @@ class="E">EX 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:

-
+
\renewcommand*{\glshypernavsep}{\space}
-

-

Note that the hyper-navigation line is now (as from version 1.14) set inside the +

+

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 + id="dx1-61018"> instead of after it to prevent a spurious space at the start. This can be changed by redefining \glossaryheader, + id="dx1-61019">, but note that this needs to be done after the glossary style has been set. @@ -16016,60 +17731,60 @@ class="cmti-10">after the glossary style has been class="cmbx-10">altlist

The altlist style is like style is like list but the description starts on the line following the + id="dx1-61021"> but the description starts on the line following the name. (As with the list style, the symbol is ignored.) Each child entry starts a + id="dx1-61022"> 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 + id="dx1-61023"> style, the name associated with each child entry is ignored.
altlistgroup
The altlistgroup style is like style is like altlist but the glossary groups have + id="dx1-61025"> but the glossary groups have headings.
altlisthypergroup
The altlisthypergroup style is like style is like altlistgroup but has a set of links + id="dx1-61027"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, + id="dx1-61028">, described above.
listdotted
This style uses the description + id="dx1-61029"> environment.15.2 + id="x1-61031f2"> 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 + id="dx1-61033"> 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.

@@ -16077,35 +17792,35 @@ class="cmtt-10">\glslistdottedwidth
class="cmbx-10">sublistdotted
This is a variation on the listdotted style designed for hierarchical + id="dx1-61035"> style designed for hierarchical glossaries. The main entries have just the name displayed. The sub entries are displayed in the same manner as listdotted.
+ id="dx1-61036">. -

+

-

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 + id="dx1-62001">. Since they all use the longtable environment, they are governed by the same parameters + id="dx1-62002"> 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 or nostyles package options. These styles fully justify + id="dx1-62005"> 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 §15.1.3 Longtable Styles (Ragged Right).

@@ -16113,88 +17828,88 @@ Right). class="cmbx-10">long
The long style uses the style uses the longtable environment (defined by the environment (defined by the longtable + id="dx1-62009"> 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 + id="dx1-62011">. 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 + id="dx1-62012">. 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 + id="dx1-62014"> 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-62016"> but has a header row.
longheaderborder
The longheaderborder style is like style is like longheader but has + id="dx1-62018"> 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 + id="dx1-62020"> 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 + id="dx1-62022">. 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 + id="dx1-62023">, and the width of the third column is governed by the length \glspagelistwidth. + id="dx1-62024">.
long3colborder
The long3colborder style is like the style is like the long3col style but has + id="dx1-62026"> 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-62028"> but has a header row.
@@ -16202,130 +17917,130 @@ class="cmss-10">long3collong3colheaderborder
The long3colheaderborder style is like style is like long3colheader + id="dx1-62030"> but has horizontal and vertical lines around it.
long4col
The long4col style is like style is like long3col but has an additional column in + id="dx1-62032"> 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-62033"> for multi-line descriptions.
long4colborder
The long4colborder style is like the style is like the long4col style but has + id="dx1-62035"> 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-62037"> but has a header row.
long4colheaderborder
The long4colheaderborder style is like style is like long4colheader + id="dx1-62039"> but has horizontal and vertical lines around it.
altlong4col
The altlong4col + id="dx1-62040"> style is like long4col but allows multi-line descriptions and page lists. The + id="dx1-62041"> but allows multi-line descriptions and page lists. The width of the description column is governed by the length \glsdescwidth + id="dx1-62042"> and the width of the page list column is governed by the length \glspagelistwidth. The widths of the name and symbol columns are + id="dx1-62043">. The widths of the name and symbol columns are governed by the widest entry in the given column.
altlong4colborder
The altlong4colborder style is like the style is like the long4colborder but + id="dx1-62045"> but allows multi-line descriptions and page lists.
altlong4colheader
The altlong4colheader style is like style is like long4colheader but allows + id="dx1-62047"> but allows multi-line descriptions and page lists.
altlong4colheaderborder
The altlong4colheaderborder style is like + id="dx1-62048"> style is like long4colheaderborder but allows multi-line descriptions and page lists.
-

+ id="dx1-62049"> 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. + id="dx1-63001">. These styles are analogous to those defined in glossary-long but the multiline + id="dx1-63002"> 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 + id="dx1-63003"> environment, they are governed by the same parameters as that environment. The glossary-longragged package additionally requires the package additionally requires the array + id="dx1-63006"> package. Note that these styles will only be available if you explicitly load glossary-longragged: + id="dx1-63007">:

-
+
\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 + id="dx1-63008"> package option since the styles aren’t defined until after the glossaries package has been loaded.

@@ -16333,83 +18048,83 @@ class="cmss-10">glossaries package has been loaded. class="cmbx-10">longragged
The longragged style has two columns: the first column contains the + id="dx1-63009"> 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 + id="dx1-63011">. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. Child entries have a similar format + id="dx1-63012">. Child entries have a similar format to the parent entries except that their name is suppressed.
longraggedborder
The longraggedborder style is like style is like longragged but has + id="dx1-63014"> but has horizontal and vertical lines around it.
longraggedheader
The longraggedheader style is like style is like longragged but has a + id="dx1-63016"> but has a header row.
longraggedheaderborder
The longraggedheaderborder style is like + id="dx1-63017"> style is like longraggedheader but has horizontal and vertical lines around it. + id="dx1-63018"> but has horizontal and vertical lines around it.
longragged3col
The longragged3col style is like style is like longragged but has three + id="dx1-63020"> 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 + id="dx1-63022">. 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 + id="dx1-63023">, and the width of the third column is governed by the length \glspagelistwidth. + id="dx1-63024">.
longragged3colborder
The longragged3colborder style is like the + id="dx1-63025"> style is like the longragged3col style but has horizontal and vertical lines around it. + id="dx1-63026"> style but has horizontal and vertical lines around it.
longragged3colheader
The longragged3colheader style is like style is like longragged3col + id="dx1-63028"> but has a header row. @@ -16418,87 +18133,87 @@ class="cmss-10">longragged3collongragged3colheaderborder
The longragged3colheaderborder style is like + id="dx1-63029"> style is like longragged3colheader but has horizontal and vertical lines around it. + id="dx1-63030"> but has horizontal and vertical lines around it.
altlongragged4col
The altlongragged4col style is like style is like longragged3col but has + id="dx1-63032"> 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 + id="dx1-63033"> and the width of the page list column is governed by the length \glspagelistwidth. The widths of the name and symbol columns are + id="dx1-63034">. The widths of the name and symbol columns are governed by the widest entry in the given column.
altlongragged4colborder
The altlongragged4colborder style is like the + id="dx1-63035"> style is like the altlongragged4col but has horizontal and vertical lines around it. + id="dx1-63036"> but has horizontal and vertical lines around it.
altlongragged4colheader
The altlongragged4colheader style is like + id="dx1-63037"> style is like altlongragged4col but has a header row. + id="dx1-63038"> but has a header row.
altlongragged4colheaderborder
The altlongragged4colheaderborder style is + id="dx1-63039"> style is like altlongragged4colheader but has horizontal and vertical lines around it. + id="dx1-63040"> but has horizontal and vertical lines around it.
-

+

-

Top

15.1.4 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 + id="dx1-64001">. Since they all use the supertabular environment, they are governed by the same parameters + id="dx1-64002"> 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-64006"> environment is better, but there are some circumstances where it is better to use supertabular..15.3 + id="x1-64010f3"> 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 §15.1.5 Supertabular Styles (Ragged Right).

@@ -16506,131 +18221,131 @@ Styles (Ragged Right). class="cmbx-10">super
The super style uses the style uses the supertabular environment (defined by the + id="dx1-64013"> environment (defined by the supertabular package). It has two columns: the first column contains the + id="dx1-64015"> 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 + id="dx1-64017">. 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 + id="dx1-64018">. 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 + id="dx1-64020"> 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-64022"> but has a header row.
superheaderborder
The superheaderborder style is like style is like superheader but has + id="dx1-64024"> but has horizontal and vertical lines around it.
super3col
The super3col style is like style is like super but has three columns. The + id="dx1-64026"> 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 + id="dx1-64028">. 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 + id="dx1-64029">. The width of the third column is governed by the length \glspagelistwidth. + id="dx1-64030">.
super3colborder
The super3colborder style is like the style is like the super3col style but has + id="dx1-64032"> style but has horizontal and vertical lines around it.
super3colheader
The super3colheader style is like style is like super3col but has a header + id="dx1-64034"> but has a header row.
super3colheaderborder
The super3colheaderborder style is like the + id="dx1-64035"> style is like the super3colheader style but has horizontal and vertical lines around it. + id="dx1-64036"> style but has horizontal and vertical lines around it.
super4col
The super4col style is like style is like super3col but has an additional column + id="dx1-64038"> 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 + id="dx1-64039"> for multi-line descriptions.
super4colborder
The super4colborder style is like the style is like the super4col style but has + id="dx1-64041"> style but has horizontal and vertical lines around it.
super4colheader
The super4colheader style is like style is like super4col but has a header + id="dx1-64043"> but has a header row. @@ -16639,88 +18354,88 @@ class="cmss-10">super4colsuper4colheaderborder
The super4colheaderborder style is like the + id="dx1-64044"> style is like the super4colheader style but has horizontal and vertical lines around it. + id="dx1-64045"> style but has horizontal and vertical lines around it.
altsuper4col
The altsuper4col style is like style is like super4col but allows multi-line + id="dx1-64047"> 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 + id="dx1-64048"> and the width of the page list column is governed by the length \glspagelistwidth. The width of the name and + id="dx1-64049">. The width of the name and symbol columns is governed by the widest entry in the given column.
altsuper4colborder
The altsuper4colborder style is like the style is like the super4colborder + id="dx1-64051"> style but allows multi-line descriptions and page lists.
altsuper4colheader
The altsuper4colheader style is like style is like super4colheader but + id="dx1-64053"> but allows multi-line descriptions and page lists.
altsuper4colheaderborder
The altsuper4colheaderborder style is like + id="dx1-64054"> style is like super4colheaderborder but allows multi-line descriptions and page lists.
-

+ id="dx1-64055"> but allows multi-line descriptions and page lists. +

-

Top

15.1.5 Supertabular Styles (Ragged Right)

-

The styles described in this section are all defined in the package

The styles described in this section are all defined in the package glossary-superragged. + id="dx1-65001">. These styles are analogous to those defined in glossary-super but the multiline + id="dx1-65002"> 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 + id="dx1-65003"> environment, they are governed by the same parameters as that environment. The glossary-superragged package additionally requires the package additionally requires the array + id="dx1-65006"> package. Note that these styles will only be available if you explicitly load glossary-superragged: + id="dx1-65007">:

-
+
\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 + id="dx1-65008"> package option since the styles aren’t defined until after the glossaries package has been loaded.

@@ -16728,91 +18443,91 @@ class="cmss-10">glossaries package has been loaded. class="cmbx-10">superragged
The superragged style uses the style uses the supertabular environment (defined + id="dx1-65010"> environment (defined by the supertabular package). It has two columns: the first column contains + id="dx1-65012"> 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 + id="dx1-65014">. 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 + id="dx1-65015">. 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 + id="dx1-65017"> but has horizontal and vertical lines around it.
superraggedheader
The superraggedheader style is like style is like superragged but has a + id="dx1-65019"> but has a header row.
superraggedheaderborder
The superraggedheaderborder + id="dx1-65020"> style is like superraggedheader but has horizontal and vertical lines around + id="dx1-65021"> but has horizontal and vertical lines around it.
superragged3col
The superragged3col style is like style is like superragged but has three + id="dx1-65023"> 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 + id="dx1-65025">. 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 + id="dx1-65026">. The width of the third column is governed by the length \glspagelistwidth. + id="dx1-65027">.
superragged3colborder
The superragged3colborder style is like the + id="dx1-65028"> style is like the superragged3col style but has horizontal and vertical lines around it. + id="dx1-65029"> style but has horizontal and vertical lines around it.
superragged3colheader
The superragged3colheader style is like + id="dx1-65030"> style is like superragged3col but has a header row. + id="dx1-65031"> but has a header row.
@@ -16820,18 +18535,18 @@ class="cmss-10">superragged3colsuperragged3colheaderborder
The superragged3colheaderborder style is like + id="dx1-65032"> style is like superragged3colheader but has horizontal and vertical lines around it. + id="dx1-65033"> but has horizontal and vertical lines around it.
altsuperragged4col
The altsuperragged4col style is like style is like superragged3col but has + id="dx1-65035"> 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. @@ -16840,67 +18555,67 @@ class="cmss-10">superragged3colaltsuperragged4colborder
The altsuperragged4colborder style is like the + id="dx1-65036"> style is like the altsuperragged4col style but has horizontal and vertical lines around it. + id="dx1-65037"> style but has horizontal and vertical lines around it.
altsuperragged4colheader
The altsuperragged4colheader style is like + id="dx1-65038"> style is like altsuperragged4col but has a header row. + id="dx1-65039"> but has a header row.
altsuperragged4colheaderborder
The altsuperragged4colheaderborder style + id="dx1-65040"> style is like altsuperragged4colheader but has horizontal and vertical lines around + id="dx1-65041"> but has horizontal and vertical lines around it.
-

+

-

Top

15.1.6 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 + id="dx1-66001">. 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 + id="dx1-66003"> package options.

index
The index style is similar to the way indices are usually formatted in that + id="dx1-66004"> 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-66005">.
indexgroup
The indexgroup style is similar to the style is similar to the index style except that each + id="dx1-66007"> style except that each group has a heading. @@ -16909,105 +18624,105 @@ class="cmss-10">indexindexhypergroup
The indexhypergroup style is like style is like indexgroup but has a set of + id="dx1-66009"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described above. + id="dx1-66010">, described above.
tree
The tree style is similar to the style is similar to the index style except that it can have arbitrary + id="dx1-66012"> style except that it can have arbitrary levels. (Note that makeindex is limited to three levels, so you will need to + id="dx1-66014"> 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-66016"> if you want more than three levels.) Each sub-level is indented by \glstreeindent \glstreeindent. Note that the name, symbol (if present) and description are placed in the same paragraph block. If you want the name to be apart from the description, use the alttree style instead. (See + id="dx1-66018"> style instead. (See below.)
treegroup
The treegroup style is similar to the style is similar to the tree style except that each group + id="dx1-66020"> style except that each group has a heading.
treehypergroup
The treehypergroup style is like style is like treegroup but has a set of + id="dx1-66022"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described above. + id="dx1-66023">, described above.
treenoname
The treenoname style is like the style is like the tree style except that the name + id="dx1-66025"> 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 + id="dx1-66027"> style except that each group has a heading.
treenonamehypergroup
The treenonamehypergroup style + id="dx1-66028"> style is like treenonamegroup but has a set of links to the glossary groups. The + id="dx1-66029"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described above. + id="dx1-66030">, described above.
alttree
The alttree style is similar to the style is similar to the tree style except that the indentation for + id="dx1-66032"> 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\glssetwidest class="cmmi-10"><level> is omitted, 0 is assumed. -

For each level, the name is placed to the left of the paragraph block containing +

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. @@ -17039,298 +18754,298 @@ class="cmmi-10">> is omitted, 0 is assumed. class="cmbx-10">alttreegroup

The alttreegroup is like the is like the alttree style except that each group has a + id="dx1-66035"> style except that each group has a heading.
alttreehypergroup
The alttreehypergroup style is like style is like alttreegroup but has a set of + id="dx1-66037"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described above. + id="dx1-66038">, described above.
-

+

-

Top

15.1.7 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 + id="dx1-67002"> environment (defined by the multicol package). The style names are as their analogous + id="dx1-67004"> package). The style names are as their analogous tree styles (as defined in §15.1.6 §15.1.6 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 + id="dx1-67007"> environment. For the complete list, see table 15.2. -

Note that table 15.2. +

Note that glossary-mcols is not loaded by 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. + id="dx1-67010">.
-

-

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
-
Multicolumn Styles +
+ id="dx1-67017"> + id="dx1-67019"> + id="dx1-67023"> + id="dx1-67025"> + id="dx1-67027"> + id="dx1-67029"> + id="dx1-67031"> + id="dx1-67033"> + id="dx1-67035">
glossary-mcols Style 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-67037">
-

Top

15.1.8 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 + id="dx1-68002"> 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 + id="dx1-68005"> 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 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-68007">.

+

+

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

+

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

\glsinlinesubseparator  \glsinlinesubseparator
-

+ id="dx1-68012">

+

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

\glsinlineparentchildseparator  \glsinlineparentchildseparator + id="dx1-68014">
-

+

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

\glspostinline  \glspostinline
-

+ id="dx1-68016">

+

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

+

where <name<definitions> needs to redefine all of the following: -

theglossary  theglossary
-

+ id="dx1-69004">

+

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). + id="dx1-69007">). For example, the list style uses the style uses the description environment, so the environment, so the theglossary + id="dx1-69011"> 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 \glossarypreamble, which should not be affected by + id="dx1-69016">, which should not be affected by changes in the glossary style. The list glossary style redefines glossary style redefines \glossaryheader to do + id="dx1-69018"> to do nothing, whereas the longheader glossary style redefines glossary style redefines \glossaryheader to do a header row. -

\glsgroupheading  \glsgroupheading{<label>}
-

+

This macro indicates what to do at the start of each logical block within the main body of the glossary. If you use makeindex the glossary is sub-divided into a + id="dx1-69022"> 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 + id="dx1-69025"> key is omitted). The sub-divisions are in the following order: symbols, numbers, A, …, Z. If you use xindy, the sub-divisions depend + id="dx1-69027">, the sub-divisions depend on the language settings. -

Note that the argument to

Note that the argument to \glsgroupheading is a label not the group title. The group title can be obtained via -

\glsgetgrouptitle  \glsgetgrouptitle{<label>}
-

+

This obtains the title as follows: if <label>. (The “symbols” group has the label glssymbols, so the command \glssymbolsgroupname is + id="dx1-69029"> 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 +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

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

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

See also

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 list glossary style simply redefines glossary style simply redefines \glsgroupskip to be \indexspace, whereas the tabular-like styles redefine , whereas the tabular-like styles redefine \glsgroupskip to produce a blank row. -

As from version 3.03, the package option

As from version 3.03, the package option nogroupskip can be used to suppress this + id="dx1-69039"> can be used to suppress this default gap for the predefined styles. -

\glossentry  \glossentry{<label<number list>}
-

+

This macro indicates what to do for each level 0 glossary entry. The entry label is given by <label> and the associated number list is given by is given by <number list>. You can redefine \glossentry to use commands like to use commands like \glossentryname{<label>}, \glossentrydesc{<label>} and \glossentrysymbol{<label} to display the name, description and symbol fields, or to access other fields, use commands like \glsentryuseri{<label>}. (See §9 §9 Using Glossary Terms Without Links for further details.) You can also use the following commands: -

\glsentryitem  \glsentryitem{<label>}
-

+

This macro will increment and display the associated counter for the main (level 0) entries if the entrycounter or or counterwithin package options have been used. This macro + id="dx1-69050"> package options have been used. This macro is typically called by \glossentry before \glstarget. The format of the counter is controlled by the macro -

\glsentrycounterlabel  \glsentrycounterlabel
-

-

Each time you use a glossary entry it creates a hyperlink (if hyperlinks are +

+

Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the relevant line in the glossary. Your new glossary style must therefore redefine \glossentry to set the appropriate target. This is done using -

\glstarget  \glstarget{<label<text>}
-

+

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

For example, the

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

+

where <number(s)> may contain \delimN (to delimit individual numbers) and/or + id="dx1-69057"> (to delimit individual numbers) and/or \delimR (to indicate a range of numbers). There may be multiple occurrences of + id="dx1-69058"> (to indicate a range of numbers). There may be multiple occurrences of \setentrycounter[<Hprefix}, 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 + id="dx1-69060">. 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 + id="dx1-69061"> is to provide a means of suppressing the number list altogether. (In fact, the nonumberlist option redefines option redefines \glossaryentrynumbers to + id="dx1-69063"> 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-69064"> package option. -

\subglossentry  \subglossentry{<levelnumber list>}
-

+

This is used to display sub-entries. The first argument, <level>, indicates the sub-entry level. This must be an integer from 1 (first sub-level) onwards. The remaining arguments are analogous to those for \glossentry described + id="dx1-69066"> described above. -

\glssubentryitem  \glssubentryitem{<label>}
-

+

This macro will increment and display the associated counter for the level 1 entries if the subentrycounter package option has been used. This macro is typically called by + id="dx1-69068"> 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-69069">. 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 +

For further details of these commands, see “Displaying the glossary” in the documented code (glossaries-code.pdf). -

+

Example 20 (Creating a completely new style) -

If you want a completely new style, you will need to redefine all of the commands + id="x1-69075"> +

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 +

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 + id="dx1-69078"> 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 + id="dx1-69081"> 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 + id="dx1-69082"> 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 + id="dx1-69084"> 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}% @@ -17891,40 +19606,40 @@ follows:  
   \glossentry{##2}{##3}}%  
 }
-

Note that this style creates a flat glossary, where sub-entries are displayed in exactly +

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 + id="dx1-69085"> or \glssubentryitem so it won’t be affected by the so it won’t be affected by the entrycounter, , counterwithin or + id="dx1-69088"> or subentrycounter package options. -

Variations:

+ id="dx1-69089"> package options. +

Variations:

  • You might want the entry name to be capitalised, in which case use \Glossentryname instead of instead of \glossentryname. + id="dx1-69091">.
  • 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 +class="cmsy-10">§16 Utilities): -
    +
     \renewcommand*{\glossentry}[2]{%  
     \item % bullet point  
     \glstarget{##1}{\glossentryname{##1}}% the entry name @@ -17937,82 +19652,82 @@ href="#sec:utilities">Utilities):  
     \space [##2]% the number list in square brackets  
     }%
    -

+

-

-

____________________________

+

+

____________________________

-

+

Example 21 (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 + id="x1-69094"> +

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 + id="dx1-69095"> within the second argument of \newglossarystyle followed by whatever alterations you require. For example, + id="dx1-69096"> 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 + id="dx1-69097"> style but you don’t want the extra vertical space created by \indexspace between groups, then you can create a new glossary style + id="dx1-69098"> 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 + id="dx1-69099"> style in combination with the package option nogroupskip.)

+ id="dx1-69100">.)

-

-

____________________________

+

+

____________________________

-

+

Example 22 (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 + id="x1-69104"> +

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 + id="dx1-69106">). Then you can define a glossary style that displays each entry in a longtable as follows: + id="dx1-69107"> as follows:

-
+
\newglossarystyle{long6col}{%  
 % put the glossary in a longtable environment:  
 \renewenvironment{theglossary}% @@ -18051,29 +19766,29 @@ class="cmss-10">longtable \renewcommand*{\glsgroupskip}{}%  
}
-

+

-

-

____________________________

+

+

____________________________

-

-

+

Top

16. Utilities

-

This section describes some utility commands. Additional commands can be found +

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

Some of the commands described here take a comma-separated list as an +

Some of the commands described here take a comma-separated list as an argument. As with LATEX’s \@for command, make sure your list doesn’t have an unwanted spaces in it as they don’t get stripped.
-

-

+

\forallglossaries  \forallglossaries[<glossary listbody>}
-

+

This iterates through <glossary list<glossary list> is omitted, the default is to iterate over all glossaries. -

\forglsentries  \forglsentries[<glossary labelbody>}
-

+

This iterates through all entries in the glossary given by <glossary labelglossary label> is omitted, \glsdefaulttype (usually the main glossary) is used. -

(usually the main glossary) is used. +

\forallglsentries  \forallglsentries[<glossary listbody>}
-

+

This is like \forglsentries but for each glossary in <<body>.) -

\ifglossaryexists  \ifglossaryexists<label><false part>
-

+

This checks if the glossary given by <label<false part>. -

\ifglsentryexists  \ifglsentryexists<label><false part>
-

+

This checks if the glossary entry given by <label>. (Note that \ifglsentryexists will always be true after the containing glossary has been displayed via \printglossary or + id="dx1-70007"> or \printglossaries even if the entry is explicitly defined later in the document. This is + id="dx1-70008"> even if the entry is explicitly defined later in the document. This is because the entry has to be defined before it can be displayed in the glossary, see §4.8.1 §4.8.1 Technical Issues for further details.) -

\glsdoifexists  \glsdoifexists{<label<code>}
-

+

Does <codelabel> 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  \glsdoifexistsorwanr{<labelcode>}
-

+

As \glsdoifexists but issues a warning rather than an error if the entry doesn’t exist. -

\ifglsused  \ifglsused<labeltrue part><false part>
-

+

See §14 §14 Unsetting and Resetting Entry Flags. -

\ifglshaschildren  \ifglshaschildren<label><false part>
-

+

This checks if the glossary entry given by <label> is performed, otherwise <false part>. -

\ifglshasparent  \ifglshasparent<label><false part>
-

+

This checks if the glossary entry given by <label> is performed, otherwise <false part>. -

\ifglshassymbol  \ifglshassymbol{<labelfalse part>}
-

+

This checks if the glossary entry given by <label> has had the symbol field set. If it + id="dx1-70016"> field set. If it has, <true part> is performed, otherwise <false part>. -

\ifglshaslong  \ifglshaslong{<labelfalse part>}
-

+

This checks if the glossary entry given by <label> has had the long field set. If it has, + id="dx1-70018"> field set. If it has, <true partfalse part>. This should be true for any entry that has been defined via \newacronym. There is no check for the existance of + id="dx1-70019">. There is no check for the existance of <label>. -

\ifglshasshort  \ifglshasshort{<labelfalse part>}
-

+

This checks if the glossary entry given by <label> has had the short field set. If it has, + id="dx1-70021"> field set. If it has, <true partfalse part>. This should be true for any entry that has been defined via \newacronym. There is no check for the existance of + id="dx1-70022">. There is no check for the existance of <label>. -

\ifglshasdesc  \ifglshasdesc{<label}
-

+

This checks if the description field is non-empty for the entry given by field is non-empty for the entry given by <label>. If it @@ -18522,10 +20237,10 @@ class="cmmi-10">> is performed, otherwise <false part>. Compare with: -

\ifglsdescsuppressed  \ifglsdescsuppressed{<labelfalse class="cmitt-10">part>}
-

+

This checks if the description field has been set to just field has been set to just \nopostdesc for the entry given + id="dx1-70027"> for the entry given by <label<label>. -

For all other fields you can use: -

For all other fields you can use: +

\ifglshasfield{<fieldfalse part>}
-

+

This checks if the field given by <field -

-

+

Top

17. Prefixes or Determiners

-

The

The glossaries-prefix package provides additional keys that can be used as prefixes. + id="dx1-71001"> 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

The extra keys for \newglossaryentry are as follows: + id="dx1-71002"> are as follows:

prefix
The prefix associated with the text key. This defaults to nothing. + id="dx1-71004"> key. This defaults to nothing.
prefixplural
The prefix associated with the plural key. This defaults to nothing. + id="dx1-71006"> key. This defaults to nothing.
prefixfirst
The prefix associated with the first key. If omitted, this defaults to + id="dx1-71008"> key. If omitted, this defaults to the value of the prefix key. + id="dx1-71009"> key.
prefixfirstplural
The prefix associated with the firstplural key. If omitted, this + id="dx1-71011"> key. If omitted, this defaults to the value of the prefixplural key.
+ id="dx1-71012"> key. -

+

Example 23 (Defining Determiners) -

Here’s the start of my example document: + id="x1-71014"> +

Here’s the start of my example document:

-
+
documentclass{article}  
\usepackage[colorlinks]{hyperref}  
\usepackage[toc,acronym]{glossaries-prefix}
-

Note that I’ve simply replaced

Note that I’ve simply replaced glossaries from previous sample documents with glossaries-prefix. Now for a sample definition17.1: + id="x1-71015f1">:

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

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

Where a space is required at the end of the prefix, you must use a spacing command, such as \space, \␣ (backslash space) or >=<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 + id="dx1-71017"> package provides convenient commands to use these prefixes with commands such as \gls. Note that the prefix is not considered part + id="dx1-71018">. Note that the prefix is not considered part of the link text, so it’s not included in the hyperlink (where hyperlinks are + id="dx1-71020">, so it’s not included in the hyperlink (where hyperlinks are enabled). -

\pgls  \pgls[<options<insert>]
-

+

This is prepends the value of the prefix key (or key (or prefixfirst key, on key, on first use) in front of \gls[<insert>]. -

\Pgls  \Pgls[<options<insert>]
-

+

If the prefix key (or key (or prefixfirst, on first use) has been set, this displays the + id="dx1-71027">, on first use) has been set, this displays the value of that key with the first letter converted to upper case followed by \gls[>]. If that key hasn’t been set, this is equivalent to \Gls[<options<insert>]. -

\PGLS  \PGLS[<options<insert>]
-

+

As \pgls but converts the prefix to upper case and uses \GLS instead of + id="dx1-71031"> instead of \gls. -

\pglspl  \pglspl[<options<insert>]
-

+

This is prepends the value of the prefixplural key (or key (or prefixfirstplural key, on key, on first use) in front of \glspl[<insert>]. -

\Pglspl  \Pglspl[<options<insert>]
-

+

If the prefixplural key (or key (or prefixfirstplural, on first use) has been set, this displays the + id="dx1-71038">, on first use) has been set, this displays the value of that key with the first letter converted to upper case followed by \glspl[>]. If that key hasn’t been set, this is equivalent to \Glspl[<options<insert>]. -

\PGLSpl  \PGLSpl[<options<insert>]
-

+

As \pglspl but converts the prefix to upper case and uses \GLSpl instead of + id="dx1-71042"> instead of \glspl. -

+

Example 24 (Using Prefixes) -

Continuing from Example 23, now that I’ve defined my entries, I can use them in + id="x1-71044"> +

Continuing from Example 23, now that I’ve defined my entries, I can use them in the text via the above commands:

-
+
First use: \pgls{svm}. Next use: \pgls{svm}.  
Singular: \pgls{sample}, \pgls{oeil}.  
Plural: \pglspl{sample}, \pglspl{oeil}.
-

which produces: +

which produces:

-

First use: a support vector machine (SVM). Next use: an SVM. +

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

For a complete document, see sample-prefix.tex.

-

-

____________________________

-

This package also provides the following commands: -

+

____________________________

+

This package also provides the following commands: +

\ifglshasprefix  \ifglshasprefix{<labelfalse part>}
-

+

Does <true partlabel> has a non-empty value for the prefix key. -

This package also provides the following commands: -

key. +

This package also provides the following commands: +

\ifglshasprefixplural  \ifglshasprefixplural{<label<false part>}
-

+

Does <true partlabel> has a non-empty value for the prefixplural key. -

key. +

\ifglshasprefixfirst  \ifglshasprefixfirst{<labelfalse class="cmitt-10">part>}
-

+

Does <true partlabel> has a non-empty value for the prefixfirst key. -

key. +

\ifglshasprefixfirstplural  -

+

\ifglshasprefixfirstplural{<labelfalse part>}
-

+

Does <true partlabel> 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>. (No check is performed to determine if the entry exists.) -

\glsentryprefixfirst  \glsentryprefixfirst{<label>}
-

+

Displays the value of the prefixfirst key for the entry given by key for the entry given by <label>. (No check is performed to determine if the entry exists.) -

\glsentryprefixplural  \glsentryprefixplural{<label>}
-

+

Displays the value of the prefixplural key for the entry given by 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: -

: +

\Glsentryprefix  \Glsentryprefix{<label>}
-

-

+

\Glsentryprefixfirst  \Glsentryprefixfirst{<label>}
-

-

+

\Glsentryprefixplural  \Glsentryprefixplural{<label>}
-

-

+

\Glsentryprefixfirstplural  -

+

\Glsentryprefixfirstplural{<label>}
-

-

As with analoguous commands such as

+

As with analoguous commands such as \Glsentrytext, these commands aren’t + id="dx1-71066">, these commands aren’t expandable so can’t be used in PDF bookmarks.
-

+

-

+

Example 25 (Adding Determiner to Glossary Style) -

You can use the above commands to define a new glossary style that uses the + id="x1-71068"> +

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 + id="dx1-71069"> style that inserts the prefix before the name:

-
+
\newglossarystyle{plist}{%  
  \setglossarystyle{list}%  
  \renewcommand*{\glossentry}[2]{% @@ -19269,164 +20984,164 @@ 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 + id="dx1-72001"> package, but note that this package is experimental and it requires the accsupp + id="dx1-72002"> 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-72004"> key.
textaccess
The replacement text corresponding to the text key. + id="dx1-72006"> key.
firstaccess
The replacement text corresponding to the first key. + id="dx1-72008"> key.
pluralaccess
The replacement text corresponding to the plural key. + id="dx1-72010"> key.
firstpluralaccess
The replacement text corresponding to the firstplural key. + id="dx1-72012"> key.
symbolaccess
The replacement text corresponding to the symbol key. + id="dx1-72014"> key.
symbolpluralaccess
The replacement text corresponding to the symbolplural key. + id="dx1-72016"> key.
descriptionaccess
The replacement text corresponding to the description key. + id="dx1-72018"> key.
descriptionpluralaccess
The replacement text corresponding to the descriptionplural key. + id="dx1-72020"> key.
longaccess
The replacement text corresponding to the long key (used by + id="dx1-72022"> key (used by \newacronym). + id="dx1-72023">).
shortaccess
The replacement text corresponding to the short key (used by + id="dx1-72025"> key (used by \newacronym). + id="dx1-72026">).
longpluralaccess
The replacement text corresponding to the longplural key (used + id="dx1-72028"> key (used by \newacronym). + id="dx1-72029">).
shortpluralaccess
The replacement text corresponding to the shortplural key + id="dx1-72031"> key (used by \newacronym). + id="dx1-72032">).
-

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

See the documented code (glossaries-code.pdf) for further details. It is recommended that you also read the accsupp documentation. + id="dx1-72034"> documentation.

-

-

+

Top

19. Troubleshooting

-

The

The glossaries package comes with a minimal file called minimalgls.tex which can be used for testing. This should be located in the EX code is available at http://www.dickimaw-_books.com/latex/minexample/. -

Below is a list of the most frequently asked questions. For other queries, consult -the

Below is a list of some frequently asked questions about the glossaries package. For +a complete list, consult the glossaries FAQ. If that doesn’t help, try posting your query to somewhere like -the comp.text.tex newsgroup, the glossaries FAQ. If that doesn’t help, try posting your query +to somewhere like the comp.text.tex newsgroup, the LATEX Community Forum or EX 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.

  1. Q. I get the error message: -
    +
    ! Undefined control sequence.  
    \in@ #1#2->\begingroup \def \in@@
    -

    -

    +

    A. This error can occur if you have a fragile command in one of your entry definitions. In most cases using \glsnoexpandfields before defining your entry @@ -19476,394 +21192,398 @@ class="cmtt-10">\protect in front of the fragile command.

  2. Q. I get the error message: -
    +
    Missing \begin{document}
    -

    -

    +

    A. Check you are using an up to date version of the xkeyval package. + id="dx1-73005"> package.

  3. Q. When I use xindy, I get the following error message: + id="dx1-73009">, I get the following error message: -
    +
    ERROR: CHAR: index 0 should be less than the length of  
    the string
    -

    -

    +

    A. xindy discards all commands and braces from the sort string. If your sort + id="dx1-73011"> discards all commands and braces from the sort string. If your sort string (either specified by the sort key or the key or the name key) only consists of + id="dx1-73013"> key) only consists of commands, this will be treated by xindy as an empty sort string, which + id="dx1-73015"> as an empty sort string, which produces an error message in newer versions of xindy. For example, the + id="dx1-73017">. For example, the following will cause a problem:

    -
    +
    \newglossaryentry{alpha}{name={\ensuremath{\alpha}},  
      description=alpha}
    -

    Either use a different sort key for the entry, for example: +

    Either use a different sort key for the entry, for example:

    -
    +
    \newglossaryentry{alpha}{sort=alpha,  
      name={\ensuremath{\alpha}},  
      description=alpha}
    -

    or, if all entries are like this, you may prefer to use the

    or, if all entries are like this, you may prefer to use the sort=use or or sort=def + id="dx1-73019"> package options. See §2.4 Sorting Options for further details of the §2.4 Sorting Options for further details of the sort + id="dx1-73020"> option.

  4. Q. I’ve used the smallcaps option, but the acronyms are displayed in normal + id="dx1-73023"> option, but the acronyms are displayed in normal sized upper case letters. -

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

  5. Q. My acronyms won’t break across a line when they’re expanded. -

    A. PDFLATEX can break hyperlinks across a line, but LATEX can’t. If you can’t use PDFLATEX then disable the first use links using the package option hyperfirst=false. + id="dx1-73029">.

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

    A. The easiest way to do this is to specify the smaller package option and + id="dx1-73032"> package option and redefine \acronymfont to use the required typesetting command. For example, + id="dx1-73033"> to use the required typesetting command. For example, suppose you would like the acronyms displayed in a sans-serif font, then you can do:

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

    +

  7. Q. How do I change the font that the acronyms are displayed in on first use? -

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

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

    +

  8. Q. I don’t have Perl installed, do I have to use makeglossaries? -

    ? +

    A. No. Although it is strongly recommended, you don’t have to use makeglossaries. If you prefer a GUI application and have Java installed, you + id="dx1-73047">. If you prefer a GUI application and have Java installed, you can use makeglossariesgui instead. Otherwise you can just call instead. Otherwise you can just call makeindex + id="dx1-73051"> explicitly (see §1.3.3 Using makeindex explicitly). Note that you can’t use §1.3.3 Using makeindex explicitly (Option 2)). Note that you + can’t use xindy - if you don’t have Perl installed. + id="dx1-73055"> if you don’t have Perl installed.

  9. Q. I’m used to using the glossary package: are there any instructions on migrating from the glossary package to the package to the glossaries package? -

    A. Read “Upgrading from the glossary package to the glossaries package” which should be available from the same location as this document.

  10. Q. I’m using babel but the fixed names haven’t been translated. -

    but the fixed names haven’t been translated. +

    A. The glossaries package currently only supports the following languages: Brazilian Portuguese, Danish, Dutch, English, French, German, Irish, Italian, Hungarian, Polish, Serbian and Spanish. If you want to add another language, send me the translations, and I’ll add them to the next version. -

    If you are using one of the above languages, but the text hasn’t been translated, +

    If you are using one of the above languages, but the text hasn’t been translated, try using the glossaries package option translate=babel. Also, try adding the + id="dx1-73062">. Also, try adding the language as a global option to the class file.

  11. Q. My glossaries haven’t appeared. -

    A. Remember to do the following:

    -

    Check the log files (

    Check the log files (.log, , .glg etc) for any warnings. + id="dx1-73073"> etc) for any warnings.

  12. Q. Why is glossaries creating an empty .glo file? -

    file? +

    A. Because you haven’t used any entries in the main glossary via commands such as \gls. If you don’t want to use this glossary, you can suppress its + id="dx1-73077">. If you don’t want to use this glossary, you can suppress its creation via the package option nomain. + id="dx1-73078">.

  13. Q. It is possible to change the rules used to sort the glossary entries? -

    A. If it’s for an individual entry, then you can use the entry’s sort key to sort it + id="dx1-73081"> key to sort it according to a different term. If it’s for the entire alphabet, then you will need to use xindy (instead of (instead of makeindex) and use an appropriate ) and use an appropriate xindy + id="dx1-73087"> language module. Writing xindy modules or styles is beyond the scope of + id="dx1-73089"> modules or styles is beyond the scope of this manual. Further information about xindy can be found at the + id="dx1-73091"> can be found at the Xindy Web Site. There is also a link to the xindy mailing list from that + id="dx1-73093"> mailing list from that site. -

    If you want to sort according to order of definition or order of use, use the

    If you want to sort according to order of definition or order of use, use the sort + id="dx1-73094"> package option described in §2.4 Sorting Options. +href="#sortingoptions">§2.4 Sorting Options.

  14. Q. I get an error when using TeX4HT with with glossaries. -

    A. TeX4HT seems to have a problem with the glossary styles that use \indexspace. I don’t know enough about TeX4HT to find out + id="dx1-73098">. I don’t know enough about TeX4HT to find out why. Either use a different glossary style or redefine the style command that uses \indexspace. For example, if you are using the list style, + id="dx1-73099"> style, try:

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

    or +

    or

    -
    +
    \renewcommand*{\glsgroupskip}{\item[]}
    -

    +

-

+ id="index">

Top

Index

Index Symbols
\@gls@codepage  5

A \AA  6
+\Ac  6
+href="glossaries-user.html#dx1-52095" >7
\ac  7
+href="glossaries-user.html#dx1-52093" >8
accsupp package  8, 9
+href="glossaries-user.html#dx1-72002" >9, 10
\Acf  10
+href="glossaries-user.html#dx1-52087" >11
\acf  11
+href="glossaries-user.html#dx1-52085" >12
\Acfp  12
+href="glossaries-user.html#dx1-52091" >13
\acfp  13
+href="glossaries-user.html#dx1-52089" >14
\Acl  14
+href="glossaries-user.html#dx1-52079" >15
\acl  15
+href="glossaries-user.html#dx1-52077" >16
\Aclp  16
+href="glossaries-user.html#dx1-52083" >17
\aclp  17
+href="glossaries-user.html#dx1-52081" >18
\Acp  18
+href="glossaries-user.html#dx1-52099" >19
\acp  19
+href="glossaries-user.html#dx1-52097" >20
\ACRfull  20
+href="glossaries-user.html#dx1-52058" >21
\Acrfull  21, 22
+href="glossaries-user.html#dx1-52057" >22, 23
\acrfull  23, 24, 25, 26, 27, 28
+href="glossaries-user.html#dx1-52054" >24, 25, 26, 27, 28, 29
\ACRfullfmt  29
+href="glossaries-user.html#dx1-52060" >30
\Acrfullfmt  30
+href="glossaries-user.html#dx1-52059" >31
\acrfullfmt  31, 32, 33
+href="glossaries-user.html#dx1-52056" >32, 33, 34
\ACRfullpl  34
+href="glossaries-user.html#dx1-52063" >35
\Acrfullpl  35, 36
+href="glossaries-user.html#dx1-52062" >36, 37
\acrfullpl  37, 38
+href="glossaries-user.html#dx1-52061" >38, 39
\ACRfullplfmt  39
-\Acrfullplfmt  40
\acrfullplfmt  \Acrfullplfmt  41
\ACRlong  \acrfullplfmt  42
+\ACRlong  43
\Acrlong  43, 44
+href="glossaries-user.html#dx1-52049" >44, 45
\acrlong  45, 46
+href="glossaries-user.html#dx1-52048" >46, 47
\ACRlongpl  47
+href="glossaries-user.html#dx1-52053" >48
\Acrlongpl  48, 49
+href="glossaries-user.html#dx1-52052" >49, 50
\acrlongpl  50, 51
+href="glossaries-user.html#dx1-52051" >51, 52
acronym styles:
     dua  52, 53, 54, 55
+href="glossaries-user.html#dx1-54018" >53, 54, 55, 56
    dua-desc  56, 57
+href="glossaries-user.html#dx1-54048" >57, 58
    footnote  58, 59, 60
+href="glossaries-user.html#dx1-54019" >59, 60, 61
    footnote-desc  61
+href="glossaries-user.html#dx1-54070" >62
    footnote-sc  62
+href="glossaries-user.html#dx1-54060" >63
    footnote-sc-desc  63, 64, 65, 66
+href="glossaries-user.html#dx1-5035" >64, 65, 66, 67
    footnote-sm  67
+href="glossaries-user.html#dx1-54061" >68
    footnote-sm-desc  68
+href="glossaries-user.html#dx1-54072" >69
    long-sc-short  69, 70, 71, 72
+href="glossaries-user.html#dx1-54007" >70, 71, 72, 73
    long-sc-short-desc  73
+href="glossaries-user.html#dx1-54033" >74
    long-short  74, 75, 76, 77, 78, 79
+href="glossaries-user.html#dx1-40050" >75, 76, 77, 78, 79, 80
    long-short-desc  80, 81, 82
+href="glossaries-user.html#dx1-54032" >81, 82, 83
    long-sm-short  83, 84, 85
+href="glossaries-user.html#dx1-54011" >84, 85, 86
    long-sm-short-desc  86
+href="glossaries-user.html#dx1-54034" >87
    sc-short-long  87
+href="glossaries-user.html#dx1-54027" >88
    sc-short-long-desc  88
+href="glossaries-user.html#dx1-54044" >89
    short-long  89
+href="glossaries-user.html#dx1-54026" >90
    short-long-desc  90
+href="glossaries-user.html#dx1-54043" >91
    sm-short-long  91
+href="glossaries-user.html#dx1-54028" >92
    sm-short-long-desc  92
+href="glossaries-user.html#dx1-54045" >93
\acronymentry  93, 94, 95, 96, 97, 98
+href="glossaries-user.html#dx1-53010" >94, 95, 96, 97, 98, 99
\acronymfont  99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109
+href="glossaries-user.html#dx1-19021" >100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110
\acronymname  110
+href="glossaries-user.html#dx1-7019" >111
\acronymsort  111, 112, 113, 114, 115
+href="glossaries-user.html#dx1-53012" >112, 113, 114, 115, 116
\acronymtype  116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126
+href="glossaries-user.html#dx1-14077" >117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128
\ACRshort  127
+href="glossaries-user.html#dx1-52044" >129
\Acrshort  128, 129
+href="glossaries-user.html#dx1-52043" >130, 131
\acrshort  130, 131, 132
+href="glossaries-user.html#dx1-52040" >132, 133, 134
\ACRshortpl  133
+href="glossaries-user.html#dx1-52047" >135
\Acrshortpl  134, 135
+href="glossaries-user.html#dx1-52046" >136, 137
\acrshortpl  136, 137
+href="glossaries-user.html#dx1-52045" >138, 139
\Acs  138
+href="glossaries-user.html#dx1-52071" >140
\acs  139
+href="glossaries-user.html#dx1-52069" >141
\Acsp  140
+href="glossaries-user.html#dx1-52075" >142
\acsp  141
+href="glossaries-user.html#dx1-52073" >143
\addcontentsline  142
+href="glossaries-user.html#dx1-15007" >144
align (environment)  143
+href="glossaries-user.html#dx1-58024" >145
\altnewglossary  144
+href="glossaries-user.html#dx1-51012" >146
amsmath package  145
-\andname  146
+href="glossaries-user.html#dx1-58023" >147
+\andname  148
arara  147
+href="glossaries-user.html#dx1-8020" >149
array package  148, 149
+href="glossaries-user.html#dx1-63006" >150, 151

B babel package  150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165
+href="glossaries-user.html#dx1-7001" >152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167
beamer class  166, 167
+href="glossaries-user.html#dx1-58019" >168, 169
beamer package  168
+href="glossaries-user.html#dx1-7031" >170

C \chapter  169
+href="glossaries-user.html#dx1-46047" >171
\chapter*  170, 171
+href="glossaries-user.html#dx1-15047" >172, 173
\currentglossary  172
+href="glossaries-user.html#dx1-69073" >174

D +datatool package  175, 176, 177, 178
\DeclareAcronymList  173, 174, 175
+href="glossaries-user.html#dx1-18022" >179, 180, 181
\defentryfmt  176
+href="glossaries-user.html#dx1-52038" >182
\defglsentryfmt  177, 178, 179, 180, 181, 182, 183, 184, 185, 186
+href="glossaries-user.html#dx1-39030" >183, 184, 185, 186, 187, 188, 189, 190, 191, 192
\DefineAcronymShortcuts  187
+href="glossaries-user.html#dx1-18027" >193
\delimN  188
+href="glossaries-user.html#dx1-69057" >194
\delimR  189
+href="glossaries-user.html#dx1-69058" >195
description (environment)  190, 191, 192, 193, 194
+href="glossaries-user.html#dx1-61002" >196, 197, 198, 199, 200
\descriptionname  195
+href="glossaries-user.html#dx1-7022" >201
doc package  196, 197, 198
+href="glossaries-user.html#dx1-9" >202, 203, 204
document (environment)  199, 200, 201
+href="glossaries-user.html#dx1-35003" >205, 206, 207, 208
+\dtlcompare  209
+\dtlicompare  210
+\dtlletterindexcompare  211
+\dtlwordindexcompare  212

E \emph  202
+href="glossaries-user.html#dx1-39050" >213
entry location  203
+class="cmbx-10">214
\entryname  204
+href="glossaries-user.html#dx1-7021" >215
environments:
     align  205
+href="glossaries-user.html#dx1-58025" >216
    description  206, 207, 208, 209, 210
+href="glossaries-user.html#dx1-61003" >217, 218, 219, 220, 221
    document  211, 212, 213
+href="glossaries-user.html#dx1-35004" >222, 223, 224, 225
    equation  214
+href="glossaries-user.html#dx1-5053" >226
    frame  215
+href="glossaries-user.html#dx1-58018" >227
    itemize  216
+href="glossaries-user.html#dx1-69077" >228
+ +     longtable  217, 218, 219, 220, 221, 222
+href="glossaries-user.html#dx1-62003" >229, 230, 231, 232, 233, 234
    multicols  223, 224
+href="glossaries-user.html#dx1-67003" >235, 236
    supertabular  225, 226, 227, 228, 229
+href="glossaries-user.html#dx1-64003" >237, 238, 239, 240, 241
    theglossary  230, 231, 232, 233
+href="glossaries-user.html#dx1-69003" >242, 243, 244, 245
equation (environment)  234
+href="glossaries-user.html#dx1-5052" >246
etex package  235
- - +href="glossaries-user.html#dx1-14024" >247
etoolbox package  236, 237
+href="glossaries-user.html#dx1-17041" >248, 249
+Extended Latin Alphabet  250
+extended Latin character  251, 252, 253, 254, 255, 256

F file types
     .alg  238
+href="glossaries-user.html#dx1-8093" >257
    .aux  239, 240, 241
+href="glossaries-user.html#dx1-9003" >258, 259, 260
    .glg  242, 243, 244, 245
+href="glossaries-user.html#dx1-8092" >261, 262, 263, 264
    .glg2  246
+href="glossaries-user.html#dx1-13" >265
    .glo  247, 248, 249, 250, 251
+href="glossaries-user.html#dx1-9033" >266, 267, 268, 269
    .gls  252, 253, 254
+href="glossaries-user.html#dx1-10024" >270, 271
    .glsdefs  255
+href="glossaries-user.html#dx1-36007" >272
    .ist  256, 257, 258, 259, 260, 261
+href="glossaries-user.html#dx1-11007" >273, 274, 275, 276, 277, 278
    .log  262
+href="glossaries-user.html#dx1-73072" >279
    .tex  263, 264
+href="glossaries-user.html#dx1-10016" >280, 281
    .xdy  265, 266, 267, 268, 269, 270, 271, 272
+href="glossaries-user.html#dx1-10019" >282, 283, 284, 285, 286, 287, 288, 289
    glo2  273
+href="glossaries-user.html#dx1-12" >290
    gls2  274
+href="glossaries-user.html#dx1-11" >291
first use  275
+href="glossaries-user.html#dx1-3018" >292
    flag  276, 277
+href="glossaries-user.html#dx1-3026" >293, 294
    text  278
+href="glossaries-user.html#dx1-3028" >295
\firstacronymfont  279, 280, 281, 282, 283, 284, 285, 286
+href="glossaries-user.html#dx1-40045" >296, 297, 298, 299, 300, 301, 302, 303
flowfram package  287
+href="glossaries-user.html#dx1-64011" >304
fmtcount package  288
+href="glossaries-user.html#dx1-49039" >305
\footnote  289
+href="glossaries-user.html#dx1-54062" >306
\forallglossaries  290
+href="glossaries-user.html#dx1-70001" >307
\forallglsentries  291
+href="glossaries-user.html#dx1-70004" >308
\forglsentries  292
+href="glossaries-user.html#dx1-70002" >309
frame (environment)  293
+href="glossaries-user.html#dx1-58017" >310

G \Genacrfullformat  294
+href="glossaries-user.html#dx1-40046" >311
\genacrfullformat  295, 296, 297, 298, 299, 300
+href="glossaries-user.html#dx1-40040" >312, 313, 314, 315, 316, 317
\GenericAcronymFields  301, 302, 303
+href="glossaries-user.html#dx1-55022" >318, 319, 320
\Genplacrfullformat  304
+href="glossaries-user.html#dx1-40047" >321
\genplacrfullformat  305, 306
+href="glossaries-user.html#dx1-40042" >322, 323
german package  307
+href="glossaries-user.html#dx1-7010" >324
+ + glossaries-accsupp package  308, 309, 310, 311, 312
+href="glossaries-user.html#dx1-5139" >325, 326, 327, 328, 329
glossaries-babel package  313, 314
+href="glossaries-user.html#dx1-14044" >330, 331
glossaries-polyglossia package  315, 316
+href="glossaries-user.html#dx1-7037" >332, 333
glossaries-prefix package  317, 318, 319, 320, 321
+href="glossaries-user.html#dx1-5137" >334, 335, 336, 337, 338
glossary counters:
     glossaryentry  322
+class="cmti-10">339
    glossarysubentry  323
+class="cmti-10">340
glossary package  324, 325, 326, 327, 328, 329
- - +href="glossaries-user.html#dx1-4" >341, 342, 343, 344, 345, 346
glossary styles:
     altlist  330, 331, 332, 333, 334
+href="glossaries-user.html#dx1-54042" >347, 348, 349, 350, 351
    altlistgroup  335, 336
+href="glossaries-user.html#dx1-61024" >352, 353
    altlisthypergroup  337
+href="glossaries-user.html#dx1-61026" >354
    altlong4col  338, 339, 340
+href="glossaries-user.html#dx1-60019" >355, 356, 357
    altlong4colborder  341
+href="glossaries-user.html#dx1-62044" >358
    altlong4colheader  342
+href="glossaries-user.html#dx1-62046" >359
    altlong4colheaderborder  343
+href="glossaries-user.html#dx1-62048" >360
    altlongragged4col  344, 345, 346
+href="glossaries-user.html#dx1-63031" >361, 362, 363
    altlongragged4colborder  347
+href="glossaries-user.html#dx1-63035" >364
    altlongragged4colheader  348, 349
+href="glossaries-user.html#dx1-63037" >365, 366
    altlongragged4colheaderborder  350
+href="glossaries-user.html#dx1-63039" >367
    altsuper4col  351, 352, 353
+href="glossaries-user.html#dx1-60020" >368, 369, 370
    altsuper4colborder  354
+href="glossaries-user.html#dx1-64050" >371
    altsuper4colheader  355
+href="glossaries-user.html#dx1-64052" >372
    altsuper4colheaderborder  356
+href="glossaries-user.html#dx1-64054" >373
    altsuperragged4col  357, 358, 359
+href="glossaries-user.html#dx1-65034" >374, 375, 376
    altsuperragged4colborder  360
+href="glossaries-user.html#dx1-65036" >377
    altsuperragged4colheader  361, 362
+href="glossaries-user.html#dx1-65038" >378, 379
    altsuperragged4colheaderborder  363
+href="glossaries-user.html#dx1-65040" >380
    alttree  364, 365, 366, 367
+href="glossaries-user.html#dx1-66018" >381, 382, 383, 384
    alttreegroup  368, 369, 370
+href="glossaries-user.html#dx1-66034" >385, 386, 387
    alttreehypergroup  371, 372
+href="glossaries-user.html#dx1-66036" >388, 389
    index  373, 374, 375, 376, 377
+href="glossaries-user.html#dx1-66004" >390, 391, 392, 393, 394
    indexgroup  378, 379, 380
+href="glossaries-user.html#dx1-66006" >395, 396, 397
    indexhypergroup  381, 382
+href="glossaries-user.html#dx1-66008" >398, 399
    inline  383, 384, 385
+href="glossaries-user.html#dx1-5076" >400, 401, 402
    list  386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399
+href="glossaries-user.html#dx1-16044" >403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416
    listdotted  400, 401, 402
+href="glossaries-user.html#dx1-60031" >417, 418, 419
    listgroup  403, 404
+href="glossaries-user.html#dx1-61013" >420, 421
    listhypergroup  405, 406, 407, 408, 409, 410, 411
+href="glossaries-user.html#dx1-61015" >422, 423, 424, 425, 426, 427, 428
    long  412, 413, 414, 415, 416
+href="glossaries-user.html#dx1-60027" >429, 430, 431, 432, 433
    long3col  417, 418, 419, 420, 421
+href="glossaries-user.html#dx1-60005" >434, 435, 436, 437, 438
    long3colborder  422, 423
+href="glossaries-user.html#dx1-60007" >439, 440
    long3colheader  424, 425, 426
+href="glossaries-user.html#dx1-60006" >441, 442, 443
    long3colheaderborder  427, 428
+href="glossaries-user.html#dx1-60008" >444, 445
    long4col  429, 430, 431, 432, 433
+href="glossaries-user.html#dx1-60017" >446, 447, 448, 449, 450
    long4colborder  434, 435
+href="glossaries-user.html#dx1-62034" >451, 452
+ +     long4colheader  436, 437, 438
+href="glossaries-user.html#dx1-62036" >453, 454, 455
    long4colheaderborder  439, 440
+href="glossaries-user.html#dx1-62038" >456, 457
    longborder  441
+href="glossaries-user.html#dx1-62013" >458
    longheader  442, 443, 444
+href="glossaries-user.html#dx1-62015" >459, 460, 461
    longheaderborder  445, 446
+href="glossaries-user.html#dx1-62017" >462, 463
    longragged  447, 448, 449, 450
+href="glossaries-user.html#dx1-63009" >464, 465, 466, 467
    longragged3col  451, 452, 453, 454
+href="glossaries-user.html#dx1-63019" >468, 469, 470, 471
    longragged3colborder  455
- - +href="glossaries-user.html#dx1-63025" >472
    longragged3colheader  456, 457
+href="glossaries-user.html#dx1-63027" >473, 474
    longragged3colheaderborder  458
+href="glossaries-user.html#dx1-63029" >475
    longraggedborder  459
+href="glossaries-user.html#dx1-63013" >476
    longraggedheader  460, 461
+href="glossaries-user.html#dx1-63015" >477, 478
    longraggedheaderborder  462
+href="glossaries-user.html#dx1-63017" >479
    mcolalttree  463
+href="glossaries-user.html#dx1-67032" >480
    mcolalttreegroup  464
+href="glossaries-user.html#dx1-67034" >481
    mcolalttreehypergroup  465
+href="glossaries-user.html#dx1-67036" >482
    mcolindex  466, 467
+href="glossaries-user.html#dx1-67005" >483, 484
    mcolindexgroup  468
+href="glossaries-user.html#dx1-67016" >485
    mcolindexhypergroup  469
+href="glossaries-user.html#dx1-67018" >486
    mcoltree  470
+href="glossaries-user.html#dx1-67020" >487
    mcoltreegroup  471
+href="glossaries-user.html#dx1-67022" >488
    mcoltreehypergroup  472
+href="glossaries-user.html#dx1-67024" >489
    mcoltreenoname  473
+href="glossaries-user.html#dx1-67026" >490
    mcoltreenonamegroup  474
+href="glossaries-user.html#dx1-67028" >491
    mcoltreenonamehypergroup  475
+href="glossaries-user.html#dx1-67030" >492
    super  476, 477, 478, 479
+href="glossaries-user.html#dx1-64012" >493, 494, 495, 496
    super3col  480, 481, 482, 483
+href="glossaries-user.html#dx1-64025" >497, 498, 499, 500
    super3colborder  484
+href="glossaries-user.html#dx1-64031" >501
    super3colheader  485, 486
+href="glossaries-user.html#dx1-64033" >502, 503
    super3colheaderborder  487
+href="glossaries-user.html#dx1-64035" >504
    super4col  488, 489, 490, 491, 492
+href="glossaries-user.html#dx1-60018" >505, 506, 507, 508, 509
    super4colborder  493, 494
+href="glossaries-user.html#dx1-64040" >510, 511
    super4colheader  495, 496, 497
+href="glossaries-user.html#dx1-64042" >512, 513, 514
    super4colheaderborder  498, 499
+href="glossaries-user.html#dx1-64044" >515, 516
    superborder  500
+href="glossaries-user.html#dx1-64019" >517
    superheader  501, 502
+href="glossaries-user.html#dx1-64021" >518, 519
    superheaderborder  503, 504
+href="glossaries-user.html#dx1-46059" >520, 521
    superragged  505, 506, 507, 508
+href="glossaries-user.html#dx1-65009" >522, 523, 524, 525
    superragged3col  509, 510, 511, 512
+href="glossaries-user.html#dx1-65022" >526, 527, 528, 529
    superragged3colborder  513
+href="glossaries-user.html#dx1-65028" >530
    superragged3colheader  514, 515
+href="glossaries-user.html#dx1-65030" >531, 532
    superragged3colheaderborder  516
+href="glossaries-user.html#dx1-65032" >533
    superraggedborder  517
+href="glossaries-user.html#dx1-65016" >534
    superraggedheader  518, 519
+href="glossaries-user.html#dx1-65018" >535, 536
    superraggedheaderborder  520
+href="glossaries-user.html#dx1-65020" >537
    tree  521, 522, 523, 524, 525, 526
+href="glossaries-user.html#dx1-55069" >538, 539, 540, 541, 542, 543
+ +     treegroup  527, 528, 529
+href="glossaries-user.html#dx1-66019" >544, 545, 546
    treehypergroup  530, 531
+href="glossaries-user.html#dx1-66021" >547, 548
    treenoname  532, 533, 534
+href="glossaries-user.html#dx1-66024" >549, 550, 551
    treenonamegroup  535, 536, 537
+href="glossaries-user.html#dx1-66026" >552, 553, 554
    treenonamehypergroup  538, 539
+href="glossaries-user.html#dx1-66028" >555, 556
glossary-inline package  540, 541
+href="glossaries-user.html#dx1-68001" >557, 558
glossary-list package  542, 543, 544, 545, 546
+href="glossaries-user.html#dx1-16029" >559, 560, 561, 562, 563
glossary-long package  547, 548, 549, 550, 551, 552
- - +href="glossaries-user.html#dx1-16030" >564, 565, 566, 567, 568, 569
glossary-longragged package  553, 554, 555
+href="glossaries-user.html#dx1-63001" >570, 571, 572
glossary-mcols package  556, 557, 558, 559
+href="glossaries-user.html#dx1-16050" >573, 574, 575, 576
glossary-super package  560, 561, 562, 563, 564, 565
+href="glossaries-user.html#dx1-16031" >577, 578, 579, 580, 581, 582
glossary-superragged package  566, 567, 568
+href="glossaries-user.html#dx1-65001" >583, 584, 585
glossary-tree package  569, 570, 571, 572, 573
+href="glossaries-user.html#dx1-16032" >586, 587, 588, 589, 590
glossaryentry (counter)  574, 575, 576, 577
+class="cmti-10">591, 592, 593, 594
\glossaryentrynumbers  578, 579, 580, 581
+href="glossaries-user.html#dx1-69055" >595, 596, 597, 598
\glossaryheader  582, 583, 584, 585
+href="glossaries-user.html#dx1-61019" >599, 600, 601, 602
\glossaryname  586, 587
+href="glossaries-user.html#dx1-7018" >603, 604
\glossarypostamble  588, 589, 590
+href="glossaries-user.html#dx1-41039" >605, 606, 607
\glossarypreamble  591, 592, 593, 594
+href="glossaries-user.html#dx1-16017" >608, 609, 610, 611
\glossarysection  595
+href="glossaries-user.html#dx1-68005" >612
\glossarystyle  596
+href="glossaries-user.html#dx1-46028" >613
glossarysubentry (counter)  597
+class="cmti-10">614
\glossentry  598, 599, 600
+href="glossaries-user.html#dx1-69040" >615, 616, 617
\Glossentrydesc  601
+href="glossaries-user.html#dx1-45028" >618
\glossentrydesc  602, 603
+href="glossaries-user.html#dx1-45027" >619, 620
\Glossentryname  604, 605
+href="glossaries-user.html#dx1-45010" >621, 622
\glossentryname  606, 607, 608
+href="glossaries-user.html#dx1-45009" >623, 624, 625
\Glossentrysymbol  609
+href="glossaries-user.html#dx1-45034" >626
\glossentrysymbol  610, 611
+href="glossaries-user.html#dx1-45033" >627, 628
\GLS  612, 613, 614, 615
+href="glossaries-user.html#dx1-3021" >629, 630, 631, 632
\Gls  616, 617, 618, 619, 620, 621, 622, 623, 624, 625
+href="glossaries-user.html#dx1-3020" >633, 634, 635, 636, 637, 638, 639, 640, 641, 642
\gls  626, 627, 628, 629, 630, 631, 632, 633, 634, 635, 636, 637, 638, 639, 640, 641, 642, 643, 644, 645, 646, 647, 648, 649, 650, 651, 652, 653, 654, 655, 656, 657, 658, 659, 660, 661, 662
+href="glossaries-user.html#dx1-3019" >643, 644, 645, 646, 647, 648, 649, 650, 651, 652, 653, 654, 655, 656, 657, 658, 659, 660, 661, 662, 663, 664, 665, 666, 667, 668, 669, 670, 671, 672, 673, 674, 675, 676, 677, 678, 679
\gls*  663
+href="glossaries-user.html#dx1-14073" >680
\glsadd  664
+href="glossaries-user.html#dx1-42001" >681
\glsaddall  665, 666
+href="glossaries-user.html#dx1-5042" >682, 683
\glsaddall options
     types  667
+href="glossaries-user.html#dx1-42006" >684
\glsaddallunused  668
+href="glossaries-user.html#dx1-42011" >685
\glsaddkey  669, 670, 671, 672
+href="glossaries-user.html#dx1-25103" >686, 687, 688, 689
\GlsAddXdyAttribute  673, 674
+href="glossaries-user.html#dx1-39056" >690, 691
\GlsAddXdyCounters  675, 676
+href="glossaries-user.html#dx1-49011" >692, 693
\GlsAddXdyLocation  677, 678
+href="glossaries-user.html#dx1-49027" >694, 695
\glsautoprefix  679
+class="cmti-10">696
\glscapscase  680, 681
+href="glossaries-user.html#dx1-40023" >697, 698
\glsclearpage  682
+class="cmti-10">699
+ + \glsclosebrace  683
+href="glossaries-user.html#dx1-47013" >700
\glscustomtext  684, 685
+href="glossaries-user.html#dx1-40017" >701, 702
\GlsDeclareNoHyperList  686, 687, 688, 689, 690
+href="glossaries-user.html#dx1-14078" >703, 704, 705, 706, 707
\glsdefaulttype  691, 692, 693, 694, 695, 696
+href="glossaries-user.html#dx1-33005" >708, 709, 710, 711, 712, 713
\GLSdesc  697
+href="glossaries-user.html#dx1-39158" >714
\Glsdesc  698
+href="glossaries-user.html#dx1-39157" >715
\glsdesc  699
+href="glossaries-user.html#dx1-39154" >716
\glsdescwidth  700, 701, 702, 703, 704, 705, 706, 707, 708, 709, 710, 711
- - +href="glossaries-user.html#dx1-60011" >717, 718, 719, 720, 721, 722, 723, 724, 725, 726, 727, 728
\glsdisablehyper  712, 713
+href="glossaries-user.html#dx1-41006" >729, 730
\glsdisp  714, 715, 716, 717, 718, 719, 720, 721, 722
+href="glossaries-user.html#dx1-3025" >731, 732, 733, 734, 735, 736, 737, 738, 739
\glsdisplay  723, 724
+href="glossaries-user.html#dx1-25064" >740, 741
\glsdisplayfirst  725, 726
+href="glossaries-user.html#dx1-25065" >742, 743
\glsdisplaynumberlist  727, 728
+href="glossaries-user.html#dx1-4097" >744, 745, 746
\glsdoifexists  729
+href="glossaries-user.html#dx1-70009" >747
\glsdoifexistsorwarn  730
+href="glossaries-user.html#dx1-70011" >748
\glsdoifnoexists  731
+href="glossaries-user.html#dx1-70010" >749
\glsdosanitizesort  732
+href="glossaries-user.html#dx1-17028" >750
\glsenablehyper  733
+href="glossaries-user.html#dx1-41007" >751
\glsentrycounterlabel  734
+href="glossaries-user.html#dx1-69051" >752
\Glsentrydesc  735
+href="glossaries-user.html#dx1-45026" >753
\glsentrydesc  736
+href="glossaries-user.html#dx1-45025" >754
\Glsentrydescplural  737
+href="glossaries-user.html#dx1-45030" >755
\glsentrydescplural  738
+href="glossaries-user.html#dx1-45029" >756
\Glsentryfirst  739
+href="glossaries-user.html#dx1-45018" >757
\glsentryfirst  740
+href="glossaries-user.html#dx1-45017" >758
\Glsentryfirstplural  741
+href="glossaries-user.html#dx1-45022" >759
\glsentryfirstplural  742
+href="glossaries-user.html#dx1-45021" >760
\glsentryfmt  743, 744, 745, 746, 747, 748, 749, 750, 751, 752, 753
+href="glossaries-user.html#dx1-5134" >761, 762, 763, 764, 765, 766, 767, 768, 769, 770, 771
\Glsentryfull  754
+href="glossaries-user.html#dx1-52112" >772
\glsentryfull  755, 756, 757, 758, 759, 760
+href="glossaries-user.html#dx1-52111" >773, 774, 775, 776, 777, 778
\Glsentryfullpl  761
+href="glossaries-user.html#dx1-52114" >779
\glsentryfullpl  762
+href="glossaries-user.html#dx1-52113" >780
\glsentryitem  763, 764
+href="glossaries-user.html#dx1-69048" >781, 782
\Glsentrylong  765, 766, 767, 768
+href="glossaries-user.html#dx1-40049" >783, 784, 785, 786
\glsentrylong  769, 770, 771
+href="glossaries-user.html#dx1-52103" >787, 788, 789
\Glsentrylongpl  772, 773
+href="glossaries-user.html#dx1-52106" >790, 791
\glsentrylongpl  774, 775
+href="glossaries-user.html#dx1-52105" >792, 793
\Glsentryname  776
+href="glossaries-user.html#dx1-45007" >794
\glsentryname  777, 778
+href="glossaries-user.html#dx1-45006" >795, 796
\glsentrynumberlist  779, 780
+href="glossaries-user.html#dx1-14083" >797, 798
\Glsentryplural  781
+href="glossaries-user.html#dx1-45015" >799
\glsentryplural  782
+href="glossaries-user.html#dx1-45014" >800
\Glsentryprefix  783
+href="glossaries-user.html#dx1-71062" >801
\glsentryprefix  784
+href="glossaries-user.html#dx1-71053" >802
\Glsentryprefixfirst  785
+href="glossaries-user.html#dx1-71063" >803
\glsentryprefixfirst  786
+href="glossaries-user.html#dx1-71055" >804
+ + \Glsentryprefixfirstplural  787
+href="glossaries-user.html#dx1-71065" >805
\glsentryprefixfirstplural  788
+href="glossaries-user.html#dx1-71059" >806
\Glsentryprefixplural  789
+href="glossaries-user.html#dx1-71064" >807
\glsentryprefixplural  790
+href="glossaries-user.html#dx1-71057" >808
\Glsentryshort  791
+href="glossaries-user.html#dx1-52108" >809
\glsentryshort  792
+href="glossaries-user.html#dx1-52107" >810
\Glsentryshortpl  793
+href="glossaries-user.html#dx1-52110" >811
\glsentryshortpl  794
- - +href="glossaries-user.html#dx1-52109" >812
\Glsentrysymbol  795
+href="glossaries-user.html#dx1-45032" >813
\glsentrysymbol  796, 797
+href="glossaries-user.html#dx1-40061" >814, 815
\Glsentrysymbolplural  798
+href="glossaries-user.html#dx1-45036" >816
\glsentrysymbolplural  799
+href="glossaries-user.html#dx1-45035" >817
\Glsentrytext  800, 801, 802, 803, 804
+href="glossaries-user.html#dx1-28005" >818, 819, 820, 821, 822
\glsentrytext  805, 806, 807, 808, 809, 810
+href="glossaries-user.html#dx1-28004" >823, 824, 825, 826, 827, 828
\Glsentryuseri  811
+href="glossaries-user.html#dx1-45038" >829
\glsentryuseri  812, 813
+href="glossaries-user.html#dx1-45037" >830, 831
\Glsentryuserii  814
+href="glossaries-user.html#dx1-45040" >832
\glsentryuserii  815
+href="glossaries-user.html#dx1-45039" >833
\Glsentryuseriii  816
+href="glossaries-user.html#dx1-45042" >834
\glsentryuseriii  817
+href="glossaries-user.html#dx1-45041" >835
\Glsentryuseriv  818
+href="glossaries-user.html#dx1-45044" >836
\glsentryuseriv  819
+href="glossaries-user.html#dx1-45043" >837
\Glsentryuserv  820
+href="glossaries-user.html#dx1-45046" >838
\glsentryuserv  821
+href="glossaries-user.html#dx1-45045" >839
\Glsentryuservi  822
+href="glossaries-user.html#dx1-45048" >840
\glsentryuservi  823
+href="glossaries-user.html#dx1-45047" >841
\glsexpandfields  824
+href="glossaries-user.html#dx1-29022" >842
\GLSfirst  825
+href="glossaries-user.html#dx1-39133" >843
\Glsfirst  826
+href="glossaries-user.html#dx1-39132" >844
\glsfirst  827
+href="glossaries-user.html#dx1-39129" >845
\GLSfirstplural  828
+href="glossaries-user.html#dx1-39143" >846
\Glsfirstplural  829
+href="glossaries-user.html#dx1-39142" >847
\glsfirstplural  830
+href="glossaries-user.html#dx1-39139" >848
\glsgenacfmt  831, 832, 833, 834, 835, 836
+href="glossaries-user.html#dx1-40031" >849, 850, 851, 852, 853, 854
\glsgenentryfmt  837, 838, 839
+href="glossaries-user.html#dx1-40025" >855, 856, 857
\glsgetgrouptitle  840
+href="glossaries-user.html#dx1-69028" >858
\glsglossarymark  841, 842, 843, 844, 845
+class="cmti-10">859, 860, 861, 862, 863
\glsgroupheading  846, 847
+href="glossaries-user.html#dx1-69020" >864, 865
\glsgroupskip  848, 849, 850
+href="glossaries-user.html#dx1-60025" >866, 867, 868
\glshyperlink  851, 852, 853
+href="glossaries-user.html#dx1-41033" >869, 870, 871
\glshypernavsep  854
+href="glossaries-user.html#dx1-61017" >872
\glsIfListOfAcronyms  855
+href="glossaries-user.html#dx1-18025" >873
\glsifplural  856, 857
+href="glossaries-user.html#dx1-40022" >874, 875
\glsinlineparentchildseparator  858, 859
+href="glossaries-user.html#dx1-68013" >876, 877
\glsinlineseparator  860, 861
+href="glossaries-user.html#dx1-68009" >878, 879
\glsinlinesubseparator  862, 863
+href="glossaries-user.html#dx1-68011" >880, 881
+ + \glsinsert  864
+href="glossaries-user.html#dx1-40021" >882
\glslabel  865
+href="glossaries-user.html#dx1-40016" >883
\glslabeltok  866
+href="glossaries-user.html#dx1-55024" >884
\glslink  867, 868, 869, 870, 871, 872, 873, 874, 875, 876, 877
+href="glossaries-user.html#dx1-39040" >885, 886, 887, 888, 889, 890, 891, 892, 893, 894, 895
\glslink options
     counter  878, 879
+href="glossaries-user.html#dx1-39080" >896, 897
    format  880, 881, 882, 883, 884
+href="glossaries-user.html#dx1-39043" >898, 899, 900, 901, 902
    hyper  885, 886, 887, 888
- - +href="glossaries-user.html#dx1-39024" >903, 904, 905, 906
    local  889
+href="glossaries-user.html#dx1-39085" >907
\glslink*  890
+href="glossaries-user.html#dx1-39089" >908
\glslistdottedwidth  891
+href="glossaries-user.html#dx1-61034" >909
\glslocalreset  892
+href="glossaries-user.html#dx1-58007" >910
\glslocalresetall  893
+href="glossaries-user.html#dx1-58011" >911
\glslocalunset  894
+href="glossaries-user.html#dx1-58009" >912
\glslocalunsetall  895
+href="glossaries-user.html#dx1-58013" >913
\glslongtok  896
+href="glossaries-user.html#dx1-55025" >914
\glsmcols  897
+href="glossaries-user.html#dx1-67011" >915
\glsmoveentry  898
+href="glossaries-user.html#dx1-34001" >916
\GLSname  899
+href="glossaries-user.html#dx1-39148" >917
\Glsname  900
+href="glossaries-user.html#dx1-39147" >918
\glsname  901
+href="glossaries-user.html#dx1-39144" >919
\glsnamefont  902, 903
+href="glossaries-user.html#dx1-46064" >920, 921
\glsnavhypertarget  904
+href="glossaries-user.html#dx1-69033" >922
\glsnoexpandfields  905
+href="glossaries-user.html#dx1-29023" >923
+\glsnoidxdisplayloc  924
\glsnumberformat  906
+href="glossaries-user.html#dx1-49048" >925
+\glsnumberlistloop  926
\glsnumbersgroupname  907
+href="glossaries-user.html#dx1-7026" >927
\glsnumbersgrouptitle  908
+href="glossaries-user.html#dx1-69030" >928
\glsnumlistlastsep  909
+href="glossaries-user.html#dx1-45068" >929
\glsnumlistsep  910
+href="glossaries-user.html#dx1-45067" >930
\glsopenbrace  911
+href="glossaries-user.html#dx1-47012" >931
\glspagelistwidth  912, 913, 914, 915, 916, 917, 918, 919
+href="glossaries-user.html#dx1-60012" >932, 933, 934, 935, 936, 937, 938, 939
\glspar  920
+href="glossaries-user.html#dx1-25019" >940
\GLSpl  921, 922, 923, 924, 925
+href="glossaries-user.html#dx1-3024" >941, 942, 943, 944, 945
\Glspl  926, 927, 928, 929, 930, 931, 932
+href="glossaries-user.html#dx1-3023" >946, 947, 948, 949, 950, 951, 952
\glspl  933, 934, 935, 936, 937, 938, 939, 940, 941, 942, 943, 944, 945, 946
+href="glossaries-user.html#dx1-3022" >953, 954, 955, 956, 957, 958, 959, 960, 961, 962, 963, 964, 965, 966
\GLSplural  947
+href="glossaries-user.html#dx1-39138" >967
\Glsplural  948
+href="glossaries-user.html#dx1-39137" >968
\glsplural  949
+href="glossaries-user.html#dx1-39134" >969
\glspluralsuffix  950, 951, 952, 953
+href="glossaries-user.html#dx1-25040" >970, 971, 972, 973
\glspostdescription  954
+href="glossaries-user.html#dx1-60032" >974
\glspostinline  955, 956
+href="glossaries-user.html#dx1-68015" >975, 976
\glsprestandardsort  957, 958
+href="glossaries-user.html#dx1-17021" >977, 978
\glsquote  959
+href="glossaries-user.html#dx1-47015" >979
\glsrefentry  960, 980, 961, 962
+class="cmti-10">981, 982
+ + \glsreset  963, 964
+href="glossaries-user.html#dx1-52025" >983, 984
\glsresetall  965
+href="glossaries-user.html#dx1-58010" >985
\glsresetentrycounter  966
+class="cmti-10">986
\glssee  967, 968, 969, 970, 971, 972
+href="glossaries-user.html#dx1-16064" >987, 988, 989, 990, 991
\glsseeformat  973, 974, 975
+href="glossaries-user.html#dx1-3001" >992, 993, 994
\glsseeitemformat  976
+href="glossaries-user.html#dx1-44012" >995
\glsseelastsep  977
+href="glossaries-user.html#dx1-44010" >996
\glsseelist  978, 979
+href="glossaries-user.html#dx1-3004" >997, 998
\glsseesep  980
+href="glossaries-user.html#dx1-44009" >999
\glsSetAlphaCompositor  981
- - +href="glossaries-user.html#dx1-24024" >1000
\glsSetCompositor  982
+href="glossaries-user.html#dx1-24023" >1001
\glssetexpandfield  983
+href="glossaries-user.html#dx1-29007" >1002
\glssetnoexpandfield  984
+href="glossaries-user.html#dx1-29008" >1003
\glsSetSuffixF  985
+href="glossaries-user.html#dx1-38019" >1004
\glsSetSuffixFF  986
+href="glossaries-user.html#dx1-38020" >1005
\glssetwidest  987
+href="glossaries-user.html#dx1-66033" >1006
\GlsSetXdyCodePage  988, 989, 990
+href="glossaries-user.html#dx1-8107" >1007, 1008, 1009
\GlsSetXdyFirstLetterAfterDigits  991
+href="glossaries-user.html#dx1-50002" >1010
\GlsSetXdyLanguage  992, 993, 994, 995
+href="glossaries-user.html#dx1-8106" >1011, 1012, 1013, 1014
\GlsSetXdyLocationClassOrder  996
+href="glossaries-user.html#dx1-49058" >1015
\GlsSetXdyMinRangeLength  997, 998
+href="glossaries-user.html#dx1-38012" >1016, 1017
\glsshorttok  999
+href="glossaries-user.html#dx1-55026" >1018
\glssortnumberfmt  1000
+href="glossaries-user.html#dx1-17017" >1019
\glssubentrycounterlabel  1001
+href="glossaries-user.html#dx1-69070" >1020
\glssubentryitem  1002, 1003
+href="glossaries-user.html#dx1-69067" >1021, 1022
\GLSsymbol  1004
+href="glossaries-user.html#dx1-39153" >1023
\Glssymbol  1005
+href="glossaries-user.html#dx1-39152" >1024
\glssymbol  1006, 1007
+href="glossaries-user.html#dx1-39149" >1025, 1026
\glssymbolsgroupname  1008, 1009
+href="glossaries-user.html#dx1-7025" >1027, 1028
\glstarget  1010, 1011
+href="glossaries-user.html#dx1-69052" >1029, 1030
\GLStext  1012, 1013
+href="glossaries-user.html#dx1-28008" >1031, 1032
\Glstext  1014, 1015
+href="glossaries-user.html#dx1-28007" >1033, 1034
\glstext  1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027
+href="glossaries-user.html#dx1-28006" >1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046
\glstextformat  1028, 1029, 1030
+href="glossaries-user.html#dx1-39027" >1047, 1048, 1049
\glstextup  1031
+href="glossaries-user.html#dx1-55035" >1050
\glstocfalse  1032
+class="cmti-10">1051
\glstoctrue  1033
+class="cmti-10">1052
\glstreeindent  1034
+href="glossaries-user.html#dx1-66017" >1053
\glsunset  1035
+href="glossaries-user.html#dx1-58008" >1054
\glsunsetall  1036, 1037
+href="glossaries-user.html#dx1-41026" >1055, 1056
\GlsUseAcrEntryDispStyle  1038
+href="glossaries-user.html#dx1-55031" >1057
\GlsUseAcrStyleDefs  1039
+href="glossaries-user.html#dx1-55032" >1058
\GLSuseri  1040
+href="glossaries-user.html#dx1-39163" >1059
\Glsuseri  1041
+href="glossaries-user.html#dx1-39162" >1060
\glsuseri  1042
+href="glossaries-user.html#dx1-39159" >1061
\GLSuserii  1043
+href="glossaries-user.html#dx1-39166" >1062
+ + \Glsuserii  1044
+href="glossaries-user.html#dx1-39165" >1063
\glsuserii  1045
+href="glossaries-user.html#dx1-39164" >1064
\GLSuseriii  1046
+href="glossaries-user.html#dx1-39169" >1065
\Glsuseriii  1047
+href="glossaries-user.html#dx1-39168" >1066
\glsuseriii  1048
+href="glossaries-user.html#dx1-39167" >1067
\GLSuseriv  1049
+href="glossaries-user.html#dx1-39172" >1068
\Glsuseriv  1050
+href="glossaries-user.html#dx1-39171" >1069
\glsuseriv  1051
+href="glossaries-user.html#dx1-39170" >1070
\GLSuserv  1052
+href="glossaries-user.html#dx1-39175" >1071
\Glsuserv  1053
- - +href="glossaries-user.html#dx1-39174" >1072
\glsuserv  1054
+href="glossaries-user.html#dx1-39173" >1073
\GLSuservi  1055
+href="glossaries-user.html#dx1-39178" >1074
\Glsuservi  1056
+href="glossaries-user.html#dx1-39177" >1075
\glsuservi  1057
+href="glossaries-user.html#dx1-39176" >1076

H html package  1058
+href="glossaries-user.html#dx1-41002" >1077
\hyperbf  1059
+href="glossaries-user.html#dx1-39068" >1078
\hyperbsf  1060
+href="glossaries-user.html#dx1-39076" >1079
\hyperemph  1061
+href="glossaries-user.html#dx1-39074" >1080
\hyperit  1062
+href="glossaries-user.html#dx1-39070" >1081
\hyperlink  1063, 1064, 1065
+href="glossaries-user.html#dx1-39075" >1082, 1083, 1084
\hypermd  1066
+href="glossaries-user.html#dx1-39069" >1085
\hyperpage  1067
+href="glossaries-user.html#dx1-39062" >1086
hyperref package  1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084
+href="glossaries-user.html#dx1-7" >1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096, 1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105
\hyperrm  1085, 1086
+href="glossaries-user.html#dx1-39065" >1106, 1107
\hypersc  1087
+href="glossaries-user.html#dx1-39073" >1108
\hypersf  1088
+href="glossaries-user.html#dx1-39066" >1109
\hypersl  1089
+href="glossaries-user.html#dx1-39071" >1110
\hypertarget  1090
+href="glossaries-user.html#dx1-41009" >1111
\hypertt  1091
+href="glossaries-user.html#dx1-39067" >1112
\hyperup  1092
+href="glossaries-user.html#dx1-39072" >1113

I \ifglossaryexists  1093
+href="glossaries-user.html#dx1-70005" >1114
\ifglsdescsuppressed  1094
+href="glossaries-user.html#dx1-70025" >1115
\ifglsentryexists  1095
+href="glossaries-user.html#dx1-70006" >1116
\ifglshaschildren  1096
+href="glossaries-user.html#dx1-70013" >1117
\ifglshasdesc  1097
+href="glossaries-user.html#dx1-70023" >1118
\ifglshaslong  1098, 1099
+href="glossaries-user.html#dx1-55013" >1119, 1120
\ifglshasparent  1100
+href="glossaries-user.html#dx1-70014" >1121
\ifglshasprefix  1101
+href="glossaries-user.html#dx1-71045" >1122
\ifglshasprefixfirst  1102
+href="glossaries-user.html#dx1-71049" >1123
+ + \ifglshasprefixfirstplural  1103
+href="glossaries-user.html#dx1-71051" >1124
\ifglshasprefixplural  1104
+href="glossaries-user.html#dx1-71047" >1125
\ifglshasshort  1105, 1106
+href="glossaries-user.html#dx1-55012" >1126, 1127
\ifglshassymbol  1107, 1108
+href="glossaries-user.html#dx1-69092" >1128, 1129
\ifglsucmark  1109
+class="cmti-10">1130
\ifglsused  1110, 1111, 1112, 1113
+href="glossaries-user.html#dx1-40024" >1131, 1132, 1133, 1134
imakeidx package  1114
+href="glossaries-user.html#dx1-20022" >1135
+\include  1136
\index  1115, 1116, 1117, 1118, 1119
+href="glossaries-user.html#dx1-20019" >1137, 1138, 1139, 1140, 1141
index package  1120
+href="glossaries-user.html#dx1-20021" >1142
+\indexname  1143
\indexspace  1121, 1122, 1123, 1124, 1125
- - +href="glossaries-user.html#dx1-61012" >1144, 1145, 1146, 1147, 1148
+\input  1149
inputenc package  1126, 1127, 1128, 1129
+href="glossaries-user.html#dx1-5021" >1150, 1151, 1152, 1153, 1154, 1155
\inputencodingname  1130
+href="glossaries-user.html#dx1-48014" >1156
\item  1131, 1132
+href="glossaries-user.html#dx1-61009" >1157, 1158
itemize (environment)  1133
+href="glossaries-user.html#dx1-69076" >1159

J \jobname  1134, 1135
+href="glossaries-user.html#dx1-24015" >1160, 1161

L \label  1136
+href="glossaries-user.html#dx1-15040" >1162
latex  1137, 1138
+href="glossaries-user.html#dx1-17" >1163, 1164
latexmk  1139
+href="glossaries-user.html#dx1-8019" >1165
+Latin alphabet  1166, 1167, 1168, 1169
+Latin character  1170, 1171, 1172, 1173, 1174, 1175
link text  1140, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150
+href="glossaries-user.html#dx1-3046" >1176, 1177, 1178, 1179, 1180, 1181, 1182, 1183, 1184, 1185, 1186
\loadglsentries  1151, 1152, 1153
+href="glossaries-user.html#dx1-33001" >1187, 1188
location list  see number list
+href="glossaries-user.html#dx1-38005" >number list
\longnewglossaryentry  1155, 1156, 1157, 1158
+href="glossaries-user.html#dx1-25003" >1190, 1191, 1192, 1193
\longprovideglossaryentry  1159
+href="glossaries-user.html#dx1-25005" >1194
longtable (environment)  1160, 1161, 1162, 1163, 1164, 1165
+href="glossaries-user.html#dx1-62002" >1195, 1196, 1197, 1198, 1199, 1200
longtable package  1166, 1167
+href="glossaries-user.html#dx1-16035" >1201, 1202

M \makefirstuc  1168, 1169
+href="glossaries-user.html#dx1-40048" >1203, 1204
makeglossaries  1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177, 1178, 1179, 1180, 1181, 1182, 1183, 1184, 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203, 1204, 1205, 1206, 1207, 1208, 1209, 1210, 1211, 1212, 1213, 1214, 1215, 1216, 1217, 1218, 1219, 1220, 1221, 1222, 1223, 1224, 1225, 1226, 1227, 1228, 1229, 1230, 1231, 1232, 1233
+href="glossaries-user.html#dx1-3048" >1205, 1206, 1207, 1208, 1209, 1210, 1211, 1212, 1213, 1214, 1215, 1216, 1217, 1218, 1219, 1220, 1221, 1222, 1223, 1224, 1225, 1226, 1227, 1228, 1229, 1230, 1231, 1232, 1233, 1234, 1235, 1236, 1237, 1238, 1239, 1240, 1241, 1242, 1243, 1244, 1245, 1246, 1247, 1248, 1249, 1250, 1251, 1252, 1253, 1254, 1255, 1256, 1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274, 1275
\makeglossaries  1234, 1235, 1236, 1237, 1238, 1239, 1240, 1241, 1242, 1243, 1244, 1245, 1246, 1247, 1248, 1249, 1250, 1251, 1252, 1253, 1254, 1255
+href="glossaries-user.html#dx1-8027" >1276, 1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296, 1297
makeglossariesgui  1256, 1257, 1258, 1259, 1260, 1261
+href="glossaries-user.html#dx1-3053" >1298, 1299, 1300, 1301, 1302, 1303
makeidx package  1262
+href="glossaries-user.html#dx1-20020" >1304
+ + makeindex  1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274, 1275, 1276, 1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335
+href="glossaries-user.html#dx1-3035" >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, 1378, 1379, 1380, 1381, 1382, 1383, 1384
+\makenoidxglossaries  1385, 1386, 1387, 1388
\MakeTextUppercase  1336
+href="glossaries-user.html#dx1-15024" >1389
\markboth  1337
+href="glossaries-user.html#dx1-15016" >1390
memoir class  1338, 1339, 1340, 1341
+href="glossaries-user.html#dx1-15021" >1391, 1392, 1393, 1394
\memUChead  1342
+href="glossaries-user.html#dx1-15034" >1395
mfirstuc package  1343, 1344
+href="glossaries-user.html#dx1-5" >1396, 1397
\mfirstucMakeUppercase  1345
+href="glossaries-user.html#dx1-15026" >1398
multicol package  1346
+href="glossaries-user.html#dx1-67004" >1399
multicols (environment)  1347, 1348
+href="glossaries-user.html#dx1-67002" >1400, 1401

N nameref package  1349
+href="glossaries-user.html#dx1-15049" >1402
\newacronym  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
- - +href="glossaries-user.html#dx1-5032" >1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430
\newacronymstyle  1378, 1379, 1380
+href="glossaries-user.html#dx1-55001" >1431, 1432, 1433
\newdualentry  1381
+href="glossaries-user.html#dx1-42015" >1434
\newglossary  1382, 1383, 1384, 1385, 1386, 1387
+href="glossaries-user.html#dx1-10027" >1435, 1436, 1437, 1438, 1439, 1440
\newglossaryentry  1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407
+href="glossaries-user.html#dx1-3032" >1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461
\newglossaryentry options
     access  1408
+href="glossaries-user.html#dx1-72003" >1462
    description  1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422
+href="glossaries-user.html#dx1-25011" >1463, 1464, 1465, 1466, 1467, 1468, 1469, 1470, 1471, 1472, 1473, 1474, 1475, 1476, 1477
    descriptionaccess  1423
+href="glossaries-user.html#dx1-72017" >1478
    descriptionplural  1424, 1425, 1426, 1427
+href="glossaries-user.html#dx1-25022" >1479, 1480, 1481, 1482
    descriptionpluralaccess  1428
+href="glossaries-user.html#dx1-72019" >1483
    first  1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448
+href="glossaries-user.html#dx1-3030" >1484, 1485, 1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497, 1498, 1499, 1500, 1501, 1502, 1503
    firstaccess  1449
+href="glossaries-user.html#dx1-72007" >1504
    firstplural  1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466
+href="glossaries-user.html#dx1-3031" >1505, 1506, 1507, 1508, 1509, 1510, 1511, 1512, 1513, 1514, 1515, 1516, 1517, 1518, 1519, 1520, 1521
    firstpluralaccess  1467
+href="glossaries-user.html#dx1-72011" >1522
    format  1468
+href="glossaries-user.html#dx1-39077" >1523
    long  1469, 1470, 1471, 1472, 1473, 1474
+href="glossaries-user.html#dx1-25125" >1524, 1525, 1526, 1527, 1528, 1529
    longaccess  1475
+href="glossaries-user.html#dx1-72021" >1530
    longplural  1476, 1477, 1478, 1479, 1480, 1481, 1482
+href="glossaries-user.html#dx1-25126" >1531, 1532, 1533, 1534, 1535, 1536, 1537
    longpluralaccess  1483
+href="glossaries-user.html#dx1-72027" >1538
    name  1484, 1485, 1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497, 1498, 1499, 1500, 1501, 1502, 1503, 1504, 1505, 1506, 1507, 1508
+href="glossaries-user.html#dx1-17009" >1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547, 1548, 1549, 1550, 1551, 1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564, 1565, 1566, 1567
    nonumberlist  1509
+href="glossaries-user.html#dx1-25106" >1568
    parent  1510, 1511, 1512, 1513
+href="glossaries-user.html#dx1-25013" >1569, 1570, 1571, 1572
    plural  1514, 1515, 1516, 1517, 1518, 1519, 1520, 1521, 1522, 1523, 1524, 1525, 1526, 1527
+href="glossaries-user.html#dx1-25038" >1573, 1574, 1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584, 1585, 1586
    pluralaccess  1528
+href="glossaries-user.html#dx1-72009" >1587
    prefix  1529, 1530, 1531, 1532, 1533, 1534, 1535
+href="glossaries-user.html#dx1-71003" >1588, 1589, 1590, 1591, 1592, 1593, 1594
    prefixfirst  1536, 1537, 1538, 1539, 1540
+href="glossaries-user.html#dx1-71007" >1595, 1596, 1597, 1598, 1599
+ +     prefixfirstplural  1541, 1542, 1543, 1544, 1545
+href="glossaries-user.html#dx1-71010" >1600, 1601, 1602, 1603, 1604
    prefixplural  1546, 1547, 1548, 1549, 1550, 1551
+href="glossaries-user.html#dx1-71005" >1605, 1606, 1607, 1608, 1609, 1610
+    printnoidxglossary  1611
    see  1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564, 1565
+href="glossaries-user.html#dx1-16062" >1612, 1613, 1614, 1615, 1616, 1617, 1618, 1619, 1620, 1621, 1622, 1623, 1624
    short  1566, 1567, 1568, 1569, 1570, 1571
+href="glossaries-user.html#dx1-25127" >1625, 1626, 1627, 1628, 1629, 1630
    shortaccess  1572
+href="glossaries-user.html#dx1-72024" >1631
    shortplural  1573, 1574, 1575, 1576, 1577, 1578, 1579
+href="glossaries-user.html#dx1-25128" >1632, 1633, 1634, 1635, 1636, 1637, 1638
    shortpluralaccess  1580
+href="glossaries-user.html#dx1-72030" >1639
    sort  1581, 1582, 1583, 1584, 1585, 1586, 1587, 1588, 1589, 1590, 1591, 1592, 1593, 1594, 1595, 1596, 1597, 1598, 1599, 1600, 1601, 1602, 1603
+href="glossaries-user.html#dx1-3070" >1640, 1641, 1642, 1643, 1644, 1645, 1646, 1647, 1648, 1649, 1650, 1651, 1652, 1653, 1654, 1655, 1656, 1657, 1658, 1659, 1660, 1661, 1662, 1663, 1664, 1665, 1666, 1667
    symbol  1604, 1605, 1606, 1607, 1608, 1609, 1610, 1611, 1612
+href="glossaries-user.html#dx1-25062" >1668, 1669, 1670, 1671, 1672, 1673, 1674, 1675, 1676
    symbolaccess  1613
+href="glossaries-user.html#dx1-72013" >1677
    symbolplural  1614, 1615, 1616
+href="glossaries-user.html#dx1-25063" >1678, 1679, 1680
    symbolpluralaccess  1617
+href="glossaries-user.html#dx1-72015" >1681
    text  1618, 1619, 1620, 1621, 1622, 1623, 1624, 1625, 1626, 1627, 1628, 1629, 1630, 1631, 1632
+href="glossaries-user.html#dx1-25024" >1682, 1683, 1684, 1685, 1686, 1687, 1688, 1689, 1690, 1691, 1692, 1693, 1694, 1695, 1696
    textaccess  1633
+href="glossaries-user.html#dx1-72005" >1697
    type  1634, 1635, 1636
- - +href="glossaries-user.html#dx1-25095" >1698, 1699, 1700
    user1  1637, 1638, 1639, 1640, 1641
+href="glossaries-user.html#dx1-25097" >1701, 1702, 1703, 1704, 1705
    user2  1642, 1643, 1644
+href="glossaries-user.html#dx1-25099" >1706, 1707, 1708
    user3  1645, 1646
+href="glossaries-user.html#dx1-25100" >1709, 1710
    user4  1647, 1648
+href="glossaries-user.html#dx1-25101" >1711, 1712
    user5  1649, 1650
+href="glossaries-user.html#dx1-25102" >1713, 1714
    user6  1651, 1652, 1653
+href="glossaries-user.html#dx1-25098" >1715, 1716, 1717
\newglossarystyle  1654, 1655, 1656, 1657
+href="glossaries-user.html#dx1-60028" >1718, 1719, 1720, 1721
\newline  1658, 1659
+href="glossaries-user.html#dx1-25020" >1722, 1723
\newterm  1660
+class="cmti-10">1724, 1725
ngerman package  1661, 1662
+href="glossaries-user.html#dx1-7009" >1726, 1727
\nohyperpage  1663
+href="glossaries-user.html#dx1-38024" >1728
\noist  1664, 1665, 1666, 1667, 1668, 1669, 1670, 1671, 1672, 1673, 1674, 1675
+href="glossaries-user.html#dx1-5094" >1729, 1730, 1731, 1732, 1733, 1734, 1735, 1736, 1737, 1738, 1739
+Non-Latin Alphabet  1740
+non-Latin character  1741, 1742, 1743, 1744, 1745, 1746, 1747, 1748, 1749, 1750, 1751, 1752
\nopostdesc  1676, 1677, 1678, 1679, 1680, 1681
+href="glossaries-user.html#dx1-20014" >1753, 1754, 1755, 1756, 1757, 1758
number list  1682, 1683, 1684, 1685, 1686, 1687, 1688, 1689, 1690, 1691, 1692, 1693, 1694, 1695, 1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704, 1705, 1706, 1707, 1708, 1709, 1710, 1711, 1712, 1713, 1714, 1715, 1716, 1717, 1718, 1719, 1720, 1721, 1722, 1723, 1724, 1725, 1726
+href="glossaries-user.html#dx1-3066" >1759, 1760, 1761, 1762, 1763, 1764, 1765, 1766, 1767, 1768, 1769, 1770, 1771, 1772, 1773, 1774, 1775, 1776, 1777, 1778, 1779, 1780, 1781, 1782, 1783, 1784, 1785, 1786, 1787, 1788, 1789, 1790, 1791, 1792, 1793, 1794, 1795, 1796, 1797, 1798, 1799, 1800, 1801, 1802, 1803, 1804, 1805
\numberline  1727
+href="glossaries-user.html#dx1-15006" >1806

O \oldacronym  1728, 1729
+href="glossaries-user.html#dx1-57004" >1807, 1808

P package options:
     acronym  1730, 1731, 1732, 1733, 1734, 1735, 1736, 1737, 1738, 1739, 1740, 1741, 1742, 1743, 1744, 1745, 1746, 1747, 1748, 1749, 1750, 1751, 1752, 1753
+href="glossaries-user.html#dx1-7020" >1809, 1810, 1811, 1812, 1813, 1814, 1815, 1816, 1817, 1818, 1819, 1820, 1821, 1822, 1823, 1824, 1825, 1826, 1827, 1828, 1829, 1830, 1831, 1832
        true  1754, 1755
+href="glossaries-user.html#dx1-13002" >1833, 1834
+ +     acronymlists  1756, 1757, 1758, 1759, 1760, 1761
+href="glossaries-user.html#dx1-18019" >1835, 1836, 1837, 1838, 1839, 1840
    acronyms  1762, 1763
+href="glossaries-user.html#dx1-14007" >1841, 1842
    compatible-2.07  1764, 1765, 1766
+href="glossaries-user.html#dx1-20027" >1843, 1844, 1845
    compatible-3.07  1767, 1768, 1769
+href="glossaries-user.html#dx1-18004" >1846, 1847, 1848
    counter  1770, 1771, 1772, 1773, 1774
+href="glossaries-user.html#dx1-16068" >1849, 1850, 1851, 1852, 1853
        page  1775
+href="glossaries-user.html#dx1-16069" >1854
    counterwithin  1776, 1777, 1778, 1779, 1780
+href="glossaries-user.html#dx1-16012" >1855, 1856, 1857, 1858, 1859
    description  1781, 1782, 1783, 1784, 1785, 1786, 1787, 1788, 1789
+href="glossaries-user.html#dx1-19002" >1860, 1861, 1862, 1863, 1864, 1865, 1866, 1867, 1868
    dua  1790, 1791
+href="glossaries-user.html#dx1-19011" >1869, 1870
    entrycounter  1792, 1793, 1794, 1795, 1796
+href="glossaries-user.html#dx1-16001" >1871, 1872, 1873, 1874, 1875
        false  1797
+href="glossaries-user.html#dx1-16002" >1876
        true  1798
+href="glossaries-user.html#dx1-16013" >1877
    footnote  1799, 1800, 1801, 1802, 1803, 1804
+href="glossaries-user.html#dx1-19006" >1878, 1879, 1880, 1881, 1882, 1883
    hyperfirst  1805, 1806, 1807
+href="glossaries-user.html#dx1-14069" >1884, 1885, 1886
        false  1808, 1809, 1810, 1811, 1812
+href="glossaries-user.html#dx1-14074" >1887, 1888, 1889, 1890, 1891
        true  1813
+href="glossaries-user.html#dx1-14071" >1892
    index  1814, 1815, 1816, 1817
+href="glossaries-user.html#dx1-14010" >1893, 1894, 1895, 1896, 1897
    makeindex  1818, 1819, 1820
+href="glossaries-user.html#dx1-13004" >1898, 1899, 1900
    nogroupskip  1821, 1822, 1823, 1824, 1825
- - +href="glossaries-user.html#dx1-5027" >1901, 1902, 1903, 1904, 1905
        false  1826
+href="glossaries-user.html#dx1-16075" >1906
    nohypertypes  1827, 1828, 1829, 1830, 1831, 1832, 1833
+href="glossaries-user.html#dx1-14075" >1907, 1908, 1909, 1910, 1911, 1912, 1913
        index  1834
+href="glossaries-user.html#dx1-20024" >1914
    nolist  1835, 1836, 1837
+href="glossaries-user.html#dx1-16041" >1915, 1916, 1917
    nolong  1838, 1839, 1840, 1841
+href="glossaries-user.html#dx1-16033" >1918, 1919, 1920, 1921
    nomain  1842, 1843, 1844, 1845, 1846, 1847, 1848, 1849, 1850
+href="glossaries-user.html#dx1-14005" >1922, 1923, 1924, 1925, 1926, 1927, 1928, 1929, 1930
    nonumberlist  1851, 1852, 1853, 1854, 1855, 1856, 1857, 1858
+href="glossaries-user.html#dx1-3068" >1931, 1932, 1933, 1934, 1935, 1936, 1937, 1938
    nopostdot  1859, 1860
+href="glossaries-user.html#dx1-16072" >1939, 1940
        false  1861
+href="glossaries-user.html#dx1-16073" >1941
+    noredefwarn  1942
    nostyles  1862, 1863, 1864, 1865, 1866, 1867, 1868
+href="glossaries-user.html#dx1-16049" >1943, 1944, 1945, 1946, 1947, 1948, 1949
    nosuper  1869, 1870, 1871, 1872
+href="glossaries-user.html#dx1-16037" >1950, 1951, 1952, 1953
    notranslate  1873, 1874
+href="glossaries-user.html#dx1-14067" >1954, 1955
    notree  1875, 1876, 1877
+href="glossaries-user.html#dx1-16046" >1956, 1957, 1958
    nowarn  1878, 1879
+href="glossaries-user.html#dx1-14001" >1959, 1960, 1961
    numberedsection  1880, 1881, 1882, 1883, 1884
+href="glossaries-user.html#dx1-15035" >1962, 1963, 1964, 1965, 1966
        autolabel  1885, 1886
+href="glossaries-user.html#dx1-15039" >1967, 1968
        false  1887
+href="glossaries-user.html#dx1-15037" >1969
        nameref  1888
+href="glossaries-user.html#dx1-15045" >1970
        nolabel  1889
+href="glossaries-user.html#dx1-15038" >1971
    numberline  1890, 1891
+href="glossaries-user.html#dx1-15004" >1972, 1973
    numbers  1892, 1893, 1894
+href="glossaries-user.html#dx1-14009" >1974, 1975, 1976
    order  1895, 1896
+href="glossaries-user.html#dx1-17045" >1977, 1978, 1979
        letter  1897, 1898, 1899
+href="glossaries-user.html#dx1-4077" >1980, 1981, 1982, 1983
        word  1900, 1901, 1902
+href="glossaries-user.html#dx1-5069" >1984, 1985, 1986
    sanitizesort  1903, 1904
+href="glossaries-user.html#dx1-4099" >1987, 1988, 1989
        false  1905, 1906
+href="glossaries-user.html#dx1-4010" >1990, 1991, 1992, 1993, 1994, 1995
+ +         true  1907
+href="glossaries-user.html#dx1-4013" >1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
    savenumberlist  1908, 1909
+href="glossaries-user.html#dx1-14079" >2004, 2005
        false  1910
+href="glossaries-user.html#dx1-14082" >2006
    savewrites  1911, 1912, 1913
+href="glossaries-user.html#dx1-14021" >2007, 2008, 2009
        false  1914
+href="glossaries-user.html#dx1-14022" >2010
    section  1915, 1916
+href="glossaries-user.html#dx1-15011" >2011, 2012
    seeautonumberlist  1917, 1918, 1919, 1920
+href="glossaries-user.html#dx1-16058" >2013, 2014, 2015, 2016
    shortcuts  1921, 1922, 1923
+href="glossaries-user.html#dx1-18026" >2017, 2018
    smallcaps  1924, 1925, 1926, 1927, 1928, 1929, 1930, 1931
+href="glossaries-user.html#dx1-19004" >2019, 2020, 2021, 2022, 2023, 2024, 2025, 2026
    smaller  1932, 1933, 1934, 1935, 1936, 1937, 1938
+href="glossaries-user.html#dx1-19005" >2027, 2028, 2029, 2030, 2031, 2032, 2033
    sort  1939, 1940, 1941
+href="glossaries-user.html#dx1-17001" >2034, 2035, 2036
        def  1942, 1943, 1944, 1945, 1946, 1947, 1948
+href="glossaries-user.html#dx1-17004" >2037, 2038, 2039, 2040, 2041, 2042, 2043, 2044
        standard  1949, 1950, 1951
+href="glossaries-user.html#dx1-17006" >2045, 2046, 2047
        use  1952, 1953, 1954, 1955, 1956, 1957, 1958
+href="glossaries-user.html#dx1-17005" >2048, 2049, 2050, 2051, 2052, 2053, 2054, 2055
    style  1959, 1960, 1961, 1962, 1963, 1964, 1965
+href="glossaries-user.html#dx1-16027" >2056, 2057, 2058, 2059, 2060, 2061, 2062
        list  1966
+href="glossaries-user.html#dx1-16028" >2063
    subentrycounter  1967, 1968, 1969, 1970, 1971, 1972
+href="glossaries-user.html#dx1-16021" >2064, 2065, 2066, 2067, 2068, 2069
        false  1973
+href="glossaries-user.html#dx1-16022" >2070
    symbols  1974, 1975, 1976
+href="glossaries-user.html#dx1-14008" >2071, 2072, 2073
    toc  1977, 1978, 1979, 1980, 1981
- - +href="glossaries-user.html#dx1-15001" >2074, 2075, 2076, 2077, 2078
    translate  1982, 1983, 1984, 1985
+href="glossaries-user.html#dx1-14036" >2079, 2080, 2081, 2082
        babel  1986, 1987, 1988, 1989, 1990, 1991
+href="glossaries-user.html#dx1-7007" >2083, 2084, 2085, 2086, 2087, 2088
        false  1992, 1993, 1994, 1995, 1996
+href="glossaries-user.html#dx1-7006" >2089, 2090, 2091, 2092, 2093
        true  1997, 1998, 1999, 2000
+href="glossaries-user.html#dx1-14037" >2094, 2095, 2096, 2097
    ucfirst  2001
+href="glossaries-user.html#dx1-15032" >2098
    ucmark  2002, 2003
+href="glossaries-user.html#dx1-15017" >2099, 2100
        false  2004
+href="glossaries-user.html#dx1-15020" >2101
        true  2005
+href="glossaries-user.html#dx1-15022" >2102
    xindy  2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018
+href="glossaries-user.html#dx1-4066" >2103, 2104, 2105, 2106, 2107, 2108, 2109, 2110, 2111, 2112, 2113, 2114, 2115, 2116
    xindygloss  2019, 2020
+href="glossaries-user.html#dx1-17084" >2117, 2118
    xindynoglsnumbers  2021, 2022
+href="glossaries-user.html#dx1-17088" >2119, 2120
page (counter)  2023
+href="glossaries-user.html#dx1-49047" >2121
\pagelistname  2024
+href="glossaries-user.html#dx1-7024" >2122
pdflatex  2025, 2026
+href="glossaries-user.html#dx1-16" >2123, 2124
\PGLS  2027
+href="glossaries-user.html#dx1-71030" >2125
\Pgls  2028
+href="glossaries-user.html#dx1-71025" >2126
\pgls  2029
+href="glossaries-user.html#dx1-71021" >2127
\PGLSpl  2030
+href="glossaries-user.html#dx1-71041" >2128
\Pglspl  2031
+href="glossaries-user.html#dx1-71036" >2129
\pglspl  2032
+href="glossaries-user.html#dx1-71032" >2130
pod2man  2033
+href="glossaries-user.html#dx1-9048" >2131
polyglossia package  2034, 2035, 2036, 2037, 2038
+href="glossaries-user.html#dx1-7002" >2132, 2133, 2134, 2135, 2136
\printacronyms  2039, 2040
+class="cmti-10">2137, 2138
\printglossaries  2041, 2042, 2043, 2044, 2045, 2046, 2047
+href="glossaries-user.html#dx1-46003" >2139, 2140, 2141, 2142, 2143
\printglossary  2048, 2049, 2050, 2051, 2052, 2053, 2054, 2055, 2056, 2057, 2058, 2059, 2060, 2061, 2062
+href="glossaries-user.html#dx1-16054" >2144, 2145, 2146, 2147, 2148, 2149, 2150, 2151, 2152, 2153, 2154, 2155, 2156
\printglossary options
 + +     nonumberlist  2063
+href="glossaries-user.html#dx1-46032" >2157
    numberedsection  2064
+href="glossaries-user.html#dx1-46029" >2158
    style  2065, 2066, 2067, 2068
+href="glossaries-user.html#dx1-16053" >2159, 2160, 2161, 2162
    title  2069, 2070
+href="glossaries-user.html#dx1-46022" >2163, 2164
    toctitle  2071
+href="glossaries-user.html#dx1-46023" >2165
    type  2072
+href="glossaries-user.html#dx1-46021" >2166
\printindex  2073
+href="glossaries-user.html#dx1-20015" >2167
+\printnoidxglossaries  2168, 2169
+\printnoidxglossary  2170, 2171, 2172, 2173, 2174, 2175, 2176, 2177, 2178, 2179, 2180
+\printnoidxglossary options
 +    sort  2181, 2182, 2183
\printnumbers  2074
+href="glossaries-user.html#dx1-20007" >2184
\printsymbols  2075
+class="cmti-10">2185
\provideglossaryentry  2076, 2077
+href="glossaries-user.html#dx1-25004" >2186, 2187

R relsize package  2078, 2079
+href="glossaries-user.html#dx1-19019" >2188, 2189
\Roman  2080
+href="glossaries-user.html#dx1-49036" >2190

S sanitize  2081, 2082, 2083, 2084
+href="glossaries-user.html#dx1-3069" >2191, 2192, 2193, 2194, 2195
scrwfile package  2085
- - +href="glossaries-user.html#dx1-14025" >2196
\section*  2086, 2087
+href="glossaries-user.html#dx1-15048" >2197, 2198
\seename  2088, 2089, 2090, 2091
+href="glossaries-user.html#dx1-3002" >2199, 2200, 2201, 2202
\SetAcronymLists  2092
+href="glossaries-user.html#dx1-18024" >2203
\setacronymstyle  2093, 2094, 2095, 2096
+href="glossaries-user.html#dx1-19001" >2204, 2205, 2206, 2207
\setAlphaCompositor  2097
+href="glossaries-user.html#dx1-49056" >2208
\setCompositor  2098
+href="glossaries-user.html#dx1-49054" >2209
\setentrycounter  2099, 2100
+href="glossaries-user.html#dx1-69056" >2210, 2211
\setglossarypreamble  2101, 2102
+href="glossaries-user.html#dx1-16020" >2212, 2213
\setglossarysection  2103, 2104
+class="cmti-10">2214, 2215
\setglossarystyle  2105, 2106, 2107, 2108, 2109, 2110, 2111
+href="glossaries-user.html#dx1-16052" >2216, 2217, 2218, 2219, 2220, 2221, 2222
\setStyleFile  2112, 2113, 2114
+href="glossaries-user.html#dx1-10021" >2223, 2224, 2225
\setupglossaries  2115
+class="cmti-10">2226
\subglossentry  2116
+href="glossaries-user.html#dx1-69065" >2227
supertabular (environment)  2117, 2118, 2119, 2120, 2121
+href="glossaries-user.html#dx1-64002" >2228, 2229, 2230, 2231, 2232
supertabular package  2122, 2123, 2124
+href="glossaries-user.html#dx1-16039" >2233, 2234, 2235
\symbolname  2125
+href="glossaries-user.html#dx1-7023" >2236

T TeX4HT  2126
+href="glossaries-user.html#dx1-73097" >2237
\textbf  2127
+href="glossaries-user.html#dx1-39049" >2238
textcase package  2128, 2129
+href="glossaries-user.html#dx1-15027" >2239, 2240
+ + \textrm  2130
+href="glossaries-user.html#dx1-49013" >2241
\textsc  2131, 2132, 2133, 2134, 2135, 2136, 2137
+href="glossaries-user.html#dx1-54008" >2242, 2243, 2244, 2245, 2246, 2247, 2248
\textsmaller  2138, 2139, 2140, 2141
+href="glossaries-user.html#dx1-19020" >2249, 2250, 2251, 2252
\textulc  2142
+href="glossaries-user.html#dx1-55037" >2253
\textup  2143
+href="glossaries-user.html#dx1-55038" >2254
\the  2144
+href="glossaries-user.html#dx1-55027" >2255
theglossary (environment)  2145, 2146, 2147, 2148
+href="glossaries-user.html#dx1-69002" >2256, 2257, 2258, 2259
\thepage  2149
+href="glossaries-user.html#dx1-49040" >2260
translator package  2150, 2151, 2152, 2153, 2154, 2155, 2156, 2157, 2158, 2159, 2160, 2161, 2162, 2163, 2164
+href="glossaries-user.html#dx1-7004" >2261, 2262, 2263, 2264, 2265, 2266, 2267, 2268, 2269, 2270, 2271, 2272, 2273, 2274, 2275

W \write18  2165
+href="glossaries-user.html#dx1-14026" >2276

X xindy  2166, 2167, 2168, 2169, 2170, 2171, 2172, 2173, 2174, 2175, 2176, 2177, 2178, 2179, 2180, 2181, 2182, 2183, 2184, 2185, 2186, 2187, 2188, 2189, 2190, 2191, 2192, 2193, 2194, 2195, 2196, 2197, 2198, 2199, 2200, 2201, 2202, 2203, 2204, 2205, 2206, 2207, 2208, 2209, 2210, 2211, 2212, 2213, 2214, 2215, 2216, 2217, 2218, 2219, 2220, 2221, 2222, 2223, 2224, 2225, 2226, 2227, 2228, 2229, 2230, 2231, 2232, 2233, 2234, 2235, 2236, 2237, 2238, 2239, 2240, 2241, 2242, 2243, 2244, 2245, 2246, 2247, 2248, 2249, 2250, 2251, 2252, 2253, 2254, 2255, 2256, 2257, 2258, 2259, 2260, 2261, 2262, 2263, 2264, 2265, 2266, 2267, 2268, 2269, 2270, 2271, 2272, 2273, 2274, 2275, 2276, 2277
+href="glossaries-user.html#dx1-3037" >2277, 2278, 2279, 2280, 2281, 2282, 2283, 2284, 2285, 2286, 2287, 2288, 2289, 2290, 2291, 2292, 2293, 2294, 2295, 2296, 2297, 2298, 2299, 2300, 2301, 2302, 2303, 2304, 2305, 2306, 2307, 2308, 2309, 2310, 2311, 2312, 2313, 2314, 2315, 2316, 2317, 2318, 2319, 2320, 2321, 2322, 2323, 2324, 2325, 2326, 2327, 2328, 2329, 2330, 2331, 2332, 2333, 2334, 2335, 2336, 2337, 2338, 2339, 2340, 2341, 2342, 2343, 2344, 2345, 2346, 2347, 2348, 2349, 2350, 2351, 2352, 2353, 2354, 2355, 2356, 2357, 2358, 2359, 2360, 2361, 2362, 2363, 2364, 2365, 2366, 2367, 2368, 2369, 2370, 2371, 2372, 2373, 2374, 2375, 2376, 2377, 2378, 2379, 2380, 2381, 2382, 2383, 2384, 2385, 2386, 2387, 2388, 2389, 2390, 2391, 2392, 2393, 2394, 2395, 2396, 2397
xkeyval package  2278, 2279
+href="glossaries-user.html#dx1-5005" >2398, 2399
\xmakefirstuc  2280
+href="glossaries-user.html#dx1-3003" >2400
\xspace  2281
+href="glossaries-user.html#dx1-57018" >2401
xspace package  2282, 2283, 2284, 2285, 2286, 2287, 2288
+href="glossaries-user.html#dx1-57014" >2402, 2403, 2404, 2405, 2406, 2407, 2408

-

1.1That is, if the term has been referenced using any of the commands described in 夤6 Links to @@ -24028,7 +25923,7 @@ class="cmr-8">Links to class="cmr-8">Glossary Entries and 夤7 Adding an Entry to the Glossary Without Generating Text key) or commands such as \acrshort.

-

1.2Note that although I’ve written latex possible, for the reasons given earlier.

-

1.3As from v3.01 \gls is no longer fragile and doesn’t need protecting.

-

1.4Apparently MiKTeX has an alternative makeglossaries.exe but I don’t know how using this -differs from using makeglossaries.bat.

-

2.1unless memoirmemoiris loaded, which case it uses \markboth

-

2.2Actually it uses \mfirstucMakeUppercasepackage is class="cmr-8">automatically loaded by glossaries.)

-

2.3Actually it sets \acronymtype to \glsdefaulttype if the acronym package option is not used, but \glsdefaulttype usually has the value main unless the nomain option has been used.

used.

4.1The only preamble restriction on \newglossaryentry and \newacronym was removed in -version 1.13, but the restriction remains for \loadglsentries. See §4.8 Drawbacks With Defining -Entries in the Document Environment for a discussion of the problems with defining entries within -the document instead of in the preamble.

-

4.2Except possibly the style file but then you’ll need to use \noist to prevent your changes from -being overwritten.

-

4.3This is because \acronymtype is set to \glsdefaulttype if the acronym package option is not used.

used.

6.1\glsdisplayfirst and \glsdisplay are now deprecated. Backwards compatibility should be preserved but you may need to use the compatible-3.07 option

-

8.1makeindex will always assign a location number, even if it’s not needed, so it needs to be discarded.

discarded.

8.2Ifyou redefine \glsseeformat, keep the default value of the optional argument as \seename + id="dx1-44007"> as both see and \glssee explicitly write [\seename] in the output file if no optional argument is given.

-

8.3In versions before 3.0, \glsentryname was used, but this could cause problems when the name + id="dx1-44015"> key was sanitized.

-

9.1versions before 3.0 used \glsentryname as the default, but this could cause problems when name had been sanitized.

.

10.1you can’t use the longheaderborder style for this example as you can’t use the longtable + id="dx1-46062"> environment in two column mode.

environment in two column mode.

11.1see \setCompositor described in 夤3 Setting Up

-

11.2see \setAlphaCompositor described in 夤3 Setting Up

-

13.1as from version 1.18

as from version 1.18

13.2See David Carlisle’sexplanation in http://tex.stackexchange.com/questions/86565/drawbacks-_of-_xspace

-

15.1These lengths will not be available if you use both the nolong and nosuper package options or if you use the nostyles package option unless you explicitly load the relevant package.

-

15.2This style was supplied by Axel Menzel.

-

15.3e.g. with the flowfram package.

-

17.1Single letter words, such as “a” and “I” should typically not appear at the end of a line, hence the non-breakable space after “a” in the prefix field.

-

17.2The earlier caveats about initial non-Latin characters apply.

diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf index a89c532e549..12ed1e68eef 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 dbc79467c05..8da3d8bcaf0 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -20,7 +20,14 @@ pdftitle={User Manual for glossaries.sty}, pdfkeywords={LaTeX,package,glossary,acronyms}]{hyperref} \usepackage{xr-hyper} -\usepackage[xindy,nonumberlist,seeautonumberlist,toc,nogroupskip,style=altlist]{glossaries} +\usepackage[ + xindy, + nonumberlist, + toc, + nopostdot, + nogroupskip, + style=altlist +]{glossaries} \usepackage{glossary-inline} \pagestyle{headings} @@ -37,8 +44,8 @@ \begin{tabbing} \cs{usepackage}[\=xindy,\\ \+\>nonumberlist,\\ - seeautonumberlist,\\ toc,\\ + nopostdot,\\ style=altlist,\\ nogroupskip]\{glossaries\} \end{tabbing} @@ -109,7 +116,7 @@ name={\appfmt{makeindex}\index{makeindex=\appfmt{makeindex}|htextbf}},% sort={makeindex},% text={\appfmt{makeindex}\iapp{makeindex}},% -description={An \gls{indexingapp}}, +description={An \gls{indexingapp}.}, } \newglossaryentry{makeglossaries}{% @@ -118,7 +125,7 @@ sort={makeglossaries},% text={\appfmt{makeglossaries}\iapp{makeglossaries}},% description={A custom designed Perl script interface to \gls{xindy} and \gls{makeindex} provided with the \styfmt{glossaries} -package} +package.} } \longnewglossaryentry{makeglossariesgui}{% @@ -137,7 +144,7 @@ sort={number list},% text={number list\iterm{number list}},% description={A list of \glslink{entrylocation}{entry locations} (also called a location list). The number list can be suppressed using the -\pkgopt{nonumberlist} package option} +\pkgopt{nonumberlist} package option.} } \newglossaryentry{entrylocation}{% @@ -146,15 +153,15 @@ sort={entry location},% text={entry location\iterm{entry location}},% description={The location of the entry in the document. This defaults to the page number on which the entry appears. An entry may -have multiple locations} +have multiple locations.} } \newglossaryentry{locationlist}{% name={Location list},% text={location list}, sort={location list},% -description={A list of \glslink{entrylocation}{entry locations}},% -see={numberlist} +description={A list of \glslink{entrylocation}{entry locations}. +See \gls{numberlist}.}% } \newglossaryentry{linktext}{% @@ -162,7 +169,7 @@ name={Link text\itermdef{link text}}, sort={link text},% text={link text\iterm{link text}}, description={The text produced by commands such as \ics{gls}. It may -or may not be a hyperlink to the glossary} +or may not be a hyperlink to the glossary.} } \let\glsd\glsuseri @@ -200,7 +207,7 @@ text={first use text},% description={The text that is displayed on \gls{firstuse}, which is governed by the \gloskey{first} and \gloskey{firstplural} keys of \ics{newglossaryentry}. (May be overridden by -\ics{glsdisp}.)\nopostdesc}% +\ics{glsdisp}.)}% } \longnewglossaryentry{sanitize}{% @@ -223,6 +230,68 @@ user2={sanitization\protect\iterm{sanitize}}% for the \gloskey{sort} key. } +\newglossaryentry{latinchar}{% + name={Latin Character\itermdef{Latin character}}, + text={Latin character\iterm{Latin character}}, + sort={Latin character}, + description={One of the letters \texttt{a}, \ldots, \texttt{z}, + \texttt{A}, \ldots, \texttt{Z}. + See also \gls{exlatinchar}.} +} + +\newglossaryentry{exlatinchar}{% + name={Extended Latin Character\itermdef{extended Latin character}}, + text={extended Latin character\iterm{extended Latin character}}, + sort={extended Latin character}, + description={A character that's created by combining \glspl{latinchar} + to form ligatures (e.g.\ \ae) or by applying diacritical marks + to a~\gls*{latinchar} or characters (e.g.\ \'a or \o). + See also \gls{nonlatinchar}.} +} + +\newglossaryentry{latexexlatinchar}{% + name={Standard \LaTeX\ Extended Latin Character\itermdef{standard +\LaTeX\ extended Latin character}}, + text={standard \LaTeX\ extended Latin character\iterm{standard +\LaTeX\ extended Latin character}}, + sort={standard LaTeX extended Latin character}, + description={An \gls{exlatinchar} that can be created by a~core +\LaTeX\ command, such as \cs{o} (\o) or \cs{'}\texttt{e} (\'e). + That is, the character can be produced without the need to load + a~particular package.} +} + +\newglossaryentry{nonlatinchar}{% + name={Non-Latin Character\itermdef{non-Latin character}}, + text={non-Latin character\iterm{non-Latin character}}, + sort={non-Latin character}, + description={An \gls{exlatinchar} or a~character from + a~non-\gls{latinalph}.} +} + +\newglossaryentry{latinalph}{% + name={Latin Alphabet\itermdef{Latin alphabet}}, + text={Latin alphabet\iterm{Latin alphabet}}, + sort={Latin alphabet}, + description={The alphabet consisting of \glspl{latinchar}. + See also \gls{exlatinalph}.} +} + +\newglossaryentry{exlatinalph}{% + name={Extended Latin Alphabet\itermdef{Extended Latin Alphabet}}, + text={extended Latin alphabet}, + sort={extended Latin alphabet}, + description={An alphabet consisting of \glspl{latinchar} + and \glspl{exlatinchar}.} +} + +\newglossaryentry{nonlatinalph}{% + name={Non-Latin Alphabet\itermdef{Non-Latin Alphabet}}, + text={non-Latin alphabet}, + sort={non-Latin alphabet}, + description={An alphabet consisting of \glspl{nonlatinchar}.} +} + \ifpdf \externaldocument{glossaries-code} \fi @@ -236,6 +305,21 @@ user2={sanitization\protect\iterm{sanitize}}% \newcommand*{\tick}{\ding{51}} +\newcommand*{\yes}{\ding{52}} +\newcommand*{\no}{\ding{56}} + +\makeatletter +\newcommand*{\optionlabel}[1]{% + \@glstarget{option#1}{}\textbf{Option~#1}} +\makeatother + +\newcommand*{\opt}[1]{\hyperlink{option#1}{Option~#1}} +\newcommand*{\optsor}[2]{Options~\hyperlink{option#1}{#1} +or~\hyperlink{option#2}{#2}} +\newcommand*{\optsand}[2]{Options~\hyperlink{option#1}{#1} +and~\hyperlink{option#2}{#2}} + + \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\ifirstuseflag}{\iterm{first use>flag}} \newcommand*{\ifirstusetext}{\iterm{first use>text}} @@ -278,11 +362,11 @@ user2={sanitization\protect\iterm{sanitize}}% \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.03} + \title{User Manual for glossaries.sty v4.04} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2014-01-20} + \date{2014-03-06} \maketitle \begin{abstract} @@ -335,7 +419,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.03}. +\qt{Documented Code for glossaries v4.04}. This includes the documented code for the \sty{mfirstuc} package. \item[INSTALL] Installation instructions. @@ -382,13 +466,15 @@ Nomenclature, Lists of Symbols and Acronyms}. \clearpage \printglossaries +\glsresetall + \chapter{Introduction} \label{sec:intro} The \styfmt{glossaries} package is provided to assist generating -glossaries. It has a certain amount of flexibility, allowing the +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 acronyms and glossary styles that +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 used\footnote{That is, if the term has been @@ -409,22 +495,254 @@ size of the manual, try starting off with the much shorter \docref{guide for beginners}{glossariesbegin}. \begin{important} -The \styfmt{glossaries} package comes with a -\href{http://www.perl.org/about.html}{Perl} script called -\gls{makeglossaries}. This provides a convenient interface to the -\glspl{indexingapp} \gls{makeindex} or \gls{xindy}. It is strongly -recommended that you use this script, but \emph{it is not -essential}. If you are reluctant to install Perl, or for any other -reason you don't want to use \gls*{makeglossaries}, you can call -\gls*{makeindex} or \gls*{xindy} explicitly. See -\sectionref{sec:makeglossaries} for further details. +There's a~common misconception that you have to have Perl installed +in order to use the \styfmt{glossaries} package. Perl is \emph{not} +a~requirement but it does increase the available options, +particularly if you use an \gls{exlatinalph} or a~\gls{nonlatinalph}. +\end{important} + +The basic idea behind the \styfmt{glossaries} package is that you +first define your entries (terms, symbols or abbreviations). Then +you can reference these within your document (like \cs{cite} or +\cs{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: + +\begin{description} +\item[]\optionlabel1: + + This is the simplest option but it's slow and if + you want a sorted list, it doesn't work well for \glspl{exlatinalph} or + \glspl{nonlatinalph}. However, if you use the + \pkgopt[false]{sanitizesort} package option (the default for + Option~1) then the \glslink{latexexlatinchar}{standard \LaTeX\ accent commands} will be + ignored, so if an entry's name is set to \verb|{\'e}lite| then the + sort will default to \texttt{elite} if + \pkgopt[false]{sanitizesort} is used + and will default to \verb|\'elite| if \pkgopt[true]{sanitizesort} + is used. + + \begin{enumerate} + \item Add \cs{makenoidxglossaries} to your preamble (before you + start defining your entries, as described in + \sectionref{sec:newglosentry}). + + \item Put +\begin{definition} +\cs{printnoidxglossary} +\end{definition} + where you want your list of entries to appear (described in + \sectionref{sec:printglossary}). + + \item Run \LaTeX\ twice on your document. (As you would do to + make a~table of contents appear.) For example, click twice on + the \qt{typeset} or \qt{build} or \qt{PDF\LaTeX} button in your editor. + \end{enumerate} + +\item\optionlabel2: + + This option uses a~\gls{cli} application called \gls{makeindex} to sort + the entries. This application comes with all modern \TeX\ distributions, + but it's hard-coded for the non-extended \gls{latinalph}, so + it doesn't work well for \glspl{exlatinalph} or + \glspl{nonlatinalph}. This process involves making \LaTeX\ write the + glossary information to a temporary file which \gls{makeindex} reads. + Then \gls{makeindex} writes a~new file containing the code to typeset + the glossary. \LaTeX\ then reads this file in on the next run. + + \begin{enumerate} + \item Add \cs{makeglossaries} to your preamble (before you start + defining your entries, as described in + \sectionref{sec:newglosentry}). + + \item Put +\begin{definition} +\cs{printglossary} +\end{definition} + where you want your list of entries to appear (described in + \sectionref{sec:printglossary}). + + \item Run \LaTeX\ on your document. This creates files with the + extensions \texttt{.glo} and \texttt{.ist} (for example, if your + \LaTeX\ document is called \texttt{myDoc.tex}, then you'll have + two extra files called \texttt{myDoc.glo} and \texttt{myDoc.ist}). + If you look at your document at this point, you won't see the + glossary as it hasn't been created yet. + + \item Run \gls{makeindex} with the \texttt{.glo} file as the + input file and the \texttt{.ist} file as the style so that + it creates an output file with the extension \texttt{.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: +\begin{verbatim} +makeindex -s myDoc.ist -o myDoc.gls myDoc.glo +\end{verbatim} + (Replace \texttt{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 + \gls{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 (\qt{sea lion} comes before +\qt{seal}). + If you want letter ordering you need to add the \texttt{-l} + switch: +\begin{verbatim} +makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo +\end{verbatim} + (See \sectionref{sec:makeindexapp} for further details on using + \gls*{makeindex} explicitly.) + + \item Once you have successfully completed the previous step, + you can now run \LaTeX\ on your document again. + \end{enumerate} + + This is the default option (although you still need to use + \cs{makeglossaries} to ensure the glossary files are created). + +\item\optionlabel3: + + This option uses a~\gls{cli} application called + \gls{xindy} to sort the entries. This application is more flexible than + \texttt{makeindex} and is able to sort \glspl{exlatinalph} or + \glspl{nonlatinalph}. The \gls{xindy} application comes with \TeX~Live + but not with MiK\TeX. Since \gls{xindy} is a Perl script, if you are + using MiK\TeX\ you will not only need to install \gls{xindy}, you + will also need to install Perl. In a~similar way to \opt2, this + option involves making \LaTeX\ write the glossary information to + a~temporary file which \gls{xindy} reads. Then \gls{xindy} + writes a~new file containing the code to typeset the glossary. + \LaTeX\ then reads this file in on the next run. + + \begin{enumerate} + \item Add the \pkgopt{xindy} option to the \styfmt{glossaries} +package option list: +\begin{verbatim} +\usepackage[xindy]{glossaries} +\end{verbatim} + + \item Add \cs{makeglossaries} to your preamble (before you start + defining your entries, as described in \sectionref{sec:newglosentry}). + + \item Run \LaTeX\ on your document. This creates files with the + extensions \texttt{.glo} and \texttt{.xdy} (for example, if your + \LaTeX\ document is called \texttt{myDoc.tex}, then you'll have + two extra files called \texttt{myDoc.glo} and \texttt{myDoc.xdy}). + If you look at your document at this point, you won't see the + glossary as it hasn't been created yet. + + \item Run \gls{xindy} with the \texttt{.glo} file as the + input file and the \texttt{.xdy} file as a~module so that + it creates an output file with the extension \texttt{.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): +\begin{verbatim} +xindy -L english -C utf8 -I xindy -M myDoc +-t myDoc.glg -o myDoc.gls myDoc.glo +\end{verbatim} + (Replace \texttt{myDoc} with the base name of your \LaTeX\ + document file. Avoid spaces in the file name. If necessary, also replace + \texttt{english} with the name of your language and \texttt{utf8} + with your input encoding.) If you don't know + how to use the command prompt, then you can probably access + \gls{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 (\qt{sea lion} comes before +\qt{seal}). + If you want letter ordering you need to add the + \pkgopt[letter]{order} package option: +\begin{verbatim} +\usepackage[xindy,order=letter]{glossaries} +\end{verbatim} + (See \sectionref{sec:xindyapp} for further details on using + \gls*{xindy} explicitly.) + + \item Once you have successfully completed the previous step, + you can now run \LaTeX\ on your document again. + + \end{enumerate} + +\end{description} + +For \optsand23, it can be difficult to remember all the +parameters required for \gls{makeindex} or \gls{xindy}, so the +\styfmt{glossaries} package provides a~script called +\gls{makeglossaries} that reads the \texttt{.aux} file to +determine what settings you have used and will then run +\gls{makeindex} or \gls{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 \texttt{myDoc.tex}, +then run: +\begin{verbatim} +makeglossaries myDoc +\end{verbatim} +(Replace \texttt{myDoc} with the base name of your \LaTeX\ document +file. Avoid spaces in the file name.) This is described in more +detail in \sectionref{sec:makeglossaries}. + +\begin{important} +The \texttt{.gls} and \texttt{.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. \end{important} + +An overview of these three options is given in +\tableref{tab:options}. + +\begin{table}[htbp] + \caption{Glossary Options: Pros and Cons} + \label{tab:options} + {% + \centering + \begin{tabular}{>{\raggedright}p{0.3\textwidth}ccc} + & \bfseries \opt1 & \bfseries \opt2 & \bfseries \opt3\\ + Requires an external application? & + \no & \yes & \yes\\ + Requires Perl? & + \no & \no & \yes\\ + Can sort \glspl{exlatinalph} + or \glspl{nonlatinalph}? & + \no\textsuperscript{\textdagger} & \no & \yes\\ + Efficient sort algorithm? & + \no & \yes & \yes\\ + Can use a different sort algorithm for each glossary? & + \yes & \no & \no\\ + Can form ranges in the location lists? & + \no & \yes & \yes\\ + Can have non-standard locations in the location lists? & + \yes & \no & \yes\\ + Maximum hierarchical depth & + Unlimited & 3 & Unlimited\\ + \ics{glsdisplaynumberlist} reliable? & + \yes & \no & \no\\ + \ics{newglossaryentry} restricted to preamble? & + \yes & \no & \no\\ + Requires additional write registers? & + \no & \yes & \yes\\ + Default value of \pkgopt{sanitizesort} package option & + \texttt{false} & \texttt{true} & \texttt{true} + \end{tabular} + \par + }\textsuperscript{\textdagger} Strips standard \LaTeX\ accents +(that is, accents generated by core \LaTeX\ commands) so, +for example, \ics{AA} is treated the same as A. +\end{table} + This document uses the \styfmt{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 \qt{\gls{xindy}} you'll be taken to the entry in the glossary where there's a brief description of -what \qt{\gls*{xindy}} is. +the term \qt{\gls*{xindy}}. The remainder of this introductory section covers the following: \begin{itemize} @@ -434,12 +752,12 @@ with this package. \item \sectionref{sec:languages} provides information for users who wish to write in a language other than English. -\item \sectionref{sec:makeglossaries} describes how to use a -post-processor to create the sorted glossaries for your document. +\item \sectionref{sec:makeglossaries} describes how to use an +\gls{indexingapp} to create the sorted glossaries for your document +(\optsor23). \end{itemize} - \section{Sample Documents} \label{sec:samples} @@ -522,6 +840,22 @@ 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. +\exitem{-noidx} This document illustrates how to use the +\styfmt{glossaries} package without an external \gls{indexingapp} (\opt1). +To create the complete document, you need to do: +\begin{prompt} +latex sample-noidx +latex sample-noidx +\end{prompt} + +\exitem{-noidx-utf8} As the previous example, except that it uses +the \sty{inputenc} package. +To create the complete document, you need to do: +\begin{prompt} +latex sample-noidx-utf8 +latex sample-noidx-utf8 +\end{prompt} + \exitem{4col} 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 @@ -815,7 +1149,7 @@ See \sectionref{sec:xindyloc} for further details. \exitem{utf8} This is another example that uses \gls{xindy}. Unlike \gls{makeindex}, -\gls{xindy} can cope with accented or non-Latin characters. This +\gls{xindy} can cope with \glspl{nonlatinchar}. This document uses UTF8 encoding. To create the document do: \begin{prompt} latex sampleutf8 @@ -836,7 +1170,7 @@ latex sampleutf8 makeglossaries sampleutf8 latex sampleutf8 \end{prompt} -you will see that the entries that start with a non-Latin character +you will see that the entries that start with a \gls{nonlatinchar} now appear in the symbols group, and the word \qt{man\oe uvre} is now after \qt{manor} instead of before it. If you are unable to use \gls{makeglossaries}, the call to \gls{makeindex} is as @@ -921,9 +1255,10 @@ about the \styfmt{glossaries-accsupp} package can be found in As from version 1.17, the \styfmt{glossaries} package can now be used with \gls{xindy} as well as \gls{makeindex}. If you -are writing in a language that uses accented characters or -non-Latin characters it is recommended that you use \gls*{xindy} -as \gls*{makeindex} is hard-coded for Latin languages. This +are writing in a language that uses an \gls{exlatinalph} or +\gls{nonlatinalph} it is recommended that you use \gls*{xindy} +as \gls*{makeindex} is hard-coded for the non-extended +\gls{latinalph}. This means that you are not restricted to the A, \ldots, Z letter groups. If you want to use \gls*{xindy}, remember to use the \pkgopt{xindy} package option. For example: @@ -936,19 +1271,19 @@ If you want to use \gls*{xindy}, remember to use the \end{verbatim} \begin{important} -Note that although an accented character, such as é, looks like a plain -character in your tex file, it's actually a macro and can therefore +Note that although a~\gls{nonlatinchar}, such as \'e, looks like a plain +character in your tex file, it's actually a~macro and can therefore cause expansion problems. You may need to switch off the field expansions with \cs{glsnoexpandfields}. -If you use an accented (or other expandable) character at the start of +If you use a~\gls{nonlatinchar} (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.\ \ics{Gls}) due to expansion issues. For example: -\begin{verbatim} -\newglossaryentry{elite}{name={{é}lite}, -description={select group or class}} -\end{verbatim} +\begin{alltt} +\verb|\newglossaryentry}{elite}{name={{|\'e\verb|}lite},| +description=\verb|{select group or class}}| +\end{alltt} \end{important} If you use the \sty{inputenc} package, \gls{makeglossaries} @@ -1003,10 +1338,17 @@ The languages are currently supported by the spelling mistakes) I don't intend to change the default translations as it will cause compatibility problems. +If you want to add a~language not currently supported, you can post +the contents of your \texttt{.dict} file on my feature request form +at \url{http://www.dickimaw-books.com/feature-request.html}. Please +use \LaTeX\ commands for \glspl{nonlatinchar} as the file must be +independent of the input encoding otherwise it won't be of any use +to people who use a~different encoding to yourself. + \begin{table}[htbp] \caption{Supported Languages} \label{tab:supportedlanguages} -\begin{center} +\centering \begin{tabular}{lc} \bfseries Language & \bfseries As from version\\ Brazilian Portuguese & 1.17\\ @@ -1022,7 +1364,6 @@ Polish & 1.13\\ Serbian & 2.06\\ Spanish & 1.08 \end{tabular} -\end{center} \end{table} The language dependent commands and \sty{translator} keys used by the @@ -1121,18 +1462,24 @@ you specify the package option \pkgopt[false]{translate}. Note that \gls{xindy} provides much better multi-lingual support than \gls{makeindex}, so it's recommended that you use \gls*{xindy} -if you have glossary entries that contain diacritics or -non-Roman letters. See \sectionref{sec:xindy} for further +if you have glossary entries that contain +\glspl{nonlatinchar}. See \sectionref{sec:xindy} for further details. \section{Generating the Associated Glossary Files} \label{sec:makeglossaries} -In order to generate a sorted glossary with compact \glspl{numberlist}, -it is necessary to use an external \gls{indexingapp} as an -intermediate step. It is this application that creates the file -containing the code that typesets the glossary. If this step is -omitted, the glossaries will not appear in your document. The two +\begin{important} +This section is only applicable if you have chosen \optsor23. You can +ignore this section if you have chosen \opt1. +\end{important} + +In order to generate a sorted glossary with compact +\glspl{numberlist}, it is necessary to use an external +\gls{indexingapp} as an intermediate step (unless you have chosen +\opt1). 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 \glspl*{indexingapp} that are most commonly used with \LaTeX\ are \gls{makeindex} and \gls{xindy}. As from version 1.17, the \styfmt{glossaries} package can be used with either of these @@ -1157,15 +1504,22 @@ on all the glossary files using a customized style file (which is created by \ics{makeglossaries}). See \sectionref{sec:makeglossariesapp} for further details. Perl is stable, cross-platform, open source software that -is used by a number of \TeX-related applications. Further -information is available at \url{http://www.perl.org/about.html}. +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. MiK\TeX\ doesn't come with a~Perl +interpreter so if you are a~Windows MiK\TeX\ user you will need to +install Perl if you want to use \gls{makeglossaries}. +Further information is available at \url{http://www.perl.org/about.html} +and +\href{http://tex.stackexchange.com/questions/158796/miktex-and-perl-scripts-and-one-python-script}{MiKTeX and Perl scripts (and one Python script)}. + The advantages of using \gls*{makeglossaries}: \begin{itemize} \item It automatically detects whether to use \gls*{makeindex} or \gls*{xindy} and sets the relevant application switches. \item One call of \gls*{makeglossaries} will run -\gls*{makeindex}/\gls*{xindy} for each glossary type. +\gls*{makeindex}\slash\gls*{xindy} for each glossary type. \item If things go wrong, \gls{makeglossaries} will scan the messages from \gls{makeindex} or \gls{xindy} and attempt to diagnose @@ -1257,8 +1611,9 @@ If any problems occur, remember to check the transcript files (e.g.\ \filetype{.glg} or \filetype{.alg}) for messages. \begin{table}[htbp] -\caption{Commands and package options that have no effect when -using \texttt{xindy} or \texttt{makeindex} explicitly} +\caption[Commands and package options that have no effect when +using xindy or makeindex explicitly]{Commands and package options that have no effect when +using \gls{xindy} or \gls{makeindex} explicitly} \label{tab:makeglossariesCmds} \vskip\baselineskip \begin{tabular}{@{}lll@{}} @@ -1297,11 +1652,41 @@ You may need to explicitly load \gls{makeglossaries} into Perl: \begin{prompt} perl makeglossaries myDoc \end{prompt} -There is a batch file called \texttt{makeglossaries.bat} which does -this for Windows users, but you must have Perl installed to be able -to use it.\footnote{Apparently MiKTeX has an alternative -\texttt{makeglossaries.exe} but I don't know how using this differs -from using \texttt{makeglossaries.bat}.} You can specify in which directory the \filetype{.aux}, + +Windows users: TeX~Live on Windows has its own internal Perl +interpreter and provides \texttt{makeglossaries.exe} as a~convenient +wrapper for the \gls{makeglossaries} Perl script. MiKTeX also +provides a~wrapper \texttt{makeglossaries.exe} but doesn't provide +a~Perl interpreter, which is still required even if you run MiKTeX's +\texttt{makeglossaries.exe}, so with MiKTeX you'll need to install +Perl. There's more information about this at +\url{http://tex.stackexchange.com/q/158796/19862} on the TeX.SX +site. Alternatively, there is a batch file called +\texttt{makeglossaries.bat} that should be located in the same +folder as the \gls{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 \texttt{perl.exe}, you can +edit the \texttt{makeglossaries.bat} file to include the full path +to \texttt{perl.exe} (but take care as this file will be overwritten +next time you update the \styfmt{glossaries} package). If you move +the \texttt{.bat} file to a new location, you will also need to +supply the full path to the \gls{makeglossaries} Perl script. (Don't +also move the Perl script as well or you may miss out on updates to +\gls{makeglossaries}.) + +The \gls{makeglossaries} script attempts to fork the +\gls{makeindex}\slash\gls{xindy} process using \texttt{open()} on the +piped redirection \verb"2>&1 |" and parses the processor output to +help diagnose problems. If this method fails \gls{makeglossaries} +will print an \qt{Unable to fork} warning and will retry without +redirection. If you run \gls{makeglossaries} on an operating system +that doesn't support this form of redirection, then you can use the +\texttt{-Q} switch to suppress this warning or you can use the +\texttt{-k} switch to make \gls{makeglossaries} automatically use +the fallback method without attempting the redirection. Without this +redirection, the \texttt{-q} (quiet) switch doesn't work as well. + +You can specify in which directory the \filetype{.aux}, \filetype{.glo} etc files are located using the \texttt{-d} switch. For example: \begin{prompt} @@ -1324,14 +1709,15 @@ 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.12. +2.14. \end{important} -\subsection{Using xindy explicitly} +\subsection[Using xindy explicitly (Option~3)]{Using +\gls{xindy} explicitly (\ifpdf \opt3\else Option 3\fi)} \label{sec:xindyapp} -\Gls{xindy} comes with TeXLive, but not with MiKTeX. However MikTeX -users can install it. See +\Gls{xindy} comes with \TeX~Live, but not with MiK\TeX. However +Mik\TeX\ users can install it. See \href{http://tex.stackexchange.com/questions/71167/how-to-use-xindy-with-miktex}{How to use Xindy with MikTeX} on \urlfootref{http://www.stackexchange.com/}{\TeX\ on StackExchange}. @@ -1395,7 +1781,8 @@ you use \gls{xindy} explicitly instead of using \tableref{tab:makeglossariesCmds}. -\subsection{Using makeindex explicitly} +\subsection[Using makeindex explicitly (Option~2)]{Using +\gls{makeindex} explicitly (\ifpdf \opt2\else Option 2\fi)} \label{sec:makeindexapp} If you want to use \gls{makeindex} explicitly, you must @@ -1500,6 +1887,11 @@ the root language (e.g.\ \texttt{english}) and \meta{code} is the encoding (e.g.\ \texttt{utf8}). These commands are omitted if \gls{makeindex} should be used. +If \opt1 has been used, the \texttt{.aux} file will contain +\begin{definition} +\cs{@gls@reference}\marg{type}\marg{label}\marg{location} +\end{definition} +for every time an entry has been referenced. \chapter{Package Options} \label{sec:pkgopts} @@ -1526,6 +1918,15 @@ the \styfmt{glossaries} package. Don't use this option if you're new to using \styfmt{glossaries} as the warnings are designed to help detect common mistakes (such as forgetting to use \ics{makeglossaries}). +\item[\pkgopt{noredefwarn}] If you load \styfmt{glossaries} with +a~class or another package that already defines glossary related +commands, by default \styfmt{glossaries} will warn you that it's +redefining those commands. If you are aware of the consequences of +using \styfmt{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 +\pkgopt{nowarn} option described above. + \item[\pkgopt{nomain}] This suppresses the creation of the main glossary and associated \texttt{.glo} file, if unrequired. Note that if you use this option, you must create another glossary in which to @@ -1573,8 +1974,10 @@ suppose you do: \end{verbatim} and you actually want \cs{mysortvalue} expanded, so that the entry is sorted according to \texttt{AAA}, then use the package option -\pkgopt[false]{sanitizesort}. (The default is -\pkgopt[true]{sanitizesort}.) +\pkgopt[false]{sanitizesort}. + +The default for \optsand23 is \pkgopt[true]{sanitizesort}, and the +default for \opt1 is \pkgopt[false]{sanitizesort}. \item[\pkgopt{savewrites}] This is a boolean option to minimise the number of write registers used by the \styfmt{glossaries} package. @@ -1593,6 +1996,10 @@ alternative, you can use the \sty{scrwfile} package (part of the KOMA-Script bundle) and not use this option. \end{important} +You can also reduce the number of write registers by using +\opt1 or by ensuring you define all your glossary entries in the +preamble. + \begin{important} If you want to use \TeX's \ics{write18} mechanism to call \gls{makeindex} or \gls{xindy} from your document and use @@ -1694,7 +2101,8 @@ See \sectionref{sec:glslink} for further details. specifies whether or not to gather and store the \gls{numberlist} for each entry. The default is \pkgopt[false]{savenumberlist}. (See \ics{glsentrynumberlist} and \ics{glsdisplaynumberlist} in -\sectionref{sec:glsnolink}.) +\sectionref{sec:glsnolink}.) This is always true if you +use \opt1. \end{description} @@ -2037,9 +2445,17 @@ some of the predefined styles. The default setting is \label{sec:pkgopts-sort} \begin{description} -\item[\pkgopt{sort}] This is a \meta{key}=\meta{value} option where -the option can only have one of the following values: - +\item[\pkgopt{sort}] If you use \optsor23, this package option is +the only way of specifying how to sort the glossaries. Only \opt1 +allows you to specify sort methods for individual glossaries +via the \gloskey[printnoidxglossary]{sort} key in the optional +argument of \ics{printnoidxglossary}. If you have multiple +glossaries in your document and you are using \opt1, only use +\pkgopt[def]{sort} or \pkgopt[use]{sort} if you want to set this +sort method for \emph{all} your glossaries. + +This is a \meta{key}=\meta{value} option where +\meta{value} may be one of the following: \begin{itemize} \item \pkgoptval{standard}{sort} : entries are sorted according to the value of the \gloskey{sort} key used in \ics{newglossaryentry} @@ -2079,8 +2495,9 @@ By default \cs{glsprestandardsort} just does: \begin{definition}[\DescribeMacro{\glsdosanitizesort}] \cs{glsdosanitizesort} \end{definition} -which sanitizes \meta{sort cs} if the \pkgopt{sanitizesort} package option -is set (or does nothing if the package option \pkgopt[false]{sanitizesort} is used). +which \gls{sanitize}[s] \meta{sort cs} if the \pkgopt{sanitizesort} package +option is set (or does nothing if the package option +\pkgopt[false]{sanitizesort} is used). The other arguments, \meta{type} and \meta{label}, are the glossary type and the entry label for the current entry. Note that @@ -2098,7 +2515,17 @@ Suppose I have three glossaries: \texttt{main}, \texttt{acronym} and \texttt{notation}, and let's suppose I want the \texttt{main} and \texttt{acronym} glossaries to be sorted alphabetically, but the \texttt{notation} type should be -sorted in order of definition. I can set the sort to standard +sorted in order of definition. + +For \opt1, I~just need to set the \gloskey[printnoidxglossary]{sort} key in +the optional argument of \ics{printnoidxglossary}: +\begin{verbatim} +\printnoidxglossary[sort=word] +\printnoidxglossary[type=acronym,sort=word] +\printnoidxglossary[type=notation,sort=def] +\end{verbatim} + +For \optsor23, I can set the sort to \texttt{standard} (which is the default, but can be explicitly set via the package option \pkgopt[standard]{sort}), and I can either define all my \texttt{main} and \texttt{acronym} entries, then @@ -2136,7 +2563,7 @@ The second option can be achieved as follows: For a complete document, see the sample file \samplefile{Sort}. \end{example} -\begin{example}{Customizing Standard Sort}{ex:customsort} +\begin{example}{Customizing Standard Sort (Options 2 or 3)}{ex:customsort} Suppose you want a glossary of people and you want the names listed as \meta{first-name} \meta{surname} in the glossary, but you want the names sorted by \meta{surname}, \meta{first-name}. You can do this by @@ -2190,15 +2617,31 @@ Note that the \pkgopt{order} option has no effect if you don't use \gls{makeglossaries}. \end{important} -\item[\pkgopt{makeindex}] (Default) The glossary information and +If you use \opt1, this setting will be used if you use +\gloskey[printnoidxglossary]{sort}\texttt{=standard} in +the optional argument of \ics{printnoidxglossary}: +\begin{verbatim} +\printnoidxglossary[sort=standard] +\end{verbatim} +Alternatively, you can specify the order for individual glossaries: +\begin{verbatim} +\printnoidxglossary[sort=word] +\printnoidxglossary[type=acronym,sort=letter] +\end{verbatim} + +\item[\pkgopt{makeindex}] (\opt2) The glossary information and indexing style file will be written in \gls{makeindex} format. If you use \gls{makeglossaries}, it will automatically detect that it needs to call \gls*{makeindex}. If you don't use \gls*{makeglossaries}, you need to remember to use \gls*{makeindex} -not \gls{xindy}. The indexing style file will been given a -\filetype{.ist} extension. +not \gls{xindy}. The indexing style file will been given +a~\filetype{.ist} extension. -\item[\pkgopt{xindy}] The glossary information and indexing style +You may omit this package option if you are using \opt2 as this is the +default. It's available in case you need to override the effect of an earlier +occurrence of \pkgopt{xindy} in the package option list. + +\item[\pkgopt{xindy}] (\opt3) The glossary information and indexing style file will be written in \gls{xindy} format. If you use \gls{makeglossaries}, it will automatically detect that it needs to call \gls*{xindy}. If you don't use \gls*{makeglossaries}, you need to @@ -2223,13 +2666,13 @@ language, codepage and number group settings are unchanged. See \sectionref{sec:xindy} for further details on using \gls{xindy} with the \styfmt{glossaries} package. -\item[\pkgopt{xindygloss}] This is equivalent to +\item[\pkgopt{xindygloss}] (\opt3) This is equivalent to \verb|xindy={}| (that is, the \pkgopt{xindy} option without any value supplied) and may be used as a document class option. The language and code page can be set via \ics{GlsSetXdyLanguage} and \ics{GlsSetXdyCodePage} (see \sectionref{sec:langenc}.) -\item[\pkgopt{xindynoglsnumbers}] This is equivalent to +\item[\pkgopt{xindynoglsnumbers}] (\opt3) This is equivalent to \verb|xindy={glsnumbers=false}| and may be used as a document class option. @@ -2255,6 +2698,12 @@ that's equivalent to (unless that command is already defined before the beginning of the document or the package option \pkgopt{compatible-3.07} is used). +If you are using \opt1, you need to use +\begin{alltt} +\ics{printnoidxglossary}[type=acronym,\meta{options}] +\end{alltt} +to display the list of acronyms. + If the \pkgopt{acronym} package option is used, \ics{acronymtype} is set to \texttt{acronym} otherwise it is set to \texttt{main}.\footnote{Actually it sets \ics{acronymtype} to @@ -2448,7 +2897,15 @@ It also defines \cs{printsymbols}\oarg{options} \end{definition} which is a synonym for -\ics{printglossary}\texttt{[type=symbols,\meta{options}]}. +\begin{alltt} +\ics{printglossary}[type=symbols,\meta{options}] +\end{alltt} + +If you use \opt1, you need to use: +\begin{alltt} +\ics{printnoidxglossary}[type=symbols,\meta{options}] +\end{alltt} +to display the list of symbols. \begin{important} Remember to use the \pkgopt{nomain} package option if you're only @@ -2465,7 +2922,15 @@ It also defines \cs{printnumbers}\oarg{options} \end{definition} which is a synonym for -\ics{printglossary}\texttt{[type=numbers,\meta{options}]}. +\begin{alltt} +\ics{printglossary}[type=numbers,\meta{options}] +\end{alltt} + +If you use \opt1, you need to use: +\begin{alltt} +\ics{printnoidxglossary}[type=numbers,\meta{options}] +\end{alltt} +to display the list of numbers. \begin{important} Remember to use the \pkgopt{nomain} package option if you're only @@ -2478,11 +2943,6 @@ the label \texttt{index} via \newglossary[ilg]{index}{ind}{idx}{\indexname}% \end{verbatim} It also defines -\begin{definition}[\DescribeMacro\printindex] -\cs{printindex}\oarg{options} -\end{definition} -which is a synonym for -\ics{printglossary}\texttt{[type=index,\meta{options}]} and \begin{definition}[\DescribeMacro\newterm] \cs{newterm}\oarg{options}\marg{term} \end{definition} @@ -2491,6 +2951,20 @@ which is a synonym for \ics{newglossaryentry}\marg{term}[type=index,name=\marg{term},% description=\ics{nopostdesc},\meta{options}] \end{alltt} +and +\begin{definition}[\DescribeMacro\printindex] +\cs{printindex}\oarg{options} +\end{definition} +which is a synonym for +\begin{alltt} +\ics{printglossary}[type=index,\meta{options}] +\end{alltt} + +If you use \opt1, you need to use: +\begin{alltt} +\ics{printnoidxglossary}[type=index,\meta{options}] +\end{alltt} +to display this glossary. \begin{important} Remember to use the \pkgopt{nomain} package option if you're only @@ -2540,36 +3014,56 @@ using commands like \ics{GlsSetXdyLanguage} (see \sectionref{sec:xindy} for further details). \begin{important} -I recommend you use this command as soon as possible after loading -\styfmt{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 \pkgopt{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. +If you need to use this command, use it as soon as +possible after loading \styfmt{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 \pkgopt{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. \end{important} \chapter{Setting Up} \label{sec:setup} +In the preamble you need to indicate whether you want to use \opt1, +\opt2 or \opt3. It's not possible to mix these options within +a~document. + +\section[Option 1]{\ifpdf\opt1\else Option 1\fi} +\label{sec:setupopt1} + +The command +\begin{definition}[\DescribeMacro{\makenoidxglossaries}] +\cs{makenoidxglossaries} +\end{definition} +must be placed in the preamble. This sets up the internal commands +required to make \opt1 work. +\textbf{If you omit \cs{makenoidxglossaries} none of +the glossaries will be displayed.} + +\section[Options 2 and 3]{\ifpdf\optsand23\else Options 2 and 3\fi} +\label{sec:setupopt23} + The command \begin{definition}[\DescribeMacro{\makeglossaries}] \cs{makeglossaries} \end{definition} must be placed in the preamble in order to create the customised \gls{makeindex} (\filetype{.ist}) or \gls{xindy} (\filetype{.xdy}) -style file and to ensure that glossary entries are written to the -appropriate output files. \textbf{If you omit \cs{makeglossaries} none of -the glossaries will be created.} +style file (for \optsor23, respectively) and to ensure that glossary +entries are written to the appropriate output files. +\textbf{If you omit \cs{makeglossaries} none of +the glossary files will be created.} \begin{important} Note that some of the commands provided by the \styfmt{glossaries} -package must be placed before \cs{makeglossaries} as they are +package must not be used after \cs{makeglossaries} as they are required when creating the customised style file. If you attempt to use those commands after \cs{makeglossaries} you will generate an error. -Similarly, there are some commands that must be used after +Similarly, there are some commands that must not be used before \cs{makeglossaries}. \end{important} @@ -2578,7 +3072,7 @@ or \gls{makeindex} style file using \begin{definition}[\DescribeMacro{\noist}] \cs{noist} \end{definition} -Note that this command must be used before \cs{makeglossaries}. +That this command must not be used after \cs{makeglossaries}. \begin{important} Note that if you have a custom \filetype{.xdy} file created when using \styfmt{glossaries} version 2.07 or below, you will need to use the @@ -2586,14 +3080,14 @@ Note that if you have a custom \filetype{.xdy} file created when using \end{important} The default name for the customised style file is given by -\ics{jobname}\filetype{.ist} (for \gls{makeindex}) or -\ics{jobname}\filetype{.xdy} (for \gls{xindy}). This name may be +\ics{jobname}\filetype{.ist} (\opt2) or +\ics{jobname}\filetype{.xdy} (\opt3). This name may be changed using: \begin{definition}[\DescribeMacro{\setStyleFile}] \cs{setStyleFile}\marg{name} \end{definition} where \meta{name} is the name of the style file without the -extension. Note that this command must be used before +extension. Note that this command must not be used after \cs{makeglossaries}. Each glossary entry is assigned a \gls{numberlist} that lists all @@ -2610,15 +3104,14 @@ For example: \begin{verbatim} \glsSetCompositor{-} \end{verbatim} -Note that this command must be used before \cs{makeglossaries}. +This command must not be used after \cs{makeglossaries}. -If you use \gls{xindy}, you can have a different compositor for page +If you use \opt3, you can have a different compositor for page numbers starting with an upper case alphabetical character using: \begin{definition}[\DescribeMacro{\glsSetAlphaCompositor}] \cs{glsSetAlphaCompositor}\marg{symbol} \end{definition} -Note that this command has no effect if you haven't used the -\pkgopt{xindy} package option. For example, if you want +This command has no effect if you use \opt2. For example, if you want \glspl{numberlist} containing a mixture of A-1 and 2.3 style formats, then do: \begin{verbatim} @@ -2631,28 +3124,23 @@ See \sectionref{sec:numberlists} for further information about \label{sec:newglosentry} All glossary entries must be defined before they are used, so it is -better to define them in the preamble to ensure this.\footnote{The -only preamble restriction on \ics{newglossaryentry} and -\ics{newacronym} was removed in version 1.13, but the restriction -remains for \ics{loadglsentries}. See \sectionref{sec:docdefs} for +better to define them in the preamble to ensure this. In fact, some +commands such as \cs{longnewglossaryentry} +may only be used in the preamble. See \sectionref{sec:docdefs} for a discussion of the problems with defining entries within the -document instead of in the preamble.} However only those entries that -occur in the document (using any of the commands described in +document instead of in the preamble. +\begin{important} +\opt1 enforces the preamble-only restriction on +\ics{newglossaryentry}. +\end{important} + +Only those entries that are referenced in the document +(using any of the commands described in \sectionref{sec:glslink}, \sectionref{sec:glsadd} or -\sectionref{sec:crossref}) will appear in the glossary. Each time an -entry is used in this way, a line is added to an associated glossary -file (\filetype{.glo}), which then needs to be converted into a -corresponding \filetype{.gls} file which contains the typeset -glossary which is input by \ics{printglossary} or -\ics{printglossaries}. The Perl script \gls{makeglossaries} can be -used to call \gls{makeindex} or \gls{xindy}, using a customised -indexing style file, for each of the glossaries that are defined in -the document. \textbf{Note that there should be no need for you to -explicitly edit or input any of these external -files.}\footnote{Except possibly the style file but then you'll need -to use \ics{noist} to prevent your changes from being -overwritten.} See -\sectionref{sec:makeglossaries} for further details. +\sectionref{sec:crossref}) will appear in the glossary. See +\sectionref{sec:printglossary} to find out how to display the +glossary. + New glossary entries are defined using the command: \begin{definition}[\DescribeMacro{\newglossaryentry}] @@ -2665,8 +3153,7 @@ needs to span multiple paragraphs, use \cs{longnewglossaryentry}\marg{label}\marg{key=value list}\marg{long description} \end{definition} -instead. Note that, unlike \cs{newglossaryentry}, the command -\cs{longnewglossaryentry} may only be used in the preamble. +instead. Note that this command may only be used in the preamble. Be careful of unwanted spaces. \cs{longnewglossaryentry} will remove trailing spaces in the description (via \cs{unskip}) but won't remove leading spaces (otherwise it would interfere with @@ -2690,9 +3177,9 @@ a~unique label with which to identify this entry. This can't contain any non-expandable commands or active characters. \begin{important} -Note that although an accented character or other non-Latin -character, such as \'e or \ss, looks like a plain character in your -\texttt{.tex} file, it's actually a macro (an active character) and +Note that although an \gls{exlatinchar} or other \gls{nonlatinchar}, +such as \'e or \ss, looks like a plain character in your +\texttt{.tex} file, it's actually a~macro (an active character) and therefore can't be used in the label. Also be careful of \sty{babel}'s options that change certain punctuation characters (such as \texttt{:} or \texttt{-}) to active characters. @@ -2702,6 +3189,9 @@ The second argument, \meta{key=value list}, is a \meta{key}=\meta{value} list that supplies the relevant information about this entry. There are two required fields: \gloskey{description} and either \gloskey{name} or \gloskey{parent}. +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: \begin{description} @@ -2778,8 +3268,8 @@ symbol (as passed to \ics{glsdisplay} and \ics{glsdisplayfirst} by \ics{glspl}, \ics{Glspl} and \ics{GLSpl}). If omitted, the value is set to the same as the \gloskey{symbol} key. -\item[{\gloskey{sort}}] This value indicates how \gls{makeindex} or -\gls{xindy} should sort this entry. If omitted, the value is given +\item[{\gloskey{sort}}] This value indicates how this entry should +be sorted. If omitted, the value is given by the \gloskey{name} field unless one of the package options \pkgopt[def]{sort} and \pkgopt[use]{sort} have been used. In general, it's best to use the \gloskey{sort} key if the @@ -2787,6 +3277,78 @@ general, it's best to use the \gloskey{sort} key if the You can also override the \gloskey{sort} key by redefining \ics{glsprestandardsort} (see \sectionref{sec:pkgopts-sort}). +\opt1 by default strips the \glslink{latexexlatinchar}{standard +\LaTeX\ accents} (that is, accents generated by core \LaTeX\ commands) from the +\gloskey{name} key when it sets the \gloskey{sort} key. So with +\opt1: +\begin{verbatim} +\newglossaryentry{elite}{% + name={{\'e}lite}, + description={select group of people} +} +\end{verbatim} +This is equivalent to: +\begin{verbatim} +\newglossaryentry{elite}{% + name={{\'e}lite}, + description={select group of people}, + sort={elite} +} +\end{verbatim} +Unless you use the package option \pkgopt[true]{sanitizesort}, in +which case it's equivalent to: +\begin{verbatim} +\newglossaryentry{elite}{% + name={{\'e}lite}, + description={select group of people}, + sort={\'elite} +} +\end{verbatim} +This will place the entry before the \qt{A} letter group since the +sort value starts with a symbol. + +Similarly if you use the \sty{inputenc} package: +\begin{alltt} +\verb|\newglossaryentry{elite}{%| + name=\verb|{{|\'e\verb|}|lite\verb|}|, + description=\verb|{select group of people}| +\verb|}| +\end{alltt} +This is equivalent to +\begin{alltt} +\verb|\newglossaryentry{elite}{%| + name=\verb|{{|\'e\verb|}|lite\verb|}|, + description=\verb|{select group of people}|, + sort=elite +\verb|}| +\end{alltt} +Unless you use the package option \pkgopt[true]{sanitizesort}, in +which case it's equivalent to: +\begin{alltt} +\verb|\newglossaryentry{elite}{%| + name=\verb|{{|\'e\verb|}|lite\verb|}|, + description=\verb|{select group of people}|, + sort=\'elite +\verb|}| +\end{alltt} +Again, this will place the entry before the \qt{A} group. + +With \optsand23, the default value of \gloskey{sort} will either be +set to the \gloskey{name} key (if \pkgopt[true]{sanitizesort}) or it +will set it to the expansion of the \gloskey{name} key (if +\pkgopt[false]{sanitizesort}). + +\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. + +Take care if you use \opt1 and the \gloskey{name} contains fragile +commands. You will either need to explicitly set the \gloskey{sort} +key or use the \pkgopt[true]{sanitizesort} package option (unless +you use the \texttt{def} or \texttt{use} sort methods). +\end{important} + \item[{\gloskey{type}}] This specifies the label of the glossary in which this entry belongs. If omitted, the default glossary is assumed unless \ics{newacronym} is used (see @@ -2824,7 +3386,7 @@ Alternatively, you can use the \pkgopt{seeautonumberlist} package option. For further details, see \sectionref{sec:crossref}. \begin{important} -\ics{makeglossaries} must be used before any occurrence of +For \optsand23, \ics{makeglossaries} must be used before any occurrence of \ics{newglossaryentry} that contains the \gloskey{see} key. \end{important} @@ -2838,8 +3400,8 @@ and the \sty{glossaries-accsupp} (\sectionref{sec:accsupp}) packages. You can also define your own custom keys (see \sectionref{sec:addkey}). -Note that if the name starts with an accented letter or other non-Latin -character, you must group the character, otherwise it will +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}. For example: \begin{verbatim} @@ -2848,14 +3410,16 @@ description={select group or class}} \end{verbatim} Note that the same applies if you are using the \sty{inputenc} package: -\begin{verbatim} -\newglossaryentry{elite}{name={{é}lite}, -description={select group or class}} -\end{verbatim} +\begin{alltt} +\verb|\newglossaryentry{elite}{name={{|\'e\verb|}lite},| +description=\verb|{select group or class}}| +\end{alltt} Note that in both of the above examples, you will also need to -supply the \gloskey{sort} key if you are using \gls{makeindex} -whereas \gls{xindy} is usually able to sort accented letters -correctly. +supply the \gloskey{sort} key if you are using \opt2 +whereas \gls{xindy} (\opt3) is usually able to sort +\glspl{nonlatinchar} +correctly. \opt1 discards accents from +\glspl{latexexlatinchar} unless you use the \pkgopt[true]{sanitizesort}. \section{Plurals} \label{sec:plurals} @@ -3240,6 +3804,9 @@ been omitted (or, more specifically, for those entries whose type has been specified by \ics{glsdefaulttype}, which is what \ics{newglossaryentry} uses by default). +This is a~preamble-only command. You may also use \ics{input} to load +the file but don't use \ics{include}. + \begin{example}{Loading Entries from Another File}{ex:loadgls} Suppose I have a file called \texttt{myentries.tex} which contains: \begin{verbatim} @@ -3374,7 +3941,9 @@ its parent or children. Originally, \ics{newglossaryentry} (and \ics{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 \env{document} -environment instead of the preamble. +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. \subsection{Technical Issues} \label{sec:techissues} @@ -3384,9 +3953,8 @@ environment instead of the preamble. subsequently shuffle sections around, you could end up using an entry before it has been defined. - \item Entry information is required when the glossary is displayed -using \ics{printglossary} or \ics{printglossaries}. When either of these -commands occur at the start of the document, the entry details are + \item Entry information is required when displaying the glossary. +If this occur at the start of the document, the entry details are being looked up before the entry has been defined. \end{enumerate} @@ -3396,15 +3964,18 @@ To overcome these problems, as from version 4.0 the environment so that the definitions are written to an external file (\cs{jobname}\filetype{.glsdefs}) which is then read in at the start of the document on the next run. The entry will then only be defined -if it doesn't already exist. This means that the entry can now be -looked up in the glossary, even if the glossary occurs at the -beginning of the document. +in the \env{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 \cs{newwrite}, which may exceed -\TeX's maximum allocation; if you have very long entries, you could -find unexpected line breaks have been written to the temporary file. +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. @@ -3429,7 +4000,10 @@ 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. +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. \chapter{Number lists} \label{sec:numberlists} @@ -3443,9 +4017,9 @@ option, or an alternative counter can be set as the default using the \pkgopt{counter} package option. The number list is also referred to as the location list\index{location list|see{number list}}. -Both \gls{makeindex} and \gls{xindy} concatenate a -sequence of 3 or more consecutive pages into a range. With -\gls*{xindy} you can vary the minimum sequence length using +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 \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. @@ -3455,7 +4029,7 @@ Note that \cs{GlsSetXdyMinRangeLength} must be used before \ics{makeglossaries} and has no effect if \ics{noist} is used. \end{important} -With both \gls{makeindex} and \gls{xindy}, you can replace +With both \gls{makeindex} and \gls{xindy} (\optsand23), you can replace the separator and the closing number in the range using: \begin{definition}[\DescribeMacro{\glsSetSuffixF}] \cs{glsSetSuffixF}\marg{suffix} @@ -3470,7 +4044,7 @@ For example: \glsSetSuffixF{f.} \glsSetSuffixFF{ff.} \end{verbatim} -Note that if you use \gls{xindy}, you will also need to +Note that if you use \gls{xindy} (\opt3), you will also need to set the minimum range length to 1 if you want to change these suffixes: \begin{verbatim} @@ -3490,6 +4064,62 @@ before \ics{makeglossaries} and have no effect if \ics{noist} is used. \end{important} +\opt1 doesn't form ranges. However, with this option you +can iterate over an entry's \gls{numberlist} using: +\begin{definition}[\DescribeMacro\glsnumberlistloop] +\cs{glsnumberlistloop}\marg{label}\marg{handler cs}\marg{xr handler +cs} +\end{definition} +where \meta{label} is the entry's label and \meta{handler cs} is a +handler control sequence of the form: +\begin{definition} +\meta{handler cs}\marg{prefix}\marg{counter}\marg{format}\marg{location} +\end{definition} +where \meta{prefix} is the \sty{hyperref} prefix, \meta{counter} is +the name of the counter used for the location, \meta{format} is the +format used to display the location (e.g.\ \texttt{textbf}) +and \meta{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: +\begin{definition} +\meta{xr handler cs}\oarg{tag}\marg{xr list} +\end{definition} +where \meta{tag} is the cross-referenced text (e.g.\ \qt{see}) and +\meta{xr list} is a~comma-separated list of labels. (This actually +has a third argument but it's always empty when used with \opt1.) + +For example, if on page~12 +I~have used +\begin{verbatim} +\gls[format=textbf]{apple} +\end{verbatim} +and on page~18 I~have used +\begin{verbatim} +\gls[format=emph]{apple} +\end{verbatim} +then +\begin{verbatim} +\glsnumberlistloop{apple}{\myhandler} +\end{verbatim} +will be equivalent to: +\begin{verbatim} +\myhandler{}{page}{textbf}{12}% +\myhandler{}{page}{emph}{18}% +\end{verbatim} +There is a predefined handler that's used to display the +\gls{numberlist} in the glossary: +\begin{definition}[\DescribeMacro\glsnoidxdisplayloc] +\cs{glsnoidxdisplayloc}\marg{prefix}\marg{counter}\marg{format}\marg{location} +\end{definition} +The predefined handler used for the cross-references in the glossary is: +\begin{definition} +\cs{glsseeformat}\oarg{tag}\marg{xr list}\marg{location} +\end{definition} +which is described in \sectionref{sec:customxr}. + +\begin{important} +\cs{glsnumberlistloop} is not available for \optsand23. +\end{important} \chapter{Links to Glossary Entries} \label{sec:glslink} @@ -3500,11 +4130,11 @@ commands listed in this section. The text which appears at that point in the document when using one of these commands is referred to as the \gls{linktext} (even if there are no hyperlinks). The commands in this section also add a line to an external file that is -used by \gls{makeindex} or \gls{xindy} to generate the relevant -entry in the glossary. This information includes an associated -location that is added to the \gls{numberlist} for that entry. By -default, the location refers to the page number. For further -information on number lists, see \sectionref{sec:numberlists}. +used to generate the relevant entry in the glossary. This +information includes an associated location that is added to the +\gls{numberlist} for that entry. By default, the location refers to +the page number. For further information on number lists, see +\sectionref{sec:numberlists}. \begin{important} It is strongly recommended that you don't use the commands @@ -3548,8 +4178,8 @@ as a subscript or superscript, if you use the DVI format, it won't come out the correct size. \end{important} -It may be that you only want terms in a certain glossary to have -links, but not for another glossary. In which case, you can use the +It may be that you only want terms in certain glossaries to have +links, but not for other glossaries. In this case, you can use the package option \pkgopt{nohypertypes} to identify the glossary lists that shouldn't have hyperlinked \gls{linktext}. For example, suppose your document contains lots of technical acronyms that the reader @@ -3834,9 +4464,11 @@ $\gls{Falpha}[^2]$ Note that \ics{glslink} doesn't use or affect the \firstuseflag, nor does it use \ics{glsentryfmt} or the equivalent definition provided by \ics{defglsentryfmt} (see \sectionref{sec:glsdisplay}). Instead, -you can use: \begin{definition}[\DescribeMacro{\glsdisp}] +you can use: +\begin{definition}[\DescribeMacro{\glsdisp}] \cs{glsdisp}\oarg{options}\marg{label}\marg{link text} -\end{definition} This behaves in the same way as \ics{gls}, except +\end{definition} +This behaves in the same way as \ics{gls}, except that it uses \meta{link text} instead of the value of the \gloskey{first} or \gloskey{text} key. (Note that this command always sets \meta{insert} to nothing.) This command affects the @@ -4452,10 +5084,12 @@ reference the entry in the main glossary with \verb|\gls{main-svm}|. \label{sec:crossref} \begin{important} -You must use \ics{makeglossaries} \emph{before} defining any -cross-referenced entries. If any of the terms that you have +You must use \ics{makeglossaries} (\optsor23) or +\ics{makenoidxglossaries} (\opt1) \emph{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 \cs{makeglossaries} before all entry definitions. +put \cs{makeglossaries}\slash\cs{makenoidxglossaries} before all +entry definitions. \end{important} There are several ways of cross-referencing entries in the @@ -4502,6 +5136,31 @@ series}, description={Series expansion}, see=[see also]{TaylorsTheorem}} \end{verbatim} +Take care if you want to use the optional argument of commands such +as \ics{newacronym} or \ics{newterm} as the value will need to be +grouped. For example: +\begin{verbatim} +\newterm{seal} +\newterm[see={[see also]seal}]{sea lion} +\end{verbatim} +Similarly if the value contains a list. For example: +\begin{verbatim} +\glossaryentry{lemon}{ + name={lemon}, + description={Yellow citrus fruit} +} +\glossaryentry{lime} +{ + name={lime}, + description={Green citrus fruit} +} +\glossaryentry{citrus} +{ + name={citrus}, + description={Plant in the Rutaceae family}, + see={lemon,lime} +} +\end{verbatim} \item After you have defined the entry, use \begin{definition}[\DescribeMacro{\glssee}] @@ -4532,13 +5191,6 @@ just use the \gloskey{see} key instead of \ics{glssee}, you can automatically activate the \gls*{numberlist} using the \pkgopt{seeautonumberlist} package option. -\begin{important} -You must use \ics{makeglossaries} \emph{before} the entry -definitions containing the \gloskey{see} key and before any -instances of \ics{glssee} or the entry won't be automatically added -to the glossary. -\end{important} - \section{Customising Cross-reference Text} \label{sec:customxr} @@ -4577,7 +5229,7 @@ or (for the last pair) \cs{glsseelastsep} \end{definition} These default to ``",\space"'' and -``\cs{space}\ics{andname}\cs{space}'' respectively. The list entry text +\qt{\cs{space}\ics{andname}\cs{space}} respectively. The list entry text is displayed using: \begin{definition}[\DescribeMacro{\glsseeitemformat}] \cs{glsseeitemformat}\marg{label} @@ -4619,6 +5271,8 @@ you will need to provide an alternative via \sty{hyperref}'s (This isn't specific to the \styfmt{glossaries} package.) See the \sty{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. \end{important} \begin{definition}[\DescribeMacro{\glsentryname}] @@ -4844,7 +5498,7 @@ described in \sectionref{sec:glslink} or \sectionref{sec:glsadd} otherwise you will end up with an undefined link. \end{important} -The next two commands are only available with the +The next two commands are only available with \opt1 or with the \pkgopt{savenumberlist} package option: \begin{definition}[\DescribeMacro{\glsentrynumberlist}] \cs{glsentrynumberlist}\marg{label} @@ -4853,9 +5507,12 @@ The next two commands are only available with the \cs{glsdisplaynumberlist}\marg{label} \end{definition} Both display the \gls{numberlist} for the entry given by -\meta{label} and require a run of \gls{makeglossaries} (or -\gls{xindy} or \gls{makeindex}) followed by one or two runs of -\LaTeX. The first command, \cs{glsentrynumberlist}, simply displays +\meta{label}. When used with \opt1 a~rerun is required to ensure +this list is up-to-date, when used with \optsor23 +a run of \gls{makeglossaries} (or \gls{makeindex}\slash\gls{xindy}) +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: \begin{definition}[\DescribeMacro{\glsnumlistsep}] @@ -4869,11 +5526,13 @@ between the final two elements. The defaults are \verb*|, | and \verb*| \& |, respectively. \begin{important} -\cs{glsdisplaynumberlist} is fairly experimental. It only works when -the default counter format is used (that is, when the -\gloskey[glslink]{format} key is set to \texttt{glsnumberformat}). -This command also doesn't work with \sty{hyperref}. If you try using -it with that package, \cs{glsentrynumberlist} will be used instead. +\cs{glsdisplaynumberlist} is fairly experimental. It works with +\opt1, but for \optsor23 it only works when the default counter +format is used (that is, when the \gloskey[glslink]{format} key is +set to \texttt{glsnumberformat}). This command will only work with +\sty{hyperref} if you choose \opt1. If you try using this command +with \optsor23 and \sty{hyperref}, \cs{glsentrynumberlist} will be +used instead. \end{important} For further information see \ifpdf section~\ref*{sec:code:glsnolink} @@ -4883,24 +5542,44 @@ glossary} in the documented code (\texttt{glossaries-code.pdf}). \chapter{Displaying a glossary} \label{sec:printglossary} -The command +\begin{description} +\item[\opt1:]\null +\begin{definition}[\DescribeMacro{\printnoidxglossaries}] +\cs{printnoidxglossaries} +\end{definition} +(Must be used with \ics{makenoidxglossaries} in the preamble.) + +\item[\optsand23:]\null \begin{definition}[\DescribeMacro{\printglossaries}] \cs{printglossaries} \end{definition} -will display all the glossaries in the order in which they were -defined. Note that no glossaries will appear until you have either +(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. -Remember that you also need to use the command \ics{makeglossaries} -in the preamble to enable the glossaries. +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} +\item[\opt1:]\null +\begin{definition}[\DescribeMacro{\printnoidxglossary}] +\cs{printnoidxglossary}\oarg{options} +\end{definition} +(Must be used with \ics{makenoidxglossaries} in the preamble.) + +\item[\optsand23:]\null \begin{definition}[\DescribeMacro{\printglossary}] \cs{printglossary}\oarg{options} \end{definition} +(Must be used with \ics{makeglossaries} in the preamble.) +\end{description} where \meta{options} is a \meta{key}=\meta{value} list of options. The following keys are available: \begin{description} @@ -4937,6 +5616,25 @@ for this glossary. If false \linebreak(\verb|nonumberlist=false|) the numberlist is displayed for this glossary. If no value is supplied, true is assumed. +\item[{\gloskey{printnoidxglossary}{sort}}] This key is only +available for \opt1. Possible values are: \texttt{word} (word +order), \texttt{letter} (letter order), \texttt{standard} (word or +letter ordering taken from the \pkgopt{order} package option), +\texttt{use} (order of use), \texttt{def} (order of definition) +\texttt{nocase} (case-insensitive) or \texttt{case} (case-sensitive). + +The word and letter order sort methods use \sty{datatool}'s +\ics{dtlwordindexcompare} and \ics{dtlletterindexcompare} handlers. +The case-insensitive sort method uses \sty{datatool}'s +\ics{dtlicompare} handler. The case-sensitive sort method uses +\sty{datatool}'s \ics{dtlcompare} handler. See the \sty{datatool} +documentation for further details. + +If you don't get an error with \texttt{sort=use} and +\texttt{sort=def} but you do get an error with one of the other sort +options, then you probably need to use the +\pkgopt[true]{sanitizesort} package option or make sure none of the +entries have fragile commands in their \gloskey{sort} field. \end{description} By default, the glossary is started either by \ics{chapter*} or by @@ -4963,8 +5661,7 @@ For example: \renewcommand{\glossarypreamble}{Numbers in italic indicate primary definitions.} \end{verbatim} -This needs to be done before the glossary is displayed using -\linebreak\cs{printglossaries} or \cs{printglossary}. +This needs to be done before the glossary is displayed. If you want a different preamble per glossary you can use \begin{definition}[\DescribeMacro{\setglossarypreamble}] @@ -5030,7 +5727,7 @@ medium weight small caps in your glossaries, then you can do: \end{verbatim} \end{example} -\chapter{Xindy} +\chapter[Xindy (Option 3)]{Xindy (\ifpdf\opt3\else Option 3\fi)} \label{sec:xindy} If you want to use \gls{xindy} to sort the glossary, you @@ -5138,7 +5835,6 @@ need to remember to set the language and encoding using the \texttt{-L} and \texttt{-C} switches. \end{important} - \section{Locations and Number lists} \label{sec:xindyloc} @@ -5371,7 +6067,6 @@ is used or if \ics{makeglossaries} is omitted. See \sectionref{sec:numberlists} for further details. - \section{Glossary Groups} \label{sec:groups} @@ -5415,15 +6110,16 @@ is the default title for this new glossary and the final optional argument \meta{counter} specifies which counter to use for the associated \glspl{numberlist} (see also \sectionref{sec:numberlists}). The first optional argument specifies -the extension for the \gls{makeindex} or \gls{xindy} transcript file -(this information is only used by \gls{makeglossaries} which picks -up the information from the auxiliary file). +the extension for the \gls{makeindex} (\opt2) or \gls{xindy} (\opt3) +transcript file (this information is only used by +\gls{makeglossaries} which picks up the information from the +auxiliary file). If you use \opt1, the \meta{log-ext}, +\meta{in-ext} and \meta{out-ext} arguments are ignored. \begin{important} The glossary label \meta{name} must not contain any active characters. It's generally best to stick with just characters that -have category code~11 (typically \texttt{a}, \ldots, \texttt{z} -and \texttt{A}, \ldots, \texttt{Z}). +have category code~11 (typically the non-extended \glspl{latinchar}). \end{important} You can also use: @@ -5460,20 +6156,28 @@ label \texttt{symbols} using: \begin{verbatim} \newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname} \end{verbatim} -and the \pkgopt{numbers} package option creates a new glossary with +The \pkgopt{numbers} package option creates a new glossary with the label \texttt{numbers} using: \begin{verbatim} \newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname} \end{verbatim} +The \pkgopt{index} package option creates a new glossary with +the label \texttt{index} using: +\begin{verbatim} +\newglossary[ilg]{index}{ind}{idx}{\indexname} +\end{verbatim} \begin{important} -All glossaries must be defined before \ics{makeglossaries} to +\optsand23: all glossaries must be defined before \ics{makeglossaries} to ensure that the relevant output files are opened. See \sectionref{sec:fixednames} if you want to redefine \cs{glossaryname}, especially if you are using \sty{babel} or \sty{translator}. (Similarly for \cs{glssymbolsgroupname} and -\cs{glsnumbersgroupname}.) +\cs{glsnumbersgroupname}.) If you want to redefine \ics{indexname}, +just follow the advice in +\href{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fixnam}{How to +change LaTeX’s \qt{fixed names}}. \end{important} \chapter{Acronyms} @@ -5671,7 +6375,7 @@ the \pkgopt{shortcuts} package option to activate the shorter command names listed in \tableref{tab:shortcuts}. \begin{table}[htbp] -\caption[Synonyms provided by the package option shortcuts]{Synonyms provided by the package option \pkgopt{shortcuts}} +\caption{Synonyms provided by the package option \pkgoptfmt{shortcuts}} \label{tab:shortcuts} \vskip\baselineskip \centering @@ -5779,7 +6483,7 @@ or \gloskey{text} keys, but instead they use \ics{defglsentryfmt} to set a~custom format that uses the \gloskey{long} and \gloskey{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 +singular form with the letter \qt{s}. In fact, most of the predefined styles use \ics{glsgenacfmt} and modify the definitions of commands like \ics{genacrfullformat}. @@ -6250,7 +6954,7 @@ change the above to: \renewcommand*{\acronymsort}[2]{##1}% \end{verbatim} The acronym font needs to be set to \ics{textsc} and the plural -suffix adjusted so that the ``s'' suffix in the plural short form +suffix adjusted so that the \qt{s} suffix in the plural short form doesn't get converted to smallcaps: \begin{verbatim} \renewcommand*{\acronymfont}[1]{\textsc{##1}}% @@ -6407,12 +7111,19 @@ example. \label{sec:disploa} The list of acronyms is just like any other type of glossary and can -be displayed on its own using +be displayed on its own using: +\begin{description} +\item[\opt1:]\null +\begin{alltt} +\ics{printnoidxglossary}[type=\ics{acronymtype}] +\end{alltt} + +\item[\optsand23:]\null \begin{alltt} \ics{printglossary}[type=\ics{acronymtype}] \end{alltt} -or with all the other -glossaries using \ics{printglossaries}. (If you use the + +(If you use the \pkgopt{acronym} package option you can also use \begin{alltt} \ics{printacronyms}\oarg{options} @@ -6423,6 +7134,15 @@ as a synonym for \end{alltt} See \sectionref{sec:pkgopts-acronym}.) +\end{description} +Alternatively the list of acronyms can be displayed with all the other +glossaries using: +\begin{description} +\item[\opt1:] \ics{printnoidxglossaries} + +\item[\optsand23:] \ics{printglossaries} +\end{description} + 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 @@ -6596,9 +7316,9 @@ Consider the following example: \end{document} \end{verbatim} -On the first overlay, \verb|\gls{svm}| produces ``support vector -machine (SVM)'' and then unsets the \firstuseflag. When the second -overlay is processed, \verb|\gls{svm}| now produces ``SVM'', which +On the first overlay, \verb|\gls{svm}| produces \qt{support vector +machine (SVM)} and then unsets the \firstuseflag. When the second +overlay is processed, \verb|\gls{svm}| now produces \qt{SVM}, which is unlikely to be the desired effect. I~don't know anyway around this and the only suggestion I~can give is to explicitly reset each acronym on first use: @@ -6634,7 +7354,8 @@ document, you can defined your own style (see \sectionref{sec:newglossarystyle}). The glossary style can be set using the \gloskey[printglossary]{style} key in the optional -argument to \ics{printglossary} or using the command: +argument to \ics{printnoidxglossary} (\opt1) or \ics{printglossary} +(\optsand23) or using the command: \begin{definition}[\DescribeMacro{\setglossarystyle}] \cs{setglossarystyle}\marg{style-name} \end{definition} @@ -6663,7 +7384,7 @@ matches \glostyle{long3col}, \glostyle{long3colheader}, A maximum level of 0 indicates a flat glossary (sub-entries are displayed in the same way as main entries). Where the maximum level is given as --- there is no limit, but note that -\gls{makeindex} imposes a limit of 2 sub-levels. If the +\gls{makeindex} (\opt2) 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.} @@ -6713,7 +7434,8 @@ a tabular-like style it's better to use \ics{newline} instead of \verb|\\|. Note that if you use the \gloskey[printglossary]{style} key in the -optional argument to \ics{printglossary}, it will override any +optional argument to \ics{printnoidxglossary} (\opt1) or +\ics{printglossary} (\optsand23), it will override any previous style settings for the given glossary, so if, for example, you do \begin{verbatim} @@ -7293,7 +8015,8 @@ groups. The navigation line is the same as that for The \sty{glossary-mcols} package provides tree-like styles that are in the \env{multicols} environment (defined by the \sty{multicol} package). The style names are as their analogous tree styles (as -defined in \sectionref{sec:treestyles}) but are prefixed with ``mcol''. +defined in \sectionref{sec:treestyles}) but are prefixed with +\qt{mcol}. For example, the \glostyle{mcolindex} style is essentially the \glostyle{index} style but put in a \env{multicols} environment. For the complete list, see \tableref{tab:mcols}. @@ -7374,22 +8097,22 @@ The \glostyle{inline} style is governed by the following: \begin{definition}[\DescribeMacro{\glsinlineseparator}] \ics{glsinlineseparator} \end{definition} -This defaults to ``\texttt{\glsinlineseparator}'' and is used between +This defaults to \qt{\texttt{\glsinlineseparator}} and is used between main (i.e.\ level~0) entries. \begin{definition}[\DescribeMacro{\glsinlinesubseparator}] \ics{glsinlinesubseparator} \end{definition} -This defaults to ``\texttt{\glsinlinesubseparator}'' and is used between +This defaults to \qt{\texttt{\glsinlinesubseparator}} and is used between sub-entries. \begin{definition}[\DescribeMacro{\glsinlineparentchildseparator}] \ics{glsinlineparentchildseparator} \end{definition} -This defaults to ``\texttt{\glsinlineparentchildseparator}'' and is used between +This defaults to \qt{\texttt{\glsinlineparentchildseparator}} and is used between a parent main entry and its first sub-entry. \begin{definition}[\DescribeMacro{\glspostinline}] \ics{glspostinline} \end{definition} -This defaults to ``\texttt{\glsinlineseparator}'' and is used at the end +This defaults to \qt{\texttt{\glsinlineseparator}} and is used at the end of the glossary. \section{Defining your own glossary style} @@ -8195,8 +8918,9 @@ texmf-dist\slash doc\slash latex\slash glossaries/}. Further information on debugging \LaTeX\ code is available at \url{http://www.dickimaw-books.com/latex/minexample/}. -Below is a list of the most frequently asked questions. For other -queries, consult the +Below is a list of some frequently asked questions about the +\styfmt{glossaries} package. For a complete +list, consult the \urlfootref{http://www.dickimaw-books.com/faqs/glossariesfaq.html}{\styfmt{glossaries} FAQ}. If that doesn't help, try posting your query to somewhere like the comp.text.tex newsgroup, the diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index 6bc51a6a310..5f6142320e7 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -1,5 +1,4 @@ - + @@ -11,7 +10,7 @@ - + -
+
@@ -159,27 +199,30 @@ div.important { border : solid red; }

The glossaries package: a guide for beginners

-
Nicola L.C. Talbot

2014-01-20
+class="cmr-12">2014-03-06
-

-

+

Abstract

-

This document is a brief guide to the glossaries package for beginners who +class="cmr-9">package for beginners find the size of the main user manual daunting and, as such, it only covers +class="cmr-9">who find the size of the main user manual daunting and, as such, it only the basics. For more advanced topics, see the covers the basics. For brevity some options to the commands described here + are omitted. For a more detailed guide, see the main user manual. @@ -189,622 +232,1862 @@ class="cmr-9">. id="x1-1000">Contents

1 What Do I Need? +href="#sec:defterm" id="QQ2-1-2">Defining Terms
2 Getting Started +href="#sec:useterm" id="QQ2-1-3">Using Entries
3 Defining a Term or Symbol +href="#sec:acronyms" id="QQ2-1-4">Acronyms
4 Using a Term +href="#sec:printglossaries" id="QQ2-1-5">Displaying a List of Entries
5 Acronyms +href="#sec:glosstyle" id="QQ2-1-7">Customising the Glossary
6 Displaying the Glossary or List of Acronyms +href="#sec:multigloss" id="QQ2-1-8">Multiple Glossaries +
7 glossaries and hyperref +
8 Cross-References +
9 Further Information
-

+

-

Top

1 What Do I Need?

-

You need to have the glossaries package installed. This and all dependent packages are -contained in both the TeX Live and MikTeX distributions. Use your distribution’s -update manager to ensure you have an up-to-date version. These packages can also be -downloaded from CTAN if you don’t have them installed. See “Installing things on a -(La)TeX System” for further assistance. -

In addition, you need an indexing application. The glossaries package is configured to -use either makeindex or xindy. Makeindex should be available on all TEX systems. It’s -possible you may not have xindy installed, but it can be downloaded from the xindy -home page. MiKTeX users may find the Xindy for MiKTeX thread on the LaTeX -Community Forum helpful. -

The Defining Terms +

When you use the glossaries package provides a helper Perl script called makeglossaries which -will act as an interface to makeindex or xindy. If you want to use makeglossaries or + id="dx1-2001"> 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: +

+
+\newglossaryentry{<label>} +
{ +
  name={<name>}, +
  description={<description>}, +
  <other options> +
} +
+
+

+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 this command in your document.) As with similar labelling commands, such as xindy, you need to have Perl installed. If you don’t have Perl installed, you can still use +class="cmtt-10">\label or \bibitem, the label should not contain active characters, so just use a, …, z, glossaries but you can only use it with makeindex. -

-

-

Top

2 Getting Started

-

The most obvious things to do is to remember to load the glossaries package: +class="cmtt-10">A, …, Z, 0, …, 9. You may also be able to use some punctuation characters, unless they +have been made active (for example, via babel’s shorthand activation.) The +<name> is the word, phrase or symbol you are defining, and <description> is the +description. +

This command is a “short” command, which means that <description> can’t +contain a paragraph break. If you have a long description, you can instead +use: +

+
+\longnewglossaryentry{<label>} +
{ +
  name={<name>}, +
  <other options> +
} +
{<description>} +
+
+

-

-
-\usepackage{glossaries} +

Examples: +

    +
  1. Define the term “set” with the label set: + + + +
    + \newglossaryentry{set} +  
    { +  
      name={set}, +  
      description={a collection of objects} +  
    }
    -

    -

    Note that the glossaries package must be loaded after the hyperref package -(contrary to the general advice that hyperref should be loaded last). The glossaries -package should also be loaded after html, inputenc, babel and ngerman. If you are using -babel I recommend you use the glossaries package option translate=babel: +

    +

    2. +
  2. Define the symbol ∅ with the label emptyset: -

    -
    -\usepackage{babel} - 
    \usepackage[translate=babel]{glossaries} +
    + \newglossaryentry{emptyset} +  
    { +  
      name={\ensuremath{\emptyset}}, +  
      description={the empty set} +  
    }
    -

    -

    -

    If you want to use xindy rather than makeindex to sort the glossaries, you need to -specify this in the package options: +

    +

    3. +
  3. Define the phrase “Fish Age” with the label fishage: -

    -
    -\usepackage[xindy]{glossaries} +
    + \longnewglossaryentry{fishage} +  
    {name={Fish Age}} +  
    {% +  
      A common name for the Devonian geologic period +  
      spanning from the end of the Silurian Period to +  
      the beginning of the Carboniferous Period. +  

      This age was known for its remarkable variety of +  
      fish species. +  
    }
    -

    Other package options are described in Package Options in the main glossaries user -manual. -

    Next, you need to enable the creation of the various external files that are required -by the indexing application. This is done using: -

    \makeglossaries
    -

    -

    Don’t attempt to input any of these external files in your document.
    -

    -

    -

    -

    Top

    3 Defining a Term or Symbol

    -

    You must define terms or symbols before you can use them in the document. This is -best done in the preamble. Each term is defined using: -

    \newglossaryentry{

    (The percent character discards the end of line character that would otherwise + cause an unwanted space to appear at the start of the description.) +

    4. +
  4. Take care if the first letter is an extended Latin or non-Latin character (either + specified via a command such as \’e or explicitly via the inputenc package such + as é). This first letter must be placed in a group: + + + +
    + \newglossaryentry{elite} +  
    { +  
      name={{\’e}lite}, +  
      description={select group or class} +  
    } +
    +

    or

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

Acronyms or abbreviations can be defined using +

\newacronym{<label>}{<settingsshort>}{<long>}
-

+

where <label> is a unique label used to identify the term. The second argument, +class="cmmi-10">> is the label (as with the \newglossaryentry and the \longnewglossaryentry commands), <settings>, is a key=value comma separated list that is used to set the required -information for the term. A full list of available keys can be found in Defining Glossary -Entries in the main glossaries user manual. The principle keys are name and +class="cmti-10">short> is the abbreviation or acronym and description. -

For example, to define the term “electrolyte”: - - - -

-
-\newglossaryentry{electrolyte}{name=electrolyte, - 
description={solution able to conduct electric current}} -
-

In the above example, the label and the name happen to be the same. In the next -example, the name contains a ligature but the label doesn’t: +class="cmmi-10"><long> is the long form. For example:

-\newglossaryentry{oesophagus}{name=\oe sophagus, - 
description={canal from mouth to stomach}, - 
plural=\oe sophagi} -
-

In this case the label is oesophagus. Note that in this case, the plural has to be -specified using the plural key since it isn’t formed by simply appending the letter -“s”. -

If you want to define all your terms in a separate file don’t use \include to input -the file. You can use \input but it’s better to use \loadglsentries. (See Loading -Entries From a File.)
-

-

When you define terms, it is important to remember that they will be sorted by an -external application that doesn’t interpret LATEX commands. xindy is a little more -TEX-aware than makeindex, but for this example they will both mis-sort -\oe sophagus. Xindy will ignore the \oe␣ part and will sort it according to sophagus, -so it will be placed with the terms starting with an “s”. makeindex, on the other hand, -will sort it according to \oe␣sophagus which starts with a symbol (the backslash), so it -will end up in the symbol group. You therefore need to specify how to sort the -term: +\newacronym{svm}{svm}{support vector machine} +

+

This defines a glossary entry with the label svm. By default, the <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:

-\newglossaryentry{oesophagus}{name=\oe sophagus, - 
description={canal from mouth to stomach}, - 
plural=\oe sophagi, - 
sort=oesophagus} +\newacronym + 
 [description={statistical pattern recognition technique}] + 
 {svm}{svm}{support vector machine}
-

Note, however, that if you use the inputenc package and xindy, you can use the -encoded character œ rather than \oe and xindy will sort it correctly: +

+

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{oesophagus}{name=œsophagus, - 
description={canal from mouth to stomach}, - 
plural=œsophagi} +\newglossaryentry{latinalph} + 
{ + 
  name={Latin Alphabet}, + 
  text={Latin alphabet}, + 
  description={alphabet consisting of the letters + 
  a, \ldots, z, A, \ldots, Z} + 
}
-

-

If the name starts with an accented character, the first character must be -grouped: +

This will appear in the text as “Latin alphabet” but will be listed in the glossary as +“Latin Alphabet”. +

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 plural key to override it:

-\newglossaryentry{elite}{name={\’e}lite, - 
description={select group of people}, - 
sort=elite} +\newglossaryentry{oesophagus} + 
{ + 
  name={{\oe}sophagus}, + 
  plural={{\oe}sophagi}, + 
  description={canal from mouth to stomach} + 
}
-

or +

(Remember from earlier that the initial ligature \oe needs to be grouped.) +

The plural forms for acronyms can be specified using the longplural and +shortplural keys. For example:

-\newglossaryentry{elite}{name={é}lite, - 
description={select group of people}} +\newacronym + 
 [longplural={diagonal matrices}] + 
 {dm}{DM}{diagonal matrix}
-

-

The name can also be a symbol, but you will also need to specify the sort key. 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 +name key for the name and the symbol key for the symbol. For example:

-\newglossaryentry{pi}{name={\ensuremath{\pi}}, - 
description={ratio of circumference of circle to its - 
diameter},sort=pi} +\newglossaryentry{emptyset} + 
{ + 
  name={empty set}, + 
  symbol={\ensuremath{\emptyset}}, + 
  description={the set containing no elements} + 
}
-

It’s also possible to have a name and a symbol. For example: - - - -

-
-\newglossaryentry{set}{name=set, - 
description={a collection of objects}, - 
symbol={\ensuremath{\mathcal{S}}}} -
-

Note, however, that not all glossary styles display the symbol in the glossary. -

+

+

-

Top

4 Using a Term

-

Once you have defined a term, you can use it in the document. The glossaries -package provides a number of commands that are described in Links to Glossary -Entries in the main glossaries user manual. Here, I shall just cover the main -commands: -

Top

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

\gls{<label>}
-

-This prints the term associated with

+where <label>. Using the example in the previous -section, \gls{oesophagus} will display œsophagus. If the hyperref package has also -been loaded, the term will also be hyperlinked to the relevant entry in the -glossary. -

> is the label you assigned to the entry when you defined it. For example, +\gls{fishage} will display “Fish Age” in the text (given the definition from the +previous section). +

If the entry was defined as an acronym (using \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, \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>}
-

-This prints the plural of the term associated with

+instead of \gls{<label>, so \glspl{oesophagus} will -display œsophagi. Again, the text will be a hyperlink to the relevant entry in the -glossary, if hyperlinks are defined. -

There are also versions that convert the first character to upper case if you need to -start a sentence with a term: -

>}. For example, \glspl{set} displays “sets”. +

If the term appears at the start of a sentence, you can convert the first letter to +upper case using: +

\Gls{<label>}
-

-and -

+for the singular form or +

\Glspl{<label>}
-

-For example: +

+for the plural form. For example:

-
-\Glspl{electrolyte} usually exist as solutions of salts, - 
bases or acids. +
+\Glspl{set} are collections.
-

-

Note that these commands all have two optional arguments that aren’t discussed -here, but they are described in Links to Glossary Entries in the main glossaries user -manual. -

Don’t use these commands in moving arguments, such as those used by \chapter, -\section and \caption.
-

-You can, instead, use commands such as -

\glsentrytext{

produces “Sets are collections”. +

If you’ve specified a symbol using the symbol key, you can display it using: +

\glssymbol{<label>}
-

-See Using Glossary Terms Without Links in the main glossaries user manual. -

+

+

-

Top

5 Acronyms

-

The

Top

3 Acronyms

+

Recall from above, the first time you use an acronym with \gls, it’s full form is +displayed but subsequent uses display only the short form. By default, the first use +displays <long> (<short>). That is, the long form is displayed followed by the short +form in parentheses. You can change this first-use format with: +

\setacronymstyle{<style name>}
+

+(This must be used before you start defining your acronyms with \newacronym.) There +are a number of predefined styles listed in Predefined Acronym Styles in the main +glossaries package also allows you to define acronyms. By default, acronyms will be -added to the main glossary, but if you use the acronym package option, acronyms will -be placed in a separate list of acronyms: + id="dx1-4001"> user manual. Here are a few examples: +

    +
  1. <short> (<long>) -

    -
    -\usepackage[acronym]{glossaries} +
    + \setacronymstyle{short-long}
    -

    -

    Acronyms must be defined before use and are defined using: -

    \newacronym{

    This displays the short form followed by the long form in parentheses. +

    2. +
  2. <label>}{long> (\textsc{<abbrvshort>}{}) + + + +
    + \setacronymstyle{long-short-sc} +
    +

    This is like the default style but the short form is displayed in small caps. + Remember that when you use \textsc{<fulltext>}

-

-where } to generate small capitals, you + must specify <label> is the label identifying the acronym, text> in lower case, so the short form of the acronym should be + defined in lower case. For example: + + + +

+
+ \newacronym{svm}{svm}{support vector machine} +
+

+

+
  • <abbrv> is the abbreviated form -and long> (\textsmaller{<full> is the fully expanded text. For example: +class="cmti-10">short>}) + + + +
    + \setacronymstyle{long-short-sm} +
    +

    This is similar to the previous style but uses \textsmaller to format the short + form. Remember to load the relsize package, which defines \textsmaller, if you + want to use this style. The short form now needs to be defined in upper + case:

    -
    -\newacronym{label}{svm}{support vector machine} +
    + \newacronym{svm}{SVM}{support vector machine}
    -

    -

    Once the acronym is defined, it can be used in the same way as any other glossary -term with commands such as \gls and \glspl. On first use, the default will display -

    +

    +
    • +

    +

    +

    Top

    4 Displaying a List of Entries

    +

    Suppose you now want to display a list of all the entries you’ve referenced in your +document. This is where things start to get complicated and a lot of new users get +bewildered. You have three options: +

    +

    +
    Option 1: +

    This is the simplest option but it’s slow and if you want a sorted list, it + doesn’t work for non-Latin alphabets. +

    +

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

      \printnoidxglossary[sort=<full> (order>,<abbrv>). On subsequent use, only the abbreviation will appear. For -example: +class="cmitt-10">other options>]
      +

      + where you want your list of entries to appear. The sort <order> may be one + of: word (word ordering), letter (letter ordering), case (case-sensitive + letter ordering), def (in order of definition) or use (in order of + use). +

      3. +
    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 + “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 reads. Then 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). +
      2. +
    2. Put +

      \printglossary[<options>]
      +

      + where you want your list of entries (glossary) to appear. +

      3. +
    3. Run LATEX 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. +
      4. +
    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 command: + + + +
      + makeindex -s myDoc.ist -o myDoc.gls myDoc.glo +
      +

      (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 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 -l switch:

      -
      -A \gls{svm} was implemented. +
      + makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo
      -

      If this is the first time this term has been used, the above would produce: - -
      A support vector machine (svm) was implemented. -
      -otherwise it would produce: -
      A svm was implemented. -
      -If you prefer a different way of displaying the acronyms (for example, putting the long -form in a footnote on first use) it’s possible to change the acronym style. For further -details, see Acronyms in the main

      +

      5. +
    5. Once you have successfully completed the previous step, you can now run + LATEX on your document again.
    +
    +
    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 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 xindy reads. Then xindy writes a new file containing the + code to typeset the glossary. LATEX then reads this file on the next + run. +

    +

      +
    1. Add the xindy option to the glossaries user manual. -

      You can reset an acronym so that the next use fully expands it again using: -

      \glsreset{ package option list: + + + +
      + \usepackage[xindy]{glossaries} +
      +

      +

      2. +
    2. Add \makeglossaries to your preamble (before you start defining your + entries). +
      3. +
    3. Put +

      \printglossary[<labeloptions>}
      -

      -or you can reset all acronyms using -

      \glsresetall
      -

      -For further details on resetting and unsetting acronyms, see Unsetting and Resetting -Entry Flags in the main ]

    +

    + where you want your list of entries (glossary) to appear. +

    +
  • Run LATEX 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. +
    • +
  • 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 + 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 +
    +

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

    +

    • +
  • Once you have successfully completed the previous step, you can now run + LATEX on your document again. +
    • + +

    For Options 2 and 3, it can be difficult to remember all the parameters required for +makeindex or xindy, so the glossaries user manual. -

    + 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 +myDoc.tex, then run: + + +

    -

    Top

    6 Displaying the Glossary or List of Acronyms

    -

    In order to display the sorted list of terms, you first need to use -

    \printglossaries
    -

    -at the place where you want the glossary and list of acronyms to appear. Note that +

    +makeglossaries myDoc +
    +

    (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, +you can probably access 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 + 
     arara: makeglossaries + 
     arara: pdflatex +
    +

    +

    The 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. If you are using Windows and +MiKTEX 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 makeindex directly, as described +above. +

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

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

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

    +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. If you use + the sanitizesort=true 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. +
    +Option 2:
    The sort key will be interpreted the sequence of characters: { \ ’ e } + l i t and e. The first character is an opening curly brace { so makeindex + will put this entry in the “symbols” group. +
    +Option 3:
    xindy disregards LATEX commands so it sorts on elite, which puts + this entry in the “E” group.
    +

    If the inputenc package is used and the entry is defined as:

    +
    +\newglossaryentry{elite} +
    { +
      name={{é}lite}, +
      description={select group or class} +
    } +
    +
    then: +
    +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 sanitizesort=true 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. + + + +
    +Option 2:
    makeindex doesn’t recognise é as a letter so it will be put in the + symbols group. +
    +Option 3:
    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 xindy (Option 3) with the inputenc package. If you use makeindex (Option 2) you +need to specify the sort key like this: + + + +

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

    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 name key if you don’t set the sort +key. +

    Table 1 summarises the pros and cons of three options described above. +

    +
    + + + +

    + + + +
    Table 1: Glossary Options: Pros and Cons
    +
    + + + + + + + +

    		 Option 1 Option 2 Option 3

    Requires + an + external + application?

    		✘ ✔ ✔

    Requires + Perl?

    		✘ ✘ ✔

    Can + sort + extended + Latin + or + non-Latin + alphabets?

    		✘† ✘ ✔

    Efficient + sort + algorithm?

    		✘ ✔ ✔

    Can + form + ranges + in + the + location + lists?

    		✘ ✔ ✔

    Can + have + non-standard + locations?

    		✔ ✘ ✔

    \newglossaryentry + restricted + to + preamble?

    		✔ ✘ ✘
    +

    † 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 description environment to display the entry list. +Each entry name is set in the optional argument of \item which means that it will +typically be displayed in bold. You can switch to medium weight by redefining \printglossaries won’t produce any text the first time you create your document, -as an external indexing application needs to be used to sort and collate the -entries. Creating the completed document is therefore at least a three step -process. -

    Suppose your document is called myDoc.tex, then you need to: +class="cmtt-10">\glsnamefont: + + + +

    +
    +\renewcommand*{\glsnamefont}[1]{\textmd{#1}} +
    +

    +

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

    +
    +\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 +nogroupskip package option: + + + +

    +
    +\usepackage[nogroupskip]{glossaries} +
    +

    +

    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:

    1. Build/LATEX your document, either by clicking on an appropriate button in - your front-end/text editor or by typing the following at a terminal/command - prompt: + class="enumerate" id="x1-6002x1">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: -
      - latex myDoc +
      + \usepackage[nogroupskip,nopostdot]{glossaries} +  
      \usepackage{glossary-mcols} +  
      \setglossarystyle{mcolindex}
      -

      +

    2. Run the indexing application on the external file(s) created by the 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. +
    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: + + + +

      +
      + \usepackage[nopostdot,nonumberlist]{glossaries} +  
      \setglossarystyle{tree} +
      +

    +

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

    +
    +\newacronym + 
     [description={statistical pattern recognition technique}] + 
     {svm}{svm}{support vector machine} +
    +

    Choose a glossary style that suits wide entry names: + + + +

    +
    +\setglossarystyle{altlist} +
    +

    +

    +

    +

    Top

    6 Multiple Glossaries

    +

    The glossaries - package. If you have used the xindy package option, you must use xindy, - otherwise you must use makeindex. The package predefines a default main glossary. When you define an entry +(using one of the commands described in §1 Defining Terms), that entry is +automatically assigned to the default glossary, unless you indicate otherwise using the +type key. However you first need to make sure the desired glossary has been defined. +This is done using: +

    \newglossary[<glg>]{<label>}{<gls>}{<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 <label>. The final +argument <title> is the section or chapter heading used by \printglossary or +\printnoidxglossary. The other arguments indicate the file extensions used +by makeindex/xindy (described in §4 Displaying a List of Entries). If you +use Option 1 described above, the <glg>, <gls> and <glo> arguments are +ignored. 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 +acronyms, the glossaries package comes with a - convenient Perl wrapper that calls the appropriate indexing application the - required number of times with the required options. If you have Perl installed, all - you need to do is type - - - -

    - makeglossaries myDoc -
    -

    in a terminal or command prompt. If you are using a front-end (such as WinEdt - or TeXnicCenter) and you want it to automatically run makeglossaries - when you build your document, you will need to consult the front-end’s - documentation. -

    If you don’t have Perl installed, you will need to call makeindex or xindy - explicitly. This is more complicated and is described in Generating the Associated - Glossary Files in the main package provides the package option acronyms, which is +a convenient shortcut for + + + +

    +
    +\newglossary[alg]{acronym}{acr}{acn}{\acronymname} +
    +

    It 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 +a list of notation: + + + +

    +
    +\usepackage[acronyms]{glossaries} + 
    \newglossary[nlg]{notation}{not}{ntn}{Notation} +
    +

    After \makeglossaries (or \makenoidxglossaries) you can define the entries. For +example: + + + +

    +
    +\newglossaryentry{gls:set} + 
    {% This entry goes in the ‘main’ glossary + 
      name=set, + 
      description={A collection of distinct objects} + 
    } + 
     This entry goes in the ‘acronym’ glossary: + 
    \newacronym{svm}{svm}{support vector machine} + 
    \newglossaryentry{not:set} + 
    {% This entry goes in the ‘notation’ glossary: + 
      type=notation, + 
      name={\ensuremath{\mathcal{S}}}, + 
      description={A set}, + 
      sort={S}} +
    +

    or if you don’t like using \ensuremath: + + + +

    +
    +\newglossaryentry{not:set} + 
    {% This entry goes in the ‘notation’ glossary: + 
      type=notation, + 
      name={$\mathcal{S}$}, + 
      text={\mathcal{S}}, + 
      description={A set}, + 
      sort={S}} +
    +

    +

    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 main glossary is assumed. +

    There’s a convenient shortcut that will display all the defined glossaries: +

    \printnoidxglossaries
    +

    +(Option 1) or +

    \printglossaries
    +

    +(Options 2 and 3). +

    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 without the makeglossaries Perl script then +you need to make sure you run makeindex/xindy for each defined glossary. +The <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 makeindex/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 LATEX document is in a file called myDoc.tex): +

    +

    +
    Option 2: +

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

    +
    + 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 +  
    -o myDoc.acr myDoc.acn +  
    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 glossaries user manual. -

    -
  • Once you have successfully run the indexing application, you need to - build/LATEX your document again (see step 1).
    • -

    Note that sometimes you may have to repeat steps 2 and 3. -

    The appearance of the glossary depends on the glossary style in use. The default -style uses the description environment, but there are many other styles available. These -are described in Glossary Styles in the main package with hyperref. Contrary to the usual +advice that hyperref should be loaded last, glossaries user manual. By default, a -number or list of numbers will appear after each entry in the glossary. This indicates -the page (or pages) on which the term was used. This list can be suppressed using the + id="dx1-8004"> must be loaded after +hyperref: + + + +

    +
    +\usepackage[colorlinks]{hyperref} + 
    \usepackage{glossaries} +
    +

    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. +Also, hyperlinks in sub- or superscripts aren’t correctly sized with the DVI +format. +

    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 don’t want this to happen for nonumberlist package option: +class="cmti-10">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 acronym and notation glossaries but you do want them for entries in the main +glossary, then do:

    -
    -\usepackage[nonumberlist]{glossaries} +
    +\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 hyperfirst=false package +option: + + + +

    +
    +\usepackage[colorlinks]{hyperref} + 
    \usepackage[hyperfirst=false]{glossaries}
    -

    -

    Further information can be found in the main

    +

    Take care not to use non-expandable commands in PDF bookmarks. This +isn’t specific to the glossaries user manual and there is -also an package but is a limitation of PDF bookmarks. +Non-expandable commands include commands like \gls, \glspl, \Gls and \Glspl. +The 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 \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 containing 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. +

    +

    +

    Top

    8 Cross-References

    +

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

    +
    +\longnewglossaryentry{devonian}{name={Devonian}}% + 
    {% + 
      The geologic period spanning from the end of the + 
      Silurian Period to the beginning of the Carboniferous Period. + 
      This age was known for its remarkable variety of + 
      fish species. + 
    } + 
    \newglossaryentry{fishage} + 
    { + 
      name={Fish Age}, + 
      description={Common name for the Devonian period}, + 
      see={devonian} + 
    } +
    +

    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}, + 
      description={alphabet consisting of the letters + 
      a, \ldots, z, A, \ldots, Z}, + 
      see=[see also]{exlatinalph} + 
    } + 
    \newglossaryentry{exlatinalph} + 
    { + 
       name={extended Latin alphabet}, + 
       description={The Latin alphabet extended to include + 
       other letters such as ligatures or diacritics.} + 
    } +
    +

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

    +

    +

    +

    Top

    9 Further Information

    +

    Further information can be found in the main glossaries user manual and there is also +an article on the glossaries package on the LATEX Community’s Know How -section.

    +class="E">EX Community’s Know How section +and a chapter on the glossaries package in Using LATEX 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 6b7eeb0c8af..0b1b6883c6f 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 3c1aed60ecf..c8d9905bde2 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex @@ -8,376 +8,1002 @@ \usepackage{courier} \usepackage{xr-hyper} \fi + +\usepackage{alltt} +\usepackage{pifont} +\usepackage{array} + \usepackage[colorlinks,pdfauthor={Nicola L.C. Talbot}, pdftitle={The glossaries package: a guide for beginners}]{hyperref} +\usepackage[nomain]{glossaries} + +\newcommand*{\yes}{\ding{52}} +\newcommand*{\no}{\ding{56}} \title{The glossaries package: a guide for beginners} \author{Nicola L.C. Talbot} -\date{2014-01-20} +\date{2014-03-06} + +\ifpdf + \externaldocument{glossaries-user} +\fi -\newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} -\newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} +\makeatletter +\newcommand*{\optionlabel}[1]{% + \@glstarget{option#1}{}\textbf{Option~#1}} +\makeatother -\ifpdf\externaldocument{glossaries-user}\fi +\newcommand*{\opt}[1]{\hyperlink{option#1}{Option~#1}} +\newcommand*{\optsor}[2]{Options~\hyperlink{option#1}{#1} +or~\hyperlink{option#2}{#2}} +\newcommand*{\optsand}[2]{Options~\hyperlink{option#1}{#1} +and~\hyperlink{option#2}{#2}} \begin{document} \maketitle \begin{abstract} -This document is a brief guide to the \styfmt{glossaries} package for -beginners who find the size of the main user manual daunting and, as -such, it only covers the basics. For more advanced topics, see the -\docref{main user manual}{glossaries-user}. +This document is a brief guide to the \styfmt{glossaries} package +for beginners who find the size of the main user manual daunting +and, as such, it only covers the basics. For brevity some options to +the commands described here are omitted. For a~more detailed guide, +see the \docref{main user manual}{glossaries-user}. \end{abstract} \tableofcontents -\section{What Do I Need?} -\label{requirements} - -You need to have the \styfmt{glossaries} package installed. This and -all dependent packages are contained in both the TeX~Live and MikTeX -distributions. Use your distribution's update manager to ensure you -have an up-to-date version. These packages can also be downloaded -from CTAN if you don't have them installed. See -\urlfootref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings}{\qt{Installing -things on a (La)TeX System}} for further assistance. - -In addition, you need an indexing application. The \sty{glossaries} -package is configured to use either \app{makeindex} or \app{xindy}. -\app{Makeindex} should be available on all \TeX\ systems. It's -possible you may not have \app{xindy} installed, but it can be -downloaded from the \urlfootref{http://www.xindy.org/}{xindy home -page}. MiKTeX users may find the -\urlfootref{http://www.latex-community.org/forum/viewtopic.php?f=51&t=5383}{Xindy for MiKTeX} thread on the LaTeX Community Forum helpful. - -The \sty{glossaries} package provides a helper Perl script -called \app{makeglossaries} which will act as an interface to -\app{makeindex} or \app{xindy}. If you want to use -\app{makeglossaries} or \app{xindy}, you need to have Perl -installed. If you don't have Perl installed, you can still use -\styfmt{glossaries} but you can only use it with \app{makeindex}. - -\section{Getting Started} -\label{start} - -The most obvious things to do is to remember to load the -\sty{glossaries} package: +\section{Defining Terms} +\label{sec:defterm} + +When you use the \sty{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: +\begin{definition} +\begin{alltt} +\cs{newglossaryentry}\marg{label} +\verb|{| + name=\marg{name}, + description=\marg{description}, + \meta{other options} +\verb|}| +\end{alltt} +\end{definition} +where \meta{label} is a unique label that identifies this entry. +(Don't include the angle brackets \meta{ }. They just indicate the parts of +the code you need to change when you use this command in your document.) As +with similar labelling commands, such as \cs{label} or \cs{bibitem}, +the label should not contain active characters, so just use +\texttt{a}, \ldots, \texttt{z}, \texttt{A}, \ldots, \texttt{Z}, +\texttt{0}, \ldots, \texttt{9}. You may also be able to use some +punctuation characters, unless they have been made active (for +example, via \sty{babel}'s shorthand activation.) +The \meta{name} is the word, phrase or symbol you are defining, +and \meta{description} is the description. + +This command is a ``short'' command, which means that +\meta{description} can't contain a~paragraph break. If you have +a~long description, you can instead use: +\begin{definition} +\begin{alltt} +\cs{longnewglossaryentry}\marg{label} +\verb|{| + name=\marg{name}, + \meta{other options} +\verb|}| +\marg{description} +\end{alltt} +\end{definition} + +Examples: +\begin{enumerate} +\item Define the term ``set'' with the label \texttt{set}: \begin{verbatim} -\usepackage{glossaries} +\newglossaryentry{set} +{ + name={set}, + description={a collection of objects} +} \end{verbatim} -\begin{important} -Note that the \styfmt{glossaries} package must be loaded \emph{after} -the \sty{hyperref} package (contrary to the general advice that -\sty{hyperref} should be loaded last). The \sty{glossaries} package -should also be loaded after \sty{html}, \sty{inputenc}, -\sty{babel} and \sty{ngerman}. If you are using \sty{babel} I -recommend you use the \sty{glossaries} package option -\pkgopt[babel]{translate}: + +\item Define the symbol $\emptyset$ with the label +\texttt{emptyset}: \begin{verbatim} -\usepackage{babel} -\usepackage[translate=babel]{glossaries} +\newglossaryentry{emptyset} +{ + name={\ensuremath{\emptyset}}, + description={the empty set} +} \end{verbatim} -\end{important} -If you want to use \app{xindy} rather than \app{makeindex} to sort the -glossaries, you need to specify this in the package options: +\item Define the phrase ``Fish Age'' with the label +\texttt{fishage}: \begin{verbatim} -\usepackage[xindy]{glossaries} +\longnewglossaryentry{fishage} +{name={Fish Age}} +{% + A common name for the Devonian geologic period + spanning from the end of the Silurian Period to + the beginning of the Carboniferous Period. + + This age was known for its remarkable variety of + fish species. +} \end{verbatim} -Other package options are described in -\xrsectionref{sec:pkgopts}{glossaries-user}{Package Options} -in the main \sty{glossaries} user manual. +(The percent character discards the end of line character that would +otherwise cause an unwanted space to appear at the start of the +description.) -Next, you need to enable the creation of the various external -files that are required by the indexing application. This is done using: -\begin{definition} -\cs{makeglossaries} -\end{definition} - -\begin{important} -\emph{Don't} attempt to input any of these external files in your document. -\end{important} +\item Take care if the first letter is an extended Latin or +non-Latin character (either specified via a~command such as +\verb|\'e| or explicitly via the \sty{inputenc} package such +as \texttt{\'e}). This first letter must be placed in a~group: -\section{Defining a Term or Symbol} -\label{defterm} +\begin{verbatim} +\newglossaryentry{elite} +{ + name={{\'e}lite}, + description={select group or class} +} +\end{verbatim} +or +\begin{alltt} +\verb|\newglossaryentry{elite}| +\verb|{| + name=\verb|{{|\'e\verb|}lite}|, + description=\verb|{select group or class}| +\verb|}| +\end{alltt} +\end{enumerate} -You must define terms or symbols before you can use them in the -document. This is best done in the preamble. Each term is defined -using: +Acronyms or abbreviations can be defined using \begin{definition} -\cs{newglossaryentry}\marg{label}\marg{settings} +\cs{newacronym}\marg{label}\marg{short}\marg{long} \end{definition} -where \meta{label} is a unique label used to identify the term. -The second argument, \meta{settings}, is a key=value comma -separated list that is used to set the required information for -the term. A full list of available keys can be found in -\xrsectionref{sec:newglosentry}{glossaries-user}{Defining Glossary -Entries} -in the main \sty{glossaries} user manual. The principle keys are -\gloskey{name} and \gloskey{description}. - -For example, to define the term \qt{electrolyte}: -\begin{verbatim} -\newglossaryentry{electrolyte}{name=electrolyte, -description={solution able to conduct electric current}} -\end{verbatim} -In the above example, the label and the name happen to be the same. -In the next example, the name contains a ligature but the label -doesn't: -\begin{verbatim} -\newglossaryentry{oesophagus}{name=\oe sophagus, -description={canal from mouth to stomach}, -plural=\oe sophagi} -\end{verbatim} -In this case the label is \texttt{oesophagus}. Note that in this -case, the plural has to be specified using the \gloskey{plural} key -since it isn't formed by simply appending the letter \qt{s}. - -\begin{important} -If you want to define all your terms in a separate file \emph{don't} -use \ics{include} to input the file. You can use \ics{input} but -it's better to use \ics{loadglsentries}. (See -\xrsectionref{sec:loadglsentries}{glossaries-user}{Loading Entries -From a File}.) -\end{important} - -When you define terms, it is important to remember that they will -be sorted by an external application that doesn't interpret \LaTeX\ -commands. \app{xindy} is a little more \TeX-aware than \app{makeindex}, but -for this example they will both mis-sort \verb|\oe sophagus|. -Xindy will ignore the \verb*|\oe | part and will sort it according -to \texttt{sophagus}, so it will be placed with the terms starting -with an \qt{s}. \app{makeindex}, on the other hand, will sort it according -to \verb*|\oe sophagus| which starts with a symbol (the backslash), -so it will end up in the symbol group. You therefore need to -specify how to sort the term: -\begin{verbatim} -\newglossaryentry{oesophagus}{name=\oe sophagus, -description={canal from mouth to stomach}, -plural=\oe sophagi, -sort=oesophagus} -\end{verbatim} -Note, however, that if you use the \sty{inputenc} package and -\app{xindy}, you can use the encoded character \texttt{œ} rather than -\cs{oe} and \app{xindy} will sort it correctly: -\begin{verbatim} -\newglossaryentry{oesophagus}{name=œsophagus, -description={canal from mouth to stomach}, -plural=œsophagi} -\end{verbatim} - -If the name starts with an accented character, the first character -must be grouped: -\begin{verbatim} -\newglossaryentry{elite}{name={\'e}lite, -description={select group of people}, -sort=elite} +where \meta{label} is the label (as with the \cs{newglossaryentry} +and the \cs{longnewglossaryentry} commands), \meta{short} is the abbreviation or +acronym and \meta{long} is the long form. For example: +\begin{verbatim} +\newacronym{svm}{svm}{support vector machine} \end{verbatim} -or +This defines a glossary entry with the label \texttt{svm}. By +default, the \meta{name} is set to \meta{short} (``svm'' in the +above example) and the \meta{description} is set to \meta{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: +\begin{verbatim} +\newacronym + [description={statistical pattern recognition technique}] + {svm}{svm}{support vector machine} +\end{verbatim} + +There are other keys you can use when you define an entry. For +example, the \texttt{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 \texttt{text} key as well. + +For example: +\begin{verbatim} +\newglossaryentry{latinalph} +{ + name={Latin Alphabet}, + text={Latin alphabet}, + description={alphabet consisting of the letters + a, \ldots, z, A, \ldots, Z} +} +\end{verbatim} +This will appear in the text as \qt{Latin alphabet} but will be listed in +the glossary as \qt{Latin Alphabet}. + +Another commonly used key is \texttt{plural} for specifying the +plural of the term. This defaults to the value of the \texttt{text} +key with an ``s'' appended, but if this is incorrect, just use the +\texttt{plural} key to override it: \begin{verbatim} -\newglossaryentry{elite}{name={é}lite, -description={select group of people}} +\newglossaryentry{oesophagus} +{ + name={{\oe}sophagus}, + plural={{\oe}sophagi}, + description={canal from mouth to stomach} +} \end{verbatim} +(Remember from earlier that the initial ligature \cs{oe} needs to +be grouped.) -The name can also be a symbol, but you will also need to specify -the sort key. For example: +The plural forms for acronyms can be specified using the +\texttt{longplural} and \texttt{shortplural} keys. For example: \begin{verbatim} -\newglossaryentry{pi}{name={\ensuremath{\pi}}, -description={ratio of circumference of circle to its -diameter},sort=pi} +\newacronym + [longplural={diagonal matrices}] + {dm}{DM}{diagonal matrix} \end{verbatim} -It's also possible to have a name and a symbol. 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 \texttt{name} key for the name and the \texttt{symbol} key +for the symbol. For example: \begin{verbatim} -\newglossaryentry{set}{name=set, -description={a collection of objects}, -symbol={\ensuremath{\mathcal{S}}}} +\newglossaryentry{emptyset} +{ + name={empty set}, + symbol={\ensuremath{\emptyset}}, + description={the set containing no elements} +} \end{verbatim} -Note, however, that not all glossary styles display the symbol -in the glossary. -\section{Using a Term} -\label{usingterm} +\section{Using Entries} +\label{sec:useterm} -Once you have defined a term, you can use it in the document. The -\sty{glossaries} package provides a number of commands that are -described in \xrsectionref{sec:glslink}{glossaries-user}{Links to -Glossary Entries} in the main \sty{glossaries} user manual. -Here, I shall just cover the main commands: +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: \begin{definition} \cs{gls}\marg{label} \end{definition} -This prints the term associated with \meta{label}. Using the -example in the previous section, \verb|\gls{oesophagus}| -will display \oe sophagus. If the \sty{hyperref} package has also -been loaded, the term will also be hyperlinked to the relevant -entry in the glossary. +where \meta{label} is the label you assigned to the entry when you +defined it. For example, \verb|\gls{fishage}| will display \qt{Fish +Age} in the text (given the definition from the previous section). + +If the entry was defined as an acronym (using \cs{newacronym} +described above), then \cs{gls} will display the full form the first +time it's used and just the short form on +subsequent use. For example, \verb|\gls{svm}| will display \qt{support vector +machine (svm)} the first time it's used, but the next occurrence of +\verb|\gls{svm}| will just display \qt{svm}. + +If you want the plural form, you can use: \begin{definition} \cs{glspl}\marg{label} \end{definition} -This prints the plural of the term associated with \meta{label}, -so \verb|\glspl{oesophagus}| will display \oe sophagi. Again, the -text will be a hyperlink to the relevant entry in the glossary, if -hyperlinks are defined. +instead of \cs{gls}\marg{label}. For example, \verb|\glspl{set}| +displays \qt{sets}. -There are also versions that convert the first character to upper -case if you need to start a sentence with a term: +If the term appears at the start of a~sentence, you can convert the +first letter to upper case using: \begin{definition} \cs{Gls}\marg{label} \end{definition} -and +for the singular form or \begin{definition} \cs{Glspl}\marg{label} \end{definition} -For example: +for the plural form. For example: \begin{verbatim} -\Glspl{electrolyte} usually exist as solutions of salts, -bases or acids. +\Glspl{set} are collections. \end{verbatim} +produces \qt{Sets are collections}. -Note that these commands all have two optional arguments that aren't -discussed here, but they are described in -\xrsectionref{sec:glslink}{glossaries-user}{Links to Glossary -Entries} in the main \sty{glossaries} user manual. - -\begin{important} -Don't use these commands in moving arguments, such -as those used by \cs{chapter}, \cs{section} and \cs{caption}. -\end{important} -You can, instead, use commands such as +If you've specified a symbol using the \texttt{symbol} key, you can +display it using: \begin{definition} -\cs{glsentrytext}\marg{label} +\cs{glssymbol}\marg{label} \end{definition} -See \xrsectionref{sec:glsnolink}{glossaries-user}{Using Glossary -Terms Without Links} in the main \sty{glossaries} user manual. \section{Acronyms} -\label{acronyms} +\label{sec:acronyms} + +Recall from above, the first time you use an acronym +with \cs{gls}, it's full form is displayed but subsequent uses +display only the short form. By default, the first use displays +\meta{long} (\meta{short}). That is, the long form is displayed +followed by the short form in parentheses. You can change this +first-use format with: +\begin{definition} +\cs{setacronymstyle}\marg{style name} +\end{definition} +(This must be used before you start defining your acronyms with +\cs{newacronym}.) There are a~number of predefined styles listed in +\xrsectionref{sec:predefinedacrstyles}{glossaries-user}{Predefined +Acronym Styles} in the main \sty{glossaries} user manual. Here are +a~few examples: +\begin{enumerate} +\item \meta{short} (\meta{long}) +\begin{verbatim} +\setacronymstyle{short-long} +\end{verbatim} +This displays the short form followed by the long form in +parentheses. -The \sty{glossaries} package also allows you to define acronyms. -By default, acronyms will be added to the main glossary, but if -you use the \pkgopt{acronym} package option, acronyms will be -placed in a separate list of acronyms: +\item \meta{long} (\cs{textsc}\marg{short}) +\begin{verbatim} +\setacronymstyle{long-short-sc} +\end{verbatim} +This is like the default style but the short form is displayed in +small caps. Remember that when you use \cs{textsc}\marg{text} to generate small +capitals, you must specify \meta{text} in lower case, so the short +form of the acronym should be defined in lower case. For example: \begin{verbatim} -\usepackage[acronym]{glossaries} +\newacronym{svm}{svm}{support vector machine} \end{verbatim} -Acronyms must be defined before use and are defined using: +\item \meta{long} (\cs{textsmaller}\marg{short}) +\begin{verbatim} +\setacronymstyle{long-short-sm} +\end{verbatim} +This is similar to the previous style but uses \cs{textsmaller} to +format the short form. Remember to load the \sty{relsize} package, +which defines \cs{textsmaller}, if you want to use this style. The +short form now needs to be defined in upper case: +\begin{verbatim} +\newacronym{svm}{SVM}{support vector machine} +\end{verbatim} + +\end{enumerate} + +\section{Displaying a List of Entries} +\label{sec:printglossaries} + +Suppose you now want to display a list of all the entries you've +referenced in your document. This is where things start to get +complicated and a~lot of new users get bewildered. You have three +options: + +\begin{description} +\item[]\optionlabel1: + + This is the simplest option but it's slow and if + you want a sorted list, it doesn't work for non-Latin alphabets. + + \begin{enumerate} + \item Add \cs{makenoidxglossaries} to your preamble (before you + start defining your entries, as described in + \sectionref{sec:defterm}). + + \item Put \begin{definition} -\cs{newacronym}\marg{label}\marg{abbrv}\marg{full} +\cs{printnoidxglossary}[sort=\meta{order},\meta{other options}] \end{definition} -where \meta{label} is the label identifying the acronym, \meta{abbrv} -is the abbreviated form and \meta{full} is the fully expanded text. -For example: + where you want your list of entries to appear. The sort + \meta{order} may be one of: \texttt{word} (word ordering), + \texttt{letter} (letter ordering), \texttt{case} (case-sensitive + letter ordering), \texttt{def} (in order of definition) or + \texttt{use} (in order of use). + + \item 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 ``PDF\LaTeX'' button in your editor. + \end{enumerate} + +\item[]\optionlabel2: + + This option uses an application called \texttt{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 \texttt{makeindex} reads. Then \texttt{makeindex} writes + a~new file containing the code to typeset the glossary. \LaTeX\ then + reads this file on the next run. + + \begin{enumerate} + \item Add \cs{makeglossaries} to your preamble (before you start + defining your entries). + + \item Put +\begin{definition} +\cs{printglossary}\oarg{options} +\end{definition} + where you want your list of entries (glossary) to appear. + + \item Run \LaTeX\ on your document. This creates files with the + extensions \texttt{.glo} and \texttt{.ist} (for example, if your + \LaTeX\ document is called \texttt{myDoc.tex}, then you'll have + two extra files called \texttt{myDoc.glo} and \texttt{myDoc.ist}). + If you look at your document at this point, you won't see the + glossary as it hasn't been created yet. + + \item Run \texttt{makeindex} with the \texttt{.glo} file as the + input file and the \texttt{.ist} file as the style so that + it creates an output file with the extension \texttt{.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: +\begin{verbatim} +makeindex -s myDoc.ist -o myDoc.gls myDoc.glo +\end{verbatim} + (Replace \texttt{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 + \texttt{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 \texttt{-l} + switch: +\begin{verbatim} +makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo +\end{verbatim} + + \item Once you have successfully completed the previous step, + you can now run \LaTeX\ on your document again. + \end{enumerate} + +\item[]\optionlabel3: + + This option uses an application called + \texttt{xindy} to sort the entries. This application is more + flexible than \texttt{makeindex} and is able to sort extended + Latin or non-Latin alphabets. It comes with \TeX~Live but not + with MiK\TeX. Since \texttt{xindy} is a Perl script, if you are + using MiK\TeX\ you will not only need to install \texttt{xindy}, you + will also need to install Perl. In a~similar way to \opt2, this + option involves making \LaTeX\ write the glossary information to + a~temporary file which \texttt{xindy} reads. Then \texttt{xindy} + writes a~new file containing the code to typeset the glossary. + \LaTeX\ then reads this file on the next run. + + \begin{enumerate} + \item Add the \texttt{xindy} option to the \sty{glossaries} +package option list: +\begin{verbatim} +\usepackage[xindy]{glossaries} +\end{verbatim} + + \item Add \cs{makeglossaries} to your preamble (before you start + defining your entries). + + \item Put +\begin{definition} +\cs{printglossary}\oarg{options} +\end{definition} + where you want your list of entries (glossary) to appear. + + \item Run \LaTeX\ on your document. This creates files with the + extensions \texttt{.glo} and \texttt{.xdy} (for example, if your + \LaTeX\ document is called \texttt{myDoc.tex}, then you'll have + two extra files called \texttt{myDoc.glo} and \texttt{myDoc.xdy}). + If you look at your document at this point, you won't see the + glossary as it hasn't been created yet. + + \item Run \texttt{xindy} with the \texttt{.glo} file as the + input file and the \texttt{.xdy} file as a~module so that + it creates an output file with the extension \texttt{.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): +\begin{verbatim} +xindy -L english -C utf8 -I xindy -M myDoc +-t myDoc.glg -o myDoc.gls myDoc.glo +\end{verbatim} + (Replace \texttt{myDoc} with the base name of your \LaTeX\ + document file. Avoid spaces in the file name. If necessary, also replace + \texttt{english} with the name of your language and \texttt{utf8} + with your input encoding.) If you don't know + how to use the command prompt, then you can probably access + \texttt{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 + \texttt{order=letter} package option: +\begin{verbatim} +\usepackage[xindy,order=letter]{glossaries} +\end{verbatim} + + \item Once you have successfully completed the previous step, + you can now run \LaTeX\ on your document again. + + \end{enumerate} + +\end{description} + +For \optsand23, it can be difficult to remember all the +parameters required for \texttt{makeindex} or \texttt{xindy}, so the +\sty{glossaries} package provides a~script called +\texttt{makeglossaries} that reads the \texttt{.aux} file to +determine what settings you have used and will then run +\texttt{makeindex} or \texttt{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 \texttt{myDoc.tex}, +then run: +\begin{verbatim} +makeglossaries myDoc +\end{verbatim} +(Replace \texttt{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, you can probably access \texttt{makeglossaries} +via your text editor. Check your editor's manual for advice. If you +are using \texttt{arara} then you can just use the directives: +\begin{verbatim} +% arara: pdflatex +% arara: makeglossaries +% arara: pdflatex +\end{verbatim} + +The \texttt{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. If you are using Windows and +MiK\TeX\ then you need to install a~Perl distribution for Windows. +If you are using \opt3, then you need to do this anyway as +\texttt{xindy} is also written in Perl. If you are using \opt2 +and can't work out how to install Perl (or for some reason don't +want to install it) then just use \texttt{makeindex} directly, as +described above. + +When sorting the entries, the string comparisons are made according +to each entry's \texttt{sort} key. If this is omitted, the +\texttt{name} key is used. For example, recall the earlier +definition: +\begin{verbatim} +\newglossaryentry{elite} +{ + name={{\'e}lite}, + description={select group or class} +} +\end{verbatim} +No \texttt{sort} key was used, so it's set to the same as the +\texttt{name} key: \verb|{\'e}lite|. How this is interpreted depends +on which option you have used: +\begin{description} +\item[\opt1:] By default, the accent command will be stripped so the +sort value will be \texttt{elite}. This will put the entry in the +\qt{E} letter group. If you use the +\pkgopt[true]{sanitizesort} package option, the sort value will be +interpreted as the sequence of characters: \verb|\| \texttt{'} \texttt{e} +\texttt{l} \texttt{i} \texttt{t} and \texttt{e}. This will place +this entry before the \qt{A} letter group since it starts with a symbol. + +\item[\opt2:] The sort key will be interpreted the sequence of characters: +\verb|{| \verb|\| \verb|'| \texttt{e} \verb|}| \texttt{l} \texttt{i} \texttt{t} +and \texttt{e}. The first character is an opening curly brace +\verb|{| so \texttt{makeindex} will put this entry in the ``symbols'' group. + +\item[\opt3:] +\texttt{xindy} disregards \LaTeX\ commands so it sorts on +\texttt{elite}, which puts this entry in the \qt{E} group. +\end{description} + + +If the \sty{inputenc} package is used and the entry is defined as: +\begin{alltt} +\verb|\newglossaryentry{elite}| +\verb|{| + name=\verb|{{|\'e\verb|}lite},| + description=\verb|{select group or class}| +\verb|}| +\end{alltt} +then: +\begin{description} +\item[\opt1:] By default the sort value will be interpreted as +\texttt{elite} so the entry will be put in the \qt{E} letter group. +If you use the \pkgopt[true]{sanitizesort} package option, the +sort value will be interpreted as \texttt{\'elite} where \'e has +been sanitized (so it's no longer an active character) which will +put this entry before the \qt{A} letter group. + +\item[\opt2:] \texttt{makeindex} doesn't recognise \texttt{\'e} as +a~letter so it will be put in the symbols group. + +\item[\opt3:] \texttt{xindy} will correctly recognise the sort value +\texttt{\'elite} and will place it in whatever letter group is +appropriate for the given language setting. (In English, this would +just be the \qt{E} letter group.) +\end{description} + +Therefore if you have extended Latin or non-Latin characters, your +best option is to use \texttt{xindy} (\opt3) with the \sty{inputenc} +package. If you use \texttt{makeindex} (\opt2) you need to specify the +\texttt{sort} key like this: \begin{verbatim} -\newacronym{label}{svm}{support vector machine} -\end{verbatim} - -Once the acronym is defined, it can be used in the same way as -any other glossary term with commands such as \cs{gls} and -\cs{glspl}. On first use, the default will display \meta{full} -(\meta{abbrv}). On subsequent use, only the abbreviation will -appear. For example: -\begin{verbatim} -A \gls{svm} was implemented. -\end{verbatim} -If this is the first time this term has been used, the above would -produce: -\begin{display} -A support vector machine (svm) was implemented. -\end{display} -otherwise it would produce: -\begin{display} -A svm was implemented. -\end{display} -If you prefer a different way of displaying the acronyms (for -example, putting the long form in a footnote on first use) it's -possible to change the acronym style. For further -details, see \xrsectionref{sec:acronyms}{glossaries-user}{Acronyms} -in the main \sty{glossaries} user manual. - -You can reset an acronym so that the next use fully -expands it again using: +\newglossaryentry{elite} +{ + name={{\'e}lite}, + sort={elite}, + description={select group or class} +} +\end{verbatim} +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. + +\Tableref{tab:optionsp+c} summarises the pros and cons of three options described +above. + +\begin{table}[htbp] + \caption{Glossary Options: Pros and Cons} + \label{tab:optionsp+c} + {% + \centering + \begin{tabular}{>{\raggedright}p{0.3\textwidth}ccc} + & \bfseries \opt1 & \bfseries \opt2 & \bfseries \opt3\\ + Requires an external application? & + \no & \yes & \yes\\ + Requires Perl? & + \no & \no & \yes\\ + Can sort extended Latin + or non-Latin alphabets? & + \no\textsuperscript{\textdagger} & \no & \yes\\ + Efficient sort algorithm? & + \no & \yes & \yes\\ + Can form ranges in the location lists? & + \no & \yes & \yes\\ + Can have non-standard locations? & + \yes & \no & \yes\\ + \ics{newglossaryentry} restricted to preamble? & + \yes & \no & \no + \end{tabular} + \par + }\textsuperscript{\textdagger} Strips standard \LaTeX\ accents so, +for example, \verb|\AA| is treated the same as A. +\end{table} + +\section{Customising the Glossary} +\label{sec:glosstyle} + +The default glossary style uses the \texttt{description} environment +to display the entry list. Each entry name is set in the optional +argument of \cs{item} which means that it will typically be +displayed in bold. You can switch to medium weight by redefining +\cs{glsnamefont}: +\begin{verbatim} +\renewcommand*{\glsnamefont}[1]{\textmd{#1}} +\end{verbatim} + +By default, a~full stop is appended to the description. To prevent +this from happening use the \texttt{nopostdot} package option: +\begin{verbatim} +\usepackage[nopostdot]{glossaries} +\end{verbatim} + +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 \optsor23 described +in \sectionref{sec:printglossaries} location ranges will be compressed. For +example, if an entry was used on pages~1, 2 and~3, with +\optsor23 the location list will appear as 1--3, but with \opt1 it +will appear as 1, 2, 3. If you don't want the locations displayed +you can hide them using the \texttt{nonumberlist} package option: +\begin{verbatim} +\usepackage[nonumberlist]{glossaries} +\end{verbatim} + +Entries are grouped according to the first letter of +each entry's \texttt{sort} key. By default a~vertical gap is placed +between letter groups. You can suppress this with the +\texttt{nogroupskip} package option: +\begin{verbatim} +\usepackage[nogroupskip]{glossaries} +\end{verbatim} + +If the default style doesn't suit your document, you can change the +style using: \begin{definition} -\cs{glsreset}\marg{label} +\cs{setglossarystyle}\marg{style name} \end{definition} -or you can reset all acronyms using +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: +\begin{enumerate} + \item 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 \sty{glossary-mcols} package. For example: +\begin{verbatim} +\usepackage[nogroupskip,nopostdot]{glossaries} +\usepackage{glossary-mcols} +\setglossarystyle{mcolindex} +\end{verbatim} + + \item 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: +\begin{verbatim} +\usepackage[nopostdot]{glossaries} +\setglossarystyle{altlist} +\end{verbatim} + + \item 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: +\begin{verbatim} +\usepackage[nopostdot,nonumberlist]{glossaries} +\setglossarystyle{long4col} +\end{verbatim} +or one of the ``tree'' styles: +\begin{verbatim} +\usepackage[nopostdot,nonumberlist]{glossaries} +\setglossarystyle{tree} +\end{verbatim} +\end{enumerate} + +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 \texttt{long-short-desc} acronym style: +\begin{verbatim} +\setacronymstyle{long-short-desc} +\end{verbatim} +Define the acronyms with a~description: +\begin{verbatim} +\newacronym + [description={statistical pattern recognition technique}] + {svm}{svm}{support vector machine} +\end{verbatim} +Choose a~glossary style that suits wide entry names: +\begin{verbatim} +\setglossarystyle{altlist} +\end{verbatim} + +\section{Multiple Glossaries} +\label{sec:multigloss} + +The \sty{glossaries} package predefines a~default \texttt{main} +glossary. When you define an entry (using one of the commands +described in \sectionref{sec:defterm}), that entry is automatically +assigned to the default glossary, unless you indicate otherwise +using the \texttt{type} key. However you first need to +make sure the desired glossary has been defined. This is done using: \begin{definition} -\cs{glsresetall} +\cs{newglossary}\oarg{glg}\marg{label}\marg{gls}\marg{glo}\marg{title} \end{definition} -For further details on resetting and unsetting acronyms, see -\xrsectionref{sec:glsunset}{glossaries-user}{Unsetting and -Resetting Entry Flags} -in the main \sty{glossaries} user manual. +The \meta{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 \meta{label}. The final argument +\meta{title} is the section or chapter heading used by +\cs{printglossary} or \cs{printnoidxglossary}. The other arguments +indicate the file extensions used by +\texttt{makeindex}\slash\texttt{xindy} (described in +\sectionref{sec:printglossaries}). If you use \opt1 described +above, the \meta{glg}, \meta{gls} and \meta{glo} arguments are +ignored. In the case of \optsor23, all glossary definitions must come before +\cs{makeglossaries}. + +Since it's quite common for documents to have both a~list of terms +and a~list of acronyms, the \sty{glossaries} package provides the +package option \texttt{acronyms}, which is a~convenient shortcut for +\begin{verbatim} +\newglossary[alg]{acronym}{acr}{acn}{\acronymname} +\end{verbatim} +It also changes the behaviour of \cs{newacronym} so that acronyms +are automatically put in the list of acronyms instead of the main +glossary. -\section{Displaying the Glossary or List of Acronyms} -\label{printglossaries} +For example, suppose you want a~main glossary for terms, a~list of +acronyms and a~list of notation: +\begin{verbatim} +\usepackage[acronyms]{glossaries} +\newglossary[nlg]{notation}{not}{ntn}{Notation} +\end{verbatim} +After \cs{makeglossaries} (or \cs{makenoidxglossaries}) you can +define the entries. For example: +\begin{verbatim} +\newglossaryentry{gls:set} +{% This entry goes in the `main' glossary + name=set, + description={A collection of distinct objects} +} + +% This entry goes in the `acronym' glossary: +\newacronym{svm}{svm}{support vector machine} + +\newglossaryentry{not:set} +{% This entry goes in the `notation' glossary: + type=notation, + name={\ensuremath{\mathcal{S}}}, + description={A set}, + sort={S}} +\end{verbatim} +or if you don't like using \cs{ensuremath}: +\begin{verbatim} +\newglossaryentry{not:set} +{% This entry goes in the `notation' glossary: + type=notation, + name={$\mathcal{S}$}, + text={\mathcal{S}}, + description={A set}, + sort={S}} +\end{verbatim} -In order to display the sorted list of terms, you first need to -use +Each glossary is displayed using: +\begin{definition} +\cs{printnoidxglossary}[type=\meta{type}] +\end{definition} +(\opt1) or +\begin{definition} +\cs{printglossary}[type=\meta{type}] +\end{definition} +(\optsand23). Where \meta{type} is the glossary label. If the +type is omitted the default \texttt{main} glossary is assumed. + +There's a~convenient shortcut that will display all the defined +glossaries: +\begin{definition} +\cs{printnoidxglossaries} +\end{definition} +(\opt1) or \begin{definition} \cs{printglossaries} \end{definition} -at the place where you want the glossary and list of acronyms to -appear. Note that \cs{printglossaries} won't produce any text the -first time you create your document, as an external indexing -application needs to be used to sort and collate the entries. -Creating the completed document is therefore \emph{at least} a three -step process. - -Suppose your document is called \texttt{myDoc.tex}, then you need -to: -\begin{enumerate} -\item Build/\LaTeX\ your document, either by clicking on an -appropriate button in your front-end/text editor or by typing the -following at a terminal/command prompt: +(\optsand23). + +If you use \opt1, you don't need to do anything else. If you use +\optsor23 with the \texttt{makeglossaries} Perl script, you +similarly don't need to do anything else. If you use \optsor23 +without the \texttt{makeglossaries} Perl script then you need to +make sure you run \texttt{makeindex}\slash\texttt{xindy} \emph{for +each defined glossary}. The \meta{gls} and \meta{glo} arguments of +\cs{newglossary} specify the file extensions to use instead of +\texttt{.gls} and \texttt{.glo}. The optional argument \meta{glg} is +the file extension for the transcript file. This should be different +for each glossary in case you need to check for +\texttt{makeindex}\slash\texttt{xindy} errors or warnings if things +go wrong. + +For example, suppose you have three glossaries in your document +(\texttt{main}, \texttt{acronym} and \texttt{notation}), +specified using: \begin{verbatim} -latex myDoc +\usepackage[acronyms]{glossaries} +\newglossary[nlg]{notation}{not}{ntn}{Notation} \end{verbatim} +Then (assuming your \LaTeX\ document is in a~file called +\texttt{myDoc.tex}): + +\begin{description} +\item\opt2: -\item Run the indexing application on the external file(s) created -by the \sty{glossaries} package. If you have used the \pkgopt{xindy} -package option, you must use \app{xindy}, otherwise you must use -\app{makeindex}. The \sty{glossaries} package comes with a convenient -Perl wrapper that calls the appropriate indexing application the -required number of times with the required options. If you have Perl -installed, all you need to do is type +You need to run \texttt{makeindex} three times: \begin{verbatim} -makeglossaries myDoc +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 \end{verbatim} -in a terminal or command prompt. If you are using a front-end (such -as WinEdt or TeXnicCenter) and you want it to automatically run -makeglossaries when you build your document, you will need to -consult the front-end's documentation. -If you don't have Perl installed, you will need to call -\app{makeindex} or \app{xindy} explicitly. This is more complicated -and is described in -\xrsectionref{sec:makeglossaries}{glossaries-user}{Generating the -Associated Glossary Files} in the main \sty{glossaries} user manual. +\item\opt3:\nopagebreak -\item Once you have successfully run the indexing application, you -need to build/\LaTeX\ your document again (see step~1). -\end{enumerate} -Note that sometimes you may have to repeat steps~2 and~3. - -The appearance of the glossary depends on the glossary style in -use. The default style uses the \env{description} environment, -but there are many other styles available. These are described -in \xrsectionref{sec:styles}{glossaries-user}{Glossary Styles} -in the main \sty{glossaries} user manual. -By default, a number or list of numbers will appear after each entry -in the glossary. This indicates the page (or pages) -on which the term was used. This list can be suppressed using -the \pkgopt{nonumberlist} package option: +You need to run \texttt{xindy} three times (be careful not to insert +line breaks where the line has wrapped.) \begin{verbatim} -\usepackage[nonumberlist]{glossaries} +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 +-o myDoc.acr myDoc.acn +xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.nlg +-o myDoc.not myDoc.ntn +\end{verbatim} +\end{description} + +\section[glossaries and hyperref]{\styfmt{glossaries} and \styfmt{hyperref}} +\label{sec:hyperref} + +Take care if you use the \sty{glossaries} package with +\sty{hyperref}. Contrary to the usual advice that \sty{hyperref} +should be loaded last, \sty{glossaries} must be loaded \emph{after} +\sty{hyperref}: +\begin{verbatim} +\usepackage[colorlinks]{hyperref} +\usepackage{glossaries} \end{verbatim} +If you use \sty{hyperref} make sure you use PDF\LaTeX\ 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. Also, hyperlinks in sub- or +superscripts aren't correctly sized with the DVI format. + +By default, if the \sty{hyperref} package has been loaded, commands +like \cs{gls} will form a~hyperlink to the relevant entry in the +glossary. If you don't want this to happen for \emph{all} your +glossaries, then use +\begin{definition} +\cs{glsdisablehyper} +\end{definition} +If you want hyperlinks suppressed for entries in specific +glossaries, then use the \texttt{nohypertypes} package option. For +example, if you don't want hyperlinks for entries in the \texttt{acronym} and +\texttt{notation} glossaries but you do want them for entries in the +\texttt{main} glossary, then do: +\begin{verbatim} +\usepackage[colorlinks]{hyperref} +\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries} +\newglossary[nlg]{notation}{not}{ntn}{Notation} +\end{verbatim} + +If you want the hyperlinks suppressed the first time an entry is +used, but you want hyperlinks for subsequence references then use +the \texttt{hyperfirst=false} package option: +\begin{verbatim} +\usepackage[colorlinks]{hyperref} +\usepackage[hyperfirst=false]{glossaries} +\end{verbatim} + +Take care not to use non-expandable commands in PDF bookmarks. This +isn't specific to the \sty{glossaries} package but is a~limitation +of PDF bookmarks. Non-expandable commands include commands like +\cs{gls}, \cs{glspl}, \cs{Gls} and \cs{Glspl}. The \sty{hyperref} +package provides a~way of specifying alternative text for the PDF +bookmarks via \cs{texorpdfstring}. For example: +\begin{verbatim} +\section{The \texorpdfstring{\gls{fishage}}{Fish Age}} +\end{verbatim} +However, it's not a~good idea to use commands like \cs{gls} in +a~section heading as you'll end up with the table of contents in +your location list. Instead you can use +\begin{definition} +\cs{glsentrytext}\marg{label} +\end{definition} +This is expandable provided that the \texttt{text} key doesn't +containing non-expandable code. For example, the following works: +\begin{verbatim} +\section{The \glsentrytext{fishage}} +\end{verbatim} +and it doesn't put the table of contents in the location list. + +\section{Cross-References} +\label{sec:xr} + +You can add a~reference to another entry in a~location list using +the \texttt{see=}\marg{label} key when you define an entry. +The referenced entry must also be defined. + +For example: +\begin{verbatim} +\longnewglossaryentry{devonian}{name={Devonian}}% +{% + The geologic period spanning from the end of the + Silurian Period to the beginning of the Carboniferous Period. + + This age was known for its remarkable variety of + fish species. +} + +\newglossaryentry{fishage} +{ + name={Fish Age}, + description={Common name for the Devonian period}, + see={devonian} +} +\end{verbatim} +The cross-reference will appear as \qt{\emph{see} Devonian}. You can +change the \qt{see} tag using the format +\texttt{see=}\oarg{tag}\meta{label}. For example: +\begin{verbatim} +\newglossaryentry{latinalph} +{ + name={Latin alphabet}, + description={alphabet consisting of the letters + a, \ldots, z, A, \ldots, Z}, + see=[see also]{exlatinalph} +} +\newglossaryentry{exlatinalph} +{ + name={extended Latin alphabet}, + description={The Latin alphabet extended to include + other letters such as ligatures or diacritics.} +} +\end{verbatim} +If you use the \texttt{see} key in the optional argument of +\cs{newacronym}, make sure you enclose the value in braces. For +example: +\begin{verbatim} +\newacronym{ksvm}{ksvm}{kernel support vector machine} +\newacronym + [see={[see also]{ksvm}}] + {svm}{svm}{support vector machine} +\end{verbatim} + +\section{Further Information} +\label{sec:moreinfo} Further information can be found in the main \sty{glossaries} \docref{user manual}{glossaries-user} and there is also an \href{http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114}{article on the glossaries package} on the \urlfootref{http://www.latex-community.org/}{\LaTeX\ Community's} -Know How section. +Know How section and a~chapter on the \sty{glossaries} package in +\href{http://www.dickimaw-books.com/latex/thesis/}{Using +\LaTeX\ to Write a PhD Thesis}. \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index 8d06788c037..f9ce5bc72fe 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -1,5 +1,4 @@ - + @@ -11,67 +10,46 @@ - + -
    +
    @@ -199,141 +179,146 @@ div.important { border : solid red; }

    Upgrading from the glossary package to the glossaries package

    Nicola L.C. Talbot

    +class="cmr-12">Nicola L.C. Talbot

    2014-01-20
    +class="cmr-12">2014-03-06
    -

    -

    Abstract

    -

    The purpose of this document is to provide advice if you want to convert a - LAT

    +

    Abstract

    +

    The purpose of this document is to provide advice if you want to + convert a LATEX document from using the obsolete glossary package to the replacement +class="cmr-9">EX document from using the obsolete glossary package to the glossaries package. +class="cmr-9">replacement glossaries package.

    Contents

    1 Why the Need for a New Package? +href="#whyglossaries" id="QQ2-1-2">Why the Need for a New Package?
    2 Package Options +href="#packageoptions" id="QQ2-1-3">Package Options
    3 Dening new glossary types +href="#definingnewglossarytypes" id="QQ2-1-5">Defining new glossary types
    4 \make +class="cmtt-10">\make<glossary name>
    5 Storing glossary information +href="#storingglossaryinformation" id="QQ2-1-7">Storing glossary information
    6 Adding an entry to the glossary +href="#addinganentrytotheglossary" id="QQ2-1-8">Adding an entry to the glossary
     6.1 \useglosentry +class="cmtt-10">\useglosentry
     6.2 \useGlosentry +class="cmtt-10">\useGlosentry
     6.3 \gls +class="cmtt-10">\gls
     6.4 \glossary -
    7 Acronyms +class="cmtt-10">\glossary +
    7 Acronyms
     7.1 \acrln and \acrsh +class="cmtt-10">\acrln and \acrsh
     7.2 \ifacronymfirstuse +class="cmtt-10">\ifacronymfirstuse
     7.3 \resetacronym and \unsetacronym +class="cmtt-10">\resetacronym and \unsetacronym
    8 Displaying the glossary +href="#displayingtheglossary" id="QQ2-1-17">Displaying the glossary
    9 Processing Your Document +href="#processingyourdocument" id="QQ2-1-18">Processing Your Document
    10 Troubleshooting +href="#troubleshooting" id="QQ2-1-19">Troubleshooting
    Index +href="#index">Index
    -

    +

    -

    Top

    1 Why the Need for a New Package?

    -

    The glossary package started out as an example in a tutorial, but I decided that I may as well -package it up and upload it to CTAN. Unfortunately it was fairly rigid and unable to adapt -well to the wide variation in glossary styles. Users began making requests for enhancements, -but with each enhancement the code became more complicated and bugs crept in. Each x -in one place seemed to cause another problem elsewhere. In the end, it was taking up too -much of my time to maintain, so I decided to replace it with a much better designed package. -With the new glossaries package: +

    Top

    1 Why the Need for a New Package?

    +

    The glossary package started out as an example in a tutorial, but I decided that I may +as well package it up and upload it to CTAN. Unfortunately it was fairly rigid and +unable to adapt well to the wide variation in glossary styles. Users began making +requests for enhancements, but with each enhancement the code became more +complicated and bugs crept in. Each fix in one place seemed to cause another problem +elsewhere. In the end, it was taking up too much of my time to maintain, so I decided +to replace it with a much better designed package. With the new glossaries +package:

      -
    • you can dene irregular plurals; +
    • you can define irregular plurals;
      • -
    • glossary terms can have an associated symbol in addition to the name and +
    • glossary terms can have an associated symbol in addition to the name and description;
    • new glossary styles are much easier to design;
      • -
    • you can add dictionaries to supply translations for the xed names used in +
    • you can add dictionaries to supply translations for the fixed names used in headings and by some of the glossary styles;
    • you can choose1 - between using makeindex or xindy to sort the glossary. Using xindymakeindex or xindy to sort the glossary. Using xindy means that: - -

      +

      -

      Top

      2 Package Options

      -

      When converting a document that currently uses the obsolete glossary package to the +

      Top

      2 Package Options

      +

      When converting a document that currently uses the obsolete glossary package to the replacement glossaries package, it should be fairly obvious that the rst thing you -need to do is replace \usepackage{glossary} with \usepackage{glossaries}, -however some of the package options are dierent, so you may need to change those -as well. Table 1 shows the mappings from the glossary to the glossaries package +class="cmss-10">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 1 shows the mappings from the glossary to the glossaries package options.

      -

      @@ -376,11 +361,11 @@ options.
      Table 1: Mappings from glossary to glossaries package options
      +class="cmss-10">glossary to glossaries package options
      -

      +

      +class="cmssbx-10">glossaries option +class="td11">style=list +class="td11">style=altlist +class="td11">style=long +class="td11">style=longheader +class="td11">style=longborder +class="td11">style=longheaderborder +class="td11">style=long3col +class="td11">style=long3colheader +class="td11">style=long3colborder +class="td11">style=super,header=none,border=none,cols=2 +class="td11">style=superheader +class="td11">style=superborder +class="td11">style=superheaderborder +class="td11">style=super,header=none,border=none,cols=3 +class="td11">style=super3colheader +class="td11">style=super3colborder +class="td11">number=none +class="cmmi-10"><counter name> +class="td11">toc +class="td11">hypertoc +class="cmti-10">no corresponding option +class="td11">section=true +class="cmti-10">no corresponding option +class="td11">acronym
      glossary option glossary option glossaries option
      style=list style=list style=list
      style=altlist style=altlist style=altlist
      style=long,header=none,border=none,cols=2 style=long
      style=long,header=plain,border=none,cols=2 style=longheader
      style=long,header=none,border=plain,cols=2 style=longborder
      style=long,header=plain,border=plain,cols=2 style=longheaderborder
      style=long,header=none,border=none,cols=3 style=long3col
      style=long,header=plain,border=none,cols=3 style=long3colheader
      style=long,header=none,border=plain,cols=3 style=long3colborder
      style=long,header=plain,border=plain,cols=3 style=long3colheaderborder
      style=super,header=none,border=none,cols=2style=super style=super
      style=super,header=plain,border=none,cols=2style=superheader
      style=super,header=none,border=plain,cols=2style=superborder
      style=super,header=plain,border=plain,cols=2style=superheaderborder
      style=super,header=none,border=none,cols=3style=super3col style=super3col
      style=super,header=plain,border=none,cols=3style=super3colheader
      style=super,header=none,border=plain,cols=3style=super3colborder
      style=super,header=plain,border=plain,cols=3style=super3colheaderborder
      number=none nonumberlist nonumberlist
      number= <counter name> counter=
      toc toc toc
      hypertoc toc toc
      hyper hyper no corresponding option
      section=true section section
      section=false section=false no corresponding option
      acronym acronym acronym
      global global no corresponding option
      +class="cmti-10">no corresponding option
      -

      Top

      3 Dening new glossary types

      -

      If you have created new glossary types, you will need to replace all instances of -

      glossary +

      Top

      3 Defining new glossary types

      +

      If you have created new glossary types, you will need to replace all instances +of +

      glossary \newglossarytype\newglossarytype[<log-ext>]{<type>}{<out-ext>}{<in-ext>}[<old style +class="cmtt-10">[<log-ext>]{<type>}{<out-ext>}{<in-ext>}[<old list>]
      style list>]

      \newcommand{\<type>name}{<title>} +class="cmtt-10">\newcommand{\<type>name}{<title>}

      with -

      glossaries +

      glossaries \newglossary\newglossary[<log-ext>]{<type>}{<out-ext>}{<in-ext>}{<title>} +class="cmtt-10">[<log-ext>]{<type>}{<out-ext>}{<in-ext>}{<title>}

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

      glossaries +

      glossaries \glossarystyle\glossarystyle{<new style>} +class="cmtt-10">{<new style>}

      -immediately before the glossary is displayed, or you can specify the style when you display -the glossary using \printglossary\printglossary (see below). -

      The optional argument can be converted to using the same -mapping given in Table 1. -

      For example, if your document contains the following: +

      The <old style list> optional argument can be converted to <new style> using the +same mapping given in Table 1. +

      For example, if your document contains the following: @@ -596,7 +616,7 @@ href="#x1-30011">1. \newglossarytype[nlg]{notation}{not}{ntn}[style=long,header]  
      \newcommand{\notationname}{Index of Notation}

      -

      You will need to replace the above two lines with: +

      You will need to replace the above two lines with: @@ -604,7 +624,7 @@ href="#x1-30011">1.

      \newglossary[nlg]{notation}{not}{ntn}{Index of Notation}
      -

      in the preamble and +

      in the preamble and @@ -612,12 +632,13 @@ href="#x1-30011">1.

      \glossarystyle{longheader}
      -

      immediately prior to displaying this glossary. Alternatively, you can specify the style using -the style

      immediately prior to displaying this glossary. Alternatively, you can specify the +style using the style key in the optional argument of \printglossary. For example: +class="cmtt-10">\printglossary. For +example: @@ -625,48 +646,58 @@ class="ec-lmtt-10">\printglossary \printglossary[type=notation,style=longheader]

      -

      -

      Note that the glossary title is no longer specied using \name (except for -\glossaryname

      +

      Note that the glossary title is no longer specified using \<glossary-type>name +(except for \glossaryname and \acronymname) but is instead specied in the </span>argument of -<span -class="ec-lmtt-10">\newglossary</span><a - id="dx1-4009"></a>. The short title which is speci�ed in the <span -class="ec-lmss-10">glossary </span>package by the command -<span -class="ec-lmtt-10">\short</span><span -class="futri8t-"><glossary-name></span><span -class="ec-lmtt-10">name </span>is now speci�ed using the <span -class="ec-lmss-10">toctitle</span><a - id="dx1-4010"></a> key in the optional argument -to <span -class="ec-lmtt-10">\printglossary</span><a +class="cmtt-10">\acronymname</span><a + id="dx1-4008"></a>) but is instead specified in the <span +class="cmmi-10"><</span><span +class="cmti-10">title</span><span +class="cmmi-10">></span> +argument of <span +class="cmtt-10">\newglossary</span><a + id="dx1-4009"></a>. The short title which is specified in the <span +class="cmss-10">glossary </span>package by +the command <span +class="cmtt-10">\short</span><span +class="cmmi-10"><</span><span +class="cmti-10">glossary-name</span><span +class="cmmi-10">></span><span +class="cmtt-10">name </span>is now specified using the <span +class="cmss-10">toctitle</span><a + id="dx1-4010"></a> key in the +optional argument to <span +class="cmtt-10">\printglossary</span><a id="dx1-4011"></a>. -</p><!--l. 214--><p class="noindent" > +</p><!--l. 216--><p class="noindent" > </p> -<!--l. 214--><p class="noindent" ><a -href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a +<!--l. 216--><p class="noindent" ><a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a id="x1-50004"></a><span -class="ec-lmtt-10">\make</span><span -class="futri8t-"><glossary name></span></h3> -<!--l. 216--><p class="noindent" >All instances of <span -class="ec-lmtt-10">\make</span><span -class="futri8t-"><glossary name> </span>(e.g. <span -class="ec-lmtt-10">\makeglossary</span><a +class="cmtt-10">\make</span><span +class="cmmi-10"><</span><span +class="cmti-10">glossary name</span><span +class="cmmi-10">></span></h3> +<!--l. 218--><p class="noindent" >All instances of <span +class="cmtt-10">\make</span><span +class="cmmi-10"><</span><span +class="cmti-10">glossary name</span><span +class="cmmi-10">> </span>(e.g. <span +class="cmtt-10">\makeglossary</span><a id="dx1-5001"></a> and <span -class="ec-lmtt-10">\makeacronym</span><a - id="dx1-5002"></a>) should be -replaced by the single command <span -class="ec-lmtt-10">\makeglossaries</span><a - id="dx1-5003"></a>. For example, if your document -contained the following: +class="cmtt-10">\makeacronym</span><a + id="dx1-5002"></a>) +should be replaced by the single command <span +class="cmtt-10">\makeglossaries</span><a + id="dx1-5003"></a>. For example, if your +document contained the following: @@ -675,7 +706,7 @@ contained the following: \makeglossary  <br />\makeacronym </div> -<!--l. 223--><p class="nopar" > then you should replace both lines with the single line: +<!--l. 225--><p class="nopar" > then you should replace both lines with the single line: @@ -683,112 +714,138 @@ contained the following: <div class="verbatim" id="verbatim-6"> \makeglossaries </div> -<!--l. 227--><p class="nopar" > -</p><!--l. 229--><p class="noindent" > +<!--l. 229--><p class="nopar" > +</p><!--l. 231--><p class="noindent" > </p> -<!--l. 229--><p class="noindent" ><a -href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a - id="x1-60005"></a>Storing glossary information</h3> -<!--l. 231--><p class="noindent" >With the old <span -class="ec-lmss-10">glossary </span>package you could optionally store glossary information for later use, -or you could simply use <span -class="ec-lmtt-10">\glossary</span><a +<!--l. 231--><p class="noindent" ><a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a + id="storingglossaryinformation"></a>Storing glossary information</h3> +<!--l. 233--><p class="noindent" >With the old <span +class="cmss-10">glossary </span>package you could optionally store glossary information for later +use, or you could simply use <span +class="cmtt-10">\glossary</span><a id="dx1-6001"></a> whenever you wanted to add information to the glossary. With the new <span -class="ec-lmss-10">glossaries </span>package, the latter option is no longer +class="cmss-10">glossaries </span>package, the latter option is no longer available.<span class="footnote-mark"><a href="#fn3x0" id="fn3x0-bk"><sup class="textsuperscript">3</sup></a></span><a id="x1-6002f3"></a> If you have stored all the glossary information using <span -class="ec-lmtt-10">\storeglosentry</span><a - id="dx1-6004"></a>, then you will need to -convert these commands into the equivalent <span -class="ec-lmtt-10">\newglossaryentry</span><a - id="dx1-6005"></a>. If you have only used -<span -class="ec-lmtt-10">\glossary</span><a +class="cmtt-10">\storeglosentry</span><a + id="dx1-6004"></a>, then you will +need to convert these commands into the equivalent <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-6005"></a>. If you have +only used <span +class="cmtt-10">\glossary</span><a id="dx1-6006"></a>, then see <a -href="#x1-110006.4">�6.4 </a><a href="#x1-110006.4"><span -class="ec-lmtt-10">\glossary</span><!--tex4ht:ref: sec:csglossary --></a>. -</p><!--l. 242--><p class="indent" > Substitute all instances of -</p><!--l. 243--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +class="cmsy-10">§</span>6.4 </a><a +href="#x1-110006.4"><span +class="cmtt-10">\glossary</span><!--tex4ht:ref: sec:csglossary --></a>. +</p><!--l. 244--><p class="indent" > Substitute all instances of +</p><!--l. 245--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\storeglosentry</span><a +class="cmtt-10">\storeglosentry</span><a id="dx1-6007"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}{</span><span -class="ec-lmtti-10"><gls-entry></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">gls-entry</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> with -</p><!--l. 247--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 249--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\newglossaryentry</span><a +class="cmtt-10">\newglossaryentry</span><a id="dx1-6008"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}{</span><span -class="ec-lmtti-10"><gls-entry></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">gls-entry</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> -This should be fairly easy to do using the search and replace facility in your editor (but see -notes below). -</p><!--l. 253--><p class="indent" > If you have used the optional argument of <span -class="ec-lmtt-10">\storeglosentry</span><a +This should be fairly easy to do using the search and replace facility in your editor (but +see notes below). +</p><!--l. 255--><p class="indent" > If you have used the optional argument of <span +class="cmtt-10">\storeglosentry</span><a id="dx1-6009"></a> (i.e. you have multiple glossaries) then you will need to substitute -</p><!--l. 256--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +</p><!--l. 258--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\storeglosentry</span><a +class="cmtt-10">\storeglosentry</span><a id="dx1-6010"></a><span -class="ec-lmtt-10">[</span><span -class="ec-lmtti-10"><gls-type></span><span -class="ec-lmtt-10">]{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}{</span><span -class="ec-lmtti-10"><gls-entry></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">[</span><span +class="cmmi-10"><</span><span +class="cmitt-10">gls-type</span><span +class="cmmi-10">></span><span +class="cmtt-10">]{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">gls-entry</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> with -</p><!--l. 260--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 262--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\newglossaryentry</span><a +class="cmtt-10">\newglossaryentry</span><a id="dx1-6011"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}</span><span class="verb"><span -class="ec-lmtt-10">{</span></span><span -class="ec-lmtti-10"><gls-entry></span><span -class="ec-lmtt-10">,type=</span><span -class="ec-lmtti-10"><gls-type></span><span class="verb"><span -class="ec-lmtt-10">}</span></span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span><span class="verb"><span +class="cmtt-10">{</span></span><span +class="cmmi-10"><</span><span +class="cmitt-10">gls-entry</span><span +class="cmmi-10">></span><span +class="cmtt-10">,type=</span><span +class="cmmi-10"><</span><span +class="cmitt-10">gls-type</span><span +class="cmmi-10">></span><span class="verb"><span +class="cmtt-10">}</span></span> <br /></div><hr> <br /></span> -</p><!--l. 264--><p class="indent" > The glossary entry information <span -class="futri8t-"><gls-entry> </span>may also need changing. If <span -class="futri8t-"><gls-entry></span> -contains any of <span -class="ec-lmtt-10">makeindex</span><a - id="dx1-6012"></a>'s special characters (i.e. <span -class="ec-lmtt-10">@!</span><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">"</span></span></span> or <span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">|</span></span></span>) then they should no longer be -escaped with <span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">"</span></span></span> since the <span -class="ec-lmss-10">glossaries </span>package deals with these characters internally. For -example, if your document contains the following: +</p><!--l. 266--><p class="indent" > The glossary entry information <span +class="cmmi-10"><</span><span +class="cmti-10">gls-entry</span><span +class="cmmi-10">> </span>may also need changing. If +<span +class="cmmi-10"><</span><span +class="cmti-10">gls-entry</span><span +class="cmmi-10">> </span>contains any of <span +class="cmtt-10">makeindex</span><a + id="dx1-6012"></a>’s special characters (i.e. <span +class="cmtt-10">@ ! </span><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">"</span></span></span> or <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">|</span></span></span>) then +they should no longer be escaped with <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">"</span></span></span> since the <span +class="cmss-10">glossaries </span>package deals +with these characters internally. For example, if your document contains the +following: @@ -797,7 +854,7 @@ example, if your document contains the following: \storeglosentry{card}{name={$"|\mathcal{S}"|$},  <br />description={The cardinality of the set $\mathcal{S}$}} </div> -<!--l. 273--><p class="nopar" > then you will need to replace it with: +<!--l. 275--><p class="nopar" > then you will need to replace it with: @@ -806,295 +863,375 @@ example, if your document contains the following: \newglossaryentry{card}{name={$|\mathcal{S}|$},  <br />description={The cardinality of the set $\mathcal{S}$}} </div> -<!--l. 278--><p class="nopar" > -</p><!--l. 280--><p class="indent" > The <span -class="ec-lmss-10">format</span><a +<!--l. 280--><p class="nopar" > +</p><!--l. 282--><p class="indent" > The <span +class="cmss-10">format</span><a id="dx1-6013"></a> and <span -class="ec-lmss-10">number</span><a +class="cmss-10">number</span><a id="dx1-6014"></a> keys available in <span -class="ec-lmtt-10">\storeglosentry</span><a +class="cmtt-10">\storeglosentry</span><a id="dx1-6015"></a> are not available with <span -class="ec-lmtt-10">\newglossaryentry</span><a +class="cmtt-10">\newglossaryentry</span><a id="dx1-6016"></a>. -</p><!--l. 284--><p class="noindent" > +</p><!--l. 286--><p class="noindent" > </p> -<!--l. 284--><p class="noindent" ><a -href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a - id="x1-70006"></a>Adding an entry to the glossary</h3> -<!--l. 286--><p class="noindent" >The <span -class="ec-lmss-10">glossary </span>package provided two basic means to add information to the glossary: �rstly, the -term was de�ned using <span -class="ec-lmtt-10">\storeglosentry</span><a - id="dx1-7001"></a> and the entries for that term were added using -<span -class="ec-lmtt-10">\useglosentry</span><a +<!--l. 286--><p class="noindent" ><a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a + id="addinganentrytotheglossary"></a>Adding an entry to the glossary</h3> +<!--l. 288--><p class="noindent" >The <span +class="cmss-10">glossary </span>package provided two basic means to add information to the glossary: +firstly, the term was defined using <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-7001"></a> and the entries for that term were +added using <span +class="cmtt-10">\useglosentry</span><a id="dx1-7002"></a>, <span -class="ec-lmtt-10">\useGlosentry</span><a +class="cmtt-10">\useGlosentry</span><a id="dx1-7003"></a> and <span -class="ec-lmtt-10">\gls</span><a - id="dx1-7004"></a>. Secondly, the term was added to the -glossary using <span -class="ec-lmtt-10">\glossary</span><a +class="cmtt-10">\gls</span><a + id="dx1-7004"></a>. Secondly, the term was added +to the glossary using <span +class="cmtt-10">\glossary</span><a id="dx1-7005"></a>. This second approach is unavailable with the <span -class="ec-lmss-10">glossaries</span> +class="cmss-10">glossaries</span> package. -</p><!--l. 295--><p class="noindent" > +</p><!--l. 297--><p class="noindent" > </p> -<!--l. 295--><p class="noindent" ><a -href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.1 </span> <a +<!--l. 297--><p class="noindent" ><a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.1 </span> <a id="x1-80006.1"></a><span -class="ec-lmtt-10">\useglosentry</span></h4> -<!--l. 298--><p class="noindent" >The <span -class="ec-lmss-10">glossary </span>package allows you to add information to the glossary for a prede�ned term -without producing any text in the document using -</p><!--l. 301--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +class="cmtt-10">\useglosentry</span></h4> +<!--l. 300--><p class="noindent" >The <span +class="cmss-10">glossary </span>package allows you to add information to the glossary for a predefined +term without producing any text in the document using +</p><!--l. 303--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\useglosentry</span><a +class="cmtt-10">\useglosentry</span><a id="dx1-8001"></a><span -class="ec-lmtt-10">[</span><span -class="ec-lmtti-10"><old options></span><span -class="ec-lmtt-10">]{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">[</span><span +class="cmmi-10"><</span><span +class="cmitt-10">old options</span><span +class="cmmi-10">></span><span +class="cmtt-10">]{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> Any occurrences of this command will need to be replaced with -</p><!--l. 305--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 307--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\glsadd</span><a +class="cmtt-10">\glsadd</span><a id="dx1-8002"></a><span -class="ec-lmtt-10">[</span><span -class="ec-lmtti-10"><new options></span><span -class="ec-lmtt-10">]{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">[</span><span +class="cmmi-10"><</span><span +class="cmitt-10">new options</span><span +class="cmmi-10">></span><span +class="cmtt-10">]{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> The <span -class="ec-lmss-10">format</span><a +class="cmss-10">format</span><a id="dx1-8003"></a> key in <span -class="futri8t-"><old options> </span>remains the same in <span -class="futri8t-"><new options></span>. However the -<span -class="ec-lmss-10">number</span><a +class="cmmi-10"><</span><span +class="cmti-10">old options</span><span +class="cmmi-10">> </span>remains the same in <span +class="cmmi-10"><</span><span +class="cmti-10">new options</span><span +class="cmmi-10">></span>. However +the <span +class="cmss-10">number</span><a id="dx1-8004"></a><span -class="ec-lmtt-10">=</span><span -class="futri8t-"><counter name> </span>key in <span -class="futri8t-"><old options> </span>should be replaced with <span -class="ec-lmss-10">counter</span><a - id="dx1-8005"></a><span -class="ec-lmtt-10">=</span><span -class="futri8t-"><counter</span> +class="cmtt-10">=</span><span +class="cmmi-10"><</span><span +class="cmti-10">counter name</span><span +class="cmmi-10">> </span>key in <span +class="cmmi-10"><</span><span +class="cmti-10">old options</span><span +class="cmmi-10">> </span>should be replaced with <span -class="futri8t-">name> </span>in <span -class="futri8t-"><new options></span>. +class="cmss-10">counter</span><a + id="dx1-8005"></a><span +class="cmtt-10">=</span><span +class="cmmi-10"><</span><span +class="cmti-10">counter name</span><span +class="cmmi-10">> </span>in <span +class="cmmi-10"><</span><span +class="cmti-10">new options</span><span +class="cmmi-10">></span>. -</p><!--l. 316--><p class="noindent" > +</p><!--l. 318--><p class="noindent" > </p> -<!--l. 316--><p class="noindent" ><a -href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.2 </span> <a +<!--l. 318--><p class="noindent" ><a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.2 </span> <a id="x1-90006.2"></a><span -class="ec-lmtt-10">\useGlosentry</span></h4> -<!--l. 318--><p class="noindent" >The <span -class="ec-lmss-10">glossary </span>package allows you to add information to the glossary for a prede�ned term with -the given text using -</p><!--l. 320--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +class="cmtt-10">\useGlosentry</span></h4> +<!--l. 320--><p class="noindent" >The <span +class="cmss-10">glossary </span>package allows you to add information to the glossary for a predefined +term with the given text using +</p><!--l. 322--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\useGlosentry</span><a +class="cmtt-10">\useGlosentry</span><a id="dx1-9001"></a><span -class="ec-lmtt-10">[</span><span -class="ec-lmtti-10"><old options></span><span -class="ec-lmtt-10">]{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}{</span><span -class="ec-lmtti-10"><text></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">[</span><span +class="cmmi-10"><</span><span +class="cmitt-10">old options</span><span +class="cmmi-10">></span><span +class="cmtt-10">]{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">text</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> Any occurrences of this command will need to be replaced with -</p><!--l. 324--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 326--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\glslink</span><a +class="cmtt-10">\glslink</span><a id="dx1-9002"></a><span -class="ec-lmtt-10">[</span><span -class="ec-lmtti-10"><new options></span><span -class="ec-lmtt-10">]{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}{</span><span -class="ec-lmtti-10"><text></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">[</span><span +class="cmmi-10"><</span><span +class="cmitt-10">new options</span><span +class="cmmi-10">></span><span +class="cmtt-10">]{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">text</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> The mapping from <span -class="futri8t-"><old options> </span>to <span -class="futri8t-"><new options> </span>is the same as that given <a -href="#x1-80006.1">�6.1 +class="cmmi-10"><</span><span +class="cmti-10">old options</span><span +class="cmmi-10">> </span>to <span +class="cmmi-10"><</span><span +class="cmti-10">new options</span><span +class="cmmi-10">> </span>is the same as that given <a +href="#x1-80006.1"><span +class="cmsy-10">§</span>6.1 </a><a href="#x1-80006.1"><span -class="ec-lmtt-10">\useglosentry</span><!--tex4ht:ref: sec:useglosentry --></a>. -</p><!--l. 330--><p class="noindent" > +class="cmtt-10">\useglosentry</span><!--tex4ht:ref: sec:useglosentry --></a>. +</p><!--l. 332--><p class="noindent" > </p> -<!--l. 330--><p class="noindent" ><a -href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.3 </span> <a +<!--l. 332--><p class="noindent" ><a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.3 </span> <a id="x1-100006.3"></a><span -class="ec-lmtt-10">\gls</span></h4> -<!--l. 332--><p class="noindent" >Both the <span -class="ec-lmss-10">glossary </span>and the <span -class="ec-lmss-10">glossaries </span>packages de�ne the command <span -class="ec-lmtt-10">\gls</span><a - id="dx1-10001"></a>. In this case, the only -thing you need to change is the <span -class="ec-lmss-10">number</span><a - id="dx1-10002"></a> key in the optional argument to <span -class="ec-lmss-10">counter</span><a - id="dx1-10003"></a>. Note that -the new form of <span -class="ec-lmtt-10">\gls</span><a - id="dx1-10004"></a> also takes a �nal optional argument which can be used to insert text -into the automatically generated text. -</p><!--l. 339--><p class="noindent" > +class="cmtt-10">\gls</span></h4> +<!--l. 334--><p class="noindent" >Both the <span +class="cmss-10">glossary </span>and the <span +class="cmss-10">glossaries </span>packages define the command <span +class="cmtt-10">\gls</span><a + id="dx1-10001"></a>. In this +case, the only thing you need to change is the <span +class="cmss-10">number</span><a + id="dx1-10002"></a> key in the optional +argument to <span +class="cmss-10">counter</span><a + id="dx1-10003"></a>. Note that the new form of <span +class="cmtt-10">\gls</span><a + id="dx1-10004"></a> also takes a final optional +argument which can be used to insert text into the automatically generated +text. +</p><!--l. 341--><p class="noindent" > </p> -<!--l. 339--><p class="noindent" ><a -href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.4 </span> <a +<!--l. 341--><p class="noindent" ><a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">6.4 </span> <a id="x1-110006.4"></a><span -class="ec-lmtt-10">\glossary</span></h4> -<!--l. 342--><p class="noindent" >When using the <span -class="ec-lmss-10">glossaries </span>package, you should not use <span -class="ec-lmtt-10">\glossary</span><a +class="cmtt-10">\glossary</span></h4> +<!--l. 344--><p class="noindent" >When using the <span +class="cmss-10">glossaries </span>package, you should not use <span +class="cmtt-10">\glossary</span><a id="dx1-11001"></a> directly.<span class="footnote-mark"><a href="#fn4x0" id="fn4x0-bk"><sup class="textsuperscript">4</sup></a></span><a id="x1-11002f4"></a> If, with the old package, you have opted to explicitly use <span -class="ec-lmtt-10">\glossary</span><a - id="dx1-11008"></a> instead of storing the -glossary information with <span -class="ec-lmtt-10">\storeglosentry</span><a +class="cmtt-10">\glossary</span><a + id="dx1-11008"></a> instead of storing +the glossary information with <span +class="cmtt-10">\storeglosentry</span><a id="dx1-11009"></a>, then converting from <span -class="ec-lmss-10">glossary </span>to +class="cmss-10">glossary </span>to <span -class="ec-lmss-10">glossaries </span>will be more time-consuming, although in the end, I hope you will see the -bene�ts.<span class="footnote-mark"><a +class="cmss-10">glossaries </span>will be more time-consuming, although in the end, I hope you will see the +benefits.<span class="footnote-mark"><a href="#fn5x0" id="fn5x0-bk"><sup class="textsuperscript">5</sup></a></span><a id="x1-11010f5"></a> If you have used <span -class="ec-lmtt-10">\glossary</span><a - id="dx1-11013"></a> with the old glossary package, you will instead need to de�ne -the relevant glossary terms using <span -class="ec-lmtt-10">\newglossaryentry</span><a - id="dx1-11014"></a> and reference the terms using -<span -class="ec-lmtt-10">\glsadd</span><a +class="cmtt-10">\glossary</span><a + id="dx1-11013"></a> with the old glossary package, you will instead need to +define the relevant glossary terms using <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-11014"></a> and reference the terms +using <span +class="cmtt-10">\glsadd</span><a id="dx1-11015"></a>, <span -class="ec-lmtt-10">\glslink</span><a +class="cmtt-10">\glslink</span><a id="dx1-11016"></a>, <span -class="ec-lmtt-10">\gls</span><a +class="cmtt-10">\gls</span><a id="dx1-11017"></a> etc. -</p><!--l. 365--><p class="indent" > If you don't like the idea of continually scrolling back to the preamble to type all your -<span -class="ec-lmtt-10">\newglossaryentry</span><a - id="dx1-11018"></a> commands, you may prefer to create a new �le, in which to store all -these commands, and then input that �le in your document's preamble. Most text editors -and front-ends allow you to have multiple �les open, and you can tab back and forth +</p><!--l. 367--><p class="indent" > If you don’t like the idea of continually scrolling back to the preamble to type all +your <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-11018"></a> commands, you may prefer to create a new file, in which to +store all these commands, and then input that file in your document’s preamble. Most -between them. -</p><!--l. 372--><p class="noindent" > +text editors and front-ends allow you to have multiple files open, and you can tab back +and forth between them. +</p><!--l. 374--><p class="noindent" > </p> -<!--l. 372--><p class="noindent" ><a -href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">7 </span> <a - id="x1-120007"></a>Acronyms</h3> -<!--l. 374--><p class="noindent" >In the <span -class="ec-lmss-10">glossary </span>package, acronyms were treated di�erently to glossary entries. This resulted in -inconsistencies and sprawling unmaintainable code. The new <span -class="ec-lmss-10">glossaries </span>package treats -acronyms in exactly the same way as normal glossary terms. In fact, in the <span -class="ec-lmss-10">glossaries </span>package, -the default de�nition of: -</p><!--l. 379--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +<!--l. 374--><p class="noindent" ><a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">7 </span> <a + id="acronyms"></a>Acronyms</h3> +<!--l. 376--><p class="noindent" >In the <span +class="cmss-10">glossary </span>package, acronyms were treated differently to glossary entries. This +resulted in inconsistencies and sprawling unmaintainable code. The new <span +class="cmss-10">glossaries</span> +package treats acronyms in exactly the same way as normal glossary terms. In fact, in +the <span +class="cmss-10">glossaries </span>package, the default definition of: +</p><!--l. 381--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\newacronym</span><a +class="cmtt-10">\newacronym</span><a id="dx1-12001"></a><span -class="ec-lmtt-10">[</span><span -class="ec-lmtti-10"><options></span><span -class="ec-lmtt-10">]{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}{</span><span -class="ec-lmtti-10"><abbrv></span><span -class="ec-lmtt-10">}{</span><span -class="ec-lmtti-10"><long></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">[</span><span +class="cmmi-10"><</span><span +class="cmitt-10">options</span><span +class="cmmi-10">></span><span +class="cmtt-10">]{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">abbrv</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">long</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> is a shortcut for: -</p><!--l. 383--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 385--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\newglossaryentry</span><a +class="cmtt-10">\newglossaryentry</span><a id="dx1-12002"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}{type=\acronymtype,</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span><span +class="cmsy-10">{</span><span +class="cmtt-10">type=\acronymtype,</span> <br /><span -class="ec-lmtt-10">name={</span><span -class="ec-lmtti-10"><abbrv></span><span -class="ec-lmtt-10">},</span> +class="cmtt-10">name={</span><span +class="cmmi-10"><</span><span +class="cmitt-10">abbrv</span><span +class="cmmi-10">></span><span +class="cmtt-10">},</span> <br /><span -class="ec-lmtt-10">description={</span><span -class="ec-lmtti-10"><long></span><span -class="ec-lmtt-10">},</span> +class="cmtt-10">description={</span><span +class="cmmi-10"><</span><span +class="cmitt-10">long</span><span +class="cmmi-10">></span><span +class="cmtt-10">},</span> <br /><span -class="ec-lmtt-10">text={</span><span -class="ec-lmtti-10"><abbrv></span><span -class="ec-lmtt-10">},</span> +class="cmtt-10">text={</span><span +class="cmmi-10"><</span><span +class="cmitt-10">abbrv</span><span +class="cmmi-10">></span><span +class="cmtt-10">},</span> <br /><span -class="ec-lmtt-10">first={</span><span -class="ec-lmtti-10"><long> </span><span -class="ec-lmtt-10">(</span><span -class="ec-lmtti-10"><abbrv></span><span -class="ec-lmtt-10">)},</span> +class="cmtt-10">first=</span><span +class="cmsy-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">long</span><span +class="cmmi-10">> </span><span +class="cmtt-10">(</span><span +class="cmmi-10"><</span><span +class="cmitt-10">abbrv</span><span +class="cmmi-10">></span><span +class="cmtt-10">)</span><span +class="cmsy-10">}</span><span +class="cmtt-10">,</span> <br /><span -class="ec-lmtt-10">plural={</span><span -class="ec-lmtti-10"><abbrv></span><span -class="ec-lmtt-10">s},</span> +class="cmtt-10">plural=</span><span +class="cmsy-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">abbrv</span><span +class="cmmi-10">></span><span +class="cmtt-10">s</span><span +class="cmsy-10">}</span><span +class="cmtt-10">,</span> <br /><span -class="ec-lmtt-10">firstplural={</span><span -class="ec-lmtti-10"><long></span><span -class="ec-lmtt-10">s (</span><span -class="ec-lmtti-10"><abbrv></span><span -class="ec-lmtt-10">s)},</span> +class="cmtt-10">firstplural=</span><span +class="cmsy-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">long</span><span +class="cmmi-10">></span><span +class="cmtt-10">s (</span><span +class="cmmi-10"><</span><span +class="cmitt-10">abbrv</span><span +class="cmmi-10">></span><span +class="cmtt-10">s)</span><span +class="cmsy-10">}</span><span +class="cmtt-10">,</span> <br /><span -class="ec-lmtti-10"><options></span><span -class="ec-lmtt-10">}</span> +class="cmmi-10"><</span><span +class="cmitt-10">options</span><span +class="cmmi-10">></span><span +class="cmsy-10">}</span> <br /></div><hr> <br /></span> -</p><!--l. 394--><p class="indent" > This is di�erent to the <span -class="ec-lmss-10">glossary </span>package which set the <span -class="ec-lmss-10">name</span><a +</p><!--l. 396--><p class="indent" > This is different to the <span +class="cmss-10">glossary </span>package which set the <span +class="cmss-10">name</span><a id="dx1-12003"></a> key to <span -class="futri8t-"><long> </span>(<span -class="futri8t-"><abbrv></span>) and -allowed you to set a description using the <span -class="ec-lmss-10">description</span><a - id="dx1-12004"></a> key. If you still want to do this, you can -use the <span -class="ec-lmss-10">description</span><a +class="cmmi-10"><</span><span +class="cmti-10">long</span><span +class="cmmi-10">></span> +(<span +class="cmmi-10"><</span><span +class="cmti-10">abbrv</span><span +class="cmmi-10">></span>) and allowed you to set a description using the <span +class="cmss-10">description</span><a + id="dx1-12004"></a> key. If you still +want to do this, you can use the <span +class="cmss-10">description</span><a id="dx1-12005"></a> package option, and use the <span -class="ec-lmss-10">description</span><a - id="dx1-12006"></a> key in the optional argument of -<span -class="ec-lmtt-10">\newacronym</span><a +class="cmss-10">description</span><a + id="dx1-12006"></a> key +in the optional argument of <span +class="cmtt-10">\newacronym</span><a id="dx1-12007"></a>. -</p><!--l. 402--><p class="indent" > For example, if your document originally had the following: +</p><!--l. 404--><p class="indent" > For example, if your document originally had the following: @@ -1103,11 +1240,11 @@ class="ec-lmtt-10">\newacronym</span><a \newacronym{SVM}{Support Vector Machine}{description=Statistical  <br />pattern recognition technique} </div> -<!--l. 406--><p class="nopar" > Then you would need to load the <span -class="ec-lmss-10">glossaries </span>package using the <span -class="ec-lmss-10">description</span><a - id="dx1-12008"></a> package option, for -example: +<!--l. 408--><p class="nopar" > Then you would need to load the <span +class="cmss-10">glossaries </span>package using the <span +class="cmss-10">description</span><a + id="dx1-12008"></a> package +option, for example: @@ -1115,7 +1252,7 @@ example: <div class="verbatim" id="verbatim-10"> \usepackage[description]{glossaries} </div> -<!--l. 411--><p class="nopar" > and change the acronym de�nition to: +<!--l. 413--><p class="nopar" > and change the acronym definition to: @@ -1124,437 +1261,498 @@ example: \newacronym[description=Statistical pattern recognition  <br />technique]{svm}{SVM}{Support Vector Machine} </div> -<!--l. 416--><p class="nopar" > You can then reference the acronym using any of the new referencing commands, such as -<span -class="ec-lmtt-10">\gls</span><a +<!--l. 418--><p class="nopar" > You can then reference the acronym using any of the new referencing commands, such +as <span +class="cmtt-10">\gls</span><a id="dx1-12009"></a> or <span -class="ec-lmtt-10">\glsadd</span><a +class="cmtt-10">\glsadd</span><a id="dx1-12010"></a>. -</p><!--l. 420--><p class="indent" > With the old <span -class="ec-lmss-10">glossary </span>package, when you de�ned an acronym, it also de�ned a command -<span -class="ec-lmtt-10">\</span><span -class="futri8t-"><acr-name> </span>which could be used to display the acronym in the text. So the above SVM -example would create the command <span -class="ec-lmtt-10">\SVM </span>with the old package. In the new <span -class="ec-lmss-10">glossaries</span> -package, the acronyms are just another type of glossary entry, so they are displayed using -<span -class="ec-lmtt-10">\gls</span><a +</p><!--l. 422--><p class="indent" > With the old <span +class="cmss-10">glossary </span>package, when you defined an acronym, it also defined a +command <span +class="cmtt-10">\</span><span +class="cmmi-10"><</span><span +class="cmti-10">acr-name</span><span +class="cmmi-10">> </span>which could be used to display the acronym in the text. +So the above SVM example would create the command <span +class="cmtt-10">\SVM </span>with the old +package. In the new <span +class="cmss-10">glossaries </span>package, the acronyms are just another type of +glossary entry, so they are displayed using <span +class="cmtt-10">\gls</span><a id="dx1-12011"></a><span -class="ec-lmtt-10">{</span><span -class="futri8t-"><label></span><span -class="ec-lmtt-10">}</span>. Therefore, in the above example, you will also need to replace all occurrences -of <span -class="ec-lmtt-10">\SVM </span>with <span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\gls{svm}</span></span></span>. -</p><!--l. 430--><p class="indent" > If you have used <span -class="ec-lmtt-10">\useacronym</span><a +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmti-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span>. Therefore, in the +above example, you will also need to replace all occurrences of <span +class="cmtt-10">\SVM </span>with +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{svm}</span></span></span>. +</p><!--l. 432--><p class="indent" > If you have used <span +class="cmtt-10">\useacronym</span><a id="dx1-12012"></a> instead of <span -class="ec-lmtt-10">\</span><span -class="futri8t-"><acr-name></span>, then you will need to replace all -occurrences of -</p><!--l. 432--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +class="cmtt-10">\</span><span +class="cmmi-10"><</span><span +class="cmti-10">acr-name</span><span +class="cmmi-10">></span>, then you will need to +replace all occurrences of +</p><!--l. 434--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\useacronym</span><a +class="cmtt-10">\useacronym</span><a id="dx1-12013"></a><span -class="ec-lmtt-10">[</span><span -class="ec-lmtti-10"><insert></span><span -class="ec-lmtt-10">]{</span><span -class="ec-lmtti-10"><acr-name></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">[</span><span +class="cmmi-10"><</span><span +class="cmitt-10">insert</span><span +class="cmmi-10">></span><span +class="cmtt-10">]{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">acr-name</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> with -</p><!--l. 436--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 438--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\gls</span><a +class="cmtt-10">\gls</span><a id="dx1-12014"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}[</span><span -class="ec-lmtti-10"><insert></span><span -class="ec-lmtt-10">]</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}[</span><span +class="cmmi-10"><</span><span +class="cmitt-10">insert</span><span +class="cmmi-10">></span><span +class="cmtt-10">]</span> <br /></div><hr> <br /></span> Note that the starred versions of <span -class="ec-lmtt-10">\useacronym</span><a +class="cmtt-10">\useacronym</span><a id="dx1-12015"></a> and <span -class="ec-lmtt-10">\</span><span -class="futri8t-"><acr-name> </span>(which make the �rst letter -uppercase) should be replaced with <span -class="ec-lmtt-10">\Gls</span><a +class="cmtt-10">\</span><span +class="cmmi-10"><</span><span +class="cmti-10">acr-name</span><span +class="cmmi-10">> </span>(which make the first +letter uppercase) should be replaced with <span +class="cmtt-10">\Gls</span><a id="dx1-12016"></a><span -class="ec-lmtt-10">{</span><span -class="futri8t-"><label></span><span -class="ec-lmtt-10">}</span>. -</p><!--l. 443--><p class="indent" > Alternatively (as from v1.18 of the <span -class="ec-lmss-10">glossaries </span>package), you can use <span -class="ec-lmtt-10">\oldacronym</span><a - id="dx1-12017"></a> which -uses the same syntax as the old <span -class="ec-lmss-10">glossary </span>package's <span -class="ec-lmtt-10">\newacronym</span><a - id="dx1-12018"></a> and also de�nes -<span -class="ec-lmtt-10">\</span><span -class="futri8t-"><acr-name></span>. For example, if your document originally had the following: -</p><!--l. 448--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmti-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span>. +</p><!--l. 445--><p class="indent" > Alternatively (as from v1.18 of the <span +class="cmss-10">glossaries </span>package), you can use <span +class="cmtt-10">\oldacronym</span><a + id="dx1-12017"></a> +which uses the same syntax as the old <span +class="cmss-10">glossary </span>package’s <span +class="cmtt-10">\newacronym</span><a + id="dx1-12018"></a> and +also defines <span +class="cmtt-10">\</span><span +class="cmmi-10"><</span><span +class="cmti-10">acr-name</span><span +class="cmmi-10">></span>. For example, if your document originally had the +following: +</p><!--l. 450--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <div class="verbatim" id="verbatim-12"> -<!--l. 452--><p class="noindent" >\newacronym{SVM}{Support Vector Machine}{description=Statistical -</p><!--l. 452--><p class="noindent" >pattern recognition technique} +<!--l. 454--><p class="noindent" >\newacronym{SVM}{Support Vector Machine}{description=Statistical +</p><!--l. 454--><p class="noindent" >pattern recognition technique} </p></div> -<!--l. 452--><p class="nopar" > +<!--l. 454--><p class="nopar" > </div><hr> -</p><!--l. 453--><p class="noindent" ></p></span> +</p><!--l. 455--><p class="noindent" ></p></span> then you can change this to: -</p><!--l. 455--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 457--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <div class="verbatim" id="verbatim-13"> -<!--l. 459--><p class="noindent" >\oldacronym{SVM}{Support Vector Machine}{description=Statistical -</p><!--l. 459--><p class="noindent" >pattern recognition technique} +<!--l. 461--><p class="noindent" >\oldacronym{SVM}{Support Vector Machine}{description=Statistical +</p><!--l. 461--><p class="noindent" >pattern recognition technique} </p></div> -<!--l. 459--><p class="nopar" > +<!--l. 461--><p class="nopar" > </div><hr> -</p><!--l. 460--><p class="noindent" ></p></span> +</p><!--l. 462--><p class="noindent" ></p></span> You can then continue to use <span -class="ec-lmtt-10">\SVM</span>. However, remember that <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> generally -ignores spaces after command names that consist of alphabetical characters. You -will therefore need to force a space after <span -class="ec-lmtt-10">\</span><span -class="futri8t-"><acr-name></span>, unless you also load the -<span -class="ec-lmss-10">xspace </span>package. (See <a +class="cmtt-10">\SVM</span>. However, remember that <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> generally ignores +spaces after command names that consist of alphabetical characters. You will therefore +need to force a space after <span +class="cmtt-10">\</span><span +class="cmmi-10"><</span><span +class="cmti-10">acr-name</span><span +class="cmmi-10">></span>, unless you also load the <span +class="cmss-10">xspace </span>package. +(See <a href="glossaries-user.html#sec:acronyms" >Acronyms</a> of the <span -class="ec-lmss-10">glossaries </span>documentation for further details.) -Note that <span -class="ec-lmtt-10">\oldacronym</span><a - id="dx1-12019"></a> uses its �rst argument to de�ne the acronym's label (as -used by commands like <span -class="ec-lmtt-10">\gls</span><a +class="cmss-10">glossaries </span>documentation for further details.) Note that +<span +class="cmtt-10">\oldacronym</span><a + id="dx1-12019"></a> uses its first argument to define the acronym’s label (as used by +commands like <span +class="cmtt-10">\gls</span><a id="dx1-12020"></a>), so in the above example, with the new <span -class="ec-lmss-10">glossaries</span> -package, <span -class="ec-lmtt-10">\SVM </span>becomes a shortcut for <span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\gls{SVM}</span></span></span> and <span -class="ec-lmtt-10">\SVM* </span>becomes a shortcut for +class="cmss-10">glossaries </span>package, +<span +class="cmtt-10">\SVM </span>becomes a shortcut for <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{SVM}</span></span></span> and <span +class="cmtt-10">\SVM* </span>becomes a shortcut for <span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\Gls{SVM}</span></span></span>. -</p><!--l. 475--><p class="noindent" > +class="cmtt-10">\Gls{SVM}</span></span></span>. +</p><!--l. 477--><p class="noindent" > </p> -<!--l. 475--><p class="noindent" ><a -href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">7.1 </span> <a +<!--l. 477--><p class="noindent" ><a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">7.1 </span> <a id="x1-130007.1"></a><span -class="ec-lmtt-10">\acrln </span>and <span -class="ec-lmtt-10">\acrsh</span></h4> -<!--l. 477--><p class="noindent" >In the <span -class="ec-lmss-10">glossary </span>package, it is possible to produce the long and short forms of an acronym -without adding an entry to the glossary using <span -class="ec-lmtt-10">\acrln</span><a +class="cmtt-10">\acrln </span>and <span +class="cmtt-10">\acrsh</span></h4> +<!--l. 479--><p class="noindent" >In the <span +class="cmss-10">glossary </span>package, it is possible to produce the long and short forms of an +acronym without adding an entry to the glossary using <span +class="cmtt-10">\acrln</span><a id="dx1-13001"></a> and <span -class="ec-lmtt-10">\acrsh</span><a - id="dx1-13002"></a>. With the <span -class="ec-lmss-10">glossaries</span> -package (provided you de�ned the acronym using <span -class="ec-lmtt-10">\newacronym</span><a - id="dx1-13003"></a> or <span -class="ec-lmtt-10">\oldacronym</span><a - id="dx1-13004"></a> and -provided you haven't rede�ned <span -class="ec-lmtt-10">\newacronym</span><a - id="dx1-13005"></a>) you can replace -</p><!--l. 484--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +class="cmtt-10">\acrsh</span><a + id="dx1-13002"></a>. With +the <span +class="cmss-10">glossaries </span>package (provided you defined the acronym using <span +class="cmtt-10">\newacronym</span><a + id="dx1-13003"></a> +or <span +class="cmtt-10">\oldacronym</span><a + id="dx1-13004"></a> and provided you haven’t redefined <span +class="cmtt-10">\newacronym</span><a + id="dx1-13005"></a>) you can +replace +</p><!--l. 486--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\acrsh</span><a +class="cmtt-10">\acrsh</span><a id="dx1-13006"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><acr-name></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">acr-name</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> with -</p><!--l. 488--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 490--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\acrshort</span><a +class="cmtt-10">\acrshort</span><a id="dx1-13007"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> and you can replace -</p><!--l. 492--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +</p><!--l. 494--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\acrln</span><a +class="cmtt-10">\acrln</span><a id="dx1-13008"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><acr-name></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">acr-name</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> - <br /></span> -with -</p><!--l. 496--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <br /></span> +with +</p><!--l. 498--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\acrlong</span><a +class="cmtt-10">\acrlong</span><a id="dx1-13009"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> The <span -class="ec-lmss-10">glossaries </span>package also provides the related commands <span -class="ec-lmtt-10">\acrshortpl</span><a - id="dx1-13010"></a> (plural short form) -and <span -class="ec-lmtt-10">\acrlongpl</span><a - id="dx1-13011"></a> (plural long form) as well as upper case variations. If you use the <span -class="ec-lmss-10">glossaries</span> -�shortcuts� package option, you can use <span -class="ec-lmtt-10">\acs</span><a +class="cmss-10">glossaries </span>package also provides the related commands <span +class="cmtt-10">\acrshortpl</span><a + id="dx1-13010"></a> (plural short +form) and <span +class="cmtt-10">\acrlongpl</span><a + id="dx1-13011"></a> (plural long form) as well as upper case variations. If you use the +<span +class="cmss-10">glossaries </span>“shortcuts” package option, you can use <span +class="cmtt-10">\acs</span><a id="dx1-13012"></a> in place of <span -class="ec-lmtt-10">\acrshort</span><a +class="cmtt-10">\acrshort</span><a id="dx1-13013"></a> and <span -class="ec-lmtt-10">\acl</span><a - id="dx1-13014"></a> in place of -<span -class="ec-lmtt-10">\acrlong</span><a +class="cmtt-10">\acl</span><a + id="dx1-13014"></a> +in place of <span +class="cmtt-10">\acrlong</span><a id="dx1-13015"></a>. -</p><!--l. 506--><p class="indent" > See <a +</p><!--l. 508--><p class="indent" > See <a href="glossaries-user.html#sec:acronyms" >Acronyms</a> of the <span -class="ec-lmss-10">glossaries </span>manual for further details of how to use these +class="cmss-10">glossaries </span>manual for further details of how to use these commands. -</p><!--l. 512--><p class="noindent" > +</p><!--l. 514--><p class="noindent" > </p> -<!--l. 512--><p class="noindent" ><a -href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">7.2 </span> <a +<!--l. 514--><p class="noindent" ><a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">7.2 </span> <a id="x1-140007.2"></a><span -class="ec-lmtt-10">\ifacronymfirstuse</span></h4> -<!--l. 514--><p class="noindent" >The <span -class="ec-lmss-10">glossary </span>package command -</p><!--l. 515--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +class="cmtt-10">\ifacronymfirstuse</span></h4> +<!--l. 516--><p class="noindent" >The <span +class="cmss-10">glossary </span>package command +</p><!--l. 517--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\ifacronymfirstuse</span><a +class="cmtt-10">\ifacronymfirstuse</span><a id="dx1-14001"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><acr-name></span><span -class="ec-lmtt-10">}{</span><span -class="ec-lmtti-10"><text1></span><span -class="ec-lmtt-10">}{</span><span -class="ec-lmtti-10"><text2></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">acr-name</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">text1</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">text2</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> can be replaced by the <span -class="ec-lmss-10">glossaries </span>command: -</p><!--l. 519--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +class="cmss-10">glossaries </span>command: +</p><!--l. 521--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\ifglsused</span><a +class="cmtt-10">\ifglsused</span><a id="dx1-14002"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}{</span><span -class="ec-lmtti-10"><text2></span><span -class="ec-lmtt-10">}{</span><span -class="ec-lmtti-10"><text1></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">text2</span><span +class="cmmi-10">></span><span +class="cmtt-10">}{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">text1</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> Note that <span -class="ec-lmtt-10">\ifglsused</span><a +class="cmtt-10">\ifglsused</span><a id="dx1-14003"></a> evaluates the opposite condition to that of <span -class="ec-lmtt-10">\ifacronymfirstuse</span><a +class="cmtt-10">\ifacronymfirstuse</span><a id="dx1-14004"></a> which is why the last two arguments have been reversed. -</p><!--l. 528--><p class="noindent" > +</p><!--l. 530--><p class="noindent" > </p> -<!--l. 528--><p class="noindent" ><a -href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">7.3 </span> <a +<!--l. 530--><p class="noindent" ><a +href="#top">Top</a><h3 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">7.3 </span> <a id="x1-150007.3"></a><span -class="ec-lmtt-10">\resetacronym </span>and <span -class="ec-lmtt-10">\unsetacronym</span></h4> -<!--l. 530--><p class="noindent" >The <span -class="ec-lmss-10">glossary </span>package allows you to reset and unset the acronym �ag which is used to +class="cmtt-10">\resetacronym </span>and <span +class="cmtt-10">\unsetacronym</span></h4> +<!--l. 532--><p class="noindent" >The <span +class="cmss-10">glossary </span>package allows you to reset and unset the acronym flag which is used to determine whether the acronym has been used in the document. The <span -class="ec-lmss-10">glossaries </span>package also -provides a means to do this on either a local or a global level. To reset an acronym, you will -need to replace: -</p><!--l. 535--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +class="cmss-10">glossaries </span>package +also provides a means to do this on either a local or a global level. To reset an acronym, +you will need to replace: +</p><!--l. 537--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\resetacronym</span><a +class="cmtt-10">\resetacronym</span><a id="dx1-15001"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><acr-name></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">acr-name</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> - <br /></span> -with either -</p><!--l. 539--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> + <br /></span> +with either +</p><!--l. 541--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\glsreset</span><a +class="cmtt-10">\glsreset</span><a id="dx1-15002"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> or -</p><!--l. 543--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 545--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\glslocalreset</span><a +class="cmtt-10">\glslocalreset</span><a id="dx1-15003"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> -</p><!--l. 547--><p class="indent" > To unset an acronym, you will need to replace: -</p><!--l. 548--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +</p><!--l. 549--><p class="indent" > To unset an acronym, you will need to replace: +</p><!--l. 550--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\unsetacronym</span><a +class="cmtt-10">\unsetacronym</span><a id="dx1-15004"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><acr-name></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">acr-name</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> with either -</p><!--l. 552--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 554--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\glsunset</span><a +class="cmtt-10">\glsunset</span><a id="dx1-15005"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> or -</p><!--l. 556--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 558--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\glslocalunset</span><a +class="cmtt-10">\glslocalunset</span><a id="dx1-15006"></a><span -class="ec-lmtt-10">{</span><span -class="ec-lmtti-10"><label></span><span -class="ec-lmtt-10">}</span> +class="cmtt-10">{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">label</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span> <br /></div><hr> <br /></span> -</p><!--l. 560--><p class="indent" > To reset all acronyms, you will need to replace: -</p><!--l. 561--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +</p><!--l. 562--><p class="indent" > To reset all acronyms, you will need to replace: +</p><!--l. 563--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\resetallacronyms</span><a +class="cmtt-10">\resetallacronyms</span><a id="dx1-15007"></a> <br /></div><hr> <br /></span> with -</p><!--l. 565--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 567--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\glsresetall</span><a +class="cmtt-10">\glsresetall</span><a id="dx1-15008"></a><span -class="ec-lmtt-10">[\acronymtype</span><a +class="cmtt-10">[\acronymtype</span><a id="dx1-15009"></a><span -class="ec-lmtt-10">]</span> +class="cmtt-10">]</span> <br /></div><hr> <br /></span> + + + or -</p><!--l. 569--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 571--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\glslocalresetall</span><a +class="cmtt-10">\glslocalresetall</span><a id="dx1-15010"></a><span -class="ec-lmtt-10">[\acronymtype</span><a +class="cmtt-10">[\acronymtype</span><a id="dx1-15011"></a><span -class="ec-lmtt-10">]</span> - - - +class="cmtt-10">]</span> <br /></div><hr> <br /></span> To unset all acronyms, you will need to replace: -</p><!--l. 573--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossary</span></span><span class="obeylines-h"> +</p><!--l. 575--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\unsetallacronyms</span><a +class="cmtt-10">\unsetallacronyms</span><a id="dx1-15012"></a> <br /></div><hr> <br /></span> with -</p><!--l. 577--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 579--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\glsunsetall</span><a +class="cmtt-10">\glsunsetall</span><a id="dx1-15013"></a><span -class="ec-lmtt-10">[\acronymtype</span><a +class="cmtt-10">[\acronymtype</span><a id="dx1-15014"></a><span -class="ec-lmtt-10">]</span> +class="cmtt-10">]</span> <br /></div><hr> <br /></span> or -</p><!--l. 581--><p class="indent" > <hr><div><span class="marginpar"><span -class="ec-lmss-10">glossaries</span></span><span class="obeylines-h"> +</p><!--l. 583--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> <span -class="ec-lmtt-10">\glslocalunsetall</span><a +class="cmtt-10">\glslocalunsetall</span><a id="dx1-15015"></a><span -class="ec-lmtt-10">[\acronymtype</span><a +class="cmtt-10">[\acronymtype</span><a id="dx1-15016"></a><span -class="ec-lmtt-10">]</span> +class="cmtt-10">]</span> <br /></div><hr> <br /></span> -</p><!--l. 585--><p class="noindent" > +</p><!--l. 587--><p class="noindent" > </p> -<!--l. 585--><p class="noindent" ><a -href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">8 </span> <a - id="x1-160008"></a>Displaying the glossary</h3> -<!--l. 587--><p class="noindent" >The <span -class="ec-lmss-10">glossary </span>package provides the command <span -class="ec-lmtt-10">\printglossary</span><a +<!--l. 587--><p class="noindent" ><a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">8 </span> <a + id="displayingtheglossary"></a>Displaying the glossary</h3> +<!--l. 589--><p class="noindent" >The <span +class="cmss-10">glossary </span>package provides the command <span +class="cmtt-10">\printglossary</span><a id="dx1-16001"></a> (or <span -class="ec-lmtt-10">\print</span><span -class="futri8t-"><type> </span>for other -glossary types) which can be used to print individual glossaries. The <span -class="ec-lmss-10">glossaries </span>package -provides the command <span -class="ec-lmtt-10">\printglossaries</span><a - id="dx1-16002"></a> which will print all the glossaries which have -been de�ned, or <span -class="ec-lmtt-10">\printglossary</span><a +class="cmtt-10">\print</span><span +class="cmmi-10"><</span><span +class="cmti-10">type</span><span +class="cmmi-10">> </span>for +other glossary types) which can be used to print individual glossaries. The <span +class="cmss-10">glossaries</span> +package provides the command <span +class="cmtt-10">\printglossaries</span><a + id="dx1-16002"></a> which will print all the glossaries +which have been defined, or <span +class="cmtt-10">\printglossary</span><a id="dx1-16003"></a><span -class="ec-lmtt-10">[</span><span -class="futri8t-"><options></span><span -class="ec-lmtt-10">] </span>to print individual glossaries. So -if you just have <span -class="ec-lmtt-10">\printglossary</span><a +class="cmtt-10">[</span><span +class="cmmi-10"><</span><span +class="cmti-10">options</span><span +class="cmmi-10">></span><span +class="cmtt-10">] </span>to print individual glossaries. +So if you just have <span +class="cmtt-10">\printglossary</span><a id="dx1-16004"></a>, then you can leave it as it is, but if you have, say: @@ -1565,7 +1763,7 @@ say: \printglossary  <br />\printglossary[acronym] </div> -<!--l. 598--><p class="nopar" > or +<!--l. 600--><p class="nopar" > or @@ -1574,7 +1772,7 @@ say: \printglossary  <br />\printacronym </div> -<!--l. 603--><p class="nopar" > then you will need to replace this with either +<!--l. 605--><p class="nopar" > then you will need to replace this with either @@ -1582,7 +1780,7 @@ say: <div class="verbatim" id="verbatim-16"> \printglossaries </div> -<!--l. 607--><p class="nopar" > or +<!--l. 609--><p class="nopar" > or @@ -1591,22 +1789,24 @@ say: \printglossary  <br />\printglossary[type=\acronymtype] </div> -<!--l. 612--><p class="nopar" > -</p><!--l. 614--><p class="indent" > The <span -class="ec-lmss-10">glossary </span>package allows you to specify a short title (for the table of contents and page -header) by de�ning a command of the form <span -class="ec-lmtt-10">\short</span><span -class="futri8t-"><glossary-type></span><span -class="ec-lmtt-10">name</span>. The <span -class="ec-lmss-10">glossaries</span> -package doesn't do this, but instead provides the <span -class="ec-lmss-10">toctitle</span><a - id="dx1-16005"></a> key which can be used in the -optional argument to <span -class="ec-lmtt-10">\printglossary</span><a - id="dx1-16006"></a>. For example, if you have created a new glossary type -called <span -class="ec-lmtt-10">notation</span>, and you had de�ned +<!--l. 614--><p class="nopar" > +</p><!--l. 616--><p class="indent" > The <span +class="cmss-10">glossary </span>package allows you to specify a short title (for the table of contents and +page header) by defining a command of the form <span +class="cmtt-10">\short</span><span +class="cmmi-10"><</span><span +class="cmti-10">glossary-type</span><span +class="cmmi-10">></span><span +class="cmtt-10">name</span>. The +<span +class="cmss-10">glossaries </span>package doesn’t do this, but instead provides the <span +class="cmss-10">toctitle</span><a + id="dx1-16005"></a> key which can be +used in the optional argument to <span +class="cmtt-10">\printglossary</span><a + id="dx1-16006"></a>. For example, if you have created a +new glossary type called <span +class="cmtt-10">notation</span>, and you had defined @@ -1614,8 +1814,8 @@ class="ec-lmtt-10">notation</span>, and you had de�ned <div class="verbatim" id="verbatim-18"> \newcommand{\shortnotationname}{Notation} </div> -<!--l. 624--><p class="nopar" > then you would need to use the <span -class="ec-lmss-10">toctitle</span><a +<!--l. 626--><p class="nopar" > then you would need to use the <span +class="cmss-10">toctitle</span><a id="dx1-16007"></a> key: @@ -1624,119 +1824,120 @@ class="ec-lmss-10">toctitle</span><a <div class="verbatim" id="verbatim-19"> \printglossary[type=notation,toctitle=Notation] </div> -<!--l. 628--><p class="nopar" > The <span -class="ec-lmss-10">glossaries </span>package will ignore <span -class="ec-lmtt-10">\shortnotationname</span><a +<!--l. 630--><p class="nopar" > The <span +class="cmss-10">glossaries </span>package will ignore <span +class="cmtt-10">\shortnotationname</span><a id="dx1-16008"></a>, so unless you have used it -elsewhere in the document, you may as well remove the de�nition. -</p><!--l. 633--><p class="noindent" > +elsewhere in the document, you may as well remove the definition. +</p><!--l. 635--><p class="noindent" > </p> -<!--l. 633--><p class="noindent" ><a -href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">9 </span> <a - id="x1-170009"></a>Processing Your Document</h3> -<!--l. 635--><p class="noindent" >If you convert your document from using the <span -class="ec-lmss-10">glossary </span>package to the <span -class="ec-lmss-10">glossaries </span>package, you -will need to delete any of the additional �les, such as the <span -class="ec-lmtt-10">.glo</span><a - id="dx1-17001"></a> �le, that were created by the +<!--l. 635--><p class="noindent" ><a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">9 </span> <a + id="processingyourdocument"></a>Processing Your Document</h3> +<!--l. 637--><p class="noindent" >If you convert your document from using the <span +class="cmss-10">glossary </span>package to the <span +class="cmss-10">glossaries </span>package, +you will need to delete any of the additional files, such as the <span +class="cmtt-10">.glo</span><a + id="dx1-17001"></a> file, that were +created by the <span +class="cmss-10">glossary </span>package, as the <span +class="cmss-10">glossaries </span>package uses a different format. +Remember also, that if you used the <span +class="cmtt-10">makeglos</span><a + id="dx1-17002"></a> Perl script, you will need to use the <span -class="ec-lmss-10">glossary </span>package, as the <span -class="ec-lmss-10">glossaries </span>package uses a di�erent format. Remember also, that if you -used the <span -class="ec-lmtt-10">makeglos</span><a - id="dx1-17002"></a> Perl script, you will need to use the <span -class="ec-lmtt-10">makeglossaries</span><a - id="dx1-17003"></a> Perl script instead. -As from v1.17, the <span -class="ec-lmss-10">glossaries </span>package can be used with either <span -class="ec-lmtt-10">makeindex</span><a +class="cmtt-10">makeglossaries</span><a + id="dx1-17003"></a> Perl script instead. As from v1.17, the <span +class="cmss-10">glossaries </span>package +can be used with either <span +class="cmtt-10">makeindex</span><a id="dx1-17004"></a> or <span -class="ec-lmtt-10">xindy</span><a - id="dx1-17005"></a>. Since -<span -class="ec-lmtt-10">xindy</span><a - id="dx1-17006"></a> was designed to be multilingual, the new <span -class="ec-lmss-10">glossaries </span>package is a much better option -for non-English documents. -</p><!--l. 648--><p class="indent" > For further information on using <span -class="ec-lmtt-10">makeglossaries</span><a +class="cmtt-10">xindy</span><a + id="dx1-17005"></a>. Since <span +class="cmtt-10">xindy</span><a + id="dx1-17006"></a> was designed to be +multilingual, the new <span +class="cmss-10">glossaries </span>package is a much better option for non-English +documents. +</p><!--l. 650--><p class="indent" > For further information on using <span +class="cmtt-10">makeglossaries</span><a id="dx1-17007"></a>, <span -class="ec-lmtt-10">makeindex</span><a +class="cmtt-10">makeindex</span><a id="dx1-17008"></a> or <span -class="ec-lmtt-10">xindy</span><a - id="dx1-17009"></a> to -create your glossaries, see <a +class="cmtt-10">xindy</span><a + id="dx1-17009"></a> to create +your glossaries, see <a href="glossaries-user.html#sec:makeglossaries" >Generating the Associated Glossary Files</a> of the <span -class="ec-lmss-10">glossaries</span> +class="cmss-10">glossaries</span> documentation. -</p><!--l. 654--><p class="noindent" > +</p><!--l. 656--><p class="noindent" > </p> -<!--l. 654--><p class="noindent" ><a -href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">10 </span> <a - id="x1-1800010"></a>Troubleshooting</h3> -<!--l. 656--><p class="noindent" >Please check the <a +<!--l. 656--><p class="noindent" ><a +href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">10 </span> <a + id="troubleshooting"></a>Troubleshooting</h3> +<!--l. 658--><p class="noindent" >Please check the <a href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" >FAQ</a> for the <span -class="ec-lmss-10">glossaries </span>package if you have any problems. +class="cmss-10">glossaries </span>package if you have any problems. -</p><!--l. 660--><p class="indent" > <a +</p><!--l. 662--><p class="indent" > <a id="likesection.1"></a><a - id="Q1-1-20"></a> + id="index"></a> </p> <h3 class="likesectionHead"><a id="x1-1900010"></a>Index</h3> <!--l. 4--><p class="noindent" > <span -class="futb8t-">A</span> +class="cmbx-10">A</span> </p> <div class="theindex"><span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\acl</span></span></span>  <a +class="cmtt-10">\acl</span></span></span>  <a href="glossary2glossaries.html#dx1-13014" ><span class="underline">1</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\acrln</span></span></span>  <a +class="cmtt-10">\acrln</span></span></span>  <a href="glossary2glossaries.html#dx1-13001" ><span class="underline">2</span></a>, <a href="glossary2glossaries.html#dx1-13008" ><span class="underline">3</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\acrlong</span></span></span>  <a +class="cmtt-10">\acrlong</span></span></span>  <a href="glossary2glossaries.html#dx1-13009" ><span class="underline">4</span></a>, <a href="glossary2glossaries.html#dx1-13015" ><span class="underline">5</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\acrlongpl</span></span></span>  <a +class="cmtt-10">\acrlongpl</span></span></span>  <a href="glossary2glossaries.html#dx1-13011" ><span class="underline">6</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\acronymname</span></span></span>  <a +class="cmtt-10">\acronymname</span></span></span>  <a href="glossary2glossaries.html#dx1-4008" ><span class="underline">7</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\acronymtype</span></span></span>  <a +class="cmtt-10">\acronymtype</span></span></span>  <a href="glossary2glossaries.html#dx1-15009" ><span class="underline">8</span></a>, <a href="glossary2glossaries.html#dx1-15011" ><span class="underline">9</span></a>, <a href="glossary2glossaries.html#dx1-15014" ><span class="underline">10</span></a>, <a href="glossary2glossaries.html#dx1-15016" ><span class="underline">11</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\acrsh</span></span></span>  <a +class="cmtt-10">\acrsh</span></span></span>  <a href="glossary2glossaries.html#dx1-13002" ><span class="underline">12</span></a>, <a href="glossary2glossaries.html#dx1-13006" ><span class="underline">13</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\acrshort</span></span></span>  <a +class="cmtt-10">\acrshort</span></span></span>  <a href="glossary2glossaries.html#dx1-13007" ><span class="underline">14</span></a>, <a href="glossary2glossaries.html#dx1-13013" ><span class="underline">15</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\acrshortpl</span></span></span>  <a +class="cmtt-10">\acrshortpl</span></span></span>  <a href="glossary2glossaries.html#dx1-13010" ><span class="underline">16</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\acs</span></span></span>  <a +class="cmtt-10">\acs</span></span></span>  <a href="glossary2glossaries.html#dx1-13012" ><span class="underline">17</span></a> <br /></span> -<p class="theindex"> <span -class="futb8t-">F</span> -<span class="index-item">�le types<br /></span> +<p class="theindex"> <span +class="cmbx-10">F</span> +<span class="index-item">file types<br /></span> <span class="index-subitem">    <span -class="ec-lmtt-10">.glo</span>  <a +class="cmtt-10">.glo</span>  <a href="glossary2glossaries.html#dx1-17001" >18</a> <br /></span> </p><p class="theindex"> <span -class="futb8t-">G</span> +class="cmbx-10">G</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glossary</span></span></span>  <a +class="cmtt-10">\glossary</span></span></span>  <a href="glossary2glossaries.html#dx1-6001" ><span class="underline">19</span></a>, <a href="glossary2glossaries.html#dx1-6006" ><span class="underline">20</span></a>, <a href="glossary2glossaries.html#dx1-7005" ><span class="underline">21</span></a>, <a @@ -1747,16 +1948,16 @@ href="glossary2glossaries.html#dx1-6003" ><span class="underline">25</span></a>, href="glossary2glossaries.html#dx1-11003" ><span class="underline">26</span></a>, <a href="glossary2glossaries.html#dx1-11011" ><span class="underline">27</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glossaryname</span></span></span>  <a +class="cmtt-10">\glossaryname</span></span></span>  <a href="glossary2glossaries.html#dx1-4007" ><span class="underline">28</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glossarystyle</span></span></span>  <a +class="cmtt-10">\glossarystyle</span></span></span>  <a href="glossary2glossaries.html#dx1-4003" ><span class="underline">29</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\Gls</span></span></span>  <a +class="cmtt-10">\Gls</span></span></span>  <a href="glossary2glossaries.html#dx1-12016" ><span class="underline">30</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\gls</span></span></span>  <a +class="cmtt-10">\gls</span></span></span>  <a href="glossary2glossaries.html#dx1-7004" ><span class="underline">31</span></a>, <a href="glossary2glossaries.html#dx1-10001" ><span class="underline">32</span></a>, <a href="glossary2glossaries.html#dx1-10004" ><span class="underline">33</span></a>, <a @@ -1766,84 +1967,84 @@ href="glossary2glossaries.html#dx1-12011" ><span class="underline">36</span></a> href="glossary2glossaries.html#dx1-12014" ><span class="underline">37</span></a>, <a href="glossary2glossaries.html#dx1-12020" ><span class="underline">38</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10">\gls </span>options<br /></span> +class="cmtt-10">\gls </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">counter</span>  <a +class="cmss-10">counter</span>  <a href="glossary2glossaries.html#dx1-10003" >39</a> <br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">number</span>  <a +class="cmss-10">number</span>  <a href="glossary2glossaries.html#dx1-10002" >40</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glsadd</span></span></span>  <a +class="cmtt-10">\glsadd</span></span></span>  <a href="glossary2glossaries.html#dx1-8002" ><span class="underline">41</span></a>, <a href="glossary2glossaries.html#dx1-11015" ><span class="underline">42</span></a>, <a href="glossary2glossaries.html#dx1-12010" ><span class="underline">43</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10">\glsadd </span>options<br /></span> +class="cmtt-10">\glsadd </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">counter</span>  <a +class="cmss-10">counter</span>  <a href="glossary2glossaries.html#dx1-8005" >44</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glslink</span></span></span>  <a +class="cmtt-10">\glslink</span></span></span>  <a href="glossary2glossaries.html#dx1-9002" ><span class="underline">45</span></a>, <a href="glossary2glossaries.html#dx1-11016" ><span class="underline">46</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glslocalreset</span></span></span>  <a +class="cmtt-10">\glslocalreset</span></span></span>  <a href="glossary2glossaries.html#dx1-15003" ><span class="underline">47</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glslocalresetall</span></span></span>  <a +class="cmtt-10">\glslocalresetall</span></span></span>  <a href="glossary2glossaries.html#dx1-15010" ><span class="underline">48</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glslocalunset</span></span></span>  <a +class="cmtt-10">\glslocalunset</span></span></span>  <a href="glossary2glossaries.html#dx1-15006" ><span class="underline">49</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glslocalunsetall</span></span></span>  <a +class="cmtt-10">\glslocalunsetall</span></span></span>  <a href="glossary2glossaries.html#dx1-15015" ><span class="underline">50</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glsreset</span></span></span>  <a +class="cmtt-10">\glsreset</span></span></span>  <a href="glossary2glossaries.html#dx1-15002" ><span class="underline">51</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glsresetall</span></span></span>  <a +class="cmtt-10">\glsresetall</span></span></span>  <a href="glossary2glossaries.html#dx1-15008" ><span class="underline">52</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glsunset</span></span></span>  <a +class="cmtt-10">\glsunset</span></span></span>  <a href="glossary2glossaries.html#dx1-15005" ><span class="underline">53</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\glsunsetall</span></span></span>  <a +class="cmtt-10">\glsunsetall</span></span></span>  <a href="glossary2glossaries.html#dx1-15013" ><span class="underline">54</span></a> <br /></span> </p><p class="theindex"> <span -class="futb8t-">I</span> +class="cmbx-10">I</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\ifacronymfirstuse</span></span></span>  <a +class="cmtt-10">\ifacronymfirstuse</span></span></span>  <a href="glossary2glossaries.html#dx1-14001" ><span class="underline">55</span></a>, <a href="glossary2glossaries.html#dx1-14004" ><span class="underline">56</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\ifglsused</span></span></span>  <a +class="cmtt-10">\ifglsused</span></span></span>  <a href="glossary2glossaries.html#dx1-14002" ><span class="underline">57</span></a>, <a href="glossary2glossaries.html#dx1-14003" ><span class="underline">58</span></a> <br /></span> </p><p class="theindex"> <span -class="futb8t-">M</span> +class="cmbx-10">M</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\makeacronym</span></span></span>  <a +class="cmtt-10">\makeacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-5002" ><span class="underline">59</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10">makeglos</span>  <a +class="cmtt-10">makeglos</span>  <a href="glossary2glossaries.html#dx1-17002" >60</a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10">makeglossaries</span>  <a +class="cmtt-10">makeglossaries</span>  <a href="glossary2glossaries.html#dx1-17003" >61</a>, <a href="glossary2glossaries.html#dx1-17007" >62</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\makeglossaries</span></span></span>  <a +class="cmtt-10">\makeglossaries</span></span></span>  <a href="glossary2glossaries.html#dx1-5003" ><span class="underline">63</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\makeglossary</span></span></span>  <a +class="cmtt-10">\makeglossary</span></span></span>  <a href="glossary2glossaries.html#dx1-5001" ><span class="underline">64</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10">makeindex</span>  <a +class="cmtt-10">makeindex</span>  <a href="glossary2glossaries.html#dx1-2003" >65</a>, <a href="glossary2glossaries.html#dx1-2006" >66</a>, <a href="glossary2glossaries.html#dx1-6012" >67</a>, <a @@ -1854,20 +2055,20 @@ href="glossary2glossaries.html#dx1-11004" >71</a>, <a href="glossary2glossaries.html#dx1-11006" >72</a>, <a href="glossary2glossaries.html#dx1-11012" >73</a> <br /></span> </p><p class="theindex"> <span -class="futb8t-">N</span> +class="cmbx-10">N</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\newacronym</span></span></span>  <a +class="cmtt-10">\newacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-12001" ><span class="underline">74</span></a>, <a href="glossary2glossaries.html#dx1-12007" ><span class="underline">75</span></a>, <a href="glossary2glossaries.html#dx1-12018" ><span class="underline">76</span></a>, <a href="glossary2glossaries.html#dx1-13003" ><span class="underline">77</span></a>, <a href="glossary2glossaries.html#dx1-13005" ><span class="underline">78</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\newglossary</span></span></span>  <a +class="cmtt-10">\newglossary</span></span></span>  <a href="glossary2glossaries.html#dx1-4002" ><span class="underline">79</span></a>, <a href="glossary2glossaries.html#dx1-4009" ><span class="underline">80</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\newglossaryentry</span></span></span>  <a +class="cmtt-10">\newglossaryentry</span></span></span>  <a href="glossary2glossaries.html#dx1-6005" ><span class="underline">81</span></a>, <a href="glossary2glossaries.html#dx1-6008" ><span class="underline">82</span></a>, <a href="glossary2glossaries.html#dx1-6011" ><span class="underline">83</span></a>, <a @@ -1876,36 +2077,36 @@ href="glossary2glossaries.html#dx1-11014" ><span class="underline">85</span></a> href="glossary2glossaries.html#dx1-11018" ><span class="underline">86</span></a>, <a href="glossary2glossaries.html#dx1-12002" ><span class="underline">87</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10">\newglossaryentry </span>options<br /></span> +class="cmtt-10">\newglossaryentry </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">description</span>  <a +class="cmss-10">description</span>  <a href="glossary2glossaries.html#dx1-12004" >88</a>, <a href="glossary2glossaries.html#dx1-12006" >89</a> <br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">name</span>  <a +class="cmss-10">name</span>  <a href="glossary2glossaries.html#dx1-12003" >90</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\newglossarytype</span></span></span>  <a +class="cmtt-10">\newglossarytype</span></span></span>  <a href="glossary2glossaries.html#dx1-4001" ><span class="underline">91</span></a> <br /></span> </p><p class="theindex"> <span -class="futb8t-">O</span> +class="cmbx-10">O</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\oldacronym</span></span></span>  <a +class="cmtt-10">\oldacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-12017" ><span class="underline">92</span></a>, <a href="glossary2glossaries.html#dx1-12019" ><span class="underline">93</span></a>, <a href="glossary2glossaries.html#dx1-13004" ><span class="underline">94</span></a> <br /></span> </p><p class="theindex"> <span -class="futb8t-">P</span> +class="cmbx-10">P</span> <span class="index-item">package options:<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">description</span>  <a +class="cmss-10">description</span>  <a href="glossary2glossaries.html#dx1-12005" ><span class="underline">95</span></a>, <a href="glossary2glossaries.html#dx1-12008" ><span class="underline">96</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\printglossaries</span></span></span>  <a +class="cmtt-10">\printglossaries</span></span></span>  <a href="glossary2glossaries.html#dx1-16002" ><span class="underline">97</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\printglossary</span></span></span>  <a +class="cmtt-10">\printglossary</span></span></span>  <a href="glossary2glossaries.html#dx1-4004" ><span class="underline">98</span></a>, <a href="glossary2glossaries.html#dx1-4006" ><span class="underline">99</span></a>, <a href="glossary2glossaries.html#dx1-4011" ><span class="underline">100</span></a>, <a @@ -1914,33 +2115,33 @@ href="glossary2glossaries.html#dx1-16003" ><span class="underline">102</span></a href="glossary2glossaries.html#dx1-16004" ><span class="underline">103</span></a>, <a href="glossary2glossaries.html#dx1-16006" ><span class="underline">104</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10">\printglossary </span>options<br /></span> +class="cmtt-10">\printglossary </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">style</span>  <a +class="cmss-10">style</span>  <a href="glossary2glossaries.html#dx1-4005" >105</a> <br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">toctitle</span>  <a +class="cmss-10">toctitle</span>  <a href="glossary2glossaries.html#dx1-4010" >106</a>, <a href="glossary2glossaries.html#dx1-16005" >107</a>, <a href="glossary2glossaries.html#dx1-16007" >108</a> <br /></span> </p><p class="theindex"> <span -class="futb8t-">R</span> +class="cmbx-10">R</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\resetacronym</span></span></span>  <a +class="cmtt-10">\resetacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-15001" ><span class="underline">109</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\resetallacronyms</span></span></span>  <a +class="cmtt-10">\resetallacronyms</span></span></span>  <a href="glossary2glossaries.html#dx1-15007" ><span class="underline">110</span></a> <br /></span> -</p><p class="theindex"> <span -class="futb8t-">S</span> +</p><p class="theindex"> <span +class="cmbx-10">S</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\shortnotationname</span></span></span>  <a +class="cmtt-10">\shortnotationname</span></span></span>  <a href="glossary2glossaries.html#dx1-16008" ><span class="underline">111</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\storeglosentry</span></span></span>  <a +class="cmtt-10">\storeglosentry</span></span></span>  <a href="glossary2glossaries.html#dx1-6004" ><span class="underline">112</span></a>, <a href="glossary2glossaries.html#dx1-6007" ><span class="underline">113</span></a>, <a href="glossary2glossaries.html#dx1-6009" ><span class="underline">114</span></a>, <a @@ -1949,46 +2150,46 @@ href="glossary2glossaries.html#dx1-6015" ><span class="underline">116</span></a> href="glossary2glossaries.html#dx1-7001" ><span class="underline">117</span></a>, <a href="glossary2glossaries.html#dx1-11009" ><span class="underline">118</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10">\storeglosentry </span>options<br /></span> +class="cmtt-10">\storeglosentry </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">format</span>  <a +class="cmss-10">format</span>  <a href="glossary2glossaries.html#dx1-6013" >119</a> <br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">number</span>  <a +class="cmss-10">number</span>  <a href="glossary2glossaries.html#dx1-6014" >120</a> <br /></span> </p><p class="theindex"> <span -class="futb8t-">U</span> +class="cmbx-10">U</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\unsetacronym</span></span></span>  <a +class="cmtt-10">\unsetacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-15004" ><span class="underline">121</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\unsetallacronyms</span></span></span>  <a +class="cmtt-10">\unsetallacronyms</span></span></span>  <a href="glossary2glossaries.html#dx1-15012" ><span class="underline">122</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\useacronym</span></span></span>  <a +class="cmtt-10">\useacronym</span></span></span>  <a href="glossary2glossaries.html#dx1-12012" ><span class="underline">123</span></a>, <a href="glossary2glossaries.html#dx1-12013" ><span class="underline">124</span></a>, <a href="glossary2glossaries.html#dx1-12015" ><span class="underline">125</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\useGlosentry</span></span></span>  <a +class="cmtt-10">\useGlosentry</span></span></span>  <a href="glossary2glossaries.html#dx1-7003" ><span class="underline">126</span></a>, <a href="glossary2glossaries.html#dx1-9001" ><span class="underline">127</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span -class="ec-lmtt-10">\useglosentry</span></span></span>  <a +class="cmtt-10">\useglosentry</span></span></span>  <a href="glossary2glossaries.html#dx1-7002" ><span class="underline">128</span></a>, <a href="glossary2glossaries.html#dx1-8001" ><span class="underline">129</span></a> <br /></span> <span class="index-item"><span -class="ec-lmtt-10">\useglosentry </span>options<br /></span> +class="cmtt-10">\useglosentry </span>options<br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">format</span>  <a +class="cmss-10">format</span>  <a href="glossary2glossaries.html#dx1-8003" >130</a> <br /></span> <span class="index-subitem">    <span -class="ec-lmss-10">number</span>  <a +class="cmss-10">number</span>  <a href="glossary2glossaries.html#dx1-8004" >131</a> <br /></span> -</p><p class="theindex"> <span -class="futb8t-">X</span> +</p><p class="theindex"> <span +class="cmbx-10">X</span> <span class="index-item"><span -class="ec-lmtt-10">xindy</span>  <a +class="cmtt-10">xindy</span>  <a href="glossary2glossaries.html#dx1-2004" >132</a>, <a href="glossary2glossaries.html#dx1-2005" >133</a>, <a href="glossary2glossaries.html#dx1-17005" >134</a>, <a @@ -1997,64 +2198,69 @@ href="glossary2glossaries.html#dx1-17009" >136</a>, <a href="glossary2glossaries.html#dx1-11005" >137</a>, <a href="glossary2glossaries.html#dx1-11007" >138</a> <br /></span> </p></div> - <div class="footnotes"><!--l. 84--><p class="noindent" ><span class="footnote-mark"><a + <div class="footnotes"><!--l. 86--><p class="noindent" ><span class="footnote-mark"><a href="#fn1x0-bk" id="fn1x0"><sup class="textsuperscript">1</sup></a></span><span -class="futr8t-x-x-80">as from v1.17. Previous versions were designed to be used with </span><span -class="ec-lmtt-8">makeindex</span><a +class="cmr-8">as from v1.17. Previous versions were designed to be used with </span><span +class="cmtt-8">makeindex</span><a id="dx1-2002"></a> <span -class="futr8t-x-x-80">only</span></p> -<!--l. 99--><p class="noindent" ><span class="footnote-mark"><a +class="cmr-8">only</span></p> +<!--l. 101--><p class="noindent" ><span class="footnote-mark"><a href="#fn2x0-bk" id="fn2x0"><sup class="textsuperscript">2</sup></a></span><span -class="futr8t-x-x-80">as from v1.17</span></p><!--l. 236--><p class="indent" > <span class="footnote-mark"><a +class="cmr-8">as from v1.17</span></p><!--l. 238--><p class="indent" > <span class="footnote-mark"><a href="#fn3x0-bk" id="fn3x0"><sup class="textsuperscript">3</sup></a></span><span -class="futr8t-x-x-80">mainly because having a key value list in </span><span -class="ec-lmtt-8">\glossary</span><a +class="cmr-8">mainly because having a key value list in </span><span +class="cmtt-8">\glossary</span><a id="dx1-6003"></a> <span -class="futr8t-x-x-80">caused problems, but it also helps consistency.</span></p> -<!--l. 350--><p class="indent" > <span class="footnote-mark"><a +class="cmr-8">caused problems, but it also helps</span> +<span +class="cmr-8">consistency.</span></p> +<!--l. 352--><p class="indent" > <span class="footnote-mark"><a href="#fn4x0-bk" id="fn4x0"><sup class="textsuperscript">4</sup></a></span><span -class="futr8t-x-x-80">This is because </span><span -class="ec-lmtt-8">\glossary</span><a +class="cmr-8">This is because </span><span +class="cmtt-8">\glossary</span><a id="dx1-11003"></a> <span -class="futr8t-x-x-80">requires the argument to be in a speci�c format and doesn't use</span> +class="cmr-8">requires the argument to be in a specific format and doesn’t use the</span> <span -class="futr8t-x-x-80">the </span><span -class="futri8t-x-x-80"><key></span><span -class="futr8t-x-x-80">=</span><span -class="futri8t-x-x-80"><value> </span><span -class="futr8t-x-x-80">format that the old glossary package used. The new package's internal commands</span> +class="cmmi-8"><</span><span +class="cmti-8">key</span><span +class="cmmi-8">></span><span +class="cmr-8">=</span><span +class="cmmi-8"><</span><span +class="cmti-8">value</span><span +class="cmmi-8">> </span><span +class="cmr-8">format that the old glossary package used. The new package’s internal commands set</span> <span -class="futr8t-x-x-80">set this format, as well as escaping any of </span><span -class="ec-lmtt-8">makeindex</span><a +class="cmr-8">this format, as well as escaping any of </span><span +class="cmtt-8">makeindex</span><a id="dx1-11004"></a><span -class="futr8t-x-x-80">'s or </span><span -class="ec-lmtt-8">xindy</span><a +class="cmr-8">’s or </span><span +class="cmtt-8">xindy</span><a id="dx1-11005"></a><span -class="futr8t-x-x-80">'s special characters. What's more,</span> +class="cmr-8">’s special characters. What’s more, the</span> <span -class="futr8t-x-x-80">the format has changed as from v1.17 to allow the new package to be used with either </span><span -class="ec-lmtt-8">makeindex</span><a +class="cmr-8">format has changed as from v1.17 to allow the new package to be used with either </span><span +class="cmtt-8">makeindex</span><a id="dx1-11006"></a> <span -class="futr8t-x-x-80">or</span> +class="cmr-8">or</span> <span -class="ec-lmtt-8">xindy</span><a +class="cmtt-8">xindy</span><a id="dx1-11007"></a><span -class="futr8t-x-x-80">.</span></p> -<!--l. 359--><p class="indent" > <span class="footnote-mark"><a +class="cmr-8">.</span></p> +<!--l. 361--><p class="indent" > <span class="footnote-mark"><a href="#fn5x0-bk" id="fn5x0"><sup class="textsuperscript">5</sup></a></span><span -class="futr8t-x-x-80">From the user's point of view, using </span><span -class="ec-lmtt-8">\glossary</span><a +class="cmr-8">From the user’s point of view, using </span><span +class="cmtt-8">\glossary</span><a id="dx1-11011"></a> <span -class="futr8t-x-x-80">throughout the document is time consuming, and if</span> +class="cmr-8">throughout the document is time consuming,</span> <span -class="futr8t-x-x-80">you use it more than once for the same term, there's a chance extra spaces may creep in which will</span> +class="cmr-8">and if you use it more than once for the same term, there’s a chance extra spaces may creep in which</span> <span -class="futr8t-x-x-80">cause </span><span -class="ec-lmtt-8">makeindex</span><a +class="cmr-8">will cause </span><span +class="cmtt-8">makeindex</span><a id="dx1-11012"></a> <span -class="futr8t-x-x-80">to treat the two entries as di�erent terms, even though they look the same in the</span> +class="cmr-8">to treat the two entries as different terms, even though they look the same in the</span> <span -class="futr8t-x-x-80">document.</span></p> </div> +class="cmr-8">document.</span></p> </div> </body></html> diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf index 379a251cc37..5b400eb9742 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 e10e28d3006..e4375de7774 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex @@ -1,14 +1,15 @@ \documentclass{nlctdoc} \usepackage[utf8]{inputenc} +\ifpdf \usepackage[T1]{fontenc} \usepackage{lmodern} \usepackage{fourier} -\ifpdf \usepackage{mathpazo} \usepackage[scaled=.88]{helvet} \usepackage{courier} \fi +\usepackage{cmap} \usepackage[colorlinks, bookmarks, @@ -22,6 +23,7 @@ \newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} \ifpdf +\newcommand{\glsentrytext}[1]{\texttt{#1}} \externaldocument{glossaries-user} \fi @@ -31,7 +33,7 @@ \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} -\date{2014-01-20} +\date{2014-03-06} \newenvironment{oldway}{% \begin{labelledbox}{\styfmt{glossary}}\ttfamily\obeylines diff --git a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html index 3082292be54..de875b993c6 100644 --- a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html +++ b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html @@ -1,5 +1,4 @@ -<a - id="top"></a><?xml version="1.0" encoding="utf-8" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd--> @@ -11,68 +10,30 @@ <meta name="originator" content="TeX4ht (http://www.tug.org/tex4ht/)" /> <!-- xhtml,fn-in,css-in,uni-html4,utf8 --> <meta name="src" content="mfirstuc-manual.tex" /> -<meta name="date" content="2014-01-20 17:23:00" /> +<meta name="date" content="2014-03-07 17:43:00" /> <style type="text/css"> <!-- /* start css.sty */ -.ecrm-1728{font-size:170%;} -.ecrm-1200{font-size:120%;} -.ectt-1200{font-size:120%; font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ectt-0900{font-size:90%; font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} +.cmmi-10{font-style: italic;} +.cmr-17{font-size:170%;} +.cmr-12{font-size:120%;} +.cmtt-12{font-size:120%;font-family: monospace;} +.cmtt-12{font-family: monospace;} +.cmtt-12{font-family: monospace;} +.cmtt-12{font-family: monospace;} +.cmss-10{ font-family: sans-serif;} +.cmtt-9{font-size:90%;font-family: monospace;} +.cmtt-9{font-family: monospace;} +.cmtt-9{font-family: monospace;} +.cmtt-9{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmitt-10{font-family: monospace; font-style: italic;} +.cmti-10{ font-style: italic;} p.noindent { text-indent: 0em } td p.noindent { text-indent: 0em; margin-top:0em; } p.nopar { text-indent: 0em; } @@ -184,6 +145,7 @@ div.abstract {width:100%;} .alltt P { margin-bottom : 0em; margin-top : 0em; } .alltt { margin-bottom : 1em; margin-top : 1em; } div.important { border : solid red; } +div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; clear:both; padding-top: 2ex; padding-bottom: 2ex;} /* end css.sty */ @@ -191,7 +153,8 @@ div.important { border : solid red; } </style> </head><body > - <div class="maketitle"> + <div class="maketitle"><a + id="top"></a> @@ -201,56 +164,62 @@ div.important { border : solid red; } <h2 class="titleHead">mfirstuc.sty v1.08: uppercasing first letter</h2> <div class="author" ><span -class="ecrm-1200">Nicola L.C. Talbot</span> +class="cmr-12">Nicola L.C. Talbot</span> <br /> <span -class="ecrm-1200">Dickimaw Books</span> +class="cmr-12">Dickimaw Books</span> <br /><a href="http://www.dickimaw-books.com/" class="url" ><span -class="ectt-1200">http://www.dickimaw-_books.com/</span></a></div><br /> +class="cmtt-12">http://www.dickimaw-_books.com/</span></a></div><br /> <div class="date" ><span -class="ecrm-1200">2013-11-04</span></div> +class="cmr-12">2013-11-04</span></div> </div> -<!--l. 24--><p class="indent" > The <span -class="ecss-1000">glossaries </span>bundle is supplied with the package <span -class="ecss-1000">mfirstuc</span><a +<!--l. 27--><p class="indent" > The <span +class="cmss-10">glossaries </span>bundle is supplied with the package <span +class="cmss-10">mfirstuc</span><a id="dx1-2"></a> which provides the command: -</p><!--l. 26--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\makefirstuc</span><span -class="ectt-0900"> </span></span><a +</p><!--l. 29--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="cmtt-9">\makefirstuc</span><span +class="cmtt-9"> </span></span><a id="dx1-3"></a> <span -class="ectt-1000">\makefirstuc{</span><span -class="ecit-1000"><stuff></span><span -class="ectt-1000">} </span></div><hr> -</p><!--l. 28--><p class="noindent" > +class="cmtt-10">\makefirstuc{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">stuff</span><span +class="cmmi-10">></span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 31--><p class="noindent" > This makes the first object of <span -class="ecti-1000"><stuff> </span>uppercase unless <span -class="ecti-1000"><stuff> </span>starts with a control +class="cmmi-10"><</span><span +class="cmti-10">stuff</span><span +class="cmmi-10">> </span>uppercase unless <span +class="cmmi-10"><</span><span +class="cmti-10">stuff</span><span +class="cmmi-10">> </span>starts with a control sequence followed by a non-empty group, in which case the first object in the group is converted to uppercase. Examples: </p> <ul class="itemize1"> <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{abc}</span></span></span> produces Abc. +class="cmtt-10">\makefirstuc{abc}</span></span></span> produces Abc. </li> <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{\emph{abc}}</span></span></span> produces <span -class="ecti-1000">Abc </span>(<span -class="ectt-1000">\MakeUppercase</span><a +class="cmtt-10">\makefirstuc{\emph{abc}}</span></span></span> produces <span +class="cmti-10">Abc </span>(<span +class="cmtt-10">\MakeUppercase</span><a id="dx1-4"></a> has been applied to the letter “a” rather than <span -class="ectt-1000">\emph</span>). Note however that +class="cmtt-10">\emph</span>). Note however that <div class="verbatim" id="verbatim-1"> \makefirstuc{{\em abc}} </div> - <!--l. 41--><p class="nopar" > produces <span -class="ecti-1000">ABC </span>(first object is <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">{\em</span><span -class="ectt-1000"> abc}</span></span></span> so equivalent to <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\MakeUppercase{\em</span><span -class="ectt-1000"> abc}</span></span></span>), + <!--l. 44--><p class="nopar" > produces <span +class="cmti-10">ABC </span>(first object is <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">{\em</span><span +class="cmtt-10"> abc}</span></span></span> so equivalent to <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\MakeUppercase{\em</span><span +class="cmtt-10"> abc}</span></span></span>), and @@ -259,40 +228,40 @@ class="ectt-1000"> abc}</span></span></span>), <div class="verbatim" id="verbatim-2"> {\makefirstuc{\em abc}} </div> - <!--l. 46--><p class="nopar" > produces abc (<span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\em</span></span></span> doesn’t have an argument therefore first object is <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\em</span></span></span> so + <!--l. 49--><p class="nopar" > produces abc (<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\em</span></span></span> doesn’t have an argument therefore first object is <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\em</span></span></span> so equivalent to <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">{\MakeUppercase{\em}abc}</span></span></span>). +class="cmtt-10">{\MakeUppercase{\em}abc}</span></span></span>). </p></li> <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{{\’a}bc}</span></span></span> produces Ábc. +class="cmtt-10">\makefirstuc{{\’a}bc}</span></span></span> produces Ábc. </li> <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{\ae</span><span -class="ectt-1000"> bc}</span></span></span> produces Æbc. +class="cmtt-10">\makefirstuc{\ae</span><span +class="cmtt-10"> bc}</span></span></span> produces Æbc. </li> <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{{\ae}bc}</span></span></span> produces Æbc. +class="cmtt-10">\makefirstuc{{\ae}bc}</span></span></span> produces Æbc. </li> <li class="itemize"><span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{{</span><span -class="ectt-1000">ä</span><span -class="ectt-1000">}bc}</span></span></span> produces Äbc. +class="cmtt-10">\makefirstuc{{</span><span +class="cmtt-10">ä</span><span +class="cmtt-10">}bc}</span></span></span> produces Äbc. </li></ul> -<!--l. 60--><p class="noindent" >Note that non-Latin or accented characters appearing at the start of the text must be +<!--l. 63--><p class="noindent" >Note that non-Latin or accented characters appearing at the start of the text must be placed in a group (even if you are using the <span -class="ecss-1000">inputenc</span><a +class="cmss-10">inputenc</span><a id="dx1-5"></a> package) due to expansion issues. -</p><!--l. 64--><p class="indent" > <div class="important" title="Important Note"> In version 1.02 of <span -class="ecss-1000">mfirstuc</span>, a bug fix resulted in a change in output if the first +</p><!--l. 67--><p class="indent" > <div class="important" title="Important Note"> In version 1.02 of <span +class="cmss-10">mfirstuc</span>, a bug fix resulted in a change in output if the first object is a control sequence followed by an empty group. Prior to version 1.02, <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\makefirstuc{\ae{}bc}</span></span></span> produced æBc. However as from version 1.02, it now produces -Æbc. </div> -</p><!--l. 70--><p class="noindent" > -</p><!--l. 72--><p class="indent" > Note also that +class="cmtt-10">\makefirstuc{\ae{}bc}</span></span></span> produced æBc. However as from version 1.02, it now produces +Æbc. </div> +</p><!--l. 73--><p class="noindent" > +</p><!--l. 75--><p class="indent" > Note also that @@ -301,11 +270,11 @@ class="ectt-1000">\makefirstuc{\ae{}bc}</span></span></span> produced \newcommand{\abc}{abc}  <br />\makefirstuc{\abc} </div> -<!--l. 76--><p class="nopar" > produces: ABC. This is because the first object in the argument of <span -class="ectt-1000">\makefirstuc </span>is +<!--l. 79--><p class="nopar" > produces: ABC. This is because the first object in the argument of <span +class="cmtt-10">\makefirstuc </span>is <span -class="ectt-1000">\abc</span>, so it does <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">\MakeUppercase{\abc}</span></span></span>. Whereas: +class="cmtt-10">\abc</span>, so it does <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\MakeUppercase{\abc}</span></span></span>. Whereas: @@ -314,19 +283,23 @@ class="ectt-1000">\MakeUppercase{\abc}</span></span></span>. Whereas: \newcommand{\abc}{abc}  <br />\expandafter\makefirstuc\expandafter{\abc} </div> -<!--l. 83--><p class="nopar" > produces: Abc. There is a short cut command which will do this: -</p><!--l. 85--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\xmakefirstuc</span><span -class="ectt-0900"> </span></span><a +<!--l. 86--><p class="nopar" > produces: Abc. There is a short cut command which will do this: +</p><!--l. 88--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="cmtt-9">\xmakefirstuc</span><span +class="cmtt-9"> </span></span><a id="dx1-6"></a> <span -class="ectt-1000">\xmakefirstuc{</span><span -class="ecit-1000"><stuff></span><span -class="ectt-1000">} </span></div><hr> -</p><!--l. 87--><p class="noindent" > +class="cmtt-10">\xmakefirstuc{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">stuff</span><span +class="cmmi-10">></span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 90--><p class="noindent" > This is equivalent to <span -class="ectt-1000">\expandafter\makefirstuc\expandafter{</span><span -class="ecti-1000"><stuff></span><span -class="ectt-1000">}</span>. +class="cmtt-10">\expandafter\makefirstuc\expandafter{</span><span +class="cmmi-10"><</span><span +class="cmti-10">stuff</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span>. So @@ -336,37 +309,39 @@ So \newcommand{\abc}{abc}  <br />\xmakefirstuc{\abc} </div> -<!--l. 92--><p class="nopar" > produces: Abc. -</p><!--l. 97--><p class="indent" > <div class="important" title="Important Note"> <span -class="ectt-1000">\xmakefirstuc </span>only performs one level expansion on the first object in its +<!--l. 95--><p class="nopar" > produces: Abc. +</p><!--l. 100--><p class="indent" > <div class="important" title="Important Note"> <span +class="cmtt-10">\xmakefirstuc </span>only performs one level expansion on the first object in its argument. It does not fully expand the entire argument. </div> -</p><!--l. 101--><p class="noindent" > -</p><!--l. 103--><p class="indent" > If you use <span -class="ecss-1000">mfirstuc </span>without the <span -class="ecss-1000">glossaries</span><a +</p><!--l. 104--><p class="noindent" > +</p><!--l. 106--><p class="indent" > If you use <span +class="cmss-10">mfirstuc </span>without the <span +class="cmss-10">glossaries</span><a id="dx1-7"></a> package, the standard <span -class="ectt-1000">\MakeUppercase</span> +class="cmtt-10">\MakeUppercase</span> command is used. If used with <span -class="ecss-1000">glossaries</span><a +class="cmss-10">glossaries</span><a id="dx1-8"></a>, <span -class="ectt-1000">\MakeTextUppercase</span><a +class="cmtt-10">\MakeTextUppercase</span><a id="dx1-9"></a> (defined by <span -class="ecss-1000">textcase</span><a +class="cmss-10">textcase</span><a id="dx1-10"></a> the package) is used instead. If you are using <span -class="ecss-1000">mfirstuc </span>without the <span -class="ecss-1000">glossaries </span>package and +class="cmss-10">mfirstuc </span>without the <span +class="cmss-10">glossaries </span>package and want to use <span -class="ectt-1000">\MakeTextUppercase</span><a +class="cmtt-10">\MakeTextUppercase</span><a id="dx1-11"></a> instead, you can redefine -</p><!--l. 109--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\glsmakefirstuc</span><span -class="ectt-0900"> </span></span><a +</p><!--l. 112--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="cmtt-9">\glsmakefirstuc</span><span +class="cmtt-9"> </span></span><a id="dx1-12"></a> <span -class="ectt-1000">\glsmakefirstuc{</span><span -class="ecit-1000"><text></span><span -class="ectt-1000">} </span></div><hr> -</p><!--l. 111--><p class="noindent" > +class="cmtt-10">\glsmakefirstuc{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">text</span><span +class="cmmi-10">></span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 114--><p class="noindent" > For example: @@ -375,50 +350,60 @@ For example: <div class="verbatim" id="verbatim-6"> \renewcommand{\glsmakefirstuc}[1]{\MakeTextUppercase #1} </div> -<!--l. 115--><p class="nopar" > Remember to also load <span -class="ecss-1000">textcase</span><a +<!--l. 118--><p class="nopar" > Remember to also load <span +class="cmss-10">textcase</span><a id="dx1-13"></a> (<span -class="ecss-1000">glossaries </span>loads this automatically). -</p><!--l. 119--><p class="indent" > New to mfirstuc v1.06: -</p><!--l. 120--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\capitalisewords</span><span -class="ectt-0900"> </span></span><a +class="cmss-10">glossaries </span>loads this automatically). +</p><!--l. 122--><p class="indent" > New to mfirstuc v1.06: +</p><!--l. 123--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="cmtt-9">\capitalisewords</span><span +class="cmtt-9"> </span></span><a id="dx1-14"></a> <span -class="ectt-1000">\capitalisewords{</span><span -class="ecit-1000"><text></span><span -class="ectt-1000">} </span></div><hr> -</p><!--l. 122--><p class="noindent" > +class="cmtt-10">\capitalisewords{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">text</span><span +class="cmmi-10">></span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 125--><p class="noindent" > This command apply <span -class="ectt-1000">\makefirstuc</span><a +class="cmtt-10">\makefirstuc</span><a id="dx1-15"></a> to each word in <span -class="ecti-1000"><text> </span>where the space character +class="cmmi-10"><</span><span +class="cmti-10">text</span><span +class="cmmi-10">> </span>where the space character is used as the word separator. Note that it has to be a plain space character, not another form of space, such as <span class="obeylines-h"><span class="verb"><span -class="ectt-1000">~</span></span></span> or <span -class="ectt-1000">\space</span>. Note that no expansion is performed on +class="cmtt-10">~</span></span></span> or <span +class="cmtt-10">\space</span>. Note that no expansion is performed on <span -class="ecti-1000"><text></span>. -</p><!--l. 129--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span -class="ectt-0900">\xcapitalisewords</span><span -class="ectt-0900"> </span></span><a +class="cmmi-10"><</span><span +class="cmti-10">text</span><span +class="cmmi-10">></span>. +</p><!--l. 132--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span +class="cmtt-9">\xcapitalisewords</span><span +class="cmtt-9"> </span></span><a id="dx1-16"></a> <span -class="ectt-1000">\xcapitalisewords{</span><span -class="ecit-1000"><text></span><span -class="ectt-1000">} </span></div><hr> -</p><!--l. 131--><p class="noindent" > +class="cmtt-10">\xcapitalisewords{</span><span +class="cmmi-10"><</span><span +class="cmitt-10">text</span><span +class="cmmi-10">></span><span +class="cmtt-10">} </span></div><hr> +</p><!--l. 134--><p class="noindent" > This is a short cut for <span -class="ectt-1000">\expandafter\capitalisewords\expandafter{</span><span -class="ecti-1000"><text></span><span -class="ectt-1000">}</span>. -</p><!--l. 135--><p class="indent" > <div class="important" title="Important Note"> If you are using <span -class="ecss-1000">hyperref</span><a +class="cmtt-10">\expandafter\capitalisewords\expandafter{</span><span +class="cmmi-10"><</span><span +class="cmti-10">text</span><span +class="cmmi-10">></span><span +class="cmtt-10">}</span>. +</p><!--l. 138--><p class="indent" > <div class="important" title="Important Note"> If you are using <span +class="cmss-10">hyperref</span><a id="dx1-17"></a> and want to use <span -class="ectt-1000">\capitalisewords </span>or <span -class="ectt-1000">\makefirstuc</span><a +class="cmtt-10">\capitalisewords </span>or <span +class="cmtt-10">\makefirstuc</span><a id="dx1-18"></a> (or <span -class="ectt-1000">\xcapitalisewords</span>/<span -class="ectt-1000">\xmakefirstuc</span>) in a section heading, the PDF bookmarks won’t +class="cmtt-10">\xcapitalisewords</span>/<span +class="cmtt-10">\xmakefirstuc</span>) in a section heading, the PDF bookmarks won’t be able to use the command as it’s not expandable, so you will get a warning that looks like: @@ -429,17 +414,17 @@ like: Package hyperref Warning: Token not allowed in a PDF string (PDFDocEncoding):  <br />(hyperref)                removing ‘\capitalisewords’ </div> -<!--l. 143--><p class="nopar" > If you want to provide an alternative for the PDF bookmark, you can use +<!--l. 146--><p class="nopar" > If you want to provide an alternative for the PDF bookmark, you can use <span -class="ecss-1000">hyperref</span><a +class="cmss-10">hyperref</span><a id="dx1-19"></a>’s <span -class="ectt-1000">\texorpdfstring</span><a +class="cmtt-10">\texorpdfstring</span><a id="dx1-20"></a> command. See the <span -class="ecss-1000">hyperref</span><a +class="cmss-10">hyperref</span><a id="dx1-21"></a> manual for further details. </div> -</p><!--l. 147--><p class="noindent" > -</p><!--l. 149--><p class="indent" > Examples: +</p><!--l. 150--><p class="noindent" > +</p><!--l. 152--><p class="indent" > Examples: </p><ol class="enumerate1" > <li class="enumerate" id="x1-23x1"> @@ -449,7 +434,7 @@ class="ecss-1000">hyperref</span><a <div class="verbatim" id="verbatim-8"> \capitalisewords{a book of rhyme.} </div> - <!--l. 154--><p class="nopar" > produces: A Book Of Rhyme. + <!--l. 157--><p class="nopar" > produces: A Book Of Rhyme. </p></li> <li class="enumerate" id="x1-25x2"> @@ -459,7 +444,7 @@ class="ecss-1000">hyperref</span><a <div class="verbatim" id="verbatim-9"> \capitalisewords{a book\space of rhyme.} </div> - <!--l. 161--><p class="nopar" > produces: A Book of Rhyme. + <!--l. 164--><p class="nopar" > produces: A Book of Rhyme. </p></li> <li class="enumerate" id="x1-27x3"> @@ -470,10 +455,12 @@ class="ecss-1000">hyperref</span><a \newcommand{\mytitle}{a book\space of rhyme.}  <br />\capitalisewords{\mytitle} </div> - <!--l. 169--><p class="nopar" > produces: A BOOK OF RHYME. (No expansion is performed on <span -class="ectt-1000">\mytitle</span>, so + <!--l. 172--><p class="nopar" > produces: A BOOK OF RHYME. (No expansion is performed on <span +class="cmtt-10">\mytitle</span>, so <span -class="ecti-1000"><text> </span>consists of just one “word”.) Compare with next example: +class="cmmi-10"><</span><span +class="cmti-10">text</span><span +class="cmmi-10">> </span>consists of just one “word”.) Compare with next example: </p></li> <li class="enumerate" id="x1-29x4"> @@ -484,7 +471,7 @@ class="ecti-1000"><text> </span>consists of just one “word&# \newcommand{\mytitle}{a book\space of rhyme.}  <br />\xcapitalisewords{\mytitle} </div> - <!--l. 180--><p class="nopar" > produces: A Book of Rhyme. + <!--l. 183--><p class="nopar" > produces: A Book of Rhyme. </p> </li></ol> diff --git a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.pdf b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.pdf index e36200e47ca..d0e269bfdf1 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.pdf and b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.tex b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.tex index e81c39df6b4..dabd6b4dd01 100644 --- a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.tex +++ b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.tex @@ -4,7 +4,10 @@ \usepackage{mfirstuc} \usepackage{pifont} \usepackage[utf8]{inputenc} +\ifpdf \usepackage[T1]{fontenc} +\fi +\usepackage{cmap} \usepackage[colorlinks, bookmarks, hyperindex=false, diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf index f9c277d2be0..96ecf8af5ad 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf index 16583eb7780..45577c77f98 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf index 4860ff0fdb9..39646883e57 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 02bad518a40..82bdafa07c5 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf index 998fc26de9e..221ca9437d9 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf index c46d6e61396..1c0899af097 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf index f823a59c6da..7693160f1c6 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 2e3a4de2b83..5fcce8ff549 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 73d32ba5ae0..faab9a78ab0 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.pdf index e9b277ea335..24e22a37f30 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-mfirstuc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf index 13139f5a672..bd4b49a9424 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 new file mode 100644 index 00000000000..13b007217f7 Binary files /dev/null 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-utf8.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.tex new file mode 100644 index 00000000000..b66eb41e6e5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.tex @@ -0,0 +1,146 @@ + % arara: pdflatex + % arara: pdflatex +\documentclass{report} + +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} + +\usepackage[colorlinks]{hyperref} +\usepackage[index,symbols,nohypertypes={index}]{glossaries} +\usepackage{glossary-mcols} + +\makenoidxglossaries + +\renewcommand{\theHequation}{\theequation} + + % main entries + +\newglossaryentry{elite}{% + name={{é}lite}, + description={select group of people} +} + +\newglossaryentry{elephant}{% + name={elephant}, + description={very large mammal with tusks} +} + +\newglossaryentry{elk}{% + name={elk}, + description={large northern deer} +} + +\newglossaryentry{emigre}{% + name={{é}migré}, + description={person who has emigrated to another country, + especially for political reasons} +} + + % Symbols + +\newglossaryentry{set}{% + type=symbols, + name={$\mathcal{S}$}, + text={\mathcal{S}}, + sort={S}, + description={A set}} + +\newglossaryentry{U}{% + type=symbols, + name={$\mathcal{U}$}, + text={\mathcal{U}}, + sort={U}, + description={The universal set}} + +\newglossaryentry{card}{% + type=symbols, + name={$|\glsentrytext{set}|$}, + text={|\glsentrytext{set}|}, + sort={|}, + description={cardinality of $\gls{set}$}} + +\newglossaryentry{factorial}{% + type=symbols, + name={$!$}, + text={!}, + sort={!}, + description={factorial}} + + % index entries + +\newterm{seal} + +\newterm{dinosaur} + +\newterm[parent=dinosaur]{ceratopsidae} + +\newterm[parent=dinosaur,plural={stegosauruses}]{stegosaurus} +\newterm[parent=ceratopsidae,plural={triceratopses}]{triceratops} +\newterm[parent=ceratopsidae,plural={styracosauruses}]{styracosaurus} +\newterm[parent=dinosaur,plural={apatosauruses}]{apatosaurus} + +\newterm{Triassic} + +\newterm{Devonian} + +\newterm[see={[see also]seal}]{sea lion} + +\begin{document} + +\chapter{Mathematical Notation} + +The cardinality of a set $\gls{set}$ is denoted $\gls{card}$ +The $\gls{factorial}$ symbol indicates factorial. +$\gls{U}$ is the universal set. + +\glsaddall[types=main] + +\chapter{Dinosaurs} + +\Glspl{dinosaur} are now extinct. They first appeared during the +\gls{Triassic} period. Examples of \glspl{dinosaur} include the +\gls{triceratops}, the \gls{styracosaurus}, the \gls{apatosaurus} and the \gls{stegosaurus}. + +\Glspl{seal} and \glspl{sea lion} are marine mammals. +The \gls{Devonian} period was the age of fish. + +\glsaddall[types=main] + +\chapter{Location Lists} + +Dinosaur: \glsdisplaynumberlist{dinosaur}. + +Set: \glsdisplaynumberlist{set}. + +\Gls{elite}: \glsdisplaynumberlist{elite}. + +\begin{equation} +3\gls[counter=equation]{factorial} = 3 \times 2 \times 1 +\end{equation} + +\newcommand{\myhandler}[4]{% + Prefix: #1. + Counter: #2. + Format: #3. + Value: #4. + Link: \setentrycounter[#1]{#2}% + \csuse{#3}{#4}. + \par +} +\newcommand{\myxrhandler}[2][]{XR (#1): #2. } + +Factorial locations: +\glsnumberlistloop{factorial}{\myhandler}{\myxrhandler} + +Sea lion locations: +\glsnumberlistloop{sea lion}{\myhandler}{\myxrhandler} + +\printnoidxglossary[type=main,sort=word] + +\printnoidxglossary[type=symbols,sort=use] + +\renewcommand*{\glsnamefont}[1]{\textmd{#1}} + +\printnoidxglossary[type=index,style=mcolindexgroup,sort=word] + +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf new file mode 100644 index 00000000000..66229934031 Binary files /dev/null and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.tex new file mode 100644 index 00000000000..85c52b9f0ab --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.tex @@ -0,0 +1,143 @@ + % arara: pdflatex + % arara: pdflatex +\documentclass{report} + +\usepackage[colorlinks]{hyperref} +\usepackage[index,symbols,nohypertypes={index}]{glossaries} +\usepackage{glossary-mcols} + +\makenoidxglossaries + +\renewcommand{\theHequation}{\theequation} + + % main entries + +\newglossaryentry{elite}{% + name={{\'e}lite}, + description={select group of people} +} + +\newglossaryentry{elephant}{% + name={elephant}, + description={very large mammal with tusks} +} + +\newglossaryentry{elk}{% + name={elk}, + description={large northern deer} +} + +\newglossaryentry{emigre}{% + name={{\'e}migr\'e}, + description={person who has emigrated to another country, + especially for political reasons} +} + + % Symbols + +\newglossaryentry{set}{% + type=symbols, + name={$\mathcal{S}$}, + text={\mathcal{S}}, + sort={S}, + description={A set}} + +\newglossaryentry{U}{% + type=symbols, + name={$\mathcal{U}$}, + text={\mathcal{U}}, + sort={U}, + description={The universal set}} + +\newglossaryentry{card}{% + type=symbols, + name={$|\glsentrytext{set}|$}, + text={|\glsentrytext{set}|}, + sort={|}, + description={cardinality of $\gls{set}$}} + +\newglossaryentry{factorial}{% + type=symbols, + name={$!$}, + text={!}, + sort={!}, + description={factorial}} + + % index entries + +\newterm{seal} + +\newterm{dinosaur} + +\newterm[parent=dinosaur]{ceratopsidae} + +\newterm[parent=dinosaur,plural={stegosauruses}]{stegosaurus} +\newterm[parent=ceratopsidae,plural={triceratopses}]{triceratops} +\newterm[parent=ceratopsidae,plural={styracosauruses}]{styracosaurus} +\newterm[parent=dinosaur,plural={apatosauruses}]{apatosaurus} + +\newterm{Triassic} + +\newterm{Devonian} + +\newterm[see={[see also]seal}]{sea lion} + +\begin{document} + +\chapter{Mathematical Notation} + +The cardinality of a set $\gls{set}$ is denoted $\gls{card}$ +The $\gls{factorial}$ symbol indicates factorial. +$\gls{U}$ is the universal set. + +\glsaddall[types=main] + +\chapter{Dinosaurs} + +\Glspl{dinosaur} are now extinct. They first appeared during the +\gls{Triassic} period. Examples of \glspl{dinosaur} include the +\gls{triceratops}, the \gls{styracosaurus}, the \gls{apatosaurus} and the \gls{stegosaurus}. + +\Glspl{seal} and \glspl{sea lion} are marine mammals. +The \gls{Devonian} period was the age of fish. + +\glsaddall[types=main] + +\chapter{Location Lists} + +Dinosaur: \glsdisplaynumberlist{dinosaur}. + +Set: \glsdisplaynumberlist{set}. + +\Gls{elite}: \glsdisplaynumberlist{elite}. + +\begin{equation} +3\gls[counter=equation]{factorial} = 3 \times 2 \times 1 +\end{equation} + +\newcommand{\myhandler}[4]{% + Prefix: #1. + Counter: #2. + Format: #3. + Value: #4. + Link: \setentrycounter[#1]{#2}% + \csuse{#3}{#4}. + \par +} +\newcommand{\myxrhandler}[2][]{XR (#1): #2. } + +Factorial locations: +\glsnumberlistloop{factorial}{\myhandler}{\myxrhandler} + +Sea lion locations: +\glsnumberlistloop{sea lion}{\myhandler}{\myxrhandler} + +\printnoidxglossary[type=main,sort=word] + +\printnoidxglossary[type=symbols,sort=use] + +\renewcommand*{\glsnamefont}[1]{\textmd{#1}} + +\printnoidxglossary[type=index,style=mcolindexgroup,sort=letter] + +\end{document} 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 4efb159ff35..c1d8ff654df 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 67f2ff80b19..510a9f23252 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 1c8ff7e08a6..d98a44cbded 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 e60dfc356c0..24aefb930eb 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf index 29e751949f6..e65aa3f534c 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/sample.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex index 7f7a616e109..9006df8ed04 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex @@ -70,11 +70,15 @@ sort={2}, plural={bravoes}, parent=bravo} -\newglossaryentry{seal}{name=seal,description={sea mammal with -flippers that eats fish}} - -\newglossaryentry{sealion}{name={sea lion}, -description={large seal}} +\newglossaryentry{seal}{% + name=seal,% + description={sea mammal with flippers that eats fish} +} + +\newglossaryentry{sealion}{% + name={sea lion},% + description={large seal}% +} \begin{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf index 3bbbc1c8b36..e003b2a9dcd 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 43e5e28a3e0..d423e5af5f2 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 6988d5eb08d..5567e4c3f44 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 62857b47426..4ad586d6272 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 751f890eea0..47c7cb598f8 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 e28564ef030..78f269bb7ba 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 7c7ae156f7c..5dea94737c9 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex index 715bdc504d3..9fb85acaad9 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex @@ -31,11 +31,11 @@ sort=Gamma} \newglossaryentry{gamma}{name={\ensuremath{\gamma(\alpha,x)}}, description=Incomplete gamma function, -sort=gamma} +sort=gamma1} \newglossaryentry{iGamma}{name={\ensuremath{\Gamma(\alpha,x)}}, description=Incomplete gamma function, -sort=Gamma} +sort=Gamma2} \newglossaryentry{psi}{name=\ensuremath{\psi(x)}, description=Psi function,sort=psi} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf index a61e559b22f..9cb8cd818df 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 0853be56835..5a4ca148e2a 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 3a6ec86b528..29104b21cb8 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 5a5bcaeff51..044d2111c85 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 de299908d5e..6b41bcda0a4 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 c6f4ab12b6e..5411dbaa266 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 1cb92a7afc7..a7d12becfc6 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 c1a5862b401..40315ec6a56 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 da0425f3988..d905a69c5e8 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 89443539238..93230a93a8d 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/sampleutf8.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex index fc01afc87e6..ae3fea7ed0f 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex @@ -39,6 +39,7 @@ description=instrument for measuring distance travelled by a wheeled vehicle} \newglossaryentry{oesophagus}{name={{Å“}sophagus}, +plural={{Å“}sophagi}, description={canal from mouth to stomach}} \newglossaryentry{ogre}{name=ogre, diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf index fa0ea98702f..f9814f9c7bb 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 3707e9ec010..9817366968f 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