summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex316
1 files changed, 259 insertions, 57 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex
index d46e6e58645..ac8cf241478 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex
@@ -23,7 +23,7 @@
\makeatother
\RecordChanges
\PageIndex
-\CheckSum{5110}
+\CheckSum{5121}
\CodelineNumbered
\newcommand*{\termdef}[1]{\emph{#1}\iterm{#1}}
\newcommand*{\term}[1]{#1\iterm{#1}}
@@ -31,6 +31,18 @@
\newcommand{\dq}[1]{``#1''}
\newcommand*{\tableref}[1]{\hyperref[#1]{table~\ref*{#1}}}
\newcommand*{\Tableref}[1]{\hyperref[#1]{Table~\ref*{#1}}}
+\newlength\boxlength
+\newsavebox\importantbox
+\newenvironment{important}{%
+\setlength{\fboxrule}{4pt}%
+\setlength\boxlength{\linewidth}%
+\addtolength\boxlength{-2\fboxsep}%
+\addtolength\boxlength{-2\fboxrule}%
+\begin{lrbox}{\importantbox}%
+\begin{minipage}{\boxlength}%
+}{\end{minipage}\end{lrbox}%
+\par\vskip10pt\noindent
+\fcolorbox{red}{white}{\usebox{\importantbox}}\par\vskip10pt}
}
{
\usepackage{html}
@@ -43,6 +55,7 @@
\newcommand{\dq}[1]{"#1"}
\newcommand*{\tableref}[1]{\htmlref{table~}{#1}\ref{#1}}
\newcommand*{\Tableref}[1]{\htmlref{Table~}{#1}\ref{#1}}
+\newenvironment{important}{}{}
}
@@ -96,7 +109,7 @@
\MakeShortVerb{"}
\DeleteShortVerb{\|}
- \title{glossaries.sty v 1.13: \LaTeXe\ Package to Assist Generating Glossaries}
+ \title{glossaries.sty v 1.14: \LaTeXe\ Package to Assist Generating Glossaries}
\author{Nicola L.C. Talbot\\[10pt]
School of Computing Sciences\\
University of East Anglia\\
@@ -104,7 +117,7 @@ Norwich. Norfolk\\
NR4 7TJ. United Kingdom.\\
\url{http://theoval.cmp.uea.ac.uk/~nlct/}}
- \date{12th May 2008}
+ \date{18th June 2008}
\maketitle
\tableofcontents
@@ -135,6 +148,7 @@ code for the \sty{mfirstuc} package}{}.
\ifmakedtx{}{\toTop}
\subsection{Multi-Lingual Support}
+\label{sec:languages}
As from version 1.08, the \sty{glossaries} package now has
limited multi-lingual support, thanks to all the people who have sent
@@ -143,7 +157,15 @@ me the relevant translations either via email or via
However you must load \isty{babel} \emph{before}
\sty{glossaries} to enable this. Note that if \isty{babel} is loaded
and the \isty{translator} package is detected on \TeX's path, then the
-\isty{translator} package will be loaded automatically.
+\isty{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
+\isty{translator} package with the required languages. For example:
+\begin{verbatim}
+\usepackage[spanish]{babel}
+\usepackage[spanish]{translator}
+\usepackage{glossaries}
+\end{verbatim}
If you want to use \isty{ngerman} or \isty{german} instead
of \isty{babel}, you will need to include the \isty{translator} package
@@ -269,13 +291,106 @@ If any problems occur, remember to check the transcript files
The \sty{glossaries} package comes with a minimal file called
\texttt{minimalgls.tex} which can be used for testing. This
-should be located in \texttt{texmf/doc/latex/glossaries/samples/}. Further
-information on debugging \LaTeX\ code is available at
+should be located in \texttt{texmf/doc/latex/glossaries/samples/}.
+Further information on debugging \LaTeX\ code is available at
\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/}.
-There is a list of frequently asked questions for the
-\sty{glossaries} package available at
-\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}.\ifmakedtx{}{\toTop}
+Below is a list of the most frequently asked questions. For
+other queries, consult the \sty{glossaries} FAQ at
+\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}.
+
+\begin{enumerate}
+\item I've used the \pkgopt{smallcaps} option, but the acronyms
+are displayed in normal sized upper case letters.
+
+The \pkgopt{smallcaps} package option uses \cs{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.
+
+\item How do I change the font that the acronyms are displayed in?
+
+The easiest way to do this is to specify the \pkgopt{smaller} package
+option and redefine \cs{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:
+\begin{verbatim}
+\usepackage[smaller]{glossaries}
+\renewcommand*{\acronymfont}[1]{\textsf{#1}}
+\end{verbatim}
+
+\item 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 \pkgopt{smaller} package
+option and redefine \cs{firstacronymfont} to use the required
+command. Note that if you don't want the acronym on subsequent use
+to use \cs{smaller}, you will also need to redefine \cs{acronymfont},
+as above. For example to make the acronym emphasized on first use,
+but use the surrounding font for subsequent use, you can do:
+\begin{verbatim}
+\usepackage[smaller]{glossaries}
+\renewcommand*{\firstacronymfont}[1]{\emph{#1}}
+\renewcommand*{\acronymfont}[1]{#1}
+\end{verbatim}
+
+\item I don't have Perl installed, do I have to use
+\appname{makeglossaries}?
+
+Read \ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{the previous
+section}{sec:makeglossaries}}.
+
+
+\item I'm used to using the \sty{glossary} package: are there any
+instructions on migrating from the \isty{glossary} package to the
+\sty{glossaries} package?
+
+Read \ifmakedtx{the file \texttt{glossary2glossaries.pdf}}{\htmladdnormallink{Upgrading
+from the glossary package to the glossaries
+package}{glossary2glossaries.html}} which should be available from the
+same location as this document.
+
+\item I'm using \isty{babel} but the fixed names haven't been
+translated.
+
+The \sty{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 \isty{translator} package with the
+required languages explicitly (before you load the \sty{glossaries}
+package). For example:
+\begin{verbatim}
+\usepackage[ngerman]{babel}
+\usepackage[ngerman]{translator}
+\usepackage{glossaries}
+\end{verbatim}
+Alternatively, you may be able to add the language as a global option
+to the class file. Check the \sty{translator} package documentation for
+further details.
+
+\item My glossaries haven't appeared.
+
+Remember to do the following:
+\begin{itemize}
+\item Add \ics{makeglossaries} to the document preamble.
+
+\item Use either \ics{printglossary} for each glossary that has
+been defined or \ics{printglossaries}.
+
+\item Use \ics{gls}, \ics{Gls}, \ics{GLS}, \ics{glspl}, \ics{Glspl},
+\ics{GLSpl}, \ics{glslink}, \ics{glsadd} or \ics{glsaddall} in the
+document.
+
+\item Run \LaTeX\ on your document, then run \appname{makeglossaries},
+then run \LaTeX\ on your document again. If you want the glossaries
+to appear in the table of contents, you will need an extra \LaTeX\
+run.
+\end{itemize}
+\end{enumerate}
+\ifmakedtx{}{\toTop}
\section{A Quick Guide For The Impatient}
\label{sec:quick}
@@ -562,7 +677,7 @@ will be localised to the required text.
\item Entries can be added to the glossary without producing
any text using \ics{glsadd}\marg{label} or
-\ics{glsaddall}. These commands also taken an optional
+\ics{glsaddall}. These commands also take an optional
argument where you can specify the format. For example
\begin{verbatim}
\glsadd[format=hyperbf]{singmtx}
@@ -678,6 +793,7 @@ appear in unnumbered subsections:
\changes{1.02}{2007 May 25}{added overview section}
\subsection{Package Options}
+\label{sec:pkgopts}
The \sty{glossaries} package options are as follows:
\begin{description}
@@ -747,6 +863,23 @@ if the \pkgopt{acronym} option is used. For example:
The list of acronyms is in section~\ref{\acronymtype}.
\end{verbatim}
+As from version 1.14, you can add a prefix to the label by
+redefining \DescribeMacro{\glsautoprefix}\cs{glsautoprefix}.
+For example:
+\begin{verbatim}
+\renewcommand*{\glsautoprefix}{glo:}
+\end{verbatim}
+will add \texttt{glo:} to the automatically generated label, so
+you can then, for example, refer to the list of acronyms as follows:
+\begin{verbatim}
+The list of acronyms is in section~\ref{glo:\acronymtype}.
+\end{verbatim}
+Or, if you are undecided on a prefix:
+\begin{verbatim}
+The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}.
+\end{verbatim}
+
+
\item[\pkgopt{style}] This is a \meta{key}=\meta{value} option. Its
value should be the name of the glossary style to use. Predefined
glossary styles are listed \ifmakedtx{in \autoref{sec:styles}}{\htmlref{later}{sec:styles}}.
@@ -776,6 +909,7 @@ further details.)}{} For example, to switch off the sanitization for the
symbol=true}]{glossaries}
\end{verbatim}
+\begin{important}%
\textbf{Note}: this sanitization only applies to the \gloskey{name},
\gloskey{description} and \gloskey{symbol} keys. It doesn't apply
to any of the other keys (except the \gloskey{sort} key which is
@@ -784,6 +918,7 @@ the other keys must always be protected using \cs{protect}.
Since the value of the \gloskey{text} key is obtained from the
\gloskey{name} key, you will still need to protect fragile commands
in the \gloskey{name} key if you don't use the \gloskey{text} key.
+\end{important}
\item[\pkgopt{description}] This option changes the definition of
\ics{newacronym} to allow a description. See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}}
@@ -889,6 +1024,7 @@ uppercase variants). If this field is omitted, the value is obtained
from the \gloskey{plural} key, if the \gloskey{first} key is omitted,
or by appending \ics{glspluralsuffix} to the value of the
\gloskey{first} field, if the \gloskey{first} field is present.
+
\textbf{Note:} prior to version 1.13, the default value of
\gloskey{firstplural} was always taken by appending \dq{s} to the
\gloskey{first} key, which meant that you had to specify both
@@ -925,24 +1061,6 @@ problem for commands like \cs{Gls} and \cs{Glspl}. For example:
\newglossaryentry{elite}{name={{\'e}lite},
description={select group or class}}
\end{verbatim}
-Similarly, commands such as \cs{ae} and \cs{oe} should either be placed
-inside a group or followed by a space. For example:
-\begin{verbatim}
-\newglossaryentry{oesophagus}{%
-name={{\oe}sophagus},
-description={canal from mouth to stomach}}
-\end{verbatim}
-The following is also fine:
-\begin{verbatim}
-\newglossaryentry{oesophagus}{%
-name={\oe sophagus},
-description={canal from mouth to stomach}}
-\end{verbatim}
-but don't do \verb|\oe{}sophagus| as it will confuse
-\ics{makefirstuc} (described
-\ifmakedtx{in \autoref{sec:mfirstuc}}{\htmlref{later}{sec:mfirstuc}})
-and will produce \ifmakedtx{\oe{}}{oe}Sophagus instead of
-\ifmakedtx{{\OE}}{OE}sophagus.
\ifmakedtx{}{\toTop}
@@ -1538,7 +1656,20 @@ option has been used). If omitted, the glossary title is used.
\item[{\gloskey[printglossary]{style}}] This specifies which
glossary style to use for this glossary, overriding the effect
-of the \pkgopt{style} option or \ics{glossarystyle}.
+of the \pkgopt{style} package option or \ics{glossarystyle}.
+
+\item[{\gloskey[printglossary]{numberedsection}}] This specifies
+whether to use a numbered section for this glossary, overriding
+the effect of the \pkgopt{numberedsection} package option. This
+key has the same syntax as the \pkgopt{numberedsection} package
+option, described \ifmakedtx{in \autoref{sec:pkgopts}}{\htmlref{earlier}{sec:pkgopts}}.
+
+\item[{\gloskey[printglossary]{nonumberlist}}] Unlike the package option
+of the same name, this key is a boolean key. If true (\verb|nonumberlist=true|) the numberlist
+is suppressed for this glossary. If false (\verb|nonumberlist=false|) the numberlist is
+displayed for this glossary. If no value is supplied, true is
+assumed.
+
\end{description}
\DescribeMacro{\glossarypreamble}
@@ -1656,12 +1787,13 @@ the name of the glossary in which the acronyms should appear. If the
\texttt{acronym}, otherwise it will be \texttt{main}. The acronyms can
then be used in exactly the same way as any other glossary entry.
-(\textbf{Note:} since \cs{newacronym} sets \verb|type=\acronymtype|,
+\begin{important}%
+\textbf{Note:} since \cs{newacronym} sets \verb|type=\acronymtype|,
if you want to load a file containing acronym definitions using
\cs{loadglsentries}\oarg{type}\marg{filename}, the optional argument
\meta{type} will not have an effect unless you explicitly set the
-type as \verb|type=\glsdefaulttype|. See \ifmakedtx{\autoref{sec:loadglsentries}}{\htmlref{earlier}{sec:loadglsentries} for details}.)
-
+type as \verb|type=\glsdefaulttype|. See \ifmakedtx{\autoref{sec:loadglsentries}}{\htmlref{earlier}{sec:loadglsentries} for details}.
+\end{important}
For example, the following defines the acronym IDN:
\begin{verbatim}
@@ -1695,18 +1827,33 @@ such as \cs{acrshort}, as they vary according to the definition of
\Tableref{tab:acronymsettings} lists the package options and how the
-\ics{newglossaryentry} keys are used to store \meta{long} (the long
-form) and \meta{abbrv} (the short form). Note that the
-\pkgopt{smallcaps} option redefines \ics{acronymfont} so that it sets
-its argument using \cs{textsc} (so you should use lower case characters
-in \meta{abbrv}) and the \pkgopt{smaller} option redefines
-\cs{acronymfont} to use \cs{smaller}\footnote{\cs{smaller} is defined
-in the \sty{relsize} package.}, otherwise \cs{acronymfont} simply
-displays its argument in the surrounding font. Note also that if none
-of the package options \pkgopt{smallcaps}, \pkgopt{smaller},
-\pkgopt{dua}, \pkgopt{description} or \pkgopt{footnote} are used,
-\cs{acronymfont} is not used, so changing the definition of
-\cs{acronymfont} will have no effect under such circumstances.
+\ics{newglossaryentry} keys are used to store \meta{long} (the long
+form) and \meta{abbrv} (the short form). Note that the
+\pkgopt{smallcaps} option redefines
+\DescribeMacro{\acronymfont}\cs{acronymfont} so that it sets its
+argument using \cs{textsc} (so you should use lower case characters in
+\meta{abbrv}) and the \pkgopt{smaller} option redefines
+\cs{acronymfont} to use \cs{smaller},\footnote{you will need to load a
+package, such as \sty{relsize}, that defines \cs{smaller} if you use
+this option.} otherwise \cs{acronymfont} simply displays its argument
+in the surrounding font. Note also that if none of the package options
+\pkgopt{smallcaps}, \pkgopt{smaller}, \pkgopt{dua},
+\pkgopt{description} or \pkgopt{footnote} are used, \cs{acronymfont} is
+not used, so changing the definition of \cs{acronymfont} will have no
+effect under such circumstances.
+
+If you want to display the acronym in another font, for example,
+emphasized, then use the \pkgopt{smaller} package option and
+redefine \ics{acronymfont} to use the required font. For example:
+\begin{verbatim}
+\usepackage[smaller]{glossaries}
+\renewcommand*{\acronymfont}[1]{\emph{#1}}
+\end{verbatim}
+Where \cs{acronymfont} is available,
+\DescribeMacro{\firstacronymfont}\cs{firstacronymfont} is also
+available. By default, this simply uses \cs{acronymfont}, but it
+can be redefined to change the way the acronym is displayed on
+first use.
\begin{table}[htbp]
\caption{Package options governing \cs{newacronym} and how the
@@ -1795,7 +1942,7 @@ to change the way the link text is displayed.
\item[\pkgopt{description},\pkgopt{footnote}]\ifmakedtx{\mbox{}\par}{}
When these two package options are used together, the first use displays
the entry as:\\[10pt]
-\cs{acronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}
+\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}
\\[10pt]
while subsequent use displays the entry as:\\[10pt]
\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt]
@@ -1809,7 +1956,7 @@ given order), the \sty{glossaries} package additionally implements the
\ipkgopt[description]{sanitize}\ipkgopt[symbol]{sanitize}\verb|sanitize={description=false,symbol=false}|, so
remember to protect fragile commands when defining acronyms.
-\item[dua]\ifmakedtx{\mbox{}\par}{}
+\item[\pkgopt{dua}]\ifmakedtx{\mbox{}\par}{}
The \pkgopt{dua} package option always displays the expanded
form and so may not be used with \pkgopt{footnote}, \pkgopt{smaller} or
\pkgopt{smallcaps}. Both first use and subsequent use displays the
@@ -1822,7 +1969,7 @@ If the \pkgopt{description} package option is also used, the
\item[\pkgopt{description}]\ifmakedtx{\mbox{}\par}{}
This package option displays the entry on first use as:\\[10pt]
-\meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt]
+\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt]
while subsequent use displays the entry as:\\[10pt]
\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt]
Note also that if this package option is used, the \sty{glossaries}
@@ -1832,7 +1979,7 @@ remember to protect fragile commands when defining acronyms.
\item[\pkgopt{footnote}]\ifmakedtx{\mbox{}\par}{}
This package option displays the entry on first use as:\\[10pt]
-\cs{acronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}\\[10pt]
+\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}\\[10pt]
while subsequent use displays the entry as:\\[10pt]
\cs{acronymfont}\marg{abbrv}\meta{insert}
@@ -1844,7 +1991,7 @@ remember to protect fragile commands when defining acronyms.
\item[\pkgopt{smallcaps}]\ifmakedtx{\mbox{}\par}{}
If neither the \pkgopt{footnote} nor \pkgopt{description} options
have been set, this option displays the entry on first use as:\\[10pt]
-\meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt]
+\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt]
while subsequent use displays the entry as:\\[10pt]
\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt]
where \cs{acronymfont} is set to \verb|\textsc{#1}|, so \meta{abbrv}
@@ -1858,11 +2005,14 @@ remember to protect fragile commands when defining acronyms.
\item[\pkgopt{smaller}]\ifmakedtx{\mbox{}\par}{}
If neither the \pkgopt{footnote} nor \pkgopt{description} options
have been set, this option displays the entry on first use as:\\[10pt]
-\meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt]
+\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt]
while subsequent use displays the entry as:\\[10pt]
\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt]
where \cs{acronymfont} is set to \verb|{\smaller #1}|.
+Remember to load a package that defines \ics{smaller} (such as
+\isty{relsize}) if you want to use this option.
+
Note also that if this package option is used, the \sty{glossaries}
package additionally implements the option
\ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so
@@ -1874,7 +2024,6 @@ If none of the package options \pkgopt{smallcaps}, \pkgopt{smaller},
then on first use the entry is displayed as:\\[10pt]
\meta{long} (\meta{abbrv})\meta{insert}\\[10pt]
while subsequent use displays the entry as:\\[10pt]
-\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt]
\meta{abbrv}\meta{insert}
\end{description}
@@ -1998,7 +2147,22 @@ list for that entry. Sub groups are separated using \cs{indexspace}.
\item[listhypergroup] The \glostyle{listhypergroup} style is like
\glostyle{listgroup} but has a set of links to the glossary
-groups.
+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 \DescribeMacro{\glshypernavsep}\cs{glshypernavsep} which
+defaults to a vertical bar with a space on either side. For example,
+to simply have a space separating each group, do:
+\begin{verbatim}
+\renewcommand*{\glshypernavsep}{\space}
+\end{verbatim}
+
+Note that the hyper-navigation panel is now (as from version 1.14)
+set inside the optional argument to \cs{item} instead of after it
+to prevent a spurious space at the start. This can be changed
+by redefining \ics{glossaryheader}, but note that this needs to
+be done \emph{after} the glossary style has been set.
\item[altlist] The \glostyle{altlist} style is like \glostyle{list}
but the description is placed on the following line.
@@ -2008,7 +2172,8 @@ but the description is placed on the following line.
\item[altlisthypergroup] The \glostyle{altlisthypergroup} style is like
\glostyle{altlistgroup} but has a set of links to the glossary
-groups.
+groups. The navigation panel is the same as that for
+\glostyle{listhypergroup}, described above.
\item[listdotted] This style uses the \envname{description}
environment. Each entry starts with \verb|\item[]|, followed by the
@@ -2119,6 +2284,28 @@ or using the \gloskey[printglossary]{style} key in the optional
argument to \ics{printglossary} or using the command:\\[10pt]
\DescribeMacro{\glossarystyle}\cs{glossarystyle}\marg{style-name}\\[10pt]
+Note that if you use the \gloskey[printglossary]{style} key in the
+optional argument to \ics{printglossary}, it will override any
+previous style settings for the given glossary, so if, for example,
+you do:
+\begin{verbatim}
+\renewcommand*{\glsgroupskip}{}
+\printglossary[style=long]
+\end{verbatim}
+The new definition of \ics{glsgroupskip} will not have an affect
+for this glossary, as \cs{glsgroupskip} is redefined by
+\verb|style=long|. Likewise, \ics{glossarystyle} will also
+override any previous style definitions, so, again:
+\begin{verbatim}
+\renewcommand*{\glsgroupskip}{}
+\glossarystyle{long}
+\end{verbatim}
+will reset \cs{glsgroupskip} back to its default definition for the
+named glossary style (\dq{long} in this case). If you want to
+modify the styles, either use \ics{newglossarystyle} (described
+in the next section) or make the modifications after
+\ics{glossarystyle}.
+
\changes{1.03}{2007 July 4}{'glspostdescription added}
All the styles except for the three- and four-column styles and the
\glostyle{listdotted} style use the command
@@ -2306,7 +2493,7 @@ The \sty{glossaries} package is supplied with the package
\cs{makefirstuc}\marg{stuff}\\[10pt]
which makes the first object of
\meta{stuff} uppercase unless \meta{stuff} starts with a control
-sequence followed by a group, in which case the first
+sequence followed by a non-empty group, in which case the first
object in the group is converted to uppercase. Examples:
\begin{itemize}
\item \verb|\makefirstuc{abc}| produces Abc
@@ -2322,9 +2509,13 @@ than \cs{emph}.)
\item \verb|\makefirstuc{{\ae}bc}| produces {\AE}bc
\end{itemize}
-Note however that \verb|\makefirstuc{\ae{}bc}| produces \ae Bc since
-the empty group following \cs{ae} is considered to be the argument
-of \cs{ae} which is in fact not the case.
+\begin{important}
+In version 1.02 of \sty{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, \verb|\makefirstuc{\ae{}bc}|
+produced \ae Bc. However as from version 1.02, it now produces
+\AE bc.
+\end{important}
Note also that
\begin{verbatim}
@@ -2348,6 +2539,17 @@ This is equivalent to \cs{expandafter}\cs{makefirstuc}\cs{expandafter}\marg{stuf
\end{verbatim}
produces: Abc.
+If you want to use an alternative command to convert to uppercase,
+for example \cs{MakeTextUppercase}\footnote{defined in the
+\sty{textcase} package}, you can redefine the internal
+command \cs{@gls@makefirstuc}. For example:
+\begin{verbatim}
+\renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1}
+\end{verbatim}
+(Remember that command names that contain the @ character must
+either be placed in packages or be placed between \cs{makeatletter}
+\cs{makeatother}.)
+
\ifmakedtx{}{\toTop}
\StopEventually{\clearpage\phantomsection\addcontentsline{toc}{section}{Index}\PrintIndex}