summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html477
1 files changed, 317 insertions, 160 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html
index 77571dcf832..754eec11a3a 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html
+++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html
@@ -26,7 +26,7 @@ package">
<H1 ALIGN="CENTER">Upgrading from the glossary package to the glossaries
package</H1>
<P ALIGN="CENTER"><STRONG>Nicola L.C. Talbot</STRONG></P>
-<P ALIGN="CENTER"><STRONG>17th June 2008</STRONG></P>
+<P ALIGN="CENTER"><STRONG>14th January 2009</STRONG></P>
<BR>
<H2><A NAME="SECTION00010000000000000000">
@@ -35,44 +35,46 @@ Contents</A>
<!--Table of Contents-->
<UL>
-<LI><A NAME="tex2html23"
- HREF="glossary2glossaries.html#SECTION00020000000000000000">1 Package Options</A>
-<LI><A NAME="tex2html24"
- HREF="glossary2glossaries.html#SECTION00030000000000000000">2 Defining new glossary types</A>
-<LI><A NAME="tex2html25"
- HREF="glossary2glossaries.html#SECTION00040000000000000000">3 &#92;make&lt;glossary name&gt;</A>
-<LI><A NAME="tex2html26"
- HREF="glossary2glossaries.html#SECTION00050000000000000000">4 Storing glossary information</A>
-<LI><A NAME="tex2html27"
- HREF="glossary2glossaries.html#SECTION00060000000000000000">5 Adding an entry to the glossary</A>
-<UL>
-<LI><A NAME="tex2html28"
- HREF="glossary2glossaries.html#SECTION00061000000000000000">5.1 &#92;useglosentry</A>
<LI><A NAME="tex2html29"
- HREF="glossary2glossaries.html#SECTION00062000000000000000">5.2 &#92;useGlosentry</A>
+ HREF="glossary2glossaries.html#SECTION00020000000000000000">1 Why the Need for a New Package?</A>
<LI><A NAME="tex2html30"
- HREF="glossary2glossaries.html#SECTION00063000000000000000">5.3 &#92;gls</A>
+ HREF="glossary2glossaries.html#SECTION00030000000000000000">2 Package Options</A>
<LI><A NAME="tex2html31"
- HREF="glossary2glossaries.html#SECTION00064000000000000000">5.4 &#92;glossary</A>
-</UL>
-<BR>
+ HREF="glossary2glossaries.html#SECTION00040000000000000000">3 Defining new glossary types</A>
<LI><A NAME="tex2html32"
- HREF="glossary2glossaries.html#SECTION00070000000000000000">6 Acronyms</A>
-<UL>
+ HREF="glossary2glossaries.html#SECTION00050000000000000000">4 &#92;make&lt;glossary name&gt;</A>
<LI><A NAME="tex2html33"
- HREF="glossary2glossaries.html#SECTION00071000000000000000">6.1 &#92;acrln and &#92;acrsh</A>
+ HREF="glossary2glossaries.html#SECTION00060000000000000000">5 Storing glossary information</A>
<LI><A NAME="tex2html34"
- HREF="glossary2glossaries.html#SECTION00072000000000000000">6.2 &#92;ifacronymfirstuse</A>
+ HREF="glossary2glossaries.html#SECTION00070000000000000000">6 Adding an entry to the glossary</A>
+<UL>
<LI><A NAME="tex2html35"
- HREF="glossary2glossaries.html#SECTION00073000000000000000">6.3 &#92;resetacronym and &#92;unsetacronym</A>
-</UL>
-<BR>
+ HREF="glossary2glossaries.html#SECTION00071000000000000000">6.1 &#92;useglosentry</A>
<LI><A NAME="tex2html36"
- HREF="glossary2glossaries.html#SECTION00080000000000000000">7 Displaying the glossary</A>
+ HREF="glossary2glossaries.html#SECTION00072000000000000000">6.2 &#92;useGlosentry</A>
<LI><A NAME="tex2html37"
- HREF="glossary2glossaries.html#SECTION00090000000000000000">8 Using makeindex</A>
+ HREF="glossary2glossaries.html#SECTION00073000000000000000">6.3 &#92;gls</A>
<LI><A NAME="tex2html38"
- HREF="glossary2glossaries.html#SECTION000100000000000000000">9 Troubleshooting</A>
+ HREF="glossary2glossaries.html#SECTION00074000000000000000">6.4 &#92;glossary</A>
+</UL>
+<BR>
+<LI><A NAME="tex2html39"
+ HREF="glossary2glossaries.html#SECTION00080000000000000000">7 Acronyms</A>
+<UL>
+<LI><A NAME="tex2html40"
+ HREF="glossary2glossaries.html#SECTION00081000000000000000">7.1 &#92;acrln and &#92;acrsh</A>
+<LI><A NAME="tex2html41"
+ HREF="glossary2glossaries.html#SECTION00082000000000000000">7.2 &#92;ifacronymfirstuse</A>
+<LI><A NAME="tex2html42"
+ HREF="glossary2glossaries.html#SECTION00083000000000000000">7.3 &#92;resetacronym and &#92;unsetacronym</A>
+</UL>
+<BR>
+<LI><A NAME="tex2html43"
+ HREF="glossary2glossaries.html#SECTION00090000000000000000">8 Displaying the glossary</A>
+<LI><A NAME="tex2html44"
+ HREF="glossary2glossaries.html#SECTION000100000000000000000">9 Processing Your Document</A>
+<LI><A NAME="tex2html45"
+ HREF="glossary2glossaries.html#SECTION000110000000000000000">10 Troubleshooting</A>
</UL>
<!--End of Table of Contents-->
<P>
@@ -87,8 +89,92 @@ to convert a LaTeX document from using the obsolete
<P>
-<H1><A NAME="SECTION00020000000000000000">
-1 Package Options</A>
+<H1><A NAME="SECTION00020000000000000000"></A>
+<A NAME="whyglossaries"></A>
+<BR>
+1 Why the Need for a New Package?
+</H1>
+
+<P>
+The <TT>glossary</TT> 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 <TT>glossaries</TT> package:
+
+<P>
+
+<UL>
+<LI>you can define irregular plurals;
+
+<P>
+</LI>
+<LI>glossary terms can have an associated symbol in addition
+to the name and description;
+
+<P>
+</LI>
+<LI>new glossary styles are much easier to design;
+
+<P>
+</LI>
+<LI>you can add dictionaries to supply translations for the
+fixed names used in headings and by some of the glossary styles;
+
+<P>
+</LI>
+<LI>you can choose<A NAME="tex2html1"
+ HREF="#foot582"><SUP>1</SUP></A> between using
+<TT>makeindex</TT> or <TT>xindy</TT> to sort the glossary. Using
+<TT>xindy</TT> means that:
+
+<P>
+
+<UL>
+<LI>there is much better support for terms containing accented
+ or non-Latin characters;
+
+<P>
+</LI>
+<LI>there is support for non-standard location numbers;
+
+</LI>
+</UL>
+
+<P>
+</LI>
+<LI>you don't need to remember to escape <TT>makeindex</TT>'s
+special characters as this is done internally;
+
+<P>
+</LI>
+<LI>hierarchical entries and homographs are supported;<A NAME="tex2html2"
+ HREF="#foot88"><SUP>2</SUP></A>
+<P>
+</LI>
+<LI>there is better support for cross-referencing glossary entries;
+
+<P>
+</LI>
+<LI>acronyms are just another glossary term which helps to
+maintain consistency;
+
+<P>
+</LI>
+<LI>different acronym styles are supported.
+
+<P>
+</LI>
+</UL>
+
+<P>
+
+<H1><A NAME="SECTION00030000000000000000">
+2 Package Options</A>
</H1>
<P>
@@ -107,7 +193,7 @@ to the <TT>glossaries</TT> package options.
<A NAME="tab:pkgopt"></A>
<DIV ALIGN="CENTER">
-<A NAME="502"></A>
+<A NAME="583"></A>
<TABLE CELLPADDING=3>
<CAPTION><STRONG>Table 1:</STRONG>
Mappings from <TT>glossary</TT> to <TT>glossaries</TT>
@@ -203,8 +289,8 @@ package options</CAPTION>
<P>
-<H1><A NAME="SECTION00030000000000000000">
-2 Defining new glossary types</A>
+<H1><A NAME="SECTION00040000000000000000">
+3 Defining new glossary types</A>
</H1>
<P>
@@ -212,7 +298,7 @@ If you have created new glossary types, you will need to
replace all instances of
<P>
-<TT><TT>&#92;newglossarytype[&lt;<I>log-ext</I>&gt;]&#123;&lt;<I>type</I>&gt;&#125;&#123;&lt;<I>out-ext</I>&gt;&#125;&#123;&lt;<I>in-ext</I>&gt;&#125;[&lt;<I>style list</I>&gt;]</TT>
+<TT><TT>&#92;newglossarytype[&lt;<I>log-ext</I>&gt;]&#123;&lt;<I>type</I>&gt;&#125;&#123;&lt;<I>out-ext</I>&gt;&#125;&#123;&lt;<I>in-ext</I>&gt;&#125;[&lt;<I>old style list</I>&gt;]</TT>
<BR>
<TT>&#92;newcommand</TT><code>{\</code>&lt;<I>type</I>&gt;name<code>}</code><TT>&#123;&lt;<I>title</I>&gt;&#125;</TT></TT>
<P>
@@ -221,17 +307,18 @@ with
<P>
<TT><TT>&#92;newglossary[&lt;<I>log-ext</I>&gt;]&#123;&lt;<I>type</I>&gt;&#125;&#123;&lt;<I>out-ext</I>&gt;&#125;&#123;&lt;<I>in-ext</I>&gt;&#125;&#123;&lt;<I>title</I>&gt;&#125;</TT></TT>
<P>
-in the preamble, and
+in the preamble, and, if the new glossary requires a different style
+to the main (default) glossary, you will also need to put
<P>
<TT><TT>&#92;glossarystyle&#123;&lt;<I>new style</I>&gt;&#125;</TT></TT>
<P>
-immediately before <code>\printglossary[type=</code>&lt;<I>type</I>&gt;<code>]</code>,
-if the new glossary requires a different style to the main (default)
-glossary.
+immediately before the glossary is displayed, or you can specify
+the style when you display the glossary using <TT>&#92;printglossary</TT>
+(see below).
<P>
-The &lt;<I>style list</I>&gt; optional argument can be converted to
+The &lt;<I>old style list</I>&gt; optional argument can be converted to
&lt;<I>new style</I>&gt; using the same mapping given in
Table&nbsp;<A HREF="glossary2glossaries.html#tab:pkgopt">1</A>.
@@ -245,13 +332,11 @@ You will need to replace the above two lines with:
<PRE>
\newglossary[nlg]{notation}{not}{ntn}{Index of Notation}
</PRE>
-in the preamble, and
+in the preamble and
<PRE>
\glossarystyle{longheader}
</PRE>
-immediately prior to displaying this glossary new type.
-
-<P>
+immediately prior to displaying this glossary.
Alternatively, you can specify the style using the <TT>style</TT>
key in the optional argument of <TT>&#92;printglossary</TT>. For example:
<PRE>
@@ -270,8 +355,8 @@ using the <TT>toctitle</TT> key in the optional argument to
<P>
-<H1><A NAME="SECTION00040000000000000000">
-3 <TT>&#92;make</TT>&lt;<I>glossary name</I>&gt;</A>
+<H1><A NAME="SECTION00050000000000000000">
+4 <TT>&#92;make</TT>&lt;<I>glossary name</I>&gt;</A>
</H1>
<P>
@@ -290,8 +375,8 @@ then you should replace both lines with the single line:
<P>
-<H1><A NAME="SECTION00050000000000000000">
-4 Storing glossary information</A>
+<H1><A NAME="SECTION00060000000000000000">
+5 Storing glossary information</A>
</H1>
<P>
@@ -299,15 +384,16 @@ With the old <TT>glossary</TT> package you could optionally store
glossary information for later use, or you could simply use
<TT>&#92;glossary</TT> whenever you wanted to add information to the glossary.
With the new <TT>glossaries</TT> package, the latter option is no longer
-available.<A NAME="tex2html2"
- HREF="#foot504"><SUP>1</SUP></A> If
+available.<A NAME="tex2html4"
+ HREF="#foot585"><SUP>3</SUP></A> If
you have stored all the glossary information using
<TT>&#92;storeglosentry</TT>, then you will need to convert these commands
-into the equivalent <TT>&#92;newglossaryentry</TT>. If you haven't used
-<TT>&#92;storeglosentry</TT>, then you'll have a bit more work to do!
+into the equivalent <TT>&#92;newglossaryentry</TT>. If you have only
+used <TT>&#92;glossary</TT>, then see
+<A HREF="glossary2glossaries.html#sec:csglossary">later</A>.
<P>
-The former approach requires substituting all instances of
+Substitute all instances of
<P>
<TT><TT>&#92;storeglosentry&#123;&lt;<I>label</I>&gt;&#125;&#123;&lt;<I>gls-entry</I>&gt;&#125;</TT></TT>
@@ -357,8 +443,8 @@ The <TT>format</TT> and <TT>number</TT> keys available in
<P>
-<H1><A NAME="SECTION00060000000000000000">
-5 Adding an entry to the glossary</A>
+<H1><A NAME="SECTION00070000000000000000">
+6 Adding an entry to the glossary</A>
</H1>
<P>
@@ -372,10 +458,10 @@ package.
<P>
-<H2><A NAME="SECTION00061000000000000000"></A>
+<H2><A NAME="SECTION00071000000000000000"></A>
<A NAME="sec:useglosentry"></A>
<BR>
-5.1 <TT>&#92;useglosentry</TT>
+6.1 <TT>&#92;useglosentry</TT>
</H2>
<P>
@@ -392,14 +478,14 @@ Any occurrences of this command will need to be replaced with
<TT><TT>&#92;glsadd[&lt;<I>new options</I>&gt;]&#123;&lt;<I>label</I>&gt;&#125;</TT></TT>
<P>
The <TT>format</TT> key in &lt;<I>old options</I>&gt; remains the same
-in &lt;<I>new options</I>&gt;, the <TT>number=</TT>&lt;<I>counter name</I>&gt;
-key in &lt;<I>old options</I>&gt; should be replaced with
-<BR><TT>counter=</TT>&lt;<I>counter name</I>&gt; in &lt;<I>new options</I>&gt;.
+in &lt;<I>new options</I>&gt;. However the <TT>number=</TT>&lt;<I>counter
+name</I>&gt; key in &lt;<I>old options</I>&gt; should be replaced with
+<TT>counter=</TT>&lt;<I>counter name</I>&gt; in &lt;<I>new options</I>&gt;.
<P>
-<H2><A NAME="SECTION00062000000000000000">
-5.2 <TT>&#92;useGlosentry</TT></A>
+<H2><A NAME="SECTION00072000000000000000">
+6.2 <TT>&#92;useGlosentry</TT></A>
</H2>
<P>
@@ -409,7 +495,7 @@ glossary for a predefined term with the given text using
<P>
<TT><TT>&#92;useGlosentry[&lt;<I>old options</I>&gt;]&#123;&lt;<I>label</I>&gt;&#125;&#123;&lt;<I>text</I>&gt;&#125;</TT></TT>
<P>
-Any occurrences if this command will need to be replaced with
+Any occurrences of this command will need to be replaced with
<P>
<TT><TT>&#92;glslink[&lt;<I>new options</I>&gt;]&#123;&lt;<I>label</I>&gt;&#125;&#123;&lt;<I>text</I>&gt;&#125;</TT></TT>
@@ -419,8 +505,8 @@ the same as that given <A HREF="glossary2glossaries.html#sec:useglosentry">above
<P>
-<H2><A NAME="SECTION00063000000000000000">
-5.3 <TT>&#92;gls</TT></A>
+<H2><A NAME="SECTION00073000000000000000">
+6.3 <TT>&#92;gls</TT></A>
</H2>
<P>
@@ -433,24 +519,25 @@ automatically generated text.
<P>
-<H2><A NAME="SECTION00064000000000000000">
-5.4 <TT>&#92;glossary</TT></A>
+<H2><A NAME="SECTION00074000000000000000"></A>
+<A NAME="sec:csglossary"></A>
+<BR>
+6.4 <TT>&#92;glossary</TT>
</H2>
<P>
When using the <TT>glossaries</TT> package, you should not use
-<TT>&#92;glossary</TT> directly.<A NAME="tex2html3"
- HREF="#foot511"><SUP>2</SUP></A> If, with the old
-package, you have opted to explicitly use <TT>&#92;glossary</TT> instead of
-storing the glossary information with <TT>&#92;storeglosentry</TT>, then
-converting from <TT>glossary</TT> to <TT>glossaries</TT> will be more
-time-consuming, although in the end, I hope you will see the
-benefits!<A NAME="tex2html4"
- HREF="#foot512"><SUP>3</SUP></A> If
-you have used <TT>&#92;glossary</TT> with the old glossary package, you will
-instead need to define the relevant glossary terms using
-<TT>&#92;newglossaryentry</TT> and reference the terms using <TT>&#92;glslink</TT>,
-<TT>&#92;gls</TT> (or <TT>&#92;glspl</TT> etc).
+<TT>&#92;glossary</TT> directly.<A NAME="tex2html5"
+ HREF="#foot594"><SUP>4</SUP></A> If, with the old package, you have opted to
+explicitly use <TT>&#92;glossary</TT> instead of storing the glossary
+information with <TT>&#92;storeglosentry</TT>, then converting from
+<TT>glossary</TT> to <TT>glossaries</TT> will be more time-consuming,
+although in the end, I hope you will see the benefits.<A NAME="tex2html6"
+ HREF="#foot595"><SUP>5</SUP></A> If you have
+used <TT>&#92;glossary</TT> with the old glossary package, you will instead
+need to define the relevant glossary terms using
+<TT>&#92;newglossaryentry</TT> and reference the terms using
+<TT>&#92;glsadd</TT>, <TT>&#92;glslink</TT>, <TT>&#92;gls</TT> etc.
<P>
If you don't like the idea of continually scrolling back to the
@@ -462,8 +549,8 @@ you can tab back and forth between them.
<P>
-<H1><A NAME="SECTION00070000000000000000">
-6 Acronyms</A>
+<H1><A NAME="SECTION00080000000000000000">
+7 Acronyms</A>
</H1>
<P>
@@ -513,44 +600,19 @@ and change the acronym definition to:
\newacronym[description=Statistical pattern recognition
technique]{svm}{SVM}{Support Vector Machine}
</PRE>
-You will also need to replace all occurrences of <TT>&#92;SVM</TT> with
-<code>\gls{svm}</code>. Alternatively, you can define <TT>&#92;SVM</TT>:
-<PRE>
-\newcommand{\SVM}{\gls{svm}}
-</PRE>
-Remember that generally LaTeX ignores all spaces following command
-names that consist of a backslash followed by letters! For example,
-using the above definition of <TT>&#92;SVM</TT>, the following will ignore
-the space after <TT>&#92;SVM</TT>:
-<PRE>
-The \SVM is a statistical pattern recognition technique.
-</PRE>
-Instead, you need to explicitly insert a space:
-<PRE>
-The \SVM\ is a statistical pattern recognition technique.
-</PRE>
-However, <code>\SVM['s]</code> is equivalent to <code>\gls{svm}['s]</code>,
-so you can do, for example:
-<PRE>
-The \SVM['s] parameters are obtained via optimisation techniques.
-</PRE>
+You can then reference the acronym using any of the new referencing
+commands, such as <TT>&#92;gls</TT> or <TT>&#92;glsadd</TT>.
<P>
-The <TT>xspace</TT> package provides the command <TT>&#92;xspace</TT> which can
-be used to insert a space after the command name if required. Some
-people prefer to use this at the end of the command definition so
-that they don't need to remember to insert an explicit space.
-For example, if we use the <TT>xspace</TT> package, we could define
-<TT>&#92;SVM</TT> as follows:
-<PRE>
-\newcommand{\SVM}{\gls{svm}\xspace}
-</PRE>
-so now the following will have a space before the word "is":
-<PRE>
-The \SVM is a statistical pattern recognition technique.
-</PRE>
-However, you can no longer do <code>\SVM['s]</code>, as the <TT>&#92;xspace</TT> is
-now in the way.
+With the old <TT>glossary</TT> package, when you defined an
+acronym, it also defined a command <TT>&#92;</TT>&lt;<I>acr-name</I>&gt; which
+could be used to display the acronym in the text. So the
+above SVM example would create the command <TT>&#92;SVM</TT> with the old
+package. In the new <TT>glossaries</TT> package, the acronyms are just
+another type of glossary entry, so they are displayed using
+<TT>&#92;gls&#123;&lt;<I>label</I>&gt;&#125;</TT>. Therefore, in the above example, you will
+also need to replace all occurrences of <TT>&#92;SVM</TT> with
+<code>\gls{svm}</code>.
<P>
If you have used <TT>&#92;useacronym</TT> instead of <TT>&#92;</TT>&lt;<I>acr-name</I>&gt;,
@@ -569,9 +631,42 @@ Note that the starred versions of <TT>&#92;useacronym</TT> and
be replaced with <TT>&#92;Gls&#123;&lt;<I>label</I>&gt;&#125;</TT>.
<P>
+Alternatively (as from v1.18 of the <TT>glossaries</TT> package),
+you can use <TT>&#92;oldacronym</TT> which uses the same syntax as
+the old <TT>glossary</TT> package's <TT>&#92;newacronym</TT> and also
+defines <TT>&#92;</TT>&lt;<I>acr-name</I>&gt;.
+For example, if your document originally had the following:
-<H2><A NAME="SECTION00071000000000000000">
-6.1 <TT>&#92;acrln</TT> and <TT>&#92;acrsh</TT></A>
+<P><PRE>
+\newacronym{SVM}{Support Vector Machine}{description=Statistical
+pattern recognition technique}
+</PRE>
+<P>
+then you can change this to:
+
+<P><PRE>
+\oldacronym{SVM}{Support Vector Machine}{description=Statistical
+pattern recognition technique}
+</PRE>
+<P>
+You can then continue to use <TT>&#92;SVM</TT>. However, remember that
+LaTeX generally ignores spaces after command names that consist of
+alphabetical characters. You will therefore need to force a space
+after <TT>&#92;</TT>&lt;<I>acr-name</I>&gt;, unless you also load the <TT>xspace</TT>
+package. (See the
+<A NAME="tex2html7"
+ HREF="glossaries-manual.html#sec:acronyms">Acronyms</A>
+section of the <TT>glossaries</TT> documentation for further
+details.) Note that <TT>&#92;oldacronym</TT> uses its first argument to
+define the acronym's label (as used by commands like <TT>&#92;gls</TT>), so
+in the above example, with the new <TT>glossaries</TT> package,
+<TT>&#92;SVM</TT> becomes a shortcut for <code>\gls{SVM}</code> and <TT>&#92;SVM*</TT>
+becomes a shortcut for <code>\Gls{SVM}</code>.
+
+<P>
+
+<H2><A NAME="SECTION00081000000000000000">
+7.1 <TT>&#92;acrln</TT> and <TT>&#92;acrsh</TT></A>
</H2>
<P>
@@ -579,7 +674,7 @@ In the <TT>glossary</TT> package, it is possible to produce the
long and short forms of an acronym without adding an entry to
the glossary using <TT>&#92;acrln</TT> and <TT>&#92;acrsh</TT>. With the
<TT>glossaries</TT> package (provided you defined the acronym using
-<TT>&#92;newacronym</TT> and provided you haven't redefined <TT>&#92;newacronym</TT>)
+<TT>&#92;newacronym</TT> or <TT>&#92;oldacronym</TT> and provided you haven't redefined <TT>&#92;newacronym</TT>)
you can replace
<P>
@@ -602,18 +697,22 @@ with
<P>
The <TT>glossaries</TT> package also provides the related commands
<TT>&#92;acrshortpl</TT> (plural short form) and <TT>&#92;acrlongpl</TT> (plural long
-form) as well as upper case variations.
+form) as well as upper case variations. If you use the
+<TT>glossaries</TT> "shortcuts" package option, you can use
+<TT>&#92;acs</TT> in place of <TT>&#92;acrshort</TT> and <TT>&#92;acl</TT> in place of
+<TT>&#92;acrlong</TT>.
<P>
-See
-the section "Using
-glossary entries in the text" of the <TT>glossaries</TT>
-manual for further details of how to use these commands.
+See the
+<A NAME="tex2html8"
+ HREF="glossaries-manual.html#sec:acronyms">Acronyms</A>
+section of the <TT>glossaries</TT> manual for further details of
+how to use these commands.
<P>
-<H2><A NAME="SECTION00072000000000000000">
-6.2 <TT>&#92;ifacronymfirstuse</TT></A>
+<H2><A NAME="SECTION00082000000000000000">
+7.2 <TT>&#92;ifacronymfirstuse</TT></A>
</H2>
<P>
@@ -633,15 +732,15 @@ have been reversed.
<P>
-<H2><A NAME="SECTION00073000000000000000">
-6.3 <TT>&#92;resetacronym</TT> and <TT>&#92;unsetacronym</TT></A>
+<H2><A NAME="SECTION00083000000000000000">
+7.3 <TT>&#92;resetacronym</TT> and <TT>&#92;unsetacronym</TT></A>
</H2>
<P>
The <TT>glossary</TT> 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 <TT>glossaries</TT> package also
-provides a means to do this on either a local or global level.
+provides a means to do this on either a local or a global level.
To reset an acronym, you will need to replace:
<P>
@@ -676,9 +775,41 @@ or
<P>
<P>
+To reset all acronyms, you will need to replace:
-<H1><A NAME="SECTION00080000000000000000">
-7 Displaying the glossary</A>
+<P>
+<TT><TT>&#92;resetallacronyms</TT></TT>
+<P>
+with
+
+<P>
+<TT><TT>&#92;glsresetall</TT>[<TT>&#92;acronymtype</TT>]</TT>
+<P>
+or
+
+<P>
+<TT><TT>&#92;glslocalresetall</TT>[<TT>&#92;acronymtype</TT>]</TT>
+<P>
+To unset all acronyms, you will need to replace:
+
+<P>
+<TT><TT>&#92;unsetallacronyms</TT></TT>
+<P>
+with
+
+<P>
+<TT><TT>&#92;glsunsetall</TT>[<TT>&#92;acronymtype</TT>]</TT>
+<P>
+or
+
+<P>
+<TT><TT>&#92;glslocalunsetall</TT>[<TT>&#92;acronymtype</TT>]</TT>
+<P>
+
+<P>
+
+<H1><A NAME="SECTION00090000000000000000">
+8 Displaying the glossary</A>
</H1>
<P>
@@ -699,7 +830,7 @@ or
\printglossary
\printacronym
</PRE>
-then you will need to either replace this with either
+then you will need to replace this with either
<PRE>
\printglossaries
</PRE>
@@ -731,8 +862,8 @@ as well remove the definition.
<P>
-<H1><A NAME="SECTION00090000000000000000">
-8 Using makeindex</A>
+<H1><A NAME="SECTION000100000000000000000">
+9 Processing Your Document</A>
</H1>
<P>
@@ -740,19 +871,33 @@ If you convert your document from using the <TT>glossary</TT> package
to the <TT>glossaries</TT> package, you will need to delete any of
the additional files, such as the <TT>.glo</TT> file, that were
created by the <TT>glossary</TT> package, as the <TT>glossaries</TT>
-package uses a different <TT>makeindex</TT> style file.
+package uses a different format.
Remember also, that if you used the <TT>makeglos</TT> Perl script,
you will need to use the <TT>makeglossaries</TT> Perl script
-instead.
+instead. As from v1.17, the <TT>glossaries</TT> package can be
+used with either <TT>makeindex</TT> or <TT>xindy</TT>. Since
+<TT>xindy</TT> was designed to be multilingual, the
+new <TT>glossaries</TT> package is a much better option for
+non-English documents.
<P>
+For further information on using <TT>makeglossaries</TT>,
+<TT>makeindex</TT> or <TT>xindy</TT> to create your glossaries, see
+the
+<A NAME="tex2html9"
+ HREF="glossaries-manual.html#sec:makeglossaries">Generating the Associated Glossary
+Files</A>
+section of the
+<TT>glossaries</TT> documentation.
-<H1><A NAME="SECTION000100000000000000000">
-9 Troubleshooting</A>
+<P>
+
+<H1><A NAME="SECTION000110000000000000000">
+10 Troubleshooting</A>
</H1>
<P>
-Please check the <A NAME="tex2html5"
+Please check the <A NAME="tex2html10"
HREF="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html">FAQ</A>
for the <TT>glossaries</TT> package if you have any
problems.
@@ -760,33 +905,45 @@ problems.
<P>
<BR><HR><H4>Footnotes</H4>
<DL>
-<DT><A NAME="foot504">...
+<DT><A NAME="foot582">... choose</A><A
+ HREF="glossary2glossaries.html#tex2html1"><SUP>1</SUP></A></DT>
+<DD>as from v1.17. Previous versions
+were designed to be used with <TT>makeindex</TT> only
+
+</DD>
+<DT><A NAME="foot88">... supported;</A><A
+ HREF="glossary2glossaries.html#tex2html2"><SUP>2</SUP></A></DT>
+<DD>as
+from v1.17
+
+</DD>
+<DT><A NAME="foot585">...
available.</A><A
- HREF="glossary2glossaries.html#tex2html2"><SUP>1</SUP></A></DT>
+ HREF="glossary2glossaries.html#tex2html4"><SUP>3</SUP></A></DT>
<DD>mainly because having a key value list in
<TT>&#92;glossary</TT> caused problems, but it also helps consistency.
</DD>
-<DT><A NAME="foot511">... directly.</A><A
- HREF="glossary2glossaries.html#tex2html3"><SUP>2</SUP></A></DT>
-<DD>This is because <TT>&#92;glossary</TT> requires
-the argument to be in a specific format and doesn't use the
-&lt;<I>key</I>&gt;=&lt;<I>value</I>&gt; format that the old glossary package used. The
-new package's internal commands set this format, as well as escaping
-any of <TT>makeindex</TT>'s special characters, so although it is
-still possible to use <TT>&#92;glossary</TT> with the new package, it's not
-recommended. If you persist in using <TT>&#92;glossary</TT> with the new
-package, don't complain if things go wrong!
+<DT><A NAME="foot594">... directly.</A><A
+ HREF="glossary2glossaries.html#tex2html5"><SUP>4</SUP></A></DT>
+<DD>This is because <TT>&#92;glossary</TT>
+requires the argument to be in a specific format and doesn't use the
+&lt;<I>key</I>&gt;=&lt;<I>value</I>&gt; format that the old glossary package used.
+The new package's internal commands set this format, as well as
+escaping any of <TT>makeindex</TT>'s or <TT>xindy</TT>'s special
+characters. What's more, the format has changed as from v1.17 to
+allow the new package to be used with either <TT>makeindex</TT> or
+<TT>xindy</TT>.
</DD>
-<DT><A NAME="foot512">...
-benefits!</A><A
- HREF="glossary2glossaries.html#tex2html4"><SUP>3</SUP></A></DT>
-<DD>From the user's point of view, using <TT>&#92;glossary</TT>
-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 <TT>makeindex</TT> to treat the two entries as
-different terms, even though they look the same in the document.
+<DT><A NAME="foot595">... benefits.</A><A
+ HREF="glossary2glossaries.html#tex2html6"><SUP>5</SUP></A></DT>
+<DD>From
+the user's point of view, using <TT>&#92;glossary</TT> 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 <TT>makeindex</TT> to treat the two entries as different
+terms, even though they look the same in the document.
</DD>
</DL>