1 files changed, 100 insertions, 12 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex
index 9ede69d65e0..c46dc8497f7 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{4357}
+\CheckSum{4630}
 \CodelineNumbered
 \newcommand*{\termdef}[1]{\emph{#1}\iterm{#1}}
 \newcommand*{\term}[1]{#1\iterm{#1}}
@@ -92,7 +92,7 @@
 \MakeShortVerb{"}
 \DeleteShortVerb{\|}
 
- \title{glossaries.sty v 1.11: \LaTeXe\ Package to Assist Generating Glossaries}
+ \title{glossaries.sty v 1.12: \LaTeXe\ Package to Assist Generating Glossaries}
  \author{Nicola L.C. Talbot\\[10pt]
 School of Computing Sciences\\
 University of East Anglia\\
@@ -100,7 +100,7 @@ Norwich. Norfolk\\
 NR4 7TJ. United Kingdom.\\
 \url{http://theoval.cmp.uea.ac.uk/~nlct/}}
 
- \date{2nd March 2008}
+ \date{8th March 2008}
  \maketitle
 \tableofcontents
 
@@ -121,7 +121,7 @@ As from version 1.08, the \sty{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 \isty{babel} \emph{before} 
-\sty{glossaries} to enable this. \ifmakedtx{(See \autoref{sec:predefinednames} for the
+\sty{glossaries} to enable this. \ifmakedtx{(See \autoref{sec:predefinednames} for the 
 predefined names used by the \sty{glossaries} package.)}{}
 As from version 1.1, the \sty{glossaries} package also supports 
 Till~Tantau's \isty{translator} package provided it is loaded
@@ -133,11 +133,15 @@ package option \pkgopt[false]{translate} and supply your own translations.
 This documentation is structured as follows: \ifmakedtx{\autoref{sec:quick}}{\htmlref{{A Quick Guide For The Impatient}}{sec:quick}} is for 
 people who want a few quick pointers of how to get started,
 without having to read through lengthy descriptions, 
-\ifmakedtx{\autoref{sec:overview}}{and \htmlref{Overview}{sec:overview}} gives an overview of available commands
-and their syntax\ifmakedtx{, \autoref{sec:code} contains the documented
+\ifmakedtx{\autoref{sec:overview}}{\htmlref{Overview}{sec:overview}} gives an overview of available commands 
+and their syntax\ifmakedtx{, \autoref{sec:mfirstuc}}{ and 
+\htmlref{Mfirstuc}{sec:mfirstuc}} describes the associated
+\sty{mfirstuc} 
+package\ifmakedtx{, \autoref{sec:code} contains the documented 
 source code for those who want to know more about how the
-package works, and how to do more complicated things, such as
-changing the way glossary entries appear}{}.\ifmakedtx{}{\toTop}
+package works and how to do more complicated things, such as
+changing the way glossary entries appear}{}.
+\ifmakedtx{}{\toTop}
 
 \subsection{Generating the associated glossary files}
 \label{sec:makeglossaries}
@@ -319,6 +323,12 @@ problem for \ics{Gls} and \ics{Glspl}):
 \newglossaryentry{elite}{name={{\'e}lite},
 description={select group or class}}
 \end{verbatim}
+Likewise with commands such as \cs{ae} and \cs{oe}:
+\begin{verbatim}
+\newglossaryentry{oesophagus}{%
+name={{\oe}sophagus},
+description={canal from mouth to stomach}}
+\end{verbatim}
 
 \item If you have multiple glossaries, use the \gloskey{type}
 key to specify in which glossary the entry belongs. For example:
@@ -769,6 +779,11 @@ glossary).
 \item[{\gloskey{description}}] A brief description of this term (to
 appear in the glossary).
 
+\item[{\gloskey{descriptionplural}}] The plural form of the 
+description (as passed to \ics{glsdisplay} and \ics{glsdisplayfirst}
+by \ics{glspl}, \ics{Glspl} and \ics{GLSpl}). If omitted, the value
+is set to the same as the \gloskey{description} key.
+
 \item[{\gloskey{text}}] How this entry will appear in the document text
 when using \ics{gls} (or one of its uppercase variants). If this
 field is omitted, the value of the \gloskey{name} key is used.
@@ -793,6 +808,11 @@ field.
 specify an associated symbol, but most glossary styles ignore
 this value. If omitted, the value is set to \cs{relax}.
 
+\item[{\gloskey{symbolplural}}] This is the plural form of the
+symbol (as passed to \ics{glsdisplay} and \ics{glsdisplayfirst}
+by \ics{glspl}, \ics{Glspl} and \ics{GLSpl}). If omitted, the value
+is set to the same as the \gloskey{symbol} key.
+
 \item[{\gloskey{sort}}] This value indicates how \appname{makeindex}
 should sort this entry. If omitted, the value is given by the
 \gloskey{name} field.  This value is equivalent to
@@ -807,16 +827,32 @@ belongs. If omitted, the default glossary is assumed
 \texttt{acronym}, depending on whether the \pkgopt{acronym} package
 option was used.
 \end{description}
-Note that if the \gloskey{text} key (or the \gloskey{name} key, if the
-\gloskey{text} key is omitted) starts with an accented letter,
+Note that if the key starts with an accented letter,
 you must group the accented letter, otherwise it will cause a
 problem for \cs{Gls} and \cs{Glspl}. For example:
 \begin{verbatim}
 \newglossaryentry{elite}{name={{\'e}lite},
 description={select group or class}}
 \end{verbatim}
-(Likewise for the \gloskey{plural}, \gloskey{first} and 
-\gloskey{firstplural} keys.)
+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. 
+
 
 \DescribeMacro{\loadglsentries}
 You can store all your glossary entry definitions in another
@@ -1477,6 +1513,28 @@ None of the above&
 \end{center}
 \end{table}
 
+In case you can't remember which key stores the long or short forms
+(or their plurals) the \sty{glossaries} package provides the 
+commands:
+\begin{itemize}
+\item\DescribeMacro{\glsshortkey}\cs{glsshortkey}
+The key used to store the short form.
+\item\DescribeMacro{\glsshortpluralkey}\cs{glsshortpluralkey}
+The key used to store the plural version of the short form.
+\item\DescribeMacro{\glslongkey}\cs{glslongkey}
+The key used to store the long form.
+\item\DescribeMacro{\glslongpluralkey}\cs{glslongpluralkey}
+The key used to store the plural version of the long form.
+\end{itemize}
+These can be used in the optional argument of \cs{newacronym}
+to override the defaults. For example:
+\begin{verbatim}
+\newacronym[\glslongpluralkey={diagonal matrices}]{dm}{DM}{diagonal 
+matrix}
+\end{verbatim}
+If the first use uses the plural form, \verb|\glspl{dm}| will
+display: diagonal matrices (DMs).
+
 Each of the package options \pkgopt{smallcaps}, \pkgopt{footnote}
 and \pkgopt{description} use \ics{defglsdisplay} and 
 \ics{defglsdisplayfirst} (described \ifmakedtx{in 
@@ -1940,6 +1998,36 @@ follows:
 \end{verbatim} 
 \ifmakedtx{}{\toTop}
 
+\section{Mfirstuc Package}
+\label{sec:mfirstuc}
+
+The \sty{glossaries} package is supplied with the package 
+\isty{mfirstuc} which provides the command:\\[10pt]
+\DescribeMacro{\makefirstuc}
+\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
+object in the group is converted to uppercase. Examples:
+\begin{itemize}
+\item \verb|\makefirstuc{abc}| produces Abc
+
+\item \verb|\makefirstuc{\emph{abc}}| produces \emph{Abc} 
+(\ics{MakeUppercase} has been applied to the letter \dq{a} rather
+than \cs{emph}.)
+
+\item \verb|\makefirstuc{{\'a}bc}| produces {\'A}bc
+
+\item \verb|\makefirstuc{\ae bc}| produces \AE bc
+
+\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.
+\ifmakedtx{}{\toTop}
+
  \StopEventually{\clearpage\phantomsection\addcontentsline{toc}{section}{Index}\PrintIndex}
 
 \ifmakedtx{}{\printindex\toTop}