Upgrading from the glossary package to the glossaries package

Upgrading from the glossary package to the glossaries package

Nicola L.C. Talbot

2011-04-12

Abstract

The purpose of this document is to provide advice if you want to convert a LATEX document from using the obsolete glossary package to the replacement glossaries package.

Contents

1 Why the Need for a New Package?
2 Package Options
3 Defining new glossary types
4 \make⟨glossary name⟩
5 Storing glossary information
6 Adding an entry to the glossary
 6.1 \useglosentry
 6.2 \useGlosentry
 6.3 \gls
 6.4 \glossary
7 Acronyms
 7.1 \acrln and \acrsh
 7.2 \ifacronymfirstuse
 7.3 \resetacronym and \unsetacronym
8 Displaying the glossary
9 Processing Your Document
10 Troubleshooting

1 Why the Need for a New Package?

The glossary package started out as an example in a tutorial, but I decided that I may as well package it up and upload it to CTAN. Unfortunately it was fairly rigid and unable to adapt well to the wide variation in glossary styles. Users began making requests for enhancements, but with each enhancement the code became more complicated and bugs crept in. Each fix in one place seemed to cause another problem elsewhere. In the end, it was taking up too much of my time to maintain, so I decided to replace it with a much better designed package. With the new glossaries package:

Top

2 Package Options

When converting a document that currently uses the obsolete glossary package to the replacement glossaries package, it should be fairly obvious that the first thing you need to do is replace \usepackage{glossary} with \usepackage{glossaries}, however some of the package options are different, so you may need to change those as well. Table 1 shows the mappings from the glossary to the glossaries package options.

Table 1: Mappings from glossary to glossaries package options

glossary option glossaries option
style=list style=list
style=altlist style=altlist
style=long,header=none,border=none,cols=2 style=long
style=long,header=plain,border=none,cols=2 style=longheader
style=long,header=none,border=plain,cols=2 style=longborder
style=long,header=plain,border=plain,cols=2 style=longheaderborder
style=long,header=none,border=none,cols=3 style=long3col
style=long,header=plain,border=none,cols=3 style=long3colheader
style=long,header=none,border=plain,cols=3 style=long3colborder
style=long,header=plain,border=plain,cols=3 style=long3colheaderborder
style=super,header=none,border=none,cols=2 style=super
style=super,header=plain,border=none,cols=2style=superheader
style=super,header=none,border=plain,cols=2style=superborder
style=super,header=plain,border=plain,cols=2style=superheaderborder
style=super,header=none,border=none,cols=3 style=super3col
style=super,header=plain,border=none,cols=3style=super3colheader
style=super,header=none,border=plain,cols=3style=super3colborder
style=super,header=plain,border=plain,cols=3style=super3colheaderborder
number=none nonumberlist
number=⟨counter name⟩ counter=⟨counter name⟩
toc toc
hypertoc toc
hyper no corresponding option
section=true section
section=false no corresponding option
acronym acronym
global no corresponding option

Top

3 Defining new glossary types

If you have created new glossary types, you will need to replace all instances of

glossary \newglossarytype[⟨log-ext⟩]{⟨type⟩}{⟨out-ext⟩}{⟨in-ext⟩}[⟨old style list⟩]

\newcommand{\⟨type⟩name}{⟨title⟩}

with

glossaries \newglossary[⟨log-ext⟩]{⟨type⟩}{⟨out-ext⟩}{⟨in-ext⟩}{⟨title⟩}

in the preamble, and, if the new glossary requires a different style to the main (default) glossary, you will also need to put

glossaries \glossarystyle{⟨new style⟩}

immediately before the glossary is displayed, or you can specify the style when you display the glossary using \printglossary (see below).

The ⟨old style list⟩ optional argument can be converted to ⟨new style⟩ using the same mapping given in Table 1.

For example, if your document contains the following:

\newglossarytype[nlg]{notation}{not}{ntn}[style=long,header]  
\newcommand{\notationname}{Index of Notation}

You will need to replace the above two lines with:

\newglossary[nlg]{notation}{not}{ntn}{Index of Notation}

in the preamble and

\glossarystyle{longheader}

immediately prior to displaying this glossary. Alternatively, you can specify the style using the style key in the optional argument of \printglossary. For example:

\printglossary[type=notation,style=longheader]

Note that the glossary title is no longer specified using \⟨glossary-type⟩name (except for \glossaryname and \acronymname) but is instead specified in the ⟨title⟩ argument of \newglossary. The short title which is specified in the glossary package by the command \short⟨glossary-name⟩name is now specified using the toctitle key in the optional argument to \printglossary.

Top

4 \make⟨glossary name⟩

All instances of \make⟨glossary name⟩ (e.g. \makeglossary and \makeacronym) should be replaced by the single command \makeglossaries. For example, if your document contained the following:

\makeglossary  
\makeacronym

then you should replace both lines with the single line:

\makeglossaries

Top

5 Storing glossary information

With the old glossary package you could optionally store glossary information for later use, or you could simply use \glossary whenever you wanted to add information to the glossary. With the new glossaries package, the latter option is no longer available.3 If you have stored all the glossary information using \storeglosentry, then you will need to convert these commands into the equivalent \newglossaryentry. If you have only used \glossary, then see §6.4 \glossary.

Substitute all instances of

glossary \storeglosentry{⟨label⟩}{⟨gls-entry⟩}

with

glossaries \newglossaryentry{⟨label⟩}{⟨gls-entry⟩}

This should be fairly easy to do using the search and replace facility in your editor (but see notes below).

If you have used the optional argument of \storeglosentry (i.e. you have multiple glossaries) then you will need to substitute

glossary \storeglosentry[⟨gls-type⟩]{⟨label⟩}{⟨gls-entry⟩}

with

glossaries \newglossaryentry{⟨label⟩}{⟨gls-entry⟩,type=⟨gls-type⟩}

The glossary entry information ⟨gls-entry⟩ may also need changing. If ⟨gls-entry⟩ contains any of makeindex’s special characters (i.e. @ ! " or |) then they should no longer be escaped with " since the glossaries package deals with these characters internally. For example, if your document contains the following:

\storeglosentry{card}{name={$"|\mathcal{S}"|$},  
description={The cardinality of the set $\mathcal{S}$}}

then you will need to replace it with:

\newglossaryentry{card}{name={$|\mathcal{S}|$},  
description={The cardinality of the set $\mathcal{S}$}}

The format and number keys available in \storeglosentry are not available with \newglossaryentry.

Top

6 Adding an entry to the glossary

The glossary package provided two basic means to add information to the glossary: firstly, the term was defined using \storeglosentry and the entries for that term were added using \useglosentry, \useGlosentry and \gls. Secondly, the term was added to the glossary using \glossary. This second approach is unavailable with the glossaries package.

Top

6.1 \useglosentry

The glossary package allows you to add information to the glossary for a predefined term without producing any text in the document using

glossary \useglosentry[⟨old options⟩]{⟨label⟩}

Any occurrences of this command will need to be replaced with

glossaries \glsadd[⟨new options⟩]{⟨label⟩}

The format key in ⟨old options⟩ remains the same in ⟨new options⟩. However the number=⟨counter name⟩ key in ⟨old options⟩ should be replaced with counter=⟨counter name⟩ in ⟨new options⟩.

Top

6.2 \useGlosentry

The glossary package allows you to add information to the glossary for a predefined term with the given text using

glossary \useGlosentry[⟨old options⟩]{⟨label⟩}{⟨text⟩}

Any occurrences of this command will need to be replaced with

glossaries \glslink[⟨new options⟩]{⟨label⟩}{⟨text⟩}

The mapping from ⟨old options⟩ to ⟨new options⟩ is the same as that given §6.1 \useglosentry.

Top

6.3 \gls

Both the glossary and the glossaries packages define the command \gls. In this case, the only thing you need to change is the number key in the optional argument to counter. Note that the new form of \gls also takes a final optional argument which can be used to insert text into the automatically generated text.

Top

6.4 \glossary

When using the glossaries package, you should not use \glossary directly.4 If, with the old package, you have opted to explicitly use \glossary instead of storing the glossary information with \storeglosentry, then converting from glossary to glossaries will be more time-consuming, although in the end, I hope you will see the benefits.5 If you have used \glossary with the old glossary package, you will instead need to define the relevant glossary terms using \newglossaryentry and reference the terms using \glsadd, \glslink, \gls etc.

If you don’t like the idea of continually scrolling back to the preamble to type all your \newglossaryentry commands, you may prefer to create a new file, in which to store all these commands, and then input that file in your document’s preamble. Most text editors and front-ends allow you to have multiple files open, and you can tab back and forth between them.

Top

7 Acronyms

In the glossary package, acronyms were treated differently to glossary entries. This resulted in inconsistencies and sprawling unmaintainable code. The new glossaries package treats acronyms in exactly the same way as normal glossary terms. In fact, in the glossaries package, the default definition of:

glossaries \newacronym[⟨options⟩]{⟨label⟩}{⟨abbrv⟩}{⟨long⟩}

is a shortcut for:

glossaries \newglossaryentry{⟨label⟩}{type=\acronymtype,
name={⟨abbrv⟩},
description={⟨long⟩},
text={⟨abbrv⟩},
first={⟨long⟩ (⟨abbrv⟩)},
plural={⟨abbrv⟩s},
firstplural={⟨long⟩s (⟨abbrv⟩s)},
⟨options⟩}

This is different to the glossary package which set the name key to ⟨long⟩ (⟨abbrv⟩) and allowed you to set a description using the description key. If you still want to do this, you can use the description package option, and use the description key in the optional argument of \newacronym.

For example, if your document originally had the following:

\newacronym{SVM}{Support Vector Machine}{description=Statistical  
pattern recognition technique}

Then you would need to load the glossaries package using the description package option, for example:

\usepackage[description]{glossaries}

and change the acronym definition to:

\newacronym[description=Statistical pattern recognition  
technique]{svm}{SVM}{Support Vector Machine}

You can then reference the acronym using any of the new referencing commands, such as \gls or \glsadd.

With the old glossary package, when you defined an acronym, it also defined a command \⟨acr-name⟩ which could be used to display the acronym in the text. So the above SVM example would create the command \SVM with the old package. In the new glossaries package, the acronyms are just another type of glossary entry, so they are displayed using \gls{⟨label⟩}. Therefore, in the above example, you will also need to replace all occurrences of \SVM with \gls{svm}.

If you have used \useacronym instead of \⟨acr-name⟩, then you will need to replace all occurrences of

glossary \useacronym[⟨insert⟩]{⟨acr-name⟩}

with

glossaries \gls{⟨label⟩}[⟨insert⟩]

Note that the starred versions of \useacronym and \⟨acr-name⟩ (which make the first letter uppercase) should be replaced with \Gls{⟨label⟩}.

Alternatively (as from v1.18 of the glossaries package), you can use \oldacronym which uses the same syntax as the old glossary package’s \newacronym and also defines \⟨acr-name⟩. For example, if your document originally had the following:

glossary

\newacronym{SVM}{Support Vector Machine}{description=Statistical

pattern recognition technique}

then you can change this to:

glossaries

\oldacronym{SVM}{Support Vector Machine}{description=Statistical

pattern recognition technique}

You can then continue to use \SVM. However, remember that LATEX generally ignores spaces after command names that consist of alphabetical characters. You will therefore need to force a space after \⟨acr-name⟩, unless you also load the xspace package. (See Acronyms of the glossaries documentation for further details.) Note that \oldacronym uses its first argument to define the acronym’s label (as used by commands like \gls), so in the above example, with the new glossaries package, \SVM becomes a shortcut for \gls{SVM} and \SVM* becomes a shortcut for \Gls{SVM}.

Top

7.1 \acrln and \acrsh

In the glossary package, it is possible to produce the long and short forms of an acronym without adding an entry to the glossary using \acrln and \acrsh. With the glossaries package (provided you defined the acronym using \newacronym or \oldacronym and provided you haven’t redefined \newacronym) you can replace

glossary \acrsh{⟨acr-name⟩}

with

glossaries \acrshort{⟨label⟩}

and you can replace

glossary \acrln{⟨acr-name⟩}

with

glossaries \acrlong{⟨label⟩}

The glossaries package also provides the related commands \acrshortpl (plural short form) and \acrlongpl (plural long form) as well as upper case variations. If you use the glossaries “shortcuts” package option, you can use \acs in place of \acrshort and \acl in place of \acrlong.

See Acronyms of the glossaries manual for further details of how to use these commands.

Top

7.2 \ifacronymfirstuse

The glossary package command

glossary \ifacronymfirstuse{⟨acr-name⟩}{⟨text1⟩}{⟨text2⟩}

can be replaced by the glossaries command:

glossaries \ifglsused{⟨label⟩}{⟨text2⟩}{⟨text1⟩}

Note that \ifglsused evaluates the opposite condition to that of \ifacronymfirstuse which is why the last two arguments have been reversed.

Top

7.3 \resetacronym and \unsetacronym

The glossary package allows you to reset and unset the acronym flag which is used to determine whether the acronym has been used in the document. The glossaries package also provides a means to do this on either a local or a global level. To reset an acronym, you will need to replace:

glossary \resetacronym{⟨acr-name⟩}

with either

glossaries \glsreset{⟨label⟩}

or

glossaries \glslocalreset{⟨label⟩}

To unset an acronym, you will need to replace:

glossary \unsetacronym{⟨acr-name⟩}

with either

glossaries \glsunset{⟨label⟩}

or

glossaries \glslocalunset{⟨label⟩}

To reset all acronyms, you will need to replace:

glossary \resetallacronyms

with

glossaries \glsresetall[\acronymtype]

or

glossaries \glslocalresetall[\acronymtype]

To unset all acronyms, you will need to replace:

glossary \unsetallacronyms

with

glossaries \glsunsetall[\acronymtype]

or

glossaries \glslocalunsetall[\acronymtype]

Top

8 Displaying the glossary

The glossary package provides the command \printglossary (or \print⟨type⟩ for other glossary types) which can be used to print individual glossaries. The glossaries package provides the command \printglossaries which will print all the glossaries which have been defined, or \printglossary[⟨options⟩] to print individual glossaries. So if you just have \printglossary, then you can leave it as it is, but if you have, say:

\printglossary  
\printglossary[acronym]

or

\printglossary  
\printacronym

then you will need to replace this with either

\printglossaries

or

\printglossary  
\printglossary[type=\acronymtype]

The glossary package allows you to specify a short title (for the table of contents and page header) by defining a command of the form \short⟨glossary-type⟩name. The glossaries package doesn’t do this, but instead provides the toctitle key which can be used in the optional argument to \printglossary. For example, if you have created a new glossary type called notation, and you had defined

\newcommand{\shortnotationname}{Notation}

then you would need to use the toctitle key:

\printglossary[type=notation,toctitle=Notation]

The glossaries package will ignore \shortnotationname, so unless you have used it elsewhere in the document, you may as well remove the definition.

Top

9 Processing Your Document

If you convert your document from using the glossary package to the glossaries package, you will need to delete any of the additional files, such as the .glo file, that were created by the glossary package, as the glossaries package uses a different format. Remember also, that if you used the makeglos Perl script, you will need to use the makeglossaries Perl script instead. As from v1.17, the glossaries package can be used with either makeindex or xindy. Since xindy was designed to be multilingual, the new glossaries package is a much better option for non-English documents.

For further information on using makeglossaries, makeindex or xindy to create your glossaries, see Generating the Associated Glossary Files of the glossaries documentation.

Top

10 Troubleshooting

Please check the FAQ for the glossaries package if you have any problems.

Top

Index

A

\acl  1
\acrln  2, 3
\acrlong  4, 5
\acrlongpl  6
\acronymname  7
\acronymtype  8, 9, 10, 11
\acrsh  12, 13
\acrshort  14, 15
\acrshortpl  16
\acs  17

F file types
     .glo  18

G \glossary  19, 20, 21, 22, 23, 24, 25, 26, 27
\glossaryname  28
\glossarystyle  29
\Gls  30
\gls  31, 32, 33, 34, 35, 36, 37, 38
\gls options
     counter  39
    number  40
\glsadd  41, 42, 43
\glsadd options
     counter  44
\glslink  45, 46
\glslocalreset  47
\glslocalresetall  48
\glslocalunset  49
\glslocalunsetall  50
\glsreset  51
\glsresetall  52
\glsunset  53
\glsunsetall  54

I \ifacronymfirstuse  55, 56
\ifglsused  57, 58

M \makeacronym  59
makeglos  60
makeglossaries  61, 62
\makeglossaries  63
\makeglossary  64
makeindex  65, 66, 67, 68, 69, 70, 71, 72, 73

N \newacronym  74, 75, 76, 77, 78
\newglossary  79, 80
\newglossaryentry  81, 82, 83, 84, 85, 86, 87
\newglossaryentry options
     description  88, 89
    name  90
\newglossarytype  91

O \oldacronym  92, 93, 94

P package options:
     description  95, 96
\printglossaries  97
\printglossary  98, 99, 100, 101, 102, 103, 104
\printglossary options
     style  105
    toctitle  106, 107, 108

R \resetacronym  109
\resetallacronyms  110

S \shortnotationname  111
\storeglosentry  112, 113, 114, 115, 116, 117, 118
\storeglosentry options
     format  119
    number  120

U \unsetacronym  121
\unsetallacronyms  122
\useacronym  123, 124, 125
\useGlosentry  126, 127
\useglosentry  128, 129
\useglosentry options
     format  130
    number  131

X xindy  132, 133, 134, 135, 136, 137, 138

1as from v1.17. Previous versions were designed to be used with makeindex only

2as from v1.17

3mainly because having a key value list in \glossary caused problems, but it also helps consistency.

4This is because \glossary requires the argument to be in a specific format and doesn’t use the ⟨key⟩=⟨value⟩ format that the old glossary package used. The new package’s internal commands set this format, as well as escaping any of makeindex’s or xindy’s special characters. What’s more, the format has changed as from v1.17 to allow the new package to be used with either makeindex or xindy.

5From the user’s point of view, using \glossary throughout the document is time consuming, and if you use it more than once for the same term, there’s a chance extra spaces may creep in which will cause makeindex to treat the two entries as different terms, even though they look the same in the document.