😱 If you’re freaking out at the size of this manual, start with glossariesbegin.pdf (“The glossaries package: a guide for beginnners”). You should find it in the same directory as this document or try texdoc glossariesbegin.pdf. Once you’ve got to grips with the basics, then come back to this manual to find out how to adjust the settings.
The glossaries bundle comes with the following documentation:
If you are using hyperref, it’s best to use pdflatex rather than latex (DVI format) as pdflatex deals with hyperlinks much better. If you use the DVI format, you will encounter problems where you have long hyperlinks or hyperlinks in subscripts or superscripts. This is an issue with the DVI format not with glossaries.
Other documents that describe using the glossaries package include: Using LaTeX to Write a PhD Thesis and Glossaries, Nomenclature, Lists of Symbols and Acronyms.
This glossary style was setup using:
| \usepackage[ | xindy, |
| nonumberlist, |
| seeautonumberlist, |
| toc, |
| style=altlist, |
| nogroupskip]{glossaries} |
\glsnoexpandfields
\renewcommand*{\glsseeformat}[3][\seename]{%
(\xmakefirstuc{#1} \glsseelist{#2}.)}
Earlier versions of glossaries used this technique to write
information to the files used by the indexing applications to
prevent problems caused by fragile commands. Now, this is only
used for the sort key.
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 document uses the glossaries package. For example, when viewing the PDF version of this document in a hyperlinked-enabled PDF viewer (such as Adobe Reader or Okular) if you click on the word “xindy” you’ll be taken to the entry in the glossary where there’s a brief description of what “xindy” is.
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 on your computer, they are also available from your nearest CTAN mirror at http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/.
The sample documents are as follows2:
These warnings may be ignored on the first run.
If you get a Missing \begin{document} error, then it’s most likely that your version of xkeyval is out of date. Check the log file for a warning of that nature. If this is the case, you will need to update the xkeyval package.
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 samplexdy2 -t
samplexdy2.glg -o samplexdy2.gls samplexdy2.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 an accented (or other expandable) character at the start of an entry name, you must place it in a group, or it will cause a problem for commands that convert the first letter to upper case (e.g. \Gls) due to expansion issues. For example:
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, unless you use the translate=false or translate=babel package options. However, it may not pick up on the required languages so, if the predefined text is not translated, you may need to explicitly load the translator package with the required languages. For example:
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.1. Please note that (apart from spelling mistakes) I don’t intend to change the default translations as it will cause compatibility problems.
| Table 1.1: | Supported Languages |
| 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 1.2.
| Table 1.2: | Customised Text |
Due to the varied nature of glossaries, it’s likely that the predefined translations may not be appropriate. If you are using the babel package and the glossaries package option translate=babel, you need to be familiar with the advice given in changing the words babel uses. If you are using the translator package, then you can provide your own dictionary with the necessary modifications (using \deftranslation) and load it using \usedictionary.
Your custom dictionary doesn’t have to be just a translation from English to another language. You may prefer to have a dictionary for a particular type of document. For example, suppose your institution’s in-house reports have to have the glossary labelled as “Nomenclature” and the page list should be labelled “Location”, then you can create a file called, say,
that contains the following:
You can now load it using:
(Make sure that myinstitute-glossaries-dictionary-English.dict can be found by TEX.) If you want to share your custom dictionary, you can upload it to CTAN.
If you are using babel and don’t want to use the translator interface, you can use the package option translate=babel. For example:
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 §11 Xindy for further details.
In order to generate a sorted glossary with compact number lists, it is necessary to use an external indexing application as an intermediate step. It is this application that creates the file containing the code that typesets the glossary. If this step is omitted, the glossaries will not appear in your document. The two 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 §11 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. The advantages of using makeglossaries:
There is also a Java GUI alternative called makeglossariesgui, distributed separately, that has diagnostic tools.
Whilst it is strongly recommended that you use the makeglossaries script or makeglossariesgui, it is possible to use the glossaries package without using either application. However, note that some commands and package options have no effect if you don’t use makeglossaries or makeglossariesgui. These are listed in table 1.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:3
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. Section 1.1 (Building Your Document) of “Using LATEX to Write a PhD Thesis” describes how to do it for TeXWorks. For other editors see the editor’s user manual for further details.
If any problems occur, remember to check the transcript files (e.g. .glg or .alg) for messages.
| Table 1.3: | Commands and package options that have no effect when using xindy or makeindex explicitly |
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
pdflatex -output-directory myTmpDir myDoc
makeglossaries -d myTmpDir 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. Alternatively do makeglossaries --help for a list of all options or makeglossaries --version for the version number.
Xindy comes with TeXLive, but not with MiKTeX. However MikTeX users can install it. See How to use Xindy with MikTeX on TEX on StackExchange.
If you want to use 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 applications such as makeglossaries or makeglossariesgui. This causes the glossary entries to be written in raw xindy format, so you need to use -I xindy not -I tex.
To run xindy type the following in your terminal (all on one line):
xindy -L <language> -C <encoding> -I xindy -M <style> -t
<base>.glg -o <base>.gls <base>.glo
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 default 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 sort value (#) must be sanitized before writing it to the glossary file, otherwise LATEX will try to interpret it as a parameter reference. If, on the other hand, you want the sort value expanded, you need to switch off the sanitization. For example, suppose you do:
and you actually want \mysortvalue expanded, so that the entry is sorted according to AAA, then use the package option sanitizesort=false. (The default is sanitizesort=true.)
If translate is specified without a value, translate=true is assumed. If translate isn’t specified, translate=true is assumed if babel, polyglossia or translator have been loaded. Otherwise translate=false is assumed.
See §1.2.1 Changing the Fixed Names for further details.
The values must be fully expanded, so don’t try nohypertypes=\acronymtype. You may also use
instead or additionally. See §6 Links to Glossary Entries for further details.
and
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:
If you want \glsglossarymark to use \MakeUppercase in the header, use the ucmark option described below.
Occasionally you may find that another package defines \cleardoublepage when it is not required. This may cause an unwanted blank page to appear before each glossary. This can be fixed by redefining \glsclearpage \glsclearpage:
For example:
If memoir has been loaded and ucfirst is set, then memoir’s \memUChead is used.
where <type> is the label identifying that glossary. The default value of \glsautoprefix is empty. For example, if you load glossaries using:
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:
You can redefine the prefix if the default label clashes with another label in your document. 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:
Now \nameref{main} will display the (TOC) section title associated with the main glossary. As above, you can redefine \glsautoprefix to provide a prefix for the label.
If you use this option, you can reference the entry number within the document using
where <label> is the label associated with that glossary entry.
If you want the counter reset at the start of each glossary, you can redefine \glossarypreamble to use
which sets glossaryentry to zero:
or if you are using \setglossarypreamble, add it to each glossary preamble, as required. For example:
(See §15 Glossary Styles for further details.)
Both sort=def and sort=use set the sort key to a six digit number via
(padded with leading zeros, where necessary). This can be redefined, if required, before the entries are defined (in the case of sort=def) or before the entries are used (in the case of sort=use).
The default is sort=standard. When the standard sort option is in use, you can hook into the sort mechanism by redefining:
where <sort cs> is a temporary control sequence that stores the sort value (which was either explicitly set via the sort key or implicitly set via the name key) before any escaping of the makeindex/xindy special characters is performed. By default \glsprestandardsort just does:
which sanitizes <sort cs> if the sanitizesort package option is set (or does nothing if the package option sanitizesort=false is used).
The other arguments, <type> and <label>, are the glossary type and the entry label for the current entry. Note that <type> will always be a control sequence, but <label> will be in the form used in the first argument of \newglossaryentry.
Example 1 (Mixing Alphabetical and Order of Definition Sorting)
Suppose I have three glossaries: main, acronym and notation, and let’s suppose I want the main and acronym glossaries to be sorted alphabetically, but the notation type should be sorted in order of definition. I can set the sort to standard (which is the default, but can be explicitly set via the package option sort=standard), and I can either define all my main and acronym entries, then redefine \glsprestandardsort to set <sort cs> to an incremented integer, and then define all my notation entries. Alternatively, I can redefine \glsprestandardsort to check for the glossary type and only modify <sort cs> if <type> is notation.
The first option can be achieved as follows:
The second option can be achieved as follows:
(\ifdefstring is defined by the etoolbox package.) For a complete document, see the sample file sampleSort.tex.
____________________________
Example 2 (Customizing Standard Sort)
Suppose you want a glossary of people and you want the names listed as <first-name> <surname> in the glossary, but you want the names sorted by <surname>, <first-name>. You can do this by defining a command called, say, \name{<first-name>}{<surname>} that you can use in the name key when you define the entry, but hook into the standard sort mechanism to temporarily redefine \name while the sort value is being set.
First, define two commands to set the person’s name:
and \name needs to be initialised to \textname:
Now redefine \glsprestandardsort so that it temporarily sets \name to \sortname and expands the sort value, then sets \name to \textname so that the person’s name appears as <first-name> <surname> in the text:
(The somewhat complicate use of \expandafter etc helps to protect fragile commands, but care is still needed.)
Now the entries can be defined:
For a complete document, see the sample file samplePeople.tex.
____________________________
This 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:
If no value is supplied to this package option (either simply writing xindy or writing xindy={}) then the language, codepage and number group settings are unchanged. See §11 Xindy for further details on using xindy with the glossaries package.
It will also define
that’s equivalent to
(unless that command is already defined before the beginning of the document or the package option compatible-3.07 is used).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 use
instead of or in addition to the acronymlists option. This will add the glossaries given in <list> to the list of glossaries that are identified as lists of acronyms. To replace the list of acronym lists with a new list use:
You can determine if a glossary has been identified as being a list of acronyms using:
The package options listed in this section are now deprecated but are kept for backward-compatibility. Use \setacronymstyle instead. See §13 Acronyms for further details.
or (with footnote and smallcaps)
or (with footnote and smaller)
or (with description and footnote)
This option may be replaced by:
or (with description and footnote)
or (with smallcaps and description)
or (with smaller and description)
Other available options that don’t fit any of the above categories are:
It also defines
which is a synonym for \printglossary[type=symbols,<options>].
It also defines
which is a synonym for \printglossary[type=numbers,<options>].
It also defines
which is a synonym for \printglossary[type=index,<options>] and
which is a synonym for
Since the index isn’t designed for terms with descriptions, you
might also want to disable the hyperlinks for this glossary
using the package option nohypertypes=index or the command
\GlsDeclareNoHyperList{index}
The example file sample-index.tex illustrates the use of the index package option.
Some of the options described above may also be set after the glossaries package has been loaded using
The following package options can’t be used in \setupglossaries: xindy, xindygloss, xindynoglsnumbers, makeindex, nolong, nosuper, nolist, notree, nostyles, nomain, compatible-2.07, translate, notranslate, acronym. These options have to be set while the package is loading, except for the xindy sub-options which can be set using commands like \GlsSetXdyLanguage (see §11 Xindy for further details).
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.
Similarly, there are some commands that must be used after \makeglossaries.
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 upper case 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 §5 Number lists for further information about number lists.
All glossary entries must be defined before they are used, so it is better to define them in the preamble to ensure this.1 However only those entries that occur in the document (using any of the commands described in §6 Links to Glossary Entries, §7 Adding an Entry to the Glossary Without Generating Text or §8 Cross-Referencing Entries) will appear in the glossary. Each time an entry is used in this way, a line is added to an associated glossary file (.glo), which then needs to be converted into a corresponding .gls file which contains the typeset glossary which is input by \printglossary 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.2 See §1.3 Generating the Associated Glossary Files for further details.
New glossary entries are defined using the command:
This is a short command, so values in <key-val list> can’t contain any paragraph breaks. If you have a long description that needs to span multiple paragraphs, use
instead. Note that, unlike \newglossaryentry, the command \longnewglossaryentry may only be used in the preamble. Be careful of unwanted spaces. \longnewglossaryentry will remove trailing spaces in the description (via \unskip) but won’t remove leading spaces (otherwise it would interfere with commands like \Glsentrydesc).
There are also commands that will only define the entry if it hasn’t already been defined:
and
(These are both preamble-only commands.)
For all the above commands, the first argument, <label>, must be a unique label with which to identify this entry. This can’t contain any non-expandable commands or active characters.
The second argument, <key=value list>, is a <key>=<value> list that supplies the relevant information about this entry. There are two required fields: description and either name or parent. Available fields are listed below:
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
or, better, use \longnewglossaryentry. However, note that not all glossary styles support multi-line descriptions. If you are using one of the tabular-like glossary styles that permit multi-line descriptions, use \newline not \\ 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.
The following keys are reserved for \newacronym (see §13 Acronyms): long, longplural, short and shortplural. Additional keys are provided by the glossaries-prefix (§18 Prefixes or Determiners) and the glossaries-accsupp (§19 Accessibility Support) packages. You can also define your own custom keys (see §4.3 Additional Keys).
Note that if the name starts with an accented letter or other non-Latin character, you must group the character, otherwise it will cause a problem for commands like \Gls 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 second plural. Alternatively, you can define your own keys using \glsaddkey, described in §4.3 Additional Keys.
If you are using a language that usually forms plurals by appending a different letter, or sequence of letters, you can redefine \glspluralsuffix as required. However, this must be done before the entries are defined. For languages that don’t form plurals by simply appending a suffix, all the plural forms must be specified using the plural key (and the firstplural key where necessary).
You can use the six user keys to provide alternatives, such as participles. For example:
With the above definitions, I can now define terms like this:
and use them in the text:
Alternatively, you can define your own keys using \glsaddkey, described below in §4.3 Additional Keys.
You can now also define your own custom keys using:
where:
The starred version of \glsaddkey switches on expansion for this key. The unstarred version doesn’t override the current expansion setting.
Example 3 (Defining Custom Keys)
Suppose I want to define two new keys, ed and ing, that default to the entry text followed by “ed” and “ing”, respectively. The default value will need expanding in both cases, so I need to use the starred form:
Now I can define some entries:
These entries can later be used in the document:
For a complete document, see the sample file sample-newkeys.tex.
____________________________
When you define new glossary entries expansion is performed by default, except for the name, description, descriptionplural, symbol, symbolplural and sort keys (these keys all have expansion suppressed via \glssetnoexpandfield).
You can switch expansion on or off for individual keys using
or
respectively, where <field> is the field tag corresponding to the key. In most cases, this is the same as the name of the key except for those listed in table 4.1.
| Table 4.1: | Key to Field Mappings |
Any keys that haven’t had the expansion explicitly set using \glssetexpandfield or \glssetnoexpandfield are governed by
and
If your entries contain any fragile commands, I recommend you switch off expansion via \glsnoexpandfields. (This should be used before you define the entries.)
As from version 1.17, it is possible to specify sub-entries. These may be used to order the glossary into categories, in which case the sub-entry will have a different name to its parent entry, or it may be used to distinguish different definitions for the same word, in which case the sub-entries will have the same name as the parent entry. Note that not all glossary styles support hierarchical entries and may display all the entries in a flat format. Of the styles that support sub-entries, some display the sub-entry’s name whilst others don’t. Therefore you need to ensure that you use a suitable style. (See §15 Glossary Styles for a list of predefined styles.) As from version 3.0, level 1 sub-entries are automatically numbered in the predefined styles if you use the subentrycounter package option (see §2.3 Glossary Appearance Options for further details).
Note that the parent entry will automatically be added to the glossary if any of its child entries are used in the document. If the parent entry is not referenced in the document, it will not have a number list. Note also that makeindex has a restriction on the maximum sub-entry depth.
To arrange a glossary with hierarchical categories, you need to first define the category and then define the sub-entries using the relevant category entry as the value of the parent key.
Example 4 (Hierarchical Categories—Greek and Roman Mathematical Symbols)
Suppose I want a glossary of mathematical symbols that are divided into Greek letters and Roman letters. Then I can define the categories as follows:
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:
For a complete document, see the sample file sampletree.tex.
____________________________
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 unless you are using the sort=use or sort=def package options (see §2.4 Sorting Options). You can use the subentrycounter package option to automatically number the first-level child entries. See §2.3 Glossary Appearance Options for further details.
In the above example, the plural form for both of the child entries is the same as the parent entry, so the plural key was not required for the child entries. However, if the sub-entries have different plurals, they will need to be specified. For example:
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 or \longnewglossaryentry commands. The optional argument <type> is the name of the glossary to which those entries should belong, for those entries where the type key has been omitted (or, more specifically, for those entries whose type has been specified by \glsdefaulttype, which is what \newglossaryentry uses by default).
Example 5 (Loading Entries from Another File)
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 §13 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.3
If you have used the acronym package option, there are two possible solutions to this problem:
and do:
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.
As from version 3.02, you can move an entry from one glossary to another using:
where <label> is the unique label identifying the required entry and <target glossary label> is the unique label identifying the glossary in which to put the entry.
Note that no check is performed to determine the existence of the target glossary. This means that you can, for example, move an entry to an undefined glossary so you can use the entry in the document text but not have it listed in any of the glossaries. (Maybe you have an acronym that is so common it doesn’t need listing.)
Originally, \newglossaryentry (and \newacronym) could only be used in the preamble. I reluctantly removed this restriction in version 1.13, but there are issues with defining commands in the document environment instead of the preamble.
To overcome these problems, as from version 4.0 the glossaries package modifies the definition of \newglossaryentry at the beginning of the document environment so that the definitions are written to an external file (\jobname.glsdefs) which is then read in at the start of the document on the next run. The entry will then only be defined if it doesn’t already exist. This means that the entry can now be looked up in the glossary, even if the glossary occurs at the beginning of the document.
There are drawbacks to this mechanism: if you modify an entry definition, you need a second run to see the effect of your modification; this method requires an extra \newwrite, which may exceed TEX’s maximum allocation; if you have very long entries, you could find unexpected line breaks have been written to the temporary file.
The last reason is why \longnewglossaryentry has the preamble-only restriction, which I don’t intend to lift.
The above section covers technical issues that can cause your document to have compilation errors or produce incorrect output. This section focuses on good writing practice. The main reason cited by users wanting to define entries within the document environment rather than in the preamble is that they want to write the definition as they type in their document text. This suggests a “stream of consciousness” style of writing that may be acceptable in certain literary genres but is inappropriate for factual documents.
When you write technical documents, regardless of whether it’s a PhD thesis or an article for a journal or proceedings, you must plan what you write in advance. If you plan in advance, you should have a fairly good idea of the type of terminology that your document will contain, so while you are planning, create a new file with all your entry definitions. If, while you’re writing your document, you remember another term you need, then you can switch over to your definition file and add it. Most text editors have the ability to have more than one file open at a time.
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 §5 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 §9 Using Glossary Terms Without Links (such as \glsentrytext) or provide an alternative via the optional argument to the sectioning/caption command. Examples:
If you want the link text to produce a hyperlink to the corresponding entry details in the glossary, you should load the hyperref package before the glossaries package. That’s what I’ve done in this document, so if you see a hyperlinked term, such as link text, you can click on the word or phrase and it will take you to a brief description in this document’s glossary.
It may be that you only want terms in a certain glossary to have links, but not for another glossary. In which case, you can use the package option nohypertypes to identify the glossary lists that shouldn’t have hyperlinked link text. For example, suppose your document contains lots of technical acronyms that the reader might not know, but it also contains some very common acronyms that most readers will recognise. So you might want two acronym lists, but only the technical list will get displayed in your document. The technical acronyms can be hyperlinked to that list, but common acronyms shouldn’t have hyperlinks as there’s no target for them. In this case, identify the common acronym list as having non-hyperlinked entries using nohypertypes. Example:
Alternatively, you can use
For example:
Note that no check is performed to see if the glossary types listed in nohypertypes or \GlsDeclareNoHyperList have been defined.
is correct, but nohypertypes={{acronym},{common}} won’t work.
You can override the effect of nohypertypes or \GlsDeclareNoHyperList by explicitly setting the hyper option in commands such as \glslink or \gls.
The way the link text is displayed depends on
For example, to make all link text appear in a sans-serif font, do:
Further customisation can be done via \defglsentryfmt or by redefining \glsentryfmt. See §6.1 Changing the format of the link text for further details.
Each entry has an associated conditional referred to as the first use flag. This determines whether \gls or \glspl (or their upper case variants) should use the value of the first/firstplural or text/plural keys. Note that an entry can be used without affecting the first use flag (for example, when used with \glslink). See §14 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 6.1.
Note that unlike \index, you can’t have anything following the command name, such as an asterisk or arguments. If you want to cross-reference another entry, either use the see key when you define the entry or use \glssee (described in §8 Cross-Referencing Entries).
If you are using hyperlinks and you want to change the font of the hyperlinked location, don’t use \hyperpage (provided by the hyperref package) as the locations may not refer to a page number. Instead, the glossaries package provides number formats listed in table 6.1.
| Table 6.1: | Predefined Hyperlinked Location Formats |
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. (See also “Displaying the glossary” in the documented code, glossaries-code.pdf.) Remember that if you use xindy, you will need to add this to the list of location attributes:
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 upper case variants:
and
which make the first letter of the link text or all the link text upper case, respectively.
The final optional argument <insert>, allows you to insert some additional text into the link text. By default, this will append <insert> at the end of the link text, but this can be changed (see §6.1 Changing the format of the link text).
The first optional argument <options> is the same as the optional argument to \glslink. As with \glslink, these commands also have a starred version that disable the hyperlink.
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.
and later you use it in math mode:
This will result in Fα2 instead of Fα2. In this situation it’s best to bring the superscript into the hyperlink using the final <insert> optional argument:
Note that \glslink doesn’t use or affect the first use flag, nor does it use \glsentryfmt or the equivalent definition provided by \defglsentryfmt (see §6.1 Changing the format of the link text). Instead, you can use:
This behaves in the same way as \gls, except that it uses <link text> instead of the value of the first or text key. (Note that this command always sets <insert> to nothing.) This command affects the first use flag, and uses \glsentryfmt or the equivalent definition provided by \defglsentryfmt.
The command:
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 \glsentryfmt or the equivalent definition provided by \defglsentryfmt. (The same is true for all the following commands described in the rest of this section.)
There are also analogous commands:
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.
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.
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.
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 upper case variants and also for \glsdisp is governed by1:
If you want to redefine this command, you may use the following commands within its definition:
This is the label of the entry being referenced.
This is the custom text supplied in \glsdisp. It’s always empty for \gls, \glspl and their upper case variants. (You can use etoolbox’s \ifdefempty to determine if \glscustomtext is empty.)
The custom text supplied in the final optional argument to \gls, \glspl and their upper case variants.
If \glspl, \Glspl or \GLSpl was used, this command does <true text> otherwise it does <false text>.
If \gls, \glspl or \glsdisp were used, this does <no case>. If \Gls or \Glspl were used, this does <first uc>. If \GLS or \GLSpl were used, this does <all caps>.
Note that you can also use commands such as \ifglsused within the definition of \glsentryfmt (see §14 Unsetting and Resetting Entry Flags).
If you only want to make minor modifications to \glsentryfmt, you can use
This uses the above commands to display just the first, text, plural or firstplural keys (or the custom text) with the insert text appended.
Alternatively, if want to change the entry format for acronyms (defined via \newacronym) you can use:
This uses the values from the long, short, longplural and shortplural keys, rather than using the text, plural, first and firstplural keys. The first use singular text is obtained via:
instead of from the first key, and the first use plural text is obtained via:
instead of from the firstplural key. In both cases, <label> is the entry’s label and <insert> is the insert text provided in the final optional argument of commands like \gls. The default behaviour is to do the long form (or plural long form) followed by <insert> and a space and the short form (or plural short form) in parentheses, where the short form is in the argument of \firstacronymfont. There are also first letter upper case versions:
and
By default these perform a protected expansion on their no-case-change equivalents and then use \makefirstuc to convert the first character to upper case. If there are issues caused by this expansion, you will need to redefine those commands to explicitly use commands like \Glsentrylong (which is what the predefined acronym styles, such as long-short, do). Otherwise, you only need to redefine \genacrfullformat and \genplacrfullformat to change the behaviour of \glsgenacfmt. See §13 Acronyms for further details on changing the style of acronyms.
Example 6 (Custom Entry Display in Text)
Suppose you want a glossary of measurements and units, you can use the symbol key to store the unit:
and now suppose you want \gls{distance} to produce “distance (km)” on first use, then you can redefine \glsentryfmt as follows:
(Note that I’ve used \glsentrysymbol rather than \glssymbol to avoid nested hyperlinks.)
Note also that all of the link text will be formatted according to \glstextformat (described earlier). So if you do, say:
then \gls{distance} will produce “distance (km)”.
For a complete document, see the sample file sample-entryfmt.tex.
____________________________
If you have multiple glossaries, changing \glsentryfmt will change the way entries for all of the glossaries appear when using the commands \gls, \glspl, their upper case variants and \glsdisp. If you only want the change to affect entries for a given glossary, then you need to use
instead of redefining \glsentryfmt. The optional first argument <type> is the glossary type. This defaults to \glsdefaulttype if omitted. The second argument is the entry format definition.
Example 7 (Custom Format for Particular Glossary)
Suppose you have created a new glossary called notation and you want to change the way the entry is displayed on 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).
Alternatively, if you expect all the symbols to be set in math mode, you can do:
and define entries like this:
____________________________
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.
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.
Example 8 (First Use With Hyperlinked Footnote Description)
Suppose I want the first use to have a hyperlink to the description in a footnote instead of hyperlinking to the relevant place in the glossary. First I need to disable the hyperlinks on first use via the package option hyperfirst=false:
Now I need to redefine \glsentryfmt (see §6.1 Changing the format of the link text):
Now the first use won’t have hyperlinked text, but will be followed by a footnote. See the sample file sample-FnDesc.tex for a complete document.
____________________________
Note that the hyperfirst option applies to all defined glossaries. It may be that you only want to disable the hyperlinks on first use for glossaries that have a different form on first use. This can be achieved by noting that since the entries that require hyperlinking for all instances have identical first and subsequent text, they can be unset via \glsunsetall (see §14 Unsetting and Resetting Entry Flags) so that the hyperfirst option doesn’t get applied.
Example 9 (Suppressing Hyperlinks on First Use Just For Acronyms)
Suppose I want to suppress the hyperlink on first use for acronyms but not for entries in the main glossary. I can load the glossaries package using:
Once all glossary entries have been defined I then do:
____________________________
For more complex requirements, you might find it easier to switch off all hyperlinks via \glsdisablehyper and put the hyperlinks (where required) within the definition of \glsentryfmt (see §6.1 Changing the format of the link text) via \glshyperlink (see §9 Using Glossary Terms Without Links).
Example 10 (Only Hyperlink in Text Mode Not Math Mode)
This is a bit of a contrived example, but suppose, for some reason, I only want commands like \gls and \glsdisp to have hyperlinks when used in text mode, but not in math mode. I can do this by disabling all hyperlinks and redefining \glsentryfmt:
To ensure the target exists, the hyperlinks must be enabled again when the glossary is displayed:
(The redefinition of \glossarypostamble is only necessary if the glossary is displayed at the start of the document instead of at the end.) See the sample file sample-nomathhyper.tex for a complete document.
____________________________
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 is now a variation of \glsaddall that skips any entries that have already been used:
This command uses \glsadd[format=@gobble] which will ignore this location in the number list. The optional argument <list> is a comma-separated list of glossary types. If omitted, it defaults to the list of all defined glossaries.
The example file sample-dual.tex makes use of \glsadd to allow for an entry that should appear both in the main glossary and in the list of acronyms. This example sets up the list of acronyms using the acronym package option:
A new command is then defined to make it easier to define dual entries:
This has the following syntax:
You can then define a new dual entry:Now you can reference the acronym with \gls{svm} or you can reference the entry in the main glossary with \gls{main-svm}.
____________________________
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 main part of the document, you will need two runs of makeglossaries:
Note that in this case, the entry with the see key will automatically be added to the glossary, but the cross-referenced entry won’t. You therefore need to ensure that you use the cross-referenced term with the commands described in §6 Links to Glossary Entries or §7 Adding an Entry to the Glossary Without Generating Text.
The “see” tag is produce using \seename, but can be overridden in specific instances using square brackets at the start of the see value. For example:
where <xr label list> is a comma-separated list of entry labels to be cross-referenced, <label> is the label of the entry doing the cross-referencing and <tag> is the “see” tag. (The default value of <tag> is \seename.) 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. (See the sample-crossref.tex example file that comes with this package.) This means that in cases 2 and 3, the cross-referencing information won’t appear if you have suppressed the number list. In this case, you will need to activate the number list for the given entries using nonumberlist=false. Alternatively, if you just use the see key instead of \glssee, you can automatically activate the number list using the seeautonumberlist package option.
When you use either the see key or the command \glssee, the cross-referencing information will be typeset in the glossary according to:
The default definition of \glsseeformat is:
\emph{<tag>} \glsseelist{<label-list>}
The list of labels is dealt with by \glsseelist, which iterates through the list and typesets each entry in the label. The entries are separated by
or (for the last pair)
These default to “,\space” and “\space\andname\space” respectively. The list entry text is displayed using:
This defaults to \glsentrytext{<label>}.3 For example, to make the cross-referenced list use small caps:
These commands display the name of the glossary entry given by <label>, as specified by the name key. \Glsentryname makes the first letter upper case. Neither of these commands check for the existence of <label>. The first form \glsentryname is expandable (unless the name contains unexpandable commands).
This is like \glsnamefont{\glsentryname{<label>}} but also checks for the existence of <label>. This command is not expandable. It’s used in the predefined glossary styles, so if you want to change the way the name is formatted in the glossary, you can redefine \glsnamefont to use the required fonts. For example:
This is like \glossentryname but makes the first letter of the name upper case.
These commands display the subsequent use text for the glossary entry given by <label>, as specified by the text key. \Glsentrytext makes the first letter upper case. The first form is expandable (unless the text contains unexpandable commands). The second form is not expandable. Neither checks for the existence of <label>.
These commands display the subsequent use plural text for the glossary entry given by <label>, as specified by the plural key. \Glsentryplural makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of <label>.
These commands display the first use text for the glossary entry given by <label>, as specified by the first key. \Glsentryfirst makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of <label>.
These commands display the plural form of the first use text for the glossary entry given by <label>, as specified by the firstplural key. \Glsentryfirstplural makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of <label>.
These commands display the description for the glossary entry given by <label>. \Glsentrydesc makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of <label>.
This is like \glsentrydesc{<label>} but also checks for the existence of <label>. This command is not expandable. It’s used in the predefined glossary styles to display the description.
This is like \glossentrydesc but converts the first letter to upper case. This command is not expandable.
These commands display the plural description for the glossary entry given by <label>. \Glsentrydescplural makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of <label>.
These commands display the symbol for the glossary entry given by <label>. \Glsentrysymbol makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of <label>.
This is like \glsentrysymbol{<label>} but also checks for the existence of <label>. This command is not expandable. It’s used in the predefined glossary styles to display the symbol.
This is like \glossentrysymbol but converts the first letter to upper case. This command is not expandable.
These commands display the plural symbol for the glossary entry given by <label>. \Glsentrysymbolplural makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of <label>.
These commands display the value of the user keys for the glossary entry given by <label>. The lower case forms are expandable (unless the value of the key contains unexpandable commands). The commands beginning with an upper case letter convert the first letter of the required value to upper case and are not expandable. None of these commands check for the existence of <label>.
This command provides a hyperlink to the glossary entry given by <label> but does not add any information to the glossary file. The link text is given by \glsentrytext{<label>} by default1, but can be overridden using the optional argument.
The next two commands are only available with the savenumberlist package option:
Both display the number list for the entry given by <label> and require a run of makeglossaries (or xindy or makeindex) followed by one or two runs of LATEX. The first command, \glsentrynumberlist, simply displays the number list as is. The second command, \glsdisplaynumberlist, formats the list using:
as the separator between all but the last two elements and
between the final two elements. The defaults are ,␣ and ␣\&␣, respectively.
For further information see “Displaying entry details without adding information to the glossary” in the documented code (glossaries-code.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
If this mechanism is unsuitable for your chosen class file or page style package, you will need to redefine \glsglossarymark. Further information about these options and commands is given in §2.2 Sectioning, Headings and TOC Options.
Information can be added to the start of the glossary (after the title and before the main body of the glossary) by redefining
For example:
This needs to be done before the glossary is displayed using \printglossaries or \printglossary.
If you want a different preamble per glossary you can use
If <type> is omitted, \glsdefaulttype is used.
For example:
This will print the given preamble text for the main glossary, but not have any preamble text for any other glossaries.
There is an analogous command to \glossarypreamble called
which is placed at the end of each glossary.
Example 12 (Switch to Two Column Mode for Glossary)
Suppose you are using the superheaderborder style1, and you want the glossary to be in two columns, but after the glossary you want to switch back to one column mode, you could do:
____________________________
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.
Example 13 (Changing the Font Used to Display Entry Names in the Glossary)
Suppose you want all the entry names to appear in medium weight small caps in your glossaries, 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. I’m sorry I can’t provide any assistance with writing xindy style files. If you need help, I recommend you ask on the xindy mailing list (http://xindy.sourceforge.net/mailing-list.html).
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 makeglossaries script attempts to find the root language given your document settings, but in the event that it gets it wrong or if xindy doesn’t support that language, then you can specify the required language 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).
If you use xindy, the glossaries package needs to know which counters you will be using in the number list in order to correctly format the xindy style file. Counters specified using the counter package option or the <counter> option of \newglossary are automatically taken care of, but if you plan to use a different counter in the counter key for commands like \glslink, then you need to identify these counters before \makeglossaries using:
where <counter list> is a comma-separated list of counter names.
The most likely attributes used in the format key (textrm, hyperrm etc) are automatically added to the xindy style file, but if you want to use another attribute, you need to add it using:
where <name> is the name of the attribute, as used in the format key.
Example 14 (Custom Font for Displaying a Location)
Suppose I want a bold, italic, hyperlinked location. I first need to define a command that will do this:
but with xindy, I also need to add this as an allowed attribute:
Now I can use it in the optional argument of commands like \gls:
(where sample is the label of the required entry).
____________________________
If the location numbers don’t get expanded to a simple Arabic or Roman number or a letter from a, …, z or A, …, Z, then you need to add a location style in the appropriate format using
where <name> is the name of the format and <definition> is the xindy definition. The optional argument <prefix-location> is needed if \theH<counter> either isn’t defined or is different from \the<counter>.
Example 15 (Custom Numbering System for Locations)
Suppose I decide to use a somewhat eccentric numbering system for sections where I redefine \thesection as follows:
If I haven’t done counter=section in the package option, I need to specify that the counter will be used as a location number:
Next I need to add the location style (\thechapter is assumed to be the standard \arabic{chapter}):
Note that if I have further decided to use the hyperref package and want to redefine \theHsection as:
then I need to modify the \GlsAddXdyLocation code above to:
Since \Roman will result in an empty string if the counter is zero, it’s a good idea to add an extra location to catch this:
This example is illustrated in the sample file samplexdy2.tex.
____________________________
Example 16 (Locations as Words not Digits)
Suppose I want the page numbers written as words rather than digits and I use the fmtcount package to do this. I can redefine \thepage as follows:
This gets expanded to \protect \Numberstringnum {<n>} where <n> is the Arabic page number. This means that I need to define a new location that has that form:
Note that it’s necessary to use \space to indicate that spaces also appear in the format, since, unlike TEX, xindy doesn’t ignore spaces after control sequences.
Note that \GlsAddXdyLocation{<name>}{<definition>} will define commands in the form:
for each counter that has been identified either by the counter package option, the <counter> option for \newglossary or in the argument of \GlsAddXdyCounters.
The first argument <Hprefix> is only relevant when used with the hyperref package and indicates that \the<Hcounter> is given by \Hprefix.\the<counter>. The sample file samplexdy.tex, which comes with the glossaries package, uses the default page counter for locations, and it uses the default \glsnumberformat and a custom \hyperbfit format. A new xindy location called Numberstring, as illustrated above, is defined to make the page numbers appear as “One”, “Two”, etc. In order for the location numbers to hyperlink to the relevant pages, I need to redefine the necessary \glsX<counter>X<format> commands:
____________________________
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 hyphen1), 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 hyphen2), 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:
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.
See §5 Number lists for further details.
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
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 §5 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.
The symbols package option creates a new glossary with the label symbols using:
and the numbers package option creates a new glossary with the label numbers using:
See §1.2.1 Changing the Fixed Names if you want to redefine \glossaryname, especially if you are using babel or translator. (Similarly for \glssymbolsgroupname and \glsnumbersgroupname.)
You may have noticed in §4 Defining Glossary Entries that when you specify a new entry, you can specify alternate text to use when the term is first used in the document. This provides a useful means to define acronyms. For convenience, the glossaries package defines the command:
This uses \newglossaryentry to create an entry with the given label in the glossary given by \acronymtype. It also uses the long, longplural, short and shortplural keys to store the long and abbreviated forms and their plurals.
The optional argument {<key-val list>} allows you to specify keys such as description (when used with one of the styles that require a description, described in §13.1 Changing the Acronym Style) or you can override plural forms of <abbrv> or <long> using the shortplural or longplural keys. For example:
If the first use uses the plural form, \glspl{dm} will display: diagonal matrices (DMs).
Since \newacronym uses \newglossaryentry, you can use commands like \gls and \glsreset as with any other glossary entry.
Example 17 (Defining an Acronym)
The following defines the acronym IDN:
\gls{idn} will produce “identification number (IDN)” on first use and “IDN” on subsequent uses. If you want to use one of the smallcaps acronym styles, described in §13.1 Changing the Acronym Style, you need to use lower case characters for the shortened form:
Now \gls{idn} will produce “identification number (idn)” on first use and “idn” on subsequent uses.
____________________________
There are commands analogous to \glstext (described in §6 Links to Glossary Entries) that allow you to access just the short form, just the long form or the full form, without affecting the first use flag. (Note that the full form isn’t necessarily the same as the text produced on first use.)
This displays the short form for the entry given by <label>. The optional arguments are the same as those for \glstext. There is also a starred version to suppress the hyperlink. There are also analogous upper case variants:
There are also plural versions:
Similarly for the long form:
This displays the long form for the entry given by <label>. The optional arguments are the same as before. There is also a starred version to suppress the hyperlink. There are also analogous upper case variants:
Again there are also plural versions:
And for the full form:
This defaults to <long> (\acronymfont{<short>}). The format (including hyperlinks) can be modified by redefining:
There are also analogous upper case variants:
The formats (including hyperlinks) can be modified by redefining:
As before there are also plural versions:
The formats (including hyperlinks) can be modified by redefining:
If you find the above commands too cumbersome to write, you can use the shortcuts package option to activate the shorter command names listed in table 13.1.
It is also possible to access the long and short forms without adding information to the glossary using commands analogous to \glsentrytext (described in §9 Using Glossary Terms Without Links).
The long form can be accessed using:
or, with the first letter converted to upper case:
Plural forms:
Similarly, to access the short form:
or, with the first letter converted to upper case:
Plural forms:
And the full form, <long> (<short>), can be obtained using:
(These may be redefined by the acronym style.)
It may be that the default style doesn’t suit your requirements in which case you can switch to another styles via
where <style name> is the name of the required style.
Note that unlike the default behaviour of \newacronym, the styles used via \setacronymstyle don’t use the first or text keys, but instead they use \defglsentryfmt to set a custom format that uses the long and short keys (or their plural equivalents). This means that these styles cope better with plurals that aren’t formed by simply appending the singular form with the letter “s”. In fact, most of the predefined styles use \glsgenacfmt and modify the definitions of commands like \genacrfullformat.
Note that when you use \setacronymstyle the name key is set to
These commands are redefined by the acronym styles. However, you can redefine them again after the style has been set but before you use \newacronym. Protected expansion is performed on \acronymsort when the entry is defined.
The glossaries package provides a number of predefined styles. These styles apply
to the short form on first use and
on subsequent use. The styles modify the definition of \acronymfont as required, but \firstacronymfont is only set once by the package when it’s loaded. By default \firstacronymfont{<text>} is the same as \acronymfont{<text>}. If you want the short form displayed differently on first use, you can redefine \firstacronymfont independently of the acronym style.
The predefined styles that contain sc in their name (for example long-sc-short) redefine \acronymfont to use \textsc (so the short form needs to be specified in lower case).
The predefined styles that contain sm in their name (for example long-sm-short) redefine \acronymfont to use \textsmaller.
The remaining predefined styles redefine \acronymfont{<text>} to simply do its argument <text>.
The following styles are supplied by the glossaries package:
With these three styles, acronyms are displayed in the form
on first use and
on subsequent use. They also set \acronymsort{<short>}{<long>} to just <short>. This means that the acronyms are sorted according to their short form. In addition, \acronymentry{<label>} is set to just the short form (enclosed in \acronymfont) and the description key is set to the long form.
These three styles are analogous to the above three styles, except the display order is swapped to
on first use.
Note, however, that \acronymsort and \acronymentry are the same as for the <long> (<short>) styles above, so the acronyms are still sorted according to the short form.
These are like the long-short, long-sc-short and long-sm-short styles described above, except that the description key must be supplied in the optional argument of \newacronym. They also redefine \acronymentry to {<long>} (\acronymfont{<short>}) and redefine \acronymsort{<short>}{<long>} to just <long>. This means that the acronyms are sorted according to the long form, and in the list of acronyms the name field has the long form followed by the short form in parentheses. I recommend you use a glossary style such as altlist with these acronym styles to allow for the long name field.
These styles are analogous to the above three styles, but the first use display style is:
The definitions of \acronymsort and \acronymentry are the same as those for long-short-desc etc.
These styles always display (via \gls) the long form regardless of whether the entry has been used or not. However, \acrfull and \glsentryfull will display <long> (\acronymfont{<short>}). In the case of dua, the name and sort keys are set to the short form and the description is set to the long form. In the case of dua-desc, the name and sort keys are set to the long form and the description is supplied in the optional argument of \newacronym.
These three styles set the first use display to:
However, \acrfull and \glsentryfull are set to \acronymfont{<short>} (<long>). (And similarly for plural and upper case forms.) On subsequent use the display is:
The sort and name keys are set to the short form, and the description is set to the long form.
These three styles are similar to the previous three styles, but the description has to be supplied in the optional argument of \newacronym. The name key is set to the long form followed by the short form in parentheses and the sort key is set to the long form. This means that the acronyms will be sorted according to the long form. In addition, since the name will typically be quite wide it’s best to choose a glossary style that can accommodate this, such as altlist.
Example 18 (Adapting a Predefined Acronym Style)
Suppose I want to use the footnote-sc-desc style, but I want the name key set to the short form followed by the long form in parentheses and the sort key set to the short form. Then I need to specify the footnote-sc-desc style:
and then redefine \acronymsort and \acronymentry:
(I’ve used \space for extra clarity, but you can just use an actual space instead.)
Since the default Computer Modern fonts don’t support bold smallcaps, I’m also going to redefine \acronymfont so that it always switches to medium weight to ensure the smallcaps setting is used:
This isn’t necessary if you use a font that supports bold smallcaps.
The sample file sampleFnAcrDesc.tex illustrates this example.
____________________________
You may find that the predefined acronyms styles that come with the glossaries package don’t suit your requirements. In this case you can define your own style using:
where <style name> is the name of the new style (avoid active characters). The second argument, <display>, is equivalent to the mandatory argument of \defglsentryfmt. You can simply use \glsgenacfmt or you can customize the display using commands like \ifglsused, \glsifplural and \glscapscase. (See §6.1 Changing the format of the link text for further details.) If the style is likely to be used with a mixed glossary (that is entries in that glossary are defined both with \newacronym and \newglossaryentry) then you can test if the entry is an acronym and use \glsgenacfmt if it is or \glsgenentryfmt if it isn’t. For example, the long-short style sets <display> as
(You can use \ifglshasshort instead of \ifglshaslong to test if the entry is an acronym if you prefer.)
The third argument, <definitions>, can be used to redefine the commands that affect the display style, such as \acronymfont or, if <display> uses \glsgenacfmt, \genacrfullformat and its variants.
Note that \setacronymstyle redefines \glsentryfull and \acrfullfmt to use \genacrfullformat (and similarly for the plural and upper case variants). If this isn’t appropriate for the style (as in the case of styles like footnote and dua) \newacronymstyle should redefine these commands within <definitions>.
Within \newacronymstyle’s <definitions> argument you can also redefine
This is a list of additional fields to be set in \newacronym. You can use the following token registers to access the entry label, long form and short form: \glslabeltok \glslabeltok, \glslongtok \glslongtok and \glsshorttok \glsshorttok. As with all TEX registers, you can access their values by preceding the register with \the. For example, the long-short style does:
which sets the description field to the long form of the acronym whereas the long-short-desc style does:
since the description needs to be specified by the user.
It may be that you want to define a new acronym style that’s based on an existing style. Within <display> you can use
to use the <display> definition from the style given by <style name>. Within <definitions> you can use
to use the <definitions> from the style given by <style name>. For example, the long-sc-short acronym style is based on the long-short style with minor modifications (remember to use ## instead of # within <definitions>):
(\glstextup \glstextup is used to cancel the effect of \textsc. This defaults to \textulc, if defined, otherwise \textup. For example, the plural of svm should be rendered as svms rather than svms.)
Example 19 (Defining a Custom Acronym Style)
Suppose I want my acronym on first use to have the short form
in the text and the long form with the description in a footnote.
Suppose also that I want the short form to be put in small caps in
the main body of the document, but I want it in normal capitals
in the list of acronyms. In my list of acronyms, I want the long
form as the name with the short form in brackets followed by the
description. That is, in the text I want \gls on first use to display:
\textsc{<abbrv>}\footnote{<long>: <description>}
\textsc{<abbrv>}
<long> (<short>) <description>
Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the second argument of \newacronymstyle using:
This will use \glsgenentryfmt if the entry isn’t an acronym, otherwise it will use \glsgenacfmt. The third argument (<definitions>) of \newacronymstyle needs to redefine \genacrfullformat etc so that the first use displays the short form in the text with the long form in a footnote followed by the description. This is done as follows (remember to use ## instead of #):
If you think it inappropriate for the short form to be capitalised at the start of a sentence you can change the above to:
Another variation is to use \Glsentrylong and \Glsentrylongpl in the footnote instead of \glsentrylong and \glsentrylongpl.
Now let’s suppose that commands such as \glsentryfull and \acrfull shouldn’t use a footnote, but instead use the format: <long> (<short>). This means that the style needs to redefine \glsentryfull, \acrfullfmt and their plural and upper case variants.
First, the non-linking commands:
Now for the linking commands:
(This may cause problems with long hyperlinks, in which case adjust the definitions so that, for example, only the short form is inside the argument of \glslink.)
The style also needs to redefine \acronymsort so that the acronyms are sorted according to the long form:
If you prefer them to be sorted according to the short form you can change the above to:
The acronym font needs to be set to \textsc and the plural suffix adjusted so that the “s” suffix in the plural short form doesn’t get converted to smallcaps:
There are a number of ways of dealing with the format in the list of acronyms. The simplest way is to redefine \acronymentry to the long form followed by the upper case short form in parentheses:
(I’ve used \Glsentrylong instead of \glsentrylong to capitalise the name in the glossary.)
An alternative approach is to set \acronymentry to just the long form and redefine \GenericAcronymFields to set the symbol key to the short form and use a glossary style that displays the symbol in parentheses after the name (such as the tree style) like this:
I’m going to use the first approach and set \GenericAcronymFields to do nothing:
Finally, this style needs to switch off hyperlinks on first use to avoid nested links:
Putting this all together:
Now I need to specify that I want to use this new style:
I also need to use a glossary style that suits this acronym style, for example altlist:
Once the acronym style has been set, I can define my acronyms:
The sample file sample-custom-acronym.tex illustrates this example.
____________________________
The list of acronyms is just like any other type of glossary and can be displayed on its own using
or with all the other glossaries using \printglossaries. (If you use the acronym package option you can also use as a synonym for See §2.5 Acronym Options.)However, care must be taken to choose a glossary style that’s appropriate to your acronym style. Alternatively, you can define your own custom style (see §16 Defining your own glossary style for further details).
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 package1 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>}
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 13.2 illustrates the effect of \abc (on subsequent use) according to whether or not the xspace package has been loaded. As can be seen from the final row in the table, the xspace package prevents the optional argument from being recognised.
| Table 13.2: | The effect of using xspace with \oldacronym |
| 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 |
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.
For example, the frame environment in beamer processes its argument for each overlay. This means that the first use flag will be unset on the first overlay and subsequent overlays will use the non-first use form.
Consider the following example:
On the first overlay, \gls{svm} produces “support vector machine (SVM)” and then unsets the first use flag. When the second overlay is processed, \gls{svm} now produces “SVM”, which is unlikely to be the desired effect. I don’t know anyway around this and the only suggestion I can give is to explicitly reset each acronym on first use:
This is non-optimal, but the beamer class is too complex for me to suggest an alternative solution.
The amsmath environments, such as align, also process their contents multiple times, but the glossaries package now checks for this.
Glossaries vary from lists that simply contain a symbol with a terse description to lists of terms or phrases with lengthy descriptions. Some glossaries may have terms with associated symbols. Some may have hierarchical entries. There is therefore no single style that fits every type of glossary. The glossaries package comes with a number of pre-defined glossary styles, and you need to choose one that best suits your type of glossary. There is a summary of available styles in table 15.1. If none of them suit your document, you can defined your own style (see §16 Defining your own glossary style).
The predefined styles can accommodate numbered level 0 (main) and level 1 entries. See the package options entrycounter, counterwithin and subentrycounter described in §2.3 Glossary Appearance Options.
| Table 15.1: | Glossary Styles. An asterisk in the style name indicates anything that matches that doesn’t match any previously listed style (e.g. long3col* matches long3col, long3colheader, long3colborder and long3colheaderborder). A maximum level of 0 indicates a flat glossary (sub-entries are displayed in the same way as main entries). Where the maximum level is given as — there is no limit, but note that makeindex imposes a limit of 2 sub-levels. If the homograph column is checked, then the name is not displayed for sub-entries. If the symbol column is checked, then the symbol will be displayed. |
| 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* | — | ✓ | |
| inline | 1 | ✓ |
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.1 These will need to be changed using \setlength if the glossary is too wide. Note that the long4col and super4col styles (and their header and border variations) don’t use these lengths as they are designed for single line entries. Instead you should use the analogous altlong4col and altsuper4col styles. If you want to explicitly create a line-break within a multi-line description in a tabular-like style it’s better to use \newline instead of \\.
Note that if you use the style key in the optional argument to \printglossary, it will override any previous style settings for the given glossary, so if, for example, you do
then the new definition of \glsgroupskip will not have an affect for this glossary, as \glsgroupskip is redefined by style=long. Likewise, \setglossarystyle will also override any previous style definitions, so, again
will reset \glsgroupskip back to its default definition for the named glossary style (long in this case). If you want to modify the styles, either use \newglossarystyle (described in the next section) or make the modifications after \setglossarystyle, e.g.:
As from version 3.03, you can now use the package option nogroupskip to suppress the gap between groups for the default styles instead of redefining \glsgroupskip.
All the styles except for the three- and four-column styles and the listdotted style use the command
after the description. This simply displays a full stop by default. To eliminate this full stop (or replace it with something else, say, a comma) you will need to redefine \glspostdescription before the glossary is displayed. Alternatively, you can suppress it for a given entry by placing \nopostdesc in the entry’s description.
As from version 3.03 you can now use the package option nopostdot to suppress this full stop.
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 §15.3 Longtable Styles (Ragged Right).
The styles described in this section are all defined in the package glossary-longragged. These styles are analogous to those defined in glossary-long but the multiline columns are left justified instead of fully justified. Since these styles all use the longtable environment, they are governed by the same parameters as that environment. The glossary-longragged package additionally requires the array package. Note that these styles will only be available if you explicitly load glossary-longragged:
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.3 These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the analogous styles described in §15.5 Supertabular Styles (Ragged Right).
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.
The glossary-mcols package provides tree-like styles that are in the multicols environment (defined by the multicol package). The style names are as their analogous tree styles (as defined in §15.6 Tree-Like Styles) but are prefixed with “mcol”. For example, the mcolindex style is essentially the index style but put in a multicols environment. For the complete list, see table 15.2.
The default number of columns is 2, but can be changed by redefining
to the required number. For example, for a three column glossary:
| Table 15.2: | Multicolumn Styles |
This section covers the glossary-inline package that supplies the inline style. This is a style that is designed for in-line use (as opposed to block styles, such as lists or tables). This style doesn’t display the number list.
You will most likely need to redefine \glossarysection with this style. For example, suppose you are required to have your glossaries and list of acronyms in a footnote, you can do:
Where you need to include your glossaries as a footnote you can do:
The inline style is governed by the following:
This defaults to “; ” and is used between main (i.e. level 0) entries.
This defaults to “, ” and is used between sub-entries.
This defaults to “: ” and is used between a parent main entry and its first sub-entry.
This defaults to “; ” and is used at the end of the glossary.
where <name> is the name of the new glossary style (to be used in \setglossarystyle). The second argument <definitions> needs to redefine all of the following:
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> consists of a single non-active character or <label> is equal to glssymbols or glsnumbers and \<label>groupname exists, this is taken to be the title, otherwise the title is just <label>. (The “symbols” group has the label glssymbols, so the command \glssymbolsgroupname is used, and the “numbers” group has the label glsnumbers, so the command \glsnumbersgrouptitle is used.) If you are using xindy, <label> may be an active character (for example ø), in which case the title will be set to just <label>. You can redefine \glsgetgrouptitle if this is unsuitable for your document.
A navigation hypertarget can be created using
For further details about \glsnavhypertarget, see the documented code (glossaries-code.pdf).
Most of the predefined glossary styles redefine \glsgroupheading to simply ignore its argument. The 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.
As from version 3.03, the package option nogroupskip can be used to suppress this default gap for the predefined styles.
This macro indicates what to do for each level 0 glossary entry. The entry label is given by <label> and the associated number list is given by <number list>. You can redefine \glossentry to use commands like \glossentryname{<label>}, \glossentrydesc{<label>} and \glossentrysymbol{<label>} to display the name, description and symbol fields, or to access other fields, use commands like \glsentryuseri{<label>}. (See §9 Using Glossary Terms Without Links for further details.) You can also use the following commands:
This macro will increment and display the associated counter for the main (level 0) entries if the entrycounter or counterwithin package options have been used. This macro is typically called by \glossentry before \glstarget. The format of the counter is controlled by the macro
Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the relevant line in the glossary. Your new glossary style must therefore redefine \glossentry to set the appropriate target. This is done using
where <label> is the entry’s label. Note that you don’t need to worry about whether the hyperref package has been loaded, as \glstarget won’t create a target if \hypertarget hasn’t been defined.
For example, the list style defines \glossentry as follows:
Note also that <number list> will always be of the form
where <number(s)> may contain \delimN (to delimit individual numbers) and/or \delimR (to indicate a range of numbers). There may be multiple occurrences of \setentrycounter[<Hprefix>]{<counter name>}<format cmd>{<number(s)>}, but note that the entire number list is enclosed within the argument of \glossaryentrynumbers. The user can redefine this to change the way the entire number list is formatted, regardless of the glossary style. However the most common use of \glossaryentrynumbers is to provide a means of suppressing the number list altogether. (In fact, the nonumberlist option redefines \glossaryentrynumbers to ignore its argument.) Therefore, when you define a new glossary style, you don’t need to worry about whether the user has specified the nonumberlist package option.
This is used to display sub-entries. The first argument, <level>, indicates the sub-entry level. This must be an integer from 1 (first sub-level) onwards. The remaining arguments are analogous to those for \glossentry described above.
This macro will increment and display the associated counter for the level 1 entries if the subentrycounter package option has been used. This macro is typically called by \subglossentry before \glstarget. The format of the counter is controlled by the macro
Note that \printglossary (which \printglossaries calls) sets
to the current glossary label, so it’s possible to create a glossary style that varies according to the glossary type.
For further details of these commands, see “Displaying the glossary” in the documented code (glossaries-code.pdf).
Example 20 (Creating a completely new style)
If you want a completely new style, you will need to redefine all of the commands and the environment listed above.
For example, suppose you want each entry to start with a bullet point. This means that the glossary should be placed in the itemize environment, so theglossary should start and end that environment. Let’s also suppose that you don’t want anything between the glossary groups (so \glsgroupheading and \glsgroupskip should do nothing) and suppose you don’t want anything to appear immediately after \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. It also hasn’t used \glsentryitem or \glssubentryitem so it won’t be affected by the entrycounter, counterwithin or subentrycounter package options.
Variations:
____________________________
Example 21 (Creating a new glossary style based on an existing style)
If you want to define a new style that is a slightly modified version of an existing style, you can use \setglossarystyle within the second argument of \newglossarystyle followed by whatever alterations you require. For example, suppose you want a style like the list style but you don’t want the extra vertical space created by \indexspace between groups, then you can create a new glossary style called, say, mylist as follows:
(In this case, you can actually achieve the same effect using the list style in combination with the package option nogroupskip.)
____________________________
Example 22 (Example: creating a glossary style that uses the user1, …, user6 keys)
Suppose each entry not only has an associated symbol, but also units (stored in user1) and dimension (stored in user2). Then you can define a glossary style that displays each entry in a longtable as follows:
____________________________
This section describes some utility commands. Additional commands can be found in the documented code (glossaries-code.pdf).
This iterates through <glossary list>, a comma-separated list of glossary labels (as supplied when the glossary was defined). At each iteration <cs> (which must be a control sequence) is set to the glossary label for the current iteration and <body> is performed. If <glossary list> is omitted, the default is to iterate over all glossaries.
This iterates through all entries in the glossary given by <glossary label>. At each iteration <cs> (which must be a control sequence) is set to the entry label for the current iteration and <body> is performed. If <glossary label> is omitted, \glsdefaulttype (usually the main glossary) is used.
This is like \forglsentries but for each glossary in <glossary list> (a comma-separated list of glossary labels). If <glossary list> is omitted, the default is the list of all defined glossaries. At each iteration <cs> is set to the entry label and <body> is performed. (The current glossary label can be obtained using \glsentrytype{<cs>} within <body>.)
This checks if the glossary given by <label> exists. If it does <true part> is performed, otherwise <false part>.
This checks if the glossary entry given by <label> exists. If it does <true part> is performed, otherwise <false part>. (Note that \ifglsentryexists will always be true after the containing glossary has been displayed via \printglossary or \printglossaries even if the entry is explicitly defined later in the document. This is because the entry has to be defined before it can be displayed in the glossary, see §4.8.1 Technical Issues for further details.)
Does <code> if the entry given by <label> exists. If it doesn’t exist, an error is generated. (This command uses \ifglsentryexists.)
Does the reverse of \glsdoifexists. (This command uses \ifglsentryexists.)
See §14 Unsetting and Resetting Entry Flags.
This checks if the glossary entry given by <label> has any sub-entries. If it does, <true part> is performed, otherwise <false part>.
This checks if the glossary entry given by <label> has a parent entry. If it does, <true part> is performed, otherwise <false part>.
This checks if the glossary entry given by <label> has had the symbol field set. If it has, <true part> is performed, otherwise <false part>.
This checks if the glossary entry given by <label> has had the long field set. If it has, <true part> is performed, otherwise <false part>. This should be true for any entry that has been defined via \newacronym.
This checks if the glossary entry given by <label> has had the short field set. If it has, <true part> is performed, otherwise <false part>. This should be true for any entry that has been defined via \newacronym.
This checks if the description field is non-empty for the entry given by <label>. If it has, <true part> is performed, otherwise <false part>. Compare with:
This checks if the description field has been set to just \nopostdesc for the entry given by <label>. If it has, <true part> is performed, otherwise <false part>.
The glossaries-prefix package provides additional keys that can be used as prefixes. For example, if you want to specify determiners (such as “a”, “an” or “the”). The glossaries-prefix package automatically loads the glossaries package and has the same package options.
The extra keys for \newglossaryentry are as follows:
Example 23 (Defining Determiners)
Here’s the start of my example document:
Note that I’ve simply replaced glossaries from previous sample documents with glossaries-prefix. Now for a sample definition1:
Note that I’ve had to explicitly insert a space after the prefix. This allows for the possibility of prefixes that shouldn’t have a space, such as:
Where a space is required at the end of the prefix, you must use a spacing command, such as \space, \␣ (backslash space) or ~ due to the automatic spacing trimming performed in <key>=<value> options.
The prefixes can also be used with acronyms. For example:
____________________________
The glossaries-prefix package provides convenient commands to use these prefixes with commands such as \gls. Note that the prefix is not considered part of the link text, so it’s not included in the hyperlink (where hyperlinks are enabled).
This is prepends the value of the prefix key (or prefixfirst key, on first use) in front of \gls[<options>]{<label>}[<insert>].
If the prefix key (or prefixfirst, on first use) has been set, this displays the value of that key with the first letter converted to upper case followed by \gls[<options>]{<label>}[<insert>]. If that key hasn’t been set, this is equivalent to \Gls[<options>]{<label>}[<insert>].
As \pgls but converts the prefix to upper case and uses \GLS instead of \gls.
This is prepends the value of the prefixplural key (or prefixfirstplural key, on first use) in front of \glspl[<options>]{<label>}[<insert>].
If the prefixplural key (or prefixfirstplural, on first use) has been set, this displays the value of that key with the first letter converted to upper case followed by \glspl[<options>]{<label>}[<insert>]. If that key hasn’t been set, this is equivalent to \Glspl[<options>]{<label>}[<insert>].
As \pglspl but converts the prefix to upper case and uses \GLSpl instead of \glspl.
Continuing from Example 23, now that I’ve defined my entries, I can use them in the text via the above commands:
which produces:
First use: a support vector machine (SVM). Next use: an SVM. Singular: a sample, l’oeil. Plural: the samples, les yeux.
For a complete document, see sample-prefix.tex.
____________________________
This package also provides the following commands:
Does <true part> if the entry identified by <label> has a non-empty value for the prefix key.
This package also provides the following commands:
Does <true part> if the entry identified by <label> has a non-empty value for the prefixplural key.
Does <true part> if the entry identified by <label> has a non-empty value for the prefixfirst key.
Does <true part> if the entry identified by <label> has a non-empty value for the prefixfirstplural key.
Displays the value of the prefix key for the entry given by <label>. (No check is performed to determine if the entry exists.)
Displays the value of the prefixfirst key for the entry given by <label>. (No check is performed to determine if the entry exists.)
Displays the value of the prefixplural key for the entry given by <label>. (No check is performed to determine if the entry exists.)
Displays the value of the prefixfirstplural key for the entry given by <label>. (No check is performed to determine if the entry exists.)
There are also variants that convert the first letter to upper case2:
Example 25 (Adding Determiner to Glossary Style)
You can use the above commands to define a new glossary style that uses the determiner. For example, the following style is a slight modification of the list style that inserts the prefix before the name:
____________________________
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
The sample file sampleaccsupp.tex illustrates the glossaries-accsupp package.
See the documented code (glossaries-code.pdf) for further details. It is recommended that you also read the accsupp documentation.
The glossaries package comes with a minimal file called minimalgls.tex which can be used for testing. This should be located in the samples subdirectory (folder) of the glossaries documentation directory. The location varies according to your operating system and TEX installation. For example, on my Linux partition it can be found in /usr/local/texlive/2013/texmf-dist/doc/latex/glossaries/. Further information on debugging LATEX code is available at http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/.
Below is a list of the most frequently asked questions. For other queries, consult the glossaries FAQ at http://www.dickimaw-books.com/faqs/glossariesfaq.html. If that doesn’t help, try posting your query to somewhere like the comp.text.tex newsgroup, the LATEX Community Forum (http://www.latex-community.org/) or TEX on StackExchange (http://tex.stackexchange.com/). Bug reports can be submitted at http://www.dickimaw-books.com/bug-report.html.
A. This error can occur if you have a fragile command in one of your entry definitions. In most cases using \glsnoexpandfields before defining your entry should fix this, but there are still a few fragile commands that will still cause this error even with \glsnoexpandfields. If this is the case put \protect in front of the fragile command.
A. Check you are using an up to date version of the xkeyval package.
A. xindy discards all commands and braces from the sort string. If your sort string (either specified by the sort key or the name key) only consists of commands, this will be treated by xindy as an empty sort string, which produces an error message in newer versions of xindy. For example, the following will cause a problem:
Either use a different sort key for the entry, for example:
or, if all entries are like this, you may prefer to use the sort=use or sort=def package options. See §2.4 Sorting Options for further details of the sort option.
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. No. Although it is strongly recommended, you don’t have to use makeglossaries. If you prefer a GUI application and have Java installed, you can use makeglossariesgui instead. Otherwise you can just call makeindex explicitly (see §1.3.3 Using makeindex explicitly). Note that you can’t use xindy if you don’t have Perl installed.
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 using the glossaries package option translate=babel. Also, try adding the language as a global option to the class file.
A. Remember to do the following:
A. Because you haven’t used any entries in the main glossary via commands such as \gls. If you don’t want to use this glossary, you can suppress its creation via the package option nomain.
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.
If you want to sort according to order of definition or order of use, use the sort package option described in §2.4 Sorting Options.
A. TeX4HT seems to have a problem with the glossary styles that use \indexspace. I don’t know enough about TeX4HT to find out why. Either use a different glossary style or redefine the style command that uses \indexspace. For example, if you are using the list style, try:
or
Symbols
A
\Ac 7
\ac 8
accsupp package 9, 10
\Acf 11
\acf 12
\Acfp 13
\acfp 14
\Acl 15
\acl 16
\Aclp 17
\aclp 18
\Acp 19
\acp 20
\ACRfull 21
\Acrfull 22, 23
\acrfull 24, 25, 26, 27, 28, 29
\ACRfullfmt 30
\Acrfullfmt 31
\acrfullfmt 32, 33, 34
\ACRfullpl 35
\Acrfullpl 36, 37
\acrfullpl 38, 39
\ACRfullplfmt 40
\Acrfullplfmt 41
\acrfullplfmt 42
\ACRlong 43
\Acrlong 44, 45
\acrlong 46, 47
\ACRlongpl 48
\Acrlongpl 49, 50
\acrlongpl 51, 52
acronym styles:
dua 53, 54, 55, 56
dua-desc 57, 58
footnote 59, 60, 61
footnote-desc 62
footnote-sc 63
footnote-sc-desc 64, 65, 66, 67
footnote-sm 68
footnote-sm-desc 69
long-sc-short 70, 71, 72, 73
long-sc-short-desc 74
long-short 75, 76, 77, 78, 79, 80
long-short-desc 81, 82, 83
long-sm-short 84, 85, 86
long-sm-short-desc 87
sc-short-long 88
sc-short-long-desc 89
short-long 90
short-long-desc 91
sm-short-long 92
sm-short-long-desc 93
\acronymentry 94, 95, 96, 97, 98, 99
\acronymfont 100, 101, 102, 103, 104, 105, 106, 107, 108, 109
\acronymname 110
\acronymsort 111, 112, 113, 114, 115
\acronymtype 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126
\ACRshort 127
\Acrshort 128, 129
\acrshort 130, 131, 132
\ACRshortpl 133
\Acrshortpl 134, 135
\acrshortpl 136, 137
\Acs 138
\acs 139
\Acsp 140
\acsp 141
\addcontentsline 142
align (environment) 143
amsmath package 144
\andname 145
arara 146
array package 147, 148
B
babel package 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164
beamer class 165, 166
beamer package 167
C
\chapter 168
\chapter* 169, 170
\currentglossary 171
D
\DeclareAcronymList 172
\defglsentryfmt 173, 174, 175, 176, 177, 178, 179
\DefineAcronymShortcuts 180
\delimN 181
\delimR 182
description (environment) 183, 184, 185, 186, 187
\descriptionname 188
doc package 189, 190, 191
document (environment) 192, 193, 194
E
\emph 195
\entryname 196
environments:
align 197
description 198, 199, 200, 201, 202
document 203, 204, 205
equation 206
frame 207
itemize 208
longtable 209, 210, 211, 212, 213, 214
multicols 215, 216
supertabular 217, 218, 219, 220, 221
theglossary 222, 223, 224, 225
equation (environment) 226
etex package 227
etoolbox package 228, 229
F
file types
.alg 230
.aux 231, 232, 233
.glg 234, 235, 236, 237
.glg2 238
.glo 239, 240, 241, 242, 243
.gls 244, 245, 246
.glsdefs 247
.ist 248, 249, 250, 251, 252, 253
.log 254
.tex 255, 256
.xdy 257, 258, 259, 260, 261, 262, 263, 264
glo2 265
gls2 266
first use 267
flag 268, 269
text 270
\firstacronymfont 271, 272, 273, 274, 275, 276, 277, 278
flowfram package 279
fmtcount package 280
\footnote 281
\forallglossaries 282
\forallglsentries 283
\forglsentries 284
frame (environment) 285
G
\Genacrfullformat 286
\genacrfullformat 287, 288, 289, 290, 291, 292
\GenericAcronymFields 293, 294, 295
\Genplacrfullformat 296
\genplacrfullformat 297, 298
german package 299
glossaries-accsupp package 300, 301, 302, 303, 304
glossaries-babel package 305, 306
glossaries-polyglossia package 307, 308
glossaries-prefix package 309, 310, 311, 312, 313
glossary counters:
glossaryentry 314
glossarysubentry 315
glossary package 316, 317, 318, 319, 320, 321
glossary styles:
altlist 322, 323, 324, 325, 326
altlistgroup 327, 328
altlisthypergroup 329
altlong4col 330, 331, 332
altlong4colborder 333
altlong4colheader 334
altlong4colheaderborder 335
altlongragged4col 336, 337, 338
altlongragged4colborder 339
altlongragged4colheader 340, 341
altlongragged4colheaderborder 342
altsuper4col 343, 344, 345
altsuper4colborder 346
altsuper4colheader 347
altsuper4colheaderborder 348
altsuperragged4col 349, 350, 351
altsuperragged4colborder 352
altsuperragged4colheader 353, 354
altsuperragged4colheaderborder 355
alttree 356, 357, 358, 359
alttreegroup 360, 361, 362
alttreehypergroup 363, 364
index 365, 366, 367, 368, 369
indexgroup 370, 371, 372
indexhypergroup 373, 374
inline 375, 376, 377
list 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391
listdotted 392, 393, 394
listgroup 395, 396
listhypergroup 397, 398, 399, 400, 401, 402, 403
long 404, 405, 406, 407, 408
long3col 409, 410, 411, 412, 413
long3colborder 414, 415
long3colheader 416, 417, 418
long3colheaderborder 419, 420
long4col 421, 422, 423, 424, 425
long4colborder 426, 427
long4colheader 428, 429, 430
long4colheaderborder 431, 432
longborder 433
longheader 434, 435, 436
longheaderborder 437, 438
longragged 439, 440, 441, 442
longragged3col 443, 444, 445, 446
longragged3colborder 447
longragged3colheader 448, 449
longragged3colheaderborder 450
longraggedborder 451
longraggedheader 452, 453
longraggedheaderborder 454
mcolalttree 455
mcolalttreegroup 456
mcolalttreehypergroup 457
mcolindex 458, 459
mcolindexgroup 460
mcolindexhypergroup 461
mcoltree 462
mcoltreegroup 463
mcoltreehypergroup 464
mcoltreenoname 465
mcoltreenonamegroup 466
mcoltreenonamehypergroup 467
super 468, 469, 470, 471
super3col 472, 473, 474, 475
super3colborder 476
super3colheader 477, 478
super3colheaderborder 479
super4col 480, 481, 482, 483, 484
super4colborder 485, 486
super4colheader 487, 488, 489
super4colheaderborder 490, 491
superborder 492
superheader 493, 494
superheaderborder 495, 496
superragged 497, 498, 499, 500
superragged3col 501, 502, 503, 504
superragged3colborder 505
superragged3colheader 506, 507
superragged3colheaderborder 508
superraggedborder 509
superraggedheader 510, 511
superraggedheaderborder 512
tree 513, 514, 515, 516, 517, 518
treegroup 519, 520, 521
treehypergroup 522, 523
treenoname 524, 525, 526
treenonamegroup 527, 528, 529
treenonamehypergroup 530, 531
glossary-inline package 532, 533
glossary-list package 534, 535, 536, 537, 538
glossary-long package 539, 540, 541, 542, 543, 544
glossary-longragged package 545, 546, 547
glossary-mcols package 548, 549, 550, 551
glossary-super package 552, 553, 554, 555, 556, 557
glossary-superragged package 558, 559, 560
glossary-tree package 561, 562, 563, 564, 565
glossaryentry (counter) 566
glossaryentry counter 567, 568, 569
\glossaryentrynumbers 570, 571, 572, 573
\glossaryheader 574, 575, 576, 577
\glossaryname 578, 579
\glossarypostamble 580, 581, 582
\glossarypreamble 583, 584, 585, 586
\glossarysection 587
\glossarystyle 588
glossarysubentry (counter) 589
\glossentry 590, 591, 592
\Glossentrydesc 593
\glossentrydesc 594, 595
\Glossentryname 596, 597
\glossentryname 598, 599, 600
\Glossentrysymbol 601
\glossentrysymbol 602, 603
\GLS 604, 605, 606, 607
\Gls 608, 609, 610, 611, 612, 613, 614, 615, 616, 617
\gls 618, 619, 620, 621, 622, 623, 624, 625, 626, 627, 628, 629, 630, 631, 632, 633, 634, 635, 636, 637, 638, 639, 640, 641, 642, 643, 644, 645, 646, 647, 648, 649, 650, 651, 652, 653, 654, 655
\gls* 656
\glsadd 657
\glsaddall 658, 659
\glsaddall options
types 660
\glsaddallunused 661
\glsaddkey 662, 663, 664, 665
\GlsAddXdyAttribute 666, 667
\GlsAddXdyCounters 668, 669
\GlsAddXdyLocation 670, 671
\glsautoprefix 672
\glscapscase 673, 674
\glsclearpage 675
\glsclosebrace 676
\glscustomtext 677
\GlsDeclareNoHyperList 678, 679, 680, 681, 682
\glsdefaulttype 683, 684, 685, 686, 687, 688
\GLSdesc 689
\Glsdesc 690
\glsdesc 691
\glsdescwidth 692, 693, 694, 695, 696, 697, 698, 699, 700, 701, 702, 703
\glsdisablehyper 704, 705
\glsdisp 706, 707, 708, 709, 710, 711, 712, 713, 714
\glsdisplay 715, 716
\glsdisplayfirst 717, 718
\glsdisplaynumberlist 719, 720
\glsdoifexists 721
\glsdoifnoexists 722
\glsdosanitizesort 723
\glsenablehyper 724
\glsentrycounterlabel 725
\Glsentrydesc 726
\glsentrydesc 727
\Glsentrydescplural 728
\glsentrydescplural 729
\Glsentryfirst 730
\glsentryfirst 731
\Glsentryfirstplural 732
\glsentryfirstplural 733
\glsentryfmt 734, 735, 736, 737, 738, 739, 740, 741, 742, 743
\Glsentryfull 744
\glsentryfull 745, 746, 747, 748, 749, 750
\Glsentryfullpl 751
\glsentryfullpl 752
\glsentryitem 753, 754
\Glsentrylong 755, 756, 757, 758
\glsentrylong 759, 760, 761
\Glsentrylongpl 762, 763
\glsentrylongpl 764, 765
\Glsentryname 766
\glsentryname 767, 768
\glsentrynumberlist 769, 770
\Glsentryplural 771
\glsentryplural 772
\Glsentryprefix 773
\glsentryprefix 774
\Glsentryprefixfirst 775
\glsentryprefixfirst 776
\Glsentryprefixfirstplural 777
\glsentryprefixfirstplural 778
\Glsentryprefixplural 779
\glsentryprefixplural 780
\Glsentryshort 781
\glsentryshort 782
\Glsentryshortpl 783
\glsentryshortpl 784
\Glsentrysymbol 785
\glsentrysymbol 786, 787
\Glsentrysymbolplural 788
\glsentrysymbolplural 789
\Glsentrytext 790, 791
\glsentrytext 792, 793, 794, 795, 796, 797
\Glsentryuseri 798
\glsentryuseri 799, 800
\Glsentryuserii 801
\glsentryuserii 802
\Glsentryuseriii 803
\glsentryuseriii 804
\Glsentryuseriv 805
\glsentryuseriv 806
\Glsentryuserv 807
\glsentryuserv 808
\Glsentryuservi 809
\glsentryuservi 810
\glsexpandfields 811
\GLSfirst 812
\Glsfirst 813
\glsfirst 814
\GLSfirstplural 815
\Glsfirstplural 816
\glsfirstplural 817
\glsgenacfmt 818, 819, 820, 821, 822, 823
\glsgenentryfmt 824, 825, 826
\glsgetgrouptitle 827
\glsglossarymark 828, 829, 830, 831, 832
\glsgroupheading 833, 834
\glsgroupskip 835, 836, 837
\glshyperlink 838, 839, 840
\glshypernavsep 841
\glsIfListOfAcronyms 842
\glsifplural 843, 844
\glsinlineparentchildseparator 845, 846
\glsinlineseparator 847, 848
\glsinlinesubseparator 849, 850
\glsinsert 851
\glslabel 852
\glslabeltok 853
\glslink 854, 855, 856, 857, 858, 859, 860, 861, 862, 863, 864
\glslink options
counter 865, 866
format 867, 868, 869, 870, 871
hyper 872, 873, 874, 875
local 876
\glslink* 877
\glslistdottedwidth 878
\glslocalreset 879
\glslocalresetall 880
\glslocalunset 881
\glslocalunsetall 882
\glslongtok 883
\glsmcols 884
\glsmoveentry 885
\GLSname 886
\Glsname 887
\glsname 888
\glsnamefont 889, 890
\glsnavhypertarget 891
\glsnoexpandfields 892
\glsnumberformat 893
\glsnumbersgroupname 894
\glsnumbersgrouptitle 895
\glsnumlistlastsep 896
\glsnumlistsep 897
\glsopenbrace 898
\glspagelistwidth 899, 900, 901, 902, 903, 904, 905, 906
\glspar 907
\GLSpl 908, 909, 910, 911, 912
\Glspl 913, 914, 915, 916, 917, 918, 919
\glspl 920, 921, 922, 923, 924, 925, 926, 927, 928, 929, 930, 931, 932, 933, 934
\GLSplural 935
\Glsplural 936
\glsplural 937
\glspluralsuffix 938, 939, 940, 941
\glspostdescription 942
\glspostinline 943, 944
\glsprestandardsort 945, 946
\glsquote 947
\glsrefentry 948, 949, 950
\glsreset 951, 952
\glsresetall 953
\glsresetentrycounter 954
\glssee 955, 956, 957, 958, 959, 960
\glsseeformat 961, 962, 963
\glsseeitemformat 964
\glsseelastsep 965
\glsseelist 966, 967
\glsseesep 968
\glsSetAlphaCompositor 969
\glsSetCompositor 970
\glssetexpandfield 971
\glssetnoexpandfield 972
\glsSetSuffixF 973
\glsSetSuffixFF 974
\glssetwidest 975
\GlsSetXdyCodePage 976, 977, 978
\GlsSetXdyFirstLetterAfterDigits 979
\GlsSetXdyLanguage 980, 981, 982, 983
\GlsSetXdyLocationClassOrder 984
\GlsSetXdyMinRangeLength 985, 986
\glsshorttok 987
\glssortnumberfmt 988
\glssubentrycounterlabel 989
\glssubentryitem 990, 991
\GLSsymbol 992
\Glssymbol 993
\glssymbol 994, 995
\glssymbolsgroupname 996, 997
\glstarget 998, 999
\GLStext 1000, 1001
\Glstext 1002, 1003
\glstext 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014
\glstextformat 1015, 1016, 1017
\glstextup 1018
\glstocfalse 1019
\glstoctrue 1020
\glstreeindent 1021
\glsunset 1022
\glsunsetall 1023, 1024
\GlsUseAcrEntryDispStyle 1025
\GlsUseAcrStyleDefs 1026
\GLSuseri 1027
\Glsuseri 1028
\glsuseri 1029
\GLSuserii 1030
\Glsuserii 1031
\glsuserii 1032
\GLSuseriii 1033
\Glsuseriii 1034
\glsuseriii 1035
\GLSuseriv 1036
\Glsuseriv 1037
\glsuseriv 1038
\GLSuserv 1039
\Glsuserv 1040
\glsuserv 1041
\GLSuservi 1042
\Glsuservi 1043
\glsuservi 1044
H
html package 1045
\hyperbf 1046
\hyperbsf 1047
\hyperemph 1048
\hyperit 1049
\hyperlink 1050, 1051, 1052
\hypermd 1053
\hyperpage 1054
hyperref package 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071
\hyperrm 1072, 1073
\hypersc 1074
\hypersf 1075
\hypersl 1076
\hypertarget 1077
\hypertt 1078
\hyperup 1079
I
\ifglossaryexists 1080
\ifglsdescsuppressed 1081
\ifglsentryexists 1082
\ifglshaschildren 1083
\ifglshasdesc 1084
\ifglshaslong 1085, 1086
\ifglshasparent 1087
\ifglshasprefix 1088
\ifglshasprefixfirst 1089
\ifglshasprefixfirstplural 1090
\ifglshasprefixplural 1091
\ifglshasshort 1092, 1093
\ifglshassymbol 1094, 1095
\ifglsucmark 1096
\ifglsused 1097, 1098, 1099, 1100
imakeidx package 1101
\index 1102, 1103, 1104, 1105, 1106
index package 1107
\indexspace 1108, 1109, 1110, 1111, 1112
inputenc package 1113, 1114, 1115, 1116
\inputencodingname 1117
\item 1118, 1119
itemize (environment) 1120
L
\label 1123
latex 1124, 1125
latexmk 1126
link text 1127, 1128, 1129, 1130, 1131, 1132, 1133, 1134, 1135, 1136, 1137
\loadglsentries 1138, 1139, 1140
location list see number list
\longnewglossaryentry 1142, 1143, 1144, 1145
\longprovideglossaryentry 1146
longtable (environment) 1147, 1148, 1149, 1150, 1151, 1152
longtable package 1153, 1154
M
\makefirstuc 1155, 1156
makeglossaries 1157
makeglossaries 1158, 1159, 1160, 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168, 1169, 1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177, 1178, 1179, 1180, 1181, 1182, 1183, 1184, 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203, 1204, 1205, 1206, 1207, 1208, 1209, 1210, 1211, 1212, 1213, 1214, 1215, 1216, 1217, 1218, 1219, 1220
\makeglossaries 1221, 1222, 1223, 1224, 1225, 1226, 1227, 1228, 1229, 1230, 1231, 1232, 1233, 1234, 1235, 1236, 1237, 1238, 1239, 1240, 1241
makeglossariesgui 1242
makeglossariesgui 1243, 1244, 1245, 1246, 1247
makeidx package 1248
makeindex 1249
makeindex 1250, 1251, 1252, 1253, 1254, 1255, 1256, 1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274, 1275, 1276, 1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321
\MakeTextUppercase 1322
memoir class 1323, 1324, 1325
\memUChead 1326
mfirstuc package 1327, 1328
\mfirstucMakeUppercase 1329
multicol package 1330
multicols (environment) 1331, 1332
N
nameref package 1333
\newacronym 1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344, 1345, 1346, 1347, 1348, 1349, 1350, 1351, 1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359, 1360, 1361
\newacronymstyle 1362, 1363, 1364
\newdualentry 1365
\newglossary 1366, 1367, 1368, 1369, 1370, 1371
\newglossaryentry 1372, 1373, 1374, 1375, 1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390
\newglossaryentry options
access 1391
description 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405
descriptionaccess 1406
descriptionplural 1407, 1408, 1409, 1410
descriptionpluralaccess 1411
first 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431
firstaccess 1432
firstplural 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449
firstpluralaccess 1450
format 1451
long 1452, 1453, 1454, 1455, 1456, 1457
longaccess 1458
longplural 1459, 1460, 1461, 1462, 1463, 1464
longpluralaccess 1465
name 1466, 1467, 1468, 1469, 1470, 1471, 1472, 1473, 1474, 1475, 1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484, 1485, 1486, 1487, 1488, 1489, 1490
nonumberlist 1491
parent 1492, 1493, 1494, 1495
plural 1496, 1497, 1498, 1499, 1500, 1501, 1502, 1503, 1504, 1505, 1506, 1507, 1508, 1509
pluralaccess 1510
prefix 1511, 1512, 1513, 1514, 1515, 1516, 1517
prefixfirst 1518, 1519, 1520, 1521, 1522
prefixfirstplural 1523, 1524, 1525, 1526, 1527
prefixplural 1528, 1529, 1530, 1531, 1532, 1533
see 1534, 1535, 1536, 1537, 1538, 1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547
short 1548, 1549, 1550, 1551, 1552, 1553
shortaccess 1554
shortplural 1555, 1556, 1557, 1558, 1559, 1560
shortpluralaccess 1561
sort 1562, 1563, 1564, 1565, 1566, 1567, 1568, 1569, 1570, 1571, 1572, 1573, 1574, 1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584
symbol 1585, 1586, 1587, 1588, 1589, 1590, 1591, 1592, 1593
symbolaccess 1594
symbolplural 1595, 1596, 1597
symbolpluralaccess 1598
text 1599, 1600, 1601, 1602, 1603, 1604, 1605, 1606, 1607, 1608, 1609, 1610, 1611, 1612, 1613
textaccess 1614
type 1615, 1616
user1 1617, 1618, 1619, 1620, 1621
user2 1622, 1623, 1624
user3 1625, 1626
user4 1627, 1628
user5 1629, 1630
user6 1631, 1632, 1633
\newglossarystyle 1634, 1635, 1636, 1637
\newline 1638, 1639
\newterm 1640
ngerman package 1641, 1642
\nohyperpage 1643
\noist 1644, 1645, 1646, 1647, 1648, 1649, 1650, 1651, 1652, 1653, 1654, 1655
\nopostdesc 1656, 1657, 1658, 1659, 1660, 1661
number list 1662, 1663, 1664, 1665, 1666, 1667, 1668, 1669, 1670, 1671, 1672, 1673, 1674, 1675, 1676, 1677, 1678, 1679, 1680, 1681, 1682, 1683, 1684, 1685, 1686, 1687, 1688, 1689, 1690, 1691, 1692, 1693, 1694, 1695, 1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704, 1705, 1706
\numberline 1707
P
package options:
acronym 1710, 1711, 1712, 1713, 1714, 1715, 1716, 1717, 1718, 1719, 1720, 1721, 1722, 1723, 1724, 1725, 1726, 1727, 1728, 1729, 1730, 1731, 1732, 1733
true 1734, 1735
acronymlists 1736, 1737, 1738, 1739
acronyms 1740, 1741
compatible-2.07 1742, 1743, 1744
compatible-3.07 1745, 1746, 1747
counter 1748, 1749, 1750, 1751, 1752
page 1753
counterwithin 1754, 1755, 1756, 1757, 1758
description 1759, 1760, 1761, 1762, 1763, 1764, 1765, 1766, 1767
dua 1768, 1769
entrycounter 1770, 1771, 1772, 1773, 1774
false 1775
true 1776
footnote 1777, 1778, 1779, 1780, 1781, 1782
hyperfirst 1783, 1784, 1785
false 1786, 1787, 1788, 1789, 1790
true 1791
index 1792, 1793, 1794, 1795
makeindex 1796, 1797, 1798
nogroupskip 1799, 1800, 1801, 1802, 1803
false 1804
nohypertypes 1805, 1806, 1807, 1808, 1809, 1810, 1811
index 1812
nolist 1813, 1814, 1815
nolong 1816, 1817, 1818, 1819
nomain 1820, 1821, 1822, 1823, 1824, 1825, 1826, 1827, 1828
nonumberlist 1829, 1830, 1831, 1832, 1833, 1834, 1835, 1836
nopostdot 1837, 1838
false 1839
nostyles 1840, 1841, 1842, 1843, 1844, 1845, 1846
nosuper 1847, 1848, 1849, 1850
notranslate 1851, 1852
notree 1853, 1854, 1855
nowarn 1856, 1857
numberedsection 1858, 1859, 1860, 1861, 1862
autolabel 1863, 1864
false 1865
nameref 1866
nolabel 1867
numberline 1868, 1869
numbers 1870, 1871, 1872
order 1873, 1874
letter 1875, 1876, 1877
word 1878, 1879, 1880
sanitizesort 1881, 1882
false 1883, 1884
true 1885
savenumberlist 1886, 1887
false 1888
savewrites 1889, 1890, 1891
false 1892
section 1893, 1894
seeautonumberlist 1895, 1896, 1897, 1898
shortcuts 1899, 1900, 1901
smallcaps 1902, 1903, 1904, 1905, 1906, 1907, 1908, 1909
smaller 1910, 1911, 1912, 1913, 1914, 1915, 1916
sort 1917, 1918, 1919
def 1920, 1921, 1922, 1923, 1924, 1925, 1926
standard 1927, 1928, 1929
use 1930, 1931, 1932, 1933, 1934, 1935, 1936
style 1937, 1938, 1939, 1940, 1941, 1942, 1943
list 1944
subentrycounter 1945, 1946, 1947, 1948, 1949, 1950
false 1951
symbols 1952, 1953, 1954
toc 1955, 1956, 1957, 1958, 1959
translate 1960, 1961, 1962, 1963
babel 1964, 1965, 1966, 1967, 1968, 1969
false 1970, 1971, 1972, 1973, 1974
true 1975, 1976, 1977, 1978
ucfirst 1979
ucmark 1980, 1981
false 1982
true 1983
xindy 1984, 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996
xindygloss 1997, 1998
xindynoglsnumbers 1999, 2000
page counter 2001
\pagelistname 2002
pdflatex 2003, 2004
\PGLS 2005
\Pgls 2006
\pgls 2007
\PGLSpl 2008
\Pglspl 2009
\pglspl 2010
pod2man 2011
polyglossia package 2012, 2013, 2014, 2015, 2016
\printacronyms 2017, 2018
\printglossaries 2019, 2020, 2021, 2022, 2023, 2024, 2025
\printglossary 2026, 2027, 2028, 2029, 2030, 2031, 2032, 2033, 2034, 2035, 2036, 2037, 2038, 2039, 2040
\printglossary options
nonumberlist 2041
numberedsection 2042
style 2043, 2044, 2045, 2046
title 2047, 2048
toctitle 2049
type 2050
\printindex 2051
\printnumbers 2052
\printsymbols 2053
\provideglossaryentry 2054
R
relsize package 2055, 2056
\Roman 2057
S
sanitize 2058, 2059, 2060, 2061
scrwfile package 2062
\section* 2063, 2064
\seename 2065, 2066, 2067, 2068
\SetAcronymLists 2069
\setacronymstyle 2070, 2071, 2072
\setAlphaCompositor 2073
\setCompositor 2074
\setentrycounter 2075, 2076
\setglossarypreamble 2077, 2078
\setglossarysection 2079, 2080
\setglossarystyle 2081, 2082, 2083, 2084, 2085, 2086, 2087
\setStyleFile 2088, 2089, 2090
\setupglossaries 2091
\subglossentry 2092
supertabular (environment) 2093, 2094, 2095, 2096, 2097
supertabular package 2098, 2099, 2100
\symbolname 2101
T
TeX4HT 2102
\textbf 2103
textcase package 2104, 2105
\textrm 2106
\textsc 2107, 2108, 2109, 2110, 2111, 2112, 2113
\textsmaller 2114, 2115, 2116, 2117
\textulc 2118
\textup 2119
\the 2120
theglossary (environment) 2121, 2122, 2123, 2124
\thepage 2125
translator package 2126, 2127, 2128, 2129, 2130, 2131, 2132, 2133, 2134, 2135, 2136, 2137, 2138, 2139, 2140
W
\write18 2141
X
xindy 2142
xindy 2143, 2144, 2145, 2146, 2147, 2148, 2149, 2150, 2151, 2152, 2153, 2154, 2155, 2156, 2157, 2158, 2159, 2160, 2161, 2162, 2163, 2164, 2165, 2166, 2167, 2168, 2169, 2170, 2171, 2172, 2173, 2174, 2175, 2176, 2177, 2178, 2179, 2180, 2181, 2182, 2183, 2184, 2185, 2186, 2187, 2188, 2189, 2190, 2191, 2192, 2193, 2194, 2195, 2196, 2197, 2198, 2199, 2200, 2201, 2202, 2203, 2204, 2205, 2206, 2207, 2208, 2209, 2210, 2211, 2212, 2213, 2214, 2215, 2216, 2217, 2218, 2219, 2220, 2221, 2222, 2223, 2224, 2225, 2226, 2227, 2228, 2229, 2230, 2231, 2232, 2233, 2234, 2235, 2236, 2237, 2238, 2239, 2240, 2241, 2242, 2243, 2244, 2245, 2246, 2247, 2248, 2249, 2250, 2251, 2252
xkeyval package 2253, 2254
\xmakefirstuc 2255
\xspace 2256
xspace package 2257, 2258, 2259, 2260, 2261, 2262, 2263
1That is, if the term has been referenced using any of the commands described in §6 Links to Glossary Entries and §7 Adding an Entry to the Glossary Without Generating Text or via \glssee (or the see key) or commands such as \acrshort.
2Note that although I’ve written latex in this section, it’s better to use pdflatex, where possible, for the reasons given earlier.
3As from v3.01 \gls is no longer fragile and doesn’t need protecting.
4Apparently MiKTeX has an alternative makeglossaries.exe but I don’t know how using this differs from using makeglossaries.bat.
1Actually it uses \mfirstucMakeUppercase which is set to textcase’s \MakeTextUppercase by the glossaries package. This makes it consistent with \makefirstuc. (The textcase package is automatically loaded by glossaries.)
2Actually it sets \acronymtype to \glsdefaulttype if the acronym package option is not used, but \glsdefaulttype usually has the value main unless the nomain option has been used.
1The only preamble restriction on \newglossaryentry and \newacronym was removed in version 1.13, but the restriction remains for \loadglsentries. See §4.8 Drawbacks With Defining Entries in the Document Environment for a discussion of the problems with defining entries within the document instead of in the preamble.
2Except possibly the style file but then you’ll need to use \noist to prevent your changes from being overwritten.
3This is because \acronymtype is set to \glsdefaulttype if the acronym package option is not used.
1\glsdisplayfirst and \glsdisplay are now deprecated. Backwards compatibility should be preserved but you may need to use the compatible-3.07 option
1makeindex will always assign a location number, even if it’s not needed, so it needs to be discarded.
2If you redefine \glsseeformat, keep the default value of the optional argument as \seename as both see and \glssee explicitly write [\seename] in the output file if no optional argument is given.
3In versions before 3.0, \glsentryname was used, but this could cause problems when the name key was sanitized.
1versions before 3.0 used \glsentryname as the default, but this could cause problems when name had been sanitized.
1you can’t use the longheaderborder style for this example as you can’t use the longtable environment in two column mode.
1see \setCompositor described in §3 Setting Up
2see \setAlphaCompositor described in §3 Setting Up
1as from version 1.18
2See David Carlisle’s explanation in http://tex.stackexchange.com/questions/86565/drawbacks-of-xspace
1These lengths will not be available if you use both the nolong and nosuper package options or if you use the nostyles package option unless you explicitly load the relevant package.
2This style was supplied by Axel Menzel.
3e.g. with the flowfram package.
1Single letter words, such as “a” and “I” should typically not appear at the end of a line, hence the non-breakable space after “a” in the prefix field.
2The earlier caveats about initial non-Latin characters apply.