diff options
| author | Karl Berry <karl@freefriends.org> | 2006-07-10 22:34:51 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2006-07-10 22:34:51 +0000 |
| commit | 102bce50404c6f184c8dcea9c9f3910081cd5589 (patch) | |
| tree | 0884f04c8f57ebb931ec49dc171a8b2ed4983617 /Master | |
| parent | 8abaae73c1bd5624110e77ebafcfba25e7d0694e (diff) | |
glossary update (11jul06)
git-svn-id: svn://tug.org/texlive/trunk@1811 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
20 files changed, 2333 insertions, 1239 deletions
diff --git a/Master/texmf-dist/doc/latex/glossary/CHANGES b/Master/texmf-dist/doc/latex/glossary/CHANGES new file mode 100644 index 00000000000..d3b795cf21f --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossary/CHANGES @@ -0,0 +1,97 @@ +glossary.sty history: + + * Version 2.38: fixed by where inappropriate spaces are + inserted when using xspace package. + + * Version 2.37: fixed hypertoc to work with sections + + * Version 2.36: added \useglosentry{*}. Fixed bug which + allowed a pagebreak to occur between entry name and + entry description when using the altlist style. + + * Version 2.35: fixed makeglos.bat + + * Version 2.34: \acronymname now defined using + \providecommand instead of \newcommand. Fixed bug + that prevented redefinition of \glossaryalignment. + + * Version 2.33: fixed bug that occurs when a comma is + used in the description field of \newacronym. + + * Version 2.32: added \setacronymdescfmt. (Makes it + easier to align the list of acronyms with + acronym in one column and the long name in the + second column.) + + * Version 2.31: added global package option. Added + \unsetacronym and \unsetallacronyms. + + * Version 2.3: Made it easier to have multiple glossaries + with different styles within the same document. Added + facility for inserting text before and after the list of + page numbers. + + * Version 2.26: Fixed bug in \useacronym (optional argument + was ignored in certain situations). + + * Version 2.25: Minor bug fix (missing page delimiters). + + * Version 2.24: Added hypertoc option, and changed the + hyperlink targets in the glossary entries. + + * Version 2.23: Fixed bug in hyperlinks caused by \glsxspace. + + * Version 2.22: Added acronymfont. Added xspace support. + Changed makeglos.pl so that it reads information from + auxiliary file. Added makeglos.bat file + + * Version 2.21: Added \resetallacronyms + + * Version 2.2: \glossaryname is now defined using + \providecommand instead of \newcommand. Checks if + theglossary environment is already defined, and if so + redefines it and issues a warning. + + * Version 2.19: fixed bug in \storeglosentry. + + * Version 2.18: fixed bug in \useacronym. Added \gls. + + * Version 2.17: added acronym package option. Added + \storeglosentry (replacing old \saveglosentry command) + + * Version 2.16: fixed bug preventing changes to \glossaryname + and \shortglossary name from having an effect. + + * Version 2.15: added \shortglossaryname (for page header and + table of contents) + + * Version 2.14: added LaTeX2HTML support, added \xglossary + command (provides hyperlink to relevent entry in the + glossary), added -m switch to makeglos.pl (merges multiple + entries with the same name but different descriptions). + + * Version 2.13: added extra package option "hyperacronym". + + * Version 2.12: mostly bug fixes, also added extra package + option "section". + + * Version 2.11: starred form of acronym defined. Added + \useacronym. + + * Version 2.1: fixed conflict with array package. Fixed + problems which occured when using certain commands (such as + \cite) in the last argument of \newacronym. + + * Version 2.01: fixed conflict with datetime package. + + * Version 2.0: provides the command \newacronym to define + acronyms. Additional package options "toc" (add glossary to + table of contents) and "hyper" use hyperlinks in the + glossary. + + * Version 1.1: provides the additional package option + "number" which sets the associated glossary entry number to + the page number (default), the section number or no number. + Also provides the additional commands \glossarypreamble and + \glossarypostamble + diff --git a/Master/texmf-dist/doc/latex/glossary/README b/Master/texmf-dist/doc/latex/glossary/README index 1a35ffe5cac..976a19f6743 100644 --- a/Master/texmf-dist/doc/latex/glossary/README +++ b/Master/texmf-dist/doc/latex/glossary/README @@ -1,6 +1,6 @@ -LaTeX Package : glossary v 2.24
+LaTeX Package : glossary v 2.38
-Last Modified : 27th Sept 2005
+Last Modified : 9th July 2006
Author : Nicola Talbot
diff --git a/Master/texmf-dist/doc/latex/glossary/glossary.pdf b/Master/texmf-dist/doc/latex/glossary/glossary.pdf Binary files differindex 6afb04d2c4f..b9251bbad73 100644 --- a/Master/texmf-dist/doc/latex/glossary/glossary.pdf +++ b/Master/texmf-dist/doc/latex/glossary/glossary.pdf diff --git a/Master/texmf-dist/doc/latex/glossary/glossary.perl b/Master/texmf-dist/doc/latex/glossary/glossary.perl index 6013c1edce2..b0de72c074c 100644 --- a/Master/texmf-dist/doc/latex/glossary/glossary.perl +++ b/Master/texmf-dist/doc/latex/glossary/glossary.perl @@ -1,7 +1,7 @@ # File : glossary.perl # Author : Nicola Talbot -# Date : 8 July 2005 -# Version : 1.02 +# Date : 5 December 2005 +# Version : 1.03 # Description : LaTeX2HTML implementation of glossary package. package main; @@ -771,6 +771,36 @@ sub do_cmd_resetallacronyms{ $_; } +sub do_cmd_unsetacronym{ + local($_) = @_; + local($cmdname); + + $cmdname = &missing_braces unless + (s/$next_pair_pr_rx/$cmdname=$2;''/eo); + + if (defined %{$acronym{$cmdname}}) + { + $global{"${cmdname}first"} = 0; + } + else + { + &write_warnings("acronym '$cmdname' not defined"); + } + + $_; +} + +sub do_cmd_unsetallacronyms{ + local($_) = @_; + + foreach $key (keys %acronym) + { + $global{"${key}first"} = 0; + } + + $_; +} + %savedglosentry = (); # This command is deprecated diff --git a/Master/texmf-dist/doc/latex/glossary/makeglos.bat b/Master/texmf-dist/doc/latex/glossary/makeglos.bat index ab83c738703..35dffccdca3 100644 --- a/Master/texmf-dist/doc/latex/glossary/makeglos.bat +++ b/Master/texmf-dist/doc/latex/glossary/makeglos.bat @@ -1,3 +1,3 @@ @rem = '-*- Perl -*-
@echo off
-perl -S %0.pl %1 %2 %3 %4 %5 %6 %7 %8 %9
+perl -S %~dp0makeglos.pl %*
diff --git a/Master/texmf-dist/doc/latex/glossary/makeglos.pl b/Master/texmf-dist/doc/latex/glossary/makeglos.pl index 77075e46c28..456001bc7fb 100644 --- a/Master/texmf-dist/doc/latex/glossary/makeglos.pl +++ b/Master/texmf-dist/doc/latex/glossary/makeglos.pl @@ -2,7 +2,7 @@ # File : makeglos # Author : Nicola Talbot -# Version : 1.3 (2005/06/28) +# Version : 1.4 (2005/11/19) # Description: simple Perl script that calls makeindex. # Intended for use with "glossary.sty" (saves having to remember # all the various switches) @@ -279,6 +279,11 @@ sub makeindex{ for ($i=0; $i <= $j; $i++) { + # remove all but the last \delimT + while ($item[$i]{'desc'}=~s/\\delimT/$&/sg > 1) + { + $item[$i]{'desc'}=~s/\\delimT//s; + } print OUTPUT "\\gloitem ", $item[$i]{'name'}, $item[$i]{'desc'}; } diff --git a/Master/texmf-dist/doc/latex/glossary/manual.html b/Master/texmf-dist/doc/latex/glossary/manual.html index da5650e9e76..2f01d8d2b57 100644 --- a/Master/texmf-dist/doc/latex/glossary/manual.html +++ b/Master/texmf-dist/doc/latex/glossary/manual.html @@ -1,22 +1,19 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!--Converted with jLaTeX2HTML 2002-2-1 (1.70) JA patch-2.0 -patched version by: Kenshi Muto, Debian Project. -* modified by: Shige TAKENO -LaTeX2HTML 2002-2-1 (1.70), +<!--Converted with LaTeX2HTML 2002-2-1 (1.70) 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>glossary.sty v 2.24: LaTeX2e Package to Assist Generating Glossaries</TITLE> -<META NAME="description" CONTENT="glossary.sty v 2.24: LaTeX2e Package to Assist Generating Glossaries"> +<TITLE>glossary.sty v 2.38: LaTeX2e Package to Assist Generating Glossaries</TITLE> +<META NAME="description" CONTENT="glossary.sty v 2.38: LaTeX2e Package to Assist Generating Glossaries"> <META NAME="keywords" CONTENT="manual"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> -<META NAME="Generator" CONTENT="jLaTeX2HTML v2002-2-1 JA patch-2.0"> +<META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1"> <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> @@ -26,11 +23,11 @@ original version by: Nikos Drakos, CBLU, University of Leeds <P> - <H1 ALIGN="CENTER">glossary.sty v 2.24: LaTeX2e Package to Assist Generating Glossaries</H1> + <H1 ALIGN="CENTER">glossary.sty v 2.38: LaTeX2e Package to Assist Generating Glossaries</H1> <DIV> <P ALIGN="CENTER"><STRONG>Nicola L.C. Talbot</STRONG></P> -<P ALIGN="CENTER"><STRONG>27th September 2005</STRONG></P> +<P ALIGN="CENTER"><STRONG>9th July 2006</STRONG></P> </DIV> <BR> @@ -40,57 +37,57 @@ Contents</A> <!--Table of Contents--> <UL> -<LI><A NAME="tex2html29" +<LI><A NAME="tex2html31" HREF="manual.html#SECTION00020000000000000000">Introduction</A> -<LI><A NAME="tex2html30" +<LI><A NAME="tex2html32" HREF="manual.html#SECTION00030000000000000000">Installation</A> -<LI><A NAME="tex2html31" +<LI><A NAME="tex2html33" HREF="manual.html#SECTION00040000000000000000">Generating Glossary Information</A> <UL> -<LI><A NAME="tex2html32" +<LI><A NAME="tex2html34" HREF="manual.html#SECTION00041000000000000000">Storing Glossary Information</A> </UL> <BR> -<LI><A NAME="tex2html33" +<LI><A NAME="tex2html35" HREF="manual.html#SECTION00050000000000000000">makeglos.pl</A> -<LI><A NAME="tex2html34" +<LI><A NAME="tex2html36" HREF="manual.html#SECTION00060000000000000000">Displaying the Glossary</A> -<LI><A NAME="tex2html35" +<LI><A NAME="tex2html37" HREF="manual.html#SECTION00070000000000000000">Package Options</A> <UL> -<LI><A NAME="tex2html36" +<LI><A NAME="tex2html38" HREF="manual.html#SECTION00071000000000000000">Examples</A> </UL> <BR> -<LI><A NAME="tex2html37" +<LI><A NAME="tex2html39" HREF="manual.html#SECTION00080000000000000000">Defining New Glossary Types</A> -<LI><A NAME="tex2html38" +<LI><A NAME="tex2html40" HREF="manual.html#SECTION00090000000000000000">Acronyms</A> <UL> -<LI><A NAME="tex2html39" +<LI><A NAME="tex2html41" HREF="manual.html#SECTION00091000000000000000">Examples</A> </UL> <BR> -<LI><A NAME="tex2html40" +<LI><A NAME="tex2html42" HREF="manual.html#SECTION000100000000000000000">Customizing the Glossary</A> -<LI><A NAME="tex2html41" +<LI><A NAME="tex2html43" HREF="manual.html#SECTION000110000000000000000">Sample Documents</A> -<LI><A NAME="tex2html42" +<LI><A NAME="tex2html44" HREF="manual.html#SECTION000120000000000000000">LaTeX2HTML Style File</A> <UL> -<LI><A NAME="tex2html43" +<LI><A NAME="tex2html45" HREF="manual.html#SECTION000121000000000000000">Limitations</A> </UL> <BR> -<LI><A NAME="tex2html44" +<LI><A NAME="tex2html46" HREF="manual.html#SECTION000130000000000000000">Troubleshooting</A> -<LI><A NAME="tex2html45" +<LI><A NAME="tex2html47" HREF="manual.html#SECTION000140000000000000000">Obsolete Commands</A> -<LI><A NAME="tex2html46" +<LI><A NAME="tex2html48" HREF="manual.html#SECTION000150000000000000000">Contact Details</A> -<LI><A NAME="tex2html47" +<LI><A NAME="tex2html49" HREF="manual.html#SECTION000160000000000000000">Acknowledgements</A> -<LI><A NAME="tex2html48" +<LI><A NAME="tex2html50" HREF="manual.html#SECTION000170000000000000000">Index</A> </UL> <!--End of Table of Contents--> @@ -100,7 +97,7 @@ Contents</A> Introduction</A> </H1> - The <TT>glossary</TT><A NAME="1481"></A> package is provided to assist + The <TT>glossary</TT><A NAME="1609"></A> package is provided to assist generating a glossary. It has a certain amount of flexibility, allowing the user to customize the format of the glossary, and define new glossary-style objects. @@ -137,7 +134,7 @@ should be placed somewhere in the LaTeX path, e.g. <TT>glossary.perl</TT> is a LaTeX2HTML style file, and should be placed in the LaTeX2HTML style file directory (usually <TT>latex2html/styles/</TT>). The file <TT>makeglos.pl</TT> -is a Perl script which calls <TT>makeindex</TT><A NAME="1484"></A>. If you are +is a Perl script which calls <TT>makeindex</TT><A NAME="1612"></A>. If you are using UNIX or Linux, you will need to set the permissions so that you can execute the file: <PRE> @@ -145,8 +142,8 @@ chmod a+x makeglos.pl </PRE> You should then place this file somewhere on your path. (You may also need to edit the first line of -this file, if <TT>perl</TT><A NAME="1487"></A> is located in a directory other than <code>/usr/bin/</code><A NAME="tex2html1" - HREF="#foot1364"><SUP>1</SUP></A>.) +this file, if <TT>perl</TT><A NAME="1615"></A> is located in a directory other than <code>/usr/bin/</code><A NAME="tex2html1" + HREF="#foot1488"><SUP>1</SUP></A>.) <P> If you are not using UNIX or Linux, you may have to explicitly @@ -157,16 +154,21 @@ is provided which will run Perl on <TT>makeglos.pl</TT>. Both <TT>makeglos.pl</TT> and <TT>makeglos.bat</TT> should be placed somewhere specified by the PATH environment variable. (For example, put them both in the same -directory as <TT>makeindex</TT><A NAME="1490"></A>, which will probably +directory as <TT>makeindex</TT><A NAME="1618"></A>, which will probably be in <code>\texmf\miktex\bin\</code>). <P> If you don't have Perl installed on your system, you can just use -<TT>makeindex</TT><A NAME="1493"></A>, only you will have to remember all the +<TT>makeindex</TT><A NAME="1621"></A>, only you will have to remember all the command line switches, and you won't be able to merge entries that have the same name, but different descriptions. <P> +Note that if you are updating the glossary package, it is +a good idea to update <TT>makeglos.pl</TT> as it may also +have been modified. + +<P> <H1><A NAME="SECTION00040000000000000000"> Generating Glossary Information</A> @@ -189,16 +191,16 @@ available: <TR><TH ALIGN="LEFT"><B>Key </B></TH> <TH ALIGN="LEFT"><B>Value</B></TH> </TR> -<TR><TD ALIGN="LEFT"><TT><TT>name</TT><A NAME="1506"></A> </TT></TD> +<TR><TD ALIGN="LEFT"><TT><TT>name</TT><A NAME="1634"></A> </TT></TD> <TD ALIGN="LEFT">The entry name</TD> </TR> -<TR><TD ALIGN="LEFT"><TT><TT>description</TT><A NAME="1510"></A> </TT></TD> +<TR><TD ALIGN="LEFT"><TT><TT>description</TT><A NAME="1638"></A> </TT></TD> <TD ALIGN="LEFT">A description about the entry</TD> </TR> -<TR><TD ALIGN="LEFT"><TT><TT>sort</TT><A NAME="1514"></A> </TT></TD> +<TR><TD ALIGN="LEFT"><TT><TT>sort</TT><A NAME="1642"></A> </TT></TD> <TD ALIGN="LEFT">How to sort the entry. (Entry name used if sort omitted)</TD> </TR> -<TR><TD ALIGN="LEFT"><TT><TT>format</TT><A NAME="1518"></A> </TT></TD> +<TR><TD ALIGN="LEFT"><TT><TT>format</TT><A NAME="1646"></A> </TT></TD> <TD ALIGN="LEFT">How to format the page number</TD> </TR> </TABLE> @@ -216,7 +218,7 @@ For example: sort=U} </PRE> The page format for individual entries can be changed using the -<TT>format</TT><A NAME="1522"></A> key. This should be the name of a LaTeX +<TT>format</TT><A NAME="1650"></A> key. This should be the name of a LaTeX formatting command without the preceding <code>\</code> (as with the <code>|</code> operator in <TT>\index</TT>.) For example: <PRE> @@ -229,29 +231,29 @@ In addition, the following formats are also available: <DIV ALIGN="CENTER"> <TABLE CELLPADDING=3> -<TR><TD ALIGN="LEFT"><TT>hyperrm</TT><A NAME="1528"></A><A NAME="1529"></A></TD> +<TR><TD ALIGN="LEFT"><TT>hyperrm</TT><A NAME="1656"></A><A NAME="1657"></A></TD> <TD ALIGN="LEFT">The number is a hyper link in roman</TD> </TR> -<TR><TD ALIGN="LEFT"><TT>hypersf</TT><A NAME="1533"></A><A NAME="1534"></A></TD> +<TR><TD ALIGN="LEFT"><TT>hypersf</TT><A NAME="1661"></A><A NAME="1662"></A></TD> <TD ALIGN="LEFT">The number is a hyper link in sans-serif</TD> </TR> -<TR><TD ALIGN="LEFT"><TT>hypertt</TT><A NAME="1538"></A><A NAME="1539"></A></TD> +<TR><TD ALIGN="LEFT"><TT>hypertt</TT><A NAME="1666"></A><A NAME="1667"></A></TD> <TD ALIGN="LEFT">The number is a hyper link in typewriter font</TD> </TR> -<TR><TD ALIGN="LEFT"><TT>hyperbf</TT><A NAME="1543"></A><A NAME="1544"></A></TD> +<TR><TD ALIGN="LEFT"><TT>hyperbf</TT><A NAME="1671"></A><A NAME="1672"></A></TD> <TD ALIGN="LEFT">The number is a hyper link in bold</TD> </TR> -<TR><TD ALIGN="LEFT"><TT>hyperit</TT><A NAME="1548"></A><A NAME="1549"></A></TD> +<TR><TD ALIGN="LEFT"><TT>hyperit</TT><A NAME="1676"></A><A NAME="1677"></A></TD> <TD ALIGN="LEFT">The number is a hyper link in italic</TD> </TR> </TABLE> </DIV> -If the <TT>hyper</TT><A NAME="1558"></A> option has not been set, -<TT>hyperrm</TT><A NAME="1562"></A><A NAME="1563"></A> etc are equivalent to <TT>textrm</TT> etc. -You should use <TT>\hyperrm</TT><A NAME="1567"></A> instead of +If the <TT>hyper</TT><A NAME="1686"></A> option has not been set, +<TT>hyperrm</TT><A NAME="1690"></A><A NAME="1691"></A> etc are equivalent to <TT>textrm</TT> etc. +You should use <TT>\hyperrm</TT><A NAME="1695"></A> instead of <TT>\hyperpage</TT>, as <TT>\hyperpage</TT> won't work on a list or range of numbers in the glossary<A NAME="tex2html2" - HREF="#foot1367"><SUP>2</SUP></A>. + HREF="#foot1491"><SUP>2</SUP></A>. <P> As with the <TT>\index</TT> command, care must be taken if you @@ -274,7 +276,7 @@ As from version 2.14, there is an additional command available: <P> This is equivalent to -<I>text</I><TT>\glossary</TT><A NAME="1584"></A><code>{</code><I>gls-entry</I><code>}</code>, +<I>text</I><TT>\glossary</TT><A NAME="1712"></A><code>{</code><I>gls-entry</I><code>}</code>, where <I>text</I> will be made a hyperlink to the relevant entry in the glossary, if hyper links are supported. @@ -326,7 +328,7 @@ can instead store the information: </PRE> (Note the use of <TT>\protect</TT>.) Now, instead of continually copying and pasting the glossary command for this entry (which -can have quite a large <TT>description</TT><A NAME="1607"></A> field), you can use either: +can have quite a large <TT>description</TT><A NAME="1735"></A> field), you can use either: <PRE> \useglosentry{glos:U} </PRE> @@ -379,6 +381,12 @@ fragile, care should be taken when using commands within its argument. If in doubt, use <TT>\protect</TT>. <P> +As from version 2.36, if you want to use all glossary entries +which have been defined using <TT>\storeglosentry</TT>, do: +<code>\useglosentry{*}</code>. (Note that this option is not +available for <TT>\useGlosentry</TT> and <TT>\gls</TT>.) + +<P> <H1><A NAME="SECTION00050000000000000000"> makeglos.pl</A> @@ -387,29 +395,29 @@ makeglos.pl</A> <P> The glossary information (as given by the commands <TT>\glossary</TT> and <TT>\xglossary</TT>) is saved in the file -with the extension <TT>glo</TT><A NAME="1619"></A> (unless the -<TT>\makeglossary</TT><A NAME="1621"></A> command is omitted, in which case the -glossary information is simply ignored.) A <TT>makeindex</TT><A NAME="1626"></A> -style file<A NAME="1382"></A> -(<TT>ist</TT><A NAME="1629"></A>) is also created, which is customized for the -document, and can be passed to <TT>makeindex</TT><A NAME="1631"></A>. +with the extension <TT>glo</TT><A NAME="1753"></A> (unless the +<TT>\makeglossary</TT><A NAME="1755"></A> command is omitted, in which case the +glossary information is simply ignored.) A <TT>makeindex</TT><A NAME="1760"></A> +style file<A NAME="1506"></A> +(<TT>ist</TT><A NAME="1763"></A>) is also created, which is customized for the +document, and can be passed to <TT>makeindex</TT><A NAME="1765"></A>. <P> For example, suppose your document is called <TT>mydoc.tex</TT>, the glossary will be saved in the file -<TT>mydoc.glo</TT><A NAME="1634"></A>, and the <TT>makeindex</TT><A NAME="1636"></A> style -file <TT>mydoc.ist</TT><A NAME="1639"></A> will be created. - These files can then be passed to <TT>makeindex</TT><A NAME="1641"></A> as follows: +<TT>mydoc.glo</TT><A NAME="1768"></A>, and the <TT>makeindex</TT><A NAME="1770"></A> style +file <TT>mydoc.ist</TT><A NAME="1773"></A> will be created. + These files can then be passed to <TT>makeindex</TT><A NAME="1775"></A> as follows: <PRE> makeindex -s mydoc.ist -t mydoc.glg -o mydoc.gls mydoc.glo </PRE> -which generates the output file <TT>mydoc.gls</TT><A NAME="1644"></A>, +which generates the output file <TT>mydoc.gls</TT><A NAME="1778"></A>, with transcript written to -<TT>mydoc.glg</TT><A NAME="1646"></A>. +<TT>mydoc.glg</TT><A NAME="1780"></A>. <P> -The Perl script <TT>makeglos.pl</TT><A NAME="1648"></A> provided with this package -allows you to use <TT>makeindex</TT><A NAME="1651"></A> without having to remember +The Perl script <TT>makeglos.pl</TT><A NAME="1782"></A> provided with this package +allows you to use <TT>makeindex</TT><A NAME="1785"></A> without having to remember all the command line options. The command <PRE> makeglos.pl mydoc.glo @@ -418,47 +426,47 @@ will perform the command: <PRE> makeindex -s mydoc.ist -t mydoc.glg -o mydoc.gls mydoc.glo </PRE> -The <TT>glo</TT><A NAME="1654"></A> extension may be omitted. In addition, -<TT>makeglos.pl</TT><A NAME="1656"></A> also takes the option +The <TT>glo</TT><A NAME="1788"></A> extension may be omitted. In addition, +<TT>makeglos.pl</TT><A NAME="1790"></A> also takes the option <TT>-m</TT> which can be used to collate entries where the same name has multiple descriptions. <P> -<TT>makeglos.pl</TT><A NAME="1659"></A> has the following syntax: +<TT>makeglos.pl</TT><A NAME="1793"></A> has the following syntax: <PRE> makeglos.pl [-ilqrgm] [-s sty] [-o gls] [-t log] [-p num] <filename> </PRE> where all switches, apart from <TT>-m</TT> are the same as -those for <TT>makeindex</TT><A NAME="1662"></A>. In addition, if the extension -to the input file name is omitted, <TT>glo</TT><A NAME="1665"></A> will be +those for <TT>makeindex</TT><A NAME="1796"></A>. In addition, if the extension +to the input file name is omitted, <TT>glo</TT><A NAME="1799"></A> will be assumed. If there are multiple glossary types (see <A HREF="#sec:newglostype">later</A>) -and the file extension is omitted, <TT>makeglos.pl</TT><A NAME="1667"></A> will +and the file extension is omitted, <TT>makeglos.pl</TT><A NAME="1801"></A> will iterate through each glossary type. <P> -The name of the <TT>ist</TT><A NAME="1670"></A> file can be changed by redefining +The name of the <TT>ist</TT><A NAME="1804"></A> file can be changed by redefining the command <TT>\istfilename</TT>. For example: <PRE> \renewcommand{\istfilename}{foo.ist} </PRE> However, you will need to explicitly pass the name of this -file to <TT>makeglos.pl</TT><A NAME="1674"></A> using the <TT>-s</TT> switch. +file to <TT>makeglos.pl</TT><A NAME="1808"></A> using the <TT>-s</TT> switch. <P> -Creation of the <TT>ist</TT><A NAME="1677"></A> file can be suppressed by issuing +Creation of the <TT>ist</TT><A NAME="1811"></A> file can be suppressed by issuing the command <TT>\noist</TT> before -<TT>\makeglossary</TT><A NAME="1681"></A>. It will also be suppressed when the -command <TT>\nofiles</TT><A NAME="1686"></A> is used, or if the command -<TT>\makeglossary</TT><A NAME="1691"></A> is omitted. +<TT>\makeglossary</TT><A NAME="1815"></A>. It will also be suppressed when the +command <TT>\nofiles</TT><A NAME="1820"></A> is used, or if the command +<TT>\makeglossary</TT><A NAME="1825"></A> is omitted. <P> It should be noted that there are a few packages that can -cause problems with the creation of the <TT>ist</TT><A NAME="1696"></A> file, -for example <TT>ngerman</TT><A NAME="1698"></A>. If you encounter problems -when LaTeX is processing the <TT>\makeglossary</TT><A NAME="1701"></A> command, -or if you get errors from <TT>makeindex</TT><A NAME="1706"></A> complaining about +cause problems with the creation of the <TT>ist</TT><A NAME="1830"></A> file, +for example <TT>ngerman</TT><A NAME="1832"></A>. If you encounter problems +when LaTeX is processing the <TT>\makeglossary</TT><A NAME="1835"></A> command, +or if you get errors from <TT>makeindex</TT><A NAME="1840"></A> complaining about the style file, this is the most probable cause. See <A HREF="#itm:ngerman">later</A> for information on how to fix this. @@ -470,12 +478,12 @@ Displaying the Glossary</A> </H1> <P> -Once the <TT>gls</TT><A NAME="1709"></A> file has been created by -<TT>makeindex</TT><A NAME="1711"></A> (as described in the previous +Once the <TT>gls</TT><A NAME="1843"></A> file has been created by +<TT>makeindex</TT><A NAME="1845"></A> (as described in the previous section) the glossary can then be included in the document with the command <TT>\printglossary</TT>. If chapters are defined, the glossary will start -with<A NAME="1715"></A> +with<A NAME="1849"></A> <PRE> \chapter*{\glossaryname} </PRE> @@ -488,33 +496,35 @@ options passed to the package. <P> -<H1><A NAME="SECTION00070000000000000000"> -Package Options</A> +<H1><A NAME="SECTION00070000000000000000"></A> +<A NAME="sec:options"></A> +<BR> +Package Options </H1> <P> The package options must be specified as a comma-separated list of <I>key</I>=<I>value</I> pairs. Available options are: <DL> -<DT><STRONG><TT>style</TT><A NAME="1724"></A></STRONG></DT> +<DT><STRONG><TT>style</TT><A NAME="1858"></A></STRONG></DT> <DD>The glossary style. Values: -<A NAME="1387"></A> +<A NAME="1511"></A> <DL> -<DT><STRONG><TT>list</TT><A NAME="1728"></A></STRONG></DT> +<DT><STRONG><TT>list</TT><A NAME="1862"></A></STRONG></DT> <DD>use <TT>description</TT> environment in the glossary </DD> -<DT><STRONG><TT>altlist</TT><A NAME="1731"></A></STRONG></DT> +<DT><STRONG><TT>altlist</TT><A NAME="1865"></A></STRONG></DT> <DD>modified -version of <TT>style=list</TT><A NAME="1740"></A>. The description starts on the +version of <TT>style=list</TT><A NAME="1874"></A>. The description starts on the line following the name of the term being defined. </DD> -<DT><STRONG><TT>super</TT><A NAME="1742"></A></STRONG></DT> +<DT><STRONG><TT>super</TT><A NAME="1876"></A></STRONG></DT> <DD>use <TT>supertabular</TT> environment in the glossary </DD> -<DT><STRONG><TT>long</TT><A NAME="1745"></A></STRONG></DT> +<DT><STRONG><TT>long</TT><A NAME="1879"></A></STRONG></DT> <DD>use <TT>longtable</TT> environment in the glossary (Default) </DD> @@ -522,15 +532,15 @@ line following the name of the term being defined. <P> </DD> -<DT><STRONG><TT>header</TT><A NAME="1753"></A></STRONG></DT> -<DD><A NAME="1389"></A> Glossary +<DT><STRONG><TT>header</TT><A NAME="1887"></A></STRONG></DT> +<DD><A NAME="1513"></A> Glossary header. Values: <DL> -<DT><STRONG><TT>none</TT><A NAME="1757"></A></STRONG></DT> +<DT><STRONG><TT>none</TT><A NAME="1891"></A></STRONG></DT> <DD>The glossary doesn't have a heading (Default) </DD> -<DT><STRONG><TT>plain</TT><A NAME="1759"></A></STRONG></DT> +<DT><STRONG><TT>plain</TT><A NAME="1893"></A></STRONG></DT> <DD>The glossary has a heading </DD> @@ -538,15 +548,15 @@ has a heading <P> </DD> -<DT><STRONG><TT>border</TT><A NAME="1766"></A></STRONG></DT> -<DD><A NAME="1390"></A> Glossary +<DT><STRONG><TT>border</TT><A NAME="1900"></A></STRONG></DT> +<DD><A NAME="1514"></A> Glossary border. Values: <DL> -<DT><STRONG><TT>none</TT><A NAME="1770"></A></STRONG></DT> +<DT><STRONG><TT>none</TT><A NAME="1904"></A></STRONG></DT> <DD>The glossary doesn't have a border (Default) </DD> -<DT><STRONG><TT>plain</TT><A NAME="1772"></A></STRONG></DT> +<DT><STRONG><TT>plain</TT><A NAME="1906"></A></STRONG></DT> <DD>Border around the main body of the glossary </DD> @@ -554,16 +564,16 @@ around the main body of the glossary <P> </DD> -<DT><STRONG><TT>cols</TT><A NAME="1779"></A></STRONG></DT> -<DD><A NAME="1391"></A> Number of +<DT><STRONG><TT>cols</TT><A NAME="1913"></A></STRONG></DT> +<DD><A NAME="1515"></A> Number of columns. Values: <DL> -<DT><STRONG><TT>2</TT><A NAME="1783"></A></STRONG></DT> +<DT><STRONG><TT>2</TT><A NAME="1917"></A></STRONG></DT> <DD>The entry name and description are in two separate columns with the associated page numbers in the same column as the description. (Default) </DD> -<DT><STRONG><TT>3</TT><A NAME="1785"></A></STRONG></DT> +<DT><STRONG><TT>3</TT><A NAME="1919"></A></STRONG></DT> <DD>The entry name, description and associated page numbers are in three separate columns. </DD> @@ -572,18 +582,18 @@ are in three separate columns. <P> </DD> -<DT><STRONG><TT>number</TT><A NAME="1792"></A></STRONG></DT> +<DT><STRONG><TT>number</TT><A NAME="1926"></A></STRONG></DT> <DD>Associated number corresponding to each entry. Values: <DL> -<DT><STRONG><TT>page</TT><A NAME="1796"></A></STRONG></DT> +<DT><STRONG><TT>page</TT><A NAME="1930"></A></STRONG></DT> <DD>Each entry has the corresponding page number(s) where the entry is defined. (Default) </DD> -<DT><STRONG><TT>section</TT><A NAME="1798"></A></STRONG></DT> +<DT><STRONG><TT>section</TT><A NAME="1932"></A></STRONG></DT> <DD>Each entry has the corresponding section number(s) where the entry is defined. </DD> -<DT><STRONG><TT>none</TT><A NAME="1800"></A></STRONG></DT> +<DT><STRONG><TT>none</TT><A NAME="1934"></A></STRONG></DT> <DD>The corresponding numbers are suppressed. </DD> @@ -591,15 +601,15 @@ suppressed. <P> </DD> -<DT><STRONG><TT>toc</TT><A NAME="1807"></A></STRONG></DT> -<DD><A NAME="1393"></A> +<DT><STRONG><TT>toc</TT><A NAME="1941"></A></STRONG></DT> +<DD><A NAME="1517"></A> Boolean variable: <DL> -<DT><STRONG><TT>true</TT><A NAME="1811"></A></STRONG></DT> +<DT><STRONG><TT>true</TT><A NAME="1945"></A></STRONG></DT> <DD>Add glossary to table of contents </DD> -<DT><STRONG><TT>false</TT><A NAME="1813"></A></STRONG></DT> +<DT><STRONG><TT>false</TT><A NAME="1947"></A></STRONG></DT> <DD>Omit glossary from table of contents (Default) </DD> </DL> @@ -608,50 +618,50 @@ LaTeX twice after generating the glossary. <P> </DD> -<DT><STRONG><TT>hypertoc</TT><A NAME="1820"></A></STRONG></DT> +<DT><STRONG><TT>hypertoc</TT><A NAME="1954"></A></STRONG></DT> <DD>Boolean variable. This is similar to the package option -<TT>toc</TT><A NAME="1829"></A>, but if you are using the <TT>hyperref</TT><A NAME="1833"></A> -package, <TT>hypertoc</TT><A NAME="1841"></A> will generate a link to the -beginning of the page, whereas <TT>toc</TT><A NAME="1850"></A> will have +<TT>toc</TT><A NAME="1963"></A>, but if you are using the <TT>hyperref</TT><A NAME="1967"></A> +package, <TT>hypertoc</TT><A NAME="1975"></A> will generate a link to the +beginning of the page, whereas <TT>toc</TT><A NAME="1984"></A> will have a hyperlink to jst after the glossary title. Note -that you can not use both <TT>toc=true</TT><A NAME="1861"></A> and -<TT>hypertoc=true</TT><A NAME="1870"></A>. Default value: -<TT>hypertoc=false</TT><A NAME="1879"></A>. +that you can not use both <TT>toc=true</TT><A NAME="1995"></A> and +<TT>hypertoc=true</TT><A NAME="2004"></A>. Default value: +<TT>hypertoc=false</TT><A NAME="2013"></A>. <P> </DD> -<DT><STRONG><TT>hyper</TT><A NAME="1886"></A></STRONG></DT> +<DT><STRONG><TT>hyper</TT><A NAME="2020"></A></STRONG></DT> <DD>Boolean variable: <DL> -<DT><STRONG><TT>true</TT><A NAME="1890"></A></STRONG></DT> +<DT><STRONG><TT>true</TT><A NAME="2024"></A></STRONG></DT> <DD>Make associated numbers in the glossary a hypertext link, and also make acronyms, and the text -given by <TT>\xglossary</TT><A NAME="1892"></A> have a hyperlink to their +given by <TT>\xglossary</TT><A NAME="2026"></A> have a hyperlink to their corresponding entries in the glossary. </DD> -<DT><STRONG><TT>false</TT><A NAME="1897"></A></STRONG></DT> +<DT><STRONG><TT>false</TT><A NAME="2031"></A></STRONG></DT> <DD>Don't make associated numbers a hypertext link </DD> </DL> -If the <TT>hyperref</TT><A NAME="1899"></A> or <TT>html</TT><A NAME="1902"></A> package has +If the <TT>hyperref</TT><A NAME="2033"></A> or <TT>html</TT><A NAME="2036"></A> package has been loaded prior to loading <TT>glossary.sty</TT>, -<TT>hyper=true</TT><A NAME="1912"></A> is set, otherwise -the default is <TT>hyper=false</TT><A NAME="1921"></A>. Note that this package -option now encompasses the old <TT>hyperacronym</TT><A NAME="1928"></A> option. +<TT>hyper=true</TT><A NAME="2046"></A> is set, otherwise +the default is <TT>hyper=false</TT><A NAME="2055"></A>. Note that this package +option now encompasses the old <TT>hyperacronym</TT><A NAME="2062"></A> option. <P> </DD> -<DT><STRONG><TT>section</TT><A NAME="1937"></A></STRONG></DT> +<DT><STRONG><TT>section</TT><A NAME="2071"></A></STRONG></DT> <DD>Boolean variable: <DL> -<DT><STRONG><TT>true</TT><A NAME="1941"></A></STRONG></DT> +<DT><STRONG><TT>true</TT><A NAME="2075"></A></STRONG></DT> <DD>Make the glossary an unnumbered section, even if chapters are defined </DD> -<DT><STRONG><TT>false</TT><A NAME="1943"></A></STRONG></DT> +<DT><STRONG><TT>false</TT><A NAME="2077"></A></STRONG></DT> <DD>Only make glossary an unnumbered section if chapters are not defined (default). </DD> @@ -659,44 +669,60 @@ unnumbered section if chapters are not defined (default). <P> </DD> -<DT><STRONG><TT>acronym</TT><A NAME="1950"></A></STRONG></DT> +<DT><STRONG><TT>acronym</TT><A NAME="2084"></A></STRONG></DT> <DD>Boolean variable: <DL> -<DT><STRONG><TT>true</TT><A NAME="1954"></A></STRONG></DT> +<DT><STRONG><TT>true</TT><A NAME="2088"></A></STRONG></DT> <DD>Make the list of acronyms separate from the main glossary. <P> </DD> -<DT><STRONG><TT>false</TT><A NAME="1956"></A></STRONG></DT> +<DT><STRONG><TT>false</TT><A NAME="2090"></A></STRONG></DT> <DD>The acronyms will all be placed in the main glossary. (Default) </DD> </DL> + +<P> +</DD> +<DT><STRONG><TT>global</TT><A NAME="2097"></A></STRONG></DT> +<DD>Boolean variable: + +<DL> +<DT><STRONG><TT>false</TT><A NAME="2101"></A></STRONG></DT> +<DD>Acronym commands only have +a local effect. (Default) +</DD> +<DT><STRONG><TT>true</TT><A NAME="2103"></A></STRONG></DT> +<DD>Acronym commands have a global +effect. +</DD> +</DL> </DD> </DL> - The <TT>border</TT><A NAME="1963"></A>, <TT>header</TT><A NAME="1972"></A> and <TT>cols</TT><A NAME="1981"></A> options -should not be used in conjunction with <TT>style=list</TT><A NAME="1992"></A> -or <TT>style=altlist</TT><A NAME="2001"></A>, as they only make sense with one of + The <TT>border</TT><A NAME="2110"></A>, <TT>header</TT><A NAME="2119"></A> and <TT>cols</TT><A NAME="2128"></A> options +should not be used in conjunction with <TT>style=list</TT><A NAME="2139"></A> +or <TT>style=altlist</TT><A NAME="2148"></A>, as they only make sense with one of the tabular-style options. The value for the boolean variables can be omitted if they are to be set. For example - <TT>toc</TT><A NAME="2008"></A> is equivalent to <TT>toc=true</TT><A NAME="2019"></A>. Note that the -<TT>altlist</TT><A NAME="2021"></A> style is better suited to + <TT>toc</TT><A NAME="2155"></A> is equivalent to <TT>toc=true</TT><A NAME="2166"></A>. Note that the +<TT>altlist</TT><A NAME="2168"></A> style is better suited to glossaries with long entry names. <P> You can set up your own preferred defaults in a configuration -file<A NAME="1399"></A>. -The file must be called <TT>glossary.cfg</TT><A NAME="2023"></A> and +file<A NAME="1524"></A>. +The file must be called <TT>glossary.cfg</TT><A NAME="2170"></A> and should be placed somewhere on the T<SMALL>E</SMALL>X path. In this file you can use the command <TT>\glossarypackageoptions</TT><code>{</code><I>option-list</I><code>}</code> where <I>option-list</I> is a comma-separated list of <I>key</I>=<I>value</I> pairs, as passed to the -<TT>glossary</TT><A NAME="2027"></A> +<TT>glossary</TT><A NAME="2174"></A> package. Note that this command may only be used in the configuration file. @@ -720,13 +746,13 @@ Defining New Glossary Types <P> A new type of glossary can be defined using the command: <BR> -<BR><TT>\newglossarytype</TT><code>[</code><I>log-ext</I><code>]{</code><I>name</I><code>}{</code><I>out-ext</I><code>}{</code><I>in-ext</I><code>}</code> +<BR><TT>\newglossarytype</TT><code>[</code><I>log-ext</I><code>]{</code><I>name</I><code>}{</code><I>out-ext</I><code>}{</code><I>in-ext</I><code>}[</code><I>style list</I><code>]</code> <BR> <BR> For example, suppose you want your document to have a separate index of terms and index of notation, -you could use <TT>\makeglossary</TT><A NAME="2205"></A>, <TT>\glossary</TT><A NAME="2210"></A>, -<TT>\xglossary</TT><A NAME="2215"></A> and <TT>\printglossary</TT><A NAME="2220"></A> for the first +you could use <TT>\makeglossary</TT><A NAME="2352"></A>, <TT>\glossary</TT><A NAME="2357"></A>, +<TT>\xglossary</TT><A NAME="2362"></A> and <TT>\printglossary</TT><A NAME="2367"></A> for the first glossary, and define a new type of glossary called say, <TT>notation</TT>, using <PRE> @@ -738,6 +764,17 @@ and <TT>\printnotation</TT> which can be used for the second glossary. <P> +As from version 2.3, <TT>\newglossarytype</TT> now has an +additional optional argument <I>style list</I>. This should +be a comma separated list of <I>key</I>=<I>value</I> pairs +that can be used to specify the style of the new glossary. +If omitted, the new glossary will have the same format +as the main glossary. The following options are available: +<TT>style</TT>, <TT>header</TT>, <TT>border</TT> and +<TT>cols</TT>. These can take the same values as those +given in the package options (described in section <A HREF="#sec:options">6</A>). + +<P> The command <TT>\newglossarytype</TT> should only occur in the preamble. The new commands <TT>\make</TT><I>name</I>, <code>\</code><I>name</I>, @@ -747,18 +784,18 @@ same format as their ``glossary'' counter-parts. <P> The glossary information will be saved to a file with the extension given by <I>out-ext</I> (analogous to -<TT>glo</TT><A NAME="2239"></A>), which can then be passed to <TT>makeindex</TT><A NAME="2241"></A> -either directly or via <TT>makeglos.pl</TT><A NAME="2244"></A>, +<TT>glo</TT><A NAME="2388"></A>), which can then be passed to <TT>makeindex</TT><A NAME="2390"></A> +either directly or via <TT>makeglos.pl</TT><A NAME="2393"></A>, and the file to be read in (i.e. the file created by -<TT>makeindex</TT><A NAME="2247"></A>) will have the extension <I>in-ext</I> -(analogous to <TT>gls</TT><A NAME="2250"></A>). +<TT>makeindex</TT><A NAME="2396"></A>) will have the extension <I>in-ext</I> +(analogous to <TT>gls</TT><A NAME="2399"></A>). <P> The optional argument <I>log-ext</I> indicates -the extension for the <TT>makeindex</TT><A NAME="2252"></A> log file, if omitted the -extension <TT>glg</TT><A NAME="2255"></A> is used. This is not used by LaTeX, -however <TT>makeglos.pl</TT><A NAME="2257"></A> reads in this information from -the LaTeX auxiliary file and passes it to <TT>makeindex</TT><A NAME="2260"></A>. +the extension for the <TT>makeindex</TT><A NAME="2401"></A> log file, if omitted the +extension <TT>glg</TT><A NAME="2404"></A> is used. This is not used by LaTeX, +however <TT>makeglos.pl</TT><A NAME="2406"></A> reads in this information from +the LaTeX auxiliary file and passes it to <TT>makeindex</TT><A NAME="2409"></A>. <P> For the above <TT>notation</TT> @@ -771,7 +808,7 @@ latex mydoc </PRE> (You may need to do an extra <code>latex mydoc</code> to get cross-references up-to-date.) Note that if you don't specify the -file extension when using <TT>makeglos.pl</TT><A NAME="2263"></A>, it will +file extension when using <TT>makeglos.pl</TT><A NAME="2412"></A>, it will check the transcript file from the LaTeX run to determine all the glossary types, so, for this example, <PRE> @@ -782,14 +819,14 @@ is equivalent to: makeglos.pl mydoc.glo makeglos.pl mydoc.not </PRE> -since <TT>makeglos.pl</TT><A NAME="2266"></A> has read in the information +since <TT>makeglos.pl</TT><A NAME="2415"></A> has read in the information for the <TT>notation</TT> glossary type from the file <TT>mydoc.log</TT>. <P> If you don't have Perl installed on your system, or for any other reason are unable to use -<TT>makeglos.pl</TT><A NAME="2269"></A>, you can call <TT>makeindex</TT><A NAME="2272"></A> +<TT>makeglos.pl</TT><A NAME="2418"></A>, you can call <TT>makeindex</TT><A NAME="2421"></A> explicitly: <PRE> latex mydoc @@ -800,7 +837,7 @@ latex mydoc <P> Note that you can use the command -<TT>\printglossary</TT><A NAME="2275"></A><TT>[</TT><I>name</I><TT>]</TT> +<TT>\printglossary</TT><A NAME="2424"></A><TT>[</TT><I>name</I><TT>]</TT> instead of <code>\print</code><I>name</I>. These two commands have the same effect when using LaTeX, however, they have a slightly different effect when @@ -810,7 +847,7 @@ using LaTeX2HTML (see <A HREF="#sec:l2h">later</A>). If the command <code>\</code><I>glossary-type</I><code>name</code> is defined, (e.g. <code>\notationname</code> in the above example) this will be used as the title for the specified -glossary. If this command is not defined, <TT>\glossaryname</TT><A NAME="2280"></A> +glossary. If this command is not defined, <TT>\glossaryname</TT><A NAME="2429"></A> will be used instead. If the command <code>\short</code><I>glossary-type</I><code>name</code> is defined, (e.g. <TT>\shortnotationname</TT> in the above @@ -831,7 +868,7 @@ Acronyms</A> </H1> <P> -The <TT>glossary</TT><A NAME="2287"></A> package provides the command: +The <TT>glossary</TT><A NAME="2436"></A> package provides the command: <BR> <BR><TT><TT>\newacronym</TT>[</TT> <I>cmd-name</I><TT>]{</TT> <I>acronym</I><TT>}{</TT> <I>long</I><TT>}{</TT> <I>glossary entry</I><TT>} </TT> @@ -840,7 +877,7 @@ The <TT>glossary</TT><A NAME="2287"></A> package provides the command: which can be used to define acronyms. The argument <I>long</I> is the full name, the argument <I>acronym</I> is the acronym for <I>long</I> and <I>glossary entry</I> is the glossary information -in the form used by the <TT>\glossary</TT><A NAME="2292"></A> command. If the +in the form used by the <TT>\glossary</TT><A NAME="2441"></A> command. If the optional argument <I>cmd-name</I> is missing, <TT>\newacronym</TT> will create a command called <code>\</code><I>acronym</I>, otherwise it will create a command @@ -848,12 +885,12 @@ called <code>\</code><I>cmd-name</I> (henceforth denoted <TT>\</TT><I>acr-na This command can then be used throughout the text. The first instance of this command is equivalent to: <BR> -<BR><I>long</I> <TT>(\xacronym</TT><A NAME="2301"></A><code>{</code><TT>name</TT><A NAME="2306"></A><TT>=</TT><I>long</I> <TT>(</TT><I>acronym</I><TT>),</TT><I>glossary entry</I><code>}{</code><I>acronym</I><code>}</code><TT>)</TT> +<BR><I>long</I> <TT>(\xacronym</TT><A NAME="2450"></A><code>{</code><TT>name</TT><A NAME="2455"></A><TT>=</TT><I>long</I> <TT>(</TT><I>acronym</I><TT>),</TT><I>glossary entry</I><code>}{</code><I>acronym</I><code>}</code><TT>)</TT> <BR> <BR> subsequent instances will be equivalent to: <BR> -<BR><TT>\xacronym</TT><A NAME="2310"></A><code>{</code><TT>name</TT><A NAME="2315"></A><TT>=</TT><I>long</I> <TT>(</TT><I>acronym</I><TT>),</TT><I>glossary entry</I><code>}{</code><I>acronym</I><code>}</code> +<BR><TT>\xacronym</TT><A NAME="2459"></A><code>{</code><TT>name</TT><A NAME="2464"></A><TT>=</TT><I>long</I> <TT>(</TT><I>acronym</I><TT>),</TT><I>glossary entry</I><code>}{</code><I>acronym</I><code>}</code> <BR> <BR> The command <TT>\</TT><I>acr-name</I> also has a starred @@ -864,7 +901,7 @@ uppercase (for use at the start of a sentence). Note that if you want to change the format of the acronym, for example, if you want the acronym to appear in small caps, you will need to not only use the optional argument, but you -will also need to use the <TT>sort</TT><A NAME="2321"></A> key, otherwise you +will also need to use the <TT>sort</TT><A NAME="2470"></A> key, otherwise you will get an error. For example: <PRE> \newacronym[SVM]{\textsc{svm}}{Support Vector Machine}% @@ -873,18 +910,18 @@ technique,sort=svm} </PRE> <P> -If the package option <TT>acronym</TT><A NAME="2330"></A> is not set (default) -<TT>\xacronym</TT><A NAME="2334"></A>, is a synonym for <TT>\xglossary</TT><A NAME="2339"></A>. -If the package option <TT>acronym=true</TT><A NAME="2351"></A> is specified, a +If the package option <TT>acronym</TT><A NAME="2479"></A> is not set (default) +<TT>\xacronym</TT><A NAME="2483"></A>, is a synonym for <TT>\xglossary</TT><A NAME="2488"></A>. +If the package option <TT>acronym=true</TT><A NAME="2500"></A> is specified, a new glossary type called <TT>acronym</TT> will be defined as: <PRE> \newglossarytype[alg]{acronym}{acr}{acn} -\newcommand{\acronymname}{List of Acronyms} +\providecommand{\acronymname}{List of Acronyms} </PRE> -You will then need to use the commands <TT>\makeacronym</TT><A NAME="2353"></A> -and <TT>\printacronym</TT><A NAME="2358"></A> to make the list of acronyms appear. -You will also need to run the <TT>acr</TT><A NAME="2363"></A> file through -<TT>makeindex</TT><A NAME="2365"></A> (or <TT>makeglos.pl</TT><A NAME="2368"></A>). For example: +You will then need to use the commands <TT>\makeacronym</TT><A NAME="2502"></A> +and <TT>\printacronym</TT><A NAME="2507"></A> to make the list of acronyms appear. +You will also need to run the <TT>acr</TT><A NAME="2512"></A> file through +<TT>makeindex</TT><A NAME="2514"></A> (or <TT>makeglos.pl</TT><A NAME="2517"></A>). For example: <PRE> makeindex -s mydoc.ist -t mydoc.alg -o mydoc.acn mydoc.acr </PRE> @@ -892,12 +929,21 @@ alternatively: <PRE> makeglos.pl mydoc </PRE> -Note that the package option <TT>acronym=true</TT><A NAME="2378"></A> is only +Note that the package option <TT>acronym=true</TT><A NAME="2527"></A> is only appropriate if you want both a glossary and a separate list of -acronyms. +acronyms. If you do not write in English, you can set up your +own language definition +for <TT>\acronymname</TT> in the configuration file +<TT>glossarycfg</TT><A NAME="2531"></A>. For example: +<PRE> +\newcommand{\acronymname}{Akronyme} +</PRE> +(If <TT>glossary.cfg</TT> does not exist, create a new file, add the +appropriate definition of <TT>\acronymname</TT>, and save it to the +same directory as <TT>glossary.sty</TT>.) <P> -The <TT>name</TT><A NAME="2380"></A> key is not used in <I>glossary +The <TT>name</TT><A NAME="2535"></A> key is not used in <I>glossary entry</I>, as it is constructed from <I>long</I> and <I>acronym</I>. By default this will be in the form: <I>long</I> (<I>acronym</I>), however the format can be @@ -909,8 +955,8 @@ command: <BR> Within <I>format</I> the following commands may be used to represent <I>long</I> and <I>acronym</I>: -<TT>\glolong</TT><A NAME="2386"></A> and -<TT>\gloshort</TT><A NAME="2391"></A>. For example, +<TT>\glolong</TT><A NAME="2541"></A> and +<TT>\gloshort</TT><A NAME="2546"></A>. For example, suppose you just want the acronym to appear in the glossary entry, and not its full length name, then you would need to do: <PRE> @@ -918,6 +964,46 @@ and not its full length name, then you would need to do: </PRE> <P> +As from version 2.32, you can also modify the way the description +key is formatted for acronyms using: +<BR> +<BR><TT>\setacronymdescfmt</TT>{<I>format</I>} +<BR> +<BR> +Within <I>format</I> you may use the commands <TT>\glolong</TT><A NAME="2553"></A> +and <TT>\gloshort</TT><A NAME="2558"></A> (as above), and you can also use +the command <TT>\glodesc</TT><A NAME="2563"></A> which is the description as +specified by the <TT>description</TT><A NAME="2568"></A> key in +<TT>\newacronym</TT><A NAME="2572"></A>. This means that if you are using +a tabular style glossary, you can have the abbreviated +form in one column and the long form in the second column +with the description. For example, the following: +<PRE> +\setacronymnamefmt{\gloshort} +\setacronymdescfmt{\glolong: \glodesc} +\newacronym{svm}{support vector machine}{description=Statistical +pattern recognition technique} +</PRE> +will generate a glossary entry of the form: +<PRE> +\glossary{name=svm,description=support vector machine: Statistical +pattern recognition technique} +</PRE> +Note that if you omit <TT>\glodesc</TT><A NAME="2577"></A> from +<TT>\setacronymdescfmt</TT> the description specified +in <TT>\newacronym</TT> will be ignored. So +<PRE> +\setacronymnamefmt{\gloshort} +\setacronymdescfmt{\glolong} +\newacronym{svm}{support vector machine}{description=Statistical +pattern recognition technique} +</PRE> +will generate a glossary entry of the form: +<PRE> +\glossary{name=svm,description=support vector machine} +</PRE> + +<P> Given an acronym named <I>acr-name</I> (the command name associated with the acronym as defined in <TT>\newacronym</TT> without the preceding backslash), @@ -952,6 +1038,18 @@ do <TT>\resetallacronyms</TT>. <BR> <BR> +<TT>\unsetacronym</TT><code>{</code><I>acr-name</I><code>}</code> +<BR> +<BR> +This command will cause all subsequent uses of +<TT>\</TT><I>acr-name</I> to produce the short version. +To unset all acronyms +do <TT>\unsetallacronyms</TT>. + +<P> +<BR> +<BR> + <TT>\ifacronymfirstuse</TT><code>{</code><I>acr-name</I><code>}{</code><I>true text</I><code>}{</code><I>false text</I><code>}</code> <BR> <BR> @@ -981,7 +1079,7 @@ The other two commands, simply contain <I>long</I> and <P> Note that since these four commands do not generate glossary entries they will therefore not contain any hyperlinks, even if -you have specified the <TT>hyper</TT><A NAME="2431"></A> package option. They are +you have specified the <TT>hyper</TT><A NAME="2627"></A> package option. They are provided for use in situations where the associated glossary command may cause problems (e.g. in the table of contents entry.) @@ -994,9 +1092,9 @@ can either place an empty set of braces after the command name (e.g. <code>\SVM{}</code>) or use <TT>\_</TT> i.e. a backslash followed by a space (e.g. <code>\SVM\ </code>). Alternatively, as from -version 2.22, if you load the <TT>xspace</TT><A NAME="2437"></A> package -before loading the <TT>glossary</TT><A NAME="2440"></A> package, spaces will -be put in automatically using <TT>\xspace</TT><A NAME="2443"></A>. +version 2.22, if you load the <TT>xspace</TT><A NAME="2633"></A> package +before loading the <TT>glossary</TT><A NAME="2636"></A> package, spaces will +be put in automatically using <TT>\xspace</TT><A NAME="2639"></A>. <P> If you want the acronym to appear in a particular font, @@ -1060,7 +1158,7 @@ To expand the acronym a second time: The \SVM\ \ldots </PRE> Note the use of <TT>\protect</TT> (see -note <A HREF="#itm:fragile">14</A>.) In fact, in this situation +note <A HREF="#itm:fragile">15</A>.) In fact, in this situation it would be better to do: <PRE> \chapter[An overview of the \SVMlong]{An overview of the \protect\SVM} @@ -1088,7 +1186,7 @@ techniques are widely used ...(Assuming this is the first use of either <TT>\SVM</TT> or <TT>\SVM*</TT>.) <P> -Alternatively, <TT>\useacronym</TT><A NAME="2468"></A><code>{SVM}</code> can be used instead of +Alternatively, <TT>\useacronym</TT><A NAME="2664"></A><code>{SVM}</code> can be used instead of <TT>\SVM</TT>. For example: <PRE> \useacronym*[s]{SVM} are widely used in the area of pattern @@ -1113,7 +1211,7 @@ SVMs are widely used in the area of pattern recognition. <H1><A NAME="SECTION000100000000000000000"> Customizing the Glossary</A> </H1> -The <TT>glossary</TT><A NAME="2475"></A> package provides commands which can be redefined to customize the +The <TT>glossary</TT><A NAME="2671"></A> package provides commands which can be redefined to customize the glossary. The following name commands are defined by this package: <DIV ALIGN="CENTER"> <TABLE CELLPADDING=3> @@ -1147,21 +1245,55 @@ italic indicate the main definition\par} By default, <TT>\glossarypreamble</TT> and <TT>\glossarypostamble</TT> do nothing. <P> +Any text required before or after the list of page numbers +are specified by the commands <TT>\glsbeforenum</TT> + +and <TT>\glsafternum</TT>. +By default, these commands do nothing, any redefinition +of these commands should come somewhere before the +relevant <TT>\printglossary</TT> command. For example: +<PRE> +\printglossary +\renewcommand{\glsbeforenum}{(} +\renewcommand{\glsafternum}{)} +\printnotation +</PRE> +This will put the page number list in brackets for the +second glossary, but not the first. + +<P> +Individual glossaries can have their styles changed either +by setting the style in the final optional argument +to <TT>\newglossarystyle</TT><A NAME="2700"></A> (see +<A HREF="#sec:newglostype">earlier</A>) +or using the command: +<BR> +<BR><TT>\setglossarystyle</TT>[<I>type</I>]{<I>style list</I>} +<BR> +<BR> +For example: +<PRE> +\setglossarystyle[acronym]{style=long,border=true,cols=2} +</PRE> +If <I>type</I> is omitted, the change is applied to the main +glossary. + +<P> The command <TT>\setglossary</TT><code>{</code><I>key-val list</I><code>}</code> can be used to modify some of the glossary settings. The argument <I>key-val list</I> is a comma-separated list of <I>key</I>=<I>value</I> pairs. Available keys are: <DL> -<DT><STRONG><TT>type</TT><A NAME="2500"></A></STRONG></DT> +<DT><STRONG><TT>type</TT><A NAME="2709"></A></STRONG></DT> <DD>This is the glossary type. If it is omitted, the standard glossary is assumed. <P> </DD> -<DT><STRONG><TT>glsnumformat</TT><A NAME="2504"></A></STRONG></DT> +<DT><STRONG><TT>glsnumformat</TT><A NAME="2713"></A></STRONG></DT> <DD>This is the name of the command, <I>without</I> the preceding backslash<A NAME="tex2html4" - HREF="#foot1416"><SUP>3</SUP></A>, to format the + HREF="#foot1544"><SUP>3</SUP></A>, to format the entry numbers. For example, to make all the entry numbers italic, do: <PRE> @@ -1174,45 +1306,85 @@ To suppress numbering altogether, you can do: <P> </DD> -<DT><STRONG><TT>glodelim</TT><A NAME="2510"></A></STRONG></DT> +<DT><STRONG><TT>glodelim</TT><A NAME="2719"></A></STRONG></DT> <DD>This specifies what to do after the entry description and -before the page numbers. The default value is a comma, unless the <TT>cols=3</TT><A NAME="2521"></A> option is specified, +before the page numbers. The default value is a comma, unless the <TT>cols=3</TT><A NAME="2730"></A> option is specified, in which case it has the value <code>&</code>, or if -<TT>style=altlist</TT><A NAME="2530"></A>, +<TT>style=altlist</TT><A NAME="2739"></A>, in which case it is simply a space<A NAME="tex2html5" - HREF="#foot1417"><SUP>4</SUP></A>. If the package option <TT>number=none</TT><A NAME="2539"></A> is -specified, <TT>glodelim</TT><A NAME="2541"></A> will have an empty value (unless -<TT>cols=3</TT><A NAME="2552"></A> is specified, + HREF="#foot1545"><SUP>4</SUP></A>. If the package option <TT>number=none</TT><A NAME="2748"></A> is +specified, <TT>glodelim</TT><A NAME="2750"></A> will have an empty value (unless +<TT>cols=3</TT><A NAME="2761"></A> is specified, where, again, it will have the value <code>&</code>.) -This setting corresponds to the <TT>delim_0</TT><A NAME="2554"></A> key in the -<TT>makeindex</TT><A NAME="2556"></A> style file. +This setting corresponds to the <TT>delim_0</TT><A NAME="2763"></A> key in the +<TT>makeindex</TT><A NAME="2765"></A> style file. + +<P> +Note that if you want a new line between the description +and the list of page numbers you will need to use +<TT>\noexpand</TT>. For example: +<PRE> +\setglossary{glodelim={\noexpand\newline}} +</PRE> <P> </DD> -<DT><STRONG><TT>delimN</TT><A NAME="2559"></A></STRONG></DT> +<DT><STRONG><TT>delimN</TT><A NAME="2770"></A></STRONG></DT> <DD> The delimiter to be inserted between two page numbers for the same entry. (This corresponds to the -<TT>delim_n</TT><A NAME="2563"></A> key in the <TT>makeindex</TT><A NAME="2565"></A> style file.) +<TT>delim_n</TT><A NAME="2774"></A> key in the <TT>makeindex</TT><A NAME="2776"></A> style file.) By default, this has the value <TT>,_</TT> (comma followed by a space). If the -package option <TT>number=none</TT><A NAME="2575"></A> is chosen, the value is set +package option <TT>number=none</TT><A NAME="2786"></A> is chosen, the value is set to empty. <P> </DD> -<DT><STRONG><TT>delimR</TT><A NAME="2577"></A></STRONG></DT> +<DT><STRONG><TT>delimR</TT><A NAME="2788"></A></STRONG></DT> <DD> The delimiter to be inserted between the starting and ending page number range for the same entry. (This corresponds to the -<TT>delim_r</TT><A NAME="2581"></A> key in the <TT>makeindex</TT><A NAME="2583"></A> style file.) +<TT>delim_r</TT><A NAME="2792"></A> key in the <TT>makeindex</TT><A NAME="2794"></A> style file.) By default, this has the value <code>--</code>. If the -package option <TT>number=none</TT><A NAME="2593"></A> is chosen, the value is set +package option <TT>number=none</TT><A NAME="2804"></A> is chosen, the value is set to empty. <P> </DD> +<DT><STRONG><TT>gloskip</TT><A NAME="2806"></A></STRONG></DT> +<DD> +This specifies what to do between groups. +If <TT>style=list</TT><A NAME="2817"></A> or <TT>style=altlist</TT><A NAME="2826"></A> this has the +value <TT>\indexspace</TT>, otherwise it creates a blank line + in the <TT>longtable</TT> or <TT>supertabular</TT> environment. +This command corresponds to the <TT>group_skip</TT><A NAME="2832"></A> key in +the <TT>makeindex</TT><A NAME="2834"></A> style file. +Note that as from version 2.3, you should no longer redefine +the command <TT>\gloskip</TT>. + +<P> +</DD> +<DT><STRONG><TT>delimT</TT><A NAME="2839"></A></STRONG></DT> +<DD> +The text to be inserted after the list of +page numbers for an entry. (This corresponds to the +<TT>delim_t</TT><A NAME="2843"></A> key in the <TT>makeindex</TT><A NAME="2845"></A> style file.) +The default value depends on the glossary style. It does +nothing for the list-type styles, and has the value +<code>\\</code> for the tabular-type styles. Note that +<TT>delimT</TT><A NAME="2848"></A> is separate from <TT>\glsafternum</TT>. + +<P> +For example, if you are using a 2 column tabular style, +and you want a blank line after every entry (not just +after every group) you can do the following: +<PRE> +\setglossary{delimT={\cr & \cr},gloskip={}} +</PRE> +Note the use of <TT>\cr</TT> instead of <code>\\</code>. +</DD> </DL> Note that: <PRE> @@ -1226,7 +1398,7 @@ is equivalent to <P> The number associated with each entry is, by default, the page number where that entry was defined. If the package option -<TT>number=section</TT><A NAME="2602"></A> has been chosen, this +<TT>number=section</TT><A NAME="2863"></A> has been chosen, this will be the section number instead. You can choose a different counter by changing the value of the command <TT>\theglossarynum</TT>. For example, suppose you have the following code: @@ -1250,51 +1422,51 @@ you will need to specify that the number is in the form <I>NUM</I>.<I>num</I> \renewcommand{\pagecompositor}{.} </PRE> (By default this value is <TT>-</TT>, unless the package option -<TT>number=section</TT><A NAME="2617"></A> has +<TT>number=section</TT><A NAME="2878"></A> has been chosen, in which case this command has the value <TT>.</TT> (full stop), as in the example above). The <TT>\pagecompositor</TT> command must be -redefined before <TT>\makeglossary</TT><A NAME="2621"></A> for it to have any effect. -If the package option <TT>number=none</TT><A NAME="2633"></A> is used, +redefined before <TT>\makeglossary</TT><A NAME="2882"></A> for it to have any effect. +If the package option <TT>number=none</TT><A NAME="2894"></A> is used, the numbering will be suppressed, regardless -of the value of <TT>\theglossarynum</TT><A NAME="2635"></A>. -This command corresponds to the <TT>page_compositor</TT><A NAME="2640"></A> key -in the <TT>makeindex</TT><A NAME="2642"></A> style file. +of the value of <TT>\theglossarynum</TT><A NAME="2896"></A>. +This command corresponds to the <TT>page_compositor</TT><A NAME="2901"></A> key +in the <TT>makeindex</TT><A NAME="2903"></A> style file. <P> The start and end of the main body of the glossary is given by the commands: <TT>\beforeglossary</TT> and <TT>\afterglossary</TT>. -If the <TT>style=list</TT><A NAME="2656"></A> -or <TT>style=altlist</TT><A NAME="2665"></A> +If the <TT>style=list</TT><A NAME="2917"></A> +or <TT>style=altlist</TT><A NAME="2926"></A> package options are chosen these commands simply begin and end the <TT>description</TT> environment, otherwise these commands begin and end the <TT>longtable</TT> or <TT>supertabular</TT> environment with argument specified by -<TT>\glossaryalignment</TT>. +<TT>\glossaryalignment</TT><A NAME="tex2html6" + HREF="#foot1100"><SUP>5</SUP></A>. <P> -The above conflicts with the <TT>array</TT><A NAME="2672"></A> package, so as -from version 2.1, if the <TT>array</TT><A NAME="2675"></A> package has been -loaded <I>prior</I> to loading the <TT>glossary</TT><A NAME="2678"></A> package, -the new column type <TT>G</TT> will be defined and used -instead of <TT>\glossaryalignment</TT>. +The glossary package no longer conflicts with the <TT>array</TT><A NAME="2933"></A> +package. Changes can now be made to <TT>\glossaryalignment</TT> +regardless of whether or not the <TT>array</TT><A NAME="2938"></A> +package has been used. <P> The command <TT>\gloitem</TT> indicates what to do at the start of each glossary entry. -This command takes one argument, which will be the text specified by the <TT>name</TT><A NAME="2685"></A> key -in the <TT>\glossary</TT><A NAME="2689"></A> command. In the case of the -<TT>style=list</TT><A NAME="2701"></A> option, +This command takes one argument, which will be the text specified by the <TT>name</TT><A NAME="2943"></A> key +in the <TT>\glossary</TT><A NAME="2947"></A> command. In the case of the +<TT>style=list</TT><A NAME="2959"></A> option, <TT>\gloitem</TT><code>{</code><I>text</I><code>}</code> will do <BR> <BR><code>\item[</code><I>text</I><code>]</code> <BR> <BR> -or if <TT>style=altlist</TT><A NAME="2712"></A>: +or if <TT>style=altlist</TT><A NAME="2970"></A>: <BR> <BR><code>\item[</code><I>text</I><code>]\mbox{}\par</code> <BR> @@ -1304,33 +1476,18 @@ otherwise it will do <BR><I>text</I><code> &</code> <BR> <BR> -if it's the first -item of the page or -<BR> -<BR><code>\\ </code><I>text</I><code> &</code> -<BR> -<BR> -otherwise. -This command corresponds to the <TT>item_0</TT><A NAME="2714"></A> key in the -<TT>makeindex</TT><A NAME="2716"></A> style file. - -<P> -The command <TT>\gloskip</TT> specifies what to do between groups. -If <TT>style=list</TT><A NAME="2728"></A> or <TT>style=altlist</TT><A NAME="2737"></A> this has the -value <TT>\indexspace</TT>, otherwise it creates a blank line - in the <TT>longtable</TT> or <TT>supertabular</TT> environment. -This command corresponds to the <TT>group_skip</TT><A NAME="2743"></A> key in -the <TT>makeindex</TT><A NAME="2745"></A> style file. +This command corresponds to the <TT>item_0</TT><A NAME="2972"></A> key in the +<TT>makeindex</TT><A NAME="2974"></A> style file. <P> -The command <TT>\glossaryheader</TT> (if <TT>style=long</TT><A NAME="2757"></A> or <TT>style=super</TT><A NAME="2766"></A> is selected) +The command <TT>\glossaryheader</TT> (if <TT>style=long</TT><A NAME="2986"></A> or <TT>style=super</TT><A NAME="2995"></A> is selected) indicates what to do at the start of the <TT>longtable</TT> or -<TT>supertabular</TT> environment. If <TT>border=none</TT><A NAME="2777"></A>, it +<TT>supertabular</TT> environment. If <TT>border=none</TT><A NAME="3006"></A>, it is defined as: <PRE> \bfseries\entryname & \bfseries \descriptionname\\ </PRE> -So, if you want the <TT>\descriptionname</TT><A NAME="2779"></A> to be centred, you could do: +So, if you want the <TT>\descriptionname</TT><A NAME="3008"></A> to be centred, you could do: <PRE> \renewcommand{\glossaryheader}{\bfseries\entryname & \hfil\bfseries\descriptionname\\} @@ -1352,10 +1509,10 @@ This package comes with the following sample documents: <UL> <LI><TT>sampleSec.tex</TT> -- This document uses the options: -<TT>style=altlist</TT><A NAME="2799"></A>, <TT>toc</TT><A NAME="2806"></A> and -<TT>number=section</TT><A NAME="2817"></A>. It also loads the -<TT>hyperref</TT><A NAME="2819"></A> package before loading the -<TT>glossary</TT><A NAME="2822"></A> package, so the glossary has hyperlinks +<TT>style=altlist</TT><A NAME="3028"></A>, <TT>toc</TT><A NAME="3035"></A> and +<TT>number=section</TT><A NAME="3046"></A>. It also loads the +<TT>hyperref</TT><A NAME="3048"></A> package before loading the +<TT>glossary</TT><A NAME="3051"></A> package, so the glossary has hyperlinks to the section numbers. Experimenting with different package options, will illustrate the different glossary styles. You will need to do: @@ -1365,7 +1522,7 @@ makeglos.pl sampleSec pdflatex sampleSec pdflatex sampleSec </PRE> -If you don't want to use <TT>makeglos.pl</TT><A NAME="2825"></A>, you will need +If you don't want to use <TT>makeglos.pl</TT><A NAME="3054"></A>, you will need to do <PRE> makeindex -s sampleSec.ist -t sampleSec.glg -o sampleSec.gls sampleSec.glo @@ -1376,6 +1533,7 @@ makeindex -s sampleSec.ist -t sampleSec.glg -o sampleSec.gls sampleSec.glo <LI><TT>sampleNtn.tex</TT> -- This has a glossary and defines a new glossary type called <TT>notation</TT>. The glossary has associated page numbers, but the new glossary type doesn't. +The two glossaries have different styles. You will need to do: <PRE> latex sampleNtn @@ -1383,7 +1541,7 @@ makeglos.pl sampleNtn latex sampleNtn latex sampleNtn </PRE> -If you don't want to use <TT>makeglos.pl</TT><A NAME="2828"></A>, you will need +If you don't want to use <TT>makeglos.pl</TT><A NAME="3057"></A>, you will need to do <PRE> makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo @@ -1393,22 +1551,22 @@ makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.ntn sampleNtn.not <P> </LI> <LI><TT>sampleNtn2.tex</TT> --This is similar to -<TT>sampleNtn.tex</TT>, but uses <TT>\storeglosentry</TT><A NAME="2831"></A>. +<TT>sampleNtn.tex</TT>, but uses <TT>\storeglosentry</TT><A NAME="3060"></A>. <P> </LI> <LI><TT>sampleEq.tex</TT> -- This has a glossary where the numbers in the glossary refer to the equation number rather than -the page number. The <TT>\pagecompositor</TT><A NAME="2836"></A>, -<TT>\theglossarynum</TT><A NAME="2841"></A>, <TT>\glossaryname</TT><A NAME="2846"></A> and -<TT>\glossaryheader</TT><A NAME="2851"></A> are all redefined to customize the +the page number. The <TT>\pagecompositor</TT><A NAME="3065"></A>, +<TT>\theglossarynum</TT><A NAME="3070"></A>, <TT>\glossaryname</TT><A NAME="3075"></A> and +<TT>\glossaryheader</TT><A NAME="3080"></A> are all redefined to customize the glossary. You will need to do: <PRE> latex sampleEq makeglos.pl sampleEq latex sampleEq </PRE> -If you don't want to use <TT>makeglos.pl</TT><A NAME="2856"></A>, you will need +If you don't want to use <TT>makeglos.pl</TT><A NAME="3085"></A>, you will need to do <PRE> makeindex -s sampleEq.ist -t sampleEq.glg -o sampleEq.gls sampleEq.glo @@ -1426,7 +1584,7 @@ latex sampleEqPg makeglos.pl sampleEqPg latex sampleEqPg </PRE> -If you don't want to use <TT>makeglos.pl</TT><A NAME="2859"></A>, you will need +If you don't want to use <TT>makeglos.pl</TT><A NAME="3088"></A>, you will need to do <PRE> makeindex -s sampleEqPg.ist -t sampleEqPg.glg -o sampleEqPg.gls sampleEqPg.glo @@ -1435,9 +1593,9 @@ makeindex -s sampleEqPg.ist -t sampleEqPg.glg -o sampleEqPg.gls sampleEqPg.glo <P> </LI> <LI><TT>sampleAcr.tex</TT> -- This has a glossary containing -acronyms. It uses the style <TT>altlist</TT><A NAME="2862"></A> as this is better +acronyms. It uses the style <TT>altlist</TT><A NAME="3091"></A> as this is better suited to glossaries with long names. It also uses the -<TT>hyperref</TT><A NAME="2864"></A> package, so the page numbers in the +<TT>hyperref</TT><A NAME="3093"></A> package, so the page numbers in the glossary will automatically be hyperlinks, and the acronyms within the text will have hyperlinks to their corresponding entry in the glossary. You will need to do: @@ -1447,7 +1605,7 @@ makeglos.pl sampleAcr pdflatex sampleAcr pdflatex sampleAcr </PRE> -If you don't want to use <TT>makeglos.pl</TT><A NAME="2867"></A>, you will need +If you don't want to use <TT>makeglos.pl</TT><A NAME="3096"></A>, you will need to do <PRE> makeindex -s sampleAcr.ist -t sampleAcr.glg -o sampleAcr.gls sampleAcr.glo @@ -1457,9 +1615,9 @@ makeindex -s sampleAcr.ist -t sampleAcr.glg -o sampleAcr.gls sampleAcr.glo </LI> <LI><TT>sample.tex</TT> -- This has a glossary entry with two different definitions of the same name. -If you just use <TT>makeindex</TT><A NAME="2870"></A>, the two entries +If you just use <TT>makeindex</TT><A NAME="3099"></A>, the two entries will be treated separately, however, if you want them -concatenated, you can use <TT>makeglos.pl</TT><A NAME="2873"></A> with +concatenated, you can use <TT>makeglos.pl</TT><A NAME="3102"></A> with the <TT>-m</TT> switch. You will need to do: <PRE> pdflatex sample @@ -1469,10 +1627,10 @@ pdflatex sample </PRE> (Depending on the configuration of your system, you may have to do <TT>perl makeglos.pl</TT> instead of -just <TT>makeglos.pl</TT><A NAME="2876"></A>) +just <TT>makeglos.pl</TT><A NAME="3105"></A>) <P> -If you don't want to use <TT>makeglos.pl</TT><A NAME="2879"></A>, you will need +If you don't want to use <TT>makeglos.pl</TT><A NAME="3108"></A>, you will need to do <PRE> makeindex -s sample.ist -t sample.glg -o sample.gls sample.glo @@ -1482,6 +1640,17 @@ will not be merged. <P> </LI> +<LI><TT>sample4col.tex</TT>--This illustrates how to +modify the glossary style so that it has 4 columns. You +will need to do: +<PRE> +latex sample4col +makeglos.pl sample4col +latex sample4col +</PRE> + +<P> +</LI> </UL> <P> @@ -1493,10 +1662,10 @@ LaTeX2HTML Style File </H1> <P> -A LaTeX2HTML Perl script, <TT>glossary.perl</TT><A NAME="2882"></A>, is +A LaTeX2HTML Perl script, <TT>glossary.perl</TT><A NAME="3111"></A>, is provided with this package for those wishing to use the glossary package with the LaTeX2HTML translator. -The file <TT>glossary.perl</TT><A NAME="2884"></A> should be extracted +The file <TT>glossary.perl</TT><A NAME="3113"></A> should be extracted along with <TT>glossary.sty</TT> when you run the installation script (<TT>glossary.ins</TT>) through LaTeX. @@ -1510,8 +1679,8 @@ Limitations</A> <UL> <LI>The only package options supported are: -<TT>style=altlist</TT><A NAME="2893"></A>, <TT>hyper=true</TT><A NAME="2902"></A>, <TT>toc=true</TT><A NAME="2911"></A>, -<TT>acronym=true</TT><A NAME="2920"></A> and <TT>acronym=false</TT><A NAME="2929"></A>. +<TT>style=altlist</TT><A NAME="3122"></A>, <TT>hyper=true</TT><A NAME="3131"></A>, <TT>toc=true</TT><A NAME="3140"></A>, +<TT>acronym=true</TT><A NAME="3149"></A> and <TT>acronym=false</TT><A NAME="3158"></A>. <P> </LI> @@ -1524,18 +1693,18 @@ as the primary glossary if you use the command <P> </LI> -<LI>The command <TT>\setglossary</TT><A NAME="2931"></A> must be +<LI>The command <TT>\setglossary</TT><A NAME="3160"></A> must be placed in the preamble to have an effect. <P> </LI> -<LI>The <TT>\storeglosentry</TT><A NAME="2936"></A> commands must be in +<LI>The <TT>\storeglosentry</TT><A NAME="3165"></A> commands must be in the document environment to have an effect. (They don't seem to work in the preamble, I don't know why.) <P> </LI> -<LI>If you place a <TT>\glossary</TT><A NAME="2941"></A> command +<LI>If you place a <TT>\glossary</TT><A NAME="3170"></A> command inside an environment not translated by LaTeX2HTML (for example, inside a mathematics environment), it will not be entered into the glossary. @@ -1546,7 +1715,7 @@ it will not be entered into the glossary. and <code>"@</code> will be correctly translated, unless they occur within a maths environment. This is because the maths environment is translated before being -passed to <TT>\glossary</TT><A NAME="2946"></A>. You can overcome this +passed to <TT>\glossary</TT><A NAME="3175"></A>. You can overcome this by doing, e.g.: <BR><TT>\begin</TT><code>{latexonly}</code> <BR><code>\glossary{name=$"|\mathcal{S}"|$,description=cardinality of set</code> @@ -1571,7 +1740,7 @@ definitions will not be merged. <P> </LI> -<LI>The command <TT>\theglossarynum</TT><A NAME="2961"></A> is ignored +<LI>The command <TT>\theglossarynum</TT><A NAME="3190"></A> is ignored by LaTeX2HTML, as page numbers have no meaning within HTML files. @@ -1591,6 +1760,13 @@ HTML files. Troubleshooting </H1> +<P> +This is a list of common problems, for a more up-to-date FAQ, see +<TT><A NAME="tex2html7" + HREF="http://theoval.cmp.uea.ac.uk/~nlct/packages/faq/">http://theoval.cmp.uea.ac.uk/~nlct/packages/faq/</A></TT>. + +<P> + <OL> <LI>My glossary hasn't appeared. @@ -1598,56 +1774,56 @@ Troubleshooting Check the following: <UL> -<LI>Have you included the command <TT>\makeglossary</TT><A NAME="2966"></A> +<LI>Have you included the command <TT>\makeglossary</TT><A NAME="3195"></A> in the preamble? <P> </LI> -<LI>Have you put the command <TT>\printglossary</TT><A NAME="2971"></A> where +<LI>Have you put the command <TT>\printglossary</TT><A NAME="3200"></A> where you want the glossary to appear? <P> </LI> -<LI>Have you used <TT>makeglos.pl</TT><A NAME="2976"></A> or <TT>makeindex</TT><A NAME="2979"></A>, -and if you did, did it successfully create the <TT>gls</TT><A NAME="2982"></A> -file? (Check the transcript <TT>glg</TT><A NAME="2984"></A> file.) +<LI>Have you used <TT>makeglos.pl</TT><A NAME="3205"></A> or <TT>makeindex</TT><A NAME="3208"></A>, +and if you did, did it successfully create the <TT>gls</TT><A NAME="3211"></A> +file? (Check the transcript <TT>glg</TT><A NAME="3213"></A> file.) <P> <UL> -<LI>If you used <TT>makeindex</TT><A NAME="2986"></A> directly, did you specify -the <TT>ist</TT><A NAME="2989"></A> file created by <TT>\makeglossary</TT><A NAME="2991"></A>, +<LI>If you used <TT>makeindex</TT><A NAME="3215"></A> directly, did you specify +the <TT>ist</TT><A NAME="3218"></A> file created by <TT>\makeglossary</TT><A NAME="3220"></A>, and did you remember to specify the output file with the extension -<TT>gls</TT><A NAME="2996"></A>? +<TT>gls</TT><A NAME="3225"></A>? <P> </LI> -<LI>When <TT>makeindex</TT><A NAME="2998"></A> scans the <TT>ist</TT><A NAME="3001"></A> file, +<LI>When <TT>makeindex</TT><A NAME="3227"></A> scans the <TT>ist</TT><A NAME="3230"></A> file, it should generate the message: <PRE> 9 attributes redefined, 0 ignored </PRE> If you have a number other than 0 ignored, then there is something -wrong with the <TT>ist</TT><A NAME="3003"></A> file. Some packages can cause +wrong with the <TT>ist</TT><A NAME="3232"></A> file. Some packages can cause problems with the creation of this file, see -item <A HREF="#itm:ngerman">15</A> below. +item <A HREF="#itm:ngerman">16</A> below. </LI> </UL> <P> </LI> <LI>Have you remembered to LaTeX your document again -after using <TT>makeglos.pl</TT><A NAME="3005"></A> or <TT>makeindex</TT><A NAME="3008"></A>? +after using <TT>makeglos.pl</TT><A NAME="3234"></A> or <TT>makeindex</TT><A NAME="3237"></A>? <P> </LI> -<LI>Have you used <TT>\glossary</TT><A NAME="3011"></A> or <TT>\xglossary</TT><A NAME="3016"></A>? +<LI>Have you used <TT>\glossary</TT><A NAME="3240"></A> or <TT>\xglossary</TT><A NAME="3245"></A>? <P> </LI> -<LI>If you have used <TT>\storeglosentry</TT><A NAME="3021"></A>, have you also -used <TT>\useglosentry</TT><A NAME="3026"></A>, <TT>\useGlosentry</TT><A NAME="3031"></A> or -<TT>\gls</TT><A NAME="3036"></A>? +<LI>If you have used <TT>\storeglosentry</TT><A NAME="3250"></A>, have you also +used <TT>\useglosentry</TT><A NAME="3255"></A>, <TT>\useGlosentry</TT><A NAME="3260"></A> or +<TT>\gls</TT><A NAME="3265"></A>? </LI> </UL> @@ -1660,9 +1836,9 @@ all the analogous commands to the above? <LI>My list of acronyms hasn't appeared. <P> -Have you used the <TT>acronym=true</TT><A NAME="3048"></A> package option? If no, +Have you used the <TT>acronym=true</TT><A NAME="3277"></A> package option? If no, check the answers to the previous item, if yes, make sure -you have used <TT>\makeacronym</TT><A NAME="3050"></A> and <TT>\printacronym</TT><A NAME="3055"></A>. +you have used <TT>\makeacronym</TT><A NAME="3279"></A> and <TT>\printacronym</TT><A NAME="3284"></A>. Have you used any of the acronyms you have defined? Remember that <TT>\acrsh</TT>, <TT>\acrln</TT>, <TT>\</TT><I>acr-name</I><TT>short</TT> and @@ -1672,12 +1848,23 @@ name of an acronym command. <P> </LI> +<LI>My acronym has been expanded twice. + +<P> +By default, if any of your acronym commands occur within a +group (this includes environments which form implicit grouping) +the effect will be local to that group. You can either unset +the acronym outside the group, or use the <TT>global</TT><A NAME="3304"></A> +package option. + +<P> +</LI> <LI>I get an error when using the command -<TT>\saveglosentry</TT><A NAME="3070"></A>. +<TT>\saveglosentry</TT><A NAME="3308"></A>. <P> Don't use this command it's obsolete, use -<TT>\storeglosentry</TT><A NAME="3075"></A> instead. +<TT>\storeglosentry</TT><A NAME="3313"></A> instead. <P> </LI> @@ -1687,14 +1874,14 @@ Don't use this command it's obsolete, use Check the following <UL> -<LI>If you defined the entry using <TT>\storeglosentry</TT><A NAME="3080"></A> -have you used either <TT>\useglosentry</TT><A NAME="3085"></A>, -<TT>\useGlosentry</TT><A NAME="3090"></A> or <TT>\gls</TT><A NAME="3095"></A>? +<LI>If you defined the entry using <TT>\storeglosentry</TT><A NAME="3318"></A> +have you used either <TT>\useglosentry</TT><A NAME="3323"></A>, +<TT>\useGlosentry</TT><A NAME="3328"></A> or <TT>\gls</TT><A NAME="3333"></A>? <P> </LI> -<LI>Have you remembered to <TT>\protect</TT><A NAME="3100"></A> commands -such as <TT>\mathcal</TT> within <TT>\storeglosentry</TT><A NAME="3107"></A>? +<LI>Have you remembered to <TT>\protect</TT><A NAME="3338"></A> commands +such as <TT>\mathcal</TT> within <TT>\storeglosentry</TT><A NAME="3345"></A>? <P> </LI> @@ -1705,7 +1892,7 @@ with a double quote character? </UL> <P> -Check the <TT>makeindex</TT><A NAME="3112"></A> log file to see if there are +Check the <TT>makeindex</TT><A NAME="3350"></A> log file to see if there are any error messages. <P> @@ -1713,7 +1900,7 @@ any error messages. <LI>My glossary has duplicate entries on separate lines. <P> -LaTeX treats multiple spaces equivalent to a single space, but <TT>makeindex</TT><A NAME="3115"></A> +LaTeX treats multiple spaces equivalent to a single space, but <TT>makeindex</TT><A NAME="3353"></A> takes spaces into account when determining whether two entries are identical. For example: <PRE> @@ -1725,28 +1912,28 @@ and \glossary{name=Identity matrix, description=diagonal matrix with 1's along the diagonal} </PRE> -will be treated as different entries by <TT>makeindex</TT><A NAME="3118"></A>, +will be treated as different entries by <TT>makeindex</TT><A NAME="3356"></A>, because the first has only one space between `Identity' and `matrix' and the second has two. The easiest way to ensure consistency is to use -<TT>\storeglosentry</TT><A NAME="3121"></A> together with <TT>\useglosentry</TT><A NAME="3126"></A>, -<TT>\useGlosentry</TT><A NAME="3131"></A> or <TT>\gls</TT><A NAME="3136"></A>. +<TT>\storeglosentry</TT><A NAME="3359"></A> together with <TT>\useglosentry</TT><A NAME="3364"></A>, +<TT>\useGlosentry</TT><A NAME="3369"></A> or <TT>\gls</TT><A NAME="3374"></A>. <P> </LI> <LI>I had an error, fixed it, but I keep getting the same error message. <P> -Suppose you've made an error in the <TT>\glossary</TT><A NAME="3141"></A> command. For example: +Suppose you've made an error in the <TT>\glossary</TT><A NAME="3379"></A> command. For example: <PRE> \glossary{name=Java,description=A programming language,format=texbf} </PRE> -In this case <TT>textbf</TT> has been mis-spelt. This error will be copied to the <TT>glo</TT><A NAME="3146"></A> file, -which in turn will be copied to the <TT>gls</TT><A NAME="3148"></A> file by -<TT>makeindex</TT><A NAME="3150"></A>. A subsequent run of LaTeX will +In this case <TT>textbf</TT> has been mis-spelt. This error will be copied to the <TT>glo</TT><A NAME="3384"></A> file, +which in turn will be copied to the <TT>gls</TT><A NAME="3386"></A> file by +<TT>makeindex</TT><A NAME="3388"></A>. A subsequent run of LaTeX will read this error in. If you fix the error in your main document, the error will still be read in from -the <TT>gls</TT><A NAME="3153"></A> file. The best thing to do is to delete the -<TT>gls</TT><A NAME="3155"></A> file, and try again. +the <TT>gls</TT><A NAME="3391"></A> file. The best thing to do is to delete the +<TT>gls</TT><A NAME="3393"></A> file, and try again. <P> </LI> @@ -1754,11 +1941,11 @@ the <TT>gls</TT><A NAME="3153"></A> file. The best thing to do is to delete the <P> This may occur if you have long entry names, and you are using -either the <TT>style=long</TT><A NAME="3164"></A> or <TT>style=super</TT><A NAME="3173"></A> +either the <TT>style=long</TT><A NAME="3402"></A> or <TT>style=super</TT><A NAME="3411"></A> options. The width of the description column is proportional to the text width (in fact, it's <code>0.6\textwidth</code>) but the first column is as wide as the widest entry name. You -can either redefine <TT>\glossaryalignment</TT><A NAME="3175"></A> to change the +can either redefine <TT>\glossaryalignment</TT><A NAME="3413"></A> to change the column specifications, or use one of the list-type styles. <P> @@ -1771,19 +1958,19 @@ You may need to LaTeX your document again (just as you have to do with <TT>\ <P> </LI> -<LI>I'm getting a <TT>keyval</TT><A NAME="3184"></A> error. +<LI>I'm getting a <TT>keyval</TT><A NAME="3422"></A> error. <P> -The <TT>glossary</TT><A NAME="3187"></A> package uses the <TT>keyval</TT><A NAME="3190"></A> +The <TT>glossary</TT><A NAME="3425"></A> package uses the <TT>keyval</TT><A NAME="3428"></A> package to extract the information from <I>key</I>=<I>value</I> comma separated lists. You need to make sure the syntax is correct. If your <I>value</I> contains a -comma, you will need to enclose <I>value</I> in curly braces. See the <TT>keyval</TT><A NAME="3193"></A> documentation for -further information<A NAME="tex2html6" - HREF="#foot1419"><SUP>5</SUP></A>. +comma, you will need to enclose <I>value</I> in curly braces. See the <TT>keyval</TT><A NAME="3431"></A> documentation for +further information<A NAME="tex2html8" + HREF="#foot1547"><SUP>6</SUP></A>. <P> </LI> -<LI>I've used the <TT>hyper</TT><A NAME="3201"></A> option, but nothing happens +<LI>I've used the <TT>hyper</TT><A NAME="3439"></A> option, but nothing happens when I click on the numbers in the glossary. <P> @@ -1793,32 +1980,32 @@ Check the following: <LI>Have you remembered to use PDFLaTeX instead of LaTeX, or used a driver that understands hyperlinks? </LI> -<LI>Have you remembered to use the <TT>hyperref</TT><A NAME="3205"></A> or -<TT>html</TT><A NAME="3208"></A> package? +<LI>Have you remembered to use the <TT>hyperref</TT><A NAME="3443"></A> or +<TT>html</TT><A NAME="3446"></A> package? </LI> -<LI>Have you remembered to use a formatting command which uses <TT>\hyperlink</TT>? (E.g. using <TT>hyperbf</TT><A NAME="3213"></A><A NAME="3214"></A> instead -of <TT>textbf</TT>)? Remember to check the <TT>format</TT><A NAME="3218"></A> key -in your <TT>\glossary</TT><A NAME="3222"></A> commands, and the -<TT>glsnumformat</TT><A NAME="3227"></A> key in the <TT>\setglossary</TT><A NAME="3231"></A> +<LI>Have you remembered to use a formatting command which uses <TT>\hyperlink</TT>? (E.g. using <TT>hyperbf</TT><A NAME="3451"></A><A NAME="3452"></A> instead +of <TT>textbf</TT>)? Remember to check the <TT>format</TT><A NAME="3456"></A> key +in your <TT>\glossary</TT><A NAME="3460"></A> commands, and the +<TT>glsnumformat</TT><A NAME="3465"></A> key in the <TT>\setglossary</TT><A NAME="3469"></A> command. </LI> <LI>What application are you using to view the PDF file? Ghostview can display a PDF file, but ignores the links. If you are using Windows, try -using Adobe's Acrobat Reader, or if you are using UNIX or Linux, try using <TT>xpdf</TT><A NAME="3236"></A> or <TT>acroread</TT><A NAME="3239"></A>. +using Adobe's Acrobat Reader, or if you are using UNIX or Linux, try using <TT>xpdf</TT><A NAME="3474"></A> or <TT>acroread</TT><A NAME="3477"></A>. </LI> </OL> <P> </LI> -<LI>The <TT>glossary</TT><A NAME="3242"></A> package conflicts with the -<TT>datetime</TT><A NAME="3245"></A> package. +<LI>The <TT>glossary</TT><A NAME="3480"></A> package conflicts with the +<TT>datetime</TT><A NAME="3483"></A> package. <P> This has been fixed in version 2.01. <P> </LI> -<LI>I get an error when using certain commands, such as <TT>\cite</TT> or <code>~</code> in <TT>\newacronym</TT><A NAME="3250"></A>. +<LI>I get an error when using certain commands, such as <TT>\cite</TT> or <code>~</code> in <TT>\newacronym</TT><A NAME="3488"></A>. <P> This has been fixed in version 2.1. @@ -1831,10 +2018,11 @@ This has been fixed in version 2.1. </PRE> <P> -The <TT>glossary</TT><A NAME="3255"></A> package used to conflict with the -<TT>array</TT><A NAME="3258"></A> package. This was fixed in version 2.1, -however, you must load the <TT>array</TT><A NAME="3261"></A> package -<I>prior</I> to loading the <TT>glossary</TT><A NAME="3264"></A> package. +The <TT>glossary</TT><A NAME="3493"></A> package used to conflict with the +<TT>array</TT><A NAME="3496"></A> package. This was fixed in version 2.1. +As from version 2.3, it doesn't matter whether you load +the <TT>glossary</TT><A NAME="3499"></A> package before or after the +<TT>array</TT><A NAME="3502"></A> package. <P> </LI> @@ -1873,19 +2061,19 @@ or if you are using PDFLaTeX: <P> </LI> -<LI><A NAME="itm:ngerman"></A> The <TT>glossary</TT><A NAME="3269"></A> package conflicts with -<TT>ngerman</TT><A NAME="3272"></A>. +<LI><A NAME="itm:ngerman"></A> The <TT>glossary</TT><A NAME="3507"></A> package conflicts with +<TT>ngerman</TT><A NAME="3510"></A>. <P> -This problem is caused by the fact that <TT>ngerman</TT><A NAME="3275"></A> +This problem is caused by the fact that <TT>ngerman</TT><A NAME="3513"></A> redefines the effect of the double quote character, but this character is used in the creation of the -<TT>ist</TT><A NAME="3278"></A> <TT>makeindex</TT><A NAME="3280"></A> style file. +<TT>ist</TT><A NAME="3516"></A> <TT>makeindex</TT><A NAME="3518"></A> style file. Try one of the following methods: <OL> -<LI>Include the <TT>ngerman</TT><A NAME="3283"></A> package after the -<TT>\makeglossary</TT><A NAME="3286"></A> command: +<LI>Include the <TT>ngerman</TT><A NAME="3521"></A> package after the +<TT>\makeglossary</TT><A NAME="3524"></A> command: <PRE> \usepackage{glossary} \makeglossary @@ -1894,11 +2082,11 @@ Try one of the following methods: <P> </LI> -<LI>First omit the <TT>ngerman</TT><A NAME="3291"></A> package and include -<TT>\makeglossary</TT><A NAME="3294"></A> then LaTeX your document. -This will create the <TT>ist</TT><A NAME="3299"></A> file. Then include the -<TT>ngerman</TT><A NAME="3301"></A> package, and insert <TT>\noist</TT><A NAME="3304"></A> before -the <TT>\makeglossary</TT><A NAME="3309"></A> command, this will prevent further attempts to generate the <TT>ist</TT><A NAME="3314"></A> file. +<LI>First omit the <TT>ngerman</TT><A NAME="3529"></A> package and include +<TT>\makeglossary</TT><A NAME="3532"></A> then LaTeX your document. +This will create the <TT>ist</TT><A NAME="3537"></A> file. Then include the +<TT>ngerman</TT><A NAME="3539"></A> package, and insert <TT>\noist</TT><A NAME="3542"></A> before +the <TT>\makeglossary</TT><A NAME="3547"></A> command, this will prevent further attempts to generate the <TT>ist</TT><A NAME="3552"></A> file. <PRE> \usepackage{ngerman} \usepackage{glossary} @@ -1907,8 +2095,8 @@ the <TT>\makeglossary</TT><A NAME="3309"></A> command, this will prevent fur <P> </LI> -<LI>Use <TT>\noist</TT><A NAME="3316"></A>, as above, and create the -<TT>ist</TT><A NAME="3321"></A> file +<LI>Use <TT>\noist</TT><A NAME="3554"></A>, as above, and create the +<TT>ist</TT><A NAME="3559"></A> file in an ordinary text editor. The file should contain the following lines: <PRE> @@ -1929,15 +2117,15 @@ also cause a problem, if so, try any of the above. <P> </LI> -<LI><TT>makeglos.pl</TT><A NAME="3323"></A> gives the following error message: +<LI><TT>makeglos.pl</TT><A NAME="3561"></A> gives the following error message: <PRE> unable to extract name from glossary item: </PRE> <P> -You are using an old version of <TT>makeglos.pl</TT><A NAME="3326"></A> with a -new version of the <TT>glossary</TT><A NAME="3329"></A> package. You will need -to update your version <TT>makeglos.pl</TT><A NAME="3332"></A>. +You are using an old version of <TT>makeglos.pl</TT><A NAME="3564"></A> with a +new version of the <TT>glossary</TT><A NAME="3567"></A> package. You will need +to update your version <TT>makeglos.pl</TT><A NAME="3570"></A>. </LI> </OL> Let me know if you encounter any other problems or if you have any comments regarding this package. @@ -1955,35 +2143,35 @@ use is deprecated. <P> -<TT>\saveglosentry</TT><A NAME="3335"></A>{ <I>name</I>}{<I>description</I>} +<TT>\saveglosentry</TT><A NAME="3573"></A>{ <I>name</I>}{<I>description</I>} <BR> This command has now been replaced by <TT>\storeglosentry</TT>. <P> -The command <TT>\glsprimaryfmt</TT> is no longer used in <TT>\newacronym</TT><A NAME="3344"></A> as you can end up with duplicate +The command <TT>\glsprimaryfmt</TT> is no longer used in <TT>\newacronym</TT><A NAME="3582"></A> as you can end up with duplicate page numbers, however the command is currently still defined (although it may be removed in future versions.) <P> -The package option <TT>hyperacronym</TT><A NAME="3354"></A> is now superseded by the package option -<TT>hyper</TT><A NAME="3363"></A>. This option was implemented prior to the -introduction of the command <TT>\xglossary</TT><A NAME="3367"></A>. Since the -acronyms now use <TT>\xglossary</TT><A NAME="3372"></A>, there is no difference -between the <TT>hyperacronym</TT><A NAME="3382"></A> and <TT>hyper</TT><A NAME="3391"></A> options. +The package option <TT>hyperacronym</TT><A NAME="3592"></A> is now superseded by the package option +<TT>hyper</TT><A NAME="3601"></A>. This option was implemented prior to the +introduction of the command <TT>\xglossary</TT><A NAME="3605"></A>. Since the +acronyms now use <TT>\xglossary</TT><A NAME="3610"></A>, there is no difference +between the <TT>hyperacronym</TT><A NAME="3620"></A> and <TT>hyper</TT><A NAME="3629"></A> options. This option has a boolean value: <DL> -<DT><STRONG><TT>true</TT><A NAME="3395"></A></STRONG></DT> +<DT><STRONG><TT>true</TT><A NAME="3633"></A></STRONG></DT> <DD>Make acronyms link to their corresponding entry in the glossary </DD> -<DT><STRONG><TT>false</TT><A NAME="3397"></A></STRONG></DT> +<DT><STRONG><TT>false</TT><A NAME="3635"></A></STRONG></DT> <DD>Acronyms don't have a hyperlink. </DD> </DL> -If the <TT>hyperref</TT><A NAME="3399"></A> package has been loaded prior to -loading <TT>glossary.sty</TT> or if <TT>hyper=true</TT><A NAME="3409"></A> is set, -<TT>hyperacronym=true</TT><A NAME="3418"></A> otherwise -<TT>hyperacronym=false</TT><A NAME="3427"></A>. +If the <TT>hyperref</TT><A NAME="3637"></A> package has been loaded prior to +loading <TT>glossary.sty</TT> or if <TT>hyper=true</TT><A NAME="3647"></A> is set, +<TT>hyperacronym=true</TT><A NAME="3656"></A> otherwise +<TT>hyperacronym=false</TT><A NAME="3665"></A>. <P> <H1><A NAME="SECTION000150000000000000000"> @@ -1999,7 +2187,7 @@ University of East Anglia Norwich. Norfolk <BR> NR4 7TJ. United Kingdom. -<BR><TT><A NAME="tex2html7" +<BR><TT><A NAME="tex2html9" HREF="http://theoval.cmp.uea.ac.uk/~nlct/">http://theoval.cmp.uea.ac.uk/~nlct/</A></TT> <P> @@ -2008,13 +2196,8 @@ Acknowledgements</A> </H1> <P> -I would like to thank the following people for their -suggestions: -Jens Happe, -Dmitry Katsubo, -Markus Lazanowski, -Slava Pestov and -Dario Teixeira +I would like to thank all the many people who have made suggestions +and pointed out bugs. <P> @@ -2025,87 +2208,92 @@ Dario Teixeira Index</A> </H2><DL COMPACT> <DT><STRONG><TT>acroread</TT></STRONG> -<DD><A HREF="manual.html#3239">Troubleshooting</A> +<DD><A HREF="manual.html#3477">Troubleshooting</A> <DT><STRONG><TT>array</TT></STRONG> -<DD><A HREF="manual.html#2672">Customizing the Glossary</A> - | <A HREF="manual.html#2675">Customizing the Glossary</A> - | <A HREF="manual.html#3258">Troubleshooting</A> - | <A HREF="manual.html#3261">Troubleshooting</A> +<DD><A HREF="manual.html#2933">Customizing the Glossary</A> + | <A HREF="manual.html#2938">Customizing the Glossary</A> + | <A HREF="manual.html#3496">Troubleshooting</A> + | <A HREF="manual.html#3502">Troubleshooting</A> <DT><STRONG><TT>datetime</TT></STRONG> -<DD><A HREF="manual.html#3245">Troubleshooting</A> +<DD><A HREF="manual.html#3483">Troubleshooting</A> <DT><STRONG><TT>\descriptionname</TT></STRONG> -<DD><A HREF="manual.html#2779">Customizing the Glossary</A> +<DD><A HREF="manual.html#3008">Customizing the Glossary</A> <DT><STRONG>file types</STRONG> <DD><DL COMPACT> <DT><STRONG>acr</STRONG> -<DD><A HREF="manual.html#2363">Acronyms</A> +<DD><A HREF="manual.html#2512">Acronyms</A> <DT><STRONG>cfg</STRONG> -<DD><A HREF="manual.html#2023">Package Options</A> +<DD><A HREF="manual.html#2170">Package Options</A> + | <A HREF="manual.html#2531">Acronyms</A> <DT><STRONG>glg</STRONG> -<DD><A HREF="manual.html#1646">makeglos.pl</A> - | <A HREF="manual.html#2255">Defining New Glossary Types</A> - | <A HREF="manual.html#2984">Troubleshooting</A> +<DD><A HREF="manual.html#1780">makeglos.pl</A> + | <A HREF="manual.html#2404">Defining New Glossary Types</A> + | <A HREF="manual.html#3213">Troubleshooting</A> <DT><STRONG>glo</STRONG> -<DD><A HREF="manual.html#1619">makeglos.pl</A> - | <A HREF="manual.html#1634">makeglos.pl</A> - | <A HREF="manual.html#1654">makeglos.pl</A> - | <A HREF="manual.html#1665">makeglos.pl</A> - | <A HREF="manual.html#2239">Defining New Glossary Types</A> - | <A HREF="manual.html#3146">Troubleshooting</A> +<DD><A HREF="manual.html#1753">makeglos.pl</A> + | <A HREF="manual.html#1768">makeglos.pl</A> + | <A HREF="manual.html#1788">makeglos.pl</A> + | <A HREF="manual.html#1799">makeglos.pl</A> + | <A HREF="manual.html#2388">Defining New Glossary Types</A> + | <A HREF="manual.html#3384">Troubleshooting</A> <DT><STRONG>gls</STRONG> -<DD><A HREF="manual.html#1644">makeglos.pl</A> - | <A HREF="manual.html#1709">Displaying the Glossary</A> - | <A HREF="manual.html#2250">Defining New Glossary Types</A> - | <A HREF="manual.html#2982">Troubleshooting</A> - | <A HREF="manual.html#2996">Troubleshooting</A> - | <A HREF="manual.html#3148">Troubleshooting</A> - | <A HREF="manual.html#3153">Troubleshooting</A> - | <A HREF="manual.html#3155">Troubleshooting</A> +<DD><A HREF="manual.html#1778">makeglos.pl</A> + | <A HREF="manual.html#1843">Displaying the Glossary</A> + | <A HREF="manual.html#2399">Defining New Glossary Types</A> + | <A HREF="manual.html#3211">Troubleshooting</A> + | <A HREF="manual.html#3225">Troubleshooting</A> + | <A HREF="manual.html#3386">Troubleshooting</A> + | <A HREF="manual.html#3391">Troubleshooting</A> + | <A HREF="manual.html#3393">Troubleshooting</A> <DT><STRONG>ist</STRONG> -<DD><A HREF="manual.html#1629">makeglos.pl</A> - | <A HREF="manual.html#1639">makeglos.pl</A> - | <A HREF="manual.html#1670">makeglos.pl</A> - | <A HREF="manual.html#1677">makeglos.pl</A> - | <A HREF="manual.html#1696">makeglos.pl</A> - | <A HREF="manual.html#2989">Troubleshooting</A> - | <A HREF="manual.html#3001">Troubleshooting</A> - | <A HREF="manual.html#3003">Troubleshooting</A> - | <A HREF="manual.html#3278">Troubleshooting</A> - | <A HREF="manual.html#3299">Troubleshooting</A> - | <A HREF="manual.html#3314">Troubleshooting</A> - | <A HREF="manual.html#3321">Troubleshooting</A> +<DD><A HREF="manual.html#1763">makeglos.pl</A> + | <A HREF="manual.html#1773">makeglos.pl</A> + | <A HREF="manual.html#1804">makeglos.pl</A> + | <A HREF="manual.html#1811">makeglos.pl</A> + | <A HREF="manual.html#1830">makeglos.pl</A> + | <A HREF="manual.html#3218">Troubleshooting</A> + | <A HREF="manual.html#3230">Troubleshooting</A> + | <A HREF="manual.html#3232">Troubleshooting</A> + | <A HREF="manual.html#3516">Troubleshooting</A> + | <A HREF="manual.html#3537">Troubleshooting</A> + | <A HREF="manual.html#3552">Troubleshooting</A> + | <A HREF="manual.html#3559">Troubleshooting</A> <DT><STRONG>perl</STRONG> -<DD><A HREF="manual.html#2882">LaTeX2HTML Style File</A> - | <A HREF="manual.html#2884">LaTeX2HTML Style File</A> +<DD><A HREF="manual.html#3111">LaTeX2HTML Style File</A> + | <A HREF="manual.html#3113">LaTeX2HTML Style File</A> </DL> +<DT><STRONG><TT>\glodesc</TT></STRONG> +<DD><A HREF="manual.html#2563">Acronyms</A> + | <A HREF="manual.html#2577">Acronyms</A> <DT><STRONG><TT>\glolong</TT></STRONG> -<DD><A HREF="manual.html#2386">Acronyms</A> +<DD><A HREF="manual.html#2541">Acronyms</A> + | <A HREF="manual.html#2553">Acronyms</A> <DT><STRONG><TT>\gloshort</TT></STRONG> -<DD><A HREF="manual.html#2391">Acronyms</A> +<DD><A HREF="manual.html#2546">Acronyms</A> + | <A HREF="manual.html#2558">Acronyms</A> <DT><STRONG><TT>glossary</TT></STRONG> -<DD><A HREF="manual.html#1481">Introduction</A> - | <A HREF="manual.html#1584">Generating Glossary Information</A> - | <A HREF="manual.html#2027">Package Options</A> - | <A HREF="manual.html#2030">Examples</A> - | <A HREF="manual.html#2210">Defining New Glossary Types</A> - | <A HREF="manual.html#2287">Acronyms</A> - | <A HREF="manual.html#2292">Acronyms</A> - | <A HREF="manual.html#2440">Acronyms</A> - | <A HREF="manual.html#2475">Customizing the Glossary</A> - | <A HREF="manual.html#2678">Customizing the Glossary</A> - | <A HREF="manual.html#2689">Customizing the Glossary</A> - | <A HREF="manual.html#2822">Sample Documents</A> - | <A HREF="manual.html#2941">Limitations</A> - | <A HREF="manual.html#2946">Limitations</A> - | <A HREF="manual.html#3011">Troubleshooting</A> - | <A HREF="manual.html#3141">Troubleshooting</A> - | <A HREF="manual.html#3187">Troubleshooting</A> - | <A HREF="manual.html#3222">Troubleshooting</A> - | <A HREF="manual.html#3242">Troubleshooting</A> - | <A HREF="manual.html#3255">Troubleshooting</A> - | <A HREF="manual.html#3264">Troubleshooting</A> - | <A HREF="manual.html#3269">Troubleshooting</A> - | <A HREF="manual.html#3329">Troubleshooting</A> +<DD><A HREF="manual.html#1609">Introduction</A> + | <A HREF="manual.html#1712">Generating Glossary Information</A> + | <A HREF="manual.html#2174">Package Options</A> + | <A HREF="manual.html#2177">Examples</A> + | <A HREF="manual.html#2357">Defining New Glossary Types</A> + | <A HREF="manual.html#2436">Acronyms</A> + | <A HREF="manual.html#2441">Acronyms</A> + | <A HREF="manual.html#2636">Acronyms</A> + | <A HREF="manual.html#2671">Customizing the Glossary</A> + | <A HREF="manual.html#2947">Customizing the Glossary</A> + | <A HREF="manual.html#3051">Sample Documents</A> + | <A HREF="manual.html#3170">Limitations</A> + | <A HREF="manual.html#3175">Limitations</A> + | <A HREF="manual.html#3240">Troubleshooting</A> + | <A HREF="manual.html#3379">Troubleshooting</A> + | <A HREF="manual.html#3425">Troubleshooting</A> + | <A HREF="manual.html#3460">Troubleshooting</A> + | <A HREF="manual.html#3480">Troubleshooting</A> + | <A HREF="manual.html#3493">Troubleshooting</A> + | <A HREF="manual.html#3499">Troubleshooting</A> + | <A HREF="manual.html#3507">Troubleshooting</A> + | <A HREF="manual.html#3567">Troubleshooting</A> <DT><STRONG>glossary border</STRONG> <DD><i>see </i> package options, border <DT><STRONG>glossary columns</STRONG> @@ -2115,542 +2303,565 @@ Index</A> <DT><STRONG><TT>\glossary</TT> keys</STRONG> <DD><DL COMPACT> <DT><STRONG>description</STRONG> -<DD><A HREF="manual.html#1510">Generating Glossary Information</A> - | <A HREF="manual.html#1607">Storing Glossary Information</A> +<DD><A HREF="manual.html#1638">Generating Glossary Information</A> + | <A HREF="manual.html#1735">Storing Glossary Information</A> + | <A HREF="manual.html#2568">Acronyms</A> <DT><STRONG>format</STRONG> -<DD><A HREF="manual.html#1518">Generating Glossary Information</A> - | <A HREF="manual.html#1522">Generating Glossary Information</A> - | <A HREF="manual.html#3218">Troubleshooting</A> +<DD><A HREF="manual.html#1646">Generating Glossary Information</A> + | <A HREF="manual.html#1650">Generating Glossary Information</A> + | <A HREF="manual.html#3456">Troubleshooting</A> <DD><DL COMPACT> <DT><STRONG>hyperbf</STRONG> -<DD><A HREF="manual.html#1544">Generating Glossary Information</A> - | <A HREF="manual.html#3214">Troubleshooting</A> +<DD><A HREF="manual.html#1672">Generating Glossary Information</A> + | <A HREF="manual.html#3452">Troubleshooting</A> <DT><STRONG>hyperit</STRONG> -<DD><A HREF="manual.html#1549">Generating Glossary Information</A> +<DD><A HREF="manual.html#1677">Generating Glossary Information</A> <DT><STRONG>hyperrm</STRONG> -<DD><A HREF="manual.html#1529">Generating Glossary Information</A> - | <A HREF="manual.html#1563">Generating Glossary Information</A> +<DD><A HREF="manual.html#1657">Generating Glossary Information</A> + | <A HREF="manual.html#1691">Generating Glossary Information</A> <DT><STRONG>hypersf</STRONG> -<DD><A HREF="manual.html#1534">Generating Glossary Information</A> +<DD><A HREF="manual.html#1662">Generating Glossary Information</A> <DT><STRONG>hypertt</STRONG> -<DD><A HREF="manual.html#1539">Generating Glossary Information</A> +<DD><A HREF="manual.html#1667">Generating Glossary Information</A> </DL> <DT><STRONG>name</STRONG> -<DD><A HREF="manual.html#1506">Generating Glossary Information</A> - | <A HREF="manual.html#2306">Acronyms</A> - | <A HREF="manual.html#2315">Acronyms</A> - | <A HREF="manual.html#2380">Acronyms</A> - | <A HREF="manual.html#2685">Customizing the Glossary</A> +<DD><A HREF="manual.html#1634">Generating Glossary Information</A> + | <A HREF="manual.html#2455">Acronyms</A> + | <A HREF="manual.html#2464">Acronyms</A> + | <A HREF="manual.html#2535">Acronyms</A> + | <A HREF="manual.html#2943">Customizing the Glossary</A> <DT><STRONG>sort</STRONG> -<DD><A HREF="manual.html#1514">Generating Glossary Information</A> - | <A HREF="manual.html#2321">Acronyms</A> +<DD><A HREF="manual.html#1642">Generating Glossary Information</A> + | <A HREF="manual.html#2470">Acronyms</A> </DL> <DT><STRONG>glossary style</STRONG> <DD><i>see </i> package options, style <DT><STRONG>glossary.cfg</STRONG> <DD><i>see </i> file type, cfg <DT><STRONG><TT>\glossaryalignment</TT></STRONG> -<DD><A HREF="manual.html#3175">Troubleshooting</A> +<DD><A HREF="manual.html#3413">Troubleshooting</A> <DT><STRONG><TT>\glossaryheader</TT></STRONG> -<DD><A HREF="manual.html#2851">Sample Documents</A> +<DD><A HREF="manual.html#3080">Sample Documents</A> <DT><STRONG><TT>\glossaryname</TT></STRONG> -<DD><A HREF="manual.html#1715">Displaying the Glossary</A> - | <A HREF="manual.html#2280">Defining New Glossary Types</A> - | <A HREF="manual.html#2846">Sample Documents</A> +<DD><A HREF="manual.html#1849">Displaying the Glossary</A> + | <A HREF="manual.html#2429">Defining New Glossary Types</A> + | <A HREF="manual.html#3075">Sample Documents</A> <DT><STRONG><TT>\gls</TT></STRONG> -<DD><A HREF="manual.html#3036">Troubleshooting</A> - | <A HREF="manual.html#3095">Troubleshooting</A> - | <A HREF="manual.html#3136">Troubleshooting</A> +<DD><A HREF="manual.html#3265">Troubleshooting</A> + | <A HREF="manual.html#3333">Troubleshooting</A> + | <A HREF="manual.html#3374">Troubleshooting</A> <DT><STRONG><TT>html</TT></STRONG> -<DD><A HREF="manual.html#1902">Package Options</A> - | <A HREF="manual.html#3208">Troubleshooting</A> +<DD><A HREF="manual.html#2036">Package Options</A> + | <A HREF="manual.html#3446">Troubleshooting</A> <DT><STRONG><TT>hyperref</TT></STRONG> -<DD><A HREF="manual.html#1833">Package Options</A> - | <A HREF="manual.html#1899">Package Options</A> - | <A HREF="manual.html#2819">Sample Documents</A> - | <A HREF="manual.html#2864">Sample Documents</A> - | <A HREF="manual.html#3205">Troubleshooting</A> - | <A HREF="manual.html#3399">Obsolete Commands</A> +<DD><A HREF="manual.html#1967">Package Options</A> + | <A HREF="manual.html#2033">Package Options</A> + | <A HREF="manual.html#3048">Sample Documents</A> + | <A HREF="manual.html#3093">Sample Documents</A> + | <A HREF="manual.html#3443">Troubleshooting</A> + | <A HREF="manual.html#3637">Obsolete Commands</A> <DT><STRONG><TT>\hyperrm</TT></STRONG> -<DD><A HREF="manual.html#1567">Generating Glossary Information</A> +<DD><A HREF="manual.html#1695">Generating Glossary Information</A> <DT><STRONG><TT>keyval</TT></STRONG> -<DD><A HREF="manual.html#3184">Troubleshooting</A> - | <A HREF="manual.html#3190">Troubleshooting</A> - | <A HREF="manual.html#3193">Troubleshooting</A> +<DD><A HREF="manual.html#3422">Troubleshooting</A> + | <A HREF="manual.html#3428">Troubleshooting</A> + | <A HREF="manual.html#3431">Troubleshooting</A> <DT><STRONG><TT>\makeacronym</TT></STRONG> -<DD><A HREF="manual.html#2353">Acronyms</A> - | <A HREF="manual.html#3050">Troubleshooting</A> +<DD><A HREF="manual.html#2502">Acronyms</A> + | <A HREF="manual.html#3279">Troubleshooting</A> <DT><STRONG><TT>makeglos.pl</TT></STRONG> -<DD><A HREF="manual.html#1648">makeglos.pl</A> - | <A HREF="manual.html#1656">makeglos.pl</A> - | <A HREF="manual.html#1659">makeglos.pl</A> - | <A HREF="manual.html#1667">makeglos.pl</A> - | <A HREF="manual.html#1674">makeglos.pl</A> - | <A HREF="manual.html#2244">Defining New Glossary Types</A> - | <A HREF="manual.html#2257">Defining New Glossary Types</A> - | <A HREF="manual.html#2263">Defining New Glossary Types</A> - | <A HREF="manual.html#2266">Defining New Glossary Types</A> - | <A HREF="manual.html#2269">Defining New Glossary Types</A> - | <A HREF="manual.html#2368">Acronyms</A> - | <A HREF="manual.html#2825">Sample Documents</A> - | <A HREF="manual.html#2828">Sample Documents</A> - | <A HREF="manual.html#2856">Sample Documents</A> - | <A HREF="manual.html#2859">Sample Documents</A> - | <A HREF="manual.html#2867">Sample Documents</A> - | <A HREF="manual.html#2873">Sample Documents</A> - | <A HREF="manual.html#2876">Sample Documents</A> - | <A HREF="manual.html#2879">Sample Documents</A> - | <A HREF="manual.html#2976">Troubleshooting</A> - | <A HREF="manual.html#3005">Troubleshooting</A> - | <A HREF="manual.html#3323">Troubleshooting</A> - | <A HREF="manual.html#3326">Troubleshooting</A> - | <A HREF="manual.html#3332">Troubleshooting</A> +<DD><A HREF="manual.html#1782">makeglos.pl</A> + | <A HREF="manual.html#1790">makeglos.pl</A> + | <A HREF="manual.html#1793">makeglos.pl</A> + | <A HREF="manual.html#1801">makeglos.pl</A> + | <A HREF="manual.html#1808">makeglos.pl</A> + | <A HREF="manual.html#2393">Defining New Glossary Types</A> + | <A HREF="manual.html#2406">Defining New Glossary Types</A> + | <A HREF="manual.html#2412">Defining New Glossary Types</A> + | <A HREF="manual.html#2415">Defining New Glossary Types</A> + | <A HREF="manual.html#2418">Defining New Glossary Types</A> + | <A HREF="manual.html#2517">Acronyms</A> + | <A HREF="manual.html#3054">Sample Documents</A> + | <A HREF="manual.html#3057">Sample Documents</A> + | <A HREF="manual.html#3085">Sample Documents</A> + | <A HREF="manual.html#3088">Sample Documents</A> + | <A HREF="manual.html#3096">Sample Documents</A> + | <A HREF="manual.html#3102">Sample Documents</A> + | <A HREF="manual.html#3105">Sample Documents</A> + | <A HREF="manual.html#3108">Sample Documents</A> + | <A HREF="manual.html#3205">Troubleshooting</A> + | <A HREF="manual.html#3234">Troubleshooting</A> + | <A HREF="manual.html#3561">Troubleshooting</A> + | <A HREF="manual.html#3564">Troubleshooting</A> + | <A HREF="manual.html#3570">Troubleshooting</A> <DT><STRONG><TT>\makeglossary</TT></STRONG> -<DD><A HREF="manual.html#1621">makeglos.pl</A> - | <A HREF="manual.html#1681">makeglos.pl</A> - | <A HREF="manual.html#1691">makeglos.pl</A> - | <A HREF="manual.html#1701">makeglos.pl</A> - | <A HREF="manual.html#2205">Defining New Glossary Types</A> - | <A HREF="manual.html#2621">Customizing the Glossary</A> - | <A HREF="manual.html#2966">Troubleshooting</A> - | <A HREF="manual.html#2991">Troubleshooting</A> - | <A HREF="manual.html#3286">Troubleshooting</A> - | <A HREF="manual.html#3294">Troubleshooting</A> - | <A HREF="manual.html#3309">Troubleshooting</A> +<DD><A HREF="manual.html#1755">makeglos.pl</A> + | <A HREF="manual.html#1815">makeglos.pl</A> + | <A HREF="manual.html#1825">makeglos.pl</A> + | <A HREF="manual.html#1835">makeglos.pl</A> + | <A HREF="manual.html#2352">Defining New Glossary Types</A> + | <A HREF="manual.html#2882">Customizing the Glossary</A> + | <A HREF="manual.html#3195">Troubleshooting</A> + | <A HREF="manual.html#3220">Troubleshooting</A> + | <A HREF="manual.html#3524">Troubleshooting</A> + | <A HREF="manual.html#3532">Troubleshooting</A> + | <A HREF="manual.html#3547">Troubleshooting</A> <DT><STRONG><TT>makeindex</TT></STRONG> -<DD><A HREF="manual.html#1484">Installation</A> - | <A HREF="manual.html#1490">Installation</A> - | <A HREF="manual.html#1493">Installation</A> - | <A HREF="manual.html#1626">makeglos.pl</A> - | <A HREF="manual.html#1631">makeglos.pl</A> - | <A HREF="manual.html#1636">makeglos.pl</A> - | <A HREF="manual.html#1641">makeglos.pl</A> - | <A HREF="manual.html#1651">makeglos.pl</A> - | <A HREF="manual.html#1662">makeglos.pl</A> - | <A HREF="manual.html#1706">makeglos.pl</A> - | <A HREF="manual.html#1711">Displaying the Glossary</A> - | <A HREF="manual.html#2241">Defining New Glossary Types</A> - | <A HREF="manual.html#2247">Defining New Glossary Types</A> - | <A HREF="manual.html#2252">Defining New Glossary Types</A> - | <A HREF="manual.html#2260">Defining New Glossary Types</A> - | <A HREF="manual.html#2272">Defining New Glossary Types</A> - | <A HREF="manual.html#2365">Acronyms</A> - | <A HREF="manual.html#2556">Customizing the Glossary</A> - | <A HREF="manual.html#2565">Customizing the Glossary</A> - | <A HREF="manual.html#2583">Customizing the Glossary</A> - | <A HREF="manual.html#2642">Customizing the Glossary</A> - | <A HREF="manual.html#2716">Customizing the Glossary</A> - | <A HREF="manual.html#2745">Customizing the Glossary</A> - | <A HREF="manual.html#2870">Sample Documents</A> - | <A HREF="manual.html#2979">Troubleshooting</A> - | <A HREF="manual.html#2986">Troubleshooting</A> - | <A HREF="manual.html#2998">Troubleshooting</A> - | <A HREF="manual.html#3008">Troubleshooting</A> - | <A HREF="manual.html#3112">Troubleshooting</A> - | <A HREF="manual.html#3115">Troubleshooting</A> - | <A HREF="manual.html#3118">Troubleshooting</A> - | <A HREF="manual.html#3150">Troubleshooting</A> - | <A HREF="manual.html#3280">Troubleshooting</A> +<DD><A HREF="manual.html#1612">Installation</A> + | <A HREF="manual.html#1618">Installation</A> + | <A HREF="manual.html#1621">Installation</A> + | <A HREF="manual.html#1760">makeglos.pl</A> + | <A HREF="manual.html#1765">makeglos.pl</A> + | <A HREF="manual.html#1770">makeglos.pl</A> + | <A HREF="manual.html#1775">makeglos.pl</A> + | <A HREF="manual.html#1785">makeglos.pl</A> + | <A HREF="manual.html#1796">makeglos.pl</A> + | <A HREF="manual.html#1840">makeglos.pl</A> + | <A HREF="manual.html#1845">Displaying the Glossary</A> + | <A HREF="manual.html#2390">Defining New Glossary Types</A> + | <A HREF="manual.html#2396">Defining New Glossary Types</A> + | <A HREF="manual.html#2401">Defining New Glossary Types</A> + | <A HREF="manual.html#2409">Defining New Glossary Types</A> + | <A HREF="manual.html#2421">Defining New Glossary Types</A> + | <A HREF="manual.html#2514">Acronyms</A> + | <A HREF="manual.html#2765">Customizing the Glossary</A> + | <A HREF="manual.html#2776">Customizing the Glossary</A> + | <A HREF="manual.html#2794">Customizing the Glossary</A> + | <A HREF="manual.html#2834">Customizing the Glossary</A> + | <A HREF="manual.html#2845">Customizing the Glossary</A> + | <A HREF="manual.html#2903">Customizing the Glossary</A> + | <A HREF="manual.html#2974">Customizing the Glossary</A> + | <A HREF="manual.html#3099">Sample Documents</A> + | <A HREF="manual.html#3208">Troubleshooting</A> + | <A HREF="manual.html#3215">Troubleshooting</A> + | <A HREF="manual.html#3227">Troubleshooting</A> + | <A HREF="manual.html#3237">Troubleshooting</A> + | <A HREF="manual.html#3350">Troubleshooting</A> + | <A HREF="manual.html#3353">Troubleshooting</A> + | <A HREF="manual.html#3356">Troubleshooting</A> + | <A HREF="manual.html#3388">Troubleshooting</A> + | <A HREF="manual.html#3518">Troubleshooting</A> <DT><STRONG>makeindex key</STRONG> <DD><DL COMPACT> <DT><STRONG>delim_0</STRONG> -<DD><A HREF="manual.html#2554">Customizing the Glossary</A> +<DD><A HREF="manual.html#2763">Customizing the Glossary</A> <DT><STRONG>delim_n</STRONG> -<DD><A HREF="manual.html#2563">Customizing the Glossary</A> +<DD><A HREF="manual.html#2774">Customizing the Glossary</A> <DT><STRONG>delim_r</STRONG> -<DD><A HREF="manual.html#2581">Customizing the Glossary</A> +<DD><A HREF="manual.html#2792">Customizing the Glossary</A> +<DT><STRONG>delim_t</STRONG> +<DD><A HREF="manual.html#2843">Customizing the Glossary</A> <DT><STRONG>group_skip</STRONG> -<DD><A HREF="manual.html#2743">Customizing the Glossary</A> +<DD><A HREF="manual.html#2832">Customizing the Glossary</A> <DT><STRONG>item_0</STRONG> -<DD><A HREF="manual.html#2714">Customizing the Glossary</A> +<DD><A HREF="manual.html#2972">Customizing the Glossary</A> <DT><STRONG>page_compositor</STRONG> -<DD><A HREF="manual.html#2640">Customizing the Glossary</A> +<DD><A HREF="manual.html#2901">Customizing the Glossary</A> </DL> <DT><STRONG>makeindex style file (.ist)</STRONG> <DD><i>see </i> file types, ist <DT><STRONG><TT>\newacronym</TT></STRONG> -<DD><A HREF="manual.html#3250">Troubleshooting</A> - | <A HREF="manual.html#3344">Obsolete Commands</A> +<DD><A HREF="manual.html#2572">Acronyms</A> + | <A HREF="manual.html#3488">Troubleshooting</A> + | <A HREF="manual.html#3582">Obsolete Commands</A> +<DT><STRONG><TT>\newglossarystyle</TT></STRONG> +<DD><A HREF="manual.html#2700">Customizing the Glossary</A> <DT><STRONG><TT>ngerman</TT></STRONG> -<DD><A HREF="manual.html#1698">makeglos.pl</A> - | <A HREF="manual.html#3272">Troubleshooting</A> - | <A HREF="manual.html#3275">Troubleshooting</A> - | <A HREF="manual.html#3283">Troubleshooting</A> - | <A HREF="manual.html#3291">Troubleshooting</A> - | <A HREF="manual.html#3301">Troubleshooting</A> +<DD><A HREF="manual.html#1832">makeglos.pl</A> + | <A HREF="manual.html#3510">Troubleshooting</A> + | <A HREF="manual.html#3513">Troubleshooting</A> + | <A HREF="manual.html#3521">Troubleshooting</A> + | <A HREF="manual.html#3529">Troubleshooting</A> + | <A HREF="manual.html#3539">Troubleshooting</A> <DT><STRONG><TT>\nofiles</TT></STRONG> -<DD><A HREF="manual.html#1686">makeglos.pl</A> +<DD><A HREF="manual.html#1820">makeglos.pl</A> <DT><STRONG><TT>\noist</TT></STRONG> -<DD><A HREF="manual.html#3304">Troubleshooting</A> - | <A HREF="manual.html#3316">Troubleshooting</A> +<DD><A HREF="manual.html#3542">Troubleshooting</A> + | <A HREF="manual.html#3554">Troubleshooting</A> <DT><STRONG>package options</STRONG> <DD><DL COMPACT> <DT><STRONG>acronym</STRONG> -<DD><A HREF="manual.html#1950">Package Options</A> - | <A HREF="manual.html#1952">Package Options</A> - | <A HREF="manual.html#2330">Acronyms</A> - | <A HREF="manual.html#2332">Acronyms</A> - | <A HREF="manual.html#2349">Acronyms</A> - | <A HREF="manual.html#2376">Acronyms</A> - | <A HREF="manual.html#2918">Limitations</A> - | <A HREF="manual.html#2927">Limitations</A> - | <A HREF="manual.html#3046">Troubleshooting</A> +<DD><A HREF="manual.html#2084">Package Options</A> + | <A HREF="manual.html#2086">Package Options</A> + | <A HREF="manual.html#2479">Acronyms</A> + | <A HREF="manual.html#2481">Acronyms</A> + | <A HREF="manual.html#2498">Acronyms</A> + | <A HREF="manual.html#2525">Acronyms</A> + | <A HREF="manual.html#3147">Limitations</A> + | <A HREF="manual.html#3156">Limitations</A> + | <A HREF="manual.html#3275">Troubleshooting</A> <DD><DL COMPACT> <DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#1956">Package Options</A> - | <A HREF="manual.html#2929">Limitations</A> +<DD><A HREF="manual.html#2090">Package Options</A> + | <A HREF="manual.html#3158">Limitations</A> <DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#1954">Package Options</A> - | <A HREF="manual.html#2351">Acronyms</A> - | <A HREF="manual.html#2378">Acronyms</A> - | <A HREF="manual.html#2920">Limitations</A> - | <A HREF="manual.html#3048">Troubleshooting</A> +<DD><A HREF="manual.html#2088">Package Options</A> + | <A HREF="manual.html#2500">Acronyms</A> + | <A HREF="manual.html#2527">Acronyms</A> + | <A HREF="manual.html#3149">Limitations</A> + | <A HREF="manual.html#3277">Troubleshooting</A> </DL> <DT><STRONG>border</STRONG> -<DD><A HREF="manual.html#1766">Package Options</A> - | <A HREF="manual.html#1768">Package Options</A> - | <A HREF="manual.html#1963">Package Options</A> - | <A HREF="manual.html#1965">Package Options</A> - | <A HREF="manual.html#2091">Examples</A> - | <A HREF="manual.html#2127">Examples</A> - | <A HREF="manual.html#2154">Examples</A> - | <A HREF="manual.html#2181">Examples</A> - | <A HREF="manual.html#2775">Customizing the Glossary</A> +<DD><A HREF="manual.html#1900">Package Options</A> + | <A HREF="manual.html#1902">Package Options</A> + | <A HREF="manual.html#2110">Package Options</A> + | <A HREF="manual.html#2112">Package Options</A> + | <A HREF="manual.html#2238">Examples</A> + | <A HREF="manual.html#2274">Examples</A> + | <A HREF="manual.html#2301">Examples</A> + | <A HREF="manual.html#2328">Examples</A> + | <A HREF="manual.html#3004">Customizing the Glossary</A> <DD><DL COMPACT> <DT><STRONG>none</STRONG> -<DD><A HREF="manual.html#1770">Package Options</A> - | <A HREF="manual.html#2093">Examples</A> - | <A HREF="manual.html#2183">Examples</A> - | <A HREF="manual.html#2777">Customizing the Glossary</A> +<DD><A HREF="manual.html#1904">Package Options</A> + | <A HREF="manual.html#2240">Examples</A> + | <A HREF="manual.html#2330">Examples</A> + | <A HREF="manual.html#3006">Customizing the Glossary</A> <DT><STRONG>plain</STRONG> -<DD><A HREF="manual.html#1772">Package Options</A> - | <A HREF="manual.html#2129">Examples</A> - | <A HREF="manual.html#2156">Examples</A> +<DD><A HREF="manual.html#1906">Package Options</A> + | <A HREF="manual.html#2276">Examples</A> + | <A HREF="manual.html#2303">Examples</A> </DL> <DT><STRONG>cols</STRONG> -<DD><A HREF="manual.html#1779">Package Options</A> - | <A HREF="manual.html#1781">Package Options</A> - | <A HREF="manual.html#1981">Package Options</A> - | <A HREF="manual.html#1983">Package Options</A> - | <A HREF="manual.html#2199">Examples</A> - | <A HREF="manual.html#2519">Customizing the Glossary</A> - | <A HREF="manual.html#2550">Customizing the Glossary</A> +<DD><A HREF="manual.html#1913">Package Options</A> + | <A HREF="manual.html#1915">Package Options</A> + | <A HREF="manual.html#2128">Package Options</A> + | <A HREF="manual.html#2130">Package Options</A> + | <A HREF="manual.html#2346">Examples</A> + | <A HREF="manual.html#2728">Customizing the Glossary</A> + | <A HREF="manual.html#2759">Customizing the Glossary</A> <DD><DL COMPACT> <DT><STRONG>2</STRONG> -<DD><A HREF="manual.html#1783">Package Options</A> +<DD><A HREF="manual.html#1917">Package Options</A> <DT><STRONG>3</STRONG> -<DD><A HREF="manual.html#1785">Package Options</A> - | <A HREF="manual.html#2201">Examples</A> - | <A HREF="manual.html#2521">Customizing the Glossary</A> - | <A HREF="manual.html#2552">Customizing the Glossary</A> +<DD><A HREF="manual.html#1919">Package Options</A> + | <A HREF="manual.html#2348">Examples</A> + | <A HREF="manual.html#2730">Customizing the Glossary</A> + | <A HREF="manual.html#2761">Customizing the Glossary</A> +</DL> +<DT><STRONG>global</STRONG> +<DD><A HREF="manual.html#2097">Package Options</A> + | <A HREF="manual.html#2099">Package Options</A> + | <A HREF="manual.html#3304">Troubleshooting</A> + | <A HREF="manual.html#3306">Troubleshooting</A> +<DD><DL COMPACT> +<DT><STRONG>false</STRONG> +<DD><A HREF="manual.html#2101">Package Options</A> +<DT><STRONG>true</STRONG> +<DD><A HREF="manual.html#2103">Package Options</A> </DL> <DT><STRONG>header</STRONG> -<DD><A HREF="manual.html#1753">Package Options</A> - | <A HREF="manual.html#1755">Package Options</A> - | <A HREF="manual.html#1972">Package Options</A> - | <A HREF="manual.html#1974">Package Options</A> - | <A HREF="manual.html#2100">Examples</A> - | <A HREF="manual.html#2136">Examples</A> - | <A HREF="manual.html#2163">Examples</A> - | <A HREF="manual.html#2190">Examples</A> +<DD><A HREF="manual.html#1887">Package Options</A> + | <A HREF="manual.html#1889">Package Options</A> + | <A HREF="manual.html#2119">Package Options</A> + | <A HREF="manual.html#2121">Package Options</A> + | <A HREF="manual.html#2247">Examples</A> + | <A HREF="manual.html#2283">Examples</A> + | <A HREF="manual.html#2310">Examples</A> + | <A HREF="manual.html#2337">Examples</A> <DD><DL COMPACT> <DT><STRONG>none</STRONG> -<DD><A HREF="manual.html#1757">Package Options</A> - | <A HREF="manual.html#2102">Examples</A> - | <A HREF="manual.html#2138">Examples</A> +<DD><A HREF="manual.html#1891">Package Options</A> + | <A HREF="manual.html#2249">Examples</A> + | <A HREF="manual.html#2285">Examples</A> <DT><STRONG>plain</STRONG> -<DD><A HREF="manual.html#1759">Package Options</A> - | <A HREF="manual.html#2165">Examples</A> - | <A HREF="manual.html#2192">Examples</A> +<DD><A HREF="manual.html#1893">Package Options</A> + | <A HREF="manual.html#2312">Examples</A> + | <A HREF="manual.html#2339">Examples</A> </DL> <DT><STRONG>hyper</STRONG> -<DD><A HREF="manual.html#1558">Generating Glossary Information</A> - | <A HREF="manual.html#1560">Generating Glossary Information</A> - | <A HREF="manual.html#1886">Package Options</A> - | <A HREF="manual.html#1888">Package Options</A> - | <A HREF="manual.html#1910">Package Options</A> - | <A HREF="manual.html#1919">Package Options</A> - | <A HREF="manual.html#2431">Acronyms</A> - | <A HREF="manual.html#2433">Acronyms</A> - | <A HREF="manual.html#2900">Limitations</A> - | <A HREF="manual.html#3201">Troubleshooting</A> - | <A HREF="manual.html#3203">Troubleshooting</A> - | <A HREF="manual.html#3363">Obsolete Commands</A> - | <A HREF="manual.html#3365">Obsolete Commands</A> - | <A HREF="manual.html#3391">Obsolete Commands</A> - | <A HREF="manual.html#3393">Obsolete Commands</A> - | <A HREF="manual.html#3407">Obsolete Commands</A> +<DD><A HREF="manual.html#1686">Generating Glossary Information</A> + | <A HREF="manual.html#1688">Generating Glossary Information</A> + | <A HREF="manual.html#2020">Package Options</A> + | <A HREF="manual.html#2022">Package Options</A> + | <A HREF="manual.html#2044">Package Options</A> + | <A HREF="manual.html#2053">Package Options</A> + | <A HREF="manual.html#2627">Acronyms</A> + | <A HREF="manual.html#2629">Acronyms</A> + | <A HREF="manual.html#3129">Limitations</A> + | <A HREF="manual.html#3439">Troubleshooting</A> + | <A HREF="manual.html#3441">Troubleshooting</A> + | <A HREF="manual.html#3601">Obsolete Commands</A> + | <A HREF="manual.html#3603">Obsolete Commands</A> + | <A HREF="manual.html#3629">Obsolete Commands</A> + | <A HREF="manual.html#3631">Obsolete Commands</A> + | <A HREF="manual.html#3645">Obsolete Commands</A> <DD><DL COMPACT> <DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#1897">Package Options</A> - | <A HREF="manual.html#1921">Package Options</A> +<DD><A HREF="manual.html#2031">Package Options</A> + | <A HREF="manual.html#2055">Package Options</A> <DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#1890">Package Options</A> - | <A HREF="manual.html#1912">Package Options</A> - | <A HREF="manual.html#2902">Limitations</A> - | <A HREF="manual.html#3409">Obsolete Commands</A> +<DD><A HREF="manual.html#2024">Package Options</A> + | <A HREF="manual.html#2046">Package Options</A> + | <A HREF="manual.html#3131">Limitations</A> + | <A HREF="manual.html#3647">Obsolete Commands</A> </DL> <DT><STRONG>hyperacronym</STRONG> -<DD><A HREF="manual.html#1928">Package Options</A> - | <A HREF="manual.html#1930">Package Options</A> - | <A HREF="manual.html#3354">Obsolete Commands</A> - | <A HREF="manual.html#3356">Obsolete Commands</A> - | <A HREF="manual.html#3382">Obsolete Commands</A> - | <A HREF="manual.html#3384">Obsolete Commands</A> - | <A HREF="manual.html#3416">Obsolete Commands</A> - | <A HREF="manual.html#3425">Obsolete Commands</A> +<DD><A HREF="manual.html#2062">Package Options</A> + | <A HREF="manual.html#2064">Package Options</A> + | <A HREF="manual.html#3592">Obsolete Commands</A> + | <A HREF="manual.html#3594">Obsolete Commands</A> + | <A HREF="manual.html#3620">Obsolete Commands</A> + | <A HREF="manual.html#3622">Obsolete Commands</A> + | <A HREF="manual.html#3654">Obsolete Commands</A> + | <A HREF="manual.html#3663">Obsolete Commands</A> <DD><DL COMPACT> <DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#3397">Obsolete Commands</A> - | <A HREF="manual.html#3427">Obsolete Commands</A> +<DD><A HREF="manual.html#3635">Obsolete Commands</A> + | <A HREF="manual.html#3665">Obsolete Commands</A> <DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#3395">Obsolete Commands</A> - | <A HREF="manual.html#3418">Obsolete Commands</A> +<DD><A HREF="manual.html#3633">Obsolete Commands</A> + | <A HREF="manual.html#3656">Obsolete Commands</A> </DL> <DT><STRONG>hypertoc</STRONG> -<DD><A HREF="manual.html#1820">Package Options</A> - | <A HREF="manual.html#1822">Package Options</A> - | <A HREF="manual.html#1841">Package Options</A> - | <A HREF="manual.html#1843">Package Options</A> - | <A HREF="manual.html#1868">Package Options</A> - | <A HREF="manual.html#1877">Package Options</A> +<DD><A HREF="manual.html#1954">Package Options</A> + | <A HREF="manual.html#1956">Package Options</A> + | <A HREF="manual.html#1975">Package Options</A> + | <A HREF="manual.html#1977">Package Options</A> + | <A HREF="manual.html#2002">Package Options</A> + | <A HREF="manual.html#2011">Package Options</A> <DD><DL COMPACT> <DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#1879">Package Options</A> +<DD><A HREF="manual.html#2013">Package Options</A> <DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#1870">Package Options</A> +<DD><A HREF="manual.html#2004">Package Options</A> </DL> <DT><STRONG>number</STRONG> -<DD><A HREF="manual.html#1792">Package Options</A> - | <A HREF="manual.html#1794">Package Options</A> - | <A HREF="manual.html#2073">Examples</A> - | <A HREF="manual.html#2109">Examples</A> - | <A HREF="manual.html#2537">Customizing the Glossary</A> - | <A HREF="manual.html#2573">Customizing the Glossary</A> - | <A HREF="manual.html#2591">Customizing the Glossary</A> - | <A HREF="manual.html#2600">Customizing the Glossary</A> - | <A HREF="manual.html#2615">Customizing the Glossary</A> - | <A HREF="manual.html#2631">Customizing the Glossary</A> - | <A HREF="manual.html#2815">Sample Documents</A> +<DD><A HREF="manual.html#1926">Package Options</A> + | <A HREF="manual.html#1928">Package Options</A> + | <A HREF="manual.html#2220">Examples</A> + | <A HREF="manual.html#2256">Examples</A> + | <A HREF="manual.html#2746">Customizing the Glossary</A> + | <A HREF="manual.html#2784">Customizing the Glossary</A> + | <A HREF="manual.html#2802">Customizing the Glossary</A> + | <A HREF="manual.html#2861">Customizing the Glossary</A> + | <A HREF="manual.html#2876">Customizing the Glossary</A> + | <A HREF="manual.html#2892">Customizing the Glossary</A> + | <A HREF="manual.html#3044">Sample Documents</A> <DD><DL COMPACT> <DT><STRONG>none</STRONG> -<DD><A HREF="manual.html#1800">Package Options</A> - | <A HREF="manual.html#2075">Examples</A> - | <A HREF="manual.html#2539">Customizing the Glossary</A> - | <A HREF="manual.html#2575">Customizing the Glossary</A> - | <A HREF="manual.html#2593">Customizing the Glossary</A> - | <A HREF="manual.html#2633">Customizing the Glossary</A> +<DD><A HREF="manual.html#1934">Package Options</A> + | <A HREF="manual.html#2222">Examples</A> + | <A HREF="manual.html#2748">Customizing the Glossary</A> + | <A HREF="manual.html#2786">Customizing the Glossary</A> + | <A HREF="manual.html#2804">Customizing the Glossary</A> + | <A HREF="manual.html#2894">Customizing the Glossary</A> <DT><STRONG>page</STRONG> -<DD><A HREF="manual.html#1796">Package Options</A> - | <A HREF="manual.html#2111">Examples</A> +<DD><A HREF="manual.html#1930">Package Options</A> + | <A HREF="manual.html#2258">Examples</A> <DT><STRONG>section</STRONG> -<DD><A HREF="manual.html#1798">Package Options</A> - | <A HREF="manual.html#2602">Customizing the Glossary</A> - | <A HREF="manual.html#2617">Customizing the Glossary</A> - | <A HREF="manual.html#2817">Sample Documents</A> +<DD><A HREF="manual.html#1932">Package Options</A> + | <A HREF="manual.html#2863">Customizing the Glossary</A> + | <A HREF="manual.html#2878">Customizing the Glossary</A> + | <A HREF="manual.html#3046">Sample Documents</A> </DL> <DT><STRONG>section</STRONG> -<DD><A HREF="manual.html#1937">Package Options</A> - | <A HREF="manual.html#1939">Package Options</A> +<DD><A HREF="manual.html#2071">Package Options</A> + | <A HREF="manual.html#2073">Package Options</A> <DD><DL COMPACT> <DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#1943">Package Options</A> +<DD><A HREF="manual.html#2077">Package Options</A> <DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#1941">Package Options</A> +<DD><A HREF="manual.html#2075">Package Options</A> </DL> <DT><STRONG>style</STRONG> -<DD><A HREF="manual.html#1724">Package Options</A> - | <A HREF="manual.html#1726">Package Options</A> - | <A HREF="manual.html#1738">Package Options</A> - | <A HREF="manual.html#1990">Package Options</A> - | <A HREF="manual.html#1999">Package Options</A> - | <A HREF="manual.html#2046">Examples</A> - | <A HREF="manual.html#2055">Examples</A> - | <A HREF="manual.html#2064">Examples</A> - | <A HREF="manual.html#2082">Examples</A> - | <A HREF="manual.html#2118">Examples</A> - | <A HREF="manual.html#2145">Examples</A> - | <A HREF="manual.html#2172">Examples</A> - | <A HREF="manual.html#2528">Customizing the Glossary</A> - | <A HREF="manual.html#2654">Customizing the Glossary</A> - | <A HREF="manual.html#2663">Customizing the Glossary</A> - | <A HREF="manual.html#2699">Customizing the Glossary</A> - | <A HREF="manual.html#2710">Customizing the Glossary</A> - | <A HREF="manual.html#2726">Customizing the Glossary</A> - | <A HREF="manual.html#2735">Customizing the Glossary</A> - | <A HREF="manual.html#2755">Customizing the Glossary</A> - | <A HREF="manual.html#2764">Customizing the Glossary</A> - | <A HREF="manual.html#2797">Sample Documents</A> - | <A HREF="manual.html#2891">Limitations</A> - | <A HREF="manual.html#3162">Troubleshooting</A> - | <A HREF="manual.html#3171">Troubleshooting</A> +<DD><A HREF="manual.html#1858">Package Options</A> + | <A HREF="manual.html#1860">Package Options</A> + | <A HREF="manual.html#1872">Package Options</A> + | <A HREF="manual.html#2137">Package Options</A> + | <A HREF="manual.html#2146">Package Options</A> + | <A HREF="manual.html#2193">Examples</A> + | <A HREF="manual.html#2202">Examples</A> + | <A HREF="manual.html#2211">Examples</A> + | <A HREF="manual.html#2229">Examples</A> + | <A HREF="manual.html#2265">Examples</A> + | <A HREF="manual.html#2292">Examples</A> + | <A HREF="manual.html#2319">Examples</A> + | <A HREF="manual.html#2737">Customizing the Glossary</A> + | <A HREF="manual.html#2815">Customizing the Glossary</A> + | <A HREF="manual.html#2824">Customizing the Glossary</A> + | <A HREF="manual.html#2915">Customizing the Glossary</A> + | <A HREF="manual.html#2924">Customizing the Glossary</A> + | <A HREF="manual.html#2957">Customizing the Glossary</A> + | <A HREF="manual.html#2968">Customizing the Glossary</A> + | <A HREF="manual.html#2984">Customizing the Glossary</A> + | <A HREF="manual.html#2993">Customizing the Glossary</A> + | <A HREF="manual.html#3026">Sample Documents</A> + | <A HREF="manual.html#3120">Limitations</A> + | <A HREF="manual.html#3400">Troubleshooting</A> + | <A HREF="manual.html#3409">Troubleshooting</A> <DD><DL COMPACT> <DT><STRONG>altlist</STRONG> -<DD><A HREF="manual.html#1731">Package Options</A> - | <A HREF="manual.html#2001">Package Options</A> - | <A HREF="manual.html#2021">Package Options</A> - | <A HREF="manual.html#2057">Examples</A> - | <A HREF="manual.html#2530">Customizing the Glossary</A> - | <A HREF="manual.html#2665">Customizing the Glossary</A> - | <A HREF="manual.html#2712">Customizing the Glossary</A> - | <A HREF="manual.html#2737">Customizing the Glossary</A> - | <A HREF="manual.html#2799">Sample Documents</A> - | <A HREF="manual.html#2862">Sample Documents</A> - | <A HREF="manual.html#2893">Limitations</A> +<DD><A HREF="manual.html#1865">Package Options</A> + | <A HREF="manual.html#2148">Package Options</A> + | <A HREF="manual.html#2168">Package Options</A> + | <A HREF="manual.html#2204">Examples</A> + | <A HREF="manual.html#2739">Customizing the Glossary</A> + | <A HREF="manual.html#2826">Customizing the Glossary</A> + | <A HREF="manual.html#2926">Customizing the Glossary</A> + | <A HREF="manual.html#2970">Customizing the Glossary</A> + | <A HREF="manual.html#3028">Sample Documents</A> + | <A HREF="manual.html#3091">Sample Documents</A> + | <A HREF="manual.html#3122">Limitations</A> <DT><STRONG>list</STRONG> -<DD><A HREF="manual.html#1728">Package Options</A> - | <A HREF="manual.html#1740">Package Options</A> - | <A HREF="manual.html#1992">Package Options</A> - | <A HREF="manual.html#2048">Examples</A> - | <A HREF="manual.html#2066">Examples</A> - | <A HREF="manual.html#2656">Customizing the Glossary</A> - | <A HREF="manual.html#2701">Customizing the Glossary</A> - | <A HREF="manual.html#2728">Customizing the Glossary</A> +<DD><A HREF="manual.html#1862">Package Options</A> + | <A HREF="manual.html#1874">Package Options</A> + | <A HREF="manual.html#2139">Package Options</A> + | <A HREF="manual.html#2195">Examples</A> + | <A HREF="manual.html#2213">Examples</A> + | <A HREF="manual.html#2817">Customizing the Glossary</A> + | <A HREF="manual.html#2917">Customizing the Glossary</A> + | <A HREF="manual.html#2959">Customizing the Glossary</A> <DT><STRONG>long</STRONG> -<DD><A HREF="manual.html#1745">Package Options</A> - | <A HREF="manual.html#2084">Examples</A> - | <A HREF="manual.html#2120">Examples</A> - | <A HREF="manual.html#2147">Examples</A> - | <A HREF="manual.html#2174">Examples</A> - | <A HREF="manual.html#2757">Customizing the Glossary</A> - | <A HREF="manual.html#3164">Troubleshooting</A> +<DD><A HREF="manual.html#1879">Package Options</A> + | <A HREF="manual.html#2231">Examples</A> + | <A HREF="manual.html#2267">Examples</A> + | <A HREF="manual.html#2294">Examples</A> + | <A HREF="manual.html#2321">Examples</A> + | <A HREF="manual.html#2986">Customizing the Glossary</A> + | <A HREF="manual.html#3402">Troubleshooting</A> <DT><STRONG>super</STRONG> -<DD><A HREF="manual.html#1742">Package Options</A> - | <A HREF="manual.html#2766">Customizing the Glossary</A> - | <A HREF="manual.html#3173">Troubleshooting</A> +<DD><A HREF="manual.html#1876">Package Options</A> + | <A HREF="manual.html#2995">Customizing the Glossary</A> + | <A HREF="manual.html#3411">Troubleshooting</A> </DL> <DT><STRONG>toc</STRONG> -<DD><A HREF="manual.html#1807">Package Options</A> - | <A HREF="manual.html#1809">Package Options</A> - | <A HREF="manual.html#1829">Package Options</A> - | <A HREF="manual.html#1831">Package Options</A> - | <A HREF="manual.html#1850">Package Options</A> - | <A HREF="manual.html#1852">Package Options</A> - | <A HREF="manual.html#1859">Package Options</A> - | <A HREF="manual.html#2008">Package Options</A> - | <A HREF="manual.html#2010">Package Options</A> - | <A HREF="manual.html#2017">Package Options</A> - | <A HREF="manual.html#2806">Sample Documents</A> - | <A HREF="manual.html#2808">Sample Documents</A> - | <A HREF="manual.html#2909">Limitations</A> +<DD><A HREF="manual.html#1941">Package Options</A> + | <A HREF="manual.html#1943">Package Options</A> + | <A HREF="manual.html#1963">Package Options</A> + | <A HREF="manual.html#1965">Package Options</A> + | <A HREF="manual.html#1984">Package Options</A> + | <A HREF="manual.html#1986">Package Options</A> + | <A HREF="manual.html#1993">Package Options</A> + | <A HREF="manual.html#2155">Package Options</A> + | <A HREF="manual.html#2157">Package Options</A> + | <A HREF="manual.html#2164">Package Options</A> + | <A HREF="manual.html#3035">Sample Documents</A> + | <A HREF="manual.html#3037">Sample Documents</A> + | <A HREF="manual.html#3138">Limitations</A> <DD><DL COMPACT> <DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#1813">Package Options</A> +<DD><A HREF="manual.html#1947">Package Options</A> <DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#1811">Package Options</A> - | <A HREF="manual.html#1861">Package Options</A> - | <A HREF="manual.html#2019">Package Options</A> - | <A HREF="manual.html#2911">Limitations</A> +<DD><A HREF="manual.html#1945">Package Options</A> + | <A HREF="manual.html#1995">Package Options</A> + | <A HREF="manual.html#2166">Package Options</A> + | <A HREF="manual.html#3140">Limitations</A> </DL> </DL> <DT><STRONG>page number formats</STRONG> <DD><DL COMPACT> <DT><STRONG>hyperbf</STRONG> -<DD><A HREF="manual.html#1543">Generating Glossary Information</A> - | <A HREF="manual.html#3213">Troubleshooting</A> +<DD><A HREF="manual.html#1671">Generating Glossary Information</A> + | <A HREF="manual.html#3451">Troubleshooting</A> <DT><STRONG>hyperit</STRONG> -<DD><A HREF="manual.html#1548">Generating Glossary Information</A> +<DD><A HREF="manual.html#1676">Generating Glossary Information</A> <DT><STRONG>hyperrm</STRONG> -<DD><A HREF="manual.html#1528">Generating Glossary Information</A> - | <A HREF="manual.html#1562">Generating Glossary Information</A> +<DD><A HREF="manual.html#1656">Generating Glossary Information</A> + | <A HREF="manual.html#1690">Generating Glossary Information</A> <DT><STRONG>hypersf</STRONG> -<DD><A HREF="manual.html#1533">Generating Glossary Information</A> +<DD><A HREF="manual.html#1661">Generating Glossary Information</A> <DT><STRONG>hypertt</STRONG> -<DD><A HREF="manual.html#1538">Generating Glossary Information</A> +<DD><A HREF="manual.html#1666">Generating Glossary Information</A> </DL> <DT><STRONG><TT>\pagecompositor</TT></STRONG> -<DD><A HREF="manual.html#2836">Sample Documents</A> +<DD><A HREF="manual.html#3065">Sample Documents</A> <DT><STRONG><TT>perl</TT></STRONG> -<DD><A HREF="manual.html#1487">Installation</A> +<DD><A HREF="manual.html#1615">Installation</A> <DT><STRONG><TT>\printacronym</TT></STRONG> -<DD><A HREF="manual.html#2358">Acronyms</A> - | <A HREF="manual.html#3055">Troubleshooting</A> +<DD><A HREF="manual.html#2507">Acronyms</A> + | <A HREF="manual.html#3284">Troubleshooting</A> <DT><STRONG><TT>\printglossary</TT></STRONG> -<DD><A HREF="manual.html#2220">Defining New Glossary Types</A> - | <A HREF="manual.html#2275">Defining New Glossary Types</A> - | <A HREF="manual.html#2971">Troubleshooting</A> +<DD><A HREF="manual.html#2367">Defining New Glossary Types</A> + | <A HREF="manual.html#2424">Defining New Glossary Types</A> + | <A HREF="manual.html#3200">Troubleshooting</A> <DT><STRONG><TT>\protect</TT></STRONG> -<DD><A HREF="manual.html#3100">Troubleshooting</A> +<DD><A HREF="manual.html#3338">Troubleshooting</A> <DT><STRONG><TT>\saveglosentry</TT></STRONG> -<DD><A HREF="manual.html#3070">Troubleshooting</A> - | <A HREF="manual.html#3335">Obsolete Commands</A> +<DD><A HREF="manual.html#3308">Troubleshooting</A> + | <A HREF="manual.html#3573">Obsolete Commands</A> <DT><STRONG><TT>\setglossary</TT></STRONG> -<DD><A HREF="manual.html#2931">Limitations</A> - | <A HREF="manual.html#3231">Troubleshooting</A> +<DD><A HREF="manual.html#3160">Limitations</A> + | <A HREF="manual.html#3469">Troubleshooting</A> <DT><STRONG><TT>\setglossary</TT> keys</STRONG> <DD><DL COMPACT> <DT><STRONG>delimN</STRONG> -<DD><A HREF="manual.html#2559">Customizing the Glossary</A> +<DD><A HREF="manual.html#2770">Customizing the Glossary</A> <DT><STRONG>delimR</STRONG> -<DD><A HREF="manual.html#2577">Customizing the Glossary</A> +<DD><A HREF="manual.html#2788">Customizing the Glossary</A> +<DT><STRONG>delimT</STRONG> +<DD><A HREF="manual.html#2839">Customizing the Glossary</A> + | <A HREF="manual.html#2848">Customizing the Glossary</A> <DT><STRONG>glodelim</STRONG> -<DD><A HREF="manual.html#2510">Customizing the Glossary</A> - | <A HREF="manual.html#2541">Customizing the Glossary</A> +<DD><A HREF="manual.html#2719">Customizing the Glossary</A> + | <A HREF="manual.html#2750">Customizing the Glossary</A> +<DT><STRONG>gloskip</STRONG> +<DD><A HREF="manual.html#2806">Customizing the Glossary</A> <DT><STRONG>glsnumformat</STRONG> -<DD><A HREF="manual.html#2504">Customizing the Glossary</A> - | <A HREF="manual.html#3227">Troubleshooting</A> +<DD><A HREF="manual.html#2713">Customizing the Glossary</A> + | <A HREF="manual.html#3465">Troubleshooting</A> <DT><STRONG>type</STRONG> -<DD><A HREF="manual.html#2500">Customizing the Glossary</A> +<DD><A HREF="manual.html#2709">Customizing the Glossary</A> </DL> <DT><STRONG><TT>\storeglosentry</TT></STRONG> -<DD><A HREF="manual.html#2831">Sample Documents</A> - | <A HREF="manual.html#2936">Limitations</A> - | <A HREF="manual.html#3021">Troubleshooting</A> - | <A HREF="manual.html#3075">Troubleshooting</A> - | <A HREF="manual.html#3080">Troubleshooting</A> - | <A HREF="manual.html#3107">Troubleshooting</A> - | <A HREF="manual.html#3121">Troubleshooting</A> +<DD><A HREF="manual.html#3060">Sample Documents</A> + | <A HREF="manual.html#3165">Limitations</A> + | <A HREF="manual.html#3250">Troubleshooting</A> + | <A HREF="manual.html#3313">Troubleshooting</A> + | <A HREF="manual.html#3318">Troubleshooting</A> + | <A HREF="manual.html#3345">Troubleshooting</A> + | <A HREF="manual.html#3359">Troubleshooting</A> <DT><STRONG>table of contents, adding to</STRONG> <DD><i>see </i> package options, toc <DT><STRONG><TT>\theglossarynum</TT></STRONG> -<DD><A HREF="manual.html#2635">Customizing the Glossary</A> - | <A HREF="manual.html#2841">Sample Documents</A> - | <A HREF="manual.html#2961">Limitations</A> +<DD><A HREF="manual.html#2896">Customizing the Glossary</A> + | <A HREF="manual.html#3070">Sample Documents</A> + | <A HREF="manual.html#3190">Limitations</A> <DT><STRONG><TT>\useacronym</TT></STRONG> -<DD><A HREF="manual.html#2468">Examples</A> +<DD><A HREF="manual.html#2664">Examples</A> <DT><STRONG><TT>\useGlosentry</TT></STRONG> -<DD><A HREF="manual.html#3026">Troubleshooting</A> - | <A HREF="manual.html#3031">Troubleshooting</A> - | <A HREF="manual.html#3085">Troubleshooting</A> - | <A HREF="manual.html#3090">Troubleshooting</A> - | <A HREF="manual.html#3126">Troubleshooting</A> - | <A HREF="manual.html#3131">Troubleshooting</A> +<DD><A HREF="manual.html#3255">Troubleshooting</A> + | <A HREF="manual.html#3260">Troubleshooting</A> + | <A HREF="manual.html#3323">Troubleshooting</A> + | <A HREF="manual.html#3328">Troubleshooting</A> + | <A HREF="manual.html#3364">Troubleshooting</A> + | <A HREF="manual.html#3369">Troubleshooting</A> <DT><STRONG><TT>\xacronym</TT></STRONG> -<DD><A HREF="manual.html#2301">Acronyms</A> - | <A HREF="manual.html#2310">Acronyms</A> - | <A HREF="manual.html#2334">Acronyms</A> +<DD><A HREF="manual.html#2450">Acronyms</A> + | <A HREF="manual.html#2459">Acronyms</A> + | <A HREF="manual.html#2483">Acronyms</A> <DT><STRONG><TT>\xglossary</TT></STRONG> -<DD><A HREF="manual.html#1892">Package Options</A> - | <A HREF="manual.html#2215">Defining New Glossary Types</A> - | <A HREF="manual.html#2339">Acronyms</A> - | <A HREF="manual.html#3016">Troubleshooting</A> - | <A HREF="manual.html#3367">Obsolete Commands</A> - | <A HREF="manual.html#3372">Obsolete Commands</A> +<DD><A HREF="manual.html#2026">Package Options</A> + | <A HREF="manual.html#2362">Defining New Glossary Types</A> + | <A HREF="manual.html#2488">Acronyms</A> + | <A HREF="manual.html#3245">Troubleshooting</A> + | <A HREF="manual.html#3605">Obsolete Commands</A> + | <A HREF="manual.html#3610">Obsolete Commands</A> <DT><STRONG><TT>xpdf</TT></STRONG> -<DD><A HREF="manual.html#3236">Troubleshooting</A> +<DD><A HREF="manual.html#3474">Troubleshooting</A> <DT><STRONG><TT>\xspace</TT></STRONG> -<DD><A HREF="manual.html#2437">Acronyms</A> - | <A HREF="manual.html#2443">Acronyms</A> +<DD><A HREF="manual.html#2633">Acronyms</A> + | <A HREF="manual.html#2639">Acronyms</A> </DL> <P> <BR><HR><H4>Footnotes</H4> <DL> -<DT><A NAME="foot1364">... <code>/usr/bin/</code></A><A +<DT><A NAME="foot1488">... <code>/usr/bin/</code></A><A HREF="manual.html#tex2html1"><SUP>1</SUP></A></DT> <DD>and you can also remove the <TT>.pl</TT> extension which isn't to everyone's liking. </DD> -<DT><A NAME="foot1367">... glossary</A><A +<DT><A NAME="foot1491">... glossary</A><A HREF="manual.html#tex2html2"><SUP>2</SUP></A></DT> <DD>This is because the list and number ranges are delimited using <TT>\delimR</TT> and <TT>\delimN</TT> instead of explicitly using a comma or en-dash. </DD> -<DT><A NAME="foot1416">... backslash</A><A +<DT><A NAME="foot1544">... backslash</A><A HREF="manual.html#tex2html4"><SUP>3</SUP></A></DT> <DD>Note, you should no longer try redefining the command <TT>\glsnumformat</TT>, as @@ -2658,15 +2869,21 @@ this now takes an optional argument, allowing for different glossary types </DD> -<DT><A NAME="foot1417">... space</A><A +<DT><A NAME="foot1545">... space</A><A HREF="manual.html#tex2html5"><SUP>4</SUP></A></DT> <DD>This is because the <TT>altlist</TT> style is intended for use with long descriptions that will look better ending with a full stop which the user can add if desired. </DD> -<DT><A NAME="foot1419">... information</A><A +<DT><A NAME="foot1100">...\glossaryalignment</A><A HREF="manual.html#tex2html6"><SUP>5</SUP></A></DT> +<DD>This isn't quite true +anymore, see the documented code for clarification + +</DD> +<DT><A NAME="foot1547">... information</A><A + HREF="manual.html#tex2html8"><SUP>6</SUP></A></DT> <DD>This should be in the directory <TT>texmf/doc/latex/graphics/</TT> @@ -2674,7 +2891,7 @@ is because the <TT>altlist</TT> style is intended for use with long descriptions </DL> <BR><HR> <ADDRESS> -<a href=http://theoval.cmp.uea.ac.uk/~nlct/>Nicola L. C. Talbot</a>. <a href=http://www.cmp.uea.ac.uk/>School of Computing Sciences</a>. <a href=http://www.uea.ac.uk/>University of East Anglia.</a> Last Modified: 2005-09-27 +<a href=http://theoval.cmp.uea.ac.uk/~nlct/>Nicola L. C. Talbot</a>. <a href=http://www.cmp.uea.ac.uk/>School of Computing Sciences</a>. <a href=http://www.uea.ac.uk/>University of East Anglia.</a> Last Modified: 2006-07-09 </ADDRESS> </BODY> </HTML> diff --git a/Master/texmf-dist/doc/latex/glossary/sample.tex b/Master/texmf-dist/doc/latex/glossary/sample.tex index 9b823a64bfc..adb2f94af49 100644 --- a/Master/texmf-dist/doc/latex/glossary/sample.tex +++ b/Master/texmf-dist/doc/latex/glossary/sample.tex @@ -5,7 +5,7 @@ %% The original source files were: %% %% glossary.dtx (with options: `sample.tex,package') -%% Copyright (C) 2005 Nicola Talbot, all rights reserved. +%% Copyright (C) 2006 Nicola Talbot, all rights reserved. %% If you modify this file, you must change its name first. %% You are NOT ALLOWED to distribute this file alone. You are NOT %% ALLOWED to take money for the distribution or use of either this @@ -75,6 +75,10 @@ merge them. This can be done using \texttt{makeglos.pl}, and passing the option \texttt{-m}. +If a comma appears within the name or description, grouping +must be used: \xglossary{name=page list,description={a list +of individual pages or page ranges, e.g.\ 1,2,4,7-9}}{page list} + \printglossary \end{document} diff --git a/Master/texmf-dist/doc/latex/glossary/sample4col.tex b/Master/texmf-dist/doc/latex/glossary/sample4col.tex new file mode 100644 index 00000000000..2d3ee56f266 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossary/sample4col.tex @@ -0,0 +1,52 @@ +%% +%% This is file `sample4col.tex', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% glossary.dtx (with options: `sample4col.tex,package') +%% Copyright (C) 2006 Nicola Talbot, all rights reserved. +%% If you modify this file, you must change its name first. +%% You are NOT ALLOWED to distribute this file alone. You are NOT +%% ALLOWED to take money for the distribution or use of either this +%% file or a changed version, except for a nominal charge for copying +%% etc. +%% \CharacterTable +%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z +%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z +%% Digits \0\1\2\3\4\5\6\7\8\9 +%% Exclamation \! Double quote \" Hash (number) \# +%% Dollar \$ Percent \% Ampersand \& +%% Acute accent \' Left paren \( Right paren \) +%% Asterisk \* Plus \+ Comma \, +%% Minus \- Point \. Solidus \/ +%% Colon \: Semicolon \; Less than \< +%% Equals \= Greater than \> Question mark \? +%% Commercial at \@ Left bracket \[ Backslash \\ +%% Right bracket \] Circumflex \^ Underscore \_ +%% Grave accent \` Left brace \{ Vertical bar \| +%% Right brace \} Tilde \~} +\documentclass[a4paper]{article} + +\usepackage[style=long,cols=3]{glossary} + +\renewcommand{\glossaryalignment}{llll} +\renewcommand{\glossaryheader}{% +\bfseries Name & \bfseries Description & \bfseries Unit & +\bfseries Page} + +\makeglossary + +\begin{document} + +\printglossary + +The width\glossary{name={$w$},sort=w,description={width&m}}, $w$, is +measured in meters. The +mass\glossary{name={$M$},sort=M,description={mass&kg}}, $M$ is +measured in kilograms. + +\end{document} +\endinput +%% +%% End of file `sample4col.tex'. diff --git a/Master/texmf-dist/doc/latex/glossary/sampleAcr.tex b/Master/texmf-dist/doc/latex/glossary/sampleAcr.tex index 4454ae6bf90..7199904b0b6 100644 --- a/Master/texmf-dist/doc/latex/glossary/sampleAcr.tex +++ b/Master/texmf-dist/doc/latex/glossary/sampleAcr.tex @@ -5,7 +5,7 @@ %% The original source files were: %% %% glossary.dtx (with options: `sampleAcr.tex,package') -%% Copyright (C) 2005 Nicola Talbot, all rights reserved. +%% Copyright (C) 2006 Nicola Talbot, all rights reserved. %% If you modify this file, you must change its name first. %% You are NOT ALLOWED to distribute this file alone. You are NOT %% ALLOWED to take money for the distribution or use of either this @@ -30,22 +30,19 @@ \usepackage{xspace} \usepackage[colorlinks,plainpages=false]{hyperref} -\usepackage[style=altlist,toc,number=none]{glossary} +\usepackage[style=altlist,hypertoc,number=none,acronym]{glossary} -\makeglossary +\makeacronym -\renewcommand{\acronymfont}[1]{\textmd{\scshape #1}} -\setacronymnamefmt{\gloshort: \expandafter\MakeUppercase\glolong} \newacronym{svm}{support vector machine}{description=Statistical pattern recognition technique~\cite{svm}} -\newacronym[ksvm]{k-svm}{kernel support vector machine}{description=Statistical pattern recognition technique using -the ``kernel trick'' (see also SVM)} +\newacronym[ksvm]{k-svm}{kernel support vector machine}{description={Statistical pattern recognition technique using +the ``kernel trick'' (see also SVM)}} \begin{document} \tableofcontents -\printglossary \chapter{Support Vector Machines} @@ -68,6 +65,8 @@ The \ksvm\ is \ifacronymfirstuse{svm}{a}{an} \svm\ that uses the so called ``ker \bibitem{svm} \ldots \end{thebibliography} +\printacronym + \end{document} \endinput %% diff --git a/Master/texmf-dist/doc/latex/glossary/sampleEq.tex b/Master/texmf-dist/doc/latex/glossary/sampleEq.tex index 375874f06c5..03edb3092a0 100644 --- a/Master/texmf-dist/doc/latex/glossary/sampleEq.tex +++ b/Master/texmf-dist/doc/latex/glossary/sampleEq.tex @@ -5,7 +5,7 @@ %% The original source files were: %% %% glossary.dtx (with options: `sampleEq.tex,package') -%% Copyright (C) 2005 Nicola Talbot, all rights reserved. +%% Copyright (C) 2006 Nicola Talbot, all rights reserved. %% If you modify this file, you must change its name first. %% You are NOT ALLOWED to distribute this file alone. You are NOT %% ALLOWED to take money for the distribution or use of either this @@ -37,6 +37,7 @@ \renewcommand{\theglossarynum}{\theequation} \renewcommand{\pagecompositor}{.} + \renewcommand{\glossaryname}{Index of Special Functions and Notations} \renewcommand{\glossaryheader}{\bfseries Notation & diff --git a/Master/texmf-dist/doc/latex/glossary/sampleEqPg.tex b/Master/texmf-dist/doc/latex/glossary/sampleEqPg.tex index 06eca783988..08449db253c 100644 --- a/Master/texmf-dist/doc/latex/glossary/sampleEqPg.tex +++ b/Master/texmf-dist/doc/latex/glossary/sampleEqPg.tex @@ -5,7 +5,7 @@ %% The original source files were: %% %% glossary.dtx (with options: `sampleEqPg.tex,package') -%% Copyright (C) 2005 Nicola Talbot, all rights reserved. +%% Copyright (C) 2006 Nicola Talbot, all rights reserved. %% If you modify this file, you must change its name first. %% You are NOT ALLOWED to distribute this file alone. You are NOT %% ALLOWED to take money for the distribution or use of either this diff --git a/Master/texmf-dist/doc/latex/glossary/sampleNtn.tex b/Master/texmf-dist/doc/latex/glossary/sampleNtn.tex index 4186f296196..4873151ab9f 100644 --- a/Master/texmf-dist/doc/latex/glossary/sampleNtn.tex +++ b/Master/texmf-dist/doc/latex/glossary/sampleNtn.tex @@ -5,7 +5,7 @@ %% The original source files were: %% %% glossary.dtx (with options: `sampleNtn.tex,package') -%% Copyright (C) 2005 Nicola Talbot, all rights reserved. +%% Copyright (C) 2006 Nicola Talbot, all rights reserved. %% If you modify this file, you must change its name first. %% You are NOT ALLOWED to distribute this file alone. You are NOT %% ALLOWED to take money for the distribution or use of either this @@ -30,15 +30,13 @@ \usepackage[plainpages=false,colorlinks]{hyperref} \usepackage{html} -\usepackage[toc]{glossary} +\usepackage[toc,style=long,cols=3]{glossary} \makeglossary -\newglossarytype{notation}{not}{ntn} +\newglossarytype{notation}{not}{ntn}[style=long,cols=2,border,header] \newcommand{\notationname}{Notation} -\setglossary{type=notation,glsnumformat=ignore,% -glodelim={.}} \makenotation diff --git a/Master/texmf-dist/doc/latex/glossary/sampleNtn2.tex b/Master/texmf-dist/doc/latex/glossary/sampleNtn2.tex index 5ea38558d05..9d44b0e8a9a 100644 --- a/Master/texmf-dist/doc/latex/glossary/sampleNtn2.tex +++ b/Master/texmf-dist/doc/latex/glossary/sampleNtn2.tex @@ -5,7 +5,7 @@ %% The original source files were: %% %% glossary.dtx (with options: `sampleNtn2.tex,package') -%% Copyright (C) 2005 Nicola Talbot, all rights reserved. +%% Copyright (C) 2006 Nicola Talbot, all rights reserved. %% If you modify this file, you must change its name first. %% You are NOT ALLOWED to distribute this file alone. You are NOT %% ALLOWED to take money for the distribution or use of either this diff --git a/Master/texmf-dist/doc/latex/glossary/sampleSec.tex b/Master/texmf-dist/doc/latex/glossary/sampleSec.tex index 4e1ba036a28..4fdd0de8a82 100644 --- a/Master/texmf-dist/doc/latex/glossary/sampleSec.tex +++ b/Master/texmf-dist/doc/latex/glossary/sampleSec.tex @@ -5,7 +5,7 @@ %% The original source files were: %% %% glossary.dtx (with options: `sampleSec.tex,package') -%% Copyright (C) 2005 Nicola Talbot, all rights reserved. +%% Copyright (C) 2006 Nicola Talbot, all rights reserved. %% If you modify this file, you must change its name first. %% You are NOT ALLOWED to distribute this file alone. You are NOT %% ALLOWED to take money for the distribution or use of either this diff --git a/Master/texmf-dist/source/latex/glossary/glossary.dtx b/Master/texmf-dist/source/latex/glossary/glossary.dtx index bf00b2ba979..3c50320922c 100644 --- a/Master/texmf-dist/source/latex/glossary/glossary.dtx +++ b/Master/texmf-dist/source/latex/glossary/glossary.dtx @@ -1,20 +1,20 @@ %\iffalse -% glossary.dtx generated using makedtx version 0.9b (c) Nicola Talbot +% glossary.dtx generated using /nlctltpc/home/nlct/bin/makedtx version 0.9b (c) Nicola Talbot % Command line args: % -macrocode ".*\.p.*l" % -macrocode ".*\.bat" % -setambles ".*\.p.*l=>\nopreamble\nopostamble" % -setambles ".*\.bat=>\nopreamble\nopostamble" -% -src "(.+)\.(sty)=>\1.\2" -% -src "(.+)\.(pl)=>\1.\2" -% -src "(.+)\.(bat)=>\1.\2" -% -src "(.+)\.(perl)=>\1.\2" -% -src "(.+)\.(tex)=>\1.\2" +% -src "(.+)\.(sty)\Z=>\1.\2" +% -src "(.+)\.(pl)\Z=>\1.\2" +% -src "(.+)\.(bat)\Z=>\1.\2" +% -src "(.+)\.(perl)\Z=>\1.\2" +% -src "(.+)\.(tex)\Z=>\1.\2" % -doc "manual.tex" % -author "Nicola Talbot" % -dir "source" % glossary -% Created on 2005/9/27 12:20 +% Created on 2006/7/9 16:01 %\fi %\iffalse %<*package> @@ -37,7 +37,7 @@ %\fi % \iffalse % Doc-Source file to use with LaTeX2e -% Copyright (C) 2005 Nicola Talbot, all rights reserved. +% Copyright (C) 2006 Nicola Talbot, all rights reserved. % \fi % \iffalse %<*driver> @@ -48,7 +48,7 @@ hyperindex=false, pdfauthor={N.L.C. Talbot}, pdftitle={glossary.sty: LaTeX2e Package to Assist Generating Glossaries}, - pdfkeywords={LaTeX,package,glossary}]{hyperref} + pdfkeywords={LaTeX,package,glossary,acronym}]{hyperref} %hyperindex conflicts with doc %(end up with |usage|hyperpage in indexentry) @@ -94,9 +94,9 @@ %\MakeShortVerb{"} %\DeleteShortVerb{\|} % -% \title{glossary.sty v 2.24: \LaTeXe\ Package to Assist Generating Glossaries} +% \title{glossary.sty v 2.38: \LaTeXe\ Package to Assist Generating Glossaries} % \author{Nicola L.C. Talbot} -% \date{27th September 2005} +% \date{9th July 2006} % \maketitle %\tableofcontents % @@ -162,6 +162,10 @@ %command line switches, and you won't be able to merge entries %that have the same name, but different descriptions. % +%Note that if you are updating the glossary package, it is +%a good idea to update \texttt{makeglos.pl} as it may also +%have been modified. +% % \section{Generating Glossary Information} % % The standard \LaTeX\ command \cmdname{makeglossary}\DescribeMacro{\makeglossary}{} (analogous to \cmdname{makeindex}) @@ -347,6 +351,11 @@ %fragile, care should be taken when using commands within its %argument. If in doubt, use \cmdname{protect}. % +%As from version 2.36, if you want to use all glossary entries +%which have been defined using \cmdname{storeglosentry}, do: +%\verb|\useglosentry{*}|. (Note that this option is not +%available for \cmdname{useGlosentry} and \cmdname{gls}.) +% %\section{makeglos.pl} % %The glossary information (as given by the commands @@ -440,6 +449,7 @@ %options passed to the package. % %\section{Package Options} +%\label{sec:options} % %The package options must be specified as a comma-separated list %of \meta{key}=\meta{value} pairs. Available options are: @@ -558,6 +568,15 @@ %\item[\pkgoptval{false}{acronym}] The acronyms will all %be placed in the main glossary. (Default) %\end{description} +% +%\item[\pkgopt{global}] Boolean variable: +%\changes{2.31}{2005 December 5}{Package option \texttt{global}} +%\begin{description} +%\item[\pkgoptval{false}{global}] Acronym commands only have +%a local effect. (Default) +%\item[\pkgoptval{true}{global}] Acronym commands have a global +%effect. +%\end{description} %\end{description} % The \pkgopt{border}, \pkgopt{header} and \pkgopt{cols} options %should not be used in conjunction with \pkgopt[list]{style} @@ -691,7 +710,7 @@ %\label{sec:newglostype} % %A new type of glossary can be defined using the command:\DescribeMacro{\newglossarytype}\\[5pt] -%\cmdname{newglossarytype}\verb/[/\meta{log-ext}\verb"]{"\meta{name}\verb'}{'\meta{out-ext}\verb+}{+\meta{in-ext}\verb!}!\\[5pt] +%\cmdname{newglossarytype}\verb/[/\meta{log-ext}\verb"]{"\meta{name}\verb'}{'\meta{out-ext}\verb+}{+\meta{in-ext}\verb!}[!\meta{style list}\verb-]-\\[5pt] %For example, suppose you want your document to have a separate %index of terms and index of notation, %you could use \icmdname{makeglossary}, \icmdname{glossary}, @@ -706,6 +725,17 @@ %and \cmdname{printnotation} which can be used for the second %glossary. % +%\changes{2.3}{2005 Nov 18}{Added extra optional argument to'newglosarytype} +%As from version 2.3, \cmdname{newglossarytype} now has an +%additional optional argument \meta{style list}. This should +%be a comma separated list of \meta{key}=\meta{value} pairs +%that can be used to specify the style of the new glossary. +%If omitted, the new glossary will have the same format +%as the main glossary. The following options are available: +%\texttt{style}, \texttt{header}, \texttt{border} and +%\texttt{cols}. These can take the same values as those +%given in the package options (described in section~\ref{sec:options}). +% %The command \cmdname{newglossarytype} should only occur in the %preamble. The new commands % \cmdname{make}\meta{name}, \verb'\'\meta{name}, @@ -827,7 +857,7 @@ %new glossary type called \texttt{acronym} will be defined as: %\begin{verbatim} %\newglossarytype[alg]{acronym}{acr}{acn} -%\newcommand{\acronymname}{List of Acronyms} +%\providecommand{\acronymname}{List of Acronyms} %\end{verbatim} %You will then need to use the commands \icmdname{makeacronym} %and \icmdname{printacronym} to make the list of acronyms appear. @@ -842,7 +872,16 @@ %\end{verbatim} %Note that the package option \pkgopt[true]{acronym} is only %appropriate if you want both a glossary and a separate list of -%acronyms. +%acronyms. If you do not write in English, you can set up your +%own language definition +%for \cmdname{acronymname} in the configuration file +%\texttt{glossary}\filetype{cfg}. For example: +%\begin{verbatim} +%\newcommand{\acronymname}{Akronyme} +%\end{verbatim} +%(If \texttt{glossary.cfg} does not exist, create a new file, add the +%appropriate definition of \cmdname{acronymname}, and save it to the +%same directory as \texttt{glossary.sty}.) % %\changes{2.1}{2004 October 25}{name field can be omitted in %\texttt{'newacronym}} @@ -863,6 +902,43 @@ %\setacronymnamefmt{\gloshort} %\end{verbatim} % +%\changes{2.32}{2006 January 5}{added \texttt{'setacronymdescfmt}} +%As from version 2.32, you can also modify the way the description +%key is formatted for acronyms using\DescribeMacro{\setacronymdescfmt}:\\[10pt] +%\cmdname{setacronymdescfmt}\{\meta{format}\}\\[10pt] +%Within \meta{format} you may use the commands \icmdname{glolong} +%and \icmdname{gloshort} (as above), and you can also use +%the command \icmdname{glodesc} which is the description as +%specified by the \gloskey{description} key in +%\icmdname{newacronym}. This means that if you are using +%a tabular style glossary, you can have the abbreviated +%form in one column and the long form in the second column +%with the description. For example, the following: +%\begin{verbatim} +%\setacronymnamefmt{\gloshort} +%\setacronymdescfmt{\glolong: \glodesc} +%\newacronym{svm}{support vector machine}{description=Statistical +%pattern recognition technique} +%\end{verbatim} +%will generate a glossary entry of the form: +%\begin{verbatim} +%\glossary{name=svm,description=support vector machine: Statistical +%pattern recognition technique} +%\end{verbatim} +%Note that if you omit \icmdname{glodesc} from +%\cmdname{setacronymdescfmt} the description specified +%in \cmdname{newacronym} will be ignored. So +%\begin{verbatim} +%\setacronymnamefmt{\gloshort} +%\setacronymdescfmt{\glolong} +%\newacronym{svm}{support vector machine}{description=Statistical +%pattern recognition technique} +%\end{verbatim} +%will generate a glossary entry of the form: +%\begin{verbatim} +%\glossary{name=svm,description=support vector machine} +%\end{verbatim} +% %Given an acronym named \meta{acr-name} (the command name %associated with the acronym as defined in %\cmdname{newacronym} without the preceding backslash), @@ -871,6 +947,7 @@ %\vspace{10pt} %\changes{2.11}{2004 October 25}{\texttt{'useacronym}} %\changes{2.18}{2005 July 5}{Fixed bug in 'useacronym} +%\changes{2.26}{2005 November 17}{Fixed bug in 'useacronym} %\noindent %\cmdname{useacronym}\verb"["\meta{insert}\verb']{'\meta{acr-name}\verb!}!\DescribeMacro{\useacronym}\\[5pt] %This command can be used instead of \cmdname{}\meta{acr-name}. @@ -890,6 +967,16 @@ %\changes{2.21}{2005 July 27}{'resetallacronyms added} % %\vspace{10pt} +%\changes{2.31}{2005 December 5}{'unsetacronym added}\noindent +%\cmdname{unsetacronym}\verb'{'\meta{acr-name}\verb"}" +%\DescribeMacro{\unsetacronym}\\[10pt] +%This command will cause all subsequent uses of +%\cmdname{}\meta{acr-name} to produce the short version. +%To unset all acronyms +%do \cmdname{unsetallacronyms}.\DescribeMacro{\unsetallacronyms} +%\changes{2.31}{2005 December 5}{'unsetallacronyms added} +% +%\vspace{10pt} %\changes{2.14}{2005 May 28}{'ifacronymfirstuse added}\noindent %\cmdname{ifacronymfirstuse}% %\verb'{'\meta{acr-name}% @@ -932,6 +1019,8 @@ %be put in automatically using \icmdname{xspace}. %\changes{2.22}{2005 Sept 16}{Added provision for 'xspace} %\changes{2.23}{2005 Sept 17}{Fixed minor bug with hyperlinks and 'glsxspace} +%\changes{2.28}{2005 July 9}{Fixed erroneous spaces occuring while +%using xspace} % %\DescribeMacro{\acronymfont} %\changes{2.22}{2005 Sept 12}{Added 'acronymfont}% @@ -1053,6 +1142,36 @@ %\end{verbatim} %By default, \cmdname{glossarypreamble} and \cmdname{glossarypostamble} do nothing. % +%\changes{2.3}{2005 Nov 18}{'glsbeforenum}% +%\changes{2.3}{2005 Nov 18}{'glsafternum}% +%Any text required before or after the list of page numbers +%are specified by the commands \cmdname{glsbeforenum} +%\DescribeMacro{\glsbeforenum} +%and \cmdname{glsafternum}\DescribeMacro{\glsafternum}. +%By default, these commands do nothing, any redefinition +%of these commands should come somewhere before the +%relevant \cmdname{printglossary} command. For example: +%\begin{verbatim} +%\printglossary +%\renewcommand{\glsbeforenum}{(} +%\renewcommand{\glsafternum}{)} +%\printnotation +%\end{verbatim} +%This will put the page number list in brackets for the +%second glossary, but not the first. +% +%Individual glossaries can have their styles changed either +%by setting the style in the final optional argument +%to \icmdname{newglossarystyle} (see +%\autoref{sec:newglostype}) or using the command\DescribeMacro{setglossarystyle}:\\[10pt] +%\cmdname{setglossarystyle}[\meta{type}]\{\meta{style list}\}\\[10pt] +%For example: +%\begin{verbatim} +%\setglossarystyle[acronym]{style=long,border=true,cols=2} +%\end{verbatim} +%If \meta{type} is omitted, the change is applied to the main +%glossary. +% %\changes{1.1}{2004 August 14}{\relax Increased User Flexibility}% %\changes{2.14}{2005 May 29}{'setglossary added} %\DescribeMacro{\setglossary} @@ -1095,6 +1214,13 @@ %This setting corresponds to the \istkey{delim\_0} key in the %\appname{makeindex} style file. % +%Note that if you want a new line between the description +%and the list of page numbers you will need to use +%\cmdname{noexpand}. For example: +%\begin{verbatim} +%\setglossary{glodelim={\noexpand\newline}} +%\end{verbatim} +% %\item[\setglos{delimN}] %\changes{1.1}{2004 August 14}{\texttt{'delimN}} %The delimiter to be inserted between two @@ -1114,6 +1240,34 @@ %package option \pkgopt[none]{number} is chosen, the value is set %to empty. % +%\item[\setglos{gloskip}] +%\changes{2.3}{2005 Nov 18}{'gloskip} +%This specifies what to do between groups. +%If \pkgopt[list]{style} or \pkgopt[altlist]{style} this has the +%value \cmdname{indexspace}, otherwise it creates a blank line +% in the \envname{longtable} or \envname{supertabular} environment. +%This command corresponds to the \istkey{group\_skip} key in +%the \appname{makeindex} style file. +%Note that as from version 2.3, you should no longer redefine +%the command \cmdname{gloskip}. +% +%\item[\setglos{delimT}] +%\changes{2.3}{2005 Nov 18}{'delimT} +%The text to be inserted after the list of +%page numbers for an entry. (This corresponds to the +%\istkey{delim\_t} key in the \appname{makeindex} style file.) +%The default value depends on the glossary style. It does +%nothing for the list-type styles, and has the value +%\verb/\\/ for the tabular-type styles. Note that +%\setglos{delimT} is separate from \cmdname{glsafternum}. +% +%For example, if you are using a 2 column tabular style, +%and you want a blank line after every entry (not just +%after every group) you can do the following: +%\begin{verbatim} +%\setglossary{delimT={\cr & \cr},gloskip={}} +%\end{verbatim} +%Note the use of \cmdname{cr} instead of \verb/\\/. %\end{description} %Note that: %\begin{verbatim} @@ -1172,14 +1326,15 @@ %\envname{longtable} or %\envname{supertabular} %environment with argument specified by -%\cmdname{glossaryalignment}.\DescribeMacro{\glossaryalignment} +%\cmdname{glossaryalignment}\footnote{This isn't quite true +%anymore, see the documented code for clarification}.\DescribeMacro{\glossaryalignment} % %\changes{2.1}{2004 October 25}{made glossary compatible with array package} -%The above conflicts with the \stynamefmt{array} package, so as -%from version 2.1, if the \stynamefmt{array} package has been -%loaded \emph{prior} to loading the \stynamefmt{glossary} package, -%the new column type \texttt{G} will be defined and used -%instead of \cmdname{glossaryalignment}. +%\changes{2.3}{2005 Nov 18}{made glossary compatible with array package} +%The glossary package no longer conflicts with the \stynamefmt{array} +%package. Changes can now be made to \cmdname{glossaryalignment} +%regardless of whether or not the \stynamefmt{array} +%package has been used. % %The command \cmdname{gloitem}\DescribeMacro{\gloitem}\ indicates %what to do at the start of each glossary entry. @@ -1193,20 +1348,9 @@ %\verb"\item["\meta{text}\verb']\mbox{}\par'\\[5pt] %otherwise it will do\\[5pt] %\meta{text}\verb" &"\\[5pt] -%if it's the first -%item of the page or\\[5pt] -%\verb'\\ '\meta{text}\verb" &"\\[5pt] -%otherwise. %This command corresponds to the \istkey{item\_0} key in the %\appname{makeindex} style file. % -%The command \cmdname{gloskip}\DescribeMacro{\gloskip}\ specifies what to do between groups. -%If \pkgopt[list]{style} or \pkgopt[altlist]{style} this has the -%value \cmdname{indexspace}, otherwise it creates a blank line -% in the \envname{longtable} or \envname{supertabular} environment. -%This command corresponds to the \istkey{group\_skip} key in -%the \appname{makeindex} style file. -% %The command \cmdname{glossaryheader}\DescribeMacro{\glossaryheader}\ (if \pkgopt[long]{style} or \pkgopt[super]{style} is selected) %indicates what to do at the start of the \envname{longtable} or %\envname{supertabular} environment. If \pkgopt[none]{border}, it @@ -1252,6 +1396,7 @@ %\item \texttt{sampleNtn.tex} --- This has a glossary and defines %a new glossary type called \texttt{notation}. The glossary has %associated page numbers, but the new glossary type doesn't. +%The two glossaries have different styles. %You will need to do: %\begin{verbatim} %latex sampleNtn @@ -1346,6 +1491,15 @@ %however, the entries with the same name but multiple descriptions %will not be merged. % +%\item \texttt{sample4col.tex}---This illustrates how to +%modify the glossary style so that it has 4 columns. You +%will need to do: +%\begin{verbatim} +%latex sample4col +%makeglos.pl sample4col +%latex sample4col +%\end{verbatim} +% %\end{itemize} % %\section{LaTeX2HTML Style File} @@ -1419,6 +1573,10 @@ % %\section{Troubleshooting} %\label{sec:trouble} +% +%This is a list of common problems, for a more up-to-date FAQ, see +%\url{http://theoval.cmp.uea.ac.uk/~nlct/packages/faq/}. +% %\begin{enumerate} %\item My glossary hasn't appeared. % @@ -1476,6 +1634,14 @@ %in the list of acronyms, where \cmdname{}\meta{acr-name} is the %name of an acronym command. % +%\item My acronym has been expanded twice. +% +%By default, if any of your acronym commands occur within a +%group (this includes environments which form implicit grouping) +%the effect will be local to that group. You can either unset +%the acronym outside the group, or use the \pkgopt{global} +%package option. +% %\item I get an error when using the command %\icmdname{saveglosentry}. % @@ -1594,9 +1760,10 @@ %\end{verbatim} % %The \stynamefmt{glossary} package used to conflict with the -%\stynamefmt{array} package. This was fixed in version 2.1, -%however, you must load the \stynamefmt{array} package -%\emph{prior} to loading the \stynamefmt{glossary} package. +%\stynamefmt{array} package. This was fixed in version 2.1. +%As from version 2.3, it doesn't matter whether you load +%the \stynamefmt{glossary} package before or after the +%\stynamefmt{array} package. % %\item\label{itm:fragile} I get the following error: %\begin{verbatim} @@ -1734,13 +1901,8 @@ % %\section{Acknowledgements} % -%I would like to thank the following people for their -%suggestions: -%Jens~Happe, -%Dmitry~Katsubo, -%Markus~Lazanowski, -%Slava~Pestov and -%Dario~Teixeira +%I would like to thank all the many people who have made suggestions +%and pointed out bugs. % % \StopEventually{\PrintChanges\addcontentsline{toc}{section}{Change History}\PrintIndex\addcontentsline{toc}{section}{Index}} % @@ -1754,7 +1916,7 @@ % \subsection{Package Definition} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossary}[2005/09/27 2.24 (NLCT)] +\ProvidesPackage{glossary}[2006/07/09 2.38 (NLCT)] % \end{macrocode} % Load packages needed by glossary.sty: % \begin{macrocode} @@ -1835,7 +1997,14 @@ \newif\ifglsacronym \define@key{gloss}{acronym}[true]{\ifthenelse{\equal{#1}{true} \or \equal{#1}{false}}{\setboolean{glsacronym}{#1}}{% -\PackageError{glossary}{Glossary option 'acronym' is boolean}{The value of 'acronym' canonly be set to 'true' or 'false'}}} +\PackageError{glossary}{Glossary option 'acronym' is boolean}{The +value of 'acronym' can only be set to 'true' or 'false'}}} + +\newif\ifglsglobal +\define@key{gloss}{global}[true]{\ifthenelse{\equal{#1}{true}\or +\equal{#1}{false}}{\setboolean{glsglobal}{#1}}{% +\PackageError{glossary}{Glossary option 'global' is boolean}{The +value of 'global' can only be set to 'true' or 'false'}}} % \end{macrocode} % Set up defaults % \begin{macrocode} @@ -1863,9 +2032,10 @@ \let\glsxspace\relax}{% \let\glsxspace\xspace} % \end{macrocode} -% Temporarily disable xspace: +% Set "\glossaryalignment" to "\relax" before loading +% configuration file. % \begin{macrocode} -\newcommand{\gls@noxspace}[1]{{\let\glsxspace\relax#1}} +\let\glossaryalignment\relax % \end{macrocode} % Load configuation file if it exists % \begin{macrocode} @@ -1886,8 +2056,13 @@ % \end{macrocode} %Check to make sure that the options don't conflict. % \begin{macrocode} -\ifthenelse{\(\equal{\gls@style}{list} \or \equal{\gls@style}{altlist}\) \and \(\not\equal{\gls@header}{none} \or \not\equal{\gls@border}{none} \or \gls@cols=3\)} -{\PackageError{glossary}{You can't have option 'style=list' or 'style=altlist' in combination with any of the other options} +\ifthenelse{\(\equal{\gls@style}{list} \or +\equal{\gls@style}{altlist}\) \and +\(\not\equal{\gls@header}{none} \or \not\equal{\gls@border}{none} +\or \gls@cols=3\)} +{\PackageError{glossary}{You can't have option 'style=list' or +'style=altlist' in combination with any of the other style +options} {The 'list' and 'altlist' options don't have a header, border or number of columns option.}} {} % \end{macrocode} @@ -1940,6 +2115,16 @@ \gdef\@glo@n@me{}\setkeys{wrgloss}{#1}\relax \endgroup\@esphack} % \end{macrocode} +% Command to extract description key from glossary entry. +% \begin{macrocode} +\newcommand{\@gls@getdescr}[1]{% +\@bsphack\begingroup\@sanitize +\protected@edef\@gls@dos@tk@y{\noexpand\setkeys{wrgloss}{#1}}% +\def\@descr{}\@gls@dos@tk@y\relax +\global\let\@glo@desc\@descr +\endgroup\@esphack +} +% \end{macrocode} % Now do macro so you can have a hyperlink that takes % you to the entry in the glossary % \begin{macrocode} @@ -1947,24 +2132,42 @@ \glossref{\@glo@l@bel}{##1}\renewcommand{\@@wrglossary}{}}% \glossary} % \end{macrocode} -% Save a bit of typing. The followig command is new to v2.17 +% Save a bit of typing. The following command is new to v2.17 +% (New to version 2.36: store label in a list) +% \begin{macrocode} +\newcommand*{\@glo@label@list}{} +\toksdef\gls@ta=0 \toksdef\gls@tb=2 +\newcommand{\@glo@label@addtolist}[1]{% +\gls@ta={{#1}}\gls@tb=\expandafter{\@glo@label@list}% +\xdef\@glo@label@list{\the\gls@ta,\the\gls@tb}} +% \end{macrocode} +% First define command to store details: % \begin{macrocode} \newcommand*{\storeglosentry}[3][glossary]{% +\ifthenelse{\equal{#2}{*}}{% +\PackageError{glossary}{Glossary label '*' invalid}{You can't have +a glossary entry with a * as the label}}{% \@ifundefined{glo@#2@entry}{% +\@glo@label@addtolist{#2}% \expandafter\def\csname glo@#2@type\endcsname{#1}% \expandafter\def\csname glo@#2@entry\endcsname{#3}% \@gls@getn@me{#3}% \expandafter\protected@edef\csname glo@#2@name\endcsname{\@glo@n@me}% }{% \PackageError{glossary}{Glossary entry '#2' already -defined}{There already exists a glossary entry with the label '#2'}}% +defined}{There already exists a glossary entry with the label '#2'}}}% } - +% \end{macrocode} +% This command will not produce text in the document, but will +% produce the relevant glossary entry. +% \begin{macrocode} \providecommand{\useglosentry}[2][\relax]{% +\ifthenelse{\equal{#2}{*}}{\@for\@glolab:=\@glo@label@list\do{% +\ifthenelse{\equal{\@glolab}{}}{}{\useglosentry[#1]{\@glolab}}}}{% \@ifundefined{glo@#2@type}{% \PackageError{glossary}{Glossary entry '#2' undefined}{You need to define the entry using \string\storeglosentry\space before -using it.}}{% +using it.}}{{% \edef\@glostype{\csname glo@#2@type\endcsname}% \ifx#1\relax \protected@edef\@glo@cmd{\expandafter\noexpand\csname \@glostype\endcsname{\csname glo@#2@entry\endcsname}}% @@ -1972,13 +2175,17 @@ using it.}}{% \protected@edef\@glo@cmd{\expandafter\noexpand\csname \@glostype{\csname glo@#2@entry\endcsname,#1}}% \fi \@glo@cmd -}} - +}}}} +% \end{macrocode} +% This command will produce the specified text in the document +% (with a hyperlink if enabled), and will produce the relevant +% glossary entry. +% \begin{macrocode} \providecommand{\useGlosentry}[3][\relax]{% \@ifundefined{glo@#2@type}{% \PackageError{glossary}{Glossary entry '#2' undefined}{You need to define the entry using \string\storeglosentry\space before -using it.}}{% +using it.}}{{% \edef\@glostype{x\csname glo@#2@type\endcsname}% \ifx#1\relax \protected@edef\@glo@cmd{\expandafter\noexpand\csname \@glostype\endcsname{\csname glo@#2@entry\endcsname}}% @@ -1986,8 +2193,11 @@ using it.}}{% \protected@edef\@glo@cmd{\expandafter\noexpand\csname \@glostype\endcsname{\csname glo@#2@entry\endcsname,#1}}% \fi \@glo@cmd{#3}% -}} - +}}} +% \end{macrocode} +% As above, but the text displayed in the document is constructed from +% the name key. +% \begin{macrocode} \newcommand{\gls}[2][\relax]{\useGlosentry[#1]{#2}{\csname glo@#2@name\endcsname}} % \end{macrocode} % This command was defined in earlier verions, but doesn't @@ -2038,7 +2248,12 @@ using it.}}{% \def\@glostype{glossary} \newcommand{\delimN}{\csname @\@glostype @delimN\endcsname} \newcommand{\delimR}{\csname @\@glostype @delimR\endcsname} -\newcommand{\glodelim}{\csname @\@glostype @glodelim\endcsname} +\newcommand{\gloitem}{\csname @\@glostype @gloitem\endcsname} +\newcommand{\gloskip}{\csname @\@glostype @gloskip\endcsname} +\newcommand{\delimT}{\glsafternum +\csname @\@glostype @delimT\endcsname} +\newcommand{\glodelim}{\csname @\@glostype @glodelim\endcsname +\glsbeforenum} % \end{macrocode} % Allow user to change number format for different @@ -2048,6 +2263,8 @@ using it.}}{% \define@key{glossnum}{type}{\def\@glsnumtype{#1}} \define@key{glossnum}{delimN}{\def\@delimN{#1}} \define@key{glossnum}{delimR}{\def\@delimR{#1}} +\define@key{glossnum}{delimT}{\def\@delimT{#1}} +\define@key{glossnum}{gloskip}{\def\@gloskip{#1}} \define@key{glossnum}{glodelim}{\def\@glodelim{#1}} \providecommand{\ignore}[1]{} @@ -2056,6 +2273,8 @@ using it.}}{% \def\@glsnumtype{glossary}% \def\@delimN{@dontchange@}% \def\@delimR{@dontchange@}% +\def\@delimT{@dontchange@}% +\def\@gloskip{@dontchange@}% \def\@glodelim{@dontchange@}% \setkeys{glossnum}{#1}\relax \@ifundefined{print\@glsnumtype}{% @@ -2070,19 +2289,27 @@ Glossary type '\@glsnumtype' has not been defined} \expandafter\xdef\csname @\@glsnumtype @delimR\endcsname{}% }{}% }% - +% \ifthenelse{\equal{\@delimN}{@dontchange@}}{}{% \expandafter\xdef\csname @\@glsnumtype @delimN\endcsname{% -\@delimN}} - +\@delimN}}% +% \ifthenelse{\equal{\@delimR}{@dontchange@}}{}{% \expandafter\xdef\csname @\@glsnumtype @delimR\endcsname{% -\@delimR}} - +\@delimR}}% +% +\ifthenelse{\equal{\@delimT}{@dontchange@}}{}{% +\expandafter\xdef\csname @\@glsnumtype @delimT\endcsname{% +\@delimT}}% +% +\ifthenelse{\equal{\@gloskip}{@dontchange@}}{}{% +\expandafter\xdef\csname @\@glsnumtype @gloskip\endcsname{% +\@gloskip}}% +% \ifthenelse{\equal{\@glodelim}{@dontchange@}}{}{% \expandafter\xdef\csname @\@glsnumtype @glodelim\endcsname{% -\@glodelim} -} +\@glodelim}% +}% }} % \end{macrocode} % Now define the command "\printglossary" which will print the contents of the glossary file. @@ -2113,34 +2340,74 @@ Glossary type '\@glsnumtype' has not been defined} % version 2.24) % \begin{macrocode} \providecommand{\glossarytitle}{% -\@ifundefined{chapter} -{\section*{\@glossaryname}\relax - \ifgls@toc\@glosaddtoc{section}\fi} -{\ifthenelse{\boolean{gls@section}} - {\section*{\@glossaryname}\relax - \ifgls@toc\@glosaddtoc{section}\fi} - {\ifgls@hypertoc\@ifundefined{if@twoside}{\clearpage}{% - \if@twoside\@ifundefined{cleardoublepage}{\cleardoublepage}{\clearpage}\else - \clearpage\fi}\phantomsection\@glosaddtoc{chapter}\fi\chapter*{\@glossaryname}\relax - \ifgls@toc\@glosaddtoc{chapter}\fi}} +\@ifundefined{chapter}% +% \chapter not defined +{% +\ifgls@hypertoc +% hypertoc option used +\phantomsection% add anchor before \section* +\@glosaddtoc{section}% +\section*{\@glossaryname}\relax +\else +% hypertoc=false +\section*{\@glossaryname}\relax +% only add contentsline if toc=true +\ifgls@toc\@glosaddtoc{section}\fi +\fi}% +{% \chapter defined +\ifthenelse{\boolean{gls@section}}% +{% user requested \section +\ifgls@hypertoc +% hypertoc=true +\phantomsection% add anchor before \section* +\@glosaddtoc{section}% +\section*{\@glossaryname}\relax +\else +%hypertoc=false +\section*{\@glossaryname}\relax +% only add contentsline if toc=true +\ifgls@toc\@glosaddtoc{section}\fi +\fi}% +{% use \chapter +\ifgls@hypertoc +% hypertoc=true +% chapters usually start a new page, so to ensure +% anchor is at the top of the correct page, issue +% a \clearpage (or \cleardoublepage) to place the +% anchor at the correct place +\@ifundefined{if@twoside}{% +% If document class doesn't support twosided documents +% just do \clearpage +\clearpage}{% +\if@twoside +% Document is two-sided +% If \cleardoublepage is defined, use that +% otherwise just do \clearpage +\@ifundefined{cleardoublepage}{\clearpage}{\cleardoublepage}% +\else +% One-sided document, just do \clearpage +\clearpage +\fi}% +\phantomsection% add anchor before \chapter +\@glosaddtoc{chapter}% +\fi +\chapter*{\@glossaryname}\relax +% only add contentsline if toc=true +\ifgls@toc\@glosaddtoc{chapter}\fi}} \markboth{\@shortglossaryname}{\@shortglossaryname}% } % \end{macrocode} % Now define theglossary environment. Version 2.2: % check to see if defined already % \begin{macrocode} -\@ifundefined{theglossary}{ -\newenvironment{theglossary} -{\glossarytitle - \glossarypreamble\@bef@reglos} - {\@ftergl@s\glossarypostamble} -}{% -\PackageWarning{glossary}{Redefining 'theglossary' environment} -\renewenvironment{theglossary} -{\glossarytitle - \glossarypreamble\@bef@reglos} - {\@ftergl@s\glossarypostamble} -} +\@ifundefined{theglossary}{% +\newenvironment{theglossary}{}{}}{% +\PackageWarning{glossary}{Redefining 'theglossary' environment}} +% \end{macrocode} +% \begin{macrocode} +\renewenvironment{theglossary}{% +\glossarytitle +\glossarypreamble\@bef@reglos}{\@ftergl@s\glossarypostamble} % \end{macrocode} % Provide a means to add text to the beginning or end % of the glossary. @@ -2162,21 +2429,62 @@ Glossary type '\@glsnumtype' has not been defined} \newcommand{\@bef@reglos}{\global\gloitemfirsttrue\beforeglossary} \newcommand{\@ftergl@s}{\afterglossary\global\gloitemfirstfalse} % \end{macrocode} +% Set up defaults. +% \begin{macrocode} +\newcommand{\glossaryalignment}{\relax} +\newcommand{\@gls@align@glossary}{} +\newcommand{\glosstail}{% +\@ifundefined{@gls@tail@\@glostype}{% +\PackageError{glossary}{No glossary tail defined for glossary +type '\@glostype'}{}}{% +\csname @gls@tail@\@glostype\endcsname}} +\newcommand{\@gls@tail@glossary}{} +\newcommand{\afterglossary}{% +\@ifundefined{@gls@afterglos@\@glostype}{% +\PackageError{glossary}{No after glossary defined for glossary +type '\@glostype'}{}}{% +\csname @gls@afterglos@\@glostype\endcsname}} +\newcommand{\beforeglossary}{% +\@ifundefined{@gls@beforeglos@\@glostype}{% +\PackageError{glossary}{No before glossary defined for glossary +type '\@glostype'}{}}{% +\csname @gls@beforeglos@\@glostype\endcsname}} +\newcommand{\@gls@beforeglos@glossary}{} +\newcommand{\@gls@afterglos@glossary}{} +\newcommand{\@glossary@glodelim}{} +\newcommand{\@glossary@delimT}{} +\newcommand{\glsafternum}{} +\newcommand{\glsbeforenum}{} +\newcommand{\@glossary@gloskip}{} +\newcommand{\@glossary@gloitem}[1]{#1} +% \end{macrocode} % Now define what to do depending on which style has been selected. -%First deal with the "list" and "altlist" style, as they're the easiest. +% First define command to switch to "list" style: % \begin{macrocode} - -\ifthenelse{\equal{\gls@style}{list} \or \equal{\gls@style}{altlist}} -{ -\newcommand{\beforeglossary}{\begin{description}} -\newcommand{\afterglossary}{\end{description}} -\newcommand{\gloskip}{\indexspace} -\ifthenelse{\equal{\gls@style}{list}} - {\newcommand{\gloitem}[1]{\item[#1]} - \newcommand{\@glossary@glodelim}{, }} - {\newcommand{\gloitem}[1]{\item[#1]\mbox{}\par} - \newcommand{\@glossary@glodelim}{ }} -}{ +\newcommand{\gls@setlist}[1][glossary]{% +\expandafter\def\csname @gls@beforeglos@#1\endcsname{% +\begin{description}}% +\expandafter\def\csname @gls@afterglos@#1\endcsname{% +\end{description}}% +\expandafter\def\csname @#1@gloskip\endcsname{\indexspace}% +\expandafter\def\csname @#1@glodelim\endcsname{, }% +\expandafter\def\csname @#1@gloitem\endcsname##1{\item[##1]}% +\expandafter\def\csname @#1@glodelim\endcsname{, }% +\expandafter\def\csname @#1@delimT\endcsname{} +} +% \end{macrocode} +% Next define command to switch to "altlist" style: +% \begin{macrocode} +\newcommand{\gls@setaltlist}[1][glossary]{% +\expandafter\def\csname @gls@beforeglos@#1\endcsname{% +\begin{description}}% +\expandafter\def\csname @gls@afterglos@#1\endcsname{% +\end{description}}% +\expandafter\def\csname @#1@gloskip\endcsname{\indexspace}% +\expandafter\def\csname @#1@gloitem\endcsname##1{\item[##1]\mbox{}\nopagebreak\par\nopagebreak}% +\expandafter\def\csname @#1@glodelim\endcsname{ }% +\expandafter\def\csname @#1@delimT\endcsname{} +} % \end{macrocode} %Now deal with the other styles. I orginally used a "tabular" environment, %but obviously this doesn't work for a glossary longer than one page. @@ -2191,102 +2499,199 @@ Glossary type '\@glsnumtype' has not been defined} {If you want the "super" option, you have to have the "supertab" package installed.}}} } {\RequirePackage{longtable}} - +% \end{macrocode} +% Define new length specifying the width of the description field. +% \begin{macrocode} \newlength{\descriptionwidth} \setlength{\descriptionwidth}{0.6\textwidth} - -\ifthenelse{\equal{\gls@header}{none}} -{ - \ifthenelse{\equal{\gls@border}{none}} - {\newcommand{\glossaryheader}{}} - {\newcommand{\glossaryheader}{\hline }} +% \end{macrocode} +% Initalise header to nothing. If this command is redefined it +% will override the default header. This enables the user to +% redesign the header by changing the definition of +% "\glossaryheader" (thus providing backward compatibility.) +% \begin{macrocode} +\newcommand*{\glossaryheader}{\relax} +% \end{macrocode} +% \begin{macrocode} +\newcommand{\@glossaryheader}{% +\ifx\glossaryheader\relax +\csname @\@glostype @header\endcsname +\else +\glossaryheader +\fi } -{ +% \end{macrocode} +% Define command to set header style. +% \begin{macrocode} +\newcommand{\gls@setheader}[1][glossary]{% +\ifthenelse{\equal{\gls@header}{none}}% +{% +\ifthenelse{\equal{\gls@border}{none}} +{\expandafter\def\csname @#1@header\endcsname{}% +}{\expandafter\def\csname @#1@header\endcsname{\hline}}% +}{% \ifnum\gls@cols=2\relax - \ifthenelse{\equal{\gls@border}{none}} - {\newcommand{\glossaryheader} - {\bfseries\entryname & \bfseries \descriptionname\\}} - {\newcommand{\glossaryheader} - {\hline\bfseries\entryname & \bfseries\descriptionname - \\\hline\hline}} +\ifthenelse{\equal{\gls@border}{none}} +{% +\expandafter\def\csname @#1@header\endcsname{% +\bfseries\entryname & \bfseries \descriptionname\\}}% +{% +\expandafter\def\csname @#1@header\endcsname{% +\hline\bfseries\entryname & \bfseries\descriptionname +\\\hline\hline}}% \else - \ifthenelse{\equal{\gls@border}{none}} - {\newcommand{\glossaryheader} - {\bfseries\entryname & \bfseries \descriptionname & \\}} - {\newcommand{\glossaryheader} - {\hline\bfseries\entryname &\bfseries\descriptionname & - \\\hline\hline}} +\ifthenelse{\equal{\gls@border}{none}} +{% +\expandafter\def\csname @#1@header\endcsname{% +\bfseries\entryname & \bfseries \descriptionname & \\}}% +{% +\expandafter\def\csname @#1@header\endcsname{% +\hline\bfseries\entryname &\bfseries\descriptionname & +\\\hline\hline}}% \fi -} - +}} +% \end{macrocode} +% Define command to set glossary alignment and borders +% \begin{macrocode} +\newcommand{\gls@setalignment}[1][glossary]{% \ifthenelse{\equal{\gls@border}{none}} { \ifnum\gls@cols=2\relax - \@ifundefined{newcolumntype}{\newcommand{\glossaryalignment}{@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}}}{ - \newcolumntype{G}{@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}}} +\expandafter\def\csname @gls@align@#1\endcsname{% +@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}} \else - \@ifundefined{newcolumntype}{\newcommand{\glossaryalignment}{@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}l}}{ - \newcolumntype{G}{@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}l}} +\expandafter\def\csname @gls@align@#1\endcsname{% +@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}l} \fi - - \ifthenelse{\equal{\gls@style}{super}}{ - \newcommand{\afterglossary}{ \\\end{supertabular}} - } - { - \newcommand{\afterglossary}{ \\\end{longtable}} - } - - \newcommand{\glosstail}{} -} -{ +% +\expandafter\def\csname @gls@tail@#1\endcsname{}% +}{% \ifnum\gls@cols=2\relax - \@ifundefined{newcolumntype}{\newcommand{\glossaryalignment}{|@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}|}}{ - \newcolumntype{G}{|@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}|}} +\expandafter\def\csname @gls@align@#1\endcsname{% +|@{\hspace{\tabcolsep}\bfseries +}lp{\descriptionwidth}|} \else - \@ifundefined{newcolumntype}{\newcommand{\glossaryalignment}{|@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}l|}}{ - \newcolumntype{G}{|@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}l|}} +\expandafter\def\csname @gls@align@#1\endcsname{% +|@{\hspace{\tabcolsep}\bfseries +}lp{\descriptionwidth}l|} \fi - - \ifthenelse{\equal{\gls@style}{super}}{ - \newcommand{\afterglossary}{ \\\hline\end{supertabular}} - } - { - \newcommand{\afterglossary}{ \\\hline\end{longtable}} - } - - \newcommand{\glosstail}{\hline} -} - -\ifthenelse{\equal{\gls@style}{super}} -{ - \@ifundefined{newcolumntype}{ - \newcommand{\beforeglossary} - {\tablehead{\glossaryheader}\tabletail{\glosstail} - \begin{supertabular}{\glossaryalignment}}} - {\newcommand{\beforeglossary} - {\tablehead{\glossaryheader}\tabletail{\glosstail} - \begin{supertabular}{G}}} +% +\expandafter\def\csname @gls@tail@#1\endcsname{\hline}% +}% +% +\expandafter\def\csname @#1@delimT\endcsname{\\} +% +\ifnum\gls@cols=2\relax +\expandafter\def\csname @#1@gloskip\endcsname{& \\}% +\expandafter\def\csname @#1@glodelim\endcsname{, }% +\else +\expandafter\def\csname @#1@gloskip\endcsname{& & \\}% +\expandafter\def\csname @#1@glodelim\endcsname{& }% +\fi +\expandafter\def\csname @#1@gloitem\endcsname##1{##1 &}% } -{ - \@ifundefined{newcolumntype}{\newcommand{\beforeglossary} - {\begin{longtable}{\glossaryalignment} - \glossaryheader\endhead\glosstail\endfoot}} - {\newcommand{\beforeglossary} - {\begin{longtable}{G} - \glossaryheader\endhead\glosstail\endfoot}} +% \end{macrocode} +% Need a way to avoid conflict with the array package. In an +% earlier version I defined a new column type if the array +% package was being used, however this restricts the ability +% to have multiple glossaries with different column alignments. +% \begin{macrocode} +\newcommand{\@st@rtglostable}[2]{% +\gls@ta={\begin{#1}}\gls@tb=\expandafter{#2}% +\edef\@st@rtglost@ble{\the\gls@ta{\the\gls@tb}} +\@st@rtglost@ble} +% \end{macrocode} +% Define command to switch to "super" style: +% \begin{macrocode} +\newcommand{\gls@setsuper}[1][glossary]{% +\gls@setalignment[#1]% +\gls@setheader[#1]% +% +\expandafter\def\csname @gls@beforeglos@#1\endcsname{% +\tablehead{\@glossaryheader}\tabletail{\glosstail}% +\if\glossaryalignment\relax +\expandafter\let\expandafter\@glossaryalignment\csname @gls@align@#1\endcsname +\else +\let\@glossaryalignment\glossaryalignment +\fi +\@st@rtglostable{supertabular}\@glossaryalignment} +% +\expandafter\def\csname @gls@afterglos@#1\endcsname{% +\end{supertabular}}% } - -\ifnum\gls@cols=2\relax -\newcommand{\gloskip}{\ifgloitemfirst\global\gloitemfirstfalse \else\\ \fi &} -\newcommand{\@glossary@glodelim}{, } +% \end{macrocode} +% Define command to switch to "long" style: +% \begin{macrocode} +\newcommand{\gls@setlong}[1][glossary]{% +\gls@setalignment[#1]% +\gls@setheader[#1]% +% +\expandafter\def\csname @gls@beforeglos@#1\endcsname{% +\if\relax\glossaryalignment +\expandafter\let\expandafter\@glossaryalignment\csname @gls@align@#1\endcsname \else -\newcommand{\gloskip}{\ifgloitemfirst\global\gloitemfirstfalse \else\\ \fi & &} -\newcommand{\@glossary@glodelim}{& } +\let\@glossaryalignment\glossaryalignment \fi -\newcommand{\gloitem}[1]{\ifgloitemfirst\global\gloitemfirstfalse #1 \else \\#1 \fi &} +\@st@rtglostable{longtable}{\@glossaryalignment} +\@glossaryheader\endhead\glosstail\endfoot} + +% +\expandafter\def\csname @gls@afterglos@#1\endcsname{% +\end{longtable}}% } +% \end{macrocode} +% Define command to set the glossary style. +% \begin{macrocode} +\newcommand{\@setglossarystyle}[1][glossary]{% +\@ifundefined{gls@set\gls@style}{% +\PackageError{glossary}{Glossary style '\gls@style' undefined}{}}{% +\csname gls@set\gls@style\endcsname[#1]}} +% \end{macrocode} +% Set glossary style +% \begin{macrocode} +\@setglossarystyle +% \end{macrocode} +% Define keys to change glossary style +% \begin{macrocode} +\define@key{glosstyle} + {style} + {\ifthenelse{\equal{#1}{list} \or \equal{#1}{altlist} \or \equal{#1}{super} \or \equal{#1}{long}} + {\def\gls@style{#1}} + {\PackageError{glossary} + {Unknown glossary style '#1'} + {Available styles are: list, altlist, super and long}}} -\ifthenelse{\equal{\gls@number}{none} \and \gls@cols<3}{\renewcommand{\@glossary@glodelim}{}}{} +\define@key{glosstyle} + {header}[plain]{\ifthenelse{\equal{#1}{none} \or \equal{#1}{plain}} + {\def\gls@header{#1}} + {\PackageError{glossary} + {Unknown glossary style '#1'} + {Available styles are: none and plain}}} + +\define@key{glosstyle} + {border}[plain]{\ifthenelse{\equal{#1}{none} \or \equal{#1}{plain}} + {\def\gls@border{#1}} + {\PackageError{glossary} + {Unknown glossary border '#1'} + {Available styles are: none and plain}}} +\define@key{glosstyle}{cols}{\gls@cols=#1\relax +\ifthenelse{\gls@cols<2 \or \gls@cols>3} + {\PackageError{glossary} + {invalid number of columns} + {The cols option can only be 2 or 3}} + {}} +% \end{macrocode} +% \begin{macrocode} +\newcommand{\setglossarystyle}[2][glossary]{% +\setkeys{glosstyle}{#2}% +\@setglossarystyle[#1]% +} +% \end{macrocode} +% Set the delimiter for the case where there is no numbering +% and there aren't 3 columns. +% \begin{macrocode} +\ifthenelse{\equal{\gls@number}{none} \and \gls@cols<3}{% +\renewcommand{\@glossary@glodelim}{}}{} % \end{macrocode} % \subsection{Makeindex style file} %This is the code to generate the ".ist" file. @@ -2309,6 +2714,7 @@ Glossary type '\@glsnumtype' has not been defined} \write\istfile{page_compositor "\pagecompositor"} \write\istfile{delim_n "\string\\delimN "} \write\istfile{delim_r "\string\\delimR "} +\write\istfile{delim_t "\string\\delimT "} \closeout\istfile } \catcode`\%14\relax @@ -2337,9 +2743,13 @@ Glossary type '\@glsnumtype' has not been defined} \@bsphack\begingroup\@sanitize\@index} % \end{macrocode} %\subsection{Defining new glossary type} -%First parameter name of new glossary type e.g.\ "notation". -%Second parameter extension of output file (equivalent to "ind" or "glo". -%Third parameter extension of input file (equivalent to "idx" or "gls"). +% First parameter (optional) is the extension of the log file +% (information used by makeglos.pl but not \LaTeX). +% Second parameter is the name of new glossary type +% e.g.\ "notation". Third parameter is the extension of output +% file (equivalent to "ind" or "glo". Fourth parameter +% is the extension of input file (equivalent to "idx" or "gls"). +% The fifth parameter (optional) is the format. % \begin{macrocode} \newcommand{\@newglossarytype}[4][glg]{} \newcommand{\newglossarytype}[4][glg]{ @@ -2349,7 +2759,6 @@ Glossary type '\@glsnumtype' has not been defined} \expandafter\gdef\csname glsX\@glstype Xnumformat\endcsname{\glsXglossaryXnumformat}% \expandafter\gdef\csname @\@glstype @delimN\endcsname{\@glossary@delimN}% \expandafter\gdef\csname @\@glstype @delimR\endcsname{\@glossary@delimR}% -\expandafter\gdef\csname @\@glstype @glodelim\endcsname{\@glossary@glodelim}% \expandafter\gdef\csname @gls@\@glstype @inext\endcsname{#4}% \expandafter\def\csname @gls@#2@type\endcsname{#4}% \expandafter\edef\csname make\@glstype\endcsname{% @@ -2371,12 +2780,14 @@ Glossary type '\@glsnumtype' has not been defined} }{% \noexpand\edef\noexpand\@shortglossaryname{% \noexpand\csname short\@glstype name\noexpand\endcsname}}% -\noexpand\@prntgl@ss@ry{\@glsin}} +\noexpand\@prntgl@ss@ry{\@glsin}}% }{\PackageError{glossary}{Command \expandafter\string\csname #2\endcsname \space already defined}{% You can't call your new glossary type '#2' because there already -exists a command with this name}} -} +exists a command with this name}}% +\@@n@wglostype} +\newcommand{\@@n@wglostype}[1][]{% +\setglossarystyle[\@glstype]{#1}} % \end{macrocode} % Define equivalent of "\makeglossary": % \begin{macrocode} @@ -2462,11 +2873,18 @@ exists a command with this name}} % \begin{macrocode} \newcommand{\glsprimaryfmt}[1]{\textbf{\glsnumformat{#1}}} % \end{macrocode} +% Specify how to control the way the name key is +% set for acronyms. % \begin{macrocode} -%\newcommand{\acronymlabprefix}{GGG} \newcommand{\@acronymnamefmt}{\glolong\ (\gloshort)} \newcommand{\setacronymnamefmt}[1]{\def\@acronymnamefmt{#1}} % \end{macrocode} +% Specify how to control the way the description key is +% set for acronyms. +% \begin{macrocode} +\newcommand{\@acronymdescfmt}{\glodesc} +\newcommand{\setacronymdescfmt}[1]{\def\@acronymdescfmt{#1}} +% \end{macrocode} % Format the acronym abbreviation in the format specified % by \verb'\acronymfont'. This simply prints its % argument by default. @@ -2479,64 +2897,70 @@ exists a command with this name}} \ifthenelse{\equal{#1}{}}{\renewcommand\@acrnmcmd{#2}}{\renewcommand\@acrnmcmd{#1}} \@ifundefined{\@acrnmcmd}{% \expandafter\newcommand\csname\@acrnmcmd short\endcsname{#2\protect\glsxspace} +\expandafter\newcommand\csname\@acrnmcmd @nx@short\endcsname{#2} \expandafter\newcommand\csname\@acrnmcmd long\endcsname{#3\protect\glsxspace} +\expandafter\newcommand\csname\@acrnmcmd @nx@long\endcsname{#3} \def\@acrn@entry{#4} { +% extract description +\@gls@getdescr{\@acrn@entry}% +\let\glodesc\@glo@desc% \def\glolong{#3}% \def\gloshort{\noexpand\acronymfont{#2}}% \expandafter\protected@xdef\expandafter\@acrnamefmt{\@acronymnamefmt} +\expandafter\protected@xdef\expandafter\@acrdesc{\@acronymdescfmt} } \@acr@addtolist{\@acrnmcmd} -\protected@edef\@acr@glsentry{name=\@acrnamefmt,format=glsnumformat,sort=\@acrnmcmd,\@acrn@entry} +\protected@edef\@acr@glsentry{name={\@acrnamefmt},format=glsnumformat,sort={\@acrnmcmd},\@acrn@entry,description={\@acrdesc}} \newboolean{\@acrnmcmd first}\setboolean{\@acrnmcmd first}{true} \expandafter\protected@edef\csname \@acrnmcmd\endcsname{\noexpand\@ifstar{\csname @s@\@acrnmcmd\endcsname}{\csname @\@acrnmcmd\endcsname}} -\ifglshyperacronym +\ifglshyperacronym % hyperlinks % unstarred version \expandafter\protected@edef\csname @\@acrnmcmd\endcsname{% \noexpand\ifthenelse{\noexpand\boolean{\@acrnmcmd first}}{% -\noexpand\gls@noxspace{\csname\@acrnmcmd long\endcsname\noexpand\@acrnmins\ +\csname\@acrnmcmd @nx@long\endcsname\noexpand\@acrnmins\ (\noexpand\xacronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}% -})}\noexpand\setboolean{\@acrnmcmd first}{false}% +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}% +})\noexpand\unsetacronym{\@acrnmcmd}% }{\noexpand\xacronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}\noexpand\@acrnmins}}\noexpand\glsxspace} +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}\noexpand\@acrnmins}}\noexpand\glsxspace} % starred version \expandafter\protected@edef\csname @s@\@acrnmcmd\endcsname{% \noexpand\ifthenelse{\noexpand\boolean{\@acrnmcmd first}}{% -\noexpand\gls@noxspace{\noexpand\expandafter\noexpand\MakeUppercase -\csname\@acrnmcmd long\endcsname\noexpand\@acrnmins\ +\noexpand\expandafter\noexpand\MakeUppercase +\csname\@acrnmcmd @nx@long\endcsname\noexpand\@acrnmins\ (\noexpand\xacronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}% -})}% -\noexpand\setboolean{\@acrnmcmd first}{false}}{% +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}% +})% +\noexpand\unsetacronym{\@acrnmcmd}}{% \noexpand\xacronym{\@acr@glsentry}{% \noexpand\acronymfont{\noexpand\expandafter\noexpand\MakeUppercase -\csname\@acrnmcmd short\endcsname}% +\csname\@acrnmcmd @nx@short\endcsname}% \noexpand\@acrnmins}}\noexpand\glsxspace} -\else +\else % no hyperlinks % unstarred version \expandafter\protected@edef\csname @\@acrnmcmd\endcsname{% \noexpand\ifthenelse{\noexpand\boolean{\@acrnmcmd first}}{% -\noexpand\gls@noxspace{\csname\@acrnmcmd long\endcsname\ +\csname\@acrnmcmd @nx@long\endcsname\noexpand\@acrnmins\ (\noexpand\acronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}% -})}\noexpand\setboolean{\@acrnmcmd first}{false}% +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}% +})\noexpand\unsetacronym{\@acrnmcmd}% }{\noexpand\acronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}}}% +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}\noexpand\@acrnmins}}% \noexpand\glsxspace} % starred version \expandafter\protected@edef\csname @s@\@acrnmcmd\endcsname{% \noexpand\ifthenelse{\noexpand\boolean{\@acrnmcmd first}}{% -\noexpand\gls@noxspace{\noexpand\expandafter +\noexpand\expandafter \noexpand\MakeUppercase -\csname\@acrnmcmd long\endcsname\noexpand\@acrnmins\ +\csname\@acrnmcmd @nx@long\endcsname\noexpand\@acrnmins\ (\noexpand\acronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}% -})}% -\noexpand\setboolean{\@acrnmcmd first}{false}}{% +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}% +})% +\noexpand\unsetacronym{\@acrnmcmd}}{% \noexpand\acronym{\@acr@glsentry}{% \noexpand\acronymfont{\noexpand\expandafter\noexpand\MakeUppercase -\csname\@acrnmcmd short\endcsname}% +\csname\@acrnmcmd @nx@short\endcsname}% \noexpand\@acrnmins}}\noexpand\glsxspace} \fi }{% @@ -2555,21 +2979,23 @@ exists a command with this name}} \newcommand{\@acrln}[1]{\@ifundefined{#1long}{% \PackageError{glossary}{Acronym '#1' has not been defined}{}}{% -\gls@noxspace{\csname#1long\endcsname}}} +\csname#1@nx@long\endcsname}} \newcommand{\@sacrln}[1]{\@ifundefined{#1long}{% \PackageError{glossary}{Acronym '#1' has not been defined}{}}{% -\gls@noxspace{\expandafter\expandafter\expandafter -\MakeUppercase\csname#1long\endcsname}}} +\expandafter\expandafter\expandafter +\MakeUppercase\csname#1@nx@long\endcsname}} \newcommand{\acrsh}{\@ifstar\@sacrsh\@acrsh} \newcommand{\@acrsh}[1]{\@ifundefined{#1short}{% -\PackageError{glossary}{Acronym '#1' has not been defined}{}}{\acronymfont{\gls@noxspace{\csname#1short\endcsname}}}} +\PackageError{glossary}{Acronym '#1' has not been defined}{}}{% +\acronymfont{\csname#1@nx@short\endcsname}}} \newcommand{\@sacrsh}[1]{\@ifundefined{#1short}{% \PackageError{glossary}{Acronym '#1' has not been defined}{}}{% -\acronymfont{\gls@noxspace{\expandafter\expandafter\expandafter\MakeUppercase\csname#1short\endcsname}}}} +\acronymfont{\expandafter\expandafter\expandafter +\MakeUppercase\csname#1@nx@short\endcsname}}} \newcommand{\ifacronymfirstuse}[3]{% \@ifundefined{if#1first}{% @@ -2579,10 +3005,26 @@ exists a command with this name}} \newcommand{\resetacronym}[1]{% \@ifundefined{if#1first}{% \PackageError{glossary}{Acronym '#1' not defined}{}}{% -\setboolean{#1first}{true}}} +\ifglsglobal +\expandafter\global\csname #1firsttrue\endcsname +\else +\setboolean{#1first}{true}% +\fi}} + +\newcommand{\unsetacronym}[1]{% +\@ifundefined{if#1first}{% +\PackageError{glossary}{Acronym '#1' not defined}{}}{% +\ifglsglobal +\expandafter\global\csname #1firstfalse\endcsname +\else +\setboolean{#1first}{false}% +\fi}} \newcommand{\resetallacronyms}{% \@for\@acr:=\@acr@list\do{\resetacronym{\@acr}}} + +\newcommand{\unsetallacronyms}{% +\@for\@acr:=\@acr@list\do{\unsetacronym{\@acr}}} % \end{macrocode} %These commands are provided to make it easier change the page number format to bf, sf, tt and it %if you are using hyperlinks @@ -2658,7 +3100,7 @@ exists a command with this name}} % \begin{macrocode} \ifglsacronym \newglossarytype[alg]{acronym}{acr}{acn} -\newcommand{\acronymname}{List of Acronyms} +\providecommand{\acronymname}{List of Acronyms} \else \let\acronym=\glossary \let\xacronym=\xglossary @@ -2676,7 +3118,7 @@ exists a command with this name}} # File : makeglos # Author : Nicola Talbot -# Version : 1.3 (2005/06/28) +# Version : 1.4 (2005/11/19) # Description: simple Perl script that calls makeindex. # Intended for use with "glossary.sty" (saves having to remember # all the various switches) @@ -2953,6 +3395,11 @@ sub makeindex{ for ($i=0; $i <= $j; $i++) { + # remove all but the last \delimT + while ($item[$i]{'desc'}=~s/\\delimT/$&/sg > 1) + { + $item[$i]{'desc'}=~s/\\delimT//s; + } print OUTPUT "\\gloitem ", $item[$i]{'name'}, $item[$i]{'desc'}; } @@ -2977,7 +3424,7 @@ sub makeindex{ % \begin{macrocode} @rem = '-*- Perl -*-
@echo off
-perl -S %0.pl %1 %2 %3 %4 %5 %6 %7 %8 %9
+perl -S %~dp0makeglos.pl %*
% \end{macrocode} % \begin{macrocode} %</makeglos.bat> @@ -2988,8 +3435,8 @@ perl -S %0.pl %1 %2 %3 %4 %5 %6 %7 %8 %9 % \begin{macrocode} # File : glossary.perl # Author : Nicola Talbot -# Date : 8 July 2005 -# Version : 1.02 +# Date : 5 December 2005 +# Version : 1.03 # Description : LaTeX2HTML implementation of glossary package. package main; @@ -3759,6 +4206,36 @@ sub do_cmd_resetallacronyms{ $_; } +sub do_cmd_unsetacronym{ + local($_) = @_; + local($cmdname); + + $cmdname = &missing_braces unless + (s/$next_pair_pr_rx/$cmdname=$2;''/eo); + + if (defined %{$acronym{$cmdname}}) + { + $global{"${cmdname}first"} = 0; + } + else + { + &write_warnings("acronym '$cmdname' not defined"); + } + + $_; +} + +sub do_cmd_unsetallacronyms{ + local($_) = @_; + + foreach $key (keys %acronym) + { + $global{"${key}first"} = 0; + } + + $_; +} + %savedglosentry = (); # This command is deprecated @@ -4067,6 +4544,10 @@ merge them. This can be done using \texttt{makeglos.pl}, and passing the option \texttt{-m}. +If a comma appears within the name or description, grouping +must be used: \xglossary{name=page list,description={a list +of individual pages or page ranges, e.g.\ 1,2,4,7-9}}{page list} + \printglossary \end{document} @@ -4074,29 +4555,63 @@ merge them. This can be done using %</sample.tex> % \end{macrocode} % \begin{macrocode} +%<*sample4col.tex> +% \end{macrocode} +\documentclass[a4paper]{article} + +% start out with 3 column format to make it easier to modify +\usepackage[style=long,cols=3]{glossary} + +% make glossary have 4 columns all left aligned +% (this assumes entries can fit onto a single line +% otherwise use p specifier instead of l) +\renewcommand{\glossaryalignment}{llll} +% Header row +\renewcommand{\glossaryheader}{% +\bfseries Name & \bfseries Description & \bfseries Unit & +\bfseries Page} + +\makeglossary + +\begin{document} + +\printglossary + +The width\glossary{name={$w$},sort=w,description={width&m}}, $w$, is +measured in meters. The +mass\glossary{name={$M$},sort=M,description={mass&kg}}, $M$ is +measured in kilograms. + +\end{document} +% \begin{macrocode} +%</sample4col.tex> +% \end{macrocode} +% \begin{macrocode} %<*sampleAcr.tex> % \end{macrocode} \documentclass[a4paper]{report} \usepackage{xspace} \usepackage[colorlinks,plainpages=false]{hyperref} -\usepackage[style=altlist,toc,number=none]{glossary} +\usepackage[style=altlist,hypertoc,number=none,acronym]{glossary} +%\usepackage[style=long,toc,number=none]{glossary} -\makeglossary +%\makeglossary +\makeacronym -\renewcommand{\acronymfont}[1]{\textmd{\scshape #1}} +%\renewcommand{\acronymfont}[1]{\textmd{\scshape #1}} -\setacronymnamefmt{\gloshort: \expandafter\MakeUppercase\glolong} +%\setacronymnamefmt{\gloshort: \expandafter\MakeUppercase\glolong} +%\setacronymnamefmt{\gloshort} +%\setacronymdescfmt{\expandafter\MakeUppercase\glolong: \glodesc} \newacronym{svm}{support vector machine}{description=Statistical pattern recognition technique~\cite{svm}} -\newacronym[ksvm]{k-svm}{kernel support vector machine}{description=Statistical pattern recognition technique using -the ``kernel trick'' (see also SVM)} +\newacronym[ksvm]{k-svm}{kernel support vector machine}{description={Statistical pattern recognition technique using +the ``kernel trick'' (see also SVM)}} \begin{document} \tableofcontents -\printglossary - \chapter{Support Vector Machines} @@ -4120,6 +4635,9 @@ The \ksvm\ is \ifacronymfirstuse{svm}{a}{an} \svm\ that uses the so called ``ker \bibitem{svm} \ldots \end{thebibliography} +%\printglossary +\printacronym + \end{document} % \begin{macrocode} %</sampleAcr.tex> @@ -4132,13 +4650,15 @@ The \ksvm\ is \ifacronymfirstuse{svm}{a}{an} \svm\ that uses the so called ``ker \usepackage{amsmath} \usepackage[header,border=none,cols=3]{glossary} - \newcommand{\erf}{\operatorname{erf}} \newcommand{\erfc}{\operatorname{erfc}} \renewcommand{\theglossarynum}{\theequation} \renewcommand{\pagecompositor}{.} +% The following will put a blank line between every entry +%\setglossary{delimT={\cr & \cr},gloskip={}} + \renewcommand{\glossaryname}{Index of Special Functions and Notations} \renewcommand{\glossaryheader}{\bfseries Notation & @@ -4573,18 +5093,18 @@ G = 0.915\,965\,594\ldots \usepackage[plainpages=false,colorlinks]{hyperref} \usepackage{html} -\usepackage[toc]{glossary} +%\usepackage{array} +\usepackage[toc,style=long,cols=3]{glossary} \makeglossary -\newglossarytype{notation}{not}{ntn} +\newglossarytype{notation}{not}{ntn}[style=long,cols=2,border,header] % Set up notation style \newcommand{\notationname}{Notation} % Don't display numbers, remove commas and number hyphens % for notation entries -\setglossary{type=notation,glsnumformat=ignore,% -glodelim={.}} +%\setglossary{type=notation,glsnumformat=ignore,glodelim={.}} \makenotation diff --git a/Master/texmf-dist/source/latex/glossary/glossary.ins b/Master/texmf-dist/source/latex/glossary/glossary.ins index f67fe529aa4..1091023f1c1 100644 --- a/Master/texmf-dist/source/latex/glossary/glossary.ins +++ b/Master/texmf-dist/source/latex/glossary/glossary.ins @@ -1,8 +1,8 @@ -% glossary.ins generated using makedtx version 0.9b 2005/9/27 12:20 +% glossary.ins generated using /nlctltpc/home/nlct/bin/makedtx version 0.9b 2006/7/9 16:01 \input docstrip \preamble -Copyright (C) 2005 Nicola Talbot, all rights reserved. +Copyright (C) 2006 Nicola Talbot, all rights reserved. If you modify this file, you must change its name first. You are NOT ALLOWED to distribute this file alone. You are NOT ALLOWED to take money for the distribution or use of either this @@ -27,6 +27,8 @@ etc. \file{glossary.perl}{\nopreamble\nopostamble\from{glossary.dtx}{glossary.perl}} \file{glossary.sty}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossary.dtx}{glossary.sty,package}} +\file{sample4col.tex}{\usepreamble\defaultpreamble +\usepostamble\defaultpostamble\from{glossary.dtx}{sample4col.tex,package}} \file{sampleAcr.tex}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossary.dtx}{sampleAcr.tex,package}} \file{sampleEq.tex}{\usepreamble\defaultpreamble diff --git a/Master/texmf-dist/tex/latex/glossary/glossary.sty b/Master/texmf-dist/tex/latex/glossary/glossary.sty index b1fa2e9fd8b..828fab35f26 100644 --- a/Master/texmf-dist/tex/latex/glossary/glossary.sty +++ b/Master/texmf-dist/tex/latex/glossary/glossary.sty @@ -5,7 +5,7 @@ %% The original source files were: %% %% glossary.dtx (with options: `glossary.sty,package') -%% Copyright (C) 2005 Nicola Talbot, all rights reserved. +%% Copyright (C) 2006 Nicola Talbot, all rights reserved. %% If you modify this file, you must change its name first. %% You are NOT ALLOWED to distribute this file alone. You are NOT %% ALLOWED to take money for the distribution or use of either this @@ -27,7 +27,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossary}[2005/09/27 2.24 (NLCT)] +\ProvidesPackage{glossary}[2006/07/09 2.38 (NLCT)] \RequirePackage{ifthen} \RequirePackage{keyval} \define@key{gloss} @@ -100,7 +100,14 @@ \newif\ifglsacronym \define@key{gloss}{acronym}[true]{\ifthenelse{\equal{#1}{true} \or \equal{#1}{false}}{\setboolean{glsacronym}{#1}}{% -\PackageError{glossary}{Glossary option 'acronym' is boolean}{The value of 'acronym' canonly be set to 'true' or 'false'}}} +\PackageError{glossary}{Glossary option 'acronym' is boolean}{The +value of 'acronym' can only be set to 'true' or 'false'}}} + +\newif\ifglsglobal +\define@key{gloss}{global}[true]{\ifthenelse{\equal{#1}{true}\or +\equal{#1}{false}}{\setboolean{glsglobal}{#1}}{% +\PackageError{glossary}{Glossary option 'global' is boolean}{The +value of 'global' can only be set to 'true' or 'false'}}} \def\gls@style{long} \def\gls@header{none} \def\gls@border{none} @@ -119,7 +126,7 @@ \@ifundefined{xspace}{% \let\glsxspace\relax}{% \let\glsxspace\xspace} -\newcommand{\gls@noxspace}[1]{{\let\glsxspace\relax#1}} +\let\glossaryalignment\relax \newcommand{\glossarypackageoptions}[1]{\setkeys{gloss}{#1}} \InputIfFileExists{glossary.cfg}{% \typeout{Glossary configuration file loaded}}{% @@ -131,8 +138,13 @@ \ifthenelse{\equal{\CurrentOption}{}}{}{\@pkg@ptions}} \ProcessOptions -\ifthenelse{\(\equal{\gls@style}{list} \or \equal{\gls@style}{altlist}\) \and \(\not\equal{\gls@header}{none} \or \not\equal{\gls@border}{none} \or \gls@cols=3\)} -{\PackageError{glossary}{You can't have option 'style=list' or 'style=altlist' in combination with any of the other options} +\ifthenelse{\(\equal{\gls@style}{list} \or +\equal{\gls@style}{altlist}\) \and +\(\not\equal{\gls@header}{none} \or \not\equal{\gls@border}{none} +\or \gls@cols=3\)} +{\PackageError{glossary}{You can't have option 'style=list' or +'style=altlist' in combination with any of the other style +options} {The 'list' and 'altlist' options don't have a header, border or number of columns option.}} {} \ifthenelse{\boolean{gls@hypertoc} \and \boolean{gls@toc}}{% @@ -166,25 +178,42 @@ \newcommand{\@gls@getn@me}[1]{\@bsphack\begingroup\@sanitize \gdef\@glo@n@me{}\setkeys{wrgloss}{#1}\relax \endgroup\@esphack} +\newcommand{\@gls@getdescr}[1]{% +\@bsphack\begingroup\@sanitize +\protected@edef\@gls@dos@tk@y{\noexpand\setkeys{wrgloss}{#1}}% +\def\@descr{}\@gls@dos@tk@y\relax +\global\let\@glo@desc\@descr +\endgroup\@esphack +} \newcommand{\xglossary}{\renewcommand{\@@wrglossary}[1]{% \glossref{\@glo@l@bel}{##1}\renewcommand{\@@wrglossary}{}}% \glossary} +\newcommand*{\@glo@label@list}{} +\toksdef\gls@ta=0 \toksdef\gls@tb=2 +\newcommand{\@glo@label@addtolist}[1]{% +\gls@ta={{#1}}\gls@tb=\expandafter{\@glo@label@list}% +\xdef\@glo@label@list{\the\gls@ta,\the\gls@tb}} \newcommand*{\storeglosentry}[3][glossary]{% +\ifthenelse{\equal{#2}{*}}{% +\PackageError{glossary}{Glossary label '*' invalid}{You can't have +a glossary entry with a * as the label}}{% \@ifundefined{glo@#2@entry}{% +\@glo@label@addtolist{#2}% \expandafter\def\csname glo@#2@type\endcsname{#1}% \expandafter\def\csname glo@#2@entry\endcsname{#3}% \@gls@getn@me{#3}% \expandafter\protected@edef\csname glo@#2@name\endcsname{\@glo@n@me}% }{% \PackageError{glossary}{Glossary entry '#2' already -defined}{There already exists a glossary entry with the label '#2'}}% +defined}{There already exists a glossary entry with the label '#2'}}}% } - \providecommand{\useglosentry}[2][\relax]{% +\ifthenelse{\equal{#2}{*}}{\@for\@glolab:=\@glo@label@list\do{% +\ifthenelse{\equal{\@glolab}{}}{}{\useglosentry[#1]{\@glolab}}}}{% \@ifundefined{glo@#2@type}{% \PackageError{glossary}{Glossary entry '#2' undefined}{You need to define the entry using \string\storeglosentry\space before -using it.}}{% +using it.}}{{% \edef\@glostype{\csname glo@#2@type\endcsname}% \ifx#1\relax \protected@edef\@glo@cmd{\expandafter\noexpand\csname \@glostype\endcsname{\csname glo@#2@entry\endcsname}}% @@ -192,13 +221,12 @@ using it.}}{% \protected@edef\@glo@cmd{\expandafter\noexpand\csname \@glostype{\csname glo@#2@entry\endcsname,#1}}% \fi \@glo@cmd -}} - +}}}} \providecommand{\useGlosentry}[3][\relax]{% \@ifundefined{glo@#2@type}{% \PackageError{glossary}{Glossary entry '#2' undefined}{You need to define the entry using \string\storeglosentry\space before -using it.}}{% +using it.}}{{% \edef\@glostype{x\csname glo@#2@type\endcsname}% \ifx#1\relax \protected@edef\@glo@cmd{\expandafter\noexpand\csname \@glostype\endcsname{\csname glo@#2@entry\endcsname}}% @@ -206,8 +234,7 @@ using it.}}{% \protected@edef\@glo@cmd{\expandafter\noexpand\csname \@glostype\endcsname{\csname glo@#2@entry\endcsname,#1}}% \fi \@glo@cmd{#3}% -}} - +}}} \newcommand{\gls}[2][\relax]{\useGlosentry[#1]{#2}{\csname glo@#2@name\endcsname}} \providecommand{\saveglosentry}[3][glossary]{% \expandafter\def\csname glo@#2@type\endcsname{#1}% @@ -247,12 +274,19 @@ using it.}}{% \def\@glostype{glossary} \newcommand{\delimN}{\csname @\@glostype @delimN\endcsname} \newcommand{\delimR}{\csname @\@glostype @delimR\endcsname} -\newcommand{\glodelim}{\csname @\@glostype @glodelim\endcsname} +\newcommand{\gloitem}{\csname @\@glostype @gloitem\endcsname} +\newcommand{\gloskip}{\csname @\@glostype @gloskip\endcsname} +\newcommand{\delimT}{\glsafternum +\csname @\@glostype @delimT\endcsname} +\newcommand{\glodelim}{\csname @\@glostype @glodelim\endcsname +\glsbeforenum} \define@key{glossnum}{glsnumformat}{\def\@glsnumformat{#1}} \define@key{glossnum}{type}{\def\@glsnumtype{#1}} \define@key{glossnum}{delimN}{\def\@delimN{#1}} \define@key{glossnum}{delimR}{\def\@delimR{#1}} +\define@key{glossnum}{delimT}{\def\@delimT{#1}} +\define@key{glossnum}{gloskip}{\def\@gloskip{#1}} \define@key{glossnum}{glodelim}{\def\@glodelim{#1}} \providecommand{\ignore}[1]{} @@ -261,6 +295,8 @@ using it.}}{% \def\@glsnumtype{glossary}% \def\@delimN{@dontchange@}% \def\@delimR{@dontchange@}% +\def\@delimT{@dontchange@}% +\def\@gloskip{@dontchange@}% \def\@glodelim{@dontchange@}% \setkeys{glossnum}{#1}\relax \@ifundefined{print\@glsnumtype}{% @@ -275,19 +311,22 @@ Glossary type '\@glsnumtype' has not been defined} \expandafter\xdef\csname @\@glsnumtype @delimR\endcsname{}% }{}% }% - \ifthenelse{\equal{\@delimN}{@dontchange@}}{}{% \expandafter\xdef\csname @\@glsnumtype @delimN\endcsname{% -\@delimN}} - +\@delimN}}% \ifthenelse{\equal{\@delimR}{@dontchange@}}{}{% \expandafter\xdef\csname @\@glsnumtype @delimR\endcsname{% -\@delimR}} - +\@delimR}}% +\ifthenelse{\equal{\@delimT}{@dontchange@}}{}{% +\expandafter\xdef\csname @\@glsnumtype @delimT\endcsname{% +\@delimT}}% +\ifthenelse{\equal{\@gloskip}{@dontchange@}}{}{% +\expandafter\xdef\csname @\@glsnumtype @gloskip\endcsname{% +\@gloskip}}% \ifthenelse{\equal{\@glodelim}{@dontchange@}}{}{% \expandafter\xdef\csname @\@glsnumtype @glodelim\endcsname{% -\@glodelim} -} +\@glodelim}% +}% }} \newcommand{\@gls@glossary@inext}{gls} \newcommand\printglossary[1][glossary]{% @@ -307,30 +346,49 @@ Glossary type '\@glsnumtype' has not been defined} \def\@glossaryname{\glossaryname} \def\@shortglossaryname{\shortglossaryname} \providecommand{\glossarytitle}{% -\@ifundefined{chapter} -{\section*{\@glossaryname}\relax - \ifgls@toc\@glosaddtoc{section}\fi} -{\ifthenelse{\boolean{gls@section}} - {\section*{\@glossaryname}\relax - \ifgls@toc\@glosaddtoc{section}\fi} - {\ifgls@hypertoc\@ifundefined{if@twoside}{\clearpage}{% - \if@twoside\@ifundefined{cleardoublepage}{\cleardoublepage}{\clearpage}\else - \clearpage\fi}\phantomsection\@glosaddtoc{chapter}\fi\chapter*{\@glossaryname}\relax - \ifgls@toc\@glosaddtoc{chapter}\fi}} +\@ifundefined{chapter}% +{% +\ifgls@hypertoc +\phantomsection% add anchor before \section* +\@glosaddtoc{section}% +\section*{\@glossaryname}\relax +\else +\section*{\@glossaryname}\relax +\ifgls@toc\@glosaddtoc{section}\fi +\fi}% +{% \chapter defined +\ifthenelse{\boolean{gls@section}}% +{% user requested \section +\ifgls@hypertoc +\phantomsection% add anchor before \section* +\@glosaddtoc{section}% +\section*{\@glossaryname}\relax +\else +\section*{\@glossaryname}\relax +\ifgls@toc\@glosaddtoc{section}\fi +\fi}% +{% use \chapter +\ifgls@hypertoc +\@ifundefined{if@twoside}{% +\clearpage}{% +\if@twoside +\@ifundefined{cleardoublepage}{\clearpage}{\cleardoublepage}% +\else +\clearpage +\fi}% +\phantomsection% add anchor before \chapter +\@glosaddtoc{chapter}% +\fi +\chapter*{\@glossaryname}\relax +\ifgls@toc\@glosaddtoc{chapter}\fi}} \markboth{\@shortglossaryname}{\@shortglossaryname}% } -\@ifundefined{theglossary}{ -\newenvironment{theglossary} -{\glossarytitle - \glossarypreamble\@bef@reglos} - {\@ftergl@s\glossarypostamble} -}{% -\PackageWarning{glossary}{Redefining 'theglossary' environment} -\renewenvironment{theglossary} -{\glossarytitle - \glossarypreamble\@bef@reglos} - {\@ftergl@s\glossarypostamble} -} +\@ifundefined{theglossary}{% +\newenvironment{theglossary}{}{}}{% +\PackageWarning{glossary}{Redefining 'theglossary' environment}} +\renewenvironment{theglossary}{% +\glossarytitle +\glossarypreamble\@bef@reglos}{\@ftergl@s\glossarypostamble} \newcommand{\glossarypreamble}{} \newcommand{\glossarypostamble}{} \newcommand{\@glosaddtoc}[1]{% @@ -340,18 +398,53 @@ Glossary type '\@glsnumtype' has not been defined} \newif\ifgloitemfirst \newcommand{\@bef@reglos}{\global\gloitemfirsttrue\beforeglossary} \newcommand{\@ftergl@s}{\afterglossary\global\gloitemfirstfalse} - -\ifthenelse{\equal{\gls@style}{list} \or \equal{\gls@style}{altlist}} -{ -\newcommand{\beforeglossary}{\begin{description}} -\newcommand{\afterglossary}{\end{description}} -\newcommand{\gloskip}{\indexspace} -\ifthenelse{\equal{\gls@style}{list}} - {\newcommand{\gloitem}[1]{\item[#1]} - \newcommand{\@glossary@glodelim}{, }} - {\newcommand{\gloitem}[1]{\item[#1]\mbox{}\par} - \newcommand{\@glossary@glodelim}{ }} -}{ +\newcommand{\glossaryalignment}{\relax} +\newcommand{\@gls@align@glossary}{} +\newcommand{\glosstail}{% +\@ifundefined{@gls@tail@\@glostype}{% +\PackageError{glossary}{No glossary tail defined for glossary +type '\@glostype'}{}}{% +\csname @gls@tail@\@glostype\endcsname}} +\newcommand{\@gls@tail@glossary}{} +\newcommand{\afterglossary}{% +\@ifundefined{@gls@afterglos@\@glostype}{% +\PackageError{glossary}{No after glossary defined for glossary +type '\@glostype'}{}}{% +\csname @gls@afterglos@\@glostype\endcsname}} +\newcommand{\beforeglossary}{% +\@ifundefined{@gls@beforeglos@\@glostype}{% +\PackageError{glossary}{No before glossary defined for glossary +type '\@glostype'}{}}{% +\csname @gls@beforeglos@\@glostype\endcsname}} +\newcommand{\@gls@beforeglos@glossary}{} +\newcommand{\@gls@afterglos@glossary}{} +\newcommand{\@glossary@glodelim}{} +\newcommand{\@glossary@delimT}{} +\newcommand{\glsafternum}{} +\newcommand{\glsbeforenum}{} +\newcommand{\@glossary@gloskip}{} +\newcommand{\@glossary@gloitem}[1]{#1} +\newcommand{\gls@setlist}[1][glossary]{% +\expandafter\def\csname @gls@beforeglos@#1\endcsname{% +\begin{description}}% +\expandafter\def\csname @gls@afterglos@#1\endcsname{% +\end{description}}% +\expandafter\def\csname @#1@gloskip\endcsname{\indexspace}% +\expandafter\def\csname @#1@glodelim\endcsname{, }% +\expandafter\def\csname @#1@gloitem\endcsname##1{\item[##1]}% +\expandafter\def\csname @#1@glodelim\endcsname{, }% +\expandafter\def\csname @#1@delimT\endcsname{} +} +\newcommand{\gls@setaltlist}[1][glossary]{% +\expandafter\def\csname @gls@beforeglos@#1\endcsname{% +\begin{description}}% +\expandafter\def\csname @gls@afterglos@#1\endcsname{% +\end{description}}% +\expandafter\def\csname @#1@gloskip\endcsname{\indexspace}% +\expandafter\def\csname @#1@gloitem\endcsname##1{\item[##1]\mbox{}\nopagebreak\par\nopagebreak}% +\expandafter\def\csname @#1@glodelim\endcsname{ }% +\expandafter\def\csname @#1@delimT\endcsname{} +} \ifthenelse{\equal{\gls@style}{super}}{ \IfFileExists{supertab.sty}{\RequirePackage{supertab}} {\IfFileExists{supertabular.sty}{\RequirePackage{supertabular}} @@ -359,102 +452,147 @@ Glossary type '\@glsnumtype' has not been defined} {If you want the "super" option, you have to have the "supertab" package installed.}}} } {\RequirePackage{longtable}} - \newlength{\descriptionwidth} \setlength{\descriptionwidth}{0.6\textwidth} - -\ifthenelse{\equal{\gls@header}{none}} -{ - \ifthenelse{\equal{\gls@border}{none}} - {\newcommand{\glossaryheader}{}} - {\newcommand{\glossaryheader}{\hline }} +\newcommand*{\glossaryheader}{\relax} +\newcommand{\@glossaryheader}{% +\ifx\glossaryheader\relax +\csname @\@glostype @header\endcsname +\else +\glossaryheader +\fi } -{ +\newcommand{\gls@setheader}[1][glossary]{% +\ifthenelse{\equal{\gls@header}{none}}% +{% +\ifthenelse{\equal{\gls@border}{none}} +{\expandafter\def\csname @#1@header\endcsname{}% +}{\expandafter\def\csname @#1@header\endcsname{\hline}}% +}{% \ifnum\gls@cols=2\relax - \ifthenelse{\equal{\gls@border}{none}} - {\newcommand{\glossaryheader} - {\bfseries\entryname & \bfseries \descriptionname\\}} - {\newcommand{\glossaryheader} - {\hline\bfseries\entryname & \bfseries\descriptionname - \\\hline\hline}} +\ifthenelse{\equal{\gls@border}{none}} +{% +\expandafter\def\csname @#1@header\endcsname{% +\bfseries\entryname & \bfseries \descriptionname\\}}% +{% +\expandafter\def\csname @#1@header\endcsname{% +\hline\bfseries\entryname & \bfseries\descriptionname +\\\hline\hline}}% \else - \ifthenelse{\equal{\gls@border}{none}} - {\newcommand{\glossaryheader} - {\bfseries\entryname & \bfseries \descriptionname & \\}} - {\newcommand{\glossaryheader} - {\hline\bfseries\entryname &\bfseries\descriptionname & - \\\hline\hline}} +\ifthenelse{\equal{\gls@border}{none}} +{% +\expandafter\def\csname @#1@header\endcsname{% +\bfseries\entryname & \bfseries \descriptionname & \\}}% +{% +\expandafter\def\csname @#1@header\endcsname{% +\hline\bfseries\entryname &\bfseries\descriptionname & +\\\hline\hline}}% \fi -} - +}} +\newcommand{\gls@setalignment}[1][glossary]{% \ifthenelse{\equal{\gls@border}{none}} { \ifnum\gls@cols=2\relax - \@ifundefined{newcolumntype}{\newcommand{\glossaryalignment}{@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}}}{ - \newcolumntype{G}{@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}}} +\expandafter\def\csname @gls@align@#1\endcsname{% +@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}} \else - \@ifundefined{newcolumntype}{\newcommand{\glossaryalignment}{@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}l}}{ - \newcolumntype{G}{@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}l}} +\expandafter\def\csname @gls@align@#1\endcsname{% +@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}l} \fi - - \ifthenelse{\equal{\gls@style}{super}}{ - \newcommand{\afterglossary}{ \\\end{supertabular}} - } - { - \newcommand{\afterglossary}{ \\\end{longtable}} - } - - \newcommand{\glosstail}{} -} -{ +\expandafter\def\csname @gls@tail@#1\endcsname{}% +}{% \ifnum\gls@cols=2\relax - \@ifundefined{newcolumntype}{\newcommand{\glossaryalignment}{|@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}|}}{ - \newcolumntype{G}{|@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}|}} +\expandafter\def\csname @gls@align@#1\endcsname{% +|@{\hspace{\tabcolsep}\bfseries +}lp{\descriptionwidth}|} \else - \@ifundefined{newcolumntype}{\newcommand{\glossaryalignment}{|@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}l|}}{ - \newcolumntype{G}{|@{\hspace{\tabcolsep}\bfseries}lp{\descriptionwidth}l|}} +\expandafter\def\csname @gls@align@#1\endcsname{% +|@{\hspace{\tabcolsep}\bfseries +}lp{\descriptionwidth}l|} \fi - - \ifthenelse{\equal{\gls@style}{super}}{ - \newcommand{\afterglossary}{ \\\hline\end{supertabular}} - } - { - \newcommand{\afterglossary}{ \\\hline\end{longtable}} - } - - \newcommand{\glosstail}{\hline} -} - -\ifthenelse{\equal{\gls@style}{super}} -{ - \@ifundefined{newcolumntype}{ - \newcommand{\beforeglossary} - {\tablehead{\glossaryheader}\tabletail{\glosstail} - \begin{supertabular}{\glossaryalignment}}} - {\newcommand{\beforeglossary} - {\tablehead{\glossaryheader}\tabletail{\glosstail} - \begin{supertabular}{G}}} +\expandafter\def\csname @gls@tail@#1\endcsname{\hline}% +}% +\expandafter\def\csname @#1@delimT\endcsname{\\} +\ifnum\gls@cols=2\relax +\expandafter\def\csname @#1@gloskip\endcsname{& \\}% +\expandafter\def\csname @#1@glodelim\endcsname{, }% +\else +\expandafter\def\csname @#1@gloskip\endcsname{& & \\}% +\expandafter\def\csname @#1@glodelim\endcsname{& }% +\fi +\expandafter\def\csname @#1@gloitem\endcsname##1{##1 &}% } -{ - \@ifundefined{newcolumntype}{\newcommand{\beforeglossary} - {\begin{longtable}{\glossaryalignment} - \glossaryheader\endhead\glosstail\endfoot}} - {\newcommand{\beforeglossary} - {\begin{longtable}{G} - \glossaryheader\endhead\glosstail\endfoot}} +\newcommand{\@st@rtglostable}[2]{% +\gls@ta={\begin{#1}}\gls@tb=\expandafter{#2}% +\edef\@st@rtglost@ble{\the\gls@ta{\the\gls@tb}} +\@st@rtglost@ble} +\newcommand{\gls@setsuper}[1][glossary]{% +\gls@setalignment[#1]% +\gls@setheader[#1]% +\expandafter\def\csname @gls@beforeglos@#1\endcsname{% +\tablehead{\@glossaryheader}\tabletail{\glosstail}% +\if\glossaryalignment\relax +\expandafter\let\expandafter\@glossaryalignment\csname @gls@align@#1\endcsname +\else +\let\@glossaryalignment\glossaryalignment +\fi +\@st@rtglostable{supertabular}\@glossaryalignment} +\expandafter\def\csname @gls@afterglos@#1\endcsname{% +\end{supertabular}}% } - -\ifnum\gls@cols=2\relax -\newcommand{\gloskip}{\ifgloitemfirst\global\gloitemfirstfalse \else\\ \fi &} -\newcommand{\@glossary@glodelim}{, } +\newcommand{\gls@setlong}[1][glossary]{% +\gls@setalignment[#1]% +\gls@setheader[#1]% +\expandafter\def\csname @gls@beforeglos@#1\endcsname{% +\if\relax\glossaryalignment +\expandafter\let\expandafter\@glossaryalignment\csname @gls@align@#1\endcsname \else -\newcommand{\gloskip}{\ifgloitemfirst\global\gloitemfirstfalse \else\\ \fi & &} -\newcommand{\@glossary@glodelim}{& } +\let\@glossaryalignment\glossaryalignment \fi -\newcommand{\gloitem}[1]{\ifgloitemfirst\global\gloitemfirstfalse #1 \else \\#1 \fi &} +\@st@rtglostable{longtable}{\@glossaryalignment} +\@glossaryheader\endhead\glosstail\endfoot} + +\expandafter\def\csname @gls@afterglos@#1\endcsname{% +\end{longtable}}% } +\newcommand{\@setglossarystyle}[1][glossary]{% +\@ifundefined{gls@set\gls@style}{% +\PackageError{glossary}{Glossary style '\gls@style' undefined}{}}{% +\csname gls@set\gls@style\endcsname[#1]}} +\@setglossarystyle +\define@key{glosstyle} + {style} + {\ifthenelse{\equal{#1}{list} \or \equal{#1}{altlist} \or \equal{#1}{super} \or \equal{#1}{long}} + {\def\gls@style{#1}} + {\PackageError{glossary} + {Unknown glossary style '#1'} + {Available styles are: list, altlist, super and long}}} + +\define@key{glosstyle} + {header}[plain]{\ifthenelse{\equal{#1}{none} \or \equal{#1}{plain}} + {\def\gls@header{#1}} + {\PackageError{glossary} + {Unknown glossary style '#1'} + {Available styles are: none and plain}}} -\ifthenelse{\equal{\gls@number}{none} \and \gls@cols<3}{\renewcommand{\@glossary@glodelim}{}}{} +\define@key{glosstyle} + {border}[plain]{\ifthenelse{\equal{#1}{none} \or \equal{#1}{plain}} + {\def\gls@border{#1}} + {\PackageError{glossary} + {Unknown glossary border '#1'} + {Available styles are: none and plain}}} +\define@key{glosstyle}{cols}{\gls@cols=#1\relax +\ifthenelse{\gls@cols<2 \or \gls@cols>3} + {\PackageError{glossary} + {invalid number of columns} + {The cols option can only be 2 or 3}} + {}} +\newcommand{\setglossarystyle}[2][glossary]{% +\setkeys{glosstyle}{#2}% +\@setglossarystyle[#1]% +} +\ifthenelse{\equal{\gls@number}{none} \and \gls@cols<3}{% +\renewcommand{\@glossary@glodelim}{}}{} \newif\ifist \let\noist=\istfalse \if@filesw\isttrue\else\istfalse\fi @@ -473,6 +611,7 @@ Glossary type '\@glsnumtype' has not been defined} \write\istfile{page_compositor "\pagecompositor"} \write\istfile{delim_n "\string\\delimN "} \write\istfile{delim_r "\string\\delimR "} +\write\istfile{delim_t "\string\\delimT "} \closeout\istfile } \catcode`\%14\relax @@ -496,7 +635,6 @@ Glossary type '\@glsnumtype' has not been defined} \expandafter\gdef\csname glsX\@glstype Xnumformat\endcsname{\glsXglossaryXnumformat}% \expandafter\gdef\csname @\@glstype @delimN\endcsname{\@glossary@delimN}% \expandafter\gdef\csname @\@glstype @delimR\endcsname{\@glossary@delimR}% -\expandafter\gdef\csname @\@glstype @glodelim\endcsname{\@glossary@glodelim}% \expandafter\gdef\csname @gls@\@glstype @inext\endcsname{#4}% \expandafter\def\csname @gls@#2@type\endcsname{#4}% \expandafter\edef\csname make\@glstype\endcsname{% @@ -517,12 +655,14 @@ Glossary type '\@glsnumtype' has not been defined} }{% \noexpand\edef\noexpand\@shortglossaryname{% \noexpand\csname short\@glstype name\noexpand\endcsname}}% -\noexpand\@prntgl@ss@ry{\@glsin}} +\noexpand\@prntgl@ss@ry{\@glsin}}% }{\PackageError{glossary}{Command \expandafter\string\csname #2\endcsname \space already defined}{% You can't call your new glossary type '#2' because there already -exists a command with this name}} -} +exists a command with this name}}% +\@@n@wglostype} +\newcommand{\@@n@wglostype}[1][]{% +\setglossarystyle[\@glstype]{#1}} \newcommand\@m@kegl@ss[2]{ \expandafter\newwrite\csname @#1file\endcsname \expandafter\immediate\expandafter @@ -579,65 +719,72 @@ exists a command with this name}} \newcommand{\glsprimaryfmt}[1]{\textbf{\glsnumformat{#1}}} \newcommand{\@acronymnamefmt}{\glolong\ (\gloshort)} \newcommand{\setacronymnamefmt}[1]{\def\@acronymnamefmt{#1}} +\newcommand{\@acronymdescfmt}{\glodesc} +\newcommand{\setacronymdescfmt}[1]{\def\@acronymdescfmt{#1}} \newcommand{\acronymfont}[1]{#1} \newcommand{\newacronym}[4][]{% \ifthenelse{\equal{#1}{}}{\renewcommand\@acrnmcmd{#2}}{\renewcommand\@acrnmcmd{#1}} \@ifundefined{\@acrnmcmd}{% \expandafter\newcommand\csname\@acrnmcmd short\endcsname{#2\protect\glsxspace} +\expandafter\newcommand\csname\@acrnmcmd @nx@short\endcsname{#2} \expandafter\newcommand\csname\@acrnmcmd long\endcsname{#3\protect\glsxspace} +\expandafter\newcommand\csname\@acrnmcmd @nx@long\endcsname{#3} \def\@acrn@entry{#4} { +\@gls@getdescr{\@acrn@entry}% +\let\glodesc\@glo@desc% \def\glolong{#3}% \def\gloshort{\noexpand\acronymfont{#2}}% \expandafter\protected@xdef\expandafter\@acrnamefmt{\@acronymnamefmt} +\expandafter\protected@xdef\expandafter\@acrdesc{\@acronymdescfmt} } \@acr@addtolist{\@acrnmcmd} -\protected@edef\@acr@glsentry{name=\@acrnamefmt,format=glsnumformat,sort=\@acrnmcmd,\@acrn@entry} +\protected@edef\@acr@glsentry{name={\@acrnamefmt},format=glsnumformat,sort={\@acrnmcmd},\@acrn@entry,description={\@acrdesc}} \newboolean{\@acrnmcmd first}\setboolean{\@acrnmcmd first}{true} \expandafter\protected@edef\csname \@acrnmcmd\endcsname{\noexpand\@ifstar{\csname @s@\@acrnmcmd\endcsname}{\csname @\@acrnmcmd\endcsname}} -\ifglshyperacronym +\ifglshyperacronym % hyperlinks \expandafter\protected@edef\csname @\@acrnmcmd\endcsname{% \noexpand\ifthenelse{\noexpand\boolean{\@acrnmcmd first}}{% -\noexpand\gls@noxspace{\csname\@acrnmcmd long\endcsname\noexpand\@acrnmins\ +\csname\@acrnmcmd @nx@long\endcsname\noexpand\@acrnmins\ (\noexpand\xacronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}% -})}\noexpand\setboolean{\@acrnmcmd first}{false}% +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}% +})\noexpand\unsetacronym{\@acrnmcmd}% }{\noexpand\xacronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}\noexpand\@acrnmins}}\noexpand\glsxspace} +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}\noexpand\@acrnmins}}\noexpand\glsxspace} \expandafter\protected@edef\csname @s@\@acrnmcmd\endcsname{% \noexpand\ifthenelse{\noexpand\boolean{\@acrnmcmd first}}{% -\noexpand\gls@noxspace{\noexpand\expandafter\noexpand\MakeUppercase -\csname\@acrnmcmd long\endcsname\noexpand\@acrnmins\ +\noexpand\expandafter\noexpand\MakeUppercase +\csname\@acrnmcmd @nx@long\endcsname\noexpand\@acrnmins\ (\noexpand\xacronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}% -})}% -\noexpand\setboolean{\@acrnmcmd first}{false}}{% +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}% +})% +\noexpand\unsetacronym{\@acrnmcmd}}{% \noexpand\xacronym{\@acr@glsentry}{% \noexpand\acronymfont{\noexpand\expandafter\noexpand\MakeUppercase -\csname\@acrnmcmd short\endcsname}% +\csname\@acrnmcmd @nx@short\endcsname}% \noexpand\@acrnmins}}\noexpand\glsxspace} -\else +\else % no hyperlinks \expandafter\protected@edef\csname @\@acrnmcmd\endcsname{% \noexpand\ifthenelse{\noexpand\boolean{\@acrnmcmd first}}{% -\noexpand\gls@noxspace{\csname\@acrnmcmd long\endcsname\ +\csname\@acrnmcmd @nx@long\endcsname\noexpand\@acrnmins\ (\noexpand\acronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}% -})}\noexpand\setboolean{\@acrnmcmd first}{false}% +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}% +})\noexpand\unsetacronym{\@acrnmcmd}% }{\noexpand\acronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}}}% +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}\noexpand\@acrnmins}}% \noexpand\glsxspace} \expandafter\protected@edef\csname @s@\@acrnmcmd\endcsname{% \noexpand\ifthenelse{\noexpand\boolean{\@acrnmcmd first}}{% -\noexpand\gls@noxspace{\noexpand\expandafter +\noexpand\expandafter \noexpand\MakeUppercase -\csname\@acrnmcmd long\endcsname\noexpand\@acrnmins\ +\csname\@acrnmcmd @nx@long\endcsname\noexpand\@acrnmins\ (\noexpand\acronym{\@acr@glsentry}{% -\noexpand\acronymfont{\csname\@acrnmcmd short\endcsname}% -})}% -\noexpand\setboolean{\@acrnmcmd first}{false}}{% +\noexpand\acronymfont{\csname\@acrnmcmd @nx@short\endcsname}% +})% +\noexpand\unsetacronym{\@acrnmcmd}}{% \noexpand\acronym{\@acr@glsentry}{% \noexpand\acronymfont{\noexpand\expandafter\noexpand\MakeUppercase -\csname\@acrnmcmd short\endcsname}% +\csname\@acrnmcmd @nx@short\endcsname}% \noexpand\@acrnmins}}\noexpand\glsxspace} \fi }{% @@ -656,21 +803,23 @@ The command name specified by \string\newacronym already exists.}}} \newcommand{\@acrln}[1]{\@ifundefined{#1long}{% \PackageError{glossary}{Acronym '#1' has not been defined}{}}{% -\gls@noxspace{\csname#1long\endcsname}}} +\csname#1@nx@long\endcsname}} \newcommand{\@sacrln}[1]{\@ifundefined{#1long}{% \PackageError{glossary}{Acronym '#1' has not been defined}{}}{% -\gls@noxspace{\expandafter\expandafter\expandafter -\MakeUppercase\csname#1long\endcsname}}} +\expandafter\expandafter\expandafter +\MakeUppercase\csname#1@nx@long\endcsname}} \newcommand{\acrsh}{\@ifstar\@sacrsh\@acrsh} \newcommand{\@acrsh}[1]{\@ifundefined{#1short}{% -\PackageError{glossary}{Acronym '#1' has not been defined}{}}{\acronymfont{\gls@noxspace{\csname#1short\endcsname}}}} +\PackageError{glossary}{Acronym '#1' has not been defined}{}}{% +\acronymfont{\csname#1@nx@short\endcsname}}} \newcommand{\@sacrsh}[1]{\@ifundefined{#1short}{% \PackageError{glossary}{Acronym '#1' has not been defined}{}}{% -\acronymfont{\gls@noxspace{\expandafter\expandafter\expandafter\MakeUppercase\csname#1short\endcsname}}}} +\acronymfont{\expandafter\expandafter\expandafter +\MakeUppercase\csname#1@nx@short\endcsname}}} \newcommand{\ifacronymfirstuse}[3]{% \@ifundefined{if#1first}{% @@ -680,10 +829,26 @@ The command name specified by \string\newacronym already exists.}}} \newcommand{\resetacronym}[1]{% \@ifundefined{if#1first}{% \PackageError{glossary}{Acronym '#1' not defined}{}}{% -\setboolean{#1first}{true}}} +\ifglsglobal +\expandafter\global\csname #1firsttrue\endcsname +\else +\setboolean{#1first}{true}% +\fi}} + +\newcommand{\unsetacronym}[1]{% +\@ifundefined{if#1first}{% +\PackageError{glossary}{Acronym '#1' not defined}{}}{% +\ifglsglobal +\expandafter\global\csname #1firstfalse\endcsname +\else +\setboolean{#1first}{false}% +\fi}} \newcommand{\resetallacronyms}{% \@for\@acr:=\@acr@list\do{\resetacronym{\@acr}}} + +\newcommand{\unsetallacronyms}{% +\@for\@acr:=\@acr@list\do{\unsetacronym{\@acr}}} \ifglshyper \def\glshyperpage#1{\@glshyperpage#1\delimR \delimR \\} \def\@glshyperpage#1\delimR #2\delimR #3\\{% @@ -751,7 +916,7 @@ The command name specified by \string\newacronym already exists.}}} \fi \ifglsacronym \newglossarytype[alg]{acronym}{acr}{acn} -\newcommand{\acronymname}{List of Acronyms} +\providecommand{\acronymname}{List of Acronyms} \else \let\acronym=\glossary \let\xacronym=\xglossary diff --git a/Master/texmf-dist/tpm/glossary.tpm b/Master/texmf-dist/tpm/glossary.tpm index c7114322911..9d0dd4ab420 100644 --- a/Master/texmf-dist/tpm/glossary.tpm +++ b/Master/texmf-dist/tpm/glossary.tpm @@ -3,7 +3,7 @@ <rdf:Description about="http://texlive.dante.de/texlive/Package/glossary.zip"> <TPM:Name>glossary</TPM:Name> <TPM:Type>Package</TPM:Type> - <TPM:Date>2006/01/11 23:03:17</TPM:Date> + <TPM:Date>2006/07/10 22:34:35</TPM:Date> <TPM:Version>2.19</TPM:Version> <TPM:Creator>rahtz</TPM:Creator> <TPM:Title>Create a glossary</TPM:Title> @@ -18,11 +18,12 @@ one type of glossary in your document. <TPM:Author>Nicola Talbot</TPM:Author> <TPM:Size>658249</TPM:Size> <TPM:Build/> - <TPM:RunFiles size="32551"> + <TPM:RunFiles size="38063"> texmf-dist/tex/latex/glossary/glossary.sty texmf-dist/tpm/glossary.tpm </TPM:RunFiles> - <TPM:DocFiles size="463936"> + <TPM:DocFiles size="495604"> +texmf-dist/doc/latex/glossary/CHANGES texmf-dist/doc/latex/glossary/README texmf-dist/doc/latex/glossary/glossary.pdf texmf-dist/doc/latex/glossary/glossary.perl @@ -30,6 +31,7 @@ texmf-dist/doc/latex/glossary/makeglos.bat texmf-dist/doc/latex/glossary/makeglos.pl texmf-dist/doc/latex/glossary/manual.html texmf-dist/doc/latex/glossary/sample.tex +texmf-dist/doc/latex/glossary/sample4col.tex texmf-dist/doc/latex/glossary/sampleAcr.tex texmf-dist/doc/latex/glossary/sampleEq.tex texmf-dist/doc/latex/glossary/sampleEqPg.tex @@ -37,7 +39,7 @@ texmf-dist/doc/latex/glossary/sampleNtn.tex texmf-dist/doc/latex/glossary/sampleNtn2.tex texmf-dist/doc/latex/glossary/sampleSec.tex </TPM:DocFiles> - <TPM:SourceFiles size="161762"> + <TPM:SourceFiles size="179741"> texmf-dist/source/latex/glossary/glossary.dtx texmf-dist/source/latex/glossary/glossary.ins </TPM:SourceFiles> diff --git a/Master/texmf/lists/glossary b/Master/texmf/lists/glossary index d239b01bb83..4d218e3237b 100644 --- a/Master/texmf/lists/glossary +++ b/Master/texmf/lists/glossary @@ -1,3 +1,4 @@ +texmf-dist/doc/latex/glossary/CHANGES texmf-dist/doc/latex/glossary/README texmf-dist/doc/latex/glossary/glossary.pdf texmf-dist/doc/latex/glossary/glossary.perl @@ -5,6 +6,7 @@ texmf-dist/doc/latex/glossary/makeglos.bat texmf-dist/doc/latex/glossary/makeglos.pl texmf-dist/doc/latex/glossary/manual.html texmf-dist/doc/latex/glossary/sample.tex +texmf-dist/doc/latex/glossary/sample4col.tex texmf-dist/doc/latex/glossary/sampleAcr.tex texmf-dist/doc/latex/glossary/sampleEq.tex texmf-dist/doc/latex/glossary/sampleEqPg.tex |