summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex478
1 files changed, 238 insertions, 240 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex
index eae0a6359ad..384ae3995d6 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex
@@ -1,71 +1,49 @@
-\documentclass[a4paper]{article}
+\documentclass{nlctdoc}
\usepackage[colorlinks,pdfauthor={Nicola L.C. Talbot},
pdftitle={Upgrading from the glossary package to
the glossaries package}]{hyperref}
-\usepackage{html}
-\usepackage{xr}
+\usepackage{xr-hyper}
+\ifpdf
\externaldocument{glossaries}
+\fi
+
+\IndexPrologue{\section*{Index}}
+\setcounter{IndexColumns}{2}
\title{Upgrading from the glossary package to the glossaries
package}
\author{Nicola L.C. Talbot}
-\date{14th January 2009}
-
-%\begin{latexonly}
-\newcommand*{\sty}[1]{\textsf{#1}}
-\newcommand*{\key}[1]{\textsf{#1}}
-\newcommand*{\pkgopt}[1]{\textsf{#1}}
-\newcommand*{\dq}[1]{``#1''}
-
-\newsavebox\waybox
-\newenvironment{oldway}{\begin{lrbox}{\waybox}%
-\begin{minipage}{0.98\linewidth}\ttfamily
-\ignorespaces}{\end{minipage}\end{lrbox}\vskip\baselineskip\par\noindent
-\begin{tabular}{@{}r@{}}%
-\fbox{\usebox\waybox}\\[4pt]\footnotesize\mbox{\sty{glossary}}%
-\end{tabular}%
-\vskip\baselineskip\par\noindent\ignorespacesafterend}
-
-\newenvironment{newway}{\begin{lrbox}{\waybox}
-\begin{minipage}{0.98\linewidth}\ttfamily
-\ignorespaces}{\end{minipage}\end{lrbox}\vskip\baselineskip\par\noindent
-\begin{tabular}{@{}r@{}}%
-\fbox{\usebox\waybox}\\[4pt]\footnotesize\mbox{\sty{glossaries}}
-\end{tabular}%
-\vskip\baselineskip\par\noindent\ignorespacesafterend}
-\newcommand*{\meta}[1]{\textnormal{$\langle$\emph{#1}$\rangle$}}
-%\end{latexonly}
-\begin{htmlonly}
-\newenvironment{oldway}{\par\begin{ttfamily}}{\end{ttfamily}\par}
-\newenvironment{newway}{\par\begin{ttfamily}}{\end{ttfamily}\par}
-\newcommand{\sty}[1]{\texttt{#1}}
-\renewcommand{\LaTeX}{LaTeX}
-\newcommand*{\key}[1]{\texttt{#1}}
-\newcommand*{\pkgopt}[1]{\texttt{#1}}
-\newcommand*{\dq}[1]{"#1"}
-\newcommand*{\meta}[1]{\textnormal{\textless\emph{#1}\textgreater}}
-\end{htmlonly}
-
-\newcommand*{\marg}[1]{\texttt{\char`\{\meta{#1}\char`\}}}
-\newcommand*{\oarg}[1]{\texttt{[\meta{#1}]}}
-\newcommand*{\cs}[1]{\texttt{\char`\\#1}}
+\date{2010-05-28}
+
+\newenvironment{oldway}{%
+ \begin{labelledbox}{\styfmt{glossary}}\ttfamily\obeylines
+}{%
+ \end{labelledbox}%
+}
+
+\newenvironment{newway}{%
+ \begin{labelledbox}{\styfmt{glossaries}}\ttfamily\obeylines
+}{%
+ \end{labelledbox}%
+}
\begin{document}
\maketitle
-\tableofcontents
\begin{abstract}
-The purpose of this document is to provide advice if you want
-to convert a \LaTeX\ document from using the obsolete
-\sty{glossary} package to the replacement \sty{glossaries} package.
+The purpose of this document is to provide advice if you want to
+convert a \LaTeX\ document from using the obsolete \styfmt{glossary}
+package to the replacement \styfmt{glossaries} package.
\end{abstract}
+\tableofcontents
+
\section{Why the Need for a New Package?}
\label{whyglossaries}
-The \sty{glossary} package started out as an example in a tutorial,
+The \styfmt{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
@@ -73,7 +51,7 @@ 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 \sty{glossaries} package:
+better designed package. With the new \styfmt{glossaries} package:
\begin{itemize}
\item you can define irregular plurals;
@@ -87,9 +65,9 @@ to the name and description;
fixed names used in headings and by some of the glossary styles;
\item you can choose\footnote{as from v1.17. Previous versions
-were designed to be used with \texttt{makeindex} only} between using
-\texttt{makeindex} or \texttt{xindy} to sort the glossary. Using
-\texttt{xindy} means that:
+were designed to be used with \app{makeindex} only} between using
+\app{makeindex} or \app{xindy} to sort the glossary. Using
+\app{xindy} means that:
\begin{itemize}
\item there is much better support for terms containing accented
@@ -98,7 +76,7 @@ were designed to be used with \texttt{makeindex} only} between using
\item there is support for non-standard location numbers;
\end{itemize}
-\item you don't need to remember to escape \texttt{makeindex}'s
+\item you don't need to remember to escape \app{makeindex}'s
special characters as this is done internally;
\item hierarchical entries and homographs are supported;\footnote{as
@@ -116,21 +94,21 @@ maintain consistency;
\section{Package Options}
When converting a document that currently uses the obsolete
-\sty{glossary} package to the replacement \sty{glossaries} package,
+\styfmt{glossary} package to the replacement \styfmt{glossaries} package,
it should be fairly obvious that the first thing you need to do is
replace \verb|\usepackage{glossary}| with
\verb|\usepackage{glossaries}|, however some of the package options
are different, so you may need to change those as well.
-Table~\ref{tab:pkgopt} shows the mappings from the \sty{glossary}
-to the \sty{glossaries} package options.
+Table~\ref{tab:pkgopt} shows the mappings from the \styfmt{glossary}
+to the \styfmt{glossaries} package options.
\begin{table}[htbp]
-\caption[Mappings]{Mappings from \sty{glossary} to \sty{glossaries}
+\caption[Mappings]{Mappings from \styfmt{glossary} to \styfmt{glossaries}
package options}
\label{tab:pkgopt}
\begin{center}
\begin{tabular}{ll}
-\bfseries \sty{glossary} option & \bfseries \sty{glossaries} option\\
+\bfseries \styfmt{glossary} option & \bfseries \styfmt{glossaries} option\\
style=list & style=list\\
style=altlist & style=altlist\\
style=long,header=none,border=none,cols=2 & style=long\\
@@ -167,20 +145,20 @@ global & \emph{no corresponding option}
If you have created new glossary types, you will need to
replace all instances of
\begin{oldway}
-\cs{newglossarytype}\oarg{log-ext}\marg{type}\marg{out-ext}\marg{in-ext}\oarg{old style list}\newline
+\ics{newglossarytype}\oarg{log-ext}\marg{type}\marg{out-ext}\marg{in-ext}\oarg{old style list}\newline
\cs{newcommand}\verb|{\|\meta{type}name\verb|}|\marg{title}
\end{oldway}%
with
\begin{newway}
-\cs{newglossary}\oarg{log-ext}\marg{type}\marg{out-ext}\marg{in-ext}\marg{title}
+\ics{newglossary}\oarg{log-ext}\marg{type}\marg{out-ext}\marg{in-ext}\marg{title}
\end{newway}%
in the preamble, and, if the new glossary requires a different style
to the main (default) glossary, you will also need to put
\begin{newway}
-\cs{glossarystyle}\marg{new style}
+\ics{glossarystyle}\marg{new style}
\end{newway}%
immediately before the glossary is displayed, or you can specify
-the style when you display the glossary using \cs{printglossary}
+the style when you display the glossary using \ics{printglossary}
(see below).
The \meta{old style list} optional argument can be converted to
@@ -196,31 +174,32 @@ You will need to replace the above two lines with:
\begin{verbatim}
\newglossary[nlg]{notation}{not}{ntn}{Index of Notation}
\end{verbatim}
-in the preamble and
+in the preamble and
\begin{verbatim}
\glossarystyle{longheader}
\end{verbatim}
-immediately prior to displaying this glossary.
-Alternatively, you can specify the style using the \key{style}
-key in the optional argument of \cs{printglossary}. For example:
+immediately prior to displaying this glossary. Alternatively, you
+can specify the style using the \csopt{printglossary}{style} key in
+the optional argument of \ics{printglossary}. For example:
\begin{verbatim}
\printglossary[type=notation,style=longheader]
\end{verbatim}
-Note that the glossary title is no longer specified using
-\cs{}\meta{glossary-type}\texttt{name} (except for \cs{glossaryname}
-and \cs{acronymname}) but is instead specified in the \meta{title}
-argument of \cs{newglossary}. The short title which is specified
-in the \sty{glossary} package by the command
-\cs{short}\meta{glossary-name}\texttt{name} is now specified
-using the \key{toctitle} key in the optional argument to
-\cs{printglossary}.
+Note that the glossary title is no longer specified using
+\cs{}\meta{glossary-type}\texttt{name} (except for \ics{glossaryname}
+and \ics{acronymname}) but is instead specified in the \meta{title}
+argument of \ics{newglossary}. The short title which is specified in
+the \styfmt{glossary} package by the command
+\cs{short}\meta{glossary-name}\texttt{name} is now specified using
+the \csopt{printglossary}{toctitle} key in the optional argument to
+\ics{printglossary}.
-\section{\cs{make}\meta{glossary name}}
+\section{\texorpdfstring{\cs{make}\meta{glossary
+name}}{\textbackslash make...}}
All instances of \cs{make}\meta{glossary name} (e.g.\
-\cs{makeglossary} and \cs{makeacronym}) should be replaced
-by the single command \cs{makeglossaries}. For example, if
+\ics{makeglossary} and \ics{makeacronym}) should be replaced
+by the single command \ics{makeglossaries}. For example, if
your document contained the following:
\begin{verbatim}
\makeglossary
@@ -233,45 +212,44 @@ then you should replace both lines with the single line:
\section{Storing glossary information}
-With the old \sty{glossary} package you could optionally store
+With the old \styfmt{glossary} package you could optionally store
glossary information for later use, or you could simply use
-\cs{glossary} whenever you wanted to add information to the glossary.
-With the new \sty{glossaries} package, the latter option is no longer
+\ics{glossary} whenever you wanted to add information to the glossary.
+With the new \styfmt{glossaries} package, the latter option is no longer
available.\footnote{mainly because having a key value list in
-\cs{glossary} caused problems, but it also helps consistency.} If
+\ics{glossary} caused problems, but it also helps consistency.} If
you have stored all the glossary information using
-\cs{storeglosentry}, then you will need to convert these commands
-into the equivalent \cs{newglossaryentry}. If you have only
-used \cs{glossary}, then see
-\latexhtml{section~\ref{sec:csglossary}}{\htmlref{later}{sec:csglossary}}.
+\ics{storeglosentry}, then you will need to convert these commands
+into the equivalent \ics{newglossaryentry}. If you have only
+used \ics{glossary}, then see \sectionref{sec:csglossary}.
Substitute all instances of
\begin{oldway}
-\cs{storeglosentry}\marg{label}\marg{gls-entry}
+\ics{storeglosentry}\marg{label}\marg{gls-entry}
\end{oldway}%
with
\begin{newway}
-\cs{newglossaryentry}\marg{label}\marg{gls-entry}
+\ics{newglossaryentry}\marg{label}\marg{gls-entry}
\end{newway}%
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 \cs{storeglosentry}
+If you have used the optional argument of \ics{storeglosentry}
(i.e.\ you have multiple glossaries) then you will need to
substitute
\begin{oldway}
-\cs{storeglosentry}\oarg{gls-type}\marg{label}\marg{gls-entry}
+\ics{storeglosentry}\oarg{gls-type}\marg{label}\marg{gls-entry}
\end{oldway}%
with
\begin{newway}
-\cs{newglossaryentry}\marg{label}\verb|{|\meta{gls-entry},type=\meta{gls-type}\verb|}|
+\ics{newglossaryentry}\marg{label}\verb|{|\meta{gls-entry},type=\meta{gls-type}\verb|}|
\end{newway}
The glossary entry information \meta{gls-entry} may also need
-changing. If \meta{gls-entry} contains any of \texttt{makeindex}'s
+changing. If \meta{gls-entry} contains any of \app{makeindex}'s
special characters (i.e.\ \texttt{@} \texttt{!} \verb|"| or
\verb"|") then they should no longer be escaped with \verb'"'
-since the \sty{glossaries} package deals with these characters
+since the \styfmt{glossaries} package deals with these characters
internally. For example, if your document contains the following:
\begin{verbatim}
\storeglosentry{card}{name={$"|\mathcal{S}"|$},
@@ -283,89 +261,93 @@ then you will need to replace it with:
description={The cardinality of the set $\mathcal{S}$}}
\end{verbatim}
-The \key{format} and \key{number} keys available in
-\cs{storeglosentry} are not available with \cs{newglossaryentry}.
+The \csopt{storeglosentry}{format} and
+\csopt{storeglosentry}{number} keys available in \ics{storeglosentry}
+are not available with \ics{newglossaryentry}.
\section{Adding an entry to the glossary}
-The \sty{glossary} package provided two basic means to add
+The \styfmt{glossary} package provided two basic means to add
information to the glossary: firstly, the term was defined
-using \cs{storeglosentry} and the entries for that term were
-added using \cs{useglosentry}, \cs{useGlosentry} and \cs{gls}.
-Secondly, the term was added to the glossary using \cs{glossary}.
-This second approach is unavailable with the \sty{glossaries}
+using \ics{storeglosentry} and the entries for that term were
+added using \ics{useglosentry}, \ics{useGlosentry} and \ics{gls}.
+Secondly, the term was added to the glossary using \ics{glossary}.
+This second approach is unavailable with the \styfmt{glossaries}
package.
-\subsection{\cs{useglosentry}}
+\subsection{\texorpdfstring{\cs{useglosentry}}{\textbackslash
+useglosentry}}
\label{sec:useglosentry}
-The \sty{glossary} package allows you to add information to the
-glossary for a predefined term without producing any text
-in the document using
+The \styfmt{glossary} package allows you to add information to the
+glossary for a predefined term without producing any text in the
+document using
\begin{oldway}
-\cs{useglosentry}\oarg{old options}\marg{label}
+\ics{useglosentry}\oarg{old options}\marg{label}
\end{oldway}%
Any occurrences of this command will need to be replaced with
\begin{newway}
-\cs{glsadd}\oarg{new options}\marg{label}
+\ics{glsadd}\oarg{new options}\marg{label}
\end{newway}%
-The \key{format} key in \meta{old options} remains the same
-in \meta{new options}. However the \texttt{number=}\meta{counter
-name} key in \meta{old options} should be replaced with
-\texttt{counter=}\meta{counter name} in \meta{new options}.
+The \csopt{useglosentry}{format} key in \meta{old options} remains
+the same in \meta{new options}. However the
+\csopt{useglosentry}{number}\texttt{=}\meta{counter name} key in
+\meta{old options} should be replaced with
+\csopt{glsadd}{counter}\texttt{=}\meta{counter name} in \meta{new
+options}.
-\subsection{\cs{useGlosentry}}
+\subsection{\texorpdfstring{\cs{useGlosentry}}{\textbackslash
+useGlosentry}}
-The \sty{glossary} package allows you to add information to the
+The \styfmt{glossary} package allows you to add information to the
glossary for a predefined term with the given text using
\begin{oldway}
-\cs{useGlosentry}\oarg{old options}\marg{label}\marg{text}
+\ics{useGlosentry}\oarg{old options}\marg{label}\marg{text}
\end{oldway}%
Any occurrences of this command will need to be replaced with
\begin{newway}
-\cs{glslink}\oarg{new options}\marg{label}\marg{text}
+\ics{glslink}\oarg{new options}\marg{label}\marg{text}
\end{newway}%
The mapping from \meta{old options} to \meta{new options} is
-the same as that given \latexhtml{in section~\ref{sec:useglosentry}
-above}{\htmlref{above}{sec:useglosentry}}.
+the same as that given \sectionref{sec:useglosentry}.
-\subsection{\cs{gls}}
+\subsection{\texorpdfstring{\cs{gls}}{\textbackslash gls}}
-Both the \sty{glossary} and the \sty{glossaries} packages define
-the command \cs{gls}. In this case, the only thing you need to
-change is the \key{number} key in the optional argument
-to \key{counter}. Note that the new form of \cs{gls} also takes
+Both the \styfmt{glossary} and the \styfmt{glossaries} packages define
+the command \ics{gls}. In this case, the only thing you need to
+change is the \csopt{gls}{number} key in the optional argument
+to \csopt{gls}{counter}. Note that the new form of \ics{gls} also takes
a final optional argument which can be used to insert text into the
automatically generated text.
-\subsection{\cs{glossary}}
+\subsection{\texorpdfstring{\cs{glossary}}{\textbackslash glossary}}
\label{sec:csglossary}
-When using the \sty{glossaries} package, you should not use
-\cs{glossary} directly.\footnote{This is because \cs{glossary}
+When using the \styfmt{glossaries} package, you should not use
+\ics{glossary} directly.\footnote{This is because \ics{glossary}
requires the argument to be in a specific format and doesn't use the
\meta{key}=\meta{value} format that the old glossary package used.
The new package's internal commands set this format, as well as
-escaping any of \texttt{makeindex}'s or \texttt{xindy}'s special
+escaping any of \app{makeindex}'s or \app{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 \texttt{makeindex} or
-\texttt{xindy}.} If, with the old package, you have opted to
-explicitly use \cs{glossary} instead of storing the glossary
-information with \cs{storeglosentry}, then converting from
-\sty{glossary} to \sty{glossaries} will be more time-consuming,
+allow the new package to be used with either \app{makeindex} or
+\app{xindy}.} If, with the old package, you have opted to
+explicitly use \ics{glossary} instead of storing the glossary
+information with \ics{storeglosentry}, then converting from
+\styfmt{glossary} to \styfmt{glossaries} will be more time-consuming,
although in the end, I hope you will see the benefits.\footnote{From
-the user's point of view, using \cs{glossary} throughout the
+the user's point of view, using \ics{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 \texttt{makeindex} to treat the two entries as different
+cause \app{makeindex} to treat the two entries as different
terms, even though they look the same in the document.} If you have
-used \cs{glossary} with the old glossary package, you will instead
+used \ics{glossary} with the old glossary package, you will instead
need to define the relevant glossary terms using
-\cs{newglossaryentry} and reference the terms using
-\cs{glsadd}, \cs{glslink}, \cs{gls} etc.
+\ics{newglossaryentry} and reference the terms using
+\ics{glsadd}, \ics{glslink}, \ics{gls} etc.
If you don't like the idea of continually scrolling back to the
-preamble to type all your \cs{newglossaryentry} commands, you may
+preamble to type all your \ics{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
@@ -373,17 +355,17 @@ you can tab back and forth between them.
\section{Acronyms}
-In the \sty{glossary} package, acronyms were treated differently
+In the \styfmt{glossary} package, acronyms were treated differently
to glossary entries. This resulted in inconsistencies and sprawling
-unmaintainable code. The new \sty{glossaries} package treats
+unmaintainable code. The new \styfmt{glossaries} package treats
acronyms in exactly the same way as normal glossary terms. In fact,
-in the \sty{glossaries} package, the default definition of:
+in the \styfmt{glossaries} package, the default definition of:
\begin{newway}
-\cs{newacronym}\oarg{options}\marg{label}\marg{abbrv}\marg{long}
+\ics{newacronym}\oarg{options}\marg{label}\marg{abbrv}\marg{long}
\end{newway}
is a shortcut for:
\begin{newway}
-\cs{newglossaryentry}\marg{label}\{type=\cs{acronymtype},
+\ics{newglossaryentry}\marg{label}\{type=\cs{acronymtype},
name=\marg{abbrv},
description=\marg{long},
text=\marg{abbrv},
@@ -393,19 +375,20 @@ firstplural=\{\meta{long}s (\meta{abbrv}s)\},
\meta{options}\}
\end{newway}
-This is different to the \sty{glossary} package which set the
-\key{name} key to \meta{long} (\meta{abbrv}) and allowed you
-to set a description using the \key{description} key. If you
-still want to do this, you can use the \pkgopt{description} package
-option, and use the \key{description} key in the
-optional argument of \cs{newacronym}.
+This is different to the \styfmt{glossary} package which set the
+\csopt{newglossaryentry}{name} key to \meta{long} (\meta{abbrv}) and
+allowed you to set a description using the
+\csopt{newglossaryentry}{description} key. If you still want to do
+this, you can use the \pkgopt{description} package option, and use
+the \csopt{newglossaryentry}{description} key in the optional
+argument of \ics{newacronym}.
For example, if your document originally had the following:
\begin{verbatim}
\newacronym{SVM}{Support Vector Machine}{description=Statistical
pattern recognition technique}
\end{verbatim}
-Then you would need to load the \sty{glossaries} package using the
+Then you would need to load the \styfmt{glossaries} package using the
\pkgopt{description} package option, for example:
\begin{verbatim}
\usepackage[description]{glossaries}
@@ -416,34 +399,34 @@ and change the acronym definition to:
technique]{svm}{SVM}{Support Vector Machine}
\end{verbatim}
You can then reference the acronym using any of the new referencing
-commands, such as \cs{gls} or \cs{glsadd}.
+commands, such as \ics{gls} or \ics{glsadd}.
-With the old \sty{glossary} package, when you defined an
+With the old \styfmt{glossary} package, when you defined an
acronym, it also defined a command \cs{}\meta{acr-name} which
could be used to display the acronym in the text. So the
above SVM example would create the command \cs{SVM} with the old
-package. In the new \sty{glossaries} package, the acronyms are just
+package. In the new \styfmt{glossaries} package, the acronyms are just
another type of glossary entry, so they are displayed using
-\cs{gls}\marg{label}. Therefore, in the above example, you will
+\ics{gls}\marg{label}. Therefore, in the above example, you will
also need to replace all occurrences of \cs{SVM} with
\verb|\gls{svm}|.
-If you have used \cs{useacronym} instead of \cs{}\meta{acr-name},
+If you have used \ics{useacronym} instead of \cs{}\meta{acr-name},
then you will need to replace all occurrences of
\begin{oldway}
-\cs{useacronym}\oarg{insert}\marg{acr-name}
+\ics{useacronym}\oarg{insert}\marg{acr-name}
\end{oldway}%
with
\begin{newway}
-\cs{gls}\marg{label}\oarg{insert}
+\ics{gls}\marg{label}\oarg{insert}
\end{newway}%
-Note that the starred versions of \cs{useacronym} and
+Note that the starred versions of \ics{useacronym} and
\cs{}\meta{acr-name} (which make the first letter uppercase) should
-be replaced with \cs{Gls}\marg{label}.
+be replaced with \ics{Gls}\marg{label}.
-Alternatively (as from v1.18 of the \sty{glossaries} package),
-you can use \cs{oldacronym} which uses the same syntax as
-the old \sty{glossary} package's \cs{newacronym} and also
+Alternatively (as from v1.18 of the \styfmt{glossaries} package),
+you can use \ics{oldacronym} which uses the same syntax as
+the old \styfmt{glossary} package's \ics{newacronym} and also
defines \cs{}\meta{acr-name}.
For example, if your document originally had the following:
\begin{oldway}
@@ -462,131 +445,142 @@ pattern recognition technique}
You can then continue to use \cs{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 \cs{}\meta{acr-name}, unless you also load the \sty{xspace}
-package. (See \latexhtml{section~\ref*{sec:acronyms}}{the
-\htmladdnormallink{Acronyms}{glossaries-manual.html#sec:acronyms}
-section} of the \sty{glossaries} documentation for further
-details.) Note that \cs{oldacronym} uses its first argument to
-define the acronym's label (as used by commands like \cs{gls}), so
-in the above example, with the new \sty{glossaries} package,
+after \cs{}\meta{acr-name}, unless you also load the \styfmt{xspace}
+package. (See
+\xrsectionref{sec:acronyms}{glossaries-manual}{Acronyms}
+%\latexhtml{section~\ref*{sec:acronyms}}{the
+%\htmladdnormallink{Acronyms}{glossaries-manual.html#sec:acronyms}
+%section}
+of the \styfmt{glossaries} documentation for further
+details.) Note that \ics{oldacronym} uses its first argument to
+define the acronym's label (as used by commands like \ics{gls}), so
+in the above example, with the new \styfmt{glossaries} package,
\cs{SVM} becomes a shortcut for \verb|\gls{SVM}| and \cs{SVM*}
becomes a shortcut for \verb|\Gls{SVM}|.
-\subsection{\cs{acrln} and \cs{acrsh}}
+\subsection{\texorpdfstring{\cs{acrln} and
+\cs{acrsh}}{\textbackslash acrln and \textbackslash acrsh}}
-In the \sty{glossary} package, it is possible to produce the
+In the \styfmt{glossary} package, it is possible to produce the
long and short forms of an acronym without adding an entry to
-the glossary using \cs{acrln} and \cs{acrsh}. With the
-\sty{glossaries} package (provided you defined the acronym using
-\cs{newacronym} or \cs{oldacronym} and provided you haven't redefined \cs{newacronym})
+the glossary using \ics{acrln} and \ics{acrsh}. With the
+\styfmt{glossaries} package (provided you defined the acronym using
+\ics{newacronym} or \ics{oldacronym} and provided you haven't
+redefined \ics{newacronym})
you can replace
\begin{oldway}
-\cs{acrsh}\marg{acr-name}
+\ics{acrsh}\marg{acr-name}
\end{oldway}%
with
\begin{newway}
-\cs{acrshort}\marg{label}
+\ics{acrshort}\marg{label}
\end{newway}%
and you can replace
\begin{oldway}
-\cs{acrln}\marg{acr-name}
+\ics{acrln}\marg{acr-name}
\end{oldway}%
with
\begin{newway}
-\cs{acrlong}\marg{label}
+\ics{acrlong}\marg{label}
\end{newway}%
-The \sty{glossaries} package also provides the related commands
-\cs{acrshortpl} (plural short form) and \cs{acrlongpl} (plural long
+The \styfmt{glossaries} package also provides the related commands
+\ics{acrshortpl} (plural short form) and \ics{acrlongpl} (plural long
form) as well as upper case variations. If you use the
-\sty{glossaries} \dq{shortcuts} package option, you can use
-\cs{acs} in place of \cs{acrshort} and \cs{acl} in place of
-\cs{acrlong}.
-
-See \latexhtml{section~\ref*{sec:acronyms}}{the
-\htmladdnormallink{Acronyms}{glossaries-manual.html#sec:acronyms}
-section} of the \sty{glossaries} manual for further details of
+\styfmt{glossaries} \qt{shortcuts} package option, you can use
+\ics{acs} in place of \ics{acrshort} and \ics{acl} in place of
+\ics{acrlong}.
+
+See
+\xrsectionref{sec:acronyms}{glossaries-manual}{Acronyms}
+%\latexhtml{section~\ref*{sec:acronyms}}{the
+%\htmladdnormallink{Acronyms}{glossaries-manual.html#sec:acronyms}
+%section}
+of the \styfmt{glossaries} manual for further details of
how to use these commands.
-\subsection{\cs{ifacronymfirstuse}}
+\subsection{\texorpdfstring{\cs{ifacronymfirstuse}}{\textbackslash
+ifacronymfirstuse}}
-The \sty{glossary} package command
+The \styfmt{glossary} package command
\begin{oldway}
-\cs{ifacronymfirstuse}\marg{acr-name}\marg{text1}\marg{text2}
+\ics{ifacronymfirstuse}\marg{acr-name}\marg{text1}\marg{text2}
\end{oldway}%
-can be replaced by the \sty{glossaries} command:
+can be replaced by the \styfmt{glossaries} command:
\begin{newway}
-\cs{ifglsused}\marg{label}\marg{text2}\marg{text1}
+\ics{ifglsused}\marg{label}\marg{text2}\marg{text1}
\end{newway}%
-Note that \cs{ifglsused} evaluates the opposite condition to
-that of \cs{ifacronymfirstuse} which is why the last two arguments
+Note that \ics{ifglsused} evaluates the opposite condition to
+that of \ics{ifacronymfirstuse} which is why the last two arguments
have been reversed.
-\subsection{\cs{resetacronym} and \cs{unsetacronym}}
+\subsection{\texorpdfstring{\cs{resetacronym} and
+\cs{unsetacronym}}{\textbackslash resetacronym and \textbackslash
+unsetacronym}}
-The \sty{glossary} package allows you to reset and unset the
+The \styfmt{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 \sty{glossaries} package also
+been used in the document. The \styfmt{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:
\begin{oldway}
-\cs{resetacronym}\marg{acr-name}
+\ics{resetacronym}\marg{acr-name}
\end{oldway}%
with either
\begin{newway}
-\cs{glsreset}\marg{label}
+\ics{glsreset}\marg{label}
\end{newway}%
or
\begin{newway}
-\cs{glslocalreset}\marg{label}
+\ics{glslocalreset}\marg{label}
\end{newway}
To unset an acronym, you will need to replace:
\begin{oldway}
-\cs{unsetacronym}\marg{acr-name}
+\ics{unsetacronym}\marg{acr-name}
\end{oldway}%
with either
\begin{newway}
-\cs{glsunset}\marg{label}
+\ics{glsunset}\marg{label}
\end{newway}%
or
\begin{newway}
-\cs{glslocalunset}\marg{label}
+\ics{glslocalunset}\marg{label}
\end{newway}
To reset all acronyms, you will need to replace:
\begin{oldway}
-\cs{resetallacronyms}
+\ics{resetallacronyms}
\end{oldway}
with
\begin{newway}
-\cs{glsresetall}[\cs{acronymtype}]
+\ics{glsresetall}[\ics{acronymtype}]
\end{newway}
or
\begin{newway}
-\cs{glslocalresetall}[\cs{acronymtype}]
+\ics{glslocalresetall}[\ics{acronymtype}]
\end{newway}
To unset all acronyms, you will need to replace:
\begin{oldway}
-\cs{unsetallacronyms}
+\ics{unsetallacronyms}
\end{oldway}
with
\begin{newway}
-\cs{glsunsetall}[\cs{acronymtype}]
+\ics{glsunsetall}[\ics{acronymtype}]
\end{newway}
or
\begin{newway}
-\cs{glslocalunsetall}[\cs{acronymtype}]
+\ics{glslocalunsetall}[\ics{acronymtype}]
\end{newway}
\section{Displaying the glossary}
-The \sty{glossary} package provides the command \cs{printglossary}
+The \styfmt{glossary} package provides the command \ics{printglossary}
(or \cs{print}\meta{type} for other glossary types) which
-can be used to print individual glossaries. The \sty{glossaries}
-package provides the command \cs{printglossaries} which
+can be used to print individual glossaries. The \styfmt{glossaries}
+package provides the command \ics{printglossaries} which
will print all the glossaries which have been defined, or
-\cs{printglossary}\oarg{options} to print individual glossaries.
-So if you just have \cs{printglossary}, then you can leave it as
+\ics{printglossary}\oarg{options} to print individual glossaries.
+So if you just have \ics{printglossary}, then you can leave it as
it is, but if you have, say:
\begin{verbatim}
\printglossary
@@ -607,51 +601,55 @@ or
\printglossary[type=\acronymtype]
\end{verbatim}
-The \sty{glossary} package allows you to specify a short title
-(for the table of contents and page header) by defining a command
-of the form \cs{short}\meta{glossary-type}\texttt{name}. The
-\sty{glossaries} package doesn't do this, but instead provides
-the \key{toctitle} key which can be used in the optional
-argument to \cs{printglossary}. For example, if you have created
-a new glossary type called \texttt{notation}, and you had
+The \styfmt{glossary} package allows you to specify a short title
+(for the table of contents and page header) by defining a command of
+the form \cs{short}\meta{glossary-type}\texttt{name}. The
+\styfmt{glossaries} package doesn't do this, but instead provides
+the \csopt{printglossary}{toctitle} key which can be used in the
+optional argument to \ics{printglossary}. For example, if you have
+created a new glossary type called \texttt{notation}, and you had
defined
\begin{verbatim}
\newcommand{\shortnotationname}{Notation}
\end{verbatim}
-then you would need to use the \key{toctitle} key:
+then you would need to use the \csopt{printglossary}{toctitle} key:
\begin{verbatim}
\printglossary[type=notation,toctitle=Notation]
\end{verbatim}
-The \sty{glossaries} package will ignore \cs{shortnotationname},
-so unless you have used it elsewhere in the document, you may
-as well remove the definition.
+The \styfmt{glossaries} package will ignore \ics{shortnotationname},
+so unless you have used it elsewhere in the document, you may as
+well remove the definition.
\section{Processing Your Document}
-If you convert your document from using the \sty{glossary} package
-to the \sty{glossaries} package, you will need to delete any of
-the additional files, such as the \texttt{.glo} file, that were
-created by the \sty{glossary} package, as the \sty{glossaries}
+If you convert your document from using the \styfmt{glossary} package
+to the \styfmt{glossaries} package, you will need to delete any of
+the additional files, such as the \filetype{.glo} file, that were
+created by the \styfmt{glossary} package, as the \styfmt{glossaries}
package uses a different format.
-Remember also, that if you used the \texttt{makeglos} Perl script,
-you will need to use the \texttt{makeglossaries} Perl script
-instead. As from v1.17, the \sty{glossaries} package can be
-used with either \texttt{makeindex} or \texttt{xindy}. Since
-\texttt{xindy} was designed to be multilingual, the
-new \sty{glossaries} package is a much better option for
+Remember also, that if you used the \app{makeglos} Perl script,
+you will need to use the \app{makeglossaries} Perl script
+instead. As from v1.17, the \styfmt{glossaries} package can be
+used with either \app{makeindex} or \app{xindy}. Since
+\app{xindy} was designed to be multilingual, the
+new \styfmt{glossaries} package is a much better option for
non-English documents.
-For further information on using \texttt{makeglossaries},
-\texttt{makeindex} or \texttt{xindy} to create your glossaries, see
-\latexhtml{section~\ref*{sec:makeglossaries}}{the
-\htmladdnormallink{Generating the Associated Glossary
-Files}{glossaries-manual.html#sec:makeglossaries} section} of the
-\sty{glossaries} documentation.
+For further information on using \app{makeglossaries},
+\app{makeindex} or \app{xindy} to create your glossaries, see
+\xrsectionref{sec:makeglossaries}{glossaries-manual}{Generating the
+Associated Glossary Files}
+%\latexhtml{section~\ref*{sec:makeglossaries}}{the
+%\htmladdnormallink{Generating the Associated Glossary
+%Files}{glossaries-manual.html#sec:makeglossaries} section}
+of the \styfmt{glossaries} documentation.
\section{Troubleshooting}
-Please check the \htmladdnormallinkfoot{FAQ}{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}
-for the \sty{glossaries} package if you have any
+Please check the \urlfootref{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}{FAQ}
+for the \styfmt{glossaries} package if you have any
problems.
+\PrintIndex
+
\end{document}