From 444dc3f77d9f65e57e4d093cc3c3149d8c0762d2 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 13 Dec 2016 22:25:27 +0000 Subject: glossaries-extra (13dec16) git-svn-id: svn://tug.org/texlive/trunk@42699 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/latex/glossaries-extra/CHANGES | 13 + .../texmf-dist/doc/latex/glossaries-extra/README | 4 +- .../glossaries-extra/glossaries-extra-code.pdf | Bin 688684 -> 702960 bytes .../glossaries-extra/glossaries-extra-manual.html | 12019 ++++++++++--------- .../glossaries-extra/glossaries-extra-manual.pdf | Bin 565793 -> 570872 bytes .../glossaries-extra/glossaries-extra-manual.tex | 86 +- .../doc/latex/glossaries-extra/sample-abbrv.pdf | Bin 43319 -> 43307 bytes .../doc/latex/glossaries-extra/sample-accsupp.pdf | Bin 80757 -> 80745 bytes .../latex/glossaries-extra/sample-acronym-desc.pdf | Bin 50368 -> 50358 bytes .../doc/latex/glossaries-extra/sample-acronym.pdf | Bin 36745 -> 36734 bytes .../latex/glossaries-extra/sample-altmodifier.pdf | Bin 35308 -> 35296 bytes .../glossaries-extra/sample-alttree-marginpar.pdf | Bin 91061 -> 91049 bytes .../latex/glossaries-extra/sample-alttree-sym.pdf | Bin 69532 -> 69519 bytes .../doc/latex/glossaries-extra/sample-alttree.pdf | Bin 54866 -> 54855 bytes .../glossaries-extra/sample-autoindex-hyp.pdf | Bin 142334 -> 142191 bytes .../latex/glossaries-extra/sample-autoindex.pdf | Bin 147413 -> 147208 bytes .../doc/latex/glossaries-extra/sample-crossref.pdf | Bin 40654 -> 40642 bytes .../latex/glossaries-extra/sample-crossref2.pdf | Bin 41319 -> 41305 bytes .../doc/latex/glossaries-extra/sample-docdef.pdf | Bin 45257 -> 45245 bytes .../latex/glossaries-extra/sample-entrycount.pdf | Bin 54623 -> 54610 bytes .../doc/latex/glossaries-extra/sample-footnote.pdf | Bin 63232 -> 63220 bytes .../doc/latex/glossaries-extra/sample-header.pdf | Bin 125199 -> 125189 bytes .../latex/glossaries-extra/sample-indexhook.pdf | Bin 42722 -> 42711 bytes .../latex/glossaries-extra/sample-initialisms.pdf | Bin 81591 -> 81582 bytes .../glossaries-extra/sample-mixed-abbrv-styles.pdf | Bin 57823 -> 57809 bytes .../doc/latex/glossaries-extra/sample-mixture.pdf | Bin 160238 -> 160022 bytes .../latex/glossaries-extra/sample-name-font.pdf | Bin 202102 -> 202090 bytes .../doc/latex/glossaries-extra/sample-nested.pdf | Bin 67736 -> 67724 bytes .../sample-noidx-restricteddocdefs.pdf | Bin 47582 -> 47572 bytes .../doc/latex/glossaries-extra/sample-onelink.pdf | Bin 44527 -> 44514 bytes .../glossaries-extra/sample-onthefly-utf8.pdf | Bin 106071 -> 106058 bytes .../glossaries-extra/sample-onthefly-xetex.pdf | Bin 19862 -> 19862 bytes .../doc/latex/glossaries-extra/sample-onthefly.pdf | Bin 43481 -> 43469 bytes .../doc/latex/glossaries-extra/sample-pages.pdf | Bin 38801 -> 38788 bytes .../doc/latex/glossaries-extra/sample-postdot.pdf | Bin 37063 -> 37051 bytes .../doc/latex/glossaries-extra/sample-postlink.pdf | Bin 67889 -> 67877 bytes .../doc/latex/glossaries-extra/sample-prefix.pdf | Bin 33119 -> 33107 bytes .../doc/latex/glossaries-extra/sample-record.pdf | Bin 0 -> 38102 bytes .../doc/latex/glossaries-extra/sample-record.tex | 19 + .../glossaries-extra/sample-restricteddocdefs.pdf | Bin 47895 -> 47883 bytes .../doc/latex/glossaries-extra/sample-trans.pdf | Bin 49455 -> 49443 bytes .../doc/latex/glossaries-extra/sample-undef.pdf | Bin 33231 -> 33219 bytes .../glossaries-extra/sample-unitentrycount.pdf | Bin 61051 -> 61040 bytes .../doc/latex/glossaries-extra/sample.pdf | Bin 45747 -> 45734 bytes 44 files changed, 6209 insertions(+), 5932 deletions(-) create mode 100644 Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries-extra/sample-record.tex (limited to 'Master/texmf-dist/doc/latex/glossaries-extra') diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES index 8925ba43cd8..33ae329ae2d 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES @@ -1,3 +1,16 @@ +1.08 (2016-12-13): + + * Added record option + + * New commands: + + - \glsxtrresourcefile + - \printunsrtglossary + - \printunsrtglossaries + + * Fixed bug that occurs with undefaction=warn and an + undefined \glslabel in the post-link hook + 1.07 (2016-08-15): * New commands \glsxtrp etc. diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/README b/Master/texmf-dist/doc/latex/glossaries-extra/README index f72617a9199..cb584d9719a 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/README +++ b/Master/texmf-dist/doc/latex/glossaries-extra/README @@ -1,6 +1,6 @@ -LaTeX Package : glossaries-extra v1.07 +LaTeX Package : glossaries-extra v1.08 -Last Modified : 2016-08-15 +Last Modified : 2016-12-13 Author : Nicola Talbot diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-code.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-code.pdf index 0e07c853fe0..5b88d52c3a5 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-code.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-code.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.html b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.html index 8892d5a193e..15def62a7e2 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.html +++ b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.html @@ -16,145 +16,41 @@ /* start css.sty */ .cmmi-10{font-style: italic;} -.ecrm-1728{font-size:170%;} -.ecrm-1200{font-size:120%;} -.ectt-1200{font-size:120%; font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ectt-1200{ font-family: monospace;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecbx-1000{ font-weight: bold;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ecss-1000{ font-family: sans-serif;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ecrm-0900{font-size:90%;} -.ecrm-0800{font-size:80%;} -.ecss-0800{font-size:80%; font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ecss-0800{ font-family: sans-serif;} -.ectt-0900{font-size:90%; font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ectt-0900{ font-family: monospace;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecsx-1000{ font-weight: bold;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} -.ecit-1000{ font-style: italic; font-family: monospace;} +.cmr-17{font-size:170%;} +.cmr-12{font-size:120%;} +.cmr-8{font-size:80%;} +.cmtt-12{font-size:120%;font-family: monospace;} +.cmtt-12{font-family: monospace;} +.cmtt-12{font-family: monospace;} +.cmtt-12{font-family: monospace;} +.cmbx-10{ font-weight: bold;} +.cmss-10{ font-family: sans-serif;} +.cmss-10{ font-family: sans-serif;} +.cmss-10{ font-family: sans-serif;} +.cmss-10{ font-family: sans-serif;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmr-9{font-size:90%;} +.cmss-8{font-size:80%; font-family: sans-serif;} +.cmss-8{ font-family: sans-serif;} +.cmss-8{ font-family: sans-serif;} +.cmss-8{ font-family: sans-serif;} +.cmtt-9{font-size:90%;font-family: monospace;} +.cmtt-9{font-family: monospace;} +.cmtt-9{font-family: monospace;} +.cmtt-9{font-family: monospace;} +.cmti-10{ font-style: italic;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmitt-10{font-family: monospace; font-style: italic;} +.cmssi-10{ font-family: sans-serif; font-style: oblique;} +.cmssi-10{ font-family: sans-serif; font-style: oblique;} +.cmssi-10{ font-family: sans-serif; font-style: oblique;} +.cmssi-10{ font-family: sans-serif; font-style: oblique;} p.noindent { text-indent: 0em } td p.noindent { text-indent: 0em; margin-top:0em; } p.nopar { text-indent: 0em; } @@ -297,24 +193,24 @@ a span.HoLogo-TeX span.HoLogo-e{text-decoration:none;} -

-

+

-

+

-

-

glossaries-extra.sty v1.07: an extension to the +

+

glossaries-extra.sty v1.08: an extension to the glossaries package +class="cmr-17">glossaries package

+class="cmr-12">Nicola L.C. Talbot +class="cmr-12">Dickimaw Books
Nicola L.C. Talbot
 
Dickimaw Books
http://www.dickimaw-books.com/
+class="cmtt-12">http://www.dickimaw-books.com/
-

2016-08-15

+

2016-12-13

-

+

-

-

Abstract

-

The glossaries-extra package is an extension to the glossaries package, providing +

+

Abstract

+

The glossaries-extra package is an extension to the glossaries package, providing additional features. Some of the features provided by this package are only available with glossaries version 4.19 (or above). This document assumes familiarity with the +class="cmss-10">glossaries version 4.19 (or above). This document assumes familiarity with the glossaries package. +class="cmss-10">glossaries package.

-

Since glossaries-extra internally loads the glossaries package, you also need to have +

Since glossaries-extra internally loads the glossaries package, you also need to have glossaries installed and all the packages that glossaries depends on (including, but not +class="cmss-10">glossaries installed and all the packages that glossaries depends on (including, but not limited to, tracklangtracklang, mfirstucmfirstuc, etoolboxetoolbox, xkeyvalxkeyval (at least version dated 2006/11/18), textcasetextcase, xforxfor, datatool-basedatatool-base and amsgenamsgen. These packages are all available in the current TEX Live and MikTEX distribution? or Updating TEX on Linux.)
-

-

Additional resources:

+

+

Additional resources:

@@ -415,7 +311,8 @@ href="http://www.latex-community.org/know-how/latex/55-latex-general/263-glossar

Contents

+ id="x1-1000">Contents +
1 Introduction
 1.1 Style Hooks href="#sec:glosstylenumlist" id="QQ2-1-14">Number List
  2.6.3 The glossaries-extra-stylemods Package +class="cmss-10">glossaries-extra-stylemods Package
3 Abbreviations
 3.1 Glossary -

1.

1. Introduction

-

The glossaries package is a flexible package, but it’s also a heavy-weight package +

The glossaries package is a flexible package, but it’s also a heavy-weight package that uses a lot of resources. As package developer, I’m caught between those users who complain about the drawbacks of a heavy-weight package with a large user manual and those users who want more features (which necessarily adds to the package weight and manual size). -

The glossaries-extra package is an attempt to provide a compromise for this +

The glossaries-extra package is an attempt to provide a compromise for this conflict. Version 4.22 of the glossaries package is the last version to incorporate new +class="cmss-10">glossaries package is the last version to incorporate new features.1.1 Future versions of glossaries will just be bug fixes. New features will instead be added +class="cmss-10">glossaries will just be bug fixes. New features will instead be added to glossaries-extra. This means that the base glossaries package won’t increase in terms +class="cmss-10">glossaries-extra. This means that the base glossaries package won’t increase in terms of package loading time and allocation of resources, but those users who do want extra features available will have more of a chance of getting their feature requests accepted.

-

Top

1.1 Package Defaults

-

I’m not happy with some of the default settings assumed by the glossaries package, +

I’m not happy with some of the default settings assumed by the glossaries package, and, judging from code I’ve seen, other users also seem unhappy with them, as certain package options are often used in questions posted on various sites. I can’t change the default behaviour of glossaries as it would break backward compatibility, +class="cmss-10">glossaries as it would break backward compatibility, but since glossaries-extra is a separate package, I have decided to implement some of +class="cmss-10">glossaries-extra is a separate package, I have decided to implement some of these commonly-used options by default. You can switch them back if they’re not appropriate. -

The new defaults are:

+

The new defaults are:

  • toc=truetoc=true (add the glossaries to the table of contents). Use toc=falsetoc=false to switch this back off.
  • nopostdot=truenopostdot=true (suppress the terminating full stop after the description in the glossary). Use nopostdot=falsenopostdot=false to restore the terminating full stop (period).
  • noredefwarn=truenoredefwarn=true (suppress the warnings that occur when the theglossarytheglossary environment and \printglossary are redefined while glossaries is +class="cmtt-10">\printglossary are redefined while glossaries is loading). To restore the warnings, use noredefwarn=falsenoredefwarn=false. Note that this won’t have any effect if the glossaries package has already been loaded +class="cmss-10">glossaries package has already been loaded before you use the glossaries-extra package. +class="cmss-10">glossaries-extra package.
  • If babelbabel has been loaded, the translate=babeltranslate=babel option is switched on. To revert to using the translatortranslator interface, use translate=truetranslate=true. There is no change to the default if babelbabel hasn’t been loaded.
-

The examples below illustrate the difference in explicit package options between +

The examples below illustrate the difference in explicit package options between glossaries and glossaries-extra. There may be other differences resulting from +class="cmss-10">glossaries and glossaries-extra. There may be other differences resulting from modifications to commands provided by glossaries (see §2 glossaries (see §2 Modifications to Existing Commands and Styles). -

+

  1. @@ -593,7 +491,7 @@ Commands and Styles). \documentclass{article}  
    \usepackage{glossaries-extra}
-

This is like: +

This is like: @@ -603,7 +501,7 @@ Commands and Styles).  
\usepackage[toc,nopostdot]{glossaries}  
\usepackage{glossaries-extra}

-

+

  • @@ -615,7 +513,7 @@ Commands and Styles).  
    \usepackage{babel}  
    \usepackage{glossaries-extra}
  • -

    This is like: +

    This is like: @@ -626,7 +524,7 @@ Commands and Styles).  
    \usepackage[toc,nopostdot,translate=babel]{glossaries}  
    \usepackage{glossaries-extra}

    -

    +

  • @@ -637,7 +535,7 @@ Commands and Styles). \documentclass{memoir}  
    \usepackage{glossaries-extra}
  • -

    This is like: +

    This is like: @@ -647,8 +545,8 @@ Commands and Styles).  
    \usepackage[toc,nopostdot,noredefwarn]{glossaries}  
    \usepackage{glossaries-extra} -

    However +

    However @@ -658,7 +556,7 @@ class="ecti-1000">However  
    \usepackage{glossaries}  
    \usepackage{glossaries-extra} -

    This is like: +

    This is like: @@ -668,31 +566,31 @@ class="ecti-1000">However  
    \usepackage[toc,nopostdot]{glossaries}  
    \usepackage{glossaries-extra} -

    Since by the time glossaries-extra has been loaded, glossaries has already +

    Since by the time glossaries-extra has been loaded, glossaries has already redefined memoirmemoir’s glossary-related commands.

    -

    Another noticeable change is that by default \printglossary will now display +

    Another noticeable change is that by default \printglossary will now display information text in the document if the external glossary file doesn’t exist. This is explanatory text to help new users who can’t work out what to do next to complete the document build. Once the document is set up correctly and the external files have been generated, this text will disappear. -

    This change is mostly likely to be noticed by users with one or more +

    This change is mostly likely to be noticed by users with one or more redundant empty glossaries who ignore transcript messages, explicitly use makeindex/makeindex/xindy on just the non-empty glossary (or glossaries) and use the iterative +class="cmtt-10">xindy on just the non-empty glossary (or glossaries) and use the iterative \printglossaries\printglossaries command instead of \printglossary\printglossary. For example, consider the following: @@ -710,35 +608,35 @@ following:  
    \printglossaries  
    \end{document} -

    The above document will only display the list of acronyms at the place where +

    The above document will only display the list of acronyms at the place where \printglossaries\printglossaries occurs. However it will also attempt to input the .gls file +class="cmtt-10">.gls file associated with the main glossary. -

    If you use main glossary. +

    If you use makeglossaries, you’ll get the warning message: +class="cmtt-10">makeglossaries, you’ll get the warning message:

    -Warning: File ’test.glo’ is empty. - 
    Have you used any entries defined in glossary ’main’? - 
    Remember to use package option ’nomain’ if you - 
    don’t want to use the main glossary. +Warning: File 'test.glo' is empty. + 
    Have you used any entries defined in glossary 'main'? + 
    Remember to use package option 'nomain' if you + 
    don't want to use the main glossary.
    -

    (where the original file is called test.tex) but if you simply call

    (where the original file is called test.tex) but if you simply call makeindex directly +class="cmtt-10">makeindex directly to generate the .acr file (without attempting to create the .gls file) then the +class="cmtt-10">.acr file (without attempting to create the .gls file) then the transcript file will always contain the message: @@ -747,30 +645,30 @@ transcript file will always contain the message:

    No file test.gls.
    -

    This doesn’t occur with

    This doesn’t occur with makeglossaries as it will create the .gls file containing +class="cmtt-10">makeglossaries as it will create the .gls file containing the single command \null. -

    If you simply change from glossaries to glossaries-extra in this document, you’ll find -a change in the resulting PDF if you don’t use \null. +

    If you simply change from glossaries to glossaries-extra in this document, you’ll +find a change in the resulting PDF if you don’t use makeglossaries and you only +class="cmtt-10">makeglossaries and you only generate the .acr file with .acr file with makeindex. -

    The transcript file will still contain the message about the missing .gls, but now +class="cmtt-10">makeindex. +

    The transcript file will still contain the message about the missing .gls, but now you’ll also see information in the actual PDF document. The simplest remedy is to follow the advice inserted into the document at that point, which is to add the nomainnomain package option: @@ -787,252 +685,387 @@ class="ecss-1000">nomain\printglossaries  
    \end{document} -

    -

    +

    +

    -

    Top

    1.2 New or Modified Package Options

    -

    If you haven’t already loaded glossaries, you can use any of the package options +

    If you haven’t already loaded glossaries, you can use any of the package options provided by glossaries when you load glossaries-extra and they will automatically be +class="cmss-10">glossaries when you load glossaries-extra and they will automatically be passed to glossaries (which glossaries-extra will load). If glossaries has already +class="cmss-10">glossaries (which glossaries-extra will load). If glossaries has already been loaded, then those options will be passed to \setupglossaries\setupglossaries, but remember that not all of the glossaries package options may be used in that +class="cmss-10">glossaries package options may be used in that command. -

    This section only lists options that are either unrecognised by the glossaries +

    This section only lists options that are either unrecognised by the glossaries package or are a modified version of options of the same name provided by glossaries. +class="cmss-10">glossaries. See the glossaries user manual for details about the unmodified options. +class="cmss-10">glossaries user manual for details about the unmodified options.
    -

    -

    The new and modified options provided by glossaries-extra are described +

    +

    The new and modified options provided by glossaries-extra are described below:

    accsuppaccsupp
    Load the glossaries-accsuppglossaries-accsupp package (if not already loaded). -

    If you want to define styles that can interface with the accessibility support +

    If you want to define styles that can interface with the accessibility support provided by glossaries-accsuppglossaries-accsupp use the \glsaccessxxx⟩ type of commands +class="cmtt-10">\glsaccess⟨xxx⟩ type of commands instead of \glsentryxxx⟩ (for example, \glsaccesstext\glsentry⟨xxx⟩ (for example, \glsaccesstext instead of \glsentrytext\glsentrytext). If glossaries-accsuppglossaries-accsupp hasn’t been loaded those commands are equivalent (for example, \glsaccesstext just does \glsentrytext) +class="cmtt-10">\glsaccesstext just does \glsentrytext) but if it has been loaded, then the \glsaccessxxx⟩ commands will add +class="cmtt-10">\glsaccess⟨xxx⟩ commands will add the accessibility information. (See §9.2 §9.2 Accessibility Support for further details.) -

    Note that the accsupp

    Note that the accsupp option can only be used as a package option (not through \glossariesextrasetup\glossariesextrasetup) since the glossaries-accsuppglossaries-accsupp package must be loaded before glossaries-extra if it’s required. +class="cmss-10">glossaries-extra if it’s required.

    stylemodsstylemods
    This is a ⟨key⟩=⟨value⟩ option used to load the glossaries-extra-stylemodskey⟩=⟨value⟩ option used to load the glossaries-extra-stylemods package. The value may be a comma-separated list of options to pass to that package. (Remember to group ⟨value⟩ if it contains any commas.) The +class="cmti-10">value⟩ if it contains any commas.) The value may be omitted if no options need to be passed. See §2.6 §2.6 Glossary Style Modifications for further details.
    undefactionundefaction
    This is a ⟨key⟩=⟨value⟩ option, which has two allowed values: warn +class="cmti-10">key⟩=⟨value⟩ option, which has two allowed values: warn and error. This indicates what to do if an undefined glossary entry is +class="cmss-10">error. This indicates what to do if an undefined glossary entry is referenced. The default behaviour is undefaction=errorundefaction=error, which produces an error message (the default for glossaries). You can switch this to a warning +class="cmss-10">glossaries). You can switch this to a warning message (and ?? appearing in the text) with undefaction=warnundefaction=warn.
    docdefrecord
    (New to v1.08.) This is a ⟨key⟩=⟨value⟩ option, which has three allowed + values: off (default), only and alsoindex. If the value is omitted only is + assumed. The option is provided for the benefit of any post-processing + applications that need to know information about the entries used in the + document. The option may only be set in the preamble. +

    The record=off option switches off the recording, as per the default + behaviour. It implements undefaction=error +

    The other values switch on the recording and also undefaction=warn, + but record=only will also switch off the indexing mechanism (even if + \makeglossaries or \makenoidxglossaries has been used) whereas + record=alsoindex will both record and index. +

    With the recording on, any of the commands that would typically index + the entry (such as \gls, \glstext or \glsadd) will add a \glsxtr@record + entry to the .aux file. The post-processing application can then read these + lines to find out which entries have been used. (Remember that commands + like \glsentryname don’t index, so any use of these commands won’t add + a corresponding \glsxtr@record entry to the .aux file.) +

    There are two new commands that are intended for use with the recording + function: + + + +


    \glsxtrresourcefile  \glsxtrresourcefile[options]{filename} +

    +

    + This writes the line

    +
    + \glsxtr@resource{options}{filename} +
    +
    to the .aux file and, if ⟨filename⟩ exists, will then input ⟨filename⟩. The + post-processor may use this information to create the required file. The + options aren’t processed by glossaries-extra (other than simply writing + ⟨options⟩ to the .aux file). The post-processor determines the allowed + options. +


    \printunsrtglossary  \printunsrtglossary[options]

    +

    + This behaves like \printnoidxglossary but never sorts the entries and always + lists all the defined entries for the given glossary (and doesn’t require + \makenoidxglossaries). The optional argument is as for \printnoidxglossary. + The number list will need setting by the post-processor by adding the loclist + field to the entry definitions, otherwise the number list will be empty. The + loclist field should be a comma-separated list where each location in the list is + in the format +


    \glsnoidxdisplayloc{prefix}{counter}{format}{location} +

    +

    + (see the glossaries manual for information about that command). +

    All glossaries may be displayed in the order of their definition using: +


    \printunsrtglossaries  \printunsrtglossaries

    +

    + which is analogous to \printnoidxglossaries. +

    +docdef
    This option governs the use of \newglossaryentry. It was originally a +class="cmtt-10">\newglossaryentry. It was originally a boolean option, but as from version 1.06, it can now take one of three values (if the value is omitted, true is assumed): +class="cmss-10">true is assumed):
    • \newglossaryentry is not permitted in the document environment +class="cmtt-10">\newglossaryentry is not permitted in the document environment (default). + + +
    • \newglossaryentry behaves as it does in the base glossaries package. +class="cmtt-10">\newglossaryentry behaves as it does in the base glossaries package. That is, where its use is permitted in the document environment, it +class="cmss-10">document environment, it uses the .glsdefs temporary file to store the entry definitions so +class="cmtt-10">.glsdefs temporary file to store the entry definitions so that on the next LATEX run the entries are defined at the beginning of the document environment. This allows the entry information +class="cmss-10">document environment. This allows the entry information to be referenced in the glossary, even if the glossary occurs before \newglossaryentry. (For example, when the glossary is displayed in +class="cmtt-10">\newglossaryentry. (For example, when the glossary is displayed in the front matter.) This method of saving the definitions for the next LATEX run has drawbacks that are detailed in the glossaries user +class="cmss-10">glossaries user manual. - - -
    • (new to version 1.06) \newglossaryentry is permitted in the +class="cmtt-10">\newglossaryentry is permitted in the document environment without using the .glsdefs file. This means +class="cmss-10">document environment without using the .glsdefs file. This means that all entries must be defined before the glossary is displayed, but it avoids the complications associated with saving the entry details in a temporary file. You will still need to take care about any changes made to characters that are required by the ⟨key⟩=⟨value⟩ mechanism +class="cmti-10">key⟩=⟨value⟩ mechanism (that is, the comma and equal sign) and any makeindex or makeindex or xindy +class="cmtt-10">xindy character that occurs in the sort key or label. If any of those characters +class="cmss-10">sort key or label. If any of those characters are made active in the document, then it can cause problems with the entry definition. This option will allow \newglossaryentry to +class="cmtt-10">\newglossaryentry to be used in the document with \makenoidxglossaries, but note that +class="cmtt-10">\makenoidxglossaries, but note that \longnewglossaryentry remains a preamble-only command. -

      With this option, if an entry appears in the glossary before it has been +class="cmtt-10">\longnewglossaryentry remains a preamble-only command. +

      With this option, if an entry appears in the glossary before it has been defined, an error will occur (or a warning if the undefaction=warn +class="cmss-10">undefaction=warn option is used.) If you edit your document and either remove an entry or change its label, you may need to delete the document’s temporary files (such as the .aux and .gls files). +class="cmtt-10">.aux and .gls files).

    -

    The glossaries package allows \newglossaryentry within the document +

    The glossaries package allows \newglossaryentry within the document environment (when used with makeindex or xindy) but the user manual warns + id="dx1-4049">makeindex or xindy) but the user manual warns against this usage. By default the glossaries-extra package prohibits +class="cmss-10">glossaries-extra package prohibits this, only allowing definitions within the preamble. If you are really determined to define entries in the document environment, despite all the +class="cmss-10">document environment, despite all the associated drawbacks, you can restore this with docdef=true. Note that this +class="cmss-10">docdef=true. Note that this doesn’t change the prohibitions that the glossaries package has in certain +class="cmss-10">glossaries package has in certain circumstances (for example, when using “option 1”). See the glossaries user +class="cmss-10">glossaries user manual for further details. A better option if document definitions are required is docdef=restricted. Only use docdef=true if document definitions +class="cmss-10">docdef=restricted. Only use docdef=true if document definitions are necessary and one or more of the glossaries occurs in the front matter. -

    This option affects commands that internally use \newglossaryentry, such as +

    This option affects commands that internally use \newglossaryentry, such as + + + \newabbreviation, but not the “on-the-fly” commands described in §8 +class="cmtt-10">\newabbreviation, but not the “on-the-fly” commands described in §8 On-the-Fly Document Definitions.

    nomissingglstext
    nomissingglstext
    This is a boolean option. If true, this will suppress the warning text that will appear in the document if the external glossary files haven’t been generated due to an incomplete document build. However, it’s probably simpler @@ -1040,101 +1073,102 @@ class="description">This is a boolean option. If true, this will suppress the wa files.
    indexcrossrefs
    indexcrossrefs
    This is a boolean option. If true, this will automatically index any - - - +class="cmss-10">true, this will automatically index any cross-referenced entries that haven’t been marked as used at the end of the document. Note that this necessarily adds to the overall document build time, especially if you have defined a large number of entries, so this defaults to false, +class="cmss-10">false, but it will be automatically switched on if you use the see key in any entries. To +class="cmss-10">see key in any entries. To force it off, even if you use the see, you need to explicitly set indexcrossrefs to +class="cmss-10">see, you need to explicitly set indexcrossrefs to false. +class="cmss-10">false.
    abbreviations
    abbreviations
    This option has no value and can’t be cancelled. If used, it will automatically create a new glossary with the label abbreviations and +class="cmtt-10">abbreviations and redefines \glsxtrabbrvtype to this label. In addition, it defines a shortcut +class="cmtt-10">\glsxtrabbrvtype to this label. In addition, it defines a shortcut command -


    \printabbreviations  \printabbreviations[options]

    -

    +


    \printabbreviations  \printabbreviations[options]

    +

    which is equivalent to

    \printglossary[type=\glsxtrabbrvtype,options] +class="cmtt-10">\printglossary[type=\glsxtrabbrvtype,⟨options]
    The title of the new glossary is given by -


    \abbreviationsname  \abbreviationsname

    -

    +


    \abbreviationsname  \abbreviationsname

    +

    If this command is already defined, it’s left unchanged. Otherwise it’s defined to “Abbreviations” if babel hasn’t been loaded or \acronymname if +class="cmss-10">babel hasn’t been loaded or \acronymname if babel has been loaded. However, if you’re using babel it’s likely you +class="cmss-10">babel has been loaded. However, if you’re using babel it’s likely you will need to change this. (See §11 §11 Multi-Lingual Support for further details.) -

    If you don’t use the abbreviations package option, the \abbreviationsname +

    If you don’t use the abbreviations package option, the \abbreviationsname command won’t be defined (unless it’s defined by an included language file).
    -

    -

    If the abbreviations option is used and the acronym option provided by the + + + +

    +

    If the abbreviations option is used and the acronym option provided by the glossaries package hasn’t been used, then \acronymtype will be set to +class="cmss-10">glossaries package hasn’t been used, then \acronymtype will be set to \glsxtrabbrvtype so that acronyms defined with \newacronym can be added +class="cmtt-10">\glsxtrabbrvtype so that acronyms defined with \newacronym can be added to the list of abbreviations. If you want acronyms in the main glossary and +class="cmtt-10">main glossary and other abbreviations in the abbreviations glossary then you will need to +class="cmtt-10">abbreviations glossary then you will need to redefine \acronymtype to main: +class="cmtt-10">\acronymtype to main: @@ -1142,407 +1176,437 @@ class="ectt-1000">main:

    \renewcommand*{\acronymtype}{main}
    -

    -

    Note that there are no analogous options to the glossaries package’s acronymlists +

    +

    Note that there are no analogous options to the glossaries package’s acronymlists option (or associated commands) as the abbreviation mechanism is handled differently with glossaries-extra. +class="cmss-10">glossaries-extra.

    symbols
    symbols
    This is passed to glossaries but will additionally define -


    \glsxtrnewsymbol  \glsxtrnewsymbol[options]{label}{symbol} +class="cmss-10">glossaries but will additionally define +


    \glsxtrnewsymbol  \glsxtrnewsymbol[options]{label}{symbol}

    -

    +

    which is equivalent to

    \newglossaryentry{label}{name={symbol}, +class="cmtt-10">\newglossaryentry{⟨label}{name={symbol},
     sort={label},type=symbols,category=symbol,options} +class="cmtt-10"> sort={⟨label},type=symbols,category=symbol,options}
    Note that the sort key is set to the ⟨label⟩ not the ⟨symbol⟩ as the symbol will +class="cmss-10">sort key is set to the ⟨label⟩ not the ⟨symbol⟩ as the symbol will likely contain commands.
    numbers
    numbers
    This is passed to glossaries but will additionally define -


    \glsxtrnewnumber  \glsxtrnewnumber[options]{number}

    -

    +class="cmss-10">glossaries but will additionally define +


    \glsxtrnewnumber  \glsxtrnewnumber[options]{number}

    +

    which is equivalent to

    \newglossaryentry{label}{name={number}, +class="cmtt-10">\newglossaryentry{⟨label}{name={number},
     sort={label},type=numbers,category=number,options} +class="cmtt-10"> sort={⟨label},type=numbers,category=number,options}
    shortcuts
    shortcuts
    Unlike the glossaries package option of the same name, this option isn’t +class="cmss-10">glossaries package option of the same name, this option isn’t boolean but has multiple values:
    • shortcuts=acronyms (or shortcuts=acro): set the shortcuts provided +class="cmss-10">shortcuts=acronyms (or shortcuts=acro): set the shortcuts provided by the glossaries package for acronyms (such as \ac). +class="cmss-10">glossaries package for acronyms (such as \ac).
    • shortcuts=abbreviations (or shortcuts=abbr): +class="cmss-10">shortcuts=abbreviations (or shortcuts=abbr): set the abbreviation shortcuts provided by glossaries-extra. (See §3.3 +class="cmss-10">glossaries-extra. (See §3.3 Shortcut Commands.) These settings don’t switch on the acronym shortcuts provided by the glossaries package. +class="cmss-10">glossaries package.
    • shortcuts=other: set the “other” shortcut commands, but not the shortcut +class="cmss-10">shortcuts=other: set the “other” shortcut commands, but not the shortcut commands for abbreviations or the acronym shortcuts provided by glossaries. The “other” shortcuts are: +class="cmss-10">glossaries. The “other” shortcuts are:
      • \newentry equivalent to \newglossaryentry +class="cmtt-10">\newentry equivalent to \newglossaryentry
      • \newsym equivalent to \glsxtrnewsymbol (see the symbols +class="cmtt-10">\newsym equivalent to \glsxtrnewsymbol (see the symbols option).
      • \newnum equivalent to \glsxtrnewnumber (see the numbers +class="cmtt-10">\newnum equivalent to \glsxtrnewnumber (see the numbers option).
    • shortcuts=all (or shortcuts=true): define all the shortcut commands. +class="cmss-10">shortcuts=all (or shortcuts=true): define all the shortcut commands.
    • shortcuts=none (or shortcuts=false): don’t define any of the shortcut +class="cmss-10">shortcuts=none (or shortcuts=false): don’t define any of the shortcut commands (default).
    -

    Note that multiple invocations of the shortcuts option within the same option +

    Note that multiple invocations of the shortcuts option within the same option list will override each other.

    -

    After the glossaries-extra package has been loaded, you can set available options +class="cmti-10">list will override each other.

    +

    After the glossaries-extra package has been loaded, you can set available options using -


    \glossariesextrasetup  \glossariesextrasetup{options}

    -

    +


    \glossariesextrasetup  \glossariesextrasetup{options}

    +

    The abbreviations and docdef options may only be used in the preamble. Additionally, +class="cmss-10">abbreviations and docdef options may only be used in the preamble. Additionally, docdef can’t be used after \makenoidxglossaries. +class="cmss-10">docdef can’t be used after \makenoidxglossaries.

    -

    -

    +

    Top

    2. Modifications to Existing Commands and Styles

    -

    The commands used by glossaries to automatically produce an error if an entry is +

    The commands used by glossaries to automatically produce an error if an entry is undefined (such as \glsdoifexists\glsdoifexists) are changed to take the undefactionundefaction option into account. -

    The \newglossaryentry command has a new key called category

    The \newglossaryentry command has a new key called category, which sets the category label for the given entry. By default this is general. See §5 general. See §5 Categories for further information about categories. -

    The \newterm

    The \newterm command (defined through the indexindex package option) is modified so that the category defaults to indexindex. The \newacronym\newacronym command is modified to use the new abbreviation interface provided by glossaries-extra. (See §3 +class="cmss-10">glossaries-extra. (See §3 Abbreviations.) +

    The \makeglossaries command now has an optional argument. +


    \makeglossaries  \makeglossaries[list]

    +

    +If ⟨list⟩ is empty, \makeglossaries behaves as per its original definition in the +glossaries package, otherwise ⟨list⟩ can be a comma-separated list of glossaries that +need processing with an external indexing application. +

    It should then be possible to use \printglossary for those glossaries listed in ⟨list⟩ +and \printnoidxglossary for the other glossaries.

    -

    Top

    2.1 Entry Indexing

    -

    The glossaries-extra package provides an extra key for commands like \gls and +

    The glossaries-extra package provides an extra key for commands like \gls and \glstext called noindex\glstext called noindex. This is a boolean key. If true, this suppresses the indexing. (That is, it prevents \gls or whatever from adding a line to the external glossary +class="cmtt-10">\gls or whatever from adding a line to the external glossary file.) This is more useful than the indexonlyfirstindexonlyfirst package option provided by glossaries, +class="cmss-10">glossaries, as the first use might not be the most pertinent use. (If you want to apply indexonlyfirstindexonlyfirst to selected entries, rather than all of them, you can use the indexonlyfirstindexonlyfirst attribute, see §5 §5 Categories for further details.) Note that the noindexnoindex key isn’t available for \glsadd\glsadd (and \glsaddall\glsaddall) since the whole purpose of that command is to index an entry. -

    There is a new hook that’s used each time indexing information is written to the +

    There is a new hook that’s used each time indexing information is written to the external glossary files: -


    \glsxtrdowrglossaryhook 


    \glsxtrdowrglossaryhook  \glsxtrdowrglossaryhook{label}

    -

    +class="cmtt-10">\glsxtrdowrglossaryhook{⟨label}


    +

    where ⟨label⟩ is the entry’s label. This does nothing by default but may be redefined. +class="cmti-10">label⟩ is the entry’s label. This does nothing by default but may be redefined. (See, for example, the accompanying sample file sample-indexhook.tex, which uses +class="cmtt-10">sample-indexhook.tex, which uses this hook to determine which entries haven’t been indexed.) -

    The value of the see

    The value of the see key is now saved as a field. This isn’t the case with glossaries, +class="cmss-10">glossaries, where the seesee attribute is simply used to directly write a line to the corresponding glossary file and is then discarded. This is why the seesee key can’t be used before \makeglossaries\makeglossaries (since the file hasn’t been opened yet). It’s also the reason why the seesee key doesn’t have any effect when used in entries that + + + are defined in the documentdocument environment. Since the value isn’t saved, it’s not available when the .glsdefs file is created at the end of the document +class="cmtt-10">.glsdefs file is created at the end of the document and so isn’t available at the start of the documentdocument environment on the next run. -

    This modification allows glossaries-extra to provide -


    \glsxtraddallcrossrefs 

    This modification allows glossaries-extra to provide +


    \glsxtraddallcrossrefs  \glsxtraddallcrossrefs

    -

    +class="cmtt-10">\glsxtraddallcrossrefs


    +

    which is used at the end of the document to automatically add any unused - - - cross-references unless the package option indexcrossrefsindexcrossrefs was set to false. -

    As a by-product of this enhancement, the see

    As a by-product of this enhancement, the see key will now work for entries defined in the documentdocument environment, but it’s still best to define entries in the preamble, and the seesee key still can’t perform any indexing before the file has been opened by \makeglossaries. Note that glossaries v4.24 introduced the seenoindex\makeglossaries. Note that glossaries v4.24 introduced the seenoindex package option, which can be used to suppress the error when the seesee key is used before \makeglossaries, so seenoindex=ignore\makeglossaries, so seenoindex=ignore will allow the seesee value to be stored even though it may not be possible to index it at that point. -

    As from version 1.06, you can display the cross-referenced information for a given +

    As from version 1.06, you can display the cross-referenced information for a given entry using -


    \glsxtrusesee 


    \glsxtrusesee  \glsxtrusesee{label}

    -

    +class="cmtt-10">\glsxtrusesee{⟨label}


    +

    This internally uses -


    \glsxtruseseeformat 


    \glsxtruseseeformat  \glsxtruseseeformat{tag}{xr list}

    -

    +class="cmtt-10">\glsxtruseseeformat{⟨tag}{xr list}


    +

    where ⟨tag⟩ and ⟨xr list⟩ are obtained from the value of the entry’s see field -(if non-empty). By default, this just does \glsseeformat[tag]{xr list}{}, +class="cmti-10">tag⟩ and ⟨xr list⟩ are obtained from the value of the entry’s see field (if +non-empty). By default, this just does \glsseeformat[tag]{xr list}{}, which is how the cross-reference is displayed in the number list. Note that \glsxtrusesee does nothing if the see\glsxtrusesee does nothing if the see field hasn’t been set for the entry given by ⟨label⟩. -

    Suppose you want to suppress the label⟩. +

    Suppose you want to suppress the number list using nonumberlistnonumberlist. This will automatically prevent the cross-references from being displayed. The seeautonumberlistseeautonumberlist package option will automatically enable the number list for entries that have the seesee key set, but this will also show the rest of the number list. -

    Another approach in this situation is to use the post description hook +

    Another approach in this situation is to use the post description hook with \glsxtrusesee to append the cross-reference after the description. For +class="cmtt-10">\glsxtrusesee to append the cross-reference after the description. For example: @@ -1555,131 +1619,133 @@ example:  
     {}%  
    }

    -

    Now the cross-references can appear even though the

    Now the cross-references can appear even though the number list has been suppressed. -

    +

    -

    Top

    2.2 Entry Display Style Modifications

    -

    Recall from the glossaries package that commands such as \gls display text at +

    Recall from the glossaries package that commands such as \gls display text at that point in the document (optionally with a hyperlink to the relevant line in the glossary). This text is referred to as the “link-text” regardless of whether or not it actually has a hyperlink. The actual text and the way it’s displayed depends on the command used (such as \gls) and the entry +class="cmtt-10">\gls) and the entry format. -

    The default entry format (\glsentryfmt

    The default entry format (\glsentryfmt) used in the link-text by commands like \gls\gls, \glsxtrfull\glsxtrfull, \glsxtrshort\glsxtrshort and \glsxtrlong\glsxtrlong (but not commands like \glslink\glslink, \glsfirst\glsfirst and \glstext) is changed by glossaries-extra to test for regular +class="cmtt-10">\glstext) is changed by glossaries-extra to test for regular entries, which are determined as follows:

    -

    This means that entries with a short form can be treated as regular entries rather +

    This means that entries with a short form can be treated as regular entries rather than abbreviations if it’s more appropriate for the desired style. -

    As from version 1.04, \glsentryfmt

    As from version 1.04, \glsentryfmt now puts \glsgenentry\glsgenentry in the argument of the new command -


    \glsxtrregularfont 


    \glsxtrregularfont  \glsxtrregularfont{text}

    -

    +class="cmtt-10">\glsxtrregularfont{⟨text}


    +

    This just does its argument ⟨text⟩ by default. This means that if you want regular +class="cmti-10">text⟩ by default. This means that if you want regular entries in a different font but don’t want that font to apply to abbreviations, then you can redefine \glsxtrregularfont. This is more precise than changing +class="cmtt-10">\glsxtrregularfont. This is more precise than changing \glstextformat\glstextformat which will be applied to all linking commands for all entries. -

    For example: +

    For example: @@ -1687,8 +1753,8 @@ class="ectt-1000">\glstextformat \renewcommand*{\glsxtrregularfont}[1]{\textsf{#1}} -

    You can access the label through \glslabel. For example, you can query the +

    You can access the label through \glslabel. For example, you can query the category: @@ -1698,7 +1764,7 @@ category: \renewcommand*{\glsxtrregularfont}[1]{%  
     \glsifcategory{\glslabel}{general}{\textsf{#1}}{#1}} -

    or query the category attribute: +

    or query the category attribute: @@ -1708,7 +1774,7 @@ category:  
    \renewcommand*{\glsxtrregularfont}[1]{%  
     \glsifattribute{\glslabel}{font}{sf}{\textsf{#1}}{#1}} -

    or use the attribute to store the control sequence name: +

    or use the attribute to store the control sequence name: @@ -1722,81 +1788,82 @@ category:  
      {#1}%  
    } -

    (Remember the category and attribute settings will only queried here for regular

    (Remember the category and attribute settings will only queried here for regular entries, so if the abbreviation style for the acronymacronym category in the above example changes the regular attribute to “false”, \glsxtrregularfont will no longer +class="cmtt-10">\glsxtrregularfont will no longer apply.) -

    The \glspostlinkhook provided by the glossaries package to insert information +

    The \glspostlinkhook provided by the glossaries package to insert information after the link-text produced by commands like \gls and \glstext is redefined +class="cmtt-10">\gls and \glstext is redefined to -


    \glsxtrpostlinkhook 


    \glsxtrpostlinkhook  \glsxtrpostlinkhook

    -

    +class="cmtt-10">\glsxtrpostlinkhook


    +

    This command will discard a following full stop (period) if the discardperioddiscardperiod attribute is set to “true” for the current entry’s category. It will also do -


    \glsxtrpostlink 


    \glsxtrpostlink  \glsxtrpostlink

    -

    +class="cmtt-10">\glsxtrpostlink


    +

    if a full stop hasn’t be discarded and -


    \glsxtrpostlinkendsentence 


    \glsxtrpostlinkendsentence  \glsxtrpostlinkendsentence

    -

    +class="cmtt-10">\glsxtrpostlinkendsentence


    +

    if a full stop has been discarded. -

    Avoid the use of \gls-like and \glstext-like commands within the +

    Avoid the use of \gls-like and \glstext-like commands within the post-link hook as they will cause interference. Consider using commands like \glsentrytext, \glsaccesstext or \glsxtrp (§2.4 \glsentrytext, \glsaccesstext or \glsxtrp (§2.4 Nested Links) instead.
    -

    -

    By default \glsxtrpostlink just does \glsxtrpostlinkcategory

    +

    By default \glsxtrpostlink just does \glsxtrpostlinkcategory if it exists, where ⟨category⟩ is the category label for the current entry. (For +class="cmti-10">category⟩ is the category label for the current entry. (For example, for the generalgeneral category, \glsxtrpostlinkgeneral if it has been +class="cmtt-10">\glsxtrpostlinkgeneral if it has been defined.) -

    The sentence-ending hook is slightly more complicated. If the command +

    The sentence-ending hook is slightly more complicated. If the command \glsxtrpostlinkcategory\glsxtrpostlink⟨category is defined the hook will do that and then insert a full stop with the space factor adjusted to match the end of sentence. If \glsxtrpostlinkcategory\glsxtrpostlink⟨category hasn’t been defined, the space factor is adjusted to match the end of sentence. This means that if you have, for example, an entry that ends with a full stop, a redundant following full stop will be discarded and the space factor @@ -1806,24 +1873,24 @@ with a full stop, a redundant following full stop will be discarded and the spac adjusted (in case the entry is in uppercase) unless the entry is followed by additional material, in which case the following full stop is no longer redundant and needs to be reinserted. -

    There are some convenient commands you might want to use when customizing +

    There are some convenient commands you might want to use when customizing the post-link-text category hooks: -


    \glsxtrpostlinkAddDescOnFirstUse 


    \glsxtrpostlinkAddDescOnFirstUse  \glsxtrpostlinkAddDescOnFirstUse +class="cmtt-10">\glsxtrpostlinkAddDescOnFirstUse

    -

    +

    This will add the description in parentheses on first use. -

    For example, suppose you want to append the description in parentheses on

    For example, suppose you want to append the description in parentheses on first use for entries in the symbolsymbol category: @@ -1834,74 +1901,74 @@ class="ecss-1000">symbol  \glsxtrpostlinkAddDescOnFirstUse  
    }

    -

    -


    \glsxtrpostlinkAddSymbolOnFirstUse 

    +


    \glsxtrpostlinkAddSymbolOnFirstUse  \glsxtrpostlinkAddSymbolOnFirstUse +class="cmtt-10">\glsxtrpostlinkAddSymbolOnFirstUse

    -

    +

    This will append the symbol (if defined) in parentheses on first use. -

    If you want to provide your own custom format be aware that you can’t use +

    If you want to provide your own custom format be aware that you can’t use \ifglsused\ifglsused within the post-link-text hook as by this point the first use flag will have been unset. Instead you can use -


    \glsxtrifwasfirstuse 


    \glsxtrifwasfirstuse  \glsxtrifwasfirstuse{true}{false}

    -

    +class="cmtt-10">\glsxtrifwasfirstuse{⟨true}{false}


    +

    This will do ⟨true⟩ if the last used entry was the true⟩ if the last used entry was the first use for that entry, otherwise it will do ⟨false⟩. (Requires at least glossaries v4.19 to work properly.) This command is +class="cmti-10">false⟩. (Requires at least glossaries v4.19 to work properly.) This command is locally set by commands like \gls, so don’t rely on it outside of the post-\gls, so don’t rely on it outside of the post-link-text hook. -

    Note that commands like \glsfirst

    Note that commands like \glsfirst and \glsxtrfull\glsxtrfull fake first use for the benefit of the post-link-text hooks by setting \glsxtrifwasfirstuse to +class="cmtt-10">\glsxtrifwasfirstuse to \@firstoftwo. (Although, depending on the styles in use, they may not exactly +class="cmtt-10">\@firstoftwo. (Although, depending on the styles in use, they may not exactly match the text produced by \gls\gls-like commands on first use.) However, the short-postfootnoteshort-postfootnote style alters \glsxtrfull so that it fakes non-\glsxtrfull so that it fakes non-first use otherwise the inline full format would include the footnote, which is inappropriate.
    -

    -

    For example, if you want to place the description in a footnote after the

    +

    For example, if you want to place the description in a footnote after the link-text on first use for the generalgeneral category: @@ -1912,26 +1979,26 @@ class="ecss-1000">general  \glsxtrifwasfirstuse{\footnote{\glsentrydesc{\glslabel}}}{}%  
    }

    -

    -

    The short-postfootnote

    +

    The short-postfootnote abbreviation style uses the post-link-text hook to place the footnote after trailing punctuation characters. -

    You can set the default options used by \glslink

    You can set the default options used by \glslink, \gls\gls etc with: -


    \GlsXtrSetDefaultGlsOpts 


    \GlsXtrSetDefaultGlsOpts  \GlsXtrSetDefaultGlsOpts{options}

    -

    +class="cmtt-10">\GlsXtrSetDefaultGlsOpts{⟨options}


    +

    For example, if you mostly don’t want to index entries then you can do: @@ -1940,52 +2007,52 @@ For example, if you mostly don’t want to index entries then you can do:

    \GlsXtrSetDefaultGlsOpts{noindex}
    -

    and then use, for example, \gls[noindex=false]{sample} when you actually want +

    and then use, for example, \gls[noindex=false]{sample} when you actually want the location added to the number list. These defaults may be overridden by other settings (such as category attributes) in addition to any settings passed in the option argument of commands like \glslink and \gls. -

    Note that if you don’t want any indexing, just omit \makeglossaries and -\printglossaries (or analogous commands). -

    Commands like \gls\glslink and \gls. +

    Note that if you don’t want any indexing, just omit \makeglossaries and +\printglossaries (or analogous commands). +

    Commands like \gls have star (*) and plus (+) modifiers as a short cut for +class="cmtt-10">*) and plus (+) modifiers as a short cut for hyper=false and hyper=true. The glossaries-extra package provides a way to add a +class="cmtt-10">hyper=false and hyper=true. The glossaries-extra package provides a way to add a third modifier, if required, using -


    \GlsXtrSetAltModifier 


    \GlsXtrSetAltModifier  \GlsXtrSetAltModifier{char}{options} +class="cmtt-10">\GlsXtrSetAltModifier{⟨char}{options}

    -

    +

    where ⟨char⟩ is the character used as the modifier and ⟨options⟩ is the default set of +class="cmti-10">char⟩ is the character used as the modifier and ⟨options⟩ is the default set of options (which may be overridden). Note that ⟨char⟩ must be a single character (not a +class="cmti-10">char⟩ must be a single character (not a UTF-8 character, unless you are using XƎLATEX or LuaLATEX). -

    When choosing the character ⟨char⟩ take care of any changes in category code. +

    When choosing the character ⟨char⟩ take care of any changes in category code.
    -

    -

    Example: +

    +

    Example: @@ -1993,9 +2060,9 @@ class="ecti-1000">char⟩ take care of any changes in category code.

    \GlsXtrSetAltModifier{!}{noindex}
    -

    This means that \gls!{sample} will be equivalent to \gls[noindex]{sample}. It’s +

    This means that \gls!{sample} will be equivalent to \gls[noindex]{sample}. It’s not possible to mix modifiers. For example, if you want to do @@ -2004,29 +2071,30 @@ not possible to mix modifiers. For example, if you want to do

    \gls[noindex,hyper=false]{sample}
    -

    you can use \gls*[noindex]{sample} or \gls![hyper=false]{sample} but you +

    you can use \gls*[noindex]{sample} or \gls![hyper=false]{sample} but you can’t combine the * and ! modifiers. -

    +class="cmtt-10">* and ! modifiers. +

    -

    Top

    2.3 Entry Counting Modifications

    -

    The \glsenableentrycount

    The \glsenableentrycount command is modified to allow for the entrycountentrycount attribute. This means that you not only need to enable entry counting with \glsenableentrycount, but you also need to set the appropriate attribute (see §5 +class="cmtt-10">\glsenableentrycount, but you also need to set the appropriate attribute (see §5 Categories). -

    For example, instead of just doing: +

    For example, instead of just doing: @@ -2034,7 +2102,7 @@ href="#sec:categories">Categories).

    \glsenableentrycount
    -

    you now need to do: +

    you now need to do: @@ -2043,34 +2111,35 @@ href="#sec:categories">Categories). \glsenableentrycount  
    \glssetcategoryattribute{abbreviation}{entrycount}{1}

    -

    This will enable the entry counting for entries in the abbreviation

    This will enable the entry counting for entries in the abbreviation category, but any entries assigned to other categories will be unchanged. -

    Further information about entry counting, including the new per-unit feature, is +

    Further information about entry counting, including the new per-unit feature, is described in §6 §6 Entry Counting. -

    +

    -

    Top

    2.4 Nested Links

    -

    Complications arise when you use \gls

    Complications arise when you use \gls in the value of the namename field (or texttext or firstfirst fields, if set). This tends to occur with abbreviations that extend other abbreviations. For example, SHTML is an abbreviation for SSI enabled HTML, where SSI is an abbreviation for Server Side Includes and HTML is an abbreviation for Hypertext Markup Language. -

    Things can go wrong if we try the following with the glossaries package: +

    Things can go wrong if we try the following with the glossaries package: @@ -2080,16 +2149,16 @@ class="ecss-1000">glossaries package:  
    \newacronym{html}{HTML}{Hypertext Markup Language}  
    \newacronym{shtml}{S\gls{html}}{\gls{ssi} enabled \gls{html}}

    -

    -

    The main problems are: +

    +

    The main problems are:

    1. The first letter upper casing commands, such as \Gls\Gls, won’t work for the shtml entry on shtml entry on first use if the long form is displayed before the short form (which is the default abbreviation style). This will attempt to @@ -2100,8 +2169,8 @@ href="#glo:firstuse">first use if the long form is displayed before the shor
      \gls{\uppercase ssi} enabled \gls{html}
      -

      which just doesn’t work. Grouping the \gls{ssi} doesn’t work either as this +

      which just doesn’t work. Grouping the \gls{ssi} doesn’t work either as this will effectively try to do @@ -2110,81 +2179,81 @@ class="ectt-1000">\gls{ssi} doesn’t work either as th

      \uppercase{\gls{ssi}} enabled \gls{html}
      -

      This will upper case the label ssi so the entry won’t be recognised. +

      This will upper case the label ssi so the entry won’t be recognised. This problem will also occur if you use the all capitals version, such as \GLS\GLS.

    2. The long and abbreviated forms accessed through \glsentrylong\glsentrylong and \glsentryshort\glsentryshort are no longer expandable and so can’t be used be used in contexts that require this, such as PDF bookmarks.
    3. The nested commands may end up in the sortsort key, which will confuse the indexing.
    4. The shtml entry produces inconsistent results depending on whether the ssi +class="cmtt-10">shtml entry produces inconsistent results depending on whether the ssi or html entries have been used. Suppose both ssi and html are used before +class="cmtt-10">html entries have been used. Suppose both ssi and html are used before shtml. For example: +class="cmtt-10">shtml. For example:
      This section discusses \gls{ssi}, \gls{html} and \gls{shtml}.
      -

      This produces: +

      This produces:

      -

      This section discusses server side includes (SSI), hypertext +

      This section discusses server side includes (SSI), hypertext markup language (HTML) and SSI enabled HTML (SHTML).

      -

      So the

      So the first use of the shtml entry produces “SSI enabled HTML (SHTML)”. -

      Now let’s suppose the html entry is used before the shtml but the ssi entry is +class="cmtt-10">shtml entry produces “SSI enabled HTML (SHTML)”. +

      Now let’s suppose the html entry is used before the shtml but the ssi entry is used after the shtml entry, for example: +class="cmtt-10">shtml entry, for example:

      - The sample files are either \gls{html} or \gls{shtml}, but let’s + The sample files are either \gls{html} or \gls{shtml}, but let's  
      first discuss \gls{ssi}.
      -

      This produces: +

      This produces:

      -

      The sample files are either hypertext markup language (HTML) +

      The sample files are either hypertext markup language (HTML) or server side includes (SSI) enabled HTML (SHTML), but let’s first discuss SSI.

      -

      So the

      So the first use of the shtml entry now produces “server side includes (SSI) +class="cmtt-10">shtml entry now produces “server side includes (SSI) enabled HTML (SHTML)”, which looks a bit strange. -

      Now let’s suppose the shtml entry is used before (or without) the other two +

      Now let’s suppose the shtml entry is used before (or without) the other two entries: @@ -2193,20 +2262,20 @@ class="ectt-1000">shtml entry is used before (or without) the other two

      This article is an introduction to \gls{shtml}.
      -

      This produces: +

      This produces:

      -

      This article is an introduction to server side includes (SSI) +

      This article is an introduction to server side includes (SSI) enabled hypertext markup language (HTML) (SHTML).

      -

      So the

      So the first use of the shtml entry now produces “server side includes (SSI) +class="cmtt-10">shtml entry now produces “server side includes (SSI) enabled hypertext markup language (HTML) (SHTML)”, which is even more strange. -

      This is all aggravated by setting the style using the glossaries package’s +

      This is all aggravated by setting the style using the glossaries package’s \setacronymstyle. For example: +class="cmtt-10">\setacronymstyle. For example: @@ -2214,21 +2283,21 @@ class="ectt-1000">\setacronymstyle. For example:

      \setacronymstyle{long-short}
      -

      as this references the label through the use of \glslabel when displaying the +

      as this references the label through the use of \glslabel when displaying the long and short forms, but this value changes with each use of \gls, so +class="cmtt-10">\gls, so instead of displaying “(SHTML)” at the end of the first use, it now displays “(HTML)”, since \glslabel has been changed to html by +class="cmtt-10">\glslabel has been changed to html by \gls{html}. -

      Another oddity occurs if you reset the html entry between uses of the shtml +class="cmtt-10">\gls{html}. +

      Another oddity occurs if you reset the html entry between uses of the shtml entry. For example: @@ -2237,47 +2306,47 @@ class="ectt-1000">shtml

      \gls{shtml} ... \glsreset{html}\gls{shtml}
      -

      The next use of shtml produces “Shypertext markup language (HTML)”, +

      The next use of shtml produces “Shypertext markup language (HTML)”, which is downright weird. -

      Even without this, the short form has nested formatting commands, which +

      Even without this, the short form has nested formatting commands, which amount to \acronymfont{S\acronymfont{HTML}}. This may not be a problem +class="cmtt-10">\acronymfont{S\acronymfont{HTML}}. This may not be a problem for some styles, but if you use one of the “sm” styles (that use \textsmaller\textsmaller), this will produce an odd result.

    5. Each time the shtml entry is used, the html entry will also be indexed and +class="cmtt-10">shtml entry is used, the html entry will also be indexed and marked as used, and on first use this will happen to both the ssi and html +class="cmtt-10">ssi and html entries. This kind of duplication in the location list isn’t usually particularly helpful to the reader.
    6. If hyperref is in use, you’ll get nested hyperlinks and there’s no consistent - way of dealing with this across the available PDF viewers. If on the - first use case, the user clicks on the “HTML” part of the “SSI enabled +class="cmss-10">hyperref is in use, you’ll get nested hyperlinks and there’s no consistent way + of dealing with this across the available PDF viewers. If on the first + use case, the user clicks on the “HTML” part of the “SSI enabled HTML (SHTML)” link, they may be directed to the HTML entry in the glossary or they may be directed to the SHTML entry in the glossary.
    -

    For these reasons it’s better to use the simple expandable commands +

    For these reasons it’s better to use the simple expandable commands like \glsentrytext\glsentrytext or \glsentryshort\glsentryshort in the definition of other entries (although that doesn’t fix the first problem). Alternatively use something like: @@ -2290,8 +2359,8 @@ like:  
     [description={\acrshort{ssi} enabled \acrshort{html}}]  
     {shtml}{SHTML}{SSI enabled HTML}

    -

    with glossaries or: +

    with glossaries or: @@ -2301,20 +2370,20 @@ class="ecss-1000">glossaries or:  
     [description={\glsxtrshort{ssi} enabled \glsxtrshort{html}}]  
     {shtml}{SHTML}{SSI enabled HTML}

    -

    with glossaries-extra. This fixes all the above listed problems (as long as you don’t +

    with glossaries-extra. This fixes all the above listed problems (as long as you don’t use \glsdesc\glsdesc). Note that replacing \gls with \acrshort in the original example +class="cmtt-10">\gls with \acrshort in the original example may fix the first use issue, but it doesn’t fix any of the other problems listed above. -

    If it’s simply that you want to use the abbreviation font, you can use +

    If it’s simply that you want to use the abbreviation font, you can use \glsabbrvfont: +class="cmtt-10">\glsabbrvfont: @@ -2326,25 +2395,25 @@ class="ectt-1000">\glsabbrvfont:  
    \newabbreviation{shtml}{shtml}{\glsabbrvfont{ssi} enabled  
    \glsabbrvfont{html}} -

    This will pick up the font style setting of the outer entry (shtml, in the above case). +

    This will pick up the font style setting of the outer entry (shtml, in the above case). This isn’t a problem in the above example as all the abbreviations use the same style. -

    However if you’re really determined to use \gls

    However if you’re really determined to use \gls in a field that may be included within some link-text, glossaries-extra patches internals used by the linking commands +class="cmss-10">glossaries-extra patches internals used by the linking commands so that if \gls (or plural or case changing variants) occurs in the \gls (or plural or case changing variants) occurs in the link-text it will behave as though you used \glstext\glstext[hyper=false,noindex] instead. Grouping is +class="cmtt-10">[hyper=false,noindex] instead. Grouping is also added so that, for example, when \gls{shtml} is used for the first time the long +class="cmtt-10">\gls{shtml} is used for the first time the long form @@ -2353,7 +2422,7 @@ form

    \gls{ssi} enabled \gls{html}
    -

    is treated as +

    is treated as @@ -2362,7 +2431,7 @@ form {\glstext[hyper=false,noindex]{ssi}} enabled  
    {\glstext[hyper=false,noindex]{html}} -

    This overcomes problems 

    This overcomes problems 4, 5 and 6 listed above, but still doesn’t fix problems 1 and 2. Problem 3 usually won’t be an issue as most abbreviation styles set the sortsort key to the short form, so using these commands in the long form but not the short form will only affect entries with a style that sorts according to the long form (such as long-noshort-desclong-noshort-desc). -

    Additionally, any instance of the long form commands, such as \glsxtrlong

    Additionally, any instance of the long form commands, such as \glsxtrlong or \acrlong\acrlong will be temporarily redefined to just use

    {\glsentrylong{\glsentrylong{label}insert} +class="cmtt-10">{⟨label}insert}
    (or case-changing versions). Similarly the short form commands, such as \glsxtrshort\glsxtrshort or \acrshort\acrshort will use \glsentryshort\glsentryshort in the argument of either \glsabbrvfont (for \glsxtrshort) or \acronymfont (for \acrshort). So if the +class="cmtt-10">\glsabbrvfont (for \glsxtrshort) or \acronymfont (for \acrshort). So if the shtml entry had instead been defined as: +class="cmtt-10">shtml entry had instead been defined as:
    \newacronym{shtml}{SHTML}{\acrshort{ssi} enabled \acrshort{html}}
    -

    then (using the long-short

    then (using the long-short style) the first use will be like @@ -2427,7 +2497,7 @@ href="#glo:firstuse">first use will be like {\acronymfont{\glsentryshort{ssi}}} enabled  
    {\acronymfont{\glsentryshort{html}}} (SHTML) -

    whereas if the entry is defined as: +

    whereas if the entry is defined as: @@ -2436,7 +2506,7 @@ href="#glo:firstuse">first use will be like \newabbreviation{shtml}{SHTML}{\glsxtrshort{ssi} enabled  
    \glsxtrshort{html}} -

    then the

    then the first use will be like: @@ -2447,88 +2517,89 @@ href="#glo:firstuse">first use will be like: {\glsabbrvfont{\glsentryshort{ssi}}} enabled  
    {\glsabbrvfont{\glsentryshort{html}}} (SHTML) -

    Note that the first optional argument of \acrshort or \glsxtrshort is ignored in +

    Note that the first optional argument of \acrshort or \glsxtrshort is ignored in this context. (The final optional argument will be inserted, if present.) The abbreviation style that governs \glsabbrvfont\glsabbrvfont will be set for \glsxtrshort\glsxtrshort. Note that \acrshort doesn’t set the abbreviation style. -

    Alternatively you can use: -


    \glsxtrp \acrshort doesn’t set the abbreviation style. +

    Alternatively you can use: +


    \glsxtrp  \glsxtrp{field}{label}

    -

    +class="cmtt-10">\glsxtrp{⟨field}{label}


    +

    where ⟨field⟩ is the field label and corresponds to a command in the form \glsfield⟩ +class="cmti-10">field⟩ is the field label and corresponds to a command in the form \glsfield⟩ (e.g. \glstext) or in the form \glsxtrfield⟩ (e.g. \glsxtrshort). -

    There’s a shortcut command for the most common fields: -


    \glsps \glstext) or in the form \glsxtrfield⟩ (e.g. \glsxtrshort). +

    There’s a shortcut command for the most common fields: +


    \glsps  \glsps{label}

    -

    +class="cmtt-10">\glsps{⟨label}


    +

    which is equivalent to \glsxtrp{short}{label}, and -


    \glspt \glsxtrp{short}{label}, and +


    \glspt  \glspt{label}

    -

    +class="cmtt-10">\glspt{⟨label}


    +

    which is equivalent to \glsxtrp{text}{label}. -

    The \glsxtrp command behaves much like the \glsfmtfield⟩ commands described +class="cmtt-10">\glsxtrp{text}{label}. +

    The \glsxtrp command behaves much like the \glsfmtfield⟩ commands described in §4 §4 Entries in Sectioning Titles, Headers, Captions and Contents but the post-link hook is also suppressed and extra grouping is added. It automatically sets hyperhyper to false and noindexfalse and noindex to true. If you want to change this, you can +class="cmtt-10">true. If you want to change this, you can use -


    \glsxtrsetpopts 


    \glsxtrsetpopts  \glsxtrsetpopts{options}

    -

    +class="cmtt-10">\glsxtrsetpopts{⟨options}


    +

    For example: @@ -2537,17 +2608,17 @@ For example:

    \glsxtrsetpopts{hyper=false}
    -

    will just switch off the hyperlinks but not the indexing. Be careful using +

    will just switch off the hyperlinks but not the indexing. Be careful using this command or you can end up back to the original problem of nested links. -

    The hyper link is re-enabled within glossaries. This is done through the +

    The hyper link is re-enabled within glossaries. This is done through the command: -


    \glossxtrsetpopts 


    \glossxtrsetpopts  \glossxtrsetpopts

    -

    +class="cmtt-10">\glossxtrsetpopts


    +

    which by default just does @@ -2556,8 +2627,8 @@ which by default just does

    \glsxtrsetpopts{noindex}
    -

    You can redefine this if you want to adjust the setting when \glsxtrp is used in the +

    You can redefine this if you want to adjust the setting when \glsxtrp is used in the glossary. For example: @@ -2566,8 +2637,8 @@ glossary. For example:

    \renewcommand{\glossxtrsetpopts}{\glsxtrsetpopts{noindex=false}}
    -

    -

    For example, +

    +

    For example, @@ -2575,7 +2646,7 @@ glossary. For example:

    \glsxtrp{short}{ssi}
    -

    is equivalent to +

    is equivalent to @@ -2585,7 +2656,7 @@ glossary. For example:  
     \glsxtrshort[hyper=false,noindex]{ssi}[]%  
    } -

    in the main body of the document or +

    in the main body of the document or @@ -2595,9 +2666,9 @@ glossary. For example:  
     \glsxtrshort[noindex]{ssi}[]%  
    } -

    inside the glossary. (Note the post-link hook is locally disabled.) -

    If \glsxtrp{short}{ssi} occurs in a sectioning mark, it’s equivalent +

    inside the glossary. (Note the post-link hook is locally disabled.) +

    If \glsxtrp{short}{ssi} occurs in a sectioning mark, it’s equivalent to @@ -2606,61 +2677,61 @@ to

    {\glsxtrheadshort{ssi}}
    -

    (which recognises the headuc

    (which recognises the headuc attribute.) -

    If hyperref

    If hyperref has been loaded, then the bookmark will use \glsentryfield⟩ +class="cmtt-10">\glsentry⟨field⟩ (\glsentryshort{ssi} in the above example). -

    There are similar commands -


    \Glsxtrp \glsentryshort{ssi} in the above example). +

    There are similar commands +


    \Glsxtrp  \Glsxtrp{field}{label}

    -

    +class="cmtt-10">\Glsxtrp{⟨field}{label}


    +

    for first letter upper case and -


    \Glsxtrp 


    \Glsxtrp  \GLSxtrp{field}{label}

    -

    +class="cmtt-10">\GLSxtrp{⟨field}{label}


    +

    for all upper case. -

    If you use any of the case-changing commands, such as \Gls

    If you use any of the case-changing commands, such as \Gls or \Glstext\Glstext, (either all caps or first letter upper casing) don’t use any of the linking commands, such as \gls\gls or \glstext\glstext, in the definition of entries for any of the fields that may be used by those case-changing commands.
    -

    -

    You can, with care, protect against issue 

    +

    You can, with care, protect against issue 1 by inserting an empty group at the start if the long form starts with a command that breaks the first letter uppercasing commands like \Gls, but you still won’t be able to use the all caps commands, such +class="cmtt-10">\Gls, but you still won’t be able to use the all caps commands, such as \GLS. -

    If you really need nested commands, the safest method is +class="cmtt-10">\GLS. +

    If you really need nested commands, the safest method is @@ -2669,8 +2740,8 @@ class="ecti-1000">really need nested commands, the safest method is \newabbreviation{shtml}{shtml}{{}\glsxtrp{short}{ssi} enabled  
    \glsxtrp{short}{html}}

    -

    but be aware that it may have some unexpected results occasionally. -

    Example document: +

    but be aware that it may have some unexpected results occasionally. +

    Example document: @@ -2700,28 +2771,29 @@ class="ecti-1000">really need nested commands, the safest method is  
    \printglossaries  
    \end{document} -

    -

    +

    +

    -

    Top

    2.5 Acronym Style Modifications

    -

    The glossaries-extra package provides a new way of dealing with abbreviations and +

    The glossaries-extra package provides a new way of dealing with abbreviations and redefines \newacronym\newacronym to use \newabbreviation (see §3 \newabbreviation (see §3 Abbreviations). The simplest way to update a document that uses \newacronym from glossaries to +class="cmtt-10">\newacronym from glossaries to glossaries-extra is do just add +class="cmss-10">glossaries-extra is do just add @@ -2729,9 +2801,9 @@ class="ecss-1000">glossaries-extra is do just add

    \setabbreviationstyle[acronym]{long-short}
    -

    before you define any entries. For example, the following document using just +

    before you define any entries. For example, the following document using just glossaries +class="cmss-10">glossaries @@ -2747,8 +2819,8 @@ class="ecss-1000">glossaries  
    \printglossaries  
    \end{document} -

    can be easily adapted to use glossaries-extra: +

    can be easily adapted to use glossaries-extra: @@ -2764,13 +2836,14 @@ class="ecss-1000">glossaries-extra:  
    \printglossaries  
    \end{document} -

    Table 

    Table 2.1 lists the nearest equivalent glossaries-extra abbreviation styles for the +class="cmss-10">glossaries-extra abbreviation styles for the predefined acronym styles provided by glossaries, but note that the new styles use +class="cmss-10">glossaries, but note that the new styles use different formatting commands. See §3.4 §3.4 Predefined Abbreviation Styles for further details.

    @@ -2778,7 +2851,7 @@ details. -


    @@ -2787,285 +2860,304 @@ details.
    Table 2.1: Old Acronym Styles \setacronymstyle{old-style-name} Verses +class="cmtt-10">\setacronymstyle{old-style-name} Verses New Abbreviation Styles \setabbreviationstyle[category]{new-style-name}
    +class="cmtt-10">\setabbreviationstyle[⟨category]{new-style-name}
    +class="td01">

    Old Style Name

    +class="cmtt-10">\renewcommand{\glsxtrfullsep}[1]{\glsacspace{#1}}

    +class="cmtt-10">\renewcommand{\glsxtrfullsep}[1]{\glsacspace{#1}}

    Old Style Name

    New Style Name

    New Style Name

    long-sc-short

    long-sc-short

    long-short-sc

    long-short-sc

    long-sm-short

    long-sm-short

    long-short-sm

    long-short-sm

    long-sp-short

    long-sp-short

    long-short

    long-short
    with \renewcommand{\glsxtrfullsep}[1]{\glsacspace{#1}}

    short-long

    short-long

    short-long

    short-long

    sc-short-long

    sc-short-long

    short-sc-long

    short-sc-long

    sm-short-long

    sm-short-long

    short-sm-long

    short-sm-long

    long-short-desc

    long-short-desc

    long-short-desc

    long-short-desc

    long-sc-short-desc

    long-sc-short-desc

    long-short-sc-desc

    long-short-sc-desc

    long-sm-short-desc

    long-sm-short-desc

    long-short-sm-desc

    long-short-sm-desc

    long-sp-short-desc

    long-sp-short-desc

    long-short-desc

    long-short-desc
    with \renewcommand{\glsxtrfullsep}[1]{\glsacspace{#1}}

    short-long-desc

    short-long-desc

    short-long-desc

    short-long-desc

    sc-short-long-desc

    sc-short-long-desc

    short-sc-long-desc

    short-sc-long-desc

    sm-short-long-desc

    sm-short-long-desc

    short-sm-long-desc

    short-sm-long-desc

    dua

    dua

    long-noshort

    long-noshort

    dua-desc

    dua-desc

    long-noshort-desc

    long-noshort-desc

    footnote

    footnote

    short-footnote

    short-footnote

    footnote-sc

    footnote-sc

    short-sc-footnote

    short-sc-footnote

    footnote-sm

    footnote-sm

    short-sm-footnote

    short-sm-footnote

    footnote-desc

    footnote-desc

    short-footnote-desc

    short-footnote-desc

    footnote-sc-desc

    footnote-sc-desc

    short-sc-footnote-desc

    short-sc-footnote-desc

    footnote-sm-desc

    footnote-sm-desc

    short-sm-footnote-desc

    short-sm-footnote-desc


    -

    The reason for introducing the new style of abbreviation commands provided by +

    The reason for introducing the new style of abbreviation commands provided by glossaries-extra is because the original acronym commands provided by glossaries are +class="cmss-10">glossaries-extra is because the original acronym commands provided by glossaries are too restrictive to work with the internal modifications made by glossaries-extra. +class="cmss-10">glossaries-extra. However, if you really want to restore the generic acronym function provided by glossaries you can use -


    \RestoreAcronyms glossaries you can use +


    \RestoreAcronyms  \RestoreAcronyms

    -

    +class="cmtt-10">\RestoreAcronyms


    +

    (before any use of \newacronym). -

    \RestoreAcronyms should not be used in combination with the newer +class="cmtt-10">\newacronym). +

    \RestoreAcronyms should not be used in combination with the newer glossaries-extra abbreviations. Don’t combine old and new style entries with the same +class="cmss-10">glossaries-extra abbreviations. Don’t combine old and new style entries with the same typetype. The original glossaries acronym mechanism doesn’t work well with the newer +class="cmss-10">glossaries acronym mechanism doesn’t work well with the newer glossaries-extra commands. -

    If you use \RestoreAcronyms, don’t use any of the commands provided by +class="cmss-10">glossaries-extra commands. +

    If you use \RestoreAcronyms, don’t use any of the commands provided by glossaries-extra intended for abbreviations (such as \glsxtrshortglossaries-extra intended for abbreviations (such as \glsxtrshort or \glsfmtshort\glsfmtshort) with entries defined via \newacronym\newacronym as it will cause unexpected results.
    -

    -

    In general, there’s rarely any need for \RestoreAcronyms. If you have a +

    +

    In general, there’s rarely any need for \RestoreAcronyms. If you have a document that uses \newacronymstyle\newacronymstyle, then it’s best to either stick with just glossaries for that document or define an equivalent abbreviation style with +class="cmss-10">glossaries for that document or define an equivalent abbreviation style with \newabbreviationstyle\newabbreviationstyle. (See §3.5 §3.5 Defining New Abbreviation Styles for further details.) -


    \glsacspace 


    \glsacspace  \glsacspace{label}

    -

    +class="cmtt-10">\glsacspace{⟨label}


    +

    The space command \glsacspace used by the long-sp-short\glsacspace used by the long-sp-short acronym style provided by glossaries is modified so that it uses -


    \glsacspacemax glossaries is modified so that it uses +


    \glsacspacemax  \glsacspacemax

    -

    +class="cmtt-10">\glsacspacemax


    +

    instead of the hard-coded 3em. This is a command not a length and so can be changed using \renewcommand. -

    Any of the new abbreviation styles that use \glsxtrfullsep\renewcommand. +

    Any of the new abbreviation styles that use \glsxtrfullsep (such as long-shortlong-short) can easily be changed to use \glsacspace with +class="cmtt-10">\glsacspace with @@ -3073,101 +3165,106 @@ class="ectt-1000">\glsacspace with

    \renewcommand*{\glsxtrfullsep}[1]{\glsacspace{#1}}
    -

    -

    The

    +

    The first use acronym font command -


    \firstacronymfont{text}

    -

    +


    \firstacronymfont{text}

    +

    is redefined to use the first use abbreviation font command \glsfirstabbrvfont\glsfirstabbrvfont. This will be reset if you use \RestoreAcronyms. -

    The subsequent use acronym font command -


    \acronymfont{text}

    -

    +class="cmtt-10">\RestoreAcronyms. +

    The subsequent use acronym font command +


    \acronymfont{text}

    +

    is redefined to use the subsequent use abbreviation font command \glsabbrvfont\glsabbrvfont. This will be reset if you use \RestoreAcronyms. +class="cmtt-10">\RestoreAcronyms.

    -

    Top

    2.6 Glossary Style Modifications

    -

    The default value of \glslistdottedwidth

    The default value of \glslistdottedwidth is changed so that it’s set at the start of the document (if it hasn’t been changed in the preamble). This should take into account situations where \hsize isn’t set until the start of the +class="cmtt-10">\hsize isn’t set until the start of the document. -

    +

    -

    Top

    2.6.1 Style Hooks

    -

    The commands \glossentryname

    The commands \glossentryname and \glossentrydesc\glossentrydesc are modified to take into account the glossnameglossname, glossdescglossdesc and glossdescfontglossdescfont attributes (see §5 §5 Categories). This means you can make simple case-changing modifications to the name and description without defining a new glossary style. -

    There is a hook after \glossentryname

    There is a hook after \glossentryname and \Glossentryname\Glossentryname: -


    \glsxtrpostnamehook 


    \glsxtrpostnamehook  \glsxtrpostnamehook{label}

    -

    +class="cmtt-10">\glsxtrpostnamehook{⟨label}


    +

    By default this checks the indexnameindexname attribute. If the attribute exists for the category to which the label belongs, then the name is automatically indexed using -


    \glsxtrdoautoindexname


    \glsxtrdoautoindexname{label}{indexname}

    -

    +class="cmtt-10">{⟨label}{indexname}


    +

    See §7 §7 Auto-Indexing for further details. -

    As from version 1.04, the post-name hook \glsxtrpostnamehook will also use +

    As from version 1.04, the post-name hook \glsxtrpostnamehook will also use \glsxtrpostnamecategory⟩ if it exists. You can use \glscurrententrylabel\glsxtrpostname⟨category⟩ if it exists. You can use \glscurrententrylabel to obtain the entry label with the definition of this command. For example, suppose you are using a glossary style the doesn’t display the symbol, you can @@ -3181,47 +3278,47 @@ category: \newcommand*{\glsxtrpostnamesymbol}{\space  
     (\glsentrysymbol{\glscurrententrylabel})}

    -

    -

    The post-description code used within the glossary is modified so that it also +

    +

    The post-description code used within the glossary is modified so that it also does -


    \glsxtrpostdescription 


    \glsxtrpostdescription  \glsxtrpostdescription

    -

    +class="cmtt-10">\glsxtrpostdescription


    +

    This occurs before the original \glspostdescription, so if the nopostdot=false\glspostdescription, so if the nopostdot=false option is used, it will be inserted before the terminating full stop. -

    This new command will do \glsxtrpostdesccategory⟩ if it exists, where +

    This new command will do \glsxtrpostdesccategory⟩ if it exists, where ⟨category⟩ is the category label associated with the current entry. For example +class="cmti-10">category⟩ is the category label associated with the current entry. For example \glsxtrpostdescgeneral for entries with the category set to general\glsxtrpostdescgeneral for entries with the category set to general or \glsxtrpostdescacronym for entries with the category set to acronym\glsxtrpostdescacronym for entries with the category set to acronym. -

    Since both \glossentry and \subglossentry set -


    \glscurrententrylabel 

    Since both \glossentry and \subglossentry set +


    \glscurrententrylabel  \glscurrententrylabel

    -

    +class="cmtt-10">\glscurrententrylabel


    +

    to the label for the current entry, you can use this within the definition of these post-description hooks if you need to reference the label. -

    For example, suppose you want to insert the plural form in brackets after the +

    For example, suppose you want to insert the plural form in brackets after the description in the glossary, but only for entries in the generalgeneral category, then you could do: @@ -3232,89 +3329,90 @@ do: \renewcommand{\glsxtrpostdescgeneral}{\space  
     (plural: \glsentryplural{\glscurrententrylabel})} -

    This means you don’t have to define a custom glossary style, which you may find +

    This means you don’t have to define a custom glossary style, which you may find more complicated. (It also allows more flexibility if you decide to change the underlying glossary style.) -

    This feature can’t be used for glossary styles that ignore \glspostdescription or if +

    This feature can’t be used for glossary styles that ignore \glspostdescription or if you redefine \glspostdescription without including \glsxtrpostdescription. +class="cmtt-10">\glspostdescription without including \glsxtrpostdescription. (For example, if you redefine \glspostdescription to do nothing instead of using +class="cmtt-10">\glspostdescription to do nothing instead of using the nopostdotnopostdot option to suppress the terminating full stop.) See §2.6.3 §2.6.3 The glossaries-extra-stylemods Package to patch the predefined styles provided by glossaries +class="cmss-10">glossaries-extra-stylemods Package to patch the predefined styles provided by glossaries that are missing \glspostdescription.
    -

    -

    +class="cmtt-10">\glspostdescription.

    +

    +

    -

    Top

    2.6.2 Number List

    -

    The

    The number list is now placed inside the argument of -


    \GlsXtrFormatLocationList 


    \GlsXtrFormatLocationList  \GlsXtrFormatLocationList{number list} +class="cmtt-10">\GlsXtrFormatLocationList{⟨number list}

    -

    +

    This is internally used by \glossaryentrynumbers. The nonumberlist\glossaryentrynumbers. The nonumberlist option redefines \glossaryentrynumbers so that it doesn’t display the \glossaryentrynumbers so that it doesn’t display the number list, but it still saves the number list in case it’s required. -

    If you want to suppress the

    If you want to suppress the number list always use the nonumberlistnonumberlist option instead of redefining \glossaryentrynumbers to do nothing.
    -

    -

    If you want to, for example, change the font for the entire \glossaryentrynumbers to do nothing.

    +

    +

    If you want to, for example, change the font for the entire number list then redefine \GlsXtrFormatLocationList as appropriate. Don’t modify -\glossaryentrynumbers. -

    Sometimes users like to insert “page” or “pages” in front of the number list. This is -quite fiddly to do with the base glossaries package, but glossaries-extra provides a way -of doing this. First you need to enable this option and specify the text to display +class="cmtt-10">\GlsXtrFormatLocationList as appropriate. Don’t modify +\glossaryentrynumbers. +

    Sometimes users like to insert “page” or “pages” in front of the number list. This +is quite fiddly to do with the base glossaries package, but glossaries-extra provides a +way of doing this. First you need to enable this option and specify the text to display using: -


    \GlsXtrEnablePreLocationTag 


    \GlsXtrEnablePreLocationTag  \GlsXtrEnablePreLocationTag{page}{pages} +class="cmtt-10">\GlsXtrEnablePreLocationTag{⟨page}{pages}

    -

    +

    where ⟨page⟩ is the text to display if the page⟩ is the text to display if the number list only contains a single location and ⟨pages⟩ is the text to display otherwise. For example: +class="cmti-10">pages⟩ is the text to display otherwise. For example: @@ -3322,28 +3420,28 @@ class="ecti-1000">pages⟩ is the text to display otherwise. For exa

    \GlsXtrEnablePreLocationTag{Page: }{Pages: }
    -

    An extra run is required when using this command. -

    Use glsignore not @gobble as the format if you want to suppress the page +

    An extra run is required when using this command. +

    Use glsignore not @gobble as the format if you want to suppress the page number (and only index the entry once).
    -

    -

    See the accompanying sample file sample-pages.tex. -

    +

    +

    See the accompanying sample file sample-pages.tex. +

    -

    Top

    2.6.3 The glossaries-extra-stylemods Package

    -

    As from v1.02, glossaries-extra now includes the package glossaries-extra-stylemodsglossaries-extra-stylemods Package +

    As from v1.02, glossaries-extra now includes the package glossaries-extra-stylemods that will redefine the predefined styles to include the post-description hook (for those that are missing it). You will need to make sure the styles have already been defined before loading glossaries-extra. For example: +class="cmss-10">glossaries-extra. For example: @@ -3353,13 +3451,13 @@ class="ecss-1000">glossaries-extra. For example:  
    \usepackage{glossary-longragged}  
    \usepackage{glossaries-extra-stylemods}

    -

    Alternatively you can load glossary-name.sty at the same time by passing ⟨name⟩ +

    Alternatively you can load glossary-name.sty at the same time by passing ⟨name⟩ as a package option to glossaries-extra-stylemodsglossaries-extra-stylemods. For example: @@ -3369,14 +3467,14 @@ class="ecss-1000">glossaries-extra-stylemods\usepackage[longragged]{glossaries-extra-stylemods}

    -

    Another option is to use the stylemods

    Another option is to use the stylemods key when you load glossaries-extra. You can +class="cmss-10">glossaries-extra. You can omit a value if you only want to use the predefined styles that are automatically loaded by glossaries (for example, the long3colglossaries (for example, the long3col style): @@ -3385,8 +3483,8 @@ class="ecss-1000">long3col \usepackage[style=long3col,stylemods]{glossaries-extra}

    -

    Or the value of stylemods

    Or the value of stylemods may be a comma-separated list of the style package identifiers. For example: @@ -3396,7 +3494,7 @@ identifiers. For example:

    \usepackage[style=mcoltree,stylemods=mcols]{glossaries-extra}
    -

    Remember to group the value if it contains any commas: +

    Remember to group the value if it contains any commas: @@ -3404,116 +3502,116 @@ identifiers. For example:

    \usepackage[stylemods={mcols,longbooktabs}]{glossaries-extra}
    -

    -

    Note that the inline

    +

    Note that the inline style is dealt with slightly differently. The original definition provided by the glossary-inlineglossary-inline package uses \glspostdescription at the end of the +class="cmtt-10">\glspostdescription at the end of the glossary (not after each entry description) within the definition of \glspostinline. +class="cmtt-10">\glspostinline. The style modification changes this so that \glspostinline just does a full stop +class="cmtt-10">\glspostinline just does a full stop followed by space factor adjustment, and the description \glsinlinedescformat and +class="cmtt-10">\glsinlinedescformat and sub-entry description formats \glsinlinesubdescformat are redefined to include +class="cmtt-10">\glsinlinesubdescformat are redefined to include \glsxtrpostdescription (not \glspostdescription). This means that the +class="cmtt-10">\glsxtrpostdescription (not \glspostdescription). This means that the modified inlineinline style isn’t affected by the nopostdotnopostdot option, but the post-description category hook can still be used. -

    As from version 1.05, the glossaries-extra-stylemods package provides some +

    As from version 1.05, the glossaries-extra-stylemods package provides some additional commands for use with the alttreealttree style to make it easier to modify. These commands are only defined if the glossary-treeglossary-tree package has already been loaded, which is typically the case unless the notreenotree option has been used when loading glossaries. -


    \eglssetwidest glossaries. +


    \eglssetwidest  \eglssetwidest[level]{name}

    -

    +class="cmtt-10">\eglssetwidest[⟨level]{name}


    +

    This is like \glssetwidest (provided by glossary-tree\glssetwidest (provided by glossary-tree) but performs a protected expansion on ⟨name⟩. This has a localised effect. For a global setting, use -


    \xglssetwidest name⟩. This has a localised effect. For a global setting, use +


    \xglssetwidest  \xglssetwidest[level]{name}

    -

    +class="cmtt-10">\xglssetwidest[⟨level]{name}


    +

    The widest entry value can later be retrieved using -


    \glsgetwidestname 


    \glsgetwidestname  \glsgetwidestname

    -

    +class="cmtt-10">\glsgetwidestname


    +

    for the top-level entries and -


    \glsgetwidestsubname 


    \glsgetwidestsubname  \glsgetwidestsubname{level}

    -

    +class="cmtt-10">\glsgetwidestsubname{⟨level}


    +

    for sub-entries, where ⟨level⟩ is the level number. -

    The command \glsfindwidesttoplevelname provided by glossary-treelevel⟩ is the level number. +

    The command \glsfindwidesttoplevelname provided by glossary-tree has a CamelCase synonym: -


    \glsFindWidestTopLevelName 


    \glsFindWidestTopLevelName  \glsFindWidestTopLevelName[glossary list] +class="cmtt-10">\glsFindWidestTopLevelName[⟨glossary list]

    -

    +

    Similar commands are also provided: -


    \glsFindWidestUsedTopLevelName 


    \glsFindWidestUsedTopLevelName  \glsFindWidestUsedTopLevelName[glossary +class="cmtt-10">\glsFindWidestUsedTopLevelName[⟨glossary list]

    -

    +class="cmitt-10">list⟩]


    +

    This has an additional check that the entry has been used. Naturally this is only useful if the glossaries that use the alttreealttree style occur at the end of the document. This command should be placed just before the start of the glossary. (Alternatively, @@ -3521,526 +3619,529 @@ This command should be placed just before the start of the glossary. (Alternativ place it at the end of the document and save the value in the auxiliary file for the next run.) -


    \glsFindWidestUsedAnyName 


    \glsFindWidestUsedAnyName  \glsFindWidestUsedAnyName[glossary list] +class="cmtt-10">\glsFindWidestUsedAnyName[⟨glossary list]

    -

    +

    This is like the previous command but if doesn’t check the parentparent key. This is useful if all levels should have the same width for the name. -


    \glsFindWidestAnyName 


    \glsFindWidestAnyName  \glsFindWidestAnyName[glossary list]

    -

    +class="cmtt-10">\glsFindWidestAnyName[⟨glossary list]


    +

    This is like the previous command but doesn’t check if the entry has been used. -


    \glsFindWidestUsedLevelTwo 


    \glsFindWidestUsedLevelTwo  \glsFindWidestUsedLevelTwo[glossary list] +class="cmtt-10">\glsFindWidestUsedLevelTwo[⟨glossary list]

    -

    +

    This is like \glsFindWidestUsedTopLevelName but also sets the first two sub-levels +class="cmtt-10">\glsFindWidestUsedTopLevelName but also sets the first two sub-levels as well. Any entry that has a great-grandparent is ignored. -


    \glsFindWidestLevelTwo 


    \glsFindWidestLevelTwo  \glsFindWidestLevelTwo[glossary list] +class="cmtt-10">\glsFindWidestLevelTwo[⟨glossary list]

    -

    +

    This is like the previous command but doesn’t check if the entry has been used. -


    \glsFindWidestUsedAnyNameSymbol 


    \glsFindWidestUsedAnyNameSymbol  \glsFindWidestUsedAnyNameSymbol -[glossary list]{register}

    -

    +class="cmtt-10">\glsFindWidestUsedAnyNameSymbol +[glossary list]{register}


    +

    This is like \glsFindWidestUsedAnyName but also measures the symbol. The length +class="cmtt-10">\glsFindWidestUsedAnyName but also measures the symbol. The length of the widest symbol is stored in ⟨register⟩. -


    \glsFindWidestAnyNameSymbol register⟩. +


    \glsFindWidestAnyNameSymbol  \glsFindWidestAnyNameSymbol[glossary -list]{register}

    -

    +class="cmtt-10">\glsFindWidestAnyNameSymbol[⟨glossary +list]{register}


    +

    This is like the previous command but it doesn’t check if the entry has been used. -


    \glsFindWidestUsedAnyNameSymbolLocation 


    \glsFindWidestUsedAnyNameSymbolLocation  \glsFindWidestUsedAnyNameSymbolLocation -[glossary list]{symbol register}{location register}

    -

    +class="cmtt-10">\glsFindWidestUsedAnyNameSymbolLocation +[glossary list]{symbol register}{location register}


    +

    This is like \glsFindWidestUsedAnyNameSymbol but also measures the \glsFindWidestUsedAnyNameSymbol but also measures the number list. This requires \glsentrynumberlist\glsentrynumberlist (see the glossaries user manual). The length of +class="cmss-10">glossaries user manual). The length of the widest symbol is stored in ⟨symbol register⟩ and the length of the widest symbol register⟩ and the length of the widest number list is stored in ⟨location register⟩. -


    \glsFindWidestAnyNameSymbolLocation location register⟩. +


    \glsFindWidestAnyNameSymbolLocation  \glsFindWidestAnyNameSymbolLocation -[glossary list]{symbol register}{location register}

    -

    +class="cmtt-10">\glsFindWidestAnyNameSymbolLocation +[glossary list]{symbol register}{location register}


    +

    This is like the previous command but it doesn’t check if the entry has been used. -


    \glsFindWidestUsedAnyNameLocation 


    \glsFindWidestUsedAnyNameLocation  \glsFindWidestUsedAnyNameLocation +class="cmtt-10">\glsFindWidestUsedAnyNameLocation [glossary list]{register}

    +class="cmtt-10">[⟨glossary list]{register}

    -

    +

    This is like \glsFindWidestUsedAnyNameSymbolLocation but doesn’t measure the +class="cmtt-10">\glsFindWidestUsedAnyNameSymbolLocation but doesn’t measure the symbol. The length of the widest number list is stored in ⟨register⟩. -


    \glsFindWidestAnyNameLocation register⟩. +


    \glsFindWidestAnyNameLocation  \glsFindWidestAnyNameLocation[glossary -list]{register}

    -

    +class="cmtt-10">\glsFindWidestAnyNameLocation[⟨glossary +list]{register}


    +

    This is like the previous command but doesn’t check if the entry has been used. -

    The layout of the symbol, description and

    The layout of the symbol, description and number list is governed by -


    \glsxtralttreeSymbolDescLocation 


    \glsxtralttreeSymbolDescLocation  \glsxtralttreeSymbolDescLocation -{label}{number list}

    -

    +class="cmtt-10">\glsxtralttreeSymbolDescLocation +{label}{number list}


    +

    for top-level entries and -


    \glsxtralttreeSubSymbolDescLocation 


    \glsxtralttreeSubSymbolDescLocation  \glsxtralttreeSubSymbolDescLocation -{label}{number list}

    -

    +class="cmtt-10">\glsxtralttreeSubSymbolDescLocation +{label}{number list}


    +

    for sub-entries. -

    There is now a user level command that performs the initialisation for the alttree

    There is now a user level command that performs the initialisation for the alttree style: -


    \glsxtralttreeInit 


    \glsxtralttreeInit  \glsxtralttreeInit

    -

    -

    The paragraph indent for subsequent paragraphs in multi-paragraph descriptions +class="cmtt-10">\glsxtralttreeInit


    +

    +

    The paragraph indent for subsequent paragraphs in multi-paragraph descriptions is provided by the length -


    \glsxtrAltTreeIndent 


    \glsxtrAltTreeIndent  \glsxtrAltTreeIndent

    -

    -

    For additional commands that are available with the alttree\glsxtrAltTreeIndent


    +

    +

    For additional commands that are available with the alttree style, see the documented code (glossaries-extra-code.pdf). For examples, see the +class="cmtt-10">glossaries-extra-code.pdf). For examples, see the accompanying sample files sample-alttree.tex, sample-alttree-sym.tex and +class="cmtt-10">sample-alttree.tex, sample-alttree-sym.tex and sample-alttree-marginpar.tex. +class="cmtt-10">sample-alttree-marginpar.tex.

    -

    -

    +

    Top

    3. Abbreviations

    -

    Abbreviations include acronyms (words formed from initial letters, such as -“laser”), initialisms (initial letters of a phrase, such as “html”, that aren’t pronounced -as words) and contractions (where parts of words are omitted, often replaced by an -apostrophe, such as “don’t”). The “acronym” code provided by the glossaries -package is misnamed as it’s more often than not used for initialisms instead. +

    Abbreviations include acronyms (words formed from initial letters, such as +“laser”), initialisms (initial letters of a phrase, such as “html”, that aren’t +pronounced as words) and contractions (where parts of words are omitted, often +replaced by an apostrophe, such as “don’t”). The “acronym” code provided by the +glossaries package is misnamed as it’s more often than not used for initialisms instead. Acronyms tend not to be expanded on expanded on first use (although they may need to be described for readers unfamiliar with the term). They are therefore +class="cmti-10">described for readers unfamiliar with the term). They are therefore more like a regular term, which may or may not require a description in the glossary. -

    The glossaries-extra package corrects this misnomer, and provides better +

    The glossaries-extra package corrects this misnomer, and provides better abbreviation handling, with -


    \newabbreviation 


    \newabbreviation  \newabbreviation[options]{label}{short}{long} +class="cmtt-10">\newabbreviation[⟨options]{label}{short}{long}

    -

    -

    This sets the category

    +

    This sets the category key to abbreviation by default, but that value may be +class="cmtt-10">abbreviation by default, but that value may be overridden in ⟨options⟩. The category may have attributes that modify the way +class="cmti-10">options⟩. The category may have attributes that modify the way abbreviations are defined. For example, the insertdotsinsertdots attribute will automatically insert full stops (periods) into ⟨short⟩ or the noshortpluralshort⟩ or the noshortplural attribute will set the default value of the shortpluralshortplural key to just ⟨short⟩ (without appending the plural suffix). See §5 +class="cmti-10">short⟩ (without appending the plural suffix). See §5 Categories for further details. -

    See §2.4

    See §2.4 Nested Links regarding the pitfalls of using commands like \gls\gls or \glsxtrshort\glsxtrshort within ⟨short⟩ or ⟨long⟩. -

    Make sure that you set the category attributes before defining new abbreviations +class="cmti-10">short⟩ or ⟨long⟩. +

    Make sure that you set the category attributes before defining new abbreviations or they may not be correctly applied.
    -

    -

    The \newacronym

    +

    The \newacronym command provided by the glossaries package is redefined by +class="cmss-10">glossaries package is redefined by glossaries-extra to use \newabbreviation with the categoryglossaries-extra to use \newabbreviation with the category set to acronym (see also +class="cmtt-10">acronym (see also §2.5 §2.5 Acronym Style Modifications) so -


    \newacronym 


    \newacronym  \newacronym[options]{label}{short}{long}

    -

    +class="cmtt-10">\newacronym[⟨options]{label}{short}{long}


    +

    is now equivalent to
    \newabbreviation[type=\acronymtype,category=acronym,options] +class="cmtt-10">\newabbreviation[type=\acronymtype,category=acronym,
    options] {label} +class="cmtt-10">{⟨label} {short} +class="cmtt-10">{⟨short} {long} +class="cmtt-10">{⟨long}
    -

    The \newabbreviation command is superficially similar to the glossaries +

    The \newabbreviation command is superficially similar to the glossaries package’s \newacronym but you can apply different styles to different categories. The +class="cmtt-10">\newacronym but you can apply different styles to different categories. The default style is short-nolongshort-nolong for entries in the acronymacronym category and short-longshort-long for entries in the abbreviationabbreviation category. (These aren’t the same as the acronym styles provided by the glossaries package, although they may produce similar +class="cmss-10">glossaries package, although they may produce similar results.) -

    The short form is displayed within commands like \gls using -


    \glsfirstabbrvfont 

    The short form is displayed within commands like \gls using +


    \glsfirstabbrvfont  \glsfirstabbrvfont{short-form}

    -

    +class="cmtt-10">\glsfirstabbrvfont{⟨short-form}


    +

    on first use and -


    \glsabbrvfont 


    \glsabbrvfont  \glsabbrvfont{short-form}

    -

    +class="cmtt-10">\glsabbrvfont{⟨short-form}


    +

    for subsequent use. -

    These commands (\glsfirstabbrvfont and \glsabbrvfont) are reset by the +

    These commands (\glsfirstabbrvfont and \glsabbrvfont) are reset by the abbreviation styles and whenever an abbreviation is used by commands like \gls +class="cmtt-10">\gls (but not by commands like \glsentryshort\glsentryshort) so don’t try redefining them outside of an abbreviation style.
    -

    -

    If you use the long-short

    +

    If you use the long-short style, \glsabbrvfont is redefine to use -


    \glsabbrvdefaultfont \glsabbrvfont is redefine to use +


    \glsabbrvdefaultfont  \glsabbrvdefaultfont{text}

    -

    +class="cmtt-10">\glsabbrvdefaultfont{⟨text}


    +

    whereas the long-short-sclong-short-sc style redefines \glsabbrvfont to use \glsxtrscfont. If +class="cmtt-10">\glsabbrvfont to use \glsxtrscfont. If you want to use a different font-changing command you can either redefine \glsabbrvdefaultfont and use one of the base styles, such as long-short\glsabbrvdefaultfont and use one of the base styles, such as long-short, or define a new style in a similar manner to the “sc”, “sm” or “em” styles. -

    Similarly the basic styles redefine \glsfirstabbrvfont to use -


    \glsfirstabbrvdefaultfont 

    Similarly the basic styles redefine \glsfirstabbrvfont to use +


    \glsfirstabbrvdefaultfont  \glsfirstabbrvdefaultfont{short-form} +class="cmtt-10">\glsfirstabbrvdefaultfont{⟨short-form}

    -

    +

    whereas the font modifier styles, such as long-short-sclong-short-sc, use their own custom command, such as \glsfirstscfont. -

    The commands that display the full form for abbreviations use \glsfirstabbrvfont +class="cmtt-10">\glsfirstscfont. +

    The commands that display the full form for abbreviations use \glsfirstabbrvfont to display the short form and -


    \glsfirstlongfont 


    \glsfirstlongfont  \glsfirstlongfont{long-form}

    -

    +class="cmtt-10">\glsfirstlongfont{⟨long-form}


    +

    to display the long form on first use or for the inline full format. Commands like \glsxtrlong use -


    \glslongfont \glsxtrlong use +


    \glslongfont  \glslongfont{long-form}

    -

    +class="cmtt-10">\glslongfont{⟨long-form}


    +

    instead. -

    As with \glsabbrvfont

    As with \glsabbrvfont, this command is changed by all styles. Currently all predefined abbreviation styles, except the “long-em” (emphasize long form) versions, provided by glossaries-extra redefine \glsfirstlongfont to +class="cmss-10">glossaries-extra redefine \glsfirstlongfont to use -


    \glsfirstlongdefaultfont 


    \glsfirstlongdefaultfont  \glsfirstlongdefaultfont{long-form} +class="cmtt-10">\glsfirstlongdefaultfont{⟨long-form}

    -

    +

    and \glslongfont to use -


    \glslongdefaultfont \glslongfont to use +


    \glslongdefaultfont  \glslongdefaultfont{long-form}

    -

    -

    You can redefine these command if you want to change the font used by the long +class="cmtt-10">\glslongdefaultfont{⟨long-form}


    +

    +

    You can redefine these command if you want to change the font used by the long form for all your abbreviations (except for the emphasize-long styles), or you can define your own abbreviation style that provides a different format for only those abbreviations defined with that style. -

    The “long-em” (emphasize long) styles use -


    \glsfirstlongemfont 

    The “long-em” (emphasize long) styles use +


    \glsfirstlongemfont  \glsfirstlongemfont{long-form}

    -

    +class="cmtt-10">\glsfirstlongemfont{⟨long-form}


    +

    instead of \glsfirstlongdefaultfont{long-form} and -


    \glslongemfont \glsfirstlongdefaultfont{⟨long-form} and +


    \glslongemfont  \glslongemfont{long-form}

    -

    +class="cmtt-10">\glslongemfont{⟨long-form}


    +

    instead of \glslongdefaultfont{long-form}. The first form \glsfirstlongemfont +class="cmtt-10">\glslongdefaultfont{⟨long-form}. The first form \glsfirstlongemfont is initialised to use \glslongemfont. -

    Note that by default inserted material (provided in the final optional argument of +class="cmtt-10">\glslongemfont. +

    Note that by default inserted material (provided in the final optional argument of commands like \gls), is placed outside the font command in the predefined styles. To +class="cmtt-10">\gls), is placed outside the font command in the predefined styles. To move it inside, use: -


    \glsxtrinsertinsidetrue 


    \glsxtrinsertinsidetrue  \glsxtrinsertinsidetrue

    -

    +class="cmtt-10">\glsxtrinsertinsidetrue


    +

    This applies to all the predefined styles. For example: @@ -4051,121 +4152,122 @@ This applies to all the predefined styles. For example:  
    \renewcommand*{\glsfirstlongdefaultfont}[1]{\emph{#1}}  
    \glsxtrinsertinsidetrue

    -

    This will make the long form and the inserted text emphasized, whereas the default +

    This will make the long form and the inserted text emphasized, whereas the default (without \glsxtrinsertinsidetrue) would place the inserted text outside of the +class="cmtt-10">\glsxtrinsertinsidetrue) would place the inserted text outside of the emphasized font. -

    Note that for some styles, such as the short-long

    Note that for some styles, such as the short-long, the inserted text would be placed inside the font command for the short form (rather than the long form in the above example). -

    There are two types of full forms. The display full form, which is used on +

    There are two types of full forms. The display full form, which is used on first use by commands like \gls\gls and the inline full form, which is used by commands like \glsxtrfull\glsxtrfull. For some of the abbreviation styles, such as long-shortlong-short, the display and inline forms are the same. In the case of styles such as short-nolongshort-nolong or short-footnoteshort-footnote, the display and inline full forms are different. -

    These formatting commands aren’t stored in the short

    These formatting commands aren’t stored in the short, shortpluralshortplural, longlong or longplurallongplural fields, which means they won’t be used within commands like \glsentryshort (but they are used within commands like \glsxtrshort and +class="cmtt-10">\glsentryshort (but they are used within commands like \glsxtrshort and \glsfmtshort). Note that \glsxtrlong\glsfmtshort). Note that \glsxtrlong and the case-changing variants don’t use \glsfirstlongfont. +class="cmtt-10">\glsfirstlongfont.

    -

    Top

    3.1 Tagging Initials

    -

    If you would like to tag the initial letters in the long form such that those letters are +

    If you would like to tag the initial letters in the long form such that those letters are underlined in the glossary but not in the main part of the document, you can use -


    \GlsXtrEnableInitialTagging 


    \GlsXtrEnableInitialTagging  \GlsXtrEnableInitialTagging{categories} -{cs}

    -

    +class="cmtt-10">\GlsXtrEnableInitialTagging{⟨categories} +{cs}


    +

    before you define your abbreviations. -

    This command (robustly) defines ⟨cs⟩ (a control sequence) to accept a single +

    This command (robustly) defines ⟨cs⟩ (a control sequence) to accept a single argument, which is the letter (or letters) that needs to be tagged. The normal behaviour of this command within the document is to simply do its argument, but in the glossary it’s activated for those categories that have the taggingtagging attribute set to “true”. For those cases it will use -


    \glsxtrtagfont 


    \glsxtrtagfont  \glsxtrtagfont{text}

    -

    +class="cmtt-10">\glsxtrtagfont{⟨text}


    +

    This command defaults to \underline\underline{text} but may be redefined as required. -

    The control sequence ⟨cs⟩ can’t already be defined when used with the unstarred +class="cmtt-10">{⟨text} but may be redefined as required. +

    The control sequence ⟨cs⟩ can’t already be defined when used with the unstarred version of \GlsXtrEnableInitialTagging for safety reasons. The starred +class="cmtt-10">\GlsXtrEnableInitialTagging for safety reasons. The starred version will overwrite any previous definition of ⟨cs⟩. As with redefining any +class="cmti-10">cs⟩. As with redefining any commands, ensure that you don’t redefine something important. In fact, just forget the existence of the starred version and let’s pretend I didn’t mention it. -

    The first argument of \GlsXtrEnableInitialTagging is a comma-separated list +

    The first argument of \GlsXtrEnableInitialTagging is a comma-separated list of category names. The taggingtagging attribute will automatically be set for those categories. You can later set this attribute for other categories (see §5 §5 Categories) but this must be done before the glossary is displayed. -

    The accompanying sample file sample-mixtures.tex uses initial tagging for both +

    The accompanying sample file sample-mixtures.tex uses initial tagging for both the acronymacronym and abbreviationabbreviation categories: @@ -4174,8 +4276,8 @@ class="ecss-1000">abbreviation \GlsXtrEnableInitialTagging{acronym,abbreviation}{\itag}

    -

    This defines the command \itag which can be used in the definitions. For +

    This defines the command \itag which can be used in the definitions. For example: @@ -4193,368 +4295,370 @@ example:  
    \newabbreviation{xml}{XML}  
     {e\itag{x}tensible \itag{m}arkup \itag{l}anguage}

    -

    The underlining of the tagged letters only occurs in the glossary and then only for +

    The underlining of the tagged letters only occurs in the glossary and then only for entries with the taggingtagging attribute set. -

    +

    -

    Top

    3.2 Abbreviation Styles

    -

    The abbreviation style must be set before abbreviations are defined using: -


    \setabbreviationstyle 

    The abbreviation style must be set before abbreviations are defined using: +


    \setabbreviationstyle  \setabbreviationstyle[category]{style-name} +class="cmtt-10">\setabbreviationstyle[⟨category]{style-name}

    -

    +

    where ⟨style-name⟩ is the name of the style and ⟨category⟩ is the category label +class="cmti-10">style-name⟩ is the name of the style and ⟨category⟩ is the category label (abbreviation by default). New abbreviations will pick up the current style +class="cmtt-10">abbreviation by default). New abbreviations will pick up the current style according to their given category. If there is no style set for the category, the fallback is the style for the abbreviation category. Some styles may automatically +class="cmtt-10">abbreviation category. Some styles may automatically modify one or more of the attributes associated with the given category. For example, the long-noshortlong-noshort and short-nolongshort-nolong styles set the regularregular attribute to true. -

    If you want to apply different styles to groups of abbreviations, assign a +class="cmtt-10">true. +

    If you want to apply different styles to groups of abbreviations, assign a different category to each group and set the style for the given category.
    -

    -

    Note that \setacronymstyle

    +

    Note that \setacronymstyle is disabled by glossaries-extra. Use

    +class="cmss-10">glossaries-extra. Use

    \setabbreviationstyle[acronym]{style-name} +class="cmtt-10">\setabbreviationstyle[acronym]{⟨style-name}
    instead. The original acronym interface can be restored with \RestoreAcronyms\RestoreAcronyms (see §2.5 §2.5 Acronym Style Modifications). However the original acronym interface is incompatible with all the commands described here. -

    Abbreviations can be used with the standard glossaries commands, such as \gls

    Abbreviations can be used with the standard glossaries commands, such as \gls, but don’t use the acronym commands like \acrshort\acrshort (which use \acronymfont\acronymfont). The short form can be produced with: -


    \glsxtrshort 


    \glsxtrshort  \glsxtrshort[options]{label}[insert]

    -

    +class="cmtt-10">\glsxtrshort[⟨options]{label}[insert]


    +

    (Use this instead of \acrshort\acrshort.) -

    The long form can be produced with -


    \glsxtrlong 

    The long form can be produced with +


    \glsxtrlong  \glsxtrlong[options]{label}[insert]

    -

    +class="cmtt-10">\glsxtrlong[⟨options]{label}[insert]


    +

    (Use this instead of \acrlong\acrlong.) -

    The inline full form can be produced with -


    \glsxtrfull 

    The inline full form can be produced with +


    \glsxtrfull  \glsxtrfull[options]{label}[insert]

    -

    +class="cmtt-10">\glsxtrfull[⟨options]{label}[insert]


    +

    (This this instead of \acrfull\acrfull.) -

    As mentioned earlier, the inline full form may not necessarily match the format +

    As mentioned earlier, the inline full form may not necessarily match the format used on first use with \gls. For example, the short-nolong\gls. For example, the short-nolong style only displays the short form on first use, but the full form will display the long form followed by the short form in parentheses. -

    If you want to use an abbreviation in a chapter or section title, use the +

    If you want to use an abbreviation in a chapter or section title, use the commands described in §4 §4 Entries in Sectioning Titles, Headers, Captions and Contents instead.
    -

    -

    The arguments ⟨options⟩, ⟨label⟩ and ⟨insert⟩ are the same as for commands such as -\glstext. There are also analogous case-changing commands: -

    First letter upper case short form: -


    \Glsxtrshort 

    +

    The arguments ⟨options⟩, ⟨label⟩ and ⟨insert⟩ are the same as for commands such as +\glstext. There are also analogous case-changing commands: +

    First letter upper case short form: +


    \Glsxtrshort  \Glsxtrshort[options]{label}[insert]

    -

    -

    First letter upper case long form: -



    +

    +

    First letter upper case long form: +


    \Glsxtrlong  \Glsxtrlong[options]{label}[insert]

    -

    -

    First letter upper case inline full form: -



    +

    +

    First letter upper case inline full form: +


    \Glsxtrfull  \Glsxtrfull[options]{label}[insert]

    -

    -

    All upper case short form: -



    +

    +

    All upper case short form: +


    \Glsxtrshort  \GLSxtrshort[options]{label}[insert]

    -

    -

    All upper case long form: -



    +

    +

    All upper case long form: +


    \Glsxtrlong  \GLSxtrlong[options]{label}[insert]

    +class="cmtt-10">\GLSxtrlong[⟨options]{label}[insert]

    -

    -

    All upper case inline full form: -


    \GLSxtrfull 

    +

    All upper case inline full form: +


    \GLSxtrfull  \GLSxtrfull[options]{label}[insert]

    -

    -

    Plural forms are also available. -

    Short form plurals: -



    +

    +

    Plural forms are also available. +

    Short form plurals: +


    \glsxtrshortpl  \glsxtrshortpl[options]{label}[insert]

    -

    -



    +

    +


    \Glsxtrshortpl  \Glsxtrshortpl[options]{label}[insert]

    -

    -



    +

    +


    \GLSxtrshortpl  \GLSxtrshortpl[options]{label}[insert]

    -

    -

    Long form plurals: -



    +

    +

    Long form plurals: +


    \glsxtrlongpl  \glsxtrlongpl[options]{label}[insert]

    -

    -



    +

    +


    \Glsxtrlongpl  \Glsxtrlongpl[options]{label}[insert]

    -

    -



    +

    +


    \GLSxtrlongpl  \GLSxtrlongpl[options]{label}[insert]

    -

    -

    Full form plurals: -



    +

    +

    Full form plurals: +


    \glsxtrfullpl  \glsxtrfullpl[options]{label}[insert]

    -

    -



    +

    +


    \Glsxtrfullpl  \Glsxtrfullpl[options]{label}[insert]

    -

    -



    +

    +


    \GLSxtrfullpl  \GLSxtrfullpl[options]{label}[insert]

    -

    -

    Be careful about using \glsentryfull, \Glsentryfull, \glsentryfullpl and -\Glsentryfullpl. These commands will use the currently applied style rather +class="cmtt-10">\GLSxtrfullpl[⟨options]{label}[insert]

    +

    +

    Be careful about using \glsentryfull, \Glsentryfull, \glsentryfullpl and +\Glsentryfullpl. These commands will use the currently applied style rather than the style in use when the entry was defined. If you have mixed styles, you’ll need to use \glsxtrfull\glsxtrfull instead. Similarly for \glsentryshort etc. +class="cmtt-10">\glsentryshort etc.
    -

    +

    -

    +

    -

    Top

    3.3 Shortcut Commands

    -

    The abbreviation shortcut commands can be enabled using the package option +

    The abbreviation shortcut commands can be enabled using the package option shortcuts=abbreviationshortcuts=abbreviation (or shortcuts=abbrshortcuts=abbr). This defines the commands listed in table 3.1. @@ -4563,7 +4667,7 @@ href="#tab:abbrshortcuts">table 3.1. -


    @@ -4579,265 +4683,265 @@ id="TBL-3-1" />ShortcutShortcutEquivalent Command +class="cmbx-10">Equivalent Command \ab\ab \cgls\cgls \abp\abp \cglspl\cglspl \as\as \glsxtrshort\glsxtrshort \asp\asp \glsxtrshortpl\glsxtrshortpl \al\al \glsxtrlong\glsxtrlong \alp\alp \glsxtrlongpl\glsxtrlongpl \af\af \glsxtrfull\glsxtrfull \afp\afp \glsxtrfullpl\glsxtrfullpl \As\As \Glsxtrshort\Glsxtrshort \Asp\Asp \Glsxtrshortpl\Glsxtrshortpl \Al\Al \Glsxtrlong\Glsxtrlong \Alp\Alp \Glsxtrlongpl\Glsxtrlongpl \Af\Af \Glsxtrfull\Glsxtrfull \Afp\Afp \Glsxtrfullpl\Glsxtrfullpl \AS\AS \GLSxtrshort\GLSxtrshort \ASP\ASP \GLSxtrshortpl\GLSxtrshortpl \AL\AL \GLSxtrlong\GLSxtrlong \ALP\ALP \GLSxtrlongpl\GLSxtrlongpl \AF\AF \GLSxtrfull\GLSxtrfull \AFP\AFP \GLSxtrfullpl\GLSxtrfullpl \newabbr\newabbr \newabbreviation\newabbreviation

    -

    Top

    3.4 Predefined Abbreviation Styles

    -

    There are two types of abbreviation styles: those that treat the abbreviation as a +

    There are two types of abbreviation styles: those that treat the abbreviation as a regular entry (so that \gls\gls uses \glsgenentryfmt\glsgenentryfmt) and those that don’t treat the abbreviation as a regular entry (so that \gls\gls uses \glsxtrgenabbrvfmt\glsxtrgenabbrvfmt). -

    The regular entry abbreviation styles set the regular

    The regular entry abbreviation styles set the regular attribute to “true” for the category assigned to each abbreviation with that style. This means that on first use, \gls\gls uses the value of the firstfirst field and on subsequent use \gls\gls uses the value of the texttext field (and analogously for the plural and case-changing versions). The shortshort and longlong fields are set as appropriate and may be accessed through commands like \glsxtrshort\glsxtrshort. -

    The other abbreviation styles don’t modify the regular

    The other abbreviation styles don’t modify the regular attribute. The firstfirst and texttext fields (and their plural forms) are set and can be accessed through commands like \glsfirst, but they aren’t used by commands like \gls\glsfirst, but they aren’t used by commands like \gls, which instead use the short form (stored in the shortshort key) and the display full format (through commands like \glsxtrfullformat\glsxtrfullformat that are defined by the style). -

    In both cases, the

    In both cases, the first use of \gls\gls may not match the text produced by \glsfirst\glsfirst (and likewise for the plural and case-changing versions). -

    For the “sc” styles that use \textsc

    For the “sc” styles that use \textsc, be careful about your choice of fonts as some only have limited support. For example, you may not be able to combine bold and small-caps. I recommend that you at least use the fontencfontenc package with the T1 +class="cmss-10">T1 option or something similar.
    -

    -

    The “sc” styles all use -


    \glsxtrscfont 

    +

    The “sc” styles all use +


    \glsxtrscfont  \glsxtrscfont{text}

    -

    +class="cmtt-10">\glsxtrscfont{⟨text}


    +

    which is defined as @@ -4846,15 +4950,15 @@ which is defined as

    \newcommand*{\glsxtrscfont}[1]{\textsc{#1}}
    -

    and -


    \glsxtrfirstscfont 

    and +


    \glsxtrfirstscfont  \glsxtrfirstscfont{text}

    -

    +class="cmtt-10">\glsxtrfirstscfont{⟨text}


    +

    which is defined as @@ -4863,13 +4967,13 @@ which is defined as

    \newcommand*{\glsxtrfirstscfont}[1]{\glsxtrscfont{#1}}
    -

    The default plural suffix for the short form is set to -


    \glsxtrscsuffix 

    The default plural suffix for the short form is set to +


    \glsxtrscsuffix  \glsxtrscsuffix

    -

    +class="cmtt-10">\glsxtrscsuffix


    +

    This just defined as @@ -4878,29 +4982,30 @@ This just defined as

    \newcommand*{\glsxtrscsuffix}{\glstextup{\glspluralsuffix}}
    -

    The \glstextup

    The \glstextup command is provided by glossaries and is used to switch off the +class="cmss-10">glossaries and is used to switch off the small caps font for the suffix. If you override the default short plural using the shortpluralshortplural key when you define the abbreviation you will need to make the appropriate adjustment if necessary. (Remember that the default plural suffix behaviour can be modified through the use of the apospluralaposplural and noshortpluralnoshortplural attributes. See §5 §5 Categories for further details.) -

    Remember that \textsc renders lowercase letters as small capitals. Uppercase +

    Remember that \textsc renders lowercase letters as small capitals. Uppercase letters are rendered as normal uppercase letters, so if you specify the short form in uppercase, you won’t get small capitals unless you redefine \glsxtrscfont to convert +class="cmtt-10">\glsxtrscfont to convert its argument to lowercase. For example: @@ -4909,16 +5014,16 @@ its argument to lowercase. For example:

    \renewcommand*{\glsxtrscfont}[1]{\textsc{\MakeLowercase{#1}}}
    -

    -

    The “sm” styles all use -


    \glsxtrsmfont 

    +

    The “sm” styles all use +


    \glsxtrsmfont  \glsxtrsmfont{text}

    -

    +class="cmtt-10">\glsxtrsmfont{⟨text}


    +

    This is defined as: @@ -4927,15 +5032,15 @@ This is defined as:

    \newcommand*{\glsxtrsmfont}[1]{\textsmaller{#1}}
    -

    and -


    \glsxtrfirstsmfont 

    and +


    \glsxtrfirstsmfont  \glsxtrfirstsmfont{text}

    -

    +class="cmtt-10">\glsxtrfirstsmfont{⟨text}


    +

    which is defined as @@ -4944,11 +5049,11 @@ which is defined as

    \newcommand*{\glsxtrfirstsmfont}[1]{\glsxtrsmfont{#1}}
    -

    If you want to use this style, you must explicitly load the relsize

    If you want to use this style, you must explicitly load the relsize package which defines the \textsmaller\textsmaller command. If you want to easily switch between the “sc” and “sm” styles, you may find it easier to redefine this command to convert to upper case: @@ -4959,25 +5064,25 @@ case:

    \renewcommand*{\glsxtrsmfont}[1]{\textsmaller{\MakeTextUppercase{#1}}}
    -

    The default plural suffix for the short form is set to -


    \glsxtrsmsuffix 

    The default plural suffix for the short form is set to +


    \glsxtrsmsuffix  \glsxtrsmsuffix

    -

    +class="cmtt-10">\glsxtrsmsuffix


    +

    This just does \glspluralsuffix\glspluralsuffix. -

    The “em” styles all use -


    \glsabbrvemfont 

    The “em” styles all use +


    \glsabbrvemfont  \glsabbrvemfont{text}

    -

    +class="cmtt-10">\glsabbrvemfont{⟨text}


    +

    which is defined as: @@ -4986,15 +5091,15 @@ which is defined as:

    \newcommand*{\glsabbrvemfont}[1]{\emph{#1}}
    -

    and -


    \glsfirstabbrvemfont 

    and +


    \glsfirstabbrvemfont  \glsfirstabbrvemfont{text}

    -

    +class="cmtt-10">\glsfirstabbrvemfont{⟨text}


    +

    which is defined as: @@ -5003,16 +5108,16 @@ which is defined as:

    \newcommand*{\glsfirstabbrvemfont}[1]{\glsabbrvemfont{#1}}
    -

    -

    Some of the styles use -


    \glsxtrfullsep 

    +

    Some of the styles use +


    \glsxtrfullsep  \glsxtrfullsep{label}

    -

    +class="cmtt-10">\glsxtrfullsep{⟨label}


    +

    as a separator between the long and short forms. This is defined as a space by default, but may be changed as required. For example: @@ -5022,7 +5127,7 @@ default, but may be changed as required. For example:

    \renewcommand*{\glsxtrfullsep}[1]{~}
    -

    or +

    or @@ -5030,161 +5135,161 @@ default, but may be changed as required. For example:

    \renewcommand*{\glsxtrfullsep}[1]{\glsacspace{#1}}
    -

    -

    The new naming scheme for abbreviation styles is as follows:

    +

    +

    The new naming scheme for abbreviation styles is as follows:

    • field1⟩[-modifier1⟩]-field2⟩[-modifier2⟩][-user] -

      This is for the parenthetical styles. The -modifier⟩ parts may be omitted. +class="cmti-10">field1⟩[-modifier1⟩]-field2⟩[-modifier2⟩][-user] +

      This is for the parenthetical styles. The -modifier⟩ parts may be omitted. These styles display ⟨field1⟩ followed by ⟨field2⟩ in parentheses. If ⟨field2⟩ starts +class="cmti-10">field1⟩ followed by ⟨field2⟩ in parentheses. If ⟨field2⟩ starts with “no” then the parenthetical element is omitted from the display style but is included in the inline style. -

      If the -modifier⟩ part is present, then the field has a font changing command +

      If the -modifier⟩ part is present, then the field has a font changing command applied to it. -

      If the -user part is present, then the user1

      If the -user part is present, then the user1 value, if provided, is inserted into the parenthetical material . (The field used for the inserted material may be changed.) -

      Examples:

      +

      Examples:

      • long-noshort-sclong-noshort-sc: ⟨field1⟩ is the long form, the short form is set in +class="cmti-10">field1⟩ is the long form, the short form is set in smallcaps but omitted in the display style.
      • long-em-short-emlong-em-short-em: both the long form and the short form are emphasized. The short form is in parentheses.
      • long-short-emlong-short-em: the short form is emphasized but not the long form. The short form is in parentheses.
      • long-short-userlong-short-user: if the user1user1 key has been set, this produces the style ⟨long⟩ (⟨short⟩, ⟨user1⟩) otherwise it just produces ⟨long⟩ (⟨short⟩).
      +class="cmti-10">long⟩ (⟨short⟩, ⟨user1⟩) otherwise it just produces ⟨long⟩ (⟨short⟩).
  • field1⟩[-modifier1⟩]-[post]footnote -

    The display style uses ⟨field1⟩ followed by a footnote with the other field in it. If +class="cmti-10">field1⟩[-modifier1⟩]-[post]footnote +

    The display style uses ⟨field1⟩ followed by a footnote with the other field in it. If post is present then the footnote is placed after the post is present then the footnote is placed after the link-text using the post-link hook. The inline style does ⟨field1⟩ followed by the other field in +class="cmti-10">field1⟩ followed by the other field in parentheses. -

    If -modifier1⟩ is present, ⟨field1⟩ has a font-changing command applied to +

    If -modifier1⟩ is present, ⟨field1⟩ has a font-changing command applied to it. -

    Examples:

    +

    Examples:

    -

    Take care with the footnote styles. Remember that there are some situations +

    Take care with the footnote styles. Remember that there are some situations where \footnote\footnote doesn’t work.
    -

    +

  • style-desc -

    Like ⟨style⟩ but the descriptionstyle⟩-desc +

    Like ⟨style⟩ but the description key must be provided when defining abbreviations with this style. -

    Examples:

    +

    Examples:

  • -

    Not all combinations that fit the above syntax are provided. Pre-version 1.04 +

    Not all combinations that fit the above syntax are provided. Pre-version 1.04 styles that didn’t fit this naming scheme are either provided with a synonym (where the former name wasn’t ambiguous) or provided with a deprecated synonym (where the former name was confusing). The deprecated style names generate a warning using: -


    \GlsXtrWarnDeprecatedAbbrStyle 


    \GlsXtrWarnDeprecatedAbbrStyle  \GlsXtrWarnDeprecatedAbbrStyle -{old-name}{new-name}

    -

    +class="cmtt-10">\GlsXtrWarnDeprecatedAbbrStyle +{old-name}{new-name}


    +

    where ⟨old-name⟩ is the deprecated name and ⟨new-name⟩ is the preferred name. You +class="cmti-10">old-name⟩ is the deprecated name and ⟨new-name⟩ is the preferred name. You can suppress these warnings by redefining this command to do nothing. -

    +

    -

    Top

    3.4.1 Predefined Abbreviation Styles that Set the Regular Attribute

    -

    The following abbreviation styles set the regular

    The following abbreviation styles set the regular attribute to “true” for all categories that have abbreviations defined with any of these styles. @@ -5192,508 +5297,508 @@ that have abbreviations defined with any of these styles.

    short-nolongshort-nolong
    This only displays the short form on first use. The namename is set to the short form. The descriptiondescription is set to the long form. The inline full form displays ⟨short⟩ (⟨long⟩). The long form on its own can be displayed through +class="cmti-10">short⟩ (⟨long⟩). The long form on its own can be displayed through commands like \glsxtrlong\glsxtrlong.
    shortshort
    A synonym for short-nolongshort-nolong.
    short-sc-nolongshort-sc-nolong
    Like short-nolongshort-nolong but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrscfont\glsxtrscfont.
    short-scshort-sc
    A synonym for short-sc-nolongshort-sc-nolong
    short-sm-nolongshort-sm-nolong
    Like short-nolongshort-nolong but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrsmfont\glsxtrsmfont.
    short-smshort-sm
    A synonym for short-sm-nolongshort-sm-nolong.
    short-em-nolongshort-em-nolong
    Like short-nolongshort-nolong but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtremfont\glsxtremfont.
    short-emshort-em
    A synonym for short-em-nolongshort-em-nolong
    short-nolong-descshort-nolong-desc
    Like the short-nolongshort-nolong style, but the namename is set to the full form and the descriptiondescription must be supplied by the user. You may prefer to use the short-nolongshort-nolong style with the post-description hook set to display the long form and override the descriptiondescription key. (See the sample file sample-acronym-desc.tex.) +class="cmtt-10">sample-acronym-desc.tex.)
    short-descshort-desc
    A synonym for short-nolong-descshort-nolong-desc.
    short-sc-nolong-descshort-sc-nolong-desc
    Like short-nolongshort-nolong but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrscfont\glsxtrscfont.
    short-sc-descshort-sc-desc
    A synonym for short-sc-nolong-descshort-sc-nolong-desc.
    short-sm-nolong-descshort-sm-nolong-desc
    Like short-nolong-descshort-nolong-desc but redefines \glsabbrvfont to +class="cmtt-10">\glsabbrvfont to use \glsxtrsmfont\glsxtrsmfont.
    short-sm-descshort-sm-desc
    A synonym for short-sm-nolong-descshort-sm-nolong-desc.
    short-em-nolong-descshort-em-nolong-desc
    Like short-nolong-descshort-nolong-desc but redefines \glsabbrvfont to +class="cmtt-10">\glsabbrvfont to use \glsxtremfont\glsxtremfont.
    short-em-descshort-em-desc
    A synonym for short-em-nolong-descshort-em-nolong-desc.
    long-noshort-desclong-noshort-desc
    This style only displays the long form, regardless of first or subsequent use of commands \gls\gls. The short form may be accessed through commands like \glsxtrshort\glsxtrshort. The inline full form displays ⟨long⟩ +class="cmti-10">long⟩ (⟨short⟩). -

    The nameshort⟩). +

    The name and sortsort keys are set to the long form and the descriptiondescription must be provided by the user. The predefined glossary styles won’t display the short form. You can use the post-description hook to automatically append the short form to the description. The inline full form will display ⟨long⟩ +class="cmti-10">long⟩ (⟨short⟩). +class="cmti-10">short⟩).

    long-desclong-desc
    A synonym for long-noshort-desclong-noshort-desc.
    long-noshort-sc-desclong-noshort-sc-desc
    Like the long-noshort-desclong-noshort-desc style but the short form (accessed through commands like \glsxtrshort\glsxtrshort) use \glsxtrscfont\glsxtrscfont. (This style was originally called long-desc-sclong-desc-sc. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    long-noshort-sm-desclong-noshort-sm-desc
    Like long-noshort-desclong-noshort-desc but redefines \glsabbrvfont to +class="cmtt-10">\glsabbrvfont to use \glsxtrsmfont\glsxtrsmfont. (This style was originally called long-desc-smlong-desc-sm. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    long-noshort-em-desclong-noshort-em-desc
    Like long-noshort-desclong-noshort-desc but redefines \glsabbrvfont to +class="cmtt-10">\glsabbrvfont to use \glsxtremfont\glsxtremfont. The long form isn’t emphasized. (This style was originally called long-desc-emlong-desc-em. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    long-em-noshort-em-desclong-em-noshort-em-desc
    New to version 1.04, like long-noshort-desclong-noshort-desc but redefines \glsabbrvfont to use \glsxtremfont\glsabbrvfont to use \glsxtremfont. The long form uses \glsfirstlongemfont\glsfirstlongemfont and \glslongemfont\glslongemfont.
    long-noshortlong-noshort
    This style doesn’t really make sense if you don’t use the short form anywhere in the document, but is provided for completeness. This is like the long-noshort-desclong-noshort-desc style, but the namename and sortsort keys are set to the short form and the descriptiondescription is set to the long form.
    longlong
    A synonym for long-noshortlong-noshort
    long-noshort-sclong-noshort-sc
    Like the long-noshortlong-noshort style but the short form (accessed through commands like \glsxtrshort\glsxtrshort) use \glsxtrscfont\glsxtrscfont. (This style was originally called long-sclong-sc. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    long-noshort-smlong-noshort-sm
    Like long-noshortlong-noshort but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrsmfont\glsxtrsmfont. (This style was originally called long-smlong-sm. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    long-noshort-emlong-noshort-em
    This style is like long-noshortlong-noshort but redefines \glsabbrvfont +class="cmtt-10">\glsabbrvfont to use \glsxtremfont\glsxtremfont. The long form isn’t emphasized. (This style was originally called long-emlong-em. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    long-em-noshort-emlong-em-noshort-em
    New to version 1.04, this style is like long-noshortlong-noshort but redefines \glsabbrvfont to use \glsxtremfont\glsabbrvfont to use \glsxtremfont, \glsfirstlongfont to +class="cmtt-10">\glsfirstlongfont to use \glsfirstlongemfont and \glslongfont to use \glslongemfont. +class="cmtt-10">\glsfirstlongemfont and \glslongfont to use \glslongemfont. The short form isn’t used by commands like \gls\gls, but can be obtained using \glsxtrshort\glsxtrshort.
    -

    +

    -

    Top

    3.4.2 Predefined Abbreviation Styles that Don’t Set the Regular Attribute

    -

    The following abbreviation styles will set the regular

    The following abbreviation styles will set the regular attribute to “false” if it has previously been set. If it hasn’t already been set, it’s left unset. Other attributes may also be set, depending on the style.

    long-shortlong-short
    On first use, this style uses the format ⟨long⟩ (⟨short⟩). The inline +class="cmti-10">long⟩ (⟨short⟩). The inline and display full forms are the same. The namename and sortsort keys are set to the short form. (The namename key additionally includes the font command \glsabbrvfont.) The description\glsabbrvfont.) The description is set to the long form. The long and short forms are separated by \glsxtrfullsep. If you want to +class="cmtt-10">\glsxtrfullsep. If you want to insert material within the parentheses (such as a translation), try the long-short-userlong-short-user style.
    long-short-sclong-short-sc
    Like long-shortlong-short but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrscfont\glsxtrscfont.
    long-short-smlong-short-sm
    Like long-shortlong-short but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrsmfont\glsxtrsmfont.
    long-short-emlong-short-em
    Like long-shortlong-short but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtremfont\glsxtremfont.
    long-em-short-emlong-em-short-em
    New to version 1.04, this style is like long-short-emlong-short-em but redefines \glsfirstlongfont to use \glsfirstlongemfont\glsfirstlongfont to use \glsfirstlongemfont.
    long-short-userlong-short-user
    This style was introduced in version 1.04. It’s like the long-shortlong-short style but additional information can be inserted into the parenthetical material. This checks the value of the field given by -


    \glsxtruserfield 


    \glsxtruserfield  \glsxtruserfield

    -

    +class="cmtt-10">\glsxtruserfield


    +

    (which defaults to useri) using \ifglshasfielduseri) using \ifglshasfield (provided by glossaries). If the +class="cmss-10">glossaries). If the field hasn’t been set, the style behaves like the long-shortlong-short style and produces ⟨long⟩ (⟨short⟩) but if the field has been set, the contents of that field are inserted +class="cmti-10">long⟩ (⟨short⟩) but if the field has been set, the contents of that field are inserted within the parentheses in the form ⟨long⟩ (⟨short⟩, ⟨field-value⟩). The format is +class="cmti-10">long⟩ (⟨short⟩, ⟨field-value⟩). The format is governed by -


    \glsxtruserparen 


    \glsxtruserparen  \glsxtruserparen{text}{label}

    -

    +class="cmtt-10">\glsxtruserparen{⟨text}{label}


    +

    where ⟨text⟩ is the short form (for the long-short-usertext⟩ is the short form (for the long-short-user style) or the long form (for the short-long-usershort-long-user style). This command first inserts a space using \glsxtrfullsep and then the parenthetical content. The ⟨text⟩ argument +class="cmtt-10">\glsxtrfullsep and then the parenthetical content. The ⟨text⟩ argument includes the font formatting command, \glsfirstabbrvfont{short} in the +class="cmtt-10">\glsfirstabbrvfont{⟨short} in the case of the long-short-userlong-short-user style and \glsfirstlongfont{long} in the case of +class="cmtt-10">\glsfirstlongfont{⟨long} in the case of the short-long-usershort-long-user style. -

    For example: +

    For example: @@ -5705,37 +5810,37 @@ class="ecss-1000">short-long-user [user1={German Speaking \TeX\ User Group}]  
     {dante}{DANTE}{Deutschsprachige Anwendervereinigung \TeX\ e.V}

    -

    On first use, \gls{tug} will appear as: +

    On first use, \gls{tug} will appear as:

    -

    T

    TEX User Group (TUG)

    -

    whereas \gls{dante} will appear as: +

    whereas \gls{dante} will appear as:

    -

    Deutschsprachige Anwendervereinigung T

    Deutschsprachige Anwendervereinigung TEX e.V (DANTE, German Speaking TEX User Group)

    -

    The short form is formatted according to -


    \glsabbrvuserfont 

    The short form is formatted according to +


    \glsabbrvuserfont  \glsabbrvuserfont{text}

    -

    +class="cmtt-10">\glsabbrvuserfont{⟨text}


    +

    and the plural suffix is given by -


    \glsxtrusersuffix 


    \glsxtrusersuffix  \glsxtrusersuffix

    -

    -

    These may be redefined as appropriate. For example, if you want a smallcaps +class="cmtt-10">\glsxtrusersuffix


    +

    +

    These may be redefined as appropriate. For example, if you want a smallcaps style, you can just set these commands to those used by the long-short-sclong-short-sc style: @@ -5746,32 +5851,32 @@ class="ecss-1000">long-short-sc\renewcommand{\glsxtrusersuffix}{\glsxtrscsuffix}

    -

    +

    long-short-desclong-short-desc
    On first use, this style uses the format ⟨long⟩ (⟨short⟩). The +class="cmti-10">long⟩ (⟨short⟩). The inline and display full forms are the same. The namename is set to the full form. The sortsort key is set to ⟨long⟩ (⟨short⟩). Before version 1.04, this was +class="cmti-10">long⟩ (⟨short⟩). Before version 1.04, this was incorrectly set to the short form. If you want to revert back to this you can redefine -


    \glsxtrlongshortdescsort 


    \glsxtrlongshortdescsort  \glsxtrlongshortdescsort

    -

    +class="cmtt-10">\glsxtrlongshortdescsort


    +

    For example: @@ -5780,314 +5885,314 @@ class="ectt-1000">\glsxtrlongshortdescsort


    \renewcommand*{\glsxtrlongshortdescsort}{\the\glsshorttok}
    -

    The description

    The description must be supplied by the user. The long and short forms are separated by \glsxtrfullsep. +class="cmtt-10">\glsxtrfullsep.

    long-short-sc-desclong-short-sc-desc
    Like long-short-desclong-short-desc but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrscfont\glsxtrscfont.
    long-short-sm-desclong-short-sm-desc
    Like long-short-desclong-short-desc but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrsmfont\glsxtrsmfont.
    long-short-em-desclong-short-em-desc
    Like long-short-desclong-short-desc but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtremfont\glsxtremfont.
    long-em-short-em-desclong-em-short-em-desc
    New to version 1.04, this style is like long-short-em-desclong-short-em-desc but redefines \glsfirstlongfont to use \glsfirstlongemfont\glsfirstlongfont to use \glsfirstlongemfont.
    long-short-user-desclong-short-user-desc
    New to version 1.04, this style is like a cross between the long-short-desclong-short-desc style and the long-short-userlong-short-user style. The display and inline forms are as for long-short-userlong-short-user and the namename key is as long-short-desclong-short-desc. The descriptiondescription key must be supplied in the optional argument of \newabbreviation (or +class="cmtt-10">\newabbreviation (or \newacronym). The sort\newacronym). The sort key is set to ⟨long⟩ (⟨short⟩) as per the long-short-desclong⟩ (⟨short⟩) as per the long-short-desc style.
    short-longshort-long
    On first use, this style uses the format ⟨short⟩ (⟨long⟩). The inline and +class="cmti-10">short⟩ (⟨long⟩). The inline and display full forms are the same. The namename and sortsort keys are set to the short form. The descriptiondescription is set to the long form. The short and long forms are separated by \glsxtrfullsep. If you want to insert material +class="cmtt-10">\glsxtrfullsep. If you want to insert material within the parentheses (such as a translation), try the short-long-usershort-long-user style.
    short-sc-longshort-sc-long
    Like short-longshort-long but redefines \glsabbrvfont to use \glsxtrscfont\glsabbrvfont to use \glsxtrscfont.
    short-sm-longshort-sm-long
    Like short-longshort-long but redefines \glsabbrvfont to use \glsxtrsmfont\glsabbrvfont to use \glsxtrsmfont.
    short-em-longshort-em-long
    Like short-longshort-long but redefines \glsabbrvfont to use \glsxtremfont\glsabbrvfont to use \glsxtremfont.
    short-em-long-emshort-em-long-em
    New to version 1.04, this style is like short-em-longshort-em-long but redefines \glsfirstlongfont to use \glsfirstlongemfont\glsfirstlongfont to use \glsfirstlongemfont.
    short-long-usershort-long-user
    New to version 1.04. This style is like the long-short-userlong-short-user style but with the long and short forms switched. The parenthetical material is governed by the same command \glsxtruserparen\glsxtruserparen, but the first argument supplied to it is the long form instead of the short form.
    short-long-descshort-long-desc
    On first use, this style uses the format ⟨short⟩ (⟨long⟩). The inline and +class="cmti-10">short⟩ (⟨long⟩). The inline and display full forms are the same. The namename is set to the full form. The descriptiondescription must be supplied by the user. The short and long forms are separated by \glsxtrfullsep. +class="cmtt-10">\glsxtrfullsep.
    short-sc-long-descshort-sc-long-desc
    Like short-long-descshort-long-desc but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrscfont\glsxtrscfont.
    short-sm-long-descshort-sm-long-desc
    Like short-long-descshort-long-desc but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrsmfont\glsxtrsmfont.
    short-em-long-descshort-em-long-desc
    Like short-long-descshort-long-desc but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtremfont\glsxtremfont.
    short-em-long-em-descshort-em-long-em-desc
    New to version 1.04, this style is like short-em-long-descshort-em-long-desc but redefines \glsfirstlongfont to use \glsfirstlongemfont\glsfirstlongfont to use \glsfirstlongemfont.
    short-long-user-descshort-long-user-desc
    New to version 1.04, this style is like a cross between the short-long-descshort-long-desc style and the short-long-usershort-long-user style. The display and inline forms are as for short-long-usershort-long-user and the namename key is as short-long-descshort-long-desc. The descriptiondescription key must be supplied in the optional argument of \newabbreviation (or +class="cmtt-10">\newabbreviation (or \newacronym). +class="cmtt-10">\newacronym).
    short-footnoteshort-footnote
    On first use, this style displays the short form with the long form as a footnote. This style automatically sets the nohyperfirstnohyperfirst attribute to “true” for the supplied category, so the first use won’t be hyperlinked (but the footnote marker may be, if the hyperrefhyperref package is used). -

    The inline full form uses the ⟨short⟩ (⟨long⟩) style. The name

    The inline full form uses the ⟨short⟩ (⟨long⟩) style. The name is set to the short form. The descriptiondescription is set to the long form. -

    As from version 1.05, all the footnote styles use: -


    \glsfirstlongfootnotefont 

    As from version 1.05, all the footnote styles use: +


    \glsfirstlongfootnotefont  \glsfirstlongfootnotefont{text} +class="cmtt-10">\glsfirstlongfootnotefont{⟨text}

    -

    +

    to format the long form on first use or for the full form and -


    \glslongfootnotefont 


    \glslongfootnotefont  \glslongfootnotefont{text}

    -

    +class="cmtt-10">\glslongfootnotefont{⟨text}


    +

    to format the long form elsewhere (for example, when used with \glsxtrlong). -

    As from version 1.07, all the footnote styles use: -


    \glsxtrabbrvfootnote \glsxtrlong). +

    As from version 1.07, all the footnote styles use: +


    \glsxtrabbrvfootnote  \glsxtrabbrvfootnote{label}{long}

    -

    +class="cmtt-10">\glsxtrabbrvfootnote{⟨label}{long}


    +

    By default, this just does \footnote\footnote{long} (the first argument is ignored). For +class="cmtt-10">{⟨long} (the first argument is ignored). For example, to make the footnote text link to the relevant place in the glossary: @@ -6099,7 +6204,7 @@ class="ectt-1000">} (the first argument is ignored). For  
      \footnote{\glshyperlink[#2]{#1}}%  
    }

    -

    or to include the short form with a hyperlink: +

    or to include the short form with a hyperlink: @@ -6109,75 +6214,77 @@ class="ectt-1000">} (the first argument is ignored). For  
      \footnote{\glshyperlink[\glsfmtshort{#1}]{#1}: #2}%  
    }

    -

    Note that I haven’t used commands like \glsxtrshort to avoid interference +

    Note that I haven’t used commands like \glsxtrshort to avoid interference (see §2.2 §2.2 Entry Display Style Modifications and §2.4 §2.4 Nested Links).

    footnotefootnote
    A synonym for short-footnoteshort-footnote.
    short-sc-footnoteshort-sc-footnote
    Like short-footnoteshort-footnote but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrscfont\glsxtrscfont. (This style was originally called footnote-scfootnote-sc. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    short-sc-footnoteshort-sc-footnote
    Like short-footnoteshort-footnote but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrsmfont\glsxtrsmfont. (This style was originally called footnote-smfootnote-sm. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    short-em-footnoteshort-em-footnote
    Like short-footnoteshort-footnote but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtremfont\glsxtremfont. (This style was originally called footnote-emfootnote-em. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    short-postfootnoteshort-postfootnote
    This is similar to the short-footnoteshort-footnote style but doesn’t modify the category attribute. Instead it changes \glsxtrpostlinkcategory\glsxtrpostlink⟨category to insert the footnote after the link-text on first use. This will also defer the footnote until after any following punctuation character that’s recognised by \glsxtrifnextpunc\glsxtrifnextpunc. -

    The inline full form uses the ⟨short⟩ (⟨long⟩) style. The name

    The inline full form uses the ⟨short⟩ (⟨long⟩) style. The name is set to the short form. The descriptiondescription is set to the long form. Note that this style will change \glsxtrfull (and it’s variants) so that it fakes non-\glsxtrfull (and it’s variants) so that it fakes non-first use. (Otherwise the footnote would appear after the inline form.)

    postfootnotepostfootnote
    A synonym for short-postfootnoteshort-postfootnote.
    short-sc-postfootnoteshort-sc-postfootnote
    Like short-postfootnoteshort-postfootnote but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrscfont\glsxtrscfont. (This style was originally called postfootnote-scpostfootnote-sc. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    short-sm-postfootnoteshort-sm-postfootnote
    Like short-postfootnoteshort-postfootnote but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtrsmfont\glsxtrsmfont. (This style was originally called postfootnote-smpostfootnote-sm. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    short-em-postfootnoteshort-em-postfootnote
    Like short-postfootnoteshort-postfootnote but redefines \glsabbrvfont to use +class="cmtt-10">\glsabbrvfont to use \glsxtremfont\glsxtremfont. (This style was originally called postfootnote-empostfootnote-em. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
    -

    +

    -

    Top

    3.5 Defining New Abbreviation Styles

    -

    New abbreviation styles may be defined using: -


    \newabbreviationstyle 

    New abbreviation styles may be defined using: +


    \newabbreviationstyle  \newabbreviationstyle{name}{setup}{fmts} +class="cmtt-10">\newabbreviationstyle{⟨name}{setup}{fmts}

    -

    -

    where ⟨name⟩ is the name of the new style (as used in the mandatory argument of +

    +

    where ⟨name⟩ is the name of the new style (as used in the mandatory argument of \setabbreviationstyle\setabbreviationstyle). This is similar but not identical to the glossaries package’s +class="cmss-10">glossaries package’s \newacronymstyle\newacronymstyle command. -

    You can’t use styles defined by \newacronymstyle with glossaries-extra +

    You can’t use styles defined by \newacronymstyle with glossaries-extra unless you have reverted \newacronym\newacronym back to its generic definition from glossaries (using \RestoreAcronymsglossaries (using \RestoreAcronyms). The acronym styles from the glossaries +class="cmss-10">glossaries package can’t be used with abbreviations defined with \newabbreviation. +class="cmtt-10">\newabbreviation.
    -

    -

    The ⟨setup⟩ argument deals with the way the entry is defined and may +

    +

    The ⟨setup⟩ argument deals with the way the entry is defined and may set attributes for the given abbreviation category. This argument should redefine -


    \CustomAbbreviationFields 


    \CustomAbbreviationFields  \CustomAbbreviationFields

    -

    +class="cmtt-10">\CustomAbbreviationFields


    +

    to set the entry fields including the namename (defaults to the short form if omitted), sortsort, firstfirst, firstpluralfirstplural. Other fields may also be set, such as texttext, pluralplural and descriptiondescription. -

    \CustomAbbreviationFields is expanded by \newabbreviation so take care to +

    \CustomAbbreviationFields is expanded by \newabbreviation so take care to protect commands that shouldn’t be expanded.
    -

    -

    For example, the long-short

    +

    For example, the long-short style has the following in ⟨setup⟩: +class="cmti-10">setup⟩: @@ -6355,27 +6462,27 @@ class="ecti-1000">setup⟩:  
        plural={\protect\glsabbvfont{\the\glsshortpltok}},%  
        description={\the\glslongtok}}%

    -

    Note that the first

    Note that the first and firstpluralfirstplural are set even though they’re not used by \gls. -

    The ⟨setup⟩ argument may also redefine -


    \GlsXtrPostNewAbbreviation \gls. +

    The ⟨setup⟩ argument may also redefine +


    \GlsXtrPostNewAbbreviation  \GlsXtrPostNewAbbreviation

    -

    +class="cmtt-10">\GlsXtrPostNewAbbreviation


    +

    which can be used to assign attributes. (This will automatically be initialised to do nothing.) -

    For example, the short-footnote

    For example, the short-footnote includes the following in ⟨setup⟩: +class="cmti-10">setup⟩: @@ -6390,108 +6497,108 @@ class="ecti-1000">setup⟩:  
        {}%  
      }%

    -

    This sets the nohyperfirst

    This sets the nohyperfirst attribute to “true”. It also unsets the regularregular attribute if it has previously been set. Note that the nohyperfirstnohyperfirst attribute doesn’t get unset by other styles, so take care not to switch styles for the same category. -

    You can access the short, long, short plural and long plural values through the +

    You can access the short, long, short plural and long plural values through the following token registers. -

    Short value (defined by glossaries): -


    \glsshorttok 

    Short value (defined by glossaries): +


    \glsshorttok  \glsshorttok

    -

    -

    Short plural value (defined by glossaries-extra): -


    \glsshortpltok \glsshorttok

    +

    +

    Short plural value (defined by glossaries-extra): +


    \glsshortpltok  \glsshortpltok

    -

    +class="cmtt-10">\glsshortpltok


    +

    (This may be the default value or, if provided, the value provided by the user through the shortpluralshortplural key in the optional argument of \newabbreviation\newabbreviation.) -

    Long value (defined by glossaries): -


    \glslongtok 

    Long value (defined by glossaries): +


    \glslongtok  \glslongtok

    -

    -

    Long plural value (defined by glossaries-extra): -


    \glslongpltok \glslongtok

    +

    +

    Long plural value (defined by glossaries-extra): +


    \glslongpltok  \glslongpltok

    -

    +class="cmtt-10">\glslongpltok


    +

    (This may be the default value or, if provided, the value provided by the user through the longplurallongplural key in the optional argument of \newabbreviation\newabbreviation.) -

    There are two other registers available that are defined by glossaries: -


    \glslabeltok 

    There are two other registers available that are defined by glossaries: +


    \glslabeltok  \glslabeltok

    -

    +class="cmtt-10">\glslabeltok


    +

    which contains the entry’s label and -


    \glskeylisttok 


    \glskeylisttok  \glskeylisttok

    -

    +class="cmtt-10">\glskeylisttok


    +

    which contains the values provided in the optional argument of \newabbreviation\newabbreviation. -

    Remember put \the in front of the register command as in the examples above. +

    Remember put \the in front of the register command as in the examples above. The category label can be access through the command (not a register): -


    \glscategorylabel 


    \glscategorylabel  \glscategorylabel

    +class="cmtt-10">\glscategorylabel

    -

    +

    This may be used inside the definition of \GlsXtrPostNewAbbreviation. -

    If you want to base a style on an existing style, you can use -


    \GlsXtrUseAbbrStyleSetup \GlsXtrPostNewAbbreviation. +

    If you want to base a style on an existing style, you can use +


    \GlsXtrUseAbbrStyleSetup  \GlsXtrUseAbbrStyleSetup{name}

    -

    +class="cmtt-10">\GlsXtrUseAbbrStyleSetup{⟨name}


    +

    where ⟨name⟩ is the name of the existing style. For example, the short-sc-footnotename⟩ is the name of the existing style. For example, the short-sc-footnote and short-sm-footnoteshort-sm-footnote styles both simply use @@ -6500,237 +6607,238 @@ class="ecss-1000">short-sm-footnote \GlsXtrUseAbbrStyleSetup{short-footnote}

    -

    within ⟨setup⟩. -

    The ⟨fmts⟩ argument deals with the way the entry is displayed in the document. +

    within ⟨setup⟩. +

    The ⟨fmts⟩ argument deals with the way the entry is displayed in the document. This argument should redefine the following commands: -

    The default suffix for the plural short form (if not overridden by the shortplural

    The default suffix for the plural short form (if not overridden by the shortplural key): -


    \abbrvpluralsuffix 


    \abbrvpluralsuffix  \abbrvpluralsuffix

    -

    +class="cmtt-10">\abbrvpluralsuffix


    +

    (Note that this isn’t used for the plural long form, which just uses the regular \glspluralsuffix.) -

    The font used for the short form on \glspluralsuffix.) +

    The font used for the short form on first use or in the full forms: -


    \glsfirstabbrvfont 


    \glsfirstabbrvfont  \glsfirstabbrvfont{text}

    -

    -

    The font used for the short form on subsequent use or through commands like +class="cmtt-10">\glsfirstabbrvfont{⟨text}


    +

    +

    The font used for the short form on subsequent use or through commands like \glsxtrshort\glsxtrshort: -


    \glsabbrvfont 


    \glsabbrvfont  \glsabbrvfont{text}

    -

    -

    The font used for the long form on \glsabbrvfont{⟨text}


    +

    +

    The font used for the long form on first use or in the full forms: -


    \glsfirstlongfont 


    \glsfirstlongfont  \glsfirstlongfont{text}

    -

    -

    The font used for the long form in commands like \glsxtrlong use: -



    +

    +

    The font used for the long form in commands like \glsxtrlong use: +


    \glslongfont  \glslongfont{text}

    -

    -

    Display full form singular no case-change (used by \gls\glslongfont{⟨text}


    +

    +

    Display full form singular no case-change (used by \gls on first use for abbreviations without the regularregular attribute set): -


    \glsxtrfullformat 


    \glsxtrfullformat  \glsxtrfullformat{label}{insert}

    -

    -

    Display full form singular first letter converted to upper case (used by \Gls\glsxtrfullformat{⟨label}{insert}


    +

    +

    Display full form singular first letter converted to upper case (used by \Gls on first use for abbreviations without the regularregular attribute set): -


    \Glsxtrfullformat 


    \Glsxtrfullformat  \Glsxtrfullformat{label}{insert}

    -

    -

    Display full form plural no case-change (used by \glspl\Glsxtrfullformat{⟨label}{insert}


    +

    +

    Display full form plural no case-change (used by \glspl on first use for abbreviations without the regularregular attribute set): -


    \glsxtrfullplformat 


    \glsxtrfullplformat  \glsxtrfullplformat{label}{insert}

    +class="cmtt-10">\glsxtrfullplformat{⟨label}{insert}

    -

    -

    Display full form plural first letter converted to upper case (used by \Glspl

    +

    Display full form plural first letter converted to upper case (used by \Glspl on first use for abbreviations without the regularregular attribute set): -


    \Glsxtrfullplformat 


    \Glsxtrfullplformat  \Glsxtrfullplformat{label}{insert}

    -

    -

    In addition ⟨fmts⟩ may also redefine the following commands that govern the inline +class="cmtt-10">\Glsxtrfullplformat{⟨label}{insert}


    +

    +

    In addition ⟨fmts⟩ may also redefine the following commands that govern the inline full formats. If the style doesn’t redefine them, they will default to the same as the display full forms. -

    Inline singular no case-change (used by \glsentryfull

    Inline singular no case-change (used by \glsentryfull, \glsxtrfull\glsxtrfull and \GLSxtrfull\GLSxtrfull): -


    \glsxtrinlinefullformat 


    \glsxtrinlinefullformat  \glsxtrinlinefullformat{label}{insert} +class="cmtt-10">\glsxtrinlinefullformat{⟨label}{insert}

    -

    -

    Inline singular first letter converted to upper case (used by \Glsentryfull

    +

    Inline singular first letter converted to upper case (used by \Glsentryfull and \Glsxtrfull\Glsxtrfull): -


    \Glsxtrinlinefullformat 


    \Glsxtrinlinefullformat  \Glsxtrinlinefullformat{label}{insert} +class="cmtt-10">\Glsxtrinlinefullformat{⟨label}{insert}

    -

    -

    Inline plural no case-change (used by \glsentryfullpl

    +

    Inline plural no case-change (used by \glsentryfullpl, \glsxtrfullpl\glsxtrfullpl and \GLSxtrfullpl\GLSxtrfullpl): -


    \glsxtrinlinefullplformat 


    \glsxtrinlinefullplformat  \glsxtrinlinefullplformat{label}{insert} +class="cmtt-10">\glsxtrinlinefullplformat{⟨label}{insert}

    -

    -

    Inline plural first letter converted to upper case (used by \Glsentryfullpl

    +

    Inline plural first letter converted to upper case (used by \Glsentryfullpl and \Glsxtrfullpl\Glsxtrfullpl): -


    \Glsxtrinlinefullplformat 


    \Glsxtrinlinefullplformat  \Glsxtrinlinefullplformat{label}{insert} +class="cmtt-10">\Glsxtrinlinefullplformat{⟨label}{insert}

    -

    -

    If you want to provide support for glossaries-accsupp

    +

    If you want to provide support for glossaries-accsupp use the following \glsaccessxxx⟩ commands (§9.2 \glsaccess⟨xxx⟩ commands (§9.2 Accessibility Support) within the definitions of \glsxtrfullformat etc instead of the analogous \glsentryxxx⟩ commands. (If you +class="cmtt-10">\glsxtrfullformat etc instead of the analogous \glsentryxxx⟩ commands. (If you don’t use glossaries-accsuppglossaries-accsupp, they will just do the corresponding \glsentryxxx⟩ +class="cmtt-10">\glsentry⟨xxx⟩ command.) -

    For example, the short-long

    For example, the short-long style has the following in ⟨fmts⟩: +class="cmti-10">fmts⟩: @@ -6758,24 +6866,24 @@ class="ecti-1000">fmts⟩:  
        (\glsfirstlongfont{\glsaccesslongpl{##1}})%  
      }%

    -

    Since the inline full commands aren’t redefined, they default to the same as the +

    Since the inline full commands aren’t redefined, they default to the same as the display versions. -

    If you want to base a style on an existing style, you can use -


    \GlsXtrUseAbbrStyleFmts 

    If you want to base a style on an existing style, you can use +


    \GlsXtrUseAbbrStyleFmts  \GlsXtrUseAbbrStyleFmts{name}

    -

    +class="cmtt-10">\GlsXtrUseAbbrStyleFmts{⟨name}


    +

    within ⟨fmts⟩, where ⟨name⟩ is the name of the existing style. For example, the +class="cmti-10">fmts⟩, where ⟨name⟩ is the name of the existing style. For example, the short-sc-longshort-sc-long style has the following in ⟨fmts⟩: +class="cmti-10">fmts⟩: @@ -6785,8 +6893,8 @@ class="ecti-1000">fmts⟩:  
      \renewcommand*{\abbrvpluralsuffix}{\protect\glsxtrscsuffix}%  
      \renewcommand*{\glsabbrvfont}[1]{\glsxtrscfont{##1}}%

    -

    and the short-sm-long

    and the short-sm-long style has: @@ -6797,10 +6905,10 @@ class="ecss-1000">short-sm-long  \renewcommand*{\glsabbrvfont}[1]{\glsxtrsmfont{##1}}%  
      \renewcommand*{\abbrvpluralsuffix}{\protect\glsxtrsmsuffix}%

    -

    -

    The simplest examples of creating a new style based on an existing style are the +

    +

    The simplest examples of creating a new style based on an existing style are the “em” styles, such as the short-em-longshort-em-long style, which is defined as: @@ -6817,18 +6925,18 @@ class="ecss-1000">short-em-long  \renewcommand*{\glsabbrvfont}[1]{\glsxtremfont{##1}}%  
    }

    -

    +

    -

    -

    +

    Top

    4. Entries in Sectioning Titles, Headers, Captions and Contents

    -

    The glossaries user manual cautions against using commands like \gls in chapter +

    The glossaries user manual cautions against using commands like \gls in chapter or section titles. The principle problems are:

    • if you have a table of contents, the first use flag will be unset in the contents
    • if the page style in use adds the chapter or section title to the header and attempts to convert it to upper case, the entry label (in the argument of \gls etc) will be converted to upper case and the entry won’t be +class="cmtt-10">\gls etc) will be converted to upper case and the entry won’t be recognised;
    • if you use hyperrefhyperref, commands like \gls can’t be expanded to a simple +class="cmtt-10">\gls can’t be expanded to a simple string and only the label will appear in the PDF bookmark (with a warning from hyperrefhyperref);
    • if you use hyperrefhyperref, you will end up with nested hyperlinks in the table of contents.
    -

    Similar problems can also occur with captions (except for the page header and bookmark +

    Similar problems can also occur with captions (except for the page header and bookmark issues). -

    To get around all these problems, the glossaries user manual recommends using -the expandable non-hyperlink commands, such as \glsentrytext (for regular -entries) or \glsentryshort (for abbreviations). This is the simplest solution, but -doesn’t allow for special formatting that’s applied to the entry through commands -like \glstext or \glsxtrshort. This means that if, for example, you are using one -of the abbreviation styles that uses \textsc then the short form displayed with -\glsentryshort won’t use small caps. If you only have one abbreviation style in -use, you can explicitly enclose \glsentryshort{label} in the argument of -\glsabbrvfont, like this: +

    To get around all these problems, the glossaries user manual recommends +using the expandable non-hyperlink commands, such as \glsentrytext +(for regular entries) or \glsentryshort (for abbreviations). This is the +simplest solution, but doesn’t allow for special formatting that’s applied to +the entry through commands like \glstext or \glsxtrshort. This means +that if, for example, you are using one of the abbreviation styles that uses +\textsc then the short form displayed with \glsentryshort won’t use +small caps. If you only have one abbreviation style in use, you can explicitly +enclose \glsentryshort{label} in the argument of \glsabbrvfont, like +this: @@ -6892,8 +7001,8 @@ class="ectt-1000">\glsabbrvfont, like this:

    \chapter{A Chapter about \glsabbrvfont{\glsentryshort{html}}}
    -

    Or, if you are using hyperref

    Or, if you are using hyperref: @@ -6903,39 +7012,39 @@ class="ecss-1000">hyperref\texorpdfstring{\glsabbrvfont{\glsentryshort{html}}}{\glsentryshort{html}}}

    -

    -

    Since this is a bit cumbersome, you might want to define a new command to do +

    +

    Since this is a bit cumbersome, you might want to define a new command to do this for you. However, if you have mixed styles this won’t work as commands like \gls and \glsxtrshort redefine \glsabbrvfont to match the entry’s style before +class="cmtt-10">\gls and \glsxtrshort redefine \glsabbrvfont to match the entry’s style before displaying it. In this case, the above example doesn’t take into account the shifting definitions of \glsabbrvfont and will use whatever happens to be the last +class="cmtt-10">\glsabbrvfont and will use whatever happens to be the last abbreviation style in use. More complicated solutions interfere with the upper casing used by the standard page styles that display the chapter or section title in the page header using \MakeUppercase\MakeUppercase. -

    The glossaries-extra package tries to resolve this by modifying \markright

    The glossaries-extra package tries to resolve this by modifying \markright and \markboth\markboth. If you don’t like this change, you can restore their former definitions using -


    \glsxtrRevertMarks 


    \glsxtrRevertMarks  \glsxtrRevertMarks

    -

    +class="cmtt-10">\glsxtrRevertMarks


    +

    In this case, you’ll have to use the glossaries manual’s recommendations of either +class="cmss-10">glossaries manual’s recommendations of either simply using \glsentryshort (as above) or use the sectioning command’s option +class="cmtt-10">\glsentryshort (as above) or use the sectioning command’s option argument to provide an alternative for the table of contents and page header. For example: @@ -6945,390 +7054,394 @@ example:

    \chapter[A Chapter about \glsentryshort{html}]{A Chapter about \gls{html}}
    -

    -

    If you don’t revert the mark commands back with \glsxtrRevertMarks, you can +

    +

    If you don’t revert the mark commands back with \glsxtrRevertMarks, you can use the commands described below in the argument of sectioning commands. You can still use them even if the mark commands have been reverted, but only where they don’t conflict with the page style. -

    The commands listed below all use \texorpdfstring

    The commands listed below all use \texorpdfstring if hyperrefhyperref has been loaded so that the expandable non-formatted version is added to the PDF bookmarks. Note that since the commands that convert the first letter to upper case aren’t expandable, the non-case-changing version is used for the bookmarks. -

    These commands essentially behave as though you have used \glsxtrshort (or +

    These commands essentially behave as though you have used \glsxtrshort (or equivalent) with the options noindexnoindex and hyper=falsehyper=false. The text produced won’t be converted to upper case in the page headings by default. If you want the text converted to upper case you need to set the headucheaduc attribute to “true” for the appropriate category. -

    If you use one of the \textsc

    If you use one of the \textsc styles, be aware that the default fonts don’t provide bold small-caps or italic small-caps. This means that if the chapter or section title style uses bold, this may override the small-caps setting, in which case the abbreviation will just appear as lower case bold. If the heading style uses italic, the abbreviation may appear in upright small-caps, even if you have set the headuceven if you have set the headuc attribute since the all-capitals form still uses +class="cmti-10">attribute since the all-capitals form still uses \glsabbrvfont. You may want to consider using the slantsc\glsabbrvfont. You may want to consider using the slantsc package in this case.
    -

    -

    Display the short form: -


    \glsfmtshort 

    +

    Display the short form: +


    \glsfmtshort  \glsfmtshort{label}

    -

    -

    Display the plural short form: -



    +

    +

    Display the plural short form: +


    \glsfmtshortpl  \glsfmtshortpl{label}

    -

    -

    First letter upper case singular short form: -



    +

    +

    First letter upper case singular short form: +


    \Glsfmtshort  \Glsfmtshort{label}

    -

    +class="cmtt-10">\Glsfmtshort{⟨label}


    +

    (No case-change applied to PDF bookmarks.) -

    First letter upper case plural short form: -


    \Glsfmtshortpl 

    First letter upper case plural short form: +


    \Glsfmtshortpl  \Glsfmtshortpl{label}

    +class="cmtt-10">\Glsfmtshortpl{⟨label}

    -

    +

    (No case-change applied to PDF bookmarks.) -

    Display the long form: -


    \glsfmtlong 

    Display the long form: +


    \glsfmtlong  \glsfmtlong{label}

    -

    -

    Display the plural long form: -



    +

    +

    Display the plural long form: +


    \glsfmtlongpl  \glsfmtlongpl{label}

    -

    -

    First letter upper case singular long form: -



    +

    +

    First letter upper case singular long form: +


    \Glsfmtlong  \Glsfmtlong{label}

    -

    +class="cmtt-10">\Glsfmtlong{⟨label}


    +

    (No case-change applied to PDF bookmarks.) -

    First letter upper case plural long form: -


    \Glsfmtlongpl 

    First letter upper case plural long form: +


    \Glsfmtlongpl  \Glsfmtlongpl{label}

    -

    +class="cmtt-10">\Glsfmtlongpl{⟨label}


    +

    (No case-change applied to PDF bookmarks.) -

    There are similar commands for the full form, but note that these use the inline +

    There are similar commands for the full form, but note that these use the inline full form, which may be different from the full form used by \gls. -

    Display the full form: -


    \glsfmtfull \gls. +

    Display the full form: +


    \glsfmtfull  \glsfmtfull{label}

    -

    -

    Display the plural full form: -



    +

    +

    Display the plural full form: +


    \glsfmtfullpl  \glsfmtfullpl{label}

    -

    -

    First letter upper case singular full form: -



    +

    +

    First letter upper case singular full form: +


    \Glsfmtfull  \Glsfmtfull{label}

    -

    +class="cmtt-10">\Glsfmtfull{⟨label}


    +

    (No case-change applied to PDF bookmarks.) -

    First letter upper case plural full form: -


    \Glsfmtfullpl 

    First letter upper case plural full form: +


    \Glsfmtfullpl  \Glsfmtfullpl{label}

    -

    +class="cmtt-10">\Glsfmtfullpl{⟨label}


    +

    (No case-change applied to PDF bookmarks.) -

    There are also equivalent commands for the value of the text

    There are also equivalent commands for the value of the text field: -


    \glsfmttext 


    \glsfmttext  \glsfmttext{label}

    -

    -

    First letter converted to upper case: -



    +

    +

    First letter converted to upper case: +


    \Glsfmttext  \Glsfmttext{label}

    -

    +class="cmtt-10">\Glsfmttext{⟨label}


    +

    (No case-change applied to PDF bookmarks.) -

    The plural equivalents: -


    \glsfmtplural 

    The plural equivalents: +


    \glsfmtplural  \glsfmtplural{label}

    +class="cmtt-10">\glsfmtplural{⟨label}

    -

    +

    and -


    \Glsfmtplural 


    \Glsfmtplural  \Glsfmtplural{label}

    -

    -

    Similarly for the value of the first\Glsfmtplural{⟨label}


    +

    +

    Similarly for the value of the first field: -


    \glsfmtfirst 


    \glsfmtfirst  \glsfmtfirst{label}

    -

    -

    First letter converted to upper case: -



    +

    +

    First letter converted to upper case: +


    \Glsfmtfirst  \Glsfmtfirst{label}

    -

    +class="cmtt-10">\Glsfmtfirst{⟨label}


    +

    (No case-change applied to PDF bookmarks.) -

    The plural equivalents: -


    \glsfmtfirstpl 

    The plural equivalents: +


    \glsfmtfirstpl  \glsfmtfirstpl{label}

    -

    +class="cmtt-10">\glsfmtfirstpl{⟨label}


    +

    and -


    \Glsfmtfirstpl 


    \Glsfmtfirstpl  \Glsfmtfirstpl{label}

    -

    +class="cmtt-10">\Glsfmtfirstpl{⟨label}


    +

    -

    -

    +

    Top

    5. Categories

    -

    Each entry defined by \newglossaryentry

    Each entry defined by \newglossaryentry (or commands that internally use it such as \newabbreviation\newabbreviation) is assigned a category through the categorycategory key. You may add any category that you like, but since the category is a label used in the creation of some control sequences, avoid problematic characters within the category label. (So take care if you have babelbabel shorthands on that make some characters active.) -

    The use of categories can give you more control over the way entries are displayed +

    The use of categories can give you more control over the way entries are displayed in the text or glossary. Note that an entry’s category is independent of the glossary type. Be careful not to confuse categorycategory with typetype. -

    The default category assumed by \newglossaryentry is labelled general

    The default category assumed by \newglossaryentry is labelled general. Abbreviations defined with \newabbreviation have the category set to abbreviation\newabbreviation have the category set to abbreviation by default. Abbreviations defined with \newacronym have the category set to +class="cmtt-10">\newacronym have the category set to acronymacronym by default. -

    Additionally, if you have enabled \newterm

    Additionally, if you have enabled \newterm with the indexindex package option that command will set the category to indexindex by default. If you have enabled \glsxtrnewsymbol\glsxtrnewsymbol with the symbolssymbols package option, that command will set the category to symbolsymbol. If you have enabled \glsxtrnewnumber\glsxtrnewnumber with the numbersnumbers package option, that command will set the category to numbernumber. -

    You can obtain the category label for a given entry using -


    \glscategory 

    You can obtain the category label for a given entry using +


    \glscategory  \glscategory{label}

    -

    +class="cmtt-10">\glscategory{⟨label}


    +

    This is equivalent to commands like \glsentryname and so may be used in an +class="cmtt-10">\glsentryname and so may be used in an expandable context. No error is generated if the entry doesn’t exist. -

    You can test the category for a given entry using -


    \glsifcategory 

    You can test the category for a given entry using +


    \glsifcategory  \glsifcategory{entry-label}{category-label}{true -part}{false part}

    -

    +class="cmtt-10">\glsifcategory{⟨entry-label}{category-label}{true +part}{false part}


    +

    This is equivalent to

    \ifglsfieldeq\ifglsfieldeq{entry-label}{category}{category-label}{true +class="cmtt-10">{⟨entry-label}{category}{category-label}{true
    part}{false part} +class="cmitt-10">part⟩}{false part}
    so any restrictions that apply to \ifglsfieldeq also apply to \glsifcategory. -

    Each category may have a set of attributes. For example, the general\ifglsfieldeq also apply to \glsifcategory. +

    Each category may have a set of attributes. For example, the general and acronymacronym categories have the attribute regularregular set to “true” to indicate that all entries with either of those categories are regular entries (as opposed to abbreviations). This attribute is accessed by \glsentryfmt to determine whether to use +class="cmtt-10">\glsentryfmt to determine whether to use \glsgenentryfmt or \glsxtrgenabbrvfmt. -

    Other attributes recognised by glossaries-extra are: +class="cmtt-10">\glsgenentryfmt or \glsxtrgenabbrvfmt. +

    Other attributes recognised by glossaries-extra are:

    nohyperfirstnohyperfirst
    When using commands like \gls\gls this will automatically suppress the @@ -7337,72 +7450,72 @@ class="ectt-1000">\glsfirst use for entries with a category that has this attribute set to “true”. (This settings can be overridden by explicitly setting the hyper key on or - off in the optional argument of commands like \gls.) As from version 1.07, +class="cmss-10">hyper key on + or off in the optional argument of commands like \gls.) As from version 1.07, \glsfirst, \Glsfirst, \GLSfirst and their plural versions (which should +class="cmtt-10">\glsfirst, \Glsfirst, \GLSfirst and their plural versions (which should ideally behave in a similar way to the first use of \gls or \glspl) now honour +class="cmtt-10">\gls or \glspl) now honour this attribute (but not the package-wide hyperfirst=falsehyperfirst=false option, which matches the behaviour of glossariesglossaries). If you want commands these \glsfirst etc commands to ignore the nohyperfirst\glsfirst etc commands to ignore the nohyperfirst attribute then just redefine -


    \glsxtrchecknohyperfirst 


    \glsxtrchecknohyperfirst  \glsxtrchecknohyperfirst{label}

    -

    +class="cmtt-10">\glsxtrchecknohyperfirst{⟨label}


    +

    to do nothing.

    nohypernohyper
    When using commands like \gls\gls this will automatically suppress the hyperlink for entries with a category that has this attribute set to “true”. (This settings can be overridden by explicitly setting the hyperhyper key on or off in the optional argument of commands like \gls.) +class="cmtt-10">\gls.)
    indexonlyfirstindexonlyfirst
    This is similar to the indexonlyfirstindexonlyfirst package option but only for entries that have a category with this attribute set to “true”.
    discardperioddiscardperiod
    If set to “true”, the post-link-text hook will discard a full stop (period) - that follows non-plural commands like \gls or \glstext. (Provided for entries - such as abbreviations that end with a full stop.) -

    Note that this can cause a problem if you access a field that doesn’t end with a +href="#glo:linktext">link-text hook will discard a full stop + (period) that follows non-plural commands like \gls or \glstext. (Provided + for entries such as abbreviations that end with a full stop.) +

    Note that this can cause a problem if you access a field that doesn’t end with a full stop. For example: @@ -7414,12 +7527,12 @@ class="ectt-1000">\glstext. (Provided for entries  
     {dante}{DANTE e.V.}{Deutschsprachige Anwendervereinigung \TeX\  
    e.V.}

    -

    Here the short

    Here the short and longlong fields end with a full stop, but the user1user1 field doesn’t. The simplest solution in this situation is to put the sentence terminator in the final optional argument. For example: @@ -7430,186 +7543,188 @@ class="ecss-1000">user1 \glsuseri{dante}[.]

    -

    This will bring the punctuation character inside the

    This will bring the punctuation character inside the link-text and it won’t be discarded.

    pluraldiscardperiodpluraldiscardperiod
    If this attribute is set to “true” and the discardperiodand the discardperiod attribute is set to “true”, this will behave as above for the plural commands like \glspl or +class="cmtt-10">\glspl or \glsplural. +class="cmtt-10">\glsplural.
    retainfirstuseperiodretainfirstuseperiod
    If this attribute is set to “true” then the full stop won’t be discarded for first use instances, even if discardperioddiscardperiod or pluraldiscardperiodpluraldiscardperiod are set. This is useful for ⟨short⟩ (⟨long⟩) abbreviation styles where only the short form +class="cmti-10">short⟩ (⟨long⟩) abbreviation styles where only the short form has a trailing full stop..
    insertdotsinsertdots
    If this attribute is set to “true” any entry defined using \newabbreviation\newabbreviation will automatically have full stops (periods) inserted after each letter. The entry will be defined with those dots present as though they had been present in the ⟨short⟩ argument of \newabbreviation (rather than inserting them +class="cmti-10">short⟩ argument of \newabbreviation (rather than inserting them every time the entry is used). The short plural form defaults to the new dotted version of the original ⟨short⟩ form with the plural suffix +class="cmti-10">short⟩ form with the plural suffix appended. -

    If you explicitly override the short plural using the shortplural

    If you explicitly override the short plural using the shortplural key, you must explicitly insert the dots yourself (since there’s no way for the code to determine if the plural has a suffix that shouldn’t be followed by a dot).
    -

    -

    This attribute is best used with the discardperiod

    +

    This attribute is best used with the discardperiod attribute set to “true”.

    apospluralaposplural
    If this attribute is set to “true”, \newabbreviation\newabbreviation will insert an apostrophe (’) before the plural suffix for the short plural form (unless +class="cmti-10">short plural form (unless explicitly overridden with the shortpluralshortplural key). The long plural form is unaffected by this setting.
    noshortpluralnoshortplural
    If this attribute is set to “true”, \newabbreviation\newabbreviation won’t append the plural suffix for the short plural form. This means the shortshort and shortpluralshortplural values will be the same unless explicitly overridden. The apospluralThe aposplural attribute +class="cmti-10">attribute trumps the noshortpluraltrumps the noshortplural attribute. +class="cmti-10">attribute.
    headucheaduc
    If this attribute is set to “true”, commands like \glsfmtshort\glsfmtshort will use the upper case version in the page headers.
    taggingtagging
    If this attribute is set to “true”, the tagging command defined by \GlsXtrEnableInitialTagging\GlsXtrEnableInitialTagging will be activated to use \glsxtrtagfont\glsxtrtagfont in the glossary (see §3.1 §3.1 Tagging Initials).
    entrycountentrycount
    Unlike the above attributes, this attribute isn’t boolean but instead must be an integer value and is used in combination with \glsenableentrycount\glsenableentrycount (see §2.3 §2.3 Entry Counting Modifications). Leave blank or undefined for categories that shouldn’t have this facility enabled. The value of this attribute is used by \glsxtrifcounttrigger\glsxtrifcounttrigger to determine how commands such as \cgls\cgls should behave. -

    With glossaries, commands like \cgls use \cglsformat only if the previous +

    With glossaries, commands like \cgls use \cglsformat only if the previous usage count for that entry was equal to 1. With glossaries-extra the test is now +class="cmss-10">glossaries-extra the test is now for entries that have the entrycountentrycount attribute set and where the previous usage count for that entry is less than or equal to the value of that attribute.

    glossdescglossdesc
    The \glossentrydesc\glossentrydesc command (used in the predefined glossary styles) is modified by glossaries-extra to check for this attribute. The attribute may have +class="cmss-10">glossaries-extra to check for this attribute. The attribute may have one of the following values:
    • firstuc: the first letter of the description will be converted to upper +class="cmtt-10">firstuc: the first letter of the description will be converted to upper case (using \Glsentrydesc\Glsentrydesc).
    • title: the description will be used in the argument of the title casing +class="cmtt-10">title: the description will be used in the argument of the title casing command \capitalisewords\capitalisewords (provided by mfirstucmfirstuc). If you want to use a different command you can redefine: -


      \glsxtrfieldtitlecasecs 


      \glsxtrfieldtitlecasecs  \glsxtrfieldtitlecasecs{phrase cs} +class="cmtt-10">\glsxtrfieldtitlecasecs{⟨phrase cs}

      -

      +

      For example: @@ -7618,26 +7733,26 @@ class="ectt-1000">}

      \newcommand*{\glsxtrfieldtitlecasecs}[1]{\xcapitalisefmtwords*{#1}}
      -

      (Note that the argument to \glsxtrfieldtitlecasecs will be a control +

      (Note that the argument to \glsxtrfieldtitlecasecs will be a control sequence whose replacement text is the entry’s description, which is why \xcapitalisefmtwords is needed instead of \capitalisefmtwords.) +class="cmtt-10">\xcapitalisefmtwords is needed instead of \capitalisefmtwords.)

    -

    Any other values of this attribute are ignored. Remember that there are design +

    Any other values of this attribute are ignored. Remember that there are design limitations for both the first letter uppercasing and the title casing commands. See the mfirstucmfirstuc user manual for further details.

    glossdescfontglossdescfont
    (New to version 1.04) In addition to the above, the modified \glossentrydesc\glossentrydesc command also checks this attribute. If set, it should be the name of a control sequence (without the leading backslash) that takes one argument. This control sequence will be applied to the description text. For @@ -7648,38 +7763,39 @@ class="ectt-1000">\glossentrydesc \glssetcategoryattribute{general}{glossdescfont}{emph}
    -

    +

    glossnameglossname
    As glossdescglossdesc but applies to \glossentryname\glossentryname. Additionally, if this attribute is set to “uc” the name is converted to all capitals.
    indexnameindexname
    If set, the \glsxtrpostnamehook hook used at the end of \glossentyname\glsxtrpostnamehook hook used at the end of \glossentyname will index the entry using \index\index. See §7 §7 Auto-Indexing for further details.
    glossnamefontglossnamefont
    (New to version 1.04) In addition to the above, the modified \glossentryname\glossentryname command also checks this attribute. If set, it should be the name of a control sequence (without the leading backslash) that takes one argument. This control sequence will be applied to the name text. For @@ -7690,181 +7806,182 @@ class="ectt-1000">\glossentryname \glssetcategoryattribute{general}{glossnamefont}{emph} -

    Note that this overrides \glsnamefont which will only be used if this attribute +

    Note that this overrides \glsnamefont which will only be used if this attribute hasn’t been set. -

    Remember that glossary styles may additionally apply a font change, +

    Remember that glossary styles may additionally apply a font change, such as the list styles which put the name in the optional argument of \item. +class="cmtt-10">\item.

    dualindexdualindex
    If set, whenever a glossary entry has information written to the external glossary file through commands like \gls\gls and \glsadd\glsadd, a corresponding line will be written to the indexing file using \index\index. See §7 §7 Auto-Indexing for further details.
    -

    An attribute can be set using: -


    \glssetcategoryattribute 

    An attribute can be set using: +


    \glssetcategoryattribute  \glssetcategoryattribute{category-label} -{attribute-label}{value}

    -

    +class="cmtt-10">\glssetcategoryattribute{⟨category-label} +{attribute-label}{value}


    +

    where ⟨category-label⟩ is the category label, ⟨attribute-label⟩ is the attribute label and +class="cmti-10">category-label⟩ is the category label, ⟨attribute-label⟩ is the attribute label and ⟨value⟩ is the new value for the attribute. -

    There is a shortcut version to set the regularvalue⟩ is the new value for the attribute. +

    There is a shortcut version to set the regular attribute to “true”: -


    \glssetregularcategory 


    \glssetregularcategory  \glssetregularcategory{category-label} +class="cmtt-10">\glssetregularcategory{⟨category-label}

    -

    -

    If you need to lookup the category label for a particular entry, you can use the +

    +

    If you need to lookup the category label for a particular entry, you can use the shortcut command: -


    \glssetattribute 


    \glssetattribute  \glssetattribute{entry-label}{attribute-label} -{value}

    -

    +class="cmtt-10">\glssetattribute{⟨entry-label}{attribute-label} +{value}


    +

    This uses \glssetcategoryattribute with \glscategory to set the attribute. Note +class="cmtt-10">\glssetcategoryattribute with \glscategory to set the attribute. Note that this will affect all other entries that share this entry’s category. -

    You can fetch the value of an attribute for a particular category using: -


    \glsgetcategoryattribute 

    You can fetch the value of an attribute for a particular category using: +


    \glsgetcategoryattribute  \glsgetcategoryattribute{category-label} -{attribute-label}

    -

    +class="cmtt-10">\glsgetcategoryattribute{⟨category-label} +{attribute-label}


    +

    Again there is a shortcut if you need to lookup the category label for a given entry: -


    \glsgetattribute 


    \glsgetattribute  \glsgetattribute{entry-label}{attribute-label} +class="cmtt-10">\glsgetattribute{⟨entry-label}{attribute-label}

    -

    -

    You can test if an attribute has been assigned to a given category using: -


    \glshascategoryattribute 

    +

    You can test if an attribute has been assigned to a given category using: +


    \glshascategoryattribute  \glshascategoryattribute{category-label} -{attribute-label}{true code}{false code}

    -

    +class="cmtt-10">\glshascategoryattribute{⟨category-label} +{attribute-label}{true code}{false code}


    +

    This uses etoolboxetoolbox’s \ifcsvoid and does ⟨true code⟩ if the attribute has been set and +class="cmtt-10">\ifcsvoid and does ⟨true code⟩ if the attribute has been set and isn’t blank and isn’t \relax. The shortcut if you need to lookup the category label +class="cmtt-10">\relax. The shortcut if you need to lookup the category label from an entry is: -


    \glshasattribute 


    \glshasattribute  \glshasattribute{entry-label}{attribute-label}{true -code}{false code}

    -

    -

    You can test the value of an attribute for a particular category using: -


    \glsifcategoryattribute \glshasattribute{⟨entry-label}{attribute-label}{true +code}{false code}

    +

    +

    You can test the value of an attribute for a particular category using: +


    \glsifcategoryattribute  \glsifcategoryattribute{category-label} -{attribute-label}{value} {true-part}{false-part}

    -

    +class="cmtt-10">\glsifcategoryattribute{⟨category-label} +{attribute-label}{value} {true-part}{false-part}


    +

    This tests if the attribute (given by ⟨attribute-label⟩) for the category (given by +class="cmti-10">attribute-label⟩) for the category (given by ⟨category-label⟩) is set and equal to ⟨value⟩. If true, ⟨true-part⟩ is done. If the attribute +class="cmti-10">category-label⟩) is set and equal to ⟨value⟩. If true, ⟨true-part⟩ is done. If the attribute isn’t set or is set but isn’t equal to ⟨value⟩, ⟨false part⟩ is done. -

    For example: +class="cmti-10">value⟩, ⟨false part⟩ is done. +

    For example: @@ -7872,325 +7989,328 @@ class="ecti-1000">false part⟩ is done.

    \glsifcategoryattribute{general}{nohyper}{true}{NO HYPER}{HYPER}
    -

    This does “NO HYPER” if the general

    This does “NO HYPER” if the general category has the nohyper attribute set to true -otherwise if does “HYPER”. -

    With boolean-style attributes like nohypernohyper attribute set to +true otherwise if does “HYPER”. +

    With boolean-style attributes like nohyper, make sure you always test for true +class="cmtt-10">true not false in case the attribute hasn’t been set. -

    Again there’s a shortcut if you need to lookup the category label from a particular +class="cmtt-10">false in case the attribute hasn’t been set. +

    Again there’s a shortcut if you need to lookup the category label from a particular entry: -


    \glsifattribute 


    \glsifattribute  \glsifattribute{entry-label}{attribute-label}{value} -{true-part} {false-part}

    -

    -

    There’s also a shortcut to determine if a particular category has the regular\glsifattribute{⟨entry-label}{attribute-label}{value} +{true-part} {false-part}


    +

    +

    There’s also a shortcut to determine if a particular category has the regular attribute set to “true”: -


    \glsifregularcategory 


    \glsifregularcategory  \glsifregularcategory{category-label} -{true-part}{false-part}

    -

    +class="cmtt-10">\glsifregularcategory{⟨category-label} +{true-part}{false-part}


    +

    Alternatively, if you need to lookup the category for a particular entry: -


    \glsifregular 


    \glsifregular  \glsifregular{entry-label}{true-part}{false-part} +class="cmtt-10">\glsifregular{⟨entry-label}{true-part}{false-part}

    -

    +

    Note that if the regularregular attribute hasn’t be set, the above do ⟨false-part⟩. There +class="cmti-10">false-part⟩. There are also reverse commands that test if the regularregular attribute has been set to “false”: -


    \glsifnotregularcategory 


    \glsifnotregularcategory  \glsifnotregularcategory{category-label} -{true-part}{false-part}

    -

    +class="cmtt-10">\glsifnotregularcategory{⟨category-label} +{true-part}{false-part}


    +

    or for a particular entry: -


    \glsifnotregular 


    \glsifnotregular  \glsifnotregular{entry-label}{true-part}{false-part} +class="cmtt-10">\glsifnotregular{⟨entry-label}{true-part}{false-part}

    -

    +

    Again, if the regularregular attribute hasn’t been set, the above do ⟨false-part⟩, so these +class="cmti-10">false-part⟩, so these reverse commands aren’t logically opposite in the strict sense. -

    You can iterate through all entries with a given category using: -


    \glsforeachincategory[glossary-labels]{category-label} {glossary-cs} -{label-cs}{body}

    -

    +

    You can iterate through all entries with a given category using: +


    \glsforeachincategory[glossary-labels]{category-label} {glossary-cs} +{label-cs}{body}

    +

    This iterates through all entries in the glossaries identified by the comma-separated list ⟨glossary-labels⟩ that have the category given by ⟨category-label⟩ and performs ⟨body⟩ +class="cmti-10">glossary-labels⟩ that have the category given by ⟨category-label⟩ and performs ⟨body⟩ for each match. Within ⟨body⟩, you can use ⟨glossary-cs⟩ and ⟨label-cs⟩ (which much be +class="cmti-10">body⟩, you can use ⟨glossary-cs⟩ and ⟨label-cs⟩ (which much be control sequences) to access the current glossary and entry label. If ⟨glossary-labels⟩ is +class="cmti-10">glossary-labels⟩ is omitted, all glossaries are assumed. -

    Similarly, you can iterate through all entries that have a category with a given +

    Similarly, you can iterate through all entries that have a category with a given attribute using: -


    \glsforeachwithattribute 


    \glsforeachwithattribute  \glsforeachwithattribute[glossary-labels] -{attribute-label} {attribute-value}{glossary-cs}{label-cs}{body} +class="cmtt-10">\glsforeachwithattribute[⟨glossary-labels] +{attribute-label} {attribute-value}{glossary-cs}{label-cs}{body}

    -

    +

    This will do ⟨body⟩ for each entry that has a category with the attribute ⟨attribute-label⟩ +class="cmti-10">body⟩ for each entry that has a category with the attribute ⟨attribute-label⟩ set to ⟨attribute-value⟩. The remaining arguments are as the previous command. -

    You can change the category for a particular entry using the standard glossary +class="cmti-10">attribute-value⟩. The remaining arguments are as the previous command. +

    You can change the category for a particular entry using the standard glossary field changing commands, such as \glsfielddef\glsfielddef. Alternatively, you can use -


    \glsxtrsetcategory 


    \glsxtrsetcategory  \glsxtrsetcategory{entry-labels}{category-label} +class="cmtt-10">\glsxtrsetcategory{⟨entry-labels}{category-label}

    -

    +

    This will change the category to ⟨category-label⟩ for each entry listed in the +class="cmti-10">category-label⟩ for each entry listed in the comma-separated list ⟨entry-labels⟩. This command uses \glsfieldxdefentry-labels⟩. This command uses \glsfieldxdef so it will expand ⟨category-label⟩ and make the change global. -

    You can also change the category for all entries with a glossary or glossaries +class="cmti-10">category-label⟩ and make the change global. +

    You can also change the category for all entries with a glossary or glossaries using: -


    \glsxtrsetcategoryforall 


    \glsxtrsetcategoryforall  \glsxtrsetcategoryforall{glossary-labels} -{category-label}

    -

    +class="cmtt-10">\glsxtrsetcategoryforall{⟨glossary-labels} +{category-label}


    +

    where ⟨glossary-labels⟩ is a comma-separated list of glossary labels. +class="cmti-10">glossary-labels⟩ is a comma-separated list of glossary labels.

    -

    -

    +

    Top

    6. Entry Counting

    -

    As mentioned in §2.3

    As mentioned in §2.3 Entry Counting Modifications, glossaries-extra modifies the +class="cmss-10">glossaries-extra modifies the \glsenableentrycount\glsenableentrycount command to allow for the entrycountentrycount attribute. This means that you not only need to enable entry counting with \glsenableentrycount\glsenableentrycount, but you also need to set the appropriate attribute (see §5 §5 Categories). -

    Remember that entry counting only counts the number of times an entry is used +

    Remember that entry counting only counts the number of times an entry is used by commands that change the first use flag. (That is, all those commands that mark the entry as having been used.) There are many commands that don’t modify this flag and they won’t contribute to the entry use count.
    -

    -

    With glossaries-extra, you may use \cgls

    +

    With glossaries-extra, you may use \cgls instead of \gls\gls even if you haven’t enabled entry counting. You will only get a warning if you use \glsenableentrycount +class="cmtt-10">\glsenableentrycount without setting the entrycountentrycount attribute. (With glossaries, commands like \cglsglossaries, commands like \cgls will generate a warning if \glsenableentrycount hasn’t been used.) The abbreviation +class="cmtt-10">\glsenableentrycount hasn’t been used.) The abbreviation shortcut \ab\ab uses \cgls (see §3.3 \cgls (see §3.3 Shortcut Commands) unlike the acronym shortcut \ac\ac which uses \gls. -

    All upper case versions (not provided by glossaries) are also available: -


    \cGLS \gls. +

    All upper case versions (not provided by glossaries) are also available: +


    \cGLS  \cGLS[options]{label}[insert]

    -

    +class="cmtt-10">\cGLS[⟨options]{label}[insert]


    +

    and -


    \cGLSpl 


    \cGLSpl  \cGLSpl[options]{label}[insert]

    -

    +class="cmtt-10">\cGLSpl[⟨options]{label}[insert]


    +

    These are analogous to \cgls and \cglspl but they use -


    \cGLSformat \cgls and \cglspl but they use +


    \cGLSformat  \cGLSformat{label}{insert}

    -

    +class="cmtt-10">\cGLSformat{⟨label}{insert}


    +

    and -


    \cGLSplformat 


    \cGLSplformat  \cGLSplformat{label}{insert}

    -

    +class="cmtt-10">\cGLSplformat{⟨label}{insert}


    +

    which convert the analogous \cglsformat and \cglsplformat to upper +class="cmtt-10">\cglsformat and \cglsplformat to upper case. -

    Just using glossaries: +

    Just using glossaries: @@ -8208,10 +8328,10 @@ class="ecss-1000">glossaries:  
    \printglossaries  
    \end{document}

    -

    -

    If you switch to glossaries-extra you must set the entrycount

    +

    If you switch to glossaries-extra you must set the entrycount attribute: @@ -8231,42 +8351,42 @@ class="ecss-1000">entrycount\printglossaries  
    \end{document}

    -

    -

    When activated with \glsenableentrycount, commands such as \cgls

    +

    When activated with \glsenableentrycount, commands such as \cgls now use -


    \glsxtrifcounttrigger 


    \glsxtrifcounttrigger  \glsxtrifcounttrigger{label}{trigger code} -{normal code}

    -

    +class="cmtt-10">\glsxtrifcounttrigger{⟨label}{trigger code} +{normal code}


    +

    to determine if the entry trips the entry count trigger. The ⟨trigger code⟩ uses +class="cmti-10">trigger code⟩ uses commands like \cglsformat and unsets the \cglsformat and unsets the first use flag. The ⟨normal code⟩ is the +class="cmti-10">normal code⟩ is the code that would ordinarily be performed by whatever the equivalent command is (for example, \cgls will use \cglsformat in ⟨trigger code⟩ but the usual \gls behaviour in +class="cmtt-10">\cgls will use \cglsformat in ⟨trigger code⟩ but the usual \gls behaviour in ⟨normal code⟩). -

    The default definition is: +class="cmti-10">normal code⟩). +

    The default definition is: @@ -8284,14 +8404,14 @@ class="ecti-1000">normal code⟩).  
     {#3}%  
    }

    -

    This means that if an entry is assigned to a category that has the entrycount

    This means that if an entry is assigned to a category that has the entrycount attribute then the ⟨trigger code⟩ will be used if the previous count value (the number of +class="cmti-10">trigger code⟩ will be used if the previous count value (the number of times the entry was used on the last run) is greater than the value of the attribute. -

    For example, to trigger normal use if the previous count value is greater than +

    For example, to trigger normal use if the previous count value is greater than four: @@ -8300,33 +8420,33 @@ four:

    \glssetcategoryattribute{abbreviation}{entrycount}{4}
    -

    -

    There is a convenient command provided to enable entry counting, set the +

    +

    There is a convenient command provided to enable entry counting, set the entrycountentrycount attribute and redefine \gls\gls, etc to use \cgls\cgls etc: -


    \GlsXtrEnableEntryCounting 


    \GlsXtrEnableEntryCounting  \GlsXtrEnableEntryCounting{categories} -{value}

    -

    +class="cmtt-10">\GlsXtrEnableEntryCounting{⟨categories} +{value}


    +

    The first argument ⟨categories⟩ is a comma-separated list of categories. For each +class="cmti-10">categories⟩ is a comma-separated list of categories. For each category, the entrycountentrycount attribute is set to ⟨value⟩. In addition, this does: +class="cmti-10">value⟩. In addition, this does: @@ -8339,13 +8459,13 @@ class="ecti-1000">value⟩. In addition, this does:  
    \renewcommand*{\GLS}{\cGLS}%  
    \renewcommand*{\GLSpl}{\cGLSpl}%

    -

    This makes it easier to enable entry-counting on existing documents. -

    If you use \GlsXtrEnableEntryCounting more than once, subsequent uses will +

    This makes it easier to enable entry-counting on existing documents. +

    If you use \GlsXtrEnableEntryCounting more than once, subsequent uses will just set the entrycountentrycount attribute for each listed category. -

    The above example document can then become: +

    The above example document can then become: @@ -8363,110 +8483,110 @@ class="ecss-1000">entrycount\printglossaries  
    \end{document}

    -

    -

    The standard entry-counting function describe above counts the number of times +

    +

    The standard entry-counting function describe above counts the number of times an entry has been marked as used throughout the document. (The reset commands will reset the total back to zero.) If you prefer to count per sectional-unit, you can use -


    \GlsXtrEnableEntryUnitCounting 


    \GlsXtrEnableEntryUnitCounting  \GlsXtrEnableEntryUnitCounting -{categories}{value}{counter-name}

    -

    +class="cmtt-10">\GlsXtrEnableEntryUnitCounting +{categories}{value}{counter-name}


    +

    where ⟨categories⟩ is a comma-separated list of categories to which this feature should +class="cmti-10">categories⟩ is a comma-separated list of categories to which this feature should be applied, ⟨value⟩ is the trigger value and ⟨counter-name⟩ is the name of the counter +class="cmti-10">value⟩ is the trigger value and ⟨counter-name⟩ is the name of the counter used by the sectional unit. -

    Due to the asynchronous nature of T

    Due to the asynchronous nature of TEX’s output routine, discrepancies will occur in page spanning paragraphs if you use the pagepage counter.
    -

    -

    Note that you can’t use both the document-wide counting and the per-unit +

    +

    Note that you can’t use both the document-wide counting and the per-unit counting in the same document. -

    The counter value is used as part of a label, which means that \thecounter-name⟩ +

    The counter value is used as part of a label, which means that \thecounter-name⟩ needs to be expandable. Since hyperrefhyperref also has a similar requirement and provides \theHcounter-name⟩ as an expandable alternative, glossaries-extra will use +class="cmtt-10">\theH⟨counter-name⟩ as an expandable alternative, glossaries-extra will use \theHcounter-name⟩ if it exists otherwise it will use \thecounter-name⟩. -

    The per-unit counting function uses two attributes: entrycount\theH⟨counter-name⟩ if it exists otherwise it will use \thecounter-name⟩. +

    The per-unit counting function uses two attributes: entrycount (as before) and unitcountunitcount (the name of the counter). -

    Both the original document-wide counting mechanism and the per-unit counting +

    Both the original document-wide counting mechanism and the per-unit counting mechanism provide a command that can be used to access the current count value for this run: -


    \glsentrycurrcount 


    \glsentrycurrcount  \glsentrycurrcount{label}

    -

    +class="cmtt-10">\glsentrycurrcount{⟨label}


    +

    and the final value from the previous run: -


    \glsentryprevcount 


    \glsentryprevcount  \glsentryprevcount{label}

    -

    +class="cmtt-10">\glsentryprevcount{⟨label}


    +

    In the case of the per-unit counting, this is the final value for the current unit. In +class="cmti-10">for the current unit. In both commands ⟨label⟩ is the entry’s label. -

    The per-unit counting mechanism additionally provides: -


    \glsentryprevtotalcount label⟩ is the entry’s label. +

    The per-unit counting mechanism additionally provides: +


    \glsentryprevtotalcount  \glsentryprevtotalcount{label}

    -

    +class="cmtt-10">\glsentryprevtotalcount{⟨label}


    +

    which gives the sum of all the per-unit totals from the previous run for the entry given by ⟨label⟩, and -


    \glsentryprevmaxcount label⟩, and +


    \glsentryprevmaxcount  \glsentryprevmaxcount{label}

    -

    +class="cmtt-10">\glsentryprevmaxcount{⟨label}


    +

    which gives the maximum per-unit total from the previous run. -

    The above two commands are unavailable for the document-wide counting. -

    Example of per-unit counting, where the unit is the chapter: +

    The above two commands are unavailable for the document-wide counting. +

    Example of per-unit counting, where the unit is the chapter: @@ -8490,47 +8610,47 @@ which gives the maximum per-unit total from the previous run.  
    \printglossaries  
    \end{document}

    -

    In this document, the css entry is used three times in the first chapter. This is +

    In this document, the css entry is used three times in the first chapter. This is more than the trigger value of 2, so \gls{css} is expanded on \gls{css} is expanded on first use with the short form used on subsequent use, and the css entries in that +class="cmtt-10">css entries in that chapter are added to the glossary. In the second chapter, the css entry is +class="cmtt-10">css entry is only used once, which trips the suppression trigger, so in that chapter, the long form is used and \gls{css} doesn’t get a line added to the glossary +class="cmtt-10">\gls{css} doesn’t get a line added to the glossary file. -

    The html is used a total of three times, but the expansion and indexing +

    The html is used a total of three times, but the expansion and indexing suppression trigger is tripped in both chapters because the per-unit total (1 for the first chapter and 2 for the second chapter) is less than or equal to the trigger value. -

    The sample entry has only been used once, but it doesn’t trip the indexing +

    The sample entry has only been used once, but it doesn’t trip the indexing suppression because it’s in the generalgeneral category, which hasn’t been listed in \GlsXtrEnableEntryUnitCounting. -

    The per-unit entry counting can be used for other purposes. In the following +class="cmtt-10">\GlsXtrEnableEntryUnitCounting. +

    The per-unit entry counting can be used for other purposes. In the following example document the trigger value is set to zero, which means the index suppression won’t be triggered, but the unit entry count is used to automatically suppress the hyperlink for commands like \gls\gls by modifying the hook -


    \glslinkcheckfirsthyperhook 


    \glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook

    -

    +class="cmtt-10">\glslinkcheckfirsthyperhook


    +

    which is used at the end of the macro the determines whether or not to suppress the hyperlink. @@ -8558,77 +8678,77 @@ hyperlink.  
    \printglossaries  
    \end{document}

    -

    This only produces a hyperlink for the first instance of \gls{sample} on each +

    This only produces a hyperlink for the first instance of \gls{sample} on each page. -

    The earlier warning about using the page

    The earlier warning about using the page counter still applies. If the first instance of \gls occurs at the top of the page within a paragraph that +class="cmtt-10">\gls occurs at the top of the page within a paragraph that started on the previous page, then the count will continue from the previous page.

    -

    -

    +

    Top

    7. Auto-Indexing

    -

    It’s possible that you may also want a normal index as well as the glossary, +

    It’s possible that you may also want a normal index as well as the glossary, and you may want entries to automatically be added to the index (as in this document). There are two attributes that govern this: indexnameindexname and dualindexdualindex. -

    The \glsxtrpostnamehook

    The \glsxtrpostnamehook macro, used at the end of \glossentryname\glossentryname and \Glossentryname\Glossentryname, checks the indexnameindexname attribute for the category associated with that entry. Since \glossentryname is used in the default glossary styles, this +class="cmtt-10">\glossentryname is used in the default glossary styles, this makes a convenient way of automatically indexing each entry name at its location in the glossary without fiddling around with the value of the namename key. -

    The internal macro used by the glossaries package to write the information to the +

    The internal macro used by the glossaries package to write the information to the external glossary file is modified to check for the dualindexdualindex attribute. -

    In both cases, the indexing is done through -


    \glsxtrdoautoindexname 

    In both cases, the indexing is done through +


    \glsxtrdoautoindexname  \glsxtrdoautoindexname{label}{attribute-label} +class="cmtt-10">\glsxtrdoautoindexname{⟨label}{attribute-label}

    -

    +

    This uses the standard \index\index command with the sort value taken from the entry’s sortsort key and the actual value set to \glsentryname{label}. If the value of the +class="cmtt-10">\glsentryname{⟨label}. If the value of the attribute given by ⟨attribute-label⟩ is “true”, no encap will be added, otherwise the +class="cmti-10">attribute-label⟩ is “true”, no encap will be added, otherwise the encap will be the attribute value. For example: @@ -8637,8 +8757,8 @@ encap will be the attribute value. For example:

    \glssetcategoryattribute{general}{indexname}{textbf}
    -

    will set the encap to textbf which will display the relevant page number in bold +

    will set the encap to textbf which will display the relevant page number in bold whereas @@ -8647,250 +8767,257 @@ whereas

    \glssetcategoryattribute{general}{dualindex}{true}
    -

    won’t apply any formatting to the page number in the index. -

    The location used in the index will always be the page number not the counter +

    won’t apply any formatting to the page number in the index. +

    The location used in the index will always be the page number not the counter used in the glossary. (Unless some other loaded package has modified the definition of \index to use some thing else.)
    -

    -

    By default the format\index to use some thing else.)

    +

    +

    By default the format key won’t be used with the dualindexdualindex attribute. You can allow the formatformat key to override the attribute value by using the preamble-only command: -


    \GlsXtrEnableIndexFormatOverride 


    \GlsXtrEnableIndexFormatOverride  \GlsXtrEnableIndexFormatOverride +class="cmtt-10">\GlsXtrEnableIndexFormatOverride

    -

    +

    If you use this command and hyperrefhyperref has been loaded, then the theindextheindex environment -will be modified to redefine \glshypernumber to allow formats that use that -command. -

    The dualindex +environment will be modified to redefine \glshypernumber to allow formats that use +that command. +

    The dualindex attribute will still be used on subsequent use even if the indexonlyfirstindexonlyfirst attribute (or indexonlyfirstindexonlyfirst package option) is set. However, the dualindexdualindex attribute will honour the noindexnoindex key.
    -

    -

    The \glsxtrdoautoindexname command will attempt to escape any of +

    +

    The \glsxtrdoautoindexname command will attempt to escape any of \makeindex\makeindex’s special characters, but there may be special cases where it fails, so take care. This assumes the default makeindex actual, level, quote and encap values +class="cmtt-10">makeindex actual, level, quote and encap values (unless any of the commands \actualchar\actualchar, \levelchar\levelchar, \quotechar\quotechar or \encapchar\encapchar have been defined before glossaries-extra is loaded). -

    If this isn’t the case, you can use the following preamble-only commands to set +class="cmss-10">glossaries-extra is loaded). +

    If this isn’t the case, you can use the following preamble-only commands to set the correct characters. -

    Be very careful of possible shifting category codes!
    -

    -


    \GlsXtrSetActualChar 

    Be very careful of possible shifting category codes!
    +

    +


    \GlsXtrSetActualChar  \GlsXtrSetActualChar{char}

    -

    +class="cmtt-10">\GlsXtrSetActualChar{⟨char}


    +

    Set the actual character to ⟨char⟩. -


    \GlsXtrSetLevelChar char⟩. +


    \GlsXtrSetLevelChar  \GlsXtrSetLevelChar{char}

    -

    +class="cmtt-10">\GlsXtrSetLevelChar{⟨char}


    +

    Set the level character to ⟨char⟩. -


    \GlsXtrSetEscChar char⟩. +


    \GlsXtrSetEscChar  \GlsXtrSetEscChar{char}

    -

    +class="cmtt-10">\GlsXtrSetEscChar{⟨char}


    +

    Set the escape (quote) character to ⟨char⟩. -


    \GlsXtrSetEncapChar char⟩. +


    \GlsXtrSetEncapChar  \GlsXtrSetEncapChar{char}

    +class="cmtt-10">\GlsXtrSetEncapChar{⟨char}

    -

    +

    Set the encap character to ⟨char⟩. +class="cmti-10">char⟩.

    -

    -

    +

    Top

    8. On-the-Fly Document Definitions

    -

    The commands described here may superficially look like ⟨word\index{word}, +

    The commands described here may superficially look like ⟨word\index{word}, but they behave rather differently. If you want to use \index then just use \index. +class="cmtt-10">\index then just use \index.
    -

    -

    The glossaries package advises against defining entries in the document

    +

    The glossaries package advises against defining entries in the document environment. As mentioned in §1.2 §1.2 New or Modified Package Options above, this ability is disabled by default with glossaries-extra but can be enabled using the +class="cmss-10">glossaries-extra but can be enabled using the docdefsdocdefs package options. -

    Although this can be problematic, the glossaries-extra package provides a way of +

    Although this can be problematic, the glossaries-extra package provides a way of defining and using entries within the documentdocument environment without the tricks used with the docdefsdocdefs option. There are limitations with this approach, so take care with it. +class="cmti-10">There are limitations with this approach, so take care with it. This function is disabled by default, but can be enabled using the preamble-only command: -


    \GlsXtrEnableOnTheFly 


    \GlsXtrEnableOnTheFly  \GlsXtrEnableOnTheFly

    -

    +class="cmtt-10">\GlsXtrEnableOnTheFly


    +

    When used, this defines the commands described below. -

    The commands \glsxtr, \glsxtrpl, \Glsxtr and \Glsxtrpl can’t be used after +

    The commands \glsxtr, \glsxtrpl, \Glsxtr and \Glsxtrpl can’t be used after the glossaries have been displayed (through \printglossary\printglossary etc). It’s best not to mix these commands with the standard glossary commands, such as \gls or there +class="cmtt-10">\gls or there may be unexpected results.
    -

    -


    \glsxtr 

    +


    \glsxtr  \glsxtr[gls-options][dfn-options]{label}

    -

    +class="cmtt-10">\glsxtr[⟨gls-options][dfn-options]{label}


    +

    If an entry with the label ⟨label⟩ has already been defined, this just does \gls -[gls-options]{label}. If ⟨label⟩ hasn’t been defined, this will define the entry using: +class="cmti-10">label⟩ has already been defined, this just does \gls +[gls-options]{label}. If ⟨label⟩ hasn’t been defined, this will define the entry using:

    \newglossaryentry{label}{name={label}, +class="cmtt-10">\newglossaryentry{⟨label}{name={label},
     category=\glsxtrcat, +class="cmtt-10"> category=\glsxtrcat,
     description={\nopostdesc}, +class="cmtt-10"> description={\nopostdesc},
     dfn-options} +class="cmtt-10"> ⟨dfn-options}
    -

    The ⟨label⟩ must contain any non-expandable commands, such as formatting +

    The ⟨label⟩ must contain any non-expandable commands, such as formatting commands or problematic characters. If the term requires any of these, they must be omitted from the ⟨label⟩ and placed in the namelabel⟩ and placed in the name key must be provided in the optional argument ⟨dfn-options⟩.
    -

    +class="cmti-10">dfn-options⟩.

    +

    -

    The second optional argument ⟨dfn-options⟩ should be empty if the entry has +

    The second optional argument ⟨dfn-options⟩ should be empty if the entry has already been defined, since it’s too late for them. If it’s not empty, a warning will be generated with -


    \GlsXtrWarning 


    \GlsXtrWarning  \GlsXtrWarning{dfn-options}{label}

    -

    -

    For example, this warning will be generated on the second instance of \glsxtr +class="cmtt-10">\GlsXtrWarning{⟨dfn-options}{label}


    +

    +

    For example, this warning will be generated on the second instance of \glsxtr below: @@ -8901,8 +9028,8 @@ below:  
     ... later  
    \glsxtr[][plural=geese]{goose}

    -

    -

    If you are considering doing something like: +

    +

    If you are considering doing something like: @@ -8913,99 +9040,99 @@ below:  
     ... later  
    \goose\ some more text here

    -

    then don’t bother. It’s simpler and less problematic to just define the entries in the +

    then don’t bother. It’s simpler and less problematic to just define the entries in the preamble with \newglossaryentry\newglossaryentry and then use \gls in the document. -

    There are plural and case-changing alternatives to \glsxtr: -


    \glsxtrpl \gls in the document. +

    There are plural and case-changing alternatives to \glsxtr: +


    \glsxtrpl  \glsxtrpl[gls-options][dfn-options]{label}

    -

    +class="cmtt-10">\glsxtrpl[⟨gls-options][dfn-options]{label}


    +

    This is like \glsxtr but uses \glspl instead of \gls. -


    \Glsxtr \glsxtr but uses \glspl instead of \gls. +


    \Glsxtr  \Glsxtr[gls-options][dfn-options]{label}

    -

    +class="cmtt-10">\Glsxtr[⟨gls-options][dfn-options]{label}


    +

    This is like \glsxtr but uses \Gls instead of \gls. -


    \Glsxtrpl \glsxtr but uses \Gls instead of \gls. +


    \Glsxtrpl  \Glsxtrpl[gls-options][dfn-options]{label}

    -

    +class="cmtt-10">\Glsxtrpl[⟨gls-options][dfn-options]{label}


    +

    This is like \glsxtr but uses \Glspl instead of \gls. -

    If you use UTF-8 and don’t want the inconvenient of needing to use an +class="cmtt-10">\glsxtr but uses \Glspl instead of \gls. +

    If you use UTF-8 and don’t want the inconvenient of needing to use an ASCII-only label, then it’s better to use XƎLATEX or LuaLATEX instead of LATEX (or pdfLATEX). If you really desperately want to use UTF-8 entry labels without switching to XƎLATEX or LuaLATEX then there is a starred version of \GlsXtrEnableOnTheFly that allows you to use UTF-8 characters in ⟨label⟩, but it’s +class="cmtt-10">\GlsXtrEnableOnTheFly that allows you to use UTF-8 characters in ⟨label⟩, but it’s experimental and may not work in some cases. -

    If you use the starred version of \GlsXtrEnableOnTheFly don’t use any +

    If you use the starred version of \GlsXtrEnableOnTheFly don’t use any commands in the ⟨label⟩, even if they expand to just text.
    -

    +class="cmti-10">label⟩, even if they expand to just text.

    +

    -

    -

    +

    Top

    9. Supplemental Packages

    -

    The glossaries bundle provides additional support packages glossaries-prefix

    The glossaries bundle provides additional support packages glossaries-prefix (for prefixing) and glossaries-accsuppglossaries-accsupp (for accessibility support). These packages aren’t automatically loaded.

    -

    Top

    9.1 Prefixes or Determiners

    -

    If prefixing is required, you can simply load glossaries-prefix

    If prefixing is required, you can simply load glossaries-prefix after glossaries-extra. For +class="cmss-10">glossaries-extra. For example: @@ -9026,18 +9153,18 @@ example:  
    \printglossaries  
    \end{document}

    -

    -

    +

    +

    -

    Top

    9.2 Accessibility Support

    -

    The glossaries-accsupp

    The glossaries-accsupp needs to be loaded before glossaries-extra or through the +class="cmss-10">glossaries-extra or through the accsuppaccsupp package option: @@ -9046,40 +9173,40 @@ class="ecss-1000">accsupp \usepackage[accsupp]{glossaries-extra}

    -

    If you don’t load glossaries-accsupp

    If you don’t load glossaries-accsupp or you load glossaries-accsuppglossaries-accsupp after glossaries-extra +class="cmss-10">glossaries-extra the new \glsaccessxxx⟩ commands described below will simply be equivalent to the +class="cmtt-10">\glsaccess⟨xxx⟩ commands described below will simply be equivalent to the corresponding \glsentryxxx⟩ commands. -

    The following \glsaccessxxx⟩ commands add accessibility information wrapped +class="cmtt-10">\glsentry⟨xxx⟩ commands. +

    The following \glsaccessxxx⟩ commands add accessibility information wrapped around the corresponding \glsentryxxx⟩ commands. There is no check for existence +class="cmtt-10">\glsentry⟨xxx⟩ commands. There is no check for existence of the entry nor do any of these commands add formatting, hyperlinks or indexing information. -


    \glsaccessname 


    \glsaccessname  \glsaccessname{label}

    -

    +class="cmtt-10">\glsaccessname{⟨label}


    +

    This displays the value of the namename field for the entry identified by ⟨label⟩. -

    If the glossaries-accsupplabel⟩. +

    If the glossaries-accsupp package isn’t loaded, this is simply defined as: @@ -9088,7 +9215,7 @@ class="ecss-1000">glossaries-accsupp \newcommand*{\glsaccessname}[1]{\glsentryname{#1}} -

    otherwise it’s defined as: +

    otherwise it’s defined as: @@ -9102,22 +9229,22 @@ class="ecss-1000">glossaries-accsupp  {#1}%  
    } -

    (\glsnameaccessdisplay

    (\glsnameaccessdisplay is defined by the glossaries-accsuppglossaries-accsupp package.) The first letter upper case version is: -


    \Glsaccessname 


    \Glsaccessname  \Glsaccessname{label}

    -

    +class="cmtt-10">\Glsaccessname{⟨label}


    +

    Without the glossaries-accsuppglossaries-accsupp package this is just defined as: @@ -9126,8 +9253,8 @@ class="ecss-1000">glossaries-accsupp \newcommand*{\Glsaccessname}[1]{\Glsentryname{#1}} -

    With the glossaries-accsupp

    With the glossaries-accsupp package this is defined as: @@ -9142,387 +9269,387 @@ class="ecss-1000">glossaries-accsupp  {#1}%  
    } -

    -

    The following commands are all defined in an analogous manner. -


    \glsaccesstext 

    +

    The following commands are all defined in an analogous manner. +


    \glsaccesstext  \glsaccesstext{label}

    -

    +class="cmtt-10">\glsaccesstext{⟨label}


    +

    This displays the value of the texttext field. -


    \Glsaccesstext 


    \Glsaccesstext  \Glsaccesstext{label}

    -

    +class="cmtt-10">\Glsaccesstext{⟨label}


    +

    This displays the value of the texttext field with the first letter converted to upper case. -


    \glsaccessplural 


    \glsaccessplural  \glsaccessplural{label}

    -

    +class="cmtt-10">\glsaccessplural{⟨label}


    +

    This displays the value of the pluralplural field. -


    \Glsaccessplural 


    \Glsaccessplural  \Glsaccessplural{label}

    -

    +class="cmtt-10">\Glsaccessplural{⟨label}


    +

    This displays the value of the pluralplural field with the first letter converted to upper case. -


    \glsaccessfirst 


    \glsaccessfirst  \glsaccessfirst{label}

    -

    +class="cmtt-10">\glsaccessfirst{⟨label}


    +

    This displays the value of the firstfirst field. -


    \Glsaccessfirst 


    \Glsaccessfirst  \Glsaccessfirst{label}

    -

    +class="cmtt-10">\Glsaccessfirst{⟨label}


    +

    This displays the value of the firstfirst field with the first letter converted to upper case. -


    \glsaccessfirstplural 


    \glsaccessfirstplural  \glsaccessfirstplural{label}

    -

    +class="cmtt-10">\glsaccessfirstplural{⟨label}


    +

    This displays the value of the firstpluralfirstplural field. -


    \Glsaccessfirstplural 


    \Glsaccessfirstplural  \Glsaccessfirstplural{label}

    -

    +class="cmtt-10">\Glsaccessfirstplural{⟨label}


    +

    This displays the value of the firstpluralfirstplural field with the first letter converted to upper case. -


    \glsaccesssymbol 


    \glsaccesssymbol  \glsaccesssymbol{label}

    -

    +class="cmtt-10">\glsaccesssymbol{⟨label}


    +

    This displays the value of the symbolsymbol field. -


    \Glsaccesssymbol 


    \Glsaccesssymbol  \Glsaccesssymbol{label}

    +class="cmtt-10">\Glsaccesssymbol{⟨label}

    -

    +

    This displays the value of the symbolsymbol field with the first letter converted to upper case. -


    \glsaccesssymbolplural 


    \glsaccesssymbolplural  \glsaccesssymbolplural{label}

    -

    +class="cmtt-10">\glsaccesssymbolplural{⟨label}


    +

    This displays the value of the symbolpluralsymbolplural field. -


    \Glsaccesssymbolplural 


    \Glsaccesssymbolplural  \Glsaccesssymbolplural{label}

    -

    +class="cmtt-10">\Glsaccesssymbolplural{⟨label}


    +

    This displays the value of the symbolpluralsymbolplural field with the first letter converted to upper case. -


    \glsaccessdesc 


    \glsaccessdesc  \glsaccessdesc{label}

    -

    +class="cmtt-10">\glsaccessdesc{⟨label}


    +

    This displays the value of the descdesc field. -


    \Glsaccessdesc 


    \Glsaccessdesc  \Glsaccessdesc{label}

    -

    +class="cmtt-10">\Glsaccessdesc{⟨label}


    +

    This displays the value of the descdesc field with the first letter converted to upper case. -


    \glsaccessdescplural 


    \glsaccessdescplural  \glsaccessdescplural{label}

    -

    +class="cmtt-10">\glsaccessdescplural{⟨label}


    +

    This displays the value of the descpluraldescplural field. -


    \Glsaccessdescplural 


    \Glsaccessdescplural  \Glsaccessdescplural{label}

    -

    +class="cmtt-10">\Glsaccessdescplural{⟨label}


    +

    This displays the value of the descpluraldescplural field with the first letter converted to upper case. -


    \glsaccessshort 


    \glsaccessshort  \glsaccessshort{label}

    -

    +class="cmtt-10">\glsaccessshort{⟨label}


    +

    This displays the value of the shortshort field. -


    \Glsaccessshort 


    \Glsaccessshort  \Glsaccessshort{label}

    -

    +class="cmtt-10">\Glsaccessshort{⟨label}


    +

    This displays the value of the shortshort field with the first letter converted to upper case. -


    \glsaccessshortpl 


    \glsaccessshortpl  \glsaccessshortpl{label}

    -

    +class="cmtt-10">\glsaccessshortpl{⟨label}


    +

    This displays the value of the shortpluralshortplural field. -


    \Glsaccessshortpl 


    \Glsaccessshortpl  \Glsaccessshortpl{label}

    -

    +class="cmtt-10">\Glsaccessshortpl{⟨label}


    +

    This displays the value of the shortpluralshortplural field with the first letter converted to upper case. -


    \glsaccesslong 


    \glsaccesslong  \glsaccesslong{label}

    -

    +class="cmtt-10">\glsaccesslong{⟨label}


    +

    This displays the value of the longlong field. -


    \Glsaccesslong 


    \Glsaccesslong  \Glsaccesslong{label}

    -

    +class="cmtt-10">\Glsaccesslong{⟨label}


    +

    This displays the value of the longlong field with the first letter converted to upper case. -


    \glsaccesslongpl 


    \glsaccesslongpl  \glsaccesslongpl{label}

    +class="cmtt-10">\glsaccesslongpl{⟨label}

    -

    +

    This displays the value of the longplurallongplural field. -


    \Glsaccesslongpl 


    \Glsaccesslongpl  \Glsaccesslongpl{label}

    -

    +class="cmtt-10">\Glsaccesslongpl{⟨label}


    +

    This displays the value of the longplurallongplural field with the first letter converted to upper case.

    -

    -

    +

    Top

    10. Sample Files

    -

    The following sample files are provided with this package: +

    The following sample files are provided with this package:

    sample.tex
    sample.tex
    Simple sample file that uses one of the dummy files provided by the glossaries package for testing. +class="cmss-10">glossaries package for testing.
    sample-mixture.tex
    sample-mixture.tex
    General entries, acronyms and initialisms all treated differently.
    sample-name-font
    sample-name-font
    Categories and attributes are used to customize the way different entries appear.
    sample-abbrv.tex
    sample-abbrv.tex
    General abbreviations.
    sample-acronym.tex
    sample-acronym.tex
    Acronyms aren’t initialisms and don’t expand on first use.
    sample-acronym-desc.tex
    sample-acronym-desc.tex
    Acronyms that have a separate long form and description.
    sample-crossref.tex
    sample-crossref.tex
    Unused entries that have been cross-referenced automatically are added at the end of the document.
    sample-indexhook.tex
    sample-indexhook.tex
    Use the index hook to track which entries have been indexed (and therefore find out which ones haven’t been indexed).
    sample-footnote.tex
    sample-footnote.tex
    Footnote abbreviation style that moves the footnote marker outside of the hyperlink generated by \gls and moves it after +class="cmtt-10">\gls and moves it after certain punctuation characters for neatness.
    sample-undef.tex
    sample-undef.tex
    Warn on undefined entries instead of generating an error.
    sample-mixed-abbrv-styles.tex
    sample-mixed-abbrv-styles.tex
    Different abbreviation styles for different entries.
    sample-initialisms.tex
    sample-initialisms.tex
    Automatically insert dots into initialisms.
    sample-postdot.tex
    sample-postdot.tex
    Another initialisms example.
    sample-postlink.tex
    sample-postlink.tex
    Automatically inserting text after the link-text produced by commands like \gls (outside of hyperlink, if present). +class="cmtt-10">\gls (outside of hyperlink, if present).
    sample-header.tex
    sample-header.tex
    Using entries in section/chapter headings.
    sample-autoindex.tex
    sample-autoindex.tex
    Using the dualindexdualindex and indexnameindexname attributes to automatically add glossary entries to the index (in addition to the glossary indexnamelocation list).
    sample-autoindex-hyp.tex
    sample-autoindex-hyp.tex
    As previous but uses hyperrefhyperref.
    sample-nested.tex
    sample-nested.tex
    Using \gls\gls within the value of the namename key.
    sample-entrycount.tex
    sample-entrycount.tex
    Enable entry-use counting (only index if used more than n times).
    sample-unitentrycount.tex
    sample-unitentrycount.tex
    Enable use of per-unit entry-use counting.
    sample-pages.tex
    sample-pages.tex
    Insert “page” or “pages” before the location list.
    sample-onelink.tex
    sample-onelink.tex
    Using the per-unit entry counting to only have one hyperlink per entry per page.
    sample-altmodifier.tex
    sample-altmodifier.tex
    Set the default options for commands like \gls and +class="cmtt-10">\gls and add an alternative modifier.
    sample-alttree.tex
    sample-alttree.tex
    Uses the glossaries-extra-stylemodsglossaries-extra-stylemods package with the alttreealttree style (see §2.6.3 §2.6.3 The glossaries-extra-stylemods Package). +class="cmss-10">glossaries-extra-stylemods Package).
    sample-alttree-sym.tex
    sample-alttree-sym.tex
    Another alttreealttree example that measures the symbol widths.
    sample-alttree-marginpar.tex
    sample-alttree-marginpar.tex
    Another alttreealttree example that puts the number list in the margin.
    sample-onthefly.tex
    sample-onthefly.tex
    Using on-the-fly commands. Terms with accents must have the namename key explicitly set.
    sample-onthefly-xetex.tex
    Using on-the-fly commands with XƎLATEX. +class="cmbx-10">sample-onthefly-xetex.tex
    Using on-the-fly commands with XƎLATEX. Terms with UTF-8 characters don’t need to have the namename key explicitly set. Terms that contain commands must have the namename key explicitly set with the commands removed from the label.
    sample-onthefly-utf8.tex
    sample-onthefly-utf8.tex
    Tries to emulate the previous sample file for use with LATEX through the starred version of \GlsXtrEnableOnTheFly\GlsXtrEnableOnTheFly. This is a bit iffy and may not always work. Terms that contain commands must have the namename key explicitly set with the commands removed from the label.
    sample-accsupp.tex
    sample-accsupp.tex
    Integrate glossaries-accsuppglossaries-accsupp.
    sample-prefix.tex
    sample-prefix.tex
    Integrate glossaries-prefixglossaries-prefix.
    -

    -

    +

    Top

    11. Multi-Lingual Support

    -

    There’s only one command provided by glossaries-extra that you’re likely to want +

    There’s only one command provided by glossaries-extra that you’re likely to want to change in your document and that’s \abbreviationsname\abbreviationsname (§1.2 §1.2 New or Modified Package Options) if you use the abbreviationsabbreviations package option to automatically create the glossary labelled abbreviations. If this command +class="cmtt-10">abbreviations. If this command doesn’t already exist, it will be defined to “Abbreviations” if babelbabel hasn’t been loaded, otherwise it will be defined as \acronymname (provided by +class="cmtt-10">\acronymname (provided by glossaries). -

    You can redefine it in the usual way. For example: +class="cmss-10">glossaries). +

    You can redefine it in the usual way. For example: @@ -9676,10 +9805,10 @@ class="ecss-1000">glossaries).

    \renewcommand*{\abbreviationsname}{List of Abbreviations}
    -

    Or using babel

    Or using babel or polyglossiapolyglossia captions hook: @@ -9690,9 +9819,9 @@ class="ecss-1000">polyglossia \renewcommand*{\abbreviationsname}{List of Abbreviations}%  
    }

    -

    -

    Alternatively you can use the title

    +

    Alternatively you can use the title key when you print the list of abbreviations. For example: @@ -9702,7 +9831,7 @@ For example:

    \printabbreviations[title={List of Abbreviations}]
    -

    or +

    or @@ -9710,23 +9839,23 @@ For example:

    \printglossary[type=abbreviations,title={List of Abbreviations}]
    -

    -

    The other fixed text commands are the diagnostic messages, which shouldn’t +

    +

    The other fixed text commands are the diagnostic messages, which shouldn’t appear in the final draft of your document. -

    The glossaries-extra package has the facility to load language modules if they exist, +

    The glossaries-extra package has the facility to load language modules if they exist, but won’t warn if they don’t. -

    If you want to write your own language module, you just need to create a file +

    If you want to write your own language module, you just need to create a file called glossariesxtr-lang.ldf, where ⟨lang⟩ is the language name (see the tracklangglossariesxtr-⟨lang.ldf, where ⟨lang⟩ is the language name (see the tracklang package). For example, glossariesxtr-french.ldf. -

    The simplest code for this file is: +class="cmtt-10">glossariesxtr-french.ldf. +

    The simplest code for this file is: @@ -9734,7 +9863,7 @@ class="ectt-1000">glossariesxtr-french.ldf.

    \ProvidesGlossariesExtraLang{french}[2015/12/09 v1.0]  
    \newcommand*{\glossariesxtrcaptionsfrench}{% - 
     \def\abbreviationsname{Abr\’eviations}% + 
     \def\abbreviationsname{Abr\'eviations}%  
    }  
    \glossariesxtrcaptionsfrench  
    \ifcsdef{captions\CurrentTrackedDialect} @@ -9757,172 +9886,172 @@ class="ectt-1000">glossariesxtr-french.ldf.  
      \glossariesxtrcaptionsfrench  
    }
    -

    -

    You can adapt this for other languages by replacing all instances of the language +

    +

    You can adapt this for other languages by replacing all instances of the language identifier french and the translated text Abr\’eviations as appropriate. This .ldf +class="cmtt-10">french and the translated text Abr\’eviations as appropriate. This .ldf file then needs to be put somewhere on TEX’s path so that it can be found by glossaries-extra. You might also want to consider uploading it to CTAN so that it can +class="cmss-10">glossaries-extra. You might also want to consider uploading it to CTAN so that it can be useful to others. (Please don’t send it to me. I already have more packages than I am able to maintain.) -

    If you additionally want to provide translations for the diagnostic messages used +

    If you additionally want to provide translations for the diagnostic messages used when a glossary is missing, you need to redefine the following commands: -


    \GlsXtrNoGlsWarningHead 


    \GlsXtrNoGlsWarningHead  \GlsXtrNoGlsWarningHead{label}{file} +class="cmtt-10">\GlsXtrNoGlsWarningHead{⟨label}{file}

    -

    +

    This produces the following text in English:

    -

    This document is incomplete. The external file associated with the +

    This document is incomplete. The external file associated with the glossary ‘⟨label⟩’ (which should be called ⟨file⟩) hasn’t been created.

    +class="cmti-10">label⟩’ (which should be called ⟨file⟩) hasn’t been created.

    -


    \GlsXtrNoGlsWarningEmptyStart 


    \GlsXtrNoGlsWarningEmptyStart  \GlsXtrNoGlsWarningEmptyStart

    -

    +class="cmtt-10">\GlsXtrNoGlsWarningEmptyStart


    +

    This produces the following text in English:

    -

    This has probably happened because there are no entries defined in +

    This has probably happened because there are no entries defined in this glossary.

    -


    \GlsXtrNoGlsWarningEmptyMain 


    \GlsXtrNoGlsWarningEmptyMain  \GlsXtrNoGlsWarningEmptyMain

    -

    +class="cmtt-10">\GlsXtrNoGlsWarningEmptyMain


    +

    This produces the following text in English:

    -

    If you don’t want this glossary, add nomain to your package option +

    If you don’t want this glossary, add nomain to your package option list when you load glossaries-extra.sty. For example:

    -


    \GlsXtrNoGlsWarningEmptyNotMain glossaries-extra.sty. For example:

    +


    \GlsXtrNoGlsWarningEmptyNotMain  \GlsXtrNoGlsWarningEmptyNotMain{label} +class="cmtt-10">\GlsXtrNoGlsWarningEmptyNotMain{⟨label}

    -

    +

    This produces the following text in English:

    -

    Did you forget to use type=label⟩ when you defined your entries? +

    Did you forget to use type=label⟩ when you defined your entries? If you tried to load entries into this glossary with \loadglsentries +class="cmtt-10">\loadglsentries did you remember to use [label] as the optional argument? If you +class="cmtt-10">[⟨label] as the optional argument? If you did, check that the definitions in the file you loaded all had the type set to \glsdefaulttype.

    -


    \GlsXtrNoGlsWarningCheckFile \glsdefaulttype.

    +


    \GlsXtrNoGlsWarningCheckFile  \GlsXtrNoGlsWarningCheckFile{file} +class="cmtt-10">\GlsXtrNoGlsWarningCheckFile{⟨file}

    -

    +

    This produces the following text in English:

    -

    Check the contents of the file ⟨file⟩. If it’s empty, that means you +

    Check the contents of the file ⟨file⟩. If it’s empty, that means you haven’t indexed any of your entries in this glossary (using commands like \gls or \glsadd) so this list can’t be generated. If the file isn’t +class="cmtt-10">\gls or \glsadd) so this list can’t be generated. If the file isn’t empty, the document build process hasn’t been completed.

    -


    \GlsXtrNoGlsWarningMisMatch 


    \GlsXtrNoGlsWarningMisMatch  \GlsXtrNoGlsWarningMisMatch

    -

    +class="cmtt-10">\GlsXtrNoGlsWarningMisMatch


    +

    This produces the following text in English:

    -

    You need +

    You need to either replace \makenoidxglossaries with \makeglossaries or +class="cmtt-10">\makenoidxglossaries with \makeglossaries or replace \printglossary (or \printglossaries) +class="cmtt-10">\printglossary (or \printglossaries) with \printnoidxglossary (or \printnoidxglossaries) and then +class="cmtt-10">\printnoidxglossary (or \printnoidxglossaries) and then rebuild this document.

    -


    \GlsXtrNoGlsWarningNoOut 


    \GlsXtrNoGlsWarningNoOut  \GlsXtrNoGlsWarningNoOut{file}

    -

    +class="cmtt-10">\GlsXtrNoGlsWarningNoOut{⟨file}


    +

    This produces the following text in English:

    -

    The file ⟨file⟩ doesn’t exist. This most likely means you haven’t used +

    The file ⟨file⟩ doesn’t exist. This most likely means you haven’t used \makeglossaries or you have used \nofiles. If this is just a draft +class="cmtt-10">\makeglossaries or you have used \nofiles. If this is just a draft version of the document, you can suppress this message using the nomissingglstext package option.

    -


    \GlsXtrNoGlsWarningTail nomissingglstext package option.

    +


    \GlsXtrNoGlsWarningTail  \GlsXtrNoGlsWarningTail

    -

    +class="cmtt-10">\GlsXtrNoGlsWarningTail


    +

    This produces the following text in English:

    -

    This message will be removed once the problem has been fixed.

    -


    \GlsXtrNoGlsWarningBuildInfo 

    This message will be removed once the problem has been fixed.

    +


    \GlsXtrNoGlsWarningBuildInfo  \GlsXtrNoGlsWarningBuildInfo

    -

    +class="cmtt-10">\GlsXtrNoGlsWarningBuildInfo


    +

    This is advice on how to generate the glossary files. See the documented code (glossaries-extra-code.pdf) for further details. -


    \GlsXtrNoGlsWarningAutoMake glossaries-extra-code.pdf) for further details. +


    \GlsXtrNoGlsWarningAutoMake  \GlsXtrNoGlsWarningAutoMake{label} +class="cmtt-10">\GlsXtrNoGlsWarningAutoMake{⟨label}

    -

    +

    This is the message produced when the automakeautomake option is used, but the document needs a rerun or the shell escape setting doesn’t permit the execution of the external application. This command also generates a warning in the transcript file. See the @@ -9944,7 +10073,7 @@ href="#top">Top

    entry locationentry location
    The location of the entry in the document. This defaults to the page number on which the entry appears. An entry may have multiple @@ -9952,29 +10081,29 @@ class="description">The location of the entry in the document. This defaults to
    first usefirst use
    The first time a glossary entry is used (from the start of the document or after a reset) with one of the following commands: \gls\gls, \Gls\Gls, \GLS\GLS, \glspl\glspl, \Glspl\Glspl, \GLSpl\GLSpl or \glsdisp\glsdisp.
    first use flagfirst use flag
    A conditional that determines whether or not the entry has been used according to the rules of first use.
    first use textfirst use text
    The text that is displayed on first use, which is governed by the firstfirst and firstpluralfirstplural keys of \newglossaryentry\newglossaryentry. (May be overridden by \glsdisp\glsdisp.)
    link-textlink-text
    The text produced by commands such as \gls\gls. It may or may not have a hyperlink to the glossary.
    location listlocation list
    A list of number list.
    makeglossariesmakeglossaries
    A custom designed Perl script interface provided with the +class="description">A custom designed Perl script interface provided with the glossaries package to run glossaries package to run xindy or xindy or makeindex according to the document +class="cmtt-10">makeindex according to the document settings.
    makeindexmakeindex
    An indexing application.
    number listnumber list
    A list of entry locations (also called a location list). The number list can be suppressed using the nonumberlistnonumberlist package option. @@ -10053,7 +10182,7 @@ class="ecss-1000">nonumberlist
    xindyxindy
    An flexible indexing application with multilingual support written in Perl.
    @@ -10061,70 +10190,72 @@ class="description">An flexible indexing application with multilingual support w

    Index

    A + id="x1-3400011">Index +

    A +

    abbreviation styles (deprecated):
        footnote-em  footnote-em  1
        footnote-sc  footnote-sc  2
        footnote-sm  footnote-sm  3
        long-desc-em  long-desc-em  4
        long-desc-sc  long-desc-sc  5
        long-desc-sm  long-desc-sm  6
        long-em  long-em  7
        long-sc  long-sc  8
        long-sm  long-sm  9
        postfootnote-em  postfootnote-em  10
        postfootnote-sc  postfootnote-sc  11
        postfootnote-sm  postfootnote-sm  12
    abbreviation styles:
        footnote  footnote  13
        long  long  14
        long-desc  long-desc  15
        long-em-noshort-em  long-em-noshort-em  16
        long-em-noshort-em-desc  long-em-noshort-em-desc  17
        long-em-short-em  long-em-short-em  18, 19
        long-em-short-em-desc  long-em-short-em-desc  20
        long-noshort  long-noshort  21, 22, 23, 26, 27, 28
        long-noshort-desc  long-noshort-desc  29, 30, 31, 35, 36, 37
        long-noshort-em  long-noshort-em  38
        long-noshort-em-desc  long-noshort-em-desc  39
        long-noshort-sc  long-noshort-sc  40, 41
        long-noshort-sc-desc  long-noshort-sc-desc  42
        long-noshort-sm  long-noshort-sm  43
        long-noshort-sm-desc  long-noshort-sm-desc  44
        long-short  long-short  45, 46, 47, 55, 56, 57
        long-short-desc  long-short-desc  58, 59, 60, 64, 65, 66
        long-short-em  long-short-em  67, 68, 69
        long-short-em-desc  long-short-em-desc  70, 71
    + + +     long-short-sc  long-short-sc  72, 73, 74, 75, 76
        long-short-sc-desc  long-short-sc-desc  77, 78
    - - -     long-short-sm  long-short-sm  79, 80
        long-short-sm-desc  long-short-sm-desc  81, 82
        long-short-user  long-short-user  83, 84, 85, 88, 89, 90
        long-short-user-desc  long-short-user-desc  91
        postfootnote  postfootnote  92
        short  short  93
        short-desc  short-desc  94
        short-em  short-em  95
        short-em-desc  short-em-desc  96
        short-em-footnote  short-em-footnote  97, 98
        short-em-footnote-desc  short-em-footnote-desc  99
        short-em-long  short-em-long  100, 101, 102
        short-em-long-desc  short-em-long-desc  103, 104
        short-em-long-em  short-em-long-em  105
        short-em-long-em-desc  short-em-long-em-desc  106
        short-em-nolong  short-em-nolong  107, 108
        short-em-nolong-desc  short-em-nolong-desc  109, 110
        short-em-postfootnote  short-em-postfootnote  111
        short-footnote  short-footnote  112, 113, 114, 119, 120, 121
        short-footnote-desc  short-footnote-desc  122
        short-long  short-long  123, 124, 125, 129, 130, 131
        short-long-desc  short-long-desc  132, 133, 134, 137, 138, 139
        short-long-user  short-long-user  140, 141, 142, 143, 144, 145
        short-long-user-desc  short-long-user-desc  146
        short-nolong  short-nolong  147, 148, 149, 156, 157, 158
        short-nolong-desc  short-nolong-desc  159, 160, 161, 162
        short-postfootnote  short-postfootnote  163, 164, 165, 167, 168, 169
        short-sc  short-sc  170
        short-sc-desc  short-sc-desc  171
        short-sc-footnote  short-sc-footnote  172, 173, 174, 175
        short-sc-footnote-desc  short-sc-footnote-desc  176
        short-sc-long  short-sc-long  177, 178, 179
        short-sc-long-desc  short-sc-long-desc  180, 181
        short-sc-nolong  short-sc-nolong  182, 183
        short-sc-nolong-desc  short-sc-nolong-desc  184, 185
        short-sc-postfootnote  short-sc-postfootnote  186, 187
        short-sm  short-sm  188
        short-sm-desc  short-sm-desc  189
        short-sm-footnote  short-sm-footnote  190, 191
        short-sm-footnote-desc  short-sm-footnote-desc  192
        short-sm-long  short-sm-long  193, 194, 195
        short-sm-long-desc  short-sm-long-desc  196, 197
        short-sm-nolong  short-sm-nolong  198, 199
        short-sm-nolong-desc  short-sm-nolong-desc  200, 201
    -    short-sm-postfootnote  202
    -\abbreviationsname  203
    +    short-sm-postfootnote  202
    +\abbreviationsname  203
    \abbrvpluralsuffix  \abbrvpluralsuffix  204
    +class="cmti-10">204
    acronym styles (glossaries):
        dua  dua  205
        dua-desc  dua-desc  206
        footnote  footnote  207
        footnote-desc  footnote-desc  208
        footnote-sc  footnote-sc  209
        footnote-sc-desc  footnote-sc-desc  210
        footnote-sm  footnote-sm  211
        footnote-sm-desc  footnote-sm-desc  212
        long-sc-short  long-sc-short  213
        long-sc-short-desc  long-sc-short-desc  214
        long-short-desc  long-short-desc  215
        long-sm-short  long-sm-short  216
        long-sm-short-desc  long-sm-short-desc  217
        long-sp-short  long-sp-short  218, 219
        long-sp-short-desc  long-sp-short-desc  220
        sc-short-long  sc-short-long  221
        sc-short-long-desc  sc-short-long-desc  222
        short-long  short-long  223
        short-long-desc  short-long-desc  224
        sm-short-long  sm-short-long  225
        sm-short-long-desc  sm-short-long-desc  226
    amsgen package  amsgen package  227

    B +class="cmbx-10">B babel package  babel package  228, 229, 230, 231, 232, 230, 231, 232, 233, 234, 235

    C +class="cmbx-10">C categories:
        abbreviation  abbreviation  236, 237, 238, 239
        acronym  acronym  240, 241, 242, 243, 244, 245
        general  general  246, 247, 248, 251, 252, 253
        index  index  254, 255
        number  number  256
        symbol  symbol  257, 258
    category attributes:
        aposplural  aposplural  259, 260, 261
        discardperiod  discardperiod  262, 263, 264, 265, 266
        dualindex  dualindex  267, 268, 269, 271, 272, 273
        entrycount  entrycount  274, 275, 276, 282, 283, 284
        glossdesc  glossdesc  285, 286, 287
    + + +     glossdescfont  glossdescfont  288, 289
        glossname  glossname  290, 291
    - - -     glossnamefont  glossnamefont  292
        headuc  headuc  293, 294, 295, 296
        indexname  indexname  297, 298, 299, 300, 301
        indexonlyfirst  indexonlyfirst  302, 303, 304
        insertdots  insertdots  305, 306
        nohyper  nohyper  307, 308, 309
        nohyperfirst  nohyperfirst  310, 311, 312, 313, 314
        noshortplural  noshortplural  315, 316, 317, 318
        pluraldiscardperiod  pluraldiscardperiod  319, 320
        regular  regular  321, 322, 323, 338, 339, 340
        retainfirstuseperiod  retainfirstuseperiod  341
        tagging  tagging  342, 343, 344, 345
        unitcount  unitcount  346
    \cGLS  \cGLS  347
    +class="cmti-10">347
    \cGLSformat  \cGLSformat  348
    +class="cmti-10">348
    \cGLSpl  \cGLSpl  349
    +class="cmti-10">349
    \cGLSplformat  \cGLSplformat  350
    +class="cmti-10">350
    \CustomAbbreviationFields  \CustomAbbreviationFields  351
    +class="cmti-10">351

    D +class="cmbx-10">D datatool-base package  datatool-base package  352

    E +class="cmbx-10">E \eglssetwidest  \eglssetwidest  353
    +class="cmti-10">353
    entry location  354, 354, 355, 356
    etoolbox package  etoolbox package  357, 358

    F +class="cmbx-10">F first use  359, 360, 407, 408, 409, 410, 410, 411, 412
    first use flag  414, 415, 416, 417
    +class="cmbx-10">417
    first use text  418, 418, 419
    fontenc package  fontenc package  420

    G +class="cmbx-10">G glossaries package  glossaries package  421
    glossaries-accsupp package  glossaries-accsupp package  422, 423, 424, 434, 435, 436
    glossaries-extra-stylemods package  glossaries-extra-stylemods package  437, 438, 439, 440
    glossaries-prefix package  glossaries-prefix package  441, 442, 443
    \glossariesextrasetup  444
    +class="cmtt-10">\glossariesextrasetup  444
    glossary styles:
    + + +     alttree  alttree  445, 446, 447, 449, 450, 451
        inline  inline  452, 453
    - - -     long3col  long3col  454
    glossary-inline package  glossary-inline package  455
    glossary-tree package  glossary-tree package  456, 457, 458
    \glossxtrsetpopts  \glossxtrsetpopts  459
    +class="cmti-10">459
    \glsabbrvdefaultfont  \glsabbrvdefaultfont  460
    +class="cmti-10">460
    \glsabbrvemfont  \glsabbrvemfont  461
    +class="cmti-10">461
    \glsabbrvfont  \glsabbrvfont  462, 462, 463
    +class="cmti-10">463
    \glsabbrvuserfont  \glsabbrvuserfont  464
    +class="cmti-10">464
    \Glsaccessdesc  \Glsaccessdesc  465
    +class="cmti-10">465
    \glsaccessdesc  \glsaccessdesc  466
    +class="cmti-10">466
    \Glsaccessdescplural  \Glsaccessdescplural  467
    +class="cmti-10">467
    \glsaccessdescplural  \glsaccessdescplural  468
    +class="cmti-10">468
    \Glsaccessfirst  \Glsaccessfirst  469
    +class="cmti-10">469
    \glsaccessfirst  \glsaccessfirst  470
    +class="cmti-10">470
    \Glsaccessfirstplural  \Glsaccessfirstplural  471
    +class="cmti-10">471
    \glsaccessfirstplural  \glsaccessfirstplural  472
    +class="cmti-10">472
    \Glsaccesslong  \Glsaccesslong  473
    +class="cmti-10">473
    \glsaccesslong  \glsaccesslong  474
    +class="cmti-10">474
    \Glsaccesslongpl  \Glsaccesslongpl  475
    +class="cmti-10">475
    \glsaccesslongpl  \glsaccesslongpl  476
    +class="cmti-10">476
    \Glsaccessname  \Glsaccessname  477
    +class="cmti-10">477
    \glsaccessname  \glsaccessname  478
    +class="cmti-10">478
    \Glsaccessplural  \Glsaccessplural  479
    +class="cmti-10">479
    \glsaccessplural  \glsaccessplural  480
    +class="cmti-10">480
    \Glsaccessshort  \Glsaccessshort  481
    +class="cmti-10">481
    \glsaccessshort  \glsaccessshort  482
    +class="cmti-10">482
    \Glsaccessshortpl  \Glsaccessshortpl  483
    +class="cmti-10">483
    \glsaccessshortpl  \glsaccessshortpl  484
    +class="cmti-10">484
    \Glsaccesssymbol  \Glsaccesssymbol  485
    +class="cmti-10">485
    \glsaccesssymbol  \glsaccesssymbol  486
    +class="cmti-10">486
    \Glsaccesssymbolplural  \Glsaccesssymbolplural  487
    +class="cmti-10">487
    \glsaccesssymbolplural  \glsaccesssymbolplural  488
    +class="cmti-10">488
    \Glsaccesstext  \Glsaccesstext  489
    +class="cmti-10">489
    \glsaccesstext  \glsaccesstext  490
    +class="cmti-10">490
    \glsacspace  \glsacspace  491
    +class="cmti-10">491
    \glsacspacemax  \glsacspacemax  492
    +class="cmti-10">492
    \glscategory  \glscategory  493
    +class="cmti-10">493
    \glscategorylabel  \glscategorylabel  494
    +class="cmti-10">494
    \glscurrententrylabel  \glscurrententrylabel  495
    +class="cmti-10">495
    \glsentrycurrcount  \glsentrycurrcount  496
    +class="cmti-10">496
    \glsentryprevcount  \glsentryprevcount  497
    +class="cmti-10">497
    \glsentryprevmaxcount  \glsentryprevmaxcount  498
    +class="cmti-10">498
    \glsentryprevtotalcount  \glsentryprevtotalcount  499
    +class="cmti-10">499
    \glsFindWidestAnyName  \glsFindWidestAnyName  500
    +class="cmti-10">500
    + + + \glsFindWidestAnyNameLocation  \glsFindWidestAnyNameLocation  501
    +class="cmti-10">501
    \glsFindWidestAnyNameSymbol  \glsFindWidestAnyNameSymbol  502
    - - - +class="cmti-10">502
    \glsFindWidestAnyNameSymbolLocation  \glsFindWidestAnyNameSymbolLocation  503
    +class="cmti-10">503
    \glsFindWidestLevelTwo  \glsFindWidestLevelTwo  504
    +class="cmti-10">504
    \glsFindWidestTopLevelName  \glsFindWidestTopLevelName  505
    +class="cmti-10">505
    \glsFindWidestUsedAnyName  \glsFindWidestUsedAnyName  506
    +class="cmti-10">506
    \glsFindWidestUsedAnyNameLocation  \glsFindWidestUsedAnyNameLocation  507
    +class="cmti-10">507
    \glsFindWidestUsedAnyNameSymbol  \glsFindWidestUsedAnyNameSymbol  508
    +class="cmti-10">508
    \glsFindWidestUsedAnyNameSymbolLocation  \glsFindWidestUsedAnyNameSymbolLocation  509
    +class="cmti-10">509
    \glsFindWidestUsedLevelTwo  \glsFindWidestUsedLevelTwo  510
    +class="cmti-10">510
    \glsFindWidestUsedTopLevelName  \glsFindWidestUsedTopLevelName  511
    +class="cmti-10">511
    \glsfirstabbrvdefaultfont  \glsfirstabbrvdefaultfont  512
    +class="cmti-10">512
    \glsfirstabbrvemfont  \glsfirstabbrvemfont  513
    +class="cmti-10">513
    \glsfirstabbrvfont  \glsfirstabbrvfont  514, 514, 515
    +class="cmti-10">515
    \glsfirstlongdefaultfont  \glsfirstlongdefaultfont  516
    +class="cmti-10">516
    \glsfirstlongemfont  \glsfirstlongemfont  517
    +class="cmti-10">517
    \glsfirstlongfont  \glsfirstlongfont  518, 518, 519
    +class="cmti-10">519
    \glsfirstlongfootnotefont  \glsfirstlongfootnotefont  520
    +class="cmti-10">520
    \Glsfmtfirst  \Glsfmtfirst  521
    +class="cmti-10">521
    \glsfmtfirst  \glsfmtfirst  522
    +class="cmti-10">522
    \Glsfmtfirstpl  \Glsfmtfirstpl  523
    +class="cmti-10">523
    \glsfmtfirstpl  \glsfmtfirstpl  524
    +class="cmti-10">524
    \Glsfmtfull  \Glsfmtfull  525
    +class="cmti-10">525
    \glsfmtfull  \glsfmtfull  526
    +class="cmti-10">526
    \Glsfmtfullpl  \Glsfmtfullpl  527
    +class="cmti-10">527
    \glsfmtfullpl  \glsfmtfullpl  528
    +class="cmti-10">528
    \Glsfmtlong  \Glsfmtlong  529
    +class="cmti-10">529
    \glsfmtlong  \glsfmtlong  530
    +class="cmti-10">530
    \Glsfmtlongpl  \Glsfmtlongpl  531
    +class="cmti-10">531
    \glsfmtlongpl  \glsfmtlongpl  532
    +class="cmti-10">532
    \Glsfmtplural  \Glsfmtplural  533
    +class="cmti-10">533
    \glsfmtplural  \glsfmtplural  534
    +class="cmti-10">534
    \Glsfmtshort  \Glsfmtshort  535
    +class="cmti-10">535
    \glsfmtshort  \glsfmtshort  536
    +class="cmti-10">536
    \Glsfmtshortpl  \Glsfmtshortpl  537
    +class="cmti-10">537
    \glsfmtshortpl  \glsfmtshortpl  538
    +class="cmti-10">538
    \Glsfmttext  \Glsfmttext  539
    +class="cmti-10">539
    \glsfmttext  \glsfmttext  540
    +class="cmti-10">540
    \glsforeachwithattribute  \glsforeachwithattribute  541
    +class="cmti-10">541
    \glsgetattribute  \glsgetattribute  542
    +class="cmti-10">542
    \glsgetcategoryattribute  \glsgetcategoryattribute  543
    +class="cmti-10">543
    \glsgetwidestname  \glsgetwidestname  544
    +class="cmti-10">544
    \glsgetwidestsubname  \glsgetwidestsubname  545
    +class="cmti-10">545
    \glshasattribute  \glshasattribute  546
    +class="cmti-10">546
    \glshascategoryattribute  \glshascategoryattribute  547
    +class="cmti-10">547
    \glsifattribute  \glsifattribute  548
    +class="cmti-10">548
    + + + \glsifcategory  \glsifcategory  549
    +class="cmti-10">549
    \glsifcategoryattribute  \glsifcategoryattribute  550
    - - - +class="cmti-10">550
    \glsifnotregular  \glsifnotregular  551
    +class="cmti-10">551
    \glsifnotregularcategory  \glsifnotregularcategory  552
    +class="cmti-10">552
    \glsifregular  \glsifregular  553
    +class="cmti-10">553
    \glsifregularcategory  \glsifregularcategory  554
    +class="cmti-10">554
    \glskeylisttok  \glskeylisttok  555
    +class="cmti-10">555
    \glslabeltok  \glslabeltok  556
    +class="cmti-10">556
    \glslink options
    +class="cmtt-10">\glslink options
        format  format  557, 558
        hyper  hyper  559, 560, 561
        hyper=false  hyper=false  562
        noindex  noindex  563, 564, 565, 566, 567
    \glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook  568
    +class="cmti-10">568
    \glslongdefaultfont  \glslongdefaultfont  569
    +class="cmti-10">569
    \glslongemfont  \glslongemfont  570
    +class="cmti-10">570
    \glslongfont  \glslongfont  571, 571, 572
    +class="cmti-10">572
    \glslongfootnotefont  \glslongfootnotefont  573
    +class="cmti-10">573
    \glslongpltok  \glslongpltok  574
    +class="cmti-10">574
    \glslongtok  \glslongtok  575
    +class="cmti-10">575
    \glsps  \glsps  576
    +class="cmti-10">576
    \glspt  \glspt  577
    +class="cmti-10">577
    \glssetattribute  \glssetattribute  578
    +class="cmti-10">578
    \glssetcategoryattribute  \glssetcategoryattribute  579
    +class="cmti-10">579
    \glssetregularcategory  \glssetregularcategory  580
    +class="cmti-10">580
    \glsshortpltok  \glsshortpltok  581
    +class="cmti-10">581
    \glsshorttok  \glsshorttok  582
    +class="cmti-10">582
    \Glsxtr  \Glsxtr  583
    +class="cmti-10">583
    \glsxtr  \glsxtr  584
    +class="cmti-10">584
    \glsxtrabbrvfootnote  \glsxtrabbrvfootnote  585
    +class="cmti-10">585
    \glsxtraddallcrossrefs  \glsxtraddallcrossrefs  586
    +class="cmti-10">586
    \glsxtrAltTreeIndent  \glsxtrAltTreeIndent  587
    +class="cmti-10">587
    \glsxtralttreeInit  \glsxtralttreeInit  588
    +class="cmti-10">588
    \glsxtralttreeSubSymbolDescLocation  \glsxtralttreeSubSymbolDescLocation  589
    +class="cmti-10">589
    \glsxtralttreeSymbolDescLocation  \glsxtralttreeSymbolDescLocation  590
    +class="cmti-10">590
    \glsxtrchecknohyperfirst  \glsxtrchecknohyperfirst  591
    +class="cmti-10">591
    \glsxtrdoautoindexname  \glsxtrdoautoindexname  592
    +class="cmti-10">592
    \glsxtrdowrglossaryhook  \glsxtrdowrglossaryhook  593
    +class="cmti-10">593
    \GlsXtrEnableEntryCounting  \GlsXtrEnableEntryCounting  594
    +class="cmti-10">594
    \GlsXtrEnableEntryUnitCounting  \GlsXtrEnableEntryUnitCounting  595
    +class="cmti-10">595
    \GlsXtrEnableIndexFormatOverride  \GlsXtrEnableIndexFormatOverride  596
    +class="cmti-10">596
    \GlsXtrEnableInitialTagging  \GlsXtrEnableInitialTagging  597
    +class="cmti-10">597
    \GlsXtrEnableOnTheFly  \GlsXtrEnableOnTheFly  598
    +class="cmti-10">598
    \GlsXtrEnablePreLocationTag  \GlsXtrEnablePreLocationTag  599
    +class="cmti-10">599
    \glsxtrfieldtitlecasecs  \glsxtrfieldtitlecasecs  600
    +class="cmti-10">600
    \glsxtrfirstscfont  \glsxtrfirstscfont  601
    +class="cmti-10">601
    + + + \glsxtrfirstsmfont  \glsxtrfirstsmfont  602
    +class="cmti-10">602
    \GlsXtrFormatLocationList  \GlsXtrFormatLocationList  603
    - - - +class="cmti-10">603
    \GLSxtrfull  \GLSxtrfull  604
    +class="cmti-10">604
    \Glsxtrfull  \Glsxtrfull  605
    +class="cmti-10">605
    \glsxtrfull  \glsxtrfull  606
    +class="cmti-10">606
    \Glsxtrfullformat  \Glsxtrfullformat  607
    +class="cmti-10">607
    \glsxtrfullformat  \glsxtrfullformat  608
    +class="cmti-10">608
    \GLSxtrfullpl  \GLSxtrfullpl  609
    +class="cmti-10">609
    \Glsxtrfullpl  \Glsxtrfullpl  610
    +class="cmti-10">610
    \glsxtrfullpl  \glsxtrfullpl  611
    +class="cmti-10">611
    \Glsxtrfullplformat  \Glsxtrfullplformat  612
    +class="cmti-10">612
    \glsxtrfullplformat  \glsxtrfullplformat  613
    +class="cmti-10">613
    \glsxtrfullsep  \glsxtrfullsep  614
    +class="cmti-10">614
    \glsxtrifcounttrigger  \glsxtrifcounttrigger  615
    +class="cmti-10">615
    \glsxtrifwasfirstuse  \glsxtrifwasfirstuse  616
    +class="cmti-10">616
    \Glsxtrinlinefullformat  \Glsxtrinlinefullformat  617
    +class="cmti-10">617
    \glsxtrinlinefullformat  \glsxtrinlinefullformat  618
    +class="cmti-10">618
    \Glsxtrinlinefullplformat  \Glsxtrinlinefullplformat  619
    +class="cmti-10">619
    \glsxtrinlinefullplformat  \glsxtrinlinefullplformat  620
    +class="cmti-10">620
    \glsxtrinsertinsidetrue  \glsxtrinsertinsidetrue  621
    +class="cmti-10">621
    \Glsxtrlong  \Glsxtrlong  622, 622, 623
    +class="cmti-10">623
    \glsxtrlong  \glsxtrlong  624
    +class="cmti-10">624
    \GLSxtrlongpl  \GLSxtrlongpl  625
    +class="cmti-10">625
    \Glsxtrlongpl  \Glsxtrlongpl  626
    +class="cmti-10">626
    \glsxtrlongpl  \glsxtrlongpl  627
    +class="cmti-10">627
    \glsxtrlongshortdescsort  \glsxtrlongshortdescsort  628
    +class="cmti-10">628
    \glsxtrnewnumber  629
    +class="cmtt-10">\glsxtrnewnumber  629
    \glsxtrnewsymbol  630
    +class="cmtt-10">\glsxtrnewsymbol  630
    \GlsXtrNoGlsWarningAutoMake  \GlsXtrNoGlsWarningAutoMake  631
    +class="cmti-10">631
    \GlsXtrNoGlsWarningBuildInfo  \GlsXtrNoGlsWarningBuildInfo  632
    +class="cmti-10">632
    \GlsXtrNoGlsWarningCheckFile  \GlsXtrNoGlsWarningCheckFile  633
    +class="cmti-10">633
    \GlsXtrNoGlsWarningEmptyMain  \GlsXtrNoGlsWarningEmptyMain  634
    +class="cmti-10">634
    \GlsXtrNoGlsWarningEmptyNotMain  \GlsXtrNoGlsWarningEmptyNotMain  635
    +class="cmti-10">635
    \GlsXtrNoGlsWarningEmptyStart  \GlsXtrNoGlsWarningEmptyStart  636
    +class="cmti-10">636
    \GlsXtrNoGlsWarningHead  \GlsXtrNoGlsWarningHead  637
    +class="cmti-10">637
    \GlsXtrNoGlsWarningMisMatch  \GlsXtrNoGlsWarningMisMatch  638
    +class="cmti-10">638
    \GlsXtrNoGlsWarningNoOut  \GlsXtrNoGlsWarningNoOut  639
    +class="cmti-10">639
    \GlsXtrNoGlsWarningTail  \GlsXtrNoGlsWarningTail  640
    +class="cmti-10">640
    \Glsxtrp  \Glsxtrp  641, 641, 642
    +class="cmti-10">642
    \glsxtrp  \glsxtrp  643
    +class="cmti-10">643
    \Glsxtrpl  \Glsxtrpl  644
    +class="cmti-10">644
    \glsxtrpl  \glsxtrpl  645
    +class="cmti-10">645
    \glsxtrpostdescription  \glsxtrpostdescription  646
    +class="cmti-10">646
    \glsxtrpostlink  \glsxtrpostlink  647
    +class="cmti-10">647
    \glsxtrpostlinkAddDescOnFirstUse  \glsxtrpostlinkAddDescOnFirstUse  648
    +class="cmti-10">648
    \glsxtrpostlinkAddSymbolOnFirstUse  \glsxtrpostlinkAddSymbolOnFirstUse  649
    +class="cmti-10">649
    + + + \glsxtrpostlinkendsentence  \glsxtrpostlinkendsentence  650
    +class="cmti-10">650
    \glsxtrpostlinkhook  \glsxtrpostlinkhook  651
    - - - +class="cmti-10">651
    \glsxtrpostnamehook  \glsxtrpostnamehook  652
    +class="cmti-10">652
    \GlsXtrPostNewAbbreviation  \GlsXtrPostNewAbbreviation  653
    +class="cmti-10">653
    \glsxtrregularfont  \glsxtrregularfont  654
    +class="cmti-10">654
    +\glsxtrresourcefile  655
    \glsxtrRevertMarks  \glsxtrRevertMarks  655
    +class="cmti-10">656
    \glsxtrscfont  \glsxtrscfont  656
    +class="cmti-10">657
    \glsxtrscsuffix  \glsxtrscsuffix  657
    +class="cmti-10">658
    \GlsXtrSetActualChar  \GlsXtrSetActualChar  658
    +class="cmti-10">659
    \GlsXtrSetAltModifier  \GlsXtrSetAltModifier  659
    +class="cmti-10">660
    \glsxtrsetcategory  \glsxtrsetcategory  660
    +class="cmti-10">661
    \glsxtrsetcategoryforall  \glsxtrsetcategoryforall  661
    +class="cmti-10">662
    \GlsXtrSetDefaultGlsOpts  \GlsXtrSetDefaultGlsOpts  662
    +class="cmti-10">663
    \GlsXtrSetEncapChar  \GlsXtrSetEncapChar  663
    +class="cmti-10">664
    \GlsXtrSetEscChar  \GlsXtrSetEscChar  664
    +class="cmti-10">665
    \GlsXtrSetLevelChar  \GlsXtrSetLevelChar  665
    +class="cmti-10">666
    \glsxtrsetpopts  \glsxtrsetpopts  666
    +class="cmti-10">667
    \Glsxtrshort  \Glsxtrshort  667, 668, 668
    +class="cmti-10">669
    \glsxtrshort  \glsxtrshort  669
    +class="cmti-10">670
    \GLSxtrshortpl  \GLSxtrshortpl  670
    +class="cmti-10">671
    \Glsxtrshortpl  \Glsxtrshortpl  671
    +class="cmti-10">672
    \glsxtrshortpl  \glsxtrshortpl  672
    +class="cmti-10">673
    \glsxtrsmfont  \glsxtrsmfont  673
    +class="cmti-10">674
    \glsxtrsmsuffix  \glsxtrsmsuffix  674
    +class="cmti-10">675
    \glsxtrtagfont  \glsxtrtagfont  675
    +class="cmti-10">676
    \GlsXtrUseAbbrStyleFmts  \GlsXtrUseAbbrStyleFmts  676
    +class="cmti-10">677
    \GlsXtrUseAbbrStyleSetup  \GlsXtrUseAbbrStyleSetup  677
    +class="cmti-10">678
    \glsxtruserfield  \glsxtruserfield  678
    +class="cmti-10">679
    \glsxtruserparen  \glsxtruserparen  679
    +class="cmti-10">680
    \glsxtrusersuffix  \glsxtrusersuffix  680
    +class="cmti-10">681
    \glsxtrusesee  \glsxtrusesee  681
    +class="cmti-10">682
    \glsxtruseseeformat  \glsxtruseseeformat  682
    +class="cmti-10">683
    \GlsXtrWarnDeprecatedAbbrStyle  \GlsXtrWarnDeprecatedAbbrStyle  683
    +class="cmti-10">684
    \GlsXtrWarning  \GlsXtrWarning  684
    +class="cmti-10">685

    H +class="cmbx-10">H hyperref package  685, 686, 687, 688, 689, 690, 691, 692, 693, 694, 695
    +class="cmss-10">hyperref package  686, 687, 688, 689, 690, 691, 692, 693, 694, 695, 696

    L +class="cmbx-10">L link-text  696, 697, 698, 699, 700, 701, 702, 703, 704, 705, 706, 707, 708, 709, 710, 711, 712, 697, 698, 699, 700, 701, 702, 703, 704, 705, 706, 707, 708, 709, 710, 711, 712, 713, 713
    +class="cmbx-10">714
    location list  714, 715, 715
    +class="cmbx-10">716

    M +class="cmbx-10">M + + + makeglossaries  716, 717, 718, makeglossaries  717, 718, 719, 719
    +class="cmbx-10">720
    +\makeglossaries  721
    makeindex  720, 721, 722, 723, 724, 725, 726, makeindex  722, 723, 724, 725, 726, 727, 728, 727
    - - - +class="cmbx-10">729
    memoir class  728
    +class="cmss-10">memoir class  730
    mfirstuc package  729, 730, 731
    +class="cmss-10">mfirstuc package  731, 732, 733

    N +class="cmbx-10">N \newabbreviation  \newabbreviation  732
    +class="cmti-10">734
    \newabbreviationstyle  \newabbreviationstyle  733
    +class="cmti-10">735
    \newacronym  \newacronym  734
    +class="cmti-10">736
    \newglossaryentry options
    -    category  735, 736, 737, 738, 739
    -    desc  740, 741
    -    descplural  742, 743
    -    description  744, 745, 746, 747, 748, 749, 750, 751, 752, 753, 754, 755, 756, 757, 758
    -    first  759, 760, 761, 762, 763, 764, 765, 766, 767, 768
    -    firstplural  769, 770, 771, 772, 773, 774
    -    long  775, 776, 777, 778, 779
    -    longplural  780, 781, 782, 783
    -    name  784, 785, 786, 787, 788, 789, 790, 791, 792, 793, 794, 795, 796, 797, 798, 799, 800, 801, 802, 803, 804, 805, 806
    -    parent  807
    -    plural  808, 809, 810, 811
    -    see  812, 813, 814, 815, 816, 817, 818, 819, 820, 821, 822, 823, 824
    -    short  825, 826, 827, 828, 829, 830, 831, 832, 833, 834
    -    shortplural  835, 836, 837, 838, 839, 840, 841, 842, 843, 844
    -    sort  845, 846, 847, 848, 849, 850, 851, 852, 853, 854, 855, 856
    -    symbol  857, 858
    -    symbolplural  859, 860
    -    text  861, 862, 863, 864, 865, 866, 867, 868
    -    type  869, 870
    -    user1  871, 872, 873
    +class="cmtt-10">\newglossaryentry options
    +    category  737, 738, 739, 740, 741
    +    desc  742, 743
    +    descplural  744, 745
    +    description  746, 747, 748, 749, 750, 751, 752, 753, 754, 755, 756, 757, 758, 759, 760
    +    first  761, 762, 763, 764, 765, 766, 767, 768, 769, 770
    +    firstplural  771, 772, 773, 774, 775, 776
    +    loclist  777, 778
    +    long  779, 780, 781, 782, 783
    +    longplural  784, 785, 786, 787
    +    name  788, 789, 790, 791, 792, 793, 794, 795, 796, 797, 798, 799, 800, 801, 802, 803, 804, 805, 806, 807, 808, 809, 810
    +    parent  811
    +    plural  812, 813, 814, 815
    +    see  816, 817, 818, 819, 820, 821, 822, 823, 824, 825, 826, 827, 828
    +    short  829, 830, 831, 832, 833, 834, 835, 836, 837, 838
    +    shortplural  839, 840, 841, 842, 843, 844, 845, 846, 847, 848
    +    sort  849, 850, 851, 852, 853, 854, 855, 856, 857, 858, 859, 860
    +    symbol  861, 862
    +    symbolplural  863, 864
    +    text  865, 866, 867, 868, 869, 870, 871, 872
    +    type  873, 874
    +    user1  875, 876, 877
    number list  874, 875, 876, 877, 878, 879, 880, 881, 882, 883, 884, 885, 886, 887, 888, 889, 890, 891, 892, 878, 879, 880, 881, 882, 883, 884, 885, 886, 887, 888, 889, 890, 891, 892, 893, 894, 895, 896, 897, 898, 893
    +class="cmbx-10">899

    P +class="cmbx-10">P package options:
        abbreviations  894, 895, 896, 897, 898
    +class="cmss-10">abbreviations  900, 901, 902, 903, 904
        accsupp  899, 900, 901
    +class="cmss-10">accsupp  905, 906, 907
        acronym  902
    +class="cmss-10">acronym  908
        acronymlists  903
    -    automake  904
    -    docdef  905, 906, 907
    -        restricted  908
    -        true  909, 910
    -    docdefs  911, 912
    -    hyperfirst
    -        false  913
    +class="cmss-10">acronymlists  909
        index  914, 915
    +class="cmss-10">automake  910
        indexcrossrefs  916, 917, 918
    -    indexonlyfirst  919, 920, 921, 922
    -    nomain  923
    -    nomissingglstext  924
    +class="cmss-10">docdef  911, 912, 913
    +        restricted  914
    +        true  915, 916
        nonumberlist  925, 926, 927, 928
    +class="cmss-10">docdefs  917, 918
        nopostdot  929, 930
    +class="cmss-10">hyperfirst
    +        false  919
    +    index  920, 921
    +    indexcrossrefs  922, 923, 924
    +    indexonlyfirst  925, 926, 927, 928
    +    nomain  929
    +    nomissingglstext  930
    +    nonumberlist  931, 932, 933, 934
    +    nopostdot  935, 936
            false  931, 932
    +class="cmss-10">false  937, 938
            true  933
    +class="cmss-10">true  939
        noredefwarn
    +class="cmss-10">noredefwarn
            false  934
    +class="cmss-10">false  940
            true  935
    +class="cmss-10">true  941
        notree  936
    +class="cmss-10">notree  942
        numbers  937, 938, 939
    +class="cmss-10">numbers  943, 944, 945
        seeautonumberlist  940
    +class="cmss-10">record  946
    +        alsoindex  947
    +        off  948
    +        only  949
    +    seeautonumberlist  950
        seenoindex  941
    +class="cmss-10">seenoindex  951
            ignore  942
    +class="cmss-10">ignore  952
        shortcuts  943, 944
    +class="cmss-10">shortcuts  953, 954
            abbr  945, 946
    +class="cmss-10">abbr  955, 956
            abbreviation  947
    +class="cmss-10">abbreviation  957
            abbreviations  948
    +class="cmss-10">abbreviations  958
            acro  949
    +class="cmss-10">acro  959
            acronyms  950
    +class="cmss-10">acronyms  960
            all  951
    +class="cmss-10">all  961
            false  952
    +class="cmss-10">false  962
            none  953
    +class="cmss-10">none  963
            other  954
    +class="cmss-10">other  964
            true  955
    +class="cmss-10">true  965
        stylemods  956, 957, 958
    +class="cmss-10">stylemods  966, 967, 968
        symbols  959, 960, 961
    +class="cmss-10">symbols  969, 970, 971
        toc
    +class="cmss-10">toc
            false  962
    +class="cmss-10">false  972
            true  963
    +class="cmss-10">true  973
        translate
    +class="cmss-10">translate
            babel  964
    +class="cmss-10">babel  974
    + + +         true  965
    +class="cmss-10">true  975
        undefaction  966, 967
    +class="cmss-10">undefaction  976, 977
            error  968
    +class="cmss-10">error  978, 979
            warn  969, 970
    +class="cmss-10">warn  980, 981, 982
    page (counter)  971, 972
    +class="cmtt-10">page (counter)  983, 984
    polyglossia package  973
    +class="cmss-10">polyglossia package  985
    \printabbreviations  974
    +class="cmtt-10">\printabbreviations  986
    \printglossary options
    +class="cmtt-10">\printglossary options
        title  975
    +class="cmss-10">title  987
    +\printunsrtglossaries  988
    +\printunsrtglossary  989

    R - - - +class="cmbx-10">R relsize package  976
    +class="cmss-10">relsize package  990
    \RestoreAcronyms  \RestoreAcronyms  977
    +class="cmti-10">991

    S +class="cmbx-10">S \setabbreviationstyle  \setabbreviationstyle  978
    +class="cmti-10">992
    slantsc package  979
    +class="cmss-10">slantsc package  993

    T +class="cmbx-10">T textcase package  980
    +class="cmss-10">textcase package  994
    tracklang package  981, 982
    +class="cmss-10">tracklang package  995, 996
    translator package  983
    +class="cmss-10">translator package  997

    X +class="cmbx-10">X xfor package  984
    +class="cmss-10">xfor package  998
    \xglssetwidest  \xglssetwidest  985
    +class="cmti-10">999
    xindy  986, 987, 988, 989, xindy  1000, 1001, 1002, 1003, 990
    +class="cmbx-10">1004
    xkeyval package  991
    +class="cmss-10">xkeyval package  1005

    1.14.21 was originally intended as the last release of glossaries to incorporate new features, but +class="cmr-8">4.21 was originally intended as the last release of glossaries to incorporate new features, but a few new minor features slipped in with some bug fixes in v4.21.

    +class="cmr-8">a few new minor features slipped in with some bug fixes in v4.21.

    diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.pdf index dd6f8f207ea..0dba8b5f2ec 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex index 291cd280f70..f48bac27bc9 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex +++ b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex @@ -1,7 +1,5 @@ \documentclass[report,inlinetitle,widecs]{nlctdoc} -\usepackage[utf8]{inputenc} -\usepackage[T1]{fontenc} \usepackage{alltt} \usepackage{hologo} \usepackage[colorlinks, @@ -143,13 +141,13 @@ styles (glossaries):>#1={\protect\ttfamily#1}|main}} \DeleteShortVerb{\|} \MakeShortVerb{"} - \title{glossaries-extra.sty v1.07: + \title{glossaries-extra.sty v1.08: an extension to the glossaries package} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \url{http://www.dickimaw-books.com/}} - \date{2016-08-15} + \date{2016-12-13} \maketitle \begin{abstract} @@ -457,6 +455,73 @@ default for \styfmt{glossaries}). You can switch this to a warning message (and ?? appearing in the text) with \pkgopt[warn]{undefaction}. +\item[{\pkgopt{record}}] (New to v1.08.) This is a \meta{key}=\meta{value} +option, which has three allowed values: \pkgoptfmt{off} (default), +\pkgoptfmt{only} and \pkgoptfmt{alsoindex}. If the value is omitted +\pkgoptfmt{only} is assumed. The option is provided for the benefit +of any post-processing applications that need to know information +about the entries used in the document. The option may only be set +in the preamble. + +The \pkgopt[off]{record} option switches off the recording, as per +the default behaviour. It implements \pkgopt[error]{undefaction} + +The other values switch on the recording and also +\pkgopt[warn]{undefaction}, but \pkgopt[only]{record} +will also switch off the indexing mechanism (even if \cs{makeglossaries} +or \cs{makenoidxglossaries} has been used) whereas +\pkgopt[alsoindex]{record} will both record and index. + +With the recording on, any of the commands that would typically +index the entry (such as \cs{gls}, \cs{glstext} or \cs{glsadd}) +will add a \cs{glsxtr@record} entry to the \texttt{.aux} file. +The post-processing application can then read these lines to find +out which entries have been used. (Remember that commands like +\cs{glsentryname} don't index, so any use of these commands won't +add a corresponding \cs{glsxtr@record} entry to the \texttt{.aux} +file.) + +There are two new commands that are intended for use with the +recording function: +\begin{definition}[\DescribeMacro\glsxtrresourcefile] +\cs{glsxtrresourcefile}\oarg{options}\marg{filename} +\end{definition} +This writes the line +\begin{alltt} +\cs{glsxtr@resource}\marg{options}\marg{filename} +\end{alltt} +to the \texttt{.aux} file and, if \meta{filename} exists, will then +input \meta{filename}. The post-processor may use this information +to create the required file. The options aren't processed by +\styfmt{glossaries-extra} (other than simply writing \meta{options} +to the \texttt{.aux} file). The post-processor determines the +allowed options. + +\begin{definition}[\DescribeMacro\printunsrtglossary] +\cs{printunsrtglossary}\oarg{options} +\end{definition} +This behaves like \cs{printnoidxglossary} but never sorts the +entries and always lists all the defined entries for the given +glossary (and doesn't require \cs{makenoidxglossaries}). +The optional argument is as for \cs{printnoidxglossary}. +The \gls{numberlist} will need setting by the post-processor +by adding the \gloskey{loclist} field to the entry definitions, +otherwise the \gls*{numberlist} will be empty. The \gloskey{loclist} +field should be a comma-separated list where each location in the +list is in the format +\begin{definition} +\cs{glsnoidxdisplayloc}\marg{prefix}\marg{counter}\marg{format}\marg{location} +\end{definition} +(see the \styfmt{glossaries} manual for information about that +command). + +All glossaries may be displayed in the order of their definition +using: +\begin{definition}[\DescribeMacro\printunsrtglossaries] +\cs{printunsrtglossaries} +\end{definition} +which is analogous to \cs{printnoidxglossaries}. + \item[{\pkgopt{docdef}}] This option governs the use of \cs{newglossaryentry}. It was originally a boolean option, but as from version 1.06, it can now take one of three values (if @@ -673,6 +738,19 @@ The \ics{newacronym} command is modified to use the new abbreviation interface provided by \styfmt{glossaries-extra}. (See \sectionref{sec:abbreviations}.) +The \cs{makeglossaries} command now has an optional argument. +\begin{definition}[\DescribeMacro\makeglossaries] +\cs{makeglossaries}\oarg{list} +\end{definition} +If \meta{list} is empty, \cs{makeglossaries} behaves as per +its original definition in the \styfmt{glossaries} package, +otherwise \meta{list} can be a comma-separated list of glossaries +that need processing with an external indexing application. + +It should then be possible to use \cs{printglossary} for those +glossaries listed in \meta{list} and \cs{printnoidxglossary} +for the other glossaries. + \section{Entry Indexing} \label{sec:wrglossary} diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbrv.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbrv.pdf index fc808491e2c..6e789c65092 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbrv.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbrv.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-accsupp.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-accsupp.pdf index 6bc8fc7a1d3..8737e15799b 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-accsupp.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-accsupp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym-desc.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym-desc.pdf index 574e6197c9d..6abe4a1dea4 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym-desc.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym-desc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym.pdf index 81ba008be1d..0b4b52f9dd2 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-altmodifier.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-altmodifier.pdf index 94a9d744cc0..c18ae34dc48 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-altmodifier.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-altmodifier.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-marginpar.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-marginpar.pdf index c99e46974eb..eb2c0431138 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-marginpar.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-marginpar.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-sym.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-sym.pdf index 7c81e88b1d2..6247243ffd9 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-sym.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-sym.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree.pdf index 11f89693dca..8ad929ca5df 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex-hyp.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex-hyp.pdf index 3b0ad89d56d..76b7e9ce212 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex-hyp.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex-hyp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.pdf index 345ae253ff3..4814d2d4154 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.pdf index 1ac39465896..487f5c61eea 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.pdf index 72c90dc017f..206a62db024 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-docdef.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-docdef.pdf index a4096576a76..486a054d789 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-docdef.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-docdef.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-entrycount.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-entrycount.pdf index 298f146d7eb..fc0b5e87029 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-entrycount.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-entrycount.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-footnote.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-footnote.pdf index 851ed6b3bf4..fc0538e9840 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-footnote.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-footnote.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-header.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-header.pdf index 878739b75f8..53b20e987f8 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-header.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-header.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-indexhook.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-indexhook.pdf index e9ac3b7c5cd..525dc077a42 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-indexhook.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-indexhook.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-initialisms.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-initialisms.pdf index fa975758c49..da646d3e7bc 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-initialisms.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-initialisms.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixed-abbrv-styles.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixed-abbrv-styles.pdf index 728736180e8..7d55ae9f231 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixed-abbrv-styles.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixed-abbrv-styles.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixture.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixture.pdf index 9d3bcd9d523..c6d4f59b7b5 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixture.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixture.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-name-font.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-name-font.pdf index 8aae7ece1d5..558a5ffe4b2 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-name-font.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-name-font.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-nested.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-nested.pdf index ebafd0d9b8f..95af40b6d92 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-nested.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-nested.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-noidx-restricteddocdefs.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-noidx-restricteddocdefs.pdf index 0d08c94ee07..3383f207b5a 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-noidx-restricteddocdefs.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-noidx-restricteddocdefs.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onelink.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onelink.pdf index 0a0caf3cc86..49ff39b8f4f 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onelink.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onelink.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-utf8.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-utf8.pdf index 3b1a6a1b115..cf88ab4b1a1 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-utf8.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-utf8.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-xetex.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-xetex.pdf index f2e26467eac..9ccba805f82 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-xetex.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-xetex.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly.pdf index 1b0a6511238..db44dd090ba 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-pages.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-pages.pdf index 2a1c27be081..ed58282dd1b 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-pages.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-pages.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-postdot.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-postdot.pdf index af7ba179963..88057133762 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-postdot.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-postdot.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-postlink.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-postlink.pdf index e713b4a0042..234c82bcd07 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-postlink.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-postlink.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-prefix.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-prefix.pdf index cc38940d547..7c993362e4a 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-prefix.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-prefix.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf new file mode 100644 index 00000000000..dcc2799ab6f Binary files /dev/null and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.tex b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.tex new file mode 100644 index 00000000000..282b14a80f7 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.tex @@ -0,0 +1,19 @@ +% arara: pdflatex +% arara: pdflatex +\documentclass{article} + +\usepackage[record]{glossaries-extra} + +\glsxtrresourcefile{example-glossaries-brief} + +\begin{document} + +\glspl{lorem}, \gls{dolor}, \gls{amet}. + +\newpage + +\glsadd{lorem}. + +\printunsrtglossary + +\end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-restricteddocdefs.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-restricteddocdefs.pdf index c9fdc0e5adf..1b707ebcddf 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-restricteddocdefs.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-restricteddocdefs.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-trans.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-trans.pdf index 8ffecd539e3..67370e71324 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-trans.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-trans.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-undef.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-undef.pdf index 1c7ab71f16c..86dbb3629d4 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-undef.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-undef.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-unitentrycount.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-unitentrycount.pdf index 61497b0f405..ed4851616f3 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-unitentrycount.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-unitentrycount.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample.pdf index 64243f3649d..eed68303fb6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample.pdf differ -- cgit v1.2.3