glossaries.sty v 1.16: LaTeX2e Package to Assist Generating Glossaries

Nicola L.C. Talbot

School of Computing Sciences
University of East Anglia
Norwich. Norfolk
NR4 7TJ. United Kingdom.
http://theoval.cmp.uea.ac.uk/~nlct/

27th August 2008


Contents

Introduction

The glossaries package is provided to assist generating glossaries. It has a certain amount of flexibility, allowing the user to customize the format of the glossary and define multiple glossaries. It also supports acronyms and glossary styles that include symbols (in addition to a name and description) for glossary entries. There is provision for loading a database of glossary terms where only those terms used in the text are added to the glossary. This package replaces the glossary package which is now obsolete.

This documentation is structured as follows: A Quick Guide For The Impatient is for people who want a few quick pointers of how to get started, without having to read through lengthy descriptions, Overview gives an overview of available commands and their syntax and Mfirstuc describes the associated mfirstuc package.

Top


Multi-Lingual Support

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 before glossaries to enable this. Note that if babel is loaded and the translator package is detected on TEX's path, then the translator package will be loaded automatically, however, it may not pick up on the required languages, so if the predefined text is not translated, you may need to explicitly load the translator package with the required languages. For example:

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

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:

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

The following languages are currently supported:

Language As from version
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
Spanish 1.08
The language dependent commands and translator keys used by the glossaries package are listed in table 1.


Table 1: Customised Text
 Command Name Translator key word What it's for  
 \glossaryname Glossary Title of the main glossary.  
 \acronymname Acronyms Title of the list of acronyms (when used with package option acronym).  
 \entryname Notation (glossaries) Header for first column in glossary (for 2, 3 or 4 column glossaries that support headers).  
 \descriptionname Description (glossaries) Header for second column in glossary (for 2, 3 or 4 column glossaries that support headers).  
 \symbolname Symbol (glossaries) Header for symbol column in glossary for glossary styles that support this option.  
 \pagelistname Page List (glossaries) Header for page list column in glossary for glossaries that support this option.  
 \glssymbolsgroupname Symbols (glossaries) Header for symbols section of the glossary for glossary styles that support this option.  
 \glsnumbersgroupname Numbers (glossaries) Header for numbers section of the glossary for glossary styles that support this option.  

Due to the varied nature of glossaries, it's likely that the predefined translations may not be appropriate. If you are using the babel package and do not have the translator package installed, you need to be familiar with the advice on changing the words babel uses.

If you have the translator package installed, then it becomes much easier to change the default translations. For example, if you are writing in Irish and you want \symbolname to produce "Siombail" instead of "Comhartha", then you can put the following in your document preamble:

\deftranslation[to=Irish]{Symbol (glossaries)}{Siombail}


Generating the Associated Glossary Files

The glossaries package comes with the Perl script makeglossaries which will run makeindex on all the glossary files using a customized makeindex .ist style file (which is created by \makeglossaries). The relevant extensions are obtained from the auxiliary file, so you should only pass the basename as the argument. For example, if your document is called myfile.tex, do:

latex myfile
makeglossaries myfile
latex myfile
You may need to explicitly load makeglossaries into Perl:
perl makeglossaries myfile
There is a batch file called makeglossaries.bat which does this for Windows users, but you must have Perl installed to be able to use it.

If you don't have Perl installed, you will have to run makeindex for each glossary type you have defined. For example, if you have used the acronym package option then you will have both a main glossary as well as a list of acronyms, so you will need to do (assuming your document is called myfile.tex):

makeindex -s myfile.ist -t myfile.glg -o myfile.gls myfile.glo
makeindex -s myfile.ist -t myfile.alg -o myfile.acr myfile.acn
This requires remembering all extensions for each of the glossaries defined in your document, so where possible you should use makeglossaries instead to reduce the possibility of error. Don't pass all the glossary files in a single call to makeindex or it will merge all your glossaries into a single glossary.

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

Top

Troubleshooting

The glossaries package comes with a minimal file called minimalgls.tex which can be used for testing. This should be located in texmf/doc/latex/glossaries/samples/. Further information on debugging LaTeX code is available at http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/.

Below is a list of the most frequently asked questions. For other queries, consult the glossaries FAQ at http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html.

  1. I've used the smallcaps option, but the acronyms are displayed in normal sized upper case letters.

    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.

  2. How do I change the font that the acronyms are displayed in?

    The easiest way to do this is to specify the smaller package option and redefine \acronymfont to use the required typesetting command. For example, suppose you would like the acronyms displayed in a sans-serif font, then you can do:

    \usepackage[smaller]{glossaries}
    \renewcommand*{\acronymfont}[1]{\textsf{#1}}
    

  3. How do I change the font that the acronyms are displayed in on first use?

    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 \smaller, you will also need to redefine \acronymfont, as above. For example to make the acronym emphasized on first use, but use the surrounding font for subsequent use, you can do:

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

  4. I don't have Perl installed, do I have to use makeglossaries?

    Read the previous section.

  5. I'm used to using the glossary package: are there any instructions on migrating from the glossary package to the glossaries package?

    Read Upgrading from the glossary package to the glossaries package which should be available from the same location as this document.

  6. I'm using babel but the fixed names haven't been translated.

    The glossaries package currently only supports the following languages: Danish, Dutch, English, French, German, Irish, Italian, Hungarian, Polish and Spanish. If you want to add another language, send me the translations, and I'll add them to the next version.

    If you are using one of the above languages, but the text hasn't been translated, try adding the translator package with the required languages explicitly (before you load the glossaries package). For example:

    \usepackage[ngerman]{babel}
    \usepackage[ngerman]{translator}
    \usepackage{glossaries}
    
    Alternatively, you may be able to add the language as a global option to the class file. Check the translator package documentation for further details.

  7. My glossaries haven't appeared.

    Remember to do the following:

Top


A Quick Guide For The Impatient

This section is for people who want a few quick pointers of how to get started. However it is recommended that you read the overview section for additional commands and advice not listed here.

  1. Load glossaries after hyperref:
    \usepackage{hyperref}
    \usepackage{glossaries}
    
    Similarly for the html package:
    \usepackage{html}
    \usepackage{glossaries}
    

  2. Always use \makeglossaries if you want the glossary entries to be written to the glossary file:
    \documentclass{article}
    \usepackage{glossaries}
    \makeglossaries
    
    If you don't use \makeglossaries, your glossaries will not appear in the document!

  3. Use \printglossaries to make your glossaries appear in the document at that point. For example:
    \maketitle
    \printglossaries
    \section{Introduction}
    
    Note that only the glossary entries that have been used in the document text will appear in the glossary.

  4. When you have created your document, run LaTeX on it, then the Perl script makeglossaries, then run LaTeX on it again:
    latex myfile
    makeglossaries myfile
    latex myfile
    
    (You may need to run LaTeX again if you have used the toc package option.) If you use Windows, there is a batch file called makeglossaries.bat which you can use, but you will still need Perl installed.

  5. New glossaries can be defined using:

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

    where label is an identifying label, in-ext is the extension of the file to be created by makeindex (called by makeglossaries), out-ext is the extension of the file to be read by makeindex and title is the title for this new glossary. The first optional argument log-ext specifies the extension of the makeindex transcript file. Example:

    \newglossary[nlg]{notation}{not}{ntn}{Notation}
    
    This glossary's label is notation and its title will be Notation. If you use makeglossaries, the makeindex transcript will be written to a file with the extension .nlg. If log-ext is omitted, the extension .glg will be used.

  6. Any new glossaries must be defined before \makeglossaries
    \documentclass{article}
    \usepackage{glossaries}
    \newglossary{notation}{not}{ntn}{Notation}
    \makeglossaries
    

  7. If you use the acronym package option, the glossaries package will automatically create a new glossary type labelled acronym:
    \usepackage[acronym]{glossaries}
    

  8. If your pages have a hyphen compositor (i.e. your page numbers appear in the form 2-1), redefine \glscompositor before \makeglossaries:
    \documentclass{article}
    \usepackage{glossaries}
    \renewcommand{\glscompositor}{-}
    \makeglossaries
    

  9. To add the glossaries to the table of contents use the toc package option:
    \usepackage[toc]{glossaries}
    

  10. Define a new entry with:

    \newglossaryentry{label}{key-val list}

    The key-val list must at least contain a name key and a description key. For example:

    \newglossaryentry{perl}{name=Perl,
    description=A scripting language}
    
    In this example, I have given the entry the label perl. Whenever I want to use this entry, that is the label I need to use to identify it.

  11. If the entry name starts with an accented letter, you will need to group the first letter (otherwise it will cause a problem for \Gls and \Glspl):
    \newglossaryentry{elite}{name={{\'e}lite},
    description={select group or class}}
    
    Likewise with commands such as \ae and \oe:
    \newglossaryentry{oesophagus}{%
    name={{\oe}sophagus},
    description={canal from mouth to stomach}}
    

  12. If you have multiple glossaries, use the type key to specify in which glossary the entry belongs. For example:
    \newglossary{languages}{lan}{lng}{Index of Languages}
    
    \makeglossaries
    
    \newglossaryentry{perl}{name=Perl,
    description=A scripting language,
    type=languages}
    
    If type is omitted, the default glossary is used.

  13. Remember to group values that have a comma or equal sign. For example:
    \newglossaryentry{pagelist}{name=page list,
    description={A list of individual pages or page ranges
    (e.g.\ 1,2,4,7--9)}}
    

  14. Plural forms are assumed to be the singular form with an "s" appended, unless otherwise specified. To specify an irregular plural, use the plural key. For example:
    \newglossaryentry{matrix}{name=matrix,
    description=rectangular array of quantities,
    plural=matrices}
    

  15. The way the term appears in the main text can be different from the way the term appears in the glossary:
    \newglossaryentry{matrix}{name=Matrix,
    description=rectangular array of quantities,
    text=matrix,
    plural=matrices}
    
    In this example, the entry name appears as "Matrix" in the glossary, and either "matrix" or "matrices" in the text.

  16. The way the term appears on first use can be different to the way it appears subsequently:
    \newglossaryentry{singmtx}{name=Singular Matrix,
    description=A matrix with a zero determinant,
    first=singular matrix (SM),
    text=SM,
    firstplural=singular matrices (SMs)}
    
    In this example, the entry name appears as "Singular Matrix" in the glossary, and in the text it appears as "singular matrix (SM)" or "singular matrices (SMs)" the first time the entry is used, and subsequently appears as "SM" or "SMs".

  17. The quick and easy way to define an acronym is to use:

    \newacronym[key-val list]{label}{abbrev}{long}

    For example:

    \newacronym{svm}{SVM}{support vector machine}
    
    This is equivalent to:
    \newglossaryentry{svm}{type=\acronymtype,
    name={SVM},
    description={support vector machine},
    text={SVM},
    first={support vector machine (SVM)},
    plural={SVMs},
    firstplural={support vector machines (SVMs)}}
    
    (The value of \acronymtype varies depending on whether the acronym package option is used or not. The optional argument key-val list can be used to override any of the \newglossaryentry keys; for example, if the acronym has an irregular plural.)

  18. The font used to display the entry name in the glossary is governed by \glsnamefont. This can be redefined as required. For example, to make the entry names appear in a medium sans-serif font do:
    \renewcommand{\glsnamefont}[1]{\textsf{\mdseries #1}}
    
    Note that the list-like glossary styles defined in the glossary-list package place the entry name in the optional argument to \item, so they will appear in bold, unless you redefine \glsnamefont to counteract the bold font.

  19. In the document use \gls{label} to use a predefined term (this will also enter the term into the associated glossary output file). For example:
    A \gls{singmtx} is a matrix with a zero determinant.
    

  20. Other variations: For example, the following will produce the plural form with the first letter in uppercase:
    \Glspl{singmtx} are matrices with a zero determinant.
    

  21. Additional text can be appended to the link using the end optional argument. For example, to form the possessive:
    The \gls{singmtx}['s] dimensions \ldots
    

  22. The format of the associated entry number can be changed using the format key in the optional argument. Note that the value of the format key should be the name of a command without the initial backslash. For example:
    The primary definition of \glspl[format=textbf]{singmtx}.
    
    In this example the relevant glossary entry will have the page number in bold (since it uses \textbf) but it will no longer have a hyperlink (if hyperlinks are enabled).

  23. The glossaries package provides commands to change the font whilst ensuring that the number remains a hyperlink. These are of the form \hyperxx and are equivalent to the standard font changing commands of the form \textxx, as well as \hyperemph (which uses \emph). For example:
    The primary definition of \glspl[format=hyperbf]{singmtx}.
    

  24. Don't use declarations in format as this can cause unpredictable results, as there is no guarantee that the effect will be localised to the required text.

  25. Entries can be added to the glossary without producing any text using \glsadd{label} or \glsaddall. These commands also take an optional argument where you can specify the format. For example
    \glsadd[format=hyperbf]{singmtx}
    
    will add a line to the glossary file for the specified term, but will not produce any text where the command occurs.

  26. A number range can be entered using format=( and format=) to mark the beginning and ending of the range1. For example:
     \glsadd[format=(]{singmtx}
     This is a very long section all about \glspl{singmtx}.
    
     % lots of text omitted
    
     \glsadd[format=)]{singmtx}
    
    This is equivalent to makeindex's |( and |) formats.

  27. You can combine the range markers with a formatting command (again without the preceding backslash). For example:
     This is the start of a very long section all 
     about \glspl[format=(hyperbf]{singmtx}.
    
     % lots of text omitted
    
     This is the end a very long section all about 
     \glspl[format=)hyperbf]{singmtx}.
    

  28. Only those terms that have actually been used in the document will be placed in the glossary. If you have defined a term that doesn't appear in the document, then it means you haven't used it in the text (either via \glslink or \gls and related commands, or via \glsadd or \glsaddall).

  29. To change the sorting order, use the sort key. For example:
    \newglossaryentry{tex}{name={\TeX},
    description={A typesetting language},
    sort=tex}
    
    This will put the entry in the "T" group (entries starting with the letter "t" or "T") rather than the "symbols" group (entries starting with a symbol). Similarly, the following example puts the entry in the "U" group instead of the "symbol" group.
    \newglossaryentry{universal}{name={\ensuremath{\mathcal{U}}},
    description=The universal set,
    sort=U}
    

  30. You don't need to escape makeindex's special characters:
    \newglossaryentry{quote}{name={"},
    description={Double quote character}}
    
    \newglossaryentry{exclam}{name={!},
    description={Exclamation mark}}
    
    \newacronym{rna}{RNA}{ribonukleins\"aure}
    

  31. Associated symbols can also be specified, but whether the symbol appears in the glossary depends on the glossary style. For example:
    \newglossaryentry{metre}{name={metre},
    description={A metric measurement of length},
    symbol={m}}
    
    The predefined glossary styles that display the entry symbol are: long4col, long4colheader, long4colborder, long4colheaderborder, altlong4col, altlong4colheader, altlong4colborder, altlong4colheaderborder, super4col, super4colheader, super4colborder, super4colheaderborder. altsuper4col, altsuper4colheader, altsuper4colborder and altsuper4colheaderborder. All the other styles supplied by this package ignore the associated symbol.

  32. Glossary styles can be set using the style package option. For example:
    \usepackage[style=long3col]{glossaries}
    
    or using \glossarystyle{style}. For example:
    \glossarystyle{altlist}
    
    The predefined glossary styles provided by the glossaries bundle are listed in Glossary Styles.

  33. The list of numbers associated with each glossary entry can be suppressed using the package option nonumberlist:
    \usepackage[nonumberlist]{glossaries}
    

  34. By default, the glossaries will appear in an unnumbered chapter if chapters are defined, otherwise in an unnumbered section. This can be changed using the section package option. For example, to make the glossaries appear in an unnumbered section, even if chapters are defined, do:
    \usepackage[section]{glossaries}
    
    Other sectional units can also be specified as section=value. For example, to make the glossaries appear in unnumbered subsections:
    \usepackage[section=subsection]{glossaries}
    

Top


Overview


Package Options

The glossaries package options are as follows:

toc
Add the glossaries to the table of contents.

numberline
When used with toc, this will add \numberline{} in the final argument of \addcontentsline. This will align the table of contents entry with the numbered section titles. Note that this option has no effect if the toc option is omitted. If toc is used without numberline, the title will be aligned with the section numbers rather than the section titles.

acronym
Make a separate glossary for acronyms.

section
This is a key=value option. Its value should be the name of a sectional unit (e.g. chapter). This will make the glossaries appear in the named sectional unit, otherwise each glossary will appear in a chapter, if chapters exists, otherwise in a section. Unnumbered sectional units will be used by default. Example:
\usepackage[section=subsection]{glossaries}
You can omit the value if you want to use sections, i.e.
\usepackage[section]{glossaries}
is equivalent to
\usepackage[section=section]{glossaries}
You can change this value later in the document using \setglossarysection{type}.

numberedsection
The glossaries are placed in unnumbered sectional units by default, but this can be changed using numberedsection. This option can take three possible values: false (no number, i.e. use starred form), nolabel (numbered, i.e. unstarred form, but not labelled) and autolabel (numbered with automatic labelling). If numberedsection=autolabel is used, each glossary is given a label that matches the glossary type, so the main (default) glossary is labelled main, the list of acronyms is labelled acronym2 and additional glossaries are labelled using the value specified in the first mandatory argument to \newglossary. For example, if you load glossaries using:
\usepackage[section,numberedsection=autolabel]{glossaries}
then each glossary will appear in a numbered section, and can be referenced using something like:
The main glossary is in section~\ref{main} and the list of
acronyms is in section~\ref{acronym}.
If you can't decide whether to have the acronyms in the main glossary or a separate list of acronyms, you can use \acronymtype which is set to main if the acronym option is not used and is set to acronym if the acronym option is used. For example:
The list of acronyms is in section~\ref{\acronymtype}.

As from version 1.14, you can add a prefix to the label by redefining \glsautoprefix. For example:

\renewcommand*{\glsautoprefix}{glo:}
will add glo: to the automatically generated label, so you can then, for example, refer to the list of acronyms as follows:
The list of acronyms is in section~\ref{glo:\acronymtype}.
Or, if you are undecided on a prefix:
The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}.

style
This is a key=value option. Its value should be the name of the glossary style to use. Predefined glossary styles are listed later.

nonumberlist
This option will suppress the associated number lists in the glossaries (see also Number Lists).

counter
This is a key=value option. The value should be the name of the default counter to use in the number lists.

sanitize
This is a key=value option whose value is also a key=value list. By default, the glossaries package sanitizes the values of the name, description and symbol keys used when defining a new glossary entry. This may lead to unexpected results if you try to display these values within the document text. This sanitization can be switched off using the sanitize package option. For example, to switch off the sanitization for the description and name keys, but not for the symbol key, do:
\usepackage[sanitize={name=false,description=false,%
symbol=true}]{glossaries}

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

description
This option changes the definition of \newacronym to allow a description. See later for further details.

footnote
This option changes the definition of \newacronym and the way that acronyms are displayed. See later for further details.

smallcaps
This option changes the definition of \newacronym and the way that acronyms are displayed. See later for further details.

smaller
This option changes the definition of \newacronym and the way that acronyms are displayed. See later for further details.

dua
This option changes the definition of \newacronym so that acronyms are always expanded. See later for further details.

shortcuts
This option provides shortcut commands for acronyms. See later for further details.

Top


Defining Glossary Entries

All glossary entries must be defined before they are used, so it is better to define them in the preamble to ensure this.3 However only those entries that occur in the document (using any of the commands described in Links to Glossary Entries and Adding an entry to the glossary without generating text) will appear in the glossary. Each time an entry is used in this way, a line is added to an associated glossary (.glo) file, 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, using a customised .ist 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.

The command \makeglossaries must be placed in the preamble in order to create the customised makeindex .ist style file and to ensure that glossary entries are written to the appropriate output file. If you omit \makeglossaries none of the glossaries will be created. Note that if your page numbers use a hyphen compositor, you must set this by redefining \glscompositor before using \makeglossaries:

\renewcommand*{\glscompositor}{-}
(The default value of \glscompositor is a full stop.)

New glossary entries are defined using the command:

\newglossaryentry{label}{key-val list}

The first argument, label, must be a unique label with which to identify this entry. The second argument, key-val list, is a key=value list that supplies the relevant information about this entry. There are two required fields: name and description. Available fields are listed below:

name
The name of the entry (as it will appear in the glossary).

description
A brief description of this term (to appear in the glossary).

descriptionplural
The plural form of the description (as passed to \glsdisplay and \glsdisplayfirst by \glspl, \Glspl and \GLSpl). If omitted, the value is set to the same as the description key.

text
How this entry will appear in the document text when using \gls (or one of its uppercase variants). If this field is omitted, the value of the name key is used.

first
How the entry will appear in the document text the first time it is used with \gls (or one of its uppercase variants). If this field is omitted, the value of the text key is used.

plural
How the entry will appear in the document text when using \glspl (or one of its uppercase variants). If this field is omitted, the value is obtained by appending \glspluralsuffix to the value of the text field.

firstplural
How the entry will appear in the document text the first time it is used with \glspl (or one of its uppercase variants). If this field is omitted, the value is obtained from the plural key, if the first key is omitted, or by appending \glspluralsuffix to the value of the first field, if the first field is present.

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.

symbol
This field is provided to allow the user to specify an associated symbol, but most glossary styles ignore this value. If omitted, the value is set to \relax.

symbolplural
This is the plural form of the symbol (as passed to \glsdisplay and \glsdisplayfirst by \glspl, \Glspl and \GLSpl). If omitted, the value is set to the same as the symbol key.

sort
This value indicates how makeindex should sort this entry. If omitted, the value is given by the name field. This value is equivalent to makeindex's "actual" character (which is usually the at-sign @ although the glossaries package uses a different symbol).

type
This is the glossary type to which this entry belongs. If omitted, the default glossary is assumed. The list of acronyms type is given by \acronymtype which will either be main or acronym, depending on whether the acronym package option was used.
Note that if the key starts with an accented letter, you must group the accented letter, otherwise it will cause a problem for commands like \Gls and \Glspl. For example:
\newglossaryentry{elite}{name={{\'e}lite},
description={select group or class}}

Top

Plurals

You may have noticed from above that you can specify the plural form when you define a term. If you omit this, the plural will be obtained by appending \glspluralsuffix to the singular form. This command defaults to s. For example:
\newglossaryentry{cow}{name=cow,description={a fully grown
female of any bovine animal}}
defines a new entry whose singular form is "cow" and plural form is "cows". However, if you are writing in archaic English, you may want to use "kine" as the plural form, in which case you would have to do:
\newglossaryentry{cow}{name=cow,plural=kine,
description={a fully grown female of any bovine animal}}

If you are writing in a language that supports multiple plurals (for a given term) then use the plural key for one of them (typically the one you are most likely to use) and for the others you will need to explicitly write the plural form using \glslink rather than using \glspl. Returning to the cow example above, suppose you will mostly be using "cows" as the plural, but occasionally you want to use "kine" as the plural, then define the term as

\newglossaryentry{cow}{name=cow,description={a fully grown
female of any bovine animal (plural cows, archaic plural kine)}}
and use \glspl{cow} to produce "cows" and use \glslink{cow}{kine} to produce "kine".

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

Top


Loading Entries From a File

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

\loadglsentries[type]{filename}

where filename is the name of the file containing all the \newglossaryentry commands. The optional argument type is the name of the glossary to which those entries should belong, for those entries where the type key has been omitted (or, more specifically, for those entries whose type has been specified by \glsdefaulttype, which is what \newglossaryentry uses by default). For example, suppose I have a file called myentries.tex which contains:

\newglossaryentry{perl}{type=main,
name={Perl},
description={A scripting language}}

\newglossaryentry{tex}{name={\TeX},
description={A typesetting language},sort={TeX}}

\newglossaryentry{html}{type=\glsdefaulttype,
name={html},
description={A mark up language}}
and suppose in my document preamble I use the command:
\loadglsentries[languages]{myentries}
then this will add the entries tex and html to the glossary whose type is given by languages, but the entry perl will be added to the main glossary, since it explicitly sets the type to main.

Note: if you use \newacronym (see later) the type is set as type=\acronymtype unless you explicitly override it. For example, if my file myacronyms.tex contains:

\newacronym{aca}{aca}{a contrived acronym}
then (supposing I have defined a new glossary type called altacronym)
\loadglsentries[altacronym]{myacronyms}
will add aca to the glossary type acronym, if the package option acronym has been specified, or will add aca to the glossary type altacronym, if the package option acronym is not specified. In this instance, it is better to change myacronyms.tex to:
\newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym}
and now
\loadglsentries[altacronym]{myacronyms}
will add aca to the glossary type altacronym, regardless of whether or not the package option acronym is used.

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

Top


Number lists

Each entry in the glossary has an associated number list. By default, these numbers refer to the pages on which that entry has been used (using any of the commands described in Links to Glossary Entries and Adding an entry to the glossary without generating text). The number list can be suppressed using the nonumberlist package option, or an alternative counter can be set as the default using the counter package option.

Top


Links to Glossary Entries

Once you have defined a glossary entry using \newglossaryentry, you can refer to that entry in the document using one of the commands listed in this section. The text which appears at that point in the document when using one of these commands is referred to as the link text (even if there are no hyperlinks). The commands in this section also add a line to an external file that is used by makeindex to generate the relevant entry in the glossary. It is strongly recommended that you don't use the commands defined in this section in the arguments of sectioning or caption commands. This is particularly important if you are using the glossaries package in conjunction with the hyperref package. Instead, use one of the commands listed in Using Glossary Terms Without Links (such as \glsentrytext) or provide an alternative via the optional argument to the sectioning/caption command. Examples:

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

The way the link text is displayed depends on \glstextformat{text}. For example, to make all link text appear in a sans-serif font, do:

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

The command:

\glslink[options]{label}{text}

will place \glstextformat{text} in the document at that point and add a line into the associated glossary file for the glossary entry given by label. If hyperlinks are supported, text will be a hyperlink to the relevant line in the glossary. The optional argument options must be a key=value list which can take any of the following keys:

format
This specifies how to format the associated number for this entry in the glossary. This value is equivalent to the makeindex encap value, and (as with \index) the value needs to be the name of a command without the initial backslash. As with \index, the characters ( and ) can also be used to specify the beginning and ending of a number range. Again as with \index, the command should be the name of a command which takes an argument (which will be the associated number). Be careful not to use a declaration (such as \bfseries) instead of a text block command (such as \textbf) as the effect is not guaranteed to be localised. If you want to apply more than one style to a given entry (e.g. bold and italic) you will need to create a command that applies both formats, e.g.
\newcommand*{\textbfem}[1]{\textbf{\emph{#1}}}
and use that command.

If you are using hyperlinks and you want to change the font of the hyperlink, don't use \hyperpage (provided by the hyperref package) as the numbers may not refer to a page number. Instead, the glossaries package provides the following number formats:

hyperrm The number is a serif hyperlink to the relevant part of the document
hypersf The number is a sans-serif hyperlink to the relevant part of the document
hypertt The number is a monospaced hyperlink to the relevant part of the document
hyperbf The number is a bold hyperlink to the relevant part of the document
hypermd The number is a medium weight hyperlink to the relevant part of the document
hyperit The number is an italic hyperlink to the relevant part of the document
hypersl The number is a slanted hyperlink to the relevant part of the document
hyperup The number is an upright hyperlink to the relevant part of the document
hypersc The number is a small caps hyperlink to the relevant part of the document
hyperemph The number is an emphasized hyperlink to the relevant part of the document
Note that if the \hyperlink command hasn't been defined, the hyperxx formats are equivalent to the analogous \textxx font commands. 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 associated number in the glossary to be in a bold sans-serif font, you can define a command called, say, \hyperbsf:
\newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}}
and then use hyperbsf as the value for the format key.

counter
This specifies which counter to use for the associated number for this glossary entry. (See also Number Lists.)

hyper
This is a boolean key which can be used to enable/disable the hyperlink to the relevant entry in the glossary. (Note that setting hyper=true will have no effect if \hyperlink has not been defined.) The default value is hyper=true.

There is also a starred version:

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

which is equivalent to \glslink, except it sets hyper=false.

The command:

\gls[options]{label}[insert]

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 given by label as used.

There are two uppercase variants:

\Gls[options]{label}[insert]

and

\GLS[options]{label}[insert]

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

The final optional argument insert, allows you to insert some additional text into the link text. By default, this will append insert at the end of the link text, but this can be changed (see later).

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:

\glspl[options]{label}[insert]

\Glspl[options]{label}[insert]

\GLSpl[options]{label}[insert]

These determine the link text from the plural and firstplural keys supplied when the entry was first defined. As before, these commands also have a starred version that disable the hyperlink.

The command:

\glstext[options]{label}[insert]

is similar to \gls except that it always uses the value of the text key and does not mark the entry as having been used. Unlike \gls, the inserted text insert is always appended to the link text.

There are also analogous commands:

\Glstext[options]{text}[insert]

\GLStext[options]{text}[insert]

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

The command:

\glsfirst[options]{label}[insert]

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 mark the entry as having been used.

There are also analogous commands:

\Glsfirst[options]{text}[insert]

\GLSfirst[options]{text}[insert]

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

The command:

\glsplural[options]{label}[insert]

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:

\Glsplural[options]{text}[insert]

\GLSplural[options]{text}[insert]

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

The command:

\glsfirstplural[options]{label}[insert]

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:

\Glsfirstplural[options]{text}[insert]

\GLSfirstplural[options]{text}[insert]

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

The command:

\glsname[options]{label}[insert]

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

There are also analogous commands:

\Glsname[options]{text}[insert]

\GLSname[options]{text}[insert]

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

The command:

\glssymbol[options]{label}[insert]

is similar to \glstext except that it always uses the value of the symbol key. Again, insert is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the symbol key contains commands, you will have to disable the sanitization of the symbol key and protect fragile commands.

There are also analogous commands:

\Glssymbol[options]{text}[insert]

\GLSsymbol[options]{text}[insert]

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

The command:

\glsdesc[options]{label}[insert]

is similar to \glstext except that it always uses the value of the description key. Again, insert is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the description key contains commands, you will have to disable the sanitization of the description key and protect fragile commands.

There are also analogous commands:

\Glsdesc[options]{text}[insert]

\GLSdesc[options]{text}[insert]

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

Top


Changing the format of the link text

The format of the link text for \gls, \glspl and their uppercase variants is governed by two commands: \glsdisplayfirst, which is used the first time a glossary entry is used in the text and \glsdisplay, which is used subsequently. Both commands take four arguments: the first is either the singular or plural form given by the text, plural, first or firstplural keys (used when the term was defined) depending on context; the second argument is the term's description (as supplied by the description key); the third argument is the symbol associated with the term (as supplied by the symbol key) and the fourth argument is the additional text supplied in the final optional argument to \gls or \glspl (or their uppercase variants). The default definitions of \glsdisplay and \glsdisplayfirst simply print the first argument immediately followed by the fourth argument. The remaining arguments are ignored. Note that \glslink (which is used by commands like \gls and \glspl) sets \glslabel to the label for the given entry (i.e. the label supplied to the mandatory argument to \gls), so it is possible to use this label in the definition of \glsdisplay or \glsdisplayfirst to supply additional information using any of the commands described in Using Glossary Terms Without Links, if required.

For example, suppose you want a glossary of measurements and units, you can use the symbol key to store the unit:

\newglossaryentry{distance}{name=distance,
description={The length between two points},
symbol={km}}
and now suppose you want \gls{distance} to produce "distance (km)" on first use, then you can redefine \glsdisplayfirst as follows:
\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)}
Note that the additional text is placed after #1, so \gls{distance}['s] will produce "distance's (km)" rather than "distance (km)'s" which looks a bit odd (even though it may be in the context of "the distance (km) is measured between the two points" -- but in this instance it may be better not to use a contraction).

Note also that all of the link text will be formatted according to \glstextformat (described earlier). So if you do, say:

\renewcommand{\glstextformat}[1]{\textbf{#1}}
\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)}
then \gls{distance} will produce "distance (km)".

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

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

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

\defglsdisplayfirst[notation]{#1#4 (denoted #3)}
Now suppose you have defined an entry as follows:
\newglossaryentry{set}{type=notation,
name=set,
description={A collection of objects},
symbol={$S$}
}
The first time you reference this entry using \gls it will be displayed as: "set (denoted S)" (similarly for \glspl and the uppercase variants).

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

Top

Enabling and disabling hyperlinks to glossary entries

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

\glsdisablehyper

and

\glsenablehyper

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

Top


Adding an Entry to the Glossary Without Generating Text

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

\glsadd[options]{label}

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:

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

To add all entries that have been defined, use:

\glsaddall[options]

The optional argument is the same as for \glsadd, except there is also a key types which can be used to specify which glossaries to use. This should be a comma separated list. For example, if you only want to add all the entries belonging to the list of acronyms (specified by the glossary type \acronymtype) and a list of notation (specified by the glossary type notation) then you can do:

\glsaddall[types={\acronymtype,notation}]

Top


Using Glossary Terms Without Links

The commands described in this section display entry details without adding any information to the glossary. They don't use \glstextformat, they don't have any optional arguments, they don't affect the flag that determines if the term has been used and they don't produce hyperlinks.

\glsentryname{label}
\Glsentryname{label}

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

\glsentrytext{label}
\Glsentrytext{label}

These commands display the subsequent use text for the glossary entry given by label, as specified by the text key. \Glsentrytext makes the first letter uppercase.

\glsentryplural{label}
\Glsentryplural{label}

These commands display the subsequent use plural text for the glossary entry given by label, as specified by the plural key. \Glsentryplural makes the first letter uppercase.

\glsentryfirst{label}
\Glsentryfirst{label}

These commands display the first use text for the glossary entry given by label, as specified by the first key. \Glsentryfirst makes the first letter uppercase.

\glsentryfirstplural{label}
\Glsentryfirstplural{label}

These commands display the plural form of the first use text for the glossary entry given by label, as specified by the firstplural key. \Glsentryfirstplural makes the first letter uppercase.

\glsentrydesc{label}
\Glsentrydesc{label}

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

\glsentrydescplural{label}
\Glsentrydescplural{label}

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

\glsentrysymbol{label}
\Glsentrysymbol{label}

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

\glsentrysymbolplural{label}
\Glsentrysymbolplural{label}

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

For further information see the section "Displaying entry details without adding information to the glossary" in the document glossaries.pdf.

Top

Displaying a glossary

The command \printglossaries will display all the glossaries in the order in which they were defined. Note that no glossaries will appear until you have either used the Perl script makeglossaries or have directly used makeindex (as described in Generating the Associated Glossary Files). If the glossary still does not appear after you re-LaTeX your document, check the makeindex log files to see if there is a problem. Remember that you also need to use the command \makeglossaries in the preamble to enable the glossaries.

An individual glossary can be displayed using:

\printglossary[options]

where options is a key=value list of options. The following keys are available:

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

title
This is the glossary's title (overriding the title specified when the glossary was defined).

toctitle
This is the title to use for the table of contents (if the toc package option has been used). If omitted, the glossary title is used.

style
This specifies which glossary style to use for this glossary, overriding the effect of the style package option or \glossarystyle.

numberedsection
This specifies whether to use a numbered section for this glossary, overriding the effect of the numberedsection package option. This key has the same syntax as the numberedsection package option, described earlier.

nonumberlist
Unlike the package option of the same name, this key is a boolean key. If true (nonumberlist=true) the numberlist is suppressed for this glossary. If false (nonumberlist=false) the numberlist is displayed for this glossary. If no value is supplied, true is assumed.

Information can be added to the start of the glossary by redefining \glossarypreamble. For example:

\renewcommand{\glossarypreamble}{Numbers in italic indicate
primary definitions.}
This needs to be done before the glossary is displayed using \printglossaries or \printglossary. Note that if you want a different preamble for each glossary, you will need to use a separate \printglossary for each glossary and change the definition of \glossarypreamble between each glossary. For example:
\renewcommand{\glossarypreamble}{Numbers in italic indicate
primary definitions.}
\printglossary
\renewcommand{\glossarypreamble}{}
\printglossary[type=acronym]
Alternatively, you can do something like:
\renewcommand{\glossarypreamble}{Numbers in italic indicate
primary definitions.\gdef\glossarypreamble{}}
\printglossaries
which will print the preamble text for the first glossary and change the preamble to do nothing for subsequent glossaries. (Note that \gdef is required as the glossary is placed within a group.)

There is an analogous command called \glossarypostamble which is placed at the end of each glossary.

Top


Changing the way the entry name appears in the glossary

Within each glossary, each entry name is formatted according to \glsnamefont 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 styles the name will appear in bold, since the name is placed in the optional argument of \item, whereas in the tabular styles the name will appear in the normal font.

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

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

Top

Defining New Glossaries

A new glossary can be defined using:

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

where name is the label to assign to this glossary. The arguments in-ext and out-ext specify the extensions to give to the input and output files for that glossary, title is the default title for this new glossary and the final optional argument counter specifies which counter to use for the associated number lists (see also Number Lists). The first optional argument specifies the extension for the makeindex 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:

\newglossary{main}{gls}{glo}{\glossaryname}
so it can be identified by the label main. Using the acronym package option is equivalent to:
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
so it can be identified by the label acronym. If you are not sure whether the acronym option has been used, you can identify the list of acronyms by the command \acronymtype which is set to acronym, if the acronym option has been used, otherwise it is set to main.

Top


Acronyms

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

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

By default, this is equivalent to:

\newglossaryentry {label}{type=\acronymtype,
name=
{abbrv},
description=
{long},
text=
{abbrv},
first={
long ( abbrv)},
plural={
abbrv\glspluralsuffix},
firstplural={
long\glspluralsuffix\space ( abbrv\glspluralsuffix)},
key-val list}

As mentioned in the previous section, the command \acronymtype is the name of the glossary in which the acronyms should appear. If the acronym package option has been used, this will be acronym, otherwise it will be main. The acronyms can then be used in exactly the same way as any other glossary entry.

Note: since \newacronym sets type=\acronymtype, if you want to load a file containing acronym definitions using \loadglsentries[type]{filename}, the optional argument type will not have an effect unless you explicitly set the type as type=\glsdefaulttype. See earlier for details.

For example, the following defines the acronym IDN:

\newacronym{idn}{IDN}{identification number}
This is equivalent to:
\newglossaryentry{idn}{type=\acronymtype,
name={IDN},
description={identification number},
text={IDN},
first={identification number (IDN)},
plural={IDNs},
firstplural={identification numbers (IDNs)}}
so \gls{idn} will produce "identification number (IDN)" on first use and "IDN" on subsequent uses.

This section describes acronyms that have been defined using \newacronym. If you prefer to define all your acronyms using \newglossaryentry explicitly, then you should skip this section and ignore the package options: smallcaps, smaller, description, dua, footnote and shortcuts, as these options change the definition of \newacronym for common acronym formats as well as the way that the link text is displayed (see earlier). Likewise you should ignore the new commands described in this section, such as \acrshort, as they vary according to the definition of \newacronym.

Table 2 lists the package options and how the \newglossaryentry keys are used to store long (the long form) and abbrv (the short form). Note that the smallcaps option redefines \acronymfont so that it sets its argument using \textsc (so you should use lower case characters in abbrv) and the smaller option redefines \acronymfont to use \smaller,5 otherwise \acronymfont simply displays its argument in the surrounding font. Note also that if none of the package options smallcaps, smaller, dua, description or footnote are used, \acronymfont is not used, so changing the definition of \acronymfont will have no effect under such circumstances.

If you want to display the acronym in another font, for example, emphasized, then use the smaller package option and redefine \acronymfont to use the required font. For example:

\usepackage[smaller]{glossaries}
\renewcommand*{\acronymfont}[1]{\emph{#1}}
Where \acronymfont is available, \firstacronymfont is also available. By default, this simply uses \acronymfont, but it can be redefined to change the way the acronym is displayed on first use.


Table 2: Package options governing \newacronym and how the information is stored in the keys for \newglossaryentry
Package Option first key text key description key symbol key
description,footnote abbrv abbrv user supplied long
description,dua long long user supplied abbrv
description long abbrv user supplied abbrv
footnote abbrv abbrv long  
smallcaps long abbrv long abbrv
smaller long abbrv long abbrv
dua long long long abbrv
None of the above long (abbrv) abbrv long  

In case you can't remember which key stores the long or short forms (or their plurals) the glossaries package provides the commands:

These can be used in the optional argument of \newacronym to override the defaults. For example:
\newacronym[\glslongpluralkey={diagonal matrices}]{dm}{DM}{diagonal 
matrix}
If the first use uses the plural form, \glspl{dm} will display: diagonal matrices (DMs).

Each of the package options smallcaps, smaller, footnote, dua and description use \defglsdisplay and \defglsdisplayfirst (described earlier) to change the way the link text is displayed. This means that these package options only work for the glossary type given by \acronymtype. If you have multiple lists of acronyms, you will need to make the appropriate changes for each additional glossary type.

description,footnote
When these two package options are used together, the first use displays the entry as:

\firstacronymfont{abbrv}insert\footnote{long}

while subsequent use displays the entry as:

\acronymfont{abbrv}insert

where insert indicates the text supplied in the final optional argument to \gls, \glspl or their uppercase variants.

Note also that when these two package options are used (in the given order), the glossaries package additionally implements the sanitize option using sanitize={description=false,symbol=false}, so remember to protect fragile commands when defining acronyms.

dua
The dua package option always displays the expanded form and so may not be used with footnote, smaller or smallcaps. Both first use and subsequent use displays the entry in the form:

longinsert

If the description package option is also used, the name key is set to the long form, otherwise the name key is set to the short form and the description key is set to the long form.

description
This package option displays the entry on first use as:

longinsert (\firstacronymfont{abbrv})

while subsequent use displays the entry as:

\acronymfont{abbrv}insert

Note also that if this package option is used, the glossaries package additionally implements the option sanitize={symbol=false}, so remember to protect fragile commands when defining acronyms.

footnote
This package option displays the entry on first use as:

\firstacronymfont{abbrv}insert\footnote{long}

while subsequent use displays the entry as:

\acronymfont{abbrv}insert

Note also that if this package option is used, the glossaries package additionally implements the option sanitize={description=false}, so remember to protect fragile commands when defining acronyms.

smallcaps
If neither the footnote nor description options have been set, this option displays the entry on first use as:

longinsert (\firstacronymfont{abbrv})

while subsequent use displays the entry as:

\acronymfont{abbrv}insert

where \acronymfont is set to \textsc{#1}, so abbrv should be specified in lower case.

Note also that if this package option is used, the glossaries package additionally implements the option sanitize={symbol=false}, so remember to protect fragile commands when defining acronyms.

smaller
If neither the footnote nor description options have been set, this option displays the entry on first use as:

longinsert (\firstacronymfont{abbrv})

while subsequent use displays the entry as:

\acronymfont{abbrv}insert

where \acronymfont is set to {\smaller #1}.

Remember to load a package that defines \smaller (such as relsize) if you want to use this option.

Note also that if this package option is used, the glossaries package additionally implements the option sanitize={symbol=false}, so remember to protect fragile commands when defining acronyms.

None of the above
If none of the package options smallcaps, smaller, footnote, dua or description are used, then on first use the entry is displayed as:

long (abbrv)insert

while subsequent use displays the entry as:

abbrvinsert

Recall from earlier that you can access the values of individual keys using commands like \glstext, so it is possible to use these commands to print just the long form or just the abbreviation without affecting the flag that determines whether the entry has been used. However the keys that store the long and short form vary depending on the acronym style, so the glossaries package provides commands that are set according to the package options. These are as follows:

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

Print the abbreviated version with a hyperlink (if necessary) to the relevant entry in the glossary. This is usually equivalent to \glstext (or its uppercase variants) but may additionally put the link text within the argument to \acronymfont.

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

Print the long version with a hyperlink (if necessary) to the relevant entry in the glossary. This is may be equivalent to \glsdesc, \glssymbol or \glsfirst (or their uppercase variants), depending on package options.

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

Print the long version followed by the abbreviation in brackets with a hyperlink (if necessary) to the relevant entry in the glossary.

Note that if you change the definition of \newacronym, you may additionally need to change the above commands as well as the changing way the text is displayed using \defglsdisplay and \defglsdisplayfirst.

The package option shortcuts provides the synonyms listed in table 3. If any of those commands generate an "undefined control sequence" error message, check that you have enabled the shortcuts using the shortcuts package option. Note that there are no shortcuts for the commands that produce all upper case text.


Table 3: Synonyms provided by the package option shortcuts
Shortcut Command Equivalent Command
\acs \acrshort
\Acs \Acrshort
\acsp \acrshortpl
\Acsp \Acrshortpl
\acl \acrlong
\Acl \Acrlong
\aclp \acrlongpl
\Aclp \Acrlongpl
\acf \acrfull
\Acf \Acrfull
\acfp \acrfullpl
\Acfp \Acrfullpl
\ac \gls
\Ac \Gls
\acp \glspl
\Acp \Glspl

Top

Unsetting and Resetting Entry Flags

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

\glsreset{label}
\glslocalreset{label}

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

\glsunset{label}
\glslocalunset{label}

You can determine whether an entry has been used using:

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

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

Top


Glossary Styles

The glossaries package comes with some pre-defined glossary styles. These are as follows:
list
The list style uses the description environment. The entry name is placed in the optional argument of the \item command (so it will appear in bold by default). The description follows, and then the associated number list for that entry. Sub groups are separated using \indexspace.

listgroup
The listgroup style is like list but the glossary groups have headings.

listhypergroup
The listhypergroup style is like listgroup but has a set of links to the glossary groups. The start of the glossary has a navigation panel to each group that is present in the glossary. This requires an additional run through LaTeX to ensure the group information is up-to-date. In the navigation panel, each group is separated by \glshypernavsep which defaults to a vertical bar with a space on either side. For example, to simply have a space separating each group, do:
\renewcommand*{\glshypernavsep}{\space}

Note that the hyper-navigation panel is now (as from version 1.14) set inside the optional argument to \item instead of after it to prevent a spurious space at the start. This can be changed by redefining \glossaryheader, but note that this needs to be done after the glossary style has been set.

altlist
The altlist style is like list but the description is placed on the following line.

altlistgroup
The altlistgroup style is like altlist but the glossary groups have headings.

altlisthypergroup
The altlisthypergroup style is like altlistgroup but has a set of links to the glossary groups. The navigation panel is the same as that for listhypergroup, described above.

listdotted
This style uses the description environment. Each entry starts with \item[], followed by the name followed by a dotted line, followed by the description. Note that this style ignores both the number list and the symbol. The length \glslistdottedwidth governs where the description should start.6

long
The long style uses the longtable environment (defined by the longtable package). It has two columns: the first column contains the entry's name and the second column contains the description followed by the number list. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth.

longborder
The longborder style is like long but has horizontal and vertical lines around it.

longheader
The longheader style is like long but has a header row.

longheaderborder
The longheaderborder style is like longheader but has horizontal and vertical lines around it.

long3col
The long3col style is like long but has three columns. The first column contains the entry's name, the second column contains the description and the third column contains the number list. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. The width of the third column is governed by the length \glspagelistwidth.

long3colborder
The long3colborder style is like the long3col style but has horizontal and vertical lines around it.

long3colheader
The long3colheader style is like long3col but has a header row.

long3colheaderborder
The long3colheaderborder style is like long3colheader but has horizontal and vertical lines around it.

long4col
The long4col style is like long3col but has an additional column in which the entry's associated symbol appears. This style is used for brief single line descriptions. The column widths are governed by the widest entry in the given column. Use altlong4col for long descriptions.

long4colborder
The long4colborder style is like the long4col style but has horizontal and vertical lines around it.

long4colheader
The long4colheader style is like long4col but has a header row.

long4colheaderborder
The long4colheaderborder style is like long4colheader but has horizontal and vertical lines around it.

altlong4col
The altlong4col style is like long4col but allows multi-line descriptions and page lists. The width of the description column is governed by the length \glsdescwidth and the width of the page list column is governed by the length \glspagelistwidth. The width of the name and symbol columns is governed by the widest entry in the given column.

altlong4colborder
The altlong4colborder style is like the long4colborder but allows multi-line descriptions and page lists.

altlong4colheader
The altlong4colheader style is like long4colheader but allows multi-line descriptions and page lists.

altlong4colheaderborder
The altlong4colheaderborder style is like long4colheaderborder but allows multi-line descriptions and page lists.

super
The super style uses the supertabular environment (defined by the supertabular package). It has two columns: the first column contains the entry's name and the second column contains the description followed by the number list. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth.

superborder
The superborder style is like super but has horizontal and vertical lines around it.

superheader
The superheader style is like super but has a header row.

superheaderborder
The superheaderborder style is like superheader but has horizontal and vertical lines around it.

super3col
The super3col style is like super but has three columns. The first column contains the entry's name, the second column contains the description and the third column contains the . The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. The width of the third column is governed by the length \glspagelistwidth.

super3colborder
The super3colborder style is like the super3col style but has horizontal and vertical lines around it.

super3colheader
The super3colheader style is like super3col but has a header row.

super3colheaderborder
The super3colheaderborder style is like super3colheader but has horizontal and vertical lines around it.

super4col
The super4col style is like super3col but has an additional column in which the entry's associated symbol appears. This style is designed for entries with brief single line descriptions. The column widths are governed by the widest entry in the given column. Use altsuper4col for longer descriptions.

super4colborder
The super4colborder style is like the super4col style but has horizontal and vertical lines around it.

super4colheader
The super4colheader style is like super4col but has a header row.

super4colheaderborder
The super4colheaderborder style is like super4colheader but has horizontal and vertical lines around it.

altsuper4col
The altsuper4col style is like super4col but allows multi-line descriptions and page lists. The width of the description column is governed by the length \glsdescwidth and the width of the page list column is governed by the length \glspagelistwidth. The width of the name and symbol columns is governed by the widest entry in the given column.

altsuper4colborder
The altsuper4colborder style is like the super4colborder style but allows multi-line descriptions and page lists.

altsuper4colheader
The altsuper4colheader style is like super4colheader but allows multi-line descriptions and page lists.

altsuper4colheaderborder
The altsuper4colheaderborder style is like super4colheaderborder but allows multi-line descriptions and page lists.

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

\glossarystyle{style-name}

The tabular-like styles that allow multi-line descriptions and page lists use the length \glsdescwidth to set the width of the description column and the length \glspagelistwidth to set the width of the page list column. 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.

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

\renewcommand*{\glsgroupskip}{}
\printglossary[style=long]
The new definition of \glsgroupskip will not have an affect for this glossary, as \glsgroupskip is redefined by style=long. Likewise, \glossarystyle will also override any previous style definitions, so, again:
\renewcommand*{\glsgroupskip}{}
\glossarystyle{long}
will reset \glsgroupskip back to its default definition for the named glossary style (long in this case). If you want to modify the styles, either use \newglossarystyle (described in the next section) or make the modifications after \glossarystyle.

All the styles except for the three- and four-column styles and the listdotted style use the command \glspostdescription after the description. This simply displays a full stop by default. To eliminate this full stop (or replace it with something else, say a comma) you will need to redefine \glspostdescription before the glossary is displayed.

Top

Defining your own glossary style

If the predefined styles don't fit your requirements, you can define your own style using:

\newglossarystyle{name}{definitions}

where name is the name of the new glossary style (to be used in \glossarystyle). The second argument definitions, needs to redefine all of the following:

theglossary

This environment defines how the main body of the glossary should be typeset. Note that this does not include the section heading, the glossary preamble (defined by \glossarypreamble) or the glossary postamble (defined by \glossarypostamble). For example, the list style uses the description environment, so the theglossary environment is simply redefined to begin and end the description environment.

\glossaryheader

This macro indicates what to do at the start of the main body of the glossary. Note that this is not the same as \glossarypreamble, which should not be affected by changes in the glossary style. The list glossary style redefines \glossaryheader to do nothing, whereas the longheader glossary style redefines \glossaryheader to do a header row.

\glsgroupheading{label}

This macro indicates what to do at the start of each logical block within the main body of the glossary. The glossary is sub-divided into 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. Note that the argument to \glsgroupheading is a label not the group title. The group title can be obtained via \glsgetgrouptitle{label}, and a navigation hypertarget can be created using \glsnavhypertarget{label}. Most of the predefined glossary styles redefine \glsgroupheading to simply ignore its argument. The listhypergroup style redefines \glsgroupheading as follows:

\renewcommand*{\glsgroupheading}[1]{%
\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}
See also \glsgroupskip below. (Note that command definitions within \newglossarystyle must use ##1 etc instead of #1 etc.)

\glsgroupskip

This macro determines what to do after one logical group but before the header for the next logical group. The list glossary style simply redefines \glsgroupskip to be \indexspace.

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

This macro indicates what to do for a given glossary entry. Note that formatted name will always be in the form \glsnamefont{name}. This allows the user to set a given font for the entry name, regardless of the glossary style used. Note that label is the label used when the glossary entry was defined via either \newglossaryentry or \newacronym. Each time you use a glossary entry it creates a link7 using \@glslink{label}{text} with the label glo:label. Your new glossary style must therefore redefine \glossaryentryfield so that it uses \@glstarget{glo:label}{text} to ensure the hyperlinks function correctly.8 For example, the list style defines \glossaryentryfield as follows:

\renewcommand*{\glossaryentryfield}[5]{%
\item[\@glstarget{glo:##1}{##2}] ##3\glspostdescription\space ##5}

Note also that number list will always be of the form

\glossaryentrynumbers{\relax
\setentrycounter{counter name}\glsnumberformat{number(s)}}

where number(s) may contain \delimN (to delimit individual numbers) and/or \delimR (to indicate a range of numbers). There may be multiple occurrences of \setentrycounter{counter name}\glsnumberformat{number(s)}, but note that the entire number list is enclosed within the argument to \glossaryentrynumbers. The user can redefine this to change the way the entire number list is formatted, regardless of the glossary style. However the most common use of \glossaryentrynumbers is to provide a means of suppressing the number list altogether. (In fact, the nonumberlist option redefines \glossaryentrynumbers to ignore its argument.) Therefore, when you define a new glossary style, you don't need to worry about whether the user has specified the nonumberlist package option.

Top

Example: creating a completely new style

If you want a completely new style, you will need to redefine all of the commands and environment listed above. You also need to take care when using internal commands (commands whose name contain the @ symbol). These should either be used in a .sty file or must be placed within \makeatletter and \makeatother.

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:

 \newglossarystyle{mylist}{%
 % put the glossary in the itemize environment:
 \renewenvironment{theglossary}{\begin{itemize}}{\end{itemize}}%
 % have nothing after \begin{theglossary}:
 \renewcommand*{\glossaryheader}{}%
 % have nothing between glossary groups:
 \renewcommand*{\glsgroupheading}[1]{}%
 \renewcommand*{\glsgroupskip}{}%
 % set how each entry should appear:
 \renewcommand*{\glossaryentryfield}[5]{%
 \item % bullet point
 \@glstarget{glo:##1}{##2}% the entry name
 \space (##4)% the symbol in brackets
 \space ##3% the description
 \space [##5]% the number list in square brackets
 }%
 }

Top

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

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

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

Top


Mfirstuc Package

The glossaries package is supplied with the package mfirstuc which provides the command:

\makefirstuc{stuff}

which makes the first object of stuff uppercase unless stuff starts with a control sequence followed by a non-empty group, in which case the first object in the group is converted to uppercase. Examples:

In version 1.02 of mfirstuc, a bug fix resulted in a change in output if the first object is a control sequence followed by an empty group. Prior to version 1.02, \makefirstuc{\ae{}bc} produced æBc. However as from version 1.02, it now produces Æbc.

Note also that

\newcommand{\abc}{abc}
\makefirstuc{\abc}
produces: ABC. This is because the first object in the argument of \makefirstuc is \abc, so it does \MakeUppercase{\abc}. Whereas:
\newcommand{\abc}{abc}
\expandafter\makefirstuc\expandafter{\abc}
produces: Abc. There is a short cut command which will do this:

\xmakefirstuc{stuff}

This is equivalent to \expandafter\makefirstuc\expandafter{stuff}. So
\newcommand{\abc}{abc}
\xmakefirstuc{\abc}
produces: Abc.

If you want to use an alternative command to convert to uppercase, for example \MakeTextUppercase9, you can redefine the internal command \@gls@makefirstuc. For example:

\renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1}
(Remember that command names that contain the @ character must either be placed in packages or be placed between \makeatletter \makeatother.)

Top


Index

\Ac
Acronyms | Acronyms
\Acf
Acronyms | Acronyms
\Acfp
Acronyms | Acronyms
\Acl
Acronyms | Acronyms
\Aclp
Acronyms | Acronyms
\Acp
Acronyms | Acronyms
\Acrfull
Acronyms | Acronyms
\Acrfullpl
Acronyms | Acronyms
\Acrlong
Acronyms | Acronyms
\Acrlongpl
Acronyms | Acronyms
\acronymfont
Acronyms | Acronyms
\acronymname
Multi-Lingual Support
\acronymtype
A Quick Guide For | Package Options | Defining Glossary Entries
\Acrshort
Acronyms | Acronyms
\Acrshortpl
Acronyms | Acronyms
\Acs
Acronyms | Acronyms
\Acsp
Acronyms | Acronyms
babel
Multi-Lingual Support | Multi-Lingual Support | Multi-Lingual Support | Multi-Lingual Support | Troubleshooting
\defglsdisplay
Acronyms | Acronyms
\defglsdisplayfirst
Acronyms | Acronyms
\descriptionname
Multi-Lingual Support
\emph
A Quick Guide For
\entryname
Multi-Lingual Support
file types
.alg
Generating the Associated Glossary
.glg
Generating the Associated Glossary | A Quick Guide For
.glo
Defining Glossary Entries
.gls
Defining Glossary Entries
.ist
Generating the Associated Glossary | Defining Glossary Entries | Defining Glossary Entries
.nlg
A Quick Guide For
german
Multi-Lingual Support
glossary
Introduction | Troubleshooting
glossary styles
altlist
Glossary Styles | Glossary Styles
altlistgroup
Glossary Styles | Glossary Styles
altlisthypergroup
Glossary Styles
altlong4col
A Quick Guide For | Glossary Styles | Glossary Styles | Glossary Styles
altlong4colborder
A Quick Guide For | Glossary Styles
altlong4colheader
A Quick Guide For | Glossary Styles
altlong4colheaderborder
A Quick Guide For | Glossary Styles
altsuper4col
A Quick Guide For | Glossary Styles | Glossary Styles | Glossary Styles
altsuper4colborder
A Quick Guide For | Glossary Styles
altsuper4colheader
A Quick Guide For | Glossary Styles
altsuper4colheaderborder
A Quick Guide For | Glossary Styles
list
Glossary Styles | Glossary Styles | Glossary Styles | Defining your own glossary | Defining your own glossary | Defining your own glossary | Defining your own glossary | Example: creating a new
listdotted
Glossary Styles
listgroup
Glossary Styles | Glossary Styles
listhypergroup
Glossary Styles | Glossary Styles | Defining your own glossary
long
Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles
long3col
Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles
long3colborder
Glossary Styles
long3colheader
Glossary Styles | Glossary Styles
long3colheaderborder
Glossary Styles
long4col
A Quick Guide For | Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles
long4colborder
A Quick Guide For | Glossary Styles | Glossary Styles
long4colheader
A Quick Guide For | Glossary Styles | Glossary Styles | Glossary Styles
long4colheaderborder
A Quick Guide For | Glossary Styles | Glossary Styles
longborder
Glossary Styles
longheader
Glossary Styles | Glossary Styles | Defining your own glossary
longheaderborder
Glossary Styles
super
Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles
super3col
Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles
super3colborder
Glossary Styles
super3colheader
Glossary Styles | Glossary Styles
super3colheaderborder
Glossary Styles
super4col
A Quick Guide For | Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles
super4colborder
A Quick Guide For | Glossary Styles | Glossary Styles
super4colheader
A Quick Guide For | Glossary Styles | Glossary Styles | Glossary Styles
super4colheaderborder
A Quick Guide For | Glossary Styles | Glossary Styles
superborder
Glossary Styles
superheader
Glossary Styles | Glossary Styles
superheaderborder
Glossary Styles
glossary-list
A Quick Guide For
\glossaryentrynumbers
Defining your own glossary
\glossaryheader
Glossary Styles
\glossaryname
Multi-Lingual Support
\glossarystyle
A Quick Guide For | Displaying a glossary | Glossary Styles | Glossary Styles
\gls
Troubleshooting | Troubleshooting | Troubleshooting | A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | Defining Glossary Entries | Defining Glossary Entries | Links to Glossary Entries | Changing the format of | Enabling and disabling hyperlinks | Acronyms | Acronyms | Unsetting and Resetting Entry
\glsadd
Troubleshooting | A Quick Guide For | A Quick Guide For
\glsaddall
Troubleshooting | A Quick Guide For | A Quick Guide For
\glsaddall keys
types
Adding an Entry to
\glscompositor
A Quick Guide For
\glsdesc
Acronyms
\glsdescwidth
Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles
\glsdisplay
Defining Glossary Entries | Defining Glossary Entries
\glsdisplayfirst
Defining Glossary Entries | Defining Glossary Entries
\glsfirst
Acronyms
\glsgroupskip
Glossary Styles
\glslabel
Changing the format of
\glslink
Troubleshooting | A Quick Guide For | A Quick Guide For | Links to Glossary Entries | Changing the format of | Enabling and disabling hyperlinks | Adding an Entry to
\glslink keys
counter
Links to Glossary Entries
format
A Quick Guide For | A Quick Guide For | A Quick Guide For | Links to Glossary Entries
hyper
Links to Glossary Entries | Enabling and disabling hyperlinks | Adding an Entry to
\glsnamefont
A Quick Guide For | A Quick Guide For
\glsnumbersgroupname
Multi-Lingual Support
\glspagelistwidth
Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles
\glspl
Troubleshooting | Troubleshooting | Troubleshooting | A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Changing the format of | Acronyms | Acronyms | Unsetting and Resetting Entry
\glspluralsuffix
Defining Glossary Entries | Defining Glossary Entries
\glssymbol
Acronyms
\glssymbolsgroupname
Multi-Lingual Support
\glstext
Links to Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Acronyms | Acronyms
\glstextformat
Changing the format of
html
A Quick Guide For | Enabling and disabling hyperlinks
\hyperemph
A Quick Guide For
\hyperlink
Enabling and disabling hyperlinks
hyperref
A Quick Guide For | Links to Glossary Entries | Links to Glossary Entries | Enabling and disabling hyperlinks | Enabling and disabling hyperlinks
\hypertarget
Enabling and disabling hyperlinks
\item
A Quick Guide For
link text
Links to Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Changing the format of | Changing the format of | Changing the format of
longtable
Glossary Styles
makeglossaries
Generating the Associated Glossary | Generating the Associated Glossary | Generating the Associated Glossary | Generating the Associated Glossary | Troubleshooting | Troubleshooting | Troubleshooting | A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | Defining Glossary Entries | Displaying a glossary | Displaying a glossary | Defining New Glossaries
makeindex
Generating the Associated Glossary | Generating the Associated Glossary | Generating the Associated Glossary | Generating the Associated Glossary | A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Displaying a glossary | Displaying a glossary | Defining New Glossaries
\MakeUppercase
Mfirstuc Package
mfirstuc
Mfirstuc Package
\newacronym
A Quick Guide For | Package Options | Package Options | Package Options | Package Options | Package Options | Acronyms | Acronyms
\newglossary
A Quick Guide For
\newglossaryentry
A Quick Guide For | A Quick Guide For | Links to Glossary Entries | Links to Glossary Entries | Acronyms
\newglossaryentry keys
description
A Quick Guide For | Package Options | Package Options | Package Options | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Changing the format of | Acronyms | Acronyms
descriptionplural
Defining Glossary Entries
first
Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Changing the format of | Using Glossary Terms Without | Acronyms | Unsetting and Resetting Entry
firstplural
Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Plurals | Links to Glossary Entries | Links to Glossary Entries | Changing the format of | Using Glossary Terms Without
format
Links to Glossary Entries
name
A Quick Guide For | Package Options | Package Options | Package Options | Package Options | Package Options | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Using Glossary Terms Without | Acronyms | Acronyms | Defining your own glossary
plural
A Quick Guide For | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Plurals | Plurals | Links to Glossary Entries | Links to Glossary Entries | Changing the format of | Using Glossary Terms Without
sort
A Quick Guide For | Package Options | Defining Glossary Entries | Defining your own glossary | Defining your own glossary
symbol
Package Options | Package Options | Package Options | Defining Glossary Entries | Defining Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Changing the format of | Changing the format of | Changing the format of | Acronyms
symbolplural
Defining Glossary Entries
text
Package Options | Package Options | Defining Glossary Entries | Defining Glossary Entries | Defining Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Links to Glossary Entries | Changing the format of | Using Glossary Terms Without | Acronyms | Unsetting and Resetting Entry
type
A Quick Guide For | A Quick Guide For | Defining Glossary Entries | Loading Entries From a
\newglossarystyle
Glossary Styles
ngerman
Multi-Lingual Support
number list
Package Options | Package Options | Number lists | Defining New Glossaries | Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles | Glossary Styles | Example: creating a completely
package options
acronym
Multi-Lingual Support | Multi-Lingual Support | Generating the Associated Glossary | Generating the Associated Glossary | A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | Package Options | Package Options | Package Options | Package Options | Package Options | Package Options | Package Options | Package Options | Defining Glossary Entries | Defining Glossary Entries | Loading Entries From a | Loading Entries From a | Loading Entries From a | Loading Entries From a | Loading Entries From a | Loading Entries From a | Defining New Glossaries | Defining New Glossaries | Defining New Glossaries | Defining New Glossaries | Defining New Glossaries | Defining New Glossaries | Acronyms | Acronyms
counter
Package Options | Package Options | Number lists | Number lists
description
Package Options | Package Options | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms
dua
Package Options | Package Options | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms
footnote
Package Options | Package Options | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms
nonumberlist
A Quick Guide For | A Quick Guide For | Package Options | Package Options | Number lists | Number lists | Defining your own glossary | Defining your own glossary | Defining your own glossary | Defining your own glossary
numberedsection
Package Options | Package Options | Package Options | Package Options | Package Options | Displaying a glossary | Displaying a glossary | Displaying a glossary | Displaying a glossary
autolabel
Package Options | Package Options
false
Package Options
nolabel
Package Options
numberline
Package Options | Package Options | Package Options | Package Options
sanitize
Package Options | Package Options | Package Options | Package Options | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms
description
Acronyms | Acronyms
symbol
Acronyms | Acronyms | Acronyms | Acronyms
section
A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | Package Options | Package Options
shortcuts
Package Options | Package Options | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms
smallcaps
Troubleshooting | Troubleshooting | Troubleshooting | Troubleshooting | Package Options | Package Options | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms
smaller
Troubleshooting | Troubleshooting | Troubleshooting | Troubleshooting | Package Options | Package Options | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms | Acronyms
style
A Quick Guide For | A Quick Guide For | Package Options | Package Options | Displaying a glossary | Displaying a glossary | Glossary Styles | Glossary Styles
toc
A Quick Guide For | A Quick Guide For | A Quick Guide For | A Quick Guide For | Package Options | Package Options | Package Options | Package Options | Package Options | Package Options | Package Options | Package Options | Displaying a glossary | Displaying a glossary
\pagelistname
Multi-Lingual Support
\printglossaries
Troubleshooting | A Quick Guide For | Defining Glossary Entries
\printglossary
Troubleshooting | Defining Glossary Entries | Glossary Styles | Glossary Styles
\printglossary keys
nonumberlist
Displaying a glossary
numberedsection
Displaying a glossary
style
Displaying a glossary | Glossary Styles | Glossary Styles
title
Displaying a glossary
toctitle
Displaying a glossary
type
Displaying a glossary
relsize
Acronyms
\setglossarysection
Package Options
\smaller
Acronyms
supertabular
Glossary Styles
\symbolname
Multi-Lingual Support
translator
Multi-Lingual Support | Multi-Lingual Support | Multi-Lingual Support | Multi-Lingual Support | Multi-Lingual Support | Multi-Lingual Support | Multi-Lingual Support | Troubleshooting

Top



Footnotes

... range1
This is new to version 1.01
...acronym2
if the acronym option is used, otherwise the list of acronyms is the main glossary
... this.3
The only preamble restriction on \newglossaryentry and \newacronym was removed in version 1.13, but the restriction remains for \loadglsentries.
... label4
main for the main (default) glossary, \acronymtype for the list of acronyms, or the name supplied in the first mandatory argument to \newglossary for additional glossaries.
...smaller,5
you will need to load a package, such as relsize, that defines \smaller if you use this option.
... start.6
This style was supplied by Axel Menzel.
... link7
if the document doesn't have hyperlinks enabled \@glslink ignores the label and simply typesets the text.
... correctly.8
again, if the document doesn't support hyperlinks, \@glstarget will ignore the label, and just typeset the text.
...MakeTextUppercase9
defined in the textcase package