diff options
author | Karl Berry <karl@freefriends.org> | 2010-06-14 22:31:40 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2010-06-14 22:31:40 +0000 |
commit | b3f1741ccbe6dede2fc5cc309815e40728c0330f (patch) | |
tree | e9c7d2ffc516d8fff6defbf3b85205078e1701f9 /Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html | |
parent | fa2a29ef6564da92ff9b4caede3dd5456dd48eb6 (diff) |
glossaries 2.06 (14jun10)
git-svn-id: svn://tug.org/texlive/trunk@18975 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html')
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html | 2894 |
1 files changed, 1977 insertions, 917 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index 754eec11a3a..8f6c7a21e37 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -1,953 +1,2013 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> - -<!--Converted with LaTeX2HTML 2002 (1.67) -original version by: Nikos Drakos, CBLU, University of Leeds -* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan -* with significant contributions from: - Jens Lippmann, Marek Rouchal, Martin Wilck and others --> -<HTML> -<HEAD> -<TITLE>Upgrading from the glossary package to the glossaries -package</TITLE> -<META NAME="description" CONTENT="Upgrading from the glossary package to the glossaries -package"> -<META NAME="keywords" CONTENT="glossary2glossaries"> -<META NAME="resource-type" CONTENT="document"> -<META NAME="distribution" CONTENT="global"> - -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> -<META NAME="Generator" CONTENT="LaTeX2HTML v2002"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> - - -</HEAD> - -<BODY > -<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>14th January 2009</STRONG></P> -<BR> - -<H2><A NAME="SECTION00010000000000000000"> -Contents</A> -</H2> -<!--Table of Contents--> - -<UL> -<LI><A NAME="tex2html29" - HREF="glossary2glossaries.html#SECTION00020000000000000000">1 Why the Need for a New Package?</A> -<LI><A NAME="tex2html30" - HREF="glossary2glossaries.html#SECTION00030000000000000000">2 Package Options</A> -<LI><A NAME="tex2html31" - HREF="glossary2glossaries.html#SECTION00040000000000000000">3 Defining new glossary types</A> -<LI><A NAME="tex2html32" - HREF="glossary2glossaries.html#SECTION00050000000000000000">4 \make<glossary name></A> -<LI><A NAME="tex2html33" - HREF="glossary2glossaries.html#SECTION00060000000000000000">5 Storing glossary information</A> -<LI><A NAME="tex2html34" - HREF="glossary2glossaries.html#SECTION00070000000000000000">6 Adding an entry to the glossary</A> -<UL> -<LI><A NAME="tex2html35" - HREF="glossary2glossaries.html#SECTION00071000000000000000">6.1 \useglosentry</A> -<LI><A NAME="tex2html36" - HREF="glossary2glossaries.html#SECTION00072000000000000000">6.2 \useGlosentry</A> -<LI><A NAME="tex2html37" - HREF="glossary2glossaries.html#SECTION00073000000000000000">6.3 \gls</A> -<LI><A NAME="tex2html38" - HREF="glossary2glossaries.html#SECTION00074000000000000000">6.4 \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 \acrln and \acrsh</A> -<LI><A NAME="tex2html41" - HREF="glossary2glossaries.html#SECTION00082000000000000000">7.2 \ifacronymfirstuse</A> -<LI><A NAME="tex2html42" - HREF="glossary2glossaries.html#SECTION00083000000000000000">7.3 \resetacronym and \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> - -<H3>Abstract:</H3> -<DIV> -The purpose of this document is to provide advice if you want -to convert a LaTeX document from using the obsolete -<TT>glossary</TT> package to the replacement <TT>glossaries</TT> package. -</DIV> -<P> - -<P> - -<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> -When converting a document that currently uses the obsolete -<TT>glossary</TT> package to the replacement <TT>glossaries</TT> package, -it should be fairly obvious that the first thing you need to do is -replace <code>\usepackage{glossary}</code> with -<code>\usepackage{glossaries}</code>, however some of the package options -are different, so you may need to change those as well. -Table <A HREF="glossary2glossaries.html#tab:pkgopt">1</A> shows the mappings from the <TT>glossary</TT> -to the <TT>glossaries</TT> package options. - -<P> -<BR><P></P> -<DIV ALIGN="CENTER"> - -<A NAME="tab:pkgopt"></A> -<DIV ALIGN="CENTER"> -<A NAME="583"></A> -<TABLE CELLPADDING=3> -<CAPTION><STRONG>Table 1:</STRONG> -Mappings from <TT>glossary</TT> to <TT>glossaries</TT> -package options</CAPTION> -<TR><TH ALIGN="LEFT"><B><TT>glossary</TT> option </B></TH> -<TH ALIGN="LEFT"><B><TT>glossaries</TT> option</B></TH> -</TR> -<TR><TD ALIGN="LEFT">style=list</TD> -<TD ALIGN="LEFT">style=list</TD> -</TR> -<TR><TD ALIGN="LEFT">style=altlist</TD> -<TD ALIGN="LEFT">style=altlist</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=none,border=none,cols=2</TD> -<TD ALIGN="LEFT">style=long</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=plain,border=none,cols=2</TD> -<TD ALIGN="LEFT">style=longheader</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=none,border=plain,cols=2</TD> -<TD ALIGN="LEFT">style=longborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=plain,border=plain,cols=2</TD> -<TD ALIGN="LEFT">style=longheaderborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=none,border=none,cols=3</TD> -<TD ALIGN="LEFT">style=long3col</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=plain,border=none,cols=3</TD> -<TD ALIGN="LEFT">style=long3colheader</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=none,border=plain,cols=3</TD> -<TD ALIGN="LEFT">style=long3colborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=long,header=plain,border=plain,cols=3</TD> -<TD ALIGN="LEFT">style=long3colheaderborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=none,border=none,cols=2</TD> -<TD ALIGN="LEFT">style=super</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=plain,border=none,cols=2</TD> -<TD ALIGN="LEFT">style=superheader</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=none,border=plain,cols=2</TD> -<TD ALIGN="LEFT">style=superborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=plain,border=plain,cols=2</TD> -<TD ALIGN="LEFT">style=superheaderborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=none,border=none,cols=3</TD> -<TD ALIGN="LEFT">style=super3col</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=plain,border=none,cols=3</TD> -<TD ALIGN="LEFT">style=super3colheader</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=none,border=plain,cols=3</TD> -<TD ALIGN="LEFT">style=super3colborder</TD> -</TR> -<TR><TD ALIGN="LEFT">style=super,header=plain,border=plain,cols=3</TD> -<TD ALIGN="LEFT">style=super3colheaderborder</TD> -</TR> -<TR><TD ALIGN="LEFT">number=none</TD> -<TD ALIGN="LEFT">nonumberlist</TD> -</TR> -<TR><TD ALIGN="LEFT">number=<<I>counter name</I>></TD> -<TD ALIGN="LEFT">counter=<<I>counter name</I>></TD> -</TR> -<TR><TD ALIGN="LEFT">toc</TD> -<TD ALIGN="LEFT">toc</TD> -</TR> -<TR><TD ALIGN="LEFT">hypertoc</TD> -<TD ALIGN="LEFT">toc</TD> -</TR> -<TR><TD ALIGN="LEFT">hyper</TD> -<TD ALIGN="LEFT"><I>no corresponding option</I></TD> -</TR> -<TR><TD ALIGN="LEFT">section=true</TD> -<TD ALIGN="LEFT">section</TD> -</TR> -<TR><TD ALIGN="LEFT">section=false</TD> -<TD ALIGN="LEFT"><I>no corresponding option</I></TD> -</TR> -<TR><TD ALIGN="LEFT">acronym</TD> -<TD ALIGN="LEFT">acronym</TD> -</TR> -<TR><TD ALIGN="LEFT">global</TD> -<TD ALIGN="LEFT"><I>no corresponding option</I></TD> -</TR> -</TABLE> -</DIV> -</DIV> -<BR> - -<P> - -<H1><A NAME="SECTION00040000000000000000"> -3 Defining new glossary types</A> -</H1> - -<P> -If you have created new glossary types, you will need to -replace all instances of - -<P> -<TT><TT>\newglossarytype[<<I>log-ext</I>>]{<<I>type</I>>}{<<I>out-ext</I>>}{<<I>in-ext</I>>}[<<I>old style list</I>>]</TT> -<BR> -<TT>\newcommand</TT><code>{\</code><<I>type</I>>name<code>}</code><TT>{<<I>title</I>>}</TT></TT> -<P> +<a + id="top"></a><?xml version="1.0" encoding="iso-8859-1" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd--> +<html xmlns="http://www.w3.org/1999/xhtml" +> +<head><title>Upgrading from the glossary package to the glossaries package</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<!-- xhtml,fn-in,css-in --> +<meta name="src" content="glossary2glossaries.tex" /> +<meta name="date" content="2010-06-14 14:03:00" /> + +<style type="text/css"> +<!-- + +/* start css.sty */ +.cmr-17{font-size:170%;} +.cmr-12{font-size:120%;} +.cmr-8{font-size:80%;} +.cmsy-8{font-size:80%;} +.cmr-9{font-size:90%;} +.cmbx-9{font-size:90%; font-weight: bold;} +.cmbx-9{ font-weight: bold;} +.cmss-9{font-size:90%; font-family: sans-serif;} +.cmss-9{ font-family: sans-serif;} +.cmss-9{ font-family: sans-serif;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmti-10{ font-style: italic;} +.cmss-10{ font-family: sans-serif;} +.cmss-10{ font-family: sans-serif;} +.cmss-10{ font-family: sans-serif;} +.cmtt-8{font-size:80%;font-family: monospace;} +.cmtt-8{font-family: monospace;} +.cmtt-8{font-family: monospace;} +.cmbx-10{ font-weight: bold;} +.cmbx-10{ font-weight: bold;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmtt-9{font-size:90%;font-family: monospace;} +.cmtt-9{font-family: monospace;} +.cmtt-9{font-family: monospace;} +.cmti-8{font-size:80%; font-style: italic;} +p.noindent { text-indent: 0em } +td p.noindent { text-indent: 0em; margin-top:0em; } +p.nopar { text-indent: 0em; } +p.indent{ text-indent: 1.5em } +@media print {div.crosslinks {visibility:hidden;}} +a img { border-top: 0; border-left: 0; border-right: 0; } +center { margin-top:1em; margin-bottom:1em; } +td center { margin-top:0em; margin-bottom:0em; } +.Canvas { position:relative; } +img.math{vertical-align:middle;} +li p.indent { text-indent: 0em } +li p:first-child{ margin-top:0em; } +li p:last-child, li div:last-child { margin-bottom:0.5em; } +li p~ul:last-child, li p~ol:last-child{ margin-bottom:0.5em; } +.enumerate1 {list-style-type:decimal;} +.enumerate2 {list-style-type:lower-alpha;} +.enumerate3 {list-style-type:lower-roman;} +.enumerate4 {list-style-type:upper-alpha;} +div.newtheorem { margin-bottom: 2em; margin-top: 2em;} +.obeylines-h,.obeylines-v {white-space: nowrap; } +div.obeylines-v p { margin-top:0; margin-bottom:0; } +.overline{ text-decoration:overline; } +.overline img{ border-top: 1px solid black; } +td.displaylines {text-align:center; white-space:nowrap;} +.centerline {text-align:center;} +.rightline {text-align:right;} +div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; } +.fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.fbox {display:table} +div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.minipage{width:100%;} +div.center, div.center div.center {text-align: center; margin-left:1em; margin-right:1em;} +div.center div {text-align: left;} +div.flushright, div.flushright div.flushright {text-align: right;} +div.flushright div {text-align: left;} +div.flushleft {text-align: left;} +.underline{ text-decoration:underline; } +.underline img{ border-bottom: 1px solid black; margin-bottom:1pt; } +.framebox-c, .framebox-l, .framebox-r { padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +.framebox-c {text-align:center;} +.framebox-l {text-align:left;} +.framebox-r {text-align:right;} +span.thank-mark{ vertical-align: super } +span.footnote-mark sup.textsuperscript, span.footnote-mark a sup.textsuperscript{ font-size:80%; } +div.footnotes{border-top:solid 1px black; border-bottom:solid 1px black; padding-bottom:1ex; padding-top:0.5ex; margin-right:15%; margin-top:2ex; font-style:italic; font-size:85%;} +div.footnotes p{margin-top:0; margin-bottom:0; text-indent:0;} +div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; } +table.tabular td p{margin-top:0em;} +table.tabular {margin-left: auto; margin-right: auto;} +td p:first-child{ margin-top:0em; } +td p:last-child{ margin-bottom:0em; } +div.td00{ margin-left:0pt; margin-right:0pt; } +div.td01{ margin-left:0pt; margin-right:5pt; } +div.td10{ margin-left:5pt; margin-right:0pt; } +div.td11{ margin-left:5pt; margin-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +td.td00{ padding-left:0pt; padding-right:0pt; } +td.td01{ padding-left:0pt; padding-right:5pt; } +td.td10{ padding-left:5pt; padding-right:0pt; } +td.td11{ padding-left:5pt; padding-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +.hline hr, .cline hr{ height : 1px; margin:0px; } +.tabbing-right {text-align:right;} +span.TEX {letter-spacing: -0.125em; } +span.TEX span.E{ position:relative;top:0.5ex;left:-0.0417em;} +a span.TEX span.E {text-decoration: none; } +span.LATEX span.A{ position:relative; top:-0.5ex; left:-0.4em; font-size:85%;} +span.LATEX span.TEX{ position:relative; left: -0.4em; } +div.float, div.figure {margin-left: auto; margin-right: auto;} +div.float img {text-align:center;} +div.figure img {text-align:center;} +.marginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} +.marginpar p{margin-top:0.4em; margin-bottom:0.4em;} +table.equation {width:100%;} +.equation td{text-align:center; } +td.equation { margin-top:1em; margin-bottom:1em; } +td.equation-label { width:5%; text-align:center; } +td.eqnarray4 { width:5%; white-space: normal; } +td.eqnarray2 { width:5%; } +table.eqnarray-star, table.eqnarray {width:100%;} +div.eqnarray{text-align:center;} +div.array {text-align:center;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +span.pmatrix img{vertical-align:middle;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +span.bar-css {text-decoration:overline;} +img.cdots{vertical-align:middle;} +.partToc a, .partToc, .likepartToc a, .likepartToc {line-height: 200%; font-weight:bold; font-size:110%;} +.index-item, .index-subitem, .index-subsubitem {display:block} +div.caption {text-indent:-2em; margin-left:3em; margin-right:1em; text-align:left;} +div.caption span.id{font-weight: bold; white-space: nowrap; } +h1.partHead{text-align: center} +p.bibitem { text-indent: -2em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +p.bibitem-p { text-indent: 0em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +.paragraphHead, .likeparagraphHead { margin-top:2em; font-weight: bold;} +.subparagraphHead, .likesubparagraphHead { font-weight: bold;} +.quote {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; margin-right:1em; text-align:justify;} +.verse{white-space:nowrap; margin-left:2em} +div.maketitle {text-align:center;} +h2.titleHead{text-align:center;} +div.maketitle{ margin-bottom: 2em; } +div.author, div.date {text-align:center;} +div.thanks{text-align:left; margin-left:10%; font-size:85%; font-style:italic; } +.quotation {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; } +.abstract p {margin-left:5%; margin-right:5%;} +div.abstract {width:100%;} +table.multicols { width:100%; margin-left:1em; margin-top:1em; margin-bottom:1em; } +div.important { background-color:red; } +/* end css.sty */ + + +--> +</style> +</head><body +> + <div class="maketitle"> + + + + + + + +<h2 class="titleHead">Upgrading from the glossary package to the +glossaries package</h2> +<div class="author" ><span +class="cmr-12">Nicola L.C. Talbot</span></div><br /> +<div class="date" ><span +class="cmr-12">2010-05-28</span></div> + </div> + <div +class="abstract" +> +<div class="center" +> +<!--l. 35--><p class="noindent" > +</p><!--l. 35--><p class="noindent" ><span +class="cmbx-9">Abstract</span></p></div> + <!--l. 36--><p class="indent" > <span +class="cmr-9">The purpose of this document is to provide advice if you want to</span> + <span +class="cmr-9">convert a </span><span class="LATEX"><span +class="cmr-9">L</span><span class="A"><span +class="cmr-9">A</span></span><span class="TEX"><span +class="cmr-9">T</span><span +class="E"><span +class="cmr-9">E</span></span><span +class="cmr-9">X</span></span></span><span +class="cmr-9"> document from using the obsolete </span><span +class="cmss-9">glossary </span><span +class="cmr-9">package to the</span> + <span +class="cmr-9">replacement </span><span +class="cmss-9">glossaries </span><span +class="cmr-9">package.</span> +</p> +</div> + <h3 class="likesectionHead"><a + id="x1-1000"></a>Contents</h3> + <div class="tableofcontents"> + <span class="sectionToc" >1 <a +href="#x1-20001" id="QQ2-1-2">Why the Need for a New Package?</a></span> +<br /> <span class="sectionToc" >2 <a +href="#x1-30002" id="QQ2-1-3">Package Options</a></span> +<br /> <span class="sectionToc" >3 <a +href="#x1-40003" id="QQ2-1-5">Defining new glossary types</a></span> +<br /> <span class="sectionToc" >4 <a +href="#x1-50004" id="QQ2-1-6"><span +class="cmtt-10">\make</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary name</span><span +class="cmsy-10">⟩</span></a></span> +<br /> <span class="sectionToc" >5 <a +href="#x1-60005" id="QQ2-1-7">Storing glossary information</a></span> +<br /> <span class="sectionToc" >6 <a +href="#x1-70006" id="QQ2-1-8">Adding an entry to the glossary</a></span> +<br />  <span class="subsectionToc" >6.1 <a +href="#x1-80006.1" id="QQ2-1-9"><span +class="cmtt-10">\useglosentry</span></a></span> +<br />  <span class="subsectionToc" >6.2 <a +href="#x1-90006.2" id="QQ2-1-10"><span +class="cmtt-10">\useGlosentry</span></a></span> +<br />  <span class="subsectionToc" >6.3 <a +href="#x1-100006.3" id="QQ2-1-11"><span +class="cmtt-10">\gls</span></a></span> +<br />  <span class="subsectionToc" >6.4 <a +href="#x1-110006.4" id="QQ2-1-12"><span +class="cmtt-10">\glossary</span></a></span> + + + +<br /> <span class="sectionToc" >7 <a +href="#x1-120007" id="QQ2-1-13">Acronyms</a></span> +<br />  <span class="subsectionToc" >7.1 <a +href="#x1-130007.1" id="QQ2-1-14"><span +class="cmtt-10">\acrln </span>and <span +class="cmtt-10">\acrsh</span></a></span> +<br />  <span class="subsectionToc" >7.2 <a +href="#x1-140007.2" id="QQ2-1-15"><span +class="cmtt-10">\ifacronymfirstuse</span></a></span> +<br />  <span class="subsectionToc" >7.3 <a +href="#x1-150007.3" id="QQ2-1-16"><span +class="cmtt-10">\resetacronym </span>and <span +class="cmtt-10">\unsetacronym</span></a></span> +<br /> <span class="sectionToc" >8 <a +href="#x1-160008" id="QQ2-1-17">Displaying the glossary</a></span> +<br /> <span class="sectionToc" >9 <a +href="#x1-170009" id="QQ2-1-18">Processing Your Document</a></span> +<br /> <span class="sectionToc" >10 <a +href="#x1-1800010" id="QQ2-1-19">Troubleshooting</a></span> + </div> +<!--l. 43--><p class="noindent" > +</p> + <h3 class="sectionHead"><span class="titlemark">1 </span> <a + id="x1-20001"></a>Why the Need for a New Package?</h3> +<!--l. 46--><p class="noindent" >The <span +class="cmss-10">glossary </span>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 <span +class="cmss-10">glossaries</span> +package: +</p> + <ul class="itemize1"> + <li class="itemize">you can define irregular plurals; + </li> + <li class="itemize">glossary terms can have an associated symbol in addition to the name and + description; + </li> + <li class="itemize">new glossary styles are much easier to design; + </li> + <li class="itemize">you can add dictionaries to supply translations for the fixed names used in + headings and by some of the glossary styles; + </li> + <li class="itemize">you can choose<span class="footnote-mark"><a +href="#fn1x0" id="fn1x0-bk"><sup class="textsuperscript">1</sup></a></span><a + id="x1-2001f1"></a> + between using <span +class="cmtt-10">makeindex</span><a + id="dx1-2003"></a> or <span +class="cmtt-10">xindy</span><a + id="dx1-2004"></a> to sort the glossary. Using <span +class="cmtt-10">xindy</span><a + id="dx1-2005"></a> means + that: + + + + <ul class="itemize2"> + <li class="itemize">there is much better support for terms containing accented or non-Latin + characters; + </li> + <li class="itemize">there is support for non-standard location numbers;</li></ul> + </li> + <li class="itemize">you don’t need to remember to escape <span +class="cmtt-10">makeindex</span><a + id="dx1-2006"></a>’s special characters as this is + done internally; + </li> + <li class="itemize">hierarchical entries and homographs are + supported;<span class="footnote-mark"><a +href="#fn2x0" id="fn2x0-bk"><sup class="textsuperscript">2</sup></a></span><a + id="x1-2007f2"></a> + </li> + <li class="itemize">there is better support for cross-referencing glossary entries; + </li> + <li class="itemize">acronyms are just another glossary term which helps to maintain consistency; + </li> + <li class="itemize">different acronym styles are supported. + </li></ul> +<!--l. 94--><p class="noindent" > +</p> +<!--l. 94--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a + id="x1-30002"></a>Package Options</h3> +<!--l. 96--><p class="noindent" >When converting a document that currently uses the obsolete <span +class="cmss-10">glossary </span>package to the +replacement <span +class="cmss-10">glossaries </span>package, it should be fairly obvious that the first thing you need +to do is replace <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\usepackage{glossary}</span></span></span> with <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\usepackage{glossaries}</span></span></span>, however +some of the package options are different, so you may need to change those as +well. Table <a +href="#x1-30011">1<!--tex4ht:ref: tab:pkgopt --></a> shows the mappings from the <span +class="cmss-10">glossary </span>to the <span +class="cmss-10">glossaries </span>package +options. +</p> + <div class="table"> + + + +<!--l. 105--><p class="indent" > <a + id="x1-30011"></a></p><hr class="float" /><div class="float" +> + + + + <div class="caption" +><span class="id">Table 1: </span><span +class="content">Mappings from <span +class="cmss-10">glossary </span>to <span +class="cmss-10">glossaries </span>package options</span></div><!--tex4ht:label?: x1-30011 --> +<div class="center" +> +<!--l. 109--><p class="noindent" > +</p> +<div class="tabular"> <table id="TBL-2" class="tabular" +cellspacing="0" cellpadding="0" +><colgroup id="TBL-2-1g"><col +id="TBL-2-1" /><col +id="TBL-2-2" /></colgroup><tr + style="vertical-align:baseline;" id="TBL-2-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-1-1" +class="td11"><span +class="cmssbx-10">glossary </span><span +class="cmbx-10">option </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-2-1-2" +class="td11"><span +class="cmssbx-10">glossaries </span><span +class="cmbx-10">option </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-2-1" +class="td11">style=list </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-2-2" +class="td11">style=list </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-3-1" +class="td11">style=altlist </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-3-2" +class="td11">style=altlist </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-4-1" +class="td11">style=long,header=none,border=none,cols=2 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-4-2" +class="td11">style=long </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-5-1" +class="td11">style=long,header=plain,border=none,cols=2 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-5-2" +class="td11">style=longheader </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-6-1" +class="td11">style=long,header=none,border=plain,cols=2 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-6-2" +class="td11">style=longborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-7-1" +class="td11">style=long,header=plain,border=plain,cols=2 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-7-2" +class="td11">style=longheaderborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-8-1" +class="td11">style=long,header=none,border=none,cols=3 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-8-2" +class="td11">style=long3col </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-9-1" +class="td11">style=long,header=plain,border=none,cols=3 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-9-2" +class="td11">style=long3colheader </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-10-1" +class="td11">style=long,header=none,border=plain,cols=3 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-10-2" +class="td11">style=long3colborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-11-1" +class="td11">style=long,header=plain,border=plain,cols=3 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-11-2" +class="td11">style=long3colheaderborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-12-1" +class="td11">style=super,header=none,border=none,cols=2 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-12-2" +class="td11">style=super </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-13-1" +class="td11">style=super,header=plain,border=none,cols=2</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-13-2" +class="td11">style=superheader </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-14-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-14-1" +class="td11">style=super,header=none,border=plain,cols=2</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-14-2" +class="td11">style=superborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-15-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-15-1" +class="td11">style=super,header=plain,border=plain,cols=2</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-15-2" +class="td11">style=superheaderborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-16-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-16-1" +class="td11">style=super,header=none,border=none,cols=3 </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-16-2" +class="td11">style=super3col </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-17-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-17-1" +class="td11">style=super,header=plain,border=none,cols=3</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-17-2" +class="td11">style=super3colheader </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-18-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-18-1" +class="td11">style=super,header=none,border=plain,cols=3</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-18-2" +class="td11">style=super3colborder </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-19-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-19-1" +class="td11">style=super,header=plain,border=plain,cols=3</td><td style="white-space:nowrap; text-align:left;" id="TBL-2-19-2" +class="td11">style=super3colheaderborder</td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-20-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-20-1" +class="td11">number=none </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-20-2" +class="td11">nonumberlist </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-21-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-21-1" +class="td11">number=<span +class="cmsy-10">⟨</span><span +class="cmti-10">counter name</span><span +class="cmsy-10">⟩ </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-2-21-2" +class="td11">counter=<span +class="cmsy-10">⟨</span><span +class="cmti-10">counter name</span><span +class="cmsy-10">⟩ </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-22-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-22-1" +class="td11">toc </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-22-2" +class="td11">toc </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-23-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-23-1" +class="td11">hypertoc </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-23-2" +class="td11">toc </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-24-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-24-1" +class="td11">hyper </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-24-2" +class="td11"><span +class="cmti-10">no corresponding option </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-25-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-25-1" +class="td11">section=true </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-25-2" +class="td11">section </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-26-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-26-1" +class="td11">section=false </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-26-2" +class="td11"><span +class="cmti-10">no corresponding option </span></td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-27-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-27-1" +class="td11">acronym </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-27-2" +class="td11">acronym </td> +</tr><tr + style="vertical-align:baseline;" id="TBL-2-28-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-28-1" +class="td11">global </td><td style="white-space:nowrap; text-align:left;" id="TBL-2-28-2" +class="td11"><span +class="cmti-10">no corresponding option </span></td></tr></table> +</div></div> + + + + </div><hr class="endfloat" /> + </div> +<!--l. 143--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a + id="x1-40003"></a>Defining new glossary types</h3> +<!--l. 145--><p class="noindent" >If you have created new glossary types, you will need to replace all instances +of +</p><!--l. 147--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newglossarytype</span><a + id="dx1-4001"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">log-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">out-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">in-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">old style list</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]</span><br +class="newline" /> + <br /><span +class="cmtt-10">\newcommand</span><span class="verb"><span +class="cmtt-10">{\</span></span><span +class="cmsy-10">⟨</span><span +class="cmti-10">type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">name</span><span class="verb"><span +class="cmtt-10">}</span></span><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">title</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\newglossary[<<I>log-ext</I>>]{<<I>type</I>>}{<<I>out-ext</I>>}{<<I>in-ext</I>>}{<<I>title</I>>}</TT></TT> -<P> -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>\glossarystyle{<<I>new style</I>>}</TT></TT> -<P> -immediately before the glossary is displayed, or you can specify -the style when you display the glossary using <TT>\printglossary</TT> -(see below). - -<P> -The <<I>old style list</I>> optional argument can be converted to -<<I>new style</I>> using the same mapping given in -Table <A HREF="glossary2glossaries.html#tab:pkgopt">1</A>. - -<P> -For example, if your document contains the following: -<PRE> +</p><!--l. 152--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newglossary</span><a + id="dx1-4002"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">log-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">out-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">in-ext</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">title</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +in the preamble, and, if the new glossary requires a different style to the main (default) +glossary, you will also need to put +</p><!--l. 157--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glossarystyle</span><a + id="dx1-4003"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">new style</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +immediately before the glossary is displayed, or you can specify the style when you +display the glossary using <span +class="cmtt-10">\printglossary</span><a + id="dx1-4004"></a> (see below). +</p><!--l. 164--><p class="indent" > The <span +class="cmsy-10">⟨</span><span +class="cmti-10">old style list</span><span +class="cmsy-10">⟩ </span>optional argument can be converted to <span +class="cmsy-10">⟨</span><span +class="cmti-10">new style</span><span +class="cmsy-10">⟩ </span>using the +same mapping given in Table <a +href="#x1-30011">1<!--tex4ht:ref: tab:pkgopt --></a>. +</p><!--l. 168--><p class="indent" > For example, if your document contains the following: + + + +</p> + <div class="verbatim" id="verbatim-1"> \newglossarytype[nlg]{notation}{not}{ntn}[style=long,header] -\newcommand{\notationname}{Index of Notation} -</PRE> -You will need to replace the above two lines with: -<PRE> -\newglossary[nlg]{notation}{not}{ntn}{Index of Notation} -</PRE> -in the preamble and -<PRE> + <br />\newcommand{\notationname}{Index of Notation} +</div> +<!--l. 172--><p class="nopar" > You will need to replace the above two lines with: + + + +</p> + <div class="verbatim" id="verbatim-2"> +\newglossary[nlg]{notation}{not}{ntn}{Index of Notation} +</div> +<!--l. 176--><p class="nopar" > in the preamble and + + + +</p> + <div class="verbatim" id="verbatim-3"> \glossarystyle{longheader} -</PRE> -immediately prior to displaying this glossary. -Alternatively, you can specify the style using the <TT>style</TT> -key in the optional argument of <TT>\printglossary</TT>. For example: -<PRE> +</div> +<!--l. 180--><p class="nopar" > immediately prior to displaying this glossary. Alternatively, you can specify the +style using the <span +class="cmss-10">style</span><a + id="dx1-4005"></a> key in the optional argument of <span +class="cmtt-10">\printglossary</span><a + id="dx1-4006"></a>. For +example: + + + +</p> + <div class="verbatim" id="verbatim-4"> \printglossary[type=notation,style=longheader] -</PRE> - -<P> -Note that the glossary title is no longer specified using -<TT>\</TT><<I>glossary-type</I>><TT>name</TT> (except for <TT>\glossaryname</TT> -and <TT>\acronymname</TT>) but is instead specified in the <<I>title</I>> -argument of <TT>\newglossary</TT>. The short title which is specified -in the <TT>glossary</TT> package by the command -<TT>\short</TT><<I>glossary-name</I>><TT>name</TT> is now specified -using the <TT>toctitle</TT> key in the optional argument to -<TT>\printglossary</TT>. - -<P> - -<H1><A NAME="SECTION00050000000000000000"> -4 <TT>\make</TT><<I>glossary name</I>></A> -</H1> - -<P> -All instances of <TT>\make</TT><<I>glossary name</I>> (e.g. -<TT>\makeglossary</TT> and <TT>\makeacronym</TT>) should be replaced -by the single command <TT>\makeglossaries</TT>. For example, if -your document contained the following: -<PRE> +</div> +<!--l. 186--><p class="nopar" > +</p><!--l. 188--><p class="indent" > Note that the glossary title is no longer specified using <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary-type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">name </span>(except +for <span +class="cmtt-10">\glossaryname</span><a + id="dx1-4007"></a> and <span +class="cmtt-10">\acronymname</span><a + id="dx1-4008"></a>) but is instead specified in the <span +class="cmsy-10">⟨</span><span +class="cmti-10">title</span><span +class="cmsy-10">⟩ </span>argument +of <span +class="cmtt-10">\newglossary</span><a + id="dx1-4009"></a>. The short title which is specified in the <span +class="cmss-10">glossary </span>package by the +command <span +class="cmtt-10">\short</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">name </span>is now specified using the <span +class="cmss-10">toctitle</span><a + id="dx1-4010"></a> key in the +optional argument to <span +class="cmtt-10">\printglossary</span><a + id="dx1-4011"></a>. +</p><!--l. 198--><p class="noindent" > +</p> +<!--l. 198--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a + id="x1-50004"></a><span +class="cmtt-10">\make</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary name</span><span +class="cmsy-10">⟩</span></h3> +<!--l. 200--><p class="noindent" >All instances of <span +class="cmtt-10">\make</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary name</span><span +class="cmsy-10">⟩ </span>(e.g. <span +class="cmtt-10">\makeglossary</span><a + id="dx1-5001"></a> and <span +class="cmtt-10">\makeacronym</span><a + id="dx1-5002"></a>) should +be replaced by the single command <span +class="cmtt-10">\makeglossaries</span><a + id="dx1-5003"></a>. For example, if your document +contained the following: + + + +</p> + <div class="verbatim" id="verbatim-5"> \makeglossary -\makeacronym -</PRE> -then you should replace both lines with the single line: -<PRE> + <br />\makeacronym +</div> +<!--l. 207--><p class="nopar" > then you should replace both lines with the single line: + + + +</p> + <div class="verbatim" id="verbatim-6"> \makeglossaries -</PRE> - -<P> - -<H1><A NAME="SECTION00060000000000000000"> -5 Storing glossary information</A> -</H1> - -<P> -With the old <TT>glossary</TT> package you could optionally store -glossary information for later use, or you could simply use -<TT>\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="tex2html4" - HREF="#foot585"><SUP>3</SUP></A> If -you have stored all the glossary information using -<TT>\storeglosentry</TT>, then you will need to convert these commands -into the equivalent <TT>\newglossaryentry</TT>. If you have only -used <TT>\glossary</TT>, then see -<A HREF="glossary2glossaries.html#sec:csglossary">later</A>. - -<P> -Substitute all instances of - -<P> -<TT><TT>\storeglosentry{<<I>label</I>>}{<<I>gls-entry</I>>}</TT></TT> -<P> +</div> +<!--l. 211--><p class="nopar" > +</p><!--l. 213--><p class="noindent" > +</p> +<!--l. 213--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a + id="x1-60005"></a>Storing glossary information</h3> +<!--l. 215--><p class="noindent" >With the old <span +class="cmss-10">glossary </span>package you could optionally store glossary information for later +use, or you could simply use <span +class="cmtt-10">\glossary</span><a + id="dx1-6001"></a> whenever you wanted to add information to +the glossary. With the new <span +class="cmss-10">glossaries </span>package, the latter option is no longer +available.<span class="footnote-mark"><a +href="#fn3x0" id="fn3x0-bk"><sup class="textsuperscript">3</sup></a></span><a + id="x1-6002f3"></a> +If you have stored all the glossary information using <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-6004"></a>, then you will +need to convert these commands into the equivalent <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-6005"></a>. If you have +only used <span +class="cmtt-10">\glossary</span><a + id="dx1-6006"></a>, then see <a +href="#x1-110006.4"><span +class="cmsy-10">§</span>6.4 </a><a +href="#x1-110006.4"><span +class="cmtt-10">\glossary</span><!--tex4ht:ref: sec:csglossary --></a>. +</p><!--l. 226--><p class="indent" > Substitute all instances of +</p><!--l. 227--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-6007"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\newglossaryentry{<<I>label</I>>}{<<I>gls-entry</I>>}</TT></TT> -<P> -This should be fairly easy to do using the search and replace -facility in your editor (but see notes below). - -<P> -If you have used the optional argument of <TT>\storeglosentry</TT> -(i.e. you have multiple glossaries) then you will need to -substitute - -<P> -<TT><TT>\storeglosentry[<<I>gls-type</I>>]{<<I>label</I>>}{<<I>gls-entry</I>>}</TT></TT> -<P> +</p><!--l. 231--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-6008"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +This should be fairly easy to do using the search and replace facility in your editor (but +see notes below). +</p><!--l. 237--><p class="indent" > If you have used the optional argument of <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-6009"></a> (i.e. you have multiple +glossaries) then you will need to substitute +</p><!--l. 240--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-6010"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\newglossaryentry{<<I>label</I>>}</TT><code>{</code><<I>gls-entry</I>>,type=<<I>gls-type</I>><code>}</code></TT> -<P> - -<P> -The glossary entry information <<I>gls-entry</I>> may also need -changing. If <<I>gls-entry</I>> contains any of <TT>makeindex</TT>'s -special characters (i.e. <TT>@</TT> <TT>!</TT> <code>"</code> or -<code>|</code>) then they should no longer be escaped with <code>"</code> -since the <TT>glossaries</TT> package deals with these characters +</p><!--l. 244--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-6011"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span><span class="verb"><span +class="cmtt-10">{</span></span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">,type=</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-type</span><span +class="cmsy-10">⟩</span><span class="verb"><span +class="cmtt-10">}</span></span> + <br /></div><hr> + + + + <br /></span> +</p><!--l. 248--><p class="indent" > The glossary entry information <span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩ </span>may also need changing. If <span +class="cmsy-10">⟨</span><span +class="cmti-10">gls-entry</span><span +class="cmsy-10">⟩</span> +contains any of <span +class="cmtt-10">makeindex</span><a + id="dx1-6012"></a>’s special characters (i.e. <span +class="cmtt-10">@ ! </span><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">"</span></span></span> or <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">|</span></span></span>) then they should no +longer be escaped with <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">"</span></span></span> since the <span +class="cmss-10">glossaries </span>package deals with these characters internally. For example, if your document contains the following: -<PRE> + + + +</p> + <div class="verbatim" id="verbatim-7"> \storeglosentry{card}{name={$"|\mathcal{S}"|$}, -description={The cardinality of the set $\mathcal{S}$}} -</PRE> -then you will need to replace it with: -<PRE> + <br />description={The cardinality of the set $\mathcal{S}$}} +</div> +<!--l. 257--><p class="nopar" > then you will need to replace it with: + + + +</p> + <div class="verbatim" id="verbatim-8"> \newglossaryentry{card}{name={$|\mathcal{S}|$}, -description={The cardinality of the set $\mathcal{S}$}} -</PRE> - -<P> -The <TT>format</TT> and <TT>number</TT> keys available in -<TT>\storeglosentry</TT> are not available with <TT>\newglossaryentry</TT>. - -<P> - -<H1><A NAME="SECTION00070000000000000000"> -6 Adding an entry to the glossary</A> -</H1> - -<P> -The <TT>glossary</TT> package provided two basic means to add -information to the glossary: firstly, the term was defined -using <TT>\storeglosentry</TT> and the entries for that term were -added using <TT>\useglosentry</TT>, <TT>\useGlosentry</TT> and <TT>\gls</TT>. -Secondly, the term was added to the glossary using <TT>\glossary</TT>. -This second approach is unavailable with the <TT>glossaries</TT> + <br />description={The cardinality of the set $\mathcal{S}$}} +</div> +<!--l. 262--><p class="nopar" > +</p><!--l. 264--><p class="indent" > The <span +class="cmss-10">format</span><a + id="dx1-6013"></a> and <span +class="cmss-10">number</span><a + id="dx1-6014"></a> keys available in <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-6015"></a> are not available with +<span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-6016"></a>. +</p><!--l. 268--><p class="noindent" > +</p> +<!--l. 268--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a + id="x1-70006"></a>Adding an entry to the glossary</h3> +<!--l. 270--><p class="noindent" >The <span +class="cmss-10">glossary </span>package provided two basic means to add information to the glossary: +firstly, the term was defined using <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-7001"></a> and the entries for that term were +added using <span +class="cmtt-10">\useglosentry</span><a + id="dx1-7002"></a>, <span +class="cmtt-10">\useGlosentry</span><a + id="dx1-7003"></a> and <span +class="cmtt-10">\gls</span><a + id="dx1-7004"></a>. Secondly, the term was added +to the glossary using <span +class="cmtt-10">\glossary</span><a + id="dx1-7005"></a>. This second approach is unavailable with the <span +class="cmss-10">glossaries</span> package. - -<P> - -<H2><A NAME="SECTION00071000000000000000"></A> -<A NAME="sec:useglosentry"></A> -<BR> -6.1 <TT>\useglosentry</TT> -</H2> - -<P> -The <TT>glossary</TT> package allows you to add information to the -glossary for a predefined term without producing any text -in the document using - -<P> -<TT><TT>\useglosentry[<<I>old options</I>>]{<<I>label</I>>}</TT></TT> -<P> +</p><!--l. 279--><p class="noindent" > +</p> +<!--l. 279--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.1 </span> <a + id="x1-80006.1"></a><span +class="cmtt-10">\useglosentry</span></h4> +<!--l. 282--><p class="noindent" >The <span +class="cmss-10">glossary </span>package allows you to add information to the glossary for a predefined +term without producing any text in the document using +</p><!--l. 285--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\useglosentry</span><a + id="dx1-8001"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">old options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> Any occurrences of this command will need to be replaced with - -<P> -<TT><TT>\glsadd[<<I>new options</I>>]{<<I>label</I>>}</TT></TT> -<P> -The <TT>format</TT> key in <<I>old options</I>> remains the same -in <<I>new options</I>>. However the <TT>number=</TT><<I>counter -name</I>> key in <<I>old options</I>> should be replaced with -<TT>counter=</TT><<I>counter name</I>> in <<I>new options</I>>. - -<P> - -<H2><A NAME="SECTION00072000000000000000"> -6.2 <TT>\useGlosentry</TT></A> -</H2> - -<P> -The <TT>glossary</TT> package allows you to add information to the -glossary for a predefined term with the given text using - -<P> -<TT><TT>\useGlosentry[<<I>old options</I>>]{<<I>label</I>>}{<<I>text</I>>}</TT></TT> -<P> +</p><!--l. 289--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glsadd</span><a + id="dx1-8002"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">new options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +The <span +class="cmss-10">format</span><a + id="dx1-8003"></a> key in <span +class="cmsy-10">⟨</span><span +class="cmti-10">old options</span><span +class="cmsy-10">⟩ </span>remains the same in <span +class="cmsy-10">⟨</span><span +class="cmti-10">new options</span><span +class="cmsy-10">⟩</span>. However the +<span +class="cmss-10">number</span><a + id="dx1-8004"></a><span +class="cmtt-10">=</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">counter name</span><span +class="cmsy-10">⟩ </span>key in <span +class="cmsy-10">⟨</span><span +class="cmti-10">old options</span><span +class="cmsy-10">⟩ </span>should be replaced with <span +class="cmss-10">counter</span><a + id="dx1-8005"></a><span +class="cmtt-10">=</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">counter</span> +<span +class="cmti-10">name</span><span +class="cmsy-10">⟩ </span>in <span +class="cmsy-10">⟨</span><span +class="cmti-10">new options</span><span +class="cmsy-10">⟩</span>. + + + +</p><!--l. 300--><p class="noindent" > +</p> +<!--l. 300--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.2 </span> <a + id="x1-90006.2"></a><span +class="cmtt-10">\useGlosentry</span></h4> +<!--l. 302--><p class="noindent" >The <span +class="cmss-10">glossary </span>package allows you to add information to the glossary for a predefined +term with the given text using +</p><!--l. 304--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\useGlosentry</span><a + id="dx1-9001"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">old options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> Any occurrences of this command will need to be replaced with - -<P> -<TT><TT>\glslink[<<I>new options</I>>]{<<I>label</I>>}{<<I>text</I>>}</TT></TT> -<P> -The mapping from <<I>old options</I>> to <<I>new options</I>> is -the same as that given <A HREF="glossary2glossaries.html#sec:useglosentry">above</A>. - -<P> - -<H2><A NAME="SECTION00073000000000000000"> -6.3 <TT>\gls</TT></A> -</H2> - -<P> -Both the <TT>glossary</TT> and the <TT>glossaries</TT> packages define -the command <TT>\gls</TT>. In this case, the only thing you need to -change is the <TT>number</TT> key in the optional argument -to <TT>counter</TT>. Note that the new form of <TT>\gls</TT> also takes -a final optional argument which can be used to insert text into the -automatically generated text. - -<P> - -<H2><A NAME="SECTION00074000000000000000"></A> -<A NAME="sec:csglossary"></A> -<BR> -6.4 <TT>\glossary</TT> -</H2> - -<P> -When using the <TT>glossaries</TT> package, you should not use -<TT>\glossary</TT> directly.<A NAME="tex2html5" - HREF="#foot594"><SUP>4</SUP></A> If, with the old package, you have opted to -explicitly use <TT>\glossary</TT> instead of storing the glossary -information with <TT>\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>\glossary</TT> with the old glossary package, you will instead -need to define the relevant glossary terms using -<TT>\newglossaryentry</TT> and reference the terms using -<TT>\glsadd</TT>, <TT>\glslink</TT>, <TT>\gls</TT> etc. - -<P> -If you don't like the idea of continually scrolling back to the -preamble to type all your <TT>\newglossaryentry</TT> commands, you may -prefer to create a new file, in which to store all these commands, -and then input that file in your document's preamble. Most text -editors and front-ends allow you to have multiple files open, and -you can tab back and forth between them. - -<P> - -<H1><A NAME="SECTION00080000000000000000"> -7 Acronyms</A> -</H1> - -<P> -In the <TT>glossary</TT> package, acronyms were treated differently -to glossary entries. This resulted in inconsistencies and sprawling -unmaintainable code. The new <TT>glossaries</TT> package treats -acronyms in exactly the same way as normal glossary terms. In fact, -in the <TT>glossaries</TT> package, the default definition of: - -<P> -<TT><TT>\newacronym[<<I>options</I>>]{<<I>label</I>>}{<<I>abbrv</I>>}{<<I>long</I>>}</TT></TT> -<P> +</p><!--l. 308--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glslink</span><a + id="dx1-9002"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">new options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +The mapping from <span +class="cmsy-10">⟨</span><span +class="cmti-10">old options</span><span +class="cmsy-10">⟩ </span>to <span +class="cmsy-10">⟨</span><span +class="cmti-10">new options</span><span +class="cmsy-10">⟩ </span>is the same as that given <a +href="#x1-80006.1"><span +class="cmsy-10">§</span>6.1 +</a><a +href="#x1-80006.1"><span +class="cmtt-10">\useglosentry</span><!--tex4ht:ref: sec:useglosentry --></a>. +</p><!--l. 314--><p class="noindent" > +</p> +<!--l. 314--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.3 </span> <a + id="x1-100006.3"></a><span +class="cmtt-10">\gls</span></h4> +<!--l. 316--><p class="noindent" >Both the <span +class="cmss-10">glossary </span>and the <span +class="cmss-10">glossaries </span>packages define the command <span +class="cmtt-10">\gls</span><a + id="dx1-10001"></a>. In this +case, the only thing you need to change is the <span +class="cmss-10">number</span><a + id="dx1-10002"></a> key in the optional +argument to <span +class="cmss-10">counter</span><a + id="dx1-10003"></a>. Note that the new form of <span +class="cmtt-10">\gls</span><a + id="dx1-10004"></a> also takes a final optional +argument which can be used to insert text into the automatically generated +text. +</p><!--l. 323--><p class="noindent" > +</p> +<!--l. 323--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">6.4 </span> <a + id="x1-110006.4"></a><span +class="cmtt-10">\glossary</span></h4> +<!--l. 326--><p class="noindent" >When using the <span +class="cmss-10">glossaries </span>package, you should not use <span +class="cmtt-10">\glossary</span><a + id="dx1-11001"></a> +directly.<span class="footnote-mark"><a +href="#fn4x0" id="fn4x0-bk"><sup class="textsuperscript">4</sup></a></span><a + id="x1-11002f4"></a> +If, with the old package, you have opted to explicitly use <span +class="cmtt-10">\glossary</span><a + id="dx1-11008"></a> instead of storing +the glossary information with <span +class="cmtt-10">\storeglosentry</span><a + id="dx1-11009"></a>, then converting from <span +class="cmss-10">glossary </span>to +<span +class="cmss-10">glossaries </span>will be more time-consuming, although in the end, I hope you will see the +benefits.<span class="footnote-mark"><a +href="#fn5x0" id="fn5x0-bk"><sup class="textsuperscript">5</sup></a></span><a + id="x1-11010f5"></a> +If you have used <span +class="cmtt-10">\glossary</span><a + id="dx1-11013"></a> with the old glossary package, you will instead need to +define the relevant glossary terms using <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-11014"></a> and reference the terms +using <span +class="cmtt-10">\glsadd</span><a + id="dx1-11015"></a>, <span +class="cmtt-10">\glslink</span><a + id="dx1-11016"></a>, <span +class="cmtt-10">\gls</span><a + id="dx1-11017"></a> etc. +</p><!--l. 349--><p class="indent" > If you don’t like the idea of continually scrolling back to the preamble to type all +your <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-11018"></a> commands, you may prefer to create a new file, in which to +store all these commands, and then input that file in your document’s preamble. Most + + + +text editors and front-ends allow you to have multiple files open, and you can tab back +and forth between them. +</p><!--l. 356--><p class="noindent" > +</p> +<!--l. 356--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">7 </span> <a + id="x1-120007"></a>Acronyms</h3> +<!--l. 358--><p class="noindent" >In the <span +class="cmss-10">glossary </span>package, acronyms were treated differently to glossary entries. This +resulted in inconsistencies and sprawling unmaintainable code. The new <span +class="cmss-10">glossaries</span> +package treats acronyms in exactly the same way as normal glossary terms. In fact, in +the <span +class="cmss-10">glossaries </span>package, the default definition of: +</p><!--l. 363--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newacronym</span><a + id="dx1-12001"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">long</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> is a shortcut for: - -<P> -<TT><TT>\newglossaryentry{<<I>label</I>>}</TT>{type=<TT>\acronymtype</TT>, -name=<TT>{<<I>abbrv</I>>}</TT>, -description=<TT>{<<I>long</I>>}</TT>, -text=<TT>{<<I>abbrv</I>>}</TT>, -first={<<I>long</I>> (<<I>abbrv</I>>)}, -plural={<<I>abbrv</I>>s}, -firstplural={<<I>long</I>>s (<<I>abbrv</I>>s)}, -<<I>options</I>>}</TT> -<P> - -<P> -This is different to the <TT>glossary</TT> package which set the -<TT>name</TT> key to <<I>long</I>> (<<I>abbrv</I>>) and allowed you -to set a description using the <TT>description</TT> key. If you -still want to do this, you can use the <TT>description</TT> package -option, and use the <TT>description</TT> key in the -optional argument of <TT>\newacronym</TT>. - -<P> -For example, if your document originally had the following: -<PRE> -\newacronym{SVM}{Support Vector Machine}{description=Statistical -pattern recognition technique} -</PRE> -Then you would need to load the <TT>glossaries</TT> package using the -<TT>description</TT> package option, for example: -<PRE> +</p><!--l. 367--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-12002"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span><span +class="cmsy-10">{</span><span +class="cmtt-10">type=\acronymtype,</span> + <br /><span +class="cmtt-10">name={</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">},</span> + <br /><span +class="cmtt-10">description={</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">long</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">},</span> + <br /><span +class="cmtt-10">text={</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">},</span> + <br /><span +class="cmtt-10">first=</span><span +class="cmsy-10">{⟨</span><span +class="cmti-10">long</span><span +class="cmsy-10">⟩ </span><span +class="cmtt-10">(</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">)</span><span +class="cmsy-10">}</span><span +class="cmtt-10">,</span> + <br /><span +class="cmtt-10">plural=</span><span +class="cmsy-10">{⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">s</span><span +class="cmsy-10">}</span><span +class="cmtt-10">,</span> + <br /><span +class="cmtt-10">firstplural=</span><span +class="cmsy-10">{⟨</span><span +class="cmti-10">long</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">s (</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">s)</span><span +class="cmsy-10">}</span><span +class="cmtt-10">,</span> + <br /><span +class="cmsy-10">⟨</span><span +class="cmti-10">options</span><span +class="cmsy-10">⟩}</span> + <br /></div><hr> + <br /></span> +</p><!--l. 378--><p class="indent" > This is different to the <span +class="cmss-10">glossary </span>package which set the <span +class="cmss-10">name</span><a + id="dx1-12003"></a> key to <span +class="cmsy-10">⟨</span><span +class="cmti-10">long</span><span +class="cmsy-10">⟩ </span>(<span +class="cmsy-10">⟨</span><span +class="cmti-10">abbrv</span><span +class="cmsy-10">⟩</span>) +and allowed you to set a description using the <span +class="cmss-10">description</span><a + id="dx1-12004"></a> key. If you still want to do +this, you can use the <span +class="cmss-10">description</span><a + id="dx1-12005"></a> package option, and use the <span +class="cmss-10">description</span><a + id="dx1-12006"></a> key in the +optional argument of <span +class="cmtt-10">\newacronym</span><a + id="dx1-12007"></a>. +</p><!--l. 386--><p class="indent" > For example, if your document originally had the following: + + + +</p> + <div class="verbatim" id="verbatim-9"> +\newacronym{SVM}{Support Vector Machine}{description=Statistical + <br />pattern recognition technique} +</div> +<!--l. 390--><p class="nopar" > Then you would need to load the <span +class="cmss-10">glossaries </span>package using the <span +class="cmss-10">description</span><a + id="dx1-12008"></a> package +option, for example: + + + +</p> + <div class="verbatim" id="verbatim-10"> \usepackage[description]{glossaries} -</PRE> -and change the acronym definition to: -<PRE> -\newacronym[description=Statistical pattern recognition -technique]{svm}{SVM}{Support Vector Machine} -</PRE> -You can then reference the acronym using any of the new referencing -commands, such as <TT>\gls</TT> or <TT>\glsadd</TT>. - -<P> -With the old <TT>glossary</TT> package, when you defined an -acronym, it also defined a command <TT>\</TT><<I>acr-name</I>> which -could be used to display the acronym in the text. So the -above SVM example would create the command <TT>\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>\gls{<<I>label</I>>}</TT>. Therefore, in the above example, you will -also need to replace all occurrences of <TT>\SVM</TT> with -<code>\gls{svm}</code>. - -<P> -If you have used <TT>\useacronym</TT> instead of <TT>\</TT><<I>acr-name</I>>, -then you will need to replace all occurrences of - -<P> -<TT><TT>\useacronym[<<I>insert</I>>]{<<I>acr-name</I>>}</TT></TT> -<P> +</div> +<!--l. 395--><p class="nopar" > and change the acronym definition to: + + + +</p> + <div class="verbatim" id="verbatim-11"> +\newacronym[description=Statistical pattern recognition + <br />technique]{svm}{SVM}{Support Vector Machine} +</div> +<!--l. 400--><p class="nopar" > You can then reference the acronym using any of the new referencing commands, such +as <span +class="cmtt-10">\gls</span><a + id="dx1-12009"></a> or <span +class="cmtt-10">\glsadd</span><a + id="dx1-12010"></a>. +</p><!--l. 404--><p class="indent" > With the old <span +class="cmss-10">glossary </span>package, when you defined an acronym, it also defined a +command <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩ </span>which could be used to display the acronym in the text. +So the above SVM example would create the command <span +class="cmtt-10">\SVM </span>with the old +package. In the new <span +class="cmss-10">glossaries </span>package, the acronyms are just another type of +glossary entry, so they are displayed using <span +class="cmtt-10">\gls</span><a + id="dx1-12011"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span>. Therefore, in the +above example, you will also need to replace all occurrences of <span +class="cmtt-10">\SVM </span>with +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{svm}</span></span></span>. +</p><!--l. 414--><p class="indent" > If you have used <span +class="cmtt-10">\useacronym</span><a + id="dx1-12012"></a> instead of <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span>, then you will need to replace +all occurrences of +</p><!--l. 416--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\useacronym</span><a + id="dx1-12013"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">insert</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\gls{<<I>label</I>>}[<<I>insert</I>>]</TT></TT> -<P> -Note that the starred versions of <TT>\useacronym</TT> and -<TT>\</TT><<I>acr-name</I>> (which make the first letter uppercase) should -be replaced with <TT>\Gls{<<I>label</I>>}</TT>. - -<P> -Alternatively (as from v1.18 of the <TT>glossaries</TT> package), -you can use <TT>\oldacronym</TT> which uses the same syntax as -the old <TT>glossary</TT> package's <TT>\newacronym</TT> and also -defines <TT>\</TT><<I>acr-name</I>>. -For example, if your document originally had the following: - -<P><PRE> -\newacronym{SVM}{Support Vector Machine}{description=Statistical -pattern recognition technique} -</PRE> -<P> +</p><!--l. 420--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\gls</span><a + id="dx1-12014"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">insert</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">]</span> + <br /></div><hr> + <br /></span> +Note that the starred versions of <span +class="cmtt-10">\useacronym</span><a + id="dx1-12015"></a> and <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩ </span>(which make the first +letter uppercase) should be replaced with <span +class="cmtt-10">\Gls</span><a + id="dx1-12016"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span>. +</p><!--l. 427--><p class="indent" > Alternatively (as from v1.18 of the <span +class="cmss-10">glossaries </span>package), you can use <span +class="cmtt-10">\oldacronym</span><a + id="dx1-12017"></a> +which uses the same syntax as the old <span +class="cmss-10">glossary </span>package’s <span +class="cmtt-10">\newacronym</span><a + id="dx1-12018"></a> and +also defines <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span>. For example, if your document originally had the +following: +</p><!--l. 432--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + + + + <div class="verbatim" id="verbatim-12"> +<!--l. 436--><p class="noindent" >\newacronym{SVM}{Support Vector Machine}{description=Statistical +</p><!--l. 436--><p class="noindent" >pattern recognition technique} + +</p></div> +<!--l. 436--><p class="nopar" > + </div><hr> +</p><!--l. 437--><p class="noindent" ></p></span> 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>\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>\</TT><<I>acr-name</I>>, 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>\oldacronym</TT> uses its first argument to -define the acronym's label (as used by commands like <TT>\gls</TT>), so -in the above example, with the new <TT>glossaries</TT> package, -<TT>\SVM</TT> becomes a shortcut for <code>\gls{SVM}</code> and <TT>\SVM*</TT> -becomes a shortcut for <code>\Gls{SVM}</code>. - -<P> - -<H2><A NAME="SECTION00081000000000000000"> -7.1 <TT>\acrln</TT> and <TT>\acrsh</TT></A> -</H2> - -<P> -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>\acrln</TT> and <TT>\acrsh</TT>. With the -<TT>glossaries</TT> package (provided you defined the acronym using -<TT>\newacronym</TT> or <TT>\oldacronym</TT> and provided you haven't redefined <TT>\newacronym</TT>) -you can replace - -<P> -<TT><TT>\acrsh{<<I>acr-name</I>>}</TT></TT> -<P> +</p><!--l. 439--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + + + + <div class="verbatim" id="verbatim-13"> +<!--l. 443--><p class="noindent" >\oldacronym{SVM}{Support Vector Machine}{description=Statistical +</p><!--l. 443--><p class="noindent" >pattern recognition technique} + +</p></div> +<!--l. 443--><p class="nopar" > + </div><hr> +</p><!--l. 444--><p class="noindent" ></p></span> +You can then continue to use <span +class="cmtt-10">\SVM</span>. However, remember that <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> generally ignores +spaces after command names that consist of alphabetical characters. You will therefore +need to force a space after <span +class="cmtt-10">\</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span>, unless you also load the <span +class="cmss-10">xspace </span>package. +(See <a +href="glossaries-manual.html#sec:acronyms" >Acronyms</a> of the <span +class="cmss-10">glossaries </span>documentation for further details.) Note that +<span +class="cmtt-10">\oldacronym</span><a + id="dx1-12019"></a> uses its first argument to define the acronym’s label (as used by +commands like <span +class="cmtt-10">\gls</span><a + id="dx1-12020"></a>), so in the above example, with the new <span +class="cmss-10">glossaries </span>package, +<span +class="cmtt-10">\SVM </span>becomes a shortcut for <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{SVM}</span></span></span> and <span +class="cmtt-10">\SVM* </span>becomes a shortcut for +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Gls{SVM}</span></span></span>. +</p><!--l. 462--><p class="noindent" > +</p> +<!--l. 462--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">7.1 </span> <a + id="x1-130007.1"></a><span +class="cmtt-10">\acrln </span>and <span +class="cmtt-10">\acrsh</span></h4> +<!--l. 464--><p class="noindent" >In the <span +class="cmss-10">glossary </span>package, it is possible to produce the long and short forms of an +acronym without adding an entry to the glossary using <span +class="cmtt-10">\acrln</span><a + id="dx1-13001"></a> and <span +class="cmtt-10">\acrsh</span><a + id="dx1-13002"></a>. With +the <span +class="cmss-10">glossaries </span>package (provided you defined the acronym using <span +class="cmtt-10">\newacronym</span><a + id="dx1-13003"></a> +or <span +class="cmtt-10">\oldacronym</span><a + id="dx1-13004"></a> and provided you haven’t redefined <span +class="cmtt-10">\newacronym</span><a + id="dx1-13005"></a>) you can +replace +</p><!--l. 471--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\acrsh</span><a + id="dx1-13006"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\acrshort{<<I>label</I>>}</TT></TT> -<P> +</p><!--l. 475--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\acrshort</span><a + id="dx1-13007"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> and you can replace - -<P> -<TT><TT>\acrln{<<I>acr-name</I>>}</TT></TT> -<P> +</p><!--l. 479--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\acrln</span><a + id="dx1-13008"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + + + + <br /></span> with - -<P> -<TT><TT>\acrlong{<<I>label</I>>}</TT></TT> -<P> -The <TT>glossaries</TT> package also provides the related commands -<TT>\acrshortpl</TT> (plural short form) and <TT>\acrlongpl</TT> (plural long -form) as well as upper case variations. If you use the -<TT>glossaries</TT> "shortcuts" package option, you can use -<TT>\acs</TT> in place of <TT>\acrshort</TT> and <TT>\acl</TT> in place of -<TT>\acrlong</TT>. - -<P> -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="SECTION00082000000000000000"> -7.2 <TT>\ifacronymfirstuse</TT></A> -</H2> - -<P> -The <TT>glossary</TT> package command - -<P> -<TT><TT>\ifacronymfirstuse{<<I>acr-name</I>>}{<<I>text1</I>>}{<<I>text2</I>>}</TT></TT> -<P> -can be replaced by the <TT>glossaries</TT> command: - -<P> -<TT><TT>\ifglsused{<<I>label</I>>}{<<I>text2</I>>}{<<I>text1</I>>}</TT></TT> -<P> -Note that <TT>\ifglsused</TT> evaluates the opposite condition to -that of <TT>\ifacronymfirstuse</TT> which is why the last two arguments -have been reversed. - -<P> - -<H2><A NAME="SECTION00083000000000000000"> -7.3 <TT>\resetacronym</TT> and <TT>\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 a global level. -To reset an acronym, you will need to replace: - -<P> -<TT><TT>\resetacronym{<<I>acr-name</I>>}</TT></TT> -<P> +</p><!--l. 483--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\acrlong</span><a + id="dx1-13009"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +The <span +class="cmss-10">glossaries </span>package also provides the related commands <span +class="cmtt-10">\acrshortpl</span><a + id="dx1-13010"></a> (plural short +form) and <span +class="cmtt-10">\acrlongpl</span><a + id="dx1-13011"></a> (plural long form) as well as upper case variations. If you use the +<span +class="cmss-10">glossaries </span>“shortcuts” package option, you can use <span +class="cmtt-10">\acs</span><a + id="dx1-13012"></a> in place of <span +class="cmtt-10">\acrshort</span><a + id="dx1-13013"></a> and <span +class="cmtt-10">\acl</span><a + id="dx1-13014"></a> +in place of <span +class="cmtt-10">\acrlong</span><a + id="dx1-13015"></a>. +</p><!--l. 493--><p class="indent" > See <a +href="glossaries-manual.html#sec:acronyms" >Acronyms</a> of the <span +class="cmss-10">glossaries </span>manual for further details of how to use these +commands. +</p><!--l. 502--><p class="noindent" > +</p> +<!--l. 502--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">7.2 </span> <a + id="x1-140007.2"></a><span +class="cmtt-10">\ifacronymfirstuse</span></h4> +<!--l. 504--><p class="noindent" >The <span +class="cmss-10">glossary </span>package command +</p><!--l. 505--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\ifacronymfirstuse</span><a + id="dx1-14001"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text1</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text2</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +can be replaced by the <span +class="cmss-10">glossaries </span>command: +</p><!--l. 509--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\ifglsused</span><a + id="dx1-14002"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text2</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">text1</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +Note that <span +class="cmtt-10">\ifglsused</span><a + id="dx1-14003"></a> evaluates the opposite condition to that of <span +class="cmtt-10">\ifacronymfirstuse</span><a + id="dx1-14004"></a> +which is why the last two arguments have been reversed. +</p><!--l. 518--><p class="noindent" > +</p> +<!--l. 518--><p class="noindent" ><a +href="#top">Top</a></p><h4 class="subsectionHead"><span class="titlemark">7.3 </span> <a + id="x1-150007.3"></a><span +class="cmtt-10">\resetacronym </span>and <span +class="cmtt-10">\unsetacronym</span></h4> +<!--l. 520--><p class="noindent" >The <span +class="cmss-10">glossary </span>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 <span +class="cmss-10">glossaries </span>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: +</p><!--l. 525--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\resetacronym</span><a + id="dx1-15001"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + + + + <br /></span> with either - -<P> -<TT><TT>\glsreset{<<I>label</I>>}</TT></TT> -<P> +</p><!--l. 529--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glsreset</span><a + id="dx1-15002"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> or - -<P> -<TT><TT>\glslocalreset{<<I>label</I>>}</TT></TT> -<P> - -<P> -To unset an acronym, you will need to replace: - -<P> -<TT><TT>\unsetacronym{<<I>acr-name</I>>}</TT></TT> -<P> +</p><!--l. 533--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glslocalreset</span><a + id="dx1-15003"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +</p><!--l. 537--><p class="indent" > To unset an acronym, you will need to replace: +</p><!--l. 538--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\unsetacronym</span><a + id="dx1-15004"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">acr-name</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> with either - -<P> -<TT><TT>\glsunset{<<I>label</I>>}</TT></TT> -<P> +</p><!--l. 542--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glsunset</span><a + id="dx1-15005"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> or - -<P> -<TT><TT>\glslocalunset{<<I>label</I>>}</TT></TT> -<P> - -<P> -To reset all acronyms, you will need to replace: - -<P> -<TT><TT>\resetallacronyms</TT></TT> -<P> +</p><!--l. 546--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glslocalunset</span><a + id="dx1-15006"></a><span +class="cmtt-10">{</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">label</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">}</span> + <br /></div><hr> + <br /></span> +</p><!--l. 550--><p class="indent" > To reset all acronyms, you will need to replace: +</p><!--l. 551--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\resetallacronyms</span><a + id="dx1-15007"></a> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\glsresetall</TT>[<TT>\acronymtype</TT>]</TT> -<P> +</p><!--l. 555--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glsresetall</span><a + id="dx1-15008"></a><span +class="cmtt-10">[\acronymtype</span><a + id="dx1-15009"></a><span +class="cmtt-10">]</span> + <br /></div><hr> + <br /></span> + + + or - -<P> -<TT><TT>\glslocalresetall</TT>[<TT>\acronymtype</TT>]</TT> -<P> +</p><!--l. 559--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glslocalresetall</span><a + id="dx1-15010"></a><span +class="cmtt-10">[\acronymtype</span><a + id="dx1-15011"></a><span +class="cmtt-10">]</span> + <br /></div><hr> + <br /></span> To unset all acronyms, you will need to replace: - -<P> -<TT><TT>\unsetallacronyms</TT></TT> -<P> +</p><!--l. 563--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossary</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\unsetallacronyms</span><a + id="dx1-15012"></a> + <br /></div><hr> + <br /></span> with - -<P> -<TT><TT>\glsunsetall</TT>[<TT>\acronymtype</TT>]</TT> -<P> +</p><!--l. 567--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glsunsetall</span><a + id="dx1-15013"></a><span +class="cmtt-10">[\acronymtype</span><a + id="dx1-15014"></a><span +class="cmtt-10">]</span> + <br /></div><hr> + <br /></span> or - -<P> -<TT><TT>\glslocalunsetall</TT>[<TT>\acronymtype</TT>]</TT> -<P> - -<P> - -<H1><A NAME="SECTION00090000000000000000"> -8 Displaying the glossary</A> -</H1> - -<P> -The <TT>glossary</TT> package provides the command <TT>\printglossary</TT> -(or <TT>\print</TT><<I>type</I>> for other glossary types) which -can be used to print individual glossaries. The <TT>glossaries</TT> -package provides the command <TT>\printglossaries</TT> which -will print all the glossaries which have been defined, or -<TT>\printglossary[<<I>options</I>>]</TT> to print individual glossaries. -So if you just have <TT>\printglossary</TT>, then you can leave it as -it is, but if you have, say: -<PRE> +</p><!--l. 571--><p class="indent" > <hr><div><span class="marginpar"><span +class="cmss-10">glossaries</span></span><span class="obeylines-h"> + <span +class="cmtt-10">\glslocalunsetall</span><a + id="dx1-15015"></a><span +class="cmtt-10">[\acronymtype</span><a + id="dx1-15016"></a><span +class="cmtt-10">]</span> + <br /></div><hr> + <br /></span> +</p><!--l. 575--><p class="noindent" > +</p> +<!--l. 575--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">8 </span> <a + id="x1-160008"></a>Displaying the glossary</h3> +<!--l. 577--><p class="noindent" >The <span +class="cmss-10">glossary </span>package provides the command <span +class="cmtt-10">\printglossary</span><a + id="dx1-16001"></a> (or <span +class="cmtt-10">\print</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">type</span><span +class="cmsy-10">⟩ </span>for +other glossary types) which can be used to print individual glossaries. The <span +class="cmss-10">glossaries</span> +package provides the command <span +class="cmtt-10">\printglossaries</span><a + id="dx1-16002"></a> which will print all the glossaries +which have been defined, or <span +class="cmtt-10">\printglossary</span><a + id="dx1-16003"></a><span +class="cmtt-10">[</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">options</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">] </span>to print individual glossaries. +So if you just have <span +class="cmtt-10">\printglossary</span><a + id="dx1-16004"></a>, then you can leave it as it is, but if you have, +say: + + + +</p> + <div class="verbatim" id="verbatim-14"> \printglossary -\printglossary[acronym] -</PRE> -or -<PRE> + <br />\printglossary[acronym] +</div> +<!--l. 588--><p class="nopar" > or + + + +</p> + <div class="verbatim" id="verbatim-15"> \printglossary -\printacronym -</PRE> -then you will need to replace this with either -<PRE> + <br />\printacronym +</div> +<!--l. 593--><p class="nopar" > then you will need to replace this with either + + + +</p> + <div class="verbatim" id="verbatim-16"> \printglossaries -</PRE> -or -<PRE> +</div> +<!--l. 597--><p class="nopar" > or + + + +</p> + <div class="verbatim" id="verbatim-17"> \printglossary -\printglossary[type=\acronymtype] -</PRE> - -<P> -The <TT>glossary</TT> package allows you to specify a short title -(for the table of contents and page header) by defining a command -of the form <TT>\short</TT><<I>glossary-type</I>><TT>name</TT>. The -<TT>glossaries</TT> package doesn't do this, but instead provides -the <TT>toctitle</TT> key which can be used in the optional -argument to <TT>\printglossary</TT>. For example, if you have created -a new glossary type called <TT>notation</TT>, and you had -defined -<PRE> + <br />\printglossary[type=\acronymtype] +</div> +<!--l. 602--><p class="nopar" > +</p><!--l. 604--><p class="indent" > The <span +class="cmss-10">glossary </span>package allows you to specify a short title (for the table of contents and +page header) by defining a command of the form <span +class="cmtt-10">\short</span><span +class="cmsy-10">⟨</span><span +class="cmti-10">glossary-type</span><span +class="cmsy-10">⟩</span><span +class="cmtt-10">name</span>. The +<span +class="cmss-10">glossaries </span>package doesn’t do this, but instead provides the <span +class="cmss-10">toctitle</span><a + id="dx1-16005"></a> key which can be +used in the optional argument to <span +class="cmtt-10">\printglossary</span><a + id="dx1-16006"></a>. For example, if you have created a +new glossary type called <span +class="cmtt-10">notation</span>, and you had defined + + + +</p> + <div class="verbatim" id="verbatim-18"> \newcommand{\shortnotationname}{Notation} -</PRE> -then you would need to use the <TT>toctitle</TT> key: -<PRE> +</div> +<!--l. 614--><p class="nopar" > then you would need to use the <span +class="cmss-10">toctitle</span><a + id="dx1-16007"></a> key: + + + +</p> + <div class="verbatim" id="verbatim-19"> \printglossary[type=notation,toctitle=Notation] -</PRE> -The <TT>glossaries</TT> package will ignore <TT>\shortnotationname</TT>, -so unless you have used it elsewhere in the document, you may -as well remove the definition. - -<P> - -<H1><A NAME="SECTION000100000000000000000"> -9 Processing Your Document</A> -</H1> - -<P> -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 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. 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. - -<P> - -<H1><A NAME="SECTION000110000000000000000"> -10 Troubleshooting</A> -</H1> - -<P> -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. - -<P> -<BR><HR><H4>Footnotes</H4> -<DL> -<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#tex2html4"><SUP>3</SUP></A></DT> -<DD>mainly because having a key value list in -<TT>\glossary</TT> caused problems, but it also helps consistency. - -</DD> -<DT><A NAME="foot594">... directly.</A><A - HREF="glossary2glossaries.html#tex2html5"><SUP>4</SUP></A></DT> -<DD>This is because <TT>\glossary</TT> -requires the argument to be in a specific format and doesn't use the -<<I>key</I>>=<<I>value</I>> 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="foot595">... benefits.</A><A - HREF="glossary2glossaries.html#tex2html6"><SUP>5</SUP></A></DT> -<DD>From -the user's point of view, using <TT>\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> -<BR><HR> - -</BODY> -</HTML> +</div> +<!--l. 618--><p class="nopar" > The <span +class="cmss-10">glossaries </span>package will ignore <span +class="cmtt-10">\shortnotationname</span><a + id="dx1-16008"></a>, so unless you have used it +elsewhere in the document, you may as well remove the definition. +</p><!--l. 623--><p class="noindent" > +</p> +<!--l. 623--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">9 </span> <a + id="x1-170009"></a>Processing Your Document</h3> +<!--l. 625--><p class="noindent" >If you convert your document from using the <span +class="cmss-10">glossary </span>package to the <span +class="cmss-10">glossaries </span>package, +you will need to delete any of the additional files, such as the <span +class="cmtt-10">.glo</span><a + id="dx1-17001"></a> file, that were +created by the <span +class="cmss-10">glossary </span>package, as the <span +class="cmss-10">glossaries </span>package uses a different format. +Remember also, that if you used the <span +class="cmtt-10">makeglos</span><a + id="dx1-17002"></a> Perl script, you will need to use the +<span +class="cmtt-10">makeglossaries</span><a + id="dx1-17003"></a> Perl script instead. As from v1.17, the <span +class="cmss-10">glossaries </span>package +can be used with either <span +class="cmtt-10">makeindex</span><a + id="dx1-17004"></a> or <span +class="cmtt-10">xindy</span><a + id="dx1-17005"></a>. Since <span +class="cmtt-10">xindy</span><a + id="dx1-17006"></a> was designed to be +multilingual, the new <span +class="cmss-10">glossaries </span>package is a much better option for non-English +documents. +</p><!--l. 638--><p class="indent" > For further information on using <span +class="cmtt-10">makeglossaries</span><a + id="dx1-17007"></a>, <span +class="cmtt-10">makeindex</span><a + id="dx1-17008"></a> or <span +class="cmtt-10">xindy</span><a + id="dx1-17009"></a> to create +your glossaries, see <a +href="glossaries-manual.html#sec:makeglossaries" >Generating the Associated Glossary Files</a> of the <span +class="cmss-10">glossaries</span> +documentation. +</p><!--l. 647--><p class="noindent" > +</p> +<!--l. 647--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">10 </span> <a + id="x1-1800010"></a>Troubleshooting</h3> +<!--l. 649--><p class="noindent" >Please check the <a +href="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html" >FAQ</a> for the <span +class="cmss-10">glossaries </span>package if you have any problems. +</p><!--l. 2--><p class="noindent" > +</p> +<!--l. 2--><p class="noindent" ><a +href="#top">Top</a></p><h3 class="likesectionHead"><a + id="x1-1900010"></a>Index</h3> +<!--l. 4--><p class="noindent" > <span +class="cmbx-10">F</span> +</p> + <div class="theindex"><span class="index-item">file types<br /></span> +<span class="index-subitem">    <span +class="cmtt-10">.glo</span>  13 <br /></span> +<p class="theindex"> <span +class="cmbx-10">G</span> +<span class="index-item"><span +class="cmtt-10">\gls </span>options<br /></span> + + + +<span class="index-subitem">    <span +class="cmss-10">counter</span>  7 <br /></span> +<span class="index-subitem">    <span +class="cmss-10">number</span>  7 <br /></span> +<span class="index-item"><span +class="cmtt-10">\glsadd </span>options<br /></span> +<span class="index-subitem">    <span +class="cmss-10">counter</span>  6 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">M</span> +<span class="index-item"><span +class="cmtt-10">makeglos</span>  13 <br /></span> +<span class="index-item"><span +class="cmtt-10">makeglossaries</span>  13 <br /></span> +<span class="index-item"><span +class="cmtt-10">makeindex</span>  2, 6, 7, 13 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">N</span> +<span class="index-item"><span +class="cmtt-10">\newglossaryentry </span>options<br /></span> +<span class="index-subitem">    <span +class="cmss-10">description</span>  8 <br /></span> +<span class="index-subitem">    <span +class="cmss-10">name</span>  8 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">P</span> +<span class="index-item">package options:<br /></span> +<span class="index-subitem">    <span +class="cmss-10">description</span>  <span class="underline">8</span> <br /></span> +<span class="index-item"><span +class="cmtt-10">\printglossary </span>options<br /></span> +<span class="index-subitem">    <span +class="cmss-10">style</span>  4 <br /></span> +<span class="index-subitem">    <span +class="cmss-10">toctitle</span>  4, 12 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">S</span> +<span class="index-item"><span +class="cmtt-10">\storeglosentry </span>options<br /></span> +<span class="index-subitem">    <span +class="cmss-10">format</span>  6 <br /></span> +<span class="index-subitem">    <span +class="cmss-10">number</span>  6 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">U</span> +<span class="index-item"><span +class="cmtt-10">\useglosentry </span>options<br /></span> +<span class="index-subitem">    <span +class="cmss-10">format</span>  6 <br /></span> +<span class="index-subitem">    <span +class="cmss-10">number</span>  6 <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">X</span> +<span class="index-item"><span +class="cmtt-10">xindy</span>  2, 7, 13 <br /></span> +</p></div> + + + + <div class="footnotes"><!--l. 68--><p class="noindent" ><span class="footnote-mark"><a +href="#fn1x0-bk" id="fn1x0"><sup class="textsuperscript">1</sup></a></span><span +class="cmr-8">as from v1.17. Previous versions were designed to be used with </span><span +class="cmtt-8">makeindex</span><a + id="dx1-2002"></a> <span +class="cmr-8">only</span></p> +<!--l. 83--><p class="noindent" ><span class="footnote-mark"><a +href="#fn2x0-bk" id="fn2x0"><sup class="textsuperscript">2</sup></a></span><span +class="cmr-8">as from v1.17</span></p><!--l. 220--><p class="indent" > <span class="footnote-mark"><a +href="#fn3x0-bk" id="fn3x0"><sup class="textsuperscript">3</sup></a></span><span +class="cmr-8">mainly because having a key value list in </span><span +class="cmtt-8">\glossary</span><a + id="dx1-6003"></a> <span +class="cmr-8">caused problems, but it also helps</span> +<span +class="cmr-8">consistency.</span></p> +<!--l. 334--><p class="indent" > <span class="footnote-mark"><a +href="#fn4x0-bk" id="fn4x0"><sup class="textsuperscript">4</sup></a></span><span +class="cmr-8">This is because </span><span +class="cmtt-8">\glossary</span><a + id="dx1-11003"></a> <span +class="cmr-8">requires the argument to be in a specific format and doesn’t use the</span> +<span +class="cmsy-8">⟨</span><span +class="cmti-8">key</span><span +class="cmsy-8">⟩</span><span +class="cmr-8">=</span><span +class="cmsy-8">⟨</span><span +class="cmti-8">value</span><span +class="cmsy-8">⟩ </span><span +class="cmr-8">format that the old glossary package used. The new package’s internal commands set</span> +<span +class="cmr-8">this format, as well as escaping any of </span><span +class="cmtt-8">makeindex</span><a + id="dx1-11004"></a><span +class="cmr-8">’s or </span><span +class="cmtt-8">xindy</span><a + id="dx1-11005"></a><span +class="cmr-8">’s special characters. What’s more, the</span> +<span +class="cmr-8">format has changed as from v1.17 to allow the new package to be used with either </span><span +class="cmtt-8">makeindex</span><a + id="dx1-11006"></a> <span +class="cmr-8">or</span> +<span +class="cmtt-8">xindy</span><a + id="dx1-11007"></a><span +class="cmr-8">.</span></p> +<!--l. 343--><p class="indent" > <span class="footnote-mark"><a +href="#fn5x0-bk" id="fn5x0"><sup class="textsuperscript">5</sup></a></span><span +class="cmr-8">From the user’s point of view, using </span><span +class="cmtt-8">\glossary</span><a + id="dx1-11011"></a> <span +class="cmr-8">throughout the document is time consuming,</span> +<span +class="cmr-8">and if you use it more than once for the same term, there’s a chance extra spaces may creep in which</span> +<span +class="cmr-8">will cause </span><span +class="cmtt-8">makeindex</span><a + id="dx1-11012"></a> <span +class="cmr-8">to treat the two entries as different terms, even though they look the same in the</span> +<span +class="cmr-8">document.</span></p> </div> + +</body></html> + + + + |