This is the user manual for the glossaries package. Other documents accompanying this manual:
See the file INSTALL for installation instructions. Related web resources:
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 used1 in the document will be added to the glossary.
This package replaces the glossary package which is now obsolete. Please see the document “Upgrading from the glossary package to the glossaries package” for assistance in upgrading.
One of the strengths of this package is its flexibility, however the drawback of this is the necessity of having a large manual that 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.
This manual is structured as follows:
The PDF version of this manual also describes more advanced commands in the documented code section (such as determining if an entry or a glossary exists and commands that iterate through defined terms or glossaries).
The remainder of this introductory section covers the following:
The glossaries package is provided with some sample documents that illustrate the
various functions. These should be located in the samples subdirectory (folder) of
the glossaries documentation directory. This location varies according to your
operating system and TEX distribution. You can use texdoc to locate the main
glossaries documentation. For example, in a terminal or command prompt, type:
texdoc -l glossaries
If you can’t find the sample files, they are available in the subdirectory doc/latex/glossaries/samples/ in the glossaries.tds.zip archive which can be downloaded from CTAN.
The sample documents are as follows:
If you get a Missing \begin{document} error, then it’s most likely that your version of xkeyval is out of date. Check the log file for a warning of that nature. If this is the case, you will need to update the xkeyval package.
perl makeglossaries minimalgls
makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls
minimalgls.glo
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.
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.
it will set the style file to samplexdy-mc.xdy instead. This provides an additional letter group for entries starting with “Mc” or “Mac”. If you use makeglossaries, you don’t need to supply any additional information. If you don’t use makeglossaries, you will need to specify the required information. Note that if you set the style file to samplexdy-mc.xdy you must also specify \noist, otherwise the glossaries package will overwrite samplexdy-mc.xdy and you will lose the “Mc” letter group.
To create the document do:
latex samplexdy
makeglossaries samplexdy
latex samplexdy
xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o
samplexdy.gls samplexdy.glo
xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls
samplexdy.glo
xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o
sampleutf8.gls sampleutf8.glo
If you remove the xindy option from sampleutf8.tex and do:
latex sampleutf8
makeglossaries sampleutf8
latex sampleutf8
makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls
sampleutf8.glo
As from version 1.17, the glossaries package can now be used with xindy as well as makeindex. If you are writing in a language that uses accented characters or non-Latin characters it is recommended that you use xindy as makeindex is hard-coded for Latin languages. This means that you are not restricted to the A, …, Z letter groups. If you want to use xindy, remember to use the xindy package option. For example:
If you use the inputenc package, makeglossaries will pick up the encoding from the auxiliary file. If you use xindy explicitly instead of via makeglossaries, you may need to specify the encoding using the -C option. Read the xindy manual for further details.
As from version 1.08, the glossaries package now has limited multi-lingual support, thanks to all the people who have sent me the relevant translations either via email or via comp.text.tex. However you must load babel or polyglossia before glossaries to enable this. Note that if babel is loaded and the translator package is detected on TEX’s path, then the translator package will be loaded automatically. However, it may not pick up on the required languages so, if the predefined text is not translated, you may need to explicitly load the translator package with the required languages. For example:
Alternatively, specify the language as a class option rather than a package option. For example:
If you want to use ngerman or german instead of babel, you will need to include the translator package to provide the translations. For example:
The languages are currently supported by the glossaries package are listed in table 1.
| Language | As from version |
| Brazilian Portuguese | 1.17 |
| Danish | 1.08 |
| Dutch | 1.08 |
| English | 1.08 |
| French | 1.08 |
| German | 1.08 |
| Irish | 1.08 |
| Italian | 1.08 |
| Hungarian | 1.08 |
| Polish | 1.13 |
| Serbian | 2.06 |
| Spanish | 1.08 |
The language dependent commands and translator keys used by the glossaries package are listed in table 2.
Due to the varied nature of glossaries, it’s likely that the predefined translations may not be appropriate. If you are using the babel package and do not have the translator package installed, you need to be familiar with the advice given in changing the words babel uses. If you have the translator package installed, then you can provide your own dictionary with the necessary modifications (using \deftranslation) and load it using \usedictionary. Note that the dictionaries are loaded at the beginning of the document, so it won’t have any effect if you put \deftranslation in the preamble. It should be put in your personal dictionary instead. See the translator documentation for further details.
If you are using babel and don’t want to use the translator interface, you can suppress it using the package option translate=false, and either load glossaries-babel after glossaries or specify you’re own translations. For example:
or:
If you are using polyglossia instead of babel, glossaries-polyglossia will automatically be loaded unless you specify the package option translate=false.
Note that xindy provides much better multi-lingual support than makeindex, so it’s recommended that you use xindy if you have glossary entries that contain diacritics or non-Roman letters. See §2.8.2 Xindy for further details.
In order to generate a sorted glossary with compact location lists, it is necessary to use an external indexing application as an intermediate step. It is this application that creates the file containing the code that typesets the glossary. If this step is omitted, the glossaries will not appear in your document. The two indexing applications that are most commonly used with LATEX are makeindex and xindy. As from version 1.17, the glossaries package can be used with either of these applications. Previous versions were designed to be used with makeindex only. Note that xindy has much better multi-lingual support than makeindex, so xindy is recommended if you’re not writing in English. Commands that only have an effect when xindy is used are described in §2.8.2 Xindy.
The glossaries package comes with the Perl script makeglossaries which will run makeindex or xindy on all the glossary files using a customized style file (which is created by \makeglossaries). See §1.3.1 Using the makeglossaries Perl Script for further details. Perl is stable, cross-platform, open source software that is used by a number of TEX-related applications. Further information is available at http://www.perl.org/about.html. However, whilst it is strongly recommended that you use the makeglossaries script, it is possible to use the glossaries package without having Perl installed. In which case, if you have used the xindy package option, you will need to use xindy (see §1.3.2 Using xindy explicitly), otherwise you will need to use makeindex (see §1.3.3 Using makeindex explicitly). Note that some commands and package options have no effect if you don’t use makeglossaries. These are listed in table 3.
Note that if any of your entries use an entry that is not referenced outside the glossary, you will need to do an additional makeglossaries, makeindex or xindy run, as appropriate. For example, suppose you have defined the following entries:
and suppose you have \gls{citrusfruit} in your document but don’t reference the
orange entry, then the orange entry won’t appear in your glossary until you first
create the glossary and then do another run of makeglossaries, makeindex or
xindy. For example, if the document is called myDoc.tex, then you must do:
latex myDoc
makeglossaries myDoc
latex myDoc
makeglossaries myDoc
latex myDoc
Likewise, an additional makeglossaries and LATEX run may be required if the document pages shift with re-runs. For example, if the page numbering is not reset after the table of contents, the insertion of the table of contents on the second LATEX run may push glossary entries across page boundaries, which means that the number lists in the glossary may need updating.
The examples in this document assume that you are accessing makeglossaries, xindy or makeindex via a terminal. Windows users can use the MSDOS Prompt which is usually accessed via the Start->All Programs menu or Start->All Programs->Accessories menu.
Alternatively, your text editor may have the facility to create a function that will call the required application. The article “Glossaries, Nomenclature, List of Symbols and Acronyms” in the LATEX Community’s Know How section describes how to do this for TeXnicCenter, and the thread “Executing Glossaries’ makeindex from a WinEdt macro” on the comp.text.tex newsgroup describes how to do it for WinEdt. For other editors see the editor’s user manual for further details.
If any problems occur, remember to check the transcript files (e.g. .glg or .alg) for messages.
The makeglossaries script picks up the relevant information from the auxiliary (.aux)
file and will either call xindy or makeindex, depending on the supplied information.
Therefore, you only need to pass the document’s name without the extension to
makeglossaries. For example, if your document is called myDoc.tex, type the
following in your terminal:
latex myDoc
makeglossaries myDoc
latex myDoc
perl makeglossaries myDoc
The makeglossaries script contains POD (Plain Old Documentation). If you want, you can create a man page for makeglossaries using pod2man and move the resulting file onto the man path.
If you want to use xindy to process the glossary files, you must make sure you have used the xindy package option:
This is required regardless of whether you use xindy explicitly or whether it’s called implicitly via makeglossaries. This causes the glossary entries to be written in raw xindy format, so you need to use -I xindy not -I tex.
To run xindy type the following in your terminal (all on one line):
xindy -L ⟨language⟩ -C ⟨encoding⟩ -I xindy -M ⟨style⟩ -t ⟨base⟩.glg -o
⟨base⟩.gls ⟨base⟩.glo
For example, if your document is called myDoc.tex and you are using UTF8
encoding in English, then type the following in your terminal:
xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls
myDoc.glo
Note that this just creates the main glossary. You need to do the same for each of
the other glossaries (including the list of acronyms if you have used the acronym
package option), substituting .glg, .gls and .glo with the relevant extensions. For
example, if you have used the acronym package option, then you would need to do:
xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr
myDoc.acn
Note that if you use makeglossaries instead, you can replace all those calls to
xindy with just one call to makeglossaries:
makeglossaries myDoc
If you want to use makeindex explicitly, you must make sure that you haven’t used the
xindy package option or the glossary entries will be written in the wrong format. To run
makeindex, type the following in your terminal:
makeindex -s ⟨style⟩.ist -t ⟨base⟩.glg -o ⟨base⟩.gls ⟨base⟩.glo
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
makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn
Note that if you use makeglossaries instead, you can replace all those calls to
makeindex with just one call to makeglossaries:
makeglossaries myDoc
The information needed to determine whether to use xindy or makeindex and the information needed to call those applications is stored in the auxiliary file. This information can be gathered by a front-end, editor or script to make the glossaries where appropriate. This section describes how the information is stored in the auxiliary file.
The file extensions used by each defined glossary are given by
where ⟨in-ext⟩ is the extension of the indexing application’s input file (the output file from the glossaries package’s point of view), ⟨out-ext⟩ is the extension of the indexing application’s output file (the input file from the glossaries package’s point of view) and ⟨log⟩ is the extension of the indexing application’s transcript file. The label for the glossary is also given for information purposes only, but is not required by the indexing applications. For example, the information for the main glossary is written as:
The indexing application’s style file is specified by
The file extension indicates whether to use makeindex (.ist) or xindy (.xdy). Note that the glossary information is formatted differently depending on which indexing application is supposed to be used, so it’s important to call the correct one.
Word or letter ordering is specified by:
where ⟨order⟩ can be either word or letter.
If xindy should be used, the language and code page for each glossary is specified by
where ⟨label⟩ identifies the glossary, ⟨language⟩ is the root language (e.g. english) and ⟨code⟩ is the encoding (e.g. utf8). These commands are omitted if makeindex should be used.
The glossaries package comes with a minimal file called minimalgls.tex which can be used for testing. This should be located in the samples subdirectory (folder) of the glossaries documentation directory. The location varies according to your operating system and TEX installation. For example, on my Linux partition it can be found in /usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/. Further information on debugging LATEX code is available at http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/.
Below is a list of the most frequently asked questions. For other queries, consult the glossaries FAQ at http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html.
A. Check you are using an up to date version of the xkeyval package.
A. The smallcaps package option uses \textsc to typeset the acronyms. This command converts lower case letters to small capitals, while upper case letters remain their usual size. Therefore you need to specify the acronym in lower case letters.
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.
A. The easiest way to do this is to specify the smaller package option and redefine \acronymfont to use the required typesetting command. For example, suppose you would like the acronyms displayed in a sans-serif font, then you can do:
A. The easiest way to do this is to specify the smaller package option and redefine \firstacronymfont to use the required command. Note that if you don’t want the acronym on subsequent use to use \textsmaller, you will also need to redefine \acronymfont, as above. For example to make the acronym emphasized on first use, but use the surrounding font for subsequent use, you can do:
A. Although it is strongly recommended that you use makeglossaries, you don’t have to use it. For further details, read §1.3.2 Using xindy explicitly or §1.3.3 Using makeindex explicitly, depending on whether you want to use xindy or makeindex.
A. Read “Upgrading from the glossary package to the glossaries package” which should be available from the same location as this document.
A. The glossaries package currently only supports the following languages: Brazilian Portuguese, Danish, Dutch, English, French, German, Irish, Italian, Hungarian, Polish, Serbian and Spanish. If you want to add another language, send me the translations, and I’ll add them to the next version.
If you are using one of the above languages, but the text hasn’t been translated, try adding the translator package with the required languages explicitly (before you load the glossaries package). For example:
Alternatively, you can add the language as a global option to the class file. Check the translator package documentation for further details.
A. Switch off the sanitization:
and protect fragile commands.
A. Remember to do the following:
A. If it’s for an individual entry, then you can use the entry’s sort key to sort it according to a different term. If it’s for the entire alphabet, then you will need to use xindy (instead of makeindex) and use an appropriate xindy language module. Writing xindy modules or styles is beyond the scope of this manual. Further information about xindy can be found at the Xindy Web Site. There is also a link to the xindy mailing list from that site.
This section is an overview of the main user commands and package options. If you find this too complicated, try starting out with the guide for beginners.
The glossaries package options are as follows:
and
If the acronym package option is used, \acronymtype is set to acronym otherwise it is set to main.2 Entries that are defined using \newacronym are placed in the glossary whose label is given by \acronymtype, unless another glossary is explicitly specified.
No check is performed to determine if the listed glossaries exist, so you can add glossaries you haven’t defined yet. For example:
You can omit the value if you want to use sections, i.e.
is equivalent to
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
This defaults to \@mkboth, but you may need to redefine it. For example, to only change the right header:
or to prevent it from changing the headers:
Occasionally you may find that another package defines \cleardoublepage when it is not required. This may cause an unwanted blank page to appear before each glossary. This can be fixed by redefining \glsclearpage:
then each glossary will appear in a numbered section, and can be referenced using something like:
If you can’t decide whether to have the acronyms in the main glossary or a separate list of acronyms, you can use \acronymtype which is set to main if the acronym option is not used and is set to acronym if the acronym option is used. For example:
As from version 1.14, you can add a prefix to the label by redefining
For example:
will add glo: to the automatically generated label, so you can then, for example, refer to the list of acronyms as follows:
Or, if you are undecided on a prefix:
You can use sanitize=none as a shortcut for
sanitize={name=false,description=false,symbol=false}.
The xindy package option may additionally have a value that is a ⟨key⟩=⟨value⟩ comma-separated list to override the language and codepage. For example:
You can also specify whether you want a number group in the glossary. This defaults to true, but can be suppressed. For example:
See §2.8.2 Xindy for further details on using xindy with the glossaries package.
See §1.2.1 Changing the Fixed Names for further details.
All glossary entries must be defined before they are used, so it is better to define them in the preamble to ensure this.4 However only those entries that occur in the document (using any of the commands described in §2.4 Links to Glossary Entries, §2.5 Adding an Entry to the Glossary Without Generating Text or §2.6 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. See §1.3 Generating the Associated Glossary Files for further details.
The command
must be placed in the preamble in order to create the customised makeindex (.ist) or xindy (.xdy) style file and to ensure that glossary entries are written to the appropriate output files. If you omit \makeglossaries none of the glossaries will be created.
You can suppress the creation of the customised xindy or makeindex style file using
Note that this command must be used before \makeglossaries.
The default name for the customised style file is given by \jobname.ist (for makeindex) or \jobname.xdy (for xindy). This name may be changed using:
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 number list that lists all the locations in the document where that entry was used. By default, the location refers to the page number but this may be overridden using the counter package option. The default form of the location number assumes a full stop compositor (e.g. 1.2), but if your location numbers use a different compositor (e.g. 1-2) you need to set this using
For example:
Note that this command must be used before \makeglossaries.
If you use xindy, you can have a different compositor for page numbers starting with an uppercase alphabetical character using:
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:
See §2.3 Number lists for further information about number lists.
New glossary entries are defined using the command:
The first argument, ⟨label⟩, must be a unique label with which to identify this entry. The second argument, ⟨key-val list⟩, is a ⟨key⟩=⟨value⟩ list that supplies the relevant information about this entry. There are two required fields: description and either name or parent. Available fields are listed below:
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
However, note that not all glossary styles support multi-line descriptions. If you are using one of the tabular-like glossary styles that permit multi-line descriptions, use \newline not \\ if you want to force a line break.
Note: prior to version 1.13, the default value of firstplural was always taken by appending “s” to the first key, which meant that you had to specify both plural and firstplural, even if you hadn’t used the first key.
Note that if the name starts with an accented letter or non-Latin character, you must group the accented letter, otherwise it will cause a problem for commands like \Gls and \Glspl. For example:
Note that the same applies if you are using the inputenc package:
Note that in both of the above examples, you will also need to supply the sort key if you are using makeindex whereas xindy is usually able to sort accented letters correctly.
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
to the singular form. This command defaults to the letter “s”. For example:
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:
If you are writing in a language that supports multiple plurals (for a given term) then use the plural key for one of them and one of the user keys to specify the other plural form. For example:
You can then use \glspl{cow} to produce “cows” and \glsuseri{cow} to produce “kine”. You can, of course, define an easy to remember synonym. For example:
Then you don’t have to remember which key you used to store the alternative plural.
If you are using a language that usually forms plurals by appending a different letter, or sequence of letters, you can redefine \glspluralsuffix as required. However, this must be done before the entries are defined. For languages that don’t form plurals by simply appending a suffix, all the plural forms must be specified using the plural key (and the firstplural key where necessary).
As from version 1.17, it is possible to specify sub-entries. These may be used to order the glossary into categories, in which case the sub-entry will have a different name to its parent entry, or it may be used to distinguish different definitions for the same word, in which case the sub-entries will have the same name as the parent entry. Note that not all glossary styles support hierarchical entries and may display all the entries in a flat format. Of the styles that support sub-entries, some display the sub-entry’s name whilst others don’t. Therefore you need to ensure that you use a suitable style. See §2.12 Glossary Styles for a list of predefined styles.
Note that the parent entry will automatically be added to the glossary if any of its child entries are used in the document. If the parent entry is not referenced in the document, it will not have a number list.
Hierarchical Categories To arrange a glossary with hierarchical categories, you need to first define the category and then define the sub-entries using the relevant category entry as the value of the parent key. For example, suppose I want a glossary of mathematical symbols that are divided into Greek letters and Roman letters. Then I can define the categories as follows:
Note that in this example, the category entries don’t need a description so I have set the descriptions to \nopostdesc. This gives a blank description and suppresses the description terminator.
I can now define my sub-entries as follows:
Homographs Sub-entries that have the same name as the parent entry, don’t need to have the name key. For example, the word “glossary” can mean a list of technical words or a collection of glosses. In both cases the plural is “glossaries”. So first define the parent entry:
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:
Note that if I reference the parent entry, the location will be added to the parent’s number list, whereas if I reference any of the child entries, the location will be added to the child entry’s number list. Note also that since the sub-entries have the same name, the sort key is required.
In the above example, the plural form for both of the child entries is the same as the parent entry, so the plural key was not required for the child entries. However, if the sub-entries have different plurals, they will need to be specified. For example:
You can store all your glossary entry definitions in another file and use:
where ⟨filename⟩ is the name of the file containing all the \newglossaryentry commands. The optional argument ⟨type⟩ is the name of the glossary to which those entries should belong, for those entries where the type key has been omitted (or, more specifically, for those entries whose type has been specified by \glsdefaulttype, which is what \newglossaryentry uses by default). For example, suppose I have a file called myentries.tex which contains:
and suppose in my document preamble I use the command:
then this will add the entries tex and html to the glossary whose type is given by languages, but the entry perl will be added to the main glossary, since it explicitly sets the type to main.
Note: if you use \newacronym (see §2.10 Acronyms) the type is set as type=\acronymtype unless you explicitly override it. For example, if my file myacronyms.tex contains:
then (supposing I have defined a new glossary type called altacronym)
will add aca to the glossary type acronym, if the package option acronym has been specified, or will add aca to the glossary type altacronym, if the package option acronym is not specified.5 In this instance, it is better to change myacronyms.tex to:
and now
will add aca to the glossary type altacronym, regardless of whether or not the package option acronym is used.
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.
Each entry in the glossary has an associated number list. By default, these numbers refer to the pages on which that entry has been used (using any of the commands described in §2.4 Links to Glossary Entries and §2.5 Adding an Entry to the Glossary Without Generating Text). The number list can be suppressed using the nonumberlist package option, or an alternative counter can be set as the default using the counter package option. The number list is also referred to as the location list.
Both makeindex and xindy concatenate a sequence of 3 or more consecutive pages into a range. With xindy you can vary the minimum sequence length using \GlsSetXdyMinRangeLength{⟨n⟩} where ⟨n⟩ is either an integer or the keyword none which indicates that there should be no range formation.
With both makeindex and xindy, you can replace the separator and the closing number in the range using:
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:
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:
Note that if you use the hyperref package, you will need to use \nohyperpage in the suffix to ensure that the hyperlinks work correctly. For example:
Once you have defined a glossary entry using \newglossaryentry, you can refer to that entry in the document using one of the commands listed in this section. The text which appears at that point in the document when using one of these commands is referred to as the link text (even if there are no hyperlinks). The commands in this section also add a line to an external file that is used by makeindex or xindy to generate the relevant entry in the glossary. This information includes an associated location that is added to the number list for that entry. By default, the location refers to the page number. For further information on number lists, see §2.3 Number lists.
The above warning is particularly important if you are using the glossaries package in conjunction with the hyperref package. Instead, use one of the commands listed in §2.7 Using Glossary Terms Without Links (such as \glsentrytext) or provide an alternative via the optional argument to the sectioning/caption command. Examples:
The way the link text is displayed depends on
For example, to make all link text appear in a sans-serif font, do:
Each entry has an associated conditional referred to as the first use flag. This determines whether \gls, \glspl (and their uppercase variants) should use the value of the first or text keys. Note that an entry can be used without affecting the first use flag (for example, when used with \glslink). See §2.11 Unsetting and Resetting Entry Flags for commands that unset or reset this conditional.
The command:
will place \glstextformat{⟨text⟩} in the document at that point and add a line into the associated glossary file for the glossary entry given by ⟨label⟩. If hyperlinks are supported, ⟨text⟩ will be a hyperlink to the relevant line in the glossary. (Note that this command doesn’t affect the first use flag: use \glsdisp instead.) The optional argument ⟨options⟩ must be a ⟨key⟩=⟨value⟩ list which can take any of the following keys:
and use that command.
In this document, the standard formats refer to the standard text block commands such as \textbf or \emph or any of the commands listed in table 4.
Note that unlike \index, you can’t have anything following the command name, such as an asterisk or arguments. If you want to cross-reference another entry, either use the see key when you define the entry or use \glssee (described in §2.6 Cross-Referencing Entries).
If you are using hyperlinks and you want to change the font of the hyperlinked location, don’t use \hyperpage (provided by the hyperref package) as the locations may not refer to a page number. Instead, the glossaries package provides number formats listed in table 4.
Note that if the \hyperlink command hasn’t been defined, the hyper⟨xx⟩ formats are equivalent to the analogous text⟨xx⟩ font commands (and hyperemph is equivalent to emph). If you want to make a new format, you will need to define a command which takes one argument and use that. For example, if you want the location number to be in a bold sans-serif font, you can define a command called, say, \hyperbsf:
and then use hyperbsf as the value for the format key. Remember that if you use xindy, you will need to add this to the list of location attributes:
There is also a starred version:
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.
The command:
is the same as \glslink, except that the link text is determined from the values of the text and first keys supplied when the entry was defined using \newglossaryentry. If the entry has been marked as having been used, the value of the text key will be used, otherwise the value of the first key will be used. On completion, \gls will mark the entry’s first use flag as used.
There are two uppercase variants:
and
which make the first letter of the link text or all the link text uppercase, respectively.
The final optional argument ⟨insert⟩, allows you to insert some additional text into the link text. By default, this will append ⟨insert⟩ at the end of the link text, but this can be changed (see §2.4.1 Changing the format of the link text).
The first optional argument ⟨options⟩ is the same as the optional argument to \glslink. As with \glslink, these commands also have a starred version that disable the hyperlink.
There are also analogous plural forms:
These determine the link text from the plural and firstplural keys supplied when the entry was first defined. As before, these commands also have a starred version that disable the hyperlink.
Note that \glslink doesn’t use or affect the first use flag, nor does it use \glsdisplay or \glsdisplayfirst (see §2.4.1 Changing the format of the link text). Instead, you can use:
This behaves in the same way as \gls, except that it uses ⟨link text⟩ instead of the value of the first or text key. (Note that this command always sets ⟨insert⟩ to nothing.) This command affects the first use flag, and uses \glsdisplay or \glsdisplayfirst.
The command:
is similar to \gls except that it always uses the value of the text key and does not affect the first use flag. Unlike \gls, the inserted text ⟨insert⟩ is always appended to the link text since \glstext doesn’t use \glsdisplay or \glsdisplayfirst. (The same is true for all the following commands described in this section.)
There are also analogous commands:
As before, these commands also have a starred version that disable the hyperlink.
The command:
is similar to \glstext except that it always uses the value of the first key. Again, ⟨insert⟩ is always appended to the end of the link text and does not affect the first use flag.
There are also analogous commands:
As before, these commands also have a starred version that disable the hyperlink.
The command:
is similar to \glstext except that it always uses the value of the plural key. Again, ⟨insert⟩ is always appended to the end of the link text and does not mark the entry as having been used.
There are also analogous commands:
As before, these commands also have a starred version that disable the hyperlink.
The command:
is similar to \glstext except that it always uses the value of the firstplural key. Again, ⟨insert⟩ is always appended to the end of the link text and does not mark the entry as having been used.
There are also analogous commands:
As before, these commands also have a starred version that disable the hyperlink.
The command:
is similar to \glstext except that it always uses the value of the name key. Again, ⟨insert⟩ is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the name key contains commands, you will have to disable the sanitization of the name key and protect fragile commands.
There are also analogous commands:
As before, these commands also have a starred version that disable the hyperlink.
The command:
is similar to \glstext except that it always uses the value of the symbol key. Again, ⟨insert⟩ is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the symbol key contains commands, you will have to disable the sanitization of the symbol key and protect fragile commands.
There are also analogous commands:
As before, these commands also have a starred version that disable the hyperlink.
The command:
is similar to \glstext except that it always uses the value of the description key. Again, ⟨insert⟩ is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the description key contains commands, you will have to disable the sanitization of the description key and protect fragile commands.
There are also analogous commands:
As before, these commands also have a starred version that disable the hyperlink.
The command:
is similar to \glstext except that it always uses the value of the user1 key. Again, ⟨insert⟩ is always appended to the end of the link text and does not mark the entry as having been used.
There are also analogous commands:
As before, these commands also have a starred version that disable the hyperlink. Similarly for the other user keys:
The format of the link text for \gls, \glspl and their uppercase variants is governed by two commands:
which is used the first time a glossary entry is used in the text and
which is used subsequently. Both commands take four arguments: the first is either the singular or plural form given by the text, plural, first or firstplural keys (set when the term was defined) depending on context; the second argument is the term’s description (as supplied by the description or descriptionplural keys); the third argument is the symbol associated with the term (as supplied by the symbol or symbolplural keys) and the fourth argument is the additional text supplied in the final optional argument to \gls or \glspl (or their uppercase variants). The default definitions of \glsdisplay and \glsdisplayfirst simply print the first argument immediately followed by the fourth argument. The remaining arguments are ignored.
If required, you can access the label for the given entry via
so it is possible to use this label in the definition of \glsdisplay or \glsdisplayfirst to supply additional information using any of the commands described in §2.7 Using Glossary Terms Without Links, if required.
Note that \glsdisplay and \glsdisplayfirst are not used by \glslink. If you want to supply your own link text, you need to use \glsdisp instead.
For example, suppose you want a glossary of measurements and units, you can use the symbol key to store the unit:
and now suppose you want \gls{distance} to produce “distance (km)” on first use, then you can redefine \glsdisplayfirst as follows:
Note that the additional text is placed after #1, so \gls{distance}[’s] will produce “distance’s (km)” rather than “distance (km)’s” which looks a bit odd (even though it may be in the context of “the distance (km) is measured between the two points” — but in this instance it would be better not to use a contraction).
Note also that all of the link text will be formatted according to \glstextformat (described earlier). So if you do, say:
then \gls{distance} will produce “distance (km)”.
If you have multiple glossaries, changing \glsdisplayfirst and \glsdisplay will change the way entries for all of the glossaries appear when using the commands \gls, \glspl, their uppercase variants and \glsdisp. If you only want the change to affect entries for a given glossary, then you need to use
and
instead of redefining \glsdisplay and \glsdisplayfirst.
Both \defglsdisplay and \defglsdisplayfirst take two arguments: the first (which is optional) is the glossary’s label6 and the second is how the term should be displayed when it is invoked using commands \gls, \glspl, their uppercase variants and \glsdisp. This is similar to the way \glsdisplayfirst was redefined above.
For example, suppose you have created a new glossary called notation and you want to change the way the entry is displayed on first use so that it includes the symbol, you can do:
Now suppose you have defined an entry as follows:
The first time you reference this entry it will be displayed as: “set (denoted S)” (assuming \gls was used).
Remember that if you use the symbol key, you need to use a glossary style that displays the symbol, as many of the styles ignore it. In addition, if you want either the description or symbol to appear in the link text, you will have to disable the sanitization of these keys and protect fragile commands.
If you load the hyperref or html packages prior to loading the glossaries package, commands such as \glslink and \gls, described above, will automatically have hyperlinks to the relevant glossary entry, unless the hyper option has been set to false. You can disable or enable links using:
and
respectively. The effect can be localised by placing the commands within a group. Note that you should only use \glsenablehyper if the commands \hyperlink and \hypertarget have been defined (for example, by the hyperref package).
You can disable just the first use links using the package option hyperfirst=false. Note that this option only affects commands that recognise the first use flag, for example \gls, \glspl and \glsdisp but not \glslink.
It is possible to add a line in the glossary file without generating any text at that point in the document using:
This is similar to \glslink, only it doesn’t produce any text (so therefore, there is no hyper key available in ⟨options⟩ but all the other options that can be used with \glslink can be passed to \glsadd). For example, to add a page range to the glossary number list for the entry whose label is given by set:
To add all entries that have been defined, use:
The optional argument is the same as for \glsadd, except there is also a key types which can be used to specify which glossaries to use. This should be a comma separated list. For example, if you only want to add all the entries belonging to the list of acronyms (specified by the glossary type \acronymtype) and a list of notation (specified by the glossary type notation) then you can do:
There are several ways of cross-referencing entries in the glossary:
Note that with this method, if you don’t use the cross-referenced term in the
glossary, you will need two runs of makeglossaries:
latex filename
makeglossaries filename
latex filename
makeglossaries filename
latex filename
Note that in this case, the entry with the see key will automatically be added to the glossary, but the cross-referenced entry won’t. You therefore need to ensure that you use the cross-referenced term with the commands described in §2.4 Links to Glossary Entries or §2.5 Adding an Entry to the Glossary Without Generating Text.
You can optionally override the “see” tag using square brackets at the start of the see value. For example:
where ⟨xr label list⟩ is a comma-separated list of entry labels to be cross-referenced, ⟨label⟩ is the label of the entry doing the cross-referencing and ⟨tag⟩ is the “see” tag. For example:
Note that this automatically adds the entry given by ⟨label⟩ to the glossary but doesn’t add the cross-referenced entries (specified by ⟨xr label list⟩) to the glossary.
In both cases 2 and 3 above, the cross-referenced information appears in the number list, whereas in case 1, the cross-referenced information appears in the description. In cases 2 and 3, the default text for the “see” tag is given by \seename.
The commands described in this section display entry details without adding any information to the glossary. They don’t use \glstextformat, they don’t have any optional arguments, they don’t affect the first use flag and, apart from \glshyperlink, they don’t produce hyperlinks.
These commands display the name of the glossary entry given by ⟨label⟩, as specified by the name key. \Glsentryname makes the first letter uppercase.
These commands display the subsequent use text for the glossary entry given by ⟨label⟩, as specified by the text key. \Glsentrytext makes the first letter uppercase.
These commands display the subsequent use plural text for the glossary entry given by ⟨label⟩, as specified by the plural key. \Glsentryplural makes the first letter uppercase.
These commands display the first use text for the glossary entry given by ⟨label⟩, as specified by the first key. \Glsentryfirst makes the first letter uppercase.
These commands display the plural form of the first use text for the glossary entry given by ⟨label⟩, as specified by the firstplural key. \Glsentryfirstplural makes the first letter uppercase.
These commands display the description for the glossary entry given by ⟨label⟩. \Glsentrydesc makes the first letter uppercase.
These commands display the plural description for the glossary entry given by ⟨label⟩. \Glsentrydescplural makes the first letter uppercase.
These commands display the symbol for the glossary entry given by ⟨label⟩. \Glsentrysymbol makes the first letter uppercase.
These commands display the plural symbol for the glossary entry given by ⟨label⟩. \Glsentrysymbolplural makes the first letter uppercase.
These commands display the value of the user keys for the glossary entry given by ⟨label⟩.
This command provides a hyperlink to the glossary entry given by ⟨label⟩ but does not add any information to the glossary file. The link text is given by \glsentryname{⟨label⟩} by default, but can be overridden using the optional argument.
For further information see the section “Displaying entry details without adding information to the glossary” in the document glossaries.pdf.
The command
will display all the glossaries in the order in which they were defined. Note that no glossaries will appear until you have either used the Perl script makeglossaries or have directly used makeindex or xindy (as described in §1.3 Generating the Associated Glossary Files). If the glossary still does not appear after you re-LATEX your document, check the makeindex/xindy log files to see if there is a problem. Remember that you also need to use the command \makeglossaries in the preamble to enable the glossaries.
An individual glossary can be displayed using:
where ⟨options⟩ is a ⟨key⟩=⟨value⟩ list of options. The following keys are available:
By default, the glossary is started either by \chapter* or by \section*, depending on whether or not \chapter is defined. This can be overridden by the section package option or the \setglossarysection command. Numbered sectional units can be obtained using the numberedsection package option. Each glossary sets the page header via the command \glossarymark. If this mechanism is unsuitable for your chosen class file or page style package, you will need to redefine \glossarymark. Further information about these options and commands is given in §2.1 Package Options.
Information can be added to the start of the glossary (after the title and before the main body of the glossary) by redefining
For example:
This needs to be done before the glossary is displayed using \printglossaries or \printglossary. Note that if you want a different preamble for each glossary, you will need to use a separate \printglossary for each glossary and change the definition of \glossarypreamble between each glossary. For example:
Alternatively, you can do something like:
which will print the preamble text for the first glossary and change the preamble to do nothing for subsequent glossaries. (Note that \gdef is required as the glossary is placed within a group.)
There is an analogous command called
which is placed at the end of each glossary.
Within each glossary, each entry name is formatted according to
which takes one argument: the entry name. This command is always used regardless of the glossary style. By default, \glsnamefont simply displays its argument in whatever the surrounding font happens to be. This means that in the list-like glossary styles (defined in the glossary-list style file) the name will appear in bold, since the name is placed in the optional argument of \item, whereas in the tabular styles (defined in the glossary-long and glossary-super style files) the name will appear in the normal font. The hierarchical glossary styles (defined in the glossary-tree style file) also set the name in bold.
For example, suppose you want all the entry names to appear in medium weight small caps, then you can do:
If you want to use xindy to sort the glossary, you must use the package option xindy:
This ensures that the glossary information is written in xindy syntax.
§1.3 Generating the Associated Glossary Files covers how to use the external indexing application. This section covers the commands provided by the glossaries package that allow you to adjust the xindy style file (.xdy) and parameters.
To assist writing information to the xindy style file, the glossaries package provides the following commands:
which produce an open and closing brace. (This is needed because \{ and \} don’t expand to a simple brace character when written to a file.)
In addition, if you are using a package that makes the double quote character active (e.g. ngerman) you can use:
which will produce "⟨text⟩". Alternatively, you can use \string" to write the double-quote character. This document assumes that the double quote character has not been made active, so the examples just use " for clarity.
If you want greater control over the xindy style file than is available through the LATEX commands provided by the glossaries package, you will need to edit the xindy style file. In which case, you must use \noist to prevent the style file from being overwritten by the glossaries package. For additional information about xindy, read the xindy documentation.
Language and Encodings When you use xindy, you need to specify the language and encoding used (unless you have written your own custom xindy style file that defines the relevant alphabet and sort rules). If you use makeglossaries, this information is obtained from the document’s auxiliary (.aux) file. The glossaries package attempts to find the root language, but in the event that it gets it wrong or if xindy doesn’t support that language, then you can specify the language using:
where ⟨language⟩ is the name of the language. The optional argument can be used if you have multiple glossaries in different languages. If ⟨glossary type⟩ is omitted, it will be applied to all glossaries, otherwise the language setting will only be applied to the glossary given by ⟨glossary type⟩.
If the inputenc package is used, the encoding will be obtained from the value of \inputencodingname. Alternatively, you can specify the encoding using:
where ⟨code⟩ is the name of the encoding. For example:
Note that you can also specify the language and encoding using the package option xindy={language=⟨lang⟩,codepage=⟨code⟩}. For example:
If you write your own custom xindy style file that includes the language settings, you need to set the language to nothing:
(and remember to use \noist to prevent the style file from being overwritten).
Locations and Number lists The most likely attributes used in the format key (textrm, hyperrm etc) are automatically added to the xindy style file, but if you want to use another attribute, you need to add it using:
where ⟨name⟩ is the name of the attribute, as used in the format key. For example, suppose I want a bold, italic, hyperlinked location. I first need to define a command that will do this:
but with xindy, I also need to add this as an allowed attribute:
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.
For example, suppose you want the page numbers written as words rather than digits and you use the fmtcount package to do this. You can redefine \thepage as follows:
This gets expanded to \protect \Numberstringnum {⟨n⟩} where ⟨n⟩ is the Arabic page number. This means that you need to define a new location that has that form:
Note that it’s necessary to use \space to indicate that spaces also appear in the format, since, unlike TEX, xindy doesn’t ignore spaces after control sequences.
In the number list, the locations are sorted according to type. The default ordering is: roman-page-numbers (e.g. i), arabic-page-numbers (e.g. 1), arabic-section-numbers (e.g. 1.1 if the compositor is a full stop or 1-1 if the compositor is a hyphen7), alpha-page-numbers (e.g. a), Roman-page-numbers (e.g. I), Alpha-page-numbers (e.g. A), Appendix-page-numbers (e.g. A.1 if the Alpha compositor is a full stop or A-1 if the Alpha compositor is a hyphen8), user defined location names (as specified by \GlsAddXdyLocation in the order in which they were defined), see (cross-referenced entries). This ordering can be changed using:
where each location name is delimited by double quote marks and separated by white space. For example:
\GlsSetXdyLocationClassOrder must be used before \makeglossaries.
If a number list consists of a sequence of consecutive numbers, the range will be concatenated. The number of consecutive locations that causes a range formation defaults to 2, but can be changed using:
For example:
The argument may also be the keyword none, to indicate that there should be no range formations. See the xindy manual for further details on range formations.
\GlsSetXdyMinRangeLength must be used before \makeglossaries.
See §2.3 Number lists for further details.
Glossary Groups The glossary is divided into groups according to the first letter of the sort key. The glossaries package also adds a number group by default, unless you suppress it in the xindy package option. For example:
Any entry that doesn’t go in one of the letter groups or the number group is placed in the default group.
If you have a number group, the default behaviour is to locate it before the “A”
letter group. If you are not using a Roman alphabet, you can change this
using
\GlsSetXdyFirstLetterAfterDigits{⟨letter⟩}
\GlsSetXdyFirstLetterAfterDigits must be used before \makeglossaries.
A new glossary can be defined using:
where ⟨name⟩ is the label to assign to this glossary. The arguments ⟨in-ext⟩ and ⟨out-ext⟩ specify the extensions to give to the input and output files for that glossary, ⟨title⟩ is the default title for this new glossary and the final optional argument ⟨counter⟩ specifies which counter to use for the associated number lists (see also §2.3 Number lists). The first optional argument specifies the extension for the makeindex or xindy transcript file (this information is only used by makeglossaries which picks up the information from the auxiliary file).
Note that the main (default) glossary is automatically created as:
so it can be identified by the label main (unless the nomain package option is used). Using the acronym package option is equivalent to:
so it can be identified by the label acronym. If you are not sure whether the acronym option has been used, you can identify the list of acronyms by the command \acronymtype \acronymtype which is set to acronym, if the acronym option has been used, otherwise it is set to main. Note that if you are using the main glossary as your list of acronyms, you need to declare it as a list of acronyms using the package option acronymlists.
You may have noticed in §2.2 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:
By default, this is equivalent to:
\newglossaryentry{⟨label⟩}{type=\acronymtype,
name={⟨abbrv⟩},
description={⟨long⟩},
text={⟨abbrv⟩},
first={⟨long⟩ (⟨abbrv⟩)},
plural={⟨abbrv⟩\glspluralsuffix},
firstplural={⟨long⟩\glspluralsuffix\space (⟨abbrv⟩\glspluralsuffix)},
⟨key-val list⟩}
For example, the following defines the acronym IDN:
This is equivalent to:
so \gls{idn} will produce “identification number (IDN)” on first use and “IDN” on subsequent uses.
This section describes acronyms that have been defined using \newacronym. If you prefer to define your acronyms using \newglossaryentry explicitly, then you should skip this section and ignore the package options: smallcaps, smaller, description, dua and footnote, as these options change the definition of \newacronym for common acronym formats as well as the way that the link text is displayed (see §2.4.1 Changing the format of the link text). Likewise you should ignore the package option shortcuts and the new commands described in this section, such as \acrshort, as they vary according to the definition of \newacronym.
If you want to define your own custom acronym style, see §2.10.1 Defining A Custom Acronym Style.
If you use any of the package options smallcaps, smaller, description or footnote, the acronyms will be displayed in the document using:
and
where \firstacronymfont is applied on first use and \acronymfont is applied on subsequent use. Note that if you don’t use any of the above package options, changing the definition of \acronymfont or \firstacronymfont will have no effect. In this case, the recommended route is to use either the smaller or the smallcaps package option and redefine \acronymfont and \firstacronymfont as required. (The smallcaps option sets the default plural suffix in an upright font to cancel the effect of \textsc, whereas smaller sets the suffix in the surrounding font.) For example, if you want acronyms in a normal font on first use and emphasized on subsequent use, do:
(Note that it is for this reason that the relsize package is not automatically loaded when selecting the smaller package option.)
Table 5 lists the package options that govern the acronym styles and how the \newglossaryentry keys are used to store ⟨long⟩ (the long form) and ⟨abbrv⟩ (the short form). Note that the smallcaps option redefines \acronymfont so that it sets its argument using \textsc (so you should use lower case characters in ⟨abbrv⟩) and the smaller option redefines \acronymfont to use \textsmaller,9 otherwise \acronymfont simply displays its argument in the surrounding font.
In case you can’t remember which key stores the long or short forms (or their plurals) the glossaries package provides the commands:
These can be used in the optional argument of \newacronym to override the defaults. For example:
If the first use uses the plural form, \glspl{dm} will display: diagonal matrices (DMs).
Each of the package options smallcaps, smaller, footnote, dua and description use \defglsdisplay and \defglsdisplayfirst (described in §2.4.1 Changing the format of the link text) to change the way the link text is displayed. This means that these package options only work for the glossary type given by \acronymtype. If you have multiple lists of acronyms, you will need to make the appropriate changes for each additional glossary type.
In this case, the long form is stored in the symbol key. This means that the long form will not be displayed in the list of acronyms unless you use a glossary style that displays the entry’s symbol (for example, the index style). Entries will be sorted according to the short form.
Note also that when these two package options are used (in the given order), the glossaries package additionally implements the sanitize option using sanitize={description=false,symbol=false}, so remember to protect fragile commands when defining acronyms.
If the description package option is also used, the name key is set to the long form, otherwise the name key is set to the short form and the description key is set to the long form. In both cases the symbol is set to the short form. Therefore, if you use the description package option and you want the short form to appear in the list of acronyms, you will need to use a glossary style that displays the entry’s symbol (for example, the index style). Entries will be sorted according to the long form if the description option is used, otherwise they will be sorted according to the short form (unless overridden by the sort key in the optional argument of \newacronym).
Note that with this option, you need to specify the description using the description key in the optional argument of \newacronym. When this option is used without the footnote or dua options, the name field is specified as
This defaults to \acronymfont{⟨short⟩}, which means that the long form will not appear in the list of acronyms by default. To change this, you need to redefine \acrnameformat as appropriate. For example, to display the long form followed by the short form in parentheses do:
Note that even if you redefine \acrnameformat, the entries will be sorted according to the short form, unless you override this using the sort key in the optional argument to \newacronym.
Note also that if this package option is used, the glossaries package additionally implements the option sanitize={description=false}, so remember to protect fragile commands when defining acronyms.
Note that on first use, it is the long form in the footnote that links to the relevant glossary entry (where hyperlinks are enabled), whereas on subsequent use, the acronym links to the relevant glossary entry. It is possible to change this to make the acronym on first use have the hyperlink instead of the footnote, but since the footnote marker will also be a hyperlink, you will have two hyperlinks in immediate succession. This can be ambiguous where the hyperlinks are coloured rather than boxed. The code required to change the first use to make the acronym a hyperlink is as follows:
Note that this involves using internal commands (i.e. commands whose name contains an @ character), so if this code is place in a .tex file it needs to be placed within a \makeatletter … \makeatother pair. (See \@ and @ in macro names for further details.)
Note also that if this package option is used, the glossaries package additionally implements the option sanitize={symbol=false}, so remember to protect fragile commands when defining acronyms.
Note also that if this package option is used, the glossaries package additionally implements the option sanitize={symbol=false}, so remember to protect fragile commands when defining acronyms.
Recall from §2.4 Links to Glossary Entries that you can access the values of individual keys using commands like \glstext, so it is possible to use these commands to print just the long form or just the abbreviation without affecting the flag that determines whether the entry has been used. However the keys that store the long and short form vary depending on the acronym style, so the glossaries package provides commands that are set according to the package options. These are as follows:
Print the abbreviated version with (if required) a hyperlink to the relevant entry in the glossary. This is usually equivalent to \glstext (or its uppercase variants) but may additionally put the link text within the argument to \acronymfont.
Print the long version with (if required) a hyperlink to the relevant entry in the glossary. This is may be equivalent to \glsdesc, \glssymbol or \glsfirst (or their uppercase variants), depending on package options.
Print the long version followed by the abbreviation in brackets with (if required) a hyperlink to the relevant entry in the glossary.
However, if you do this, you must remember to protect fragile commands when defining acronyms or glossary entries.
Note that if you change the definition of \newacronym, you may additionally need to change the above commands as well as changing the way the text is displayed using \defglsdisplay and \defglsdisplayfirst.
The package option shortcuts provides the synonyms listed in table 6. If any of those commands generate an “undefined control sequence” error message, check that you have enabled the shortcuts using the shortcuts package option. Note that there are no shortcuts for the commands that produce all upper case text.
You may find that the predefined acronyms styles that come with the glossaries package don’t suit your requirements. In this case you can define your own style. This is done by redefining the following commands:
This command sets up the keys for \newglossaryentry when you define an acronym using \newacronym. Within the definition of \CustomAcronymFields, you may use \the\glslongtok to access the long form, \the\glsshorttok to access the short form and \the\glslabeltok to access the label. This command is typically used to set the name, first, firstplural, text and plural keys. It may also be used to set the symbol or description keys depending on your requirements.
This is used to set up the display style for the glossary given by ⟨type⟩. This should typically just use \defglsdisplayfirst and \defglsdisplay.
Once you have redefined \CustomAcronymFields and \SetCustomDisplayStyle, you must then switch to this style using
Note that you may still use the shortcuts package option with your custom style.
As an example, suppose I want my acronym on first use to have the short form in the text and the long form with the description in a footnote. Suppose also that I want the short form to be put in small caps in the main body of the document, but I want it in normal capitals in the list of acronyms. In my list of acronyms, I want the long form as the name with the short form in brackets followed by the description.
First, I need to redefine \CustomAcronymFields so that \newacronym will correctly set the name, text and plural keys. I want the long form to be stored in the name and the short form to be stored in text. In addition, I’m going to set the symbol to the short form in upper case so that it will appear in the list of acronyms.
Note that in this case I haven’t bothered with \acrpluralsuffix and have just inserted an “s”.
When I use the custom acronym style, the short form is stored in user1, the plural short form is stored in user2, the long form is stored in user3 and the plural long form is stored in user4. So when I use \defglsdisplayfirst and \defglsdisplay, I can use \glsentryuseriii to access the long form. Recall from §2.4.1 Changing the format of the link text, that the optional argument to \defglsdisplayfirst and \defglsdisplay indicates the glossary type. This is passed to \SetCustomDisplayStyle. The mandatory argument sets up the definition of \glsdisplayfirst and \glsdisplay for the given glossary, where the first argument corresponds to the first, firstplural, text or plural, as appropriate, the second argument corresponds to the description, the third corresponds to the symbol and the fourth argument is the inserted text.
Since we have a definition inside a definition, #1 refers to the argument of \SetCustomDisplayStyle, and ##1, …, ##4, refer to the arguments of \glsdisplayfirst and \glsdisplay.
Now that I’ve redefined \CustomAcronymFields and \SetCustomDisplayStyle, I can set this style using
and now I can define my acronyms:
Note that since I’ve used the description in the main body of the text, I need to switch off the sanitization otherwise any commands within the description won’t get interpreted. Also I want to use the hyperref package, but this will cause a problem on first use as I’ll get nested hyperlinks, so I need to switch off the hyperlinks on first use. In addition, I want to use a glossary style that displays the symbol. Therefore, in my preamble I have:
Note that I haven’t used the description or footnote package options.
Users of the obsolete glossary package may recall that the syntax used to define new acronyms has changed with the replacement glossaries package. In addition, the old glossary package created the command \⟨acr-name⟩ when defining the acronym ⟨acr-name⟩.
In order to facilitate migrating from the old package to the new one, the glossaries package11 provides the command:
This uses the same syntax as the glossary package’s method of defining acronyms. It is
equivalent to:
\newacronym[⟨key-val list⟩]{⟨label⟩}{⟨abbrv⟩}{⟨long⟩}
In addition, \oldacronym also defines the commands \⟨label⟩, which is equivalent to
\gls{⟨label⟩}, and \⟨label⟩*, which is equivalent to \Gls{⟨label⟩}. If ⟨label⟩ is omitted,
⟨abbrv⟩ is used. Since commands names must consist only of alphabetical characters,
⟨label⟩ must also only consist of alphabetical characters. Note that \⟨label⟩ doesn’t
allow you to use the first optional argument of \gls or \Gls — you will need to
explicitly use \gls or \Gls to change the settings.
The glossaries package doesn’t load the xspace package since there are both advantages and disadvantages to using \xspace in \⟨label⟩. If you don’t use the xspace package you need to explicitly force a space using \␣ (backslash space) however you can follow \⟨label⟩ with additional text in square brackets (the final optional argument to \gls). If you use the xspace package you don’t need to escape the spaces but you can’t use the optional argument to insert text (you will have to explicitly use \gls).
To illustrate this, suppose I define the acronym “abc” as follows:
This will create the command \abc and its starred version \abc*. Table 7 illustrates the effect of \abc (on subsequent use) according to whether or not the xspace package has been loaded. As can be seen from the final row in the table, the xspace package prevents the optional argument from being recognised.
| Code | With xspace | Without xspace |
| \abc. | abc. | abc. |
| \abc xyz | abc xyz | abcxyz |
| \abc\ xyz | abc xyz | abc xyz |
| \abc* xyz | Abc xyz | Abc xyz |
| \abc[’s] xyz | abc [’s] xyz | abc’s xyz |
When using \gls, \glspl and their uppercase variants it is possible that you may want to use the value given by the first key, even though you have already used the glossary entry. Conversely, you may want to use the value given by the text key, even though you haven’t used the glossary entry. The former can be achieved by one of the following commands:
while the latter can be achieved by one of the following commands:
You can also reset or unset all entries for a given glossary or list of glossaries using:
where ⟨glossary list⟩ is a comma-separated list of glossary labels. If omitted, all defined glossaries are assumed. For example, to reset all entries in the main glossary and the list of acronyms:
You can determine whether an entry’s first use flag is set using:
where ⟨label⟩ is the label of the required entry. If the entry has been used, ⟨true part⟩ will be done, otherwise ⟨false part⟩ will be done.
The glossaries package comes with some pre-defined glossary styles. Note that the styles are suited to different types of glossaries: some styles ignore the associated symbol; some styles are not designed for hierarchical entries, so they display sub-entries in the same way as they display top level entries; some styles are designed for homographs, so they ignore the name for sub-entries. You should therefore pick a style that suits your type of glossary. See table 8 for a summary of the available styles.
| Style | Maximum Level | Homograph | Symbol |
| listdotted | 0 | ||
| sublistdotted | 1 | ||
| list* | 1 | ✓ | |
| altlist* | 1 | ✓ | |
| long*3col* | 1 | ✓ | |
| long4col* | 1 | ✓ | ✓ |
| altlong*4col* | 1 | ✓ | ✓ |
| long* | 1 | ✓ | |
| super*3col* | 1 | ✓ | |
| super4col* | 1 | ✓ | ✓ |
| altsuper*4col* | 1 | ✓ | ✓ |
| super* | 1 | ✓ | |
| index* | 2 | ✓ | |
| treenoname* | — | ✓ | ✓ |
| tree* | — | ✓ | |
| alttree* | — | ✓ |
The glossary style can be set using the style key in the optional argument to \printglossary or using the command:
Some of the glossary styles may also be set using the style package option, it depends if the package in which they are defined is automatically loaded by the glossaries package.
The tabular-like styles that allow multi-line descriptions and page lists use the length \glsdescwidth \glsdescwidth to set the width of the description column and the length \glspagelistwidth \glspagelistwidth to set the width of the page list column.12 These will need to be changed using \setlength if the glossary is too wide. Note that the long4col and super4col styles (and their header and border variations) don’t use these lengths as they are designed for single line entries. Instead you should use the analogous altlong4col and altsuper4col styles. If you want to explicitly create a line-break within a multi-line description in a tabular-like style you should use \newline instead of \\.
Note that if you use the style key in the optional argument to \printglossary, it will override any previous style settings for the given glossary, so if, for example, you do
then the new definition of \glsgroupskip will not have an affect for this glossary, as \glsgroupskip is redefined by style=long. Likewise, \glossarystyle will also override any previous style definitions, so, again
will reset \glsgroupskip back to its default definition for the named glossary style (long in this case). If you want to modify the styles, either use \newglossarystyle (described in the next section) or make the modifications after \glossarystyle, e.g.:
All the styles except for the three- and four-column styles and the listdotted style use the command
after the description. This simply displays a full stop by default. To eliminate this full stop (or replace it with something else, say, a comma) you will need to redefine \glspostdescription before the glossary is displayed. Alternatively, you can suppress it for a given entry by placing \nopostdesc in the entry’s description.
The styles described in this section are all defined in the package glossary-list. Since they all use the description environment, they are governed by the same parameters as that environment. These styles all ignore the entry’s symbol. Note that these styles will automatically be available unless you use the nolist or nostyles package options.
which defaults to a vertical bar with a space on either side. For example, to simply have a space separating each group, do:
Note that the hyper-navigation line is now (as from version 1.14) set inside the optional argument to \item instead of after it to prevent a spurious space at the start. This can be changed by redefining \glossaryheader, but note that this needs to be done after the glossary style has been set.
governs where the description should start. This is a flat style, so child entries are formatted in the same way as the parent entries.
The styles described in this section are all defined in the package glossary-long. Since they all use the longtable environment, they are governed by the same parameters as that environment. Note that these styles will automatically be available unless you use the nolong or nostyles package options. These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the analogous styles described in §2.12.3 Longtable Styles (Ragged Right).
The styles described in this section are all defined in the package glossary-longragged. These styles are analogous to those defined in glossary-long but the multiline columns are left justified instead of fully justified. Since these styles all use the longtable environment, they are governed by the same parameters as that environment. The glossary-longragged package additionally requires the array package. Note that these styles will only be available if you explicitly load glossary-longragged:
Note that you can’t set these styles using the style package option since the styles aren’t defined until after the glossaries package has been loaded.
The styles described in this section are all defined in the package glossary-super. Since they all use the supertabular environment, they are governed by the same parameters as that environment. Note that these styles will automatically be available unless you use the nosuper or nostyles package options. In general, the longtable environment is better, but there are some circumstances where it is better to use supertabular.14 These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the analogous styles described in §2.12.5 Supertabular Styles (Ragged Right).
The styles described in this section are all defined in the package glossary-superragged. These styles are analogous to those defined in glossary-super but the multiline columns are left justified instead of fully justified. Since these styles all use the supertabular environment, they are governed by the same parameters as that environment. The glossary-superragged package additionally requires the array package. Note that these styles will only be available if you explicitly load glossary-superragged:
Note that you can’t set these styles using the style package option since the styles aren’t defined until after the glossaries package has been loaded.
The styles described in this section are all defined in the package glossary-tree. These styles are designed for hierarchical glossaries but can also be used with glossaries that don’t have sub-entries. These styles will display the entry’s symbol if it exists. Note that these styles will automatically be available unless you use the notree or nostyles package options.
The optional argument ⟨level⟩ indicates the level, where 0 indicates the top-most level, 1 indicates the first level sub-entries, etc. If \glssetwidest hasn’t been used for a given sub-level, the level 0 widest text is used instead. If ⟨level⟩ is omitted, 0 is assumed.
For each level, the name is placed to the left of the paragraph block containing the symbol (optional) and the description. If the symbol is present, it is placed in parentheses before the description.
If the predefined styles don’t fit your requirements, you can define your own style using:
where ⟨name⟩ is the name of the new glossary style (to be used in \glossarystyle). The second argument ⟨definitions⟩ needs to redefine all of the following:
This environment defines how the main body of the glossary should be typeset. Note that this does not include the section heading, the glossary preamble (defined by \glossarypreamble) or the glossary postamble (defined by \glossarypostamble). For example, the list style uses the description environment, so the theglossary environment is simply redefined to begin and end the description environment.
This macro indicates what to do at the start of the main body of the glossary. Note that this is not the same as \glossarypreamble, which should not be affected by changes in the glossary style. The list glossary style redefines \glossaryheader to do nothing, whereas the longheader glossary style redefines \glossaryheader to do a header row.
This macro indicates what to do at the start of each logical block within the main body of the glossary. If you use makeindex the glossary is sub-divided into a maximum of twenty-eight logical blocks that are determined by the first character of the sort key (or name key if the sort key is omitted). The sub-divisions are in the following order: symbols, numbers, A, …, Z. If you use xindy, the sub-divisions depend on the language settings.
Note that the argument to \glsgroupheading is a label not the group title. The group title can be obtained via
This obtains the title as follows: if \⟨label⟩groupname exists, this is taken to be the title, otherwise the title is just ⟨label⟩.
A navigation hypertarget can be created using
For further details about \glsnavhypertarget, see the documented code of glossary-hypernav in glossaries.pdf.
Most of the predefined glossary styles redefine \glsgroupheading to simply ignore its argument. The listhypergroup style redefines \glsgroupheading as follows:
See also \glsgroupskip below. (Note that command definitions within \newglossarystyle must use ##1 instead of #1 etc.)
This macro determines what to do after one logical group but before the header for the next logical group. The list glossary style simply redefines \glsgroupskip to be \indexspace, whereas the tabular-like styles redefine \glsgroupskip to produce a blank row.
This macro indicates what to do for a given glossary entry. Note that ⟨formatted name⟩ will always be in the form \glsnamefont{⟨name⟩}. This allows the user to set a given font for the entry name, regardless of the glossary style used. Note that ⟨label⟩ is the label used when the glossary entry was defined via either \newglossaryentry or \newacronym.
Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the relevant line in the glossary. Your new glossary style must therefore redefine \glossaryentryfield to set the appropriate target. This is done using
where ⟨label⟩ is the entry’s label. Note that you don’t need to worry about whether the hyperref package has been loaded, as \glstarget won’t create a target if \hypertarget hasn’t been defined.
For example, the list style defines \glossaryentryfield as follows:
Note also that ⟨number list⟩ will always be of the form
\glossaryentrynumbers{\relax
\setentrycounter{⟨counter name⟩}\glsnumberformat{⟨number(s)⟩}}
where ⟨number(s)⟩ may contain \delimN (to delimit individual numbers) and/or
\delimR (to indicate a range of numbers). There may be multiple occurrences of
\setentrycounter{⟨counter name⟩}\glsnumberformat{⟨number(s)⟩}, but note that
the entire number list is enclosed within the argument to \glossaryentrynumbers. The
user can redefine this to change the way the entire number list is formatted, regardless
of the glossary style. However the most common use of \glossaryentrynumbers is to
provide a means of suppressing the number list altogether. (In fact, the nonumberlist
option redefines \glossaryentrynumbers to ignore its argument.) Therefore, when you
define a new glossary style, you don’t need to worry about whether the user has
specified the nonumberlist package option.
This is new to version 1.17, and is used to display sub-entries. The first argument, ⟨level⟩, indicates the sub-entry level. This must be an integer from 1 (first sub-level) onwards. The remaining arguments are analogous to those for \glossaryentryfield described above.
For further details of these commands, see the documented code in glossaries.pdf.
If you want a completely new style, you will need to redefine all of the commands and the environment listed above.
For example, suppose you want each entry to start with a bullet point. This means that the glossary should be placed in the itemize environment, so theglossary should start and end that environment. Let’s also suppose that you don’t want anything between the glossary groups (so \glsgroupheading and \glsgroupskip should do nothing) and suppose you don’t want anything to appear immediately after \begin{theglossary} (so \glossaryheader should do nothing). In addition, let’s suppose the symbol should appear in brackets after the name, followed by the description and last of all the number list should appear within square brackets at the end. Then you can create this new glossary style, called, say, mylist, as follows:
Note that this style creates a flat glossary, where sub-entries are displayed in exactly the same way as the top level entries.
If you want to define a new style that is a slightly modified version of an existing style, you can use \glossarystyle within the second argument of \newglossarystyle followed by whatever alterations you require. For example, suppose you want a style like the list style but you don’t want the extra vertical space created by \indexspace between groups, then you can create a new glossary style called, say, mylist as follows:
Since \glossaryentryfield and \glossarysubentryfield provide the label for the entry, it’s also possible to access the values of the generic user keys, such as user1. For example, suppose each entry not only has an associated symbol, but also units (stored in user1) and dimension (stored in user2). Then you can define a glossary style that displays each entry in a longtable as follows:
Limited accessibility support is provided by the accompanying glossaries-accsupp package, but note that this package is experimental and it requires the accsupp package which is also listed as experimental. This package defines additional keys that may be used when defining glossary entries. The keys are as follows:
For example:
Now \gls{tex} will be equivalent to
See the section “glossaries-accsupp code” in the document glossaries.pdf for further details. It is recommended that you also read the accsupp documentation.
The glossaries bundle is supplied with the package mfirstuc which provides the command:
which makes the first object of ⟨stuff ⟩ uppercase unless ⟨stuff ⟩ starts with a control sequence followed by a non-empty group, in which case the first object in the group is converted to uppercase. Examples:
Note that non-Latin or accented characters appearing at the start of the text must be placed in a group (even if you are using the inputenc package) due to expansion issues.
Note also that
produces: ABC. This is because the first object in the argument of \makefirstuc is \abc, so it does \MakeUppercase\abc. Whereas:
produces: Abc. There is a short cut command which will do this:
This is equivalent to \expandafter\makefirstuc\expandafter{⟨stuff ⟩}. So
produces: Abc.
If you want to use an alternative command to convert to uppercase, for example \MakeTextUppercase,15 you can redefine the internal command \@gls@makefirstuc. For example:
(Remember that command names that contain the @ character must either be placed in packages or be placed between \makeatletter and \makeatother.)
Symbols
A
\Ac 6
\ac 7
accsupp package 8, 9
\Acf 10
\acf 11
\Acfp 12
\acfp 13
\Acl 14
\acl 15
\Aclp 16
\aclp 17
\Acp 18
\acp 19
\ACRfull 20
\Acrfull 21, 22
\acrfull 23, 24
\Acrfullpl 25
\acrfullpl 26
\ACRlong 27
\Acrlong 28, 29
\acrlong 30, 31, 32
\Acrlongpl 33
\acrlongpl 34
\acrnameformat 35, 36, 37
\acronymfont 38, 39, 40, 41, 42
\acronymname 43
\acronymtype 44, 45, 46, 47, 48, 49, 50, 51
\acrpluralsuffix 52
\ACRshort 53
\Acrshort 54, 55
\acrshort 56, 57, 58
\Acrshortpl 59
\acrshortpl 60
\Acs 61
\acs 62
\Acsp 63
\acsp 64
array package 65, 66
B
babel package 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77
C
\CustomAcronymFields 78, 79, 80
D
\defglsdisplay 81, 82, 83, 84, 85, 86
\defglsdisplayfirst 87, 88, 89, 90, 91, 92
description (environment) 93, 94, 95, 96, 97
\descriptionname 98
E
\emph 99
\entryname 100
environments:
description 101, 102, 103, 104, 105
equation 106
itemize 107
longtable 108, 109, 110, 111, 112
supertabular 113, 114, 115, 116, 117
theglossary 118, 119, 120, 121
equation (environment) 122
F
file types
.alg 123
.aux 124, 125
.glg 126, 127, 128, 129
.glo 130, 131, 132
.gls 133, 134, 135
.ist 136, 137, 138, 139, 140, 141
.log 142
.tex 143, 144
.xdy 145, 146, 147, 148, 149, 150, 151
first use 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173
flag 174, 175, 176, 177, 178, 179, 180, 181, 182, 183
text 184, 185, 186, 187
\firstacronymfont 188
flowfram package 189
fmtcount package 190
G
german package 191
glossaries-accsupp package 192, 193
glossaries-babel package 194, 195, 196
glossaries-polyglossia package 197, 198, 199
glossary package 200, 201, 202, 203, 204
glossary styles:
altlist 205, 206
altlistgroup 207, 208
altlisthypergroup 209
altlong4col 210, 211, 212
altlong4colborder 213
altlong4colheader 214
altlong4colheaderborder 215
altlongragged4col 216, 217, 218
altlongragged4colborder 219
altlongragged4colheader 220, 221
altlongragged4colheaderborder 222
altsuper4col 223, 224, 225
altsuper4colborder 226
altsuper4colheader 227
altsuper4colheaderborder 228
altsuperragged4col 229, 230, 231
altsuperragged4colborder 232
altsuperragged4colheader 233, 234
altsuperragged4colheaderborder 235
alttree 236, 237, 238
alttreegroup 239, 240
alttreehypergroup 241
index 242, 243, 244, 245, 246
indexgroup 247, 248
indexhypergroup 249
list 250, 251, 252, 253, 254, 255, 256, 257, 258, 259, 260
listdotted 261, 262, 263
listgroup 264, 265
listhypergroup 266, 267, 268, 269, 270, 271, 272
long 273, 274, 275, 276, 277
long3col 278, 279, 280, 281, 282
long3colborder 283, 284
long3colheader 285, 286, 287
long3colheaderborder 288, 289
long4col 290, 291, 292, 293, 294
long4colborder 295, 296
long4colheader 297, 298, 299
long4colheaderborder 300, 301
longborder 302
longheader 303, 304, 305
longheaderborder 306
longragged 307, 308, 309, 310
longragged3col 311, 312, 313, 314
longragged3colborder 315
longragged3colheader 316, 317
longragged3colheaderborder 318
longraggedborder 319
longraggedheader 320, 321
longraggedheaderborder 322
super 323, 324, 325, 326
super3col 327, 328, 329, 330
super3colborder 331
super3colheader 332, 333
super3colheaderborder 334
super4col 335, 336, 337, 338, 339
super4colborder 340, 341
super4colheader 342, 343, 344
super4colheaderborder 345, 346
superborder 347
superheader 348, 349
superheaderborder 350
superragged 351, 352, 353, 354
superragged3col 355, 356, 357, 358
superragged3colborder 359
superragged3colheader 360, 361
superragged3colheaderborder 362
superraggedborder 363
superraggedheader 364, 365
superraggedheaderborder 366
tree 367, 368, 369, 370
treegroup 371, 372
treehypergroup 373
treenoname 374, 375
treenonamegroup 376, 377
treenonamehypergroup 378
glossary-hypernav package 379
glossary-list package 380, 381, 382
glossary-long package 383, 384, 385, 386
glossary-longragged package 387, 388, 389
glossary-super package 390, 391, 392, 393
glossary-superragged package 394, 395, 396
glossary-tree package 397, 398, 399
\glossaryentryfield 400, 401, 402
\glossaryentrynumbers 403
\glossaryheader 404, 405, 406
\glossarymark 407, 408, 409
\glossaryname 410
\glossarypostamble 411
\glossarypreamble 412
\glossarystyle 413, 414, 415, 416, 417
\glossarysubentryfield 418, 419
\GLS 420
\Gls 421, 422, 423, 424, 425, 426
\gls 427, 428, 429, 430, 431, 432, 433, 434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444
\glsadd 445
\glsaddall 446, 447
\glsaddall options
types 448
\GlsAddXdyAttribute 449, 450
\GlsAddXdyLocation 451
\glsautoprefix 452
\glsclearpage 453
\glsclosebrace 454
\glsdefaulttype 455, 456
\GLSdesc 457
\Glsdesc 458
\glsdesc 459, 460
\glsdescwidth 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472
\glsdisablehyper 473
\glsdisp 474, 475, 476, 477, 478
\glsdisplay 479, 480, 481, 482, 483, 484, 485, 486
\glsdisplayfirst 487, 488, 489, 490, 491, 492, 493, 494
\glsenablehyper 495
\Glsentrydesc 496
\glsentrydesc 497
\Glsentrydescplural 498
\glsentrydescplural 499
\Glsentryfirst 500
\glsentryfirst 501
\Glsentryfirstplural 502
\glsentryfirstplural 503
\Glsentryname 504
\glsentryname 505, 506
\Glsentryplural 507
\glsentryplural 508
\Glsentrysymbol 509
\glsentrysymbol 510
\Glsentrysymbolplural 511
\glsentrysymbolplural 512
\Glsentrytext 513
\glsentrytext 514
\Glsentryuseri 515
\glsentryuseri 516
\Glsentryuserii 517
\glsentryuserii 518
\Glsentryuseriii 519
\glsentryuseriii 520, 521
\Glsentryuseriv 522
\glsentryuseriv 523
\Glsentryuserv 524
\glsentryuserv 525
\Glsentryuservi 526
\glsentryuservi 527
\GLSfirst 528
\Glsfirst 529
\glsfirst 530, 531
\GLSfirstplural 532
\Glsfirstplural 533
\glsfirstplural 534
\glsgetgrouptitle 535
\glsgroupheading 536, 537
\glsgroupskip 538, 539, 540, 541
\glshyperlink 542, 543
\glshypernavsep 544
\glslabel 545
\glslabeltok 546
\glslink 547, 548, 549, 550, 551, 552
\glslink options
counter 553
format 554, 555, 556, 557
hyper 558, 559, 560
\glslink* 561
\glslistdottedwidth 562
\glslocalreset 563
\glslocalresetall 564
\glslocalunset 565
\glslocalunsetall 566
\glslongkey 567
\glslongpluralkey 568
\glslongtok 569
\GLSname 570
\Glsname 571
\glsname 572
\glsnamefont 573
\glsnavhypertarget 574
\glsnumbersgroupname 575
\glsopenbrace 576
\glspagelistwidth 577, 578, 579, 580, 581, 582, 583, 584
\glspar 585
\GLSpl 586, 587, 588
\Glspl 589, 590, 591, 592
\glspl 593, 594, 595, 596, 597, 598, 599, 600, 601, 602, 603
\GLSplural 604
\Glsplural 605
\glsplural 606
\glspluralsuffix 607, 608, 609
\glspostdescription 610
\glsquote 611
\glsreset 612
\glsresetall 613
\glssee 614, 615, 616
\glsSetAlphaCompositor 617
\glsSetCompositor 618
\glsSetSuffixF 619
\glsSetSuffixFF 620
\glssetwidest 621
\GlsSetXdyCodePage 622, 623
\GlsSetXdyLanguage 624, 625
\GlsSetXdyLocationClassOrder 626
\GlsSetXdyMinRangeLength 627, 628
\glsshortkey 629
\glsshortpluralkey 630
\glsshorttok 631
\GLSsymbol 632
\Glssymbol 633
\glssymbol 634, 635
\glssymbolsgroupname 636
\glstarget 637
\GLStext 638
\Glstext 639
\glstext 640, 641, 642, 643, 644, 645, 646, 647, 648, 649
\glstextformat 650, 651
\glstocfalse 652
\glstoctrue 653
\glstreeindent 654
\glsunset 655
\glsunsetall 656
\GLSuseri 657
\Glsuseri 658
\glsuseri 659
\GLSuserii 660
\Glsuserii 661
\glsuserii 662
\GLSuseriii 663
\Glsuseriii 664
\glsuseriii 665
\GLSuseriv 666
\Glsuseriv 667
\glsuseriv 668
\GLSuserv 669
\Glsuserv 670
\glsuserv 671
\GLSuservi 672
\Glsuservi 673
\glsuservi 674
H
html package 675
\hyperbf 676
\hyperemph 677
\hyperit 678
\hyperlink 679, 680
\hypermd 681
\hyperpage 682
hyperref package 683, 684, 685, 686, 687, 688, 689
\hyperrm 690, 691
\hypersc 692
\hypersf 693
\hypersl 694
\hypertarget 695
\hypertt 696
\hyperup 697
I
\ifglsused 698
\indexspace 699
inputenc package 700, 701, 702, 703, 704
\inputencodingname 705
itemize (environment) 706
L
link text 709, 710, 711, 712, 713, 714, 715
\loadglsentries 716
location list see number list
longtable (environment) 718, 719, 720, 721, 722
longtable package 723, 724
M
\makefirstuc 725, 726
makeglossaries 727, 728, 729, 730, 731, 732, 733, 734, 735, 736, 737, 738, 739, 740, 741, 742, 743, 744, 745, 746, 747, 748, 749, 750, 751, 752, 753, 754, 755, 756, 757, 758, 759, 760, 761, 762, 763, 764, 765, 766, 767, 768, 769, 770, 771, 772, 773, 774, 775, 776
\makeglossaries 777, 778, 779, 780, 781, 782, 783, 784, 785, 786, 787, 788, 789, 790, 791, 792, 793
makeindex 794, 795, 796, 797, 798, 799, 800, 801, 802, 803, 804, 805, 806, 807, 808, 809, 810, 811, 812, 813, 814, 815, 816, 817, 818, 819, 820, 821, 822, 823, 824, 825, 826, 827, 828, 829, 830, 831, 832, 833, 834, 835, 836, 837, 838, 839, 840, 841, 842, 843, 844, 845, 846, 847, 848, 849, 850
\MakeUppercase 851
mfirstuc package 852
N
\newacronym 853, 854, 855, 856, 857, 858, 859, 860, 861, 862, 863, 864, 865, 866, 867, 868, 869, 870, 871, 872
\newglossary 873, 874, 875, 876
\newglossaryentry 877, 878, 879, 880, 881, 882, 883, 884, 885
\newglossaryentry options
access 886
description 887, 888, 889, 890, 891, 892, 893, 894, 895, 896, 897, 898, 899, 900, 901, 902
descriptionaccess 903
descriptionplural 904, 905, 906
descriptionpluralaccess 907
first 908, 909, 910, 911, 912, 913, 914, 915, 916, 917, 918, 919, 920, 921, 922, 923, 924, 925
firstaccess 926
firstplural 927, 928, 929, 930, 931, 932, 933, 934, 935, 936, 937
firstpluralaccess 938
format 939
name 940, 941, 942, 943, 944, 945, 946, 947, 948, 949, 950, 951, 952, 953, 954, 955, 956, 957, 958, 959, 960
nonumberlist 961
parent 962, 963, 964, 965
plural 966, 967, 968, 969, 970, 971, 972, 973, 974, 975, 976, 977, 978, 979
pluralaccess 980
see 981, 982, 983, 984, 985, 986, 987
sort 988, 989, 990, 991, 992, 993, 994, 995, 996
symbol 997, 998, 999, 1000, 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014
symbolaccess 1015
symbolplural 1016, 1017, 1018
symbolpluralaccess 1019
text 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038
textaccess 1039
type 1040, 1041
user1 1042, 1043, 1044, 1045, 1046, 1047, 1048
user2 1049, 1050
user3 1051
user4 1052
user6 1053, 1054, 1055
\newglossarystyle 1056, 1057
\newline 1058, 1059
ngerman package 1060, 1061
\nohyperpage 1062
\noist 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073
\nopostdesc 1074, 1075, 1076, 1077
number list 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096, 1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105
P
package options:
acronym 1108, 1109, 1110, 1111, 1112, 1113, 1114, 1115, 1116, 1117, 1118, 1119, 1120, 1121, 1122, 1123, 1124, 1125, 1126, 1127, 1128
acronymlists 1129, 1130, 1131, 1132
counter 1133, 1134, 1135
description 1136, 1137, 1138, 1139, 1140, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1151
dua 1152, 1153, 1154, 1155, 1156, 1157, 1158, 1159, 1160
footnote 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168, 1169, 1170, 1171, 1172, 1173, 1174, 1175
hyperfirst 1176
false 1177, 1178
true 1179
makeindex 1180
nolist 1181, 1182
nolong 1183, 1184, 1185
nomain 1186, 1187
nonumberlist 1188, 1189, 1190, 1191
nostyles 1192, 1193, 1194, 1195, 1196, 1197
nosuper 1198, 1199, 1200
notree 1201, 1202
nowarn 1203
numberedsection 1204, 1205, 1206, 1207, 1208
autolabel 1209, 1210
false 1211
nolabel 1212
numberline 1213, 1214
order 1215
letter 1216, 1217, 1218
word 1219, 1220, 1221
sanitize 1222, 1223, 1224, 1225, 1226
description 1227, 1228
none 1229
symbol 1230, 1231, 1232, 1233
section 1234, 1235
shortcuts 1236, 1237, 1238, 1239, 1240, 1241
smallcaps 1242, 1243, 1244, 1245, 1246, 1247, 1248, 1249, 1250, 1251, 1252, 1253, 1254, 1255
smaller 1256, 1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269
style 1270, 1271, 1272, 1273, 1274, 1275, 1276
toc 1277, 1278, 1279, 1280, 1281
translate 1282
false 1283, 1284, 1285, 1286
true 1287, 1288
xindy 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296, 1297, 1298, 1299
\pagelistname 1300
pod2man 1301
polyglossia package 1302, 1303, 1304, 1305, 1306
\printglossaries 1307, 1308, 1309
\printglossary 1310, 1311, 1312, 1313, 1314, 1315
\printglossary options
nonumberlist 1316
numberedsection 1317
style 1318, 1319, 1320, 1321
title 1322
toctitle 1323
type 1324
R
relsize package 1325, 1326, 1327
S
\seename 1328
\setAlphaCompositor 1329
\setCompositor 1330
\SetCustomDisplayStyle 1331, 1332, 1333, 1334
\SetCustomStyle 1335
\setglossarysection 1336
\setStyleFile 1337, 1338, 1339
\smaller 1340
supertabular (environment) 1341, 1342, 1343, 1344, 1345
supertabular package 1346, 1347, 1348
\symbolname 1349
T
\textbf 1350
\textrm 1351
\textsc 1352
\textsmaller 1353, 1354, 1355
theglossary (environment) 1356, 1357, 1358, 1359
\thepage 1360
translator package 1361, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371, 1372, 1373, 1374, 1375
X
xindy 1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459
xkeyval package 1460, 1461
\xmakefirstuc 1462
\xspace 1463
xspace package 1464, 1465, 1466, 1467, 1468, 1469
1that is, if the term has been referenced using any of the commands described in §2.4 Links to Glossary Entries, §2.5 Adding an Entry to the Glossary Without Generating Text or via \glssee (or the see key)
2Actually it sets \acronymtype to \glsdefaulttype if the acronym package option is not used, but \glsdefaulttype usually has the value main.
3if the acronym option is used, otherwise the list of acronyms is the main glossary
4The only preamble restriction on \newglossaryentry and \newacronym was removed in version 1.13, but the restriction remains for \loadglsentries.
5This is because \acronymtype is set to \glsdefaulttype if the acronym package option is not used.
6main for the main (default) glossary, \acronymtype for the list of acronyms, or the name supplied in the first mandatory argument to \newglossary for additional glossaries.
7see \setCompositor described in §2.2 Defining Glossary Entries
8see \setAlphaCompositor described in §2.2 Defining Glossary Entries
9you will need to load a package, such as relsize, that defines \textsmaller if you use this option.
10not that this was change from using \smaller to \textsmaller as declarations cause a problem for \makefirstuc.
11as from version 1.18
12these 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.
13This style was supplied by Axel Menzel.
14e.g. with the flowfram package.
15defined in the textcase package