From fcd87a9cfad7e0d21b6843d62708c8ee5dbbe174 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 11 Sep 2017 20:47:29 +0000 Subject: glossaries-extra (11sep17) git-svn-id: svn://tug.org/texlive/trunk@45271 c570f23f-e606-0410-a88d-b1316a301751 --- .../example-glossaries-acronym-desc.bib | 43 - .../example-glossaries-acronym.bib | 43 - .../example-glossaries-acronyms-lang.bib | 43 - .../glossaries-extra/example-glossaries-brief.bib | 43 - .../example-glossaries-childnoname.bib | 43 - .../glossaries-extra/example-glossaries-cite.bib | 43 - .../glossaries-extra/example-glossaries-images.bib | 43 - .../glossaries-extra/example-glossaries-long.bib | 43 - .../example-glossaries-multipar.bib | 43 - .../glossaries-extra/example-glossaries-parent.bib | 43 - .../example-glossaries-symbols.bib | 43 - .../glossaries-extra/example-glossaries-url.bib | 43 - .../bib/glossaries-extra/example-glossaries-xr.bib | 43 - .../texmf-dist/doc/latex/glossaries-extra/CHANGES | 7 + .../texmf-dist/doc/latex/glossaries-extra/README | 4 +- .../glossaries-extra/glossaries-extra-code.pdf | Bin 931301 -> 936527 bytes .../glossaries-extra/glossaries-extra-manual.html | 3202 ++++++++++---------- .../glossaries-extra/glossaries-extra-manual.pdf | Bin 741612 -> 742259 bytes .../glossaries-extra/glossaries-extra-manual.tex | 40 +- .../latex/glossaries-extra/sample-abbr-styles.pdf | Bin 500436 -> 500436 bytes .../doc/latex/glossaries-extra/sample-abbrv.pdf | Bin 44761 -> 44761 bytes .../doc/latex/glossaries-extra/sample-accsupp.pdf | Bin 80757 -> 80757 bytes .../latex/glossaries-extra/sample-acronym-desc.pdf | Bin 50368 -> 50368 bytes .../doc/latex/glossaries-extra/sample-acronym.pdf | Bin 36745 -> 36745 bytes .../doc/latex/glossaries-extra/sample-alias.pdf | Bin 43611 -> 43611 bytes .../latex/glossaries-extra/sample-altmodifier.pdf | Bin 35308 -> 35308 bytes .../glossaries-extra/sample-alttree-marginpar.pdf | Bin 91061 -> 91061 bytes .../latex/glossaries-extra/sample-alttree-sym.pdf | Bin 69532 -> 69532 bytes .../doc/latex/glossaries-extra/sample-alttree.pdf | Bin 54866 -> 54866 bytes .../glossaries-extra/sample-autoindex-hyp.pdf | Bin 142285 -> 142037 bytes .../latex/glossaries-extra/sample-autoindex.pdf | Bin 161788 -> 161503 bytes .../doc/latex/glossaries-extra/sample-crossref.pdf | Bin 41294 -> 41294 bytes .../latex/glossaries-extra/sample-crossref2.pdf | Bin 41613 -> 41613 bytes .../doc/latex/glossaries-extra/sample-docdef.pdf | Bin 45257 -> 45257 bytes .../latex/glossaries-extra/sample-entrycount.pdf | Bin 54623 -> 54623 bytes .../doc/latex/glossaries-extra/sample-external.pdf | Bin 55786 -> 55786 bytes .../doc/latex/glossaries-extra/sample-fmt.pdf | Bin 97564 -> 97564 bytes .../doc/latex/glossaries-extra/sample-footnote.pdf | Bin 63232 -> 63232 bytes .../doc/latex/glossaries-extra/sample-header.pdf | Bin 125199 -> 125199 bytes .../latex/glossaries-extra/sample-indexhook.pdf | Bin 42722 -> 42722 bytes .../latex/glossaries-extra/sample-initialisms.pdf | Bin 81618 -> 81618 bytes .../glossaries-extra/sample-mixed-abbrv-styles.pdf | Bin 57823 -> 57823 bytes .../latex/glossaries-extra/sample-mixedsort.pdf | Bin 45154 -> 45154 bytes .../doc/latex/glossaries-extra/sample-mixture.pdf | Bin 160222 -> 159939 bytes .../latex/glossaries-extra/sample-name-font.pdf | Bin 202102 -> 202094 bytes .../doc/latex/glossaries-extra/sample-nested.pdf | Bin 67736 -> 67736 bytes .../sample-noidx-restricteddocdefs.pdf | Bin 47582 -> 47582 bytes .../doc/latex/glossaries-extra/sample-onelink.pdf | Bin 44455 -> 44527 bytes .../glossaries-extra/sample-onthefly-utf8.pdf | Bin 106071 -> 106071 bytes .../glossaries-extra/sample-onthefly-xetex.pdf | Bin 19859 -> 19863 bytes .../doc/latex/glossaries-extra/sample-onthefly.pdf | Bin 43481 -> 43481 bytes .../doc/latex/glossaries-extra/sample-pages.pdf | Bin 38801 -> 38801 bytes .../doc/latex/glossaries-extra/sample-postdot.pdf | Bin 37059 -> 37059 bytes .../doc/latex/glossaries-extra/sample-postlink.pdf | Bin 67889 -> 67890 bytes .../doc/latex/glossaries-extra/sample-prefix.pdf | Bin 33119 -> 33119 bytes .../latex/glossaries-extra/sample-record.glstex | 1 + .../doc/latex/glossaries-extra/sample-record.pdf | Bin 49196 -> 49091 bytes .../glossaries-extra/sample-restricteddocdefs.pdf | Bin 47895 -> 47895 bytes .../latex/glossaries-extra/sample-suppl-hyp.pdf | Bin 34944 -> 34944 bytes .../glossaries-extra/sample-suppl-main-hyp.pdf | Bin 46402 -> 46402 bytes .../latex/glossaries-extra/sample-suppl-main.pdf | Bin 31607 -> 31607 bytes .../doc/latex/glossaries-extra/sample-suppl.pdf | Bin 13423 -> 13423 bytes .../doc/latex/glossaries-extra/sample-trans.pdf | Bin 49455 -> 49455 bytes .../doc/latex/glossaries-extra/sample-undef.pdf | Bin 33231 -> 33231 bytes .../glossaries-extra/sample-unitentrycount.pdf | Bin 61051 -> 61051 bytes .../doc/latex/glossaries-extra/sample.pdf | Bin 45747 -> 45747 bytes .../latex/glossaries-extra/glossaries-extra.dtx | 54 +- .../latex/glossaries-extra/glossaries-extra.ins | 41 +- .../glossaries-extra-stylemods.sty | 2 +- .../latex/glossaries-extra/glossaries-extra.sty | 14 +- 70 files changed, 1737 insertions(+), 2187 deletions(-) diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronym-desc.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronym-desc.bib index 20cadcf2a2d..b09edbd6f74 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronym-desc.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronym-desc.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-acronym-desc.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-acronym-desc.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @acronym{ndl, description = {fringilla a, euismod sodales, sollicitudin vel, wisi}, @@ -97,6 +57,3 @@ turpis}, long = {pellentesque cursus luctus mauris} } -\endinput -%% -%% End of file `example-glossaries-acronym-desc.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronym.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronym.bib index 58eb6289d82..8316f97d9f7 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronym.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronym.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-acronym.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-acronym.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @acronym{lid, short = {LID}, long = {lorem ipsum dolor} @@ -253,6 +213,3 @@ long = {dignissim rutrum nam} } -\endinput -%% -%% End of file `example-glossaries-acronym.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronyms-lang.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronyms-lang.bib index 221cbc1d19d..b9ac0034f11 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronyms-lang.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-acronyms-lang.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-acronyms-lang.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-acronyms-lang.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @acronym{li, user1 = {love itself}, short = {LI}, @@ -74,6 +34,3 @@ risus ut urna} long = {duis iaculi} } -\endinput -%% -%% End of file `example-glossaries-acronyms-lang.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-brief.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-brief.bib index 93e671e4935..b4b50e54a17 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-brief.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-brief.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-brief.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-brief.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @entry{lorem, name = {lorem}, description = {ipsum} @@ -303,6 +263,3 @@ description = {dignissim} } -\endinput -%% -%% End of file `example-glossaries-brief.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-childnoname.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-childnoname.bib index 16db4cdf17c..f910b83aff6 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-childnoname.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-childnoname.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-childnoname.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-childnoname.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @entry{scelerisque, name = {scelerisque}, description = {at} @@ -232,6 +192,3 @@ magnis} parturient montes} } -\endinput -%% -%% End of file `example-glossaries-childnoname.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-cite.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-cite.bib index c1c81f18b11..adc1a90d765 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-cite.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-cite.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-cite.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-cite.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @entry{fusce, user1 = {article-minimal}, name = {fusce}, @@ -157,6 +117,3 @@ description = {lacus} } -\endinput -%% -%% End of file `example-glossaries-cite.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-images.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-images.bib index 774aed565a5..22f8d690a1a 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-images.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-images.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-images.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-images.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @entry{sedfeugiat, user1 = {example-image}, name = {sed feugiat}, @@ -328,6 +288,3 @@ aliquet. Pellentesque aliquet sodales urna. } } -\endinput -%% -%% End of file `example-glossaries-images.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-long.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-long.bib index fbb42e28b1c..da3198e2b09 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-long.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-long.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-long.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-long.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @entry{loremipsum, name = {lorem ipsum}, description = {dolor sit amet, consectetuer adipiscing elit. Ut purus @@ -128,6 +88,3 @@ vel magna. Integer non enim. Praesent euismod nunc eu purus. Donec bibendum quam in tellus.} } -\endinput -%% -%% End of file `example-glossaries-long.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-multipar.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-multipar.bib index 823e5a6ba6d..9ca1fa9b1d3 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-multipar.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-multipar.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-multipar.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-multipar.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @entry{loremi-ii, name = {lorem 1--2}, description = {Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, @@ -166,6 +126,3 @@ Praesent malesuada, diam id pretium elementum, eros sem dictum tortor, vel consectetuer odio sem sed wisi.} } -\endinput -%% -%% End of file `example-glossaries-multipar.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-parent.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-parent.bib index 1ff7d2e9166..80ded4369b7 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-parent.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-parent.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-parent.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-parent.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @entry{sedmattis, name = {sed mattis}, description = {erat sit amet} @@ -165,6 +125,3 @@ suscipit} description = {elit, molestie non} } -\endinput -%% -%% End of file `example-glossaries-parent.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-symbols.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-symbols.bib index 7b813f3bca8..196d148ad54 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-symbols.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-symbols.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-symbols.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-symbols.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @entry{alpha, symbol = {\ensuremath{\alpha}}, name = {alpha}, @@ -181,6 +141,3 @@ lectus sagittis dui, et vehicula libero dui cursus dui.} description = {Mauris tempor ligula sed lacus.} } -\endinput -%% -%% End of file `example-glossaries-symbols.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-url.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-url.bib index bbca8176846..ccf61024b53 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-url.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-url.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-url.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-url.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @entry{aenean-url, user1 = {http://uk.tug.org/}, name = {aenean}, @@ -99,6 +59,3 @@ amet, libero} \texttt{\string\glspercentchar})} } -\endinput -%% -%% End of file `example-glossaries-url.bib'. diff --git a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-xr.bib b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-xr.bib index 7aacf223c3d..e98957c198d 100644 --- a/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-xr.bib +++ b/Master/texmf-dist/bibtex/bib/glossaries-extra/example-glossaries-xr.bib @@ -1,43 +1,3 @@ -%% -%% This is file `example-glossaries-xr.bib', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% glossaries-extra.dtx (with options: `example-glossaries-xr.bib,package') -%% -%% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3 -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3 or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This work has the LPPL maintenance status `maintained'. -%% -%% The Current Maintainer of this work is Nicola Talbot. -%% -%% This work consists of the files glossaries-extra.dtx and glossaries-extra.ins and the derived files glossaries-extra.sty, glossaries-extra-stylemods.sty, example-glossaries-xr.tex, example-glossaries-acronym-desc.bib, example-glossaries-acronym.bib, example-glossaries-acronyms-lang.bib, example-glossaries-brief.bib, example-glossaries-childnoname.bib, example-glossaries-cite.bib, example-glossaries-images.bib, example-glossaries-long.bib, example-glossaries-multipar.bib, example-glossaries-parent.bib, example-glossaries-symbols.bib, example-glossaries-url.bib, example-glossaries-xr.bib. -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} @entry{lorem, name = {lorem}, description = {ipsum} @@ -337,6 +297,3 @@ seealso = {diam} } -\endinput -%% -%% End of file `example-glossaries-xr.bib'. diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES index 363f5a52ab4..8847364c4f2 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES @@ -1,3 +1,10 @@ +1.20 (2017-09-11): + + * New 'printgloss' key targetnameprefix + + * Corrected .ins to remove default preamble and postamble + from .bib files + 1.19 (2017-09-08): * New command: \GlsXtrSetDefaultNumberFormat diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/README b/Master/texmf-dist/doc/latex/glossaries-extra/README index d80be737d10..695a88fd053 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.19 +LaTeX Package : glossaries-extra v1.20 -Last Modified : 2017-09-08 +Last Modified : 2017-09-11 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 b300a1a6164..d49590fb5cf 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 527e2998ae1..46f0c965061 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 @@ -176,7 +176,7 @@ div.abstract {width:100%;} .equation-star td{text-align:center; } table.equation-star { width:100%; } table.equation { width:100%; } -table.align, table.alignat, table.xalignat, table.xxalignat, table.flalign {width:100%; margin-left:5%; white-space: nowrap;} +table.align, table.alignat, table.xalignat, table.xxalignat, table.flalign {width:95%; margin-left:5%; white-space: nowrap;} table.align-star, table.alignat-star, table.xalignat-star, table.flalign-star {margin-left:auto; margin-right:auto; white-space: nowrap;} td.align-label { width:5%; text-align:center; } td.align-odd { text-align:right; padding-right:0.3em;} @@ -217,7 +217,7 @@ a span.HoLogo-TeX span.HoLogo-e{text-decoration:none;} >

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

@@ -241,7 +241,7 @@ href="http://www.dickimaw-books.com/" class="url" >http://www.dickimaw-books.com/

2017-09-08

+class="cmr-12">2017-09-11

@@ -1573,25 +1573,38 @@ which will only define the glossary if it doesn’t already exist. This also version that doesn’t automatically switch off hyperlinks.

The individual glossary displaying commands \printglossary, -, \printnoidxglossary and \printunsrtglossary have an extra key +and \printunsrtglossary have two extra keys: +

+ +

The \newglossaryentry command has three new keys:

-

The test file

The test file example-glossaries-xr.tex contains dummy entries with a mixture of + + + see, , alias and and seealso keys for use with minimal working examples. There are also + id="dx1-5016"> keys for use with minimal working examples. There are also example-glossaries-*.bib files that correspond to each example-glossaries-*.tex file for testing bib2gls. -

The . +

The \longnewglossaryentry command now has a starred version (as from v1.12) that doesn’t automatically insert @@ -1643,11 +1659,11 @@ that doesn’t automatically insert

\leavevmode\unskip\nopostdesc
-

at the end of the description field. -


at the end of the description field. +


\longnewglossaryentry  \longnewglossaryentry*{label}{} class="cmtt-10">{description}

-

+

The descriptionplural key is left unset unless explicitly set in ⟨ key is left unset unless explicitly set in ⟨options⟩. -

The unstarred version no longer hard-codes the above code (which removes +

The unstarred version no longer hard-codes the above code (which removes trailing space and suppresses the post-description hook) but instead uses: -



\glsxtrpostlongdescription  \glsxtrpostlongdescription

-

+

This can be redefined to allow the post-description hook to work but retain the \unskip part if required. For example: @@ -1680,56 +1696,56 @@ class="cmtt-10">\unskip part if required. For example:

\renewcommand*{\glsxtrpostlongdescription}{\leavevmode\unskip}
-

This will discarded unwanted trailing space at the end of the description but won’t +

This will discarded unwanted trailing space at the end of the description but won’t suppress the post-description hook. -

The unstarred version also alters the base

The unstarred version also alters the base glossaries package’s treatment of the + id="dx1-5022"> package’s treatment of the descriptionplural key. Since a plural description doesn’t make much sense for + id="dx1-5023"> key. Since a plural description doesn’t make much sense for multi-paragraph descriptions, the default behaviour with glossaries-extra’s + id="dx1-5024">’s \longnewglossaryentry is to simply leave the plural description unset unless explicitly set using the descriptionplural key. The key. The glossaries.sty version of this command sets the description’s plural form to the same as the singular.2.1 -

Note that this modified unstarred version doesn’t append +

Note that this modified unstarred version doesn’t append \glsxtrpostlongdescription to the description’s plural form. -

The

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

The

The \makeglossaries command now has an optional argument. -



\makeglossaries  \makeglossaries[list]

-

+

If ⟨list⟩ is empty, \makeglossaries behaves as per its original definition in the @@ -1737,29 +1753,29 @@ class="cmtt-10">\makeglossaries behaves as per its original definition in class="cmss-10">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

It should then be possible to use \printglossary for those glossaries listed in ⟨list⟩ and \printnoidxglossary for the other glossaries. (See the accompanying file sample-mixedsort.tex for an example.) -

If you use the optional argument ⟨

If you use the optional argument ⟨list⟩, you can’t define entries in the document (even with the docdef option).
-

-

You will need at least version 2.20 of option).

+

+

You will need at least version 2.20 of makeglossaries or at least version 1.3 of the Lua alternative makeglossaries-lite.lua (both distributed with (both distributed with glossaries v4.27) to allow for this use of \makeglossaries[list]. Alternatively, use the automake option. + id="dx1-5041"> option.

-

Top

2.1 Entry Indexing

-

The

The glossaries-extra package provides extra keys for commands like \gls and wrgloss=after for specific instances. Note that this opti settings (such as noindex). -

The default value is set up using -


The default value is set up using +


\glsxtrinitwrgloss  \glsxtrinitwrgloss

-

+

which is defined as: @@ -1856,15 +1872,15 @@ class="cmtt-10">\glsxtrinitwrgloss


 
 }%  
}
-

This sets the conditional -


This sets the conditional +


\ifglsxtrinitwrglossbefore  \ifglsxtrinitwrgloss

-

+

which is used to determine where to perform the indexing. -

This means you can set the

This means you can set the wrgloss attribute to \GlsXtrSetDefaultGlsOpts\glsxtrinitwrgloss.)

-

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{label}

-

+

where ⟨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 this hook to determine which entries haven’t been indexed.) -

As from version 1.14, there are two new keys for

As from version 1.14, there are two new keys for \glsadd: thevalue and thevalue keys is intended primarily for adding locations in supplementary material that can’t be obtained from a counter. -

The principle key

The principle key thevalue is for the location value. The other key theHvalue

If you use

If you use thevalue, you must make sure that you use an indexing application that will accept the given value.
-

-

For example,

+

For example, makeindex will only accept locations in the form [⟨num⟩⟨ \glsadd[thevalue={Supplementary Material}]{sample}

-

This location value will be accepted by

This location value will be accepted by bib2glsformat key to prevent a hyperlink if one can’t naturally be formed from the prefix, counter and location value. -

For example, suppose the file

For example, suppose the file suppl.tex contains: @@ -1987,7 +2003,7 @@ class="cmtt-10">suppl.tex contains:  
\gls{sample}.  
\end{document}

-

This has an entry on page S.2. Suppose another document wants to include this +

This has an entry on page S.2. Suppose another document wants to include this location in the glossary. Then this can be done by setting thevalue to \glsadd[thevalue={S.2}]{sample}  
\end{document}

-

This location value will be accepted by

This location value will be accepted by makeindex as it’s in the form ⟨num⟩⟨sep⟩⟨num⟩. -

If you want hyperlinks, things are more complicated. First you need to set the +

If you want hyperlinks, things are more complicated. First you need to set the externallocationexternallocation\newglossaryentry{sample}{category=supplemental,  
 name={sample},description={an example}}

-

Next you need to add

Next you need to add glsxtrsupphypernumber as the format: @@ -2037,7 +2053,7 @@ class="cmtt-10">glsxtrsupphypernumber as the format:

\glsadd[thevalue={S.2},format=glsxtrsupphypernumber]{sample}
-

Both documents will need to use the

Both documents will need to use the hyperref package. Remember that the counter used for the location also needs to match. If sample-suppl-main-hyp.tex for an example that uses hyperref. -

The hyperlink for the supplementary location may or

The hyperlink for the supplementary location may or may not take you to the relevant place in the external PDF file depending on your PDF viewer. Some may not support external links, and some may take you to the first page or last visited page.
-

-

For example, if both

+

For example, if both sample-suppl-hyp.pdf and sample-suppl-main-hyp.pdf are in the same directory, then viewing sample-suppl-main-hyp.pdf in Evince will take you to the correct location in the linked document (when you click on the S.2 external link), but Okular will take you to the top of the first page of the linked document. -

+

-

Top

2.2 Cross-References (“see” and “see also”)

-

The value of the

The value of the see key is now saved as a field. This isn’t the case with glossaries, @@ -2100,20 +2116,20 @@ class="cmss-10">document environment on the next run. -

This modification allows

This modification allows glossaries-extra to provide -



\glsxtraddallcrossrefs  \glsxtraddallcrossrefs

-

+

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

As a by-product of this enhancement, the

As a by-product of this enhancement, the see key will now work for entries defined in the see 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{label}

-

+

This internally uses -



\glsxtruseseeformat  tag}{xr list}

-

+

where ⟨tag⟩ and ⟨xr list⟩ are obtained from the value of the entry’s see field hasn’t been set for the entry given by ⟨label⟩. -

Suppose you want to suppress the

Suppose you want to suppress the number list using nonumberlist. This @@ -2198,7 +2214,7 @@ class="cmss-10">see 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 example: @@ -2213,11 +2229,11 @@ example:  
 {}%  
}

-

Now the cross-references can appear even though the

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

As from v1.16, there’s a separate

As from v1.16, there’s a separate seealso key. Unlike see\seealsoname or \glsxtruseseealsoformat, described below). -

You can display the formatted list of cross-references stored in the

You can display the formatted list of cross-references stored in the seealso key using: -



\glsxtruseseealso  \glsxtruseseealso{label}

-

+

This works in much the same way as \glsxtrusesee but it internally uses -



\glsxtruseseeformat  \glsxtruseseealsoformat{xr list}

-

+

For example: @@ -2274,20 +2290,20 @@ For example:  
 {}%  
}

-

-

The actual unformatted comma-separated list ⟨

+

The actual unformatted comma-separated list ⟨xr-list⟩ stored in the seealso field can be accessed with: -



\glsxtrseealsolabels  \glsxtrseealsolabels{label}

-

+

This will just expand to the ⟨xr-labels⟩ provided in the value of the seealso[⟨tag], so it can’t be automatically treated as a simple comma-separated list. -

The base

The base glossaries package provides \glsseelist, which requires a @@ -2313,20 +2329,20 @@ class="cmti-10">label⟩} as the argument. For convenience, glossaries-extra provides -



\glsxtrseelist  \glsxtrseelist{xr list}

-

+

which fully expands its argument and passes it to \glsseelist. -

The

The seealso key implements the automatic indexing using -



\glsxtrindexseealso  label}{xr list}

-

+

which just does

glossaries v4.30+, in which case a distinct seealso cross-reference class is used instead. -

+

-

Top

2.3 Entry Display Style Modifications

-

Recall from the

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 @@ -2372,7 +2388,7 @@ 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 format. -

The default entry format (

The default entry format (\glsentryfmt) used in the §3.2 Abbreviation Styles). -

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,

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



\glsxtrregularfont  \glsxtrregularfont{text}

-

+

This just does its argument ⟨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 @@ -2479,7 +2495,7 @@ class="cmtt-10">\glsxtrregularfont. This is more precise than changing \glstextformat which will be applied to all linking commands for all entries. -

For example: +

For example: @@ -2487,7 +2503,7 @@ class="cmtt-10">\glstextformat \renewcommand*{\glsxtrregularfont}[1]{\textsf{#1}}

-

You can access the label through

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

-

or query the category attribute: +

or query the category attribute: @@ -2508,7 +2524,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: @@ -2522,7 +2538,7 @@ category:  
  {#1}%  
}

-

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

(Remember the category and attribute settings will only queried here for regular @@ -2532,7 +2548,7 @@ class="cmss-10">acronym\glsxtrregularfont will no longer apply.) -

The

The \glspostlinkhook provided by the glossaries package to insert information after the link-text produced by commands like \gls and \glstext is redefined to -



\glsxtrpostlinkhook  \glsxtrpostlinkhook

-

+

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



\glsxtrpostlink  \glsxtrpostlink

-

+

if a full stop hasn’t be discarded and -



\glsxtrpostlinkendsentence  \glsxtrpostlinkendsentence

-

+

if a full stop has been discarded. -

Avoid the use of

Avoid the use of \gls-like and \glstext-like commands within the post-link hook as they will cause interference. Consider using commands like @@ -2578,8 +2594,8 @@ href="#sec:nested">§2.6 Nested Links) instead.
-

-

By default

+

By default \glsxtrpostlink just does \glsxtrpostlinkcategorygeneral category, \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

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

-

+

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  \glsxtrpostlinkAddDescOnFirstUse  
}

-

-


+


\glsxtrpostlinkAddSymbolOnFirstUse  \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 within the post-link-text hook as by this point the first use flag will have been unset. Instead you can use -



\glsxtrifwasfirstuse  true}{false}

-

+

This will do ⟨true⟩ if the last used entry was the first use for that entry, otherwise it @@ -2677,7 +2693,7 @@ locally set by commands like \gls, so don’t rely on it outside of the post-link-text hook. -

Note that commands like

Note that commands like \glsfirst and \glsxtrfull\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 general  \glsxtrifwasfirstuse{\footnote{\glsentrydesc{\glslabel}}}{}%  
}

-

-

The

+

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

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



\GlsXtrSetDefaultGlsOpts  \GlsXtrSetDefaultGlsOpts{options}

-

+

For example, if you mostly don’t want to index entries then you can do: @@ -2745,7 +2761,7 @@ For example, if you mostly don’t want to index entries then you can do:

\GlsXtrSetDefaultGlsOpts{noindex}
-

and then use, for example,

and then use, for example, \gls[noindex=false]{sample} when you actually want the location added to the \glslink and \gls. -

Note that if you don’t want

Note that if you don’t want any indexing, just omit \makeglossaries and wrgloss\glsxtrinitwrgloss instead. -

\GlsXtrSetDefaultGlsOpts doesn’t affect \glsadd.
-

-

If you want to change the default value of

+

If you want to change the default value of format, you can instead use: -



\GlsXtrSetDefaultNumberFormat{format}

-

+

This has the advantage of also working for \glsadd. For example, if you want all locations in the back matter to appear in italic (unless explicitly @@ -2789,8 +2805,8 @@ overridden): \backmatter  
\GlsXtrSetDefaultNumberFormat{hyperit}

-

-

Commands like

+

Commands like \gls have star (*) and plus (hyper=false and hyper=true. The glossaries-extra package provides a way to add a third modifier, if required, using -



\GlsXtrSetAltModifier  }{options}

-

+

where ⟨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 UTF-8 character, unless you are using XƎLATEX or LuaLATEX). -

When choosing the character ⟨

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

-

Example: +

+

Example: @@ -2829,7 +2845,7 @@ class="cmti-10">char⟩ take care of any changes in category code.

\GlsXtrSetAltModifier{!}{noindex}
-

This means that

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 @@ -2840,17 +2856,17 @@ not possible to mix modifiers. For example, if you want to do

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

you can use

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

Location lists displayed with \printnoidxglossary internally use -



\glsnoidxdisplayloc  } class="cmtt-10">{⟨location}

-

+

This command is provided by glossaries, but is modified by glossaries-extra to check @@ -2874,8 +2890,8 @@ class="cmtt-10">( and ) which are discarded to obtain the actual control sequence name that forms the location formatting command. -

If the range identifiers aren’t present, this just uses -


If the range identifiers aren’t present, this just uses +


\glsxtrdisplaysingleloc  }{location}

-

+

otherwise it uses -



\glsxtrdisplaystartloc  }{location}

-

+

for the start of a range (where the identifier has been stripped from ⟨format⟩) or -



\glsxtrdisplayendloc  }{location}

-

+

for the end of a range (where the identifier has been stripped from ⟨format⟩). -

By default the start range command saves the format in -


By default the start range command saves the format in +


\glsxtrlocrangefmt  \glsxtrlocrangefmt

-

+

and does
\glsxtrdisplaysingleloc{}
(If the format is empty, it will be replaced with glsnumberformat.) -

The end command checks that the format matches the start of the range, +

The end command checks that the format matches the start of the range, does -



\glsxtrdisplayendlochook  }{location}

-

+

(which does nothing by default), followed by
\glsxtrdisplaysingleloc{\glsxtrlocrangefmt to empty. -

This means that the list +

This means that the list @@ -2967,7 +2983,7 @@ class="cmtt-10">\glsxtrlocrangefmt to empty.  
\glsnoidxdisplayloc{}{page}{textbf}{1},  
\glsnoidxdisplayloc{}{page}{)textbf}{1}.

-

doesn’t display any differently from +

doesn’t display any differently from @@ -2977,14 +2993,14 @@ class="cmtt-10">\glsxtrlocrangefmt to empty.  
\glsnoidxdisplayloc{}{page}{textbf}{1},  
\glsnoidxdisplayloc{}{page}{textbf}{1}.

-

but it does make it easier to define your own custom list handler that can +

but it does make it easier to define your own custom list handler that can accommodate the ranges. -

+

-

Top

2.4 Entry Counting Modifications

-

The

The \glsenableentrycount command is modified to allow for the §5 Categories). -

For example, instead of just doing: +

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

\glsenableentrycount
-

you now need to do: +

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

-

This will enable the entry counting for entries in the

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 Entry Counting. -

+

-

Top

2.5 Plurals

-

Some languages, such as English, have a general rule that plurals are formed from +

Some languages, such as English, have a general rule that plurals are formed from the singular with a suffix appended. This isn’t an absolute rule. There are plenty of exceptions (for example, geese, children, churches, elves, fairies, sheep). The plural

To make life easier for languages where the majority of plurals can simply be +

To make life easier for languages where the majority of plurals can simply be formed by appending a suffix to the singular, the glossaries package sets lets the plural supplied as well, and you only need to use it for the exceptions. -

For languages that don’t have this general rule, the

For languages that don’t have this general rule, the plural field will always need to be supplied, where needed. -

There are other plural fields, such as

There are other plural fields, such as firstplural, longpluralshortplural

If these fields are omitted, the

If these fields are omitted, the glossaries package follows these rules:

    @@ -3133,7 +3149,7 @@ class="cmtt-10">\acrpluralsuffixshort field.
-

This

This last case is changed with glossaries-extra. With this extension package, the \abbrvpluralsuffix is redefined. In most cases its redefined to use -



\glsxtrabbrvpluralsuffix  \glsxtrabbrvpluralsuffix

-

+

which defaults to just \glspluralsuffix. Some of the abbreviation styles have their own command for the plural suffix, such as \abbrvpluralsuffix, which changes with the style. Redefining \acrpluralsuffix will have no affect, since it’s not used by the new abbreviation mechanism. -

If you require a mixture (for example, in a multilingual document), there are two +

If you require a mixture (for example, in a multilingual document), there are two attributes that affect the short plural suffix formation. The first is aposplural '\abbrvpluralsuffix

-

That is, an apostrophe followed by

That is, an apostrophe followed by \abbrvpluralsuffix is appended. The second attribute is shortpluralshort. -

+

-

Top

2.6 Nested Links

-

Complications arise when you use

Complications arise when you use \gls in the value of the name

Things can go wrong if we try the following with the

Things can go wrong if we try the following with the glossaries package: @@ -3219,8 +3235,8 @@ class="cmss-10">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. first use if the long form is displayed before the shor
    \gls{\uppercase ssi} enabled \gls{html}
    -

    which just doesn’t work. Grouping the

    which just doesn’t work. Grouping the \gls{ssi} doesn’t work either as this will effectively try to do @@ -3249,7 +3265,7 @@ class="cmtt-10">\gls{ssi} doesn’t work either as this

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

    This will upper case the label

    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 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

    Now let’s suppose the html entry is used before the shtml but the ssi entry is @@ -3312,17 +3328,17 @@ class="cmtt-10">shtml entry, for example: 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) enabled HTML (SHTML)”, which looks a bit strange. -

Now let’s suppose the

Now let’s suppose the shtml entry is used before (or without) the other two entries: @@ -3332,17 +3348,17 @@ class="cmtt-10">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) enabled hypertext markup language (HTML) (SHTML)”, which is even more strange. -

This is all aggravated by setting the style using the

This is all aggravated by setting the style using the glossaries package’s \setacronymstyle. For example: @@ -3353,7 +3369,7 @@ class="cmtt-10">\setacronymstyle. For example:

\setacronymstyle{long-short}
-

as this references the label through the use of

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 @@ -3365,7 +3381,7 @@ class="cmtt-10">\glslabel has been changed to html by \gls{html}. -

Another oddity occurs if you reset the

Another oddity occurs if you reset the html entry between uses of the shtml entry. For example: @@ -3376,10 +3392,10 @@ class="cmtt-10">shtml

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

The next use of

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 for some styles, but if you use one of the “sm” styles (that use hyperref -

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 or  [description={\acrshort{ssi} enabled \acrshort{html}}]  
 {shtml}{SHTML}{SSI enabled HTML}

-

with

with glossaries or: @@ -3440,7 +3456,7 @@ class="cmss-10">glossaries or:  
 [description={\glsxtrshort{ssi} enabled \glsxtrshort{html}}]  
 {shtml}{SHTML}{SSI enabled HTML}

-

with

with glossaries-extra. This fixes all the above listed problems (as long as you don’t use \glsdescfirst 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: @@ -3465,10 +3481,10 @@ class="cmtt-10">\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

However if you’re really determined to use \gls in a field that may be included within some \gls{ssi} enabled \gls{html}

-

is treated as +

is treated as @@ -3501,7 +3517,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 long-noshort-desc). -

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

Additionally, any instance of the long form commands, such as \glsxtrlong or shtml entry had instead been defined as:

\newacronym{shtml}{SHTML}{\acrshort{ssi} enabled \acrshort{html}}
-

then (using the

then (using the long-short style) the 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: @@ -3578,7 +3594,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: @@ -3589,7 +3605,7 @@ href="#glo:firstuse">first use will be like: {\glsabbrvfont{\glsentryshort{ssi}}} enabled  
{\glsabbrvfont{\glsentryshort{html}}} (SHTML)

-

Note that the first optional argument of

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 @@ -3600,8 +3616,8 @@ class="cmtt-10">\glsxtrshort. Note that \acrshort doesn’t set the abbreviation style. -

Alternatively you can use: -


Alternatively you can use: +


\glsxtrp  field}{label}

-

+

where ⟨field⟩ is the field label and corresponds to a command in the form \gls\glstext) or in the form \glsxtrfield⟩ (e.g. \glsxtrshort). -

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


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


\glsps  \glsps{label}

-

+

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



\glspt  \glspt{label}

-

+

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

The

The \glsxtrp command behaves much like the \glsfmtfield⟩ commands described @@ -3664,14 +3680,14 @@ class="cmss-10">noindex to true. If you want to change this, you can use -



\glsxtrsetpopts  \glsxtrsetpopts{options}

-

+

For example: @@ -3680,17 +3696,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

-

+

which by default just does @@ -3699,7 +3715,7 @@ which by default just does

\glsxtrsetpopts{noindex}
-

You can redefine this if you want to adjust the setting when

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

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

-

For example, +

+

For example, @@ -3718,7 +3734,7 @@ glossary. For example:

\glsxtrp{short}{ssi}
-

is equivalent to +

is equivalent to @@ -3728,7 +3744,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 @@ -3738,8 +3754,8 @@ glossary. For example:  
 \glsxtrshort[noindex]{ssi}[]%  
}

-

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

If

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

If \glsxtrp{short}{ssi} occurs in a sectioning mark, it’s equivalent to @@ -3749,19 +3765,19 @@ to

{\glsxtrheadshort{ssi}}
-

(which recognises the

(which recognises the headuc attribute.) -

If

If hyperref has been loaded, then the bookmark will use \glsentryfield⟩ (\glsentryshort{ssi} in the above example). -

There are similar commands -


There are similar commands +


\Glsxtrp  field}{label}

-

+

for first letter upper case and -



\Glsxtrp  field}{label}

-

+

for all upper case. -

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

If you use any of the case-changing commands, such as \Gls or \Glstext\gls\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 as \GLS. -

If you

If you really need nested commands, the safest method is @@ -3813,8 +3829,8 @@ class="cmti-10">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: @@ -3844,16 +3860,16 @@ class="cmti-10">really need nested commands, the safest method is  
\printglossaries  
\end{document}

-

-

+

+

-

Top

2.7 Acronym Style Modifications

-

The

The glossaries-extra package provides a new way of dealing with abbreviations and redefines \newacronymglossaries-extra is do just add

-

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 @@ -3892,7 +3908,7 @@ class="cmss-10">glossaries  
\printglossaries  
\end{document}

-

can be easily adapted to use

can be easily adapted to use glossaries-extra: @@ -3909,7 +3925,7 @@ class="cmss-10">glossaries-extra:  
\printglossaries  
\end{document}

-

Table 

Table 2.1 lists the nearest equivalent glossaries-extra abbreviation styles for the predefined acronym styles provided by


@@ -3948,34 +3964,34 @@ cellspacing="0" cellpadding="0" id="TBL-2-1" />

Old Style Name

New Style Name

long-sc-short

long-short-sc

long-sm-short

long-short-sm

long-sp-short

long-short
#1}}

short-long

short-long

sc-short-long

short-sc-long

sm-short-long

short-sm-long

long-short-desc

long-short-desc

long-sc-short-desc

long-short-sc-desc

long-sm-short-desc

long-short-sm-desc

long-sp-short-desc

long-short-desc
#1}}

short-long-desc

short-long-desc

sc-short-long-desc

short-sc-long-desc

sm-short-long-desc

short-sm-long-desc

dua

long-noshort

dua-desc

long-noshort-desc

footnote

short-footnote

footnote-sc

short-sc-footnote

footnote-sm

short-sm-footnote

footnote-desc

short-footnote-desc

footnote-sc-desc

short-sc-footnote-desc

footnote-sm-desc

short-sm-footnote-desc

@@ -4168,7 +4184,7 @@ class="cmss-10">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 @@ -4177,15 +4193,15 @@ class="cmss-10">glossaries-extra. However, if you really want to restore the generic acronym function provided by glossaries you can use -



\RestoreAcronyms  \RestoreAcronyms

-

+

(before any use of \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 @@ -4195,7 +4211,7 @@ class="cmss-10">typeglossaries acronym mechanism doesn’t work well with the newer glossaries-extra commands. -

If you use

-

-

In general, there’s rarely any need for

+

In general, there’s rarely any need for \RestoreAcronyms. If you have a document that uses \newacronymstyle§3.5 Defining New Abbreviation Styles for further details.) -



\glsacspace  \glsacspace{label}

-

+

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



\glsacspacemax  \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

Any of the new abbreviation styles that use \glsxtrfullsep (such as \glsacspace with

-

-

The

+

The first use acronym font command -



\firstacronymfont{text}

-

+

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

The subsequent use acronym font command -


The subsequent use acronym font command +


\acronymfont{text}

-

+

is redefined to use the subsequent use abbreviation font command \glsabbrvfont. This will be reset if you use \RestoreAcronyms.

-

Top

2.8 Glossary Style Modifications

-

The default value of

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 document. -

The

The glossaries package tries to determine the group title from its label by first checking if \glsxtr@grouptitle@label⟩ which shouldn’t clash with another package. You can set the group title using -



\glsxtrsetgrouptitle  label}{title}

-

+

For example: @@ -4336,13 +4352,13 @@ For example:

\glsxtrsetgrouptitle{A}{A (a)}
-

-

+

+

-

Top

2.8.1 Style Hooks

-

The commands

The commands \glossentryname and \glossentrydesc§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

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



\glsxtrpostnamehook  \glsxtrpostnamehook{label}

-

+

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



\glsxtrdoautoindexname{}{indexname}

-

+

See §7 Auto-Indexing for further details. -

As from version 1.04, the post-name hook

As from version 1.04, the post-name hook \glsxtrpostnamehook will also use \glsxtrpostname (\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

-

+

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

This new command will do

This new command will do \glsxtrpostdesccategory⟩ if it exists, where ⟨general\glsxtrpostdescacronym for entries with the category set to acronym. -

Since both

Since both \glossentry and \subglossentry set -



\glscurrententrylabel  \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 general category, then you could @@ -4465,10 +4481,10 @@ 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

This feature can’t be used for glossary styles that ignore \glspostdescription or if you redefine \glspostdescription without including glossaries-extra-stylemods Package

-

+

+

-

Top

2.8.2 Number List

-

The

The number list is now placed inside the argument of -



\GlsXtrFormatLocationList  \GlsXtrFormatLocationList{number list}

-

+

This is internally used by \glossaryentrynumbers. The nonumberlist\glossaryentrynumbers so that it doesn’t display th id="dx1-15004">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 nonumberlist option instead of redefining \glossaryentrynumbers to do nothing.
-

-

If you want to, for example, change the font for the entire

+

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

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  }{pages}

-

+

where ⟨page⟩ is the text to display if the number list only contains a single location and @@ -4556,28 +4572,28 @@ class="cmti-10">pages⟩ is the text to display otherwise. For examp

\GlsXtrEnablePreLocationTag{Page: }{Pages: }
-

An extra run is required when using this command. -

Use

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

+

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

Note that

Note that bib2gls can be instructed to insert a prefix at the start of non-empty location lists, which can be used as an alternative to \GlsXtrEnablePreLocationTag. -

+

-

Top

2.8.3 The glossaries-extra-stylemods Package

-

As from v1.02,

As from v1.02, glossaries-extra now includes the package glossaries-extra-stylemods that @@ -4594,7 +4610,7 @@ class="cmss-10">glossaries-extra. For example:  
\usepackage{glossary-longragged}  
\usepackage{glossaries-extra-stylemods}

-

Alternatively you can load

Alternatively you can load glossary-name.sty at the same time by passing ⟨glossaries-extra-stylemods\usepackage[longragged]{glossaries-extra-stylemods}

-

Another option is to use the

Another option is to use the stylemods key when you load long3col \usepackage[style=long3col,stylemods]{glossaries-extra}

-

Or the value of

Or the value of stylemods may be a comma-separated list of the style package @@ -4639,7 +4655,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: @@ -4647,8 +4663,8 @@ identifiers. For example:

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

-

Note that the

+

Note that the inline style is dealt with slightly differently. The original definition provided by the inlinenopostdot option, but the post-description category hook can still be used. -

As from version 1.05, the

As from version 1.05, the glossaries-extra-stylemods package provides some additional commands for use with the alttreenotree option has been used when loading glossaries. -



\eglssetwidest  level]{name}

-

+

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



\xglssetwidest  level]{name}

-

+

The widest entry value can later be retrieved using -



\glsgetwidestname  \glsgetwidestname

-

+

for the top-level entries and -



\glsgetwidestsubname  \glsgetwidestsubname{level}

-

+

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

The command

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



\glsFindWidestTopLevelName  \glsFindWidestTopLevelName[glossary list]

-

+

Similar commands are also provided: -



\glsFindWidestUsedTopLevelName  glossary list]

-

+

This has an additional check that the entry has been used. Naturally this is only useful if the glossaries that use the alttree



\glsFindWidestUsedAnyName  \glsFindWidestUsedAnyName[glossary list]

-

+

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



\glsFindWidestAnyName  \glsFindWidestAnyName[glossary list]

-

+

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



\glsFindWidestUsedLevelTwo  \glsFindWidestUsedLevelTwo[glossary list]

-

+

This is like \glsFindWidestUsedTopLevelName but also sets the first two sub-levels as well. Any entry that has a great-grandparent is ignored. -



\glsFindWidestLevelTwo  \glsFindWidestLevelTwo[glossary list]

-

+

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



\glsFindWidestUsedAnyNameSymbol  glossary list]{register}

-

+

This is like \glsFindWidestUsedAnyName but also measures the symbol. The length of the widest symbol is stored in ⟨register⟩. -



\glsFindWidestAnyNameSymbol  list]{register}

-

+

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



\glsFindWidestUsedAnyNameSymbolLocation  symbol register}{location register}

-

+

This is like \glsFindWidestUsedAnyNameSymbol but also measures the symbol register⟩ and the length of the widest number list is stored in ⟨location register⟩. -



\glsFindWidestAnyNameSymbolLocation  symbol register}{location register}

-

+

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



\glsFindWidestUsedAnyNameLocation  }

-

+

This is like \glsFindWidestUsedAnyNameSymbolLocation but doesn’t measure the symbol. The length of the widest number list is stored in ⟨register⟩. -



\glsFindWidestAnyNameLocation  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  label}{number list}

-

+

for top-level entries and -



\glsxtralttreeSubSymbolDescLocation  label}{number list}

-

+

for sub-entries. -

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

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



\glsxtralttreeInit  \glsxtralttreeInit

-

-

The paragraph indent for subsequent paragraphs in multi-paragraph descriptions +

+

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



\glsxtrAltTreeIndent  \glsxtrAltTreeIndent

-

-

For additional commands that are available with the

+

For additional commands that are available with the alttree style, see the documented code (sample-alttree-marginpar.tex.

-

-

+

Top

3. Abbreviations

-

Abbreviations include acronyms (words formed from initial letters, such as +

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 @@ -4996,10 +5012,10 @@ to be 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

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



\newabbreviation  }{long}

-

-

This sets the

+

This sets the category key to abbreviation by default, but that value may be @@ -5037,7 +5053,7 @@ href="#sec:categories">§5 Categories for further details. -

See

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

Make sure that you set the category attributes before defining new abbreviations +

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

-

The

+

The \newacronym command provided by the glossaries package is redefined by @@ -5065,7 +5081,7 @@ class="cmtt-10">acronym (see also href="#sec:acronymmods">§2.7 Acronym Style Modifications) so -



\newacronym  short}{long}

-

+

is now equivalent @@ -5104,7 +5120,7 @@ class="cmtt-10">}
-

The

The \newabbreviation command is superficially similar to the glossaries package’s abbreviationglossaries package, although they may produce similar results.) -

The way the abbreviations are displayed by commands like

The way the abbreviations are displayed by commands like \gls varies according to the abbreviation style. The styles are set according to the entry’s category so, unlike the base glossaries package, you can have different abbreviation styles within the same glossary. -

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 short-footnote, the display and inline full forms are different. -

These formatting commands aren’t stored in the

These formatting commands aren’t stored in the short, shortplural\glsxtrlong\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  } class="cmtt-10">{⟨cs}

-

+

before you define your abbreviations. -

This command (robustly) defines ⟨

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 @@ -5199,21 +5215,21 @@ href="#catattr.tagging">tagging attribute set to “true”. For those cases it will use -



\glsxtrtagfont  \glsxtrtagfont{text}

-

+

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

The control sequence ⟨

The control sequence ⟨cs⟩ can’t already be defined when used with the unstarred version of \GlsXtrEnableInitialTagging for safety reasons. The starred @@ -5225,7 +5241,7 @@ commands, ensure that you don’t redefine something important. In fact, jus forget the existence of the starred version and let’s pretend I didn’t mention it. -

The first argument of

The first argument of \GlsXtrEnableInitialTagging is a comma-separated list of category names. The §5 Categories) but this must be done before the glossary is displayed. -

The accompanying sample file

The accompanying sample file sample-mixtures.tex uses initial tagging for both the acronymabbreviation \GlsXtrEnableInitialTagging{acronym,abbreviation}{\itag}

-

This defines the command

This defines the command \itag which can be used in the definitions. For example: @@ -5269,18 +5285,18 @@ 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 tagging attribute set. -

+

-

Top

3.2 Abbreviation Styles

-

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


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


\setabbreviationstyle  ]{style-name}

-

+

where ⟨style-name⟩ is the name of the style and ⟨category⟩ is the category label @@ -5312,11 +5328,11 @@ class="cmss-10">regular attribute to true. -

If you want to apply different styles to groups of abbreviations, assign a +

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

+

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

@@ -5337,7 +5353,7 @@ href="#sec:acronymmods">§2.7 Acronym Style Modifications). However the original acronym interface is incompatible with all the commands described here. -

Abbreviations can be used with the standard

Abbreviations can be used with the standard glossaries commands, such as \gls, @@ -5347,7 +5363,7 @@ class="cmtt-10">\acrshort\acronymfont). The short form can be produced with: -



\glsxtrshort  label}[insert]

-

+

(Use this instead of \acrshort.) -

The long form can be produced with -


The long form can be produced with +


\glsxtrlong  label}[insert]

-

+

(Use this instead of \acrlong.) -

The

The inline full form can be produced with -



\glsxtrfull  label}[insert]

-

+

(This this instead of \acrfull.) -

In general, it’s best not to use commands like

In general, it’s best not to use commands like \glsfirst for abbreviations, especially if you use the ⟨insert⟩ optional argument. Use either \gls (possibly with a reset) or \glsxtrfull.
-

-

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 short-nolongfirst 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 Entries in Sectioning Titles, Headers, Captions and Contents instead.
-

-

The arguments ⟨

+

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: -


First letter upper case short form: +


\Glsxtrshort  label}[insert]

-

-

First letter upper case long form: -


+

First letter upper case long form: +


\Glsxtrlong  label}[insert]

-

-

First letter upper case inline full form: -


+

First letter upper case inline full form: +


\Glsxtrfull  label}[insert]

-

-

All upper case short form: +

+

All upper case short form: -



\Glsxtrshort  label}[insert]

-

-

All upper case long form: -


+

All upper case long form: +


\Glsxtrlong  label}[insert]

-

-

All upper case inline full form: -


+

All upper case inline full form: +


\GLSxtrfull  label}[insert]

-

-

Plural forms are also available. -

Short form plurals: -


+

Plural forms are also available. +

Short form plurals: +


\glsxtrshortpl  label}[insert]

-

-


+


\Glsxtrshortpl  label}[insert]

-

-


+


\GLSxtrshortpl  label}[insert]

-

-

Long form plurals: -


+

Long form plurals: +


\glsxtrlongpl  label}[insert]

-

-


+


\Glsxtrlongpl  label}[insert]

-

-


+


\GLSxtrlongpl  label}[insert]

-

-

Full form plurals: -


+

Full form plurals: +


\glsxtrfullpl  label}[insert]

-

-


+


\Glsxtrfullpl  label}[insert]

-

-


+


\GLSxtrfullpl  label}[insert]

-

-

Be careful about using

+

Be careful about using \glsentryfull, \Glsentryfull, \glsentryfullpl and @@ -5636,13 +5652,13 @@ 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 shortcutstable 3.1. -


@@ -5978,10 +5994,10 @@ class="cmtt-10">\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 uses \gls uses \glsxtrgenabbrvfmt). -

The regular entry abbreviation styles set the

The regular entry abbreviation styles set the regular attribute to “true” for the @@ -6017,7 +6033,7 @@ class="cmss-10">long\glsxtrshort. -

The other abbreviation styles don’t modify the

The other abbreviation styles don’t modify the regular attribute. The \glsxtrfullformat that are defined by the style). -

In both cases, the

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

The sample file

The sample file sample-abbr-styles.tex demonstrates all predefined styles described here. -

For the “sc” styles that use

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 @@ -6056,52 +6072,52 @@ class="cmss-10">fontenc package with the T1 option or something similar.
-

-

The parenthetical styles, such as

+

The parenthetical styles, such as long-short, use -



\glsxtrparen  \glsxtrparen{text}

-

+

to set the parenthetical material. This just puts parentheses around the text: (⟨text⟩). -

The basic abbreviation styles, such as

The basic abbreviation styles, such as long-short and short-long use -



\glsabbrvdefaultfont  \glsabbrvdefaultfont{text}

-

+

for the short form. This just does ⟨text⟩ by default. (That is, no font change is applied.) On first use, -



\glsfirstabbrvdefaultfont  \glsfirstabbrvdefaultfont{text}

-

+

is used instead. By default, this just does \glsabbrvdefaultfont. The long form is formatted according to -



\glslongdefaultfont  }

-

+

which again just does ⟨text⟩ (no font change). On first use, -



\glsfirstlongdefaultfont  \glsfirstlongdefaultfont{text}

-

+

is used instead. This just does \glslongdefaultfont. The plural suffix used for the short form is given by -



\glsxtrabbrvpluralsuffix  \glsxtrabbrvpluralsuffix

-

+

which defaults to \glspluralsuffix. -

The small-cap styles, such as

The small-cap styles, such as long-short-sc and short-sc-long, use -



\glsabbrvscfont  \glsabbrvscfont{text}

-

+

which uses \textsc.3.1 On first use -



\glsabbrvdefaultfont  \glsfirstabbrvscfont{text}

-

+

is used instead. This uses \glsabbrvscfont by default. So redefine, \glsabbrvscfont to change first and subsequent uses or \glsfirstabbrvscfont to change just the first use. -

The long form for the small-cap styles uses

The long form for the small-cap styles uses \glslongdefaultfont or \glsfirstlongdefaultfont, as with the basic style. The suffix is given by -



\glsxtrscsuffix  \glsxtrscsuffix

-

+

This is defined as @@ -6187,7 +6203,7 @@ This is defined as

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

The

The \glstextup command is provided by glossaries and is used to switch off the @@ -6207,51 +6223,51 @@ attributes. See §5 Categories for further details.) -

The small styles, such as

The small styles, such as long-short-sm and short-sm-long, use -



\glsabbrvsmfont  \glsabbrvsmfont{text}

-

+

which uses \textsmaller. (This requires the relsizes package, which isn’t loaded by glossaries-extra, so must be loaded explicitly.) On first use -



\glsfirstabbrvsmfont  \glsfirstabbrvsmfont{text}

-

+

is used instead. This uses \glsabbrvsmfont by default. -

The long form for the smaller styles uses

The long form for the smaller styles uses \glslongdefaultfont or \glsfirstlongdefaultfont, as with the basic style. The suffix is given by -



\glsxtrsmsuffix  \glsxtrsmsuffix

-

+

which defaults to just \glsxtrabbrvpluralsuffix. -

The “short-em” (emphasize short) styles, such as

The “short-em” (emphasize short) styles, such as long-short-em or short-em-long, use -



\glsabbrvemfont  \glsabbrvemfont{text}

-

+

On first use -



\glsfirstabbrvemfont  \glsfirstabbrvemfont{text}

-

+

is used instead. This uses \glsabbrvemfont by default. The suffix is given by -



\glsxtremsuffix  \glsxtremsuffix

-

+

which defaults to just \glsxtrabbrvpluralsuffix. The long form is as for the basic style unless the style is a “long-em” style. -

The “long-em” (emphasize long) styles, such as

The “long-em” (emphasize long) styles, such as long-em-short-em or short-em-long-em, use -



\glsfirstlongemfont  \glsfirstlongemfont{long-form}

-

+

instead of \glsfirstlongdefaultfont{long-form} and -



\glslongemfont  }

-

+

instead of \glslongdefaultfont{long-form}. The first form \glsfirstlongemfont is initialised to use \glslongemfont. -

The user styles have similar commands: -


The user styles have similar commands: +


\glsabbrvuserfont  \glsabbrvuserfont{text}

-

+

for the short form, -



\glsfirstabbrvuserfont  \glsfirstabbrvuserfont{text}

-

+

for the first use short form, -



\glslonguserfont  \glslonguserfont{text}

-

+

for the long form, -



\glsfirstlonguserfont  \glsfirstlonguserfont{text}

-

+

for the first use long form, and -



\glsxtrusersuffix  \glsxtrusersuffix

-

+

for the short plural suffix. -

Similarly for the hyphen styles: -


Similarly for the hyphen styles: +


\glsabbrvhyphenfont  \glsabbrvhyphenfont{text}

-

+

for the short form, -



\glsfirstabbrvhyphenfont  \glsfirstabbrvhyphenfont{text}

-

+

for the first use short form, -



\glslonghyphenfont  \glslonghyphenfont{text}

-

+

for the long form, -



\glsfirstlonghyphenfont  \glsfirstlonghyphenfont{text}

-

+

for the first use long form, and -



\glsxtrhyphensuffix  \glsxtrhyphensuffix

-

+

for the short plural suffix. -

Similarly for the “only” styles, such as

Similarly for the “only” styles, such as long-only-short-only: -



\glsabbrvonlyfont  \glsabbrvonlyfont{text}

-

+

for the short form, -



\glsfirstabbrvonlyfont  \glsfirstabbrvonlyfont{text}

-

+

for the first use short form, -



\glslongonlyfont  \glslongonlyfont{text}

-

+

for the long form, -



\glsfirstlongonlyfont  }

-

+

for the first use long form, and -



\glsxtronlysuffix  \glsxtronlysuffix

-

+

for the short plural suffix. -

Note that by default inserted material (provided in the final optional argument of +

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 move it inside, use: -



\glsxtrinsertinsidetrue  \glsxtrinsertinsidetrue

-

+

This applies to all the predefined styles. For example: @@ -6484,17 +6500,17 @@ 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 emphasized font. -

Note that for some styles, such as the

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). -

Remember that

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 @@ -6508,8 +6524,8 @@ convert its argument to lowercase. For example:

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

-

If you want to easily switch between the “sc” and “sm” styles, you may find it +

+

If you want to easily switch between the “sc” and “sm” styles, you may find it easier to redefine this command to convert case: @@ -6519,16 +6535,16 @@ easier to redefine this command to convert case: \renewcommand*{\glsabbrvscfont}[1]{\textsc{\MakeTextLowercase{#1}}}  
\renewcommand*{\glsabbrvsmfont}[1]{\textsmaller{\MakeTextUppercase{#1}}}

-

-

Some of the styles use -


+

Some of the styles use +


\glsxtrfullsep  \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: @@ -6538,7 +6554,7 @@ default, but may be changed as required. For example:

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

or +

or @@ -6546,8 +6562,8 @@ 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:

-

Or, if you are using

Or, if you are using hyperref: @@ -9341,8 +9357,8 @@ class="cmss-10">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 \MakeUppercase. -

The

The glossaries-extra package tries to resolve this by modifying \markright and @@ -9364,12 +9380,12 @@ class="cmtt-10">\markright\markboth. If you don’t like this change, you can restore their former definitions using -



\glsxtrRevertMarks  \glsxtrRevertMarks

-

+

In this case, you’ll have to use the glossaries manual’s recommendations of either simply using \chapter[A Chapter about \glsentryshort{html}]{A Chapter about \gls{html}}

-

-

If you don’t revert the mark commands back with

+

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

The commands listed below all use \texorpdfstring if hyperref

These commands essentially behave as though you have used

These commands essentially behave as though you have used \glsxtrshort (or equivalent) with the options noindexheaduc attribute to “true” for the appropriate category. -

If you use one of the

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 @@ -9429,37 +9445,37 @@ class="cmtt-10">\glsabbrvfont. You may want to consider using the slantsc package in this case.
-

-

Display the short form: -


+

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}

-

+

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

First letter upper case plural short form: -


First letter upper case plural short form: +


\Glsfmtshortpl  }

-

+

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

Display the long form: -


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}

-

+

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

First letter upper case plural long form: -


First letter upper case plural long form: +


\Glsfmtlongpl  \Glsfmtlongpl{label}

-

+

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

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

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: -


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}

-

+

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

First letter upper case plural full form: -


First letter upper case plural full form: +


\Glsfmtfullpl  \Glsfmtfullpl{label}

-

+

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

There are also equivalent commands for the value of the

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



\glsfmttext  \glsfmttext{label}

-

-

First letter converted to upper case: -


+

First letter converted to upper case: +


\Glsfmttext  \Glsfmttext{label}

-

+

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

The plural equivalents: -


The plural equivalents: +


\glsfmtplural  }

-

+

and -



\Glsfmtplural  \Glsfmtplural{label}

-

-

Similarly for the value of the

+

Similarly for the value of the first field: -



\glsfmtfirst  \glsfmtfirst{label}

-

-

First letter converted to upper case: -


+

First letter converted to upper case: +


\Glsfmtfirst  \Glsfmtfirst{label}

-

+

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

The plural equivalents: -


The plural equivalents: +


\glsfmtfirstpl  \glsfmtfirstpl{label}

-

+

and -



\Glsfmtfirstpl  \Glsfmtfirstpl{label}

-

+

-

-

+

Top

5. Categories

-

Each entry defined by

Each entry defined by \newglossaryentry (or commands that internally use it such as babel 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 category with type. -

The default category assumed by

The default category assumed by \newglossaryentry is labelled general. @@ -9674,7 +9690,7 @@ class="cmtt-10">\newacronym have the category set to acronym by default. -

Additionally, if you have enabled

Additionally, if you have enabled \newterm with the indexnumbersnumber. -

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


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


\glscategory  \glscategory{label}

-

+

This is equivalent to commands like \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 -


You can test the category for a given entry using +


\glsifcategory  part}{false part}

-

+

This is equivalent to

-

Here the

Here the short and longuser1 \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. @@ -9940,21 +9956,21 @@ class="description">If this attribute is set to “true” any entry def class="cmtt-10">\newabbreviation will automatically have spaces in the long form replaced with -



\glsxtrwordsep  \glsxtrwordsep

-

+

and each word is encapsulated with -



\glsxtrword  \glsxtrword{word}

-

+

For example: @@ -9964,7 +9980,7 @@ class="cmtt-10">}


\glssetcategoryattribute{abbreviation}{markwords}{true}  
\newabbreviation{ip}{IP}{Internet Protocol}
-

is essentially the same as +

is essentially the same as @@ -9973,7 +9989,7 @@ class="cmtt-10">}


\newabbreviation{ip}{IP}  
{\glsxtrword{Internet}\glsxtrwordsep\glsxtrword{Protocol}}
-

The “hyphen” styles, such as

The “hyphen” styles, such as long-hyphen-short-hyphen, take advantage of this @@ -9995,15 +10011,15 @@ class="cmtt-10">\glsxtrlong. You can provide your own \newcommand{\hyplong}[2][]{%  
 {\def\glsxtrwordsep{-}\glsxtrlong[#1]{#2}}}

-

-

This setting will also adjust the long plural. -

This setting may result in the

+

This setting will also adjust the long plural. +

This setting may result in the \glsxtrword and \glsxtrwordsep markup ending up in the sort field, depending on the style in use.
-

+

markwords but applies to the short form. (Only useful for abbreviations that contain spaces.) -

This setting will only adjust the short plural if the

This setting will only adjust the short plural if the shortplural key isn’t used. This setting will take precedence over insertdots. -

This setting may result in the

This setting may result in the \glsxtrword and \glsxtrwordsep markup ending up in the sort field, depending on the style in use.
-

+

markshortwords. -

If you explicitly override the short plural using the

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

+

This attribute is best used with the discardperiod attribute set to “true”. @@ -10147,7 +10163,7 @@ class="cmtt-10">\glsxtrifcounttrigger\cgls should behave. -

With

With glossaries, commands like \cgls use \cglsformat only if the previous @@ -10185,7 +10201,7 @@ class="cmtt-10">\capitalisewordsmfirstuc). If you want to use a different command you can redefine: -



\glsxtrfieldtitlecasecs  \glsxtrfieldtitlecasecs{phrase cs}

-

+

For example: @@ -10202,7 +10218,7 @@ class="cmtt-10">}

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

(Note that the argument to

(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.)

-

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 mfirstuc\glossentrydesc \glssetcategoryattribute{general}{glossdescfont}{emph}

-

+

\glossentryname \glssetcategoryattribute{general}{glossnamefont}{emph}
-

Note that this overrides

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. @@ -10319,7 +10335,7 @@ class="cmtt-10">\gls will be set to the

\glssetcategoryattribute{general}{targeturl}{master-doc.pdf}
-

(See also the accompanying sample file

(See also the accompanying sample file sample-external.tex.) If the URL contains awkward characters (such as % or \glspercentchar and \glstildechar that expand to literal characters. -

If you want to a named anchor within the target URL (notionally adding +

If you want to a named anchor within the target URL (notionally adding #name⟩ to the URL), then you also need to set \glslabel within ⟨name⟩ which is set by commands like \gls to the entry’s label. -

All the predefined glossary styles start each entry listing with

All the predefined glossary styles start each entry listing with \glstarget which sets the anchor to \glolinkprefix\glslabel, so if you want @@ -10359,10 +10375,10 @@ class="cmss-10">targeturl \glssetcategoryattribute{general}{targetname}{\glolinkprefix\glslabel}

-

(If the target document changed

(If the target document changed \glolinkprefix then you will need to adjust the above as appropriate.) -

If the anchor is in the form ⟨

If the anchor is in the form ⟨name1.name2⟩ then use targetcategory for the ⟨name1⟩ part. -

For example: +

For example: @@ -10385,11 +10401,11 @@ class="cmti-10">name1⟩ part.  
\glssetcategoryattribute{general}{targetcategory}{page}  
\glssetcategoryattribute{general}{targetname}{7}

-

will cause all link text for

will cause all link text for general entries to link to master-doc.pdf#page.7 (page 7 of that PDF). -

If you want a mixture in your document of entries that link to an internal +

If you want a mixture in your document of entries that link to an internal glossary and entries that link to an external URL then you can use the starred form of \newignoredglossary\newignoredglossary  category=external,  
  description={external example}}

-

+

-

An attribute can be set using: -


An attribute can be set using: +


\glssetcategoryattribute  attribute-label}{value}

-

+

where ⟨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

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



\glssetregularcategory  \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  } class="cmtt-10">{⟨value}

-

+

This uses \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: -


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


\glsgetcategoryattribute  } class="cmtt-10">{⟨attribute-label}

-

+

Again there is a shortcut if you need to lookup the category label for a given entry: -



\glsgetattribute  } -

-

You can test if an attribute has been assigned to a given category using: -


+

You can test if an attribute has been assigned to a given category using: +


\glshascategoryattribute  true code}{false code}

-

+

This uses etoolbox’s 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 from an entry is: -



\glshasattribute  code}{false code}

-

-

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


+

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


\glsifcategoryattribute  true-part}{false-part}

-

+

This tests if the attribute (given by ⟨attribute-label⟩) for the category (given by ⟨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: +

For example: @@ -10571,7 +10587,7 @@ class="cmti-10">false part⟩ is done.

\glsifcategoryattribute{general}{nohyper}{true}{NO HYPER}{HYPER}
-

This does “NO HYPER” if the

This does “NO HYPER” if the general category has the nohyper attribute set to true otherwise if does “HYPER”. -

With boolean-style attributes like

With boolean-style attributes like nohyper, make sure you always test for 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 +

Again there’s a shortcut if you need to lookup the category label from a particular entry: -



\glsifattribute  true-part} {false-part}

-

-

There’s also a shortcut to determine if a particular category has the

+

There’s also a shortcut to determine if a particular category has the regular attribute set to “true”: -



\glsifregularcategory  true-part}{false-part}

-

+

Alternatively, if you need to lookup the category for a particular entry: -



\glsifregular  }{false-part}

-

+

Note that if the regularregular attribute has been set to “false”: -



\glsifnotregularcategory  true-part}{false-part}

-

+

or for a particular entry: -



\glsifnotregular  }{false-part}

-

+

Again, if the regular attribute hasn’t been set, the above do ⟨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: -


You can iterate through all entries with a given category using: +


\glsforeachincategory[glossary-labels]{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 ⟨

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  }{body}

-

+

This will do ⟨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 +

You can change the category for a particular entry using the standard glossary field changing commands, such as \glsfielddef. Alternatively, you can use -



\glsxtrsetcategory  }{category-label}

-

+

This will change the category to ⟨category-label⟩ for each entry listed in the comma-separated list ⟨\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 +

You can also change the category for all entries with a glossary or glossaries using: -



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

-

+

where ⟨glossary-labels⟩ is a comma-separated list of glossary labels.

-

-

+

Top

6. Entry Counting

-

As mentioned in

As mentioned in §2.4 Entry Counting Modifications, §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

+

With glossaries-extra, you may use \cgls instead of shortcuts=ac). -

All upper case versions (not provided by

All upper case versions (not provided by glossaries) are also available: -



\cGLS  label}[insert]

-

+

and -



\cGLSpl  label}[insert]

-

+

These are analogous to \cgls and \cglspl but they use -



\cGLSformat  label}{insert}

-

+

and -



\cGLSplformat  label}{insert}

-

+

which convert the analogous \cglsformat and \cglsplformat to upper case. -

Just using

Just using glossaries: @@ -10923,8 +10939,8 @@ class="cmss-10">glossaries:  
\printglossaries  
\end{document}

-

-

If you switch to

+

If you switch to glossaries-extra you must set the entrycountentrycount\printglossaries  
\end{document}

-

-

When activated with

+

When activated with \glsenableentrycount, commands such as \cgls now use -



\glsxtrifcounttrigger  } class="cmtt-10">{⟨normal code}

-

+

to determine if the entry trips the entry count trigger. The ⟨trigger code⟩ uses commands like trigger code⟩ but the usual \gls behaviour in ⟨normal code⟩). -

The default definition is: +

The default definition is: @@ -11000,7 +11016,7 @@ class="cmti-10">normal code⟩).  
 {#3}%  
}

-

This means that if an entry is assigned to a category that has the

This means that if an entry is assigned to a category that has the entrycount @@ -11008,7 +11024,7 @@ attribute then the ⟨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: @@ -11017,8 +11033,8 @@ 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 entrycount\gls, etc to use \cgls etc: -



\GlsXtrEnableEntryCounting  } class="cmtt-10">{⟨value}

-

+

The first argument ⟨categories⟩ is a comma-separated list of categories. For each category, the 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

This makes it easier to enable entry-counting on existing documents. +

If you use \GlsXtrEnableEntryCounting more than once, subsequent uses will just set the entrycount attribute for each listed category. -

The above example document can then become: +

The above example document can then become: @@ -11083,12 +11099,12 @@ class="cmss-10">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  value}{counter-name}

-

+

where ⟨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 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 page 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

The counter value is used as part of a label, which means that \thecounter-name⟩ needs to be expandable. Since \theHcounter-name⟩ if it exists otherwise it will use \thecounter-name⟩. -

The per-unit counting function uses two attributes:

The per-unit counting function uses two attributes: entrycount (as before) and @@ -11142,53 +11158,53 @@ class="cmss-10">unitcount

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{label}

-

+

and the final value from the previous run: -



\glsentryprevcount  \glsentryprevcount{label}

-

+

In the case of the per-unit counting, this is the final value for the current unit. In both commands ⟨label⟩ is the entry’s label. -

The per-unit counting mechanism additionally provides: -


The per-unit counting mechanism additionally provides: +


\glsentryprevtotalcount  \glsentryprevtotalcount{label}

-

+

which gives the sum of all the per-unit totals from the previous run for the entry given by ⟨label⟩, and -



\glsentryprevmaxcount  \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: @@ -11212,7 +11228,7 @@ which gives the maximum per-unit total from the previous run.  
\printglossaries  
\end{document}

-

In this document, the

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} doesn’t get a line added to the glossary file. -

The

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

The sample entry has only been used once, but it doesn’t trip the indexing suppression because it’s in the general category, which hasn’t been listed in \GlsXtrEnableEntryUnitCounting. -

The per-unit entry counting can be used for other purposes. In the following +

The per-unit entry counting can be used for other purposes. In the following @@ -11247,12 +11263,12 @@ won’t be triggered, but the unit entry count is used to automatically supp hyperlink for commands like \gls by modifying the hook -



\glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook

-

+

which is used at the end of the macro the determines whether or not to suppress the hyperlink. @@ -11280,10 +11296,10 @@ hyperlink.  
\printglossaries  
\end{document}

-

This only produces a hyperlink for the first instance of

This only produces a hyperlink for the first instance of \gls{sample} on each page. -

The earlier warning about using the

The earlier warning about using the page counter still applies. If the first instance of -

-

+

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: indexnamedualindex. -

The

The \glsxtrpostnamehook macro, used at the end of \glossentrynamename key. -

The internal macro used by the

The internal macro used by the glossaries package to write the information to the external glossary file is modified to check for the dualindex attribute. -

In both cases, the indexing is done through -


In both cases, the indexing is done through +


\glsxtrdoautoindexname  }{attribute-label}

-

+

This uses the standard \index command with the sort value taken from the entry’s @@ -11355,15 +11371,15 @@ class="cmti-10">label⟩}. As from v1.16, there are user-level commands available to change the sort and actual value used by the automated index. -

The actual value is given by -


The actual value is given by +


\glsxtrautoindexentry  \glsxtrautoindexentry{label}

-

+

where ⟨label⟩ is the entry’s label. The default definition is: @@ -11373,12 +11389,12 @@ class="cmti-10">label⟩ is the entry’s label. The default def

\newcommand*{\glsxtrautoindexentry}[1]{\string\glsentryname{#1}}
-

Note the use of

Note the use of \string to prevent \glsentryname from being expanded as it’s written to the index file. -

The sort value is assigned using: -


The sort value is assigned using: +


\glsxtrautoindexassignsort  }{label}

-

+

where ⟨label⟩ is the entry label and ⟨cs⟩ is the command which needs to be set to the @@ -11402,31 +11418,31 @@ sort value. The default definition is:  
  \glsletentryfield{#1}{#2}{sort}%  
}

-

After this macro is called, ⟨

After this macro is called, ⟨cs⟩ is then processed to escape any of makeindex’s special characters. Note that this escaping is only performed on the sort not on the actual value. -

The command used to perform the actual indexing is: -


The command used to perform the actual indexing is: +


\glsxtrautoindex  \glsxtrautoindex{text}

-

+

This just does \index{text} by default. -

The entry’s

The entry’s parent field isn’t referenced in this automated indexing.
-

-

For example, to index the value of the

+

For example, to index the value of the first key, instead of the namename \renewcommand*{\glsxtrautoindexentry}[1]{\string\glsentryfirst{#1}}

-

and if the sort value also needs to be set to the

and if the sort value also needs to be set to the long field, if present, otherwise the sort  {\glsletentryfield{#1}{#2}{sort}}%  
}

-

-

If the value of the attribute given by ⟨

+

If the value of the attribute given by ⟨attribute-label⟩ is “true”, no encap will be added, otherwise the encap will be the attribute value. For example: @@ -11466,7 +11482,7 @@ added, otherwise the encap will be the attribute value. For example:

\glssetcategoryattribute{general}{indexname}{textbf}
-

will set the encap to

will set the encap to textbf which will display the relevant page number in bold whereas @@ -11476,13 +11492,13 @@ 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

+

By default the format key won’t be used with the format key to override the attribute value by using the preamble-only command: -



\GlsXtrEnableIndexFormatOverride  \GlsXtrEnableIndexFormatOverride

-

+

If you use this command and hyperref has been loaded, then the \glshypernumber to allow formats that use that command. -

The

The dualindex attribute will still be used on subsequent use even if the @@ -11525,8 +11541,8 @@ class="cmss-10">dualindexnoindex key.
-

-

The

+

The \glsxtrdoautoindexname command will attempt to escape any of \makeindex\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 +

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!
-

-


Be very careful of possible shifting category codes!
+

+


\GlsXtrSetActualChar  \GlsXtrSetActualChar{char}

-

+

Set the actual character to ⟨char⟩. -



\GlsXtrSetLevelChar  \GlsXtrSetLevelChar{char}

-

+

Set the level character to ⟨char⟩. -



\GlsXtrSetEscChar  \GlsXtrSetEscChar{char}

-

+

Set the escape (quote) character to ⟨char⟩. -



\GlsXtrSetEncapChar  }

-

+

Set the encap character to ⟨char⟩.

-

-

+

Top

8. On-the-Fly Document Definitions

-

The commands described here may superficially look like ⟨

The commands described here may superficially look like ⟨word\index{word\index then just use \index.
-

-

The

+

The glossaries package advises against defining entries in the documentglossaries-extra but can be enabled using the href="#styopt.docdefs">docdefs package options. -

Although this can be problematic, the

Although this can be problematic, the glossaries-extra package provides a way of defining and using entries within the documentdocdefsThere 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

-

+

When used, this defines the commands described below. -

The commands

The commands \glsxtr, \glsxtrpl, \Glsxtr and \printglossary\gls or there may be unexpected results.
-

-


+


\glsxtr  dfn-options]{label}

-

+

If an entry with the label ⟨label⟩ has already been defined, this just does \gls @@ -11704,7 +11720,7 @@ class="cmitt-10">dfn-options⟩}

-

The ⟨

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 ⟨name key must be provided in the optional argument ⟨dfn-options⟩.
-

+

-

The second optional argument ⟨

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  dfn-options}{label}

-

-

For example, this warning will be generated on the second instance of

+

For example, this warning will be generated on the second instance of \glsxtr below: @@ -11743,8 +11759,8 @@ below:  
 ... later  
\glsxtr[][plural=geese]{goose}

-

-

If you are considering doing something like: +

+

If you are considering doing something like: @@ -11755,14 +11771,14 @@ 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 and then use \gls in the document. -

There are plural and case-changing alternatives to

There are plural and case-changing alternatives to \glsxtr: -



\glsxtrpl  dfn-options]{label}

-

+

This is like \glsxtr but uses \glspl instead of \gls. -



\Glsxtr  dfn-options]{label}

-

+

This is like \glsxtr but uses \Gls instead of \gls. -



\Glsxtrpl  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 +

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 @@ -11819,20 +11835,20 @@ without switching to X\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

If you use the starred version of \GlsXtrEnableOnTheFly don’t use any commands in the ⟨label⟩, even if they expand to just text.
-

+

-

-

+

Top

9. bib2gls: Managing Reference Databases

-

There is a new command line application called

There is a new command line application called bib2gls.glstex file which is loaded using \glsxtrresourcefile (or \GlsXtrLoadResources). -

This means that you can use a reference managing system, such as JabRef, to +

This means that you can use a reference managing system, such as JabRef, to maintain the database and it reduces the TEX overhead by only defining the entries that are actually required in the document. If you currently have a convertgls2bibbib2gls.) -

There are some new commands and options added to

There are some new commands and options added to glossaries-extra to help assist the integration of bib2gls into the document build process. -

An example of the contents of

An example of the contents of .bib file that stores glossary entries that can be extracted with bib2gls  description={a waterbird with a long neck}  
}

-

-

The follow provides some abbreviations: +

+

The follow provides some abbreviations: @@ -11929,8 +11945,8 @@ class="cmtt-10">bib2gls  description={a simple interpreted server-side scripting language}  
}

-

-

Here are some symbols: +

+

Here are some symbols: @@ -11953,8 +11969,8 @@ preamble{"\providecommand{\mtx}[1]{\boldsymbol{#1}}"}  
  description={a set}  
}

-

-

To ensure that

+

To ensure that bib2glsrecord \usepackage[record]{glossaries-extra}

-

If this option’s value is omitted (as above), the normal indexing will be switched off, +

If this option’s value is omitted (as above), the normal indexing will be switched off, since bib2gls can also sort the entries and collate the locations. -

If you still want to use an indexing application (for example, you need a custom +

If you still want to use an indexing application (for example, you need a custom \printglossaries), but it’s a good idea to also ins id="dx1-30019">bib2gls to omit sorting to save time. -

The

The .glstex file created by \bib2gls is loaded using: -



\glsxtrresourcefile  ]{filename}

-

+

(Don’t include the file extension in ⟨filename⟩.) There’s a shortcut version (recommended over the above) that sets ⟨filename⟩ to use \jobname: -



\GlsXtrLoadResources  \GlsXtrLoadResources[options]

-

+

On the first use, this command is a shortcut for

}
where ⟨n⟩ is the current value of -



\glsxtrresourcecount

-

+

which is incremented at the end of \GlsXtrLoadResources. Any advisory notes regarding \glsxtrresourcefile also apply to \GlsXtrLoadResources. -

The

The \glsxtrresourcefile command writes the line

9.2

Since the

Since the .glstex won’t exist on the first LATEX run, the .glstex file the references should be resolved. This may cause a shift in the locations if the actual text produced once the entry is defined is larger than the placeholder ?? (as can occur with long citations). -

Note that

-

-

If you want to add all entries to the glossary, you need to tell

+

If you want to add all entries to the glossary, you need to tell bib2gls this in the @@ -12121,18 +12137,18 @@ options list. For example:

\GlsXtrLoadResources[src={terms},selection={all}]
-

See the

See the bib2gls user manual for more details of this and other available options. -

Note that as from v1.12,

Note that as from v1.12, \glsxtrresourcefile temporarily switches the category code of @ to 11 (letter) while it reads the file to allow for any internal commands stored in the location field. -

Since the

Since the .glstex file only defines those references used within the document and the definitions have been written in the order corresponding to §10.2 Display All Entries Without Sorting or Indexing. -

Suppose the

Suppose the .bib examples shown above have been stored in the files terms.bib, EX’s path. Then the document might look like:  
\printunsrtglossaries  
\end{document}

-

The document build process (assuming the document is called

The document build process (assuming the document is called mydoc) is: @@ -12181,7 +12197,7 @@ pdflatex mydoc  
bib2gls mydoc  
pdflatex mydoc

-

This creates a single glossary containing the entries:

This creates a single glossary containing the entries: bird, duck, goose, shtml. These cross-referenced entries won’t have a location list when the glossary is first displayed, but depending on how they are referenced, they may pick up a location list on the next document build. -

The entries can be separated into different glossaries with different sort +

The entries can be separated into different glossaries with different sort methods: @@ -12244,7 +12260,7 @@ methods:  
\printunsrtglossaries  
\end{document}

-

(By default, entries are sorted according to the operating system’s locale. +

(By default, entries are sorted according to the operating system’s locale. If this doesn’t match the document language, you need to set this in the option list, for example sort=de-CH-1996 for Swiss German using the new @@ -12253,11 +12269,11 @@ orthography.)

-

-

+

Top

10. Miscellaneous New Commands

-

The

The glossaries package provides \glsrefentry entry to cross-reference entries @@ -12268,21 +12284,21 @@ class="cmss-10">subentrycounter options. The glossaries-extra package provides a supplementary command -



\glsxtrpageref  \glsxtrpageref{label}

-

+

that works in the same way except that it uses \pageref instead of \ref. -

You can copy an entry to another glossary using -


You can copy an entry to another glossary using +


\glsxtrcopytoglossary  }{glossary-type}

-

+

This appends ⟨entry-label⟩ to the end of the internal list for the glossary given by ⟨ \printunsrtglossary[target=false]

-

-

The

+

The glossaries package allows you to set preamble code for a given glossary type using \setglossarypreamble. This overrides any previous setting. With glossaries-extra (as from v1.12) you can instead append to the preamble using -



\apptoglossarypreamble  type]{code}

-

+

or prepend using -



\pretoglossarypreamble  type]{code}

-

+

-

Top

10.1 Entry Fields

-

A field may now be used to store the name of a text-block command that takes a +

A field may now be used to store the name of a text-block command that takes a single argument. The field is given by -



\GlsXtrFmtField  \GlsXtrFmtField

-

+

The default value is useri. Note that the value must be the control sequence name without the initial backslash. -

For example: +

For example: @@ -12387,10 +12403,10 @@ class="cmti-10">without the initial backslash.  
   $\mtx{M}\mtxinv{M}=\glssymbol{identitymatrix}$}  
}

-

-

There are two commands provided that allow you to apply the command to an +

+

There are two commands provided that allow you to apply the command to an argument: -



\glsxtrfmt  label}{text}

-

+

This effectively does

\glsxtrfmt will simply do ⟨text⟩. The default ⟨options⟩ are given by -



\GlsXtrFmtDefaultOptions  \GlsXtrFmtDefaultOptions

-

+

@@ -12438,7 +12454,7 @@ replacement text of \GlsXtrFmtDefaultOptions is prepended to the optional argument of \glslink. -

For example: +

For example: @@ -12451,7 +12467,7 @@ class="cmtt-10">\glslink.  
  \glssymbol{identitymatrix}  
\]

-

If the default options are set to

If the default options are set to noindex then \glsxtrfmt won’t index, but will create a hyperlink (if \renewcommand{\GlsXtrFmtDefaultOptions}{hyper=false,noindex}

-

-

Note that

+

Note that \glsxtrfmt won’t work with PDF bookmarks. Instead you can use -



\glsxtrentryfmt  label}{text}

-

+

This uses \texorpdfstring and will simply expand to ⟨text⟩ within the PDF @@ -12489,14 +12505,14 @@ class="cmti-10">text⟩} if a control sequence name has been provided or just ⟨text⟩ otherwise. -

The

The glossaries package provides \glsaddstoragekey to add new keys. This command will cause an error if the key has already been defined. The glossaries-extra package provides a supplementary command that will only define the key if it doesn’t already exist: -



\glsxtrprovidestoragekey  }{cs}

-

+

If the key has already been defined, it will still provide the command given in the third argument ⟨cs⟩ (if it hasn’t already been defined). Unlike cs⟩ may be left empty if you’re happy to just use \glsfieldfetch to fetch the value of this new key. -

You can test if a key has been provided with: -


You can test if a key has been provided with: +


\glsxtrifkeydefined  true}{false}

-

+

This tests if ⟨key⟩ is available for use in the ⟨key⟩= list in the second argument of @@ -12538,7 +12554,7 @@ class="cmtt-10">\newglossaryentry (or the optional argument of commands l class="cmtt-10">\newabbreviation). The corresponding field may not have been set for any of the entries if no default was provided. -

There are now commands provided to set individual fields. Note that +

There are now commands provided to set individual fields. Note that these only change the specified field, not any related values. For example, changing the value of the textparent field). Unexpected results may occur if they are subsequently changed. -



\GlsXtrSetField  field}{value}

-

+

Sets the field given by ⟨field⟩ to ⟨value⟩ for the entry given by ⟨

\GlsXtrSetField uses -



\glsxtrsetfieldifexists  }{code}

-

+

where ⟨label⟩ is the entry label and ⟨code⟩ is the assignment code. -

This command just uses

This command just uses \glsdoifexists{=warn\glsxtrsetfieldifexists to simply do ⟨code⟩ if you want to skip the existence check. Alternatively you can instead use -



\glsxtrdeffield  replacement text}

-

+

This simply uses etoolbox’s \csdef without any checks. This command isn’t robust. There is also a version that uses \csedef instead: -



\glsxtredeffield  replacement text}

-

-


+


\gGlsXtrSetField  field}{value}

-

+

As \GlsXtrSetField but globally. -



\eGlsXtrSetField  field}{value}

-

+

As \GlsXtrSetField but uses protected expansion. -



\xGlsXtrSetField  field}{value}

-

+

As \gGlsXtrSetField but uses protected expansion. -



\GlsXtrLetField  field}{cs}

-

+

Sets the field given by ⟨field⟩ to the replacement text of ⟨cs⟩ for the entry given by ⟨label⟩ (using \let). -



\csGlsXtrLetField  }{cs name}

-

+

As \GlsXtrLetField but the control sequence name is supplied instead. -



\GlsXtrLetFieldToField  label-2}{field-2}

-

+

Sets the field given by ⟨field-1⟩ for the entry given by ⟨label-1⟩ to the field given by @@ -12760,7 +12776,7 @@ class="cmti-10">code⟩} is still used, as for \GlsXtrSetField. -

The

The glossaries package provides \ifglshasfield to determine if a field has been @@ -12769,7 +12785,7 @@ class="cmss-10">glossaries-extra package provides a simpler version: -



\glsxtrifhasfield  }{false}

-

+

(New to v1.19.) Unlike \ifglshasfield, this version doesn’t complain if the entry (given by ⟨true⟩ part is done otherwise it does ⟨false⟩. Within ⟨true⟩ you may use -



\glscurrentfieldvalue  \glscurrentfieldvalue

-

+

to access the field value. This command includes grouping which scopes the ⟨true⟩ and ⟨false⟩ parts. The starred version -



\glsxtrifhasfield*  }{false}

-

+

omits the implicit grouping. -

The

The glossaries package provides \glsfieldfetch which can be used to fetch the value of the given field and store it in a control sequence. The glossaries-extra package provides another way of accessing the field value: -



\glsxtrusefield  entry-label}{field-label}

-

+

This works in the same way as commands like \glsentrytext but the field label is specified in the first argument. Note that the ⟨glossaries manual. No error occurs if the entry or field haven’t been defined. This command is not robust. -

There is also a version that converts the first letter to uppercase (analogous to +

There is also a version that converts the first letter to uppercase (analogous to \Glsentrytext): -



\Glsxtrusefield  entry-label}{field-label}

-

-

If you want to use a field to store a list that can be used as an

+

If you want to use a field to store a list that can be used as an etoolbox internal list, you can use the following command that adds an item to the field using @@ -12867,7 +12883,7 @@ list, you can use the following command that adds an item to the field using class="cmss-10">etoolbox’s \listcsadd: -



\glsxtrfieldlistadd  }{item}

-

+

where ⟨label⟩ is the entry’s label, ⟨field⟩ is the entry’s field and ⟨\listgadd, \listeadd and \listxadd: -



\glsxtrfieldlistgadd  }{item}

-

-


+


\glsxtrfieldlisteadd  } -

-


+


\glsxtrfieldlistxadd  }{item}

-

+

You can then iterate over the list using: -



\glsxtrfielddolistloop  }{field}

-

+

or -



\glsxtrfieldforlistloop  } class="cmtt-10">{⟨handler}

-

+

that internally use \dolistcsloop and \forlistloop, respectively. -

There are also commands that use

There are also commands that use \ifinlistcs: -



\glsxtrfieldifinlist  } class="cmtt-10">{⟨false}

-

+

and \xifinlistcs -



\glsxtrfieldxifinlist  true}{false}

-

-

See the

+

See the etoolbox’s user manual for further details of these commands, in particular the limitations of \ifinlist. -

When using the

When using the record option, in addition to recording the usual location, you can also record the current value of another counter at the same time using the preamble-only command: -



\GlsXtrRecordCounter  \GlsXtrRecordCounter{counter name}

-

+

For example: @@ -13029,7 +13045,7 @@ For example: \usepackage[record]{glossaries-extra}  
\GlsXtrRecordCounter{section}

-

Each time an entry is referenced with commands like

Each time an entry is referenced with commands like \gls or \glstext, the \gls{bird} is used in section 1.2 th

\glsxtrfieldlistgadd{bird}{record.section}{1.2}
-

Note that there’s no key corresponding to this new

Note that there’s no key corresponding to this new record.section field, but its value can be accessed with \glsxtrfielduse or the list can be iterated over with \glsxtrfielddolistloop etc. -

+

-

Top

10.2 Display All Entries Without Sorting or Indexing

-



\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). -

There’s also a starred form -


There’s also a starred form +


\printunsrtglossary*  options]{code}

-

+

which is equivalent to

\endgroup class="cmtt-10">\glossarypreamble, the supplied ⟨code⟩ is done before the glossary header. -

This means you now have the option to simply list all entries on the first +

This means you now have the option to simply list all entries on the first LATEX run without the need for a post-processor, however there will be no §9 bib2gls: Managing Reference Databases). -

No attempt is made to gather hierarchical elements. If child entries aren’t defined +

No attempt is made to gather hierarchical elements. If child entries aren’t defined immediately after their parent entry, they won’t be together in the glossary when using \printunsrtglossary.
-

-

If you have any entries with the

+

If you have any entries with the see key set, you will need the glossariesrecord=only package option will automatically deal with this. -

For example: +

For example: @@ -13179,34 +13195,34 @@ will automatically deal with this.  
\printunsrtglossaries  
\end{document}

-

In the above, zebra will be listed before ant as it was defined first. -

If you allow document definitions with the

In the above, zebra will be listed before ant as it was defined first. +

If you allow document definitions with the docdefs option, the document will require a second LATEX run if the entries are defined after \printunsrtglossary. -

The optional argument is as for

The optional argument is as for \printnoidxglossary (except for the sort key, which isn’t available). -

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


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


\printunsrtglossaries  \printunsrtglossaries

-

+

which is analogous to \printnoidxglossaries. This just iterates over all defined glossaries (that aren’t on the ignored list) and does \printunsrtglossary[type=⟨type⟩]. -

The

The \printunsrtglossary command internally uses -



\printunsrtglossaryhandler  \printunsrtglossaryhandler{label}

-

+

for each item in the list, where ⟨label⟩ is the current label. -

By default this just does -


By default this just does +


\glsxtrunsrtdo  \glsxtrunsrtdo{label}

-

+

which determines whether to use \glossentry or \subglossentry and checks the @@ -13236,11 +13252,11 @@ class="cmss-10">loclist fields for the number list. -

You can redefine the handler if required. -

If you redefine the handler to exclude entries, you may end up with an empty +

You can redefine the handler if required. +

If you redefine the handler to exclude entries, you may end up with an empty glossary. This could cause a problem for the list-based styles.
-

-

For example, if the preamble includes: +

+

For example, if the preamble includes: @@ -13249,7 +13265,7 @@ glossary. This could cause a problem for the list-based styles.

\usepackage[record,style=index]{glossaries-extra}  
\GlsXtrRecordCounter{section}
-

then you can print the glossary but first redefine the handler to only select entries +

then you can print the glossary but first redefine the handler to only select entries that include the current section number in the record.section field: @@ -13263,8 +13279,8 @@ class="cmtt-10">record.section field:  
  {}%  
}

-

-

Alternatively you can use the starred form of

+

Alternatively you can use the starred form of \printunsrtglossary which will localise the change: @@ -13280,8 +13296,8 @@ localise the change:  
  }%  
}

-

-

If you are using the

+

If you are using the hyperref package and want to display the same glossary more than once, you can also add a temporary redefinition of   }%  
}

-

If it’s a short summary at the start of a section, you might also want to suppress the -glossary header and add some vertical space afterwards: +

Note that this will cause a problem if your descriptions contain commands like \gls +that need to link an entry that doesn’t appear in the summary. In this case, it’s a +better approach to use: @@ -13322,6 +13340,29 @@ glossary header and add some vertical space afterwards:  
  }%  
  \ifcsundef{theHsection}%  
  {% + 
    \setkeys{printgloss}{targetnameprefix={record.#2.\csuse{thesection}.}}% + 
  }% + 
  {% + 
    \setkeys{printgloss}{targetnameprefix={record.#2.\csuse{theHsection}.}}% + 
  }% + 
} +

+

+

If it’s a short summary at the start of a section, you might also want to suppress +the glossary header and add some vertical space afterwards: + + + +

+
+\printunsrtglossary*{% + 
  \renewcommand{\printunsrtglossaryhandler}[1]{% + 
    \glsxtrfieldxifinlist{#1}{record.section}{\thesection} + 
    {\glsxtrunsrtdo{#1}}% + 
    {}% + 
  }% + 
  \ifcsundef{theHsection}% + 
  {%  
    \renewcommand*{\glolinkprefix}{record.#2.\csuse{thesection}.}%  
  }%  
  {% @@ -13331,9 +13372,9 @@ glossary header and add some vertical space afterwards:  
  \appto\glossarypostamble{\glspar\medskip\glspar}%  
}
-

-

There’s a shortcut command that does this: -


+

There’s a shortcut command that essentially does this: +


\printunsrtglossaryunit  counter name}

-

+

The above example can simply be replaced with:

-
+
\printunsrtglossaryunit{section}
-

-

This shortcut command is actually defined to use

+

This shortcut command is actually defined to use \printunsrtglossary* with -



\printunsrtglossaryunitsetup  counter name}

-

+

so if you want to just make some minor modifications you can do

-
+
\printunsrtglossary*{\printunsrtglossaryunitsetup{section}%  
  \renewcommand*{\glossarysection}[2][]{\subsection*{Summary}}%  
}
-

which will start the list with a subsection header with the title “Summary” +

which will start the list with a subsection header with the title “Summary” (overriding the glossary’s title). -

Note that this shortcut command is only available with the

Note that this shortcut command is only available with the record (or @@ -13388,7 +13429,7 @@ href="#styopt.record">record=alsoindex) package option. -

This temporary change in the hypertarget prefix means you need to explicitly use +

This temporary change in the hypertarget prefix means you need to explicitly use \hyperlink to create a link to it as commands like \gls will try to link to the target @@ -13400,12 +13441,12 @@ the front or back matter) which can be the target for all glossary references an just use \printunsrtglossaryunit for a quick summary at the start of a section etc. -

+

-

Top

10.3 Entry Aliases

-

An entry can be made an alias of another entry using the

An entry can be made an alias of another entry using the alias key. The value should be the label of the other term. There’s no check for the other’s @@ -13416,7 +13457,7 @@ defining the other entry after the aliased entry. (For example, when used with href="#glo:bib2gls">bib2gls.) -

If an entry ⟨

If an entry ⟨entry-1⟩ is made an alias of ⟨entry-2⟩ then:

    @@ -13479,7 +13520,7 @@ class="cmtt-10">\glssee) unless it’s been explicitly class="cmtt-10">\glsadd or if the indexing has been explicitly set using noindex=false. -

    Note that with

    Note that with record=onlylocation list for aliased entries is controlled href="#glo:bib2gls">bib2gls’s settings.

-

The index suppression trigger is performed by -


The index suppression trigger is performed by +


\glsxtrsetaliasnoindex  \glsxtrsetaliasnoindex

-

+

This is performed after the default options provided by \GlsXtrSetDefaultGlsOpts @@ -13508,49 +13549,49 @@ class="cmss-10">=only, \glsxtrsetaliasnoindex will default to do nothing. -

Within the definition of

Within the definition of \glsxtrsetaliasnoindex you can use -



\glsxtrindexaliased  \glsxtrindexaliased

-

+

to index ⟨entry-2⟩. -

The index suppression command can be redefined to index the main term instead. +

The index suppression command can be redefined to index the main term instead. For example:

-
+
\renewcommand{\glsxtrsetaliasnoindex}{%  
 \glsxtrindexaliased  
 \setkeys{glslink}{noindex}%  
}
-

-

The value of the

+

The value of the alias field can be accessed using -



\glsxtralias  \glsxtralias{label}

-

+

-

-

+

Top

11. Supplemental Packages

-

The

The glossaries bundle provides additional support packages glossaries-prefix (for @@ -13559,10 +13600,10 @@ class="cmss-10">glossaries-accsupp (for accessibility support). These packages aren’t automatically loaded.

-

Top

11.1 Prefixes or Determiners

-

If prefixing is required, you can simply load

If prefixing is required, you can simply load glossaries-prefix after glossaries-extra. For @@ -13571,7 +13612,7 @@ example:

-
+
\documentclass{article}  
\usepackage{glossaries-extra}  
\usepackage{glossaries-prefix} @@ -13586,13 +13627,13 @@ example:  
\printglossaries  
\end{document}
-

-

+

+

-

Top

11.2 Accessibility Support

-

The

The glossaries-accsupp needs to be loaded before glossaries-extra or through the @@ -13604,10 +13645,10 @@ class="cmss-10">accsupp -

+
\usepackage[accsupp]{glossaries-extra}
-

If you don’t load

If you don’t load glossaries-accsupp or you load glossaries-accsuppxxx⟩ commands described below will simply be equiv corresponding \glsentryxxx⟩ commands. -

The following

The following \glsaccessxxx⟩ commands add accessibility information wrapped around the corresponding \glsentryxxx⟩ commands. There is no check for existence of the entry nor do any of these commands add formatting, hyperlinks or indexing information. -



\glsaccessname  \glsaccessname{label}

-

+

This displays the value of the name field for the entry identified by ⟨label⟩. -

If the

If the glossaries-accsupp package isn’t loaded, this is simply defined as:

-
+
\newcommand*{\glsaccessname}[1]{\glsentryname{#1}}
-

otherwise it’s defined as: +

otherwise it’s defined as:

-
+
\newcommand*{\glsaccessname}[1]{%  
  \glsnameaccessdisplay  
  {% @@ -13663,20 +13704,20 @@ class="cmss-10">glossaries-accsupp  {#1}%  
}
-

(

(\glsnameaccessdisplay is defined by the glossaries-accsupp package.) The first letter upper case version is: -



\Glsaccessname  \Glsaccessname{label}

-

+

Without the glossaries-accsupp package this is just defined as: @@ -13684,17 +13725,17 @@ class="cmss-10">glossaries-accsupp -

+
\newcommand*{\Glsaccessname}[1]{\Glsentryname{#1}}
-

With the

With the glossaries-accsupp package this is defined as:

-
+
\newcommand*{\Glsaccessname}[1]{%  
  \glsnameaccessdisplay  
  {% @@ -13703,112 +13744,112 @@ class="cmss-10">glossaries-accsupp  {#1}%  
}
-

-

The following commands are all defined in an analogous manner. -


+

The following commands are all defined in an analogous manner. +


\glsaccesstext  \glsaccesstext{label}

-

+

This displays the value of the text field. -



\Glsaccesstext  \Glsaccesstext{label}

-

+

This displays the value of the text field with the first letter converted to upper case. -



\glsaccessplural  \glsaccessplural{label}

-

+

This displays the value of the plural field. -



\Glsaccessplural  \Glsaccessplural{label}

-

+

This displays the value of the plural field with the first letter converted to upper case. -



\glsaccessfirst  \glsaccessfirst{label}

-

+

This displays the value of the first field. -



\Glsaccessfirst  \Glsaccessfirst{label}

-

+

This displays the value of the first field with the first letter converted to upper case. -



\glsaccessfirstplural  \glsaccessfirstplural{label}

-

+

This displays the value of the firstplural field. -



\Glsaccessfirstplural  \Glsaccessfirstplural{label}

-

+

This displays the value of the firstplural field with the first letter converted to upper case. -



\glsaccesssymbol  \glsaccesssymbol{label}

-

+

This displays the value of the symbol field. -



\Glsaccesssymbol  }

-

+

This displays the value of the symbol field with the first letter converted to upper case. -



\glsaccesssymbolplural  \glsaccesssymbolplural{label}

-

+

This displays the value of the symbolplural field. -



\Glsaccesssymbolplural  \Glsaccesssymbolplural{label}

-

+

This displays the value of the symbolplural field with the first letter converted to upper case. -



\glsaccessdesc  \glsaccessdesc{label}

-

+

This displays the value of the desc field. -



\Glsaccessdesc  \Glsaccessdesc{label}

-

+

This displays the value of the desc field with the first letter converted to upper case. -



\glsaccessdescplural  \glsaccessdescplural{label}

-

+

This displays the value of the descplural field. -



\Glsaccessdescplural  \Glsaccessdescplural{label}

-

+

This displays the value of the descplural field with the first letter converted to upper case. -



\glsaccessshort  \glsaccessshort{label}

-

+

This displays the value of the short field. -



\Glsaccessshort  \Glsaccessshort{label}

-

+

This displays the value of the short field with the first letter converted to upper case. -



\glsaccessshortpl  \glsaccessshortpl{label}

-

+

This displays the value of the shortplural field. -



\Glsaccessshortpl  \Glsaccessshortpl{label}

-

+

This displays the value of the shortplural field with the first letter converted to upper case. -



\glsaccesslong  \glsaccesslong{label}

-

+

This displays the value of the long field. -



\Glsaccesslong  \Glsaccesslong{label}

-

+

This displays the value of the long field with the first letter converted to upper case. -



\glsaccesslongpl  }

-

+

This displays the value of the longplural field. -



\Glsaccesslongpl  \Glsaccesslongpl{label}

-

+

This displays the value of the longplural field with the first letter converted to upper @@ -13991,11 +14032,11 @@ case.

-

-

+

Top

12. Sample Files

-

The following sample files are provided with this package: +

The following sample files are provided with this package:

sample.tex
sample-suppl-hyp.tex. -

-

+

Top

13. Multi-Lingual Support

-

There’s only one command provided by

There’s only one command provided by glossaries-extra that you’re likely to want to change in your document and that’s \abbreviationsname\acronymname (provided by glossaries). -

You can redefine it in the usual way. For example: +

You can redefine it in the usual way. For example:

-
+
\renewcommand*{\abbreviationsname}{List of Abbreviations}
-

Or using

Or using babel or polyglossiapolyglossia -

+
\appto\captionsenglish{%  
 \renewcommand*{\abbreviationsname}{List of Abbreviations}%  
}
-

-

Alternatively you can use the

+

Alternatively you can use the title key when you print the list of abbreviations. For example: @@ -14320,24 +14361,24 @@ For example:

-
+
\printabbreviations[title={List of Abbreviations}]
-

or +

or

-
+
\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

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-langtracklang package). For example, glossariesxtr-french.ldf. -

The simplest code for this file is: +

The simplest code for this file is:

-
+
\ProvidesGlossariesExtraLang{french}[2015/12/09 v1.0]  
\newcommand*{\glossariesxtrcaptionsfrench}{%  
 \def\abbreviationsname{Abr\'eviations}% @@ -14378,8 +14419,8 @@ class="cmtt-10">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 EX’s path so that it can be found by 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  }{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.

-



\GlsXtrNoGlsWarningEmptyStart  \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

-

+

This produces the following text in English:

-

If you don’t want this glossary, add

If you don’t want this glossary, add nomain to your package option list when you load glossaries-extra.sty. For example:

-



\GlsXtrNoGlsWarningEmptyNotMain  \GlsXtrNoGlsWarningEmptyNotMain{label}

-

+

This produces the following text in English:

-

Did you forget to use

Did you forget to use type=label⟩ when you defined your entries? If you tried to load entries into this glossary with ] as the optional argument? If you did, check that the definitions in the file you loaded all had the type set to \glsdefaulttype.

-



\GlsXtrNoGlsWarningCheckFile  \GlsXtrNoGlsWarningCheckFile{file}

-

+

This produces the following text in English:

-

Check the contents of the file ⟨

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 empty, the document build process hasn’t been completed.

-



\GlsXtrNoGlsWarningMisMatch  \GlsXtrNoGlsWarningMisMatch

-

+

This produces the following text in English:

-

You need +

You need to either replace \makenoidxglossaries with \makeglossaries or @@ -14497,17 +14538,17 @@ class="cmtt-10">\printglossaries) class="cmtt-10">\printnoidxglossary (or \printnoidxglossaries) and then rebuild this document.

-



\GlsXtrNoGlsWarningNoOut  \GlsXtrNoGlsWarningNoOut{file}

-

+

This produces the following text in English:

-

The file ⟨

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 version of the document, you can suppress this message using the nomissingglstext package option.

-



\GlsXtrNoGlsWarningTail  \GlsXtrNoGlsWarningTail

-

+

This produces the following text in English:

-

This message will be removed once the problem has been fixed.

-


This message will be removed once the problem has been fixed.

+


\GlsXtrNoGlsWarningBuildInfo  \GlsXtrNoGlsWarningBuildInfo

-

+

This is advice on how to generate the glossary files. See the documented code (glossaries-extra-code.pdf) for further details. -



\GlsXtrNoGlsWarningAutoMake  \GlsXtrNoGlsWarningAutoMake{label}

-

+

This is the message produced when the automake option is used, but the document @@ -15304,7 +15345,7 @@ href="glossaries-extra-manual.html#dx1-4040" >302, 303, 304, 305, 306, 306, 307, 308, 309, 331, 332, 333, 334, 335, 335, 336, 337, 338, 374, 375
    index  376, 376, 377
    number  581
glossaries package  582, 582, 583, 584, 585, 606, 607
glossaries-extra package  608, 608, 609
glossaries-extra-stylemods package  899
\glsxtrpostlongdescription  900
\glsxtrpostnamehook  997
\longnewglossaryentry  998

M @@ -17085,21 +17126,21 @@ class="cmtt-10">makeglossaries  999, 1000, 1001, 1002, 1002, 1003
\makeglossaries  1004
makeglossaries-lite.lua  1005, 1005, 1006
makeglossaries-lite.lua  1007, 1007, 1008
1029
class="cmtt-10">\newglossaryentry options
    alias  1030, 1031, 1030, 1031, 1032, 1033, 1034, 1035
    category  1036, 1036, 1037, 1038, 1039, 1059, 1060, 1061, 1062, 1063
+href="glossaries-extra-manual.html#dx1-5030" >1063
    descriptionplural  1064, 1065, 1066, 1067
+href="glossaries-extra-manual.html#dx1-5020" >1064, 1065, 1066, 1067
    first  1068, 1097, 1098, 1099, 1100, 1101
+href="glossaries-extra-manual.html#dx1-5028" >1101
    longplural  1102, 1152, 1153, 1154, 1155, 1156, 1157, 1156, 1157, 1158, 1159, 1160, seealso  1175, 1176, 1177, 1178, 1179, 1178, 1179, 1180, 1181, 1182, 1194, 1195, 1196, 1197, 1198
+href="glossaries-extra-manual.html#dx1-5029" >1198
    shortplural  1199, 1229
class="cmss-10">symbol  1230, 1231, 1232
+href="glossaries-extra-manual.html#dx1-5031" >1232
    symbolplural  1233, 1283
    automake  1284, 1284, 1285
    autoseeindex  docdef  1290, 1291, 1292, 1293
+href="glossaries-extra-manual.html#dx1-5037" >1293
        restricted  1294
@@ -17508,7 +17549,7 @@ class="cmss-10">false  1301
    index  1302, 1302, 1303
    indexcrossrefs  target  1402, 1403
    targetnameprefix  1404
+    title  1404
+href="glossaries-extra-manual.html#dx1-39006" >1405
\printnoidxglossary options
    sort  1405
+href="glossaries-extra-manual.html#dx1-33012" >1406
\printunsrtglossaries  1406
+class="cmti-10">1407
\printunsrtglossary  1407
+class="cmti-10">1408
\printunsrtglossary*  1408
+class="cmti-10">1409
\printunsrtglossaryhandler  1409
+class="cmti-10">1410
\printunsrtglossaryunit  1410
+class="cmti-10">1411
\printunsrtglossaryunitsetup  1411
+class="cmti-10">1412
\provideignoredglossary  1412
+class="cmti-10">1413

R relsizes package  1413
+href="glossaries-extra-manual.html#dx1-21048" >1414
\RestoreAcronyms  1414
+class="cmti-10">1415

S \setabbreviationstyle  1415
+class="cmti-10">1416
slantsc package  1416
+href="glossaries-extra-manual.html#dx1-25020" >1417

T textcase package  1417
-tracklang package  1418, 1419
+href="glossaries-extra-manual.html#dx1-8" >1418
+tracklang package  1419, 1420
translator package  1420
+href="glossaries-extra-manual.html#dx1-3012" >1421

X xfor package  1421
+href="glossaries-extra-manual.html#dx1-9" >1422
\xglssetwidest  1422
+class="cmti-10">1423
\xGlsXtrSetField  1423
+class="cmti-10">1424
xindy  1424, 1425, 1426, 1427, 1428, 1429, 1430, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1431
+class="cmbx-10">1432
xindy  1432
+href="glossaries-extra-manual.html#dx1-6028" >1433
xkeyval package  1433
+href="glossaries-extra-manual.html#dx1-7" >1434

glossaries to incorporate new features, but a few new minor features slipped in with some bug fixes in v4.21.

-

2.1The descriptionplural key is a throwback to the base package’s original acronym mechanism before the introduction of the long and short keys, where the long form was stored in the description + id="dx1-5030"> field and the short form was stored in the symbol field.

-

3.1For compatibility with earlier versions, \glsabbrvscfont \glsxtrscfont is now deprecated. Likewise for similar commands.

-

9.1Version 1.11 only allowed one use of \GlsXtrLoadResources per document.

-

9.2v1.08 assumed filename#1={\protect\ttfamily#1}|main}} \DeleteShortVerb{\|} \MakeShortVerb{"} - \title{glossaries-extra.sty v1.19: + \title{glossaries-extra.sty v1.20: an extension to the glossaries package} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \url{http://www.dickimaw-books.com/}} - \date{2017-09-08} + \date{2017-09-11} \maketitle \begin{abstract} @@ -855,13 +855,22 @@ This also has a starred version that doesn't automatically switch off hyperlinks. The individual glossary displaying commands \ics{printglossary}, -\ics{printnoidxglossary} and \cs{printunsrtglossary} have an extra -key \gloskey[printglossary]{target}. This is a boolean key which can +\ics{printnoidxglossary} and \cs{printunsrtglossary} have two extra +keys: + +\begin{itemize} +\item \gloskey[printglossary]{target}. This is a boolean key which can be used to switch off the automatic hypertarget for each entry. Unlike \cs{glsdisablehyper} this doesn't switch off hyperlinks, so any cross-references within the glossary won't be affected. This is a way of avoiding duplicate target warnings if a glossary needs to be displayed multiple times. +\item +\gloskey[printglossary]{targetnameprefix}\texttt{=}\marg{prefix}. Another way +of avoiding duplicate target names is to set a prefix +used for the names. Unlike changing \cs{glolinkprefix} this doesn't affect +any hyperlinks (such as those created with \cs{gls}). +\end{itemize} The \cs{newglossaryentry} command has three new keys: \begin{itemize} @@ -6595,6 +6604,27 @@ avoid duplicate hypertarget names. For example: }% } \end{verbatim} +Note that this will cause a problem if your descriptions +contain commands like \cs{gls} that need to link an entry that +doesn't appear in the summary. In this case, it's a better approach +to use: +\begin{verbatim} +\printunsrtglossary*{% + \renewcommand{\printunsrtglossaryhandler}[1]{% + \glsxtrfieldxifinlist{#1}{record.section}{\thesection} + {\glsxtrunsrtdo{#1}}% + {}% + }% + \ifcsundef{theHsection}% + {% + \setkeys{printgloss}{targetnameprefix={record.#2.\csuse{thesection}.}}% + }% + {% + \setkeys{printgloss}{targetnameprefix={record.#2.\csuse{theHsection}.}}% + }% +} +\end{verbatim} + If it's a short summary at the start of a section, you might also want to suppress the glossary header and add some vertical space afterwards: @@ -6617,7 +6647,7 @@ space afterwards: } \end{verbatim} -There's a shortcut command that does this: +There's a shortcut command that essentially does this: \begin{definition}[\DescribeMacro\printunsrtglossaryunit] \cs{printunsrtglossaryunit}\oarg{options}\marg{counter name} \end{definition} diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbr-styles.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbr-styles.pdf index 134b8b2fce5..009a541e310 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbr-styles.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbr-styles.pdf differ 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 9bf1fef1aba..bf85bd47982 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 a1c57a95805..7cda7b41e32 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 a7ef80fa2c1..febcab39d2a 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 529aaef8db3..4c353514e87 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-alias.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alias.pdf index 94daab3981b..3b3b47d884d 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alias.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alias.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 9dcf0dc5fd1..a1237da0907 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 81b8e15c62b..cd769ec76a7 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 eb96aba3139..780ea7f9db0 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 1f69d541840..ee67ac81758 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 f808bea5c03..2b1f6b0d11a 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 e22e241b0c8..2b9bf20afdd 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 2daa552e219..5b407335f71 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 849f5567390..b18f835acb3 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 1773e729ccd..102574c095d 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 2da575a39e0..3d944f5cbba 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-external.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-external.pdf index 9dfb9e4058f..8372cf14cee 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-external.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-external.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-fmt.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-fmt.pdf index 46ce0c5bf0a..b2c01f2181d 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-fmt.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-fmt.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 1f337d22000..79aca7ef653 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 04793152b95..1737882e6f3 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 1f733b650d4..9b1bab71974 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 a8de1aa901c..24f4354b641 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 bdb81ec7383..651b152fd83 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-mixedsort.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixedsort.pdf index 53396c9d7a9..6e143a8c950 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixedsort.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixedsort.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 1719d924ba2..ee11f4ac5ef 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 dc1302678ee..a72fe8f9ba4 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 c9460679cee..b8006b95067 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 279cf194350..8f08f5482d4 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 4f9c1a8feb3..76f413303a1 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 bdc6a3e8efe..e3ac091f528 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 706d3f98ea2..34c921f9aa8 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 e92c7d3ce60..b81dc9035a7 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 a5aaa30e4e4..3d3fe73ee15 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 63f60ed34c8..143062734f2 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 bfa4b989a6e..af5cdcb258a 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 2c34b09d011..7f3430da2f9 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.glstex b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.glstex index 3238f386e01..b52ad045bbd 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.glstex +++ b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.glstex @@ -19,6 +19,7 @@ \appto\glossarypreamble{% \providecommand{\bibglslocsuffix}[1]{\@.}% } +\providecommand*{\bibglsflattenedhomograph}[2]{#1} \providecommand{\bibglsnewentry}[4]{% \longnewglossaryentry*{#1}{name={#3},#2}{#4}% } diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf index 918d466d15e..d33b91240c9 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf differ 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 0d2b2281b77..287ca08da64 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-suppl-hyp.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-hyp.pdf index 179a7b9ade2..1bc2dfbb3f6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-hyp.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-hyp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main-hyp.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main-hyp.pdf index 4d4eb48591e..34ddde821ad 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main-hyp.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main-hyp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main.pdf index e4fd62e460c..31722e07d70 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl.pdf index 7143dcfc9be..3a6202a0725 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl.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 200fc872127..b2afc521098 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 8e81707e688..28a489fb8aa 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 337b1dd4785..c624abcfe3d 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 dadff3b0e91..36a5c63b233 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 diff --git a/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.dtx b/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.dtx index 3ead78d314b..e5c743bed66 100644 --- a/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.dtx +++ b/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.dtx @@ -3,18 +3,19 @@ % Command line args: % -comment ".*\.tex" % -comment ".*\.bib" -% -author "Nicola Talbot" +% -doc "glossaries-extra-codedoc.tex" % -macrocode ".*\.tex" % -macrocode ".*\.bib" % -section "chapter" -% -codetitle "Main Package Code (\\styfmt{glossaries-extra.sty})" -% -doc "glossaries-extra-codedoc.tex" +% -setambles ".*\.bib=>\nopreamble\nopostamble" +% -author "Nicola Talbot" % -src "glossaries-extra.sty\Z=>glossaries-extra.sty" % -src "glossaries-extra-stylemods.sty\Z=>glossaries-extra-stylemods.sty" % -src "(example-glossaries-.+\.tex)\Z=>\1" % -src "(example-glossaries-.+\.bib)\Z=>\1" +% -codetitle "Main Package Code (\\styfmt{glossaries-extra.sty})" % glossaries-extra -% Created on 2017/9/8 22:43 +% Created on 2017/9/11 14:10 %\fi %\iffalse %<*package> @@ -124,7 +125,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \setcounter{IndexColumns}{2} -\CheckSum{17566} +\CheckSum{17580} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{\gls{firstuse}} @@ -164,13 +165,13 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \raggedright } -\title{glossaries-extra.sty v1.19: +\title{glossaries-extra.sty v1.20: documented code} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \url{http://www.dickimaw-books.com/}} -\date{2017-09-08} +\date{2017-09-11} \begin{document} \DocInput{glossaries-extra.dtx} @@ -215,7 +216,7 @@ Dickimaw Books\\ %\section{Package Initialisation and Options} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra}[2017/09/08 v1.19 (NLCT)] +\ProvidesPackage{glossaries-extra}[2017/09/11 v1.20 (NLCT)] % \end{macrocode} % Requires \sty{xkeyval} to define package options. % \begin{macrocode} @@ -6985,7 +6986,31 @@ Dickimaw Books\\ \fi } % \end{macrocode} +%\begin{macro}{\@glsxtrhypernameprefix} +%\changes{1.20}{2017-09-11}{new} +% \begin{macrocode} +\newcommand{\@glsxtrhypernameprefix}{} +% \end{macrocode} +%\end{macro} % +%New to v1.20: +% \begin{macrocode} +\define@key{printgloss}{targetnameprefix}{% + \renewcommand{\@glsxtrhypernameprefix}{#1}% +} +% \end{macrocode} +% +%\begin{macro}{\glsdohypertarget} +%\changes{1.20}{2017-09-11}{added redefinition} +%Redefine to insert \cs{@glsxtrhypernameprefix} before the target +%name. +% \begin{macrocode} +\let\@glsxtr@org@glsdohypertarget\glsdohypertarget +\renewcommand{\glsdohypertarget}[2]{% + \@glsxtr@org@glsdohypertarget{\@glsxtrhypernameprefix#1}{#2}% +} +% \end{macrocode} +%\end{macro} %\begin{macro}{\glsxtr@makeglossaries} %For the benefit of \app{makeglossaries} %\changes{1.09}{2016-12-16}{new} @@ -8072,12 +8097,19 @@ Dickimaw Books\\ {\glsxtrunsrtdo{##1}}% {}% }% +% \end{macrocode} +%\changes{1.20}{2017-09-11}{switched from redefining \cs{glolinkprefix} to +% \cs{@glsxtrhypernameprefix}} +%Only the target names should have the prefixes adjusted as \cs{gls} +%etc need the original \cs{glolinkprefix}. The \cs{@gobble} part +%discards \cs{glolinkprefix}. +% \begin{macrocode} \ifcsundef{theH#1}% {% - \renewcommand*{\glolinkprefix}{record.#1.\csuse{the#1}.}% + \renewcommand*{\@glsxtrhypernameprefix}{record.#1.\csuse{the#1}.\@gobble}% }% {% - \renewcommand*{\glolinkprefix}{record.#1.\csuse{theH#1}.}% + \renewcommand*{\@glsxtrhypernameprefix}{record.#1.\csuse{theH#1}.\@gobble}% }% \renewcommand*{\glossarysection}[2][]{}% \appto\glossarypostamble{\glspar\medskip\glspar}% @@ -18842,7 +18874,7 @@ Dickimaw Books\\ % First identify package: % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra-stylemods}[2017/09/08 v1.19 (NLCT)] +\ProvidesPackage{glossaries-extra-stylemods}[2017/09/11 v1.20 (NLCT)] % \end{macrocode} % Provide package options to automatically load required predefined % styles. The simplest method is to just test for the existence of diff --git a/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.ins b/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.ins index 80c157f3f32..094b9017428 100644 --- a/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.ins +++ b/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.ins @@ -1,4 +1,4 @@ -% glossaries-extra.ins generated using makedtx version 1.2 2017/9/8 22:43 +% glossaries-extra.ins generated using makedtx version 1.2 2017/9/11 14:10 \input docstrip \preamble @@ -30,32 +30,19 @@ \usepostamble\defaultpostamble\from{glossaries-extra.dtx}{glossaries-extra-stylemods.sty,package}} \file{example-glossaries-xr.tex}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-xr.tex,package}} -\file{example-glossaries-acronym-desc.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-acronym-desc.bib,package}} -\file{example-glossaries-acronym.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-acronym.bib,package}} -\file{example-glossaries-acronyms-lang.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-acronyms-lang.bib,package}} -\file{example-glossaries-brief.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-brief.bib,package}} -\file{example-glossaries-childnoname.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-childnoname.bib,package}} -\file{example-glossaries-cite.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-cite.bib,package}} -\file{example-glossaries-images.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-images.bib,package}} -\file{example-glossaries-long.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-long.bib,package}} -\file{example-glossaries-multipar.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-multipar.bib,package}} -\file{example-glossaries-parent.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-parent.bib,package}} -\file{example-glossaries-symbols.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-symbols.bib,package}} -\file{example-glossaries-url.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-url.bib,package}} -\file{example-glossaries-xr.bib}{\usepreamble\defaultpreamble -\usepostamble\defaultpostamble\from{glossaries-extra.dtx}{example-glossaries-xr.bib,package}} +\file{example-glossaries-acronym-desc.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-acronym-desc.bib}} +\file{example-glossaries-acronym.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-acronym.bib}} +\file{example-glossaries-acronyms-lang.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-acronyms-lang.bib}} +\file{example-glossaries-brief.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-brief.bib}} +\file{example-glossaries-childnoname.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-childnoname.bib}} +\file{example-glossaries-cite.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-cite.bib}} +\file{example-glossaries-images.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-images.bib}} +\file{example-glossaries-long.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-long.bib}} +\file{example-glossaries-multipar.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-multipar.bib}} +\file{example-glossaries-parent.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-parent.bib}} +\file{example-glossaries-symbols.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-symbols.bib}} +\file{example-glossaries-url.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-url.bib}} +\file{example-glossaries-xr.bib}{\nopreamble\nopostamble\from{glossaries-extra.dtx}{example-glossaries-xr.bib}} } \endbatchfile diff --git a/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-stylemods.sty b/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-stylemods.sty index 318598c2c28..a2bd79b1a12 100644 --- a/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-stylemods.sty +++ b/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-stylemods.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra-stylemods}[2017/09/08 v1.19 (NLCT)] +\ProvidesPackage{glossaries-extra-stylemods}[2017/09/11 v1.20 (NLCT)] \newcommand*{\@glsxtr@loadstyles}{} \DeclareOption*{% \IfFileExists{glossary-\CurrentOption.sty} diff --git a/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra.sty b/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra.sty index 3302b6ed25d..6cef1c74f7c 100644 --- a/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra.sty +++ b/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra}[2017/09/08 v1.19 (NLCT)] +\ProvidesPackage{glossaries-extra}[2017/09/11 v1.20 (NLCT)] \RequirePackage{xkeyval} \RequirePackage{etoolbox} \@ifpackageloaded{glossaries} @@ -3479,6 +3479,14 @@ \let\@glstarget\@secondoftwo \fi } +\newcommand{\@glsxtrhypernameprefix}{} +\define@key{printgloss}{targetnameprefix}{% + \renewcommand{\@glsxtrhypernameprefix}{#1}% +} +\let\@glsxtr@org@glsdohypertarget\glsdohypertarget +\renewcommand{\glsdohypertarget}[2]{% + \@glsxtr@org@glsdohypertarget{\@glsxtrhypernameprefix#1}{#2}% +} \newcommand*{\glsxtr@makeglossaries}[1]{} \def\@glsxtr@gettype#1,type=#2,#3\@end@glsxtr@gettype{% \def\@glo@type{#2}% @@ -4072,10 +4080,10 @@ }% \ifcsundef{theH#1}% {% - \renewcommand*{\glolinkprefix}{record.#1.\csuse{the#1}.}% + \renewcommand*{\@glsxtrhypernameprefix}{record.#1.\csuse{the#1}.\@gobble}% }% {% - \renewcommand*{\glolinkprefix}{record.#1.\csuse{theH#1}.}% + \renewcommand*{\@glsxtrhypernameprefix}{record.#1.\csuse{theH#1}.\@gobble}% }% \renewcommand*{\glossarysection}[2][]{}% \appto\glossarypostamble{\glspar\medskip\glspar}% -- cgit v1.2.3