From 2591d5bab21119052bb58e82db7fd9fab8e97a7c Mon Sep 17 00:00:00 2001 From: Manuel Pégourié-Gonnard Date: Sat, 21 Jun 2008 16:05:24 +0000 Subject: glossaries update 21jun08 git-svn-id: svn://tug.org/texlive/trunk@8904 c570f23f-e606-0410-a88d-b1316a301751 --- Master/bin/win32/makeglossaries.bat | 11 +- Master/texmf-dist/doc/latex/glossaries/CHANGES | 23 + Master/texmf-dist/doc/latex/glossaries/README | 9 +- .../doc/latex/glossaries/glossaries-manual.html | 2599 +++++++++++--------- .../doc/latex/glossaries/glossaries-manual.tex | 316 ++- .../texmf-dist/doc/latex/glossaries/glossaries.pdf | Bin 739936 -> 761745 bytes .../doc/latex/glossaries/glossary2glossaries.html | 192 +- .../doc/latex/glossaries/glossary2glossaries.pdf | Bin 170294 -> 175041 bytes .../doc/latex/glossaries/glossary2glossaries.tex | 163 +- .../doc/latex/glossaries/samples/minimalgls.tex | 16 +- .../source/latex/glossaries/glossaries.dtx | 546 +++- .../source/latex/glossaries/glossaries.ins | 41 +- .../tex/latex/glossaries/base/glossaries.sty | 51 +- .../tex/latex/glossaries/base/mfirstuc.sty | 14 +- .../latex/glossaries/styles/glossary-hypernav.sty | 58 +- .../tex/latex/glossaries/styles/glossary-list.sty | 4 +- 16 files changed, 2453 insertions(+), 1590 deletions(-) diff --git a/Master/bin/win32/makeglossaries.bat b/Master/bin/win32/makeglossaries.bat index fe949613d7c..d91f67bd3e9 100755 --- a/Master/bin/win32/makeglossaries.bat +++ b/Master/bin/win32/makeglossaries.bat @@ -1,8 +1,3 @@ -@echo off -rem tl-w32-starter.bat -rem universal script starter, batch file part -rem this program calls the tl-w32-wrapper.texlua -setlocal -set ownpath=%~dp0% -texlua "%ownpath%tl-w32-wrapper.texlua" "%~dpn0" %* -endlocal +@rem = '-*- Perl -*- +@echo off +perl -S "%~dp0makeglossaries" %* diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index c7b21c9e29c..df15408017a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,28 @@ glossaries change log: +v1.14 : + * Fixed bug in \glsnavhyperlink that causes an error when used + with hyperref and translator packages. + + * Added \glsautoprefix (specifies a prefix to the automatically + generated label) + + * Added nonumberlist and numberedsection keys to \printglossary + + * Changed \glsnavigation so that it only lists the groups that + are present. (This prevents unknown target warnings.) + + * Amended documentation. + +mfirstuc v1.02 (18 June 2008): + + * Fixed bug that transfered grouping, (e.g + \makefirstuc{\emph{abc}xyz} moved the xyz into the \emph) + + * If group following initial command is empty, \MakeUppercase + is applied to the command, e.g. \makefirstuc{\ae{}bc} now + produces \MakeUppercase\ae{}bc. + v1.13 : * Fixed bug in long4colheaderborder that puts an extra row at the end of the glossary. diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index 7a842dcdddf..3530e14c9c4 100644 --- a/Master/texmf-dist/doc/latex/glossaries/README +++ b/Master/texmf-dist/doc/latex/glossaries/README @@ -1,6 +1,6 @@ -LaTeX Package : glossaries v 1.12 +LaTeX Package : glossaries v 1.14 -Last Modified : 8 March 2008 +Last Modified : 17 June 2008 Author : Nicola Talbot @@ -18,7 +18,7 @@ to the relevant glossary. The glossaries bundle also includes mfirstuc.sty which provides \makefirstuc{} which makes the first object of uppercase unless starts with a control -sequence followed by a group, in which case the first +sequence followed by a non-empty group, in which case the first object in the group is converted to uppercase. Examples: \makefirstuc{abc} -> Abc @@ -26,8 +26,7 @@ object in the group is converted to uppercase. Examples: \makefirstuc{{\'a}bc} -> {\'A}bc \makefirstuc{\ae bc} -> \AE bc \makefirstuc{{\ae}bc} -> {\AE}bc - -(but don't do \makefirstuc{\ae{}bc} which produces \ae Bc.) + \makefirstuc{\ae{}bc} -> \AE{}bc INSTALLATION diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html index 2d75f7cafa5..d95128495a4 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.html @@ -7,8 +7,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds Jens Lippmann, Marek Rouchal, Martin Wilck and others --> -glossaries.sty v 1.13: LaTeX2e Package to Assist Generating Glossaries - +glossaries.sty v 1.14: LaTeX2e Package to Assist Generating Glossaries + @@ -27,7 +27,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds

-

glossaries.sty v 1.13: LaTeX2e Package to Assist Generating Glossaries

+

glossaries.sty v 1.14: LaTeX2e Package to Assist Generating Glossaries

Nicola L.C. Talbot

@@ -40,7 +40,7 @@ Norwich. Norfolk NR4 7TJ. United Kingdom.
http://theoval.cmp.uea.ac.uk/~nlct/

-

12th May 2008

+

18th June 2008


@@ -49,49 +49,49 @@ Contents @@ -109,7 +109,7 @@ It also supports acronyms and glossary styles that include symbols (in addition to a name and description) for glossary entries. There is provision for loading a database of glossary terms where only those terms used in the text are added to the glossary. -This package replaces the glossary package which is now +This package replaces the glossary package which is now obsolete.

@@ -127,8 +127,10 @@ package.

-

-Multi-Lingual Support +

+ +
+Multi-Lingual Support

@@ -136,14 +138,22 @@ As from version 1.08, the glossaries package now has limited multi-lingual support, thanks to all the people who have sent me the relevant translations either via email or via comp.text.tex. -However you must load babel before -glossaries to enable this. Note that if babel is loaded -and the translator package is detected on TEX's path, then the -translator package will be loaded automatically. +However you must load babel before +glossaries to enable this. Note that if babel is loaded +and the translator package is detected on TEX's path, then the +translator package will be loaded automatically, however, +it may not pick up on the required languages, so if the predefined +text is not translated, you may need to explicitly load the +translator package with the required languages. For example: +

+\usepackage[spanish]{babel}
+\usepackage[spanish]{translator}
+\usepackage{glossaries}
+

-If you want to use ngerman or german instead -of babel, you will need to include the translator package +If you want to use ngerman or german instead +of babel, you will need to include the translator package to provide the translations. For example:

 \documentclass[ngerman]{article}
@@ -191,7 +201,7 @@ The following languages are currently supported:
 
 
 
-The language dependent commands and translator keys used by the 
+The language dependent commands and translator keys used by the 
 glossaries package are listed in table 1.
 
 

@@ -200,7 +210,7 @@ glossaries package are listed in

- + @@ -208,41 +218,41 @@ Customised Text - + - + +(when used with package option acronym). - + - + - + - + - + - +

Due to the varied nature of glossaries, it's likely that the predefined translations may not be appropriate. If you are using -the babel package and do not have the translator package +the babel package and do not have the translator package installed, you need to be familiar with the advice on changing the words babel uses.

-If you have the translator package installed, then it becomes +If you have the translator package installed, then it becomes much easier to change the default translations. For example, if you are writing in Irish and you want \symbolname to produce "Siombail" instead of "Comhartha", then you can put the following @@ -281,9 +291,9 @@ Generating the associated glossary files

The glossaries package comes with the Perl script -makeglossaries which will run makeindex on -all the glossary files using a customized makeindex -.ist style file (which is created by \makeglossaries). +makeglossaries which will run makeindex on +all the glossary files using a customized makeindex +.ist style file (which is created by \makeglossaries). The relevant extensions are obtained from the auxiliary file, so you should only pass the basename as the argument. For example, if your document is called @@ -293,7 +303,7 @@ latex myfile makeglossaries myfile latex myfile -You may need to explicitly load makeglossaries into +You may need to explicitly load makeglossaries into Perl:

 perl makeglossaries myfile
@@ -304,8 +314,8 @@ be able to use it.
 
 

If you don't have Perl installed, you will have to run -makeindex for each glossary type you have defined. -For example, if you have used the acronym package option +makeindex for each glossary type you have defined. +For example, if you have used the acronym package option then you will have both a main glossary as well as a list of acronyms, so you will need to do (assuming your document is called myfile.tex):

@@ -314,14 +324,14 @@ makeindex -s myfile.ist -t myfile.alg -o myfile.acr myfile.acn
 
This requires remembering all extensions for each of the glossaries defined in your document, so where possible you should use -makeglossaries instead to reduce the possibility of error. +makeglossaries instead to reduce the possibility of error. Don't pass all the glossary files in a single call to -makeindex or it will merge all your glossaries into a +makeindex or it will merge all your glossaries into a single glossary.

If any problems occur, remember to check the transcript files -(e.g. .glg or .alg) for messages. +(e.g. .glg or .alg) for messages.

Top @@ -334,16 +344,139 @@ Troubleshooting

The glossaries package comes with a minimal file called minimalgls.tex which can be used for testing. This -should be located in texmf/doc/latex/glossaries/samples/. Further -information on debugging LaTeX code is available at +should be located in texmf/doc/latex/glossaries/samples/. +Further information on debugging LaTeX code is available at http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/.

-There is a list of frequently asked questions for the -glossaries package available at +Below is a list of the most frequently asked questions. For +other queries, consult the glossaries FAQ at http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html. + HREF="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html">http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html. + +

+ +

    +
  1. I've used the smallcaps option, but the acronyms +are displayed in normal sized upper case letters. + +

    +The smallcaps package option uses \textsc to typeset +the acronyms. This command converts lower case letters to small +capitals, while upper case letters remain their usual size. Therefore +you need to specify the acronym in lower case letters. + +

    +

  2. +
  3. How do I change the font that the acronyms are displayed in? + +

    +The easiest way to do this is to specify the smaller package +option and redefine \acronymfont to use the required typesetting +command. For example, suppose you would like the acronyms displayed in +a sans-serif font, then you can do: +

    +\usepackage[smaller]{glossaries}
    +\renewcommand*{\acronymfont}[1]{\textsf{#1}}
    +
    + +

    +

  4. +
  5. How do I change the font that the acronyms are displayed in +on first use? + +

    +The easiest way to do this is to specify the smaller package +option and redefine \firstacronymfont to use the required +command. Note that if you don't want the acronym on subsequent use +to use \smaller, you will also need to redefine \acronymfont, +as above. For example to make the acronym emphasized on first use, +but use the surrounding font for subsequent use, you can do: +

    +\usepackage[smaller]{glossaries}
    +\renewcommand*{\firstacronymfont}[1]{\emph{#1}}
    +\renewcommand*{\acronymfont}[1]{#1}
    +
    + +

    +

  6. +
  7. I don't have Perl installed, do I have to use +makeglossaries? + +

    +Read the previous +section. + +

    +

  8. +
  9. I'm used to using the glossary package: are there any +instructions on migrating from the glossary package to the +glossaries package? + +

    +Read Upgrading +from the glossary package to the glossaries +package which should be available from the +same location as this document. + +

    +

  10. +
  11. I'm using babel but the fixed names haven't been +translated. + +

    +The glossaries package currently only supports the following +languages: Danish, Dutch, English, French, German, Irish, Italian, +Hungarian, Polish and Spanish. If you want to add another language, +send me the translations, and I'll add them to the next version. + +

    +If you are using one of the above languages, but the text hasn't been +translated, try adding the translator package with the +required languages explicitly (before you load the glossaries +package). For example: +

    +\usepackage[ngerman]{babel}
    +\usepackage[ngerman]{translator}
    +\usepackage{glossaries}
    +
    +Alternatively, you may be able to add the language as a global option +to the class file. Check the translator package documentation for +further details. + +

    +

  12. +
  13. My glossaries haven't appeared. + +

    +Remember to do the following: + +

      +
    • Add \makeglossaries to the document preamble. + +

      +

    • +
    • Use either \printglossary for each glossary that has +been defined or \printglossaries. + +

      +

    • +
    • Use \gls, \Gls, \GLS, \glspl, \Glspl, +\GLSpl, \glslink, \glsadd or \glsaddall in the +document. + +

      +

    • +
    • Run LaTeX on your document, then run makeglossaries, +then run LaTeX on your document again. If you want the glossaries +to appear in the table of contents, you will need an extra LaTeX run. +
    • +
    +
  14. +
+

Top @@ -364,12 +497,12 @@ for additional commands and advice not listed here.

    -
  1. Load glossaries after hyperref: +
  2. Load glossaries after hyperref:
     \usepackage{hyperref}
     \usepackage{glossaries}
     
    -Similarly for the html package: +Similarly for the html package:
     \usepackage{html}
     \usepackage{glossaries}
    @@ -377,19 +510,19 @@ Similarly for the html package:
     
     

  3. -
  4. Always use \makeglossaries if you want the glossary +
  5. Always use \makeglossaries if you want the glossary entries to be written to the glossary file:
     \documentclass{article}
     \usepackage{glossaries}
     \makeglossaries
     
    -If you don't use \makeglossaries, your glossaries will +If you don't use \makeglossaries, your glossaries will not appear in the document!

  6. -
  7. Use \printglossaries to make your glossaries appear +
  8. Use \printglossaries to make your glossaries appear in the document at that point. For example:
     \maketitle
    @@ -402,13 +535,13 @@ document text will appear in the glossary.
     

  9. When you have created your document, run LaTeX on it, -then the Perl script makeglossaries, then run LaTeX on it again: +then the Perl script makeglossaries, then run LaTeX on it again:
     latex myfile
     makeglossaries myfile
     latex myfile
     
    -(You may need to run LaTeX again if you have used the toc +(You may need to run LaTeX again if you have used the toc package option.) If you use Windows, there is a batch file called makeglossaries.bat which you can use, but you will @@ -418,23 +551,23 @@ still need Perl installed.
  10. New glossaries can be defined using:

    -\newglossary[log-ext]{label}{in-ext}{out-ext}{title} +\newglossary[log-ext]{label}{in-ext}{out-ext}{title}

    where label is an identifying label, in-ext is the extension of the file to be created -by makeindex (called by makeglossaries), +by makeindex (called by makeglossaries), out-ext is the extension of the file to be read by -makeindex and title is the title for this +makeindex and title is the title for this new glossary. The first optional argument log-ext specifies -the extension of the makeindex transcript file. Example: +the extension of the makeindex transcript file. Example:

     \newglossary[nlg]{notation}{not}{ntn}{Notation}
     
    This glossary's label is notation and its title -will be Notation. If you use makeglossaries, the -makeindex transcript will be written to a file with the -extension .nlg. If log-ext is omitted, the extension -.glg will be used. +will be Notation. If you use makeglossaries, the +makeindex transcript will be written to a file with the +extension .nlg. If log-ext is omitted, the extension +.glg will be used.

  11. @@ -449,7 +582,7 @@ extension .nlg. If log-ext is omitted, the ex

    -

  12. If you use the acronym package option, the +
  13. If you use the acronym package option, the glossaries package will automatically create a new glossary type labelled acronym: @@ -460,8 +593,8 @@ will automatically create a new glossary type labelled

  14. If your pages have a hyphen compositor (i.e. your page -numbers appear in the form 2-1), redefine \glscompositor -before \makeglossaries: +numbers appear in the form 2-1), redefine \glscompositor +before \makeglossaries:
     \documentclass{article}
     \usepackage{glossaries}
    @@ -472,7 +605,7 @@ numbers appear in the form 2-1), redefine \glscompositor package option:
    +toc package option:
     
     \usepackage[toc]{glossaries}
     
    @@ -481,10 +614,10 @@ numbers appear in the form 2-1), redefine \glscompositor{label}{key-val list} +\newglossaryentry{label}{key-val list}

    -The key-val list must at least contain a name -key and a description key. +The key-val list must at least contain a name +key and a description key. For example:

     \newglossaryentry{perl}{name=Perl,
    @@ -498,7 +631,7 @@ to use to identify it.
     
  15. If the entry name starts with an accented letter, you will need to group the first letter (otherwise it will cause a -problem for \Gls and \Glspl): +problem for \Gls and \Glspl):
     \newglossaryentry{elite}{name={{\'e}lite},
     description={select group or class}}
    @@ -512,7 +645,7 @@ description={canal from mouth to stomach}}
     
     

  16. -
  17. If you have multiple glossaries, use the type +
  18. If you have multiple glossaries, use the type key to specify in which glossary the entry belongs. For example:
     \newglossary{languages}{lan}{lng}{Index of Languages}
    @@ -523,7 +656,7 @@ key to specify in which glossary the entry belongs. For example:
     description=A scripting language,
     type=languages}
     
    -If type is omitted, the default glossary is used. +If type is omitted, the default glossary is used.

  19. @@ -539,7 +672,7 @@ description={A list of individual pages or page ranges
  20. Plural forms are assumed to be the singular form with an "s" appended, unless otherwise specified. To specify an -irregular plural, use the plural key. For example: +irregular plural, use the plural key. For example:
     \newglossaryentry{matrix}{name=matrix,
     description=rectangular array of quantities,
    @@ -579,7 +712,7 @@ and subsequently appears as "SM" or "SMs".
     
  21. The quick and easy way to define an acronym is to use:

    -\newacronym[key-val list]{label}{abbrev}{long} +\newacronym[key-val list]{label}{abbrev}{long}

    For example:

    @@ -595,30 +728,30 @@ first={support vector machine (SVM)},
     plural={SVMs},
     firstplural={support vector machines (SVMs)}}
     
    -(The value of \acronymtype varies depending on whether -the acronym package option is used or not. +(The value of \acronymtype varies depending on whether +the acronym package option is used or not. The optional argument key-val list can be used to -override any of the \newglossaryentry keys; for +override any of the \newglossaryentry keys; for example, if the acronym has an irregular plural.)

  22. The font used to display the entry name in the glossary -is governed by \glsnamefont. This can be redefined +is governed by \glsnamefont. This can be redefined as required. For example, to make the entry names appear in a medium sans-serif font do:
     \renewcommand{\glsnamefont}[1]{\textsf{\mdseries #1}}
     
    Note that the list-like glossary styles defined in the -glossary-list package place the entry name in -the optional argument to \item, so they will -appear in bold, unless you redefine \glsnamefont to counteract the +glossary-list package place the entry name in +the optional argument to \item, so they will +appear in bold, unless you redefine \glsnamefont to counteract the bold font.

  23. -
  24. In the document use \gls{label} +
  25. In the document use \gls{label} to use a predefined term (this will also enter the term into the associated glossary output file). For example:
    @@ -630,21 +763,21 @@ A \gls{singmtx} is a matrix with a zero determinant.
     
  26. Other variations:
      -
    • \Gls{label} : like \gls, +
    • \Gls{label} : like \gls, but with first letter in upper case
    • -
    • \GLS{label} : like \gls, +
    • \GLS{label} : like \gls, but all upper case.
    • -
    • \glspl{label} : use plural +
    • \glspl{label} : use plural
    • -
    • \Glspl{label} : use plural with +
    • \Glspl{label} : use plural with first letter in upper case
    • -
    • \GLSpl{label} : use plural but +
    • \GLSpl{label} : use plural but all upper case
    • -
    • \glslink{label}{link text} : +
    • \glslink{label}{link text} : use link text to link to the given entry in the glossary.
    @@ -665,8 +798,8 @@ The \gls{singmtx}['s] dimensions \ldots

  27. The format of the associated entry number can be -changed using the format key in the optional argument. -Note that the value of the format key should be the +changed using the format key in the optional argument. +Note that the value of the format key should be the name of a command without the initial backslash. For example:
    @@ -682,23 +815,23 @@ it will no longer have a hyperlink (if hyperlinks are enabled.)
     change the font whilst ensuring that the number remains a
     hyperlink. These are of the form \hyperxx and
     are equivalent to the standard font changing commands of the
    -form \textxx, as well as \hyperemph
    -(which uses \emph.) For example:
    +form \textxx, as well as \hyperemph
    +(which uses \emph.) For example:
     
     The primary definition of \glspl[format=hyperbf]{singmtx}.
     

  28. -
  29. Don't use declarations in format as this can +
  30. Don't use declarations in format as this can cause unpredictable results, as there is no guarantee that the effect will be localised to the required text.

  31. Entries can be added to the glossary without producing -any text using \glsadd{label} or -\glsaddall. These commands also taken an optional +any text using \glsadd{label} or +\glsaddall. These commands also take an optional argument where you can specify the format. For example
     \glsadd[format=hyperbf]{singmtx}
    @@ -711,8 +844,8 @@ any text where the command occurs.
     
  32. A number range can be entered using format=( and format=) to mark the beginning and ending of the -range1. For example: +range1. For example:
      \glsadd[format=(]{singmtx}
      This is a very long section all about \glspl{singmtx}.
    @@ -721,7 +854,7 @@ range
    -This is equivalent to makeindex's |( and |) 
    +This is equivalent to makeindex's |( and |) 
     formats.
     
     

    @@ -743,13 +876,13 @@ formats.

  33. Only those terms that have actually been used in the document will be placed in the glossary. If you have defined a term that doesn't appear in the document, then it means -you haven't used it in the text (either via \glslink -or \gls and related commands, or via \glsadd -or \glsaddall.) +you haven't used it in the text (either via \glslink +or \gls and related commands, or via \glsadd +or \glsaddall.)

  34. -
  35. To change the sorting order, use the sort key. +
  36. To change the sorting order, use the sort key. For example:
     \newglossaryentry{universal}{name={\ensuremath{\mathcal{U}}},
    @@ -759,7 +892,7 @@ sort=U}
     
     

  37. -
  38. You don't need to escape makeindex's special characters: +
  39. You don't need to escape makeindex's special characters:
     \newglossaryentry{quote}{name={"},
     description={Double quote character}}
    @@ -781,21 +914,21 @@ description={A metric measurement of length},
     symbol={m}}
     
    The predefined glossary styles that display the entry symbol -are: long4col, long4colheader, -long4colborder, long4colheaderborder, -super4col, super4colheader, -super4colborder and super4colheaderborder. +are: long4col, long4colheader, +long4colborder, long4colheaderborder, +super4col, super4colheader, +super4colborder and super4colheaderborder. All the other styles supplied by this package ignore the associated symbol.

  40. -
  41. Glossary styles can be set using the style +
  42. Glossary styles can be set using the style package option. For example:
     \usepackage[style=long3col]{glossaries}
     
    -or using \glossarystyle{style}. For example: +or using \glossarystyle{style}. For example:
     \glossarystyle{altlist}
     
    @@ -805,7 +938,7 @@ bundle are listed in Glossary Styles

  43. The list of numbers associated with each glossary entry -can be suppressed using the package option nonumberlist: +can be suppressed using the package option nonumberlist:
     \usepackage[nonumberlist]{glossaries}
     
    @@ -814,14 +947,14 @@ can be suppressed using the package option nonumberlist<
  44. By default, the glossaries will appear in an unnumbered chapter if chapters are defined, otherwise in an unnumbered -section. This can be changed using the section package +section. This can be changed using the section package option. For example, to make the glossaries appear in an unnumbered section, even if chapters are defined, do:
     \usepackage[section]{glossaries}
     
    Other sectional units can also be specified as -section=value. For example, to make the glossaries +section=value. For example, to make the glossaries appear in unnumbered subsections:
     \usepackage[section=subsection]{glossaries}
    @@ -842,35 +975,37 @@ Overview
     
     

    -

    -Package Options +

    + +
    +Package Options

    The glossaries package options are as follows:

    -
    toc
    +
    toc
    Add the glossaries to the table of contents.

    -
    numberline
    -
    When used with toc, this will +
    numberline
    +
    When used with toc, this will add \numberline{} in the final argument of \addcontentsline. This will align the table of contents entry with the numbered section titles. Note that this option has no -effect if the toc option is omitted. If toc is -used without numberline, the title will be aligned with +effect if the toc option is omitted. If toc is +used without numberline, the title will be aligned with the section numbers rather than the section titles.

    -
    acronym
    +
    acronym
    Make a separate glossary for acronyms.

    -
    section
    +
    section
    This is a key=value option. Its value should be the name of a sectional unit (e.g. chapter). This will make the glossaries appear in the named sectional unit, @@ -888,22 +1023,22 @@ is equivalent to \usepackage[section=section]{glossaries}
    You can change this value later in the document using -\setglossarysection{type}. +\setglossarysection{type}.

    -

    numberedsection
    +
    numberedsection
    The glossaries are placed in unnumbered sectional units by default, -but this can be changed using numberedsection. This option can take -three possible values: false (no -number, i.e. use starred form), nolabel +but this can be changed using numberedsection. This option can take +three possible values: false (no +number, i.e. use starred form), nolabel (numbered, i.e. unstarred form, but not labelled) and -autolabel (numbered with automatic -labelling). If numberedsection=autolabel is used, each +autolabel (numbered with automatic +labelling). If numberedsection=autolabel is used, each glossary is given a label that matches the glossary type, so the main (default) glossary is labelled main, the list of -acronyms is labelled acronym2 and additional glossaries are labelled +acronyms is labelled acronym2 and additional glossaries are labelled using the value specified in the first mandatory argument to \newglossary. For example, if you load glossaries using: @@ -918,102 +1053,119 @@ acronyms is in section~\ref{acronym}.
  45. If you can't decide whether to have the acronyms in the main glossary or a separate list of acronyms, you can use -\acronymtype which is set to main if the -acronym option is not used and is set to acronym -if the acronym option is used. For example: +\acronymtype which is set to main if the +acronym option is not used and is set to acronym +if the acronym option is used. For example:
     The list of acronyms is in section~\ref{\acronymtype}.
     
    +

    +As from version 1.14, you can add a prefix to the label by +redefining \glsautoprefix. +For example: +

    +\renewcommand*{\glsautoprefix}{glo:}
    +
    +will add glo: to the automatically generated label, so +you can then, for example, refer to the list of acronyms as follows: +
    +The list of acronyms is in section~\ref{glo:\acronymtype}.
    +
    +Or, if you are undecided on a prefix: +
    +The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}.
    +
    +

    -

    style
    +
    style
    This is a key=value option. Its value should be the name of the glossary style to use. Predefined glossary styles are listed later.

    -
    nonumberlist
    +
    nonumberlist
    This option will suppress the -associated number lists in the glossaries (see also +associated number lists in the glossaries (see also Number Lists.)

    -
    counter
    +
    counter
    This is a key=value option. The value should be the name of the default counter to use in the number -lists. +lists.

    -
    sanitize
    +
    sanitize
    This is a key=value option whose value is also a key=value list. By default, the glossaries package sanitizes the values of the -name, description and symbol keys used +name, description and symbol keys used when defining a new glossary entry. This may lead to unexpected results if you try to display these values within the document text. This -sanitization can be switched off using the sanitize package +sanitization can be switched off using the sanitize package option. For example, to switch off the sanitization for the -description and name keys, but not for the -symbol key, do: +description and name keys, but not for the +symbol key, do:
     \usepackage[sanitize={name=false,description=false,%
     symbol=true}]{glossaries}
     

    -Note: this sanitization only applies to the name, -description and symbol keys. It doesn't apply -to any of the other keys (except the sort key which is +Note: this sanitization only applies to the name, +description and symbol keys. It doesn't apply +to any of the other keys (except the sort key which is always sanitized) so fragile commands contained in the value of the other keys must always be protected using \protect. -Since the value of the text key is obtained from the -name key, you will still need to protect fragile commands -in the name key if you don't use the text key. +Since the value of the text key is obtained from the +name key, you will still need to protect fragile commands +in the name key if you don't use the text key.

    -
    description
    +
    description
    This option changes the definition of -\newacronym to allow a description. See later +\newacronym to allow a description. See later for further details.

    -
    footnote
    +
    footnote
    This option changes the definition of -\newacronym and the way that acronyms are displayed. See later +\newacronym and the way that acronyms are displayed. See later for further details.

    -
    smallcaps
    +
    smallcaps
    This option changes the definition of -\newacronym and the way that acronyms are displayed. See later +\newacronym and the way that acronyms are displayed. See later for further details.

    -
    smaller
    +
    smaller
    This option changes the definition of -\newacronym and the way that acronyms are displayed. See later +\newacronym and the way that acronyms are displayed. See later for further details.

    -
    dua
    +
    dua
    This option changes the definition of -\newacronym so that acronyms are always expanded. +\newacronym so that acronyms are always expanded. See later for further details.

    -
    shortcuts
    +
    shortcuts
    This option provides shortcut commands for acronyms. See later @@ -1035,24 +1187,24 @@ Defining Glossary Entries

    All glossary entries must be defined before they are used, so it -is better to define them in the preamble to ensure this.3 However +is better to define them in the preamble to ensure this.3 However only those entries that occur in the document (using any of the commands described in Links to Glossary Entries and Adding an entry to the glossary without generating text) will appear in the glossary. Each time an entry is used in this way, a line is added to an associated glossary -(.glo) file, which then needs to be converted into a -corresponding .gls file which contains the typeset glossary -which is input by \printglossary or -\printglossaries. The Perl script makeglossaries -can be used to call makeindex, using a customised -.ist style file, for each of the glossaries that are defined +(.glo) file, which then needs to be converted into a +corresponding .gls file which contains the typeset glossary +which is input by \printglossary or +\printglossaries. The Perl script makeglossaries +can be used to call makeindex, using a customised +.ist style file, for each of the glossaries that are defined in the document. Note that there should be no need for you to explicitly edit or input any of these external files.

    The command \makeglossaries must be placed in the preamble in -order to create the customised makeindex .ist +order to create the customised makeindex .ist style file and to ensure that glossary entries are written to the appropriate output file. If you omit \makeglossaries none of the glossaries will be created. Note that if your page numbers use a @@ -1074,100 +1226,102 @@ The first argument, label, must be a unique label with which to identify this entry. The second argument, key-val list, is a key=value list that supplies the relevant information -about this entry. There are two required fields: name and -description. Available fields are listed below: +about this entry. There are two required fields: name and +description. Available fields are listed below:

    -
    name
    +
    name
    The name of the entry (as it will appear in the glossary).

    -
    description
    +
    description
    A brief description of this term (to appear in the glossary).

    -
    descriptionplural
    +
    descriptionplural
    The plural form of the -description (as passed to \glsdisplay and \glsdisplayfirst -by \glspl, \Glspl and \GLSpl). If omitted, the value -is set to the same as the description key. +description (as passed to \glsdisplay and \glsdisplayfirst +by \glspl, \Glspl and \GLSpl). If omitted, the value +is set to the same as the description key.

    -
    text
    +
    text
    How this entry will appear in the document text -when using \gls (or one of its uppercase variants). If this -field is omitted, the value of the name key is used. +when using \gls (or one of its uppercase variants). If this +field is omitted, the value of the name key is used.

    -
    first
    +
    first
    How the entry will appear in the document text -the first time it is used with \gls (or one of its uppercase -variants). If this field is omitted, the value of the text +the first time it is used with \gls (or one of its uppercase +variants). If this field is omitted, the value of the text key is used.

    -
    plural
    +
    plural
    How the entry will appear in the document text -when using \glspl (or one of its uppercase variants). +when using \glspl (or one of its uppercase variants). If this field is omitted, the value is obtained by appending -\glspluralsuffix to the value of the text field. +\glspluralsuffix to the value of the text field.

    -
    firstplural
    +
    firstplural
    How the entry will appear in the -document text the first time it is used with \glspl (or one of its +document text the first time it is used with \glspl (or one of its uppercase variants). If this field is omitted, the value is obtained -from the plural key, if the first key is omitted, -or by appending \glspluralsuffix to the value of the -first field, if the first field is present. +from the plural key, if the first key is omitted, +or by appending \glspluralsuffix to the value of the +first field, if the first field is present. + +

    Note: prior to version 1.13, the default value of -firstplural was always taken by appending "s" to the -first key, which meant that you had to specify both -plural and firstplural, even if you hadn't -used the first key. +firstplural was always taken by appending "s" to the +first key, which meant that you had to specify both +plural and firstplural, even if you hadn't +used the first key.

    -
    symbol
    +
    symbol
    This field is provided to allow the user to specify an associated symbol, but most glossary styles ignore this value. If omitted, the value is set to \relax.

    -
    symbolplural
    +
    symbolplural
    This is the plural form of the -symbol (as passed to \glsdisplay and \glsdisplayfirst -by \glspl, \Glspl and \GLSpl). If omitted, the value -is set to the same as the symbol key. +symbol (as passed to \glsdisplay and \glsdisplayfirst +by \glspl, \Glspl and \GLSpl). If omitted, the value +is set to the same as the symbol key.

    -
    sort
    -
    This value indicates how makeindex +
    sort
    +
    This value indicates how makeindex should sort this entry. If omitted, the value is given by the -name field. This value is equivalent to -makeindex's "actual" character (which is usually the +name field. This value is equivalent to +makeindex's "actual" character (which is usually the at-sign @ although the glossaries package uses a different symbol).

    -
    type
    +
    type
    This is the glossary type to which this entry belongs. If omitted, the default glossary is assumed. The list of acronyms type is given by -\acronymtype which will either be main or -acronym, depending on whether the acronym package +\acronymtype which will either be main or +acronym, depending on whether the acronym package option was used.
    @@ -1178,24 +1332,6 @@ problem for commands like \Gls and \Glspl. For examp \newglossaryentry{elite}{name={{\'e}lite}, description={select group or class}}
  46. -Similarly, commands such as \ae and \oe should either be placed -inside a group or followed by a space. For example: -
    -\newglossaryentry{oesophagus}{%
    -name={{\oe}sophagus},
    -description={canal from mouth to stomach}}
    -
    -The following is also fine: -
    -\newglossaryentry{oesophagus}{%
    -name={\oe sophagus},
    -description={canal from mouth to stomach}}
    -
    -but don't do \oe{}sophagus as it will confuse -\makefirstuc (described -later) -and will produce oeSophagus instead of -OEsophagus.

    Top @@ -1224,7 +1360,7 @@ description={a fully grown female of any bovine animal}}

    If you are writing in a language that supports -multiple plurals (for a given term) then use the plural key +multiple plurals (for a given term) then use the plural key for one of them (typically the one you are most likely to use) and for the others you will need to explicitly write the plural form using \glslink rather than using \glspl. Returning to the cow @@ -1244,7 +1380,7 @@ by appending a different letter, or sequence of letters, you can redefine \glspluralsuffix as required. However, this must be done before the entries are defined. For languages that don't form plurals by simply appending a suffix, all the plural forms must be -specified using the plural key (and the firstplural +specified using the plural key (and the firstplural key where necessary).

    @@ -1270,7 +1406,7 @@ file, and use: where filename is the name of the file containing all the \newglossaryentry commands. The optional argument type is the name of the glossary to which those entries -should belong, for those entries where the type key has +should belong, for those entries where the type key has been omitted (or, more specifically, for those entries whose type has been specified by \glsdefaulttype, which is what \newglossaryentry uses by default). For example, suppose I have @@ -1311,9 +1447,9 @@ then (supposing I have defined a new glossary type called \loadglsentries[altacronym]{myacronyms}

will add aca to the glossary type acronym, if the -package option acronym has been specified, or will add +package option acronym has been specified, or will add aca to the glossary type altacronym, if the -package option acronym is not specified. In this instance, +package option acronym is not specified. In this instance, it is better to change myacronyms.tex to:
 \newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym}
@@ -1323,7 +1459,7 @@ and now
 \loadglsentries[altacronym]{myacronyms}
 
will add aca to the glossary type altacronym, -regardless of whether or not the package option acronym is +regardless of whether or not the package option acronym is used.

@@ -1343,13 +1479,13 @@ Number lists

-Each entry in the glossary has an associated number list. +Each entry in the glossary has an associated number list. By default, these numbers refer to the pages on which that entry has been used (using any of the commands described in Links to Glossary Entries and Adding an entry to the glossary without generating text). The number list can be suppressed using -the nonumberlist package option, or an alternative counter -can be set as the default using the counter package option. +the nonumberlist package option, or an alternative counter +can be set as the default using the counter package option.

Top @@ -1363,16 +1499,16 @@ Links to Glossary Entries

Once you have defined a glossary entry using -\newglossaryentry, you can refer to that entry in the +\newglossaryentry, you can refer to that entry in the document using one of the commands listed in this section. The text which appears at that point in the document when using one of these commands is referred to as the -link text (even if there are no hyperlinks). +link text (even if there are no hyperlinks).

-The way the link text is displayed +The way the link text is displayed depends on \glstextformat{text}. -For example, to make all link text appear in a sans-serif +For example, to make all link text appear in a sans-serif font, do:

 \renewcommand*{\glstextformat}[1]{\textsf{#1}}
@@ -1393,10 +1529,10 @@ any of the following keys:
 
 

-
format
+
format
This specifies how to format the associated number for this entry in the glossary. This value is -equivalent to the makeindex encap value, and (as with +equivalent to the makeindex encap value, and (as with \index) the value needs to be the name of a command without the initial backslash. As with \index, the characters ( and ) can also be used to specify the beginning and ending of a @@ -1414,7 +1550,7 @@ and use that command.

If you are using hyperlinks and you want to change the font of the -hyperlink, don't use \hyperpage (provided by the hyperref +hyperlink, don't use \hyperpage (provided by the hyperref package) as the numbers may not refer to a page number. Instead, the glossaries package provides the following number formats: @@ -1473,19 +1609,19 @@ command called, say, \hyperbsf:

 \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}}
 
-and then use hyperbsf as the value for the format +and then use hyperbsf as the value for the format key.

-
counter
+
counter
This specifies which counter to use for the associated number for this glossary entry. (See also Number Lists.)

-
hyper
+
hyper
This is a boolean key which can be used to enable/disable the hyperlink to the relevant entry in the glossary. (Note that setting hyper=true will have no @@ -1510,12 +1646,12 @@ The command:
\gls[options]{label}[insert]

-is the same as \glslink, except that the link text -is determined from the values of the text and -first keys supplied when the entry was defined using -\newglossaryentry. If the entry has been marked as having -been used, the value of the text key will be used, otherwise -the value of the first key will be used. +is the same as \glslink, except that the link text +is determined from the values of the text and +first keys supplied when the entry was defined using +\newglossaryentry. If the entry has been marked as having +been used, the value of the text key will be used, otherwise +the value of the first key will be used. On completion, \gls will mark the entry given by label as used. @@ -1544,7 +1680,7 @@ can be changed (see

The first optional argument options is the same as the optional -argument to \glslink. As with \glslink, these commands also +argument to \glslink. As with \glslink, these commands also have a starred version that disable the hyperlink.

@@ -1560,8 +1696,8 @@ There are also analogous plural forms: \GLSpl[options]{label}[insert]

-These determine the link text from the plural and -firstplural keys supplied when the entry was first +These determine the link text from the plural and +firstplural keys supplied when the entry was first defined. As before, these commands also have a starred version that disable the hyperlink. @@ -1571,8 +1707,8 @@ The command:
\glstext[options]{label}[insert]

-is similar to \gls except that it always uses the value -of the text key and does not mark the entry as +is similar to \gls except that it always uses the value +of the text key and does not mark the entry as having been used. Unlike \gls, the inserted text insert is always appended to the link text. @@ -1595,8 +1731,8 @@ The command:
\glsfirst[options]{label}[insert]

-is similar to \glstext except that it always uses the value -of the first key. Again, insert is always appended +is similar to \glstext except that it always uses the value +of the first key. Again, insert is always appended to the end of the link text and does not mark the entry as having been used. @@ -1619,8 +1755,8 @@ The command:
\glsplural[options]{label}[insert]

-is similar to \glstext except that it always uses the value -of the plural key. Again, insert is always appended +is similar to \glstext except that it always uses the value +of the plural key. Again, insert is always appended to the end of the link text and does not mark the entry as having been used. @@ -1643,8 +1779,8 @@ The command:
\glsfirstplural[options]{label}[insert]

-is similar to \glstext except that it always uses the value -of the firstplural key. Again, insert is always +is similar to \glstext except that it always uses the value +of the firstplural key. Again, insert is always appended to the end of the link text and does not mark the entry as having been used. @@ -1667,13 +1803,13 @@ The command:
\glsname[options]{label}[insert]

-is similar to \glstext except that it always uses the value of the -name key. Again, insert is always appended to the end +is similar to \glstext except that it always uses the value of the +name key. Again, insert is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the -name key contains commands, you will have to disable the +name key contains commands, you will have to disable the sanitization -of the name key and protect fragile commands. +of the name key and protect fragile commands.

There are also analogous commands: @@ -1694,13 +1830,13 @@ The command:
\glssymbol[options]{label}[insert]

-is similar to \glstext except that it always uses the value of the -symbol key. Again, insert is always appended to the +is similar to \glstext except that it always uses the value of the +symbol key. Again, insert is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this command and the -symbol key contains commands, you will have to disable the +symbol key contains commands, you will have to disable the sanitization -of the symbol key and protect fragile commands. +of the symbol key and protect fragile commands.

There are also analogous commands: @@ -1721,14 +1857,14 @@ The command:
\glsdesc[options]{label}[insert]

-is similar to \glstext except that it always uses the value -of the description key. Again, insert is always +is similar to \glstext except that it always uses the value +of the description key. Again, insert is always appended to the end of the link text and does not mark the entry as having been used. Note: if you want to use this -command and the description key contains commands, you will +command and the description key contains commands, you will have to disable the sanitization -of the description key and protect fragile commands. +of the description key and protect fragile commands.

There are also analogous commands: @@ -1757,18 +1893,18 @@ Changing the format of the link text

-The format of the link text for \gls, \glspl +The format of the link text for \gls, \glspl and their uppercase variants is governed by two commands: \glsdisplayfirst, which is used the first time a glossary entry is used in the text and \glsdisplay, which is used subsequently. Both commands take four arguments: the first is either the singular or -plural form given by the text, plural, -first or firstplural keys (used when the term was +plural form given by the text, plural, +first or firstplural keys (used when the term was defined) depending on context; the second argument is the term's -description (as supplied by the description key); the third +description (as supplied by the description key); the third argument is the symbol associated with the term (as supplied by the -symbol key) and the fourth argument is the additional text +symbol key) and the fourth argument is the additional text supplied in the final optional argument to \gls or \glspl (or their uppercase variants). The default definitions of \glsdisplay and \glsdisplayfirst simply @@ -1777,7 +1913,7 @@ The remaining arguments are ignored.

For example, suppose you want a glossary of measurements and -units, you can use the symbol key to store the unit: +units, you can use the symbol key to store the unit:

 \newglossaryentry{distance}{name=distance,
 description={The length between two points},
@@ -1797,8 +1933,8 @@ the two points" -- but in this instance it may be better not to
 use a contraction).
 
 

-Note also that all of the link text will be formatted according -to \glstextformat (described earlier). So if you do, say: +Note also that all of the link text will be formatted according +to \glstextformat (described earlier). So if you do, say:

 \renewcommand{\glstextformat}[1]{\textbf{#1}}
 \renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)}
@@ -1817,8 +1953,8 @@ of redefining \glsdisplay and \glsdisplayfirst.
 
 

Both \defglsdisplay and \defglsdisplayfirst take two arguments: -the first (which is optional) is the glossary's label4 and the second is how the term should be +the first (which is optional) is the glossary's label4 and the second is how the term should be displayed when it is invoked using commands \gls, \glspl and their uppercase variants. This is similar to the way \glsdisplayfirst was redefined above. @@ -1844,10 +1980,10 @@ will be displayed as: "set (denoted S)" (similarly for \glspl and the uppercase variants).

-Remember that if you use the symbol key, you need to use a +Remember that if you use the symbol key, you need to use a glossary style that displays the symbol, as many of the styles ignore it. In addition, if you want either the description or symbol to appear -in the link text, you will have to disable the +in the link text, you will have to disable the sanitization of these keys and protect fragile commands.

@@ -1860,10 +1996,10 @@ Enabling and disabling hyperlinks to glossary entries

-If you load the hyperref or html packages prior to -loading the glossaries package, commands such as \glslink -and \gls, described above, will automatically have hyperlinks -to the relevant glossary entry, unless the hyper +If you load the hyperref or html packages prior to +loading the glossaries package, commands such as \glslink +and \gls, described above, will automatically have hyperlinks +to the relevant glossary entry, unless the hyper option has been set to false. You can disable or enable links using:

\glsdisablehyper @@ -1876,8 +2012,8 @@ and
respectively. The effect can be localised by placing the commands within a group. Note that you should only use \glsenablehyper -if the commands \hyperlink and \hypertarget have been -defined (for example, by the hyperref package). +if the commands \hyperlink and \hypertarget have been +defined (for example, by the hyperref package).

@@ -1894,8 +2030,8 @@ generating any text at that point in the document using:
\glsadd[options]{label}

-This is similar to \glslink, only it doesn't produce -any text (so therefore, there is no hyper key +This is similar to \glslink, only it doesn't produce +any text (so therefore, there is no hyper key available in options but all the other options that can be used with \glslink can be passed to \glsadd). For example, to add a page range to the glossary number list for the @@ -1913,7 +2049,7 @@ To add all entries that have been defined, use:

The optional argument is the same as for \glsadd, except -there is also a key types which can be +there is also a key types which can be used to specify which glossaries to use. This should be a comma separated list. For example, if you only want to add all the entries belonging to the list of acronyms (specified by @@ -1937,12 +2073,12 @@ Displaying a glossary The command \printglossaries will display all the glossaries in the order in which they were defined. Note that no glossaries will appear until -you have either used the Perl script makeglossaries -or have directly used makeindex (as described in +you have either used the Perl script makeglossaries +or have directly used makeindex (as described in Generating the Associated Glossary Files). If the glossary still does not appear after you re-LaTeX your document, check -the makeindex log files to see if there is a problem. -Remember that you also need to use the command \makeglossaries in +the makeindex log files to see if there is a problem. +Remember that you also need to use the command \makeglossaries in the preamble to enable the glossaries.

@@ -1954,7 +2090,7 @@ An individual glossary can be displayed using: where options is a key=value list of options. The following keys are available:

-
type
+
type
The value of this key specifies which glossary to print. If omitted, the default glossary is assumed. For example, to print the list of acronyms: @@ -1964,24 +2100,44 @@ glossary is assumed. For example, to print the list of acronyms:

-
title
+
title
This is the glossary's title (overriding the title specified when the glossary was defined).

-
toctitle
+
toctitle
This is the title -to use for the table of contents (if the toc package +to use for the table of contents (if the toc package option has been used). If omitted, the glossary title is used.

-
style
+
style
This specifies which glossary style to use for this glossary, overriding the effect -of the style option or \glossarystyle. +of the style package option or \glossarystyle. + +

+

+
numberedsection
+
This specifies +whether to use a numbered section for this glossary, overriding +the effect of the numberedsection package option. This +key has the same syntax as the numberedsection package +option, described earlier. + +

+

+
nonumberlist
+
Unlike the package option +of the same name, this key is a boolean key. If true (nonumberlist=true) the numberlist +is suppressed for this glossary. If false (nonumberlist=false) the numberlist is +displayed for this glossary. If no value is supplied, true is +assumed. + +

@@ -2068,10 +2224,10 @@ where name is the label to assign to this glossary. The arguments input and output files for that glossary, title is the default title for this new glossary and the final optional argument counter specifies which counter to use for the associated number -lists (see also Number Lists). The +lists (see also Number Lists). The first optional argument specifies the extension for the -makeindex transcript file (this information is only used by -makeglossaries which picks up the information from the +makeindex transcript file (this information is only used by +makeglossaries which picks up the information from the auxiliary file).

@@ -2080,15 +2236,15 @@ Note that the main (default) glossary is automatically created as: \newglossary{main}{gls}{glo}{\glossaryname}

so it can be identified by the label main. Using the -acronym package option is equivalent to: +acronym package option is equivalent to:
 \newglossary[alg]{acronym}{acr}{acn}{\acronymname}
 
so it can be identified by the label acronym. If you are -not sure whether the acronym option has been used, you +not sure whether the acronym option has been used, you can identify the list of acronyms by the command \acronymtype which is set to -acronym, if the acronym option has been used, +acronym, if the acronym option has been used, otherwise it is set to main.

Top @@ -2132,16 +2288,16 @@ firstplural={ long\glspluralsuffix\space

As mentioned in the previous section, the command \acronymtype is the name of the glossary in which the acronyms should appear. If the -acronym package option has been used, this will be +acronym package option has been used, this will be acronym, otherwise it will be main. The acronyms can then be used in exactly the same way as any other glossary entry.

-(Note: since \newacronym sets type=\acronymtype, +Note: since \newacronym sets type=\acronymtype, if you want to load a file containing acronym definitions using \loadglsentries[type]{filename}, the optional argument type will not have an effect unless you explicitly set the -type as type=\glsdefaulttype. See earlier for details.) +type as type=\glsdefaulttype. See earlier for details.

For example, the following defines the acronym IDN: @@ -2165,10 +2321,10 @@ first use and "IDN" on subsequent uses. This section describes acronyms that have been defined using \newacronym. If you prefer to define all your acronyms using \newglossaryentry explicitly, then you should skip this section -and ignore the package options: smallcaps, smaller, -description, dua, footnote and -shortcuts, as these options change the -definition of \newacronym for common acronym formats +and ignore the package options: smallcaps, smaller, +description, dua, footnote and +shortcuts, as these options change the +definition of \newacronym for common acronym formats as well as the way that the link text is displayed (see earlier). Likewise you should ignore the new commands described in this section, @@ -2177,18 +2333,33 @@ such as \acrshort, as they vary according to the definition of

Table 2 lists the package options and how the -\newglossaryentry keys are used to store long (the long -form) and abbrv (the short form). Note that the -smallcaps option redefines \acronymfont so that it sets -its argument using \textsc (so you should use lower case characters -in abbrv) and the smaller option redefines -\acronymfont to use \smaller5, otherwise \acronymfont simply -displays its argument in the surrounding font. Note also that if none -of the package options smallcaps, smaller, -dua, description or footnote are used, -\acronymfont is not used, so changing the definition of -\acronymfont will have no effect under such circumstances. +\newglossaryentry keys are used to store long (the long +form) and abbrv (the short form). Note that the +smallcaps option redefines +\acronymfont so that it sets its +argument using \textsc (so you should use lower case characters in +abbrv) and the smaller option redefines +\acronymfont to use \smaller,5 otherwise \acronymfont simply displays its argument +in the surrounding font. Note also that if none of the package options +smallcaps, smaller, dua, +description or footnote are used, \acronymfont is +not used, so changing the definition of \acronymfont will have no +effect under such circumstances. + +

+If you want to display the acronym in another font, for example, +emphasized, then use the smaller package option and +redefine \acronymfont to use the required font. For example: +

+\usepackage[smaller]{glossaries}
+\renewcommand*{\acronymfont}[1]{\emph{#1}}
+
+Where \acronymfont is available, +\firstacronymfont is also +available. By default, this simply uses \acronymfont, but it +can be redefined to change the way the acronym is displayed on +first use.


@@ -2196,54 +2367,54 @@ of the package options smallcaps, smaller
- +
Table 1: Customised Text
Translator key word What it's for  
 \glossaryname
 \glossaryname Glossary Title of the main glossary.  
 \acronymname
 \acronymname Acronyms Title of the list of acronyms -(when used with package option acronym).  
 \entryname
 \entryname Notation (glossaries) Header for first column in glossary (for 2, 3 or 4 column glossaries that support headers).  
 \descriptionname
 \descriptionname Description (glossaries) Header for second column in glossary (for 2, 3 or 4 column glossaries that support headers).  
 \symbolname
 \symbolname Symbol (glossaries) Header for symbol column in glossary for glossary styles that support this option.  
 \pagelistname
 \pagelistname Page List (glossaries) Header for page list column in glossary for glossaries that support this option.  
 \glssymbolsgroupname
 \glssymbolsgroupname Symbols (glossaries) Header for symbols section of the glossary for glossary styles that support this option.  
 \glsnumbersgroupname
 \glsnumbersgroupname Numbers (glossaries) Header for numbers section of the glossary for glossary styles that support @@ -256,13 +266,13 @@ this option.
- - - - + + + + - + - + - + - + - + - + - + @@ -2289,20 +2460,20 @@ If the first use uses the plural form, \glspl{dm} will display: diagonal matrices (DMs).

-Each of the package options smallcaps, smaller, -footnote, dua -and description use \defglsdisplay and -\defglsdisplayfirst (described earlier) +Each of the package options smallcaps, smaller, +footnote, dua +and description use \defglsdisplay and +\defglsdisplayfirst (described earlier) to change the way the link text is displayed.

-
description,footnote
+
description,footnote
When these two package options are used together, the first use displays the entry as:
-
\acronymfont{abbrv}insert\footnote{long} +
\firstacronymfont{abbrv}insert\footnote{long}

while subsequent use displays the entry as: @@ -2317,34 +2488,34 @@ variants.

Note also that when these two package options are used (in the given order), the glossaries package additionally implements the -sanitize option using -sanitize={description=false,symbol=false}, so +sanitize option using +sanitize={description=false,symbol=false}, so remember to protect fragile commands when defining acronyms.

-
dua
+
dua
-The dua package option always displays the expanded -form and so may not be used with footnote, smaller or -smallcaps. Both first use and subsequent use displays the +The dua package option always displays the expanded +form and so may not be used with footnote, smaller or +smallcaps. Both first use and subsequent use displays the entry in the form:

longinsert

-If the description package option is also used, the -name key is set to the long form, otherwise the -name key is set to the short form and the -description key is set to the long form. +If the description package option is also used, the +name key is set to the long form, otherwise the +name key is set to the short form and the +description key is set to the long form.

-
description
+
description
This package option displays the entry on first use as:
-
longinsert (\acronymfont{abbrv}) +
longinsert (\firstacronymfont{abbrv})

while subsequent use displays the entry as: @@ -2354,16 +2525,16 @@ while subsequent use displays the entry as:
Note also that if this package option is used, the glossaries package additionally implements the option -sanitize={symbol=false}, so +sanitize={symbol=false}, so remember to protect fragile commands when defining acronyms.

-
footnote
+
footnote
This package option displays the entry on first use as:
-
\acronymfont{abbrv}insert\footnote{long} +
\firstacronymfont{abbrv}insert\footnote{long}

while subsequent use displays the entry as: @@ -2373,17 +2544,17 @@ while subsequent use displays the entry as:

Note also that if this package option is used, the glossaries package additionally implements the option -sanitize={description=false}, so +sanitize={description=false}, so remember to protect fragile commands when defining acronyms.

-
smallcaps
+
smallcaps
-If neither the footnote nor description options +If neither the footnote nor description options have been set, this option displays the entry on first use as:
-
longinsert (\acronymfont{abbrv}) +
longinsert (\firstacronymfont{abbrv})

while subsequent use displays the entry as: @@ -2397,17 +2568,17 @@ should be specified in lower case.

Note also that if this package option is used, the glossaries package additionally implements the option -sanitize={symbol=false}, so +sanitize={symbol=false}, so remember to protect fragile commands when defining acronyms.

-
smaller
+
smaller
-If neither the footnote nor description options +If neither the footnote nor description options have been set, this option displays the entry on first use as:
-
longinsert (\acronymfont{abbrv}) +
longinsert (\firstacronymfont{abbrv})

while subsequent use displays the entry as: @@ -2417,18 +2588,22 @@ while subsequent use displays the entry as:
where \acronymfont is set to {\smaller #1}. +

+Remember to load a package that defines \smaller (such as +relsize) if you want to use this option. +

Note also that if this package option is used, the glossaries package additionally implements the option -sanitize={symbol=false}, so +sanitize={symbol=false}, so remember to protect fragile commands when defining acronyms.

None of the above
-If none of the package options smallcaps, smaller, -footnote, dua or description are used, +If none of the package options smallcaps, smaller, +footnote, dua or description are used, then on first use the entry is displayed as:

long (abbrv)insert @@ -2436,8 +2611,6 @@ then on first use the entry is displayed as:
while subsequent use displays the entry as:
-
\acronymfont{abbrv}insert -

abbrvinsert
@@ -2445,7 +2618,7 @@ while subsequent use displays the entry as:

Recall from earlier that you can access the values of individual keys using commands -like \glstext, so it is possible to use these commands to +like \glstext, so it is possible to use these commands to print just the long form or just the abbreviation without affecting the flag that determines whether the entry has been used. However the keys that store the long and short form vary depending on @@ -2465,8 +2638,8 @@ as follows:
Print the abbreviated version with a hyperlink (if necessary) to the relevant entry in the glossary. This is usually equivalent to -\glstext (or its uppercase variants) but may additionally -put the link text within the argument to \acronymfont. +\glstext (or its uppercase variants) but may additionally +put the link text within the argument to \acronymfont.

@@ -2480,7 +2653,7 @@ put the link text within the argument to \acronymfont Print the long version with a hyperlink (if necessary) to the relevant entry in the glossary. This is may be equivalent to -\glsdesc, \glssymbol or \glsfirst (or their uppercase +\glsdesc, \glssymbol or \glsfirst (or their uppercase variants), depending on package options.

@@ -2498,16 +2671,16 @@ with a hyperlink (if necessary) to the relevant entry in the glossary.

-Note that if you change the definition of \newacronym, you +Note that if you change the definition of \newacronym, you may additionally need to change the above commands as well as -the changing way the text is displayed using \defglsdisplay -and \defglsdisplayfirst. +the changing way the text is displayed using \defglsdisplay +and \defglsdisplayfirst.

-The package option shortcuts provides the synonyms listed +The package option shortcuts provides the synonyms listed in table 3. If any of those commands generate an "undefined control sequence" error message, check that you -have enabled the shortcuts using the shortcuts package +have enabled the shortcuts using the shortcuts package option. Note that there are no shortcuts for the commands that produce all upper case text. @@ -2517,60 +2690,60 @@ produce all upper case text.

- +
Table 2: Package options governing \newacronym and how the information is stored in the keys for \newglossaryentry
Package Option first keytext keydescription keysymbol keyfirst keytext keydescription keysymbol key
description,footnote
description,footnote abbrv abbrv user supplied long
description,dua
description,dua long long user supplied abbrv
description
description long abbrv user supplied abbrv
footnote
footnote abbrv abbrv long  
smallcaps
smallcaps long abbrv long abbrv
smaller
smaller long abbrv long abbrv
dua
dua long long long
+Synonyms provided by the package option shortcuts - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
Table 3: -Synonyms provided by the package option shortcuts
Shortcut Command Equivalent Command
\acs\acrshort
\acs\acrshort
\Acs\Acrshort
\Acs\Acrshort
\acsp\acrshortpl
\acsp\acrshortpl
\Acsp\Acrshortpl
\Acsp\Acrshortpl
\acl\acrlong
\acl\acrlong
\Acl\Acrlong
\Acl\Acrlong
\aclp\acrlongpl
\aclp\acrlongpl
\Aclp\Acrlongpl
\Aclp\Acrlongpl
\acf\acrfull
\acf\acrfull
\Acf\Acrfull
\Acf\Acrfull
\acfp\acrfullpl
\acfp\acrfullpl
\Acfp\Acrfullpl
\Acfp\Acrfullpl
\ac\gls
\ac\gls
\Ac\Gls
\Ac\Gls
\acp\glspl
\acp\glspl
\Acp\Glspl
\Acp\Glspl
@@ -2589,11 +2762,11 @@ Unsetting and resetting entry flags

-When using \gls, \glspl and their uppercase variants it is +When using \gls, \glspl and their uppercase variants it is possible that you may want to use the value given by the -first key, even though you have already used the glossary +first key, even though you have already used the glossary entry. Conversely, you may want to use the value given by the -text key, even though you haven't used the glossary entry. +text key, even though you haven't used the glossary entry. The former can be achieved by one of the following commands:

\glsreset{label} @@ -2630,7 +2803,7 @@ The glossaries package comes with some pre-defined glossary styles. These are as follows:

list
-
The list style uses the description +
The list style uses the description environment. The entry name is placed in the optional argument of the \item command (so it will appear in bold by default). The description follows, and then the associated number @@ -2639,34 +2812,51 @@ list for that entry. Sub groups are separated using \indexspace.

listgroup
-
The listgroup style is like -list but the glossary groups have headings. +
The listgroup style is like +list but the glossary groups have headings.

listhypergroup
-
The listhypergroup style is like -listgroup but has a set of links to the glossary -groups. +
The listhypergroup style is like +listgroup but has a set of links to the glossary +groups. The start of the glossary has a navigation panel to +each group that is present in the glossary. This requires an +additional run through LaTeX to ensure the group information +is up-to-date. In the navigation panel, each group is separated +by \glshypernavsep which +defaults to a vertical bar with a space on either side. For example, +to simply have a space separating each group, do: +
+\renewcommand*{\glshypernavsep}{\space}
+
+ +

+Note that the hyper-navigation panel is now (as from version 1.14) +set inside the optional argument to \item instead of after it +to prevent a spurious space at the start. This can be changed +by redefining \glossaryheader, but note that this needs to +be done after the glossary style has been set.

altlist
-
The altlist style is like list +
The altlist style is like list but the description is placed on the following line.

altlistgroup
-
The altlistgroup style is like -altlist but the glossary groups have headings. +
The altlistgroup style is like +altlist but the glossary groups have headings.

altlisthypergroup
-
The altlisthypergroup style is like -altlistgroup but has a set of links to the glossary -groups. +
The altlisthypergroup style is like +altlistgroup but has a set of links to the glossary +groups. The navigation panel is the same as that for +listhypergroup, described above.

@@ -2674,174 +2864,174 @@ groups.
This style uses the description environment. Each entry starts with \item[], followed by the name followed by a dotted line, followed by the description. Note that -this style ignores both the number list and the symbol. The +this style ignores both the number list and the symbol. The length \glslistdottedwidth -governs where the description should start.6 +governs where the description should start.6

long
-
The long style uses the longtable -environment (defined by the longtable package). It has two +
The long style uses the longtable +environment (defined by the longtable package). It has two columns: the first column contains the entry's name and the second -column contains the description followed by the number list. +column contains the description followed by the number list. Sub groups are separated with a blank row.

longborder
-
The longborder style is like -long but has horizontal and vertical lines around it. +
The longborder style is like +long but has horizontal and vertical lines around it.

longheader
-
The longheader style is like -long but has a header row. +
The longheader style is like +long but has a header row.

longheaderborder
-
The longheaderborder style is -like longheader but has horizontal and vertical lines +
The longheaderborder style is +like longheader but has horizontal and vertical lines around it.

long3col
-
The long3col style is like -long but has three columns. The first column contains +
The long3col style is like +long but has three columns. The first column contains the entry's name, the second column contains the description -and the third column contains the number list. +and the third column contains the number list.

long3colborder
-
The long3colborder style is like -the long3col style but has horizontal and vertical +
The long3colborder style is like +the long3col style but has horizontal and vertical lines around it.

long3colheader
-
The long3colheader style is like -long3col but has a header row. +
The long3colheader style is like +long3col but has a header row.

long3colheaderborder
-
The long3colheaderborder style is -like long3colheader but has horizontal and vertical lines +
The long3colheaderborder style is +like long3colheader but has horizontal and vertical lines around it.

long4col
-
The long4col style is like -long3col but has an additional column in which the +
The long4col style is like +long3col but has an additional column in which the entry's associated symbol appears.

long4colborder
-
The long4colborder style is like -the long4col style but has horizontal and vertical +
The long4colborder style is like +the long4col style but has horizontal and vertical lines around it.

long4colheader
-
The long4colheader style is like -long4col but has a header row. +
The long4colheader style is like +long4col but has a header row.

long4colheaderborder
-
The long4colheaderborder style is -like long4colheader but has horizontal and vertical lines +
The long4colheaderborder style is +like long4colheader but has horizontal and vertical lines around it.

super
-
The super style uses the supertabular -environment (defined by the supertabular package). It has two +
The super style uses the supertabular +environment (defined by the supertabular package). It has two columns: the first column contains the entry's name and the second -column contains the description followed by the number list. +column contains the description followed by the number list. Sub groups are separated with a blank row.

superborder
-
The superborder style is like -super but has horizontal and vertical lines around it. +
The superborder style is like +super but has horizontal and vertical lines around it.

superheader
-
The superheader style is like -super but has a header row. +
The superheader style is like +super but has a header row.

superheaderborder
-
The superheaderborder style is -like superheader but has horizontal and vertical lines +
The superheaderborder style is +like superheader but has horizontal and vertical lines around it.

super3col
-
The super3col style is like -super but has three columns. The first column contains +
The super3col style is like +super but has three columns. The first column contains the entry's name, the second column contains the description -and the third column contains the . +and the third column contains the .

super3colborder
-
The super3colborder style is like -the super3col style but has horizontal and vertical +
The super3colborder style is like +the super3col style but has horizontal and vertical lines around it.

super3colheader
-
The super3colheader style is like -super3col but has a header row. +
The super3colheader style is like +super3col but has a header row.

super3colheaderborder
-
The super3colheaderborder style -is like super3colheader but has horizontal and vertical +
The super3colheaderborder style +is like super3colheader but has horizontal and vertical lines around it.

super4col
-
The super4col style is like -super3col but has an additional column in which the +
The super4col style is like +super3col but has an additional column in which the entry's associated symbol appears.

super4colborder
-
The super4colborder style is like -the super4col style but has horizontal and vertical +
The super4colborder style is like +the super4col style but has horizontal and vertical lines around it.

super4colheader
-
The super4colheader style is like -super4col but has a header row. +
The super4colheader style is like +super4col but has a header row.

super4colheaderborder
-
The super4colheaderborder style -is like super4colheader but has horizontal and vertical +
The super4colheaderborder style +is like super4colheader but has horizontal and vertical lines around it.

@@ -2849,16 +3039,39 @@ lines around it.

-The glossary style can be set using the style package option -or using the style key in the optional -argument to \printglossary or using the command: +The glossary style can be set using the style package option +or using the style key in the optional +argument to \printglossary or using the command:

\glossarystyle{style-name}

+

+Note that if you use the style key in the +optional argument to \printglossary, it will override any +previous style settings for the given glossary, so if, for example, +you do: +

+\renewcommand*{\glsgroupskip}{}
+\printglossary[style=long]
+
+The new definition of \glsgroupskip will not have an affect +for this glossary, as \glsgroupskip is redefined by +style=long. Likewise, \glossarystyle will also +override any previous style definitions, so, again: +
+\renewcommand*{\glsgroupskip}{}
+\glossarystyle{long}
+
+will reset \glsgroupskip back to its default definition for the +named glossary style ("long" in this case). If you want to +modify the styles, either use \newglossarystyle (described +in the next section) or make the modifications after +\glossarystyle. +

All the styles except for the three- and four-column styles and the -listdotted style use the command +listdotted style use the command \glspostdescription after the description. This simply displays a full stop by default. To eliminate this full stop (or replace it with something else, say a comma) you @@ -2894,7 +3107,7 @@ This environment defines how the main body of the glossary should be typeset. Note that this does not include the section heading, the glossary preamble (defined by \glossarypreamble) or the glossary postamble (defined by \glossarypostamble.) For example, -the list style uses the description environment, +the list style uses the description environment, so the theglossary environment is simply redefined to begin and end the description environment. @@ -2907,8 +3120,8 @@ and end the description environment. This macro indicates what to do at the start of the main body of the glossary. Note that this is not the same as \glossarypreamble, which should not be affected by changes in -the glossary style. The list glossary style redefines -\glossaryheader to do nothing, whereas the longheader +the glossary style. The list glossary style redefines +\glossaryheader to do nothing, whereas the longheader glossary style redefines \glossaryheader to do a header row.

@@ -2920,14 +3133,14 @@ glossary style redefines \glossaryheader to do a header row. This macro indicates what to do at the start of each logical block within the main body of the glossary. The glossary is sub-divided into twenty-eight logical blocks that are determined by the first character -of the sort key (or name key if the sort +of the sort key (or name key if the sort key is omitted). The sub-divisions are in the following order: symbols, numbers, A, ..., Z. Note that the argument to \glsgroupheading is a label not the group title. The group title can be obtained via \glsgetgrouptitle{label}, and a navigation hypertarget can be created using \glsnavhypertarget{label}. Most of the predefined glossary styles redefine \glsgroupheading to simply -ignore its argument. The listhypergroup style redefines +ignore its argument. The listhypergroup style redefines \glsgroupheading as follows:

 \renewcommand*{\glsgroupheading}[1]{%
@@ -2943,7 +3156,7 @@ See also \glsgroupskip below. (Note that command definitions withi
 \glsgroupskip
 

This macro determines what to do after one logical group but before -the header for the next logical group. The list glossary +the header for the next logical group. The list glossary style simply redefines \glsgroupskip to be \indexspace.

@@ -2961,15 +3174,15 @@ font for the entry name, regardless of the glossary style used. Note that label is the label used when the glossary entry was defined via either \newglossaryentry or \newacronym. Each time you use a glossary entry it creates a -link7 +link7 using \@glslink{label}{text} with the label glo:label. Your new glossary style must therefore redefine \glossaryentryfield so that it uses \@glstarget{glo:label}{text} -to ensure the hyperlinks function correctly.8 For example, the -list style defines \glossaryentryfield as follows: +to ensure the hyperlinks function correctly.8 For example, the +list style defines \glossaryentryfield as follows:

 \renewcommand*{\glossaryentryfield}[5]{%
 \item[\@glstarget{glo:##1}{##2}] ##3\glspostdescription\space ##5}
@@ -2988,15 +3201,15 @@ may contain \delimN (to delimit individual numbers) and/or
 multiple occurrences of 
 \setentrycounter{counter name}\glsnumberformat{number(s)}, but note
 that the entire number list is enclosed within the argument
-to \glossaryentrynumbers. The user can redefine this to change
+to \glossaryentrynumbers. The user can redefine this to change
 the way the entire number list is formatted, regardless of 
 the glossary style. However the most common use of
 \glossaryentrynumbers is to provide a means of suppressing the
-number list altogether. (In fact, the nonumberlist option 
+number list altogether. (In fact, the nonumberlist option 
 redefines \glossaryentrynumbers to ignore its argument.)
 Therefore, when you define a new glossary style, you don't need
 to worry about whether the user has specified the 
-nonumberlist package option.
+nonumberlist package option.
 
 
 

@@ -3025,7 +3238,7 @@ should do nothing) and suppose you don't want anything to appear immediately after \begin{theglossary} (so \glossaryheader should do nothing). In addition, let's suppose the symbol should appear in brackets after the name, followed by the description and -last of all the number list should appear within square brackets +last of all the number list should appear within square brackets at the end. Then you can create this new glossary style, called, say, mylist, as follows:

@@ -3063,7 +3276,7 @@ If you want to define a new style that is a slightly modified
 version of an existing style, you can use \glossarystyle
 within the second argument of \newglossarystyle followed by
 whatever alterations you require. For example, suppose you want 
-a style like the list style but you don't want the extra
+a style like the list style but you don't want the extra
 vertical space created by \indexspace between groups, then you
 can create a new glossary style called, say, mylist as
 follows:
@@ -3087,7 +3300,7 @@ Mfirstuc Package
 
 

The glossaries package is supplied with the package -mfirstuc which provides the command: +mfirstuc which provides the command:

\makefirstuc{stuff} @@ -3095,7 +3308,7 @@ The glossaries package is supplied with the package
which makes the first object of stuff uppercase unless stuff starts with a control -sequence followed by a group, in which case the first +sequence followed by a non-empty group, in which case the first object in the group is converted to uppercase. Examples:

    @@ -3104,7 +3317,7 @@ object in the group is converted to uppercase. Examples:

  • \makefirstuc{\emph{abc}} produces Abc -(\MakeUppercase has been applied to the letter "a" rather +(\MakeUppercase has been applied to the letter "a" rather than \emph.)

    @@ -3122,9 +3335,11 @@ than \emph.)

-Note however that \makefirstuc{\ae{}bc} produces æBc since -the empty group following \ae is considered to be the argument -of \ae which is in fact not the case. +In version 1.02 of mfirstuc, a bug fix resulted in a change +in output if the first object is a control sequence followed by +an empty group. Prior to version 1.02, \makefirstuc{\ae{}bc} +produced æBc. However as from version 1.02, it now produces +Æbc.

Note also that @@ -3152,6 +3367,18 @@ This is equivalent to \expandafter\makefirstuc\expandafter{ produces: Abc. +

+If you want to use an alternative command to convert to uppercase, +for example \MakeTextUppercase9, you can redefine the internal +command \@gls@makefirstuc. For example: +

+\renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1}
+
+(Remember that command names that contain the @ character must +either be placed in packages or be placed between \makeatletter +\makeatother.) +

@@ -3166,790 +3393,841 @@ produces: Abc. Index

\Ac -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Acf -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Acfp -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Acl -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Aclp -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Acp -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Acrfull -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Acrfullpl -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Acrlong -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Acrlongpl -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\acronymfont -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\acronymname -
Multi-Lingual Support +
Multi-Lingual Support
\acronymtype -
A Quick Guide For - | Package Options - | Defining Glossary Entries +
A Quick Guide For + | Package Options + | Defining Glossary Entries
\Acrshort -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Acrshortpl -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Acs -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\Acsp -
Acronyms - | Acronyms +
Acronyms + | Acronyms
babel -
Multi-Lingual Support - | Multi-Lingual Support - | Multi-Lingual Support - | Multi-Lingual Support +
Multi-Lingual Support + | Multi-Lingual Support + | Multi-Lingual Support + | Multi-Lingual Support + | Troubleshooting
\defglsdisplay -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\defglsdisplayfirst -
Acronyms - | Acronyms +
Acronyms + | Acronyms
\descriptionname -
Multi-Lingual Support +
Multi-Lingual Support
\emph -
A Quick Guide For +
A Quick Guide For
\entryname -
Multi-Lingual Support +
Multi-Lingual Support
file types
.alg -
Generating the associated glossary +
Generating the associated glossary
.glg -
Generating the associated glossary - | A Quick Guide For +
Generating the associated glossary + | A Quick Guide For
.glo -
Defining Glossary Entries +
Defining Glossary Entries
.gls -
Defining Glossary Entries +
Defining Glossary Entries
.ist -
Generating the associated glossary - | Defining Glossary Entries - | Defining Glossary Entries +
Generating the associated glossary + | Defining Glossary Entries + | Defining Glossary Entries
.nlg -
A Quick Guide For +
A Quick Guide For
german -
Multi-Lingual Support +
Multi-Lingual Support
glossary -
Introduction +
Introduction + | Troubleshooting
glossary styles
altlist -
Glossary Styles - | Glossary Styles +
Glossary Styles + | Glossary Styles
altlistgroup -
Glossary Styles - | Glossary Styles +
Glossary Styles + | Glossary Styles
altlisthypergroup -
Glossary Styles +
Glossary Styles
list -
Glossary Styles - | Glossary Styles - | Glossary Styles - | Defining your own glossary - | Defining your own glossary - | Defining your own glossary - | Defining your own glossary - | Example: creating a new +
Glossary Styles + | Glossary Styles + | Glossary Styles + | Defining your own glossary + | Defining your own glossary + | Defining your own glossary + | Defining your own glossary + | Example: creating a new
listdotted -
Glossary Styles +
Glossary Styles
listgroup -
Glossary Styles - | Glossary Styles +
Glossary Styles + | Glossary Styles
listhypergroup -
Glossary Styles - | Defining your own glossary +
Glossary Styles + | Glossary Styles + | Defining your own glossary
long -
Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
Glossary Styles + | Glossary Styles + | Glossary Styles + | Glossary Styles
long3col -
Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
Glossary Styles + | Glossary Styles + | Glossary Styles + | Glossary Styles
long3colborder -
Glossary Styles +
Glossary Styles
long3colheader -
Glossary Styles - | Glossary Styles +
Glossary Styles + | Glossary Styles
long3colheaderborder -
Glossary Styles +
Glossary Styles
long4col -
A Quick Guide For - | Glossary Styles - | Glossary Styles - | Glossary Styles +
A Quick Guide For + | Glossary Styles + | Glossary Styles + | Glossary Styles
long4colborder -
A Quick Guide For - | Glossary Styles +
A Quick Guide For + | Glossary Styles
long4colheader -
A Quick Guide For - | Glossary Styles - | Glossary Styles +
A Quick Guide For + | Glossary Styles + | Glossary Styles
long4colheaderborder -
A Quick Guide For - | Glossary Styles +
A Quick Guide For + | Glossary Styles
longborder -
Glossary Styles +
Glossary Styles
longheader -
Glossary Styles - | Glossary Styles - | Defining your own glossary +
Glossary Styles + | Glossary Styles + | Defining your own glossary
longheaderborder -
Glossary Styles +
Glossary Styles
super -
Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
Glossary Styles + | Glossary Styles + | Glossary Styles + | Glossary Styles
super3col -
Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles +
Glossary Styles + | Glossary Styles + | Glossary Styles + | Glossary Styles
super3colborder -
Glossary Styles +
Glossary Styles
super3colheader -
Glossary Styles - | Glossary Styles +
Glossary Styles + | Glossary Styles
super3colheaderborder -
Glossary Styles +
Glossary Styles
super4col -
A Quick Guide For - | Glossary Styles - | Glossary Styles - | Glossary Styles +
A Quick Guide For + | Glossary Styles + | Glossary Styles + | Glossary Styles
super4colborder -
A Quick Guide For - | Glossary Styles +
A Quick Guide For + | Glossary Styles
super4colheader -
A Quick Guide For - | Glossary Styles - | Glossary Styles +
A Quick Guide For + | Glossary Styles + | Glossary Styles
super4colheaderborder -
A Quick Guide For - | Glossary Styles +
A Quick Guide For + | Glossary Styles
superborder -
Glossary Styles +
Glossary Styles
superheader -
Glossary Styles - | Glossary Styles +
Glossary Styles + | Glossary Styles
superheaderborder -
Glossary Styles +
Glossary Styles
glossary-list -
A Quick Guide For +
A Quick Guide For
\glossaryentrynumbers -
Defining your own glossary +
Defining your own glossary +
\glossaryheader +
Glossary Styles
\glossaryname -
Multi-Lingual Support +
Multi-Lingual Support
\glossarystyle -
A Quick Guide For - | Displaying a glossary +
A Quick Guide For + | Displaying a glossary + | Glossary Styles + | Glossary Styles
\gls -
A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Enabling and disabling hyperlinks - | Acronyms - | Acronyms - | Unsetting and resetting entry +
Troubleshooting + | Troubleshooting + | Troubleshooting + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Enabling and disabling hyperlinks + | Acronyms + | Acronyms + | Unsetting and resetting entry
\glsadd -
A Quick Guide For - | A Quick Guide For +
Troubleshooting + | A Quick Guide For + | A Quick Guide For
\glsaddall -
A Quick Guide For - | A Quick Guide For +
Troubleshooting + | A Quick Guide For + | A Quick Guide For
\glsaddall keys
types -
Adding an entry to +
Adding an entry to
\glscompositor -
A Quick Guide For +
A Quick Guide For
\glsdesc -
Acronyms +
Acronyms
\glsdisplay -
Defining Glossary Entries - | Defining Glossary Entries +
Defining Glossary Entries + | Defining Glossary Entries
\glsdisplayfirst -
Defining Glossary Entries - | Defining Glossary Entries +
Defining Glossary Entries + | Defining Glossary Entries
\glsfirst -
Acronyms +
Acronyms +
\glsgroupskip +
Glossary Styles
\glslink -
A Quick Guide For - | A Quick Guide For - | Links to Glossary Entries - | Enabling and disabling hyperlinks - | Adding an entry to +
Troubleshooting + | A Quick Guide For + | A Quick Guide For + | Links to Glossary Entries + | Enabling and disabling hyperlinks + | Adding an entry to
\glslink keys
counter -
Links to Glossary Entries +
Links to Glossary Entries
format -
A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Links to Glossary Entries +
A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Links to Glossary Entries
hyper -
Links to Glossary Entries - | Enabling and disabling hyperlinks - | Adding an entry to +
Links to Glossary Entries + | Enabling and disabling hyperlinks + | Adding an entry to
\glsnamefont -
A Quick Guide For - | A Quick Guide For +
A Quick Guide For + | A Quick Guide For
\glsnumbersgroupname -
Multi-Lingual Support +
Multi-Lingual Support
\glspl -
A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Changing the format of - | Acronyms - | Acronyms - | Unsetting and resetting entry +
Troubleshooting + | Troubleshooting + | Troubleshooting + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Changing the format of + | Acronyms + | Acronyms + | Unsetting and resetting entry
\glspluralsuffix -
Defining Glossary Entries - | Defining Glossary Entries +
Defining Glossary Entries + | Defining Glossary Entries
\glssymbol -
Acronyms +
Acronyms
\glssymbolsgroupname -
Multi-Lingual Support +
Multi-Lingual Support
\glstext -
Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Acronyms - | Acronyms +
Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Acronyms + | Acronyms
\glstextformat -
Changing the format of +
Changing the format of
html -
A Quick Guide For - | Enabling and disabling hyperlinks +
A Quick Guide For + | Enabling and disabling hyperlinks
\hyperemph -
A Quick Guide For +
A Quick Guide For
\hyperlink -
Enabling and disabling hyperlinks +
Enabling and disabling hyperlinks
hyperref -
A Quick Guide For - | Links to Glossary Entries - | Enabling and disabling hyperlinks - | Enabling and disabling hyperlinks +
A Quick Guide For + | Links to Glossary Entries + | Enabling and disabling hyperlinks + | Enabling and disabling hyperlinks
\hypertarget -
Enabling and disabling hyperlinks +
Enabling and disabling hyperlinks
\item -
A Quick Guide For +
A Quick Guide For
link text -
Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Changing the format of - | Changing the format of +
Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Changing the format of + | Changing the format of
longtable -
Glossary Styles -
\makefirstuc -
Defining Glossary Entries +
Glossary Styles
makeglossaries -
Generating the associated glossary - | Generating the associated glossary - | Generating the associated glossary - | Generating the associated glossary - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Defining Glossary Entries - | Displaying a glossary - | Displaying a glossary - | Defining New Glossaries +
Generating the associated glossary + | Generating the associated glossary + | Generating the associated glossary + | Generating the associated glossary + | Troubleshooting + | Troubleshooting + | Troubleshooting + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Defining Glossary Entries + | Displaying a glossary + | Displaying a glossary + | Defining New Glossaries
makeindex -
Generating the associated glossary - | Generating the associated glossary - | Generating the associated glossary - | Generating the associated glossary - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Displaying a glossary - | Displaying a glossary - | Defining New Glossaries +
Generating the associated glossary + | Generating the associated glossary + | Generating the associated glossary + | Generating the associated glossary + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Displaying a glossary + | Displaying a glossary + | Defining New Glossaries
\MakeUppercase -
Mfirstuc Package +
Mfirstuc Package
mfirstuc -
Mfirstuc Package +
Mfirstuc Package
\newacronym -
A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Acronyms - | Acronyms +
A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Acronyms + | Acronyms
\newglossary -
A Quick Guide For +
A Quick Guide For
\newglossaryentry -
A Quick Guide For - | A Quick Guide For - | Links to Glossary Entries - | Links to Glossary Entries - | Acronyms +
A Quick Guide For + | A Quick Guide For + | Links to Glossary Entries + | Links to Glossary Entries + | Acronyms
\newglossaryentry keys
description -
A Quick Guide For - | Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Acronyms - | Acronyms +
A Quick Guide For + | Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Acronyms + | Acronyms
descriptionplural -
Defining Glossary Entries +
Defining Glossary Entries
first -
Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Acronyms - | Unsetting and resetting entry +
Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Acronyms + | Unsetting and resetting entry
firstplural -
Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Plurals - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of +
Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Plurals + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of
format -
Links to Glossary Entries +
Links to Glossary Entries
name -
A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Acronyms - | Acronyms - | Defining your own glossary +
A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Acronyms + | Acronyms + | Defining your own glossary
plural -
A Quick Guide For - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Plurals - | Plurals - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of +
A Quick Guide For + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Plurals + | Plurals + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of
sort -
A Quick Guide For - | Package Options - | Defining Glossary Entries - | Defining your own glossary - | Defining your own glossary +
A Quick Guide For + | Package Options + | Defining Glossary Entries + | Defining your own glossary + | Defining your own glossary
symbol -
Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Changing the format of - | Changing the format of - | Acronyms +
Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Changing the format of + | Changing the format of + | Acronyms
symbolplural -
Defining Glossary Entries +
Defining Glossary Entries
text -
Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Defining Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Links to Glossary Entries - | Changing the format of - | Acronyms - | Unsetting and resetting entry +
Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Defining Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Links to Glossary Entries + | Changing the format of + | Acronyms + | Unsetting and resetting entry
type -
A Quick Guide For - | A Quick Guide For - | Defining Glossary Entries - | Loading Entries From a +
A Quick Guide For + | A Quick Guide For + | Defining Glossary Entries + | Loading Entries From a
+
\newglossarystyle +
Glossary Styles
ngerman -
Multi-Lingual Support +
Multi-Lingual Support
number list -
Package Options - | Package Options - | Number lists - | Defining New Glossaries - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Glossary Styles - | Example: creating a completely +
Package Options + | Package Options + | Number lists + | Defining New Glossaries + | Glossary Styles + | Glossary Styles + | Glossary Styles + | Glossary Styles + | Glossary Styles + | Example: creating a completely
package options
acronym -
Multi-Lingual Support - | Multi-Lingual Support - | Generating the associated glossary - | Generating the associated glossary - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Defining Glossary Entries - | Defining Glossary Entries - | Loading Entries From a - | Loading Entries From a - | Loading Entries From a - | Loading Entries From a - | Loading Entries From a - | Loading Entries From a - | Defining New Glossaries - | Defining New Glossaries - | Defining New Glossaries - | Defining New Glossaries - | Defining New Glossaries - | Defining New Glossaries - | Acronyms - | Acronyms +
Multi-Lingual Support + | Multi-Lingual Support + | Generating the associated glossary + | Generating the associated glossary + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Defining Glossary Entries + | Defining Glossary Entries + | Loading Entries From a + | Loading Entries From a + | Loading Entries From a + | Loading Entries From a + | Loading Entries From a + | Loading Entries From a + | Defining New Glossaries + | Defining New Glossaries + | Defining New Glossaries + | Defining New Glossaries + | Defining New Glossaries + | Defining New Glossaries + | Acronyms + | Acronyms
counter -
Package Options - | Package Options - | Number lists - | Number lists +
Package Options + | Package Options + | Number lists + | Number lists
description -
Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
dua -
Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms -
footnote -
Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms +
footnote +
Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
nonumberlist -
A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Number lists - | Number lists - | Defining your own glossary - | Defining your own glossary - | Defining your own glossary - | Defining your own glossary +
A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Number lists + | Number lists + | Defining your own glossary + | Defining your own glossary + | Defining your own glossary + | Defining your own glossary
numberedsection -
Package Options - | Package Options - | Package Options - | Package Options - | Package Options +
Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Displaying a glossary + | Displaying a glossary + | Displaying a glossary + | Displaying a glossary
autolabel -
Package Options - | Package Options +
Package Options + | Package Options
false -
Package Options +
Package Options
nolabel -
Package Options +
Package Options
numberline -
Package Options - | Package Options - | Package Options - | Package Options +
Package Options + | Package Options + | Package Options + | Package Options
sanitize -
Package Options - | Package Options - | Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
Package Options + | Package Options + | Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
description -
Acronyms - | Acronyms +
Acronyms + | Acronyms
symbol -
Acronyms - | Acronyms - | Acronyms - | Acronyms +
Acronyms + | Acronyms + | Acronyms + | Acronyms
section -
A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options +
A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options
shortcuts -
Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
smallcaps -
Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
Troubleshooting + | Troubleshooting + | Troubleshooting + | Troubleshooting + | Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
smaller -
Package Options - | Package Options - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms - | Acronyms +
Troubleshooting + | Troubleshooting + | Troubleshooting + | Troubleshooting + | Package Options + | Package Options + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms + | Acronyms
style -
A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Displaying a glossary - | Displaying a glossary - | Glossary Styles - | Glossary Styles +
A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Displaying a glossary + | Displaying a glossary + | Glossary Styles + | Glossary Styles
toc -
A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | A Quick Guide For - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Package Options - | Displaying a glossary - | Displaying a glossary +
A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | A Quick Guide For + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Package Options + | Displaying a glossary + | Displaying a glossary
\pagelistname -
Multi-Lingual Support +
Multi-Lingual Support
\printglossaries -
A Quick Guide For - | Defining Glossary Entries +
Troubleshooting + | A Quick Guide For + | Defining Glossary Entries
\printglossary -
Defining Glossary Entries - | Glossary Styles +
Troubleshooting + | Defining Glossary Entries + | Glossary Styles + | Glossary Styles
\printglossary keys
+
nonumberlist +
Displaying a glossary +
numberedsection +
Displaying a glossary
style -
Displaying a glossary - | Glossary Styles +
Displaying a glossary + | Glossary Styles + | Glossary Styles
title -
Displaying a glossary +
Displaying a glossary
toctitle -
Displaying a glossary +
Displaying a glossary
type -
Displaying a glossary +
Displaying a glossary
+
relsize +
Acronyms
\setglossarysection -
Package Options +
Package Options +
\smaller +
Acronyms
supertabular -
Glossary Styles +
Glossary Styles
\symbolname -
Multi-Lingual Support +
Multi-Lingual Support
translator -
Multi-Lingual Support - | Multi-Lingual Support - | Multi-Lingual Support - | Multi-Lingual Support - | Multi-Lingual Support - | Multi-Lingual Support +
Multi-Lingual Support + | Multi-Lingual Support + | Multi-Lingual Support + | Multi-Lingual Support + | Multi-Lingual Support + | Multi-Lingual Support + | Multi-Lingual Support + | Troubleshooting

@@ -3958,60 +4236,67 @@ Index



Footnotes

-
... +
... range1
+ HREF="glossaries-manual.html#tex2html8">1
This is new to version 1.01
-
...acronym2
+
...acronym2
if the -acronym option is used, otherwise the list of +acronym option is used, otherwise the list of acronyms is the main glossary
-
... this.3
+
... this.3
The only preamble restriction on \newglossaryentry and \newacronym was removed in version 1.13, but the restriction remains for \loadglsentries.
-
... label4
+
... label4
main for the main (default) glossary, \acronymtype for the list of acronyms, or the name supplied in the first mandatory argument to \newglossary for additional glossaries.
-
...smaller5
-
\smaller is defined -in the relsize package. +
...smaller,5
+
you will need to load a +package, such as relsize, that defines \smaller if you use +this option.
-
... start.6
+
... start.6
This style was supplied by Axel Menzel.
-
... +
... link7
+ HREF="glossaries-manual.html#tex2html16">7
if the document doesn't have hyperlinks enabled \@glslink ignores the label and simply typesets the text.
-
... correctly.8
+
... correctly.8
again, if the document doesn't support hyperlinks, \@glstarget will ignore the label, and just typeset the text. +
+
...MakeTextUppercase9
+
defined in the +textcase package +


diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex index d46e6e58645..ac8cf241478 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex @@ -23,7 +23,7 @@ \makeatother \RecordChanges \PageIndex -\CheckSum{5110} +\CheckSum{5121} \CodelineNumbered \newcommand*{\termdef}[1]{\emph{#1}\iterm{#1}} \newcommand*{\term}[1]{#1\iterm{#1}} @@ -31,6 +31,18 @@ \newcommand{\dq}[1]{``#1''} \newcommand*{\tableref}[1]{\hyperref[#1]{table~\ref*{#1}}} \newcommand*{\Tableref}[1]{\hyperref[#1]{Table~\ref*{#1}}} +\newlength\boxlength +\newsavebox\importantbox +\newenvironment{important}{% +\setlength{\fboxrule}{4pt}% +\setlength\boxlength{\linewidth}% +\addtolength\boxlength{-2\fboxsep}% +\addtolength\boxlength{-2\fboxrule}% +\begin{lrbox}{\importantbox}% +\begin{minipage}{\boxlength}% +}{\end{minipage}\end{lrbox}% +\par\vskip10pt\noindent +\fcolorbox{red}{white}{\usebox{\importantbox}}\par\vskip10pt} } { \usepackage{html} @@ -43,6 +55,7 @@ \newcommand{\dq}[1]{"#1"} \newcommand*{\tableref}[1]{\htmlref{table~}{#1}\ref{#1}} \newcommand*{\Tableref}[1]{\htmlref{Table~}{#1}\ref{#1}} +\newenvironment{important}{}{} } @@ -96,7 +109,7 @@ \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{glossaries.sty v 1.13: \LaTeXe\ Package to Assist Generating Glossaries} + \title{glossaries.sty v 1.14: \LaTeXe\ Package to Assist Generating Glossaries} \author{Nicola L.C. Talbot\\[10pt] School of Computing Sciences\\ University of East Anglia\\ @@ -104,7 +117,7 @@ Norwich. Norfolk\\ NR4 7TJ. United Kingdom.\\ \url{http://theoval.cmp.uea.ac.uk/~nlct/}} - \date{12th May 2008} + \date{18th June 2008} \maketitle \tableofcontents @@ -135,6 +148,7 @@ code for the \sty{mfirstuc} package}{}. \ifmakedtx{}{\toTop} \subsection{Multi-Lingual Support} +\label{sec:languages} As from version 1.08, the \sty{glossaries} package now has limited multi-lingual support, thanks to all the people who have sent @@ -143,7 +157,15 @@ me the relevant translations either via email or via However you must load \isty{babel} \emph{before} \sty{glossaries} to enable this. Note that if \isty{babel} is loaded and the \isty{translator} package is detected on \TeX's path, then the -\isty{translator} package will be loaded automatically. +\isty{translator} package will be loaded automatically, however, +it may not pick up on the required languages, so if the predefined +text is not translated, you may need to explicitly load the +\isty{translator} package with the required languages. For example: +\begin{verbatim} +\usepackage[spanish]{babel} +\usepackage[spanish]{translator} +\usepackage{glossaries} +\end{verbatim} If you want to use \isty{ngerman} or \isty{german} instead of \isty{babel}, you will need to include the \isty{translator} package @@ -269,13 +291,106 @@ If any problems occur, remember to check the transcript files The \sty{glossaries} package comes with a minimal file called \texttt{minimalgls.tex} which can be used for testing. This -should be located in \texttt{texmf/doc/latex/glossaries/samples/}. Further -information on debugging \LaTeX\ code is available at +should be located in \texttt{texmf/doc/latex/glossaries/samples/}. +Further information on debugging \LaTeX\ code is available at \url{http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/}. -There is a list of frequently asked questions for the -\sty{glossaries} package available at -\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}.\ifmakedtx{}{\toTop} +Below is a list of the most frequently asked questions. For +other queries, consult the \sty{glossaries} FAQ at +\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}. + +\begin{enumerate} +\item I've used the \pkgopt{smallcaps} option, but the acronyms +are displayed in normal sized upper case letters. + +The \pkgopt{smallcaps} package option uses \cs{textsc} to typeset +the acronyms. This command converts lower case letters to small +capitals, while upper case letters remain their usual size. Therefore +you need to specify the acronym in lower case letters. + +\item How do I change the font that the acronyms are displayed in? + +The easiest way to do this is to specify the \pkgopt{smaller} package +option and redefine \cs{acronymfont} to use the required typesetting +command. For example, suppose you would like the acronyms displayed in +a sans-serif font, then you can do: +\begin{verbatim} +\usepackage[smaller]{glossaries} +\renewcommand*{\acronymfont}[1]{\textsf{#1}} +\end{verbatim} + +\item How do I change the font that the acronyms are displayed in +on first use? + +The easiest way to do this is to specify the \pkgopt{smaller} package +option and redefine \cs{firstacronymfont} to use the required +command. Note that if you don't want the acronym on subsequent use +to use \cs{smaller}, you will also need to redefine \cs{acronymfont}, +as above. For example to make the acronym emphasized on first use, +but use the surrounding font for subsequent use, you can do: +\begin{verbatim} +\usepackage[smaller]{glossaries} +\renewcommand*{\firstacronymfont}[1]{\emph{#1}} +\renewcommand*{\acronymfont}[1]{#1} +\end{verbatim} + +\item I don't have Perl installed, do I have to use +\appname{makeglossaries}? + +Read \ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{the previous +section}{sec:makeglossaries}}. + + +\item I'm used to using the \sty{glossary} package: are there any +instructions on migrating from the \isty{glossary} package to the +\sty{glossaries} package? + +Read \ifmakedtx{the file \texttt{glossary2glossaries.pdf}}{\htmladdnormallink{Upgrading +from the glossary package to the glossaries +package}{glossary2glossaries.html}} which should be available from the +same location as this document. + +\item I'm using \isty{babel} but the fixed names haven't been +translated. + +The \sty{glossaries} package currently only supports the following +languages: Danish, Dutch, English, French, German, Irish, Italian, +Hungarian, Polish and Spanish. If you want to add another language, +send me the translations, and I'll add them to the next version. + +If you are using one of the above languages, but the text hasn't been +translated, try adding the \isty{translator} package with the +required languages explicitly (before you load the \sty{glossaries} +package). For example: +\begin{verbatim} +\usepackage[ngerman]{babel} +\usepackage[ngerman]{translator} +\usepackage{glossaries} +\end{verbatim} +Alternatively, you may be able to add the language as a global option +to the class file. Check the \sty{translator} package documentation for +further details. + +\item My glossaries haven't appeared. + +Remember to do the following: +\begin{itemize} +\item Add \ics{makeglossaries} to the document preamble. + +\item Use either \ics{printglossary} for each glossary that has +been defined or \ics{printglossaries}. + +\item Use \ics{gls}, \ics{Gls}, \ics{GLS}, \ics{glspl}, \ics{Glspl}, +\ics{GLSpl}, \ics{glslink}, \ics{glsadd} or \ics{glsaddall} in the +document. + +\item Run \LaTeX\ on your document, then run \appname{makeglossaries}, +then run \LaTeX\ on your document again. If you want the glossaries +to appear in the table of contents, you will need an extra \LaTeX\ +run. +\end{itemize} +\end{enumerate} +\ifmakedtx{}{\toTop} \section{A Quick Guide For The Impatient} \label{sec:quick} @@ -562,7 +677,7 @@ will be localised to the required text. \item Entries can be added to the glossary without producing any text using \ics{glsadd}\marg{label} or -\ics{glsaddall}. These commands also taken an optional +\ics{glsaddall}. These commands also take an optional argument where you can specify the format. For example \begin{verbatim} \glsadd[format=hyperbf]{singmtx} @@ -678,6 +793,7 @@ appear in unnumbered subsections: \changes{1.02}{2007 May 25}{added overview section} \subsection{Package Options} +\label{sec:pkgopts} The \sty{glossaries} package options are as follows: \begin{description} @@ -747,6 +863,23 @@ if the \pkgopt{acronym} option is used. For example: The list of acronyms is in section~\ref{\acronymtype}. \end{verbatim} +As from version 1.14, you can add a prefix to the label by +redefining \DescribeMacro{\glsautoprefix}\cs{glsautoprefix}. +For example: +\begin{verbatim} +\renewcommand*{\glsautoprefix}{glo:} +\end{verbatim} +will add \texttt{glo:} to the automatically generated label, so +you can then, for example, refer to the list of acronyms as follows: +\begin{verbatim} +The list of acronyms is in section~\ref{glo:\acronymtype}. +\end{verbatim} +Or, if you are undecided on a prefix: +\begin{verbatim} +The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}. +\end{verbatim} + + \item[\pkgopt{style}] This is a \meta{key}=\meta{value} option. Its value should be the name of the glossary style to use. Predefined glossary styles are listed \ifmakedtx{in \autoref{sec:styles}}{\htmlref{later}{sec:styles}}. @@ -776,6 +909,7 @@ further details.)}{} For example, to switch off the sanitization for the symbol=true}]{glossaries} \end{verbatim} +\begin{important}% \textbf{Note}: this sanitization only applies to the \gloskey{name}, \gloskey{description} and \gloskey{symbol} keys. It doesn't apply to any of the other keys (except the \gloskey{sort} key which is @@ -784,6 +918,7 @@ the other keys must always be protected using \cs{protect}. Since the value of the \gloskey{text} key is obtained from the \gloskey{name} key, you will still need to protect fragile commands in the \gloskey{name} key if you don't use the \gloskey{text} key. +\end{important} \item[\pkgopt{description}] This option changes the definition of \ics{newacronym} to allow a description. See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} @@ -889,6 +1024,7 @@ uppercase variants). If this field is omitted, the value is obtained from the \gloskey{plural} key, if the \gloskey{first} key is omitted, or by appending \ics{glspluralsuffix} to the value of the \gloskey{first} field, if the \gloskey{first} field is present. + \textbf{Note:} prior to version 1.13, the default value of \gloskey{firstplural} was always taken by appending \dq{s} to the \gloskey{first} key, which meant that you had to specify both @@ -925,24 +1061,6 @@ problem for commands like \cs{Gls} and \cs{Glspl}. For example: \newglossaryentry{elite}{name={{\'e}lite}, description={select group or class}} \end{verbatim} -Similarly, commands such as \cs{ae} and \cs{oe} should either be placed -inside a group or followed by a space. For example: -\begin{verbatim} -\newglossaryentry{oesophagus}{% -name={{\oe}sophagus}, -description={canal from mouth to stomach}} -\end{verbatim} -The following is also fine: -\begin{verbatim} -\newglossaryentry{oesophagus}{% -name={\oe sophagus}, -description={canal from mouth to stomach}} -\end{verbatim} -but don't do \verb|\oe{}sophagus| as it will confuse -\ics{makefirstuc} (described -\ifmakedtx{in \autoref{sec:mfirstuc}}{\htmlref{later}{sec:mfirstuc}}) -and will produce \ifmakedtx{\oe{}}{oe}Sophagus instead of -\ifmakedtx{{\OE}}{OE}sophagus. \ifmakedtx{}{\toTop} @@ -1538,7 +1656,20 @@ option has been used). If omitted, the glossary title is used. \item[{\gloskey[printglossary]{style}}] This specifies which glossary style to use for this glossary, overriding the effect -of the \pkgopt{style} option or \ics{glossarystyle}. +of the \pkgopt{style} package option or \ics{glossarystyle}. + +\item[{\gloskey[printglossary]{numberedsection}}] This specifies +whether to use a numbered section for this glossary, overriding +the effect of the \pkgopt{numberedsection} package option. This +key has the same syntax as the \pkgopt{numberedsection} package +option, described \ifmakedtx{in \autoref{sec:pkgopts}}{\htmlref{earlier}{sec:pkgopts}}. + +\item[{\gloskey[printglossary]{nonumberlist}}] Unlike the package option +of the same name, this key is a boolean key. If true (\verb|nonumberlist=true|) the numberlist +is suppressed for this glossary. If false (\verb|nonumberlist=false|) the numberlist is +displayed for this glossary. If no value is supplied, true is +assumed. + \end{description} \DescribeMacro{\glossarypreamble} @@ -1656,12 +1787,13 @@ the name of the glossary in which the acronyms should appear. If the \texttt{acronym}, otherwise it will be \texttt{main}. The acronyms can then be used in exactly the same way as any other glossary entry. -(\textbf{Note:} since \cs{newacronym} sets \verb|type=\acronymtype|, +\begin{important}% +\textbf{Note:} since \cs{newacronym} sets \verb|type=\acronymtype|, if you want to load a file containing acronym definitions using \cs{loadglsentries}\oarg{type}\marg{filename}, the optional argument \meta{type} will not have an effect unless you explicitly set the -type as \verb|type=\glsdefaulttype|. See \ifmakedtx{\autoref{sec:loadglsentries}}{\htmlref{earlier}{sec:loadglsentries} for details}.) - +type as \verb|type=\glsdefaulttype|. See \ifmakedtx{\autoref{sec:loadglsentries}}{\htmlref{earlier}{sec:loadglsentries} for details}. +\end{important} For example, the following defines the acronym IDN: \begin{verbatim} @@ -1695,18 +1827,33 @@ such as \cs{acrshort}, as they vary according to the definition of \Tableref{tab:acronymsettings} lists the package options and how the -\ics{newglossaryentry} keys are used to store \meta{long} (the long -form) and \meta{abbrv} (the short form). Note that the -\pkgopt{smallcaps} option redefines \ics{acronymfont} so that it sets -its argument using \cs{textsc} (so you should use lower case characters -in \meta{abbrv}) and the \pkgopt{smaller} option redefines -\cs{acronymfont} to use \cs{smaller}\footnote{\cs{smaller} is defined -in the \sty{relsize} package.}, otherwise \cs{acronymfont} simply -displays its argument in the surrounding font. Note also that if none -of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, -\pkgopt{dua}, \pkgopt{description} or \pkgopt{footnote} are used, -\cs{acronymfont} is not used, so changing the definition of -\cs{acronymfont} will have no effect under such circumstances. +\ics{newglossaryentry} keys are used to store \meta{long} (the long +form) and \meta{abbrv} (the short form). Note that the +\pkgopt{smallcaps} option redefines +\DescribeMacro{\acronymfont}\cs{acronymfont} so that it sets its +argument using \cs{textsc} (so you should use lower case characters in +\meta{abbrv}) and the \pkgopt{smaller} option redefines +\cs{acronymfont} to use \cs{smaller},\footnote{you will need to load a +package, such as \sty{relsize}, that defines \cs{smaller} if you use +this option.} otherwise \cs{acronymfont} simply displays its argument +in the surrounding font. Note also that if none of the package options +\pkgopt{smallcaps}, \pkgopt{smaller}, \pkgopt{dua}, +\pkgopt{description} or \pkgopt{footnote} are used, \cs{acronymfont} is +not used, so changing the definition of \cs{acronymfont} will have no +effect under such circumstances. + +If you want to display the acronym in another font, for example, +emphasized, then use the \pkgopt{smaller} package option and +redefine \ics{acronymfont} to use the required font. For example: +\begin{verbatim} +\usepackage[smaller]{glossaries} +\renewcommand*{\acronymfont}[1]{\emph{#1}} +\end{verbatim} +Where \cs{acronymfont} is available, +\DescribeMacro{\firstacronymfont}\cs{firstacronymfont} is also +available. By default, this simply uses \cs{acronymfont}, but it +can be redefined to change the way the acronym is displayed on +first use. \begin{table}[htbp] \caption{Package options governing \cs{newacronym} and how the @@ -1795,7 +1942,7 @@ to change the way the link text is displayed. \item[\pkgopt{description},\pkgopt{footnote}]\ifmakedtx{\mbox{}\par}{} When these two package options are used together, the first use displays the entry as:\\[10pt] -\cs{acronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} +\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} \\[10pt] while subsequent use displays the entry as:\\[10pt] \cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] @@ -1809,7 +1956,7 @@ given order), the \sty{glossaries} package additionally implements the \ipkgopt[description]{sanitize}\ipkgopt[symbol]{sanitize}\verb|sanitize={description=false,symbol=false}|, so remember to protect fragile commands when defining acronyms. -\item[dua]\ifmakedtx{\mbox{}\par}{} +\item[\pkgopt{dua}]\ifmakedtx{\mbox{}\par}{} The \pkgopt{dua} package option always displays the expanded form and so may not be used with \pkgopt{footnote}, \pkgopt{smaller} or \pkgopt{smallcaps}. Both first use and subsequent use displays the @@ -1822,7 +1969,7 @@ If the \pkgopt{description} package option is also used, the \item[\pkgopt{description}]\ifmakedtx{\mbox{}\par}{} This package option displays the entry on first use as:\\[10pt] -\meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt] +\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] while subsequent use displays the entry as:\\[10pt] \cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] Note also that if this package option is used, the \sty{glossaries} @@ -1832,7 +1979,7 @@ remember to protect fragile commands when defining acronyms. \item[\pkgopt{footnote}]\ifmakedtx{\mbox{}\par}{} This package option displays the entry on first use as:\\[10pt] -\cs{acronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}\\[10pt] +\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}\\[10pt] while subsequent use displays the entry as:\\[10pt] \cs{acronymfont}\marg{abbrv}\meta{insert} @@ -1844,7 +1991,7 @@ remember to protect fragile commands when defining acronyms. \item[\pkgopt{smallcaps}]\ifmakedtx{\mbox{}\par}{} If neither the \pkgopt{footnote} nor \pkgopt{description} options have been set, this option displays the entry on first use as:\\[10pt] -\meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt] +\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] while subsequent use displays the entry as:\\[10pt] \cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] where \cs{acronymfont} is set to \verb|\textsc{#1}|, so \meta{abbrv} @@ -1858,11 +2005,14 @@ remember to protect fragile commands when defining acronyms. \item[\pkgopt{smaller}]\ifmakedtx{\mbox{}\par}{} If neither the \pkgopt{footnote} nor \pkgopt{description} options have been set, this option displays the entry on first use as:\\[10pt] -\meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt] +\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] while subsequent use displays the entry as:\\[10pt] \cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] where \cs{acronymfont} is set to \verb|{\smaller #1}|. +Remember to load a package that defines \ics{smaller} (such as +\isty{relsize}) if you want to use this option. + Note also that if this package option is used, the \sty{glossaries} package additionally implements the option \ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so @@ -1874,7 +2024,6 @@ If none of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, then on first use the entry is displayed as:\\[10pt] \meta{long} (\meta{abbrv})\meta{insert}\\[10pt] while subsequent use displays the entry as:\\[10pt] -\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] \meta{abbrv}\meta{insert} \end{description} @@ -1998,7 +2147,22 @@ list for that entry. Sub groups are separated using \cs{indexspace}. \item[listhypergroup] The \glostyle{listhypergroup} style is like \glostyle{listgroup} but has a set of links to the glossary -groups. +groups. The start of the glossary has a navigation panel to +each group that is present in the glossary. This requires an +additional run through \LaTeX\ to ensure the group information +is up-to-date. In the navigation panel, each group is separated +by \DescribeMacro{\glshypernavsep}\cs{glshypernavsep} which +defaults to a vertical bar with a space on either side. For example, +to simply have a space separating each group, do: +\begin{verbatim} +\renewcommand*{\glshypernavsep}{\space} +\end{verbatim} + +Note that the hyper-navigation panel is now (as from version 1.14) +set inside the optional argument to \cs{item} instead of after it +to prevent a spurious space at the start. This can be changed +by redefining \ics{glossaryheader}, but note that this needs to +be done \emph{after} the glossary style has been set. \item[altlist] The \glostyle{altlist} style is like \glostyle{list} but the description is placed on the following line. @@ -2008,7 +2172,8 @@ but the description is placed on the following line. \item[altlisthypergroup] The \glostyle{altlisthypergroup} style is like \glostyle{altlistgroup} but has a set of links to the glossary -groups. +groups. The navigation panel is the same as that for +\glostyle{listhypergroup}, described above. \item[listdotted] This style uses the \envname{description} environment. Each entry starts with \verb|\item[]|, followed by the @@ -2119,6 +2284,28 @@ or using the \gloskey[printglossary]{style} key in the optional argument to \ics{printglossary} or using the command:\\[10pt] \DescribeMacro{\glossarystyle}\cs{glossarystyle}\marg{style-name}\\[10pt] +Note that if you use the \gloskey[printglossary]{style} key in the +optional argument to \ics{printglossary}, it will override any +previous style settings for the given glossary, so if, for example, +you do: +\begin{verbatim} +\renewcommand*{\glsgroupskip}{} +\printglossary[style=long] +\end{verbatim} +The new definition of \ics{glsgroupskip} will not have an affect +for this glossary, as \cs{glsgroupskip} is redefined by +\verb|style=long|. Likewise, \ics{glossarystyle} will also +override any previous style definitions, so, again: +\begin{verbatim} +\renewcommand*{\glsgroupskip}{} +\glossarystyle{long} +\end{verbatim} +will reset \cs{glsgroupskip} back to its default definition for the +named glossary style (\dq{long} in this case). If you want to +modify the styles, either use \ics{newglossarystyle} (described +in the next section) or make the modifications after +\ics{glossarystyle}. + \changes{1.03}{2007 July 4}{'glspostdescription added} All the styles except for the three- and four-column styles and the \glostyle{listdotted} style use the command @@ -2306,7 +2493,7 @@ The \sty{glossaries} package is supplied with the package \cs{makefirstuc}\marg{stuff}\\[10pt] which makes the first object of \meta{stuff} uppercase unless \meta{stuff} starts with a control -sequence followed by a group, in which case the first +sequence followed by a non-empty group, in which case the first object in the group is converted to uppercase. Examples: \begin{itemize} \item \verb|\makefirstuc{abc}| produces Abc @@ -2322,9 +2509,13 @@ than \cs{emph}.) \item \verb|\makefirstuc{{\ae}bc}| produces {\AE}bc \end{itemize} -Note however that \verb|\makefirstuc{\ae{}bc}| produces \ae Bc since -the empty group following \cs{ae} is considered to be the argument -of \cs{ae} which is in fact not the case. +\begin{important} +In version 1.02 of \sty{mfirstuc}, a bug fix resulted in a change +in output if the first object is a control sequence followed by +an empty group. Prior to version 1.02, \verb|\makefirstuc{\ae{}bc}| +produced \ae Bc. However as from version 1.02, it now produces +\AE bc. +\end{important} Note also that \begin{verbatim} @@ -2348,6 +2539,17 @@ This is equivalent to \cs{expandafter}\cs{makefirstuc}\cs{expandafter}\marg{stuf \end{verbatim} produces: Abc. +If you want to use an alternative command to convert to uppercase, +for example \cs{MakeTextUppercase}\footnote{defined in the +\sty{textcase} package}, you can redefine the internal +command \cs{@gls@makefirstuc}. For example: +\begin{verbatim} +\renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1} +\end{verbatim} +(Remember that command names that contain the @ character must +either be placed in packages or be placed between \cs{makeatletter} +\cs{makeatother}.) + \ifmakedtx{}{\toTop} \StopEventually{\clearpage\phantomsection\addcontentsline{toc}{section}{Index}\PrintIndex} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf index ef70c06fb7f..f125d355fc9 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossaries.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index 74207fb56c1..77571dcf832 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -26,6 +26,7 @@ package">

Upgrading from the glossary package to the glossaries package

Nicola L.C. Talbot

+

17th June 2008


@@ -34,42 +35,44 @@ Contents

@@ -104,7 +107,7 @@ to the glossaries package options.

- +
Table 1: Mappings from glossary to glossaries @@ -221,7 +224,7 @@ with in the preamble, and

-\glossarystyle{<new style list>} +\glossarystyle{<new style>}

immediately before \printglossary[type=<type>], if the new glossary requires a different style to the main (default) @@ -229,7 +232,7 @@ glossary.

The <style list> optional argument can be converted to -<new style list> using the same mapping given in +<new style> using the same mapping given in Table 1.

@@ -244,10 +247,17 @@ You will need to replace the above two lines with: in the preamble, and

-\glossarystyle{style=longheader}
+\glossarystyle{longheader}
 
immediately prior to displaying this glossary new type. +

+Alternatively, you can specify the style using the style +key in the optional argument of \printglossary. For example: +

+\printglossary[type=notation,style=longheader]
+
+

Note that the glossary title is no longer specified using \<glossary-type>name (except for \glossaryname @@ -289,8 +299,8 @@ With the old glossary package you could optionally store glossary information for later use, or you could simply use \glossary whenever you wanted to add information to the glossary. With the new glossaries package, the latter option is no longer -available1. If +available.1 If you have stored all the glossary information using \storeglosentry, then you will need to convert these commands into the equivalent \newglossaryentry. If you haven't used @@ -344,9 +354,6 @@ description={The cardinality of the set $\mathcal{S}$}}

The format and number keys available in \storeglosentry are not available with \newglossaryentry. -Note also that the glossary package allowed you to use -\storeglosentry in the document, but \newglossaryentry -may only be used in the preamble.

@@ -408,7 +415,7 @@ Any occurrences if this command will need to be replaced with \glslink[<new options>]{<label>}{<text>}

The mapping from <old options> to <new options> is -the same as that given in section 5.1 above. +the same as that given above.

@@ -420,7 +427,9 @@ the same as that given in section 2 If, with the old + HREF="#foot511">2 If, with the old package, you have opted to explicitly use \glossary instead of storing the glossary information with \storeglosentry, then converting from glossary to glossaries will be more time-consuming, although in the end, I hope you will see the benefits!3 If + HREF="#foot512">3 If you have used \glossary with the old glossary package, you will instead need to define the relevant glossary terms using \newglossaryentry and reference the terms using \glslink, @@ -462,7 +471,7 @@ In the glossary package, acronyms were treated differently to glossary entries. This resulted in inconsistencies and sprawling unmaintainable code. The new glossaries package treats acronyms in exactly the same way as normal glossary terms. In fact, -in the glossaries package: +in the glossaries package, the default definition of:

\newacronym[<options>]{<label>}{<abbrv>}{<long>} @@ -483,20 +492,10 @@ firstplural={<long>s (<abbrv>s)},

This is different to the glossary package which set the name key to <long> (<abbrv>) and allowed you -to set a description using the description key. If you want -your document to remain like this, you can redefine \newacronym -as follows: -

-\renewcommand{\newacronym}[4][]{%
-\newglossaryentry{#2}{type=\acronymtype,
-name={#4 (#3)},
-text={#3},
-first={#4 (#3)},
-plural={#3s},
-firstplural={#4s (#3s)},#1}}
-
-The description key will then need to be entered using the -optional argument. +to set a description using the description key. If you +still want to do this, you can use the description package +option, and use the description key in the +optional argument of \newacronym.

For example, if your document originally had the following: @@ -504,8 +503,12 @@ For example, if your document originally had the following: \newacronym{SVM}{Support Vector Machine}{description=Statistical pattern recognition technique} -Then you would need to redefine \newacronym as shown above, -and change the above to: +Then you would need to load the glossaries package using the +description package option, for example: +

+\usepackage[description]{glossaries}
+
+and change the acronym definition to:
 \newacronym[description=Statistical pattern recognition 
 technique]{svm}{SVM}{Support Vector Machine}
@@ -515,6 +518,39 @@ You will also need to replace all occurrences of \SVM with
 
 \newcommand{\SVM}{\gls{svm}}
 
+Remember that generally LaTeX ignores all spaces following command +names that consist of a backslash followed by letters! For example, +using the above definition of \SVM, the following will ignore +the space after \SVM: +
+The \SVM is a statistical pattern recognition technique.
+
+Instead, you need to explicitly insert a space: +
+The \SVM\ is a statistical pattern recognition technique.
+
+However, \SVM['s] is equivalent to \gls{svm}['s], +so you can do, for example: +
+The \SVM['s] parameters are obtained via optimisation techniques.
+
+ +

+The xspace package provides the command \xspace which can +be used to insert a space after the command name if required. Some +people prefer to use this at the end of the command definition so +that they don't need to remember to insert an explicit space. +For example, if we use the xspace package, we could define +\SVM as follows: +

+\newcommand{\SVM}{\gls{svm}\xspace}
+
+so now the following will have a space before the word "is": +
+The \SVM is a statistical pattern recognition technique.
+
+However, you can no longer do \SVM['s], as the \xspace is +now in the way.

If you have used \useacronym instead of \<acr-name>, @@ -542,7 +578,9 @@ be replaced with \Gls{<label>}. In the glossary package, it is possible to produce the long and short forms of an acronym without adding an entry to the glossary using \acrln and \acrsh. With the -glossaries package, you can replace +glossaries package (provided you defined the acronym using +\newacronym and provided you haven't redefined \newacronym) +you can replace

\acrsh{<acr-name>} @@ -550,44 +588,26 @@ the glossary using \acrln and \acrsh. With the with

-\glsentrytext{<label>} +\acrshort{<label>}

-However the glossaries package provides no direct equivalent -of \acrln. Instead it provides \glsentryfirst which -produces the ``first use'' text without adding an entry to the -glossary, or affecting the first use flag. +and you can replace

-Alternatively, if you haven't changed the definition of -\newacronym, the long form by itself can be obtained using -\glsentrydesc, since by default the description key is -set to the long form (but read the notes in the glossaries -manual regarding the sanitize package option). +\acrln{<acr-name>} +

+with

-If you want to be able to set a description, and be able to -independently access the description, the long form and the -short form, you can redefine \newacronym so that it uses -the symbol key and use \defglsdisplayfirst -so that it uses this value on first use, as follows: -

-\renewcommand{\newacronym}[4][]{\newglossaryentry{#2}{%
-name={#4 (#3)},
-text={#3},
-first={#4},
-symbol={#3},
-}}
-\defglsdisplayfirst{\acronymtype}{##1 (##3)##4}
-
-As before, you can access the short name via -\glsentrytext{<label>}, but you can now access just the long -form via \glsentryfirst{<label>} and the description via -\glsentrydesc{<label>}. +\acrlong{<label>} +

+The glossaries package also provides the related commands +\acrshortpl (plural short form) and \acrlongpl (plural long +form) as well as upper case variations.

See -the section ``Using -glossary entries in the text'' of the glossaries +the section "Using +glossary entries in the text" of the glossaries manual for further details of how to use these commands.

@@ -725,17 +745,29 @@ Remember also, that if you used the makeglos Perl script, you will need to use the makeglossaries Perl script instead. +

+ +

+9 Troubleshooting +

+ +

+Please check the FAQ +for the glossaries package if you have any +problems. +



Footnotes

-
... -available... +available.1
mainly because having a key value list in \glossary caused problems, but it also helps consistency.
-
... directly.... directly.2
This is because \glossary requires the argument to be in a specific format and doesn't use the @@ -747,7 +779,7 @@ recommended. If you persist in using \glossary with the new package, don't complain if things go wrong!
-
... +
... benefits!3
From the user's point of view, using \glossary diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf index 275dcac7391..f72177a7152 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex index f811c671f11..12b63f036fc 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex @@ -11,6 +11,7 @@ \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} +\date{17th June 2008} \newcommand*{\meta}[1]{\textnormal{\textless\emph{#1}\textgreater}} \newcommand*{\marg}[1]{\texttt{\char`\{\meta{#1}\char`\}}} @@ -19,6 +20,9 @@ package} %\begin{latexonly} \newcommand*{\sty}[1]{\textsf{#1}} +\newcommand*{\key}[1]{\textsf{#1}} +\newcommand*{\pkgopt}[1]{\textsf{#1}} +\newcommand*{\dq}[1]{``#1''} \newsavebox\waybox \newenvironment{oldway}{\begin{lrbox}{\waybox} @@ -42,6 +46,9 @@ package} \newenvironment{newway}{\par\begin{ttfamily}}{\end{ttfamily}\par} \newcommand{\sty}[1]{\texttt{#1}} \renewcommand{\LaTeX}{LaTeX} +\newcommand*{\key}[1]{\texttt{#1}} +\newcommand*{\pkgopt}[1]{\texttt{#1}} +\newcommand*{\dq}[1]{"#1"} \end{htmlonly} \begin{document} @@ -117,14 +124,14 @@ with \end{newway}% in the preamble, and \begin{newway} -\cs{glossarystyle}\marg{new style list} +\cs{glossarystyle}\marg{new style} \end{newway}% immediately before \verb|\printglossary[type=|\meta{type}\verb|]|, if the new glossary requires a different style to the main (default) glossary. The \meta{style list} optional argument can be converted to -\meta{new style list} using the same mapping given in +\meta{new style} using the same mapping given in Table~\ref{tab:pkgopt}. For example, if your document contains the following: @@ -138,17 +145,23 @@ You will need to replace the above two lines with: \end{verbatim} in the preamble, and \begin{verbatim} -\glossarystyle{style=longheader} +\glossarystyle{longheader} \end{verbatim} immediately prior to displaying this glossary new type. +Alternatively, you can specify the style using the \key{style} +key in the optional argument of \cs{printglossary}. For example: +\begin{verbatim} +\printglossary[type=notation,style=longheader] +\end{verbatim} + Note that the glossary title is no longer specified using \cs{}\meta{glossary-type}\texttt{name} (except for \cs{glossaryname} and \cs{acronymname}) but is instead specified in the \meta{title} argument of \cs{newglossary}. The short title which is specified in the \sty{glossary} package by the command \cs{short}\meta{glossary-name}\texttt{name} is now specified -using the \texttt{toctitle} key in the optional argument to +using the \key{toctitle} key in the optional argument to \cs{printglossary}. \section{\cs{make}\meta{glossary name}} @@ -172,8 +185,8 @@ With the old \sty{glossary} package you could optionally store glossary information for later use, or you could simply use \cs{glossary} whenever you wanted to add information to the glossary. With the new \sty{glossaries} package, the latter option is no longer -available\footnote{mainly because having a key value list in -\cs{glossary} caused problems, but it also helps consistency.}. If +available.\footnote{mainly because having a key value list in +\cs{glossary} caused problems, but it also helps consistency.} If you have stored all the glossary information using \cs{storeglosentry}, then you will need to convert these commands into the equivalent \cs{newglossaryentry}. If you haven't used @@ -217,11 +230,8 @@ then you will need to replace it with: description={The cardinality of the set $\mathcal{S}$}} \end{verbatim} -The \texttt{format} and \texttt{number} keys available in +The \key{format} and \key{number} keys available in \cs{storeglosentry} are not available with \cs{newglossaryentry}. -Note also that the \sty{glossary} package allowed you to use -\cs{storeglosentry} in the document, but \cs{newglossaryentry} -may only be used in the preamble. \section{Adding an entry to the glossary} @@ -246,7 +256,7 @@ Any occurrences of this command will need to be replaced with \begin{newway} \cs{glsadd}\oarg{new options}\marg{label} \end{newway}% -The \texttt{format} key in \meta{old options} remains the same +The \key{format} key in \meta{old options} remains the same in \meta{new options}, the \texttt{number=}\meta{counter name} key in \meta{old options} should be replaced with\linebreak \texttt{counter=}\meta{counter name} in \meta{new options}. @@ -263,14 +273,17 @@ Any occurrences if this command will need to be replaced with \cs{glslink}\oarg{new options}\marg{label}\marg{text} \end{newway}% The mapping from \meta{old options} to \meta{new options} is -the same as that given in section~\ref{sec:useglosentry} above. +the same as that given \latexhtml{section~\ref{sec:useglosentry} +above}{\htmlref{above}{sec:useglosentry}}. \subsection{\cs{gls}} Both the \sty{glossary} and the \sty{glossaries} packages define the command \cs{gls}. In this case, the only thing you need to -change is the \texttt{number} key in the optional argument -to \texttt{counter}. +change is the \key{number} key in the optional argument +to \key{counter}. Note that the new form of \cs{gls} also takes +a final optional argument which can be used to insert text into the +automatically generated text. \subsection{\cs{glossary}} @@ -310,7 +323,7 @@ In the \sty{glossary} package, acronyms were treated differently to glossary entries. This resulted in inconsistencies and sprawling unmaintainable code. The new \sty{glossaries} package treats acronyms in exactly the same way as normal glossary terms. In fact, -in the \sty{glossaries} package: +in the \sty{glossaries} package, the default definition of: \begin{newway} \cs{newacronym}\oarg{options}\marg{label}\marg{abbrv}\marg{long} \end{newway} @@ -327,29 +340,23 @@ firstplural=\{\meta{long}s (\meta{abbrv}s)\}, \end{newway} This is different to the \sty{glossary} package which set the -\texttt{name} key to \meta{long} (\meta{abbrv}) and allowed you -to set a description using the \texttt{description} key. If you want -your document to remain like this, you can redefine \cs{newacronym} -as follows: -\begin{verbatim} -\renewcommand{\newacronym}[4][]{% -\newglossaryentry{#2}{type=\acronymtype, -name={#4 (#3)}, -text={#3}, -first={#4 (#3)}, -plural={#3s}, -firstplural={#4s (#3s)},#1}} -\end{verbatim} -The \texttt{description} key will then need to be entered using the -optional argument. +\key{name} key to \meta{long} (\meta{abbrv}) and allowed you +to set a description using the \key{description} key. If you +still want to do this, you can use the \pkgopt{description} package +option, and use the \key{description} key in the +optional argument of \cs{newacronym}. For example, if your document originally had the following: \begin{verbatim} \newacronym{SVM}{Support Vector Machine}{description=Statistical pattern recognition technique} \end{verbatim} -Then you would need to redefine \cs{newacronym} as shown above, -and change the above to: +Then you would need to load the \sty{glossaries} package using the +\pkgopt{description} package option, for example: +\begin{verbatim} +\usepackage[description]{glossaries} +\end{verbatim} +and change the acronym definition to: \begin{verbatim} \newacronym[description=Statistical pattern recognition technique]{svm}{SVM}{Support Vector Machine} @@ -359,6 +366,38 @@ You will also need to replace all occurrences of \cs{SVM} with \begin{verbatim} \newcommand{\SVM}{\gls{svm}} \end{verbatim} +Remember that generally \LaTeX\ ignores all spaces following command +names that consist of a backslash followed by letters! For example, +using the above definition of \cs{SVM}, the following will ignore +the space after \cs{SVM}: +\begin{verbatim} +The \SVM is a statistical pattern recognition technique. +\end{verbatim} +Instead, you need to explicitly insert a space: +\begin{verbatim} +The \SVM\ is a statistical pattern recognition technique. +\end{verbatim} +However, \verb|\SVM['s]| is equivalent to \verb|\gls{svm}['s]|, +so you can do, for example: +\begin{verbatim} +The \SVM['s] parameters are obtained via optimisation techniques. +\end{verbatim} + +The \sty{xspace} package provides the command \cs{xspace} which can +be used to insert a space after the command name if required. Some +people prefer to use this at the end of the command definition so +that they don't need to remember to insert an explicit space. +For example, if we use the \sty{xspace} package, we could define +\cs{SVM} as follows: +\begin{verbatim} +\newcommand{\SVM}{\gls{svm}\xspace} +\end{verbatim} +so now the following will have a space before the word \dq{is}: +\begin{verbatim} +The \SVM is a statistical pattern recognition technique. +\end{verbatim} +However, you can no longer do \verb|\SVM['s]|, as the \cs{xspace} is +now in the way. If you have used \cs{useacronym} instead of \cs{}\meta{acr-name}, then you will need to replace all occurrences of @@ -378,47 +417,31 @@ be replaced with \cs{Gls}\marg{label}. In the \sty{glossary} package, it is possible to produce the long and short forms of an acronym without adding an entry to the glossary using \cs{acrln} and \cs{acrsh}. With the -\sty{glossaries} package, you can replace +\sty{glossaries} package (provided you defined the acronym using +\cs{newacronym} and provided you haven't redefined \cs{newacronym}) +you can replace \begin{oldway} \cs{acrsh}\marg{acr-name} \end{oldway}% with \begin{newway} -\cs{glsentrytext}\marg{label} +\cs{acrshort}\marg{label} \end{newway}% -However the \sty{glossaries} package provides no direct equivalent -of \cs{acrln}. Instead it provides \cs{glsentryfirst} which -produces the ``first use'' text without adding an entry to the -glossary, or affecting the first use flag. - -Alternatively, if you haven't changed the definition of -\cs{newacronym}, the long form by itself can be obtained using -\cs{glsentrydesc}, since by default the \texttt{description} key is -set to the long form (but read the notes in the \sty{glossaries} -manual regarding the \texttt{sanitize} package option). - -If you want to be able to set a description, and be able to -independently access the description, the long form and the -short form, you can redefine \cs{newacronym} so that it uses -the \texttt{symbol} key and use \cs{defglsdisplayfirst} -so that it uses this value on first use, as follows: -\begin{verbatim} -\renewcommand{\newacronym}[4][]{\newglossaryentry{#2}{% -name={#4 (#3)}, -text={#3}, -first={#4}, -symbol={#3}, -}} -\defglsdisplayfirst{\acronymtype}{##1 (##3)##4} -\end{verbatim} -As before, you can access the short name via -\cs{glsentrytext}\marg{label}, but you can now access just the long -form via \cs{glsentryfirst}\marg{label} and the description via -\cs{glsentrydesc}\marg{label}. +and you can replace +\begin{oldway} +\cs{acrln}\marg{acr-name} +\end{oldway}% +with +\begin{newway} +\cs{acrlong}\marg{label} +\end{newway}% +The \sty{glossaries} package also provides the related commands +\cs{acrshortpl} (plural short form) and \cs{acrlongpl} (plural long +form) as well as upper case variations. See -\latexhtml{section~\ref*{sec:code:glslink} (}{the section }``Using -glossary entries in the text''\latex{)} of the \sty{glossaries} +\latexhtml{section~\ref*{sec:code:glslink} (}{the section }\dq{Using +glossary entries in the text}\latex{)} of the \sty{glossaries} manual for further details of how to use these commands. \subsection{\cs{ifacronymfirstuse}} @@ -500,14 +523,14 @@ The \sty{glossary} package allows you to specify a short title (for the table of contents and page header) by defining a command of the form \cs{short}\meta{glossary-type}\texttt{name}. The \sty{glossaries} package doesn't do this, but instead provides -the \texttt{toctitle} key which can be used in the optional +the \key{toctitle} key which can be used in the optional argument to \cs{printglossary}. For example, if you have created a new glossary type called \texttt{notation}, and you had defined \begin{verbatim} \newcommand{\shortnotationname}{Notation} \end{verbatim} -then you would need to use the \texttt{toctitle} key: +then you would need to use the \key{toctitle} key: \begin{verbatim} \printglossary[type=notation,toctitle=Notation] \end{verbatim} @@ -526,4 +549,10 @@ Remember also, that if you used the \texttt{makeglos} Perl script, you will need to use the \texttt{makeglossaries} Perl script instead. +\section{Troubleshooting} + +Please check the \htmladdnormallinkfoot{FAQ}{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html} +for the \sty{glossaries} package if you have any +problems. + \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex index eeaf583892d..1f97e1fffec 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex @@ -3,7 +3,9 @@ % desired, and add the relevant package options to % both the class file and the glossaries package. % Change the sample glossary entry and acronym if - % required. + % required. If the problem occurs with an additional + % glossary, add in the relevant \newglossary command + % and a sample entry. % % Only add extra packages or commands if they % contribute to whatever problem you are trying to @@ -22,17 +24,23 @@ \listfiles %\usepackage{glossaries} % acronym will go in main glossary -\usepackage[acronym]{glossaries} % make a separate list of acronyms + \usepackage[acronym]{glossaries} % make a separate list of acronyms \makeglossaries \newglossaryentry{sample}{name={sample}, description={a sample entry}} -\newacronym{aca}{aca}{a contrived acronym} +% This contrived acronym has non-standard plural forms. +% These are specified in the optional argument. +\newacronym[\glsshortpluralkey=cas,\glslongpluralkey=contrived +acronyms]{aca}{aca}{a contrived acronym} \begin{document} -A \gls{sample} entry and \gls{aca}. +A \gls{sample} entry and \gls{aca}. Second use: \gls{aca}. + +Plurals: \glspl{sample}. Reset acronym\glsreset{aca}. +First use: \glspl{aca}. Second use: \glspl{aca}. \printglossaries \end{document} diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx index 53444736371..4422a782e6f 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx @@ -15,12 +15,13 @@ % -author "Nicola Talbot" % -dir "source" % -setambles "glossaries\.perl=>\nopreamble\nopostamble" +% -setambles ".*\.tex=>\nopreamble\nopostamble" % -comment "glossaries\.perl" % -comment ".*\.tex" % -doc "glossaries-manual.tex" % -codetitle "Documented Code" % glossaries -% Created on 2008/5/13 11:33 +% Created on 2008/6/18 16:44 %\fi %\iffalse %<*package> @@ -71,7 +72,7 @@ \makeatother \RecordChanges \PageIndex -\CheckSum{5110} +\CheckSum{5121} \CodelineNumbered \newcommand*{\termdef}[1]{\emph{#1}\iterm{#1}} \newcommand*{\term}[1]{#1\iterm{#1}} @@ -79,6 +80,18 @@ \newcommand{\dq}[1]{``#1''} \newcommand*{\tableref}[1]{\hyperref[#1]{table~\ref*{#1}}} \newcommand*{\Tableref}[1]{\hyperref[#1]{Table~\ref*{#1}}} +\newlength\boxlength +\newsavebox\importantbox +\newenvironment{important}{% +\setlength{\fboxrule}{4pt}% +\setlength\boxlength{\linewidth}% +\addtolength\boxlength{-2\fboxsep}% +\addtolength\boxlength{-2\fboxrule}% +\begin{lrbox}{\importantbox}% +\begin{minipage}{\boxlength}% +}{\end{minipage}\end{lrbox}% +\par\vskip10pt\noindent +\fcolorbox{red}{white}{\usebox{\importantbox}}\par\vskip10pt} @@ -111,7 +124,7 @@ %\MakeShortVerb{"} %\DeleteShortVerb{\|} % -% \title{glossaries.sty v 1.13: \LaTeXe\ Package to Assist Generating Glossaries} +% \title{glossaries.sty v 1.14: \LaTeXe\ Package to Assist Generating Glossaries} % \author{Nicola L.C. Talbot\\[10pt] %School of Computing Sciences\\ %University of East Anglia\\ @@ -119,7 +132,7 @@ %NR4 7TJ. United Kingdom.\\ %\url{http://theoval.cmp.uea.ac.uk/~nlct/}} % -% \date{12th May 2008} +% \date{18th June 2008} % \maketitle %\tableofcontents % @@ -145,6 +158,7 @@ %code for the \sty{mfirstuc} package. % %\subsection{Multi-Lingual Support} +%\label{sec:languages} % %As from version 1.08, the \sty{glossaries} package now has %limited multi-lingual support, thanks to all the people who have sent @@ -153,7 +167,15 @@ %However you must load \isty{babel} \emph{before} %\sty{glossaries} to enable this. Note that if \isty{babel} is loaded %and the \isty{translator} package is detected on \TeX's path, then the -%\isty{translator} package will be loaded automatically. +%\isty{translator} package will be loaded automatically, however, +%it may not pick up on the required languages, so if the predefined +%text is not translated, you may need to explicitly load the +%\isty{translator} package with the required languages. For example: +%\begin{verbatim} +%\usepackage[spanish]{babel} +%\usepackage[spanish]{translator} +%\usepackage{glossaries} +%\end{verbatim} % %If you want to use \isty{ngerman} or \isty{german} instead %of \isty{babel}, you will need to include the \isty{translator} package @@ -277,13 +299,103 @@ % %The \sty{glossaries} package comes with a minimal file called %\texttt{minimalgls.tex} which can be used for testing. This -%should be located in \texttt{texmf/doc/latex/glossaries/samples/}. Further -%information on debugging \LaTeX\ code is available at +%should be located in \texttt{texmf/doc/latex/glossaries/samples/}. +%Further information on debugging \LaTeX\ code is available at %\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/}. % -%There is a list of frequently asked questions for the -%\sty{glossaries} package available at -%\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}. +%Below is a list of the most frequently asked questions. For +%other queries, consult the \sty{glossaries} FAQ at +%\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}. +% +%\begin{enumerate} +%\item I've used the \pkgopt{smallcaps} option, but the acronyms +%are displayed in normal sized upper case letters. +% +%The \pkgopt{smallcaps} package option uses \cs{textsc} to typeset +%the acronyms. This command converts lower case letters to small +%capitals, while upper case letters remain their usual size. Therefore +%you need to specify the acronym in lower case letters. +% +%\item How do I change the font that the acronyms are displayed in? +% +%The easiest way to do this is to specify the \pkgopt{smaller} package +%option and redefine \cs{acronymfont} to use the required typesetting +%command. For example, suppose you would like the acronyms displayed in +%a sans-serif font, then you can do: +%\begin{verbatim} +%\usepackage[smaller]{glossaries} +%\renewcommand*{\acronymfont}[1]{\textsf{#1}} +%\end{verbatim} +% +%\item How do I change the font that the acronyms are displayed in +%on first use? +% +%The easiest way to do this is to specify the \pkgopt{smaller} package +%option and redefine \cs{firstacronymfont} to use the required +%command. Note that if you don't want the acronym on subsequent use +%to use \cs{smaller}, you will also need to redefine \cs{acronymfont}, +%as above. For example to make the acronym emphasized on first use, +%but use the surrounding font for subsequent use, you can do: +%\begin{verbatim} +%\usepackage[smaller]{glossaries} +%\renewcommand*{\firstacronymfont}[1]{\emph{#1}} +%\renewcommand*{\acronymfont}[1]{#1} +%\end{verbatim} +% +%\item I don't have Perl installed, do I have to use +%\appname{makeglossaries}? +% +%Read \autoref{sec:makeglossaries}. +% +% +%\item I'm used to using the \sty{glossary} package: are there any +%instructions on migrating from the \isty{glossary} package to the +%\sty{glossaries} package? +% +%Read the file \texttt{glossary2glossaries.pdf} which should be available from the +%same location as this document. +% +%\item I'm using \isty{babel} but the fixed names haven't been +%translated. +% +%The \sty{glossaries} package currently only supports the following +%languages: Danish, Dutch, English, French, German, Irish, Italian, +%Hungarian, Polish and Spanish. If you want to add another language, +%send me the translations, and I'll add them to the next version. +% +%If you are using one of the above languages, but the text hasn't been +%translated, try adding the \isty{translator} package with the +%required languages explicitly (before you load the \sty{glossaries} +%package). For example: +%\begin{verbatim} +%\usepackage[ngerman]{babel} +%\usepackage[ngerman]{translator} +%\usepackage{glossaries} +%\end{verbatim} +%Alternatively, you may be able to add the language as a global option +%to the class file. Check the \sty{translator} package documentation for +%further details. +% +%\item My glossaries haven't appeared. +% +%Remember to do the following: +%\begin{itemize} +%\item Add \ics{makeglossaries} to the document preamble. +% +%\item Use either \ics{printglossary} for each glossary that has +%been defined or \ics{printglossaries}. +% +%\item Use \ics{gls}, \ics{Gls}, \ics{GLS}, \ics{glspl}, \ics{Glspl}, +%\ics{GLSpl}, \ics{glslink}, \ics{glsadd} or \ics{glsaddall} in the +%document. +% +%\item Run \LaTeX\ on your document, then run \appname{makeglossaries}, +%then run \LaTeX\ on your document again. If you want the glossaries +%to appear in the table of contents, you will need an extra \LaTeX\ +%run. +%\end{itemize} +%\end{enumerate} +% %\section{A Quick Guide For The Impatient} %\label{sec:quick} % @@ -568,7 +680,7 @@ % %\item Entries can be added to the glossary without producing %any text using \ics{glsadd}\marg{label} or -%\ics{glsaddall}. These commands also taken an optional +%\ics{glsaddall}. These commands also take an optional %argument where you can specify the format. For example %\begin{verbatim} %\glsadd[format=hyperbf]{singmtx} @@ -682,6 +794,7 @@ % \changes{1.02}{2007 May 25}{added overview section} % %\subsection{Package Options} +%\label{sec:pkgopts} % %The \sty{glossaries} package options are as follows: %\begin{description} @@ -751,6 +864,23 @@ %The list of acronyms is in section~\ref{\acronymtype}. %\end{verbatim} % +%As from version 1.14, you can add a prefix to the label by +%redefining \DescribeMacro{\glsautoprefix}\cs{glsautoprefix}. +%For example: +%\begin{verbatim} +%\renewcommand*{\glsautoprefix}{glo:} +%\end{verbatim} +%will add \texttt{glo:} to the automatically generated label, so +%you can then, for example, refer to the list of acronyms as follows: +%\begin{verbatim} +%The list of acronyms is in section~\ref{glo:\acronymtype}. +%\end{verbatim} +%Or, if you are undecided on a prefix: +%\begin{verbatim} +%The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}. +%\end{verbatim} +% +% %\item[\pkgopt{style}] This is a \meta{key}=\meta{value} option. Its %value should be the name of the glossary style to use. Predefined %glossary styles are listed in \autoref{sec:styles}. @@ -776,6 +906,7 @@ %symbol=true}]{glossaries} %\end{verbatim} % +%\begin{important}% %\textbf{Note}: this sanitization only applies to the \gloskey{name}, %\gloskey{description} and \gloskey{symbol} keys. It doesn't apply %to any of the other keys (except the \gloskey{sort} key which is @@ -784,6 +915,7 @@ %Since the value of the \gloskey{text} key is obtained from the %\gloskey{name} key, you will still need to protect fragile commands %in the \gloskey{name} key if you don't use the \gloskey{text} key. +%\end{important} % %\item[\pkgopt{description}] This option changes the definition of %\ics{newacronym} to allow a description. See \autoref{sec:acronyms} for further details. @@ -880,6 +1012,7 @@ %from the \gloskey{plural} key, if the \gloskey{first} key is omitted, %or by appending \ics{glspluralsuffix} to the value of the %\gloskey{first} field, if the \gloskey{first} field is present. +% %\textbf{Note:} prior to version 1.13, the default value of %\gloskey{firstplural} was always taken by appending \dq{s} to the %\gloskey{first} key, which meant that you had to specify both @@ -916,22 +1049,7 @@ %\newglossaryentry{elite}{name={{\'e}lite}, %description={select group or class}} %\end{verbatim} -%Similarly, commands such as \cs{ae} and \cs{oe} should either be placed -%inside a group or followed by a space. For example: -%\begin{verbatim} -%\newglossaryentry{oesophagus}{% -%name={{\oe}sophagus}, -%description={canal from mouth to stomach}} -%\end{verbatim} -%The following is also fine: -%\begin{verbatim} -%\newglossaryentry{oesophagus}{% -%name={\oe sophagus}, -%description={canal from mouth to stomach}} -%\end{verbatim} -%but don't do \verb|\oe{}sophagus| as it will confuse -%\ics{makefirstuc} (described -%in \autoref{sec:mfirstuc}) and will produce \oe{}Sophagus instead of {\OE}sophagus. +% % %\subsubsection{Plurals} %You may have noticed from above that you can specify the plural form @@ -1485,7 +1603,19 @@ % %\item[{\gloskey[printglossary]{style}}] This specifies which %glossary style to use for this glossary, overriding the effect -%of the \pkgopt{style} option or \ics{glossarystyle}. +%of the \pkgopt{style} package option or \ics{glossarystyle}. +% +%\item[{\gloskey[printglossary]{numberedsection}}] This specifies +%whether to use a numbered section for this glossary, overriding +%the effect of the \pkgopt{numberedsection} package option. This +%key has the same syntax as the \pkgopt{numberedsection} package +%option, described in \autoref{sec:pkgopts}. +%\item[{\gloskey[printglossary]{nonumberlist}}] Unlike the package option +%of the same name, this key is a boolean key. If true (\verb|nonumberlist=true|) the numberlist +%is suppressed for this glossary. If false (\verb|nonumberlist=false|) the numberlist is +%displayed for this glossary. If no value is supplied, true is +%assumed. +% %\end{description} % %\DescribeMacro{\glossarypreamble} @@ -1598,11 +1728,12 @@ %\texttt{acronym}, otherwise it will be \texttt{main}. The acronyms can %then be used in exactly the same way as any other glossary entry. % -%(\textbf{Note:} since \cs{newacronym} sets \verb|type=\acronymtype|, +%\begin{important}% +%\textbf{Note:} since \cs{newacronym} sets \verb|type=\acronymtype|, %if you want to load a file containing acronym definitions using %\cs{loadglsentries}\oarg{type}\marg{filename}, the optional argument %\meta{type} will not have an effect unless you explicitly set the -%type as \verb|type=\glsdefaulttype|. See \autoref{sec:loadglsentries}.) +%type as \verb|type=\glsdefaulttype|. See \autoref{sec:loadglsentries}.\end{important} % %For example, the following defines the acronym IDN: %\begin{verbatim} @@ -1635,18 +1766,33 @@ % % %\Tableref{tab:acronymsettings} lists the package options and how the -%\ics{newglossaryentry} keys are used to store \meta{long} (the long -%form) and \meta{abbrv} (the short form). Note that the -%\pkgopt{smallcaps} option redefines \ics{acronymfont} so that it sets -%its argument using \cs{textsc} (so you should use lower case characters -%in \meta{abbrv}) and the \pkgopt{smaller} option redefines -%\cs{acronymfont} to use \cs{smaller}\footnote{\cs{smaller} is defined -%in the \sty{relsize} package.}, otherwise \cs{acronymfont} simply -%displays its argument in the surrounding font. Note also that if none -%of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, -%\pkgopt{dua}, \pkgopt{description} or \pkgopt{footnote} are used, -%\cs{acronymfont} is not used, so changing the definition of -%\cs{acronymfont} will have no effect under such circumstances. +%\ics{newglossaryentry} keys are used to store \meta{long} (the long +%form) and \meta{abbrv} (the short form). Note that the +%\pkgopt{smallcaps} option redefines +%\DescribeMacro{\acronymfont}\cs{acronymfont} so that it sets its +%argument using \cs{textsc} (so you should use lower case characters in +%\meta{abbrv}) and the \pkgopt{smaller} option redefines +%\cs{acronymfont} to use \cs{smaller},\footnote{you will need to load a +%package, such as \sty{relsize}, that defines \cs{smaller} if you use +%this option.} otherwise \cs{acronymfont} simply displays its argument +%in the surrounding font. Note also that if none of the package options +%\pkgopt{smallcaps}, \pkgopt{smaller}, \pkgopt{dua}, +%\pkgopt{description} or \pkgopt{footnote} are used, \cs{acronymfont} is +%not used, so changing the definition of \cs{acronymfont} will have no +%effect under such circumstances. +% +%If you want to display the acronym in another font, for example, +%emphasized, then use the \pkgopt{smaller} package option and +%redefine \ics{acronymfont} to use the required font. For example: +%\begin{verbatim} +%\usepackage[smaller]{glossaries} +%\renewcommand*{\acronymfont}[1]{\emph{#1}} +%\end{verbatim} +%Where \cs{acronymfont} is available, +%\DescribeMacro{\firstacronymfont}\cs{firstacronymfont} is also +%available. By default, this simply uses \cs{acronymfont}, but it +%can be redefined to change the way the acronym is displayed on +%first use. % %\begin{table}[htbp] %\caption{Package options governing \cs{newacronym} and how the @@ -1733,7 +1879,7 @@ %\begin{description} %\item[\pkgopt{description},\pkgopt{footnote}]\mbox{}\par When these two package options are used together, the first use displays %the entry as:\\[10pt] -%\cs{acronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} +%\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} %\\[10pt] %while subsequent use displays the entry as:\\[10pt] %\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] @@ -1747,7 +1893,7 @@ %\ipkgopt[description]{sanitize}\ipkgopt[symbol]{sanitize}\verb|sanitize={description=false,symbol=false}|, so %remember to protect fragile commands when defining acronyms. % -%\item[dua]\mbox{}\par The \pkgopt{dua} package option always displays the expanded +%\item[\pkgopt{dua}]\mbox{}\par The \pkgopt{dua} package option always displays the expanded %form and so may not be used with \pkgopt{footnote}, \pkgopt{smaller} or %\pkgopt{smallcaps}. Both first use and subsequent use displays the %entry in the form:\\[10pt] @@ -1758,7 +1904,7 @@ %\gloskey{description} key is set to the long form. % %\item[\pkgopt{description}]\mbox{}\par This package option displays the entry on first use as:\\[10pt] -%\meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt] +%\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] %while subsequent use displays the entry as:\\[10pt] %\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] %Note also that if this package option is used, the \sty{glossaries} @@ -1767,7 +1913,7 @@ %remember to protect fragile commands when defining acronyms. % %\item[\pkgopt{footnote}]\mbox{}\par This package option displays the entry on first use as:\\[10pt] -%\cs{acronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}\\[10pt] +%\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}\\[10pt] %while subsequent use displays the entry as:\\[10pt] %\cs{acronymfont}\marg{abbrv}\meta{insert} % @@ -1778,7 +1924,7 @@ % %\item[\pkgopt{smallcaps}]\mbox{}\par If neither the \pkgopt{footnote} nor \pkgopt{description} options %have been set, this option displays the entry on first use as:\\[10pt] -%\meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt] +%\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] %while subsequent use displays the entry as:\\[10pt] %\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] %where \cs{acronymfont} is set to \verb|\textsc{#1}|, so \meta{abbrv} @@ -1791,11 +1937,14 @@ % %\item[\pkgopt{smaller}]\mbox{}\par If neither the \pkgopt{footnote} nor \pkgopt{description} options %have been set, this option displays the entry on first use as:\\[10pt] -%\meta{long}\meta{insert} (\cs{acronymfont}\marg{abbrv})\\[10pt] +%\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt] %while subsequent use displays the entry as:\\[10pt] %\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] %where \cs{acronymfont} is set to \verb|{\smaller #1}|. % +%Remember to load a package that defines \ics{smaller} (such as +%\isty{relsize}) if you want to use this option. +% %Note also that if this package option is used, the \sty{glossaries} %package additionally implements the option %\ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so @@ -1806,7 +1955,6 @@ %then on first use the entry is displayed as:\\[10pt] %\meta{long} (\meta{abbrv})\meta{insert}\\[10pt] %while subsequent use displays the entry as:\\[10pt] -%\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt] %\meta{abbrv}\meta{insert} %\end{description} % @@ -1927,7 +2075,22 @@ % %\item[listhypergroup] The \glostyle{listhypergroup} style is like %\glostyle{listgroup} but has a set of links to the glossary -%groups. +%groups. The start of the glossary has a navigation panel to +%each group that is present in the glossary. This requires an +%additional run through \LaTeX\ to ensure the group information +%is up-to-date. In the navigation panel, each group is separated +%by \DescribeMacro{\glshypernavsep}\cs{glshypernavsep} which +%defaults to a vertical bar with a space on either side. For example, +%to simply have a space separating each group, do: +%\begin{verbatim} +%\renewcommand*{\glshypernavsep}{\space} +%\end{verbatim} +% +%Note that the hyper-navigation panel is now (as from version 1.14) +%set inside the optional argument to \cs{item} instead of after it +%to prevent a spurious space at the start. This can be changed +%by redefining \ics{glossaryheader}, but note that this needs to +%be done \emph{after} the glossary style has been set. % %\item[altlist] The \glostyle{altlist} style is like \glostyle{list} %but the description is placed on the following line. @@ -1937,7 +2100,8 @@ % %\item[altlisthypergroup] The \glostyle{altlisthypergroup} style is like %\glostyle{altlistgroup} but has a set of links to the glossary -%groups. +%groups. The navigation panel is the same as that for +%\glostyle{listhypergroup}, described above. % %\item[listdotted] This style uses the \envname{description} %environment. Each entry starts with \verb|\item[]|, followed by the @@ -2048,6 +2212,28 @@ %argument to \ics{printglossary} or using the command:\\[10pt] %\DescribeMacro{\glossarystyle}\cs{glossarystyle}\marg{style-name}\\[10pt] % +%Note that if you use the \gloskey[printglossary]{style} key in the +%optional argument to \ics{printglossary}, it will override any +%previous style settings for the given glossary, so if, for example, +%you do: +%\begin{verbatim} +%\renewcommand*{\glsgroupskip}{} +%\printglossary[style=long] +%\end{verbatim} +%The new definition of \ics{glsgroupskip} will not have an affect +%for this glossary, as \cs{glsgroupskip} is redefined by +%\verb|style=long|. Likewise, \ics{glossarystyle} will also +%override any previous style definitions, so, again: +%\begin{verbatim} +%\renewcommand*{\glsgroupskip}{} +%\glossarystyle{long} +%\end{verbatim} +%will reset \cs{glsgroupskip} back to its default definition for the +%named glossary style (\dq{long} in this case). If you want to +%modify the styles, either use \ics{newglossarystyle} (described +%in the next section) or make the modifications after +%\ics{glossarystyle}. +% % \changes{1.03}{2007 July 4}{'glspostdescription added} %All the styles except for the three- and four-column styles and the %\glostyle{listdotted} style use the command @@ -2231,7 +2417,7 @@ %\cs{makefirstuc}\marg{stuff}\\[10pt] %which makes the first object of %\meta{stuff} uppercase unless \meta{stuff} starts with a control -%sequence followed by a group, in which case the first +%sequence followed by a non-empty group, in which case the first %object in the group is converted to uppercase. Examples: %\begin{itemize} %\item \verb|\makefirstuc{abc}| produces Abc @@ -2247,9 +2433,13 @@ %\item \verb|\makefirstuc{{\ae}bc}| produces {\AE}bc %\end{itemize} % -%Note however that \verb|\makefirstuc{\ae{}bc}| produces \ae Bc since -%the empty group following \cs{ae} is considered to be the argument -%of \cs{ae} which is in fact not the case. +%\begin{important} +%In version 1.02 of \sty{mfirstuc}, a bug fix resulted in a change +%in output if the first object is a control sequence followed by +%an empty group. Prior to version 1.02, \verb|\makefirstuc{\ae{}bc}| +%produced \ae Bc. However as from version 1.02, it now produces +%\AE bc. +%\end{important} % %Note also that %\begin{verbatim} @@ -2273,6 +2463,17 @@ %\end{verbatim} %produces: Abc. % +%If you want to use an alternative command to convert to uppercase, +%for example \cs{MakeTextUppercase}\footnote{defined in the +%\sty{textcase} package}, you can redefine the internal +%command \cs{@gls@makefirstuc}. For example: +%\begin{verbatim} +%\renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1} +%\end{verbatim} +%(Remember that command names that contain the @ character must +%either be placed in packages or be placed between \cs{makeatletter} +%\cs{makeatother}.) +% % % \StopEventually{\clearpage\phantomsection\addcontentsline{toc}{section}{Index}\PrintIndex} % @@ -2290,7 +2491,7 @@ % This package requires \LaTeXe. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2008/05/10 v1.13 (NLCT)] +\ProvidesPackage{glossaries}[2008/06/17 v1.14 (NLCT)] % \end{macrocode} % Required packages: % \begin{macrocode} @@ -2307,7 +2508,8 @@ % Need to use \cs{new@ifnextchar} instead of \cs{@ifnextchar} in % commands that have a final optional argument (such as \ics{gls}) % so require \isty{amsgen}. -% Thanks to Morten~H{\o}gholm for suggesting this. +% Thanks to Morten~H{\o}gholm for suggesting this. (This has +% replaced using the \sty{xspace} package.) % \begin{macrocode} \RequirePackage{amsgen} % \end{macrocode} @@ -2360,6 +2562,13 @@ subsection,subsubsection,paragraph,subparagraph}[section]{% \newcommand*{\@@glossaryseclabel}{} % \end{macrocode} %\end{macro} +%\begin{macro}{\glsautoprefix} +% Prefix to add before label if automatically generated: +%\changes{1.14}{2008 June 17}{new} +% \begin{macrocode} +\newcommand*{\glsautoprefix}{} +% \end{macrocode} +%\end{macro} % \begin{macrocode} \define@choicekey{glossaries.sty}{numberedsection}[\val\nr]{% false,nolabel,autolabel}[nolabel]{% @@ -2371,7 +2580,7 @@ false,nolabel,autolabel}[nolabel]{% \renewcommand*{\@@glossaryseclabel}{}% \or \renewcommand*{\@@glossarysecstar}{}% - \renewcommand*{\@@glossaryseclabel}{\label{\@glo@type}}% + \renewcommand*{\@@glossaryseclabel}{\label{\glsautoprefix\@glo@type}}% \fi} % \end{macrocode} % @@ -5900,8 +6109,8 @@ to move \string\makeglossaries\space after all your \def\glossarytitle{\csname @glotype@\@glo@type @title\endcsname}% \def\glossarytoctitle{\glossarytitle}% \def\@glossarystyle{}% -\setkeys{printgloss}{#1}% \bgroup +\setkeys{printgloss}{#1}% \@glossarystyle \makeatletter \@input@{\jobname.\csname @glotype@\@glo@type @in\endcsname}% @@ -5951,6 +6160,34 @@ to move \string\makeglossaries\space after all your style `#1' undefined}{}}{% \def\@glossarystyle{\csname @glsstyle@#1\endcsname}}} % \end{macrocode} +% \changes{1.14}{2008 June 17}{added numberedsection key to 'printglossary} +% The \gloskey[printglossary]{numberedsection} key determines if this +% glossary should be in a numbered section. +% \begin{macrocode} +\define@choicekey{printgloss}{numberedsection}[\val\nr]{% +false,nolabel,autolabel}[nolabel]{% +\ifcase\nr\relax + \renewcommand*{\@@glossarysecstar}{*}% + \renewcommand*{\@@glossaryseclabel}{}% +\or + \renewcommand*{\@@glossarysecstar}{}% + \renewcommand*{\@@glossaryseclabel}{}% +\or + \renewcommand*{\@@glossarysecstar}{}% + \renewcommand*{\@@glossaryseclabel}{\label{\glsautoprefix\@glo@type}}% +\fi} +% \end{macrocode} +% \changes{1.14}{2008 June 17}{added nonumberlist key to 'printglossary} +% The \gloskey[printglossary]{nonumberlist} key determines if this +% glossary should have a number list. +% \begin{macrocode} +\define@boolkey{printgloss}[gls]{nonumberlist}[true]{% +\ifglsnonumberlist + \def\glossaryentrynumbers##1{}% +\else + \def\glossaryentrynumbers##1{##1}% +\fi} +% \end{macrocode} % %\DescribeEnv{theglossary} % If the \envname{theglossary} environment has @@ -6504,6 +6741,13 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \newcommand{\acronymfont}[1]{#1} % \end{macrocode} %\end{macro} +%\begin{macro}{\firstacronymfont} +%This is only used with the additional acronym styles: +%\changes{1.14}{2008 June 17}{new} +% \begin{macrocode} +\newcommand{\firstacronymfont}[1]{\acronymfont{#1}} +% \end{macrocode} +%\end{macro} % \begin{macrocode} \ifglsacrdescription % \end{macrocode} @@ -6581,7 +6825,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % and 'glslink} % \begin{macrocode} \defglsdisplayfirst[\acronymtype]{% - \acronymfont{#1}#4\noexpand\protect\noexpand\footnote{% + \firstacronymfont{#1}#4\noexpand\protect\noexpand\footnote{% \noexpand\protect\noexpand\glslink [\@gls@link@opts]{\@gls@link@label}{#3}}}% \defglsdisplay[\acronymtype]{\acronymfont{#1}#4}% @@ -6624,8 +6868,6 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \newglossaryentry{#2}{type=\acronymtype,% name={\acronymfont#4},% sort={#4}, - first={#4},% - firstplural={#4\acrpluralsuffix},% text={#4},% plural={#4\acrpluralsuffix},% symbol={#3},% @@ -6691,6 +6933,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \defglsdisplay[\acronymtype]{#1#4} \else % \end{macrocode} +% (dua is not set.) % Store long form in \gloskey{first} key % and short form in \gloskey{text} and \gloskey{symbol} key. % \begin{macrocode} @@ -6702,8 +6945,8 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% firstplural={#4\acrpluralsuffix},% text={#3},% plural={#3\acrpluralsuffix},% - symbol={#3},% - symbolplural={#3\acrpluralsuffix},% + symbol={\@glo@text},% + symbolplural={\@glo@plural},% #1}} % \end{macrocode} % Set up the commands to make a note of the keys to store the long @@ -6758,7 +7001,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % \end{macrocode} % Set display. % \begin{macrocode} - \defglsdisplayfirst[\acronymtype]{#1#4 (\acronymfont{#3})} + \defglsdisplayfirst[\acronymtype]{#1#4 (\firstacronymfont{#3})} \defglsdisplay[\acronymtype]{\acronymfont{#1}#4} % \end{macrocode} % Redefine \ics{acronymfont} if small caps required. The plural suffix @@ -6811,7 +7054,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % 'glslink} % \begin{macrocode} \defglsdisplayfirst[\acronymtype]{% - \acronymfont{#1}#4\noexpand\protect\noexpand\footnote{% + \firstacronymfont{#1}#4\noexpand\protect\noexpand\footnote{% \noexpand\protect\noexpand\glslink [\@gls@link@opts]{\@gls@link@label}{#2}}}% \defglsdisplay[\acronymtype]{\acronymfont{#1}#4}% @@ -6893,12 +7136,12 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \newglossaryentry{#2}{type=\acronymtype,% name={\acronymfont{#3}},% sort={#3},% - text={#3},% - plural={#3\acrpluralsuffix},% + text={\@glo@symbol},% + plural={\@glo@symbolplural},% first={#4},% firstplural={#4\acrpluralsuffix},% - description={#4},% - descriptionplural={#4\acrpluralsuffix},% + description={\@glo@first},% + descriptionplural={\@glo@firstplural},% symbol={#3},% symbolplural={#3\acrpluralsuffix},% #1}} @@ -6913,7 +7156,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % \end{macrocode} % Change the display since \gloskey{first} only contains long form. % \begin{macrocode} - \defglsdisplayfirst[\acronymtype]{#1#4 (\acronymfont{#3})} + \defglsdisplayfirst[\acronymtype]{#1#4 (\firstacronymfont{#3})} \defglsdisplay[\acronymtype]{\acronymfont{#1}#4} % \end{macrocode} % Redefine \ics{acronymfont} if small caps required. The plural suffix @@ -6989,10 +7232,9 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \renewcommand{\newacronym}[4][]{% \newglossaryentry{#2}{type=\acronymtype,% name={#3},% - description={#4},% - descriptionplural={#4\acrpluralsuffix},% text={#4},% plural={#4\acrpluralsuffix},% + description={#4},% symbol={#3},% symbolplural={#3\acrpluralsuffix},% #1}} @@ -7189,14 +7431,15 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %\label{sec:code:mfirstuc} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{mfirstuc}[2008/05/13 v1.01 (NLCT)] +\ProvidesPackage{mfirstuc}[2008/06/18 v1.02 (NLCT)] % \end{macrocode} %\begin{macro}{\makefirstuc} % Syntax:\\ % \cs{makefirstuc}\marg{text}\\ % Makes the first letter uppercase, but will % skip initial control sequences if they are followed by a group -% and make the first thing in the group uppercase. +% and make the first thing in the group uppercase, unless the group +% is empty. % Thus \verb|\makefirstuc{abc}| will produce: Abc, % \verb|\makefirstuc{\ae bc}| will produce: \AE bc, but % \verb|\makefirstuc{\emph{abc}}| will produce \emph{Abc}. @@ -7213,17 +7456,27 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \if@glscs \@gls@getbody #1{}\@nil \ifx\@gls@rest\@empty - \MakeUppercase #1% + \@gls@makefirstuc{#1}% \else - \@gls@body{\expandafter\@gls@makefirstuc\@gls@rest}% + \expandafter\@gls@split\@gls@rest\@nil + \ifx\@gls@first\@empty + \@gls@makefirstuc{#1}% + \else + \@gls@body{\expandafter\@gls@makefirstuc\@gls@first}\@gls@rest% + \fi \fi \else - \MakeUppercase #1% + \@gls@makefirstuc{#1}% \fi \fi } % \end{macrocode} %\end{macro} +% Put first argument in \cs{@gls@first} and second argument in +% \cs{@gls@rest}: +% \begin{macrocode} +\def\@gls@split#1#2\@nil{\def\@gls@first{#1}\def\@gls@rest{#2}} +% \end{macrocode} % \begin{macrocode} \def\@gls@checkcs#1 #2#3\relax{% \def\@gls@argi{#1}\def\@gls@argii{#2}% @@ -7256,6 +7509,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \expandafter\makefirstuc\expandafter{#1}} % \end{macrocode} %\end{macro} +%\section{Glossary Styles} %\iffalse % \begin{macrocode} % @@ -7266,7 +7520,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossary-hypernav.sty> % \end{macrocode} %\fi -% \subsubsection{Glossary hyper-navigation definitions (glossary-hypernav package)} +% \subsection{Glossary hyper-navigation definitions (glossary-hypernav package)} % Package Definition: % \begin{macrocode} \ProvidesPackage{glossary-hypernav}[2007/07/04 v1.01 (NLCT)] @@ -7285,11 +7539,12 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % whose label is given by \meta{label} for the glossary given % by \meta{type}. %\begin{macro}{\glsnavhyperlink} +%\changes{1.14}{2008 June 17}{changed 'edef to 'protected@edef} % \begin{macrocode} \@ifundefined{hyperlink}{% \newcommand*{\glsnavhyperlink}[3][]{#3}}{% \newcommand*{\glsnavhyperlink}[3][\@glo@type]{% -\edef\gls@grplabel{#2}\edef\@gls@grptitle{#3}% +\edef\gls@grplabel{#2}\protected@edef\@gls@grptitle{#3}% \hyperlink{glsn:#1@#2}{#3}}} % \end{macrocode} %\end{macro} @@ -7299,14 +7554,39 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % whose label is given by \meta{label} in the glossary given % by \meta{type}. %\begin{macro}{\glsnavhypertarget} +%\changes{1.14}{2008 June 17}{added write to aux file} % \begin{macrocode} \@ifundefined{hypertarget}{% -\newcommand*{\glsnavhypertarget}[3][]{#3}}{% \newcommand*{\glsnavhypertarget}[3][\@glo@type]{% +\protected@write\@auxout{}{\string\@gls@hypergroup{#1}{#2}}% +#3}}{% +\newcommand*{\glsnavhypertarget}[3][\@glo@type]{% +\protected@write\@auxout{}{\string\@gls@hypergroup{#1}{#2}}% \hypertarget{glsn:#1@#2}{#3}}} % \end{macrocode} %\end{macro} % +%\begin{macro}{\@gls@hypergroup} +% This adds to (or creates) the command \cs{@gls@hypergrouplist@}\meta{glossary type} +% which lists all groups for a given glossary, so that +% the navigation bar only contains those groups that are present. +% However it requires at least 2 runs to ensure the information is +% up-to-date. +%\changes{1.14}{2008 June 17}{new} +% \begin{macrocode} +\newcommand*{\@gls@hypergroup}[2]{% +\@ifundefined{@gls@hypergrouplist@#1}{% + \expandafter\xdef\csname @gls@hypergrouplist@#1\endcsname{#2}% +}{% + \expandafter\let\expandafter\@gls@tmp + \csname @gls@hypergrouplist@#1\endcsname + \expandafter\xdef\csname @gls@hypergrouplist@#1\endcsname{% + \@gls@tmp,#2}% +}% +} +% \end{macrocode} +%\end{macro} +% % The \cs{glsnavigation} command displays a simple glossary % group navigation. % The symbol and number elements are defined separately, @@ -7316,42 +7596,34 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % terms, in which case you will get an undefined hyperlink warning. % Now for the whole navigation bit: %\begin{macro}{\glsnavigation} +% \changes{1.14}{2008 June 2008}{changed to only use labels for +% groups that are present} % \begin{macrocode} \newcommand*{\glsnavigation}{% -\glssymbolnav -\glsnavhyperlink{A}{\glsgetgrouptitle{A}} \textbar\ -\glsnavhyperlink{B}{\glsgetgrouptitle{B}} \textbar\ -\glsnavhyperlink{C}{\glsgetgrouptitle{C}} \textbar\ -\glsnavhyperlink{D}{\glsgetgrouptitle{D}} \textbar\ -\glsnavhyperlink{E}{\glsgetgrouptitle{E}} \textbar\ -\glsnavhyperlink{F}{\glsgetgrouptitle{F}} \textbar\ -\glsnavhyperlink{G}{\glsgetgrouptitle{G}} \textbar\ -\glsnavhyperlink{H}{\glsgetgrouptitle{H}} \textbar\ -\glsnavhyperlink{I}{\glsgetgrouptitle{I}} \textbar\ -\glsnavhyperlink{J}{\glsgetgrouptitle{J}} \textbar\ -\glsnavhyperlink{K}{\glsgetgrouptitle{K}} \textbar\ -\glsnavhyperlink{L}{\glsgetgrouptitle{L}} \textbar\ -\glsnavhyperlink{M}{\glsgetgrouptitle{M}} \textbar\ -\glsnavhyperlink{N}{\glsgetgrouptitle{N}} \textbar\ -\glsnavhyperlink{O}{\glsgetgrouptitle{O}} \textbar\ -\glsnavhyperlink{P}{\glsgetgrouptitle{P}} \textbar\ -\glsnavhyperlink{Q}{\glsgetgrouptitle{Q}} \textbar\ -\glsnavhyperlink{R}{\glsgetgrouptitle{R}} \textbar\ -\glsnavhyperlink{S}{\glsgetgrouptitle{S}} \textbar\ -\glsnavhyperlink{T}{\glsgetgrouptitle{T}} \textbar\ -\glsnavhyperlink{U}{\glsgetgrouptitle{U}} \textbar\ -\glsnavhyperlink{V}{\glsgetgrouptitle{V}} \textbar\ -\glsnavhyperlink{W}{\glsgetgrouptitle{W}} \textbar\ -\glsnavhyperlink{X}{\glsgetgrouptitle{X}} \textbar\ -\glsnavhyperlink{Y}{\glsgetgrouptitle{Y}} \textbar\ -\glsnavhyperlink{Z}{\glsgetgrouptitle{Z}}} +\def\@gls@between{}% +\@ifundefined{@gls@hypergrouplist@\@glo@type}{% + \def\@gls@list{}% +}{% + \expandafter\let\expandafter\@gls@list + \csname @gls@hypergrouplist@\@glo@type\endcsname +}% +\@for\@gls@tmp:=\@gls@list\do{% + \@gls@between + \glsnavhyperlink{\@gls@tmp}{\glsgetgrouptitle{\@gls@tmp}}% + \let\@gls@between\glshypernavsep% +}% +} +% \end{macrocode} +%\end{macro} +%\begin{macro}{\glshypernavsep} +% Separator for the hyper navigation bar. +% \begin{macrocode} +\newcommand*{\glshypernavsep}{\space\textbar\space} % \end{macrocode} %\end{macro} % The \cs{glssymbolnav} produces a simple navigation set of -% links for just the symbol and number groups. This is used at -% the start of \cs{glsnavigation}. If your glossary doesn't -% contain any symbol or navigation groups, you can redefine this -% command to do nothing. +% links for just the symbol and number groups. This used to be used at +% the start of \cs{glsnavigation}. This command is no longer needed. %\begin{macro}{\glssymbolnav} % \begin{macrocode} \newcommand*{\glssymbolnav}{% @@ -7370,7 +7642,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossary-list.sty> % \end{macrocode} %\fi -% \subsubsection{List Style (glossary-list package)} +% \subsection{List Style (glossary-list package)} % The \isty{glossary-list} package defines glossary styles % that use the \envname{description} environment. Note that since % the entry name is placed in the optional argument to the @@ -7409,7 +7681,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \newglossarystyle{listhypergroup}{% \glossarystyle{list}% \renewcommand*{\glossaryheader}{% -\item[]\glsnavigation}% +\item[\glsnavigation]}% \renewcommand*{\glsgroupheading}[1]{% \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} % \end{macrocode} @@ -7437,7 +7709,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \newglossarystyle{altlisthypergroup}{% \glossarystyle{altlist}% \renewcommand*{\glossaryheader}{% -\item[]\glsnavigation}% +\item[\glsnavigation]}% \renewcommand*{\glsgroupheading}[1]{% \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} % \end{macrocode} @@ -7470,7 +7742,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossary-long.sty> % \end{macrocode} %\fi -% \subsubsection{Glossary Styles using longtable (the glossary-long +% \subsection{Glossary Styles using longtable (the glossary-long % package)} % The glossary styles defined in the \isty{glossary-long} package % used the \envname{longtable} environment in the glossary. @@ -7637,7 +7909,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossary-super.sty> % \end{macrocode} %\fi -% \subsubsection{Glossary Styles using supertabular environment (glossary-super package)} +% \subsection{Glossary Styles using supertabular environment (glossary-super package)} % The glossary styles defined in the \isty{glossary-super} package % use the \envname{supertabular} environment. % \begin{macrocode} @@ -7807,10 +8079,10 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossaries-babel.sty> % \end{macrocode} %\fi -%\subsection{Multi-Lingual Support} +%\section{Multi-Lingual Support} % Many thanks to everyone who contributed to the translations both % via email and on comp.text.tex. -%\subsubsection{Babel Captions} +%\subsection{Babel Captions} % Define \isty{babel} captions if multi-lingual % support is required, but the \isty{translator} package is not loaded. % \begin{macrocode} @@ -7971,7 +8243,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossaries-dictionary-Danish.dict> % \end{macrocode} %\fi -%\subsubsection{Danish Dictionary} +%\subsection{Danish Dictionary} % This is a dictonary file provided for use with the \isty{translator} % package. % \begin{macrocode} @@ -7998,7 +8270,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossaries-dictionary-Dutch.dict> % \end{macrocode} %\fi -%\subsubsection{Dutch Dictionary} +%\subsection{Dutch Dictionary} % This is a dictonary file provided for use with the \isty{translator} % package. % \begin{macrocode} @@ -8025,7 +8297,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossaries-dictionary-English.dict> % \end{macrocode} %\fi -%\subsubsection{English Dictionary} +%\subsection{English Dictionary} % This is a dictonary file provided for use with the \isty{translator} % package. % \begin{macrocode} @@ -8052,7 +8324,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossaries-dictionary-French.dict> % \end{macrocode} %\fi -%\subsubsection{French Dictionary} +%\subsection{French Dictionary} % This is a dictonary file provided for use with the \isty{translator} % package. % \begin{macrocode} @@ -8079,7 +8351,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossaries-dictionary-German.dict> % \end{macrocode} %\fi -%\subsubsection{German Dictionary} +%\subsection{German Dictionary} % This is a dictonary file provided for use with the \isty{translator} % package. % \begin{macrocode} @@ -8107,7 +8379,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossaries-dictionary-Irish.dict> % \end{macrocode} %\fi -%\subsubsection{Irish Dictionary} +%\subsection{Irish Dictionary} % This is a dictonary file provided for use with the \isty{translator} % package. % \begin{macrocode} @@ -8134,7 +8406,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossaries-dictionary-Italian.dict> % \end{macrocode} %\fi -%\subsubsection{Italian Dictionary} +%\subsection{Italian Dictionary} % This is a dictonary file provided for use with the \isty{translator} % package. % \begin{macrocode} @@ -8161,7 +8433,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossaries-dictionary-Magyar.dict> % \end{macrocode} %\fi -%\subsubsection{Magyar Dictionary} +%\subsection{Magyar Dictionary} % This is a dictonary file provided for use with the \isty{translator} % package. % \begin{macrocode} @@ -8188,7 +8460,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossaries-dictionary-Polish.dict> % \end{macrocode} %\fi -%\subsubsection{Polish Dictionary} +%\subsection{Polish Dictionary} % This is a dictonary file provided for use with the \isty{translator} % package. % \begin{macrocode} @@ -8215,7 +8487,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% %<*glossaries-dictionary-Spanish.dict> % \end{macrocode} %\fi -%\subsubsection{Spanish Dictionary} +%\subsection{Spanish Dictionary} % This is a dictonary file provided for use with the \isty{translator} % package. % \begin{macrocode} @@ -8249,7 +8521,9 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% % desired, and add the relevant package options to % both the class file and the glossaries package. % Change the sample glossary entry and acronym if - % required. + % required. If the problem occurs with an additional + % glossary, add in the relevant \newglossary command + % and a sample entry. % % Only add extra packages or commands if they % contribute to whatever problem you are trying to @@ -8268,17 +8542,23 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \listfiles %\usepackage{glossaries} % acronym will go in main glossary -\usepackage[acronym]{glossaries} % make a separate list of acronyms + \usepackage[acronym]{glossaries} % make a separate list of acronyms \makeglossaries \newglossaryentry{sample}{name={sample}, description={a sample entry}} -\newacronym{aca}{aca}{a contrived acronym} +% This contrived acronym has non-standard plural forms. +% These are specified in the optional argument. +\newacronym[\glsshortpluralkey=cas,\glslongpluralkey=contrived +acronyms]{aca}{aca}{a contrived acronym} \begin{document} -A \gls{sample} entry and \gls{aca}. +A \gls{sample} entry and \gls{aca}. Second use: \gls{aca}. + +Plurals: \glspl{sample}. Reset acronym\glsreset{aca}. +First use: \glspl{aca}. Second use: \glspl{aca}. \printglossaries \end{document} diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.ins b/Master/texmf-dist/source/latex/glossaries/glossaries.ins index 2c36cc2ea3c..7996164767c 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.ins +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.ins @@ -1,4 +1,4 @@ -% glossaries.ins generated using makedtx version 0.94b 2008/5/13 11:33 +% glossaries.ins generated using makedtx version 0.94b 2008/6/18 16:44 \input docstrip \preamble @@ -58,32 +58,19 @@ \usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-Polish.dict,package}} \file{glossaries-dictionary-Spanish.dict}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-dictionary-Spanish.dict,package}} -\file{minimalgls.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{minimalgls.tex,package}} -\file{sample.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{sample.tex,package}} -\file{sample4col.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{sample4col.tex,package}} -\file{sampleAcr.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{sampleAcr.tex,package}} -\file{sampleAcrDesc.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{sampleAcrDesc.tex,package}} -\file{sampleDB.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{sampleDB.tex,package}} -\file{sampleDesc.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{sampleDesc.tex,package}} -\file{sampleEq.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{sampleEq.tex,package}} -\file{sampleEqPg.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{sampleEqPg.tex,package}} -\file{sampleNtn.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{sampleNtn.tex,package}} -\file{sampleSec.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{sampleSec.tex,package}} -\file{database1.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{database1.tex,package}} -\file{database2.tex}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries.dtx}{database2.tex,package}} +\file{minimalgls.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{minimalgls.tex}} +\file{sample.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample.tex}} +\file{sample4col.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sample4col.tex}} +\file{sampleAcr.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleAcr.tex}} +\file{sampleAcrDesc.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleAcrDesc.tex}} +\file{sampleDB.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleDB.tex}} +\file{sampleDesc.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleDesc.tex}} +\file{sampleEq.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleEq.tex}} +\file{sampleEqPg.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleEqPg.tex}} +\file{sampleNtn.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleNtn.tex}} +\file{sampleSec.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{sampleSec.tex}} +\file{database1.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{database1.tex}} +\file{database2.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{database2.tex}} \file{glossaries.perl}{\nopreamble\nopostamble\from{glossaries.dtx}{glossaries.perl}} } diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty index 9eb6e8071f1..c30716a7552 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2008/05/10 v1.13 (NLCT)] +\ProvidesPackage{glossaries}[2008/06/17 v1.14 (NLCT)] \RequirePackage{ifthen} \RequirePackage{xkeyval}[2006/11/18] \RequirePackage{mfirstuc} @@ -55,6 +55,7 @@ subsection,subsubsection,paragraph,subparagraph}[section]{% \renewcommand*{\@@glossarysec}{#1}} \newcommand*{\@@glossarysecstar}{*} \newcommand*{\@@glossaryseclabel}{} +\newcommand*{\glsautoprefix}{} \define@choicekey{glossaries.sty}{numberedsection}[\val\nr]{% false,nolabel,autolabel}[nolabel]{% \ifcase\nr\relax @@ -65,7 +66,7 @@ false,nolabel,autolabel}[nolabel]{% \renewcommand*{\@@glossaryseclabel}{}% \or \renewcommand*{\@@glossarysecstar}{}% - \renewcommand*{\@@glossaryseclabel}{\label{\@glo@type}}% + \renewcommand*{\@@glossaryseclabel}{\label{\glsautoprefix\@glo@type}}% \fi} \newcommand*{\@glossary@default@style}{list} \define@key{glossaries.sty}{style}{% @@ -1263,8 +1264,8 @@ to move \string\makeglossaries\space after all your \def\glossarytitle{\csname @glotype@\@glo@type @title\endcsname}% \def\glossarytoctitle{\glossarytitle}% \def\@glossarystyle{}% -\setkeys{printgloss}{#1}% \bgroup +\setkeys{printgloss}{#1}% \@glossarystyle \makeatletter \@input@{\jobname.\csname @glotype@\@glo@type @in\endcsname}% @@ -1279,6 +1280,24 @@ to move \string\makeglossaries\space after all your \@ifundefined{@glsstyle@#1}{\PackageError{glossaries}{Glossary style `#1' undefined}{}}{% \def\@glossarystyle{\csname @glsstyle@#1\endcsname}}} +\define@choicekey{printgloss}{numberedsection}[\val\nr]{% +false,nolabel,autolabel}[nolabel]{% +\ifcase\nr\relax + \renewcommand*{\@@glossarysecstar}{*}% + \renewcommand*{\@@glossaryseclabel}{}% +\or + \renewcommand*{\@@glossarysecstar}{}% + \renewcommand*{\@@glossaryseclabel}{}% +\or + \renewcommand*{\@@glossarysecstar}{}% + \renewcommand*{\@@glossaryseclabel}{\label{\glsautoprefix\@glo@type}}% +\fi} +\define@boolkey{printgloss}[gls]{nonumberlist}[true]{% +\ifglsnonumberlist + \def\glossaryentrynumbers##1{}% +\else + \def\glossaryentrynumbers##1{##1}% +\fi} \@ifundefined{theglossary}{% \newenvironment{theglossary}{}{}}{% \PackageWarning{glossaries}{overriding `theglossary' environment}% @@ -1424,6 +1443,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \new@ifnextchar[{\@ACRfullpl{#1}{#2}}{\@ACRfullpl{#1}{#2}[]}} \def\@ACRfullpl#1#2[#3]{\@GLSfirstplural@{#1}{#2}[#3]} \newcommand{\acronymfont}[1]{#1} +\newcommand{\firstacronymfont}[1]{\acronymfont{#1}} \ifglsacrdescription \ifglsacrfootnote \renewcommand{\newacronym}[4][]{% @@ -1464,7 +1484,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \def\@ACRfullpl#1#2[#3]{\@GLSsymbolplural@{#1}{#2}[#3] (\acronymfont{\@GLSplural@{#1}{#2}[#3]})} \defglsdisplayfirst[\acronymtype]{% - \acronymfont{#1}#4\noexpand\protect\noexpand\footnote{% + \firstacronymfont{#1}#4\noexpand\protect\noexpand\footnote{% \noexpand\protect\noexpand\glslink [\@gls@link@opts]{\@gls@link@label}{#3}}}% \defglsdisplay[\acronymtype]{\acronymfont{#1}#4}% @@ -1496,8 +1516,6 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \newglossaryentry{#2}{type=\acronymtype,% name={\acronymfont#4},% sort={#4}, - first={#4},% - firstplural={#4\acrpluralsuffix},% text={#4},% plural={#4\acrpluralsuffix},% symbol={#3},% @@ -1545,8 +1563,8 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% firstplural={#4\acrpluralsuffix},% text={#3},% plural={#3\acrpluralsuffix},% - symbol={#3},% - symbolplural={#3\acrpluralsuffix},% + symbol={\@glo@text},% + symbolplural={\@glo@plural},% #1}} \def\glsshortkey{text}% \def\glsshortpluralkey{plural}% @@ -1576,7 +1594,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% (\acronymfont{\@glssymbolplural@{#1}{#2}[#3]})} \def\@ACRfullpl#1#2[#3]{\@GLSfirstplural@{#1}{#2}[#3] (\acronymfont{\@GLSsymbolplural@{#1}{#2}[#3]})} - \defglsdisplayfirst[\acronymtype]{#1#4 (\acronymfont{#3})} + \defglsdisplayfirst[\acronymtype]{#1#4 (\firstacronymfont{#3})} \defglsdisplay[\acronymtype]{\acronymfont{#1}#4} \ifglsacrsmallcaps \renewcommand{\acronymfont}[1]{\textsc{#1}} @@ -1605,7 +1623,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \def\glslongkey{description}% \def\glslongpluralkey{descriptionplural}% \defglsdisplayfirst[\acronymtype]{% - \acronymfont{#1}#4\noexpand\protect\noexpand\footnote{% + \firstacronymfont{#1}#4\noexpand\protect\noexpand\footnote{% \noexpand\protect\noexpand\glslink [\@gls@link@opts]{\@gls@link@label}{#2}}}% \defglsdisplay[\acronymtype]{\acronymfont{#1}#4}% @@ -1652,12 +1670,12 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \newglossaryentry{#2}{type=\acronymtype,% name={\acronymfont{#3}},% sort={#3},% - text={#3},% - plural={#3\acrpluralsuffix},% + text={\@glo@symbol},% + plural={\@glo@symbolplural},% first={#4},% firstplural={#4\acrpluralsuffix},% - description={#4},% - descriptionplural={#4\acrpluralsuffix},% + description={\@glo@first},% + descriptionplural={\@glo@firstplural},% symbol={#3},% symbolplural={#3\acrpluralsuffix},% #1}} @@ -1665,7 +1683,7 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \def\glsshortpluralkey{symbolplural}% \def\glslongkey{first}% \def\glslongpluralkey{firstplural}% - \defglsdisplayfirst[\acronymtype]{#1#4 (\acronymfont{#3})} + \defglsdisplayfirst[\acronymtype]{#1#4 (\firstacronymfont{#3})} \defglsdisplay[\acronymtype]{\acronymfont{#1}#4} \ifglsacrsmallcaps \renewcommand*{\acronymfont}[1]{\textsc{#1}} @@ -1712,10 +1730,9 @@ firstplural={\@glo@descplural\space (\@glo@plural)},% \renewcommand{\newacronym}[4][]{% \newglossaryentry{#2}{type=\acronymtype,% name={#3},% - description={#4},% - descriptionplural={#4\acrpluralsuffix},% text={#4},% plural={#4\acrpluralsuffix},% + description={#4},% symbol={#3},% symbolplural={#3\acrpluralsuffix},% #1}} diff --git a/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty b/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty index fee68259460..10832f723f1 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/mfirstuc.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{mfirstuc}[2008/05/13 v1.01 (NLCT)] +\ProvidesPackage{mfirstuc}[2008/06/18 v1.02 (NLCT)] \newif\if@glscs \def\makefirstuc#1{% \def\gls@argi{#1}% @@ -51,15 +51,21 @@ \if@glscs \@gls@getbody #1{}\@nil \ifx\@gls@rest\@empty - \MakeUppercase #1% + \@gls@makefirstuc{#1}% \else - \@gls@body{\expandafter\@gls@makefirstuc\@gls@rest}% + \expandafter\@gls@split\@gls@rest\@nil + \ifx\@gls@first\@empty + \@gls@makefirstuc{#1}% + \else + \@gls@body{\expandafter\@gls@makefirstuc\@gls@first}\@gls@rest% + \fi \fi \else - \MakeUppercase #1% + \@gls@makefirstuc{#1}% \fi \fi } +\def\@gls@split#1#2\@nil{\def\@gls@first{#1}\def\@gls@rest{#2}} \def\@gls@checkcs#1 #2#3\relax{% \def\@gls@argi{#1}\def\@gls@argii{#2}% \ifx\@gls@argi\@gls@argii diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty index b79b1e8a822..e8d3a4ee331 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty @@ -42,40 +42,40 @@ \@ifundefined{hyperlink}{% \newcommand*{\glsnavhyperlink}[3][]{#3}}{% \newcommand*{\glsnavhyperlink}[3][\@glo@type]{% -\edef\gls@grplabel{#2}\edef\@gls@grptitle{#3}% +\edef\gls@grplabel{#2}\protected@edef\@gls@grptitle{#3}% \hyperlink{glsn:#1@#2}{#3}}} \@ifundefined{hypertarget}{% -\newcommand*{\glsnavhypertarget}[3][]{#3}}{% \newcommand*{\glsnavhypertarget}[3][\@glo@type]{% +\protected@write\@auxout{}{\string\@gls@hypergroup{#1}{#2}}% +#3}}{% +\newcommand*{\glsnavhypertarget}[3][\@glo@type]{% +\protected@write\@auxout{}{\string\@gls@hypergroup{#1}{#2}}% \hypertarget{glsn:#1@#2}{#3}}} +\newcommand*{\@gls@hypergroup}[2]{% +\@ifundefined{@gls@hypergrouplist@#1}{% + \expandafter\xdef\csname @gls@hypergrouplist@#1\endcsname{#2}% +}{% + \expandafter\let\expandafter\@gls@tmp + \csname @gls@hypergrouplist@#1\endcsname + \expandafter\xdef\csname @gls@hypergrouplist@#1\endcsname{% + \@gls@tmp,#2}% +}% +} \newcommand*{\glsnavigation}{% -\glssymbolnav -\glsnavhyperlink{A}{\glsgetgrouptitle{A}} \textbar\ -\glsnavhyperlink{B}{\glsgetgrouptitle{B}} \textbar\ -\glsnavhyperlink{C}{\glsgetgrouptitle{C}} \textbar\ -\glsnavhyperlink{D}{\glsgetgrouptitle{D}} \textbar\ -\glsnavhyperlink{E}{\glsgetgrouptitle{E}} \textbar\ -\glsnavhyperlink{F}{\glsgetgrouptitle{F}} \textbar\ -\glsnavhyperlink{G}{\glsgetgrouptitle{G}} \textbar\ -\glsnavhyperlink{H}{\glsgetgrouptitle{H}} \textbar\ -\glsnavhyperlink{I}{\glsgetgrouptitle{I}} \textbar\ -\glsnavhyperlink{J}{\glsgetgrouptitle{J}} \textbar\ -\glsnavhyperlink{K}{\glsgetgrouptitle{K}} \textbar\ -\glsnavhyperlink{L}{\glsgetgrouptitle{L}} \textbar\ -\glsnavhyperlink{M}{\glsgetgrouptitle{M}} \textbar\ -\glsnavhyperlink{N}{\glsgetgrouptitle{N}} \textbar\ -\glsnavhyperlink{O}{\glsgetgrouptitle{O}} \textbar\ -\glsnavhyperlink{P}{\glsgetgrouptitle{P}} \textbar\ -\glsnavhyperlink{Q}{\glsgetgrouptitle{Q}} \textbar\ -\glsnavhyperlink{R}{\glsgetgrouptitle{R}} \textbar\ -\glsnavhyperlink{S}{\glsgetgrouptitle{S}} \textbar\ -\glsnavhyperlink{T}{\glsgetgrouptitle{T}} \textbar\ -\glsnavhyperlink{U}{\glsgetgrouptitle{U}} \textbar\ -\glsnavhyperlink{V}{\glsgetgrouptitle{V}} \textbar\ -\glsnavhyperlink{W}{\glsgetgrouptitle{W}} \textbar\ -\glsnavhyperlink{X}{\glsgetgrouptitle{X}} \textbar\ -\glsnavhyperlink{Y}{\glsgetgrouptitle{Y}} \textbar\ -\glsnavhyperlink{Z}{\glsgetgrouptitle{Z}}} +\def\@gls@between{}% +\@ifundefined{@gls@hypergrouplist@\@glo@type}{% + \def\@gls@list{}% +}{% + \expandafter\let\expandafter\@gls@list + \csname @gls@hypergrouplist@\@glo@type\endcsname +}% +\@for\@gls@tmp:=\@gls@list\do{% + \@gls@between + \glsnavhyperlink{\@gls@tmp}{\glsgetgrouptitle{\@gls@tmp}}% + \let\@gls@between\glshypernavsep% +}% +} +\newcommand*{\glshypernavsep}{\space\textbar\space} \newcommand*{\glssymbolnav}{% \glsnavhyperlink{glssymbols}{\glsgetgrouptitle{glssymbols}} \textbar\ \glsnavhyperlink{glsnumbers}{\glsgetgrouptitle{glsnumbers}} \textbar\ diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty index db784552c3e..36b24637b95 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty @@ -52,7 +52,7 @@ \newglossarystyle{listhypergroup}{% \glossarystyle{list}% \renewcommand*{\glossaryheader}{% -\item[]\glsnavigation}% +\item[\glsnavigation]}% \renewcommand*{\glsgroupheading}[1]{% \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} \newglossarystyle{altlist}{% @@ -66,7 +66,7 @@ \newglossarystyle{altlisthypergroup}{% \glossarystyle{altlist}% \renewcommand*{\glossaryheader}{% -\item[]\glsnavigation}% +\item[\glsnavigation]}% \renewcommand*{\glsgroupheading}[1]{% \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}} \newlength\glslistdottedwidth -- cgit v1.2.3