From a94181338fbbc4c93ae38719f727b05d3e5be421 Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Thu, 21 Oct 2021 03:01:19 +0000 Subject: CTAN sync 202110210301 --- macros/latex/contrib/easybook/easybook.dtx | 51 +- macros/latex/contrib/easybook/easybook.pdf | Bin 579388 -> 577608 bytes macros/latex/contrib/easybook/easybook.tex | 16 +- macros/latex/contrib/glossaries/CHANGES | 22 +- macros/latex/contrib/glossaries/README.md | 2 +- .../latex/contrib/glossaries/glossaries-code.pdf | Bin 1570009 -> 1583705 bytes .../latex/contrib/glossaries/glossaries-user.html | 30602 ++++++++++--------- .../latex/contrib/glossaries/glossaries-user.pdf | Bin 1288797 -> 1290651 bytes .../latex/contrib/glossaries/glossaries-user.tex | 71 +- macros/latex/contrib/glossaries/glossaries.dtx | 311 +- macros/latex/contrib/glossaries/glossaries.ins | 8 +- .../latex/contrib/glossaries/glossariesbegin.html | 25 +- .../latex/contrib/glossaries/glossariesbegin.pdf | Bin 199351 -> 199352 bytes .../latex/contrib/glossaries/glossariesbegin.tex | 4 +- .../contrib/glossaries/glossary2glossaries.html | 56 +- .../contrib/glossaries/glossary2glossaries.pdf | Bin 150980 -> 150980 bytes .../contrib/glossaries/glossary2glossaries.tex | 2 +- macros/latex/contrib/glossaries/makeglossaries | 6 +- .../latex/contrib/glossaries/makeglossaries-lite.1 | 2 +- .../contrib/glossaries/makeglossaries-lite.lua | 4 +- macros/latex/contrib/glossaries/makeglossaries.1 | 2 +- .../samples/glossary-lipsum-examples.pdf | Bin 253763 -> 253763 bytes .../contrib/glossaries/samples/minimalgls.pdf | Bin 52292 -> 52292 bytes .../contrib/glossaries/samples/mwe-acr-desc.pdf | Bin 40465 -> 40465 bytes .../latex/contrib/glossaries/samples/mwe-acr.pdf | Bin 36154 -> 36154 bytes .../latex/contrib/glossaries/samples/mwe-gls.pdf | Bin 32446 -> 32446 bytes .../contrib/glossaries/samples/sample-FnDesc.pdf | Bin 63852 -> 63852 bytes .../glossaries/samples/sample-chap-hyperfirst.pdf | Bin 57374 -> 57374 bytes .../contrib/glossaries/samples/sample-crossref.pdf | Bin 60867 -> 60867 bytes .../glossaries/samples/sample-custom-acronym.pdf | Bin 87966 -> 87966 bytes .../contrib/glossaries/samples/sample-dot-abbr.pdf | Bin 56062 -> 56062 bytes .../contrib/glossaries/samples/sample-dual.pdf | Bin 38963 -> 38963 bytes .../glossaries/samples/sample-entrycount.pdf | Bin 39340 -> 39340 bytes .../contrib/glossaries/samples/sample-entryfmt.pdf | Bin 37408 -> 37408 bytes .../glossaries/samples/sample-font-abbr.pdf | Bin 54892 -> 54892 bytes .../contrib/glossaries/samples/sample-ignored.pdf | Bin 34318 -> 34318 bytes .../contrib/glossaries/samples/sample-index.pdf | Bin 45918 -> 45918 bytes .../contrib/glossaries/samples/sample-inline.pdf | Bin 158386 -> 157653 bytes .../contrib/glossaries/samples/sample-langdict.pdf | Bin 41705 -> 41698 bytes .../contrib/glossaries/samples/sample-newkeys.pdf | Bin 41704 -> 41704 bytes .../glossaries/samples/sample-noidxapp-utf8.pdf | Bin 102938 -> 102938 bytes .../contrib/glossaries/samples/sample-noidxapp.pdf | Bin 71472 -> 71472 bytes .../glossaries/samples/sample-nomathhyper.pdf | Bin 45042 -> 45042 bytes .../glossaries/samples/sample-numberlist.pdf | Bin 44612 -> 44612 bytes .../contrib/glossaries/samples/sample-prefix.pdf | Bin 48819 -> 48819 bytes .../latex/contrib/glossaries/samples/sample-si.pdf | Bin 23394 -> 23394 bytes .../samples/sample-storage-abbr-desc.pdf | Bin 42402 -> 42402 bytes .../glossaries/samples/sample-storage-abbr.pdf | Bin 40167 -> 40167 bytes macros/latex/contrib/glossaries/samples/sample.pdf | Bin 128521 -> 127784 bytes .../contrib/glossaries/samples/sample4col.pdf | Bin 46610 -> 46610 bytes .../latex/contrib/glossaries/samples/sampleAcr.pdf | Bin 68921 -> 68921 bytes .../contrib/glossaries/samples/sampleAcrDesc.pdf | Bin 99395 -> 99395 bytes .../contrib/glossaries/samples/sampleCustomAcr.pdf | Bin 160568 -> 160568 bytes .../latex/contrib/glossaries/samples/sampleDB.pdf | Bin 51300 -> 51300 bytes .../contrib/glossaries/samples/sampleDesc.pdf | Bin 50967 -> 50967 bytes .../latex/contrib/glossaries/samples/sampleEq.pdf | Bin 167759 -> 167865 bytes .../contrib/glossaries/samples/sampleEqPg.pdf | Bin 181669 -> 181781 bytes .../contrib/glossaries/samples/sampleFnAcrDesc.pdf | Bin 158228 -> 158228 bytes .../latex/contrib/glossaries/samples/sampleNtn.pdf | Bin 106521 -> 105795 bytes .../contrib/glossaries/samples/samplePeople.pdf | Bin 50000 -> 50000 bytes .../latex/contrib/glossaries/samples/sampleSec.pdf | Bin 69922 -> 69922 bytes .../contrib/glossaries/samples/sampleSort.pdf | Bin 102149 -> 101397 bytes .../contrib/glossaries/samples/sampleaccsupp.pdf | Bin 86117 -> 86117 bytes .../contrib/glossaries/samples/sampleacronyms.pdf | Bin 39707 -> 39707 bytes .../contrib/glossaries/samples/sampletree.pdf | Bin 72397 -> 72397 bytes .../contrib/glossaries/samples/sampleutf8.pdf | Bin 47778 -> 47778 bytes .../latex/contrib/glossaries/samples/samplexdy.pdf | Bin 144709 -> 144075 bytes .../contrib/glossaries/samples/samplexdy2.pdf | Bin 73171 -> 73171 bytes .../contrib/glossaries/samples/samplexdy3.pdf | Bin 191382 -> 190743 bytes macros/latex/contrib/incgraph/CHANGES | 62 - macros/latex/contrib/incgraph/CHANGES.md | 138 + macros/latex/contrib/incgraph/README | 52 - macros/latex/contrib/incgraph/README.md | 55 + macros/latex/contrib/incgraph/incgraph-doc.sty | 140 + .../latex/contrib/incgraph/incgraph-example-a.pdf | Bin 317031 -> 317493 bytes .../latex/contrib/incgraph/incgraph-example-b.pdf | Bin 327514 -> 328766 bytes .../latex/contrib/incgraph/incgraph-example-c.pdf | Bin 320045 -> 320763 bytes macros/latex/contrib/incgraph/incgraph.pdf | Bin 994963 -> 1023673 bytes macros/latex/contrib/incgraph/incgraph.sty | 492 +- macros/latex/contrib/incgraph/incgraph.tex | 419 +- macros/latex/contrib/unicodefonttable/README.md | 29 + macros/latex/contrib/unicodefonttable/TODO.md | 20 + macros/latex/contrib/unicodefonttable/changes.txt | 20 + .../latex/contrib/unicodefonttable/l3doc-TUB.cls | 2306 ++ .../unicodefonttable/unicodefonttable-code.pdf | Bin 0 -> 890196 bytes .../unicodefonttable/unicodefonttable-code.tex | 4 + .../unicodefonttable/unicodefonttable-doc.pdf | Bin 0 -> 707853 bytes .../unicodefonttable/unicodefonttable-doc.tex | 6 + .../unicodefonttable/unicodefonttable-samples.pdf | Bin 0 -> 742559 bytes .../contrib/unicodefonttable/unicodefonttable.dtx | 2295 ++ .../contrib/unicodefonttable/unicodefonttable.ins | 72 + macros/luatex/latex/unitipa/README.txt | 9 - macros/luatex/latex/unitipa/unitipa.dtx | 524 - macros/luatex/latex/unitipa/unitipa.ins | 47 - macros/luatex/latex/unitipa/unitipa.pdf | Bin 191655 -> 0 bytes macros/unicodetex/latex/fontsetup/README | 2 +- .../latex/fontsetup/doc/fontsetup-doc.pdf | Bin 445344 -> 446355 bytes .../latex/fontsetup/doc/fontsetup-doc.tex | 9 +- macros/unicodetex/latex/fontsetup/fontsetup.sty | 31 +- macros/unicodetex/latex/fontsetup/fspdefault.sty | 2 + .../unicodetex/latex/fontsetup/fspolddefault.sty | 2 + 101 files changed, 21541 insertions(+), 16379 deletions(-) delete mode 100644 macros/latex/contrib/incgraph/CHANGES create mode 100644 macros/latex/contrib/incgraph/CHANGES.md delete mode 100644 macros/latex/contrib/incgraph/README create mode 100644 macros/latex/contrib/incgraph/README.md create mode 100644 macros/latex/contrib/incgraph/incgraph-doc.sty create mode 100644 macros/latex/contrib/unicodefonttable/README.md create mode 100644 macros/latex/contrib/unicodefonttable/TODO.md create mode 100644 macros/latex/contrib/unicodefonttable/changes.txt create mode 100644 macros/latex/contrib/unicodefonttable/l3doc-TUB.cls create mode 100644 macros/latex/contrib/unicodefonttable/unicodefonttable-code.pdf create mode 100644 macros/latex/contrib/unicodefonttable/unicodefonttable-code.tex create mode 100644 macros/latex/contrib/unicodefonttable/unicodefonttable-doc.pdf create mode 100644 macros/latex/contrib/unicodefonttable/unicodefonttable-doc.tex create mode 100644 macros/latex/contrib/unicodefonttable/unicodefonttable-samples.pdf create mode 100644 macros/latex/contrib/unicodefonttable/unicodefonttable.dtx create mode 100644 macros/latex/contrib/unicodefonttable/unicodefonttable.ins delete mode 100644 macros/luatex/latex/unitipa/README.txt delete mode 100644 macros/luatex/latex/unitipa/unitipa.dtx delete mode 100644 macros/luatex/latex/unitipa/unitipa.ins delete mode 100644 macros/luatex/latex/unitipa/unitipa.pdf (limited to 'macros') diff --git a/macros/latex/contrib/easybook/easybook.dtx b/macros/latex/contrib/easybook/easybook.dtx index eed7155bee..d1a50adb6b 100644 --- a/macros/latex/contrib/easybook/easybook.dtx +++ b/macros/latex/contrib/easybook/easybook.dtx @@ -15,7 +15,7 @@ %<*class> \NeedsTeXFormat{LaTeX2e}[2020/10/01] \RequirePackage{l3keys2e} -\ProvidesExplClass{easybook}{2021/10/18}{1.3P} +\ProvidesExplClass{easybook}{2021/10/20}{1.3S} {Typeset Chinese theses or books} \bool_set_false:N \l__eb_compile_draft_bool @@ -319,7 +319,7 @@ %<*package> \NeedsTeXFormat{LaTeX2e}[2020/10/01] \RequirePackage{l3keys2e,etoolbox} -\ProvidesExplPackage{easybase}{2021/10/18}{1.3P} +\ProvidesExplPackage{easybase}{2021/10/20}{1.3S} {Typeset Chinese theses or books} \cs_generate_variant:Nn \dim_set:Nn { NV } @@ -339,11 +339,6 @@ \seq_set_from_clist:Nn \l_tmpa_seq {#1} \seq_map_inline:Nn \l_tmpa_seq {#2} } -\cs_new_protected:Npn \eb_clist_map_function:nN #1#2 - { - \seq_set_from_clist:Nn \l_tmpb_seq {#1} - \seq_map_function:NN \l_tmpb_seq #2 - } \cs_new_protected:Npn \eb_char_patch_cmd:nnn #1#2#3 { \ExplSyntaxOn\makeatletter @@ -676,7 +671,7 @@ \cs_gset_eq:NN \easyhead \fancyhead \cs_gset_eq:NN \easyfoot \fancyfoot \NewDocumentCommand{\markrule} - {O{\textwidth}D(){ctex@frame}m>{\SplitArgument{1}{!}}O{}} + {O{\textwidth}D(){ctex@frame}m>{\SplitArgument{1}{|}}O{}} {\eb_draw_markrule:nnnnn {#1} {#2} {#3} #4} \cs_new_protected:Npn \eb_draw_markrule:nnnnn #1#2#3#4#5 { @@ -724,7 +719,7 @@ footrule .initial:n = { }, footnoterule .tl_gset:N = \footnoterule, footnoterule .initial:n = - { \markrule[0.35\textwidth]{\l__eb_rule_width_dim}[!2.6pt] } + { \markrule[0.35\textwidth]{\l__eb_rule_width_dim}[|2.6pt] } } \cs_set_eq:NN \eb_mark_uppercase:n \text_uppercase:n @@ -937,7 +932,6 @@ { \eb_fnmark_short_label_set:nn {#1} { thefootnote } }, fnboth-num .meta:n = { fntext-num = #1,fnmark-num = #1 }, fnboth-num .initial:n = plain, - unknown .code:n = \eb_msg_unknown_option:n { hdrset } } @@ -1107,7 +1101,7 @@ } } -\ProvideDocumentCommand{\super}{od()mo}{\textsuperscript{#3}} +\ProvideDocumentCommand{\super}{omo}{\textsuperscript{#3}} \providecommand{\spbset}{\use_none:n} \NewDocumentCommand{\eb@fnmark@super}{sm} { @@ -1115,12 +1109,21 @@ {\super[\l__eb_fntext_vshift_tl]{#2}[0pt]} { \super[\l__eb_fnmark_vshift_tl] - (\l__eb_fnmate_format_tl){#2} + {\l__eb_fnmate_format_tl{#2}} [\l__eb_fnmark_hshift_tl] } } \cs_new_protected:Npn \eb_fnmark_format_initial: { + \bool_if:NTF \l__eb_normal_footnote_bool + { + \bool_if:NT \l__eb_fnmate_format_match_bool + { \tl_clear:N \l__eb_fnmate_format_tl } + } + { + \bool_if:NT \l__eb_fncust_format_match_bool + { \tl_clear:N \l__eb_fnmate_format_tl } + } \bool_if:NF \l__eb_fnmate_format_match_bool { \spbset{super-format = { }} } \tl_use:N \l__eb_subfont_footnote_tl @@ -1128,23 +1131,11 @@ \bool_set_true:N \l__eb_normal_footnote_bool \bool_new:N \l__eb_fnmate_format_match_bool \bool_new:N \l__eb_fncust_format_match_bool -\cs_new_protected:Npn \eb_fn_format_if_match:T #1 - { - \bool_if:NTF \l__eb_normal_footnote_bool - { \bool_if:NT \l__eb_fnmate_format_match_bool {#1} } - { \bool_if:NT \l__eb_fncust_format_match_bool {#1} } - } -\cs_new_protected:Npn \eb_fn_set_eq_format: - { - \tl_set_eq:NN - \l__eb_fnmate_format_tl \l__spb_super_script_formati_tl - } \cs_set:Npn \@makefnmark { \hbox:n { \eb_fnmark_format_initial: - \eb_fn_format_if_match:T { \eb_fn_set_eq_format: } \tl_if_eq:NnTF \@mpfn { footnote } { \eb@fnmark@super{\eb@thefnmark} } { \eb@fnmark@super{\@thefnmark} } @@ -1155,14 +1146,12 @@ \hbox:n { \eb_fnmark_format_initial: - \tl_use:N \l__eb_fnmark_before_tl - \tl_if_eq:NnTF \l__eb_fntext_position_tl { super } + \tl_if_eq:NnT \l__eb_fntext_position_tl { super } + { \eb@fnmark@super* } { - \eb_fn_format_if_match:T { \tl_clear:N \l__eb_fnmate_format_tl } - \eb@fnmark@super* + \tl_use:N \l__eb_fnmark_before_tl + {\l__eb_fnmate_format_tl{\@thefnmark}} } - { \eb_fn_format_if_match:T { \eb_fn_set_eq_format: } } - {\l__eb_fnmate_format_tl{\@thefnmark}} \tl_use:N \l__eb_fnmark_after_tl } } @@ -2481,7 +2470,7 @@ } % %<*tcolorbox> -\ProvidesExplFile{eb-tcolorbox.cfg}{2021/10/18}{1.3P} +\ProvidesExplFile{eb-tcolorbox.cfg}{2021/10/20}{1.3S} {Customization of tcolorbox for easybook} \tl_gset:Nn \eb@tc@line@skip { 0.5\baselineskip } diff --git a/macros/latex/contrib/easybook/easybook.pdf b/macros/latex/contrib/easybook/easybook.pdf index fb49ff7e2f..3bfd5d6790 100644 Binary files a/macros/latex/contrib/easybook/easybook.pdf and b/macros/latex/contrib/easybook/easybook.pdf differ diff --git a/macros/latex/contrib/easybook/easybook.tex b/macros/latex/contrib/easybook/easybook.tex index 8e26df50a9..07274eeb2c 100644 --- a/macros/latex/contrib/easybook/easybook.tex +++ b/macros/latex/contrib/easybook/easybook.tex @@ -20,8 +20,8 @@ name = easybook, color-scheme = blue, title = EASYBOOK 使用手册, - version = v1.3P, - date = 2021/10/18, + version = v1.3S, + date = 2021/10/20, authors = 瞿毅, info = 排版简体中文学位论文和书籍, email = q1jx@foxmail.com, @@ -75,7 +75,7 @@ \newsplitarg{\splitoarg}{[}{]} \newsplitarg{\splitdarg}{(}{)} \newsplitarg{\splitmarg}{\{}{\}} -\newcommand{\spemmeta}{\splitmeta[\code{!}]} +\newcommand{\spemmeta}{\splitmeta[\code{|}]} \newsplitarg[\spemmeta]{\spemcoarg}{[}{]} \renewcommand{\cnltx@package@abstract@width}{0.85\linewidth} \newcommand{\noitemsep}{\setlength{\itemsep}{0ex}} @@ -123,7 +123,7 @@ \begin{document} -\section{使用说明} +\section{准备开始} 您在使用 \cls*{easybook} 文档类编写文档前可能需要满足以下的条件: \begin{itemize} \item 使用 \hologo{XeLaTeX}(推荐)或 \hologo{LuaLaTeX} 两种编译方式。 @@ -187,8 +187,8 @@ 文档主题方案选项 \option{scheme} 扩展了 C\TeX 文档类中同名选项原有的作用范围,选项值 \code{plain} 可使各类标题变为英文形式。包括章节标题、图表标题和定理名等。 \opt{enmode}\Default! 同时开启 \option{newline} 和 \keyis-{scheme}{plain} 选项以符合英文原生风格。 - \keychoice{scheme}{a4paper,b5paper,c5paper,letterpaper,其它纸张}\Default{a4paper} - 页眉尺寸选项将参数交给 \pkg*{geometry} 宏包处理,可使用它支持的所有纸张规格。建议选项值 \code{b5paper} 和 \keyis*-{zihao}{5},选项值 \code{a4paper} 和 \keyis*-{zihao}{-4} 配合。 + \keychoice{paper}{a4paper,b5paper,c5paper,letterpaper,other paper}\Default{a4paper} + 文档页面尺寸选项将参数交给 \pkg*{geometry} 宏包处理,可使用它支持的所有纸张规格。建议选项值 \code{b5paper} 和 \keyis*-{zihao}{5},选项值 \code{a4paper} 和 \keyis*-{zihao}{-4} 配合。 \keyval-{config}{配置文件名}\Default 选项 \option{config} 载入用户配置文件,最好放在当前路径且需带有文件扩展名如 \code{tex}、\code{def} 和 \code{cfg}。 \keybool{floatpage}\Default{true} @@ -680,7 +680,7 @@ \begin{commands} \command{markrule}[\oarg{长度}\darg{颜色名}\marg{线宽}\spemcoarg{上间距,下间距}] - 命令 \cs{markrule} 既可在 \meta{横线命令} 中用于绘制页眉页脚横线,也可以在正文中使用。\meta{长度} 默认为页面文本区的宽度,上下间距为横线与上下方部件的间距,带有长度单位,上下间距之间用 \code{!} 号分开,若只有一部分则表示 \meta{上间距}。下面举一个设置页眉内容的例子: + 命令 \cs{markrule} 既可在 \meta{横线命令} 中用于绘制页眉页脚横线,也可以在正文中使用。\meta{长度} 默认为页面文本区的宽度,上下间距为横线与上下方部件的间距,带有长度单位,上下间距之间用 \code{|} 符号分开,若只有一部分则表示 \meta{上间距}。下面举一个设置页眉内容的例子: \begin{ctexexam} \hdrset { @@ -690,7 +690,7 @@ \easyhead[OL]{\rightmark} \easyhead[EL,OR]{\textbf{\thepage}} }, - headrule = \markrule(DarkOrchid){0.5pt}[2pt!2pt] + headrule = \markrule(DarkOrchid){0.5pt}[2pt|2pt] } \end{ctexexam} \end{commands} diff --git a/macros/latex/contrib/glossaries/CHANGES b/macros/latex/contrib/glossaries/CHANGES index 95fcef16c5..8e3787453b 100644 --- a/macros/latex/contrib/glossaries/CHANGES +++ b/macros/latex/contrib/glossaries/CHANGES @@ -1,5 +1,25 @@ glossaries change log: +v4.48 (2021-10-19): + + * glossary-list.sty: + + - bug fix #186: list style with entrycounter has problematic unexpanded content + https://www.dickimaw-books.com/bugtracker.php?key=186 + + This bug fix adds the following new commands: + + \glslistinit + \glslistexpandedname + + * glossaries.sty: + + - new command \glsunexpandedfieldvalue (provided for use in + \glslistexpandedname) + + - new command \glscapitalisewords (defaults to \capitalisewords) + provides a way to switch to \capitalisefmtwords if required + v4.47 (2021-09-20): * added new files containing dummy entries for testing: @@ -51,7 +71,7 @@ v4.47 (2021-09-20): event that the sort value contains commands like \| or \! with sanitizesort=true) - - bug file #177 https://www.dickimaw-books.com/bugtracker.php?key=177 + - bug fix #177 https://www.dickimaw-books.com/bugtracker.php?key=177 (spurious \glolist@ at the end of glslabels file with writeglslabels option) - new package option 'writeglslabelnames' diff --git a/macros/latex/contrib/glossaries/README.md b/macros/latex/contrib/glossaries/README.md index aa4dddd044..502378c9ff 100644 --- a/macros/latex/contrib/glossaries/README.md +++ b/macros/latex/contrib/glossaries/README.md @@ -1,4 +1,4 @@ -# glossaries v4.47 (2021-09-20) +# glossaries v4.48 (2021-10-19) Author: Nicola Talbot ([contact](http://www.dickimaw-books.com/contact)) diff --git a/macros/latex/contrib/glossaries/glossaries-code.pdf b/macros/latex/contrib/glossaries/glossaries-code.pdf index 4cdb4e8dbc..17be975db3 100644 Binary files a/macros/latex/contrib/glossaries/glossaries-code.pdf and b/macros/latex/contrib/glossaries/glossaries-code.pdf differ diff --git a/macros/latex/contrib/glossaries/glossaries-user.html b/macros/latex/contrib/glossaries/glossaries-user.html index e046b89f54..9fb5ff0ba1 100644 --- a/macros/latex/contrib/glossaries/glossaries-user.html +++ b/macros/latex/contrib/glossaries/glossaries-user.html @@ -101,7 +101,6 @@ img.math{vertical-align:middle;} div.par-math-display, div.math-display{text-align:center;} li p.indent { text-indent: 0em } li p:first-child{ margin-top:0em; } -li p:first-child{ margin-bottom; } li p:last-child, li div:last-child { margin-bottom:0.5em; } li p:first-child{ margin-bottom:0; } li p~ul:last-child, li p~ol:last-child{ margin-bottom:0.5em; } @@ -155,6 +154,7 @@ table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } .hline hr, .cline hr{ height : 0px; margin:0px; } .hline td, .cline td{ padding: 0; } .hline hr, .cline hr{border:none;border-top:1px solid black;} +.hline {border-top: 1px solid black;} .tabbing-right {text-align:right;} div.float, div.figure {margin-left: auto; margin-right: auto;} div.float img {text-align:center;} @@ -216,6 +216,7 @@ table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } .hline hr, .cline hr{ height : 0px; margin:0px; } .hline td, .cline td{ padding: 0; } .hline hr, .cline hr{border:none;border-top:1px solid black;} +.hline {border-top: 1px solid black;} div.array {text-align:center;} .alltt P { margin-bottom : 0em; margin-top : 0em; } .alltt { margin-bottom : 1em; margin-top : 1em; font-family:monospace,monospace; } @@ -1339,7 +1340,7 @@ span#textcolor3{color:#008080} >

User Manual for glossaries.sty v4.47 +class="cmr-17">User Manual for glossaries.sty v4.48

dickimaw-books.com/contact

2021-09-20

+class="cmr-12">2021-10-19

@@ -1408,7 +1409,7 @@ class="cmtt-10">glossaries-french or glossaries-german. If a language module is required, the glossaries package will automatically try to load it and will give a warning if the module isn’t found. See §1.3 §1.4 Multi-Lingual Support for further details. If there isn’t any support available for your language, use the nolangwarnglossaries-code.pdf

Advanced users wishing to know more about the inner workings of all the packages provided in the glossaries bundle should read “Documented Code for glossaries v4.47”. +class="cmss-10">glossaries bundle should read “Documented Code for glossaries v4.48”.

“Upgrading from the glossary package to t id="x1-1000">Contents

Glossary +href="#glossary">Glossary
1 Introduction
 1.1 Indexing Options +href="#sec:rollback" id="QQ2-1-6">Rollback
 1.2 Dummy Entries for Testing +href="#sec:indexingoptions" id="QQ2-1-7">Indexing Options
 1.3 Multi-Lingual Support -
  1.3.1 Changing the Fixed Names -
  1.3.2 Creating a New Language Module +href="#sec:lipsum" id="QQ2-1-15">Dummy Entries for Testing
 1.4 Generating the Associated Glossary Files +href="#sec:languages" id="QQ2-1-16">Multi-Lingual Support
  1.4.1 Using the makeglossaries Perl Script +href="#sec:fixednames" id="QQ2-1-17">Changing the Fixed Names
  1.4.2 Using the makeglossaries-lite Lua Script -
  1.4.3 Using xindy explicitly (Option3) -
  1.4.4 Using makeindex explicitly (Option2) +href="#sec:newlang" id="QQ2-1-19">Creating a New Language Module
 1.5 Note to Front-End and Script Developers +href="#sec:makeglossaries" id="QQ2-1-20">Generating the Associated Glossary Files
  1.5.1 MakeIndex and Xindy +href="#sec:makeglossariesapp" id="QQ2-1-22">Using the makeglossaries Perl Script
  1.5.2 Entry Labels +href="#sec:makeglossarieslua" id="QQ2-1-23">Using the makeglossaries-lite Lua Script
  1.5.3 Bib2Gls +href="#sec:xindyapp" id="QQ2-1-24">Using xindy explicitly (Option 3) +
  1.5.4 Using makeindex explicitly (Option 2) +
 1.6 Note to Front-End and Script Developers +
  1.6.1 MakeIndex and Xindy +
  1.6.2 Entry Labels +
  1.6.3 Bib2Gls
2 Package Options +href="#sec:pkgopts" id="QQ2-1-30">Package Options
 2.1 General Options +href="#sec:pkgopts-general" id="QQ2-1-31">General Options
 2.2 Sectioning, Headings and TOC Options +href="#sec:pkgopts-sec" id="QQ2-1-44">Sectioning, Headings and TOC Options
 2.3 Glossary Appearance Options +href="#sec:pkgopts-printglos" id="QQ2-1-50">Glossary Appearance Options
 2.4 Indexing Options +href="#sec:pkgopts-indexing" id="QQ2-1-67">Indexing Options
 2.5 Sorting Options +href="#sec:pkgopts-sort" id="QQ2-1-77">Sorting Options
 2.6 Glossary Type Options +href="#sec:pkgopts-type" id="QQ2-1-88">Glossary Type Options
 2.7 Acronym and Abbreviation Options +href="#sec:pkgopts-acronym" id="QQ2-1-95">Acronym and Abbreviation Options
 2.8 Deprecated Acronym Style Options +href="#sec:pkgopts-old-acronym" id="QQ2-1-101">Deprecated Acronym Style Options
 2.9 Other Options +href="#sec:pkgopts-other" id="QQ2-1-107">Other Options
 2.10 Setting Options After the Package is Loaded +href="#sec:setupglossaries" id="QQ2-1-114">Setting Options After the Package is Loaded
3 Setting Up +href="#sec:setup" id="QQ2-1-115">Setting Up
 3.1 Option 1 +href="#sec:setupopt1" id="QQ2-1-116">Option 1
 3.2 Options 2 and 3 +href="#sec:setupopt23" id="QQ2-1-117">Options 2 and 3
4 Defining Glossary Entries +href="#sec:newglosentry" id="QQ2-1-118">Defining Glossary Entries
 4.1 Plurals +href="#sec:plurals" id="QQ2-1-119">Plurals
 4.2 Other Grammatical Constructs +href="#sec:grammar" id="QQ2-1-120">Other Grammatical Constructs
 4.3 Additional Keys -
  4.3.1 Document Keys +href="#sec:addkey" id="QQ2-1-121">Additional Keys +
  4.3.1 Document Keys
  4.3.2 Storage Keys +href="#sec:glsaddstoragekey" id="QQ2-1-123">Storage Keys
 4.4 Expansion +href="#sec:expansion" id="QQ2-1-124">Expansion
 4.5 Sub-Entries +href="#sec:subentries" id="QQ2-1-126">Sub-Entries
  4.5.1 Hierarchical Categories +href="#sec:hierarchical" id="QQ2-1-127">Hierarchical Categories
  4.5.2 Homographs +href="#sec:homographs" id="QQ2-1-128">Homographs
 4.6 Loading Entries From a File +href="#sec:loadglsentries" id="QQ2-1-129">Loading Entries From a File
 4.7 Moving Entries to Another Glossary +href="#sec:moveentry" id="QQ2-1-130">Moving Entries to Another Glossary
 4.8 Drawbacks With Defining Entries in the Document Environment +href="#sec:docdefs" id="QQ2-1-131">Drawbacks With Defining Entries in the Document Environment
  4.8.1 Technical Issues +href="#sec:techissues" id="QQ2-1-132">Technical Issues
  4.8.2 Good Practice Issues +href="#sec:goodpractice" id="QQ2-1-133">Good Practice Issues
5 Referencing Entries in the Document +href="#sec:usingentries" id="QQ2-1-134">Referencing Entries in the Document
 5.1 Links to Glossary Entries +href="#sec:glslink" id="QQ2-1-135">Links to Glossary Entries
  5.1.1 The The \gls-Like Commands (First Use Flag Queried)
  5.1.2 The The \glstext-Like Commands (First Use Flag Not Queried)
  5.1.3 Changing the format of the link text +href="#sec:glsdisplay" id="QQ2-1-139">Changing the format of the link text
  5.1.4 Enabling and disabling hyperlinks to glossary entries +href="#sec:disablehyperlinks" id="QQ2-1-140">Enabling and disabling hyperlinks to glossary entries
 5.2 Using Glossary Terms Without Links +href="#sec:glsnolink" id="QQ2-1-141">Using Glossary Terms Without Links
6 Acronyms and Other Abbreviations +href="#sec:acronyms" id="QQ2-1-142">Acronyms and Other Abbreviations
 6.1 Displaying the Long, Short and Full Forms (Independent of First Use) +href="#sec:longshortfull" id="QQ2-1-143">Displaying the Long, Short and Full Forms (Independent of First Use)
 6.2 Changing the Acronym Style +href="#sec:setacronymstyle" id="QQ2-1-145">Changing the Acronym Style
  6.2.1 Predefined Acronym Styles +href="#sec:predefinedacrstyles" id="QQ2-1-146">Predefined Acronym Styles
  6.2.2 Defining A Custom Acronym Style +href="#sec:customacronym" id="QQ2-1-147">Defining A Custom Acronym Style
 6.3 Displaying the List of Acronyms +href="#sec:disploa" id="QQ2-1-148">Displaying the List of Acronyms
 6.4 Upgrading From the glossary Package +href="#sec:oldacronym" id="QQ2-1-149">Upgrading From the glossary Package
7 Unsetting and Resetting Entry Flags +href="#sec:glsunset" id="QQ2-1-151">Unsetting and Resetting Entry Flags
 7.1 Counting the Number of Times an Entry has been Used (First Use Flag Unset) +href="#sec:enableentrycount" id="QQ2-1-152">Counting the Number of Times an Entry has been Used (First Use Flag Unset)
8 Displaying a Glossary +href="#sec:printglossary" id="QQ2-1-153">Displaying a Glossary
9 Defining New Glossaries +href="#sec:newglossary" id="QQ2-1-154">Defining New Glossaries
10 Adding an Entry to the Glossary Without Generating Text +href="#sec:glsadd" id="QQ2-1-155">Adding an Entry to the Glossary Without Generating Text
11 Cross-Referencing Entries +href="#sec:crossref" id="QQ2-1-156">Cross-Referencing Entries
 11.1 Customising Cross-reference Text +href="#sec:customxr" id="QQ2-1-157">Customising Cross-reference Text
12 Number Lists +href="#sec:numberlists" id="QQ2-1-158">Number Lists
 12.1 Encap Values (Location Formats) +href="#sec:encap" id="QQ2-1-159">Encap Values (Location Formats)
 12.2 Locations +href="#sec:locationsyntax" id="QQ2-1-160">Locations
 12.3 Range Formations +href="#sec:ranges" id="QQ2-1-161">Range Formations
 12.4 Style Hook +href="#sec:isthook" id="QQ2-1-162">Style Hook
13 Glossary Styles +href="#sec:styles" id="QQ2-1-163">Glossary Styles
 13.1 Predefined Styles +href="#sec:predefinedstyles" id="QQ2-1-164">Predefined Styles
  13.1.1 List Styles +href="#sec:liststyles" id="QQ2-1-166">List Styles
  13.1.2 Longtable Styles +href="#sec:longstyles" id="QQ2-1-167">Longtable Styles
  13.1.3 Longtable Styles (Ragged Right) +href="#sec:longraggedstyles" id="QQ2-1-168">Longtable Styles (Ragged Right)
  13.1.4 Longtable Styles (Longtable Styles (booktabs)
  13.1.5 Supertabular Styles +href="#sec:superstyles" id="QQ2-1-170">Supertabular Styles
  13.1.6 Supertabular Styles (Ragged Right) +href="#sec:superraggedstyles" id="QQ2-1-171">Supertabular Styles (Ragged Right)
  13.1.7 Tree-Like Styles -
  13.1.8 Multicols Style +href="#sec:treestyles" id="QQ2-1-172">Tree-Like Styles +
  13.1.8 Multicols Style
  13.1.9 In-Line Style +href="#sec:inline" id="QQ2-1-175">In-Line Style
 13.2 Defining your own glossary style +href="#sec:newglossarystyle" id="QQ2-1-176">Defining your own glossary style
14 Xindy (Option 3) +href="#sec:xindy" id="QQ2-1-177">Xindy (Option 3)
 14.1 Language and Encodings +href="#sec:langenc" id="QQ2-1-178">Language and Encodings
 14.2 Locations and Number lists +href="#sec:xindyloc" id="QQ2-1-179">Locations and Number lists
 14.3 Glossary Groups +href="#sec:groups" id="QQ2-1-180">Glossary Groups
15 Utilities +href="#sec:utilities" id="QQ2-1-181">Utilities
 15.1 Loops +href="#sec:loops" id="QQ2-1-182">Loops
 15.2 Conditionals +href="#sec:conditionals" id="QQ2-1-183">Conditionals
 15.3 Fetching and Updating the Value of a Field +href="#sec:fetchset" id="QQ2-1-184">Fetching and Updating the Value of a Field
16 Prefixes or Determiners +href="#sec:prefix" id="QQ2-1-185">Prefixes or Determiners
17 Accessibility Support +href="#sec:accsupp" id="QQ2-1-186">Accessibility Support
18 Sample Documents +href="#sec:samples" id="QQ2-1-187">Sample Documents
 18.1 Basic +href="#sec:samplesbasic" id="QQ2-1-188">Basic
 18.2 Acronyms and First Use +href="#sec:sampleacronyms" id="QQ2-1-191">Acronyms and First Use
 18.3 Non-Page Locations +href="#sec:samplecounter" id="QQ2-1-201">Non-Page Locations
 18.4 Multiple Glossaries +href="#sec:samplestype" id="QQ2-1-205">Multiple Glossaries
 18.5 Sorting +href="#sec:samplessort" id="QQ2-1-210">Sorting
 18.6 Child Entries +href="#sec:samplesparent" id="QQ2-1-213">Child Entries
 18.7 Cross-Referencing +href="#sec:samplescrossref" id="QQ2-1-217">Cross-Referencing
 18.8 Custom Keys +href="#sec:samplescustomkeys" id="QQ2-1-219">Custom Keys
 18.9 Xindy (Option 3) +href="#sec:samplesxindy" id="QQ2-1-224">Xindy (Option 3)
 18.10 No Indexing Application (Option 1) +href="#sec:samplesnoidx" id="QQ2-1-229">No Indexing Application (Option 1)
 18.11 Other +href="#sec:samplesother" id="QQ2-1-232">Other
19 Troubleshooting +href="#sec:trouble" id="QQ2-1-241">Troubleshooting
@@ -1877,7 +1880,7 @@ href="#tab:mcols">Multicolumn Styles

+ id="glossary">

@@ -1934,13 +1937,13 @@ class="cmtt-10">glossaries}

-

+

bib2gls

-



An indexing application that combines two functions in one: (1) fetches entry definition from a bibglossaries package. See Option 4.

-

+

Command Line Interface (CLI)

-



An application that doesn’t have a graphical user interface. That is, an application that doesn’t have any windows, buttons or menus and can be run in a command prompt or terminal.

-

+

convertgls2bib

-



An application provided with bib2glsbib2gls

-

+

Entry location

-



The location of the entry in the document. This defaults to the page number on which the entry appears. An entry may have multiple locations.

-

+

Extended Latin Alphabet

-



An alphabet consisting of Latin characters and extended Latin characters.

-

+

Extended Latin Character

-



A character that’s created by combining Latin characters to form ligatures (e.g. æ) or by applying @@ -2049,13 +2052,13 @@ href="#glo:nonlatinchar">non-Latin character.

-

+

First use

-



The first time a glossary entry is used (from the start of the document or after a reset) with one of the following commands: \glsfirst use href="#glo:firstusetext">first use text.)

-

+

First use flag

-



A conditional that determines whether or not the entry has been used according to the rules of first use. Commands to unset or reset this conditional are described in §??sec:glsunset 7 Unsetting and Resetting Entry Flags.

-

+

First use text

-



The text that is displayed on first use, which is governed by the first\defglsentry.)

-

+

glossaries-extra

-



A separate package that extends the glossaries package, providing new features or improving existing features. If you want to use \gls

-

+

makeglossaries

-



A custom designed Perl script interface to xindymakeglossaries script into an class="cmtt-10">makeglossaries.exe for convenience (but Perl is still required).

-

+

makeglossariesgui

-



A Java GUI alternative to makeglossariesmakeglossariesCTAN.

-

+

makeglossaries-lite

-



A custom designed Lua script interface to xindymakeglossaries-lite.lua script.

-

+

makeindex

-



An indexing application. See Option 2.

-

+

Non-Latin AlphabetNon-Latin Alphabet -



An alphabet consisting of
non-Latin characters.

-

+

Non-Latin Character

-



An extended Latin character or a character that isn’t a Latin character.

-

+

Number list

-



A list of entry locations (also called a location list). The number list can be suppressed using the nonumberlist package option.

-

+

Sanitize

-



Converts command names into character sequences. That is, a command called, say, \foo, is converted into the sequence of characters: o, o. Depending on the font, the backslash character may appear as a dash when used in the main document text, so \foo will appear as: —foo. -

Earlier versions of

Earlier versions of glossaries used this technique to write information to the files used by the indexing applications to prevent problems caused by fragile commands. Now, this is only used for the sortsort

-

+

Small caps

-



Small capitals. The LaTeX kernel provides \textsc

-

+

Standard LaTeX Extended Latin Character

-



An extended Latin character that can be created by a core LaTeX command, such as \o (ø) or class="cmtt-10">\’e (é). That is, the character can be produced without the need to load a particular package.

-

+

UTF-8

-



A variable-width character encoding. This means that some characters are represented by more that one byte. XeLaTeX and LuaLaTeX treat the multi-byte sequence as a single token, but the older LaTeX formats have single-byte tokens, which causes complications. Related blog article: @@ -2401,13 +2404,13 @@ class="newline" />A variable-width character encoding. This means that some char href="https://www.dickimaw-books.com/blog/binary-files-text-files-and-file-encodings/" >Binary Files, Text Files and File Encodings.

-

+

xindy

-



A flexible indexing application with multilingual support written in Perl. See Option 3.
Option 5).

  • §??sec:indexingoptions 1.2 Indexing Options lists the available indexing options.

  • §??sec:lipsum 1.3 Dummy Entries for Testing lists the dummy glossary files that may be used for testing.

  • §??sec:languages 1.4 Multi-Lingual Support provides information for users who wish to write in a language other than English.

  • §??sec:makeglossaries 1.5 Generating the Associated Glossary Files describes how to use an indexing application to create the sorted glossaries for your document (Options 3).

  • There are some sample documents provided with this package. They are described in §??sec:samples 18 Sample Documents.

    Top

    1.1 Rollback

    +

    There is one rollback release: v4.46 (2020-03-19) for glossaries.sty and glossary-list.sty. The other associated +packages haven’t been changed since that release (apart from the version numbers, which are always updated for +each new release, regardless of whether or not the file has otherwise been changed). If you rollback to v4.46 +using: + + +

    +
    +\usepackage{glossaries}[=v4.46]
    +
    +

    then the 4.46 version of glossary-list.sty will automatically be loaded. If you use nostyles and subsequently load +glossary-list you will also need to add the rollback version: + + +

    +
    +\usepackage[nostyles]{glossaries}[=v4.46]
    +\usepackage{glossary-list}[=v4.46]
    +
    +

    If you rollback using latexrelease to an earlier date, then you will need to specify v4.46 for glossaries as there are +no earlier rollback versions available. +

    +

    +

    Top

    1.2 Indexing Options

    -

    The basic idea behind the

    The basic idea behind the glossaries package is that you first define your entries (terms, symbols or abbreviations). Then you can reference these within your document (like \cite or 4 and 5) as well as an option for standalone descriptions within the document body (Option 6). -

    An overview of Options 

    An overview of Options 15 is given in table ??tab:options. 1.1. Option 6 is omitted from the table as it doesn’t produce a list. For a more detailed comparison of the various methods, see the glossaries performance page. -

    If you are developing a class or package that loads

    If you are developing a class or package that loads glossaries, I recommend that you don’t force the user into a particular indexing method by adding an unconditional \makeglossaries @@ -2793,11 +2834,9 @@ means that they’re unable to use any commands that must come before \makeglossaries (such as \newglossary) and they can’t switch off the indexing whilst working on a draft document. - -
    -

    -

    Strictly speaking, Options 

    +

    Strictly speaking, Options 5 and 6 aren’t actually indexing options as no indexing is performed. In the case of -


    Table 1.1: Glossary Options: Pros and Cons
    +class="content">Glossary Options: Pros and Cons
    +class="tcrm-0900">¶

    OptionOption 5

    Requires

    Requires an @@ -2891,7 +2930,7 @@ class="td10">

    Requires Perl?

    Requires Java?

    Can sort @@ -2954,7 +2993,7 @@ class="pzdr-">✔

    N/A

    Efficient sort @@ -2971,7 +3010,7 @@ class="pzdr-">✔

    N/A

    Can use @@ -3002,7 +3041,7 @@ class="pzdr-">✔

    N/A

    Any problematic @@ -3023,7 +3062,7 @@ class="pzdr-">✘

    Are entries @@ -3058,7 +3097,7 @@ class="td10">

    Can automatically @@ -3086,7 +3125,7 @@ class="td10">

    Can have @@ -3113,10 +3152,10 @@ class="td11">

    Maximum hierarchical @@ -3136,9 +3175,9 @@ class="td10">

    \glsdisplaynumberlist + id="dx1-6002"> reliable?

    \newglossaryentry + id="dx1-6003"> allowed in document + id="dx1-6004"> environment?

    Requires additional @@ -3204,7 +3243,7 @@ class="pzdr-">✘

    Default value @@ -3212,7 +3251,7 @@ class="cmr-9">value class="cmr-9">of sanitizesort + id="dx1-6006"> package

    -

    ______________________________________________________________________________________ -

    ______________________________________________________________________________________ +

    * Strips standard LaTeX accents (that is, accents generated by core LaTeX commands) so, for example, \AA is treated the same as A. -

    Only with the hybrid method provided with glossaries-extra. -

    Provided sort=none is used. -

    § Entries with the same sort value are merged. -

    Requires some setting up. -

    The locations must be set explicitly through the custom location field provided by glossaries-extra. -

    # Unlimited but unreliable. -

    Entries are defined in bib format. \newglossaryentry should not be used explicitly. -

    Provided docdef=true or docdef=restricted but not recommended. -

    Provided docdef=false or docdef=restricted. -

    Irrelevant with sort=none. (The record=only option automatically switches this on.) @@ -3326,23 +3365,23 @@ class="cmr-8">option automatically switches this on.)


    + id="x1-6017r1">

    🔗🔗Option 1 (TeX)

    -

    This option isn’t generally recommended for reasons given below. Example Document: +

    This option isn’t generally recommended for reasons given below. Example Document:

    -
    +   
     \documentclass{article}
     \usepackage{glossaries}
     
    -

    +

    \makenoidxglossaries % use TeX sort
    -
    +   
     \newglossaryentry{sample}{name={sample},
       description={an example}}
     \begin{document}
     \gls{sample}.
     
    -

    +

    \printnoidxglossary + id="dx1-7002">
    \end{document}
    You can place all your entry definitions in a separate file and load it in the preamble with \loadglsentries + id="dx1-7003"> (after \makenoidxglossaries). -

    This option doesn’t require an external ). +

    This option doesn’t require an external indexing application but, with the default alphabetic sorting, it’s very slow with severe limitations. If you want a sorted list, it doesn’t work well for extended Latin alphabets or @@ -3384,7 +3423,7 @@ the sanitizesort=false package option (the default for Option 1) then the package option (the default for Option 1) then the standard LaTeX accent commands will be ignored, so if an entry’s name is set to {\’e}lite then the sort value will default to @@ -3393,12 +3432,12 @@ class="cmtt-10">elite if sanitizesort=false is used and will default to is used and will default to \’elite if sanitizesort=true is used. If you + id="dx1-7007"> is used. If you have any other kinds of commands that don’t expand to ASCII characters, such as \alpha or \si, then you must use sanitizesort=true or change the sort method ( or change the sort method (sort=use or or sort=def) in the + id="dx1-7010">) in the package options or explicitly set the sort key when you define the relevant entries. For example: + id="dx1-7011"> key when you define the relevant entries. For example:

    \newglossaryentry{alpha}{name={\ensuremath{\alpha}},
     sort={alpha},description={...}}
    -

    The

    The glossaries-extra package has a modified symbols package option that provides package option that provides \glsxtrnewsymbol, which + id="dx1-7014">, which automatically sets the sort key to the entry label (instead of the key to the entry label (instead of the name).
    -

    -

    This option works best with the ).

    +

    +

    This option works best with the sort=def or or sort=use setting. For any other setting, be prepared for a long + id="dx1-7018"> setting. For any other setting, be prepared for a long document build time, especially if you have a lot of entries defined. This option is intended as a last resort for alphabetical sorting. This option allows a mixture of sort methods. (For example, sorting by word order for one glossary and order of use for another.) This option is not suitable for hierarchical glossaries and does not form ranges in the number lists. If you really can’t use an s. If you really can’t use an indexing application consider using Option 5 instead. -

    Summary: +

    Summary:

    1. -

      Add + class="enumerate" id="x1-7021x1"> +

      Add

      -
      +     
            \makenoidxglossaries
       
      -

      to your preamble (before you start defining your entries, as described in

      to your preamble (before you start defining your entries, as described in §??sec:newglosentry 4 Defining Glossary Entries).

    2. -

      Put + class="enumerate" id="x1-7023x2"> +

      Put

      -
      +     
            \printnoidxglossary
       
      -

      where you want your list of entries to appear (described in

      where you want your list of entries to appear (described in §??sec:printglossary 8 Displaying a Glossary). Alternatively, to display all glossaries use the iterative command:

      -
      +     
            \printnoidxglossaries
       
      -

      +

    3. -

      Run LaTeX twice on your document. (As you would do to make a table of contents appear.) For example, + class="enumerate" id="x1-7025x3"> +

      Run LaTeX twice on your document. (As you would do to make a table of contents appear.) For example, click twice on the “typeset” or “build” or “PDFLaTeX” button in your editor.

    -

    + id="x1-7026r2"> +

    🔗🔗Option 2 (makeindex)

    -

    Example document: +

    Example document:

    -
    +   
     \documentclass{article}
     \usepackage{glossaries}
     
    -

    +

    \makeglossaries % open glossary files
    -
    +   
     \newglossaryentry{sample}{name={sample},
      description={an example}}
     \begin{document}
     \gls{sample}.
     
    -

    +

    \printglossary + id="dx1-8002">
    \end{document}
    You can place all your entry definitions in a separate file and load it in the preamble with \loadglsentries + id="dx1-8003"> (after \makeglossaries). -

    This option uses a ). +

    This option uses a CLI application called makeindex to sort the entries. This application comes with all + id="dx1-8005"> to sort the entries. This application comes with all modern TeX distributions, but it’s hard-coded for the non-extended Latin alphabet. It can’t correctly sort + id="dx1-8006">. It can’t correctly sort accent commands (such as \’ or \c) and fails with UTF-8 character (as it separates the octets resulting in a making LaTeX write the glossary information to a temporary file which makeindex reads. Then reads. Then makeindex + id="dx1-8008"> writes a new file containing the code to typeset the glossary. Then \printglossary reads this file in on the next run. -

    This option works best if you want to sort entries according to the English alphabet and you don’t want to +

    This option works best if you want to sort entries according to the English alphabet and you don’t want to install Perl or Java. This method can also work with the restricted shell escape since makeindex is considered a + id="dx1-8009"> is considered a trusted application. (So you should be able to use the automake package option provided the shell escape hasn’t + id="dx1-8010"> package option provided the shell escape hasn’t been completely disabled.) -

    This method can form ranges in the

    This method can form ranges in the number list but only accepts limited number formats: but only accepts limited number formats: \arabic, \roman, \Roman, \alph and \Alph. -

    This option does not allow a mixture of sort methods. All glossaries must be sorted according to the same +

    This option does not allow a mixture of sort methods. All glossaries must be sorted according to the same method: word/letter ordering or order of use or order of definition. If you need word ordering for one glossary and letter ordering for another you’ll have to explicitly call makeindex for each glossary + id="dx1-8012"> for each glossary type. -

    The

    The glossaries-extra package allows a hybrid mix of Options 1 and glossaries-extra alternative to sampleSort.tex in §??sec:samplessort 18.5 Sorting.
    -

    -

    Summary: +

    +

    Summary:

    1. -

      If you want to use +

      If you want to use makeindex’s ’s -g option you must change the quote character using option you must change the quote character using \GlsSetQuote. For + id="dx1-8017">. For example:

      -
      +     
            \GlsSetQuote{+}
       
      -

      This must be used before

      This must be used before \makeglossaries. Note that if you are using babel, the shorthands aren’t + id="dx1-8018">, the shorthands aren’t enabled until the start of the document, so you won’t be able to use the shorthands in definitions made in the preamble.

    2. -

      Add + class="enumerate" id="x1-8020x2"> +

      Add

      -
      +     
            \makeglossaries
       
      -

      to your preamble (before you start defining your entries, as described in

      to your preamble (before you start defining your entries, as described in §??sec:newglosentry 4 Defining Glossary Entries).

    3. -

      Put + class="enumerate" id="x1-8022x3"> +

      Put

      -
      +     
            \printglossary
       
      -

      where you want your list of entries to appear (described in

      where you want your list of entries to appear (described in §??sec:printglossary 8 Displaying a Glossary). Alternatively, to display all glossaries use the iterative command:

      -
      +     
            \printglossaries
       
      -

      +

    4. -

      Run LaTeX on your document. This creates files with the extensions +

      Run LaTeX on your document. This creates files with the extensions glo and and ist (for example, if your + id="dx1-8026"> (for example, if your LaTeX document is called myDoc.tex, then you’ll have two extra files called myDoc.glo and @@ -3704,25 +3743,25 @@ class="cmtt-10">myDoc.ist). If you look at your document at this point, y href="#glo:glossaries-extra">glossaries-extra you’ll see the section heading and some boilerplate text.) -

      If you have used package options such as

      If you have used package options such as symbols there will also be other sets of files corresponding to the + id="dx1-8027"> there will also be other sets of files corresponding to the extra glossaries that were created by those options.

    5. -

      🔗 Run +

      🔗 Run makeindex with the with the .glo file as the input file and the .ist file as the style so that it creates an output file with the extension .gls. If you have access to a terminal or a command prompt (for example, the MSDOS command prompt for Windows users or the bash console for Unix-like users) then you need to run the command: -

      
      +     

      
            
      makeindex -s myDoc.ist -o myDoc.gls myDoc.glo

      @@ -3730,35 +3769,35 @@ class="cmtt-10">.gls. If you have access to a terminal or a command promp class="cmtt-10">myDoc with the base name of your LaTeX document file. Avoid spaces in the file name if possible. The $ symbol indicates the command prompt and should be omitted.) -

      The file extensions vary according to the glossary

      The file extensions vary according to the glossary type. See . See §??sec:makeindexapp 1.5.4 Using makeindex + id="dx1-8032"> explicitly (Option 2) for further details. makeindex must be called for each set of files.
      -

      -

      If you don’t know how to use the command prompt, then you can probably access must be called for each set of files.

      +

      +

      If you don’t know how to use the command prompt, then you can probably access makeindex via your + id="dx1-8034"> via your text editor, but each editor has a different method of doing this. See Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build for some examples. -

      Alternatively, run

      Alternatively, run makeindex indirectly via the indirectly via the makeglossaries script: -

      
      + id="dx1-8036"> script:
      +     

      
                                                                                             
                                                                                             
            
      makeglossaries myDoc @@ -3767,21 +3806,21 @@ class="cmtt-10">makeglossaries
      makeglossaries with + id="dx1-8037"> with makeglossaries-lite if you don’t have Perl installed.) This will pick up all the file extensions + id="dx1-8038"> if you don’t have Perl installed.) This will pick up all the file extensions from the aux file and run file and run makeindex the appropriate number of times with all the necessary + id="dx1-8040"> the appropriate number of times with all the necessary switches. -

      The simplest approach is to use

      The simplest approach is to use arara and add the following comment lines to the start of your document: + id="dx1-8041"> and add the following comment lines to the start of your document:

       pdflatex class="cmtt-10">makeglossaries with makeglossarieslite in the second line above if you don’t have Perl installed. Note that there’s no hyphen in this case.) -

      The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to +

      The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to add the -l switch: -

      
      + id="dx1-8042"> switch:
      +     

      
            
      makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo

      (See §??sec:makeindexapp 1.5.4 Using makeindex explicitly (Option 2) for further details on using explicitly (Option 2) for further details on using makeindex + id="dx1-8044"> explicitly.) If you use makeglossaries or or makeglossaries-lite then use the then use the order=letter package option + id="dx1-8047"> package option and the -l option will be added automatically. + id="dx1-8048"> option will be added automatically.

    6. -

      🔗 Once you have successfully completed the previous step, you can now run LaTeX on your document + class="enumerate" id="x1-8050x6"> +

      🔗 Once you have successfully completed the previous step, you can now run LaTeX on your document again.

    -

    You’ll need to repeat the last step if you have used the

    You’ll need to repeat the last step if you have used the toc option (unless you’re using option (unless you’re using glossaries-extra) to ensure the section heading is added to the table of contents. You’ll also need to repeat steps 5 and 6 if you have any +href="#x1-80285">5 and 6 if you have any cross-references which can’t be indexed until the glossary file has been created. + id="x1-8052r3"> -

    +

    🔗🔗Option 3 (xindy)

    -

    Example document:

    +

    Example document:

    \documentclass{article} @@ -3867,7 +3906,7 @@ class="cmtt-10">xindy]{glossaries}
    \makeglossaries % open glossary files
    -
    +   
     \newglossaryentry{sample}{name={sample},
      description={an example}}
     \begin{document}
     \gls{sample}.
     
    -

    +

    \printglossary + id="dx1-9002">
    \end{document}
    You can place all your entry definitions in a separate file and load it in the preamble with \loadglsentries + id="dx1-9003"> (after \makeglossaries). -

    This option uses a ). +

    This option uses a CLI application called xindy to sort the entries. This application is more flexible than + id="dx1-9005"> to sort the entries. This application is more flexible than makeindex and is able to sort extended Latin alphabets or non-Latin alphabets, however it does still have some limitations. -

    The

    The xindy application comes with both TeX Live and MiKTeX, but since application comes with both TeX Live and MiKTeX, but since xindy is a Perl script, you will + id="dx1-9007"> is a Perl script, you will also need to install Perl, if you don’t already have it. In a similar way to Option 2, this option involves making LaTeX write the glossary information to a temporary file which xindy reads. Then reads. Then xindy writes a new file + id="dx1-9009"> writes a new file containing the code to typeset the glossary. Then \printglossary reads this file in on the next run. -

    This is the best option with just the base

    This is the best option with just the base glossaries package if you want to sort according to a language other than English or if you want non-standard location lists, but it can require some setting up (see §??sec:xindy 14 Xindy (Option 3)). There are some problems with certain sort values:

    • -

      entries with the same sort value are merged by

      entries with the same sort value are merged by xindy into a single glossary line so you must make + id="dx1-9010"> into a single glossary line so you must make sure that each entry has a unique sort value;

    • -

      xindy forbids empty sort values; + id="dx1-9011"> forbids empty sort values;

    • -

      xindy automatically strips control sequences, the math-shift character automatically strips control sequences, the math-shift character $ and braces {} from the sort value, which is usually desired but this can cause the sort value to collapse to an empty string which xindy forbids.

    -

    In these problematic cases, you must set the forbids.

    +

    In these problematic cases, you must set the sort field explicitly. For example:

    + id="dx1-9014"> field explicitly. For example:

    @@ -3970,22 +4009,22 @@ class="cmtt-10">sort={alpha},description={...}}
    -

    The

    The glossaries-extra package has a modified symbols package option that provides package option that provides \glsxtrnewsymbol, which + id="dx1-9016">, which automatically sets the sort key to the entry label (instead of the key to the entry label (instead of the name).
    -

    -

    All glossaries must be sorted according to the same method (word/letter ordering, order of use, or order of + id="dx1-9018">).

    +

    +

    All glossaries must be sorted according to the same method (word/letter ordering, order of use, or order of definition). -

    The

    The glossaries-extra package allows a hybrid mix of Options 1 and Option 1. See the glossaries-extra documentation for further details.
    -

    -

    Summary: +

    +

    Summary:

    1. -

      Add the +

      Add the xindy option to the option to the glossaries package option list:

      -
      +     
            \usepackage[xindy]{glossaries}
       
      -

      If you are using a non-Latin script you’ll also need to either switch off the creation of the number +

      If you are using a non-Latin script you’ll also need to either switch off the creation of the number group:

      -
      +     
            \usepackage[xindy={glsnumbers=false}]{glossaries}
       
      -

      or use either

      or use either \GlsSetXdyFirstLetterAfterDigits{letter} (to indicate the first letter group to follow the @@ -4029,25 +4068,25 @@ class="cmti-10">spec⟩} to indicate where the number group should be placed (see §??sec:xindy 14 Xindy (Option 3)).

    2. -

      Add +

      Add \makeglossaries to your preamble (before you start defining your entries, as described in §??sec:newglosentry 4 Defining Glossary Entries).

    3. -

      Run LaTeX on your document. This creates files with the extensions +

      Run LaTeX on your document. This creates files with the extensions glo and and xdy (for example, if your + id="dx1-9027"> (for example, if your LaTeX document is called myDoc.tex, then you’ll have two extra files called myDoc.glo and myDoc.xdy). href="#glo:glossaries-extra">glossaries-extra extension package, you’ll see the section header and some boilerplate text.) -

      If you have used package options such as

      If you have used package options such as symbols there will also be other sets of files corresponding to the + id="dx1-9028"> there will also be other sets of files corresponding to the extra glossaries that were created by those options.

    4. -

      Run +

      Run xindy with the with the .glo file as the input file and the .xdy file as a module so that it creates an output file with the extension .gls. You also need to set the language name and input en access to a terminal or a command prompt (for example, the MSDOS command prompt for Windows users or the bash console for Unix-like users) then you need to run the command (all on one line): -

      
      +     

      
            
      xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo

      @@ -4086,78 +4125,78 @@ class="cmtt-10">english with the name of your language and utf8 with your input encoding, for example, -L german -C din5007-utf8.) -

      The file extensions vary according to the glossary

      The file extensions vary according to the glossary type. See . See §??sec:xindyapp 1.5.3 Using xindy explicitly + id="dx1-9035"> explicitly (Option 3) for further details. xindy must be called for each set of files.
      -

      -

      It’s much simpler to use must be called for each set of files.

      +

      +

      It’s much simpler to use makeglossaries instead: -

      
      + id="dx1-9037"> instead:
      +     

      
            
      makeglossaries myDoc

      Note that the file extension isn’t supplied in this case. This will pick up all the file extensions from the aux + id="dx1-9038"> file and run xindy the appropriate number of times with all the necessary switches. -

      There’s no benefit in using the appropriate number of times with all the necessary switches. +

      There’s no benefit in using makeglossaries-lite with with xindy. (Remember that . (Remember that xindy is a Perl + id="dx1-9042"> is a Perl script so if you can use xindy then you can also use then you can also use makeglossaries, and if you don’t want + id="dx1-9044">, and if you don’t want to use makeglossaries because you don’t want to install Perl, then you can’t use because you don’t want to install Perl, then you can’t use xindy + id="dx1-9046"> either.) -

      If you don’t know how to use the command prompt, then you can probably access

      If you don’t know how to use the command prompt, then you can probably access xindy or + id="dx1-9047"> or makeglossaries via your text editor, but each editor has a different method of doing this. See + id="dx1-9048"> via your text editor, but each editor has a different method of doing this. See Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build for some examples. -

      Again, a convenient method is to use

      Again, a convenient method is to use arara and add the follow comment lines to the start of your document:

      @@ -4175,57 +4214,57 @@ class="cmtt-10"> arara: pdflatex
      -

      The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to +

      The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to add the order=letter package option: + id="dx1-9049"> package option:

      -
      +     
            \usepackage[xindy,order=letter]{glossaries}
       
      -

      (and return to the previous step). This option is picked up by

      (and return to the previous step). This option is picked up by makeglossaries. If you are explicitly using + id="dx1-9050">. If you are explicitly using xindy then you’ll need to add then you’ll need to add -M ord/letorder to the options list. See §??sec:xindyapp 1.5.3 Using xindy + id="dx1-9052"> explicitly (Option 3) for further details on using xindy explicitly. + id="dx1-9053"> explicitly.

    5. -

      Once you have successfully completed the previous step, you can now run LaTeX on your document + class="enumerate" id="x1-9055x5"> +

      Once you have successfully completed the previous step, you can now run LaTeX on your document again. As with makeindex ( (Option 2), you may need to repeat the previous step and this step to ensure the table of contents and cross-references are resolved.

    -

    + id="x1-9057r4"> +

    🔗🔗Option 4 (bib2gls)

    -



    glossaries-extraThis option is only available with the glossaries-extra extension package. This method uses bib2gls to both fetch entry definitions from to both fetch entry definitions from bib files and to hierarchically sort and collate. -

    Example document:

    + id="dx1-10002"> files and to hierarchically sort and collate. +

    Example document:

    \documentclass{article} @@ -4246,10 +4285,10 @@ class="cmtt-10">record=nameref]{glossaries-extra}
    \GlsXtrLoadResources[src={entries}]
    \begin{document} @@ -4259,7 +4298,7 @@ class="cmtt-10"> \gls{alpha},
     \gls{html}.
    \printunsrtglossary + id="dx1-10005">
    \end{document}
    @@ -4270,7 +4309,7 @@ class="cmtt-10">entries.bib contains:
    @entry{sample,
      example} class="cmtt-10">}

    @symbol{alpha,
      description={...} class="cmtt-10">}

    @abbreviation{html,
      language} class="cmtt-10">}
    -

    All entries must be provided in one or more

    All entries must be provided in one or more bib files. See the files. See the bib2gls user manual for the required + id="dx1-10010"> user manual for the required format. -

    Note that the

    Note that the sort key should not be used. Each entry type ( key should not be used. Each entry type (@entry, , @symbol, , @abbreviation) + id="dx1-10014">) has a particular field that’s used for the sort value by default (name, the label, , the label, short). You will + id="dx1-10016">). You will break this mechanism if you explicitly use the sort key. See key. See bib2gls gallery: sorting for examples.
    -

    -

    The

    +

    The glossaries-extra package needs to be loaded with the record package option:

    + id="dx1-10018"> package option:

    \usepackage[glossaries-extra v1.37 and bib2gls v1.8):
    + id="dx1-10019"> v1.8):
    \usepackage[]{glossaries-extra} class="cmss-10">record=nameref option is the best method. -

    (It’s possible to use a hybrid of this method and Options  option is the best method. +

    (It’s possible to use a hybrid of this method and Options 2 or 3 with record=hybrid but in general there is + id="dx1-10021"> but in general there is little need for this and it complicates the build process.) -

    Each resource set is loaded with

    Each resource set is loaded with \GlsXtrLoadResources[options]. For example:

    @@ -4391,7 +4430,7 @@ class="cmtt-10">]. For example:

    \GlsXtrLoadResources + id="dx1-10023">
    [% definitions entries2.bib:
     src={entries1,entries2},
     sort={de-CH-1996}% sort according]
    The bib files are identified as a comma-separated list in the value of the files are identified as a comma-separated list in the value of the src key. The key. The sort option identifies the + id="dx1-10028"> option identifies the sorting method. This may be a locale identifier for alphabetic sorting, but there are other sort methods available, such as character code or numeric. One resource set may cover multiple glossaries or one glossary may be split across multiple resource sets, forming logical sub-blocks. -

    If you want to ensure that all entries are selected, even if they haven’t been referenced in the document, then +

    If you want to ensure that all entries are selected, even if they haven’t been referenced in the document, then add the option selection=all. (There are also ways of filtering the selection or you can even have a + id="dx1-10029">. (There are also ways of filtering the selection or you can even have a random selection by shuffling and truncating the list. See the bib2gls user manual for further + id="dx1-10030"> user manual for further details.) -

    The glossary is displayed using:

    +

    The glossary is displayed using:

    \printunsrtglossary + id="dx1-10031">
    Alternatively all glossaries can be displayed using the iterative command:
    \printunsrtglossaries + id="dx1-10032">
    The document is built using: -

    
    +

    
        
    pdflatex myDoc
    bib2gls myDoc
    pdflatex myDoc @@ -4458,14 +4497,14 @@ class="cmtt-10">\printunsrtglossaries
    If letter groups are required, you need the --group switch: -

    
    + id="dx1-10033"> switch:
    +

    
        
    bib2gls --group myDoc

    or with arara:

    + id="dx1-10034">:

    % }
    (You will also need an appropriate glossary style.) -

    Unlike Options 

    Unlike Options 2 and 3, this method doesn’t create a file containing the typeset glossary but simply determines which entries are needed for the document, their associated locations and (if required) their @@ -4488,59 +4527,59 @@ one glossary and order of use for another or even sorting one block of the gloss the same glossary. See bib2gls gallery: sorting. -

    This method supports Unicode and uses the Common Locale Data Repository, which provides more extensive language support +

    This method supports Unicode and uses the Common Locale Data Repository, which provides more extensive language support than xindy..1.2 The + id="x1-10036f2"> The locations in the number list may be in any format. If may be in any format. If bib2gls can deduce a numerical value it will attempt to + id="dx1-10039"> can deduce a numerical value it will attempt to form ranges otherwise it will simply list the locations. -

    Summary: +

    Summary:

    1. -

      Use +

      Use glossaries-extra with the p=recordackage option: + id="dx1-10042">ackage option:

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

      +

    2. -

      Use +

      Use \*GlsXtrLoadResources to identify the bib file(s) and file(s) and bib2gls options: + id="dx1-10046"> options:

      -
      +     
            \GlsXtrLoadResources[src={terms.bib,abbreviations.bib},sort=en]
       
      -

      +

    3. -

      Put

      + class="enumerate" id="x1-10048x3"> +

      Put

      \*printunsrtglossary @@ -4554,52 +4593,52 @@ class="cmtt-10">\*printunsrtglossaries
    4. -

      Run LaTeX on your document. + class="enumerate" id="x1-10050x4"> +

      Run LaTeX on your document.

    5. -

      Run +

      Run bib2gls with just the document base name. + id="dx1-10053"> with just the document base name.

    6. -

      Run LaTeX on your document. + class="enumerate" id="x1-10055x6"> +

      Run LaTeX on your document.

    -

    See

    See glossaries-extra and bib2gls: An Introductory Guide or the bib2gls user manual for further details of + id="dx1-10056"> user manual for further details of this method, and also Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build. -

    + id="x1-10057r5"> +

    🔗🔗Option 5 (no sorting)

    -



    glossaries-extraThis option is only available with the extension package glossaries-extra. No indexing application is required. -

    Example document: +

    Example document:

    -
    +   
     \documentclass{article}
     \usepackage[sort=none]{glossaries-extra}
     \newglossaryentry{sample}{name={sample},
    @@ -4609,20 +4648,20 @@ is required.
     \begin{document}
     \gls{sample}.
     
    -

    +

    \printunsrtglossary + id="dx1-11001">
    \end{document}
    -

    This method is best used with the package option

    This method is best used with the package option sort=none (as shown above). There’s no “activation” + id="dx1-11002"> (as shown above). There’s no “activation” command (such as \makeglossaries for Options 2 and UTF-8 letter groups. -

    All entries must be defined before the glossary is displayed (preferably in the preamble) in the +

    All entries must be defined before the glossary is displayed (preferably in the preamble) in the required order, and child entries must be defined immediately after their parent entry if they must be kept together in the glossary. (Some glossary styles indent entries that have a parent but it’s the \loadglsentries. -

    The glossary is displayed using:

    + id="dx1-11003">. +

    The glossary is displayed using:

    \printunsrtglossary + id="dx1-11004">
    Alternatively all glossaries can be displayed using the iterative command:
    \printunsrtglossaries + id="dx1-11005">
    @@ -4659,61 +4698,61 @@ class="cmtt-10">\printunsrtglossariesall defined entries, regardless of whether or not they have been used in the document. The number lists have to be set explicitly otherwise they won’t appear. Note that this uses the same command for + id="dx1-11006">s have to be set explicitly otherwise they won’t appear. Note that this uses the same command for displaying the glossary as Option 4. This is because bib2gls takes advantage of this method by defining the + id="dx1-11007"> takes advantage of this method by defining the wanted entries in the required order and setting the locations (and letter group information, if required). -

    Therefore, the above example document has a glossary containing the entries: sample and

    Therefore, the above example document has a glossary containing the entries: sample and α (in that order). Note that the alpha entry has been included even though it wasn’t referenced in the document. -

    This just requires a single LaTeX call: -

    
    +

    This just requires a single LaTeX call: +

    
        
    pdflatex myDoc

    unless the glossary needs to appear in the table of contents, in which case a second run is required: -

    
    +

    
        
    pdflatex myDoc
    pdflatex myDoc

    (Naturally if the document also contains citations, and so on, then additional steps are required. Similarly for all the other options above.) -

    See the

    See the glossaries-extra documentation for further details of this method. -

    + id="x1-11008r6"> +

    🔗🔗Option 6 (standalone)

    -



    glossaries-extraThis option is only available with the glossaries-extra extension package.1.3 + id="x1-12001f3"> Instead of creating a list, this has standalone definitions throughout the document. The entry name may or may not be in a section heading. -

    You can either define entries in the document preamble (or in an external file loaded with

    You can either define entries in the document preamble (or in an external file loaded with \loadglsentries), as + id="dx1-12004">), as with Option 5, for example:

    -
    +   
     \documentclass{article}
     \usepackage[colorlinks]{hyperref}
     \usepackage[sort=none,
    @@ -4729,7 +4768,7 @@ href="#option5">Option 5, for example:
       symbol={\ensuremath{f(x)}}
     }
     
    -

    +

    \newcommand*{\termdef}[1]{% @@ -4737,15 +4776,15 @@ class="cmtt-10">\newcommand*{\termdef}[1]{% class="cmtt-10">  \section{\glsxtrglossentry{#1} \glsentrysymbol{#1}}%
      \begin{quote}\em\Glsentrydesc{#1}.\end{quote}%
    } @@ -4753,7 +4792,7 @@ class="cmtt-10">}
    -
    +   
     \begin{document}
     \tableofcontents
     \section{Introduction}
    @@ -4764,10 +4803,10 @@ More detailed information about \glspl{set} w
     More detailed information about \glspl{function} with examples.
     \end{document}
     
    -

    Or you can use

    Or you can use bib2gls if you want to manage a large database of terms. For example (requires if you want to manage a large database of terms. For example (requires glossaries-extra v1.42, see below):

    @@ -4797,16 +4836,16 @@ class="cmtt-10"> ]{glossaries-extra}

    \GlsXtrLoadResources[src=terms,sort=none,save-locations=false]

    \newcommand*{\termdef}[1]{% class="cmtt-10"> 
     \section{\glsxtrglossentry{#1} \glossentrysymbol{#1}}%
      \glsadd{#1}% <- index entry
      \begin{quote}\em\Glsentrydesc{#1}.\end{quote}%
    } @@ -4841,7 +4880,7 @@ class="cmtt-10">}
    -
    +   
     \begin{document}
     \tableofcontents
     \section{Introduction}
    @@ -4852,12 +4891,12 @@ More detailed information about \glspl{set} w
     More detailed information about \glspl{function} with examples.
     \end{document}
     
    -

    Where the file

    Where the file terms.bib contains:

    @entry{set,
      symbol={\ensuremath{\mathcal{S}}} class="cmtt-10">}

    @entry{function,
     }
    The advantage in this approach (with \loadglsentries or or bib2gls) is that you can use an existing database + id="dx1-12020">) is that you can use an existing database of entries shared across multiple documents, ensuring consistent notation for all of them. -

    In both cases, there’s no need to load all the glossary styles packages, as they’re not required, so I’ve used +

    In both cases, there’s no need to load all the glossary styles packages, as they’re not required, so I’ve used the nostyles package option to prevent them from being loaded. -

    In the first case, you need the package option to prevent them from being loaded. +

    In the first case, you need the sort=none package option (as in package option (as in Option 5) and then define the terms in the preamble. No external tool is required. Just run LaTeX as normal. (Twice to ensure that the table of contents is up to date.) -

    
    +

    
        
    pdflatex myDoc
    pdflatex myDoc

    -

    In the second case, you need the

    In the second case, you need the record package option (as in package option (as in Option 4) since bib2gls is needed to select the + id="dx1-12024"> is needed to select the required entries, but you don’t need a sorted list:

    \GlsXtrLoadResources[src={terms},sort=none]
    This will ensure that any entries indexed in the document (through commands like \gls or or \glsadd) will be + id="dx1-12028">) will be selected by bib2gls, but it will skip the sorting step. (The chances are you probably also won’t need location + id="dx1-12029">, but it will skip the sorting step. (The chances are you probably also won’t need location lists either. If so, you can add the option save-locations=false.) -

    Remember that for this second case you need to run .) +

    Remember that for this second case you need to run bib2gls as per as per Option 4: -

    
    +

    
        
    pdflatex myDoc
    bib2gls myDoc
    pdflatex myDoc
    pdflatex myDoc

    -

    For both cases (with or without

    For both cases (with or without bib2gls), instead of listing all the entries using ), instead of listing all the entries using \printunsrtglossary, you use \glsxtrglossentry{label} where you want the name (and anchor with hyperref) to appear in the + id="dx1-12034">) to appear in the document. This will allow the link text created by commands like created by commands like \gls to link to that point in the document. The description can simply be displayed with \glsentrydesc{label} or \Glsentrydesc{label}, as in the above @@ -5013,73 +5052,73 @@ examples. In both examples, I’ve defined a custom command \termdef to simplify the code and ensure consistency. Extra styling, such as placing the description in a coloured frame, can be added to this custom definition as required. -

    (Instead of using

    (Instead of using \glsentrydesc or \Glsentrydesc, you can use \glossentrydesc{label}, which will obey attributes such as glossdesc and and glossdescfont. See the . See the glossaries-extra manual for further details.) -

    The symbol (if required) can be displayed with either

    The symbol (if required) can be displayed with either \glsentrysymbol{label} or \glossentrysymbol + id="dx1-12042"> {label}. In the first example, I’ve used \glsentrysymbol. In the second I’ve used \glossentrysymbol. The + id="dx1-12043">. The latter is necessary with bib2gls if the symbol needs to go in a section title as the entries aren’t defined on the + id="dx1-12044"> if the symbol needs to go in a section title as the entries aren’t defined on the first LaTeX run. -

    In normal document text,

    In normal document text, \glsentrysymbol will silently do nothing if the entry hasn’t been defined, but when used in a section heading it will expand to an undefined internal command when written to the aux file, + id="dx1-12045"> file, which triggers an error. -

    The

    The \glossentrysymbol command performs an existence check, which triggers a warning if the entry is undefined. + id="dx1-12046"> command performs an existence check, which triggers a warning if the entry is undefined. (All entries will be undefined before the first bib2gls call.) You need at least call.) You need at least glossaries-extra v1.42 to use this command in a section title.1.4 + id="x1-12048f4"> If hyperref has been loaded, this will use has been loaded, this will use \texorpdfstring to allow a simple expansion for the PDF bookmarks + id="dx1-12050"> to allow a simple expansion for the PDF bookmarks (see the glossaries-extra user manual for further details). -

    If you want to test if the

    If you want to test if the symbol field has been set, you need to use field has been set, you need to use \ifglshassymbol outside of the section + id="dx1-12052"> outside of the section title. For example:

    @@ -5097,50 +5136,50 @@ class="cmtt-10">\glsxtrglossentry{#1}}}
    -

    In both of the above examples, the section titles start with a lowercase character (because the

    In both of the above examples, the section titles start with a lowercase character (because the name value is + id="dx1-12053"> value is all lowercase in entry definitions). You can apply automatic case-change with the glossname attribute. For + id="dx1-12054"> attribute. For example:

    \glssetcategoryattribute{general}{glossname}{firstuc}
    or (for title-case)
    \glssetcategoryattribute{general}{glossname}{title}
    However, this won’t apply the case-change in the table of contents or bookmarks. -

    In the second example, you can instead use

    In the second example, you can instead use bib2gls to apply a case-change:

    + id="dx1-12057"> to apply a case-change:

    \GlsXtrLoadResources[src=terms,
     sort=none,save-locations=false,
     replicate-fields={name=text},
     ]
    (Or name-case-change=title for title-case.) This copies the for title-case.) This copies the name value to the value to the text field and + id="dx1-12064"> field and then applies a case-change to the name field (leaving the field (leaving the text field unchanged). The name in the + id="dx1-12066"> field unchanged). The name in the section titles now starts with a capital but the link text produced by commands like produced by commands like \gls is still + id="dx1-12068"> is still lowercase. -

    In the first example (without

    In the first example (without bib2gls) you need to do this manually. For example:

    + id="dx1-12069">) you need to do this manually. For example:

    \newglossaryentry{set}{name={}
    -

    Note that if you use the default

    Note that if you use the default save-locations=true with with bib2gls, it’s possible to combine Options , it’s possible to combine Options 4 and 6 to have both standalone definitions and an index. Now I do need a glossary style. In this case I’m going to use bookindex, which is provided in the , which is provided in the glossary-bookindex package (bundled with package (bundled with glossaries-extra). I don’t need any of the other style packages, so I can still keep the nostyles option and just load option and just load glossary-bookindex: + id="dx1-12075">:

    ]{glossaries-extra}
    \GlsXtrLoadResources[src=terms,% definitions in terms.bib
     sort=en-GB,% sort by locale
     replicate-fields={name=text},
     ]
    \printunsrtglossary[title=Index,target=false]
    Note that I’ve had to switch off the hypertargets with target=false (otherwise there would be duplicate targets). If you want letter group headings you need to use the --group switch: -

    
    + id="dx1-12082"> switch:
    +

    
        
    bib2gls --group myDoc

    or if you are using arara:

    + id="dx1-12083">:

    % }
    -

    The

    The bookindex style doesn’t show the description, so only the name and location is displayed. Remember + id="dx1-12084"> style doesn’t show the description, so only the name and location is displayed. Remember that the name has had a case-conversion so it now starts with an initial capital. If you feel this is inappropriate for the index, you can adjust the bookindex style so that it uses the style so that it uses the text field instead. For example: + id="dx1-12086"> field instead. For example:

    \renewcommand*{\glsxtrbookindexname}[1]{%
      \glossentrynameother{#1}{text}}
    See the glossaries-extra user manual for further details about this style. -

    Note that on the first LaTeX run none of the entries will be defined. Once they are defined, the page +

    Note that on the first LaTeX run none of the entries will be defined. Once they are defined, the page numbers may shift due to the increased amount of document text. You may therefore need to repeat the document build to ensure the page numbers are correct. -

    If there are extra terms that need to be included in the index that don’t have a description, you can define +

    If there are extra terms that need to be included in the index that don’t have a description, you can define them with @index in the in the bib file. For example:

    + id="dx1-12090"> file. For example:

    @index{element}
    @index{member,alias={element}}
    They can be used in the document as usual: -
    +   
     The objects that make up a set are the \glspl{element}
     or \glspl{member}.
     
    -

    See

    See glossaries-extra and bib2gls: An Introductory Guide or the bib2gls user manual for further + id="dx1-12094"> user manual for further details. -

    The

    The glossaries package comes with a number of sample documents that illustrate the various functions. These are listed in §??sec:samples 18 Sample Documents. -

    +

    -

    Top

    1.2

    Top

    1.3 Dummy Entries for Testing

    -

    In addition to the sample files described above,

    In addition to the sample files described above, glossaries also provides some files containing lorum + id="dx1-13001"> also provides some files containing lorum ipsum dummy entries. These are provided for testing purposes and are on TeX’s path (in tex/latex/glossaries/test-entries) so they can be included via \input or or \loadglsentries. The + id="dx1-13003">. The glossaries-extra package provides bib versions of all these files for use with versions of all these files for use with bib2gls. The files are as + id="dx1-13005">. The files are as follows:

    -

    +

    example-glossaries-brief.tex

    -

    These entries all have brief descriptions. For example: +

    These entries all have brief descriptions. For example:

    -
    +     
          \newglossaryentry{lorem}{name={lorem},description={ipsum}}
     
    -

    +

    -

    +

    example-glossaries-long.tex

    -

    These entries all have long descriptions. For example: +

    These entries all have long descriptions. For example:

    -
    +     
          \newglossaryentry{loremipsum}{name={lorem ipsum},
          description={dolor sit amet, consectetuer adipiscing
          elit. Ut purus elit, vestibulum ut, placerat ac,
          adipiscing vitae, felis. Curabitur dictum gravida
          mauris.}}
     
    -

    +

    -

    +

    example-glossaries-multipar.tex

    -

    These entries all have multi-paragraph descriptions. For example: +

    These entries all have multi-paragraph descriptions. For example:

    -
    +     
          \longnewglossaryentry{loremi-ii}{name={lorem 1--2}}%
          {%
          Lorem ipsum ...
          Nam dui ligula...
          }
     
    -

    +

    -

    +

    example-glossaries-symbols.tex

    -

    These entries all use the

    These entries all use the symbol key. For example: + id="dx1-13006"> key. For example:

    -
    +     
          \newglossaryentry{alpha}{name={alpha},
          symbol={\ensuremath{\alpha}},
          description={Quisque ullamcorper placerat ipsum.}}
     
    -

    +

    -

    +

    example-glossaries-symbolnames.tex

    -

    Similar to the previous file but the

    Similar to the previous file but the symbol key isn’t used. Instead the symbol is stored in the key isn’t used. Instead the symbol is stored in the name key. + id="dx1-13008"> key. For example:

    -
    +     
          \newglossaryentry{sym.alpha}{sort={alpha},
          name={\ensuremath{\alpha}},
          description={Quisque ullamcorper placerat ipsum.}}
     
    -

    +

    -

    +

    example-glossaries-images.tex

    -

    These entries use the

    These entries use the user1 key to store the name of an image file. (The images are provided by the key to store the name of an image file. (The images are provided by the mwe + id="dx1-13010"> package and should be on TeX’s path.) One entry doesn’t have an associated image to help test for a missing key. The descriptions are long to allow for tests with the text wrapping around the image. For example:

    -
    +     
          \longnewglossaryentry{sedfeugiat}{name={sed feugiat},
          user1={example-image}}%
          {%
    @@ -5524,31 +5563,31 @@ class="cmss-10">mwe
    -     

    +

    -

    +

    example-glossaries-acronym.tex

    -

    These entries are all abbreviations. For example: +

    These entries are all abbreviations. For example:

    -
    +     
          \newacronym[type=\glsdefaulttype]{lid}{LID}{lorem ipsum
          dolor}
     
    -

    -

    If you use the

    +

    If you use the glossaries-extra extension package, then \newacronym is redefined to use is redefined to use \newabbreviation + id="dx1-13012"> with the category key set to key set to acronym (rather than the default abbreviation). This means that you need to set the abbreviation style for the acronym category. For example:

    -
    +     
          \setabbreviationstyle[acronym]{long-short}
     
    -

    -

    +

    +

    -

    +

    example-glossaries-acronym-desc.tex

    -

    This file contains entries that are all abbreviations that use the

    This file contains entries that are all abbreviations that use the description key. For example: + id="dx1-13014"> key. For example:

    -
    +     
          \newacronym[type=\glsdefaulttype,
            description={fringilla a, euismod sodales,
            sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula}
     
    -

    -

    If you use the

    +

    If you use the glossaries-extra extension package, then \newacronym is redefined to use is redefined to use \newabbreviation + id="dx1-13016"> with the category key set to key set to acronym (rather than the default abbreviation). This means that you need to set the abbreviation style for the acronym category. For example:

    -
    +     
          \setabbreviationstyle[acronym]{long-short-desc}
     
    -

    -

    +

    +

    -

    +

    example-glossaries-acronyms-lang.tex

    -

    These entries are all abbreviations, where some of them have a translation supplied in the

    These entries are all abbreviations, where some of them have a translation supplied in the user1 key. For + id="dx1-13018"> key. For example:

    -
    +     
          \newacronym[type=\glsdefaulttype,user1={love itself}]
           {li}{LI}{lorem ipsum}
     
    -

    -

    If you use the

    +

    If you use the glossaries-extra extension package, then \newacronym is redefined to use is redefined to use \newabbreviation + id="dx1-13020"> with the category key set to key set to acronym (rather than the default abbreviation). This means that you need to set the abbreviation style for the acronym category. For example:

    -
    +     
          \setabbreviationstyle[acronym]{long-short-user}
     
    -

    -

    +

    +

    -

    +

    example-glossaries-parent.tex

    -

    These are hierarchical entries where the child entries use the

    These are hierarchical entries where the child entries use the name key. For example: + id="dx1-13022"> key. For example:

    -
    +     
          \newglossaryentry{sedmattis}{name={sed mattis},
          description={erat sit amet}
          \newglossaryentry{gravida}{parent={sedmattis},
            name={gravida},description={malesuada}}
     
    -

    +

    -

    +

    example-glossaries-childnoname.tex

    -

    These are hierarchical entries where the child entries don’t use the

    These are hierarchical entries where the child entries don’t use the name key. For example: + id="dx1-13023"> key. For example:

    -
    +     
          \newglossaryentry{scelerisque}{name={scelerisque},
            description={at}}
          \newglossaryentry{vestibulum}{parent={scelerisque},
            description={eu, nulla}}
     
    -

    +

    -

    +

    example-glossaries-longchild.tex

    -

    (New to v4.47.) These entries all have long descriptions and there are some child entries. For +

    (New to v4.47.) These entries all have long descriptions and there are some child entries. For example:

    -
    +     
          \newglossaryentry{longsedmattis}{name={sed mattis},
           description={erat sit amet dolor sit amet, consectetuer adipiscing elit.
           Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis.
    @@ -5696,23 +5735,23 @@ class="description">
          senectus et netus et malesuada fames ac turpis egestas. Mauris ut
          leo.}}
     
    -

    +

    -

    +

    example-glossaries-childmultipar.tex

    -

    (New to v4.47.) This consists of parent entries with single paragraph descriptions and child entries with +

    (New to v4.47.) This consists of parent entries with single paragraph descriptions and child entries with multi-paragraph descriptions. Some entries have the user1 key set to the name of an image file provided + id="dx1-13024"> key set to the name of an image file provided by the mwe package. For example: + id="dx1-13025"> package. For example:

    -
    +     
          \newglossaryentry{hiersedmattis}{name={sed mattis},user1={example-image},
           description={Erat sit amet dolor sit amet, consectetuer adipiscing elit.
           Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis. Curabitur
    @@ -5727,75 +5766,75 @@ class="cmss-10">mwe
    -     

    +

    -

    +

    example-glossaries-cite.tex

    -

    These entries use the

    These entries use the user1 key to store a citation key (or comma-separated list of citation keys). The + id="dx1-13026"> key to store a citation key (or comma-separated list of citation keys). The citations are defined in xampl.bib, which should be available on all modern TeX distributions. One entry doesn’t have an associated citation to help test for a missing key. For example:

    -
    +     
          \newglossaryentry{fusce}{name={fusce},
          description={suscipit cursus sem},user1={article-minimal}}
     
    -

    +

    -

    +

    example-glossaries-url.tex

    -

    These entries use the

    These entries use the user1 key to store an URL associated with the entry. For example: + id="dx1-13027"> key to store an URL associated with the entry. For example:

    -
    +     
          \newglossaryentry{aenean-url}{name={aenean},
           description={adipiscing auctor est},
           user1={http://uk.tug.org/}}
     
    -

    -

    The sample file

    +

    The sample file glossary-lipsum-examples.tex in the doc/latex/glossaries/samples directory uses all these files. See also glossaries gallery. -



    glossaries-extraThe glossaries-extra package provides the additional test file:

    -

    +

    example-glossaries-xr.tex

    -

    These entries use the

    These entries use the see key provided by the base key provided by the base glossaries package and also the alias and and seealso + id="dx1-13030"> keys that require glossaries-extra. For example:

    -
    +     
          \newglossaryentry{alias-lorem}{name={alias-lorem},
           description={ipsum},alias={lorem}}
          \newglossaryentry{amet}{name={amet},description={consectetuer},
    @@ -5803,13 +5842,13 @@ class="cmss-10">glossaries-extra. For example:
          \newglossaryentry{arcu}{name={arcu},description={libero},
           seealso={placerat,vitae,curabitur}}
     
    -

    -

    +

    +

    -

    Top

    1.3

    Top

    1.4 Multi-Lingual Support

    -

    The

    The glossaries package uses the tracklang package to determine the document languages. Unfortunately, because there isn’t a standard language identification framework provided with LaTeX, Localisation with tracklang.tex for further details.
    -

    -

    As from version 1.17, the

    +

    As from version 1.17, the glossaries package can be used with xindy as well as as well as makeindex. If you are writing in a + id="dx1-14002">. If you are writing in a language that uses an extended Latin alphabet or non-Latin alphabet it’s best to use Option 3 (xindy) or + id="dx1-14003">) or Option 4 (bib2gls) as ) as makeindex ( (Option 2) is hard-coded for the non-extended Latin alphabet and and Option 1 can only perform limited ASCII comparisons. -

    This means that with Options 

    This means that with Options 3 or 4 you are not restricted to the A, …, Z letter groups. If you want to use xindy, remember to use the , remember to use the xindy package option. For example: + id="dx1-14008"> package option. For example:

    -
    +   
     \documentclass[french]{article}
     \usepackage[utf8]{inputenc}
     \usepackage[T1]{fontenc}
     \usepackage{babel}
     \usepackage[xindy]{glossaries}
     
    -

    If you want to use

    If you want to use bib2gls, you need to use the , you need to use the record option with option with glossaries-extra and supply the definitions in bib files. (See the files. (See the bib2gls user manual for further details.) -

    Note that although a  user manual for further details.) +

    Note that although a non-Latin character, such as é, looks like a plain character in your , such as é, looks like a plain character in your tex file, with + id="dx1-14014"> file, with standard LaTeX it’s actually a macro and can therefore cause expansion problems. You may need to switch off the field expansions with \glsnoexpandfields. This issue doesn’t occur with XeLaTeX or LuaLaTeX.
    -

    -

    With

    +

    With inputenc, if you use a , if you use a non-Latin character (or other expandable) character at the start of an entry + id="dx1-14016"> (or other expandable) character at the start of an entry name, you must place it in a group, or it will cause a problem for commands that convert the first letter to upper case (e.g. \Gls). For example:

    + id="dx1-14017">). For example:

    \newglossaryentry{elite}{name={{ class}}
    For further details, see the “UTF-8” section in the mfirstuc user manual. -

    If you are using user manual. +

    If you are using xindy or or bib2gls, the application needs to know the encoding of the , the application needs to know the encoding of the tex file. This + id="dx1-14021"> file. This information is added to the aux file and can be picked up by file and can be picked up by makeglossaries and and bib2gls. If you use . If you use xindy + id="dx1-14025"> explicitly instead of via makeglossaries, you may need to specify the encoding using the , you may need to specify the encoding using the -C option. Read the + id="dx1-14027"> option. Read the xindy manual for further details of this option. -

    As from v4.24, if you are writing in German (for example, using the manual for further details of this option. +

    As from v4.24, if you are writing in German (for example, using the ngerman + id="dx1-14029"> package1.5 + id="x1-14030f5"> or babel with the with the ngerman package option), and you want to use makeindex’s ’s -g option, you’ll need to change + id="dx1-14033"> option, you’ll need to change makeindex’s quote character using: -


    ’s quote character using: +


    \GlsSetQuote{character}

    -

    +

    Note that ⟨character⟩ may not be one of ? (question mark), -

    +   
     \GlsSetQuote{+}
     
    -

    This must be done before

    This must be done before \makeglossaries and any entry definitions. It’s only applicable for and any entry definitions. It’s only applicable for makeindex. This + id="dx1-14037">. This option in conjunction with ngerman will also cause will also cause makeglossaries to use the to use the -g switch when invoking + id="dx1-14040"> switch when invoking makeindex. -

    Be careful of . +

    Be careful of babel’s shorthands. These aren’t switched on until the start of the document, so any entries + id="dx1-14042">’s shorthands. These aren’t switched on until the start of the document, so any entries defined in the preamble won’t be able to use those shorthands. However, if you define the entries in the document and any of those shorthands happen to be special characters for makeindex or or xindy (such as the + id="dx1-14044"> (such as the double-quote) then this will interfere with code that tries to escape any of those characters that occur in the sort key.
    -

    -

    In general, it’s best not to use key.

    +

    +

    In general, it’s best not to use babel’s shorthands in entry definitions. For example: + id="dx1-14046">’s shorthands in entry definitions. For example:

    -
    +   
     \documentclass{article}
     \usepackage[ngerman]{babel}
     \usepackage{glossaries}
    @@ -6027,19 +6066,19 @@ class="cmss-10">babel
    -

    -

    The

    +

    The ngerman package has the shorthands on in the preamble, so they can be used in definitions if + id="dx1-14047"> package has the shorthands on in the preamble, so they can be used in definitions if \GlsSetQuote has been used to change the makeindex quote character. Example: + id="dx1-14048"> quote character. Example:

    -
    +   
     \documentclass{article}
     \usepackage[ngerman]{babel}
     \usepackage{glossaries}
    @@ -6052,100 +6091,100 @@ class="cmtt-10">makeindex
    -

    -

    +

    +

    -

    Top

    1.3.1

    Top

    1.4.1 Changing the Fixed Names

    -

    The fixed names are produced using the commands listed in

    The fixed names are produced using the commands listed in table ??tab:predefinednames. If you aren’t using a +class="cmbx-10">1.2. If you aren’t using a language package such as babel or or polyglossia that uses caption hooks, you can just redefine these commands as + id="dx1-15002"> that uses caption hooks, you can just redefine these commands as appropriate. If you are using babel or or polyglossia, you need to use their caption hooks to change the defaults. + id="dx1-15004">, you need to use their caption hooks to change the defaults. See changing the words babel uses or read the babel or or polyglossia documentation. If you have + id="dx1-15006"> documentation. If you have loaded babel, then , then glossaries will attempt to load will attempt to load translator, unless you have used the , unless you have used the notranslate, + id="dx1-15010">, translate=false or or translate=babel package options. If the package options. If the translator package is loaded, the translations + id="dx1-15013"> package is loaded, the translations are provided by dictionary files (for example, glossaries-dictionary-English.dict). See the translator package for advice on changing translations provided by package for advice on changing translations provided by translator dictionaries. If you + id="dx1-15015"> dictionaries. If you can’t work out how to modify these dictionary definitions, try switching to babel’s interface using + id="dx1-15016">’s interface using translate=babel: + id="dx1-15017">:

    -
    +   
     \documentclass[english,french]{article}
     \usepackage{babel}
     \usepackage[translate=babel]{glossaries}
     
    -

    and then use

    and then use babel’s caption hook mechanism. Note that if you pass the language options directly to ’s caption hook mechanism. Note that if you pass the language options directly to babel + id="dx1-15019"> rather that using the document class options or otherwise passing the same options to translator, then , then translator + id="dx1-15021"> won’t pick up the language and no dictionaries will be loaded and babel’s caption hooks will be used + id="dx1-15022">’s caption hooks will be used instead.

    -


    Table 1.2: Customised Text
    +class="content">Customised Text
    + id="dx1-15026">).

    Command Name

    Translator Key Word

    Purpose

    \glossaryname

    Glossary

    Title +class="td10">

    Title of the main @@ -6181,10 +6220,10 @@ class="td10">

    Title style="vertical-align:baseline;" id="TBL-3-3-">

    \acronymname

    Acronyms

    Title +class="td10">

    Title of the list @@ -6197,17 +6236,17 @@ class="td10">

    Title option acronym).

    \entryname

    Notation (glossaries)

    Header +class="td10">

    Header for first column @@ -6228,12 +6267,12 @@ class="td10">

    Header style="vertical-align:baseline;" id="TBL-3-5-">

    \descriptionname

    Description (glossaries)

    Header +class="td10">

    Header for second column @@ -6254,12 +6293,12 @@ class="td10">

    Header style="vertical-align:baseline;" id="TBL-3-6-">

    \symbolname

    Symbol (glossaries)

    Header +class="td10">

    Header for symbol column @@ -6277,14 +6316,14 @@ class="td10">

    Header style="vertical-align:baseline;" id="TBL-3-7-">

    \pagelistname

    Page List (glossaries)

    Header +class="td10">

    Header for page list @@ -6302,12 +6341,12 @@ class="td10">

    Header style="vertical-align:baseline;" id="TBL-3-8-">

    \glssymbolsgroupname

    Symbols (glossaries)

    Header +class="td10">

    Header for symbols section @@ -6325,12 +6364,12 @@ class="td10">

    Header style="vertical-align:baseline;" id="TBL-3-9-">

    \glsnumbersgroupname

    Numbers (glossaries)

    Header +class="td10">

    Header for numbers section @@ -6351,7 +6390,7 @@ class="td10">

    Header


    -

    As from version 4.12, multilingual support is provided by separate language modules that need to be +

    As from version 4.12, multilingual support is provided by separate language modules that need to be installed in addition to installing the glossaries package. You only need to install the modules for the languages that you require. If the language module has an unmaintained status, you can volunteer to take over the @@ -6359,151 +6398,151 @@ maintenance by contacting me at http://www.dickimaw-books.com/contact.html. The translator + id="dx1-15033"> dictionary files for glossaries are now provided by the appropriate language module. For further details about information specific to a given language, please see the documentation for that language module. -

    Examples of use:

    +

    Examples of use:

    • -

      Using

      Using babel and and translator: + id="dx1-15035">:

      -
      +     
            \documentclass[english,french]{article}
            \usepackage{babel}
            \usepackage{glossaries}
       
      -

      (

      (translator is automatically loaded). + id="dx1-15036"> is automatically loaded).

    • -

      Using

      Using babel: + id="dx1-15037">:

      -
      +     
            \documentclass[english,french]{article}
            \usepackage{babel}
            \usepackage[translate=babel]{glossaries}
       
      -

      (

      (translator isn’t loaded). The isn’t loaded). The glossaries-extra package has translate=babel as the default if as the default if babel has been + id="dx1-15040"> has been loaded.

    • -

      Using

      Using polyglossia: + id="dx1-15041">:

      -
      +     
            \documentclass{article}
            \usepackage{polyglossia}
            \setmainlanguage{english}
            \usepackage{glossaries}
       
      -

      +

    -

    Due to the varied nature of glossaries, it’s likely that the predefined translations may not be +

    Due to the varied nature of glossaries, it’s likely that the predefined translations may not be appropriate. If you are using the babel package and the package and the glossaries package option translate=babel, you + id="dx1-15043">, you need to be familiar with the advice given in changing the words babel uses. If you are using the translator package, then you can provide your own dictionary with the necessary modifications (using + id="dx1-15044"> package, then you can provide your own dictionary with the necessary modifications (using \deftranslation) and load it using \usedictionary. If you simply want to change the title of a glossary, you can use the title key in commands like key in commands like \printglossary (but not the iterative commands like \printglossaries). -

    Note that the

    Note that the translator dictionaries are loaded at the beginning of the document, so it won’t have any effect + id="dx1-15046"> dictionaries are loaded at the beginning of the document, so it won’t have any effect if you put \deftranslation in the preamble. It should be put in your personal dictionary instead (as in the example below). See the translator documentation for further details. (Now with documentation for further details. (Now with beamer documentation.) + id="dx1-15048"> documentation.)
    -

    -

    Your custom dictionary doesn’t have to be just a translation from English to another language. You may +

    +

    Your custom dictionary doesn’t have to be just a translation from English to another language. You may prefer to have a dictionary for a particular type of document. For example, suppose your institution’s in-house reports have to have the glossary labelled as “Nomenclature” and the page list should be labelled “Location”, then you can create a file called, say,

    -
    +   
     myinstitute-glossaries-dictionary-English.dict
     
    -

    that contains the following: +

    that contains the following:

    -
    +   
     \ProvidesDictionary{myinstitute-glossaries-dictionary}{English}
     \deftranslation{Glossary}{Nomenclature}
     \deftranslation{Page List (glossaries)}{Location}
     
    -

    You can now load it using: +

    You can now load it using:

    -
    +   
     \usedictionary{myinstitute-glossaries-dictionary}
     
    -

    (Make sure that

    (Make sure that myinstitute-glossaries-dictionary-English.dict can be found by TeX.) If you want to share your custom dictionary, you can upload it to CTAN. -

    If you are using

    If you are using babel and don’t want to use the and don’t want to use the translator interface, you can use the package option + id="dx1-15050"> interface, you can use the package option translate=babel. For example: + id="dx1-15051">. For example:

    -
    +   
     \documentclass[british]{article}
     \usepackage{babel}
     \usepackage[translate=babel]{glossaries}
    @@ -6512,68 +6551,68 @@ class="cmss-10">babel
    -

    -

    Note that

    +

    Note that xindy and and bib2gls provide much better multi-lingual support than provide much better multi-lingual support than makeindex, so I recommend + id="dx1-15054">, so I recommend that you use Options 3 or 4 if you have glossary entries that contain non-Latin characters. See s. See §??sec:xindy +class="cmbx-10">14 Xindy (Option 3) for further details on xindy, and see the , and see the bib2gls user manual for further details of that + id="dx1-15057"> user manual for further details of that application.

    -

    Top

    1.3.2 Creating a New Language Module

    -

    The

    Top

    1.4.2 Creating a New Language Module

    +

    The glossaries package now uses the tracklang package to determine which language modules need + id="dx1-16001"> package to determine which language modules need to be loaded. If you want to create a new language module, you should first read the tracklang + id="dx1-16002"> documentation. -

    To create a new language module, you need to at least create two files called:

    To create a new language module, you need to at least create two files called: glossaries-lang.ldf and + id="dx1-16003"> and glossaries-dictionary-Lang.dict where ⟨ where ⟨lang⟩ is the root language name (for example, english) and ⟨Lang⟩ is the language name used by translator (for example, (for example, English). -

    Here’s an example of

    Here’s an example of glossaries-dictionary-English.dict:

    -
    +   
     \ProvidesDictionary{glossaries-dictionary}{English}
     \providetranslation{Glossary}{Glossary}
     \providetranslation{Acronyms}{Acronyms}
    @@ -6584,22 +6623,22 @@ class="cmtt-10">glossaries-dictionary-English.dict:
     \providetranslation{Symbols (glossaries)}{Symbols}
     \providetranslation{Numbers (glossaries)}{Numbers}
     
    -

    You can use this as a template for your dictionary file. Change

    You can use this as a template for your dictionary file. Change English to the translator name for your + id="dx1-16006"> name for your language (so that it matches the file name glossaries-dictionary-Lang.dict) and, for each \providetranslation, change the second argument to the appropriate translation. -

    Here’s an example of

    Here’s an example of glossaries-english.ldf:

    -
    +   
     \ProvidesGlossariesLang{english}
     \glsifusedtranslatordict{English}
     {%
    @@ -6658,10 +6697,10 @@ class="cmtt-10">glossaries-english.ldf:
     \renewcommand*{\glsacrpluralsuffix}{\glspluralsuffix}
     \renewcommand*{\glsupacrpluralsuffix}{\glstextup{\glspluralsuffix}}
     
    -

    This is a somewhat longer file, but again you can use it as a template. Replace

    This is a somewhat longer file, but again you can use it as a template. Replace English with the translator + id="dx1-16007"> language label ⟨Lang⟩ used for the dictionary file and replace english with the root language name ⟨\glossariescaptionslang⟩, replace the English text (such as “Glossaries”) with the appropriate translation. -

    The suffixes used to generate the plural forms when the plural hasn’t been specified are given by +

    The suffixes used to generate the plural forms when the plural hasn’t been specified are given by \glspluralsuffix (for general entries). For abbreviations defined with \newacronym, \glsacrpluralsuffix for other acronym styles. There’ They may be expanded on definition or they may be expanded on use, depending on the glossaries configuration. -

    Therefore these plural suffix command definitions aren’t included in the caption mechanism as that’s +

    Therefore these plural suffix command definitions aren’t included in the caption mechanism as that’s typically not switched on until the start of the document. This means that the suffix in effect will be for the last loaded language that redefined these commands. It’s best to initialise these commands to the most common suffix required in your document and use the plural, , longplural, , shortplural etc keys to override exceptions. + id="dx1-16010"> etc keys to override exceptions.
    -

    -

    If you want to add a regional variation, create a file called

    +

    If you want to add a regional variation, create a file called glossaries-iso lang- -

    +   
      \ProvidesGlossariesLang{en-GB}
      \RequireGlossariesLang{english}
      \glsifusedtranslatordict{British}
    @@ -6730,21 +6769,21 @@ example:
        }%
      }
     
    -

    -

    If the translations includes

    +

    If the translations includes non-Latin characters, it’s necessary to provide code that’s independent of the + id="dx1-16011">s, it’s necessary to provide code that’s independent of the input encoding. Remember that while some users may use UTF-8, others may use Latin-1 or any other supported encoding, but while users won’t appreciate you enforcing your preference on them, it’s useful to provide a UTF-8 version for XeLaTeX and LuaLaTeX users. -

    The

    The glossaries-irish.ldf file provides this as follows:

    -
    +   
     \ProvidesGlossariesLang{irish}
     \glsifusedtranslatordict{Irish}
     {%
    @@ -6780,24 +6819,24 @@ class="cmtt-10">glossaries-irish.ldf file provides this as follows:
       \glossariescaptionsirish
     }
     
    -

    (Again you can use this as a template. Replace

    (Again you can use this as a template. Replace irish with your root language label and Irish with the translator dictionary label.) -

    There are now two extra files: dictionary label.) +

    There are now two extra files: glossaries-irish-noenc.ldf (no encoding information) and glossaries-irish-utf8.ldf (UTF-8). -

    These both define

    These both define \glossariescaptionsirish but the *-noenc.ldf uses LaTeX accent commands:

    -
    +   
     \@ifpackageloaded{polyglossia}%
     {%
       \newcommand*{\glossariescaptionsirish}{%
    @@ -6824,47 +6863,47 @@ class="cmtt-10">*-noenc.ldf uses LaTeX accent commands:
       }%
     }
     
    -

    whereas the

    whereas the *-utf8.ldf replaces the accent commands with the appropriate UTF-8 characters. -

    +

    -

    Top

    1.4

    Top

    1.5 Generating the Associated Glossary Files

    -

    This section is only applicable if you have chosen Options 

    This section is only applicable if you have chosen Options 2 or 3. You can ignore this section if you have chosen any of the other options. If you want to alphabetically sort your entries always remember to use the sort key if the key if the name contains any LaTeX commands (except if you’re using contains any LaTeX commands (except if you’re using bib2gls). + id="dx1-17003">).
    -

    -

    If this section seriously confuses you, and you can’t work out how to run external tools like

    +

    If this section seriously confuses you, and you can’t work out how to run external tools like makeglossaries or + id="dx1-17004"> or makeindex, you can try using the , you can try using the automake package option, described in package option, described in §??sec:pkgopts-sort 2.5 Sorting Options, but you will need TeX’s shell escape enabled. See also Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build. -

    In order to generate a sorted glossary with compact

    In order to generate a sorted glossary with compact number lists, it is necessary to use an external s, it is necessary to use an external indexing @@ -6877,52 +6916,52 @@ your document. The two indexing applications that are most commonly use makeindex and and xindy. As from version 1.17, the . As from version 1.17, the glossaries package can be used with either of these applications. Previous versions were designed to be used with makeindex only. With the only. With the glossaries-extra package, you can also use bib2gls as the indexing application. (See the as the indexing application. (See the glossaries-extra and bib2gls + id="dx1-17012"> user manuals for further details.) Note that xindy and and bib2gls have much better multi-lingual + id="dx1-17014"> have much better multi-lingual support than makeindex, so , so xindy or or bib2gls are recommended if you’re not writing in English. + id="dx1-17017"> are recommended if you’re not writing in English. Commands that only have an effect when xindy is used are described in is used are described in §??sec:xindy 14 Xindy (Option 3). -

    This is a multi-stage process, but there are methods of automating document compilation using applications +

    This is a multi-stage process, but there are methods of automating document compilation using applications such as latexmk and and arara. With . With arara you can just add special comments to your document source: + id="dx1-17021"> you can just add special comments to your document source:

     pdflatex
    With latexmk you need to set up the required dependencies.
    -

    -

    The you need to set up the required dependencies.

    +

    +

    The glossaries package comes with the Perl script makeglossaries which will run which will run makeindex or or xindy + id="dx1-17025"> on all the glossary files using a customized style file (which is created by \makeglossaries). See + id="dx1-17026">). See §??sec:makeglossariesapp 1.5.1 Using the makeglossaries Perl Script for further details. Perl is stable, cross-platform, open source software that is used by a number of TeX-related applications (including xindy and and latexmk). + id="dx1-17028">). Most Unix-like operating systems come with a Perl interpreter. TeX Live also comes with a Perl interpreter. MiKTeX doesn’t come with a Perl interpreter so if you are a Windows MiKTeX user you will need to install Perl if you want to use makeglossaries or or xindy. Further information is + id="dx1-17030">. Further information is available at http://www.perl.org/about.html and MiKTeX and Perl scripts (and one Python script). -

    The advantages of using

    The advantages of using makeglossaries:

    + id="dx1-17031">:

    • -

      It automatically detects whether to use

      It automatically detects whether to use makeindex or or xindy and sets the relevant application + id="dx1-17033"> and sets the relevant application switches.

    • -

      One call of

      One call of makeglossaries will run will run makeindex//xindy for each glossary type. + id="dx1-17036"> for each glossary type.

    • -

      If things go wrong,

      If things go wrong, makeglossaries will scan the messages from will scan the messages from makeindex or or xindy and attempt + id="dx1-17039"> and attempt to diagnose the problem in relation to the glossaries package. This will hopefully provide more helpful messages in some cases. If it can’t diagnose the problem, you will have to read the relevant transcript file and see if you can work it out from the makeindex or or xindy messages. + id="dx1-17041"> messages.

    • -

      If

      If makeindex warns about multiple encap values, warns about multiple encap values, makeglossaries will detect this and attempt to + id="dx1-17043"> will detect this and attempt to correct the problem.1.6 + id="x1-17044f6"> This correction is only provided by makeglossaries when when makeindex is used since is used since xindy uses the + id="dx1-17048"> uses the order of the attributes list to determine which format should take precedence. (see attributes list to determine which format should take precedence. (see §??sec:xindyloc +class="cmbx-10">14.2 Locations and Number lists.)

    -

    As from version 4.16, the

    As from version 4.16, the glossaries package also comes with a Lua script called makeglossaries-lite. This + id="dx1-17050">. This is a trimmed-down alternative to the makeglossaries Perl script. It doesn’t have some of the options that the + id="dx1-17051"> Perl script. It doesn’t have some of the options that the Perl version has and it doesn’t attempt to diagnose any problems, but since modern TeX distributions come with LuaTeX (and therefore have a Lua interpreter) you don’t need to install anything else in order to use makeglossaries-lite so it’s an alternative to so it’s an alternative to makeglossaries if you want to use if you want to use Option 2 (makeindex). -

    If things go wrong and you can’t work out why your glossaries aren’t being generated correctly, you can use + id="dx1-17054">). +

    If things go wrong and you can’t work out why your glossaries aren’t being generated correctly, you can use makeglossariesgui as a diagnostic tool. Once you’ve fixed the problem, you can then go back to using + id="dx1-17055"> as a diagnostic tool. Once you’ve fixed the problem, you can then go back to using makeglossaries or or makeglossaries-lite. -

    Whilst I strongly recommended that you use the . +

    Whilst I strongly recommended that you use the makeglossaries Perl script or the Perl script or the makeglossaries-lite + id="dx1-17059"> Lua script, it is possible to use the glossaries package without using those applications. However, note that some commands and package options have no effect if you explicitly run makeindex//xindy. These are listed in + id="dx1-17061">. These are listed in table ??tab:makeglossariesCmds. -

    If you are choosing not to use 1.3. +

    If you are choosing not to use makeglossaries because you don’t want to install Perl, you will only be able + id="dx1-17062"> because you don’t want to install Perl, you will only be able to use makeindex as as xindy also requires Perl. (Other useful Perl scripts include also requires Perl. (Other useful Perl scripts include epstopdf and latexmk, so it’s well-worth the effort to install Perl.)
    -

    -

    Note that if any of your entries use an entry that is not referenced outside the glossary, you will need to do an +

    +

    Note that if any of your entries use an entry that is not referenced outside the glossary, you will need to do an additional makeglossaries, , makeindex or or xindy run, as appropriate. For example, suppose you have defined the following + id="dx1-17067"> run, as appropriate. For example, suppose you have defined the following entries:1.7 + id="x1-17068f7">

    -
    +   
     \newglossaryentry{citrusfruit}{name={citrus fruit},
     description={fruit of any citrus tree. (See also
     \gls{orange})}}
     \newglossaryentry{orange}{name={orange},
     description={an orange coloured fruit.}}
     
    -

    and suppose you have

    and suppose you have \gls{citrusfruit} in your document but don’t reference the orange entry, then the orange entry won’t appear in your glossary until yo makeglossaries, , makeindex or or xindy. For example, if the document is called . For example, if the document is called myDoc.tex, then you must do: -

    
    +

    
        
    pdflatex myDoc
    makeglossaries myDoc
    pdflatex myDoc @@ -7171,35 +7210,35 @@ do: href="#option4">Option 4, bib2gls will scan the description for instances of commands like will scan the description for instances of commands like \gls to ensure they are selected but an extra bib2gls call is required to ensure the locations are included, if locations lists are + id="dx1-17074"> call is required to ensure the locations are included, if locations lists are required. See the and bib2gls manual for further details.) -

    Likewise, an additional manual for further details.) +

    Likewise, an additional makeglossaries and LaTeX run may be required if the document pages shift with + id="dx1-17076"> and LaTeX run may be required if the document pages shift with re-runs. For example, if the page numbering is not reset after the table of contents, the insertion of the table of contents on the second LaTeX run may push glossary entries across page boundaries, which means that the number lists in the glossary may need updating. -

    The examples in this document assume that you are accessing s in the glossary may need updating. +

    The examples in this document assume that you are accessing makeglossaries, , xindy or or makeindex via a + id="dx1-17080"> via a terminal. Windows users can use the MSDOS Prompt which is usually accessed via the Start->>All Programs->Accessories menu. -

    Alternatively, your text editor may have the facility to create a function that will call the required +

    Alternatively, your text editor may have the facility to create a function that will call the required application. See Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build. -

    If any problems occur, remember to check the transcript files (e.g. 

    If any problems occur, remember to check the transcript files (e.g. glg or or alg) for messages. + id="dx1-17082">) for messages.

    -


    @@ -7233,10 +7272,10 @@ class="cmtt-10">algCommands and package options that have no effect when using xindy or or makeindex explicitly
    + id="dx1-17085"> explicitly
    Command or Package Option + id="dx1-17087">
    makeindex xindy
    order=letter use -l use -M ord/letorder
    order=word default default
    xindy=={language=lang} N/A use -Llang-Ccode
    \GlsSetXdyLanguage{lang} N/A use -Llang
    \GlsSetXdyCodePage{code} N/A use -Ccode

    -

    Top

    1.4.1

    Top

    1.5.1 Using the makeglossaries Perl Script

    -

    The

    The makeglossaries script picks up the relevant information from the auxiliary ( script picks up the relevant information from the auxiliary (aux) file and will either call + id="dx1-18002">) file and will either call xindy or or makeindex, depending on the supplied information. Therefore, you only need to pass the document’s + id="dx1-18004">, depending on the supplied information. Therefore, you only need to pass the document’s name without the extension to makeglossaries. For example, if your document is called . For example, if your document is called myDoc.tex, type the following in your terminal: -

    
    +

    
        
    pdflatex myDoc
    makeglossaries myDoc
    pdflatex myDoc @@ -7357,38 +7396,38 @@ following in your terminal: You may need to explicitly load makeglossaries into Perl: -

    
    + id="dx1-18006"> into Perl:
    +

    
        
    perl makeglossaries myDoc

    -

    Windows users: TeX Live on Windows has its own internal Perl interpreter and provides +

    Windows users: TeX Live on Windows has its own internal Perl interpreter and provides makeglossaries.exe as a convenient wrapper for the makeglossaries Perl script. MiKTeX also + id="dx1-18007"> Perl script. MiKTeX also provides a wrapper makeglossaries.exe but doesn’t provide a Perl interpreter, which is still required even if you run MiKTeX’s makeglossaries.exe, so with MiKTeX you’ll need to install Perl.1.8 + id="x1-18008f8"> There’s more information about this at http://tex.stackexchange.com/q/158796/19862 on the TeX.SX site. -

    The

    The makeglossaries script attempts to fork the script attempts to fork the makeindex//xindy process using process using open() on the piped redirection 2>&1 | and parses the processor output t makeglossaries will print an “Unable to fork” warning and will retry without redirection. If you run + id="dx1-18012"> will print an “Unable to fork” warning and will retry without redirection. If you run makeglossaries on an operating system that doesn’t support this form of redirection, then you can use the on an operating system that doesn’t support this form of redirection, then you can use the -Q + id="dx1-18014"> switch to suppress this warning or you can use the -k switch to make switch to make makeglossaries automatically use the + id="dx1-18016"> automatically use the fallback method without attempting the redirection. Without this redirection, the -q (quiet) switch doesn’t + id="dx1-18017"> (quiet) switch doesn’t work as well. -

    You can specify in which directory the

    You can specify in which directory the aux, , glo etc files are located using the etc files are located using the -d switch. For example: -

    
    +

    
        
    pdflatex -output-directory myTmpDir myDoc
    makeglossaries -d myTmpDir myDoc

    Note that makeglossaries assumes by default that assumes by default that makeindex//xindy is on your operating system’s path. If + id="dx1-18022"> is on your operating system’s path. If this isn’t the case, you can specify the full pathname using -mpath/to/makeindex⟩ for makeindex or or -x + id="dx1-18025"> ⟨path/to/xindy⟩ for xindy. + id="dx1-18026">. -

    As from

    As from makeglossaries v2.18, if you are using v2.18, if you are using makeindex, there’s a check for , there’s a check for makeindex’s multiple encap + id="dx1-18029">’s multiple encap warning. This is where different encap values (location formats) are used on the same location for the same entry. For example:

    -
    +   
     \documentclass{article}
     \usepackage{glossaries}
     \makeglossaries
    @@ -7470,145 +7509,145 @@ entry. For example:
     \printglossaries
     \end{document}
     
    -

    If you explicitly use

    If you explicitly use makeindex, this will cause a warning and the location list will be “1, , this will cause a warning and the location list will be “1, 1”. That is, the page number will be repeated with each format. As from v2.18, makeglossaries will check for this warning + id="dx1-18031"> will check for this warning and, if found, will attempt to correct the problem by removing duplicate locations and retrying. There’s no similar check for xindy as as xindy won’t produce any warning and will simply discard + id="dx1-18033"> won’t produce any warning and will simply discard duplicates. -

    For a complete list of options do

    For a complete list of options do makeglossaries --help. -

    When upgrading the

    When upgrading the glossaries package, make sure you also upgrade your version of makeglossaries. The -current version is 4.47.
    -

    -

    + id="dx1-18034">. The +current version is 4.48.

    +

    +

    -

    Top

    1.4.2

    Top

    1.5.2 Using the makeglossaries-lite Lua Script

    -

    The Lua alternative to the

    The Lua alternative to the makeglossaries Perl script requires a Lua interpreter, which should already be + id="dx1-19001"> Perl script requires a Lua interpreter, which should already be available if you have a modern TeX distribution that includes LuaTeX. Lua is a light-weight, cross-platform scripting language, but because it’s light-weight it doesn’t have the full-functionality of heavy-weight scripting languages, such as Perl. The makeglossaries-lite script is therefore limited by this and some of the + id="dx1-19002"> script is therefore limited by this and some of the options available to the makeglossaries Perl script aren’t available here. (In particular the Perl script aren’t available here. (In particular the -d + id="dx1-19004"> option.) -

    Note that TeX Live on Unix-like systems creates a symbolic link called

    Note that TeX Live on Unix-like systems creates a symbolic link called makeglossaries-lite (without the lua extension) to the actual extension) to the actual makeglossaries-lite.lua script, so you may not need to supply the extension.
    -

    -

    The

    +

    The makeglossaries-lite script can be invoked in the same way as script can be invoked in the same way as makeglossaries. For example, if your + id="dx1-19007">. For example, if your document is called myDoc.tex, then do -

    
    +

    
        
    makeglossaries-lite.lua myDoc

    or -

    
    +

    
        
    makeglossaries-lite myDoc

    -

    Some of the options available with the Perl makeglossaries script are also available with the Lua + id="dx1-19008"> script are also available with the Lua makeglossaries-lite script. For a complete list of available options, do -

    
    + id="dx1-19009"> script. For a complete list of available options, do
    +

    
        
    makeglossaries-lite.lua --help

    -

    +

    -

    Top

    1.4.3

    Top

    1.5.3 Using xindy explicitly (Option 3)

    -

    Xindy comes with TeX Live. It has also been added to MikTeX, but if you don’t have it installed, see comes with TeX Live. It has also been added to MikTeX, but if you don’t have it installed, see How to use Xindy with MikTeX on TeX on StackExchange. -

    If you want to use

    If you want to use xindy to process the glossary files, you must make sure you have used the to process the glossary files, you must make sure you have used the xindy package + id="dx1-20003"> package option:

    -
    +   
     \usepackage[xindy]{glossaries}
     
    -

    This is required regardless of whether you use

    This is required regardless of whether you use xindy explicitly or whether it’s called implicitly via applications + id="dx1-20004"> explicitly or whether it’s called implicitly via applications such as makeglossaries. This causes the glossary entries to be written in raw . This causes the glossary entries to be written in raw xindy format, so you need to use + id="dx1-20006"> format, so you need to use -I xindy not -I tex. -

    To run

    To run xindy type the following in your terminal (all on one line): -

    
    + id="dx1-20009"> type the following in your terminal (all on one line):
    +

    
        
    xindy -L ⟨language⟩ -C ⟨encoding⟩ -I xindy -M ⟨encoding⟩ is the encoding, ⟨base⟩ is the name of the document without the tex extension and ⟨ extension and ⟨style⟩ is the name of the xindy style file without the style file without the xdy extension. The default + id="dx1-20012"> extension. The default name for this style file is ⟨basexdy but can be changed via but can be changed via \setStyleFile{style}. You may need to specify the full path name depending on the current working directory. If any of the file names contain spaces, you must delimit them using double-quotes. -

    For example, if your document is called

    For example, if your document is called myDoc.tex and you are using UTF8 encoding in English, then type the following in your terminal: -

    
    +

    
        
    xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo

    -

    Note that this just creates the main glossary. You need to do the same for each of the other glossaries +

    Note that this just creates the main glossary. You need to do the same for each of the other glossaries (including the list of acronyms if you have used the acronym package option), substituting package option), substituting glg, , gls and and glo + id="dx1-20018"> with the relevant extensions. For example, if you have used the acronym package option, then you would need to + id="dx1-20019"> package option, then you would need to do: -

    
    +

    
        
    xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr myDoc.acn

    For additional glossaries, the extensions are those supplied when you created the glossary with \newglossary. -

    Note that if you use . +

    Note that if you use makeglossaries instead, you can replace all those calls to instead, you can replace all those calls to xindy with just one call to + id="dx1-20022"> with just one call to makeglossaries: -

    
    + id="dx1-20023">:
    +

    
        
    makeglossaries myDoc

    Note also that some commands and package options have no effect if you use xindy explicitly instead of using + id="dx1-20024"> explicitly instead of using makeglossaries. These are listed in . These are listed in table ??tab:makeglossariesCmds. +class="cmbx-10">1.3. -

    +

    -

    Top

    1.4.4

    Top

    1.5.4 Using makeindex explicitly (Option 2)

    -

    If you want to use

    If you want to use makeindex explicitly, you must make sure that you haven’t used the explicitly, you must make sure that you haven’t used the xindy package option or + id="dx1-21002"> package option or the glossary entries will be written in the wrong format. To run makeindex, type the following in your + id="dx1-21003">, type the following in your terminal: -

    
    +

    
        
    makeindex -s ⟨style⟩.ist -t ⟨base⟩.glg -o ⟨base⟩.glo where ⟨base⟩ is the name of your document without the tex extension and ⟨ extension and ⟨styleist is the name of the + id="dx1-21005"> is the name of the makeindex style file. By default, this is ⟨ style file. By default, this is ⟨baseist, but may be changed via , but may be changed via \setStyleFile{style}. Note that there are other options, such as -l (letter ordering). See the (letter ordering). See the makeindex manual for further + id="dx1-21010"> manual for further details. -

    For example, if your document is called

    For example, if your document is called myDoc.tex, then type the following at the terminal: -

    
    +

    
        
    makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo

    Note that this only creates the main glossary. If you have additional glossaries (for example, if you have used the acronym package option) then you must call package option) then you must call makeindex for each glossary, substituting for each glossary, substituting glg, , gls and and glo with + id="dx1-21015"> with the relevant extensions. For example, if you have used the acronym package option, then you need to type the + id="dx1-21016"> package option, then you need to type the following in your terminal: -

    
    +

    
        
    makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn

    For additional glossaries, the extensions are those supplied when you created the glossary with \newglossary. -

    Note that if you use . +

    Note that if you use makeglossaries instead, you can replace all those calls to instead, you can replace all those calls to makeindex with just one call + id="dx1-21019"> with just one call to makeglossaries: -

    
    + id="dx1-21020">:
    +

    
        
    makeglossaries myDoc

    Note also that some commands and package options have no effect if you use makeindex explicitly instead of + id="dx1-21021"> explicitly instead of using makeglossaries. These are listed in . These are listed in table ??tab:makeglossariesCmds. -

    +class="cmbx-10">1.3. +

    -

    Top

    1.5

    Top

    1.6 Note to Front-End and Script Developers

    -

    The information needed to determine whether to use

    The information needed to determine whether to use xindy, , makeindex or or bib2gls is stored in the is stored in the aux file. + id="dx1-22004"> file. This information can be gathered by a front-end, editor or script to make the glossaries where appropriate. This section describes how the information is stored in the auxiliary file. -

    +

    -

    Top

    1.5.1 MakeIndex and Xindy

    -

    The file extensions used by each defined (but not ignored) glossary are given by -


    Top

    1.6.1 MakeIndex and Xindy

    +

    The file extensions used by each defined (but not ignored) glossary are given by +


    \@newglossary{label}{out-ext}{in-ext}

    -

    +

    where ⟨in-ext⟩ is the extension of the log⟩ is the extension of the indexing application& glossary is also given. This isn’t required with makeindex, but with , but with xindy it’s needed to pick up the associated + id="dx1-23003"> it’s needed to pick up the associated language and encoding (see below). For example, the information for the default main glossary is written as:

    -
    +   
     \@newglossary{main}{glg}{gls}{glo}
     
    -

    If

    If glossaries-extra’s hybrid method has been used (with \makeglossaries[

    \glsxtr@makeglossaries{list}
    -

    The

    The indexing application’s style file is specified by -



    \@istfilename{filename}

    -

    +

    The file extension indicates whether to use makeindex ( (ist) or ) or xindy ( (xdy). Note that the glossary information + id="dx1-23009">). Note that the glossary information is formatted differently depending on which indexing application is supposed to be used, so it’s important to call the correct one. -

    For example, with

    For example, with arara you can easily determine whether to run you can easily determine whether to run makeglossaries:

    + id="dx1-23011">:

    % "@istfilename")
    It’s more complicated if you want to explicitly run makeindex or or xindy -

    Note that if you choose to explicitly call +

    Note that if you choose to explicitly call makeindex or or xindy then the user will miss out on the diagnostic + id="dx1-23015"> then the user will miss out on the diagnostic information and the encap-clash fix that makeglossaries also provides.
    -

    -

    Word or letter ordering is specified by: -


    also provides.
    +

    +

    Word or letter ordering is specified by: +


    \@glsorder{order}

    -

    +

    where ⟨order⟩ can be either word or letter. -

    If

    If xindy should be used, the language and code page for each glossary is specified by -


    should be used, the language and code page for each glossary is specified by +


    \@xdylanguage{label}{label}{code}

    -

    +

    where ⟨label⟩ identifies the glossary, ⟨language⟩ is the root language (e.g. code⟩ is the encoding class="cmtt-10">utf8). These commands are omitted if makeindex should be used. -

    If should be used. +

    If Option 1 has been used, the aux file will contain -


    file will contain +


    \@gls@reference{type}{label}{location}

    -

    +

    for every time an entry has been referenced. -

    +

    -

    Top

    1.5.2 Entry Labels

    -

    If you need to gather labels for auto-completion, the

    Top

    1.6.2 Entry Labels

    +

    If you need to gather labels for auto-completion, the writeglslabels package option will create a file containing the + id="dx1-24001"> package option will create a file containing the labels of all defined entries (regardless of whether or not the entry has been used in the document). As from v4.47, there is a similar option writeglslabelnames that writes both the label and name (separated by a + id="dx1-24002"> that writes both the label and name (separated by a tab). -

    The

    The glossaries-extra package also provides docdef=atom, which will create the , which will create the glsdefs file but will act like + id="dx1-24004"> file but will act like docdef=restricted.
    -

    -

    -

    -

    Top

    1.5.3 Bib2Gls

    -

    .

    +

    +

    +

    +

    Top

    1.6.3 Bib2Gls

    +

    bib2glsIf If Option 4 has been used, the aux file will contain one or more instances of

    + id="dx1-25002"> file will contain one or more instances of

    \glsxtr@resource{options}{}
    where ⟨basename⟩ is the basename of the glstex file that needs to be created by file that needs to be created by bib2gls. If . If src= {} isn’t present in ⟨options⟩ then ⟨basename⟩ also indicates the name of the associated bib + id="dx1-25006"> file. -

    For example, with

    For example, with arara you can easily determine whether or not to run you can easily determine whether or not to run bib2gls:

    + id="dx1-25008">:

    % "glsxtr@resource")
    (It gets more complicated if both \glsxtr@resource and and \@istfilename are present as that indicates the hybrid record=hybrid option.) -

    Remember that with option.) +

    Remember that with bib2gls, the entries will never be defined on the first LaTeX call (because their + id="dx1-25011">, the entries will never be defined on the first LaTeX call (because their definitions are contained in the glstex file created by file created by bib2gls). You can also pick up labels from the records in + id="dx1-25013">). You can also pick up labels from the records in aux file, which will be in the form:

    + id="dx1-25014"> file, which will be in the form:

    \glsxtr@record{label}{} class="cmss-10">record=nameref)
    + id="dx1-25016">)
    \glsxtr@record@nameref{label}{\glssee)
    \glsxtr@recordsee{label}{}
    You can also pick up the commands defined with \glsxtrnewglslike, which are added to the , which are added to the aux file for + id="dx1-25020"> file for bib2gls’s benefit:
    + id="dx1-25021">’s benefit:
    \@glsxtr@newglslike{label-prefix}{}
    If \GlsXtrSetAltModifier is used, then the modifier is identified with:
    + id="dx1-25023"> is used, then the modifier is identified with:
    \@glsxtr@altmodifier{character}
    Label prefixes (for the \dgls set of commands) are identified with:
    + id="dx1-25025"> set of commands) are identified with:
    \@glsxtr@prefixlabellist{list} @@ -8204,21 +8243,21 @@ class="cmtt-10">}
    -

    -

    +

    Top

    2. Package Options

    -

    This section describes the available

    This section describes the available glossaries package options. You may omit the =true for boolean options. (For example, acronym is equivalent to is equivalent to acronym=true). -

    The ). +

    The glossaries-extra package has additional options described in the glossaries-extra manual. The extension @@ -8227,57 +8266,57 @@ writing are included here. Future versions of glossaries-extra may have additional package options or new values for existing settings that aren’t listed here.
    -

    -

    Note that ⟨

    +

    Note that ⟨key⟩=⟨value⟩ package options can’t be passed via the document class options. (This includes options where the ⟨value⟩ part may be omitted, such as acronym.) This is a general limitation not restricted to the + id="dx1-26003">.) This is a general limitation not restricted to the glossaries package. Options that aren’t ⟨key⟩=⟨value⟩ (such as makeindex) may be passed via the document class + id="dx1-26004">) may be passed via the document class options.
    -

    +

    -

    Top

    2.1 General Options

    -

    +

    nowarn

    -

    This suppresses all warnings generated by the

    This suppresses all warnings generated by the glossaries package. Don’t use this option if you’re new to using glossaries as the warnings are designed to help detect common mistakes (such as forgetting to use \makeglossaries). Note that if you use ). Note that if you use debug with any value other than with any value other than false it will override this option. -

    +

    nolangwarn

    -

    This suppresses the warning generated by a missing language module. -

    +

    This suppresses the warning generated by a missing language module. +

    noredefwarn

    -

    If you load

    If you load glossaries with a class or another package that already defines glossary related commands, by default glossaries will warn you that it’s redefining those commands. If you are aware of the consequences of using @@ -8285,26 +8324,26 @@ class="cmss-10">glossaries will warn you that it’s redefining those class="cmss-10">glossaries with that class or package and you don’t want to be warned about it, use this option to suppress those warnings. Other warnings will still be issued unless you use the nowarn option described above. (This option is + id="dx1-30001"> option described above. (This option is automatically switched on by glossaries-extra.) -

    +

    debug={value}

    -

    Introduced in version 4.24. The default setting is

    Introduced in version 4.24. The default setting is debug=false. The following values are available: . The following values are available: false, true, showaccsupp (v4.45+). If no value is given, debug=true is assumed. -

    The is assumed. +

    The glossaries-extra package provides extra values showwrgloss, that may be used to show where the indexing + id="dx1-31003">, that may be used to show where the indexing is occurring, and all, which switches on all debugging options. See the , which switches on all debugging options. See the glossaries-extra manual for further details.
    -

    -

    All values other than

    +

    All values other than debug=false switch on the debug mode (and will automatically cancel the switch on the debug mode (and will automatically cancel the nowarn + id="dx1-31006"> option). The debug=showtargets option will additionally use: -


    option will additionally use: +


    \glsshowtarget{target name}

    -

    +

    to show the hypertarget or hyperlink name when \glsdohypertarget is used by commands like \glsdohyperlink is used by commands like \gls. In math mode or inner mode, this puts the target name in square brackets just before the link or anchor. In outer mode it uses: -



    \glsshowtargetouter{label}

    -

    +

    which by default places the target name in the margin. The font is given by: -



    \glsshowtargetfont

    -

    +

    The default definition is \ttfamily\small. This command is included in the definition of -

    +   
     \renewcommand*{\glsshowtargetouter}[1]{%
      {\glsshowtargetfont [#1]}}
     
    -

    -

    Similarly, the

    +

    Similarly, the debug=showaccsupp will add the accessibility support information using: -


    will add the accessibility support information using: +


    \glsshowaccsupp{options}{tag}{replacement text}

    -

    +

    This internally uses \glsshowtarget. This option is provided for use with . This option is provided for use with glossaries-accsupp. -

    The purpose of the debug mode can be demonstrated with the following example document: + id="dx1-31014">. +

    The purpose of the debug mode can be demonstrated with the following example document:

    \newglossaryentry{sample1}{name={sample1},description={example}} class="cmtt-10">\newglossaryentry{sample2}{name={sample2},description={example}}
    \glsadd{sample2}% <- does nothing here
    \makeglossaries + id="dx1-31016">
    \begin{document}
    \glsadd{sample2} has been used before the associated file is opened by \makeglossaries. Since the file isn’t open yet, the information can’t be written to it, which is why the . Since the file isn’t open yet, the information can’t be written to it, which is why the sample2 entry doesn’t appear in the glossary. -

    Without

    Without \makeglossaries the indexing is suppressed with Options 2 and 3 but, other than that, commands like \gls behave as usual. -

    This situation doesn’t cause any errors or warnings as it’s perfectly legitimate for a user to want to use +

    This situation doesn’t cause any errors or warnings as it’s perfectly legitimate for a user to want to use glossaries to format the entries (e.g. abbreviation expansion) but not display any lists of terms, abbreviations, symbols etc (or the user may prefer to use the unsorted Options 1 or 4 for indexing, which don’t use \makeglossaries. -

    Therefore

    Therefore \makeglossaries can’t be used to enable \newglossaryentry and commands like \gls and \glsadd. These commands must be enabled by default. (It does, however, enable the see key as that’s a more + id="dx1-31018"> key as that’s a more common problem. See below.) -

    The debug mode, enabled with the

    The debug mode, enabled with the debug option, + id="dx1-31019"> option,

    -
    +   
     \usepackage[debug]{glossaries}
     
    -

    will write information to the log file when the indexing can’t occur because the associated file isn’t open. The +

    will write information to the log file when the indexing can’t occur because the associated file isn’t open. The message is written in the form

    -

    Package glossaries Info: wrglossary(⟨

    Package glossaries Info: wrglossary(⟨type⟩)(⟨text⟩) on input line ⟨line number⟩.

    -

    where ⟨

    where ⟨type⟩ is the glossary label and ⟨text⟩ is the line of text that would’ve been written to the associated file if it had been open. So if any entries haven’t appeared in the glossary but you’re sure you used commands like \glsadd or \glsaddall, try switching on the debug option and see if any information has been written to the log + id="dx1-31020"> option and see if any information has been written to the log file. -

    +

    savewrites={boolean}

    -

    This is a boolean option to minimise the number of write registers used by the

    This is a boolean option to minimise the number of write registers used by the glossaries package. The default is savewrites=false. With Options . With Options 2 and 3, one write register is required per (non-ignored) glossary and one for the style file. -

    With all options except Options 

    With all options except Options 1 and 4, another write register is required if the docdefs file is needed to + id="dx1-32002"> file is needed to save document definitions. With both Options 1 and 4, no write registers are required (document definitions aren’t permitted and indexing information is written to the aux file). If you really need document definitions + id="dx1-32003"> file). If you really need document definitions but you want to minimise the number of write registers then consider using docdef=restricted with + id="dx1-32004"> with glossaries-extra. -

    There are only a limited number of write registers, and if you have a large number of glossaries +

    There are only a limited number of write registers, and if you have a large number of glossaries or if you are using a class or other packages that create a lot of external files, you may exceed the maximum number of available registers. If savewrites is set, the glossary information will be + id="dx1-32005"> is set, the glossary information will be stored in token registers until the end of the document when they will be written to the external files. -

    This option can significantly slow document compilation and may cause the indexing to fail. Page numbers +

    This option can significantly slow document compilation and may cause the indexing to fail. Page numbers in the number list will be incorrect on page boundaries due to TeX’s asynchronous output routine. As an + id="dx1-32006"> will be incorrect on page boundaries due to TeX’s asynchronous output routine. As an alternative, you can use the scrwfile package (part of the KOMA-Script bundle) and not use this option. + id="dx1-32007"> package (part of the KOMA-Script bundle) and not use this option.
    -

    -

    By way of comparison,

    +

    By way of comparison, sample-multi2.tex provided with bib2gls has a total of + id="dx1-32008"> has a total of 15 glossaries. With Options 2 or 3, this would require 46 associated files and 16 write registers.2.1 + id="x1-32009f1"> With bib2gls, no write registers are required and there are only 10 associated files for that particular document + id="dx1-32011">, no write registers are required and there are only 10 associated files for that particular document (9 resource files and 1 transcript file). -

    If you want to use TeX’s

    If you want to use TeX’s \write18 mechanism to call mechanism to call makeindex or or xindy from your document and use + id="dx1-32014"> from your document and use savewrites, you must create the external files with , you must create the external files with \glswritefiles before you call makeindex//xindy. Also set + id="dx1-32017">. Also set \glswritefiles to nothing or \relax before the end of the document to avoid rewriting the files. For @@ -8587,259 +8626,259 @@ example:

    -
    +   
     \glswritefiles
     \write18{makeindex -s \istfilename\space
     -t \jobname.glg -o \jobname.gls \jobname}
     \let\glswritefiles\relax
     
    -

    -

    In general, this package option is best avoided. -

    +

    +

    In general, this package option is best avoided. +

    translate={value}

    -

    This can take the following values: +

    This can take the following values:

    -

    +

    true

    -

    If

    If babel has been loaded and the has been loaded and the translator package is installed, package is installed, translator will be loaded and the + id="dx1-33004"> will be loaded and the translations will be provided by the translator package interface. You can modify the translations + id="dx1-33005"> package interface. You can modify the translations by providing your own dictionary. If the translator package isn’t installed and package isn’t installed and babel is loaded, + id="dx1-33007"> is loaded, the glossaries-babel package will be loaded and the translations will be provided using package will be loaded and the translations will be provided using babel’s \addto\captionlanguage⟩ mechanism. If polyglossia has been loaded, has been loaded, glossaries-polyglossia will be + id="dx1-33010"> will be loaded.

    -

    +

    false

    -

    Don’t provide translations, even if

    Don’t provide translations, even if babel or or polyglossia has been loaded. (Note that has been loaded. (Note that babel provides + id="dx1-33014"> provides the command \glossaryname so that will still be translated if you have loaded so that will still be translated if you have loaded babel.) + id="dx1-33016">.)

    -

    +

    babel

    -

    Don’t load the

    Don’t load the translator package. Instead load package. Instead load glossaries-babel. -

    I recommend you use . +

    I recommend you use translate=babel if you have any problems with the translations or with PDF + id="dx1-33020"> if you have any problems with the translations or with PDF bookmarks, but to maintain backward compatibility, if babel has been loaded the default is has been loaded the default is translate=true. + id="dx1-33022">.
    -

    +

    -

    If

    If translate is specified without a value, is specified without a value, translate=true is assumed. If is assumed. If translate isn’t specified, + id="dx1-33025"> isn’t specified, translate=true is assumed if is assumed if babel, , polyglossia or or translator have been loaded. Otherwise have been loaded. Otherwise translate=false is + id="dx1-33030"> is assumed. -

    With

    With glossaries-extra, if babel is detected then is detected then translate=babel is automatically passed to the base is automatically passed to the base glossaries + id="dx1-33033"> package.
    -

    -

    See

    +

    See §??sec:fixednames 1.4.1 Changing the Fixed Names for further details. -

    +

    notranslate

    -

    This is equivalent to

    This is equivalent to translate=false and may be passed via the document class options. -

    + id="dx1-34001"> and may be passed via the document class options. +

    hyperfirst={boolean}

    -

    This is a boolean option that specifies whether each term has a hyperlink on

    This is a boolean option that specifies whether each term has a hyperlink on first use. The default is hyperfirst=true (terms on (terms on first use have a hyperlink, unless explicitly suppressed using starred versions of commands such as \gls* or by identifying the glossary with or by identifying the glossary with nohypertypes, described above). Note that + id="dx1-35003">, described above). Note that nohypertypes overrides overrides hyperfirst=true. This option only affects commands that check the . This option only affects commands that check the first use flag, such as the \gls-like commands (for example, \gls or or \glsdisp), but not the ), but not the \glstext-like commands (for example, \glslink or or \glstext). -

    The ). +

    The hyperfirst setting applies to all glossary types (unless identified by setting applies to all glossary types (unless identified by nohypertypes or defined + id="dx1-35011"> or defined with \newignoredglossary). It can be overridden on an individual basis by explicitly setting the + id="dx1-35012">). It can be overridden on an individual basis by explicitly setting the hyper key when referencing an entry (or by using the plus or starred version of the referencing + id="dx1-35013"> key when referencing an entry (or by using the plus or starred version of the referencing command). -

    It may be that you only want to apply this to just the acronyms (where the first use explains the meaning of +

    It may be that you only want to apply this to just the acronyms (where the first use explains the meaning of the acronym) but not for ordinary glossary entries (where the first use is identical to subsequent uses). In this case, you can use hyperfirst=false and apply and apply \glsunsetall to all the regular (non-acronym) glossaries. For example:

    -
    +   
      \usepackage[acronym,hyperfirst=false]{glossaries}
      % acronym and glossary entry definitions
      % at the end of the preamble
      \glsunsetall[main]
     
    -

    -

    Alternatively you can redefine the hook -


    +

    Alternatively you can redefine the hook +


    \glslinkcheckfirsthyperhook

    -

    +

    which is used by the commands that check the first use flag, such as \gls. Within the definition of this + id="dx1-35016">. Within the definition of this command, you can use \glslabel to reference the entry label and to reference the entry label and \glstype to reference the glossary type. You + id="dx1-35018"> to reference the glossary type. You can also use \ifglsused to determine if the entry has been used. You can test if an entry is an acronym by + id="dx1-35019"> to determine if the entry has been used. You can test if an entry is an acronym by checking if it has the long key set using key set using \ifglshaslong. For example, to switch off the hyperlink on first use + id="dx1-35021">. For example, to switch off the hyperlink on first use just for acronyms:

    -
    +   
     \renewcommand*{\glslinkcheckfirsthyperhook}{%
      \ifglsused{\glslabel}{}%
      {%
    @@ -8847,20 +8886,20 @@ just for acronyms:
      }%
     }
     
    -

    -

    Note that this hook isn’t used by the commands that don’t check the

    +

    Note that this hook isn’t used by the commands that don’t check the first use flag, such as \glstext. (You can, instead, redefine . (You can, instead, redefine \glslinkpostsetkeys, which is used by both the , which is used by both the \gls-like and \glstext-like commands.) -

    The

    The glossaries-extra package provides a method of disabling the first use hyperlink according to the entry’s @@ -8868,362 +8907,362 @@ associated category. For example, if you only to switch off the first use hyperlink for abbreviations and acronyms then you simply need to set the nohyperfirst attribute for the attribute for the abbreviation and acronym categories. (Instead of using the nohyperfirst package option.) See the package option.) See the glossaries-extra manual for further details. -

    +

    writeglslabels

    -

    This is a valueless option that will create a file called

    This is a valueless option that will create a file called \jobname.glslabels at the end of the document. This file + id="dx1-36001"> at the end of the document. This file simply contains a list of all defined entry labels (including those in any ignored glossaries). It’s provided for the benefit of text editors that need to know labels for auto-completion. If you also want the name, use + id="dx1-36002">. If you also want the name, use writeglslabelnames. (See also . (See also glossaries-extra’s docdef=atom package option.) -

    Note that with package option.) +

    Note that with bib2gls the file will only contain the entries that the file will only contain the entries that bib2gls has selected from the has selected from the bib files. + id="dx1-36007"> files.
    -

    -

    +

    +

    writeglslabelnames

    -

    Similar to the above but writes both the label and name (separated by a tab). -

    +

    Similar to the above but writes both the label and name (separated by a tab). +

    undefaction={value} (glossaries-extra.sty)

    -

    The value may be one of: +

    The value may be one of:

    -

    +

    error

    -

    generate an error if a referenced entry is undefined (default, and the only available setting with +

    generate an error if a referenced entry is undefined (default, and the only available setting with just glossaries);

    -

    +

    warn

    -

    only warn if a referenced entry is undefined (automatically activated with

    only warn if a referenced entry is undefined (automatically activated with Option 4).

    -

    +

    docdef={value} (glossaries-extra.sty)

    -

    This option governs the use of

    This option governs the use of \newglossaryentry. Available values:

    -

    +

    false

    -

    \newglossaryentry is not permitted in the document environment (default with environment (default with glossaries-extra and for Option 1 with just the base glossaries package);

    -

    +

    restricted

    -

    \newglossaryentry is only permitted in the document environment if it occurs before + id="dx1-39003"> environment if it occurs before \printglossary (not available for some indexing options);

    -

    +

    atom

    -

    as

    as restricted but creates the docdefs file for use by file for use by atom (without the limitations of (without the limitations of docdef=true); + id="dx1-39007">);

    -

    +

    true

    -

    \newglossaryentry is permitted in the document environment where it would normally be + id="dx1-39008"> environment where it would normally be permitted by the base glossaries package. This will create the docdefs file if file if \newglossaryentry is found in the document environment.

    + id="dx1-39011"> environment.

    -

    +

    -

    Top

    2.2 Sectioning, Headings and TOC Options

    -

    +

    toc={boolean}

    -

    Add the glossaries to the table of contents. Note that an extra LaTeX run is required with this option. +

    Add the glossaries to the table of contents. Note that an extra LaTeX run is required with this option. Alternatively, you can switch this function on and off using -



    \glstoctrue

    -

    +

    and -



    \glstocfalse

    -

    +

    The default value is toc=false for the base for the base glossaries package and toc=true for for glossaries-extra. -

    +

    numberline={boolean}

    -

    When used with the above

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

    +

    section={value}

    -

    This option indicates the sectional unit to use for the glossary. The value should be the control +

    This option indicates the sectional unit to use for the glossary. The value should be the control sequence name without the leading backslash or following star (e.g. just chapter not \chapter or chapter*). -

    The default behaviour is for the glossary heading to use

    The default behaviour is for the glossary heading to use \chapter, if that command exists, or \section otherwise. The starred or unstarred form is determined by the numberedsection option. -

    Example: + id="dx1-43001"> option. +

    Example:

    -
    +   
     \usepackage[section=subsection]{glossaries}
     
    -

    You can omit the value if you want to use

    You can omit the value if you want to use \section, i.e. 

    -
    +   
     \usepackage[section]{glossaries}
     
    -

    is equivalent to +

    is equivalent to

    -
    +   
     \usepackage[section=section]{glossaries}
     
    -

    You can change this value later in the document using -


    You can change this value later in the document using +


    \setglossarysection{name}

    -

    +

    where ⟨name⟩ is the sectional unit. -

    The start of each glossary adds information to the page header via -


    The start of each glossary adds information to the page header via +


    \glsglossarymark{glossary title}

    -

    +

    By default this uses \@mkboth2.2 + id="x1-43004f2"> but you may need to redefine it. For example, to only change the right header:

    -
    +   
     \renewcommand{\glsglossarymark}[1]{\markright{#1}}
     
    -

    or to prevent it from changing the headers: +

    or to prevent it from changing the headers:

    -
    +   
     \renewcommand{\glsglossarymark}[1]{}
     
    -

    If you want

    If you want \glsglossarymark to use \MakeUppercase in the header, use the ucmark option described + id="dx1-43007"> option described below. -

    Occasionally you may find that another package defines

    Occasionally you may find that another package defines \cleardoublepage when it is not required. This may cause an unwanted blank page to appear before each glossary. This can be fixed by redefining \glsclearpage:

    -
    +   
     \renewcommand*{\glsclearpage}{\clearpage}
     
    -

    -

    +

    +

    ucmark={boolean}

    -

    This is a boolean option. The default is

    This is a boolean option. The default is ucmark=false, unless , unless memoir has been loaded, in which case the default + id="dx1-44002"> has been loaded, in which case the default is ucmark=true. -

    If set, . +

    If set, \glsglossarymark uses + id="dx1-44004"> uses \MakeTextUppercase2.3. + id="x1-44006f3">. You can test whether this option has been set or not using -



    \ifglsucmarktrue part\else false part\fi

    -

    +

    For example:

    -
    +   
     \renewcommand{\glsglossarymark}[1]{%
       \ifglsucmark
         \markright{\MakeTextUppercase{#1}}%
    @@ -9231,59 +9270,59 @@ For example:
         \markright{#1}%
       \fi}
     
    -

    If

    If memoir has been loaded and has been loaded and ucmark is set, then is set, then memoir’s ’s \memUChead is used. -

    + id="dx1-44015"> is used. +

    numberedsection={value}

    -

    The glossaries are placed in unnumbered sectional units by default, but this can be changed using +

    The glossaries are placed in unnumbered sectional units by default, but this can be changed using numberedsection. This option can take one of the following values:

    + id="dx1-45001">. This option can take one of the following values:

    • -

      false: no number, i.e. use starred form of sectioning command (e.g. : no number, i.e. use starred form of sectioning command (e.g. \chapter* or \section*);

    • -

      nolabel: use a numbered section, i.e. the unstarred form of sectioning command (e.g. : use a numbered section, i.e. the unstarred form of sectioning command (e.g. \chapter or \section), but the section not labelled;

    • -

      autolabel: numbered with automatic labelling. Each glossary uses the unstarred form of a sectioning + id="dx1-45004">: numbered with automatic labelling. Each glossary uses the unstarred form of a sectioning command (e.g. \chapter or \section) and is assigned a label (via \label). The label is formed + id="dx1-45005">). The label is formed from -



      \glsautoprefix type

      -

      +

      where ⟨type⟩ is the label identifying that glossary. The default value of \glsautoprefix is empty. For @@ -9292,170 +9331,170 @@ class="cmss-10">glossaries using:

      -
      +     
            \usepackage[section,numberedsection=autolabel]
              {glossaries}
       
      -

      then each glossary will appear in a numbered section, and can be referenced using something +

      then each glossary will appear in a numbered section, and can be referenced using something like:

      -
      +     
            The main glossary is in section~\ref{main} and
            the list of acronyms is in section~\ref{acronym}.
       
      -

      If you can’t decide whether to have the acronyms in the main glossary or a separate list of acronyms, you +

      If you can’t decide whether to have the acronyms in the main glossary or a separate list of acronyms, you can use \acronymtype which is set to which is set to main if the acronym option is not used and is set to option is not used and is set to acronym if the acronym option is used. For example: + id="dx1-45009"> option is used. For example:

      -
      +     
            The list of acronyms is in section~\ref{\acronymtype}.
       
      -

      You can redefine the prefix if the default label clashes with another label in your document. For +

      You can redefine the prefix if the default label clashes with another label in your document. For example:

      -
      +     
            \renewcommand*{\glsautoprefix}{glo:}
       
      -

      will add

      will add glo: to the automatically generated label, so you can then, for example, refer to the list of acronyms as follows:

      -
      +     
            The list of acronyms is in
            section~\ref{glo:\acronymtype}.
       
      -

      Or, if you are undecided on a prefix: +

      Or, if you are undecided on a prefix:

      -
      +     
            The list of acronyms is in
            section~\ref{\glsautoprefix\acronymtype}.
       
      -

      +

    • -

      nameref: this is like : this is like autolabel but uses an unnumbered sectioning command (e.g.  but uses an unnumbered sectioning command (e.g. \chapter* or + id="dx1-45012"> or \section*). It’s designed for use with the ). It’s designed for use with the nameref package. For example: + id="dx1-45014"> package. For example:

      -
      +     
            \usepackage{nameref}
            \usepackage[numberedsection=nameref]{glossaries}
       
      -

      Now

      Now \nameref{main} will display the (TOC) section title associated with the main glossary. As above, you can redefine \glsautoprefix to provide a prefix for the label.

    -

    +

    -

    Top

    2.3 Glossary Appearance Options

    -

    +

    savenumberlist={boolean}

    -

    This is a boolean option that specifies whether or not to gather and store the

    This is a boolean option that specifies whether or not to gather and store the number list for each entry. The + id="dx1-47001"> for each entry. The default is savenumberlist=false. (See . (See \glsentrynumberlist and and \glsdisplaynumberlist in in §??sec:glsnolink +class="cmbx-10">5.2 Using Glossary Terms Without Links.) This is always true if you use Option 1. -

    If you use the

    If you use the record option (with either no value or option (with either no value or record=only or or record=nameref) then this package option + id="dx1-47007">) then this package option has no effect. With bib2gls, the , the number lists are automatically saved with the default s are automatically saved with the default save-locations=true + id="dx1-47010"> and save-loclist=true resource settings.
    -

    -

    + id="dx1-47011"> resource settings.

    +

    +

    entrycounter={boolean}

    -

    This is a boolean option. (Default is

    This is a boolean option. (Default is entrycounter=false.) If set, each main (level 0) glossary entry will be + id="dx1-48001">.) If set, each main (level 0) glossary entry will be numbered when using the standard glossary styles. This option creates the counter glossaryentry. -

    If you use this option, you can reference the entry number within the document using -


    If you use this option, you can reference the entry number within the document using +


    \glsrefentry{label}

    -

    +

    where ⟨label⟩ is the label associated with that glossary entry. The labelling systems uses ⟨prefix⟩⟨label⟩, where ⟨label⟩ is the entry’s label and ⟨prefix⟩ is given by -



    \GlsEntryCounterLabelPrefix

    -

    +

    (which defaults to glsentry-). -

    If you use

    If you use \glsrefentry, you must run LaTeX twice after creating the glossary files using makeglossaries, , makeindex or or xindy to ensure the cross-references are up-to-date.
    -

    -

    + id="dx1-48008"> to ensure the cross-references are up-to-date.

    +

    +

    counterwithin={value}

    -

    This is a ⟨

    This is a ⟨key⟩=⟨value⟩ option where ⟨value⟩ is the name of a counter. If used, this option will automatically set @@ -9501,45 +9540,45 @@ class="cmti-10">value⟩ is the name of a counter. If used, this opt class="cmss-10">entrycounter=true and the and the glossaryentry counter will be reset every time ⟨ counter will be reset every time ⟨value⟩ is incremented. -

    The

    The glossaryentry counter isn’t automatically reset at the start of each glossary, except when glossary section + id="dx1-49003"> counter isn’t automatically reset at the start of each glossary, except when glossary section numbering is on and the counter used by counterwithin is the same as the counter used in the glossary’s + id="dx1-49004"> is the same as the counter used in the glossary’s sectioning command.
    -

    -

    If you want the counter reset at the start of each glossary, you can modify the glossary preamble +

    +

    If you want the counter reset at the start of each glossary, you can modify the glossary preamble (\glossarypreamble) to use -


    ) to use +


    \glsresetentrycounter

    -

    +

    which sets glossaryentry to zero: + id="dx1-49007"> to zero:

    -
    +   
     \renewcommand{\glossarypreamble}{%
       \glsresetentrycounter
     }
     
    -

    or if you are using

    or if you are using \setglossarypreamble, add it to each glossary preamble, as required. For + id="dx1-49008">, add it to each glossary preamble, as required. For example:

    -
    +   
     \setglossarypreamble[acronym]{%
       \glsresetentrycounter
       The preamble text here for the list of acronyms.
    @@ -9549,336 +9588,336 @@ example:
       The preamble text here for the main glossary.
     }
     
    -

    -

    +

    +

    subentrycounter={boolean}

    -

    This is a boolean option. (Default is

    This is a boolean option. (Default is subentrycounter=false.) If set, each level 1 glossary entry will be numbered + id="dx1-50001">.) If set, each level 1 glossary entry will be numbered when using the standard glossary styles. This option creates the counter glossarysubentry. The counter is reset with each main (level 0) entry. Note that this package option is independent of entrycounter. You can reference + id="dx1-50004">. You can reference the number within the document using \glsrefentry{label} where ⟨label⟩ is the label associated with the sub-entry. -

    +

    style={value}

    -

    This is a ⟨

    This is a ⟨key⟩=⟨value⟩ option. (Default is style=list, unless , unless classicthesis has been loaded, in which case the default is + id="dx1-51002"> has been loaded, in which case the default is style=index.) Its value should be the name of the glossary style to use. This key may only be used for styles + id="dx1-51003">.) Its value should be the name of the glossary style to use. This key may only be used for styles defined in glossary-list, , glossary-long, , glossary-super or or glossary-tree. Alternatively, you can set the style + id="dx1-51007">. Alternatively, you can set the style using -



    \setglossarystyle{style name}

    -

    +

    (See §??sec:styles 13 Glossary Styles for further details.) -

    +

    nolong

    -

    This prevents the

    This prevents the glossaries package from automatically loading glossary-long (which means that the (which means that the longtable + id="dx1-52002"> package also won’t be loaded). This reduces overhead by not defining unwanted styles and commands. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the glossary-long package (unless you explicitly load glossary-long). + id="dx1-52003">). -

    +

    nosuper

    -

    This prevents the

    This prevents the glossaries package from automatically loading glossary-super (which means that the + id="dx1-53001"> (which means that the supertabular package also won’t be loaded). This reduces overhead by not defining unwanted styles and + id="dx1-53002"> package also won’t be loaded). This reduces overhead by not defining unwanted styles and commands. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the glossary-super package (unless you explicitly load glossary-super). -

    + id="dx1-53003">). +

    nolist

    -

    This prevents the

    This prevents the glossaries package from automatically loading glossary-list. This reduces overhead by not + id="dx1-54001">. This reduces overhead by not defining unwanted styles. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the glossary-list package (unless you explicitly load glossary-list). Note that since the default style is ). Note that since the default style is list + id="dx1-54003"> (unless classicthesis has been loaded), you will also need to use the has been loaded), you will also need to use the style option to set the style to something + id="dx1-54005"> option to set the style to something else. -

    +

    notree

    -

    This prevents the

    This prevents the glossaries package from automatically loading glossary-tree. This reduces overhead by not + id="dx1-55001">. This reduces overhead by not defining unwanted styles. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the glossary-tree package (unless you explicitly load glossary-tree). Note that if ). Note that if classicthesis has been + id="dx1-55003"> has been loaded, the default style is index, which is provided by , which is provided by glossary-tree. -

    + id="dx1-55005">. +

    nostyles

    -

    This prevents all the predefined styles from being loaded. If you use this option, you need to load a glossary +

    This prevents all the predefined styles from being loaded. If you use this option, you need to load a glossary style package (such as glossary-mcols). Also if you use this option, you can’t use the ). Also if you use this option, you can’t use the style package option. Instead + id="dx1-56002"> package option. Instead you must either use \setglossarystyle{style} or the style key in the optional argument to key in the optional argument to \printglossary. + id="dx1-56005">. Example:

    -
    +   
     \usepackage[nostyles]{glossaries}
     \usepackage{glossary-mcols}
     \setglossarystyle{mcoltree}
     
    -

    -

    +

    +

    nonumberlist

    -

    This option will suppress the associated

    This option will suppress the associated number lists in the glossaries (see also s in the glossaries (see also §??sec:numberlists 12 Number Lists). Note that if you use Options 2 or 3 (makeindex or or xindy) then the locations must still be valid. This + id="dx1-57003">) then the locations must still be valid. This package option merely prevents the number list from being displayed, but both from being displayed, but both makeindex and and xindy + id="dx1-57006"> still require a location or cross-reference for each term that’s indexed. Remember that number list + id="dx1-57007"> includes any cross-references, so suppressing the number list will also hide the cross-references (see + id="dx1-57008"> will also hide the cross-references (see below). -

    +

    seeautonumberlist

    -

    If you suppress the

    If you suppress the number lists with s with nonumberlist, described above, this will also suppress any + id="dx1-58002">, described above, this will also suppress any cross-referencing information supplied by the see key in key in \newglossaryentry or or \glssee. If you + id="dx1-58005">. If you use seeautonumberlist, the , the see key will automatically implement key will automatically implement nonumberlist=false for that + id="dx1-58008"> for that entry. (Note this doesn’t affect \glssee.) For further details see §??sec:crossref 11 Cross-Referencing Entries. -

    +

    counter={value}

    -

    This is a ⟨

    This is a ⟨key⟩=⟨value⟩ option. (Default is counter=page.) The value should be the name of the default counter to + id="dx1-59001">.) The value should be the name of the default counter to use in the number lists (see s (see §??sec:numberlists 12 Number Lists). -

    +

    nopostdot={boolean}

    -

    This is a boolean option. If no value is specified,

    This is a boolean option. If no value is specified, true is assumed. When set to is assumed. When set to true, this option suppresses the + id="dx1-60002">, this option suppresses the default post description dot used by some of the predefined styles. -

    The default setting is

    The default setting is nopostdot=false for the base for the base glossaries package and nopostdot=true for + id="dx1-60004"> for glossaries-extra. -

    The

    The glossaries-extra package provides postdot, which is equivalent to , which is equivalent to nopostdot=false, and also , and also postpunc, + id="dx1-60007">, which allows you to choose a different punctuation character.
    -

    -

    +

    +

    nogroupskip={boolean}

    -

    This is a boolean option. If no value is specified,

    This is a boolean option. If no value is specified, true is assumed. When set to true, this option suppresses the default vertical gap between letter groups used by some of the predefined styles. The default setting is @@ -9886,31 +9925,31 @@ default vertical gap between letter groups used by some of the predefined styles class="cmss-10">nogroupskip=false. -

    If you are using . +

    If you are using bib2gls without the without the --group (or -g) switch then you don’t need to use nogroupskip=true as there won’t be any letter groups.
    -

    -

    +

    +

    stylemods={list} (glossaries-extra.sty)

    -

    Load the

    Load the glossaries-extra-stylemods package, which patches the predefined styles. The ⟨ package, which patches the predefined styles. The ⟨list⟩ argument is optional. If present, this will also load glossary-.sty for each ⟨element⟩ in the comma-separated ⟨list⟩. -

    +

    -

    Top

    2.4 Indexing Options

    -

    +

    seenoindex={value}

    -

    Introduced in version 4.24, this option may take one of three values:

    Introduced in version 4.24, this option may take one of three values: error, warn or ignore. The see key + id="dx1-64001"> key automatically indexes the cross-referenced entry using \glssee. This means that if this key is + id="dx1-64002">. This means that if this key is used in an entry definition before the relevant glossary file has been opened, the indexing can’t be performed. Since this is easy to miss, the glossaries package by default issues an error message if the see key is used before key is used before \makeglossaries. This option allows you to change the error into just a + id="dx1-64004">. This option allows you to change the error into just a warning (seenoindex=warn) or ignore it () or ignore it (seenoindex=ignore) if, for example, you want to temporarily + id="dx1-64006">) if, for example, you want to temporarily comment out \makeglossaries to speed up the compilation of a draft document by omitting the indexing. -

    +

    esclocations={boolean}

    -

    This is a boolean option. The default is

    This is a boolean option. The default is esclocations=true, which is needed for Options , which is needed for Options 2 and 3. With Option 1 \makenoidxglossaries changes it to changes it to esclocations=false. With . With Option 4 (bib2gls), this setting is + id="dx1-65004">), this setting is ignored. -

    Both

    Both makeindex and and xindy are fussy about the location formats ( are fussy about the location formats (makeindex more so than more so than xindy) so the + id="dx1-65008">) so the glossaries package tries to ensure that special characters are escaped and allows for the location to be substituted for a format that’s more acceptable to the indexing application. This requires a bit of trickery to circumvent the problem posed by TeX’s asynchronous output routine, which can go wrong and also adds to the complexity of the document build. -

    If you’re sure that your locations will always expand to an acceptable format (or you’re prepared to +

    If you’re sure that your locations will always expand to an acceptable format (or you’re prepared to post-process the glossary file before passing it to the relevant indexing application) then use esclocations=false to + id="dx1-65009"> to avoid the complex escaping of location values. (See “Writing information to associated files” in the documented code for further details.) -

    This isn’t an issue for Options 

    This isn’t an issue for Options 1 or 4 as the locations are written to the aux file so no syntax conversion is + id="dx1-65010"> file so no syntax conversion is required. -

    +

    indexonlyfirst={boolean}

    -

    This is a boolean option that specifies whether to only add information to the external glossary file on

    This is a boolean option that specifies whether to only add information to the external glossary file on first use. The default is indexonlyfirst=false, which will add a line to the file every time one of the , which will add a line to the file every time one of the \gls-like or \glstext-like commands are used. Note that \glsadd will always add information to the external glossary + id="dx1-66002"> will always add information to the external glossary file2.4 (since + id="x1-66003f4"> (since that’s the purpose of that command). -

    Resetting the

    Resetting the first use flag with commands like \glsreset after an entry has been indexed will cause that + id="dx1-66004"> after an entry has been indexed will cause that entry to be indexed multiple times if it’s used again after the reset. Likewise unsetting the first use flag before an entry has been indexed will prevent it from being indexed (unless specifically indexed with \glsadd).
    -

    -

    You can customise this by redefining -


    +

    You can customise this by redefining +


    \glswriteentry{label}{wr-code}

    -

    +

    where ⟨label⟩ is the entry’s label and ⟨wr-code⟩ is the code that writes the entry’s information to the external file. @@ -10079,7 +10118,7 @@ class="cmtt-10">\glswriteentry is:

    -
    +   
     \newcommand*{\glswriteentry}[2]{%
       \ifglsindexonlyfirst
         \ifglsused{#1}{}{#2}%
    @@ -10088,418 +10127,418 @@ class="cmtt-10">\glswriteentry is:
       \fi
     }
     
    -

    This checks the

    This checks the indexonlyfirst package option (using package option (using \ifglsindexonlyfirst) and does ⟨wr-code⟩ if this is false otherwise it only does ⟨wr-code⟩ of the entry hasn’t been used. -

    For example, suppose you only want to index the first use for entries in the

    For example, suppose you only want to index the first use for entries in the acronym glossary and not in the main (or any other) glossary:

    -
    +   
     \renewcommand*{\glswriteentry}[2]{%
      \ifthenelse{\equal{\glsentrytype{#1}}{acronym}}
      {\ifglsused{#1}{}{#2}}%
      {#2}%
     }
     
    -

    Here I’ve used

    Here I’ve used \ifthenelse to ensure the arguments of \equal are fully expanded before the comparison is made. -

    With the

    With the glossaries-extra package it’s possible to only index first use for particular categories. For example, if you only want this enabled for abbreviations and acronyms then you can set the indexonlyfirst attribute for the + id="dx1-66007"> attribute for the abbreviation and acronym categories. (Instead of using the indexonlyfirst package option.) See the + id="dx1-66008"> package option.) See the glossaries-extra manual for further details. -

    +

    indexcrossrefs={boolean} (glossaries-extra.sty)

    -

    If

    If true, this will automatically index (\glsadd) any cross-referenced entries that haven’t been marked as used at + id="dx1-67001">) any cross-referenced entries that haven’t been marked as used at the end of the document. Increases document build time. See glossaries-extra manual for further details. -

    Note that

    Note that bib2gls can automatically find dependent entries when it parses the can automatically find dependent entries when it parses the bib file. Use the selection + id="dx1-67003"> file. Use the selection option to \GlsXtrLoadResources to determine the selection of dependencies.
    -

    -

    + id="dx1-67004"> to determine the selection of dependencies.

    +

    +

    autoseeindex={boolean} (glossaries-extra.sty)

    -

    If

    If true, makes the see and and seealso keys automatically index the cross-reference (with keys automatically index the cross-reference (with \glssee) when the entry + id="dx1-68003">) when the entry is defined (default, and the only option with just the base glossaries package). -

    With

    With bib2gls, use the selection option to , use the selection option to \GlsXtrLoadResources to determine the selection of + id="dx1-68005"> to determine the selection of dependencies.
    -

    -

    +

    +

    record={value} (glossaries-extra.sty)

    -

    If not

    If not off, this option indicates that bib2gls is required. If the value is omitted, is required. If the value is omitted, only is assumed. Permitted values:

    -

    +

    off

    -

    bib2gls isn’t being used; + id="dx1-69002"> isn’t being used;

    -

    +

    only

    -

    bib2gls is being used to fetch entries from a is being used to fetch entries from a bib file, to sort the entries and collate the file, to sort the entries and collate the number lists, where the location information is the same as for Options s, where the location information is the same as for Options 13;

    -

    +

    nameref

    -

    like

    like only but provides extra information that allows the associated title to be used instead of the location number and provides better support for hyperlinked locations;

    -

    +

    hybrid

    -

    a hybrid approach where

    a hybrid approach where bib2gls is used to fetch entries from a is used to fetch entries from a bib file but file but makeindex or or xindy + id="dx1-69009"> are used for the indexing. This requires a more complicated document build and isn’t recommended.

    -

    See

    See glossaries-extra manual for further details. -

    +

    equations={boolean} (glossaries-extra.sty)

    -

    If

    If true, this option will cause the default location counter to automatically switch to equation when inside a numbered equation environment. -

    +

    floats={boolean} (glossaries-extra.sty)

    -

    If

    If true, this option will cause the default location counter to automatically switch to the corresponding counter when inside a float. (Remember that with floats it’s the \caption command that increments the counter so the location will be incorrect if an entry is indexed within the float before the caption.) -

    +

    indexcounter (glossaries-extra.sty)

    -

    This valueless option is primarily intended for use with

    This valueless option is primarily intended for use with bib2gls and and hyperref allowing the page location + id="dx1-72002"> allowing the page location hyperlink target to be set to the relevant point within the page (rather than the top of the page). Unexpected results will occur with other indexing methods. See glossaries-extra manual for further details. -

    +

    -

    Top

    2.5 Sorting Options

    -

    This section is mostly for Options 

    This section is mostly for Options 2 and 3. Only the sort and and order options are applicable for + id="dx1-73002"> options are applicable for Option 1. -

    With Options 

    With Options 46, only sort=none is applicable (and this is automatically implemented by + id="dx1-73003"> is applicable (and this is automatically implemented by record=only and and record=nameref). With ). With bib2gls, the sort method is provided in the optional argument of + id="dx1-73006">, the sort method is provided in the optional argument of \GlsXtrLoadResources not with the not with the sort package option. There’s no sorting with Options 5 and 6.
    -

    -

    +

    +

    sanitizesort={boolean}

    -

    This is a boolean option that determines whether or not to

    This is a boolean option that determines whether or not to sanitize the sort value when writing to the external + id="dx1-74001"> the sort value when writing to the external glossary file. For example, suppose you define an entry as follows:

    -
    +   
     \newglossaryentry{hash}{name={\#},sort={#},
      description={hash symbol}}
     
    -

    The sort value (

    The sort value (#) must be sanitized before writing it to the glossary file, otherwise LaTeX will try to interpret it as a parameter reference. If, on the other hand, you want the sort value expanded, you need to switch off the sanitization. For example, suppose you do:

    -
    +   
     \newcommand{\mysortvalue}{AAA}
     \newglossaryentry{sample}{%
       name={sample},
       sort={\mysortvalue},
       description={an example}}
     
    -

    and you actually want

    and you actually want \mysortvalue expanded, so that the entry is sorted according to AAA, then use the package option sanitizesort=false. -

    The default for Options . +

    The default for Options 2 and 3 is sanitizesort=true, and the default for , and the default for Option 1 is sanitizesort=false. -

    + id="dx1-74004">. +

    sort={value}

    -

    If you use Options 

    If you use Options 2 or 3, this package option is the only way of specifying how to sort the glossaries. Only Option 1 allows you to specify sort methods for individual glossaries via the sort key in the optional argument + id="dx1-75001"> key in the optional argument of \printnoidxglossary. If you have multiple glossaries in your document and you are using . If you have multiple glossaries in your document and you are using Option 1, only use the package options sort=def or or sort=use if you want to set this sort method for if you want to set this sort method for all your glossaries. -

    This is a ⟨

    This is a ⟨key⟩=⟨value⟩ option where ⟨value⟩ may be one of the following:

    • -

      standard : entries are sorted according to the value of the : entries are sorted according to the value of the sort key used in key used in \newglossaryentry (if + id="dx1-75007"> (if present) or the name key (if key (if sort key is missing); + id="dx1-75009"> key is missing);

    • -

      def : entries are sorted in the order in which they were defined (the : entries are sorted in the order in which they were defined (the sort key in key in \newglossaryentry is ignored);

    • -

      use : entries are sorted according to the order in which they are used in the document (the : entries are sorted according to the order in which they are used in the document (the sort + id="dx1-75013"> key in \newglossaryentry is ignored). -

      Both

      Both sort=def and and sort=use set the sort key to a six digit number via -


      set the sort key to a six digit number via +


      \glssortnumberfmt{number}

      -

      +

      (padded with leading zeros, where necessary). This can be redefined, if required, before the entries are defined (in the case of sort=def) or before the entries are used (in the case of ) or before the entries are used (in the case of sort=use). + id="dx1-75018">).

    • -

      none : this setting is new to version 4.30 and is only for documents that don’t use : this setting is new to version 4.30 and is only for documents that don’t use \makeglossaries (Options 2 or \makenoidxglossaries (Option 1). It omits the code used to sanitize or escape the sort value, since it’s not required. This can help to improve the document build speed, especially if there are a large number of entries. -

      This option can’t be used with

      This option can’t be used with \printglossary or \printnoidxglossary (or the iterative versions glossaries-extra’s \printunsrtglossary (Option 5).

    -

    Note that the group styles (such as

    Note that the group styles (such as listgroup) are incompatible with the ) are incompatible with the sort=use and and sort=def options. -

    The default is options. +

    The default is sort=standard. When the standard sort option is in use, you can hook into the sort mechanism + id="dx1-75023">. When the standard sort option is in use, you can hook into the sort mechanism by redefining: -



    \glsprestandardsort{sort cs}{type}{label}

    -

    +

    where ⟨sort cs⟩ is a temporary control sequence that stores the sort value (which was either explicitly set via the sort key or implicitly set via the key or implicitly set via the name key) before any escaping of the key) before any escaping of the makeindex//xindy special characters is + id="dx1-75028"> special characters is performed. By default \glsprestandardsort just does: -



    \glsdosanitizesort

    -

    +

    which sanitizes ⟨s ⟨sort cs⟩ if the sanitizesort package option is set (or does nothing if the package option + id="dx1-75031"> package option is set (or does nothing if the package option sanitizesort=false is used). -

    The other arguments, ⟨ is used). +

    The other arguments, ⟨type⟩ and ⟨label⟩, are the glossary type and the entry label for the current entry. Note that ⟨type⟩ will always be a control sequence, but ' class="cmti-10">label⟩ will be in the form used in the first argument of \newglossaryentry. -

    Redefining . +

    Redefining \glsprestandardsort won’t affect any entries that have already been defined and will have no effect at all if you are using sort=def or or sort=use.
    -

    + id="dx1-75035">.

    +

    -

    +

    Example 1 (Mixing Alphabetical and Order of Definition Sorting) -

    Suppose I have three glossaries: +

    Suppose I have three glossaries: main, acronym and notation, and let’s suppose I want the main and class="cmtt-10">acronym glossaries to be sorted alphabetically, but the notation type should be sorted in order of definition. -

    For

    For Option 1, the sort option can be used in option can be used in \printnoidxglossary: + id="dx1-75039">:

    -
    +   
     \printnoidxglossary[sort=word]
     \printnoidxglossary[type=acronym,sort=word]
     \printnoidxglossary[type=notation,sort=def]
     
    -

    -

    For Options 

    +

    For Options 2 or 3, I can set the sort to standard (which is the default, but can be explicitly set via the @@ -10635,7 +10674,7 @@ package option sort=standard), and I can either define all my ), and I can either define all my main and acronym entries, then redefine sort cs⟩ if ⟨type⟩ is notation. -

    The first option can be achieved as follows: +

    The first option can be achieved as follows:

    -
    +   
     \newcounter{sortcount}
     \renewcommand{\glsprestandardsort}[3]{%
       \stepcounter{sortcount}%
       \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%
     }
     
    -

    The second option can be achieved as follows: +

    The second option can be achieved as follows:

    -
    +   
     \newcounter{sortcount}
     \renewcommand{\glsprestandardsort}[3]{%
       \ifdefstring{#2}{notation}%
    @@ -10676,24 +10715,24 @@ class="cmtt-10">notation.
       }%
     }
     
    -

    (

    (\ifdefstring is defined by the etoolbox package.) For a complete document, see the sample file + id="dx1-75041"> package.) For a complete document, see the sample file sampleSort.tex.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    +

    Example 2 (Customizing Standard Sort (Options 2 or 3)) -

    Suppose you want a glossary of people and you want the names listed as ⟨ +

    Suppose you want a glossary of people and you want the names listed as ⟨first-name⟩ ⟨surname⟩ in the glossary, but you want the names sorted by ⟨}{surname} that you can use in the name key when you define the entry, but + id="dx1-75044"> key when you define the entry, but hook into the standard sort mechanism to temporarily redefine \name while the sort value is being set. -

    First, define two commands to set the person’s name: +

    First, define two commands to set the person’s name:

    -
    +   
     \newcommand{\sortname}[2]{#2, #1}
     \newcommand{\textname}[2]{#1 #2}
     
    -

    and

    and \name needs to be initialised to \textname:

    -
    +   
     \let\name\textname
     
    -

    Now redefine

    Now redefine \glsprestandardsort so that it temporarily sets \name to \sortname and expands the sort @@ -10740,7 +10779,7 @@ text:

    -
    +   
     \renewcommand{\glsprestandardsort}[3]{%
      \let\name\sortname
      \edef#1{\expandafter\expandonce\expandafter{#1}}%
    @@ -10748,215 +10787,215 @@ text:
      \glsdosanitizesort
     }
     
    -

    (The somewhat complicate use of

    (The somewhat complicate use of \expandafter etc helps to protect fragile commands, but care is still needed.) -

    Now the entries can be defined: +

    Now the entries can be defined:

    -
    +   
     \newglossaryentry{joebloggs}{name={\name{Joe}{Bloggs}},
       description={some information about Joe Bloggs}}
     \newglossaryentry{johnsmith}{name={\name{John}{Smith}},
       description={some information about John Smith}}
     
    -

    For a complete document, see the sample file

    For a complete document, see the sample file samplePeople.tex.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    order={value}

    -

    This may take two values:

    This may take two values: word or or letter. The default is word ordering. -

    Note that with Options . The default is word ordering. +

    Note that with Options 2 and 3, the order option has no effect if you don’t use option has no effect if you don’t use makeglossaries. + id="dx1-76004">.
    -

    -

    If you use

    +

    If you use Option 1, this setting will be used if you use sort=standard in the optional argument of \printnoidxglossary: + id="dx1-76006">:

    -
    +   
     \printnoidxglossary[sort=standard]
     
    -

    Alternatively, you can specify the order for individual glossaries: +

    Alternatively, you can specify the order for individual glossaries:

    -
    +   
     \printnoidxglossary[sort=word]
     \printnoidxglossary[type=acronym,sort=letter]
     
    -

    -

    With

    +

    With bib2gls, use the , use the break-at option in option in \GlsXtrLoadResources instead of instead of order.
    -

    -

    +

    +

    makeindex

    -

    (

    (Option 2) The glossary information and indexing style file will be written in makeindex format. If you use + id="dx1-77001"> format. If you use makeglossaries, it will automatically detect that it needs to call , it will automatically detect that it needs to call makeindex. If you don’t use . If you don’t use makeglossaries, + id="dx1-77004">, you need to remember to use makeindex not not xindy. The indexing style file will been given a . The indexing style file will been given a ist + id="dx1-77007"> extension. -

    You may omit this package option if you are using

    You may omit this package option if you are using Option 2 as this is the default. It’s available in case you need to override the effect of an earlier occurrence of xindy in the package option list. -

    + id="dx1-77008"> in the package option list. +

    xindy

    -

    (

    (Option 3) The glossary information and indexing style file will be written in xindy format. If you use + id="dx1-78001"> format. If you use makeglossaries, it will automatically detect that it needs to call , it will automatically detect that it needs to call xindy. If you don’t use . If you don’t use makeglossaries, + id="dx1-78004">, you need to remember to use xindy not not makeindex. The indexing style file will been given a . The indexing style file will been given a xdy + id="dx1-78007"> extension. -

    This package option may additionally have a value that is a ⟨

    This package option may additionally have a value that is a ⟨key⟩=⟨value⟩ comma-separated list to override the language and codepage. For example:

    -
    +   
     \usepackage[xindy={language=english,codepage=utf8}]
       {glossaries}
     
    -

    You can also specify whether you want a number group in the glossary. This defaults to true, but can be +

    You can also specify whether you want a number group in the glossary. This defaults to true, but can be suppressed. For example:

    -
    +   
     \usepackage[xindy={glsnumbers=false}]{glossaries}
     
    -

    If no value is supplied to this package option (either simply writing

    If no value is supplied to this package option (either simply writing xindy or writing xindy={}) then the language, codepage and number group settings are unchanged. See §??sec:xindy 14 Xindy (Option 3) for further details on using xindy with the with the glossaries package. -

    +

    xindygloss

    -

    (

    (Option 3) This is equivalent to xindy={} (that is, the xindy option without any value supplied) and may be + id="dx1-79001"> option without any value supplied) and may be used as a document class option. The language and code page can be set via \GlsSetXdyLanguage and + id="dx1-79002"> and \GlsSetXdyCodePage (see (see §??sec:langenc 14.1 Language and Encodings.) -

    +

    xindynoglsnumbers

    -

    (

    (Option 3) This is equivalent to xindy={glsnumbers=false} and may be used as a document class option. -

    +

    automake={value}

    -

    This is option was introduced to version 4.08 as a boolean option. As from version 4.42 it may now take three +

    This is option was introduced to version 4.08 as a boolean option. As from version 4.42 it may now take three values: false (default), true or automake=true will attempt to run will attempt to run makeindex or or xindy using TeX’s using TeX’s \write18 mechanism + id="dx1-81004"> mechanism at the end of the document. The option automake=immediate will attempt to run will attempt to run makeindex or + id="dx1-81006"> or xindy at the start of at the start of \makeglossaries using using \immediate (before the glossary files have been opened). -

    In the case of

    In the case of automake=true, the associated files are created at the end of the document ready + id="dx1-81009">, the associated files are created at the end of the document ready for the next LaTeX run. Since there is a possibility of commands such as \gls occurring on the last page of the document, it’s not possible to use \write18 fails. In such cases, you will need to use automake=immediate + id="dx1-81010"> instead. -

    With

    With automake=immediate, you will get a warning on the first LaTeX run as the associated glossary files + id="dx1-81011">, you will get a warning on the first LaTeX run as the associated glossary files don’t exist yet. -

    Since this mechanism can be a security risk, some TeX distributions disable it completely, in which case this +

    Since this mechanism can be a security risk, some TeX distributions disable it completely, in which case this option won’t have an effect. (If this option doesn’t appear to work, search the log file for “runsystem” and see if it is followed by “enabled” or “disabled”.) -

    Some distributions allow

    Some distributions allow \write18 in a restricted mode. This mode has a limited number of trusted applications, which usually includes makeindex but may not include but may not include xindy. So if you have the restricted mode + id="dx1-81013">. So if you have the restricted mode on, automake should work with should work with makeindex but may not work with but may not work with xindy. -

    However even in unrestricted mode this option may not work with . +

    However even in unrestricted mode this option may not work with xindy as as xindy uses language names that + id="dx1-81018"> uses language names that don’t always correspond with babel’s language names. (The ’s language names. (The makeglossaries script applies mappings to assist + id="dx1-81020"> script applies mappings to assist you.) Note that you still need at least two LaTeX runs to ensure the document is up-to-date with this setting. -

    Since this package option attempts to run the

    Since this package option attempts to run the indexing application on every LaTeX run, its use should be considered a last resort for those who can’t work out how to incorporate the indexing application into their document build. The default value for this option is automake=false. -

    + id="dx1-81021">. +

    disablemakegloss

    -

    This valueless option indicates that

    This valueless option indicates that \makeglossaries and and \makenoidxglossaries should be disabled. + id="dx1-82002"> should be disabled. This option is provided in the event that you have to use a class or package that disregards the advice in §??sec:indexingoptions 1.2 Indexing Options and automatically performs \makeglossaries or + id="dx1-82003"> or \makenoidxglossaries but you don’t want this. (For example, you want to use a different indexing method or + id="dx1-82004"> but you don’t want this. (For example, you want to use a different indexing method or you want to disable indexing while working on a draft document.) -

    This option may be passed in the standard document class option list or passed using

    This option may be passed in the standard document class option list or passed using \PassOptionsToPackage before glossaries is loaded. Note that this does nothing if is loaded. Note that this does nothing if \makeglossaries or or \makenoidxglossaries has + id="dx1-82007"> has already been used whilst enabled. -

    +

    restoremakegloss

    -

    Cancels the effect of

    Cancels the effect of disablemakegloss. This option may be used in . This option may be used in \setupglossaries. It issues a warning if \makeglossaries or or \makenoidxglossaries has already been used whilst enabled. For + id="dx1-83003"> has already been used whilst enabled. For example, suppose the class customclass.cls automatically loads glossaries and does -

    +   
     \documentclass[disablemakegloss]{customclass}
     \newglossary*{functions}{Functions}
     \setupglossaries{restoremakegloss}
     \makeglossaries
     
    -

    or +

    or

    -
    +   
     \PassOptionsToPackage{disablemakegloss}{glossaries}
     \documentclass{customclass}
     \newglossary*{functions}{Functions}
     \setupglossaries{restoremakegloss}
     \makeglossaries
     
    -

    -

    Note that restoring these commands doesn’t necessarily mean that they can be used. It just means that their +

    +

    Note that restoring these commands doesn’t necessarily mean that they can be used. It just means that their normal behaviour given the current settings will apply. For example, if you use the record=only or or record=nameref + id="dx1-83005"> options with glossaries-extra then you can’t use \makeglossaries or \makenoidxglossaries regardless of restoremakegloss. -

    + id="dx1-83006">. +

    -

    Top

    2.6 Glossary Type Options

    -

    +

    nohypertypes={list}

    -

    Use this option if you have multiple glossaries and you want to suppress the entry hyperlinks for a particular +

    Use this option if you have multiple glossaries and you want to suppress the entry hyperlinks for a particular glossary or glossaries. The value of this option should be a comma-separated list of glossary types where \gls + id="dx1-85001"> etc shouldn’t have hyperlinks by default. Make sure you enclose the value in braces if it contains any commas. Example:

    -
    +   
     \usepackage[acronym,nohypertypes={acronym,notation}]
       {glossaries}
     \newglossary[nlg]{notation}{not}{ntn}{Notation}
     
    -

    The values must be fully expanded, so don’t try

    The values must be fully expanded, so don’t try nohypertypes=\acronymtype. You may also + id="dx1-85002">. You may also use -



    \GlsDeclareNoHyperList{list}

    -

    +

    instead or additionally. See §??sec:glslink 5.1 Links to Glossary Entries for further details. -

    +

    nomain

    -

    This suppresses the creation of the main glossary and associated

    This suppresses the creation of the main glossary and associated glo file, if unrequired. Note that if you use this + id="dx1-86001"> file, if unrequired. Note that if you use this option, you must create another glossary in which to put all your entries (either via the acronym (or (or acronyms) + id="dx1-86003">) package option described in §??sec:pkgopts-acronym 2.7 Acronym and Abbreviation Options or via the symbols, + id="dx1-86004">, numbers or or index options described in options described in §??sec:pkgopts-other 2.9 Other Options or via \newglossary described in + id="dx1-86007"> described in §??sec:newglossary 9 Defining New Glossaries). -

    If you don’t use the main glossary and you don’t use this option,

    If you don’t use the main glossary and you don’t use this option, makeglossaries will produce a warning. + id="dx1-86008"> will produce a warning.
    -

    +

     glossary.
    If you did actually want to use the main glossary and you see this warning, check that you have referenced the entries in that glossary via commands such as \gls. -

    + id="dx1-86009">. +

    symbols

    -

    This valueless option defines a new glossary type with the label

    This valueless option defines a new glossary type with the label symbols via

    -
    +   
     \newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
     
    -

    It also defines -


    It also defines +


    \printsymbols[options]

    -

    +

    which is a synonym for

    \printglossary[type=symbols,options]
    -

    If you use

    If you use Option 1, you need to use:

    \printnoidxglossary[type=symbols,options]
    to display the list of symbols. -

    Remember to use the

    Remember to use the nomain package option if you’re only interested in using this package option if you’re only interested in using this symbols glossary and don’t intend to use the main glossary.
    -

    -

    The

    +

    The glossaries-extra package has a slightly modified version of this option which additionally provides \glsxtrnewsymbol as a convenient shortcut method for defining symbols. See the as a convenient shortcut method for defining symbols. See the glossaries-extra manual for further details.
    -

    -

    +

    +

    numbers

    -

    This valueless option defines a new glossary type with the label

    This valueless option defines a new glossary type with the label numbers via

    -
    +   
     \newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
     
    -

    It also defines -


    It also defines +


    \printnumbers[options]

    -

    +

    which is a synonym for

    \printglossary[type=numbers,options]
    -

    If you use

    If you use Option 1, you need to use:

    \printnoidxglossary[type=numbers,options]
    to display the list of numbers. -

    Remember to use the

    Remember to use the nomain package option if you’re only interested in using this package option if you’re only interested in using this numbers glossary and don’t intend to use the main glossary.
    -

    -

    The

    +

    The glossaries-extra package has a slightly modified version of this option which additionally provides \glsxtrnewnumber as a convenient shortcut method for defining numbers. See the as a convenient shortcut method for defining numbers. See the glossaries-extra manual for further details.
    -

    -

    +

    +

    index

    -

    This valueless option defines a new glossary type with the label

    This valueless option defines a new glossary type with the label index via

    -
    +   
     \newglossary[ilg]{index}{ind}{idx}{\indexname}%
     
    -

    It also defines -


    It also defines +


    \newterm[options]{term}

    -

    +

    which is a synonym for

    \newglossaryentry{term}[type=index,name={term},%
    description=\nopostdesc,options]
    and -



    \printindex[options]

    -

    +

    which is a synonym for

    \printglossary[type=index,options]
    -

    If you use

    If you use Option 1, you need to use:

    \printnoidxglossary[type=index,options]
    to display this glossary. -

    Remember to use the

    Remember to use the nomain package option if you’re only interested in using this package option if you’re only interested in using this index glossary and don’t intend to use the main glossary. Note that you can’t mix this option with \index. Either use + id="dx1-89008">. Either use glossaries for the indexing or use a custom indexing package, such as makeidx, , index or or imakeidx. (You + id="dx1-89011">. (You can, of course, load one of those packages and load glossaries without the index package option.) + id="dx1-89012"> package option.)
    -

    -

    Since the index isn’t designed for terms with descriptions, you might also want to disable the hyperlinks for +

    +

    Since the index isn’t designed for terms with descriptions, you might also want to disable the hyperlinks for this glossary using the package option nohypertypes=index or the command + id="dx1-89013"> or the command
    \GlsDeclareNoHyperList{index}
    -

    The example file

    The example file sample-index.tex illustrates the use of the index package option. + id="dx1-89015"> package option. -

    +

    noglossaryindex

    -

    This valueless option switches off

    This valueless option switches off index if if index has been passed implicitly (for example, through global + id="dx1-90002"> has been passed implicitly (for example, through global document options). This option can’t be used in \setupglossaries. -

    +

    -

    Top

    2.7 Acronym and Abbreviation Options

    -

    +

    acronym={boolean}

    -

    If true, this creates a new glossary with the label

    If true, this creates a new glossary with the label acronym. This is equivalent to:

    -
    +   
     \newglossary[alg]{acronym}{acr}{acn}{\acronymname}
     
    -

    It will also define -


    It will also define +


    \printacronyms[options]

    -

    +

    that’s equivalent to

    \printglossary[type=acronym,options] @@ -11557,162 +11596,162 @@ class="cmtt-10">]
    (unless that command is already defined before the beginning of the document or the package option compatible-3.07 is used). -

    If you are using is used). +

    If you are using Option 1, you need to use

    \printnoidxglossary[type=acronym,options]
    to display the list of acronyms. -

    If the

    If the acronym package option is used, package option is used, \acronymtype is set to is set to acronym otherwise it is set to main.2.5 + id="x1-92007f5"> Entries that are defined using \newacronym are placed in the glossary whose label is given by are placed in the glossary whose label is given by \acronymtype, + id="dx1-92014">, unless another glossary is explicitly specified. -

    Remember to use the

    Remember to use the nomain package option if you’re only interested in using this package option if you’re only interested in using this acronym glossary. (That is, you don’t intend to use the main glossary.)
    -

    -

    The

    +

    The glossaries-extra extension package comes with an analogous abbreviations option, which creates a new + id="dx1-92016"> option, which creates a new glossary with the label abbreviations and sets the command \glsxtrabbrvtype to this. If the to this. If the acronym option + id="dx1-92018"> option hasn’t also been used, then \acronymtype will be set to will be set to \glsxtrabbrvtype. This enables both . This enables both \newacronym + id="dx1-92021"> and \newabbreviation to use the same glossary. -

    Make sure you have at least v1.42 of to use the same glossary. +

    Make sure you have at least v1.42 of glossaries-extra if you use the acronym (or (or acronyms) package option + id="dx1-92024">) package option with the extension package to avoid a bug that interferes with the abbreviation style.

    -

    -

    +

    +

    acronyms

    -

    This is equivalent to

    This is equivalent to acronym=true and may be used in the document class option list. + id="dx1-93001"> and may be used in the document class option list. -

    +

    abbreviations (glossaries-extra.sty)

    -

    This valueless option creates a new glossary type using: +

    This valueless option creates a new glossary type using:

    -
    +   
     \newglossary[glg-abr]{abbreviations}{gls-abr}{glo-abr}{\abbreviationsname}
     
    -

    The label can be accessed with

    The label can be accessed with \glsxtrabbrvtype, which is analogous to , which is analogous to \acronymtype. See glossaries-extra manual for further details. -

    +

    acronymlists={value}

    -

    By default, only the

    By default, only the \acronymtype glossary is considered to be a list of acronyms. If you have other lists of acronyms, you can specify them as a comma-separated list in the value of acronymlists. For example, if you use + id="dx1-95001">. For example, if you use the acronym package option but you also want the package option but you also want the main glossary to also contain a list of acronyms, you can do:

    -
    +   
     \usepackage[acronym,acronymlists={main}]{glossaries}
     
    -

    No check is performed to determine if the listed glossaries exist, so you can add glossaries you haven’t defined +

    No check is performed to determine if the listed glossaries exist, so you can add glossaries you haven’t defined yet. For example:

    -
    +   
     \usepackage[acronym,acronymlists={main,acronym2}]
       {glossaries}
     \newglossary[alg2]{acronym2}{acr2}{acn2}%
       {Statistical Acronyms}
     
    -

    You can use -


    You can use +


    \DeclareAcronymList{list}

    -

    +

    instead of or in addition to the acronymlists option. This will add the glossaries given in ⟨ option. This will add the glossaries given in ⟨list⟩ to the list of glossaries that are identified as lists of acronyms. To replace the list of acronym lists with a new list use: -



    \SetAcronymLists{list}

    -

    -

    You can determine if a glossary has been identified as being a list of acronyms using: -


    +

    You can determine if a glossary has been identified as being a list of acronyms using: +


    \glsIfListOfAcronyms{label}{true part}{false part}

    -

    -

    This option and associated commands are incompatible with

    +

    -

    -

    +

    +

    shortcuts

    -

    This option provides shortcut commands for acronyms. See

    This option provides shortcut commands for acronyms. See §??sec:acronyms 6 Acronyms and Other Abbreviations for further details. Alternatively you can use: -



    \DefineAcronymSynonyms

    -

    -

    The

    +

    The glossaries-extra package provides additional shortcuts.
    -

    -

    +

    +

    -

    Top

    2.8 Deprecated Acronym Style Options

    -

    The package options listed in this section are now deprecated but are kept for backward-compatibility. Use +

    The package options listed in this section are now deprecated but are kept for backward-compatibility. Use \setacronymstyle instead. See instead. See §??sec:acronyms 6 Acronyms and Other Abbreviations for further details. -

    +

    description

    -

    This option changes the definition of

    This option changes the definition of \newacronym to allow a description. This option may be replaced + id="dx1-98001"> to allow a description. This option may be replaced by

    -
    +   
     \setacronymstyle{long-short-desc}
     
    -

    or (with

    or (with smallcaps) + id="dx1-98002">)

    -
    +   
     \setacronymstyle{long-sc-short-desc}
     
    -

    or (with

    or (with smaller) + id="dx1-98003">)

    -
    +   
     \setacronymstyle{long-sm-short-desc}
     
    -

    or (with

    or (with footnote) + id="dx1-98004">)

    -
    +   
     \setacronymstyle{footnote-desc}
     
    -

    or (with

    or (with footnote and and smallcaps) + id="dx1-98006">)

    -
    +   
     \setacronymstyle{footnote-sc-desc}
     
    -

    or (with

    or (with footnote and and smaller) + id="dx1-98008">)

    -
    +   
     \setacronymstyle{footnote-sm-desc}
     
    -

    or (with

    or (with dua) + id="dx1-98009">)

    -
    +   
     \setacronymstyle{dua-desc}
     
    -

    -

    +

    +

    smallcaps

    -

    This option changes the definition of

    This option changes the definition of \newacronym and the way that acronyms are displayed. This option may + id="dx1-99001"> and the way that acronyms are displayed. This option may be replaced by:

    -
    +   
     \setacronymstyle{long-sc-short}
     
    -

    or (with

    or (with description) + id="dx1-99002">)

    -
    +   
     \setacronymstyle{long-sc-short-desc}
     
    -

    or (with

    or (with description and and footnote) + id="dx1-99004">)

    -
    +   
     \setacronymstyle{footnote-sc-desc}
     
    -

    -

    +

    +

    smaller

    -

    This option changes the definition of

    This option changes the definition of \newacronym and the way that acronyms are displayed. -

    If you use this option, you will need to include the and the way that acronyms are displayed. +

    If you use this option, you will need to include the relsize package or otherwise define package or otherwise define \textsmaller or + id="dx1-100003"> or redefine \acronymfont.
    -

    + id="dx1-100004">.

    +

    This option may be replaced by:

    -
    +   
     \setacronymstyle{long-sm-short}
     
    -

    or (with

    or (with description) + id="dx1-100005">)

    -
    +   
     \setacronymstyle{long-sm-short-desc}
     
    -

    or (with

    or (with description and and footnote) + id="dx1-100007">)

    -
    +   
     \setacronymstyle{footnote-sm-desc}
     
    -

    -

    +

    +

    footnote

    -

    This option changes the definition of

    This option changes the definition of \newacronym and the way that acronyms are displayed. This option may + id="dx1-101001"> and the way that acronyms are displayed. This option may be replaced by:

    -
    +   
     \setacronymstyle{footnote}
     
    -

    or (with

    or (with smallcaps) + id="dx1-101002">)

    -
    +   
     \setacronymstyle{footnote-sc}
     
    -

    or (with

    or (with smaller) + id="dx1-101003">)

    -
    +   
     \setacronymstyle{footnote-sm}
     
    -

    or (with

    or (with description) + id="dx1-101004">)

    -
    +   
     \setacronymstyle{footnote-desc}
     
    -

    or (with

    or (with smallcaps and and description) + id="dx1-101006">)

    -
    +   
     \setacronymstyle{footnote-sc-desc}
     
    -

    or (with

    or (with smaller and and description) + id="dx1-101008">)

    -
    +   
     \setacronymstyle{footnote-sm-desc}
     
    -

    -

    +

    +

    dua

    -

    This option changes the definition of

    This option changes the definition of \newacronym so that acronyms are always expanded. This option may be + id="dx1-102001"> so that acronyms are always expanded. This option may be replaced by:

    -
    +   
     \setacronymstyle{dua}
     
    -

    or (with

    or (with description) + id="dx1-102002">)

    -
    +   
     \setacronymstyle{dua-desc}
     
    -

    -

    +

    +

    -

    Top

    2.9 Other Options

    -

    Other available options that don’t fit any of the above categories are described below. -

    +

    Other available options that don’t fit any of the above categories are described below. +

    accsupp (glossaries-extra.sty)

    -

    Load the

    Load the glossaries-accsupp package. -

    + id="dx1-104001"> package. +

    prefix (glossaries-extra.sty)

    -

    Load the

    Load the glossaries-prefix package. -

    + id="dx1-105001"> package. +

    nomissingglstext={boolean} (glossaries-extra.sty)

    -

    This option may be used to suppress the boilerplate text generated by

    This option may be used to suppress the boilerplate text generated by \printglossary if the glossary file is missing. -

    +

    compatible-2.07={boolean}

    -

    Compatibility mode for old documents created using version 2.07 or below. +

    Compatibility mode for old documents created using version 2.07 or below. -

    +

    compatible-3.07={boolean}

    -

    Compatibility mode for old documents created using version 3.07 or below. -

    +

    Compatibility mode for old documents created using version 3.07 or below. +

    kernelglossredefs={value}

    -

    As a legacy from the precursor

    As a legacy from the precursor glossary package, the standard glossary commands provided by the LaTeX kernel + id="dx1-109001"> package, the standard glossary commands provided by the LaTeX kernel (\makeglossary and \glossary) are redefined in terms of the glossaries package’s commands. However, they were never documented in this user manual, and the conversion guide (“Upgrading from the glossary package to the glossaries package”) explicitly discourages their use. -

    The use of those kernel commands (instead of the appropriate commands documented in this user guide) are +

    The use of those kernel commands (instead of the appropriate commands documented in this user guide) are deprecated, and you will now get a warning if you try using them. -

    In the event that you require the original form of these kernel commands, for example, if you need to use the +

    In the event that you require the original form of these kernel commands, for example, if you need to use the glossaries package with another class or package that also performs glossary-style indexing, then you can restore these commands to their previous definition (that is, their definitions prior to loading the kernelglossredefs=false. You may also need to use the . You may also need to use the nomain option in the event of file + id="dx1-109003"> option in the event of file extension conflicts. (In which case, you must provide a new default glossary for use with the glossaries + id="dx1-109004"> package.) -

    This option may take one of three values:

    This option may take one of three values: true (redefine with warnings, default), false (restore previous definitions) or nowarn (redefine without warnings, not recommended). -

    The only glossary-related commands provided by the LaTeX kernel are

    The only glossary-related commands provided by the LaTeX kernel are \makeglossary and \glossary. Other packages or classes may provide additional glossary-related commands or environments that conflict with @@ -12119,110 +12158,110 @@ Other packages or classes may provide additional glossary-related commands or en class="cmss-10">glossaries (such as \printglossary and theglossary). These non-kernel commands aren’t affected by this + id="dx1-109005">). These non-kernel commands aren’t affected by this package option, and you will have to find some way to resolve the conflict if you require both glossary mechanisms. (The glossaries package will override the existing definitions of package will override the existing definitions of \printglossary and theglossary.) -

    In general, if possible, it’s best to stick with just one package that provides a glossary mechanism. (The + id="dx1-109008">.) +

    In general, if possible, it’s best to stick with just one package that provides a glossary mechanism. (The glossaries package does check for the doc package and patches package and patches \PrintChanges.) -

    +

    -

    Top

    2.10 Setting Options After the Package is Loaded

    -

    Some of the options described above may also be set after the

    Some of the options described above may also be set after the glossaries package has been loaded using -



    \setupglossaries{key-val list}

    -

    +

    The following package options can’t be used in \setupglossaries: xindy, , xindygloss, , xindynoglsnumbers, + id="dx1-110004">, makeindex, , nolong, , nosuper, , nolist, , notree, , nostyles, , nomain, , compatible-2.07, , translate, , notranslate, , acronym. These + id="dx1-110015">. These options have to be set while the package is loading, except for the xindy sub-options which can + id="dx1-110016"> sub-options which can be set using commands like \GlsSetXdyLanguage (see (see §??sec:xindy 14 Xindy (Option 3) for further details). -

    If you need to use this command, use it as soon as possible after loading

    If you need to use this command, use it as soon as possible after loading glossaries otherwise you might end up using it too late for the change to take effect. For example, if you try changing the acronym styles (such as smallcaps) after you have started defining your acronyms, you are likely to get unexpected results. If you try + id="dx1-110018">) after you have started defining your acronyms, you are likely to get unexpected results. If you try changing the sort option after you have started to define entries, you may get unexpected results.
    -

    -

    With

    +

    With glossaries-extra, use \glossariesextrasetup instead.
    -

    + id="dx1-110019"> instead.

    +

    -

    -

    +

    Top

    3. Setting Up

    -

    In the preamble you need to indicate which method you want to use to generate the glossary +

    In the preamble you need to indicate which method you want to use to generate the glossary (or glossaries). The available options with both glossaries and glossaries-extra are summarized in §??sec:indexingoptions 1.2 Indexing Options. This chapter documents Options 13, which are provided by the @@ -12231,54 +12270,54 @@ href="#glo:glossaries-extra">glossaries-extra and bib2gls manuals for the full documentation of the other + id="dx1-111001"> manuals for the full documentation of the other options. -

    If you don’t need to display any glossaries, for example, if you are just using the

    If you don’t need to display any glossaries, for example, if you are just using the glossaries package to enable consistent formatting, then skip ahead to §??sec:newglosentry 4 Defining Glossary Entries.

    -

    Top

    3.1 Option 1

    -

    The command -


    The command +


    \makenoidxglossaries

    -

    +

    must be placed in the preamble. This sets up the internal commands required to make Option 1 work. If you omit \makenoidxglossaries none of the glossaries will be displayed. -

    +

    -

    Top

    3.2 Options 2 and 3

    -

    The command -


    The command +


    \makeglossaries

    -

    +

    must be placed in the preamble in order to create the customised makeindex ( (ist) or ) or xindy ( (xdy) style file (for + id="dx1-113005">) style file (for Options 2 or 3, respectively) and to ensure that glossary entries are written to the appropriate output files. If you omit \makeglossaries none of the glossary files will be created. -

    If you are using

    If you are using glossaries-extra, \makeglossaries has an optional argument that allows you to @@ -12290,8 +12329,8 @@ href="#option3">3. See glossaries-extra manual for further details.
    -

    -

    Note that some of the commands provided by the

    +

    Note that some of the commands provided by the glossaries package must not be used after \makeglossaries as they are required when creating the customised style file. If you attempt to use those @@ -12299,122 +12338,122 @@ commands after \makeglossaries you will generate an error. Similarly, there are some commands that must not be used before \makeglossaries. -

    You can suppress the creation of the customised

    You can suppress the creation of the customised xindy or or makeindex style file using -


    style file using +


    \noist

    -

    +

    That this command must not be used after \makeglossaries. -

    Note that if you have a custom

    Note that if you have a custom xdy file created when using file created when using glossaries version 2.07 or below, you will need to use the compatible-2.07 package option with it.
    + id="dx1-113010"> package option with it.
    -

    -

    The default name for the customised style file is given by

    +

    The default name for the customised style file is given by \jobname.ist ( (Option 2) or \jobname.xdy + id="dx1-113014"> (Option 3). This name may be changed using: -



    \setStyleFile{name}

    -

    +

    where ⟨name⟩ is the name of the style file without the extension. Note that this command must not be used after \makeglossaries. -

    Each glossary entry is assigned a

    Each glossary entry is assigned a number list that lists all the locations in the document where that entry + id="dx1-113016"> that lists all the locations in the document where that entry was used. By default, the location refers to the page number but this may be overridden using the counter package option. The default form of the location number assumes a full stop compositor + id="dx1-113017"> package option. The default form of the location number assumes a full stop compositor (e.g. 1.2), but if your location numbers use a different compositor (e.g. 1-2) you need to set this using -



    \glsSetCompositor{symbol}

    -

    +

    For example:

    -
    +   
     \glsSetCompositor{-}
     
    -

    This command must not be used after

    This command must not be used after \makeglossaries. -

    If you use

    If you use Option 3, you can have a different compositor for page numbers starting with an upper case alphabetical character using: -



    \glsSetAlphaCompositor{symbol}

    -

    +

    This command has no effect if you use Option 2. For example, if you want number lists containing a mixture of + id="dx1-113020">s containing a mixture of A-1 and 2.3 style formats, then do:

    -
    +   
     \glsSetCompositor{.}\glsSetAlphaCompositor{-}
     
    -

    See

    See §??sec:numberlists 12 Number Lists for further information about number lists. + id="dx1-113021">s.

    -

    -

    +

    Top

    4. Defining Glossary Entries

    -

    If you want to use

    If you want to use bib2gls, entries must be defined in , entries must be defined in bib files using the syntax described in the files using the syntax described in the bib2gls + id="dx1-114003"> user manual.
    -

    -

    Acronyms are covered in

    +

    Acronyms are covered in §??sec:acronyms 6 Acronyms and Other Abbreviations but they use the same underlying mechanism as all the other entries, so it’s a good idea to read this chapter first. The keys provided for \newglossaryentry can also be used in the optional argume class="cmtt-10">\newacronym, although some of them, such as first and and plural, interfere with the acronym styles. -

    All glossary entries must be defined before they are used, so it is better to define them in the preamble to + id="dx1-114005">, interfere with the acronym styles. +

    All glossary entries must be defined before they are used, so it is better to define them in the preamble to ensure this. In fact, some commands such as \longnewglossaryentry may only be used in the preamble. See §??sec:docdefs 4.8 Drawbacks With Defining Entries in the Document Environment for a discussion of the problems with defining entries within the document instead of in the preamble. (The glossaries-extra package has an option that provides a restricted form of document definitions that avoids some of the issues discussed in §??sec:docdefs 4.8 Drawbacks With Defining Entries in the Document Environment.) -

    Option 1 enforces the preamble-only restriction on \newglossaryentry. . Option 4 requires that definitions are provided in bib format. format. Option 5 requires either preamble-only definitions or the use of the glossaries-extra package option docdef=restricted.
    -

    -

    Only those entries that are indexed in the document (using any of the commands described in

    +

    Only those entries that are indexed in the document (using any of the commands described in §??sec:glslink +class="cmbx-10">5.1 Links to Glossary Entries, §??sec:glsadd 10 Adding an Entry to the Glossary Without Generating Text or §??sec:crossref 11 Cross-Referencing Entries) will appear in the glossary. See §??sec:printglossary 8 Displaying a Glossary to find out how to display the glossary. -

    New glossary entries are defined using the command: -


    New glossary entries are defined using the command: +


    \newglossaryentry{label}{key=value list}

    -

    +

    This is a short command, so values in ⟨key-val list⟩ can’t contain any paragraph breaks. Take care to enclose values containing any commas (,) or equal signs (=) with braces to hide them from the key=value list parser. -

    If you have a long description that needs to span multiple paragraphs, use -


    If you have a long description that needs to span multiple paragraphs, use +


    \longnewglossaryentry{label}{key=value list}{long description}

    -

    +

    instead. Note that this command may only be used in the preamble. Be careful of unwanted spaces. \longnewglossaryentry will remove trailing spaces in the description (via \longnewglossaryentry that doesn’t append either \unskip or \nopostdesc. -

    There are also commands that will only define the entry if it hasn’t already been defined: -


    There are also commands that will only define the entry if it hasn’t already been defined: +


    \provideglossaryentry{label}{key=value list}

    -

    +

    and -



    \longprovideglossaryentry{label}{long description}

    -

    +

    (These are both preamble-only commands.) -

    For all the above commands, the first argument, ⟨

    For all the above commands, the first argument, ⟨label⟩, must be a unique label with which to identify this entry. This can’t contain any non-expandable commands or active characters. The reason for this restriction is that the label is used to construct internal commands that store the associated information (similarly to commands like \label) and therefore must be able to expand to a valid control sequence name. -

    Note that although an

    Note that although an extended Latin character or other or other non-Latin character, such as é or + id="dx1-114013">, such as é or ß, looks like a plain character in your .tex file, it’s actually a macro (an active character) and therefore can’t be used in the label. (This applies to LaTeX rather than XeLaTeX.) Also be careful of babel’s options that change certain punctuation characters (such as ’s options that change certain punctuation characters (such as : or -) to active characters.
    -

    -

    The second argument, ⟨

    +

    The second argument, ⟨key=value list⟩, is a ⟨key⟩=⟨value⟩ list that supplies the relevant information about this entry. There are two required fields: description and either and either name or or parent. The description is set in the third + id="dx1-114017">. The description is set in the third argument of \longnewglossaryentry and \longprovideglossaryentry. With the other commands it’s set via the description key. As is typical with ⟨ key. As is typical with ⟨key⟩=⟨value⟩ lists, values that contain a comma or equal sign must be enclosed in braces. Available fields are listed below. Additional fields are provided by the supplementary packages glossaries-prefix ( (§??sec:prefix 16 Prefixes or Determiners) and glossaries-accsupp ( (§??sec:accsupp +class="cmbx-10">17 Accessibility Support) and also by glossaries-extra. You can also define your own custom keys (see §??sec:addkey +class="cmbx-10">4.3 Additional Keys).

    -

    +

    name

    -

    The name of the entry (as it will appear in the glossary). If this key is omitted and the

    The name of the entry (as it will appear in the glossary). If this key is omitted and the parent key + id="dx1-114022"> key is supplied, this value will be the same as the parent’s name. -

    If the

    If the name key contains any commands, you must also use the key contains any commands, you must also use the sort key (described below) if + id="dx1-114024"> key (described below) if you intend sorting the entries alphabetically, otherwise the entries can’t be sorted correctly.
    -

    +

    -

    +

    description

    -

    A brief description of this term (to appear in the glossary). Within this value, you can use: -


    A brief description of this term (to appear in the glossary). Within this value, you can use: +


    \nopostdesc

    -

    +

    to suppress the description terminator for this entry. For example, if this entry is a parent entry that doesn’t require a description, you can do description={\nopostdesc}. If you want a paragraph break in the description use: -



    \glspar

    -

    +

    or, better, use \longnewglossaryentry. However, note that not all glossary styles support multi-line descriptions. If you are using one of the tabular-like glossary styles that permit multi-line descriptions, use \newline not not \\ if you want to force a line break. -

    With

    With glossaries-extra, use \glsxtrnopostpunc instead of instead of \nopostdesc to suppress the post-description punctuation.
    -

    +

    -

    +

    parent

    -

    The label of the parent entry. Note that the parent entry must be defined before its sub-entries. See +

    The label of the parent entry. Note that the parent entry must be defined before its sub-entries. See §??sec:subentries 4.5 Sub-Entries for further details.

    -

    +

    descriptionplural

    -

    The plural form of the description, if required. If omitted, the value is set to the same as the

    The plural form of the description, if required. If omitted, the value is set to the same as the description + id="dx1-114032"> key.

    -

    +

    text

    -

    How this entry will appear in the document text when using

    How this entry will appear in the document text when using \gls (or one of its upper case variants). If + id="dx1-114034"> (or one of its upper case variants). If this field is omitted, the value of the name key is used. -

    This key is automatically set by key is used. +

    This key is automatically set by \newacronym. Although it is possible to override it by using text in the + id="dx1-114036"> in the optional argument of \newacronym, it will interfere with the acronym style and cause unexpected results.

    -

    +

    first

    -

    How the entry will appear in the document text on

    How the entry will appear in the document text on first use with \gls (or one of its upper + id="dx1-114038"> (or one of its upper case variants). If this field is omitted, the value of the text key is used. Note that if you use + id="dx1-114039"> key is used. Note that if you use \glspl, , \Glspl, , \GLSpl, , \glsdisp before using before using \gls, the , the first value won’t be used with + id="dx1-114045"> value won’t be used with \gls. -

    You may prefer to use abbreviations (. +

    You may prefer to use abbreviations (§??sec:acronyms 6 Acronyms and Other Abbreviations) or the category post-link hook (\glsdefpostlink) provided by ) provided by glossaries-extra if you would like to automatically append content on first use in a consistent manner. See, for examp href="https://www.dickimaw-books.com/gallery/index.php?label=sample-units" >Gallery: Units (glossaries-extra.sty). -

    Although it is possible to use

    Although it is possible to use first in the optional argument of in the optional argument of \newacronym, it can interfere with the acronym style and cause unexpected results.

    -

    +

    plural

    -

    How the entry will appear in the document text when using

    How the entry will appear in the document text when using \glspl (or one of its upper case variants). If + id="dx1-114050"> (or one of its upper case variants). If this field is omitted, the value is obtained by appending \glspluralsuffix to the value of the to the value of the text field. + id="dx1-114052"> field. The default value of \glspluralsuffix is the letter “s”. -

    Although it is possible to use is the letter “s”. +

    Although it is possible to use plural in the optional argument of in the optional argument of \newacronym, it can interfere with the acronym style and cause unexpected results. Use shortplural instead, if the default value is + id="dx1-114055"> instead, if the default value is inappropriate.

    -

    +

    firstplural

    -

    How the entry will appear in the document text on

    How the entry will appear in the document text on first use with \glspl (or one of its upper case + id="dx1-114057"> (or one of its upper case variants). If this field is omitted, the value is obtained from the plural key, if the key, if the first key is omitted, or + id="dx1-114059"> key is omitted, or by appending \glspluralsuffix to the value of the to the value of the first field, if the field, if the first field is present. Note that if + id="dx1-114062"> field is present. Note that if you use \gls, , \Gls, , \GLS, , \glsdisp before using \glspl, the , the firstplural value won’t be used with + id="dx1-114067"> value won’t be used with \glspl. -

    Although it is possible to use . +

    Although it is possible to use firstplural in the optional argument of in the optional argument of \newacronym, it can interfere with the acronym style and cause unexpected results. Use shortplural and and longplural instead, if the default + id="dx1-114071"> instead, if the default value is inappropriate. -

    Note: prior to version 1.13, the default value of

    Note: prior to version 1.13, the default value of firstplural was always taken by appending “s” to the + id="dx1-114072"> was always taken by appending “s” to the first key, which meant that you had to specify both key, which meant that you had to specify both plural and and firstplural, even if you hadn’t used + id="dx1-114075">, even if you hadn’t used the first key. + id="dx1-114076"> key.

    -

    +

    symbol

    -

    This field is provided to allow the user to specify an associated symbol. If omitted, the value is set to +

    This field is provided to allow the user to specify an associated symbol. If omitted, the value is set to \relax. Note that not all glossary styles display the symbol.

    -

    +

    symbolplural

    -

    This is the plural form of the symbol (as passed to

    This is the plural form of the symbol (as passed to \glsdisplay and and \glsdisplayfirst by by \glspl, + id="dx1-114081">, \Glspl and and \GLSpl). If omitted, the value is set to the same as the ). If omitted, the value is set to the same as the symbol key. + id="dx1-114084"> key.

    -

    +

    sort

    -

    This value indicates the text to be used by the sort comparator when ordering all the entries. If omitted, +

    This value indicates the text to be used by the sort comparator when ordering all the entries. If omitted, the value is given by the name field unless one of the package options field unless one of the package options sort=def and and sort=use have been used. + id="dx1-114088"> have been used. With Option 2 it’s best to use the sort key if the key if the name contains commands (e.g.  contains commands (e.g. \ensuremath{\alpha}) @@ -12882,77 +12921,77 @@ class="cmtt-10">\ensuremath{\alpha}) href="#option1">1 and 3, it’s strongly recommended as the indexing may fail if you don’t (see below). -

    You can also override the

    You can also override the sort key by redefining key by redefining \glsprestandardsort (see (see §??sec:pkgopts-sort 2.5 Sorting Options). -

    The

    The sort key shouldn’t be used with key shouldn’t be used with bib2gls. It has a system of fallbacks that allow different types of + id="dx1-114094">. It has a system of fallbacks that allow different types of entries to obtain the sort value from the most relevant field. See the bib2gls manual for further details + id="dx1-114095"> manual for further details and see also bib2gls gallery: sorting.
    -

    -

    +

    Option 1 by default strips the standard LaTeX accents (that is, accents generated by core LaTeX commands) from the name key when it sets the key when it sets the sort key. So with key. So with Option 1:

    -
    +     
          \newglossaryentry{elite}{%
            name={{\'e}lite},
            description={select group of people}
          }
     
    -

    This is equivalent to: +

    This is equivalent to:

    -
    +     
          \newglossaryentry{elite}{%
            name={{\'e}lite},
            description={select group of people},
            sort={elite}
          }
     
    -

    Unless you use the package option

    Unless you use the package option sanitizesort=true, in which case it’s equivalent to: + id="dx1-114098">, in which case it’s equivalent to:

    -
    +     
          \newglossaryentry{elite}{%
            name={{\'e}lite},
            description={select group of people},
            sort={\'elite}
          }
     
    -

    This will place the entry before the “A” letter group since the sort value starts with a symbol. -

    Similarly if you use the

    This will place the entry before the “A” letter group since the sort value starts with a symbol. +

    Similarly if you use the inputenc package:

    + id="dx1-114099"> package:

    \newglossaryentry{elite}{% @@ -12995,7 +13034,7 @@ class="cmtt-10">} class="cmss-10">sanitizesort=true, in which case it’s equivalent to:
    + id="dx1-114100">, in which case it’s equivalent to:
    \newglossaryentry{elite}{% @@ -13019,129 +13058,129 @@ class="cmtt-10">lite class="cmtt-10">}
    Again, this will place the entry before the “A” group. -

    With Options 

    With Options 2 and 3, the default value of sort will either be set to the will either be set to the name key (if key (if sanitizesort=true) or + id="dx1-114103">) or it will set it to the expansion of the name key (if key (if sanitizesort=false). + id="dx1-114105">). -

    Take care with

    Take care with xindy ( (Option 3): if you have entries with the same sort value they will be treated as + id="dx1-114107"> value they will be treated as the same entry. If you use xindy and aren’t using the and aren’t using the def or use sort methods, always use the sort key for entries where the name just consists of a control sequence (for example + id="dx1-114109"> key for entries where the name just consists of a control sequence (for example name={\alpha}). -

    Take care if you use

    Take care if you use Option 1 and the name contains fragile commands. You will either need to explicitly + id="dx1-114110"> contains fragile commands. You will either need to explicitly set the sort key or use the key or use the sanitizesort=true package option (unless you use the package option (unless you use the def or use sort methods).

    -

    +

    -

    +

    type

    -

    This specifies the label of the glossary in which this entry belongs. If omitted, the default +

    This specifies the label of the glossary in which this entry belongs. If omitted, the default glossary is assumed unless \newacronym is used (see is used (see §??sec:acronyms 6 Acronyms and Other Abbreviations).

    -

    +

    user1, …, user6

    -

    Six keys provided for any additional information the user may want to specify. (For example, an associated +

    Six keys provided for any additional information the user may want to specify. (For example, an associated dimension or an alternative plural or some other grammatical construct.) Alternatively, you can add new keys using \glsaddkey or or \glsaddstoragekey (see (see §??sec:addkey 4.3 Additional Keys).

    -

    +

    nonumberlist

    -

    A boolean key. If the value is missing or is

    A boolean key. If the value is missing or is true, this will suppress the number list just for this + id="dx1-114124"> just for this entry. Conversely, if you have used the package option nonumberlist, you can activate the + id="dx1-114125">, you can activate the number list just for this entry with just for this entry with nonumberlist=false. (See . (See §??sec:numberlists 12 Number Lists.)

    -

    +

    see

    -

    This key essentially provides a convenient shortcut that performs

    +

    This key essentially provides a convenient shortcut that performs

    \glssee[}
    after the entry has been defined. (See §??sec:crossref 11 Cross-Referencing Entries.) It was originally designed for synonyms that may not occur in the document text but needed to be included in the glossary in order to redirect the reader. Note that it doesn’t index the cross-referenced entry (or entries) as that would interfere with their number lists. -

    Using the s. +

    Using the see key will key will automatically add this entry to the glossary, but will not automatically add the cross-referenced entry.
    -

    -

    For example: +

    +

    For example:

    -
    +     
          \newglossaryentry{courgette}{name={courgette},
            description={variety of small marrow}}
          \newglossaryentry{zucchini}{name={zucchini},
            description={(North American)},
            see={courgette}}
     
    -

    This defines two entries (courgette and zucchini) and automatically adds a cross-reference from zucchini +

    This defines two entries (courgette and zucchini) and automatically adds a cross-reference from zucchini to courgette. (That is, it adds “see courgette” to zucchini’s number list.) This doesn’t automatically index + id="dx1-114131">.) This doesn’t automatically index courgette since this would create an unwanted location in courgette’s number list. (Page 1, if the + id="dx1-114132">. (Page 1, if the definitions occur in the preamble.) -

    Note that while it’s possible to put the cross-reference in the description instead, for example: +

    Note that while it’s possible to put the cross-reference in the description instead, for example:

    -
    +     
          \newglossaryentry{zucchini}{name={zucchini},
            description={(North American) see \gls{courgette}}}
     
    -

    this won’t index the zucchini entry, so if zucchini isn’t indexed elsewhere (with commands like

    this won’t index the zucchini entry, so if zucchini isn’t indexed elsewhere (with commands like \gls or \glsadd) then it won’t appear in the glossary even if courgette does. -

    The referenced entry should be supplied as the value to this key. If you want to override +

    The referenced entry should be supplied as the value to this key. If you want to override the “see” tag, you can supply the new tag in square brackets before the label. For example see=[see also]{anotherlabel}. Note that if you have suppressed the number list, the cross-referencing + id="dx1-114133">, the cross-referencing information won’t appear in the glossary, as it forms part of the number list. You can override this for + id="dx1-114134">. You can override this for individual glossary entries using nonumberlist=false (see above). Alternatively, you can use the + id="dx1-114135"> (see above). Alternatively, you can use the seeautonumberlist package option. For further details, see package option. For further details, see §??sec:crossref 11 Cross-Referencing Entries. -

    For Options 

    For Options 2 and 3, \makeglossaries must be used before any occurrence of must be used before any occurrence of \newglossaryentry that + id="dx1-114138"> that contains the see key. This key should not be used with entries defined in the key. This key should not be used with entries defined in the document environment. + id="dx1-114140"> environment.
    -

    +

    Since it’s useful to suppress the indexing while working on a draft document, consider using the seenoindex package option to warn or ignore the package option to warn or ignore the see key while key while \makeglossaries is commented out. -

    If you use the

    If you use the see key, you may want to consider using the key, you may want to consider using the glossaries-extra package which additionally provides a seealso and alias key. If you want to avoid the automatic indexing triggered by the see key, + id="dx1-114145"> key, consider using Option 4. See also the FAQ item Why does the see key automatically index the entry? -

    The analogous

    The analogous bib2gls see field (and field (and seealso) have a slightly different meaning. The ) have a slightly different meaning. The selection + id="dx1-114149"> resource option determines the behaviour.
    -

    +

    -

    +

    seealso

    -

    This key is only available with

    This key is only available with glossaries-extra and is similar to see but it doesn’t allow for the optional + id="dx1-114151"> but it doesn’t allow for the optional tag. The glossaries-extra package provides \seealsoname and and seealso={list} is essentially like see=[\seealsoname]list⟩ (Options 3 and 4 may treat these differently).

    -

    +

    alias

    -

    This key is only available with

    This key is only available with glossaries-extra and is another form of cross-referencing. An entry can be aliased to another entry with \gls so that they index the entry given by ⟨label⟩ instead of the original entry. (See, for example, Gallery: Aliases.) -

    More variations with the key are available with

    -

    + id="dx1-114155">.

    +

    -

    +

    category

    -

    This key is only available with

    This key is only available with glossaries-extra and is used to assign a category to the entry. The value should be a label that can be used to identify the category. See glossaries-extra manual for further details.

    -

    The following keys are reserved for

    The following keys are reserved for \newacronym (see (see §??sec:acronyms 6 Acronyms and Other Abbreviations) and also for \newabbreviation (see the (see the glossaries-extra manual): long, , longplural, , short and + id="dx1-114161"> and shortplural. -

    There are also special internal field names used by . +

    There are also special internal field names used by bib2gls. See the . See the bib2gls manual for further details. + id="dx1-114164"> manual for further details.
    -

    -

    The supplementary packages

    +

    The supplementary packages glossaries-prefix (§??sec:prefix 16 Prefixes or Determiners) and glossaries-accsupp (§??sec:accsupp 17 Accessibility Support) provide additional keys. -

    Avoid using any of the

    Avoid using any of the \gls-like or \glstext-like commands within the text, , first, , short or or long keys + id="dx1-114168"> keys (or their plural equivalent) or any other key that you plan to access through those commands. (For example, the symbol key if you intend to use key if you intend to use \glssymbol.) Otherwise you end up with nested links, which can cause complications and they won’t work with the case-changing commands. You can use them within the value of keys that won’t be accessed through those commands. For example, the description key if you don’t + id="dx1-114170"> key if you don’t use \glsdesc. Additionally, they’ll confuse the entry formatting commands, such as \glslabel.
    -

    -

    Note that if the name starts with

    +

    Note that if the name starts with non-Latin character, you must group the character, otherwise it will cause + id="dx1-114171">, you must group the character, otherwise it will cause a problem for commands like \Gls and and \Glspl. For example: + id="dx1-114173">. For example:

    -
    +   
     \newglossaryentry{elite}{name={{\'e}lite},
     description={select group or class}}
     
    -

    Note that the same applies if you are using the

    Note that the same applies if you are using the inputenc package:

    + id="dx1-114174"> package:

    \newglossaryentry{elite}{name={{ class}}
    (This doesn’t apply for XeLaTeX or LuaLaTeX documents. For further details, see the “UTF-8” section in the mfirstuc user manual.) -

    Note that in both of the above examples, you will also need to supply the user manual.) +

    Note that in both of the above examples, you will also need to supply the sort key if you are + id="dx1-114176"> key if you are using Option 2 whereas xindy ( (Option 3) is usually able to sort non-Latin characters correctly. + id="dx1-114178">s correctly. Option 1 discards accents from standard LaTeX extended Latin characters unless you use the + id="dx1-114179">s unless you use the sanitizesort=true. + id="dx1-114180">.

    -

    Top

    4.1 Plurals

    -

    You may have noticed from above that you can specify the plural form when you define a term. If you omit this, +

    You may have noticed from above that you can specify the plural form when you define a term. If you omit this, the plural will be obtained by appending -



    \glspluralsuffix

    -

    +

    to the singular form. This command defaults to the letter “s”. For example:

    -
    +   
     \newglossaryentry{cow}{name=cow,description={a fully grown
     female of any bovine animal}}
     
    -

    defines a new entry whose singular form is “cow” and plural form is “cows”. However, if you are writing in +

    defines a new entry whose singular form is “cow” and plural form is “cows”. However, if you are writing in archaic English, you may want to use “kine” as the plural form, in which case you would have to do:

    -
    +   
     \newglossaryentry{cow}{name=cow,plural=kine,
     description={a fully grown female of any bovine animal}}
     
    -

    -

    If you are writing in a language that supports multiple plurals (for a given term) then use the

    +

    If you are writing in a language that supports multiple plurals (for a given term) then use the plural key for + id="dx1-115002"> key for one of them and one of the user keys to specify the other plural form. For example:

    -
    +   
     \newglossaryentry{cow}{%
       name=cow,%
       description={a fully grown female of any bovine animal
                    (plural cows, archaic plural kine)},%
       user1={kine}}
     
    -

    You can then use

    You can then use \glspl{cow} to produce “cows” and \glsuseri{cow} to produce “kine”. You can, of course, define an easy to remember synonym. For example:

    -
    +   
     \let\glsaltpl\glsuseri
     
    -

    Then you don’t have to remember which key you used to store the second plural. Alternatively, you can define +

    Then you don’t have to remember which key you used to store the second plural. Alternatively, you can define your own keys using \glsaddkey, described in , described in §??sec:addkey 4.3 Additional Keys. -

    If you are using a language that usually forms plurals by appending a different letter, or sequence of letters, +

    If you are using a language that usually forms plurals by appending a different letter, or sequence of letters, you can redefine \glspluralsuffix as required. However, this must be done before the entries are defined. For languages that don’t form plurals by simply appending a suffix, all the plural forms must be specified using the plural key (and the key (and the firstplural key where necessary). -

    + id="dx1-115005"> key where necessary). +

    -

    Top

    4.2 Other Grammatical Constructs

    -

    You can use the six user keys to provide alternatives, such as participles. For example: +

    You can use the six user keys to provide alternatives, such as participles. For example:

    -
    +   
     \let\glsing\glsuseri
     \let\glsd\glsuserii
     \newcommand*{\ingkey}{user1}
    @@ -13552,54 +13591,54 @@ href="#top">Top

    -

    With the above definitions, I can now define terms like this: +

    With the above definitions, I can now define terms like this:

    -
    +   
     \newword{play}{to take part in activities for enjoyment}
     \newword[\edkey={ran},\ingkey={running}]{run}{to move fast using
     the legs}
     
    -

    and use them in the text: +

    and use them in the text:

    -
    +   
     Peter is \glsing{play} in the park today.
     Jane \glsd{play} in the park yesterday.
     Peter and Jane \glsd{run} in the park last week.
     
    -

    -

    Alternatively, you can define your own keys using

    +

    Alternatively, you can define your own keys using \glsaddkey, described below in , described below in §??sec:addkey 4.3 Additional Keys. -

    +

    -

    Top

    4.3 Additional Keys

    -

    You can now also define your own custom keys using the commands described in this section. There are two +

    You can now also define your own custom keys using the commands described in this section. There are two types of keys: those for use within the document and those to store information used behind the scenes by other commands. -

    For example, if you want to add a key that indicates the associated unit for a term, you might want to +

    For example, if you want to add a key that indicates the associated unit for a term, you might want to reference this unit in your document. In this case use \glsaddkey described in §??sec:glsaddkey 4.3.1 Document Keys. If, on the other hand, you want to add a key to indicate to a glossary style or acronym style that this entry should be formatted differently to other entries, then you can use \glsaddstoragekey described in §??sec:glsaddstoragekey 4.3.2 Storage Keys. -

    In both cases, a new command ⟨

    In both cases, a new command ⟨no link cs⟩ will be defined that can be used to access the value of this key (analogous to commands such as \glsentrytext). This can be used in an expandable context (provided any @@ -13607,14 +13646,14 @@ fragile commands stored in the key have been protected). The new keys must be ad class="cmtt-10">\glsaddkey or \glsaddstoragekey before glossary entries are defined. -

    +

    -

    Top

    4.3.1 Document Keys

    -

    A custom key that can be used in the document is defined using: -


    A custom key that can be used in the document is defined using: +


    \glsaddkey{key}{cs}{link allcaps cs}

    -

    +

    where:

    -

    +

    key

    -

    is the new key to use in

    is the new key to use in \newglossaryentry (or similar commands such as + id="dx1-118002"> (or similar commands such as \longnewglossaryentry); + id="dx1-118003">);

    -

    +

    default value

    -

    is the default value to use if this key isn’t used in an entry definition (this may reference the current +

    is the default value to use if this key isn’t used in an entry definition (this may reference the current entry label via \glslabel, but you will have to switch on expansion via the starred version of \glsaddkey and protect fragile commands);

    -

    +

    no link cs

    -

    is the control sequence to use analogous to commands like

    is the control sequence to use analogous to commands like \glsentrytext; + id="dx1-118004">;

    -

    +

    no link ucfirst cs

    -

    is the control sequence to use analogous to commands like

    is the control sequence to use analogous to commands like \Glsentrytext; + id="dx1-118005">;

    -

    +

    link cs

    -

    is the control sequence to use analogous to commands like

    is the control sequence to use analogous to commands like \glstext; + id="dx1-118006">;

    -

    +

    link ucfirst cs

    -

    is the control sequence to use analogous to commands like

    is the control sequence to use analogous to commands like \Glstext; + id="dx1-118007">;

    -

    +

    link allcaps cs

    -

    is the control sequence to use analogous to commands like

    is the control sequence to use analogous to commands like \GLStext.

    -

    The starred version of .

    +

    The starred version of \glsaddkey switches on expansion for this key. The unstarred version doesn’t override the current expansion setting. -

    +

    Example 3 (Defining Custom Keys) -

    Suppose I want to define two new keys, +

    Suppose I want to define two new keys, ed and ing, that default to the entry text followed by “ed” and “ing”, respectively. The default value will need expanding in both cases, so I need to use the starred @@ -13714,7 +13753,7 @@ form:

    -
    +   
      % Define "ed" key:
      \glsaddkey*
       {ed}% key
    @@ -13734,11 +13773,11 @@ form:
       {\Glsing}% command analogous to \Glstext
       {\GLSing}% command analogous to \GLStext
     
    -

    Now I can define some entries: +

    Now I can define some entries:

    -
    +   
      % No need to override defaults for this entry:
      \newglossaryentry{jump}{name={jump},description={}}
      % Need to override defaults on these entries:
    @@ -13751,31 +13790,31 @@ form:
        ing={waddling},%
        description={}}
     
    -

    -

    These entries can later be used in the document: +

    +

    These entries can later be used in the document:

    -
    +   
     The dog \glsed{jump} over the duck.
     The duck was \glsing{waddle} round the dog.
     The dog \glsed{run} away from the duck.
     
    -

    For a complete document, see the sample file

    For a complete document, see the sample file sample-newkeys.tex.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    4.3.2 Storage Keys

    -

    A custom key that can be used for simply storing information is defined using: -


    A custom key that can be used for simply storing information is defined using: +


    \glsaddstoragekey{key}{default value}{no link cs}

    -

    +

    where the arguments are as the first three arguments of \glsaddkey, described above in §??sec:glsaddkey +class="cmbx-10">4.3.1 Document Keys. -

    This is essentially the same as

    This is essentially the same as \glsaddkey except that it doesn’t define the additional commands. You can access or update the value of your new field using the commands described in §??sec:fetchset 15.3 Fetching and Updating the Value of a Field. -

    +

    Example 4 (Defining Custom Storage Key (Acronyms and Initialisms)) -

    Suppose I want to define acronyms and other forms of abbreviations, such as initialisms, but I want them all + id="x1-119003"> +

    Suppose I want to define acronyms and other forms of abbreviations, such as initialisms, but I want them all in the same glossary and I want the acronyms on first use to be displayed with the short form followed by the long form in parentheses, but the opposite way round for other forms of abbreviations. (The glossaries-extra package provides a simpler way of achieving this.) -

    Here I can define a new key that determines whether the term is actually an acronym rather +

    Here I can define a new key that determines whether the term is actually an acronym rather than some other form of abbreviation. I’m going to call this key abbrtype (since type already @@ -13817,19 +13856,19 @@ exists):

    -
    +   
     \glsaddstoragekey
      {abbrtype}% key/field name
      {word}% default value if not explicitly set
      {\abbrtype}% custom command to access the value if required
     
    -

    -

    Now I can define a style that looks up the value of this new key to determine how to display the full +

    +

    Now I can define a style that looks up the value of this new key to determine how to display the full form:

    -
    +   
     \newacronymstyle
      {mystyle}% style name
      {% Use the generic display
    @@ -13903,31 +13942,31 @@ form:
       \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}%
      }
     
    -

    Remember that the new style needs to be set before defining any terms: +

    Remember that the new style needs to be set before defining any terms:

    -
    +   
     \setacronymstyle{mystyle}
     
    -

    -

    Since it’s a bit confusing to use

    +

    Since it’s a bit confusing to use \newacronym for something that’s not technically an acronym, let’s define a + id="dx1-119004"> for something that’s not technically an acronym, let’s define a new command for initialisms:

    -
    +   
     \newcommand*{\newinitialism}[4][]{%
       \newacronym[abbrtype=initialism,#1]{#2}{#3}{#4}%
     }
     
    -

    Now the entries can all be defined: +

    Now the entries can all be defined:

    -
    +   
     \newacronym{radar}{radar}{radio detecting and ranging}
     \newacronym{laser}{laser}{light amplification by stimulated
     emission of radiation}
    @@ -13936,19 +13975,19 @@ apparatus}
     \newinitialism{dsp}{DSP}{digital signal processing}
     \newinitialism{atm}{ATM}{automated teller machine}
     
    -

    On

    On first use, \gls{radar} will produce “radar (radio detecting and ranging)” but \gls{dsp} will produce “DSP (digital signal processing)”. -

    For a complete document, see the sample file

    For a complete document, see the sample file sample-storage-abbr.tex.

    -

    -

    ____________________________

    -

    In the above example, if

    +

    ____________________________

    +

    In the above example, if \newglossaryentry is explicitly used (instead of through \newacronym) the abbrtype key will be set to its default value of “w class="cmtt-10">\ifglshaslong test in the custom acronym style will be false (since the long key hasn’t been set) so the display style will switch to that given by + id="dx1-119005"> key hasn’t been set) so the display style will switch to that given by \glsgenentryfmt and they’ll be no test performed on the abbrtype field. -

    +

    Example 5 (Defining Custom Storage Key (Acronyms and Non-Acronyms with Descriptions)) -

    The previous example can be modified if the +

    The previous example can be modified if the description also needs to be provided. Here I’ve changed + id="dx1-119008"> also needs to be provided. Here I’ve changed “word” to “acronym”:

    -
    +   
     \glsaddstoragekey
      {abbrtype}% key/field name
      {acronym}% default value if not explicitly set
      {\abbrtype}% custom command to access the value if required
     
    -

    This may seem a little odd for non-abbreviated entries defined using

    This may seem a little odd for non-abbreviated entries defined using \newglossaryentry directly, but \ifglshaslong can be used to determine whether or not to reference the value of this new can be used to determine whether or not to reference the value of this new abbrtype field. -

    The new acronym style has a minor modification that forces the user to specify a description. In the +

    The new acronym style has a minor modification that forces the user to specify a description. In the previous example, the line:

    -
    +   
        \renewcommand*{\GenericAcronymFields}{%
          description={\the\glslongtok}}%
     
    -

    needs to be changed to: +

    needs to be changed to:

    -
    +   
        \renewcommand*{\GenericAcronymFields}{}%
     
    -

    Additionally, to accommodate the change in the default value of the

    Additionally, to accommodate the change in the default value of the abbrtype key, all instances of

    -
    +   
         \ifglsfieldeq{##1}{abbrtype}{word}
     
    -

    need to be changed to: +

    need to be changed to:

    -
    +   
         \ifglsfieldeq{##1}{abbrtype}{acronym}
     
    -

    -

    Once this new style has been set, the new acronyms can be defined using the optional argument to set the +

    +

    Once this new style has been set, the new acronyms can be defined using the optional argument to set the description:

    -
    +   
     \newacronym[description={system for detecting the position and
     speed of aircraft, ships, etc}]{radar}{radar}{radio detecting
     and ranging}
     
    -

    -

    No change is required for the definition of

    +

    No change is required for the definition of \newinitialism but again the optional argument is required to set the description:

    -
    +   
     \newinitialism[description={mathematical manipulation of an
     information signal}]{dsp}{DSP}{digital signal processing}
     
    -

    -

    We can also accommodate contractions in a similar manner to the initialisms: +

    +

    We can also accommodate contractions in a similar manner to the initialisms:

    -
    +   
     \newcommand*{\newcontraction}[4][]{%
       \newacronym[abbrtype=contraction,#1]{#2}{#3}{#4}%
     }
     
    -

    The contractions can similarly been defined using this new command: +

    The contractions can similarly been defined using this new command:

    -
    +   
     \newcontraction[description={front part of a ship below the
     deck}]{focsle}{fo'c's'le}{forecastle}
     
    -

    -

    Since the custom acronym style just checks if

    +

    Since the custom acronym style just checks if abbrtype is acronym, the contractions will be treated the same as the initialisms, but the style could be modified by a further test of the abbrtype value if required. -

    To test regular non-abbreviated entries, I’ve also defined a simple word: +

    To test regular non-abbreviated entries, I’ve also defined a simple word:

    -
    +   
     \newglossaryentry{apple}{name={apple},description={a fruit}}
     
    -

    -

    Now for a new glossary style that provides information about the abbreviation (in addition to the +

    +

    Now for a new glossary style that provides information about the abbreviation (in addition to the description):

    -
    +   
     \newglossarystyle
      {mystyle}% style name
      {% base it on the "list" style
    @@ -14093,105 +14132,105 @@ description):
            \glossentrydesc{##1}\glspostdescription\space ##2}%
      }
     
    -

    This uses

    This uses \ifglshaslong to determine whether or not the term is an abbreviation. If it has an abbreviation, + id="dx1-119010"> to determine whether or not the term is an abbreviation. If it has an abbreviation, the full form is supplied in parentheses and \abbrtype (defined by \glsaddstoragekey earlier) is used to indicate the type of abbreviation. -

    With this style set, the

    With this style set, the apple entry is simply displayed in the glossary as

    -

    +

    apple

    -

    a fruit.

    -

    but the abbreviations are displayed in the form +

    a fruit.

    +

    but the abbreviations are displayed in the form

    -

    +

    laser

    -

    (acronym: light amplification by stimulated emission of radiation) device that creates a narrow +

    (acronym: light amplification by stimulated emission of radiation) device that creates a narrow beam of intense light.

    -

    (for acronyms) or +

    (for acronyms) or

    -

    +

    DSP

    -

    (initialism: digital signal processing) mathematical manipulation of an information signal.

    -

    (for initalisms) or +

    (initialism: digital signal processing) mathematical manipulation of an information signal.

    +

    (for initalisms) or

    -

    +

    fo’c’s’le

    -

    (contraction: forecastle) front part of a ship below the deck.

    +

    (contraction: forecastle) front part of a ship below the deck.

    -

    (for contractions). -

    For a complete document, see

    (for contractions). +

    For a complete document, see sample-storage-abbr-desc.tex.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    4.4 Expansion

    -

    When you define new glossary entries expansion is performed by default, except for the

    When you define new glossary entries expansion is performed by default, except for the name, , description, + id="dx1-120002">, descriptionplural, , symbol, , symbolplural and and sort keys (these keys all have expansion suppressed via + id="dx1-120006"> keys (these keys all have expansion suppressed via \glssetnoexpandfield). -

    You can switch expansion on or off for individual keys using -


    You can switch expansion on or off for individual keys using +


    \glssetexpandfield{field}

    -

    +

    or -



    \glssetnoexpandfield{field}

    -

    +

    respectively, where ⟨field⟩ is the field tag corresponding to the key. In most cases, this is the same as the name of the key except for those listed in table ??tab:fieldmap. +class="cmbx-10">4.1.

    -


    Table 4.1: Key to Field Mappings
    +class="content">Key to Field Mappings
    Field style="vertical-align:baseline;" id="TBL-5-2-">
    sort sortvalue
    firstplural firstpl
    description desc
    descriptionplural descplural
    user1 useri
    user2 userii
    user3 useriii
    user4 useriv
    user5 userv
    user6 uservi
    longplural longpl
    shortplural shortpl
    @@ -14290,89 +14329,89 @@ class="cmtt-10">shortpl

    -

    Any keys that haven’t had the expansion explicitly set using

    Any keys that haven’t had the expansion explicitly set using \glssetexpandfield or \glssetnoexpandfield are governed by -



    \glsexpandfields

    -

    +

    and -



    \glsnoexpandfields

    -

    -

    If your entries contain any fragile commands, I recommend you switch off expansion via

    +

    If your entries contain any fragile commands, I recommend you switch off expansion via \glsnoexpandfields. (This should be used before you define the entries.)

    -

    Top

    4.5 Sub-Entries

    -

    As from version 1.17, it is possible to specify sub-entries. These may be used to order the glossary into +

    As from version 1.17, it is possible to specify sub-entries. These may be used to order the glossary into categories, in which case the sub-entry will have a different name to its parent entry, or it may be used to distinguish different definitions for the same word, in which case the sub-entries will have the same name as the parent entry. Note that not all glossary styles support hierarchical entries and may display all the entries in a flat format. Of the styles that support sub-entries, some display the sub-entry’s name whilst others don’t. Therefore you need to ensure that you use a suitable style. (See §??sec:styles 13 Glossary Styles for a list of predefined styles.) As from version 3.0, level 1 sub-entries are automatically numbered in the predefined styles if you use the subentrycounter package option (see package option (see §??sec:pkgopts-printglos 2.3 Glossary Appearance Options for further details). -

    Note that the parent entry will automatically be added to the glossary if any of its child entries are used in +

    Note that the parent entry will automatically be added to the glossary if any of its child entries are used in the document. If the parent entry is not referenced in the document, it will not have a number list. Note also + id="dx1-121002">. Note also that makeindex has a restriction on the maximum sub-entry depth. -

    + id="dx1-121003"> has a restriction on the maximum sub-entry depth. +

    -

    Top

    4.5.1 Hierarchical Categories

    -

    To arrange a glossary with hierarchical categories, you need to first define the category and then define the +

    To arrange a glossary with hierarchical categories, you need to first define the category and then define the sub-entries using the relevant category entry as the value of the parent key. + id="dx1-122001"> key. -

    +

    Example 6 (Hierarchical Categories—Greek and Roman Mathematical Symbols) -

    Suppose I want a glossary of mathematical symbols that are divided into Greek letters and Roman letters. + id="x1-122003"> +

    Suppose I want a glossary of mathematical symbols that are divided into Greek letters and Roman letters. Then I can define the categories as follows:

    -
    +   
     \newglossaryentry{greekletter}{name={Greek letters},
     description={\nopostdesc}}
     \newglossaryentry{romanletter}{name={Roman letters},
     description={\nopostdesc}}
     
    -

    -

    Note that in this example, the category entries don’t need a description so I have set the descriptions to +

    +

    Note that in this example, the category entries don’t need a description so I have set the descriptions to \nopostdesc. This gives a blank description and suppresses the description terminator. -

    I can now define my sub-entries as follows: + id="dx1-122004">. This gives a blank description and suppresses the description terminator. +

    I can now define my sub-entries as follows:

    -
    +   
     \newglossaryentry{pi}{name={\ensuremath{\pi}},sort={pi},
     description={ratio of the circumference of a circle to
     the diameter},
    @@ -14381,40 +14420,40 @@ parent=greekletter}
     description={Euler's constant},
     parent=romanletter}
     
    -

    For a complete document, see the sample file

    For a complete document, see the sample file sampletree.tex.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    4.5.2 Homographs

    -

    Sub-entries that have the same name as the parent entry, don’t need to have the

    Sub-entries that have the same name as the parent entry, don’t need to have the name key. For example, the + id="dx1-123001"> key. For example, the word “glossary” can mean a list of technical words or a collection of glosses. In both cases the plural is “glossaries”. So first define the parent entry:

    -
    +   
     \newglossaryentry{glossary}{name=glossary,
     description={\nopostdesc},
     plural={glossaries}}
     
    -

    Again, the parent entry has no description, so the description terminator needs to be suppressed using +

    Again, the parent entry has no description, so the description terminator needs to be suppressed using \nopostdesc. -

    Now define the two different meanings of the word: + id="dx1-123002">. +

    Now define the two different meanings of the word:

    -
    +   
     \newglossaryentry{glossarylist}{
     description={list of technical words},
     sort={1},
    @@ -14424,41 +14463,41 @@ description={collection of glosses},
     sort={2},
     parent={glossary}}
     
    -

    Note that if I reference the parent entry, the location will be added to the parent’s

    Note that if I reference the parent entry, the location will be added to the parent’s number list, whereas if I + id="dx1-123003">, whereas if I reference any of the child entries, the location will be added to the child entry’s number list. Note also that since the sub-entries have the same name, the sort key is required unless you are using the key is required unless you are using the sort=use or or sort=def + id="dx1-123006"> package options (see §??sec:pkgopts-sort 2.5 Sorting Options). You can use the subentrycounter package option to + id="dx1-123007"> package option to automatically number the first-level child entries. See §??sec:pkgopts-printglos 2.3 Glossary Appearance Options for further details. -

    In the above example, the plural form for both of the child entries is the same as the parent entry, so the +

    In the above example, the plural form for both of the child entries is the same as the parent entry, so the plural key was not required for the child entries. However, if the sub-entries have different plurals, they will + id="dx1-123008"> key was not required for the child entries. However, if the sub-entries have different plurals, they will need to be specified. For example:

    -
    +   
     \newglossaryentry{bravo}{name={bravo},
     description={\nopostdesc}}
     \newglossaryentry{bravocry}{description={cry of approval
    @@ -14472,85 +14511,85 @@ sort={2},
     plural={bravoes},
     parent=bravo}
     
    -

    -

    +

    +

    -

    Top

    4.6 Loading Entries From a File

    -

    You can store all your glossary entry definitions in another file and use: -


    You can store all your glossary entry definitions in another file and use: +


    \loadglsentries[type]{filename}

    -

    +

    where ⟨filename⟩ is the name of the file containing all the \newglossaryentry or or \longnewglossaryentry + id="dx1-124003"> commands. The optional argument ⟨type⟩ is the name of the glossary to which those entries should belong, for those entries where the type key has been omitted (or, more specifically, for those entries + id="dx1-124004"> key has been omitted (or, more specifically, for those entries whose type has been specified by \glsdefaulttype, which is what , which is what \newglossaryentry uses by + id="dx1-124006"> uses by default). -

    This is a preamble-only command. You may also use

    This is a preamble-only command. You may also use \input to load the file but don’t use to load the file but don’t use \include. If you + id="dx1-124008">. If you find that your file is becoming unmanageably large, you may want to consider switching to bib2gls and use an + id="dx1-124009"> and use an application such as JabRef to manage the entry definitions. -

    If you want to use

    If you want to use \AtBeginDocument to to \input all your entries automatically at the start of the document, add the \AtBeginDocument command before you load the glossaries package (and package (and babel, if you are also loading + id="dx1-124012">, if you are also loading that) to avoid the creation of the glsdefs file and any associated problems that are caused by defining + id="dx1-124013"> file and any associated problems that are caused by defining commands in the document environment. (See environment. (See §??sec:docdefs 4.8 Drawbacks With Defining Entries in the Document Environment.)
    -

    +

    -

    +

    Example 7 (Loading Entries from Another File) -

    Suppose I have a file called +

    Suppose I have a file called myentries.tex which contains:

    -
    +   
     \newglossaryentry{perl}{type=main,
     name={Perl},
     description={A scripting language}}
    @@ -14560,14 +14599,14 @@ description={A typesetting language},sort={TeX}}
     name={html},
     description={A mark up language}}
     
    -

    and suppose in my document preamble I use the command: +

    and suppose in my document preamble I use the command:

    -
    +   
     \loadglsentries[languages]{myentries}
     
    -

    then this will add the entries

    then this will add the entries tex and html to the glossary whose type is given by languages, @@ -14577,13 +14616,13 @@ class="cmtt-10">main.

    -

    -

    ____________________________

    -

    Note: if you use

    +

    ____________________________

    +

    Note: if you use \newacronym (see (see §??sec:acronyms 6 Acronyms and Other Abbreviations) the type is set as type=\acronymtype unless you explicitly override it. For example, if my file -

    +   
     \newacronym{aca}{aca}{a contrived acronym}
     
    -

    then (supposing I have defined a new glossary type called

    then (supposing I have defined a new glossary type called altacronym)

    -
    +   
     \loadglsentries[altacronym]{myacronyms}
     
    -

    will add

    will add aca to the glossary type acronym, if the package option acronym has been specified, + id="dx1-124019"> has been specified, or will add aca to the glossary type altacronym, if the package option acronym is not + id="dx1-124020"> is not specified.4.1 -

    If you have used the +

    If you have used the acronym package option, there are two possible solutions to this problem: + id="dx1-124025"> package option, there are two possible solutions to this problem:

    1. -

      Change +

      Change myacronyms.tex so that entries are defined in the form:

      -
      +     
            \newacronym[type=\glsdefaulttype]{aca}{aca}{a
            contrived acronym}
       
      -

      and do: +

      and do:

      -
      +     
            \loadglsentries[altacronym]{myacronyms}
       
      -

      +

    2. -

      Temporarily change +

      Temporarily change \acronymtype to the target glossary:

      -
      +     
            \let\orgacronymtype\acronymtype
            \renewcommand{\acronymtype}{altacronym}
            \loadglsentries{myacronyms}
            \let\acronymtype\orgacronymtype
       
      -

    -

    Note that only those entries that have been used in the text will appear in the relevant glossaries. Note also +

    +

    Note that only those entries that have been used in the text will appear in the relevant glossaries. Note also that \loadglsentries may only be used in the preamble. -

    Remember that you can use

    Remember that you can use \provideglossaryentry rather than rather than \newglossaryentry. Suppose you want + id="dx1-124031">. Suppose you want to maintain a large database of acronyms or terms that you’re likely to use in your documents, but you may want to use a modified version of some of those entries. (Suppose, for example, one document may require a more detailed description.) Then if you define the entries using terms.tex) contains:

    -
    +   
     \provideglossaryentry{mallard}{name=mallard,
      description={a type of duck}}
     
    -

    but suppose your document requires a more detailed description, you can do: +

    but suppose your document requires a more detailed description, you can do:

    -
    +   
     \usepackage{glossaries}
     \makeglossaries
     \newglossaryentry{mallard}{name=mallard,
      description={a dabbling duck where the male has a green head}}
     \loadglsentries{terms}
     
    -

    Now the

    Now the mallard definition in the terms.tex file will be ignored. -

    +

    -

    Top

    4.7 Moving Entries to Another Glossary

    -

    As from version 3.02, you can move an entry from one glossary to another using: -


    As from version 3.02, you can move an entry from one glossary to another using: +


    \glsmoveentry{label}{target glossary label}

    -

    +

    where ⟨label⟩ is the unique label identifying the required entry and ⟨target glossary label⟩ is the unique label identifying the glossary in which to put the entry. -

    Note that no check is performed to determine the existence of the target glossary. If you want to move an +

    Note that no check is performed to determine the existence of the target glossary. If you want to move an entry to a glossary that’s skipped by \printglossaries, then define an ignored glossary with + id="dx1-125002">, then define an ignored glossary with \newignoredglossary. (See . (See §??sec:newglossary 9 Defining New Glossaries.) -

    Unpredictable results may occur if you move an entry to a different glossary from its parent or children. +

    Unpredictable results may occur if you move an entry to a different glossary from its parent or children.
    -

    -

    +

    +

    -

    Top

    4.8 Drawbacks With Defining Entries in the Document Environment

    -

    Originally,

    Originally, \newglossaryentry (and (and \newacronym) could only be used in the preamble. I reluctantly removed + id="dx1-126002">) could only be used in the preamble. I reluctantly removed this restriction in version 1.13, but there are issues with defining commands in the document environment + id="dx1-126003"> environment instead of the preamble, which is why the restriction is maintained for newer commands. This restriction is also reimposed for \newglossaryentry by the new 3 but provides a package option to allow document definition necessary.) -

    +

    -

    Top

    4.8.1 Technical Issues

    -

    +

    1. -

      If you define an entry mid-way through your document, but subsequently shuffle sections around, + class="enumerate" id="x1-127002x1"> +

      If you define an entry mid-way through your document, but subsequently shuffle sections around, you could end up using an entry before it has been defined.

    2. -

      Entry information is required when displaying the glossary. If this occurs at the start of the + class="enumerate" id="x1-127004x2"> +

      Entry information is required when displaying the glossary. If this occurs at the start of the document, but the entries aren’t defined until later, then the entry details are being looked up before the entry has been defined. This means that it’s not possible to display the content of the glossary unless the entry definitions are saved on the previous LaTeX run and can be picked up at the start of the document environment on the next run (in a similar way that environment on the next run (in a similar way that \label and \ref work).

    3. -

      If you use a package, such as +

      If you use a package, such as babel, that makes certain characters active at the start of the , that makes certain characters active at the start of the document + id="dx1-127010"> environment, there will be a problem if those characters have a special significance when defining glossary entries. These characters include the double-quote " character, the exclamation mark ? character, and the pipe | character. They must not be active when defining a glossary entry where they occur in the sort key (and they should be avoided in the label + id="dx1-127012"> key (and they should be avoided in the label if they may be active at any point in the document). Additionally, the comma , character and the equals key⟩=⟨value⟩ arguments.

    -

    To overcome the first two problems, as from version 4.0 the

    To overcome the first two problems, as from version 4.0 the glossaries package modifies the definition of \newglossaryentry at the beginning of the document environment so that the definitions are written to an + id="dx1-127013"> environment so that the definitions are written to an external file (\jobname.glsdefs) which is then read in at the start of the document on the next run. This + id="dx1-127015">) which is then read in at the start of the document on the next run. This means that the entry can now be looked up in the glossary, even if the glossary occurs at the beginning of the document. -

    There are drawbacks to this mechanism: if you modify an entry definition, you need a second run to see the +

    There are drawbacks to this mechanism: if you modify an entry definition, you need a second run to see the effect of your modification in \printglossary (if it occurs at the start of the document); this method requires an extra \newwrite, which may exceed TeX’s maximum allocation; unexpected expansion issues could occur. -

    Version 4.47 has introduced changes that have removed some of the issues involved, and there are now +

    Version 4.47 has introduced changes that have removed some of the issues involved, and there are now warning messages if there is an attempt to multiple define the same entry label. -

    The

    The glossaries-extra package provides a setting (but only for Options 2 and 3) that allows \newglossaryentry to occur in the document environment but doesn’t create the glsdefs file. This circumvents some problems but + id="dx1-127016"> file. This circumvents some problems but it means that you can’t display any of the glossaries before all the entries have been defined (so it’s all right if all the glossaries are at the end of the document but not if any occur in the front matter). -

    +

    -

    Top

    4.8.2 Good Practice Issues

    -

    The above section covers technical issues that can cause your document to have compilation errors or produce +

    The above section covers technical issues that can cause your document to have compilation errors or produce incorrect output. This section focuses on good writing practice. The main reason cited by users wanting to define entries within the document environment rather than in the preamble is that they want to + id="dx1-128001"> environment rather than in the preamble is that they want to write the definition as they type in their document text. This suggests a “stream of consciousness” style of writing that may be acceptable in certain literary genres but is inappropriate for factual documents. -

    When you write technical documents, regardless of whether it’s a PhD thesis or an article for a journal or +

    When you write technical documents, regardless of whether it’s a PhD thesis or an article for a journal or proceedings, you must plan what you write in advance. If you plan in advance, you should have a fairly good idea of the type of terminology that your document will contain, so while you are planning, create a new file with all your entry definitions. If, while you’re writing your document, you remember another term you need, @@ -14859,21 +14898,21 @@ definition.

    -

    -

    +

    Top

    5. Referencing Entries in the Document

    -

    Once you have defined a glossary entry using a command like

    Once you have defined a glossary entry using a command like \newglossaryentry ( (§??sec:newglosentry +class="cmbx-10">4 Defining Glossary Entries) or \newacronym ( (§??sec:acronyms 6 Acronyms and Other Abbreviations), you can refer to that entry in the document with one of the provided commands that are describe in this manual. (There are some additional commands provided by glossaries-extra.) The text produced at that point in determined by the command and can also be governed by whether or not the entry has been marked as used. -

    Some of these commands are more complicated than others. Many of them are robust and can’t be used in +

    Some of these commands are more complicated than others. Many of them are robust and can’t be used in fully expandable contexts, such as in PDF bookmarks. -

    The commands are broadly divided into: +

    The commands are broadly divided into:

    1. -

      Those that display text in the document (where the formatting can be adjusted by a style or + class="enumerate" id="x1-129004x1"> +

      Those that display text in the document (where the formatting can be adjusted by a style or hook) and also index the entry (so that it’s added to the document) are described in §??sec:glslink +class="cmbx-10">5.1 Links to Glossary Entries. This set of commands can be further sub-divided into those that mark the entry as having been used (the \gls-like commands, §??sec:gls-like The §5.1.1 The \gls-Like Commands (First Use Flag Queried)) and those that don’t (the \glstext-like commands, §??sec:glstext-like +href="#x1-1320005.1.2">§5.1.2 The The \glstext-Like Commands (First Use Flag Not Queried)).

    2. -

      Those that display text in the document without indexing or applying any additional formatting + class="enumerate" id="x1-129006x2"> +

      Those that display text in the document without indexing or applying any additional formatting (§??sec:glsnolink 5.2 Using Glossary Terms Without Links).

    -

    There are additional commands specific to entries defined with

    There are additional commands specific to entries defined with \newacronym that are described in §??sec:longshortfull 6.1 Displaying the Long, Short and Full Forms (Independent of First Use).

    -

    Top

    5.1 Links to Glossary Entries

    -

    The text which appears at the point in the document when using any of the commands described in +

    The text which appears at the point in the document when using any of the commands described in §??sec:gls-like The §5.1.1 The \gls-Like Commands (First Use Flag Queried) or §??sec:glstext-like The §5.1.2 The \glstext-Like Commands (First Use Flag Not Queried) is referred to as the link text (even if there are no hyperlinks). These + id="dx1-130001"> (even if there are no hyperlinks). These commands also add a line to an external file that is used to generate the relevant entry in the glossary. This information includes an associated location that is added to the number list for that entry. By default, the + id="dx1-130002"> for that entry. By default, the location refers to the page number. For further information on number lists, see §??sec:numberlists 12 Number Lists. These external files need to be post-processed by makeindex or or xindy unless you have chosen Options  unless you have chosen Options 1 or 4. If you don’t use \makeglossaries these external files won’t be created. (Options  these external files won’t be created. (Options 1 and 4 write the information to the aux file.) -

    Note that repeated use of these commands for the same entry can cause the file.) +

    Note that repeated use of these commands for the same entry can cause the number list to become quite + id="dx1-130007"> to become quite long, which may not be particular helpful to the reader. In this case, you can use the non-indexing commands described in §??sec:glsnolink 5.2 Using Glossary Terms Without Links or you can use the supplemental glossaries-extra package, which provides a means to s this chapter. -

    I strongly recommend that you don’t use the commands defined in this chapter in the arguments of +

    I strongly recommend that you don’t use the commands defined in this chapter in the arguments of sectioning or caption commands or any other command that has a moving argument. -

    Aside from problems with expansion issues, PDF bookmarks and possible nested hyperlinks in the table of +

    Aside from problems with expansion issues, PDF bookmarks and possible nested hyperlinks in the table of contents (or list of whatever) any use of the commands described in §??sec:gls-like The §5.1.1 The \gls-Like Commands (First Use Flag Queried) will have their first use flag unset when they appear in the table of contents (or list of whatever).

    -

    -

    The above warning is particularly important if you are using the

    +

    The above warning is particularly important if you are using the glossaries package in conjunction with the hyperref package. Instead, use one of the package. Instead, use one of the expandable commands listed in §??sec:glsnolink 5.2 Using Glossary Terms Without Links (such as \glsentrytext but not the non-expandable case changing versions like \Glsentrytext). Alternatively, provide an alternative via the optional argument to the sectioning/caption + id="dx1-130010">). Alternatively, provide an alternative via the optional argument to the sectioning/caption command or use hyperref’s ’s \texorpdfstring. Examples: + id="dx1-130012">. Examples:

    -
    +   
     \chapter{An overview of \glsentrytext{perl}}
     \chapter[An overview of Perl]{An overview of \gls{perl}}
     \chapter{An overview of \texorpdfstring{\gls{perl}}{Perl}}
     
    -

    -

    If you want to retain the formatting that’s available through commands like

    +

    If you want to retain the formatting that’s available through commands like \acrshort (for example, if you are using one of the small caps styles), then you might want to consider the glossaries-extra package which provides commands for this purpose.
    -

    -

    If you want the

    +

    If you want the link text to produce a hyperlink to the corresponding entry details in the glossary, you + id="dx1-130013"> to produce a hyperlink to the corresponding entry details in the glossary, you should load the hyperref package package before the glossaries package. That’s what I’ve done in this document, so if you see a hyperlinked term, such as link text, you can click on the word or phrase and it will take you to a brief + id="dx1-130015">, you can click on the word or phrase and it will take you to a brief description in this document’s glossary. -

    If you use the

    If you use the hyperref package, I strongly recommend you use package, I strongly recommend you use pdflatex rather than rather than latex to compile your + id="dx1-130018"> to compile your document, if possible. The DVI format of LaTeX has limitations with the hyperlinks that can cause a problem when used with the glossaries package. Firstly, the DVI format can’t break a hyperlink across a line @@ -15053,78 +15092,78 @@ acronym) won’t be able to break across a line with the DVI format. Secondl correctly size hyperlinks in subscripts or superscripts. This means that if you define a term that may be used as a subscript or superscript, if you use the DVI format, it won’t come out the correct size. -

    These are limitations of the DVI format not of the

    These are limitations of the DVI format not of the glossaries package.

    -

    -

    It may be that you only want terms in certain glossaries to have hyperlinks, but not for other + id="dx1-130019"> package.

    +

    +

    It may be that you only want terms in certain glossaries to have hyperlinks, but not for other glossaries. In this case, you can use the package option nohypertypes to identify the glossary lists + id="dx1-130020"> to identify the glossary lists that shouldn’t have hyperlinked link text. See . See §??sec:pkgopts-general 2.1 General Options for further details. -

    The way the

    The way the link text is displayed depends on -


    is displayed depends on +


    \glstextformat{text}

    -

    +

    For example, to make all link text appear in a sans-serif font, do: + id="dx1-130024"> appear in a sans-serif font, do:

    -
    +   
     \renewcommand*{\glstextformat}[1]{\textsf{#1}}
     
    -

    Further customisation can be done via

    Further customisation can be done via \defglsentryfmt or by redefining or by redefining \glsentryfmt. See . See §??sec:glsdisplay +class="cmbx-10">5.1.3 Changing the format of the link text for further details. -

    Each entry has an associated conditional referred to as the

    Each entry has an associated conditional referred to as the first use flag. Some of the commands described in this chapter automatically unset this flag and can also use it to determine what text should be displayed. These types of commands are the \gls-like commands and are described in §??sec:gls-like The §5.1.1 The \gls-Like Commands (First Use Flag Queried). The commands that don’t reference or change the first use flag are \glstext-like commands and are described in §??sec:glstext-like The §5.1.2 The \glstext-Like Commands (First Use Flag Not Queried). See §??sec:glsunset 7 Unsetting and Resetting Entry Flags for commands that unset (mark the entry as having been used) or reset (mark the entry as not used) the first use flag without referencing the entries. -

    The

    The \gls-like and \glstext-like commands all take a first optional argument that is a comma-separated list of ⟨key⟩=⟨\gls{sample} will use the default hyperlink on a number of factors (such as whether the entry is in a glossary that has been identified in the nohypertypes list). You can override the list). You can override the hyper key in the variant’s optional argument, for example, + id="dx1-130028"> key in the variant’s optional argument, for example, \gls*[hyper=true]{sample} but this creates redundancy and is best avoided. The glossaries-extra package provides the option to add a third custom variant. -

    Avoid nesting these commands. For example don’t do

    Avoid nesting these commands. For example don’t do \glslink{label}} as this is likely to cause problems. By implication, this means that you should avoid using any of these commands within the text, , first, , short or or long keys (or their plural equivalent) or any other key that you plan to + id="dx1-130032"> keys (or their plural equivalent) or any other key that you plan to access through these commands. (For example, the symbol key if you intend to use key if you intend to use \glssymbol.)
    -

    -

    The keys listed below are available for the optional first argument. The

    +

    The keys listed below are available for the optional first argument. The glossaries-extra package provides additional keys. (See the glossaries-extra manual for further details.)

    -

    +

    hyper

    -

    This is a boolean key which can be used to enable/disable the hyperlink to the relevant entry in +

    This is a boolean key which can be used to enable/disable the hyperlink to the relevant entry in the glossary. If this key is omitted, the value is determined by current settings, as indicated above. For example, when used with a \gls-like command, if this is the first use and the hyperfirst=false + id="dx1-130035"> package option has been used, then the default value is hyper=false. The hyperlink can be forced on using hyper=true unless the hyperlinks have been suppressed using \glsdisablehyper. You + id="dx1-130036">. You must load the hyperref package before the package before the glossaries package to ensure the hyperlinks work. + id="dx1-130038"> package to ensure the hyperlinks work.

    -

    +

    format

    -

    This specifies how to format the associated location number for this entry in the glossary. This value is +

    This specifies how to format the associated location number for this entry in the glossary. This value is equivalent to the makeindex encap value, and (as with encap value, and (as with \index) the value needs to be the name of a + id="dx1-130041">) the value needs to be the name of a command without the initial backslash. As with \index, the characters , the characters ( and ) can also be used to specify the beginning and ending of a number range and they must be in matching pairs. (For example, @@ -15233,7 +15272,7 @@ class="cmtt-10">\gls[format={(}]{sample} on one page to sta class="cmtt-10">\gls[format={)}]{sample} to close the range.) Again as with \index, the command should be the name of a command + id="dx1-130043">, the command should be the name of a command which takes an argument (which will be the associated location). Be careful not to use a declaration (such as bfseries) instead of a text block command (such as italic) you will need to create a command that applies bo

    -
    +     
          \newcommand*{\textbfem}[1]{\textbf{\emph{#1}}}
     
    -

    and use that command. -

    In this document, the standard formats refer to the standard text block commands such as

    and use that command. +

    In this document, the standard formats refer to the standard text block commands such as \textbf or + id="dx1-130044"> or \emph or any of the commands listed in or any of the commands listed in table ??tab:hyperxx. You can combine a range and format using +class="cmbx-10">5.1. You can combine a range and format using (format⟩ to start the range and format⟩ part must match. For example, format={(emph} and format={)emph}. -

    If you use

    If you use xindy instead of instead of makeindex, you must specify any non-standard formats that you want to use + id="dx1-130047">, you must specify any non-standard formats that you want to use with the format key using key using \GlsAddXdyAttribute{name}. So if you use xindy with the above example, + id="dx1-130050"> with the above example, you would need to add:

    -
    +     
          \GlsAddXdyAttribute{textbfem}
     
    -

    See

    See §??sec:xindy 14 Xindy (Option 3) for further details.

    -

    -

    If you are using hyperlinks and you want to change the font of the hyperlinked location, don’t use +

    +

    If you are using hyperlinks and you want to change the font of the hyperlinked location, don’t use \hyperpage (provided by the (provided by the hyperref package) as the locations may not refer to a page number. Instead, + id="dx1-130052"> package) as the locations may not refer to a page number. Instead, the glossaries package provides number formats listed in table ??tab:hyperxx. These commands are +class="cmbx-10">5.1. These commands are designed to work with the particular location formats created by makeindex and and xindy and shouldn’t be + id="dx1-130054"> and shouldn’t be used in other contexts.

    -


    Table 5.1: Predefined Hyperlinked Location Formats
    +class="content">Predefined Hyperlinked Location Formats
    hyperrm serif hyperlink
    hypersf sans-serif hyperlink
    hypertt monospaced hyperlink
    hyperbf bold hyperlink
    hypermd medium weight hyperlink
    hyperit italic hyperlink
    hypersl slanted hyperlink
    hyperup upright hyperlink
    hypersc small caps hyperlink
    hyperemph emphasized hyperlink

    -

    Note that if the

    Note that if the \hyperlink command hasn’t been defined, the command hasn’t been defined, the hyperxx⟩ formats are equivalent to the analogous emph). If you want to make a new want the location number to be in a bold sans-serif font, you can define a command called, say, \hyperbsf: + id="dx1-130067">:

    -
    +     
          \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}}
     
    -

    and then use

    and then use hyperbsf as the value for the format + id="dx1-130068"> key.5.1 -

    When defining a custom location format command that uses one of the +

    When defining a custom location format command that uses one of the \hyperxx commands, make sure + id="dx1-130070"> commands, make sure that the argument of \hyperxx is just the location. Any formatting must be outside of is just the location. Any formatting must be outside of \hyperxx (as in + id="dx1-130072"> (as in the above \hyperbfsf example).
    -

    -

    Remember that if you use

    +

    Remember that if you use xindy, you will need to add this to the list of location attributes: + id="dx1-130073">, you will need to add this to the list of location attributes:

    -
    +     
          \GlsAddXdyAttribute{hyperbsf}
     
    -

    +

    -

    +

    counter

    -

    This specifies which counter to use for this location. This overrides the default counter used by this entry. +

    This specifies which counter to use for this location. This overrides the default counter used by this entry. (See also §??sec:numberlists 12 Number Lists.)

    -

    +

    local

    -

    This is a boolean key that only makes a difference when used with

    This is a boolean key that only makes a difference when used with \gls-like commands that change the entry’s first use flag. If local=true, the change to the first use flag will be loca The default is local=false.

    -

    +

    noindex

    -

    This is a boolean key that suppresses the indexing. Only available with

    This is a boolean key that suppresses the indexing. Only available with glossaries-extra.

    -

    +

    hyperoutside

    -

    This is a boolean key that determines whether to put the hyperlink outside of

    This is a boolean key that determines whether to put the hyperlink outside of \glstextformat. Only + id="dx1-130079">. Only available with glossaries-extra.

    -

    +

    wrgloss

    -

    This key determines whether to index before (

    This key determines whether to index before (wrgloss=before) or after (wrgloss=after) the link text. + id="dx1-130081">. Only available with glossaries-extra.

    -

    +

    textformat

    -

    This key identifies the name of the control sequence to encapsulate the

    This key identifies the name of the control sequence to encapsulate the link text instead of the default + id="dx1-130083"> instead of the default \glstextformat. Only available with . Only available with glossaries-extra.

    -

    +

    prefix

    -

    This key locally redefines

    This key locally redefines \glolinkprefix to the given value. Only available with to the given value. Only available with glossaries-extra.

    -

    +

    thevalue

    -

    This key explicitly sets the location. Only available with

    This key explicitly sets the location. Only available with glossaries-extra.

    -

    +

    theHvalue

    -

    This key explicitly sets the hyperlink location. Only available with

    This key explicitly sets the hyperlink location. Only available with glossaries-extra.

    -

    The

    The link text isn’t scoped by default with just the base isn’t scoped by default with just the base glossaries package. Any unscoped declarations in the link text may affect subsequent text.
    -

    -

    + id="dx1-130090"> may affect subsequent text.

    +

    +

    -

    Top

    5.1.1 The The \gls-Like Commands (First Use Flag Queried)

    -

    This section describes the commands that unset (mark as used) the

    This section describes the commands that unset (mark as used) the first use flag on completion, and in most cases they use the current state of the flag to determine the text to be displayed. As described above, these commands all have a star-variant (key⟩=⟨value⟩ list. These commands use \glsentryfmt or the equivalent definition provided by + id="dx1-131001"> or the equivalent definition provided by \defglsentryfmt to determine the automatically generated text and its format (see to determine the automatically generated text and its format (see §??sec:glsdisplay 5.1.3 Changing the format of the link text). -

    Apart from

    Apart from \glsdisp, the commands described in this section also have a , the commands described in this section also have a final optional argument ⟨insert⟩ which may be used to insert material into the automatically generated text. -

    Since the commands have a final optional argument, take care if you actually want to display an open +

    Since the commands have a final optional argument, take care if you actually want to display an open square bracket after the command when the final optional argument is absent. Insert an empty set of braces {} immediately before the opening square bracket to prevent it from being interpreted as the final argument. For @@ -15596,48 +15635,48 @@ example:

    -
    +   
     \gls{sample} {}[Editor's comment]
     
    -

    -

    Don’t use any of the

    +

    Don’t use any of the \gls-like or \glstext-like commands in the ⟨insert⟩ argument.

    -

    -

    Take care using these commands within commands or environments that are processed multiple times as this +

    +

    Take care using these commands within commands or environments that are processed multiple times as this can confuse the first use flag query and state change. This includes frames with overlays in beamer and the + id="dx1-131004"> and the tabularx environment provided by tabularx. The . The glossaries package automatically deals with this issue in amsmath’s ’s align environment. You can apply a patch to tabularx by placing the following command (new to + id="dx1-131007"> by placing the following command (new to v4.28) in the preamble: -



    \glspatchtabularx

    -

    +

    This does nothing if tabularx hasn’t been loaded. There’s no patch available for hasn’t been loaded. There’s no patch available for beamer. See . See §??sec:glsunset +class="cmbx-10">7 Unsetting and Resetting Entry Flags for more details. -



    \gls[options]{label}[insert]

    -

    +

    This command typically determines the link text from the values of the from the values of the text or or first keys supplied when the + id="dx1-131014"> keys supplied when the entry was defined using \newglossaryentry. However, if the entry was defined using . However, if the entry was defined using \newacronym and + id="dx1-131016"> and \setacronymstyle was used, then the link text will usually be determined from the was used, then the link text will usually be determined from the long or or short + id="dx1-131020"> keys. -

    There are two upper case variants: -


    There are two upper case variants: +


    \Gls[options]{label}[insert]

    -

    +

    and -



    \GLS[options]{label}[insert]

    -

    +

    which make the first letter of the link text or all the link text upper case, respectively. For the former, the uppercasing of the first letter is performed by \makefirstuc. -

    The first letter uppercasing command . +

    The first letter uppercasing command \makefirstuc has limitations which must be taken into account if you use \Gls or any of the other commands that convert the first letter to uppercase.
    -

    +

    The upper casing is performed as follows:

    • -

      If the first thing in the

      If the first thing in the link text is a command follow by a group, the upper casing is performed on the + id="dx1-131024"> is a command follow by a group, the upper casing is performed on the first object of the group. For example, if an entry has been defined as

      -
      +     
            \newglossaryentry{sample}{
             name={\emph{sample} phrase},
             sort={sample phrase},
             description={an example}}
       
      -

      Then

      Then \Gls{sample} will set the link text to to5.2 + id="x1-131026f2">

      -
      +     
            \emph{\MakeUppercase sample} phrase
       
      -

      which will appear as

      which will appear as Sample phrase.

    • -

      If the first thing in the

      If the first thing in the link text isn’t a command or is a command but isn’t followed by a group, then the + id="dx1-131027"> isn’t a command or is a command but isn’t followed by a group, then the upper casing will be performed on that first thing. For example, if an entry has been defined as:

      -
      +     
            \newglossaryentry{sample}{
              name={\oe-ligature},
              sort={oe-ligature},
              description={an example}
            }
       
      -

      Then

      Then \Gls{sample} will set the link text to + id="dx1-131028"> to

      -
      +     
            \MakeUppercase \oe-ligature
       
      -

      which will appear as Œ-ligature. +

      which will appear as Œ-ligature.

    • -

      If you have

      If you have mfirstuc v2.01 or above, an extra case is added. If the first thing is v2.01 or above, an extra case is added. If the first thing is \protect it will be discarded and the above rules will then be tried.

    -

    (Note the use of the

    (Note the use of the sort key in the above examples.) -

    There are hundreds of LaTeX packages that altogether define thousands of commands with + id="dx1-131030"> key in the above examples.) +

    There are hundreds of LaTeX packages that altogether define thousands of commands with various syntax and it’s impossible for mfirstuc to take them all into account. The above rules are + id="dx1-131031"> to take them all into account. The above rules are quite simplistic and are designed for link text that starts with a text-block command (such as + id="dx1-131032"> that starts with a text-block command (such as \emph) or a command that produces a character (such as \oe). This means that if your link text + id="dx1-131033"> starts with something that doesn’t adhere to mfirstuc’s assumptions then things are likely to go + id="dx1-131034">’s assumptions then things are likely to go wrong. -

    For example, starting with a math-shift symbol: +

    For example, starting with a math-shift symbol:

    -
    +   
     \newglossaryentry{sample}{
       name={$a$},
       sort={a},
       description={an example}
     }
     
    -

    This falls into case 2 above, so the

    This falls into case 2 above, so the link text will be set to + id="dx1-131035"> will be set to

    -
    +   
     \MakeUppercase $a$
     
    -

    This attempts to uppercase the math-shift

    This attempts to uppercase the math-shift $, which will go wrong. In this case it’s not appropriate to perform any case-changing, but it may be that you want to use \Gls programmatically without checking if @@ -15816,43 +15855,43 @@ start:

    -
    +   
     \newglossaryentry{sample}{
       name={{}$a$},
       sort={a},
       description={an example}
     }
     
    -

    Now the

    Now the link text will be set to + id="dx1-131036"> will be set to

    -
    +   
     \MakeUppercase{}$a$
     
    -

    and the

    and the \uppercase becomes harmless. -

    Another issue occurs when the

    Another issue occurs when the link text starts with a command followed by an argument (case 1) but the + id="dx1-131037"> starts with a command followed by an argument (case 1) but the argument is a label, identifier or something else that shouldn’t have a case-change. A common example is when the link text starts with one of the commands described in this chapter. (But you haven’t done that, have you? + id="dx1-131038"> starts with one of the commands described in this chapter. (But you haven’t done that, have you? What with the warning not to do it at the beginning of the chapter.) Or when the link text starts with one of + id="dx1-131039"> starts with one of the non-linking commands described in §??sec:glsnolink 5.2 Using Glossary Terms Without Links. For example:

    -
    +   
     \newglossaryentry{sample}{name={sample},description={an example}}
     \newglossaryentry{sample2}{
        name={\glsentrytext{sample} two},
    @@ -15860,31 +15899,31 @@ example:
        description={another example}
      }
     
    -

    Now the

    Now the link text will be set to: + id="dx1-131040"> will be set to:

    -
    +   
     \glsentrytext{\MakeUppercase sample} two
     
    -

    This will generate an error because there’s no entry with the label “

    This will generate an error because there’s no entry with the label “\MakeUppercase sample”. The best solution here is to write the term out in the text field and use the command in the field and use the command in the name field. If you don’t use + id="dx1-131042"> field. If you don’t use \glsname anywhere in your document, you can use \gls in the name field: + id="dx1-131043"> field:

    -
    +   
     \newglossaryentry{sample}{name={sample},description={an example}}
     \newglossaryentry{sample2}{
        name={\gls{sample} two},
    @@ -15893,63 +15932,63 @@ class="cmtt-10">name
    -

    -

    If the

    +

    If the link text starts with a command that has an optional argument or with multiple arguments where the + id="dx1-131044"> starts with a command that has an optional argument or with multiple arguments where the actual text isn’t in the first argument, then \makefirstuc will also fail. For example:

    -
    +   
     \newglossaryentry{sample}{
      name={\textcolor{blue}{sample} phrase},
      sort={sample phrase},
      description={an example}}
     
    -

    Now the

    Now the link text will be set to: + id="dx1-131045"> will be set to:

    -
    +   
     \textcolor{\MakeUppercase blue}{sample} phrase
     
    -

    This won’t work because

    This won’t work because \MakeUppercase blue isn’t a recognised colour name. In this case you will have to define a helper command where the first argument is the text. For example:

    -
    +   
     \newglossaryentry{sample}{
     \newcommand*{\blue}[1]{\textcolor{blue}{#1}}
      name={\blue{sample} phrase},
      sort={sample phrase},
      description={an example}}
     
    -

    In fact, since the whole design ethos of LaTeX is the separation of content and style, it’s better to use a +

    In fact, since the whole design ethos of LaTeX is the separation of content and style, it’s better to use a semantic command. For example:

    -
    +   
     \newglossaryentry{sample}{
     \newcommand*{\keyword}[1]{\textcolor{blue}{#1}}
      name={\keyword{sample} phrase},
      sort={sample phrase},
      description={an example}}
     
    -

    For further details see the

    For further details see the mfirstuc user manual. -

    There are plural forms that are analogous to user manual. +

    There are plural forms that are analogous to \gls: -



    \glspl[options]{label}[insert]

    -

    -


    +


    \Glspl[options]{label}[insert]

    -

    -


    +


    \GLSpl[options]{label}[insert]

    -

    +

    These typically determine the link text from the plural or or firstplural keys supplied when the entry was + id="dx1-131051"> keys supplied when the entry was defined using \newglossaryentry or, if the entry is an abbreviation and or, if the entry is an abbreviation and \setacronymstyle was used, from the longplural or or shortplural keys. -

    Be careful when you use glossary entries in math mode especially if you are using keys. +

    Be careful when you use glossary entries in math mode especially if you are using hyperref as it can affect + id="dx1-131055"> as it can affect the spacing of subscripts and superscripts. For example, suppose you have defined the following entry:

    -
    +   
     \newglossaryentry{Falpha}{name={F_\alpha},
     description=sample}
     
    -

    and later you use it in math mode: +

    and later you use it in math mode:

    -
    +   
     $\gls{Falpha}^2$
     
    -

    This will result in

    This will result in Fα2 instead of insert⟩ optional argument:

    -
    +   
     $\gls{Falpha}[^2]$
     
    -

    -

    -


    +

    +


    \glsdisp[options]{label}{link text}

    -

    +

    This behaves in the same way as the above commands, except that the ⟨link text⟩ is explicitly set. There’s no final optional argument as any inserted material can be added to the ⟨link text⟩ argument. -

    Don’t use any of the

    Don’t use any of the \gls-like or \glstext-like commands in the ⟨link text⟩ argument of \glsdisp.
    -

    -

    +

    +

    -

    Top

    5.1.2 The The \glstext-Like Commands (First Use Flag Not Queried)

    -

    This section describes the commands that don’t change or reference the

    This section describes the commands that don’t change or reference the first use flag. As described above, these commands all have a star-variant (hyper=false) and a plus-variant (key⟩=⟨value⟩ list. These commands also don’t use \glsentryfmt or the equivalent + id="dx1-132001"> or the equivalent definition provided by \defglsentryfmt (see (see §??sec:glsdisplay 5.1.3 Changing the format of the link text). Additional commands for abbreviations are described in §??sec:acronyms 6 Acronyms and Other Abbreviations. -

    Apart from

    Apart from \glslink, the commands described in this section also have a , the commands described in this section also have a final optional argument ⟨insert⟩ which may be used to insert material into the automatically generated text. See the caveat above in §??sec:gls-like The §5.1.1 The \gls-Like Commands (First Use Flag Queried). -



    \glslink[options]{label}{link text}

    -

    +

    This command explicitly sets the link text as given in the final argument. -

    Don’t use any of the as given in the final argument. +

    Don’t use any of the \gls-like or \glstext-like commands in the argument of \glslink. By extension, this means that you can’t use them in the value of fields that are used to form link text. + id="dx1-132006">.
    -

    -


    +


    \glstext[options]{label}[insert]

    -

    +

    This command always uses the value of the text key as the key as the link text. -

    There are also analogous commands: -


    . +

    There are also analogous commands: +


    \Glstext[options]{text}[insert]

    -

    +

    -



    \GLStext[options]{text}[insert]

    -

    +

    These convert the first character or all the characters to uppercase, respectively. See the note on \Gls above for details on the limitations of converting the first letter to upper case. -

    There’s no equivalent command for title-casing, but you can use the more generic command +

    There’s no equivalent command for title-casing, but you can use the more generic command \glsentrytitlecase in combination with in combination with \glslink. For example:

    -
    +   
     \glslink{sample}{\glsentrytitlecase{sample}{text}}
     
    -

    (See

    (See §??sec:glsnolink 5.2 Using Glossary Terms Without Links.) -



    \glsfirst[options]{label}[insert]

    -

    +

    This command always uses the value of the first key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsfirst[options]{text}[insert]

    -

    -


    +


    \GLSfirst[options]{text}[insert]

    -

    -

    The value of the

    +

    The value of the first key (and key (and firstplural key) doesn’t necessarily match the text produced by key) doesn’t necessarily match the text produced by \gls (or + id="dx1-132020"> (or \glspl) on ) on first use as the link text used by used by \gls may be modified through commands like may be modified through commands like \defglsentry. + id="dx1-132024">. (Similarly, the value of the text and and plural keys don’t necessarily match the link text used by keys don’t necessarily match the link text used by \gls or \glspl on subsequent use.)
    -

    -


    +


    \glsplural[options]{label}[insert]

    -

    +

    This command always uses the value of the plural key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsplural[options]{text}[insert]

    -

    -


    +


    \GLSplural[options]{text}[insert]

    -

    -


    +


    \glsfirstplural[options]{label}[insert]

    -

    +

    This command always uses the value of the firstplural key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsfirstplural[options]{text}[insert]

    -

    -


    +


    \GLSfirstplural[options]{text}[insert]

    -

    -


    +


    \glsname[options]{label}[insert]

    -

    +

    This command always uses the value of the name key as the key as the link text. Note that this may be different from the + id="dx1-132040">. Note that this may be different from the values of the text or or first keys. In general it’s better to use keys. In general it’s better to use \glstext or \glsfirst instead of \glsname. -

    There are also analogous uppercasing commands: -


    There are also analogous uppercasing commands: +


    \Glsname[options]{text}[insert]

    -

    -


    +


    \GLSname[options]{text}[insert]

    -

    -

    In general it’s best to avoid

    +

    In general it’s best to avoid \Glsname with acronyms. Instead, consider using \Acrlong, \Acrshort or \Acrfull.
    -

    -


    +


    \glssymbol[options]{label}[insert]

    -

    +

    This command always uses the value of the symbol key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glssymbol[options]{text}[insert]

    -

    -


    +


    \GLSsymbol[options]{text}[insert]

    -

    -


    +


    \glsdesc[options]{label}[insert]

    -

    +

    This command always uses the value of the description key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsdesc[options]{text}[insert]

    -

    -


    +


    \GLSdesc[options]{text}[insert]

    -

    -

    If you want the title case version you can use +

    +

    If you want the title case version you can use

    -
    +   
     \glslink{sample}{\glsentrytitlecase{sample}{desc}}
     
    -

    -


    +


    \glsuseri[options]{label}[insert]

    -

    +

    This command always uses the value of the user1 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuseri[options]{text}[insert]

    -

    -


    +


    \GLSuseri[options]{text}[insert]

    -

    -


    +


    \glsuserii[options]{text}[insert]

    -

    +

    This command always uses the value of the user2 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuserii[options]{text}[insert]

    -

    -


    +


    \GLSuserii[options]{text}[insert]

    -

    -


    +


    \glsuseriii[options]{text}[insert]

    -

    +

    This command always uses the value of the user3 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuseriii[options]{text}[insert]

    -

    -


    +


    \GLSuseriii[options]{text}[insert]

    -

    -


    +


    \glsuseriv[options]{text}[insert]

    -

    +

    This command always uses the value of the user4 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuseriv[options]{text}[insert]

    -

    -


    +


    \GLSuseriv[options]{insert]

    -

    -


    +


    \glsuserv[options]{text}[insert]

    -

    +

    This command always uses the value of the user5 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuserv[options]{text}[insert]

    -

    -


    +


    \GLSuserv[options]{text}[insert]

    -

    -


    +


    \glsuservi[options]{text}[insert]

    -

    +

    This command always uses the value of the user6 key as the key as the link text. -

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuservi[options]{text}[insert]

    -

    -


    +


    \GLSuservi[options]{text}[insert]

    -

    -

    +

    +

    -

    Top

    5.1.3 Changing the format of the link text

    -

    The

    The glossaries-extra package provides ways of altering the format according to the category. See the glossaries-extra manual for further details.
    -

    -

    The default format of the

    +

    The default format of the link text for the for the \gls-like commands is governed by5.3: -


    : +


    \glsentryfmt

    -

    +

    This may be redefined but if you only want the change the display style for a given glossary, then you need to use -



    \defglsentryfmt[type]{definition}

    -

    +

    instead of redefining \glsentryfmt. The optional first argument ⟨type⟩ is the glossary type. This defaults to \glsdefaulttype if omitted. The second argument is the entry format definition. -

    Note that if omitted. The second argument is the entry format definition. +

    Note that \glsentryfmt is the default display format for entries. Once the display format has been changed for an individual glossary using \defglsentryfmt, redefining , redefining \glsentryfmt won’t have an effect on that glossary, you must instead use \defglsentryfmt again. Note that glossaries that have been identified as lists of acronyms (via the package option acronymlists or the command or the command \DeclareAcronymList, see + id="dx1-133011">, see §??sec:pkgopts-acronym 2.7 Acronym and Abbreviation Options) use \defglsentryfmt to set their display style.
    -

    -

    Within the ⟨

    +

    Within the ⟨definition⟩ argument of \defglsentryfmt, or if you want to redefine \glsentryfmt, you may use the following commands: -



    \glslabel

    -

    +

    This is the label of the entry being referenced. As from version 4.08, you can also access the glossary entry type using: -



    \glstype

    -

    +

    This is defined using \edef so the replacement text is the actual glossary type rather than + id="dx1-133014"> so the replacement text is the actual glossary type rather than \glsentrytype{\glslabel}. -



    \glscustomtext

    -

    +

    This is the custom text supplied in \glsdisp. It’s always empty for \gls, , \glspl and their upper case variants. + id="dx1-133017"> and their upper case variants. (You can use etoolbox’s ’s \ifdefempty to determine if \glscustomtext is empty.) -



    \glsinsert

    -

    +

    The custom text supplied in the final optional argument to \gls, \glspl and their upper case variants. -



    \glsifplural{true text}{false text}

    -

    +

    If \glspl, \Glspl or \GLSpl was used, this command does ⟨true text⟩ otherwise it does ⟨false text⟩. -



    \glscapscase{no case}{first uc}{all caps}

    -

    +

    If \gls, \glspl or first uc⟩. If class="cmtt-10">\GLS or \GLSpl were used, this does ⟨all caps⟩. -



    \glsifhyperon{hyper true}{hyper false}

    -

    +

    This will do ⟨hyper true⟩ if the hyperlinks are on for the current reference, otherwise it will do ⟨hyper false⟩. The hyperlink may be off even if it wasn’t explicitly switched off with the hyper key or the use of a starred + id="dx1-133023"> key or the use of a starred command. It may be off because the hyperref package hasn’t been loaded or because package hasn’t been loaded or because \glsdisablehyper + id="dx1-133025"> has been used or because the entry is in a glossary type that’s had the hyperlinks switched off (using nohypertypes) or because it’s the ) or because it’s the first use and the hyperlinks have been suppressed on first use. -

    The

    The \glsifhyperon command should be used instead of \glsifhyper, which is now deprecated (and no + id="dx1-133027">, which is now deprecated (and no longer documented).
    -

    -

    If you want to know if the command used to reference this entry was used with the star or plus variant, you +

    +

    If you want to know if the command used to reference this entry was used with the star or plus variant, you can use: -



    \glslinkvar{unmodified}{star}{plus}

    -

    +

    This will do ⟨unmodified⟩ if the unmodified version was used, or will do ⟨star⟩ if the starred version was used, or will do ⟨plus⟩ if the plus version was used. Note that this doesn’t take into account if the hyper key was used to + id="dx1-133029"> key was used to override the default setting, so this command shouldn’t be used to guess whether or not the hyperlink is on for this reference. -

    Note that you can also use commands such as

    Note that you can also use commands such as \ifglsused within the definition of within the definition of \glsentryfmt (see §??sec:glsunset 7 Unsetting and Resetting Entry Flags). -

    The commands

    The commands \glslabel, , \glstype, , \glsifplural, , \glscapscase, , \glsinsert and and \glscustomtext are + id="dx1-133036"> are typically updated at the start of the \gls-like and \glstext-like commands so they can usually be accessed in the hook user commands, such as \glspostlinkhook and and \glslinkpostsetkeys. -

    This means that using commands like . +

    This means that using commands like \gls within the fields that are accessed using the within the fields that are accessed using the \gls-like or \glstext-like commands (such as the first, , text, , long or or short keys) will cause a problem. The entry + id="dx1-133043"> keys) will cause a problem. The entry formatting performed by \glsentryfmt and related commands isn’t scoped (otherwise if would cause problems for \glspostlinkhook which may need to look ahead as well as means that any nested commands will, at the very least, change the label stored in \glslabel.
    -

    -

    If you only want to make minor modifications to

    +

    If you only want to make minor modifications to \glsentryfmt, you can use -



    \glsgenentryfmt

    -

    +

    This uses the above commands to display just the first, , text, , plural or or firstplural keys (or the custom + id="dx1-133048"> keys (or the custom text) with the insert text appended. -

    Alternatively, if you want to change the entry format for abbreviations (defined via

    Alternatively, if you want to change the entry format for abbreviations (defined via \newacronym) you can + id="dx1-133049">) you can use: -



    \glsgenacfmt

    -

    +

    This uses the values from the long, , short, , longplural and and shortplural keys, rather than using the keys, rather than using the text, + id="dx1-133055">, plural, , first and and firstplural keys. The first use singular text is obtained via: -


    keys. The first use singular text is obtained via: +


    \genacrfullformat{label}{insert}

    -

    +

    instead of from the first key, and the first use plural text is obtained via: -


    key, and the first use plural text is obtained via: +


    \genplacrfullformat{label}{insert}

    -

    +

    instead of from the firstplural key. In both cases, ⟨ key. In both cases, ⟨label⟩ is the entry’s label and ⟨insert⟩ is the insert text provided in the final optional argument of commands like \gls. The default behaviour is to do the long form (or + id="dx1-133063">. The default behaviour is to do the long form (or plural long form) followed by ⟨insert⟩ and a space and the short form (or plural short form) in parentheses, where the short form is in the argument of \firstacronymfont. There are also first letter upper case + id="dx1-133064">. There are also first letter upper case versions: -



    \Genacrfullformat{label}{insert}

    -

    +

    and -



    \Genplacrfullformat{label}{insert}

    -

    +

    By default these perform a protected expansion on their no-case-change equivalents and then use \makefirstuc to convert the first character to upper case. If there are issues caused by this expansion, you + id="dx1-133067"> to convert the first character to upper case. If there are issues caused by this expansion, you will need to redefine those commands to explicitly use commands like \Glsentrylong (which is + id="dx1-133068"> (which is what the predefined acronym styles, such as long-short, do). Otherwise, you only need to redefine + id="dx1-133069">, do). Otherwise, you only need to redefine \genacrfullformat and and \genplacrfullformat to change the behaviour of to change the behaviour of \glsgenacfmt. See + id="dx1-133072">. See §??sec:acronyms 6 Acronyms and Other Abbreviations for further details on changing the style of acronyms. -

    Note that

    Note that \glsentryfmt (or the formatting given by \defglsentryfmt) is not used by the \glstext-like commands.
    -

    -

    As from version 4.16, both the

    +

    As from version 4.16, both the \gls-like and \glstext-like commands use -



    \glslinkpostsetkeys

    -

    +

    after the ⟨options⟩ are set. This macro does nothing by default but can be redefined. (For example, to switch off the hyperlink under certain conditions.) This version also introduces -



    \glspostlinkhook

    -

    +

    which is done after the link text has been displayed and also after the first use flag has been unset (see example 18). +href="#x1-140078r18">18). -

    +

    Example 8 (Custom Entry Display in Text) -

    Suppose you want a glossary of measurements and units, you can use the +

    Suppose you want a glossary of measurements and units, you can use the symbol key to store the + id="dx1-133077"> key to store the unit:

    -
    +   
     \newglossaryentry{distance}{name=distance,
     description={The length between two points},
     symbol={km}}
     
    -

    and now suppose you want

    and now suppose you want \gls{distance} to produce “distance (km)” on first use, then you can redefine \glsentryfmt as follows: + id="dx1-133078"> as follows:

    -
    +   
     \renewcommand*{\glsentryfmt}{%
       \glsgenentryfmt
       \ifglsused{\glslabel}{}{\space (\glsentrysymbol{\glslabel})}%
     }
     
    -

    -

    (Note that I’ve used

    +

    (Note that I’ve used \glsentrysymbol rather than rather than \glssymbol to avoid nested hyperlinks.) -

    Note also that all of the to avoid nested hyperlinks.) +

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

    -
    +   
     \renewcommand{\glstextformat}[1]{\textbf{#1}}
     \renewcommand*{\glsentryfmt}{%
       \glsgenentryfmt
       \ifglsused{\glslabel}{}{\space(\glsentrysymbol{\glslabel})}%
     }
     
    -

    then

    then \gls{distance} will produce “distance (km)”. -

    For a complete document, see the sample file

    For a complete document, see the sample file sample-entryfmt.tex.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    +

    Example 9 (Custom Format for Particular Glossary) -

    Suppose you have created a new glossary called +

    Suppose you have created a new glossary called notation and you want to change the way the entry is displayed on first use so that it includes the symbol, you can do:

    -
    +   
     \defglsentryfmt[notation]{\glsgenentryfmt
      \ifglsused{\glslabel}{}{\space
        (denoted \glsentrysymbol{\glslabel})}}
     
    -

    Now suppose you have defined an entry as follows: +

    Now suppose you have defined an entry as follows:

    -
    +   
     \newglossaryentry{set}{type=notation,
       name=set,
       description={A collection of objects},
       symbol={$S$}
     }
     
    -

    The

    The first time you reference this entry it will be displayed as: “set (denoted S)” (assuming \gls was + id="dx1-133085"> was used). -

    Alternatively, if you expect all the symbols to be set in math mode, you can do: +

    Alternatively, if you expect all the symbols to be set in math mode, you can do:

    -
    +   
     \defglsentryfmt[notation]{\glsgenentryfmt
      \ifglsused{\glslabel}{}{\space
        (denoted $\glsentrysymbol{\glslabel}$)}}
     
    -

    and define entries like this: +

    and define entries like this:

    -
    +   
     \newglossaryentry{set}{type=notation,
       name=set,
       description={A collection of objects},
       symbol={S}
     }
     
    -

    +

    -

    -

    ____________________________

    -

    Remember that if you use the

    +

    ____________________________

    +

    Remember that if you use the symbol key, you need to use a glossary style that displays the symbol, as many + id="dx1-133086"> key, you need to use a glossary style that displays the symbol, as many of the styles ignore it. -

    +

    -

    Top

    5.1.4 Enabling and disabling hyperlinks to glossary entries

    -

    If you load the

    If you load the hyperref or or html packages prior to loading the packages prior to loading the glossaries package, the \gls-like and \glstext-like commands will automatically have hyperlinks to the relevant glossary entry, unless the hyper + id="dx1-134003"> option has been switched off (either explicitly or through implicit means, such as via the nohypertypes package + id="dx1-134004"> package option). -

    You can disable or enable links using: -


    You can disable or enable links using: +


    \glsdisablehyper

    -

    +

    and -



    \glsenablehyper

    -

    +

    respectively. The effect can be localised by placing the commands within a group. Note that you should only use \glsenablehyper if the commands \hyperlink and and \hypertarget have been defined (for example, by the + id="dx1-134008"> have been defined (for example, by the hyperref package). -

    You can disable just the package). +

    You can disable just the first use links using the package option hyperfirst=false. Note that this option only + id="dx1-134010">. Note that this option only affects the \gls-like commands that recognise the first use flag. -

    +

    Example 10 (First Use With Hyperlinked Footnote Description) -

    Suppose I want the first use to have a hyperlink to the description in a footnote instead of hyperlinking to + id="x1-134012"> +

    Suppose I want the first use to have a hyperlink to the description in a footnote instead of hyperlinking to the relevant place in the glossary. First I need to disable the hyperlinks on first use via the package option hyperfirst=false: + id="dx1-134013">:

    -
    +   
     \usepackage[hyperfirst=false]{glossaries}
     
    -

    Now I need to redefine

    Now I need to redefine \glsentryfmt (see (see §??sec:glsdisplay 5.1.3 Changing the format of the link text):

    -
    +   
     \renewcommand*{\glsentryfmt}{%
       \glsgenentryfmt
       \ifglsused{\glslabel}{}{\footnote{\glsentrydesc{\glslabel}}}%
     }
     
    -

    -

    Now the first use won’t have hyperlinked text, but will be followed by a footnote. See the sample file +

    +

    Now the first use won’t have hyperlinked text, but will be followed by a footnote. See the sample file sample-FnDesc.tex for a complete document.

    -

    -

    ____________________________

    -

    Note that the

    +

    ____________________________

    +

    Note that the hyperfirst option applies to all defined glossaries. It may be that you only want to disable the + id="dx1-134015"> option applies to all defined glossaries. It may be that you only want to disable the hyperlinks on first use for glossaries that have a different form on first use. This can be achieved by noting that since the entries that require hyperlinking for all instances have identical first and subsequent text, they can be unset via \glsunsetall (see (see §??sec:glsunset 7 Unsetting and Resetting Entry Flags) so that the hyperfirst option + id="dx1-134017"> option doesn’t get applied. -

    +

    Example 11 (Suppressing Hyperlinks on First Use Just For Acronyms) -

    Suppose I want to suppress the hyperlink on +

    Suppose I want to suppress the hyperlink on first use for acronyms but not for entries in the main glossary. I can load the glossaries package using:

    -
    +   
     \usepackage[hyperfirst=false,acronym]{glossaries}
     
    -

    Once all glossary entries have been defined I then do: +

    Once all glossary entries have been defined I then do:

    -
    +   
     \glsunsetall[main]
     
    -

    +

    -

    -

    ____________________________

    -

    For more complex requirements, you might find it easier to switch off all hyperlinks via

    +

    ____________________________

    +

    For more complex requirements, you might find it easier to switch off all hyperlinks via \glsdisablehyper + id="dx1-134020"> and put the hyperlinks (where required) within the definition of \glsentryfmt (see (see §??sec:glsdisplay 5.1.3 Changing the format of the link text) via \glshyperlink (see (see §??sec:glsnolink 5.2 Using Glossary Terms Without Links). -

    +

    Example 12 (Only Hyperlink in Text Mode Not Math Mode) -

    This is a bit of a contrived example, but suppose, for some reason, I only want the +

    This is a bit of a contrived example, but suppose, for some reason, I only want the \gls-like commands to have hyperlinks when used in text mode, but not in math mode. I can do this by adding the glossary to the list of nohypertypes and redefining \glsentryfmt: + id="dx1-134025">:

    -
    +   
     \GlsDeclareNoHyperList{main}
     \renewcommand*{\glsentryfmt}{%
       \ifmmode
    @@ -17362,48 +17401,48 @@ class="cmtt-10">\glsentryfmt
    -

    Note that this doesn’t affect the

    Note that this doesn’t affect the \glstext-like commands, which will have the hyperlinks off unless they’re forced on using the plus variant. -

    See the sample file

    See the sample file sample-nomathhyper.tex for a complete document.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    +

    Example 13 (One Hyper Link Per Entry Per Chapter) -

    Here’s a more complicated example that will only have the hyperlink on the first time an entry is used per + id="x1-134027"> +

    Here’s a more complicated example that will only have the hyperlink on the first time an entry is used per chapter. This doesn’t involve resetting the first use flag. Instead it adds a new key using \glsaddstoragekey + id="dx1-134028"> (see §??sec:glsaddstoragekey 4.3.2 Storage Keys) that keeps track of the chapter number that the entry was last used in:

    -
    +   
     \glsaddstoragekey{chapter}{0}{\glschapnum}
     
    -

    This creates a new user command called

    This creates a new user command called \glschapnum that’s analogous to \glsentrytext. The default value for this key is 0. I then define my glossary entries as usual. -

    Next I redefine the hook

    Next I redefine the hook \glslinkpostsetkeys (see (see §??sec:glsdisplay 5.1.3 Changing the format of the link text) so that it determines the current chapter number (which is stored in \currentchap using chapter key that I defined earlier. If they’re the same, this entry has already been used in this chapter so the hyperlink is switched off using xkeyval’s ’s \setkeys command. If the chapter number isn’t the same, then this entry hasn’t been used in the current chapter. The chapter field is updated using \glsfieldxdef ( (§??sec:fetchset 15.3 Fetching and Updating the Value of a Field) provided the user hasn’t switched off the hyperlink. (This test is performed using \glsifhyperon.

    -
    +   
     \renewcommand*{\glslinkpostsetkeys}{%
      \edef\currentchap{\arabic{chapter}}%
      \ifnum\currentchap=\glschapnum{\glslabel}\relax
    @@ -17438,94 +17477,109 @@ class="cmtt-10">\glsifhyperon.
      \fi
     }
     
    -

    Note that this will be confused if you use

    Note that this will be confused if you use \gls etc when the chapter counter is 0. (That is, before the first \chapter.) -

    See the sample file

    See the sample file sample-chap-hyperfirst.tex for a complete document.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    5.2 Using Glossary Terms Without Links

    -

    The commands described in this section display entry details without adding any information to the glossary. +

    The commands described in this section display entry details without adding any information to the glossary. They don’t use \glstextformat, they don’t have any optional arguments, they don’t affect the , they don’t have any optional arguments, they don’t affect the first use flag and, apart from \glshyperlink, they don’t produce hyperlinks. -

    Commands that aren’t expandable will be ignored by PDF bookmarks, so you will need to provide an + id="dx1-135002">, they don’t produce hyperlinks. +

    Commands that aren’t expandable will be ignored by PDF bookmarks, so you will need to provide an alternative via hyperref’s ’s \texorpdfstring if you want to use them in sectioning commands. (This isn’t specific to the glossaries package.) See the hyperref documentation for further details. All the commands that convert the + id="dx1-135004"> documentation for further details. All the commands that convert the first letter to upper case aren’t expandable. The other commands depend on whether their corresponding keys were assigned non-expandable values.
    -

    -

    If you want to title case a field, you can use: -


    +

    If you want to title case a field, you can use: +


    \glsentrytitlecase{label}{field}

    -

    +

    where ⟨label⟩ is the label identifying the glossary entry, ⟨field⟩ is the field label (see table ??tab:fieldmap). For -example: +class="cmbx-10">4.1). This +internally uses: +


    \glscapitalisewords{text}

    +

    +which defaults to \capitalisewords{text}. If your field contains formatting commands, you will need to +redefine this to use \capitalisefmtwords. See the mfirstuc manual for further details. +

    For example:

    -
    +   
     \glsentrytitlecase{sample}{desc}
     
    -

    (If you want title-casing in your glossary style, you might want to investigate the

    (If you want title-casing in your glossary style, you might want to investigate the glossaries-extra package.) This command will trigger an error if the entry is undefined. -

    Note that this command has the same limitations as

    Note that this command has the same limitations as \makefirstuc which is used by commands like \Gls and \Glsentryname to upper-case the first letter (see the notes about \Gls in §??sec:gls-like The §5.1.1 The \gls-Like Commands (First Use Flag Queried)). -



    \glsentryname{label}

    -

    -


    +


    \Glsentryname{label}

    -

    +

    These commands display the name of the glossary entry given by ⟨label⟩, as specified by the name key. + id="dx1-135010"> key. \Glsentryname makes the first letter upper case. Neither of these commands check for the existence of ⟨label⟩. @@ -17533,26 +17587,26 @@ The first form \glsentryname is expandable (unless the name contains unexpandable commands). Note that this may be different from the values of the text or or first keys. In general it’s better to use keys. In general it’s better to use \glsentrytext or \glsentryfirst instead of \glsentryname. -

    In general it’s best to avoid

    In general it’s best to avoid \Glsentryname with abbreviations. Instead, consider using \Glsentrylong, \Glsentryshort or \Glsentryfull.
    -

    -


    +


    \glossentryname{label}

    -

    +

    This is like \glsnamefont{ -

    +   
     \renewcommand*{\glsnamefont}[1]{\textmd{\sffamily #1}}
     
    -

    -


    +


    \Glossentryname{label}

    -

    +

    This is like \glossentryname but makes the first letter of the name upper case. -



    \glsentrytext{label}

    -

    -


    +


    \Glsentrytext{label}

    -

    +

    These commands display the subsequent use text for the glossary entry given by ⟨label⟩, as specified by the text + id="dx1-135017"> key. \Glsentrytext makes the first letter upper case. The first form is expandable (unless the text contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentryplural{label}

    -

    -


    +


    \Glsentryplural{label}

    -

    +

    These commands display the subsequent use plural text for the glossary entry given by ⟨label⟩, as specified by the plural key. key. \Glsentryplural makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentryfirst{label}

    -

    -


    +


    \Glsentryfirst{label}

    -

    +

    These commands display the first use text for the glossary entry given by ⟨label⟩, as specified by the first key. + id="dx1-135023"> key. \Glsentryfirst makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentryfirstplural{label}

    -

    -


    +


    \Glsentryfirstplural{label}

    -

    +

    These commands display the plural form of the first use text for the glossary entry given by ⟨label⟩, as specified by the firstplural key. key. \Glsentryfirstplural makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentrydesc{label}

    -

    -


    +


    \Glsentrydesc{label}

    -

    +

    These commands display the description for the glossary entry given by ⟨label⟩. -

    \Glsentrydesc makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glossentrydesc{label}

    -

    +

    This is like \glsentrydesc{label} but also checks for the existence of ⟨label⟩. This command is not expandable. It’s used in the predefined glossary styles to display the description. -



    \Glossentrydesc{label}

    -

    +

    This is like \glossentrydesc but converts the first letter to upper case. This command is not expandable. -



    \glsentrydescplural{label}

    -

    -


    +


    \Glsentrydescplural{label}

    -

    +

    These commands display the plural description for the glossary entry given by ⟨label⟩. \Glsentrydescplural @@ -17727,27 +17781,27 @@ makes the first letter upper case. The first form is expandable (unless the valu unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentrysymbol{label}

    -

    -


    +


    \Glsentrysymbol{label}

    -

    +

    These commands display the symbol for the glossary entry given by ⟨label⟩. -

    \Glsentrysymbol makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsletentryfield{cs}{label}{field}

    -

    +

    This command doesn’t display anything. It merely fetches the value associated with the given field (where the available field names are listed in table ??tab:fieldmap) and stores the result in the control sequence ⟨4.1) and stores the result in the control sequence ⟨cs⟩. For example, to store the description for the entry whose label is “apple” in the control sequence \tmp:

    -
    +   
     \glsletentryfield{\tmp}{apple}{desc}
     
    -

    -


    +


    \glossentrysymbol{label}

    -

    +

    This is like \glsentrysymbol{label} but also checks for the existence of ⟨label⟩. This command is not expandable. It’s used in some of the predefined glossary styles to display the symbol. -



    \Glossentrysymbol{label}

    -

    +

    This is like \glossentrysymbol but converts the first letter to upper case. This command is not expandable. -



    \glsentrysymbolplural{label}

    -

    -


    +


    \Glsentrysymbolplural{label}

    -

    +

    These commands display the plural symbol for the glossary entry given by ⟨label⟩. \Glsentrysymbolplural @@ -17811,143 +17865,143 @@ makes the first letter upper case. The first form is expandable (unless the valu unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentryuseri{label}

    -

    -


    +


    \Glsentryuseri{label}

    -

    -


    +


    \glsentryuserii{label}

    -

    -


    +


    \Glsentryuserii{label}

    -

    -


    +


    \glsentryuseriii{label}

    -

    -


    +


    \Glsentryuseriii{label}

    -

    -


    +


    \glsentryuseriv{label}

    -

    -


    +


    \Glsentryuseriv{label}

    -

    -


    +


    \glsentryuserv{label}

    -

    -


    +


    \Glsentryuserv{label}

    -

    -


    +


    \glsentryuservi{label}

    -

    -


    +


    \Glsentryuservi{label}

    -

    +

    These commands display the value of the user keys for the glossary entry given by ⟨label⟩. The lower case forms are expandable (unless the value of the key contains unexpandable commands). The commands beginning with an upper case letter convert the first letter of the required value to upper case and are not expandable. None of these commands check for the existence of ⟨label⟩. -



    \glshyperlink[link text]{label}

    -

    +

    This command provides a hyperlink to the glossary entry given by ⟨labelbut does not add any information to the glossary file. The link text is given by \glsentrytext{label} by default5.4, + id="x1-135054f4">, but can be overridden using the optional argument. Note that the hyperlink will be suppressed if you have used \glsdisablehyper or if you haven’t loaded the or if you haven’t loaded the hyperref package. -

    If you use package. +

    If you use \glshyperlink, you need to ensure that the relevant entry has been added to the glossary using any of the commands described in §??sec:glslink 5.1 Links to Glossary Entries or §??sec:glsadd 10 Adding an Entry to the Glossary Without Generating Text otherwise you will end up with an undefined link.
    -

    -

    The next two commands are only available with

    +

    The next two commands are only available with Option 1 or with the savenumberlist package + id="dx1-135060"> package option: -



    \glsentrynumberlist{label}

    -

    -


    +


    \glsdisplaynumberlist{label}

    -

    +

    Both display the number list for the entry given by ⟨ for the entry given by ⟨label⟩. When used with Option 1 a rerun is required to ensure this list is up-to-date, when used with Options 2 or 3 a run of makeglossaries (or (or makeindex//xindy) + id="dx1-135066">) followed by one or two runs of LaTeX is required. -

    The first command,

    The first command, \glsentrynumberlist, simply displays the number list as is. The second command, \glsdisplaynumberlist, formats the list using: -



    \glsnumlistsep

    -

    +

    as the separator between all but the last two elements and -



    \glsnumlistlastsep

    -

    +

    between the final two elements. The defaults are ,␣ and ␣\&␣, respectively. -

    \glsdisplaynumberlist is fairly experimental. It works with Options 1 and 4, but for Options 2 or 3 it only works when the default counter format is used (that is, when the format key is set to + id="dx1-135069"> key is set to glsnumberformat). This command will only work with hyperref if you choose Options  if you choose Options 1 or 4. If you try using this command with Options 2 or 3 and hyperref, , \glsentrynumberlist will be used instead.
    -

    -

    For further information see “Displaying entry details without adding information to the glossary” in the +

    +

    For further information see “Displaying entry details without adding information to the glossary” in the documented code (glossaries-code.pdf).

    -

    -

    +

    Top

    6. Acronyms and Other Abbreviations

    -

    The

    The glossaries-extra package provides superior abbreviation handling. You may want to consider using that package instead of the commands described here.
    -

    -

    Note that although this chapter uses the term “acronym”, you can also use the commands +

    +

    Note that although this chapter uses the term “acronym”, you can also use the commands described here for initialisms or contractions (as in the case of some of the examples given below). If the glossary title is no longer applicable (for example, it should be “Abbreviations” rather than “Acronyms”) then you can change the title either by redefining \acronymname (see (see §??sec:languages +class="cmbx-10">1.4 Multi-Lingual Support) or by using the title key in the optional argument of key in the optional argument of \printglossary (or + id="dx1-136003"> (or \printacronyms). Alternatively consider using the ). Alternatively consider using the glossaries-extra package’s abbreviations option instead. + id="dx1-136005"> option instead.
    -

    -

    Acronyms use the same underlying mechanism as terms defined with

    +

    Acronyms use the same underlying mechanism as terms defined with \newglossaryentry so you can reference them with \gls and and \glspl. The way the acronym is displayed on . The way the acronym is displayed on first use is governed by the acronym style, which should be set before you define your acronyms. For example:

    -
    +   
     \documentclass{article}
     \usepackage{glossaries}
     \setacronymstyle{long-short}
    @@ -18065,18 +18119,18 @@ First use: \gls{html} and \gls{xml}.
     Next use: \gls{html} and \gls{xml}.
     \end{document}
     
    -

    If you don’t specify a style, you will have a less-flexible, but backward-compatible, “long (short)” style with just +

    If you don’t specify a style, you will have a less-flexible, but backward-compatible, “long (short)” style with just the base glossaries package or the short-nolong style (which only displays the short form on style (which only displays the short form on first use) with glossaries-extra. -

    Acronyms are defined using: -


    Acronyms are defined using: +


    \newacronym[key-val list]{abbrv}{long}

    -

    -

    This creates an entry with the given label in the glossary given by

    +

    This creates an entry with the given label in the glossary given by \acronymtype. You can specify a different + id="dx1-136010">. You can specify a different glossary using the type key within the optional argument. The key within the optional argument. The \newacronym command also uses the long, + id="dx1-136012">, longplural, , short and and shortplural keys in keys in \newglossaryentry to store the long and abbreviated forms and their plurals. -

    If you use

    If you use \newacronym with glossaries-extra, you need to first set the style with:

    \setabbreviationstyle[acronym]{style-name}
    -

    -

    Note that the same restrictions on the entry ⟨

    +

    Note that the same restrictions on the entry ⟨label⟩ in \newglossaryentry also apply to also apply to \newacronym (see §??sec:newglosentry 4 Defining Glossary Entries). Since \newacronym works like works like \newglossaryentry, you can use + id="dx1-136019">, you can use \glsreset to reset the to reset the first use flag. -

    If you haven’t identified the specified glossary type as a list of acronyms (via the package option

    If you haven’t identified the specified glossary type as a list of acronyms (via the package option acronymlists + id="dx1-136021"> or the command \DeclareAcronymList, see , see §??sec:pkgopts-acronym 2.7 Acronym and Abbreviation Options) \newacronym will add it to the list and reset the display style for that glossary via \defglsentryfmt. If you + id="dx1-136023">. If you have a mixture of acronyms and regular entries within the same glossary, care is needed if you want to change the display style: you must first identify that glossary as a list of acronyms and then use \defglsentryfmt (not + id="dx1-136024"> (not redefine \glsentryfmt) before defining your entries. Alternatively, use ) before defining your entries. Alternatively, use glossaries-extra to have better support for a mixed glossary.
    -

    -

    The optional argument

    +

    The optional argument {key-val list} allows you to specify additional information. Any key that can be used in the second argument of \newglossaryentry can also be used here in ⟨ can also be used here in ⟨key-val list⟩. For example, description + id="dx1-136027"> (when used with one of the styles that require a description, described in §??sec:setacronymstyle 6.2 Changing the Acronym Style) or you can override plural forms of ⟨abbrv⟩ or ⟨long⟩ using the shortplural or or longplural keys. + id="dx1-136029"> keys. For example:

    -
    +   
     \newacronym[longplural={diagonal matrices}]%
       {dm}{DM}{diagonal matrix}
     
    -

    If the

    If the first use uses the plural form, \glspl{dm} will display: diagonal matrices (DMs). If you want to use the longplural or or shortplural keys, I recommend you use keys, I recommend you use \setacronymstyle to set the display style rather than + id="dx1-136032"> to set the display style rather than using one of the pre-version 4.02 acronym styles (described in §??sec:pkgopts-old-acronym 2.8 Deprecated Acronym Style Options). -

    As with

    As with plural, if , if longplural is missing, it’s obtained by appending is missing, it’s obtained by appending \glspluralsuffix to the singular + id="dx1-136035"> to the singular form. The short plural shortplural is obtained (if not explicitly set) by appending is obtained (if not explicitly set) by appending \glsacrpluralsuffix to + id="dx1-136037"> to the short form. These commands may be changed by the associated language files, but they can’t be added to the usual caption hooks as there’s no guarantee when they’ll be expanded (as discussed +href="#sec:newlang">discussed earlier). -

    A different approach is used by

    A different approach is used by glossaries-extra, which has category attributes to determine whether or not + id="dx1-136038">category attributes to determine whether or not to append a suffix when forming the default value of shortplural.
    -

    -

    Since .
    +

    +

    Since \newacronym sets type=\acronymtype, if you want to load a file containing acronym definitions using \loadglsentries[type]{type⟩ will not have an effect unless you explicitl the type as type=\glsdefaulttype in the optional argument to \newacronym. See . See §??sec:loadglsentries 4.6 Loading Entries From a File.
    -

    +

    -

    +

    Example 14 (Defining an Abbreviation) -

    The following defines the abbreviation IDN: + id="x1-136043"> +

    The following defines the abbreviation IDN:

    -
    +   
     \setacronymstyle{long-short}
     \newacronym{idn}{IDN}{identification number}
     
    -

    \gls{idn} will produce “identification number (IDN)” on first use and “IDN” on subsequent uses. If you want to use one of the small caps acronym styles, described in acronym styles, described in §??sec:setacronymstyle 6.2 Changing the Acronym Style, you need to use lower case characters for the shortened form:

    -
    +   
     \setacronymstyle{long-sc-short}
     \newacronym{idn}{idn}{identification number}
     
    -

    Now

    Now \gls{idn} will produce “identification number (in” on subsequent uses.

    -

    -

    ____________________________

    -

    Avoid nested definitions.
    -

    -

    Recall from the warning in

    +

    ____________________________

    +

    Avoid nested definitions.
    +

    +

    Recall from the warning in §??sec:newglosentry 4 Defining Glossary Entries that you should avoid using the \gls-like and \glstext-like commands within the value of keys like text and and first + id="dx1-136046"> due to complications arising from nested links. The same applies to abbreviations defined using \newacronym. -

    For example, suppose you have defined: +

    For example, suppose you have defined:

    -
    +   
     \newacronym{ssi}{SSI}{server side includes}
     \newacronym{html}{HTML}{hypertext markup language}
     
    -

    you may be tempted to do: +

    you may be tempted to do:

    -
    +   
     \newacronym{shtml}{S\gls{html}}{\gls{ssi} enabled \gls{html}}
     
    -

    Don’t! This will break the case-changing commands, such as

    Don’t! This will break the case-changing commands, such as \Gls, it will cause inconsistencies on , it will cause inconsistencies on first use, and, if hyperlinks are enabled, will cause nested hyperlinks. It will also confuse the commands used by the entry formatting (such as \glslabel). -

    Instead, consider doing: + id="dx1-136048">). +

    Instead, consider doing:

    -
    +   
     \newacronym
      [description={\gls{ssi} enabled \gls{html}}]
      {shtml}{SHTML}{SSI enabled HTML}
     
    -

    or +

    or

    -
    +   
     \newacronym
      [description={\gls{ssi} enabled \gls{html}}]
      {shtml}{SHTML}
      {server side includes enabled hypertext markup language}
     
    -

    Similarly for the

    Similarly for the \glstext-like commands. -

    Other approaches are available with

    Other approaches are available with glossaries-extra. See the section “Nested Links” in the glossaries-extra user manual.
    -

    +

    -

    Top

    6.1 Displaying the Long, Short and Full Forms (Independent of First Use)

    -

    It may be that you want the long, short or full form regardless of whether or not the acronym has already been +

    It may be that you want the long, short or full form regardless of whether or not the acronym has already been used in the document. You can do so with the commands described in this section. -

    The

    The \acrcommands described below are part of the set of \glstext-like commands. That is, they index and can form hyperlinks, but they don’t modify the first use flag. However, their display is governed by \defentryfmt with with \glscustomtext set as appropriate. All caveats that apply to the + id="dx1-137002"> set as appropriate. All caveats that apply to the \glstext-like commands also apply to the following commands. (Including the above warning about nested links.) -

    If you are using

    -

    -

    The optional arguments are the same as those for the

    +

    The optional arguments are the same as those for the \glstext-like commands, and there are similar star and plus variants that switch off or on the hyperlinks. As with the \glstext-like commands, the link text is + id="dx1-137003"> is placed in the argument of \glstextformat. -


    . +


    \acrshort[options]{label}[insert]

    -

    +

    This sets the link text to the short form (within the argument of to the short form (within the argument of \acronymfont) for the entry given by ⟨) for the entry given by ⟨label⟩. The short form is as supplied by the short key, which key, which \newacronym implicitly sets. -

    There are also analogous upper case variants: -


    implicitly sets. +

    There are also analogous upper case variants: +


    \Acrshort[options]{label}[insert]

    -

    -


    +


    \ACRshort[options]{label}[insert]

    -

    +

    There are also plural versions: -



    \acrshortpl[options]{label}[insert]

    -

    +

    -



    \Acrshortpl[options]{label}[insert]

    -

    -


    +


    \ACRshortpl[options]{label}[insert]

    -

    +

    The short plural form is as supplied by the shortplural key, which key, which \newacronym implicitly sets. -


    implicitly sets. +


    \acrlong[options]{label}[insert]

    -

    +

    This sets the link text to the long form for the entry given by ⟨ to the long form for the entry given by ⟨label⟩. The long form is as supplied by the long + id="dx1-137019"> key, which \newacronym implicitly sets. -

    There are also analogous upper case variants: -


    implicitly sets. +

    There are also analogous upper case variants: +


    \Acrlong[options]{label}[insert]

    -

    -


    +


    \ACRlong[options]{label}[insert]

    -

    +

    Again there are also plural versions: -



    \acrlongpl[options]{label}[insert]

    -

    -


    +


    \Acrlongpl[options]{label}[insert]

    -

    -


    +


    \ACRlongpl[options]{label}[insert]

    -

    +

    The long plural form is as supplied by the longplural key, which key, which \newacronym implicitly sets. -

    The commands below display the full form of the acronym, but note that this isn’t necessarily the same as + id="dx1-137027"> implicitly sets. +

    The commands below display the full form of the acronym, but note that this isn’t necessarily the same as the form used on first use. These full-form commands are shortcuts that use the above commands, rather than creating the link text from the complete full form. These full-form commands have star and plus variants and + id="dx1-137028"> from the complete full form. These full-form commands have star and plus variants and optional arguments that are passed to the above commands. -



    \acrfull[options]{label}[insert]

    -

    +

    This is a shortcut for -



    \acrfullfmt{options}{label}{insert}

    -

    +

    which by default does

    label}}
    where -



    \acrfullformat{long}{short}

    -

    +

    by default does ⟨long⟩ (⟨short⟩). This command is now deprecated for new acronym styles but is used by default for backward compatibility if \setacronymstyle (§??sec:setacronymstyle 6.2 Changing the Acronym Style) hasn’t been used. (For further details of these format commands see the documented code, glossaries-code.pdf.) -

    There are also analogous upper case variants: -


    There are also analogous upper case variants: +


    \Acrfull[options]{label}[insert]

    -

    -


    +


    \ACRfull[options]{label}[insert]

    -

    +

    and plural versions: -



    \acrfullpl[options]{label}[insert]

    -

    -


    +


    \Acrfullpl[options]{label}[insert]

    -

    -


    +


    \ACRfullpl[options]{label}[insert]

    -

    -

    If you find the above commands too cumbersome to write, you can use the

    +

    If you find the above commands too cumbersome to write, you can use the shortcuts package option to + id="dx1-137037"> package option to activate the shorter command names listed in table ??tab:shortcuts. +class="cmbx-10">6.1.

    -


    @@ -18711,7 +18765,7 @@ class="cmbx-10">??tab:shortcuts.
    Table 6.1: Synonyms provided by the package option shortcuts
    +class="cmss-10">shortcuts
    Equivalent Command style="vertical-align:baseline;" id="TBL-7-2-"> + id="dx1-137040"> + id="dx1-137042"> + id="dx1-137044"> + id="dx1-137046"> + id="dx1-137048"> + id="dx1-137050"> + id="dx1-137052"> + id="dx1-137054"> + id="dx1-137056"> + id="dx1-137058"> + id="dx1-137060"> + id="dx1-137062"> + id="dx1-137064"> + id="dx1-137066"> + id="dx1-137068">
    \acs \acrshort
    \Acs \Acrshort
    \acsp \acrshortpl
    \Acsp \Acrshortpl
    \acl \acrlong
    \Acl \Acrlong
    \aclp \acrlongpl
    \Aclp \Acrlongpl
    \acf \acrfull
    \Acf \Acrfull
    \acfp \acrfullpl
    \Acfp \Acrfullpl
    \ac \gls
    \Ac \Gls
    \acp \glspl
    \Acp \Glspl
    + id="dx1-137070">

    -

    It is also possible to access the long and short forms without adding information to the glossary using +

    It is also possible to access the long and short forms without adding information to the glossary using commands analogous to \glsentrytext (described in (described in §??sec:glsnolink 5.2 Using Glossary Terms Without Links). -

    The commands that convert the first letter to upper case come with the same caveats as those for analogous +

    The commands that convert the first letter to upper case come with the same caveats as those for analogous commands like \Glsentrytext (non-expandable, can’t be used in PDF bookmarks, care needs to be taken if the + id="dx1-137072"> (non-expandable, can’t be used in PDF bookmarks, care needs to be taken if the first letter is an accented character etc). See §??sec:glsnolink 5.2 Using Glossary Terms Without Links.
    -

    -

    The long form can be accessed using: -


    +

    The long form can be accessed using: +


    \glsentrylong{label}

    -

    +

    or, with the first letter converted to upper case: -



    \Glsentrylong{label}

    -

    +

    Plural forms: -



    \glsentrylongpl{label}

    -

    -


    +


    \Glsentrylongpl{label}

    -

    -

    Similarly, to access the short form: -


    +

    Similarly, to access the short form: +


    \glsentryshort{label}

    -

    +

    or, with the first letter converted to upper case: -



    \Glsentryshort{label}

    -

    +

    Plural forms: -



    \glsentryshortpl{label}

    -

    -


    +


    \Glsentryshortpl{label}

    -

    -

    And the full form can be obtained using: -


    +

    And the full form can be obtained using: +


    \glsentryfull{label}

    -

    -


    +


    \Glsentryfull{label}

    -

    -


    +


    \glsentryfullpl{label}

    -

    -


    +


    \Glsentryfullpl{label}

    -

    +

    These again use \acrfullformat by default, but the new styles described in the section below use different + id="dx1-137085"> by default, but the new styles described in the section below use different formatting commands.

    -

    Top

    6.2 Changing the Acronym Style

    -

    If you are using

    If you are using glossaries-extra, don’t use the commands described in this section. Use \setabbreviationstyle to + id="dx1-138001"> to set the style. This uses a different (but more consistent) naming scheme. For example, long-noshort instead of + id="dx1-138002"> instead of dua. See the “Acronym Style Modifications” section and the “Abbreviations” chapter in the . See the “Acronym Style Modifications” section and the “Abbreviations” chapter in the glossaries-extra manual for further details.
    -

    -

    The acronym style is set using: -


    +

    The acronym style is set using: +


    \setacronymstyle{style name}

    -

    +

    where ⟨style name⟩ is the name of the required style. -

    You must use

    You must use \setacronymstyle before you define the acronyms with \newacronym.
    -

    -

    For example: +

    +

    For example:

    -
    +   
     \usepackage[acronym]{glossaries}
     \makeglossaries
     \setacronymstyle{long-sc-short}
     \newacronym{html}{html}{hypertext markup language}
     \newacronym{xml}{xml}{extensible markup language}
     
    -

    Unpredictable results can occur if you try to use multiple styles. -

    If you need multiple abbreviation styles, then use the

    Unpredictable results can occur if you try to use multiple styles. +

    If you need multiple abbreviation styles, then use the glossaries-extra package, which has better abbreviation management. See, for example, Gallery: Mixing Styles.
    -

    -

    Unlike the backward-compatible default behaviour of

    +

    Unlike the backward-compatible default behaviour of \newacronym, the styles set via \setacronymstyle don’t use the first or or text keys, but instead they use keys, but instead they use \defglsentryfmt to set a custom format + id="dx1-138007"> to set a custom format that uses the long and and short keys (or their plural equivalents). This means that these styles cope + id="dx1-138009"> keys (or their plural equivalents). This means that these styles cope better with plurals that aren’t formed by simply appending the singular form with the letter “s”. In fact, most of the predefined styles use \glsgenacfmt and modify the definitions of commands like + id="dx1-138010"> and modify the definitions of commands like \genacrfullformat. -

    Note that when you use . +

    Note that when you use \setacronymstyle the name key is set to -


    key is set to +


    \acronymentry{label}

    -

    +

    and the sort key is set to -


    key is set to +


    \acronymsort{short}{long}

    -

    +

    These commands are redefined by the acronym styles. However, you can redefine them again after the style has been set but before you use \newacronym. Protected expansion is performed on \acronymsort when the entry is defined. -

    +

    -

    Top

    6.2.1 Predefined Acronym Styles

    -

    The

    The glossaries package provides a number of predefined styles. These styles apply -



    \firstacronymfont{text}

    -

    +

    to the short form on first use and -



    \acronymfont{text}

    -

    +

    on subsequent use. The styles modify the definition of \acronymfont as required, but \firstacronymfont is + id="dx1-139003"> is only set once by the package when it’s loaded. By default \firstacronymfont{text} is the same as @@ -19091,107 +19145,107 @@ class="cmtt-10">} is the same as \acronymfont{text}. If you want the short form displayed differently on first use, you can redefine \firstacronymfont independently of the acronym style. -

    The predefined styles that contain independently of the acronym style. +

    The predefined styles that contain sc in their name (for example long-sc-short) redefine ) redefine \acronymfont to use \textsc, which means that the short form needs to be specified in lower case. -

    , which means that the short form needs to be specified in lower case. +

    -

    Some fonts don’t support bold

    Some fonts don’t support bold small caps, so you may need to redefine , so you may need to redefine \glsnamefont (see + id="dx1-139010"> (see §??sec:printglossary 8 Displaying a Glossary) to switch to medium weight if you are using a glossary style that displays entry names in bold and you have chosen an acronym style that uses \textsc. + id="dx1-139011">.
    -

    -

    The predefined styles that contain

    +

    The predefined styles that contain sm in their name (for example long-sm-short) redefine ) redefine \acronymfont to use \textsmaller. -

    . +

    -

    Note that the

    Note that the glossaries package doesn’t define or load any package that defines \textsmaller. If you use + id="dx1-139014">. If you use one of the acronym styles that set \acronymfont to to \textsmaller you must explicitly load the relsize package + id="dx1-139016"> package or otherwise define \textsmaller.
    -

    -

    The remaining predefined styles redefine

    +

    The remaining predefined styles redefine \acronymfont{text} to simply do its argument ⟨text⟩. -

    In most cases, the predefined styles adjust

    In most cases, the predefined styles adjust \acrfull and and \glsentryfull (and their plural and upper case + id="dx1-139018"> (and their plural and upper case variants) to reflect the style. The only exceptions to this are the dua and and footnote styles (and their variants). + id="dx1-139020"> styles (and their variants).
    -

    -

    The following styles are supplied by the

    +

    The following styles are supplied by the glossaries package:

    • -

      long-short, , long-sc-short, , long-sm-short, , long-sp-short: -

      With these three styles, acronyms are displayed in the form -


      : +

      With these three styles, acronyms are displayed in the form +


      long(\firstacronymfont{short})

      -

      +

      on first use and -



      \acronymfont{short}

      -

      +

      on subsequent use. They also set \acronymsort{short} is set to just the short form (enclosed in \acronymfont) and the description key is set to the long + id="dx1-139027"> key is set to the long form. -

      The

      The long-sp-short style was introduced in version 4.16 and uses -


      style was introduced in version 4.16 and uses +


      \glsacspace{label}

      -

      +

      for the space between the long and short forms. This defaults to a non-breakable space (~) if @@ -19229,67 +19283,67 @@ class="cmtt-10">}) is less than 3em, otherwise it uses a normal sp

      -
      +     
            \renewcommand*{\glsacspace}[1]{~}
       
      -

      +

    • -

      short-long, , sc-short-long, , sm-short-long: -

      These three styles are analogous to the above three styles, except the display order is swapped + id="dx1-139032">: +

      These three styles are analogous to the above three styles, except the display order is swapped to -



      \firstacronymfont{short} (long)

      -

      +

      on first use. -

      Note, however, that

      Note, however, that \acronymsort and and \acronymentry are the same as for the ⟨ are the same as for the ⟨long⟩ (⟨short⟩) styles above, so the acronyms are still sorted according to the short form.

    • -

      long-short-desc, , long-sc-short-desc, , long-sm-short-desc, , long-sp-short-desc: -

      These are like the : +

      These are like the long-short, , long-sc-short, , long-sm-short and and long-sp-short styles described above, except + id="dx1-139043"> styles described above, except that the description key must be supplied in the optional argument of key must be supplied in the optional argument of \newacronym. They also redefine + id="dx1-139045">. They also redefine \acronymentry to to {long} (\acronymfont{short}) and redefine \acronymsort{short}{long⟩. the name field has the long form followed by the short form in parentheses. I recommend you use a glossary style such as altlist with these acronym styles to allow for the long name + id="dx1-139048"> with these acronym styles to allow for the long name field.

    • -

      short-long-desc, , sc-short-long-desc, , sm-short-long-desc: -

      These styles are analogous to the above three styles, but the first use display style is: -


      : +

      These styles are analogous to the above three styles, but the first use display style is: +


      \firstacronymfont{short} (long)

      -

      +

      The definitions of \acronymsort and \acronymentry are the same as those for long-short-desc + id="dx1-139052"> etc.

    • -

      dua, , dua-desc: + id="dx1-139054">: -

      With these styles, the

      With these styles, the \gls-like commands always display the long form regardless of whether the entry has been used or not. However, \acrfull and and \glsentryfull will display ⟨ will display ⟨long⟩ (\acronymfont{short}). In the case of dua, the , the name and and sort keys are set to the short + id="dx1-139059"> keys are set to the short form and the description is set to the long form. In the case of dua-desc, the , the name and and sort + id="dx1-139062"> keys are set to the long form and the description is supplied in the optional argument of \newacronym. + id="dx1-139063">.

    • -

      footnote, , footnote-sc, , footnote-sm: -

      With these three styles, on first use the : +

      With these three styles, on first use the \gls-like commands display: -



      \firstacronymfont{short}\footnote{long}

      -

      +

      However, \acrfull and and \glsentryfull are set to are set to \acronymfont{short} (⟨long⟩). On subsequent use the display is: -



      \acronymfont{short}

      -

      +

      The sort and and name keys are set to the short form, and the keys are set to the short form, and the description is set to the long + id="dx1-139072"> is set to the long form. -

      In order to avoid nested hyperlinks on

      In order to avoid nested hyperlinks on first use the footnote styles automatically implement hyperfirst=false for the acronym lists.
      -

      + id="dx1-139073"> for the acronym lists.

      +

    • -

      footnote-desc, , footnote-sc-desc, , footnote-sm-desc: -

      These three styles are similar to the previous three styles, but the description has to be supplied in the + id="dx1-139076">: +

      These three styles are similar to the previous three styles, but the description has to be supplied in the optional argument of \newacronym. The . The name key is set to the long form followed by the short form in + id="dx1-139078"> key is set to the long form followed by the short form in parentheses and the sort key is set to the long form. This means that the acronyms will be sorted + id="dx1-139079"> key is set to the long form. This means that the acronyms will be sorted according to the long form. In addition, since the name will typically be quite wide it’s best to choose a + id="dx1-139080"> will typically be quite wide it’s best to choose a glossary style that can accommodate this, such as altlist. + id="dx1-139081">.

    -

    +

    Example 15 (Adapting a Predefined Acronym Style) -

    Suppose I want to use the +

    Suppose I want to use the footnote-sc-desc style, but I want the style, but I want the name key set to the short form followed by + id="dx1-139085"> key set to the short form followed by the long form in parentheses and the sort key set to the short form. Then I need to specify the key set to the short form. Then I need to specify the footnote-sc-desc + id="dx1-139087"> style:

    -
    +   
     \setacronymstyle{footnote-sc-desc}
     
    -

    and then redefine

    and then redefine \acronymsort and and \acronymentry: + id="dx1-139089">:

    -
    +   
     \renewcommand*{\acronymsort}[2]{#1}% sort by short form
     \renewcommand*{\acronymentry}[1]{%
       \acronymfont{\glsentryshort{#1}}\space (\glsentrylong{#1})}%
     
    -

    (I’ve used

    (I’ve used \space for extra clarity, but you can just use an actual space instead.) -

    Note that the default Computer Modern fonts don’t support bold

    Note that the default Computer Modern fonts don’t support bold small caps, so another font is required. For + id="dx1-139090">, so another font is required. For example:

    -
    +   
     \usepackage[T1]{fontenc}
     
    -

    The alternative is to redefine

    The alternative is to redefine \acronymfont so that it always switches to medium weight to ensure the so that it always switches to medium weight to ensure the small caps setting is used. For example: + id="dx1-139092"> setting is used. For example:

    -
    +   
     \renewcommand*{\acronymfont}[1]{\textmd{\scshape #1}}
     
    -

    -

    The sample file

    +

    The sample file sampleFnAcrDesc.tex illustrates this example.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    6.2.2 Defining A Custom Acronym Style

    -

    You may find that the predefined acronyms styles that come with the

    You may find that the predefined acronyms styles that come with the glossaries package don’t suit your requirements. In this case you can define your own style using: -



    \newacronymstyle{style name}{display}{definitions}

    -

    +

    where ⟨style name⟩ is the name of the new style (avoid active characters). The second argument, ⟨display⟩, is equivalent to the mandatory argument of \defglsentryfmt. You can simply use . You can simply use \glsgenacfmt or you can + id="dx1-140003"> or you can customize the display using commands like \ifglsused, , \glsifplural and and \glscapscase. (See + id="dx1-140006">. (See §??sec:glsdisplay 5.1.3 Changing the format of the link text for further details.) If the style is likely to be used with a mixed glossary (that is entries in that glossary are defined both with \newacronym and and \newglossaryentry) + id="dx1-140008">) then you can test if the entry is an acronym and use \glsgenacfmt if it is or if it is or \glsgenentryfmt if it isn’t. For + id="dx1-140010"> if it isn’t. For example, the long-short style sets ⟨ style sets ⟨display⟩ as

    -
    +   
     \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
     
    -

    (You can use

    (You can use \ifglshasshort instead of instead of \ifglshaslong to test if the entry is an acronym if you + id="dx1-140013"> to test if the entry is an acronym if you prefer.) -

    The third argument, ⟨

    The third argument, ⟨definitions⟩, can be used to redefine the commands that affect the display style, such as \acronymfont or, if ⟨ or, if ⟨display⟩ uses \glsgenacfmt, \genacrfullformat and its variants. -

    Note that and its variants. +

    Note that \setacronymstyle redefines redefines \glsentryfull and and \acrfullfmt to use to use \genacrfullformat (and + id="dx1-140019"> (and similarly for the plural and upper case variants). If this isn’t appropriate for the style (as in the case of styles like footnote and and dua) ) \newacronymstyle should redefine these commands within ⟨definitions⟩. -

    Within

    Within \newacronymstyle’s ⟨definitions⟩ argument you can also redefine -



    \GenericAcronymFields

    -

    +

    This is a list of additional fields to be set in \newacronym. You can use the following token registers to access + id="dx1-140023">. You can use the following token registers to access the entry label, long form and short form: \glslabeltok, \glslongtok and \glsshorttok. As with all TeX registers, you can access their values by preceding the register with \the. For example, the . For example, the long-short style + id="dx1-140028"> style does:

    -
    +   
     \renewcommand*{\GenericAcronymFields}{%
        description={\the\glslongtok}}%
     
    -

    which sets the

    which sets the description field to the long form of the acronym whereas the field to the long form of the acronym whereas the long-short-desc style + id="dx1-140030"> style does:

    -
    +   
     \renewcommand*{\GenericAcronymFields}{}%
     
    -

    since the description needs to be specified by the user. -

    It may be that you want to define a new acronym style that’s based on an existing style. Within ⟨

    since the description needs to be specified by the user. +

    It may be that you want to define a new acronym style that’s based on an existing style. Within ⟨display⟩ you can use -



    \GlsUseAcrEntryDispStyle{style name}

    -

    +

    to use the ⟨display⟩ definition from the style given by ⟨style name⟩. Within ⟨definitions⟩ you can use -



    \GlsUseAcrStyleDefs{style name}

    -

    +

    to use the ⟨definitions⟩ from the style given by ⟨style name⟩. For example, the long-sc-short acronym style is + id="dx1-140033"> acronym style is based on the long-short style with minor modifications (remember to use style with minor modifications (remember to use ## instead of # within ⟨definitions⟩):

    -
    +   
     \newacronymstyle{long-sc-short}%
     {% use the same display as "long-short"
       \GlsUseAcrEntryDispStyle{long-short}%
    @@ -19697,15 +19751,15 @@ class="cmti-10">definitions⟩):
       \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%
     }
     
    -

    (

    (\glstextup is used to cancel the effect of \textsc. This defaults to . This defaults to \textulc, if defined, otherwise , if defined, otherwise \textup. + id="dx1-140038">. For example, the plural of svms.) -

    +

    Example 16 (Defining a Custom Acronym Style) -

    Suppose I want my acronym on +

    Suppose I want my acronym on first use to have the short form in the text and the long form with the description in a footnote. Suppose also that I want the short form to be put in small caps in the main body of the document, but I want it in normal capitals in the list of acronyms. In my list of acronyms, I want the long form as the name with the short form in brackets followed by the description. That is, in the text I want \gls + id="dx1-140041"> on first use to display:
    \textsc{abbrv}\footnote} on subsequent use:
    \textsc{abbrv} @@ -19760,27 +19814,27 @@ class="cmti-10">long⟩ (⟨short⟩) ⟨description
    -

    Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the second argument of +

    Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the second argument of \newacronymstyle using: + id="dx1-140044"> using:

    -
    +   
     \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
     
    -

    This will use

    This will use \glsgenentryfmt if the entry isn’t an acronym, otherwise it will use if the entry isn’t an acronym, otherwise it will use \glsgenacfmt. The third + id="dx1-140046">. The third argument (⟨definitions⟩) of \newacronymstyle needs to redefine needs to redefine \genacrfullformat etc so that the etc so that the first use displays the short form in the text with the long form in a footnote followed by the description. This is done as follows (remember to use #):

    -
    +   
      % No case change, singular first use:
       \renewcommand*{\genacrfullformat}[2]{%
        \firstacronymfont{\glsentryshort{##1}}##2%
    @@ -19811,12 +19865,12 @@ class="cmtt-10">#):
        \footnote{\glsentrylongpl{##1}: \glsentrydesc{##1}}%
       }%
     
    -

    If you think it inappropriate for the short form to be capitalised at the start of a sentence you can change the +

    If you think it inappropriate for the short form to be capitalised at the start of a sentence you can change the above to:

    -
    +   
      % No case change, singular first use:
       \renewcommand*{\genacrfullformat}[2]{%
        \firstacronymfont{\glsentryshort{##1}}##2%
    @@ -19830,33 +19884,33 @@ above to:
      \let\Genacrfullformat\genacrfullformat
      \let\Genplacrfullformat\genplacrfullformat
     
    -

    Another variation is to use

    Another variation is to use \Glsentrylong and and \Glsentrylongpl in the footnote instead of in the footnote instead of \glsentrylong + id="dx1-140051"> and \glsentrylongpl. -

    Now let’s suppose that commands such as . +

    Now let’s suppose that commands such as \glsentryfull and and \acrfull shouldn’t use a footnote, but + id="dx1-140054"> shouldn’t use a footnote, but instead use the format: ⟨long⟩ (⟨short⟩). This means that the style needs to redefine \glsentryfull, \acrfullfmt + id="dx1-140055"> and their plural and upper case variants. -

    First, the non-linking commands: +

    First, the non-linking commands:

    -
    +   
       \renewcommand*{\glsentryfull}[1]{%
         \glsentrylong{##1}\space
           (\acronymfont{\glsentryshort{##1}})%
    @@ -19874,11 +19928,11 @@ and their plural and upper case variants.
           (\acronymfont{\glsentryshortpl{##1}})%
       }%
     
    -

    Now for the linking commands: +

    Now for the linking commands:

    -
    +   
       \renewcommand*{\acrfullfmt}[3]{%
         \glslink[##1]{##2}{%
          \glsentrylong{##2}##3\space
    @@ -19920,100 +19974,100 @@ and their plural and upper case variants.
         }%
       }%
     
    -

    (This may cause problems with long hyperlinks, in which case adjust the definitions so that, for example, only +

    (This may cause problems with long hyperlinks, in which case adjust the definitions so that, for example, only the short form is inside the argument of \glslink.) -

    The style also needs to redefine .) +

    The style also needs to redefine \acronymsort so that the acronyms are sorted according to the long + id="dx1-140057"> so that the acronyms are sorted according to the long form:

    -
    +   
       \renewcommand*{\acronymsort}[2]{##2}%
     
    -

    If you prefer them to be sorted according to the short form you can change the above to: +

    If you prefer them to be sorted according to the short form you can change the above to:

    -
    +   
       \renewcommand*{\acronymsort}[2]{##1}%
     
    -

    The acronym font needs to be set to

    The acronym font needs to be set to \textsc and the plural suffix adjusted so that the “s” suffix in the plural + id="dx1-140058"> and the plural suffix adjusted so that the “s” suffix in the plural short form doesn’t get converted to small caps: + id="dx1-140059">:

    -
    +   
       \renewcommand*{\acronymfont}[1]{\textsc{##1}}%
       \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%
     
    -

    There are a number of ways of dealing with the format in the list of acronyms. The simplest way is to redefine +

    There are a number of ways of dealing with the format in the list of acronyms. The simplest way is to redefine \acronymentry to the long form followed by the upper case short form in parentheses: + id="dx1-140060"> to the long form followed by the upper case short form in parentheses:

    -
    +   
      \renewcommand*{\acronymentry}[1]{%
        \Glsentrylong{##1}\space
          (\MakeTextUppercase{\glsentryshort{##1}})}%
     
    -

    (I’ve used

    (I’ve used \Glsentrylong instead of instead of \glsentrylong to capitalise the name in the glossary.) -

    An alternative approach is to set to capitalise the name in the glossary.) +

    An alternative approach is to set \acronymentry to just the long form and redefine to just the long form and redefine \GenericAcronymFields to + id="dx1-140064"> to set the symbol key to the short form and use a glossary style that displays the symbol in parentheses after the + id="dx1-140065"> key to the short form and use a glossary style that displays the symbol in parentheses after the name (such as the (such as the tree style) like this: + id="dx1-140067"> style) like this:

    -
    +   
      \renewcommand*{\acronymentry}[1]{\Glsentrylong{##1}}%
      \renewcommand*{\GenericAcronymFields}{%
         symbol={\protect\MakeTextUppercase{\the\glsshorttok}}}%
     
    -

    I’m going to use the first approach and set

    I’m going to use the first approach and set \GenericAcronymFields to do nothing: + id="dx1-140068"> to do nothing:

    -
    +   
      \renewcommand*{\GenericAcronymFields}{}%
     
    -

    -

    Finally, this style needs to switch off hyperlinks on first use to avoid nested links: +

    +

    Finally, this style needs to switch off hyperlinks on first use to avoid nested links:

    -
    +   
      \glshyperfirstfalse
     
    -

    Putting this all together: +

    Putting this all together:

    -
    +   
     \newacronymstyle{custom-fn}% new style name
     {%
       \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
    @@ -20103,29 +20157,29 @@ class="cmtt-10">\GenericAcronymFields
    -

    -

    Now I need to specify that I want to use this new style: +

    +

    Now I need to specify that I want to use this new style:

    -
    +   
     \setacronymstyle{custom-fn}
     
    -

    I also need to use a glossary style that suits this acronym style, for example

    I also need to use a glossary style that suits this acronym style, for example altlist: + id="dx1-140069">:

    -
    +   
     \setglossarystyle{altlist}
     
    -

    -

    Once the acronym style has been set, I can define my acronyms: +

    +

    Once the acronym style has been set, I can define my acronyms:

    -
    +   
     \newacronym[description={set of tags for use in
     developing hypertext documents}]{html}{html}{Hyper
     Text Markup Language}
    @@ -20133,44 +20187,44 @@ Text Markup Language}
     layout of a document written in a markup language}]{css}
     {css}{Cascading Style Sheet}
     
    -

    -

    The sample file

    +

    The sample file sample-custom-acronym.tex illustrates this example.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    +

    Example 17 (Italic and Upright Abbreviations) -

    Suppose I want to have some abbreviations in italic and some that just use the surrounding font. + id="x1-140071"> +

    Suppose I want to have some abbreviations in italic and some that just use the surrounding font. Hard-coding this into the ⟨short⟩ argument of \newacronym can cause complications. -

    This example uses

    This example uses \glsaddstoragekey to add an extra field that can be used to store the formatting + id="dx1-140072"> to add an extra field that can be used to store the formatting declaration (such as \em).

    -
    +   
     \glsaddstoragekey{font}{}{\entryfont}
     
    -

    This defines a new field/key called

    This defines a new field/key called font, which defaults to nothing if it’s not explicitly set. This also defines a command called \entryfont that’s analogous to \glsentrytext. A new style is then created to format abbreviations that access this field. -

    There are two ways to do this. The first is to create a style that doesn’t use

    There are two ways to do this. The first is to create a style that doesn’t use \glsgenacfmt + id="dx1-140073"> but instead provides a modified version that doesn’t use \acronymfont{short -

    +   
       \renewcommand*{\genacrfullformat}[2]{%
        \glsentrylong{##1}##2\space
        ({\entryfont{##1}\glsentryshort{##1}})%
       }%
     
    -

    This will deal with commands like

    This will deal with commands like \gls but not commands like but not commands like \acrshort which still use which still use \acronymfont. + id="dx1-140076">. Another approach is to redefine \acronymfont to look up the required font declaration. Since \acronymfont @@ -20206,7 +20260,7 @@ doesn’t take the entry label as an argument, the following will only work class="cmtt-10">\acronymfont is used in a context where the label is provided by \glslabel. This is true in . This is true in \gls, \acrshort and \acrfull. The redefinition is @@ -20214,14 +20268,14 @@ now:

    -
    +   
     \renewcommand*{\acronymfont}[1]{{\entryfont{\glslabel}#1}}%
     
    -

    So the new style can be defined as: +

    So the new style can be defined as:

    -
    +   
     \newacronymstyle{long-font-short}
     {%
       \GlsUseAcrEntryDispStyle{long-short}%
    @@ -20248,22 +20302,22 @@ now:
       \renewcommand*{\acronymentry}[1]{{\entryfont{##1}\glsentryshort{##1}}}%
     }
     
    -

    Remember the style needs to be set before defining the entries: +

    Remember the style needs to be set before defining the entries:

    -
    +   
     \setacronymstyle{long-font-short}
     
    -

    -

    The complete document is contained in the sample file

    +

    The complete document is contained in the sample file sample-font-abbr.tex.

    -

    -

    ____________________________

    -

    Some writers and publishing houses have started to drop full stops (periods) from upper case initials but +

    +

    ____________________________

    +

    Some writers and publishing houses have started to drop full stops (periods) from upper case initials but may still retain them for lower case abbreviations, while others may still use them for both upper and lower case. This can cause complications. Chapter 12 of The TeXbook discusses the spacing between words but, @@ -20275,25 +20329,25 @@ class="cmtt-10">␣ (back slash space) in place of jus for an inter-word mid-sentence space and use \@ before the full stop to indicate the end of the sentence. -

    For example: +

    For example:

    -
    +   
     I was awarded a B.Sc. and a Ph.D. (From the same place.)
     
    -

    is typeset as +

    is typeset as
    I was awarded a B.Sc. and a Ph.D. (From the same place.)
    The spacing is more noticeable with the typewriter font:

    -
    +   
     \ttfamily
     I was awarded a B.Sc. and a Ph.D. (From the same place.)
     
    -

    is typeset as +

    is typeset as
    I was awarded a B.Sc. and a Ph.D. (From the same place.)
    @@ -20303,11 +20357,11 @@ the following full stop is just part of the abbreviation. These can be corrected

    -
    +   
     I was awarded a B.Sc.\ and a Ph.D\@. (From the same place.)
     
    -

    -

    This situation is a bit problematic for

    +

    This situation is a bit problematic for glossaries. The full stops can form part of the ⟨short⟩ argument of \@ before the full stop. -

    The next example shows one way of achieving this. (Note that the supplemental

    The next example shows one way of achieving this. (Note that the supplemental glossaries-extra package provides a much simpler way of doing this, which you may prefer to use. See Gallery: Initialisms.) -

    +

    Example 18 (Abbreviations with Full Stops (Periods)) -

    As from version 4.16, there’s now a hook ( +

    As from version 4.16, there’s now a hook (\glspostlinkhook) that’s called at the very end of the + id="dx1-140080">) that’s called at the very end of the \gls-like and \glstext-like commands. This can be redefined to check if the following character is a full stop. The amsgen package (which is automatically loaded by package (which is automatically loaded by glossaries) provides an internal command called \new@ifnextchar that can be used to determine if the given character appears next. (For more information see the amsgen documentation.) -

    It’s possible that I may also want acronyms or contractions in my document, so I need some way to + id="dx1-140082"> documentation.) +

    It’s possible that I may also want acronyms or contractions in my document, so I need some way to differentiate between them. Here I’m going to use the same method as in example 4 where a new field is defined +href="#x1-119002r4">4 where a new field is defined to indicate the type of abbreviation:

    -
    +   
     \glsaddstoragekey{abbrtype}{word}{\abbrtype}
     \newcommand*{\newabbr}[1][]{\newacronym[abbrtype=initials,#1]}
     
    -

    Now I just use

    Now I just use \newacronym for the acronyms, for example, + id="dx1-140083"> for the acronyms, for example,

    -
    +   
     \newacronym{laser}{laser}{light amplification by stimulated
     emission of radiation}
     
    -

    and my new command

    and my new command \newabbr for initials, for example,

    -
    +   
     \newabbr{eg}{e.g.}{exempli gratia}
     \newabbr{ie}{i.e.}{id est}
     \newabbr{bsc}{B.Sc.}{Bachelor of Science}
     \newabbr{ba}{B.A.}{Bachelor of Arts}
     \newabbr{agm}{A.G.M.}{annual general meeting}
     
    -

    Within

    Within \glspostlinkhook the entry’s label can be accessed using \glslabel and and \ifglsfieldeq can be used + id="dx1-140085"> can be used to determine if the current entry has the new abbrtype field set to “initials”. If it doesn’t, then nothing needs to happen, but if it does, a check is performed to see if the next character is a full stop. If it is, this signals the end of a sentence otherwise it’s mid-sentence. -

    Remember that internal commands within the document file (rather than in a class or package) need to be +

    Remember that internal commands within the document file (rather than in a class or package) need to be placed between \makeatletter and and \makeatother: + id="dx1-140087">:

    -
    +   
     \makeatletter
     \renewcommand{\glspostlinkhook}{%
      \ifglsfieldeq{\glslabel}{abbrtype}{initials}%
    @@ -20410,7 +20464,7 @@ class="cmtt-10">\makeatother
    -

    In the event that a full stop is found

    In the event that a full stop is found \doendsentence is performed but it will be followed by the full stop, which needs to be discarded. Otherwise \doendword will be done but it won’t be followed by a full stop so @@ -20418,79 +20472,79 @@ there’s nothing to discard. The definitions for these commands are:

    -
    +   
     \newcommand{\doendsentence}[1]{\spacefactor=10000{}}
     \newcommand{\doendword}{\spacefactor=1000{}}
     
    -

    Now, I can just do

    Now, I can just do \gls{bsc} mid-sentence and \gls{phd}. at the end of the sentence. The terminating full stop will be discarded in the latter case, but it won’t be discarded in, say, \gls{laser}. as that doesn’t have the abbrtype field set to “initials”. -

    This also works on first use when the style is set to one of the ⟨

    This also works on first use when the style is set to one of the ⟨long⟩ (⟨short⟩) styles but it will fail with the ⟨short⟩ (⟨long⟩) styles as in this case the terminating full stop shouldn’t be discarded. Since \glspostlinkhook is + id="dx1-140088"> is used after the first use flag has been unset for the entry, this can’t be fixed by simply checking with \ifglsused. One possible solution to this is to redefine . One possible solution to this is to redefine \glslinkpostsetkeys to check for the to check for the first use flag and define a macro that can then be used in \glspostlinkhook. -

    The other thing to consider is what to do with plurals. One possibility is to check for plural use + id="dx1-140091">. +

    The other thing to consider is what to do with plurals. One possibility is to check for plural use within \doendsentence (using \glsifplural) and put the full stop back if the plural has been + id="dx1-140092">) and put the full stop back if the plural has been used. -

    The complete document is contained in the sample file

    The complete document is contained in the sample file sample-dot-abbr.tex.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    6.3 Displaying the List of Acronyms

    -

    The list of acronyms is just like any other type of glossary and can be displayed on its own using: +

    The list of acronyms is just like any other type of glossary and can be displayed on its own using:

    -

    +

    Option 1:

    -

    +

    \printnoidxglossary[type=\acronymtype]
    -

    +

    Options 3:

    -

    +

    \printglossary[type=\acronymtype]
    -

    (If you use the

    (If you use the acronym package option you can also use

    + id="dx1-141005"> package option you can also use

    \printacronyms[options] @@ -20529,32 +20583,32 @@ class="cmtt-10">]
    \printglossary[type=\acronymtype,options]
    See §??sec:pkgopts-acronym 2.7 Acronym and Abbreviation Options.)
    -

    Alternatively the list of acronyms can be displayed with all the other glossaries using: +

    Alternatively the list of acronyms can be displayed with all the other glossaries using:

    -

    +

    Option 1:

    -

    \printnoidxglossaries + id="dx1-141009">

    -

    +

    Options 3:

    -

    \printglossaries

    -

    However, care must be taken to choose a glossary style that’s appropriate to your acronym style. + id="dx1-141010">

    +

    However, care must be taken to choose a glossary style that’s appropriate to your acronym style. Alternatively, you can define your own custom style (see §??sec:newglossarystyle 13.2 Defining your own glossary style for further details). -

    +

    -

    Top

    6.4 Upgrading From the glossary Package

    -

    Users of the obsolete

    Users of the obsolete glossary package may recall that the syntax used to define new acronyms has changed with + id="dx1-142001"> package may recall that the syntax used to define new acronyms has changed with the replacement glossaries package. In addition, the old glossary package created the command package created the command \acr-name⟩ when defining the acronym ⟨acr-name⟩. -

    In order to facilitate migrating from the old package to the new one, the

    In order to facilitate migrating from the old package to the new one, the glossaries package6.1 + id="x1-142003f1"> provides the command: -



    \oldacronym[label]{long}{key-val list}

    -

    +

    This uses the same syntax as the glossary package’s method of defining acronyms. It is equivalent to: + id="dx1-142005"> package’s method of defining acronyms. It is equivalent to:
    \newacronym[key-val list]{}
    In addition, \oldacronym also defines the commands also defines the commands \label⟩, which is equivalent to \gls{label}, and label*, which is equivalent to \Gls{label}. If ⟨\label⟩ doesn’t allow you to use the first optional argument of \gls or or \Gls — you will need to explicitly use — you will need to explicitly use \gls or or \Gls to change + id="dx1-142013"> to change the settings. -

    Recall that, in general, LaTeX ignores spaces following command names consisting of alphabetical +

    Recall that, in general, LaTeX ignores spaces following command names consisting of alphabetical characters. This is also true for \label⟩ unless you additionally load the xspace package, but be aware that there + id="dx1-142014"> package, but be aware that there are some issues with using xspace..6.2
    -

    +

    -

    The +

    The glossaries package doesn’t load the xspace package since there are both advantages and disadvantages to + id="dx1-142017"> package since there are both advantages and disadvantages to using \xspace in in \label⟩. If you don’t use the xspace package you need to explicitly force a space + id="dx1-142019"> package you need to explicitly force a space using \␣ (backslash space) however you can follow \label⟩ with additional text in square brackets (the final optional argument to \gls). If you use the ). If you use the xspace package you don’t need to escape + id="dx1-142021"> package you don’t need to escape the spaces but you can’t use the optional argument to insert text (you will have to explicitly use \gls). -

    To illustrate this, suppose I define the acronym “abc” as follows: + id="dx1-142022">). +

    To illustrate this, suppose I define the acronym “abc” as follows:

    -
    +   
     \oldacronym{abc}{example acronym}{}
     
    -

    This will create the command

    This will create the command \abc and its starred version \abc*. Table ??tab:xspace illustrates the effect of +class="cmbx-10">6.2 illustrates the effect of \abc (on subsequent use) according to whether or not the xspace package has been loaded. As can be seen + id="dx1-142023"> package has been loaded. As can be seen from the final row in the table, the xspace package prevents the optional argument from being + id="dx1-142024"> package prevents the optional argument from being recognised.

    -


    @@ -20733,7 +20787,7 @@ recognised. >Table 6.2: The effect of using xspace with \oldacronym
    +class="cmtt-10">\oldacronym
    abc’s xyz
    -

    -

    +

    Top

    7. Unsetting and Resetting Entry Flags

    -

    When using the

    When using the \gls-like commands it is possible that you may want to use the value given by the first + id="dx1-143001"> key, even though you have already used the glossary entry. Conversely, you may want to use the value given by the text key, even though you haven’t used the glossary entry. The former can be achieved by one of the + id="dx1-143002"> key, even though you haven’t used the glossary entry. The former can be achieved by one of the following commands: -



    \glsreset{label}

    -

    -


    +


    \glslocalreset{label}

    -

    +

    while the latter can be achieved by one of the following commands: -



    \glsunset{label}

    -

    -


    +


    \glslocalunset{label}

    -

    +

    You can also reset or unset all entries for a given glossary or list of glossaries using: -



    \glsresetall[glossary list]

    -

    -


    +


    \glslocalresetall[glossary list]

    -

    -


    +


    \glsunsetall[glossary list]

    -

    -


    +


    \glslocalunsetall[glossary list]

    -

    +

    where ⟨glossary list⟩ is a comma-separated list of glossary labels. If omitted, all defined glossaries are assumed (except for the ignored ones). For example, to reset all entries in the main glossary and the list of @@ -20862,14 +20916,14 @@ acronyms:

    -
    +   
     \glsresetall[main,acronym]
     
    -

    -

    You can determine whether an entry’s

    +

    You can determine whether an entry’s first use flag is set using: -



    \ifglsused{label}{true part}{false part}

    -

    +

    where ⟨label⟩ is the label of the required entry. If the entry has been used, ⟨true part⟩ will be done, otherwise ⟨false part⟩ will be done. -

    Note that

    Note that \ifglsused is unreliable with bib2gls as the entry isn’t defined on the first LaTeX run, + id="dx1-143012"> as the entry isn’t defined on the first LaTeX run, which means there’s no way of determining if it has been used, so glossaries-extra provides a similar command: -



    \GlsXtrIfUnusedOrUndefined{label}{true part}{false part}

    -

    -

    Be careful when using

    +

    Be careful when using \gls-like commands within an environment or command argument that gets processed multiple times as it can cause unwanted side-effects when the first use displayed text is different from subsequent use.
    -

    -

    For example, the

    +

    For example, the frame environment in environment in beamer processes its argument for each overlay. This means that the + id="dx1-143016"> processes its argument for each overlay. This means that the first use flag will be unset on the first overlay and subsequent overlays will use the non-first use form. -

    Consider the following example: +

    Consider the following example:

    -
    +   
     \documentclass{beamer}
     \usepackage{glossaries}
     \newacronym{svm}{SVM}{support vector machine}
    @@ -20937,21 +20991,21 @@ form.
     \end{frame}
     \end{document}
     
    -

    -

    On the first overlay,

    +

    On the first overlay, \gls{svm} produces “support vector machine (SVM)” and then unsets the first use flag. When the second overlay is processed, \gls{svm} now produces “SVM”, which is unlikely to be the desired effect. I don’t know anyway around this and I can only offer two suggestions. -

    Firstly, unset all acronyms at the start of the document and explicitly use

    Firstly, unset all acronyms at the start of the document and explicitly use \acrfull when you want the full + id="dx1-143017"> when you want the full version to be displayed:

    -
    +   
     \documentclass{beamer}
     \usepackage{glossaries}
     \newacronym{svm}{SVM}{support vector machine}
    @@ -20966,12 +21020,12 @@ version to be displayed:
     \end{frame}
     \end{document}
     
    -

    -

    Secondly, explicitly reset each acronym on first use: +

    +

    Secondly, explicitly reset each acronym on first use:

    -
    +   
     \begin{frame}
      \frametitle{Frame 1}
      \begin{itemize}
    @@ -20980,32 +21034,32 @@ version to be displayed:
      \end{itemize}
     \end{frame}
     
    -

    These are non-optimal, but the

    These are non-optimal, but the beamer class is too complex for me to provide a programmatic solution. Other + id="dx1-143018"> class is too complex for me to provide a programmatic solution. Other potentially problematic environments are some tabular-like environments (but not -like environments (but not tabular itself) that process the + id="dx1-143021"> itself) that process the contents in order to work out the column widths and then reprocess the contents to do the actual typesetting. -

    The

    The amsmath environments, such as environments, such as align, also process their contents multiple times, but the , also process their contents multiple times, but the glossaries package now checks for this. For tabularx, you need to explicitly patch it by placing , you need to explicitly patch it by placing \glspatchtabularx in the preamble (or anywhere before the problematic use of tabularx). -

    If you need to use commands like

    If you need to use commands like \gls in any problematic context that interferes with the first use flag, then you can try using the buffering system provided with glossaries-extra. See the “First Use Flag” the glossaries-extra manual.
    -

    +

    -

    Top

    7.1 Counting the Number of Times an Entry has been Used (First Use Flag Unset)

    -

    As from version 4.14, it’s now possible to keep track of how many times an entry is used. That is, +

    As from version 4.14, it’s now possible to keep track of how many times an entry is used. That is, how many times the first use flag is unset. Note that the supplemental glossaries-extra package improves this function and also provides per-unit counting, which isn’t available with the glossaries package. -

    This function is disabled by default as it adds extra overhead to the document build time and +

    This function is disabled by default as it adds extra overhead to the document build time and also switches \newglossaryentry (and therefore (and therefore \newacronym) into a preamble-only command. + id="dx1-144002">) into a preamble-only command.
    -

    -

    To enable this function, use -


    +

    To enable this function, use +


    \glsenableentrycount

    -

    +

    before defining your entries. This adds two extra (internal) fields to entries: currcount and prevcount. -

    The

    The currcount field keeps track of how many times \glsunset is used within the document. A local unset (using \glslocalunset) performs a local rather than globa class="cmtt-10">currcount. Remember that not all commands use \glsunset. Only the \gls-like commands do this. The reset commands \glsreset and \glslocalreset performs a local change). -

    The

    The prevcount field stores the final value of the currcount field from the previous run. This value is read from the aux file at the beginning of the file at the beginning of the document environment. -

    You can access these fields using -


    environment. +

    You can access these fields using +


    \glsentrycurrcount{label}

    -

    +

    for the currcount field, and -



    \glsentryprevcount{label}

    -

    +

    for the prevcount field. -

    These commands are only defined if you have used

    These commands are only defined if you have used \glsenableentrycount.
    -

    -

    For example: +

    +

    For example:

    -
    +   
     \documentclass{article}
     \usepackage{glossaries}
     \makeglossaries
    @@ -21107,7 +21161,7 @@ Total usage on previous run: \glsentryprevcou
     Number of times apple has been used: \glsentrycurrcount{apple}.
     \end{document}
     
    -

    On the first LaTeX run,

    On the first LaTeX run, \glsentryprevcount{apple} produces 0. At the end of the document, \glsentrycurrcount{apple} produces 4. This is because the only commands that have incremented the entry @@ -21128,11 +21182,11 @@ the value of the currcount field for the apple entry at the end of the document on the previous run. -

    When you enable the entry count using

    When you enable the entry count using \glsenableentrycount, you also enable the following commands: -



    \cgls[options]{label}[insert]

    -

    +

    (no case-change, singular) -



    \cglspl[options]{label}[insert]

    -

    +

    (no case-change, plural) -



    \cGls[options]{label}[insert]

    -

    +

    (first letter uppercase, singular), and -



    \cGlspl[options]{label}[insert]

    -

    +

    (first letter uppercase, plural). These all have plus and starred variants like the analogous \gls, \glspl, \Gls and \Glspl commands. -

    If you don’t use

    If you don’t use \glsenableentrycount, these commands behave like \gls, \glspl, \cgls, \cglspl, \cGls or \cGlspl. -



    \cglsformat{label}{insert}

    -

    +

    This command is used by \cgls and defaults to

    @@ -21243,14 +21297,14 @@ class="cmtt-10">}⟨insert
    otherwise. -



    \cglsplformat{label}{insert}

    -

    +

    This command is used by \cglspl and defaults to

    @@ -21270,14 +21324,14 @@ class="cmtt-10">}⟨insert
    otherwise. -



    \cGlsformat{label}{insert}

    -

    +

    This command is used by \cGls and defaults to

    @@ -21299,14 +21353,14 @@ class="cmtt-10">}⟨insert
    otherwise. -



    \cGlsplformat{label}{insert}

    -

    +

    This command is used by \cGlspl and defaults to

    @@ -21326,15 +21380,15 @@ class="cmtt-10">}⟨insert
    otherwise. -

    This means that if the previous count for the given entry was 1, the entry won’t be hyperlinked with the +

    This means that if the previous count for the given entry was 1, the entry won’t be hyperlinked with the \cgls-like commands and they won’t add a line to the external glossary file. If you haven’t used any of the other commands that add information to the glossary file (such as \glsadd or the \glstext-like commands) then the entry won’t appear in the glossary. -

    Remember that since these commands use

    Remember that since these commands use \glsentryprevcount you need to run LaTeX twice to ensure they work correctly. The document build order is now (at least): (pdf)latex, makeglossaries, (pdf)latex. -

    +

    Example 19 (Don’t index entries that are only used once) -

    In this example, the abbreviations that have only been used once (on the previous run) only have their long + id="x1-144018"> +

    In this example, the abbreviations that have only been used once (on the previous run) only have their long form shown with \cgls.

    -
    +   
     \documentclass{article}
     \usepackage[colorlinks]{hyperref}
     \usepackage[acronym]{glossaries}
    @@ -21375,7 +21429,7 @@ These entries are only used once: \cgl
     \printglossaries
     \end{document}
     
    -

    After a complete document build (

    After a complete document build (latex, latex, makeglossaries,

    -

    -

    ____________________________

    -

    Remember that if you don’t like typing

    +

    ____________________________

    +

    Remember that if you don’t like typing \cgls you can create a synonym. For example

    -
    +   
     \let\ac\cgls
     
    -

    -

    With

    +

    With bib2gls there’s an analogous record counting set of commands. See there’s an analogous record counting set of commands. See glossaries-extra and bib2gls + id="dx1-144020"> manuals for further details.
    -

    +

    -

    -

    +

    Top

    8. Displaying a Glossary

    -

    All defined glossaries may be displayed using: +

    All defined glossaries may be displayed using:

    -

    +

    Option 1:

    -

    (Must be used with

    (Must be used with \makenoidxglossaries in the preamble.) -


    in the preamble.) +


    \printnoidxglossaries

    -

    +

    which internally uses \printnoidxglossary for each glossary.

    -

    +

    Options 3:

    -

    (Must be used with

    (Must be used with \makeglossaries in the preamble.) -


    in the preamble.) +


    \printglossaries

    -

    +

    which internally uses \printglossary for each glossary.

    -

    +

    Options 6:

    -

    (

    (glossaries-extra only) -



    \printunsrtglossaries

    -

    +

    which internally uses \printunsrtglossary for each glossary.

    -

    These commands will display all the glossaries in the order in which they were defined. -

    Note that, in the case of Options 

    These commands will display all the glossaries in the order in which they were defined. +

    Note that, in the case of Options 2 and 3, no glossaries will appear until you have either used the Perl script makeglossaries or Lua script or Lua script makeglossaries-lite or have directly used or have directly used makeindex or or xindy (as described + id="dx1-145009"> (as described in §??sec:makeglossaries 1.5 Generating the Associated Glossary Files). In the case of Option 4, no glossary will appear until you have used bib2gls. -

    While the external files are missing, . +

    While the external files are missing, \printglossary will just do \null for each missing glossary to assist + id="dx1-145011"> for each missing glossary to assist dictionary style documents that just use \glsaddall without inserting any text. This use of \null ensures that + id="dx1-145012"> ensures that all indexing information is written before the final page is shipped out. Once the external files are present \null will no longer be used. This can cause a spurious blank page on the first LaTeX run before the glossary files have been created. Once these files are present, \null will no longer be used and so shouldn’t cause interference for the final document.
    -

    -

    If you use

    +

    If you use glossaries-extra, it will insert a heading and boilerplate text when the external files are missing. See the glossaries-extra manual for further details.
    -

    -

    If the glossary still does not appear after you re-LaTeX your document, check the

    +

    If the glossary still does not appear after you re-LaTeX your document, check the makeindex, , xindy or + id="dx1-145014"> or bib2gls log files, as applicable, to see if there is a problem. With log files, as applicable, to see if there is a problem. With Option 1, you just need two LaTeX runs to make the glossaries appear, but you may need further runs to make the number lists + id="dx1-145016">s up-to-date. -

    An individual glossary can be displayed using: +

    An individual glossary can be displayed using:

    -

    +

    Option 1:

    -

    -


    +


    \printnoidxglossary[options]

    -

    +

    (Must be used with \makenoidxglossaries in the preamble.) + id="dx1-145018"> in the preamble.)

    -

    +

    Options 3:

    -

    -


    +


    \printglossary[options]

    -

    +

    (Must be used with \makeglossaries in the preamble.) + id="dx1-145020"> in the preamble.)

    -

    +

    Options 6:

    -

    -


    +


    \printunsrtglossary[options]

    -

    +

    (May be used with or without bib2gls.)

    -

    where ⟨.)

    +

    where ⟨options⟩ is a ⟨key⟩=⟨value⟩ list of options. (Again, when the associated external file is missing, \null is inserted into the document.) -

    The

    The glossaries-extra package also provides -



    \printunsrtinnerglossary[options]{pre code}{post code}

    -

    +

    which is designed for inner or nested glossaries. It allows many, but not all, of the options listed below. There’s an example available in the gallery: Inner or Nested Glossaries. See the glossaries-extra package for further details.

    -

    -

    The following keys are available in

    +

    The following keys are available in {options}:

    -

    +

    type

    -

    The value of this key specifies which glossary to print. If omitted, the default glossary is assumed. For +

    The value of this key specifies which glossary to print. If omitted, the default glossary is assumed. For example, to print the list of acronyms:

    -
    +     
          \printglossary[type=\acronymtype]
     
    -

    Note that you can’t display an ignored glossary, so don’t try setting

    Note that you can’t display an ignored glossary, so don’t try setting type to the name of a glossary + id="dx1-145025"> to the name of a glossary that was defined using \newignoredglossary, described in , described in §??sec:newglossary 9 Defining New Glossaries. (You can display an ignored glossary with \printunsrtglossary provided by + id="dx1-145027"> provided by glossaries-extra.)

    -

    +

    title

    -

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

    This is the glossary’s title (overriding the title specified when the glossary was defined).

    -

    +

    toctitle

    -

    This is the title to use for the table of contents (if the

    This is the title to use for the table of contents (if the toc package option has been used). It may also + id="dx1-145030"> package option has been used). It may also be used for the page header, depending on the page style. If omitted, the value of title is + id="dx1-145031"> is used.

    -

    +

    style

    -

    This specifies which glossary style to use for this glossary, overriding the effect of the

    This specifies which glossary style to use for this glossary, overriding the effect of the style package option + id="dx1-145033"> package option or \glossarystyle. + id="dx1-145034">.

    -

    +

    numberedsection

    -

    This specifies whether to use a numbered section for this glossary, overriding the effect of the +

    This specifies whether to use a numbered section for this glossary, overriding the effect of the numberedsection package option. This key has the same syntax as the package option. This key has the same syntax as the numberedsection package option, + id="dx1-145037"> package option, described in §??sec:pkgopts-sec 2.2 Sectioning, Headings and TOC Options.

    -

    +

    nonumberlist

    -

    This is a boolean key. If true (

    This is a boolean key. If true (nonumberlist=true) the numberlist is suppressed for this glossary. If false (nonumberlist=false) the numberlist is displayed for this glossary.

    -

    +

    nogroupskip

    -

    This is a boolean key. If true the vertical gap between groups is suppressed for this glossary. +

    This is a boolean key. If true the vertical gap between groups is suppressed for this glossary.

    -

    +

    nopostdot

    -

    This is a boolean key. If true the full stop after the description is suppressed for this glossary. +

    This is a boolean key. If true the full stop after the description is suppressed for this glossary.

    -

    +

    entrycounter

    -

    This is a boolean key. Behaves similar to the package option of the same name. The corresponding package +

    This is a boolean key. Behaves similar to the package option of the same name. The corresponding package option must be used to make \glsrefentry work correctly. + id="dx1-145042"> work correctly.

    -

    +

    subentrycounter

    -

    This is a boolean key. Behaves similar to the package option of the same name. If you want to set both +

    This is a boolean key. Behaves similar to the package option of the same name. If you want to set both entrycounter and and subentrycounter, make sure you specify , make sure you specify entrycounter first. The corresponding + id="dx1-145046"> first. The corresponding package option must be used to make \glsrefentry work correctly. + id="dx1-145047"> work correctly.

    -

    +

    sort

    -

    This key is only available for

    This key is only available for Option 1. Possible values are: word (word order), letter (letter order), standard (word or letter ordering taken from the order package option), package option), use (order of use), def (order of definition) sort=def) just use a simple character code comparison. Fo a locale-sensitive sort, you must use either xindy ( (Option 3) or bib2gls ( (Option 4). Note that bib2gls + id="dx1-145052"> provides many other sort options. -

    If you use the

    If you use the use or def values make sure that you select a glossary style that doesn’t have a visual indicator between groups, as the grouping no longer makes sense. Consider using the nogroupskip option. + id="dx1-145053"> option.
    -

    -

    The +

    +

    The word and letter @@ -21821,14 +21875,14 @@ class="cmss-10">nogroupskipdatatool’s + id="dx1-145054">’s \dtlwordindexcompare + id="dx1-145055"> and \dtlletterindexcompare + id="dx1-145056"> handlers. The case-insensitive @@ -21837,10 +21891,10 @@ class="cmtt-10">\dtlletterindexcomparedatatool’s + id="dx1-145057">’s \dtlicompare + id="dx1-145058"> handler. The case-sensitive @@ -21849,40 +21903,40 @@ class="cmtt-10">\dtlicomparedatatool’s + id="dx1-145059">’s \dtlcompare + id="dx1-145060"> handler. See the datatool + id="dx1-145061"> documentation for further details. -

    If you don’t get an error with

    If you don’t get an error with sort=use and sort=def but you do get an error with one of the other sort options, then you probably need to use the sanitizesort=true package option or make sure none of the + id="dx1-145062"> package option or make sure none of the entries have fragile commands in their sort field. + id="dx1-145063"> field.

    -

    +

    label={label}

    -

    This key is only available with

    This key is only available with glossaries-extra and labels the glossary with \label{}. This is an class="cmss-10">numberedsection=autolabel + id="dx1-145065">

    -

    +

    target={boolean}

    -

    This boolean key is only available with

    This boolean key is only available with glossaries-extra and can be used to switch off the automatic hypertarget for each entry. (This refers to the target used by commands like \gls and \glslink.) -

    This option is useful with

    This option is useful with \printunsrtglossary as it allows the same list (or sub-list) of entries to be + id="dx1-145067"> as it allows the same list (or sub-list) of entries to be displayed multiple times without causing duplicate hypertarget names.

    -

    +

    prefix={prefix}

    -

    This key is only available with

    This key is only available with glossaries-extra and provides another way of avoiding duplicate hypertarget names. In this case it uses a different prefix for those names. This locally redefines \glolinkprefix but + id="dx1-145069"> but note this will also affect the target for any entry referenced within the glossary with commands like \gls, \glslink or \glshypertarget.

    -

    +

    targetnameprefix={prefix}

    -

    This key is only available with

    This key is only available with glossaries-extra. This is similar to the prefix option, but it alters the prefix of the hypertarget anchors without changing \glslinkprefix (so it won’t change the hyperlinks for any + id="dx1-145071"> (so it won’t change the hyperlinks for any entries referenced in the glossary).

    -

    +

    groups={boolean}

    -

    This boolean key is only available with

    This boolean key is only available with glossaries-extra and, if true, will attempt to perform group formation. See the glossaries-extra manual for further details.

    -

    +

    leveloffset={n}

    -

    This key is only available with

    This key is only available with \printunsrtglossary. It can be used to locally adjust the hierarchical + id="dx1-145074">. It can be used to locally adjust the hierarchical level used by the glossary style. See the glossaries-extra manual for further details.

    -

    By default, the glossary is started either by

    By default, the glossary is started either by \chapter* or by or by \section*, depending on whether or not + id="dx1-145076">, depending on whether or not \chapter is defined. This can be overridden by the is defined. This can be overridden by the section package option or the package option or the \setglossarysection + id="dx1-145079"> command. Numbered sectional units can be obtained using the numberedsection package option. Each glossary + id="dx1-145080"> package option. Each glossary sets the page header via the command -



    \glsglossarymark{title}

    -

    +

    If this mechanism is unsuitable for your chosen class file or page style package, you will need to redefine \glsglossarymark. Further information about these options and commands is given in . Further information about these options and commands is given in §??sec:pkgopts-sec +class="cmbx-10">2.2 Sectioning, Headings and TOC Options. -

    Information can be added to the start of the glossary (after the title and before the main body of the +

    Information can be added to the start of the glossary (after the title and before the main body of the glossary) by redefining -



    \glossarypreamble

    -

    +

    For example:

    -
    +   
     \renewcommand{\glossarypreamble}{Numbers in italic
     indicate primary definitions.}
     
    -

    This needs to be done before the glossary is displayed. -

    If you want a different preamble per glossary you can use -


    This needs to be done before the glossary is displayed. +

    If you want a different preamble per glossary you can use +


    \setglossarypreamble[type]{preamble text}

    -

    +

    If ⟨type⟩ is omitted, \glsdefaulttype is used. -

    For example: +

    For example:

    -
    +   
     \setglossarypreamble{Numbers in italic
     indicate primary definitions.}
     
    -

    This will print the given preamble text for the main glossary, but not have any preamble text for any other +

    This will print the given preamble text for the main glossary, but not have any preamble text for any other glossaries. -

    There is an analogous command to

    There is an analogous command to \glossarypreamble called -



    \glossarypostamble

    -

    +

    which is placed at the end of each glossary. -

    +

    Example 20 (Switch to Two Column Mode for Glossary) -

    Suppose you are using the +

    Suppose you are using the superheaderborder + id="dx1-145089"> style8.1, + id="x1-145090f1">, and you want the glossary to be in two columns, but after the glossary you want to switch back to one column mode, you could do:

    -
    +   
     \renewcommand*{\glossarysection}[2][]{%
       \twocolumn[{\chapter*{#2}}]%
       \setlength\glsdescwidth{0.6\linewidth}%
    @@ -22078,99 +22132,99 @@ mode, you could do:
     }
     \renewcommand*{\glossarypostamble}{\onecolumn}
     
    -

    +

    -

    -

    ____________________________

    -

    Within each glossary, each entry name is formatted according to -


    +

    ____________________________

    +

    Within each glossary, each entry name is formatted according to +


    \glsnamefont{name}

    -

    +

    which takes one argument: the entry name. This command is always used regardless of the glossary style. By default, \glsnamefont simply displays its argument in whatever the surrounding font happens to be. This means that in the list-like glossary styles (defined in the glossary-list style file) the name will + id="dx1-145095"> style file) the name will appear in bold, since the name is placed in the optional argument of \item, whereas in the tabular styles (defined in the glossary-long and and glossary-super style files) the name will appear in the normal + id="dx1-145097"> style files) the name will appear in the normal font. The hierarchical glossary styles (defined in the glossary-tree style file) also set the name in + id="dx1-145098"> style file) also set the name in bold. -

    If you want to change the font for the description, or if you only want to change the name +

    If you want to change the font for the description, or if you only want to change the name font for some types of entries but not others, you might want to consider using the glossaries-extra package. -

    +

    Example 21 (Changing the Font Used to Display Entry Names in the Glossary) -

    Suppose you want all the entry names to appear in medium weight small caps in your glossaries, then you + id="x1-145100"> +

    Suppose you want all the entry names to appear in medium weight small caps in your glossaries, then you can do:

    -
    +   
     \renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}}
     
    -

    +

    -

    -

    ____________________________

    -

    +

    The glossaries-extra package provides additional hooks that can be used to make other minor adjustments.
    -

    -

    The letter group titles (which are displayed for styles like

    +

    The letter group titles (which are displayed for styles like indexgroup) can be changed either by redefining the + id="dx1-145101">) can be changed either by redefining the corresponding \group-labelgroupname commands, such as \glssymbolsgroupname, (see , (see §??sec:fixednames +class="cmbx-10">1.4.1 Changing the Fixed Names) or by using the glossaries-extra commands \glsxtrsetgrouptitle and + id="dx1-145103"> and \glsxtrlocalsetgrouptitle. The ⟨. The ⟨group-label⟩ is typically obtained by the indexing application.

    -

    -

    +

    Top

    9. Defining New Glossaries

    -

    A new glossary can be defined using: -


    A new glossary can be defined using: +


    \newglossary[log-ext]{title}[counter]

    -

    +

    where ⟨name⟩ is the label to assign to this glossary. The arguments ⟨in-ext⟩ and ⟨title⟩ is the default title for this new glossary optional argument ⟨counter⟩ specifies which counter to use for the associated number lists (see also + id="dx1-146002">s (see also §??sec:numberlists 12 Number Lists). The first optional argument specifies the extension for the makeindex + id="dx1-146003"> (Option 2) or xindy ( (Option 3) transcript file (this information is only used by makeglossaries which picks + id="dx1-146005"> which picks up the information from the auxiliary file). If you use Option 1, the ⟨log-ext⟩, ⟨in-ext⟩ and ⟨out-ext⟩ arguments are ignored. -

    The glossary label ⟨

    The glossary label ⟨name⟩ must not contain any active characters. It’s generally best to stick with just characters that have category code 11 (typically the non-extended Latin characters for standard LaTeX). + id="dx1-146006">s for standard LaTeX).
    -

    -

    There is also a starred version (new to v4.08): -


    +

    There is also a starred version (new to v4.08): +


    \newglossary*{name}{title}[counter]

    -

    +

    which is equivalent to

    counter]
    or you can also use: -



    \altnewglossary{name}{title}[counter]

    -

    +

    which is equivalent to

    counter]
    -

    It may be that you have some terms that are so common that they don’t need to be listed. In this case, you +

    It may be that you have some terms that are so common that they don’t need to be listed. In this case, you can define a special type of glossary that doesn’t create any associated files. This is referred to as an “ignored glossary” and it’s ignored by commands that iterate over all the glossaries, such as \printglossaries. To + id="dx1-146009">. To define an ignored glossary, use -



    \newignoredglossary{name}

    -

    +

    where ⟨name⟩ is the name of the glossary (as above). This glossary type will automatically be added to the nohypertypes list, since there are no hypertargets for the entries in an ignored glossary. (The sample file + id="dx1-146011"> list, since there are no hypertargets for the entries in an ignored glossary. (The sample file sample-entryfmt.tex defines an ignored glossary.) -

    The

    The glossaries-extra package provides a starred version of this command that allows hyperlinks (since ignored glossaries can be useful with bib2gls). There is also an analogous ). There is also an analogous \provideignoredglossary + id="dx1-146013"> command.
    -

    -

    You can test if a glossary is an ignored one using: -


    +

    You can test if a glossary is an ignored one using: +


    \ifignoredglossary{name}{true}{false}

    -

    +

    This does ⟨true⟩ if ⟨name⟩ was defined as an ignored glossary, otherwise it does ⟨false⟩. -

    Note that the main (default) glossary is automatically created as: +

    Note that the main (default) glossary is automatically created as:

    -
    +   
     \newglossary{main}{gls}{glo}{\glossaryname}
     
    -

    so it can be identified by the label

    so it can be identified by the label main (unless the nomain package option is used). Using the package option is used). Using the acronym package + id="dx1-146016"> package option is equivalent to:

    -
    +   
     \newglossary[alg]{acronym}{acr}{acn}{\acronymname}
     
    -

    so it can be identified by the label

    so it can be identified by the label acronym. If you are not sure whether the acronym option has been used, you + id="dx1-146017"> option has been used, you can identify the list of acronyms by the command \acronymtype which is set to acronym, if the acronym + id="dx1-146019"> option has been used, otherwise it is set to main. Note that if you are using the main glossary as your list of acronyms, you need to declare it as a list of acronyms using the package option acronymlists. -

    The . +

    The symbols package option creates a new glossary with the label package option creates a new glossary with the label symbols using:

    -
    +   
     \newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
     
    -

    The

    The numbers package option creates a new glossary with the label package option creates a new glossary with the label numbers using:

    -
    +   
     \newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
     
    -

    The

    The index package option creates a new glossary with the label package option creates a new glossary with the label index using:

    -
    +   
     \newglossary[ilg]{index}{ind}{idx}{\indexname}
     
    -

    -

    Options 

    +

    Options 2 and 3: all glossaries must be defined before \makeglossaries to ensure that the relevant output + id="dx1-146024"> to ensure that the relevant output files are opened. -

    See

    See §??sec:fixednames 1.4.1 Changing the Fixed Names if you want to redefine \glossaryname, especially if you are using babel or or translator. (Similarly for . (Similarly for \glssymbolsgroupname and \glsnumbersgroupname.) If you want to redefine \indexname, just follow the advice in , just follow the advice in How to change LaTeX’s “fixed names”.

    -

    +

    -

    -

    +

    Top

    10. Adding an Entry to the Glossary Without Generating Text

    -

    It is possible to add a line to the glossary file without generating any text at that point in the document +

    It is possible to add a line to the glossary file without generating any text at that point in the document using: -



    \glsadd[options]{label}

    -

    +

    This is similar to the \glstext-like commands, only it doesn’t produce any text (so therefore, there is no hyper + id="dx1-147002"> key available in ⟨options⟩ but all the other options that can be used with \glstext-like commands can be passed to \glsadd). -

    This command essentially works like

    This command essentially works like \index (provided by the LaTeX kernel) in that it doesn’t produce text but it does add a line with an associated location to the glossary file. In this case, the “encap” (the page encapsulator information) is specified with the format key. (See key. (See §??sec:encap 12.1 Encap Values (Location Formats).) -

    For example, to add a page range to the glossary number list for the entry whose label is given by +

    For example, to add a page range to the glossary number list for the entry whose label is given by set:

    -
    +   
     \glsadd[format=(]{set}
     Lots of text about sets spanning many pages.
     \glsadd[format=)]{set}
     
    -

    -

    To add all entries that have been defined, use: -


    +

    To add all entries that have been defined, use: +


    \glsaddall[options]

    -

    +

    The optional argument is the same as for \glsadd, except there is also a key types which can be + id="dx1-147005"> which can be used to specify which glossaries to use. This should be a comma-separated list. For example, if you only want to add all the entries belonging to the list of acronyms (specified by the glossary type \acronymtype) and a list of notation (specified by the glossary type ) and a list of notation (specified by the glossary type notation) then you can do:

    -
    +   
     \glsaddall[types={\acronymtype,notation}]
     
    -

    -

    If you are using

    +

    If you are using bib2gls with with glossaries-extra, you can’t use \glsaddall. Instead use the selection=all resource option to select all entries in the given bib files.
    -

    -

    Note that files.
    +

    +

    Note that \glsadd and \glsaddall add the current location to the number list. In the case of . In the case of \glsaddall, all entries in the glossary will have the same location in the number list. If you want to use \glsaddall, it’s best to suppress the number list with the nonumberlist package option. (See sections  package option. (See sections 2.3 and 12.)
    -

    -

    There is now a variation of

    +

    There is now a variation of \glsaddall that skips any entries that have been marked as used: -



    \glsaddallunused[list]

    -

    +

    This command uses \glsadd[format=glsignore] which will ignore this location in the number list. (See §??sec:encap 12.1 Encap Values (Location Formats).) The optional argument ⟨list⟩ is a comma-separated list of glossary types. If omitted, it defaults to the list of all defined glossaries. -

    If you want to use

    If you want to use \glsaddallunused, it’s best to place the command at the end of the document to ensure that all the commands you intend to use have already been used. Otherwise you could end up with a spurious comma or dash in the location list.
    -

    -

    With

    +

    With glossaries-extra and bib2gls, , glsignore indicates an “ignored location” which influences selection but isn’t added to the location list. In this case, if you use selection=all then only those entries that have been explicitly indexed in the document will have location lists. The other entries that were selected as a result of selection=all won’t have location lists.
    -

    -

    Base

    +

    Base glossaries package only: + id="dx1-147013"> package only:

    -
    +   
     \documentclass{article}
     \usepackage{glossaries}
     \makeglossaries
    @@ -22587,16 +22641,16 @@ class="cmss-10">glossaries
    -

    Corresponding

    Corresponding glossaries-extra and bib2gls document code: + id="dx1-147014"> document code:

    -
    +   
     \documentclass{article}
     \usepackage[record]{glossaries-extra}
     \GlsXtrLoadResources[src={entries},selection=all]
    @@ -22605,41 +22659,41 @@ class="cmtt-10">bib2gls
    -

    With the file

    With the file entries.bib:

    -
    +   
     @entry{cat,name={cat},description={feline}}
     @entry{dog,name={dog},description={canine}}
     
    -

    +

    -

    +

    Example 22 (Dual Entries) -

    The example file +

    The example file sample-dual.tex makes use of \glsadd to allow for an entry that should appear both in the main glossary and in the list of acronyms. This example sets up the list of acronyms using the acronym + id="dx1-147017"> package option:

    -
    +   
     \usepackage[acronym]{glossaries}
     
    -

    A new command is then defined to make it easier to define dual entries: +

    A new command is then defined to make it easier to define dual entries:

    -
    +   
     \newcommand*{\newdualentry}[5][]{%
       \newglossaryentry{main-#2}{name={#4},%
       text={#3\glsadd{#2}},%
    @@ -22649,11 +22703,11 @@ package option:
       \newacronym{#2}{#3\glsadd{main-#2}}{#4}%
     }
     
    -

    This has the following syntax:

    +

    This has the following syntax:

    \newdualentry[options]{}
    You can then define a new dual entry: -
    +   
     \newdualentry{svm}% label
       {SVM}% abbreviation
       {support vector machine}% long form
       {Statistical pattern recognition technique}% description
     
    -

    Now you can reference the acronym with

    Now you can reference the acronym with \gls{svm} or you can reference the entry in the main glossary with \gls{main-svm}. -

    This is just an example. In general, think twice before you add this kind of duplication. If all information +

    This is just an example. In general, think twice before you add this kind of duplication. If all information (short, long and description) can be provided in a single list, it’s redundant to provide a second list unless any of the short forms start with a different letter to the associated long form, which may make it harder to lookup. -

    Note that with

    Note that with bib2gls, there are special dual entry types that implement this behaviour. That is, if an + id="dx1-147019">, there are special dual entry types that implement this behaviour. That is, if an entry is referenced then its corresponding dual entry will automatically be selected as well. So there is less need for \glsadd with bib2gls. (Although it can still be useful, as shown in . (Although it can still be useful, as shown in Option 6.)
    -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    11. Cross-Referencing Entries

    -

    You must use

    You must use \makeglossaries (Options  (Options 2 or 3) or \makenoidxglossaries ( (Option 1) before defining any terms that cross-reference entries. If any of the terms that you have cross-referenced @@ -22724,27 +22778,27 @@ before all entry definitions. The glossaries-extra package provides better cross-reference handling.
    -

    -

    There are several ways of cross-referencing entries in the glossary: +

    +

    There are several ways of cross-referencing entries in the glossary:

    1. -

      You can use commands such as +

      You can use commands such as \gls in the entries description. For example: + id="dx1-148005"> in the entries description. For example:

      -
      +     
            \newglossaryentry{apple}{name=apple,
            description={firm, round fruit. See also \gls{pear}}}
       
      -

      Note that with this method, if you don’t use the cross-referenced term in the main part of the document, +

      Note that with this method, if you don’t use the cross-referenced term in the main part of the document, you will need two runs of makeglossaries: -

      
      + id="dx1-148006">:
      +     

      
            
      pdflatex filename
      makeglossaries filename
      pdflatex filename @@ -22756,76 +22810,76 @@ class="cmtt-10">makeglossaries
      \gls in the description won’t be detected until the glossary has been created (unless the description is used elsewhere in the document with \glsentrydesc). Take care not to use ). Take care not to use \glsdesc + id="dx1-148008"> (or \Glsdesc) in this case as it will cause a nested link. + id="dx1-148009">) in this case as it will cause a nested link.

    2. -

      As described in +

      As described in §??sec:newglosentry 4 Defining Glossary Entries, you can use the see key when you define + id="dx1-148012"> key when you define the entry. For example:

      -
      +     
            \newglossaryentry{MaclaurinSeries}{name={Maclaurin
            series},
            description={Series expansion},
            see={TaylorsTheorem}}
       
      -

      Note that in this case, the entry with the

      Note that in this case, the entry with the see key will automatically be added to the glossary, but the + id="dx1-148013"> key will automatically be added to the glossary, but the cross-referenced entry won’t. You therefore need to ensure that you use the cross-referenced term with the commands described in §??sec:glslink 5.1 Links to Glossary Entries or §??sec:glsadd 10 Adding an Entry to the Glossary Without Generating Text. -

      The “see” tag is produce using

      The “see” tag is produce using \seename, but can be overridden in specific instances using square brackets + id="dx1-148014">, but can be overridden in specific instances using square brackets at the start of the see value. For example: + id="dx1-148015"> value. For example:

      -
      +     
            \newglossaryentry{MaclaurinSeries}{name={Maclaurin
            series},
            description={Series expansion},
            see=[see also]{TaylorsTheorem}}
       
      -

      Take care if you want to use the optional argument of commands such as

      Take care if you want to use the optional argument of commands such as \newacronym or or \newterm as + id="dx1-148017"> as the value will need to be grouped. For example:

      -
      +     
            \newterm{seal}
            \newterm[see={[see also]seal}]{sea lion}
       
      -

      Similarly if the value contains a list. For example: +

      Similarly if the value contains a list. For example:

      -
      +     
            \glossaryentry{lemon}{
              name={lemon},
              description={Yellow citrus fruit}
      @@ -22842,13 +22896,13 @@ class="cmtt-10">\newterm
      -     

      +

    3. -

      After you have defined the entry, use -


      +

      After you have defined the entry, use +


      \glssee[tag]{label}{xr label list}

      -

      +

      where ⟨xr label list⟩ is a comma-separated list of entry labels to be cross-referenced, ⟨label⟩ is the label of the @@ -22864,58 +22918,58 @@ class="cmti-10">label⟩ is the label of the class="cmti-10">tag⟩ is the “see” tag. (The default value of ⟨tag⟩ is \seename.) For + id="dx1-148021">.) For example:

      -
      +     
            \glssee[see also]{series}{FourierSeries,TaylorsTheorem}
       
      -

      Note that this automatically adds the entry given by ⟨

      Note that this automatically adds the entry given by ⟨label⟩ to the glossary but doesn’t add the cross-referenced entries (specified by ⟨xr label list⟩) to the glossary.

    -

    In both cases 2 and 3 above, the cross-referenced information appears in the

    In both cases 2 and 3 above, the cross-referenced information appears in the number list, whereas in case 1, + id="dx1-148022">, whereas in case 1, the cross-referenced information appears in the description. (See the sample-crossref.tex example file that comes with this package.) This means that in cases 2 and 3, the cross-referencing information won’t appear if you have suppressed the number list. In this case, you will need to activate the number list for + id="dx1-148023">. In this case, you will need to activate the number list for the given entries using nonumberlist=false. Alternatively, if you just use the . Alternatively, if you just use the see key instead + id="dx1-148026"> key instead of \glssee, you can automatically activate the number list using the , you can automatically activate the number list using the seeautonumberlist package + id="dx1-148029"> package option. -

    bib2gls provides much better support for cross-references. See, for example, provides much better support for cross-references. See, for example, Gallery: Cross-References (bib2gls).
    -

    +

    -

    Top

    11.1 Customising Cross-reference Text

    -

    When you use either the

    When you use either the see key or the command key or the command \glssee, the cross-referencing information will be typeset in the glossary according to: -



    \glsseeformat[tag]{label-list}{location}

    -

    +

    The default definition of \glsseeformat is:
    }
    Note that the location is always ignored.11.1 + id="x1-149003f1"> For example, if you want the tag to appear in bold, you can do:11.2 + id="x1-149005f2">

    -
    +   
     \renewcommand*{\glsseeformat}[3][\seename]{\textbf{#1}
      \glsseelist{#2}}
     
    -

    -

    The list of labels is dealt with by

    +

    The list of labels is dealt with by \glsseelist, which iterates through the list and typesets each entry in the label. The entries are separated by -



    \glsseesep

    -

    +

    or (for the last pair) -



    \glsseelastsep

    -

    +

    These default to “,\space” and “\space\andname\space” respectively. The list entry text is displayed using: -



    \glsseeitemformat{label}

    -

    +

    This defaults to \glsentrytext{label}.11.3 + id="x1-149013f3"> For example, to make the cross-referenced list use small caps:

    -
    +   
     \renewcommand{\glsseeitemformat}[1]{%
       \textsc{\glsentrytext{#1}}}
     
    -

    -

    The

    +

    The glossaries-extra package redefines \glsseeitemformat and additionally provides \glsxtrhiername + id="dx1-149016"> which can be used as an alternative to \glsentrytext. See the glossaries-extra manual for further details.
    -

    -

    You can use

    +

    You can use \glsseeformat and and \glsseelist in the main body of the text, but they won’t automatically + id="dx1-149018"> in the main body of the text, but they won’t automatically add the cross-referenced entries to the glossary. If you want them added with that location, you can do:

    -
    +   
     Some information (see also
     \glsseelist{FourierSeries,TaylorsTheorem}%
     \glsadd{FourierSeries}\glsadd{TaylorsTheorem}).
     
    -

    -

    +

    +

    -

    -

    +

    Top

    12. Number Lists

    -

    Each entry in the glossary has an associated

    Each entry in the glossary has an associated number list. By default, these numbers refer to the pages on + id="dx1-150001">. By default, these numbers refer to the pages on which that entry has been indexed (using any of the commands described in §??sec:glslink 5.1 Links to Glossary Entries and §??sec:glsadd 10 Adding an Entry to the Glossary Without Generating Text). The number list can be suppressed using the nonumberlist package option, or an alternative counter can be set as + id="dx1-150002"> package option, or an alternative counter can be set as the default using the counter package option. The number list is also referred to as the location + id="dx1-150003"> package option. The number list is also referred to as the location list. -

    . +

    Number lists are more common with indexes rather than glossaries (although you can use the s are more common with indexes rather than glossaries (although you can use the glossaries package for indexes as well). However, the glossaries package makes use of makeindex or or xindy to hierarchically + id="dx1-150007"> to hierarchically sort and collate the entries since they are readily available with most modern TeX distributions. Since these are both designed as indexing applications they both require that terms either have a valid location or a cross-reference. Even if you use nonumberlist, the locations must still be provided and acceptable to the , the locations must still be provided and acceptable to the indexing application or they will cause an error during the indexing stage, which will interrupt the document build. However, if you’re not interested in the locations, each entry only needs to be indexed once, so consider using indexonlyfirst, which can improve the document build time by only indexing the , which can improve the document build time by only indexing the first use of each term. -

    The

    The \glsaddall command (see command (see §??sec:glsadd 10 Adding an Entry to the Glossary Without Generating Text), which is used to automatically index all entries, iterates over all defined entries and does \glsadd{label⟩ is that entry’s label). This means th class="cmtt-10">\glsaddall automatically adds the same location to every entry’s number list, which looks weird if the number list hasn’t been + id="dx1-150011">, which looks weird if the number list hasn’t been suppressed. -

    With

    With Option 4, the indexing is performed by bib2gls, which was specifically designed for the , which was specifically designed for the glossaries-extra package. So it will allow any location format, and its selection=all option will select all entries without adding an unwanted location to the number list. If . If bib2gls can deduce a numerical value for a location, it will + id="dx1-150015"> can deduce a numerical value for a location, it will attempt to form a range over consecutive locations, otherwise it won’t try to form a range and the location will just form an individual item in the list. Option 1 also allows any location but it doesn’t form ranges.

    -

    Top

    12.1 Encap Values (Location Formats)

    -

    Each location in the

    Each location in the number list is encapsulated with a command formed from the is encapsulated with a command formed from the encap value. By default this + id="dx1-151002"> value. By default this is the \glsnumberformat command, which corresponds to the encap command, which corresponds to the encap glsnumberformat, but this may be overridden using the format key in the optional argument to commands like key in the optional argument to commands like \gls. (See §??sec:glslink 5.1 Links to Glossary Entries.) For example, you may want the location to appear in bold to indicate the principle use of a term or symbol. If the encap starts with an open parenthesis ( this signifies the start of a range and i starts with close parenthesis ) this signifies the end of a range. These must always occur in matching pairs. -

    The

    The glossaries package provides the command: -



    \glsignore{text}

    -

    +

    which ignores its argument. This is the format used by \glsaddallunused to suppress the location, which works fine as long as no other locations are added to the number list. For example, if you use + id="dx1-151005">. For example, if you use \gls{sample} on page 2 then reset the first use flag and then use \glsaddallunused on page 10, the number list for for sample will be 2, \glsignore{10} which will result in “2, ” which has a spurious comma. -

    This isn’t a problem with

    This isn’t a problem with bib2gls because you would need to use because you would need to use selection=all instead of \glsaddallunused, but even if you explicitly had used label}, then bib2gls will recognise will recognise glsignore as a special encap indicating an ignored location, so it will select the entry but not add that location to the number list. It’s a problem for all the other indexing + id="dx1-151009">. It’s a problem for all the other indexing options. -

    Complications can arise if you use different encap values for the same location. For example, suppose on +

    Complications can arise if you use different encap values for the same location. For example, suppose on page 10 you have both the default glsnumberformat and textbf encaps. While it may seem apparent that @@ -23189,58 +23243,58 @@ class="cmtt-10">glsnumberformat in this situation, the indexing application may not know it. This is therefore something you need to be careful about if you use the format key or if you use a command that + id="dx1-151010"> key or if you use a command that implicitly sets it. -

    In the case of

    In the case of xindy, it only accepts one encap (according to the order of precedence given in the , it only accepts one encap (according to the order of precedence given in the xindy + id="dx1-151012"> module) and discards the others for identical locations (for the same entry). This can cause a problem if a discarded location forms the start or end of a range. -

    In the case of

    In the case of makeindex, it accepts different encaps for the same location, but warns about it. This leads to + id="dx1-151013">, it accepts different encaps for the same location, but warns about it. This leads to a number list with the same location repeated in different formats. If you use the with the same location repeated in different formats. If you use the makeglossaries Perl script + id="dx1-151015"> Perl script with Option 2 it will detect makeindex’s warning and attempt to fix the problem, ensuring that the + id="dx1-151016">’s warning and attempt to fix the problem, ensuring that the glsnumberformat encap always has the least precedence unless it includes a range identifier. Other conflicting encaps will have the last one override earlier ones for the same location with range identifiers taking priority. -

    No discard occurs with

    No discard occurs with Option 1 so again you get the same location repeated in different formats. With Option 4, bib2gls will discard according to order of precedence, giving priority to start and end range encaps. + id="dx1-151017"> will discard according to order of precedence, giving priority to start and end range encaps. (See the bib2gls manual for further details.) -

    + id="dx1-151018"> manual for further details.) +

    -

    Top

    12.2 Locations

    -

    Neither

    Neither Option 1 nor Option 4 care about the location syntax as long as it’s valid LaTeX code (and doesn’t contain fragile commands). In both cases, the indexing is performed by writing a line to the aux file. The write + id="dx1-152001"> file. The write operation is deferred to avoid the problems associated with TeX’s asynchronous output routine. (See, for example, Finding if you’re on an odd or an even page for more details on this issue.) Unfortunately @@ -23248,26 +23302,26 @@ Options 2 and 3 are far more problematic and need some complex code to deal with awkward locations. -

    If you know that your locations will always expand to a format acceptable to your chosen

    If you know that your locations will always expand to a format acceptable to your chosen indexing application then use the package option esclocations=false to bypass this operation. This setting only affects + id="dx1-152002"> to bypass this operation. This setting only affects Options 2 and 3 as the problem doesn’t arise with the other indexing options. -

    Both

    Both makeindex and and xindy are fussy about the syntax of the locations. In the case of are fussy about the syntax of the locations. In the case of makeindex, only the + id="dx1-152005">, only the numbering system obtained with \arabic, \roman, char}) are accepted. (makeindex won’t accept an empty + id="dx1-152006"> won’t accept an empty location.) In the case of xindy, you can define your own location classes, but if the location contains a robust + id="dx1-152007">, you can define your own location classes, but if the location contains a robust command then the leading backslash must be escaped. The glossaries package tries to do this, but it’s caught + id="dx1-152008"> package tries to do this, but it’s caught between two conflicting requirements:

    1. -

      The location must be fully expanded before +

      The location must be fully expanded before \ can be converted to \\ (there’s no point converting \thepage to \\thepage);

    2. -

      The page number can’t be expanded until the deferred write operation (so +

      The page number can’t be expanded until the deferred write operation (so \c@page mustn’t expand in the previous step but \the\c@page mustn’t be converted to \\the\\c@page and \number\c@page mustn’t be converted to \\number\\c@page etc).

    -

    There’s a certain amount of trickery needed to deal with this conflict and the code requires the location to be in a +

    There’s a certain amount of trickery needed to deal with this conflict and the code requires the location to be in a form that doesn’t embed the counter’s internal register in commands like \value. For example, suppose you have a robust command called -

    +   
     \renewcommand{\thepage}{\tally{page}}
     
    -

    Now let’s suppose that a term is indexed at the beginning of page 2 at the end of a paragraph that started on +

    Now let’s suppose that a term is indexed at the beginning of page 2 at the end of a paragraph that started on page 1. With xindy, the location , the location \tally{page} needs to be written to the file as \\tallynum{2}. If it’s written as \tallynum{2} then xindy will interpret will interpret \t as the character “t” (which means the location would appear as “tallynum2”). So glossaries tries to expand tries to expand \thepage without expanding \c@page and then escapes all the backslashes, except for the page counter’s internal command. The following definitions of \tally will work:

    • -

      In the following,

      In the following, \arabic works as its internal command \c@arabic is temporarily redefined to check for \c@page:

      -
      +     
            \newcommand{\tally}[1]{\tallynum{\arabic{#1}}}
       
      -

      +

    • -

      The form

      The form \expandafter\the\csname c@counter\the is allowed to be

      -
      +     
            \newcommand{\tally}[1]{%
             \tallynum{\expandafter\the\csname c@#1\endcsname}}
       
      -

      +

    • -

      \expandafter\the\value{counter} now also works (with the same condition as above):

      -
      +     
            \newcommand{\tally}[1]{\tallynum{\expandafter\the\value{#1}}}
       
      -

      +

    • -

      Another variation that will work: +

      Another variation that will work:

      -
      +     
            \newcommand{\tally}[1]{%
              \expandafter\tallynum\expandafter{\the\csname c@#1\endcsname}}
       
      -

      +

    • -

      and also: +

      and also:

      -
      +     
            \newcommand{\tally}[1]{\tallynum{\the\csname c@#1\endcsname}}
       
      -

    -

    The following

    +

    The following don’t work:

    • -

      This definition leads to the premature expansion of

      This definition leads to the premature expansion of \c@page to “1” when, in this case, it should be “2”:

      -
      +     
            \newcommand{\tally}[1]{\tallynum{\the\value{#1}}}
       
      -

      +

    • -

      This definition leads to

      This definition leads to \\c@page in the glossary file:

      -
      +     
            \newcommand{\tally}[1]{\tallynum{\csname c@#1\endcsname}}
       
      -

    -

    If you have a numbering system where

    +

    If you have a numbering system where \cs name{page} expands to \c@page (for example, if \tally{page} expands to \tallynum\c@page) then you need to use: -



    \glsaddprotectedpagefmt{internal cs name}

    -

    +

    Note that the backslash must be omitted from ⟨internal cs name⟩ and the corresponding command must be able to process a count register as the (sole) argument. -

    For example, suppose you have a style

    For example, suppose you have a style samplenum that is implemented as follows:

    -
    +   
      \newcommand*{\samplenum}[1]{%
        \expandafter\@samplenum\csname c@#1\endcsname}
      \newcommand*{\@samplenum}[1]{\two@digits{#1}}
     
    -

    (That is, it displays the value of the counter as a two-digit number.) Then to ensure the location is correct for +

    (That is, it displays the value of the counter as a two-digit number.) Then to ensure the location is correct for entries in page-spanning paragraphs, you need to do:

    -
    +   
     \glsaddprotectedpagefmt{@samplenum}
     
    -

    (If you are using a different counter for the location, such as

    (If you are using a different counter for the location, such as section or equation, you don’t need to worry about this provided the inner command is expandable.) -

    If the inner macro (as given by

    If the inner macro (as given by \internal cs name⟩) contains non-expandable commands then you may need to redefine +

      \newcommand*{\samplenum}[1]{%
       \expandafter\@samplenum\csname c@#1\endcsname}
      \newcommand*{\@samplenum}[1]{\textsc{\romannumeral#1}}
     
    -

    Again, the inner macro needs to be identified using: +

    Again, the inner macro needs to be identified using:

    -
    +   
     \glsaddprotectedpagefmt{@samplenum}
     
    -

    However, since

    However, since \textsc isn’t fully expandable, the location is written to the file as \textsc indexing application (particularly for makeindex). To compensate for this, the ). To compensate for this, the \glsinternal cs namepage command @@ -23536,58 +23590,58 @@ example:

    -
    +   
     \renewcommand*{\gls@samplenumpage}{\romannumeral\c@page}
     
    -

    While this modification means that the

    While this modification means that the number list in the glossary won’t exactly match the format of the page + id="dx1-152018"> in the glossary won’t exactly match the format of the page numbers (displaying lower case Roman numbers instead of small cap Roman numerals) this method will at least work correctly for both makeindex and and xindy. If you are using . If you are using xindy, the following + id="dx1-152021">, the following definition:

    -
    +   
      \renewcommand*{\gls@samplenumpage}{%
        \glsbackslash\string\textsc{\romannumeral\c@page}}
     
    -

    combined with +

    combined with

    -
    +   
     \GlsAddXdyLocation{romansc}{:sep "\string\textsc\glsopenbrace"
      "roman-numbers-lowercase" :sep "\glsclosebrace"}
     
    -

    will now have lowercase Roman numerals in the location list (see

    will now have lowercase Roman numerals in the location list (see §??sec:xindyloc 14.2 Locations and Number lists for further details on that command). Take care of the backslashes. The location (which ends up in the :locref attribute) needs attribute) needs \\ but the location class (identified with \GlsAddXdyLocation) just has a single backslash. Note that this example will cause problems if your locations should be hyperlinks. -

    Another possibility that may work with both

    Another possibility that may work with both makeindex and and xindy is to redefine is to redefine \glsinternal cs namepage @@ -23596,55 +23650,55 @@ class="cmtt-10">\gls@samplenumpage in this example) to just expand to the class="cmtt-10">\number\c@page) and redefine \glsnumberformat to change the displayed format: + id="dx1-152025"> to change the displayed format:

    -
    +   
     \renewcommand*{\gls@samplenumpage}{\number\c@page}
     \renewcommand*{\glsnumberformat}[1]{\textsc{\romannumeral#1}}
     
    -

    -

    If you redefine

    +

    If you redefine \glsinternal cs namepage, you must make sure that \c@page is expanded when it’s written to the file. (So don’t, for example, hide \c@page inside a robust command.)
    -

    -

    The mechanism that allows this to work temporarily redefines

    +

    The mechanism that allows this to work temporarily redefines \the and and \number while it processes the + id="dx1-152027"> while it processes the location. If this causes a problem you can disallow it using -



    \glswrallowprimitivemodsfalse

    -

    +

    but you will need to find some other way to ensure the location expands correctly. -

    +

    -

    Top

    12.3 Range Formations

    -

    Both

    Both makeindex and and xindy (Options  (Options 2 and 3) concatenate a sequence of 3 or more consecutive pages into a range. With xindy ( (Option 3) you can vary the minimum sequence length using \GlsSetXdyMinRangeLength{n} where ⟨n⟩ is either an integer or the keyword none which indicates that there should be no range formation (see §??sec:xindyloc 14.2 Locations and Number lists for further details). -

    Note that

    Note that \GlsSetXdyMinRangeLength must be used before \makeglossaries and has no effect if and has no effect if \noist + id="dx1-153006"> is used.
    -

    -

    With both

    +

    With both makeindex and and xindy (Options  (Options 2 and 3), you can replace the separator and the closing number in the range using: -



    \glsSetSuffixF{suffix}

    -

    -


    +


    \glsSetSuffixFF{suffix}

    -

    +

    where the former command specifies the suffix to use for a 2 page list and the latter specifies the suffix to use for longer lists. For example:

    -
    +   
     \glsSetSuffixF{f.}
     \glsSetSuffixFF{ff.}
     
    -

    Note that if you use

    Note that if you use xindy ( (Option 3), you will also need to set the minimum range length to 1 if you want to change these suffixes:

    -
    +   
     \GlsSetXdyMinRangeLength{1}
     
    -

    Note that if you use the

    Note that if you use the hyperref package, you will need to use package, you will need to use \nohyperpage in the suffix to ensure that the + id="dx1-153013"> in the suffix to ensure that the hyperlinks work correctly. For example:

    -
    +   
     \glsSetSuffixF{\nohyperpage{f.}}
     \glsSetSuffixFF{\nohyperpage{ff.}}
     
    -

    -

    Note that

    +

    Note that \glsSetSuffixF and \glsSetSuffixFF must be used before \makeglossaries and have no + id="dx1-153014"> and have no effect if \noist is used.
    -

    -

    It’s also possible to concatenate a sequence of consecutive locations into a range or have suffixes with + id="dx1-153015"> is used.

    +

    +

    It’s also possible to concatenate a sequence of consecutive locations into a range or have suffixes with Option 4, but with bib2gls these implicit ranges can’t be merged with explicit ranges (created with the these implicit ranges can’t be merged with explicit ranges (created with the ( and ) encaps). See the bib2gls manual for further details. -

    manual for further details. +

    Option 1 doesn’t form ranges. However, with this option you can iterate over an entry’s number list + id="dx1-153018"> using: -



    \glsnumberlistloop{label}{handler cs}{xr handler cs}

    -

    +

    where ⟨label⟩ is the entry’s label and ⟨handler cs⟩ is a handler control sequence of the form: -



    handler cs{prefixformat}{location}

    -

    +

    where ⟨prefix⟩ is the hyperref prefix, ⟨ prefix, ⟨counter⟩ is the name of the counter used for the location, ⟨format⟩ is the format used to display the location (e.g. textbf) and ⟨location⟩ is the location. The third argument is the control sequence to use for any cross-references in the list. This handler should have the syntax: -



    xr handler cs[tag]{xr list}

    -

    +

    where ⟨tag⟩ is the cross-referenced text (e.g. “see”) and ⟨xr list⟩ is a comma-separated list of labels. (This actually has a third argument but it’s always empty when used with Option 1.) -

    For example, if on page 12 I have used +

    For example, if on page 12 I have used

    -
    +   
     \gls[format=textbf]{apple}
     
    -

    and on page 18 I have used +

    and on page 18 I have used

    -
    +   
     \gls[format=emph]{apple}
     
    -

    then +

    then

    -
    +   
     \glsnumberlistloop{apple}{\myhandler}
     
    -

    will be equivalent to: +

    will be equivalent to:

    -
    +   
     \myhandler{}{page}{textbf}{12}%
     \myhandler{}{page}{emph}{18}%
     
    -

    There is a predefined handler that’s used to display the

    There is a predefined handler that’s used to display the number list in the glossary: -


    in the glossary: +


    \glsnoidxdisplayloc{prefix}{format}{location}

    -

    +

    The predefined handler used for the cross-references in the glossary is: -



    \glsseeformat[tag]{xr list}{location}

    -

    +

    which is described in §??sec:customxr 11.1 Customising Cross-reference Text. -

    \glsnumberlistloop is not available for Options 2 and 3.
    -

    -

    +

    +

    -

    Top

    12.4 Style Hook

    -

    As from version 4.24, there’s a hook that’s used near the end of

    As from version 4.24, there’s a hook that’s used near the end of \writeist before the file is closed. You can set + id="dx1-154001"> before the file is closed. You can set the code to be performed then using: -



    \GlsSetWriteIstHook{code}

    -

    +

    If you want the ⟨code⟩ to write any information to the file, you need to use -



    \write\glswrite{style information}

    -

    +

    Make sure you use the correct format within ⟨style information⟩. For example, if you are using makeindex: + id="dx1-154004">:

    -
    +   
     \GlsSetWriteIstHook{%
      \write\glswrite{page_precedence "arnAR"}%
      \write\glswrite{line_max 80}%
     }
     
    -

    This changes the page type precedence and the maximum line length used by

    This changes the page type precedence and the maximum line length used by makeindex. -

    Remember that if you switch to . +

    Remember that if you switch to xindy, this will no longer be valid code. + id="dx1-154007">, this will no longer be valid code.

    -

    -

    +

    Top

    13. Glossary Styles

    -

    Glossaries vary from lists that simply contain a symbol with a terse description to lists of terms or phrases +

    Glossaries vary from lists that simply contain a symbol with a terse description to lists of terms or phrases with lengthy descriptions. Some glossaries may have terms with associated symbols. Some may have hierarchical entries. There is therefore no single style that fits every type of glossary. The glossaries package comes with a number of pre-defined glossary styles, described in §??sec:predefinedstyles +class="cmbx-10">13.1 Predefined Styles. You can choose one of these that best suits your type of glossary or, if none of them suit your document, you can defined your own style (see §??sec:newglossarystyle 13.2 Defining your own glossary style). There are some examples of glossary styles available at the glossaries gallery. -

    The glossary style can be set using the

    The glossary style can be set using the style key in the optional argument to key in the optional argument to \printnoidxglossary + id="dx1-155002"> (Option 1) or \printglossary (Options  (Options 2 and 3) or using the command: -



    \setglossarystyle{style-name}

    -

    +

    (before the glossary is displayed). -

    Some of the predefined glossary styles may also be set using the

    Some of the predefined glossary styles may also be set using the style package option, it depends if the + id="dx1-155005"> package option, it depends if the package in which they are defined is automatically loaded by the glossaries package. -

    You can use the lorum ipsum dummy entries provided in the accompanying

    You can use the lorum ipsum dummy entries provided in the accompanying example-glossaries-*.tex files (described in §??sec:lipsum 1.3 Dummy Entries for Testing) to test the different styles. -

    The

    The glossaries-extra-stylemods package provided with package provided with glossaries-extra patches the predefined styles. There also more styles available with glossaries-extra.
    -

    +

    -

    Top

    13.1 Predefined Styles

    -

    The predefined styles can accommodate numbered level 0 (main) and level 1 entries. See the package options +

    The predefined styles can accommodate numbered level 0 (main) and level 1 entries. See the package options entrycounter, , counterwithin and and subentrycounter described in described in §??sec:pkgopts-printglos 2.3 Glossary Appearance Options. There is a summary of available styles in table ??tab:styles. You can view samples of all the predefined +class="cmbx-10">13.1. You can view samples of all the predefined styles at https://www.dickimaw-books.com/gallery/glossaries-styles/. Note that glossaries-extra provides additional styles in the supplementary packages glossary-bookindex, , glossary-topic and and glossary-longextra. + id="dx1-156006">. See the glossaries-extra manual for further details. -

    Note that the group styles (such as

    Note that the group styles (such as listgroup) will have unexpected results if used with the ) will have unexpected results if used with the sort=def or + id="dx1-156008"> or sort=use options. If you don’t sort your entries alphabetically, it’s best to set the options. If you don’t sort your entries alphabetically, it’s best to set the nogroupskip package option to + id="dx1-156010"> package option to prevent odd vertical gaps appearing.
    -

    -

    The group title is obtained using

    +

    The group title is obtained using \glsgetgrouptitle{label}, which is described in §??sec:newglossarystyle +class="cmbx-10">13.2 Defining your own glossary style.

    -


    @@ -24035,21 +24089,21 @@ class="content">Glossary Styles. An asterisk in the style name indicates anythin match any previously listed style (e.g. long3col* matches long3col, , long3colheader, , long3colborder and + id="dx1-156014"> and long3colheaderborder). A maximum level of 0 indicates a flat glossary (sub-entries are displayed in the + id="dx1-156015">). A maximum level of 0 indicates a flat glossary (sub-entries are displayed in the same way as main entries). Where the maximum level is given as — there is no limit, but note that makeindex ( (Option 2) imposes a limit of 2 sub-levels. If the homograph column is checked, then the -name is not displayed for sub-entries. If the symbol column is checked, then the symbol will be displayed.
    +name is not displayed for sub-entries. If the symbol column is checked, then the symbol will be displayed.

    -

    The tabular-like styles that allow multi-line descriptions and page lists use the length -


    The tabular-like styles that allow multi-line descriptions and page lists use the length +


    \glsdescwidth

    -

    +

    to set the width of the description column and the length -



    \glspagelistwidth

    -

    +

    to set the width of the page list column.13.1 + id="x1-156019f1"> These will need to be changed using \setlength if the glossary is too wide. Note that the long4col and and super4col + id="dx1-156024"> styles (and their header and border variations) don’t use these lengths as they are designed for single line entries. Instead you should use the analogous altlong4col and and altsuper4col styles. If you want to explicitly create + id="dx1-156026"> styles. If you want to explicitly create a line-break within a multi-line description in a tabular-like style it’s better to use \newline instead of + id="dx1-156027"> instead of \\. -

    Remember that a cell within a tabular-like environment can’t be broken across a page, so even if a +

    Remember that a cell within a tabular-like environment can’t be broken across a page, so even if a tabular-like style, such as long, allows multilined descriptions, you’ll probably encounter page-breaking problems + id="dx1-156028">, allows multilined descriptions, you’ll probably encounter page-breaking problems if you have entries with long descriptions. You may want to consider using the alttree style instead. + id="dx1-156029"> style instead.
    -

    -

    Note that if you use the

    +

    Note that if you use the style key in the optional argument to key in the optional argument to \printnoidxglossary ( (Option 1) or \printglossary (Options  (Options 2 and 3), it will override any previous style settings for the given glossary, so if, for example, you do

    -
    +   
     \renewcommand*{\glsgroupskip}{}
     \printglossary[style=long]
     
    -

    then the new definition of

    then the new definition of \glsgroupskip will not have an affect for this glossary, as will not have an affect for this glossary, as \glsgroupskip is redefined by style=long. Likewise, \setglossarystyle will also override any previous style definitions, so, + id="dx1-156034"> will also override any previous style definitions, so, again

    -
    +   
     \renewcommand*{\glsgroupskip}{}
     \setglossarystyle{long}
     
    -

    will reset

    will reset \glsgroupskip back to its default definition for the named glossary style (long in this case). If you + id="dx1-156035"> in this case). If you want to modify the styles, either use \newglossarystyle (described in the next section) or make the + id="dx1-156036"> (described in the next section) or make the modifications after \setglossarystyle, e.g.: + id="dx1-156037">, e.g.:

    -
    +   
     \setglossarystyle{long}
     \renewcommand*{\glsgroupskip}{}
     
    -

    As from version 3.03, you can now use the package option

    As from version 3.03, you can now use the package option nogroupskip to suppress the gap between groups for + id="dx1-156038"> to suppress the gap between groups for the default styles instead of redefining \glsgroupskip. -

    All the styles except for the three- and four-column styles and the

    All the styles except for the three- and four-column styles and the listdotted style use the command -


    style use the command +


    \glspostdescription

    -

    +

    after the description. This simply displays a full stop by default. To eliminate this full stop (or replace it with something else, say, a comma) you will need to redefine \glspostdescription before the glossary is displayed. Alternatively, you can suppress it for a given entry by placing \nopostdesc in the entry’s description. Note that + id="dx1-156041"> in the entry’s description. Note that \longnewglossaryentry puts puts \nopostdesc at the end of the description. The glossaries-extra package provides a starred version that doesn’t. -

    As from version 3.03 you can now use the package option

    As from version 3.03 you can now use the package option nopostdot to suppress this full stop. This is the + id="dx1-156043"> to suppress this full stop. This is the better option if you want to use the glossaries-extra package. The glossaries-extra-stylemods package provides + id="dx1-156044"> package provides some adjustments some of to the predefined styles listed here, allowing for greater flexibility. See the glossaries-extra documentation for further details.

    -

    Top

    13.1.1 List Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-list. Since they all use the . Since they all use the description + id="dx1-157002"> environment, they are governed by the same parameters as that environment. These styles all ignore the entry’s symbol. Note that these styles will automatically be available unless you use the nolist or or nostyles package + id="dx1-157005"> package options. -

    Note that, except for the

    Note that, except for the listdotted style, these list styles are incompatible with style, these list styles are incompatible with classicthesis. They + id="dx1-157007">. They may also be incompatible with other classes or packages that modify the description environment. + id="dx1-157008"> environment.
    -

    +

    +

    As from v4.48, there is an initialisation hook that provides a patch if the gettitlestring package is loaded, +since this is used by hyperref. +


    \glslistinit

    +

    +This patch should ensure that the combination of hyperref and entercounter should correctly expand the entry +name to the aux file. The name is expanded using: +


    \glslistexpandedname{label}

    +

    +This uses \glsunexpandedfieldvalue. If you need the name to fully expand, you can redefine this. For +example: + + +

    +
    +\newcommand{\glslistexpandedname}[1]{\glsentryname{#1}}
    +
    +

    -

    +

    list

    -

    The

    The list style uses the style uses the description environment. The entry name is placed in the optional argument + id="dx1-157019"> environment. The entry name is placed in the optional argument of the \item command (so it will usually appear in bold by default). The description follows, + id="dx1-157021"> command (so it will usually appear in bold by default). The description follows, and then the associated number list for that entry. The symbol is ignored. If the entry has child + id="dx1-157022"> for that entry. The symbol is ignored. If the entry has child entries, the description and number list follows (but not the name) for each child entry. Groups are separated using \indexspace. -

    The closest matching non-list style is the . +

    The closest matching non-list style is the index style. - - + id="dx1-157024"> style.

    -

    +

    listgroup

    -

    The

    The listgroup style is like style is like list but the glossary groups have headings obtained using + id="dx1-157026"> but the glossary groups have headings obtained using \glsgetgrouptitle{label}, which is described in §??sec:newglossarystyle 13.2 Defining your own glossary style.

    -

    +

    listhypergroup

    -

    The

    The listhypergroup style is like style is like listgroup but has a navigation line at the start of the glossary with links to + id="dx1-157028"> but has a navigation line at the start of the glossary with links to each group that is present in the glossary. This requires an additional run through LaTeX to ensure the group information is up to date. In the navigation line, each group is separated by -



    \glshypernavsep

    -

    +

    which defaults to a vertical bar with a space on either side. For example, to simply have a space separating each group, do:

    -
    +     
          \renewcommand*{\glshypernavsep}{\space}
     
    -

    -

    Note that the hyper-navigation line is now (as from version 1.14) set inside the optional +

    +

    Note that the hyper-navigation line is now (as from version 1.14) set inside the optional argument to \item instead of after it to prevent a spurious space at the start. This can cause a + id="dx1-157030"> instead of after it to prevent a spurious space at the start. This can cause a problem if the navigation line is too long. As from v4.22, if you need to adjust this, you can redefine -



    \glslistnavigationitem{navigation line}

    -

    +

    The default definition is \item[navigation line] but may be redefined independently of setting the style

    -
    +     
          \renewcommand*{\glslistnavigationitem}[1]{\item \textbf{#1}}
     
    -

    -

    You may prefer to use the tree-like styles, such as

    +

    You may prefer to use the tree-like styles, such as treehypergroup instead. + id="dx1-157032"> instead.

    -

    +

    altlist

    -

    The

    The altlist style is like style is like list but the description starts on the line following the name. (As with the but the description starts on the line following the name. (As with the list style, + id="dx1-157035"> style, the symbol is ignored.) Each child entry starts a new line, but as with the list style, the name associated + id="dx1-157036"> style, the name associated with each child entry is ignored. -

    The closest matching non-list style is the

    The closest matching non-list style is the index style with the following adjustment: + id="dx1-157037"> style with the following adjustment:

    -
    +     
          \renewcommand{\glstreepredesc}{%
           \glstreeitem\parindent\hangindent}
     
    -

    +

    -

    +

    altlistgroup

    -

    The

    The altlistgroup style is like style is like altlist but the glossary groups have headings. + id="dx1-157039"> but the glossary groups have headings.

    -

    +

    altlisthypergroup

    -

    The

    The altlisthypergroup style is like style is like altlistgroup but has a set of links to the glossary groups. The navigation + id="dx1-157041"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described above. + id="dx1-157042">, described above.

    -

    +

    listdotted

    -

    This style uses the

    This style uses the description environment. environment.13.2 + id="x1-157045f2"> Each entry starts with \item[], followed by the name followed by a dotted line, followed by the description. Note that this style ignores both the number list and the symbol. The + id="dx1-157046"> and the symbol. The length -



    \glslistdottedwidth

    -

    +

    governs where the description should start. This is a flat style, so child entries are formatted in the same way as the parent entries. -

    A non-list alternative is to use the

    A non-list alternative is to use the index style with + id="dx1-157048"> style with

    -
    +     
          \renewcommand{\glstreepredesc}{\dotfill}
          \renewcommand{\glstreechildpredesc}{\dotfill}
     
    -

    Note that this doesn’t use

    Note that this doesn’t use \glslistdottedwidth and causes the description to be flush-right and will display the symbol, if provided. (It also doesn’t suppress the number list, but that can be achieved with + id="dx1-157049">, but that can be achieved with the nonumberlist option.) + id="dx1-157050"> option.)

    -

    +

    sublistdotted

    -

    This is a variation on the

    This is a variation on the listdotted style designed for hierarchical glossaries. The main entries have just + id="dx1-157051"> style designed for hierarchical glossaries. The main entries have just the name displayed. The sub entries are displayed in the same manner as listdotted. Unlike the . Unlike the listdotted + id="dx1-157053"> style, this style is incompatible with classicthesis.

    -

    + id="dx1-157054">.

    +

    -

    Top

    13.1.2 Longtable Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-long. Since they all use the . Since they all use the longtable + id="dx1-158002"> environment, they are governed by the same parameters as that environment. Note that these styles will automatically be available unless you use the nolong or or nostyles package options. These styles fully justify the + id="dx1-158005"> package options. These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the analogous styles described in §??sec:longraggedstyles 13.1.3 Longtable Styles (Ragged Right). If you want to incorporate rules from the booktabs package, try the styles described in §??sec:longbooktabsstyles Longtable Styles + id="dx1-158006"> package, try the styles described in §13.1.4 Longtable Styles (booktabs).

    -

    +

    long

    -

    The

    The long style uses the style uses the longtable environment (defined by the environment (defined by the longtable package). It has two columns: + id="dx1-158010"> package). It has two columns: the first column contains the entry’s name and the second column contains the description followed by the number list. The entry’s symbol is ignored. Sub groups are separated with a blank row. The + id="dx1-158011">. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. Child entries have a similar format to the parent + id="dx1-158012">. Child entries have a similar format to the parent entries except that their name is suppressed.

    -

    +

    longborder

    -

    The

    The longborder style is like style is like long but has horizontal and vertical lines around it. + id="dx1-158014"> but has horizontal and vertical lines around it.

    -

    +

    longheader

    -

    The

    The longheader style is like style is like long but has a header row. + id="dx1-158016"> but has a header row.

    -

    +

    longheaderborder

    -

    The

    The longheaderborder style is like style is like longheader but has horizontal and vertical lines around it. + id="dx1-158018"> but has horizontal and vertical lines around it.

    -

    +

    long3col

    -

    The

    The long3col style is like style is like long but has three columns. The first column contains the entry’s name, + id="dx1-158020"> but has three columns. The first column contains the entry’s name, the second column contains the description and the third column contains the number list. The + id="dx1-158021">. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column, the width of the second column is governed by the length \glsdescwidth, and the width + id="dx1-158022">, and the width of the third column is governed by the length \glspagelistwidth. + id="dx1-158023">.

    -

    +

    long3colborder

    -

    The

    The long3colborder style is like the style is like the long3col style but has horizontal and vertical lines around it. + id="dx1-158025"> style but has horizontal and vertical lines around it.

    -

    +

    long3colheader

    -

    The

    The long3colheader style is like style is like long3col but has a header row. + id="dx1-158027"> but has a header row.

    -

    +

    long3colheaderborder

    -

    The

    The long3colheaderborder style is like style is like long3colheader but has horizontal and vertical lines around + id="dx1-158029"> but has horizontal and vertical lines around it.

    -

    +

    long4col

    -

    The

    The long4col style is like style is like long3col but has an additional column in which the entry’s associated + id="dx1-158031"> but has an additional column in which the entry’s associated symbol appears. This style is used for brief single line descriptions. The column widths are governed by the widest entry in the given column. Use altlong4col for multi-line descriptions. + id="dx1-158032"> for multi-line descriptions.

    -

    +

    long4colborder

    -

    The

    The long4colborder style is like the style is like the long4col style but has horizontal and vertical lines around it. + id="dx1-158034"> style but has horizontal and vertical lines around it.

    -

    +

    long4colheader

    -

    The

    The long4colheader style is like style is like long4col but has a header row. + id="dx1-158036"> but has a header row.

    -

    +

    long4colheaderborder

    -

    The

    The long4colheaderborder style is like style is like long4colheader but has horizontal and vertical lines around + id="dx1-158038"> but has horizontal and vertical lines around it.

    -

    +

    altlong4col

    -

    The

    The altlong4col style is like style is like long4col but allows multi-line descriptions and page lists. The width + id="dx1-158040"> but allows multi-line descriptions and page lists. The width of the description column is governed by the length \glsdescwidth and the width of the page + id="dx1-158041"> and the width of the page list column is governed by the length \glspagelistwidth. The widths of the name and symbol + id="dx1-158042">. The widths of the name and symbol columns are governed by the widest entry in the given column.

    -

    +

    altlong4colborder

    -

    The

    The altlong4colborder style is like the style is like the long4colborder but allows multi-line descriptions and page + id="dx1-158044"> but allows multi-line descriptions and page lists.

    -

    +

    altlong4colheader

    -

    The

    The altlong4colheader style is like style is like long4colheader but allows multi-line descriptions and page lists. + id="dx1-158046"> but allows multi-line descriptions and page lists.

    -

    +

    altlong4colheaderborder

    -

    The

    The altlong4colheaderborder style is like style is like long4colheaderborder but allows multi-line descriptions and + id="dx1-158048"> but allows multi-line descriptions and page lists.

    -

    +

    -

    Top

    13.1.3 Longtable Styles (Ragged Right)

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-longragged. These styles are analogous + id="dx1-159001">. These styles are analogous to those defined in glossary-long but the multiline columns are left justified instead of fully justified. Since these + id="dx1-159002"> but the multiline columns are left justified instead of fully justified. Since these styles all use the longtable environment, they are governed by the same parameters as that environment. The + id="dx1-159003"> environment, they are governed by the same parameters as that environment. The glossary-longragged package additionally requires the package additionally requires the array package. Note that these styles will only be available + id="dx1-159006"> package. Note that these styles will only be available if you explicitly load glossary-longragged: + id="dx1-159007">:

    -
    +   
     \usepackage{glossaries}
     \usepackage{glossary-longragged}
     
    -

    Note that you can’t set these styles using the

    Note that you can’t set these styles using the style package option since the styles aren’t defined until after the + id="dx1-159008"> package option since the styles aren’t defined until after the glossaries package has been loaded. If you want to incorporate rules from the booktabs package, try the styles + id="dx1-159009"> package, try the styles described in §??sec:longbooktabsstyles Longtable Styles (§13.1.4 Longtable Styles (booktabs).

    -

    +

    longragged

    -

    The

    The longragged style has two columns: the first column contains the entry’s name and the second + id="dx1-159010"> style has two columns: the first column contains the entry’s name and the second column contains the (left-justified) description followed by the number list. The entry’s symbol is + id="dx1-159011">. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. Child entries have a similar format to the parent entries except that their name + id="dx1-159012">. Child entries have a similar format to the parent entries except that their name is suppressed.

    -

    +

    longraggedborder

    -

    The

    The longraggedborder style is like style is like longragged but has horizontal and vertical lines around it. + id="dx1-159014"> but has horizontal and vertical lines around it.

    -

    +

    longraggedheader

    -

    The

    The longraggedheader style is like style is like longragged but has a header row. + id="dx1-159016"> but has a header row.

    -

    +

    longraggedheaderborder

    -

    The

    The longraggedheaderborder style is like style is like longraggedheader but has horizontal and vertical lines + id="dx1-159018"> but has horizontal and vertical lines around it.

    -

    +

    longragged3col

    -

    The

    The longragged3col style is like style is like longragged but has three columns. The first column contains the + id="dx1-159020"> but has three columns. The first column contains the entry’s name, the second column contains the (left justified) description and the third column contains the (left justified) number list. The entry’s symbol is ignored. The width of the first + id="dx1-159021">. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column, the width of the second column is governed by the length \glsdescwidth, and the width of the third column is governed by the length + id="dx1-159022">, and the width of the third column is governed by the length \glspagelistwidth. + id="dx1-159023">.

    -

    +

    longragged3colborder

    -

    The

    The longragged3colborder style is like the style is like the longragged3col style but has horizontal and vertical lines + id="dx1-159025"> style but has horizontal and vertical lines around it.

    -

    +

    longragged3colheader

    -

    The

    The longragged3colheader style is like style is like longragged3col but has a header row. + id="dx1-159027"> but has a header row.

    -

    +

    longragged3colheaderborder

    -

    The

    The longragged3colheaderborder style is like style is like longragged3colheader but has horizontal and vertical + id="dx1-159029"> but has horizontal and vertical lines around it.

    -

    +

    altlongragged4col

    -

    The

    The altlongragged4col style is like style is like longragged3col but has an additional column in which the + id="dx1-159031"> but has an additional column in which the entry’s associated symbol appears. The width of the description column is governed by the length \glsdescwidth and the width of the page list column is governed by the length + id="dx1-159032"> and the width of the page list column is governed by the length \glspagelistwidth. The widths of the name and symbol columns are governed by the widest + id="dx1-159033">. The widths of the name and symbol columns are governed by the widest entry in the given column.

    -

    +

    altlongragged4colborder

    -

    The

    The altlongragged4colborder style is like the style is like the altlongragged4col but has horizontal and vertical lines + id="dx1-159035"> but has horizontal and vertical lines around it.

    -

    +

    altlongragged4colheader

    -

    The

    The altlongragged4colheader style is like style is like altlongragged4col but has a header row. + id="dx1-159037"> but has a header row.

    -

    +

    altlongragged4colheaderborder

    -

    The

    The altlongragged4colheaderborder style is like style is like altlongragged4colheader but has horizontal and + id="dx1-159039"> but has horizontal and vertical lines around it.

    -

    +

    -

    Top

    13.1.4 Longtable Styles (Longtable Styles (booktabs)

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-longbooktabs. -

    Since these styles all use the . +

    Since these styles all use the longtable environment, they are governed by the same parameters as that + id="dx1-160002"> environment, they are governed by the same parameters as that environment. The glossary-longbooktabs package automatically loads the package automatically loads the glossary-long ( (§??sec:longstyles +class="cmbx-10">13.1.2 Longtable Styles) and glossary-longragged ( (§??sec:longraggedstyles 13.1.3 Longtable Styles (Ragged Right)) packages. Note that these styles will only be available if you explicitly load glossary-longbooktabs: + id="dx1-160007">:

    -
    +   
     \usepackage{glossaries}
     \usepackage{glossary-longbooktabs}
     
    -

    Note that you can’t set these styles using the

    Note that you can’t set these styles using the style package option since the styles aren’t defined until after the + id="dx1-160008"> package option since the styles aren’t defined until after the glossaries package has been loaded. -

    These styles are similar to the “header” styles in the

    These styles are similar to the “header” styles in the glossary-long and and glossary-ragged packages, but they add + id="dx1-160010"> packages, but they add the rules provided by the booktabs package, package, \toprule, , \midrule and and \bottomrule. Additionally these styles + id="dx1-160014">. Additionally these styles patch the longtable environment to check for instances of the group skip occurring at a page break. If you don’t + id="dx1-160015"> environment to check for instances of the group skip occurring at a page break. If you don’t want this patch to affect any other use of longtable in your document, you can scope the effect by only setting + id="dx1-160017"> in your document, you can scope the effect by only setting the style through the style key in the optional argument of key in the optional argument of \printglossary. (The nogroupskip package option + id="dx1-160020"> package option is checked by these styles.) -

    Alternatively, you can restore the original

    Alternatively, you can restore the original longtable behaviour with: -


    behaviour with: +


    \glsrestoreLToutput

    -

    +

    For more information about the patch, see the documented code (glossaries-code.pdf).

    -

    +

    long-booktabs

    -

    This style is similar to the

    This style is similar to the longheader style but adds rules above and below the header ( style but adds rules above and below the header (\toprule and \midrule) and inserts a rule at the bottom of the table (\bottomrule).

    -

    +

    long3col-booktabs

    -

    This style is similar to the

    This style is similar to the long3colheader style but adds rules as per style but adds rules as per long-booktabs. + id="dx1-160028">.

    -

    +

    long4col-booktabs

    -

    This style is similar to the

    This style is similar to the long4colheader style but adds rules as above. + id="dx1-160030"> style but adds rules as above.

    -

    +

    altlong4col-booktabs

    -

    This style is similar to the

    This style is similar to the altlong4colheader style but adds rules as above. + id="dx1-160032"> style but adds rules as above.

    -

    +

    longragged-booktabs

    -

    This style is similar to the

    This style is similar to the longraggedheader style but adds rules as above. + id="dx1-160034"> style but adds rules as above.

    -

    +

    longragged3col-booktabs

    -

    This style is similar to the

    This style is similar to the longragged3colheader style but adds rules as above. + id="dx1-160036"> style but adds rules as above.

    -

    +

    altlongragged4col-booktabs

    -

    This style is similar to the

    This style is similar to the altlongragged4colheader style but adds rules as above. + id="dx1-160038"> style but adds rules as above.

    -

    +

    -

    Top

    13.1.5 Supertabular Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-super. Since they all use the + id="dx1-161001">. Since they all use the supertabular environment, they are governed by the same parameters as that environment. Note that these styles + id="dx1-161002"> environment, they are governed by the same parameters as that environment. Note that these styles will automatically be available unless you use the nosuper or or nostyles package options. In general, + id="dx1-161005"> package options. In general, the longtable environment is better, but there are some circumstances where it is better to use + id="dx1-161006"> environment is better, but there are some circumstances where it is better to use supertabular..13.3 + id="x1-161010f3"> These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the analogous styles described in §??sec:superraggedstyles 13.1.6 Supertabular Styles (Ragged Right).

    -

    +

    super

    -

    The

    The super style uses the style uses the supertabular environment (defined by the environment (defined by the supertabular package). It has two + id="dx1-161015"> package). It has two columns: the first column contains the entry’s name and the second column contains the description followed by the number list. The entry’s symbol is ignored. Sub groups are separated with a blank + id="dx1-161016">. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. Child entries have a similar format + id="dx1-161017">. Child entries have a similar format to the parent entries except that their name is suppressed.

    -

    +

    superborder

    -

    The

    The superborder style is like style is like super but has horizontal and vertical lines around it. + id="dx1-161019"> but has horizontal and vertical lines around it.

    -

    +

    superheader

    -

    The

    The superheader style is like style is like super but has a header row. + id="dx1-161021"> but has a header row.

    -

    +

    superheaderborder

    -

    The

    The superheaderborder style is like style is like superheader but has horizontal and vertical lines around it. + id="dx1-161023"> but has horizontal and vertical lines around it.

    -

    +

    super3col

    -

    The

    The super3col style is like style is like super but has three columns. The first column contains the entry’s name, + id="dx1-161025"> but has three columns. The first column contains the entry’s name, the second column contains the description and the third column contains the number list. The + id="dx1-161026">. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. The width of + id="dx1-161027">. The width of the third column is governed by the length \glspagelistwidth. + id="dx1-161028">.

    -

    +

    super3colborder

    -

    The

    The super3colborder style is like the style is like the super3col style but has horizontal and vertical lines around it. + id="dx1-161030"> style but has horizontal and vertical lines around it.

    -

    +

    super3colheader

    -

    The

    The super3colheader style is like style is like super3col but has a header row. + id="dx1-161032"> but has a header row.

    -

    +

    super3colheaderborder

    -

    The

    The super3colheaderborder style is like the style is like the super3colheader style but has horizontal and vertical lines + id="dx1-161034"> style but has horizontal and vertical lines around it.

    -

    +

    super4col

    -

    The

    The super4col style is like style is like super3col but has an additional column in which the entry’s associated + id="dx1-161036"> but has an additional column in which the entry’s associated symbol appears. This style is designed for entries with brief single line descriptions. The column widths are governed by the widest entry in the given column. Use altsuper4col for multi-line + id="dx1-161037"> for multi-line descriptions.

    -

    +

    super4colborder

    -

    The

    The super4colborder style is like the style is like the super4col style but has horizontal and vertical lines around it. + id="dx1-161039"> style but has horizontal and vertical lines around it.

    -

    +

    super4colheader

    -

    The

    The super4colheader style is like style is like super4col but has a header row. + id="dx1-161041"> but has a header row.

    -

    +

    super4colheaderborder

    -

    The

    The super4colheaderborder style is like the style is like the super4colheader style but has horizontal and vertical lines + id="dx1-161043"> style but has horizontal and vertical lines around it.

    -

    +

    altsuper4col

    -

    The

    The altsuper4col style is like style is like super4col but allows multi-line descriptions and page lists. The width + id="dx1-161045"> but allows multi-line descriptions and page lists. The width of the description column is governed by the length \glsdescwidth and the width of the page list + id="dx1-161046"> and the width of the page list column is governed by the length \glspagelistwidth. The width of the name and symbol columns + id="dx1-161047">. The width of the name and symbol columns is governed by the widest entry in the given column.

    -

    +

    altsuper4colborder

    -

    The

    The altsuper4colborder style is like the style is like the super4colborder style but allows multi-line descriptions and + id="dx1-161049"> style but allows multi-line descriptions and page lists.

    -

    +

    altsuper4colheader

    -

    The

    The altsuper4colheader style is like style is like super4colheader but allows multi-line descriptions and page lists. + id="dx1-161051"> but allows multi-line descriptions and page lists.

    -

    +

    altsuper4colheaderborder

    -

    The

    The altsuper4colheaderborder style is like style is like super4colheaderborder but allows multi-line descriptions + id="dx1-161053"> but allows multi-line descriptions and page lists.

    -

    +

    -

    Top

    13.1.6 Supertabular Styles (Ragged Right)

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-superragged. These styles are + id="dx1-162001">. These styles are analogous to those defined in glossary-super but the multiline columns are left justified instead of fully justified. + id="dx1-162002"> but the multiline columns are left justified instead of fully justified. Since these styles all use the supertabular environment, they are governed by the same parameters as that + id="dx1-162003"> environment, they are governed by the same parameters as that environment. The glossary-superragged package additionally requires the package additionally requires the array package. Note that these styles + id="dx1-162006"> package. Note that these styles will only be available if you explicitly load glossary-superragged: + id="dx1-162007">:

    -
    +   
     \usepackage{glossaries}
     \usepackage{glossary-superragged}
     
    -

    Note that you can’t set these styles using the

    Note that you can’t set these styles using the style package option since the styles aren’t defined until after the + id="dx1-162008"> package option since the styles aren’t defined until after the glossaries package has been loaded.

    -

    +

    superragged

    -

    The

    The superragged style uses the style uses the supertabular environment (defined by the environment (defined by the supertabular package). It + id="dx1-162012"> package). It has two columns: the first column contains the entry’s name and the second column contains the (left justified) description followed by the number list. The entry’s symbol is ignored. Sub groups + id="dx1-162013">. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. Child + id="dx1-162014">. Child entries have a similar format to the parent entries except that their name is suppressed.

    -

    +

    superraggedborder

    -

    The

    The superraggedborder style is like style is like superragged but has horizontal and vertical lines around it. + id="dx1-162016"> but has horizontal and vertical lines around it.

    -

    +

    superraggedheader

    -

    The

    The superraggedheader style is like style is like superragged but has a header row. + id="dx1-162018"> but has a header row.

    -

    +

    superraggedheaderborder

    -

    The

    The superraggedheaderborder style is like style is like superraggedheader but has horizontal and vertical lines + id="dx1-162020"> but has horizontal and vertical lines around it.

    -

    +

    superragged3col

    -

    The

    The superragged3col style is like style is like superragged but has three columns. The first column contains + id="dx1-162022"> but has three columns. The first column contains the entry’s name, the second column contains the (left justified) description and the third column contains the (left justified) number list. The entry’s symbol is ignored. The width of the first + id="dx1-162023">. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. The width of the third column is governed by the length + id="dx1-162024">. The width of the third column is governed by the length \glspagelistwidth. + id="dx1-162025">.

    -

    +

    superragged3colborder

    -

    The

    The superragged3colborder style is like the style is like the superragged3col style but has horizontal and vertical + id="dx1-162027"> style but has horizontal and vertical lines around it.

    -

    +

    superragged3colheader

    -

    The

    The superragged3colheader style is like style is like superragged3col but has a header row. + id="dx1-162029"> but has a header row.

    -

    +

    superragged3colheaderborder

    -

    The

    The superragged3colheaderborder style is like the above but has horizontal and vertical lines around + id="dx1-162030"> style is like the above but has horizontal and vertical lines around it.

    -

    +

    altsuperragged4col

    -

    The

    The altsuperragged4col style is like style is like superragged3col but has an additional column in which the entry’s + id="dx1-162032"> but has an additional column in which the entry’s associated symbol appears. The column widths for the name and symbol column are governed by the widest entry in the given column.

    -

    +

    altsuperragged4colborder

    -

    The

    The altsuperragged4colborder style is like the style is like the altsuperragged4col style but has horizontal and vertical + id="dx1-162034"> style but has horizontal and vertical lines around it.

    -

    +

    altsuperragged4colheader

    -

    The

    The altsuperragged4colheader style is like style is like altsuperragged4col but has a header row. + id="dx1-162036"> but has a header row.

    -

    +

    altsuperragged4colheaderborder

    -

    The

    The altsuperragged4colheaderborder style is like the above but has horizontal and vertical lines + id="dx1-162037"> style is like the above but has horizontal and vertical lines around it.

    -

    +

    -

    Top

    13.1.7 Tree-Like Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-tree. These styles are designed for + id="dx1-163001">. These styles are designed for hierarchical glossaries but can also be used with glossaries that don’t have sub-entries. These styles will display the entry’s symbol if it exists. Note that these styles will automatically be available unless you use the notree or + id="dx1-163002"> or nostyles package options. -

    These styles all format the entry name using: -


    package options. +

    These styles all format the entry name using: +


    \glstreenamefmt{name}

    -

    +

    This defaults to \textbf{name}, but note that ⟨name⟩ includes \glsnamefont so the bold setting in + id="dx1-163005"> so the bold setting in \glstreenamefont may be counteracted by another font change in \glsnamefont (or in \acronymfont). The tree-like styles that also display the header use -



    \glstreegroupheaderfmt{text}

    -

    +

    to format the heading. This defaults to \glstreenamefmt{text}. The tree-like styles that display navigation links to the groups (such as indexhypergroup), format the navigation line using -


    ), format the navigation line using +


    \glstreenavigationfmt{text}

    -

    +

    which defaults to \glstreenamefmt{text}. -

    Note that this is different from

    Note that this is different from \glslistnavigationitem, provided with the styles such as listhypergroup, as + id="dx1-163009">, as that also includes \item. -

    With the exception of the

    With the exception of the alttree style (and those derived from it), the space before the description for + id="dx1-163010"> style (and those derived from it), the space before the description for top-level entries is produced with -



    \glstreepredesc

    -

    +

    This defaults to \space. -

    With the exception of the

    With the exception of the treenoname and and alttree styles (and those derived from them), the space before the + id="dx1-163013"> styles (and those derived from them), the space before the description for child entries is produced with -



    \glstreechildpredesc

    -

    +

    This defaults to \space. -

    Most of these styles are not designed for multi-paragraph descriptions. (The

    Most of these styles are not designed for multi-paragraph descriptions. (The tree style isn’t too bad for + id="dx1-163015"> style isn’t too bad for multi-paragraph top-level entry descriptions, or you can use the index style with the adjustment shown below.) + id="dx1-163016"> style with the adjustment shown below.)
    -

    +

    -

    +

    index

    -

    The

    The index style is similar to the way indices are usually formatted in that it has a hierarchical + id="dx1-163017"> style is similar to the way indices are usually formatted in that it has a hierarchical structure up to three levels (the main level plus two sub-levels). The name is typeset in bold, and if the symbol is present it is set in parentheses after the name and before the description. Sub-entries are indented and also include the name, the symbol in brackets (if present) and the description. @@ -25683,246 +25770,246 @@ class="cmss-10">index\indexspace. -

    Each main level item is started with -


    . +

    Each main level item is started with +


    \glstreeitem

    -

    +

    The level 1 entries are started with -



    \glstreesubitem

    -

    -

    The level 2 entries are started with -


    +

    The level 2 entries are started with +


    \glstreesubsubitem

    -

    -

    Note that the

    +

    Note that the index style automatically sets + id="dx1-163022"> style automatically sets

    -
    +     
          \let\item\glstreeitem
          \let\subitem\glstreesubitem
          \let\subsubitem\glstreesubsubitem
     
    -

    at the start of the glossary for backward compatibility. -

    The

    at the start of the glossary for backward compatibility. +

    The index style isn’t suitable for multi-paragraph descriptions, but this limitation can be overcome by + id="dx1-163023"> style isn’t suitable for multi-paragraph descriptions, but this limitation can be overcome by redefining the above commands. For example:

    -
    +     
          \renewcommand{\glstreeitem}{%
           \parindent0pt\par\hangindent40pt
           \everypar{\parindent50pt\hangindent40pt}}
     
    -

    +

    -

    +

    indexgroup

    -

    The

    The indexgroup style is similar to the style is similar to the index style except that each group has a heading obtained using + id="dx1-163025"> style except that each group has a heading obtained using \glsgetgrouptitle{label}, which is described in §??sec:newglossarystyle 13.2 Defining your own glossary style.

    -

    +

    indexhypergroup

    -

    The

    The indexhypergroup style is like style is like indexgroup but has a set of links to the glossary groups. The + id="dx1-163027"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described above, but is formatted using + id="dx1-163028">, described above, but is formatted using \glstreenavigationfmt.

    -

    +

    tree

    -

    The

    The tree style is similar to the style is similar to the index style except that it can have arbitrary levels. (Note that style except that it can have arbitrary levels. (Note that makeindex is + id="dx1-163031"> is limited to three levels, so you will need to use xindy if you want more than three levels.) Each sub-level is + id="dx1-163032"> if you want more than three levels.) Each sub-level is indented by \glstreeindent. Note that the name, symbol (if present) and description are placed in the same paragraph block. If you want the name to be apart from the description, use the alttree style instead. + id="dx1-163034"> style instead. (See below.)

    -

    +

    treegroup

    -

    The

    The treegroup style is similar to the style is similar to the tree style except that each group has a heading. + id="dx1-163036"> style except that each group has a heading.

    -

    +

    treehypergroup

    -

    The

    The treehypergroup style is like style is like treegroup but has a set of links to the glossary groups. The + id="dx1-163038"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described above, but is formatted using + id="dx1-163039">, described above, but is formatted using \glstreenavigationfmt.

    -

    +

    treenoname

    -

    The

    The treenoname style is like the style is like the tree style except that the name for each sub-entry is ignored. + id="dx1-163041"> style except that the name for each sub-entry is ignored.

    -

    +

    treenonamegroup

    -

    The

    The treenonamegroup style is similar to the style is similar to the treenoname style except that each group has a + id="dx1-163043"> style except that each group has a heading.

    -

    +

    treenonamehypergroup

    -

    The

    The treenonamehypergroup style is like style is like treenonamegroup but has a set of links to the glossary groups. The + id="dx1-163045"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described above, but is formatted using + id="dx1-163046">, described above, but is formatted using \glstreenavigationfmt.

    -

    +

    alttree

    -

    The

    The alttree style is similar to the style is similar to the tree style except that the indentation for each level is determined by the + id="dx1-163048"> style except that the indentation for each level is determined by the width of the text specified by -



    \glssetwidest[level]{text}

    -

    +

    The optional argument ⟨level⟩ indicates the level, where 0 indicates the top-most level, 1 indicates the first level sub-entries, etc. If \glssetwidest hasn’t been used for a given sub-level, the level 0 widest text is used instead. If ⟨level⟩ is omitted, 0 is assumed. -

    As from v4.22, the

    As from v4.22, the glossary-tree package also provides -


    package also provides +


    \glsfindwidesttoplevelname[glossary list]

    -

    +

    This iterates over all parentless entries in the given glossary lists and determines the widest entry. If the optional argument is omitted, all glossaries are assumed (as per \forallglossaries). -

    For example, to have the same name width for all glossaries: +

    For example, to have the same name width for all glossaries:

    -
    +     
          \glsfindwidesttoplevelname
          \setglossarystyle{alttree}
          \printglossaries
     
    -

    Alternatively, to compute the widest entry for each glossary before it’s displayed: +

    Alternatively, to compute the widest entry for each glossary before it’s displayed:

    -
    +     
          \renewcommand{\glossarypreamble}{%
            \glsfindwidesttoplevelname[\currentglossary]}
          \setglossarystyle{alttree}
          \printglossaries
     
    -

    -

    These commands only affects the

    +

    These commands only affects the alttree styles, including those listed below and the ones in the + id="dx1-163052"> styles, including those listed below and the ones in the glossary-mcols package. If you forget to set the widest entry name, the description will overwrite the name. + id="dx1-163053"> package. If you forget to set the widest entry name, the description will overwrite the name.
    -

    -

    For each level, the name is placed to the left of the paragraph block containing the symbol +

    +

    For each level, the name is placed to the left of the paragraph block containing the symbol (optional) and the description. If the symbol is present, it is placed in parentheses before the description. -

    The name is placed inside a left-aligned

    The name is placed inside a left-aligned \makebox. As from v4.19, this can now be adjusted by redefining -



    \glstreenamebox{width}{text}

    -

    +

    where ⟨width⟩ is the width of the box and ⟨text⟩ is the contents of the box. For example, to make the name @@ -25930,72 +26017,72 @@ class="cmti-10">text⟩ is the contents of the box. For example, to

    -
    +     
          \renewcommand*{\glstreenamebox}[2]{%
            \makebox[#1][r]{#2}%
          }
     
    -

    +

    -

    +

    alttreegroup

    -

    The

    The alttreegroup is like the is like the alttree style except that each group has a heading. + id="dx1-163056"> style except that each group has a heading.

    -

    +

    alttreehypergroup

    -

    The

    The alttreehypergroup style is like style is like alttreegroup but has a set of links to the glossary groups. The navigation + id="dx1-163058"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described above. + id="dx1-163059">, described above.

    -

    +

    -

    Top

    13.1.8 Multicols Style

    -

    The

    The glossary-mcols package provides tree-like styles that are in the package provides tree-like styles that are in the multicols environment (defined by the environment (defined by the multicol + id="dx1-164004"> package). The style names are as their analogous tree styles (as defined in §??sec:treestyles 13.1.7 Tree-Like Styles) but are prefixed with “mcol”. For example, the mcolindex style is essentially the style is essentially the index style but put in a style but put in a multicols + id="dx1-164007"> environment. For the complete list, see table ??tab:mcols. The 13.2. The glossary-tree package is automatically loaded by + id="dx1-164009"> package is automatically loaded by glossary-mcols (even if the (even if the notree package option is used when loading package option is used when loading glossaries). The formatting commands \glstreenamefmt, \glstreegroupheaderfmt and \glstreenavigationfmt are all used by the corresponding glossary-mcols styles. -

    Note that styles. +

    Note that glossary-mcols is not loaded by is not loaded by glossaries. If you want to use any of the multicol styles in that package you need to load it explicitly with \usepackage and set the required glossary style using \setglossarystyle.
    -

    -

    The default number of columns is 2, but can be changed by redefining -


    .
    +

    +

    The default number of columns is 2, but can be changed by redefining +


    \glsmcols

    -

    +

    to the required number. For example, for a three column glossary:

    -
    +   
     \usepackage{glossary-mcols}
     \renewcommand*{\glsmcols}{3}
     \setglossarystyle{mcolindex}
     
    -

    +

    -


    Table 13.2: Multicolumn Styles
    +class="content">Multicolumn Styles
    @@ -26057,200 +26144,200 @@ class="cmbx-10">Analogous Tree Style style="vertical-align:baseline;" id="TBL-10-2-"> + id="dx1-164021"> + id="dx1-164024"> + id="dx1-164028"> + id="dx1-164031"> + id="dx1-164033"> + id="dx1-164035"> + id="dx1-164038"> + id="dx1-164040"> + id="dx1-164042">
    glossary-mcols Style Analogous Tree Style mcolindex index
    mcolindexgroup indexgroup
    mcolindexhypergroup or or mcolindexspannav indexhypergroup
    mcoltree tree
    mcoltreegroup treegroup
    mcoltreehypergroup or or mcoltreespannav treehypergroup
    mcoltreenoname treenoname
    mcoltreenonamegroup treenonamegroup
    mcoltreenonamehypergroup or or mcoltreenonamespannav treenonamehypergroup
    mcolalttree alttree
    mcolalttreegroup alttreegroup
    mcolalttreehypergroup or or mcolalttreespannav alttreehypergroup
    + id="dx1-164045">

    -

    The styles with a navigation line, such as

    The styles with a navigation line, such as mcoltreehypergroup, now have a variant (as from + id="dx1-164046">, now have a variant (as from v4.22) with “hypergroup” replaced with “spannav” in the style name. The original “hypergroup” styles place the navigation line at the start of the first column. The newer “spannav” styles put the navigation line in the optional argument of the multicols environment so that it spans across all the + id="dx1-164047"> environment so that it spans across all the columns.

    -

    Top

    13.1.9 In-Line Style

    -

    This section covers the

    This section covers the glossary-inline package that supplies the package that supplies the inline style. This is a style that is designed for + id="dx1-165002"> style. This is a style that is designed for in-line use (as opposed to block styles, such as lists or tables). This style doesn’t display the number list. -

    You will most likely need to redefine . +

    You will most likely need to redefine \glossarysection with this style. For example, suppose you are + id="dx1-165004"> with this style. For example, suppose you are required to have your glossaries and list of acronyms in a footnote, you can do:

    -
    +   
      \usepackage{glossary-inline}
      \renewcommand*{\glossarysection}[2][]{\textbf{#1}: }
      \setglossarystyle{inline}
     
    -

    -

    Note that you need to include

    +

    Note that you need to include glossary-inline with with \usepackage as it’s not automatically included by the glossaries package and then set the style using \setglossarystyle.
    -

    -

    Where you need to include your glossaries as a footnote you can do: + id="dx1-165006">.

    +

    +

    Where you need to include your glossaries as a footnote you can do:

    -
    +   
     \footnote{\printglossaries}
     
    -

    -

    The

    +

    The inline style is governed by the following: -


    style is governed by the following: +


    \glsinlineseparator

    -

    + id="dx1-165009">


    +

    This defaults to “; ” and is used between main (i.e. level 0) entries. -



    \glsinlinesubseparator

    -

    + id="dx1-165011">


    +

    This defaults to “, ” and is used between sub-entries. -



    \glsinlineparentchildseparator

    -

    + id="dx1-165013">


    +

    This defaults to “: ” and is used between a parent main entry and its first sub-entry. -



    \glspostinline

    -

    + id="dx1-165015">


    +

    This defaults to “; ” and is used at the end of the glossary. -



    \glsinlinenameformat{label}{name}

    -

    +

    This is used to format the entry name and defaults to \glstarget{label} and ⟨label⟩ is the entry’s label. For example, if you want the name to appear in small caps: + id="dx1-165017">:

    -
    +   
     \renewcommand*{\glsinlinenameformat}[2]{\glstarget{#1}{\textsc{#2}}}
     
    -

    Sub-entry names are formatted according to -


    Sub-entry names are formatted according to +


    \glsinlinesubnameformat{label}{name}

    -

    +

    This defaults to \glstarget{label}{} so the sub-entry name is ignored. -

    If the description has been suppressed (according to

    If the description has been suppressed (according to \ifglsdescsuppressed) then -



    \glsinlineemptydescformat{symbol}{number list}

    -

    +

    (which defaults to nothing) is used, otherwise the description is formatted according to -



    \glsinlinedescformat{description}{symbol}{number list}

    -

    +

    This defaults to just \spacedescription⟩ so the symbol and location list are ignored. If the description is missing (according to \ifglshasdesc), then \glsinlineemptydescformat is used instead. -

    For example, if you want a colon between the name and the description: +

    For example, if you want a colon between the name and the description:

    -
    +   
     \renewcommand*{\glsinlinedescformat}[3]{: #1}
     
    -

    -

    The sub-entry description is formatted according to: -


    +

    The sub-entry description is formatted according to: +


    \glsinlinesubdescformat{description}{symbol}{number list}

    -

    +

    This defaults to just ⟨description⟩. -

    +

    -

    Top

    13.2 Defining your own glossary style

    -

    Commands like

    Commands like \printglossary are designed to produce content in the PDF. If your intention is to design a style that doesn’t print any content (for example, to simply capture information) then you are likely to experience unwanted side-effects. If you just want to capture indexing information (such as locations) then a much better approach is to use bib2gls, which automatically stores this information in dedicated fields when + id="dx1-166001">, which automatically stores this information in dedicated fields when the entry is defined.
    -

    -

    If the predefined styles don’t fit your requirements, you can define your own style using: -


    +

    If the predefined styles don’t fit your requirements, you can define your own style using: +


    \newglossarystyle{name}{definitions}

    -

    +

    where ⟨name⟩ is the name of the new glossary style (to be used in \setglossarystyle). The second argument ⟨definitions⟩ needs to redefine all of the following: -



    theglossary

    -

    + id="dx1-166005">


    +

    This environment defines how the main body of the glossary should be typeset. -

    Note that this does not include the section heading, the glossary preamble (defined by

    Note that this does not include the section heading, the glossary preamble (defined by \glossarypreamble) + id="dx1-166007">) or the glossary postamble (defined by \glossarypostamble). For example, the ). For example, the list style uses the style uses the description + id="dx1-166010"> environment, so the theglossary environment is simply redefined to begin and end the environment is simply redefined to begin and end the description + id="dx1-166014"> environment. -



    \glossaryheader

    -

    +

    This macro indicates what to do at the start of the main body of the glossary. Note that this is not the same as \glossarypreamble, which should not be affected by changes in the glossary style. The , which should not be affected by changes in the glossary style. The list glossary style + id="dx1-166018"> glossary style redefines \glossaryheader to do nothing, whereas the to do nothing, whereas the longheader glossary style redefines glossary style redefines \glossaryheader to do a header row. -



    \glsgroupheading{label}

    -

    +

    This macro indicates what to do at the start of each logical block within the main body of the glossary. If you use makeindex the glossary is sub-divided into a maximum of twenty-eight logical blocks that are determined by + id="dx1-166022"> the glossary is sub-divided into a maximum of twenty-eight logical blocks that are determined by the first character of the sort key (or key (or name key if the key if the sort key is omitted). The sub-divisions are in the + id="dx1-166025"> key is omitted). The sub-divisions are in the following order: symbols, numbers, A, …, Z. If you use xindy, the sub-divisions depend on the language + id="dx1-166026">, the sub-divisions depend on the language settings. -

    Note that the argument to

    Note that the argument to \glsgroupheading is a label not the group title. The group title can be obtained via -



    \glsgetgrouptitle{label}

    -

    +

    This obtains the title as follows: if ⟨label⟩ consists of a single non-active character or ⟨label⟩ is equal to label⟩. (The “symbols” group has the label glssymbols, so the command \glssymbolsgroupname is used, + id="dx1-166028"> is used, and the “numbers” group has the label glsnumbers, so the command \glsnumbersgrouptitle is + id="dx1-166029"> is used.) If you are using xindy, ⟨, ⟨label⟩ may be an active character (for example ø), in which case the title will be set to just ⟨label⟩. You can redefine \glsgetgrouptitle if this is unsuitable for your document. -

    A navigation hypertarget can be created using -


    A navigation hypertarget can be created using +


    \glsnavhypertarget{label}{text}

    -

    +

    This typically requires \glossaryheader to be redefined to use -



    \glsnavigation

    -

    +

    which displays the navigation line. -

    For further details about

    For further details about \glsnavhypertarget, see the documented code (glossaries-code.pdf). -

    Most of the predefined glossary styles redefine

    Most of the predefined glossary styles redefine \glsgroupheading to simply ignore its argument. The listhypergroup style redefines style redefines \glsgroupheading as follows:

    -
    +   
     \renewcommand*{\glsgroupheading}[1]{%
     \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}
     
    -

    See also

    See also \glsgroupskip below. -

    Note that command definitions within

    Note that command definitions within \newglossarystyle must use must use ##1 instead of #1 etc. -



    \glsgroupskip

    -

    +

    This macro determines what to do after one logical group but before the header for the next logical group. The list glossary style simply redefines glossary style simply redefines \glsgroupskip to be \indexspace, whereas the tabular-like styles redefine + id="dx1-166037">, whereas the tabular-like styles redefine \glsgroupskip to produce a blank row. -

    As from version 3.03, the package option

    As from version 3.03, the package option nogroupskip can be used to suppress this default gap for the + id="dx1-166038"> can be used to suppress this default gap for the predefined styles. -



    \glossentry{label}{number list}

    -

    +

    This macro indicates what to do for each top-level (level 0) glossary entry. The entry label is given by ⟨label⟩ and the associated number list is given by ⟨ is given by ⟨number list⟩. You can redefine \glossentry to use commands like + id="dx1-166041"> to use commands like \glossentryname{label}, \glossentrydesc{label} and \glossentrysymbol{label} to display the name, description and symbol fields, or to access other fields, use commands like \glsentryuseri{label}. (See §??sec:glsnolink 5.2 Using Glossary Terms Without Links for further details.) You can also use the following commands: -



    \glsentryitem{label}

    -

    +

    This macro will increment and display the associated counter for the main (level 0) entries if the entrycounter or + id="dx1-166047"> or counterwithin package options have been used. This macro is typically called by package options have been used. This macro is typically called by \glossentry before \glstarget. The format of the counter is controlled by the macro -



    \glsentrycounterlabel

    -

    -

    Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the relevant line in +

    +

    Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the relevant line in the glossary. Your new glossary style must therefore redefine \glossentry to set the appropriate target. This is done using -



    \glstarget{label}{text}

    -

    +

    where ⟨label⟩ is the entry’s label. Note that you don’t need to worry about whether the hyperref package has been + id="dx1-166051"> package has been loaded, as \glstarget won’t create a target if \hypertarget hasn’t been defined. -

    For example, the

    For example, the list style defines style defines \glossentry as follows:

    -
    +   
       \renewcommand*{\glossentry}[2]{%
         \item[\glsentryitem{##1}%
               \glstarget{##1}{\glossentryname{##1}}]
            \glossentrydesc{##1}\glspostdescription\space ##2}
     
    -

    -

    Note also that ⟨

    +

    Note also that ⟨number list⟩ will always be of the form -



    \glossaryentrynumbers{\relax
    \setentrycounter[Hprefix]{{number(s)}}

    -

    +

    where ⟨number(s)⟩ may contain \delimN (to delimit individual numbers) and/or (to delimit individual numbers) and/or \delimR (to indicate a range of + id="dx1-166056"> (to indicate a range of numbers). There may be multiple occurrences of \setentrycounter[Hprefix]{{number(s)}, but note that the entire number list is enclosed within the argument of \glossaryentrynumbers. + id="dx1-166058">. The user can redefine this to change the way the entire number list is formatted, regardless of the glossary style. However the most common use of \glossaryentrynumbers is to provide a means of suppressing the number list + id="dx1-166059"> is to provide a means of suppressing the number list altogether. (In fact, the nonumberlist option redefines option redefines \glossaryentrynumbers to ignore its argument.) + id="dx1-166061"> to ignore its argument.) Therefore, when you define a new glossary style, you don’t need to worry about whether the user has specified the nonumberlist package option. -


    package option. +


    \subglossentry{level}{label}{number list}

    -

    +

    This is used to display sub-entries. The first argument, ⟨level⟩, indicates the sub-entry level. This must be an integer from 1 (first sub-level) onwards. The remaining arguments are analogous to those for \glossentry + id="dx1-166064"> described above. -



    \glssubentryitem{label}

    -

    +

    This macro will increment and display the associated counter for the level 1 entries if the subentrycounter + id="dx1-166066"> package option has been used. This macro is typically called by \subglossentry before \glstarget. The + id="dx1-166067">. The format of the counter is controlled by the macro -



    \glssubentrycounterlabel

    -

    -

    Note that

    +

    Note that \printglossary (which (which \printglossaries calls) sets -


    calls) sets +


    \currentglossary

    -

    +

    to the current glossary label, so it’s possible to create a glossary style that varies according to the glossary type. -

    For further details of these commands, see “Displaying the glossary” in the documented code +

    For further details of these commands, see “Displaying the glossary” in the documented code (glossaries-code.pdf). -

    +

    Example 23 (Creating a completely new style) -

    If you want a completely new style, you will need to redefine all of the commands and the environment listed + id="x1-166073"> +

    If you want a completely new style, you will need to redefine all of the commands and the environment listed above. -

    For example, suppose you want each entry to start with a bullet point. This means that the glossary should +

    For example, suppose you want each entry to start with a bullet point. This means that the glossary should be placed in the itemize environment, so environment, so theglossary should start and end that environment. Let’s also suppose + id="dx1-166076"> should start and end that environment. Let’s also suppose that you don’t want anything between the glossary groups (so \glsgroupheading and and \glsgroupskip should + id="dx1-166079"> should do nothing) and suppose you don’t want anything to appear immediately after \begin{theglossary} (so \glossaryheader should do nothing). In addition, let’s suppose the symbol should appear in brackets + id="dx1-166080"> should do nothing). In addition, let’s suppose the symbol should appear in brackets after the name, followed by the description and last of all the number list should appear within + id="dx1-166081"> should appear within square brackets at the end. Then you can create this new glossary style, called, say, mylist, as follows:

    -
    +   
      \newglossarystyle{mylist}{%
      % put the glossary in the itemize environment:
      \renewenvironment{theglossary}%
    @@ -26783,41 +26870,41 @@ follows:
        \glossentry{##2}{##3}}%
      }
     
    -

    Note that this style creates a flat glossary, where sub-entries are displayed in exactly the same way as the top +

    Note that this style creates a flat glossary, where sub-entries are displayed in exactly the same way as the top level entries. It also hasn’t used \glsentryitem or or \glssubentryitem so it won’t be affected by the + id="dx1-166083"> so it won’t be affected by the entrycounter, , counterwithin or or subentrycounter package options. -

    Variations:

    + id="dx1-166086"> package options. +

    Variations:

    • -

      You might want the entry name to be capitalised, in which case use

      You might want the entry name to be capitalised, in which case use \Glossentryname instead of + id="dx1-166087"> instead of \glossentryname. + id="dx1-166088">.

    • -

      You might want to check if the symbol hasn’t been set and omit the parentheses if the symbol is absent. In +

      You might want to check if the symbol hasn’t been set and omit the parentheses if the symbol is absent. In this case you can use \ifglshassymbol (see (see §??sec:utilities 15 Utilities):

      -
      +     
             \renewcommand*{\glossentry}[2]{%
             \item % bullet point
             \glstarget{##1}{\glossentryname{##1}}% the entry name
      @@ -26830,79 +26917,79 @@ href="#sec:utilities">Utilities):
             \space [##2]% the number list in square brackets
             }%
       
      -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    +

    Example 24 (Creating a new glossary style based on an existing style) -

    If you want to define a new style that is a slightly modified version of an existing style, you can use + id="x1-166091"> +

    If you want to define a new style that is a slightly modified version of an existing style, you can use \setglossarystyle within the second argument of within the second argument of \newglossarystyle followed by whatever alterations you + id="dx1-166093"> followed by whatever alterations you require. For example, suppose you want a style like the list style but you don’t want the extra vertical space + id="dx1-166094"> style but you don’t want the extra vertical space created by \indexspace between groups, then you can create a new glossary style called, say, between groups, then you can create a new glossary style called, say, mylist as follows:

    -
    +   
     \newglossarystyle{mylist}{%
     \setglossarystyle{list}% base this style on the list style
     \renewcommand{\glsgroupskip}{}% make nothing happen
                                   % between groups
     }
     
    -

    (In this case, you can actually achieve the same effect using the

    (In this case, you can actually achieve the same effect using the list style in combination with the package + id="dx1-166096"> style in combination with the package option nogroupskip.)

    + id="dx1-166097">.)

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    +

    Example 25 (Example: creating a glossary style that uses the user1, …, user6 + id="dx1-166100"> keys) -

    Suppose each entry not only has an associated symbol, but also units (stored in +

    Suppose each entry not only has an associated symbol, but also units (stored in user1) and dimension + id="dx1-166102">) and dimension (stored in user2). Then you can define a glossary style that displays each entry in a ). Then you can define a glossary style that displays each entry in a longtable as + id="dx1-166104"> as follows:

    -
    +   
     \newglossarystyle{long6col}{%
      % put the glossary in a longtable environment:
      \renewenvironment{theglossary}%
    @@ -26941,98 +27028,98 @@ follows:
      \renewcommand*{\glsgroupskip}{}%
     }
     
    -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    14. Xindy (Option 3)

    -

    If you want to use

    If you want to use xindy to sort the glossary, you must use the package option to sort the glossary, you must use the package option xindy: + id="dx1-167002">:

    -
    +   
     \usepackage[xindy]{glossaries}
     
    -

    This ensures that the glossary information is written in

    This ensures that the glossary information is written in xindy syntax. -

    syntax. +

    §??sec:makeglossaries 1.5 Generating the Associated Glossary Files covers how to use the external indexing application, and §??sec:locationsyntax 12.2 Locations covers the issues involved in the location syntax. This section covers the commands provided by the glossaries package that allow you to adjust the xindy style file ( style file (xdy) and + id="dx1-167005">) and parameters. -

    To assist writing information to the

    To assist writing information to the xindy style file, the style file, the glossaries package provides the following commands: -



    \glsopenbrace

    -

    -


    +


    \glsclosebrace

    -

    +

    which produce an open and closing brace. (This is needed because \{ and \} don’t expand to a simple brace character when written to a file.) Similarly, you can write a percent character using: -



    \glspercentchar

    -

    +

    and a tilde character using: -



    \glstildechar

    -

    +

    For example, a newline character is specified in a xindy style file using style file using ~n so you can use \glstildechar n to write this correctly (or you can do \string~n). A backslash can be written to a file using -



    \glsbackslash

    -

    -

    In addition, if you are using a package that makes the double quote character active (e.g.

    +

    In addition, if you are using a package that makes the double quote character active (e.g. ngerman) you can + id="dx1-167013">) you can use: -



    \glsquote{text}

    -

    +

    which will produce "text\string" to write the double-quote characte document assumes that the double quote character has not been made active, so the examples just use " for clarity. -

    If you want greater control over the

    If you want greater control over the xindy style file than is available through the LaTeX commands + id="dx1-167015"> style file than is available through the LaTeX commands provided by the glossaries package, you will need to edit the xindy style file. In which case, you must use + id="dx1-167016"> style file. In which case, you must use \noist to prevent the style file from being overwritten by the to prevent the style file from being overwritten by the glossaries package. For additional information about xindy, read the , read the xindy documentation. I’m sorry I can’t provide any assistance + id="dx1-167019"> documentation. I’m sorry I can’t provide any assistance with writing xindy style files. If you need help, I recommend you ask on the style files. If you need help, I recommend you ask on the xindy mailing list + id="dx1-167021"> mailing list (http://xindy.sourceforge.net/mailing-list.html).

    -

    Top

    14.1 Language and Encodings

    -

    When you use

    When you use xindy, you need to specify the language and encoding used (unless you have written your own + id="dx1-168001">, you need to specify the language and encoding used (unless you have written your own custom xindy style file that defines the relevant alphabet and sort rules). If you use style file that defines the relevant alphabet and sort rules). If you use makeglossaries, + id="dx1-168003">, this information is obtained from the document’s auxiliary (aux) file. The ) file. The makeglossaries script + id="dx1-168005"> script attempts to find the root language given your document settings, but in the event that it gets it wrong or if xindy doesn’t support that language, then you can specify the required language + id="dx1-168006"> doesn’t support that language, then you can specify the required language using: -



    \GlsSetXdyLanguage[glossary type]{language}

    -

    +

    where ⟨language⟩ is the name of the language. The optional argument can be used if you have multiple glossaries in different languages. If ⟨glossary type⟩ is omitted, it will be applied to all glossaries, otherwise the language setting will only be applied to the glossary given by ⟨glossary type⟩. -

    If the

    If the inputenc package is used, the encoding will be obtained from the value of package is used, the encoding will be obtained from the value of \inputencodingname. + id="dx1-168009">. Alternatively, you can specify the encoding using: -



    \GlsSetXdyCodePage{code}

    -

    +

    where ⟨code⟩ is the name of the encoding. For example:

    -
    +   
     \GlsSetXdyCodePage{utf8}
     
    -

    -

    Note that you can also specify the language and encoding using the package option +

    +

    Note that you can also specify the language and encoding using the package option xindy={language=lang}. For example:

    -
    +   
     \usepackage[xindy={language=english,codepage=utf8}]{glossaries}
     
    -

    -

    If you write your own custom

    +

    If you write your own custom xindy style file that includes the language settings, you need to set the + id="dx1-168011"> style file that includes the language settings, you need to set the language to nothing:

    -
    +   
     \GlsSetXdyLanguage{}
     
    -

    (and remember to use

    (and remember to use \noist to prevent the style file from being overwritten). -

    The commands to prevent the style file from being overwritten). +

    The commands \GlsSetXdyLanguage and \GlsSetXdyCodePage have no effect if you don’t use makeglossaries. If you call . If you call xindy without without makeglossaries you need to remember to set the language and + id="dx1-168015"> you need to remember to set the language and encoding using the -L and and -C switches.
    -

    -

    + id="dx1-168017"> switches.

    +

    +

    -

    Top

    14.2 Locations and Number lists

    -

    If you use

    If you use xindy, the , the glossaries package needs to know which counters you will be using in the number list in + id="dx1-169002"> in order to correctly format the xindy style file. Counters specified using the style file. Counters specified using the counter package option or the ⟨ package option or the ⟨counter⟩ option of \newglossary are automatically taken care of, but if you plan to use a different counter in the + id="dx1-169005"> are automatically taken care of, but if you plan to use a different counter in the counter key for commands like key for commands like \glslink, then you need to identify these counters , then you need to identify these counters before \makeglossaries + id="dx1-169008"> using: -



    \GlsAddXdyCounters{counter list}

    -

    +

    where ⟨counter list⟩ is a comma-separated list of counter names. -

    The most likely attributes used in the

    The most likely attributes used in the format key ( key (textrm, , hyperrm etc) are automatically added to the + id="dx1-169013"> etc) are automatically added to the xindy style file, but if you want to use another attribute, you need to add it using: -


    style file, but if you want to use another attribute, you need to add it using: +


    \GlsAddXdyAttribute{name}

    -

    +

    where ⟨name⟩ is the name of the attribute, as used in the format key. -

    Take care if you have multiple instances of the same location with different formats. The duplicate locations + id="dx1-169016"> key. +

    Take care if you have multiple instances of the same location with different formats. The duplicate locations will be discarded according to the order in which the attributes are listed. Consider defining semantic commands + id="dx1-169017">attributes are listed. Consider defining semantic commands to use for primary references. For example:

    -
    +   
     \newcommand*{\primary}[1]{\textbf{#1}}
     \GlsAddXdyAttribute{primary}
     
    -

    Then in the document: +

    Then in the document:

    -
    +   
     A \gls[format=primary]{duck} is an aquatic bird.
     There are lots of different types of \gls{duck}.
     
    -

    This will give the

    This will give the format=primary instance preference over the next use that doesn’t use the format + id="dx1-169018"> key. -

    +

    Example 26 (Custom Font for Displaying a Location) -

    Suppose I want a bold, italic, hyperlinked location. I first need to define a command that will do + id="x1-169020"> +

    Suppose I want a bold, italic, hyperlinked location. I first need to define a command that will do this:

    -
    +   
     \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}}
     
    -

    but with

    but with xindy, I also need to add this as an allowed attribute: + id="dx1-169021">, I also need to add this as an allowed attribute:

    -
    +   
     \GlsAddXdyAttribute{hyperbfit}
     
    -

    Now I can use it in the optional argument of commands like

    Now I can use it in the optional argument of commands like \gls: + id="dx1-169023">:

    -
    +   
     Here is a \gls[format=hyperbfit]{sample} entry.
     
    -

    (where

    (where sample is the label of the required entry).

    -

    -

    ____________________________

    -

    Note that

    +

    ____________________________

    +

    Note that \GlsAddXdyAttribute has no effect if \noist is used or if is used or if \makeglossaries is omitted. + id="dx1-169025"> is omitted. \GlsAddXdyAttribute must be used before \makeglossaries. Additionally, . Additionally, \GlsAddXdyCounters must come before \GlsAddXdyAttribute.
    -

    -

    If the location numbers include formatting commands, then you need to add a location style in the +

    +

    If the location numbers include formatting commands, then you need to add a location style in the appropriate format using -



    \GlsAddXdyLocation[prefix-location]{name}{definition}

    -

    +

    where ⟨name⟩ is the name of the format and ⟨definition⟩ is the xindy definition. The optional argument + id="dx1-169028"> definition. The optional argument ⟨prefix-location⟩ is needed if \theH\thecounter⟩. Be sure to also read §??sec:locationsyntax 12.2 Locations for some issues that you may encounter. -

    Note that

    Note that \GlsAddXdyLocation has no effect if \noist is used or if is used or if \makeglossaries is omitted. + id="dx1-169030"> is omitted. \GlsAddXdyLocation must be used before \makeglossaries.
    -

    + id="dx1-169031">.

    +

    -

    +

    Example 27 (Custom Numbering System for Locations) -

    Suppose I decide to use a somewhat eccentric numbering system for sections where I redefine +

    Suppose I decide to use a somewhat eccentric numbering system for sections where I redefine \thesection as follows:

    -
    +   
     \renewcommand*{\thesection}{[\thechapter]\arabic{section}}
     
    -

    If I haven’t done

    If I haven’t done counter=section in the package option, I need to specify that the counter will be used as a location number:

    -
    +   
     \GlsAddXdyCounters{section}
     
    -

    Next I need to add the location style (

    Next I need to add the location style (\thechapter is assumed to be the standard \arabic{chapter}):

    -
    +   
     \GlsAddXdyLocation{section}{:sep "[" "arabic-numbers" :sep "]"
       "arabic-numbers"
     }
     
    -

    Note that if I have further decided to use the

    Note that if I have further decided to use the hyperref package and want to redefine package and want to redefine \theHsection as:

    -
    +   
     \renewcommand*{\theHsection}{\thepart.\thesection}
     \renewcommand*{\thepart}{\Roman{part}}
     
    -

    then I need to modify the

    then I need to modify the \GlsAddXdyLocation code above to:

    -
    +   
     \GlsAddXdyLocation["roman-numbers-uppercase"]{section}{:sep "["
       "arabic-numbers" :sep "]" "arabic-numbers"
     }
     
    -

    Since

    Since \Roman will result in an empty string if the counter is zero, it’s a good idea to add an extra location to + id="dx1-169035"> will result in an empty string if the counter is zero, it’s a good idea to add an extra location to catch this:

    -
    +   
     \GlsAddXdyLocation{zero.section}{:sep "["
       "arabic-numbers" :sep "]" "arabic-numbers"
     }
     
    -

    This example is illustrated in the sample file

    This example is illustrated in the sample file samplexdy2.tex.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    +

    Example 28 (Locations as Dice) -

    Suppose I want a rather eccentric page numbering system that’s represented by the number of dots on dice. + id="x1-169037"> +

    Suppose I want a rather eccentric page numbering system that’s represented by the number of dots on dice. The stix package provides package provides \dicei, …, \dicevi that represent the six sides of a die. I can define a command that takes a number as its argument. If the number is less than seven, the appropriate \dicevi\dicevi\diceiv (6 + 6 + 4 = 16). I’ve called this command \tallynum to match the example given earlier in §??sec:locationsyntax +class="cmbx-10">12.2 Locations:

    -
    +   
     \newrobustcmd{\tallynum}[1]{%
      \ifnum\number#1<7
       $\csname dice\romannumeral#1\endcsname$%
    @@ -27467,24 +27554,24 @@ href="#sec:locationsyntax">Locations:
      \fi
     }
     
    -

    Here’s the counter command: +

    Here’s the counter command:

    -
    +   
     newcommand{\tally}[1]{\tallynum{\arabic{#1}}}
     
    -

    The

    The page counter representation ( counter representation (\thepage) needs to be changed to use this command:

    -
    +   
     \renewcommand*{\thepage}{\tally{page}}
     
    -

    The

    The \tally command expands to \tallynum {number -

    +   
     \GlsAddXdyLocation{tally}{%
      :sep "\string\tallynum\space\glsopenbrace"
      "arabic-numbers"
      :sep "\glsclosebrace"
     }
     
    -

    The space between

    The space between \tallynum and {number} is significant to xindy so so \space is required. -

    Note that

    Note that \GlsAddXdyLocation{name}{definition} will define commands in the form: -



    \glsXcounterXHprefix}{location}

    -

    +

    for each counter that has been identified either by the counter package option, the ⟨ package option, the ⟨counter⟩ option for \newglossary or in the argument of or in the argument of \GlsAddXdyCounters. The first argument ⟨. The first argument ⟨Hprefix⟩ is only relevant when used with the hyperref package and indicates that package and indicates that \theHcounter⟩ is given by \Hprefix.\thecounter⟩. -

    The sample file

    The sample file samplexdy.tex, which comes with the glossaries package, uses the default page counter for + id="dx1-169045"> counter for locations, and it uses the default \glsnumberformat and a custom and a custom \hyperbfit format. A new xindy location + id="dx1-169047"> location called tallynum, as illustrated above, is defined to make the page numbers appear as dice. In order for the location numbers to hyperlink to the relevant pages, I need to redefine the necessary -

    +   
     \renewcommand{\glsXpageXglsnumberformat}[2]{%
      \linkpagenumber#2%
     }
    @@ -27578,7 +27665,7 @@ commands:
     }
     \newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}}
     
    -

    Note that the second argument of

    Note that the second argument of \glsXpageXglsnumberformat is in the format \tallynum{n -

    +   
      \linkpagenumber#2%
     
    -

    does

    +

    does

     \linkpagenumber\tallynum{\linkpagenumber and ⟨number⟩ is the second argument.
    -

    -

    ____________________________

    -

    This method is very sensitive to the internal definition of the location command.
    -

    +

    +

    ____________________________

    +

    This method is very sensitive to the internal definition of the location command.
    +

    -

    +

    Example 29 (Locations as Words not Digits) -

    Suppose I want the page numbers written as words rather than digits and I use the +

    Suppose I want the page numbers written as words rather than digits and I use the fmtcount package to do + id="dx1-169050"> package to do this. I can redefine \thepage as follows: + id="dx1-169051"> as follows:

    -
    +   
     \renewcommand*{\thepage}{\Numberstring{page}}
     
    -

    This

    This used to get expanded to \protect \Numberstringnum -

    +   
     \GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space
       \string\Numberstringnum\space\glsopenbrace"
       "arabic-numbers" :sep "\glsclosebrace"}
     
    -

    and if I’d used the

    and if I’d used the \linkpagenumber command from the previous example, it would need three arguments (the first being \protect):

    -
    +   
     \newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}}
     
    -

    -

    The internal definition of

    +

    The internal definition of \Numberstring has since changed so that it now expands to \Numberstringnum  @@ -27667,20 +27754,20 @@ class="cmtt-10">\protect). This means that the location class definition

    -
    +   
     \GlsAddXdyLocation{Numberstring}{% no \protect now!
       :sep "\string\Numberstringnum\space\glsopenbrace"
       "arabic-numbers" :sep "\glsclosebrace"}
     
    -

    and

    and \linkpagenumber goes back to only two arguments:

    -
    +   
     \newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}}
     
    -

    The other change is that

    The other change is that \Numberstring uses

    \endcsname
    so it hides \c@page from the location escaping mechanism (see §??sec:locationsyntax 12.2 Locations). This means that the page number may be incorrect if the indexing occurs during the output routine. -

    A more recent change to

    A more recent change to fmtcount (v3.03) now puts three instances of (v3.03) now puts three instances of \expandafter before \the\value which no longer hides \c@page from the location escaping mechanism, so the page numbers should once more be correct. Further changes to the fmtcount package may cause a problem + id="dx1-169053"> package may cause a problem again. -

    When dealing with custom formats where the internal definitions are outside of your control and liable to +

    When dealing with custom formats where the internal definitions are outside of your control and liable to change, it’s best to provide a wrapper command.
    -

    -

    Instead of directly using

    +

    Instead of directly using \Numberstring in the definition of \thepage, I can provide a custom command in the same form as the earlier \tally command:

    -
    +   
     \newcommand{\customfmt}[1]{\customfmtnum{\arabic{#1}}}
     \newrobustcmd{\customfmtnum}[1]{\Numberstringnum{#1}}
     
    -

    This ensures that the location will always be written to the indexing file in the form:

    +

    This ensures that the location will always be written to the indexing file in the form:

    :locref}}"
    So the location class can be defined as: -
    +   
     \GlsAddXdyLocation{customfmt}{
      :sep "\string\customfmtnum\space\glsopenbrace"
      "arabic-numbers"
      :sep "\glsclosebrace"}
     
    -

    -

    The sample file

    +

    The sample file samplexdy3.tex illustrates this.

    -

    -

    ____________________________

    -

    In the

    +

    ____________________________

    +

    In the number list, the locations are sorted according to the list of provided location classes. + id="dx1-169054">, the locations are sorted according to the list of provided location classes. The default ordering is: roman-page-numbers (i, ii, …), arabic-page-numbers (1, 2, …), @@ -27764,7 +27851,7 @@ class="cmtt-10">arabic-page-numbers (1, 2, …), class="cmtt-10">arabic-section-numbers (for example, 1.1 if the compositor is a full stop or 1-1 if the compositor is a hyphen14.1), + id="x1-169055f1">), alpha-page-numbers (a, b, …), Roman-page-numbers (I, II, …), Alpha-page-numbers (A, B, …), class="cmtt-10">Appendix-page-numbers (for example, A.1 if the Alpha compositor is a full stop or A-1 if the Alpha compositor is a hyphen14.2), user defined + id="x1-169057f2">), user defined location names (as specified by \GlsAddXdyLocation in the order in which they were defined), and finally in the order in which they were defined), and finally see (cross-referenced entries).14.3 + id="x1-169060f3"> This ordering can be changed using: -



    \GlsSetXdyLocationClassOrder{location names}

    -

    +

    where each location name is delimited by double quote marks and separated by white space. For example:

    -
    +   
     \GlsSetXdyLocationClassOrder{
       "arabic-page-numbers"
       "arabic-section-numbers"
    @@ -27805,118 +27892,118 @@ example:
       "see"
     }
     
    -

    (Remember to add

    (Remember to add "seealso" if you’re using glossaries-extra.) -

    Note that

    Note that \GlsSetXdyLocationClassOrder has no effect if \noist is used or if is used or if \makeglossaries is + id="dx1-169063"> is omitted. \GlsSetXdyLocationClassOrder must be used before \makeglossaries.
    -

    -

    If a .

    +

    +

    If a number list consists of a sequence of consecutive numbers, the range will be concatenated. The + id="dx1-169065"> consists of a sequence of consecutive numbers, the range will be concatenated. The number of consecutive locations that causes a range formation defaults to 2, but can be changed using: -



    \GlsSetXdyMinRangeLength{n}

    -

    +

    For example:

    -
    +   
     \GlsSetXdyMinRangeLength{3}
     
    -

    The argument may also be the keyword

    The argument may also be the keyword none, to indicate that there should be no range formations. See the xindy manual for further details on range formations. -

    Note that manual for further details on range formations. +

    Note that \GlsSetXdyMinRangeLength has no effect if \noist is used or if is used or if \makeglossaries is omitted. + id="dx1-169069"> is omitted. \GlsSetXdyMinRangeLength must be used before \makeglossaries.
    -

    + id="dx1-169070">.

    +

    See also §??sec:ranges 12.3 Range Formations. -

    +

    -

    Top

    14.3 Glossary Groups

    -

    The glossary is divided into groups according to the first letter of the sort key. The

    The glossary is divided into groups according to the first letter of the sort key. The glossaries package also adds a number group by default, unless you suppress it in the xindy package option. For example: + id="dx1-170001"> package option. For example:

    -
    +   
     \usepackage[xindy={glsnumbers=false}]{glossaries}
     
    -

    Any entry that doesn’t go in one of the letter groups or the number group is placed in the default group. If you +

    Any entry that doesn’t go in one of the letter groups or the number group is placed in the default group. If you want xindy to sort the number group numerically (rather than by a string sort) then you need to use to sort the number group numerically (rather than by a string sort) then you need to use xindy’s + id="dx1-170003">’s numeric-sort module:

    -
    +   
     \GlsAddXdyStyle{numeric-sort}
     
    -

    -

    If you don’t use

    +

    If you don’t use glsnumbers=false, the default behaviour is to locate the number group before the “A” letter group. If you are not using a Roman alphabet, you need to change this using: -



    \GlsSetXdyFirstLetterAfterDigits{letter}

    -

    +

    where ⟨letter⟩ is the first letter of your alphabet. Take care if you’re using inputenc as non-ASCII characters are + id="dx1-170005"> as non-ASCII characters are actually active characters that expand. (This isn’t a problem with the native UTF-8 engines and fontspec.) The starred form will sanitize the argument to prevent expansion. Alternatively you can + id="dx1-170006">.) The starred form will sanitize the argument to prevent expansion. Alternatively you can use: -



    \GlsSetXdyNumberGroupOrder{relative location}

    -

    +

    to change the default

    \string" class="cmti-10">relative location⟩. For example: -
    +   
     \GlsSetXdyNumberGroupOrder{:after \string"Z\string"}
     
    -

    will put the number group after the “Z” letter group. Again take care of active characters. There’s a starred +

    will put the number group after the “Z” letter group. Again take care of active characters. There’s a starred version that sanitizes the argument (so don’t use \string in it).

    @@ -27941,50 +28028,50 @@ class="cmtt-10">\GlsSetXdyNumberGroupOrder*{:after "ÖÖ"}
    -

    Note that these commands have no effect if

    Note that these commands have no effect if \noist is used or if is used or if \makeglossaries is omitted. + id="dx1-170009"> is omitted. \GlsSetXdyFirstLetterAfterDigits must be used before \makeglossaries. + id="dx1-170010">.
    -

    +

    -

    -

    +

    Top

    15. Utilities

    -

    This section describes some utility commands. Additional commands can be found in the documented code +

    This section describes some utility commands. Additional commands can be found in the documented code (glossaries-code.pdf). -

    The

    The glossaries-extra package provides extra utility commands. See the “Utilities” section of the glossaries-extra manual.
    -

    +

    -

    Top

    15.1 Loops

    -

    Some of the commands described here take a comma-separated list as an argument. As with LaTeX’s

    Some of the commands described here take a comma-separated list as an argument. As with LaTeX’s \@for command, make sure your list doesn’t have any unwanted spaces in it as they don’t get stripped. (Discussed in more detail in §2.7.2 of “LaTeX for Administrative Work”.)
    -

    -


    +


    \forallglossaries[glossary list]{cs}{body}

    -

    +

    This iterates through ⟨glossary list⟩, a comma-separated list of glossary labels (as supplied when the glossary was defined). At each iteration ⟨body⟩ is performed. If ⟨glossary list⟩ is omitted, the default is to iterate over all glossaries (except the ignored ones). -



    \forallacronyms{cs}{body}

    -

    +

    This is like \forallglossaries but only iterates over the lists of acronyms (that have previously been declared using \DeclareAcronymList or the or the acronymlists package option). This command doesn’t have an optional + id="dx1-172004"> package option). This command doesn’t have an optional argument. If you want to explicitly say which lists to iterate over, just use the optional argument of \forallglossaries. -

    The

    The glossaries-extra package provides an analogous command \forallabbreviationlists.
    -

    -


    .
    +

    +


    \forglsentries[glossary label]{cs}{body}

    -

    +

    This iterates through all entries in the glossary given by ⟨glossary label⟩. At each iteration ⟨cs⟩ (which must be a @@ -28043,9 +28130,9 @@ class="cmti-10">body⟩ is performed. If ⟨glossary label⟩ is omitted, \glsdefaulttype (usually the main glossary) is used. -


    (usually the main glossary) is used. +


    \forallglsentries[glossary list]{cs}{body}

    -

    +

    This is like \forglsentries but for each glossary in ⟨glossary list⟩ (a comma-separated list of glossary labels). If @@ -28069,18 +28156,18 @@ class="cmtt-10">} within ⟨body⟩.) -

    +

    -

    Top

    15.2 Conditionals

    -



    \ifglossaryexistslabel⟩⟨true part⟩⟨false part

    -

    +

    This checks if the glossary given by ⟨label⟩ exists. If it does ⟨true part⟩ is performed, otherwise ⟨ \newignoredglossary{common}

    then -
    +   
     \ifglossaryexists{common}{true}{false}
     \ifglossaryexists*{common}{true}{false}
     
    -

    will produce “false true”. -


    will produce “false true”. +


    \ifglsentryexistslabel⟩⟨true part⟩⟨false part

    -

    +

    This checks if the glossary entry given by ⟨label⟩ exists. If it does ⟨true part⟩ is performed, otherwise ⟨false part⟩. class="cmtt-10">\ifglsentryexists will always be true after the containing glossary has been displayed via \printglossary or or \printglossaries even if the entry is explicitly defined later in the document. This is + id="dx1-173005"> even if the entry is explicitly defined later in the document. This is because the entry has to be defined before it can be displayed in the glossary, see §??sec:techissues 4.8.1 Technical Issues for further details.) -



    \glsdoifexists{label}{code}

    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ exists. If it doesn’t exist, an error is generated. (This command uses \ifglsentryexists.) -



    \glsdoifnoexists{label}{code}

    -

    +

    Does the reverse of \glsdoifexists. (This command uses \ifglsentryexists.) -



    \glsdoifexistsorwarn{label}{code}

    -

    +

    As \glsdoifexists but issues a warning rather than an error if the entry doesn’t exist. -



    \glsdoifexistsordo{label}{code}{else code}

    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ exists otherwise generate an error and do ⟨else code⟩. -



    \glsdoifnoexistsordo{label}{code}{else code}

    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ doesn’t exist otherwise generate an error and do ⟨else code⟩. -



    \ifglsusedlabel⟩⟨true part⟩⟨false part

    -

    +

    See §??sec:glsunset 7 Unsetting and Resetting Entry Flags. -



    \ifglshaschildrenlabel⟩⟨true part⟩⟨false part

    -

    +

    This checks if the glossary entry given by ⟨label⟩ has any sub-entries. If it does, ⟨true part⟩ is performed, otherwise ⟨false part⟩. This uses an inefficient method since this information isn’t stored. -

    If you use

    If you use bib2gls, a more efficient method is to use the , a more efficient method is to use the save-child-count resource option and test the + id="dx1-173014"> resource option and test the value of the childcount field.
    -

    -


    field.
    +

    +


    \ifglshasparentlabel⟩⟨true part⟩⟨false part

    -

    +

    This checks if the glossary entry given by ⟨label⟩ has a parent entry. If it does, ⟨true part⟩ is performed, otherwise ⟨false part⟩. -



    \ifglshassymbol{label}{false part}

    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the symbol field set. If it has, ⟨ field set. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. -



    \ifglshaslong{label}{true part}{false part}

    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the long field set. If it has, ⟨ field set. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. This should be true for any entry that has been defined via \newacronym. There is no + id="dx1-173021">. There is no check for the existence of ⟨label⟩. -



    \ifglshasshort{label}{true part}{false part}

    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the short field set. If it has, ⟨ field set. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. This should be true for any entry that has been defined via \newacronym. There is no + id="dx1-173024">. There is no check for the existence of ⟨label⟩. -



    \ifglshasdesc{label}{true part}{false part}

    -

    +

    This checks if the description field is non-empty for the entry given by ⟨ field is non-empty for the entry given by ⟨label⟩. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. Compare with: -



    \ifglsdescsuppressed{label}{true part}{false part}

    -

    +

    This checks if the description field has been set to just field has been set to just \nopostdesc for the entry given by ⟨ for the entry given by ⟨label⟩. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. There is no check for the existence of ⟨label⟩. -

    For all other fields you can use: -


    For all other fields you can use: +


    \ifglshasfield{field}{true part}{false part}

    -

    +

    This tests the value of the field given by ⟨field⟩ for the entry identified by ⟨label⟩. If the value is empty true part⟩ is performed. If the field supplied is class="cmti-10">false part⟩ is performed and a warning is issued. Unlike the above commands, such as \ifglshasshort, an error occurs if the entry is undefined. -

    As from version 4.23, within ⟨

    As from version 4.23, within ⟨true part⟩ you can use -



    \glscurrentfieldvalue

    -

    +

    to access the field value. This command is initially defined to nothing but has no relevance outside ⟨true part⟩. This saves re-accessing the field if the test is true. For example:

    -
    +   
     \ifglshasfield{useri}{sample}{, \glscurrentfieldvalue}{}
     
    -

    will insert a comma, space and the field value if the

    will insert a comma, space and the field value if the user1 key has been set for the entry whose label is + id="dx1-173032"> key has been set for the entry whose label is sample. -

    You can test if the value of the field is equal to a given string using: -


    You can test if the value of the field is equal to a given string using: +


    \ifglsfieldeq{label}{true}{false}

    -

    +

    In this case the ⟨field⟩ must be the field name not the key (see table ??tab:fieldmap). If the field isn’t recognised, +class="cmbx-10">4.1). If the field isn’t recognised, an error will occur. This command internally uses etoolbox’s ’s \ifcsstring to perform the comparison. The string is not expanded during the test. -

    The result may vary depending on whether or not expansion is on for the given field (when the entry was +

    The result may vary depending on whether or not expansion is on for the given field (when the entry was defined). For example:

    -
    +   
     \documentclass{article}
     \usepackage{glossaries}
     \newcommand*{\foo}{FOO}
    @@ -28421,25 +28508,25 @@ user1={\foo}}
     \ifglsfieldeq{sample2}{useri}{FOO}{TRUE}{FALSE}.
     \end{document}
     
    -

    This will produce “TRUE” in both cases since expansion is on, so

    This will produce “TRUE” in both cases since expansion is on, so \foo was expanded to “FOO” when sample2 was defined. If the tests are changed to:

    -
    +   
     \ifglsfieldeq{sample1}{useri}{\foo}{TRUE}{FALSE}.
     \ifglsfieldeq{sample2}{useri}{\foo}{TRUE}{FALSE}.
     
    -

    then this will produce “FALSE” in both cases. Now suppose expansion is switched off for the

    then this will produce “FALSE” in both cases. Now suppose expansion is switched off for the user1 + id="dx1-173035"> key:

    -
    +   
     \documentclass{article}
     \usepackage{glossaries}
     \newcommand*{\foo}{FOO}
    @@ -28453,14 +28540,14 @@ user1={\foo}}
     \ifglsfieldeq{sample2}{useri}{FOO}{TRUE}{FALSE}.
     \end{document}
     
    -

    This now produces “TRUE” for the first case (comparing “FOO” with “FOO”) and “FALSE” for the second +

    This now produces “TRUE” for the first case (comparing “FOO” with “FOO”) and “FALSE” for the second case (comparing “\foo” with “FOO”). -

    The reverse happens in the following: +

    The reverse happens in the following:

    -
    +   
     \documentclass{article}
     \usepackage{glossaries}
     \newcommand*{\foo}{FOO}
    @@ -28474,14 +28561,14 @@ user1={\foo}}
     \ifglsfieldeq{sample2}{useri}{\foo}{TRUE}{FALSE}.
     \end{document}
     
    -

    This now produces “FALSE” for the first case (comparing “FOO” with “

    This now produces “FALSE” for the first case (comparing “FOO” with “\foo”) and “TRUE” for the second case (comparing “\foo” with “\foo”). -

    You can test if the value of a field is equal to the replacement text of a command using: -


    You can test if the value of a field is equal to the replacement text of a command using: +


    \ifglsfielddefeq{label}{true}{false}

    -

    +

    This internally uses etoolbox’s ’s \ifdefstrequal command to perform the comparison. The argument ⟨command⟩ must be a macro. -

    For example: +

    For example:

    -
    +   
     \documentclass{article}
     \usepackage{glossaries}
     \newcommand*{\foo}{FOO}
    @@ -28518,13 +28605,13 @@ user1={\foo}}
     \ifglsfielddefeq{sample2}{useri}{\foo}{TRUE}{FALSE}.
     \end{document}
     
    -

    Here, the first case produces “TRUE” since the value of the

    Here, the first case produces “TRUE” since the value of the useri field (“FOO”) is the same as the replacement text (definition) of \foo (“FOO”). We have the result “FOO” is equal to “FOO”. -

    The second case produces “FALSE” since the value of the

    The second case produces “FALSE” since the value of the useri field (“\foo”) is not the same as the replacement text (definition) of useri field. We have the result “\foo” is not equal to “FOO”. -

    If we add: +

    If we add:

    -
    +   
     \newcommand{\FOO}{\foo}
     \ifglsfielddefeq{sample2}{useri}{\FOO}{TRUE}{FALSE}.
     
    -

    we now get “TRUE” since the value of the

    we now get “TRUE” since the value of the useri field (“\foo”) is the same as the replacement text (definition) of \FOO (“\foo”). We have the result “\foo” is equal to “\foo”. -

    There is a similar command that requires the control sequence name (without the leading backslash) instead +

    There is a similar command that requires the control sequence name (without the leading backslash) instead of the actual control sequence: -



    \ifglsfieldcseq{label}{true}{false}

    -

    +

    This internally uses etoolbox’s ’s \ifcsstrequal command instead of \ifdefstrequal. -

    +

    -

    Top

    15.3 Fetching and Updating the Value of a Field

    -

    In addition to the commands described in

    In addition to the commands described in §??sec:glsnolink 5.2 Using Glossary Terms Without Links, the following may also be used to fetch field information. -



    \glsentrytype{label}

    -

    +

    Expands to the entry’s glossary type. No existence check is performed. -



    \glsentryparent{label}

    -

    +

    Expands to the label of the entry’s parent. No existence check is performed. -



    \glsentrysort{label}

    -

    +

    Expands to the entry’s sort value. No existence check is performed. -

    You can fetch the value of a given field and store it in a control sequence using: -


    You can fetch the value of a given field and store it in a control sequence using: +


    \glsfieldfetch{label}{field}{cs}

    -

    +

    where ⟨label⟩ is the label identifying the glossary entry, ⟨field⟩ is the field label (see table ??tab:fieldmap) and ⟨4.1) and ⟨cs⟩ is the control sequence in which to store the value. Remember that ⟨field⟩ is the internal label and is not necessarily the same as the key used to set that field in the argument of \newglossaryentry (or the optional argument of \newacronym). -

    You can change the value of a given field using one of the following commands. Note that these commands +class="cmtt-10">\newacronym). This command uses \glsdoifexists so an error will occur if the entry hasn’t been +defined. +

    If you need to expand to the field value without expanding the contents you can use: +


    \glsunexpandedfieldvalue{label}{field}

    +

    +where ⟨label⟩ is the label identifying the glossary entry, ⟨field⟩ is the internal field label (see table 4.1). +If the entry doesn’t exist or if the field isn’t defined or hasn’t been set this expands to nothing. +

    You can change the value of a given field using one of the following commands. Note that these commands only change the value of the given field. They have no affect on any related field. For example, if you change the + + value of the text field, it won’t modify the value given by the field, it won’t modify the value given by the name, , plural, , first or any other related + id="dx1-174009"> or any other related key. -

    In all the four related commands below, ⟨

    In all the four related commands below, ⟨label⟩ and ⟨field⟩ are as above and ⟨definition⟩ is the new value of the field. -



    \glsfielddef{label}{field}{definition}

    -

    +

    This uses \def to change the value of the field (so it will be localised by any grouping). - - -



    \glsfieldedef{label}{field}{definition}

    -

    +

    This uses \edef to change the value of the field (so it will be localised by any grouping). Any fragile commands contained in the ⟨definition⟩ must be protected. -



    \glsfieldgdef{label}{field}{definition}

    -

    +

    This uses \gdef to change the value of the field. -



    \glsfieldxdef{label}{field}{definition}

    -

    +

    This uses \xdef to change the value of the field. Any fragile commands contained in the ⟨definition⟩ must be @@ -28698,109 +28802,109 @@ protected.

    -

    -

    +

    Top

    16. Prefixes or Determiners

    -

    The

    The glossaries-prefix package that comes with the package that comes with the glossaries package provides additional keys that can be used as prefixes. For example, if you want to specify determiners (such as “a”, “an” or “the”). The glossaries-prefix package automatically loads the glossaries package and has the same package options. -

    The extra keys for

    The extra keys for \newglossaryentry are as follows: + id="dx1-175002"> are as follows:

    -

    +

    prefix

    -

    The prefix associated with the

    The prefix associated with the text key. This defaults to nothing. + id="dx1-175004"> key. This defaults to nothing.

    -

    +

    prefixplural

    -

    The prefix associated with the

    The prefix associated with the plural key. This defaults to nothing. + id="dx1-175006"> key. This defaults to nothing.

    -

    +

    prefixfirst

    -

    The prefix associated with the

    The prefix associated with the first key. If omitted, this defaults to the value of the key. If omitted, this defaults to the value of the prefix key. + id="dx1-175009"> key.

    -

    +

    prefixfirstplural

    -

    The prefix associated with the

    The prefix associated with the firstplural key. If omitted, this defaults to the value of the + id="dx1-175011"> key. If omitted, this defaults to the value of the prefixplural key.

    + id="dx1-175012"> key.

    -

    +

    Example 30 (Defining Determiners) -

    Here’s the start of my example document: + id="x1-175014"> +

    Here’s the start of my example document:

    -
    +   
     \documentclass{article}
     \usepackage[colorlinks]{hyperref}
     \usepackage[toc,acronym]{glossaries-prefix}
     
    -

    Note that I’ve simply replaced

    Note that I’ve simply replaced glossaries from previous sample documents with glossaries-prefix. Now for a sample definition16.1: + id="x1-175015f1">:

    -
    +   
     \newglossaryentry{sample}{name={sample},%
       description={an example},%
       prefix={a~},%
       prefixplural={the\space}%
     }
     
    -

    Note that I’ve had to explicitly insert a space after the prefix since there’s no designated separator between the +

    Note that I’ve had to explicitly insert a space after the prefix since there’s no designated separator between the prefix and the term being referenced. This not only means that you can vary between a breaking space and non-breaking space, but also allows for the possibility of prefixes that shouldn’t have a space, such as:

    -
    +   
     \newglossaryentry{oeil}{name={oeil},
       plural={yeux},
       description={eye},
       prefix={l'},
       prefixplural={les\space}}
     
    -

    Where a space is required at the end of the prefix, you must use a spacing command, such as +

    Where a space is required at the end of the prefix, you must use a spacing command, such as \space, \␣ (backslash space) or ~ due to the automatic spacing trimming per class="cmti-10">key⟩=⟨value⟩ options. -

    In the event that you always require a space between the prefix and the term, then you can instead +

    In the event that you always require a space between the prefix and the term, then you can instead redefine -



    \glsprefixsep

    -

    +

    to do a space. (This command does nothing by default.) For example:

    -
    +   
     \renewcommand{\glsprefixsep}{\space}
     
    -

    -

    The prefixes can also be used with acronyms. For example: +

    +

    The prefixes can also be used with acronyms. For example:

    -
    +   
     \newacronym
      [%
        prefix={an\space},prefixfirst={a~}%
      ]{svm}{SVM}{support vector machine}
     
    -

    +

    -

    -

    ____________________________

    -

    The

    +

    ____________________________

    +

    The glossaries-prefix package provides convenient commands to use these prefixes with commands such as + id="dx1-175018"> package provides convenient commands to use these prefixes with commands such as \gls. Note that the prefix is not considered part of the . Note that the prefix is not considered part of the link text, so it’s not included in the hyperlink (where + id="dx1-175020">, so it’s not included in the hyperlink (where hyperlinks are enabled). The options and any star or plus modifier are passed on to the \gls-like command. (See §??sec:glslink 5.1 Links to Glossary Entries for further details.) -



    \pgls[options]{label}[insert]

    -

    +

    This is inserts the value of the prefix key (or key (or prefixfirst key, on key, on first use) in front of \gls[options} class="cmtt-10">[insert]. -



    \Pgls[options]{label}[insert]

    -

    +

    If the prefix key (or key (or prefixfirst, on first use) has been set, this displays the value of that key with the first + id="dx1-175026">, on first use) has been set, this displays the value of that key with the first letter converted to upper case followed by \gls[optionsinsert]. If that key hasn’t been set, this is equivalent to \Gls[options]{label}[insert]. -



    \PGLS[options]{label}[insert]

    -

    +

    As \pgls but converts the prefix to upper case and uses \GLS instead of instead of \gls. -



    \pglspl[options]{label}[insert]

    -

    +

    This is inserts the value of the prefixplural key (or key (or prefixfirstplural key, on key, on first use) in front of \glspl label}[insert]. -



    \Pglspl[options]{label}[insert]

    -

    +

    If the prefixplural key (or key (or prefixfirstplural, on first use) has been set, this displays the value of that key + id="dx1-175035">, on first use) has been set, this displays the value of that key with the first letter converted to upper case followed by \glspl[optionsinsert]. If that key hasn’t been set, this is equivalent to \Glspl[options]{label}[insert]. -



    \PGLSpl[options]{label}[insert]

    -

    +

    As \pglspl but converts the prefix to upper case and uses \GLSpl instead of instead of \glspl. -

    +

    Example 31 (Using Prefixes) -

    Continuing from Example 30, now that I’ve defined my entries, I can use them in the text via the above + id="x1-175040"> +

    Continuing from Example 30, now that I’ve defined my entries, I can use them in the text via the above commands:

    -
    +   
     First use: \pgls{svm}. Next use: \pgls{svm}.
     Singular: \pgls{sample}, \pgls{oeil}.
     Plural: \pglspl{sample}, \pglspl{oeil}.
     
    -

    which produces: +

    which produces:

    -

    First use: a support vector machine (SVM). Next use: an SVM. Singular: a sample, l’oeil. +

    First use: a support vector machine (SVM). Next use: an SVM. Singular: a sample, l’oeil. Plural: the samples, les yeux.

    -

    For a complete document, see

    For a complete document, see sample-prefix.tex.

    -

    -

    ____________________________

    -

    This package also provides the commands described below, none of which perform any check to determine +

    +

    ____________________________

    +

    This package also provides the commands described below, none of which perform any check to determine the entry’s existence. -



    \ifglshasprefix{label}{true part}{false part}

    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefix key. -

    This package also provides the following commands: -


    key. +

    This package also provides the following commands: +


    \ifglshasprefixplural{label}{true part}{false part}

    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixplural key. -


    key. +


    \ifglshasprefixfirst{label}{true part}{false part}

    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixfirst key. -


    key. +


    \ifglshasprefixfirstplural{label}{true part}{false part}

    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixfirstplural key. -



    \glsentryprefix{label}

    -

    +

    Displays the value of the prefix key for the entry given by ⟨ key for the entry given by ⟨label⟩. -



    \glsentryprefixfirst{label}

    -

    +

    Displays the value of the prefixfirst key for the entry given by ⟨ key for the entry given by ⟨label⟩. -



    \glsentryprefixplural{label}

    -

    +

    Displays the value of the prefixplural key for the entry given by ⟨ key for the entry given by ⟨label⟩. (No check is performed to determine if the entry exists.) -



    \glsentryprefixfirstplural{label}

    -

    +

    Displays the value of the prefixfirstplural key for the entry given by ⟨ key for the entry given by ⟨label⟩. (No check is performed to determine if the entry exists.) -

    There are also variants that convert the first letter to upper +

    There are also variants that convert the first letter to upper case16.2: -


    : +


    \Glsentryprefix{label}

    -

    -


    +


    \Glsentryprefixfirst{label}

    -

    -


    +


    \Glsentryprefixplural{label}

    -

    -


    +


    \Glsentryprefixfirstplural{label}

    -

    -

    As with analogous commands such as

    +

    As with analogous commands such as \Glsentrytext, these commands aren’t expandable so can’t be used + id="dx1-175061">, these commands aren’t expandable so can’t be used in PDF bookmarks.
    -

    +

    -

    +

    Example 32 (Adding Determiner to Glossary Style) -

    You can use the above commands to define a new glossary style that uses the determiner. For + id="x1-175063"> +

    You can use the above commands to define a new glossary style that uses the determiner. For example, the following style is a slight modification of the list style that inserts the prefix before the + id="dx1-175064"> style that inserts the prefix before the name:

    -
    +   
     \newglossarystyle{plist}{%
       \setglossarystyle{list}%
       \renewcommand*{\glossentry}[2]{%
    @@ -29192,12 +29296,12 @@ name:
            \glossentrydesc{##1}\glspostdescription\space ##2}%
     }
     
    -

    If you want to change the prefix separator (

    If you want to change the prefix separator (\glsprefixsep) then the following is better:

    -
    +   
     \newglossarystyle{plist}{%
       \setglossarystyle{list}%
       \renewcommand*{\glossentry}[2]{%
    @@ -29207,12 +29311,12 @@ class="cmtt-10">\glsprefixsep) then the following is better:
            \glossentrydesc{##1}\glspostdescription\space ##2}%
     }
     
    -

    The conditional is also useful if you want the style to use an uppercase letter at the start of the entry +

    The conditional is also useful if you want the style to use an uppercase letter at the start of the entry item:

    -
    +   
     \newglossarystyle{plist}{%
       \setglossarystyle{list}%
       \renewcommand*{\glossentry}[2]{%
    @@ -29226,77 +29330,77 @@ item:
            \glossentrydesc{##1}\glspostdescription\space ##2}%
     }
     
    -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    17. Accessibility Support

    -

    Limited accessibility support is provided by the accompanying

    Limited accessibility support is provided by the accompanying glossaries-accsupp package, but note that this + id="dx1-176001"> package, but note that this package is experimental and it requires the accsupp package which is also listed as experimental. This package + id="dx1-176002"> package which is also listed as experimental. This package automatically loads the glossaries package. Any options are passed to package. Any options are passed to glossaries (if it hasn’t already been loaded). + id="dx1-176004"> (if it hasn’t already been loaded). For example:

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

    This will load

    This will load glossaries with the with the acronym package option as well as loading package option as well as loading glossaries-accsupp. -

    If you are using the . +

    If you are using the glossaries-extra extension package, you need to load glossaries-extra with the accsupp + id="dx1-176008"> package option. For example:

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

    This will load

    This will load glossaries-extra (with the abbreviations option), option), glossaries and and glossaries-accsupp and make + id="dx1-176011"> and make appropriate patches to integrate the accessibility support with the extension commands. -

    The

    The glossaries-accsupp package defines additional keys that may be used when defining glossary entries. The + id="dx1-176012"> package defines additional keys that may be used when defining glossary entries. The keys are as follows:

    -

    +

    access

    -

    The +

    The replacement text corresponding @@ -29304,15 +29408,15 @@ class="description"> the name + id="dx1-176014"> key.

    -

    +

    textaccess

    -

    The +

    The replacement text corresponding @@ -29320,15 +29424,15 @@ class="description"> the text + id="dx1-176016"> key.

    -

    +

    firstaccess

    -

    The +

    The replacement text corresponding @@ -29338,15 +29442,15 @@ class="description"> the first + id="dx1-176018"> key.

    -

    +

    pluralaccess

    -

    The +

    The replacement text corresponding @@ -29354,15 +29458,15 @@ class="description"> the plural + id="dx1-176020"> key.

    -

    +

    firstpluralaccess

    -

    The +

    The replacement text corresponding @@ -29370,15 +29474,15 @@ class="description"> the firstplural + id="dx1-176022"> key.

    -

    +

    symbolaccess

    -

    The +

    The replacement text corresponding @@ -29386,17 +29490,17 @@ class="description"> the symbol + id="dx1-176024"> key.

    -

    +

    symbolpluralaccess

    -

    The +

    The replacement text corresponding @@ -29404,15 +29508,15 @@ class="description"> the symbolplural + id="dx1-176026"> key.

    -

    +

    descriptionaccess

    -

    The +

    The replacement text corresponding @@ -29420,15 +29524,15 @@ class="description"> the description + id="dx1-176028"> key.

    -

    +

    descriptionpluralaccess

    -

    The +

    The replacement text corresponding @@ -29436,15 +29540,15 @@ class="description"> the descriptionplural + id="dx1-176030"> key.

    -

    +

    longaccess

    -

    The +

    The replacement text corresponding @@ -29454,20 +29558,20 @@ class="description"> the long + id="dx1-176032"> key (used by \newacronym). + id="dx1-176033">).

    -

    +

    shortaccess

    -

    The +

    The replacement text corresponding @@ -29475,20 +29579,20 @@ class="description"> the short + id="dx1-176035"> key (used by \newacronym). + id="dx1-176036">).

    -

    +

    longpluralaccess

    -

    The +

    The replacement text corresponding @@ -29496,20 +29600,20 @@ class="description"> the longplural + id="dx1-176038"> key (used by \newacronym). + id="dx1-176039">).

    -

    +

    shortpluralaccess

    -

    The +

    The replacement @@ -29519,20 +29623,20 @@ class="description"> the shortplural + id="dx1-176041"> key (used by \newacronym). + id="dx1-176042">).

    -

    +

    user1access

    -

    The +

    The replacement text corresponding @@ -29540,15 +29644,15 @@ class="description"> the user1 + id="dx1-176044"> key.

    -

    +

    user2access

    -

    The +

    The replacement text corresponding @@ -29556,15 +29660,15 @@ class="description"> the user2 + id="dx1-176046"> key.

    -

    +

    user3access

    -

    The +

    The replacement text corresponding @@ -29574,15 +29678,15 @@ class="description"> the user3 + id="dx1-176048"> key.

    -

    +

    user4access

    -

    The +

    The replacement text corresponding @@ -29590,15 +29694,15 @@ class="description"> the user4 + id="dx1-176050"> key.

    -

    +

    user5access

    -

    The +

    The replacement text corresponding @@ -29606,15 +29710,15 @@ class="description"> the user5 + id="dx1-176052"> key.

    -

    +

    user6access

    -

    The +

    The replacement text corresponding @@ -29622,85 +29726,85 @@ class="description"> the user6 + id="dx1-176054"> key.

    -

    For example: +

    For example:

    -
    +   
     \newglossaryentry{tex}{name={\TeX},description={Document
     preparation language},access={TeX}}
     
    -

    Now the

    Now the link text produced by produced by \gls{tex} will be:

    -
    +   
     \BeginAccSupp{ActualText={TeX}}\TeX\EndAccSupp{}
     
    -

    The sample file

    The sample file sampleaccsupp.tex illustrates the glossaries-accsupp package. -

    If you prefer to use package. +

    If you prefer to use accessibility or or tagpdf instead of instead of accsupp then you’ll need to define then you’ll need to define \gls@accsupp@engine and \gls@accessibility before loading glossaries-accsupp. See the section “Accessibility Support”in the + id="dx1-176060">. See the section “Accessibility Support”in the documented code for further details. -

    The PDF specification identifies three different types of replacement text: +

    The PDF specification identifies three different types of replacement text:

    -

    +

    Alt

    -

    Description of some content that’s non-textual (for example, an image). A word break is assumed +

    Description of some content that’s non-textual (for example, an image). A word break is assumed after the content.

    -

    +

    ActualText

    -

    A character or sequence of characters that replaces textual content (for example, a dropped capital, +

    A character or sequence of characters that replaces textual content (for example, a dropped capital, a ligature or a symbol). No word break is assumed after the content.

    -

    +

    E

    -

    Expansion of an abbreviation to avoid ambiguity (for example, “St” could be short for “saint” or +

    Expansion of an abbreviation to avoid ambiguity (for example, “St” could be short for “saint” or “street”).

    -

    Many PDF viewers don’t actually support any type of replacement text. Some may support “ActualText” +

    Many PDF viewers don’t actually support any type of replacement text. Some may support “ActualText” but not “Alt” or “E”. PDFBox’s “PDFDebugger” tool can be used to inspect the PDF content to make sure that the replacement text has been correctly set.
    -

    -

    If you define abbreviations with

    +

    If you define abbreviations with \newacronym, the , the shortaccess field will automatically be set + id="dx1-176062"> field will automatically be set to: -



    \glsdefaultshortaccess{long}{short}

    -

    +

    With the base glossaries package this just expands to ⟨long⟩. With glossaries-extra this expands to ⟨long⟩ (⟨short⟩). This command must be fully expandable. It expands when the abbreviation is defined. -

    As from

    As from glossaries-accsupp v4.45, the helper command used to identify the replacement text depends on the + id="dx1-176064"> v4.45, the helper command used to identify the replacement text depends on the field name. Previous versions just used: -



    \glsaccsupp{replacement}{content}

    -

    +

    for all fields. This is defined to use ActualText, which is appropriate for symbols but not for abbreviations. -

    As from v4.45, there’s a new helper command: +

    As from v4.45, there’s a new helper command: -



    \glsfieldaccsupp{replacement}{field}{label}

    -

    +

    This will use \glsfieldaccsupp if it’s defined otherwise it will just use if it’s defined otherwise it will just use \glsaccsupp. There are just two of these field commands for short and and shortplural: -


    : +


    \glsshortaccsupp{replacement}{content}

    -

    +

    which is like \glsaccsupp but uses E instead of ActualText and -



    \glsshortplaccsupp{replacement}{content}

    -

    +

    which just does \glsshortaccsupp{replacementinternal field name class="cmtt-10">shortpl) not the key name (such as shortplural). See table ??tab:fieldmap. -

    Rather than explicitly using 4.1. +

    Rather than explicitly using \BeginAccSupp, these helper commands can use: -


    , these helper commands can use: +


    \glsaccessibility[options]{value}{content}

    -

    +

    where ⟨tag⟩ is one of E,

    \BeginAccSupp{tag={options}content\EndAccSupp{}
    but it also provides debugging information if debug=showaccsupp is used. If you explicitly use is used. If you explicitly use \BeginAccSupp instead of this command then the debugging support won’t be available. -

    You can define your own custom helper commands for specific fields that require them. For +

    You can define your own custom helper commands for specific fields that require them. For example:

    -
    +   
     \newcommand{\glssymbolaccsupp}[2]{%
      \glsaccessibility[method=hex,unicode]{ActualText}{#1}{#2}%
     }
     
    -

    This definition requires the replacement text to be specified with the hexadecimal character code. For +

    This definition requires the replacement text to be specified with the hexadecimal character code. For example:

    -
    +   
     \newglossaryentry{int}{name={int},description={integral},
       symbol={\ensuremath{\int}},symbolaccess={222B}
     }
     
    -

    -

    If you are using

    +

    If you are using glossaries-extra, then \glsfieldaccsupp will first test for the existence of @@ -29858,20 +29962,20 @@ class="cmtt-10">\glsxtr⟨category⟩⟨fieldaccsupp and and \glsxtrcategoryaccsupp and then for and then for \glsfieldaccsupp. For + id="dx1-176079">. For example:

    -
    +   
     \usepackage{siunitx}
     \usepackage[accsupp]{glossaries-extra}
     \glsnoexpandfields
    @@ -29888,27 +29992,27 @@ example:
       description={integral},category={symbol}
     }
     
    -

    The above uses the

    The above uses the \glsxtrcategoryaccsupp form that doesn’t include the field name. Remember that if you + id="dx1-176080"> form that doesn’t include the field name. Remember that if you want to supply a command specifically for the name field then it won’t be picked up by the field then it won’t be picked up by the text, , plural, + id="dx1-176083">, firstplural and and first fields. You’d need to supply them all. For example: + id="dx1-176085"> fields. You’d need to supply them all. For example:

    -
    +   
     \newcommand{\glsnameaccsupp}[2]{%
      \glsaccessibility[method=hex,unicode]{ActualText}{#1}{#2}%
     }
    @@ -29917,24 +30021,24 @@ class="cmtt-10">first
    -

    -

    See the documented code (

    +

    See the documented code (glossaries-code.pdf) for further details. I recommend that you also read the accsupp documentation. See also the documentation. See also the accessibility and and tagpdf packages. + id="dx1-176088"> packages.

    -

    -

    +

    Top

    18. Sample Documents

    -

    The

    The glossaries package is provided with some sample documents that illustrate the various functions. These should be located in the samples subdirectory (folder) of the texdoc to locate the main glossaries documentation. For example, in a terminal or command prompt, type: -

    
    +

    
        
    texdoc -l glossaries

    @@ -29952,20 +30056,20 @@ This should display a list of all the files in the glossaries documentation directory with their full pathnames. (The GUI version of texdoc may also provide you with the information.) -

    If you can’t find the sample files on your computer, they are also available from your nearest CTAN mirror +

    If you can’t find the sample files on your computer, they are also available from your nearest CTAN mirror at http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/. Each sample file listed below has a hyperlink to the file’s location on the CTAN mirror. -

    The

    The glossaries-extra package and bib2gls provide some additional sample files. There are also examples in + id="dx1-177001"> provide some additional sample files. There are also examples in the Dickimaw Books Gallery. -

    If you prefer to use

    If you prefer to use UTF-8 aware engines (xelatex or lualatex) remember that you’ll need to switch from @@ -29973,42 +30077,42 @@ class="cmtt-10">lualatex) remember that you’ll need to switch from class="cmss-10">fontenc & inputenc to fontspec where appropriate. -

    If you get any errors or unexpected results, check that you have up-to-date versions of all the required +

    If you get any errors or unexpected results, check that you have up-to-date versions of all the required packages. (Search the log file for lines starting with “Package: ”.) Where hyperref is loaded you will get + id="dx1-177002"> is loaded you will get warnings about non-existent references that look something like:

    -
    +   
     pdfTeX warning (dest): name{glo:aca} has been
     referenced but does not exist, replaced by a fixed one
     
    -

    These warnings may be ignored on the first LaTeX run. (The destinations won’t be defined until the glossary +

    These warnings may be ignored on the first LaTeX run. (The destinations won’t be defined until the glossary has been created.)

    -

    Top

    18.1 Basic

    -

    + id="x1-178001r1"> +

    🔗minimalgls.tex

    -

    This document is a minimal working example. You can test your installation using this file. To create the +

    This document is a minimal working example. You can test your installation using this file. To create the complete document you will need to do the following steps:

    1. -

      Run +

      Run minimalgls.tex through LaTeX either by typing -

      
      +     

      
            
      pdflatex minimalgls

      @@ -30016,21 +30120,21 @@ class="cmtt-10">minimalgls.tex through LaTeX either by typing create the required associated files but you will not see the glossary in the document.

    2. -

      If you have Perl installed, run +

      If you have Perl installed, run makeglossaries on the document ( on the document (§??sec:makeglossaries 1.5 Generating the Associated Glossary Files). This can be done on a terminal by typing: -

      
      +     

      
            
      makeglossaries minimalgls

      otherwise do: -

      
      +     

      
                                                                                             
                                                                                             
            
      makeglossaries-lite minimalgls @@ -30039,73 +30143,73 @@ href="#sec:makeglossaries">Generating the If for some reason you want to call makeindex explicitly, you can do this in a terminal by typing (all on + id="dx1-179006"> explicitly, you can do this in a terminal by typing (all on one line): -

      
      +     

      
            
      makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo

      See §??sec:makeindexapp 1.5.4 Using makeindex explicitly (Option 2) for further details on using explicitly (Option 2) for further details on using makeindex + id="dx1-179008"> explicitly. -

      Note that if the file name contains spaces, you will need to use the double-quote character to delimit the +

      Note that if the file name contains spaces, you will need to use the double-quote character to delimit the name.

    3. -

      Run +

      Run minimalgls.tex through LaTeX again (as step 1)

    -

    You should now have a complete document. The number following each entry in the glossary is the location +

    You should now have a complete document. The number following each entry in the glossary is the location number. By default, this is the page number where the entry was referenced. -

    The

    The acronym package option creates a second glossary with the label package option creates a second glossary with the label acronym (which can be referenced with \acronymtype). If you decide to enable this option then there will be a second set of glossary files that need to be processed by makeindex. If you use . If you use makeglossaries or or makeglossaries-lite you don’t need to worry + id="dx1-179014"> you don’t need to worry about it, as those scripts automatically detect which files need to be processed and will run makeindex (or + id="dx1-179015"> (or xindy) the appropriate number of times. -

    If for some reason you don’t want to use ) the appropriate number of times. +

    If for some reason you don’t want to use makeglossaries or or makeglossaries-lite and you want the + id="dx1-179018"> and you want the acronym package option then the complete build process is: -

    
    + id="dx1-179019"> package option then the complete build process is:
    +

    
        
    pdflatex minimalgls
    makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo
    makeindex -s minimalgls.ist -t minimalgls.alg -o minimalgls.acr minimalgls.acn
    pdflatex minimalgls

    -

    There are three other files that can be used as

    There are three other files that can be used as minimal working examples: mwe-gls.tex, mwe-acr.tex and mwe-acr-desc.tex. -



    glossaries-extraIf you want to try out the }

    Note the different default package options. (You may omit the acronym package option in both cases if + id="dx1-179020"> package option in both cases if you only want a single glossary.) The glossaries-extra package internally loads the base glossaries-extra load glossaries). -

    Next, replace:

    +

    Next, replace:

    \setacronymstyle{long-short} @@ -30161,35 +30265,35 @@ class="cmtt-10">\setacronymstyle{long-short}
    \setabbreviationstyle[acronym]{long-short}
    The optional argument acronym identifies the category that this style should be applied to. The identifies the category that this style should be applied to. The \newacronym command provided by the base glossaries package is redefined by glossaries-extra to use \newabbreviation with + id="dx1-179023"> with the category set to acronym. -

    If you prefer to replace . +

    If you prefer to replace \newacronym with \newabbreviation then the default category is then the default category is abbreviation so the + id="dx1-179026"> so the style should instead be:

    \setabbreviationstyle[abbreviation]{long-short} @@ -30199,38 +30303,38 @@ class="cmtt-10">]{long-short}
    \setabbreviationstyle{long-short}
    The long-short style is the default for the style is the default for the abbreviation category so you can omit this line completely if you + id="dx1-179030"> category so you can omit this line completely if you replace \newacronym. (The default style for the acronym category is category is short-nolong, which only shows the short + id="dx1-179032">, which only shows the short form on first use.) -

    As mentioned earlier, the

    As mentioned earlier, the acronym package option creates a new glossary with the label package option creates a new glossary with the label acronym. This is independent of the acronym category. You can use the category. You can use the acronym package option with either package option with either \newacronym or \newabbreviation. -

    You may instead prefer to use the . +

    You may instead prefer to use the abbreviations package option, which creates a new glossary with the label + id="dx1-179037"> package option, which creates a new glossary with the label abbreviations:

    @@ -30250,47 +30354,47 @@ class="cmtt-10">}
    This can again be used with either \newacronym or \newabbreviation, but the file extensions are different. + id="dx1-179038">, but the file extensions are different. This isn’t a problem if you are using makeglossaries or or makeglossaries-lite. If you are explicitly calling + id="dx1-179040">. If you are explicitly calling makeindex (or (or xindy) then you need to modify the file extensions. See the ) then you need to modify the file extensions. See the glossaries-extra user manual for further details. -

    If you use both the

    If you use both the acronym and and abbreviations package options then package options then \newacronym will default to the acronym glossary and \newabbreviation will default to the will default to the abbreviations glossary. -

    bib2glsIf you want to try If you want to try bib2gls, you first need to convert the document to use , you first need to convert the document to use glossaries-extra as described above. Then add the record package option. For example:

    + id="dx1-179048"> package option. For example:

    \usepackage[}
    Next you need to convert the entry definitions into the bib format required by format required by bib2gls. This can easily be + id="dx1-179050">. This can easily be done with convertgls2bib. For example: -

    
    + id="dx1-179051">. For example:
    +

    
        
    convertgls2bib --preamble-only minimalgls.tex entries.bib

    @@ -30327,10 +30431,10 @@ class="cmtt-10">\makeglossaries
    \GlsXtrLoadResources[src=entries] @@ -30341,74 +30445,74 @@ class="cmtt-10">\newglossaryentry and \newacronym or \newabbreviation). -

    The abbreviation style command must go before

    The abbreviation style command must go before \GlsXtrLoadResources. For example (if you are using + id="dx1-179054">. For example (if you are using \newacronym):

    \setabbreviationstyle[acronym]{long-short}
    \GlsXtrLoadResources[src=entries]
    Finally, replace: -
    +   
     \printglossaries
     
    -

    with:

    +

    with:

    \printunsrtglossaries + id="dx1-179058">
    The document build is now: -

    
    +

    
        
    pdflatex minimalgls
    bib2gls minimalgls
    pdflatex minimalgls

    -

    + id="x1-179059r2"> +

    🔗sampleDB.tex

    -

    This document illustrates how to load external files containing the glossary definitions. It also illustrates how to +

    This document illustrates how to load external files containing the glossary definitions. It also illustrates how to define a new glossary type. This document has the number list suppressed and uses suppressed and uses \glsaddall to add all the + id="dx1-180002"> to add all the entries to the glossaries without referencing each one explicitly. (Note that it’s more efficient to use glossaries-extra and bib2gls if you have a large number of entries.) To create the document + id="dx1-180003"> if you have a large number of entries.) To create the document do: -

    
    +

    
        
    pdflatex sampleDB
    makeglossaries sampleDB
    pdflatex sampleDB

    or -

    
    +

    
        
    pdflatex sampleDB
    makeglossaries-lite sampleDB
    pdflatex sampleDB @@ -30422,45 +30526,45 @@ class="cmtt-10">database2.tex
    . If for some reason you want to call makeindex explicitly you must have a separate call for each + id="dx1-180004"> explicitly you must have a separate call for each glossary:

    1. -

      Create the main glossary (all on one line): -

      
      +  class="enumerate" id="x1-180006x1">
      +     

      Create the main glossary (all on one line): +

      
            
      makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo

    2. -

      Create the secondary glossary (all on one line): -

      
      +  class="enumerate" id="x1-180008x2">
      +     

      Create the secondary glossary (all on one line): +

      
            
      makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn

      Note that both makeglossaries and and makeglossaries-lite do this all in one call, so they not only make + id="dx1-180010"> do this all in one call, so they not only make it easier because you don’t need to supply all the switches and remember all the extensions but they also call makeindex the appropriate number of times.

    -

    the appropriate number of times.

    +

    bib2glsIf you want to switch to using If you want to switch to using bib2gls with with glossaries-extra, you can convert database1.tex and href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/database2.tex" >database2.tex to bib files using files using convertgls2bib: -

    
    + id="dx1-180015">:
    +

    
        
    convertgls2bib database1.tex database1.bib
    convertgls2bib database2.tex database2.bib
    @@ -30496,16 +30600,16 @@ class="cmtt-10">}


    \newglossary*{punc}{Punctuation Characters}

    \GlsXtrLoadResources[src={database1},
     selection=all,sort=en]
    \GlsXtrLoadResources[src={database2},type=punc, @@ -30532,7 +30636,7 @@ class="cmtt-10">selection=all
    ,sort=letter-case]

    \end{document}
    Note that the nonumberlist package option has been omitted. It’s not needed because there are no + id="dx1-180023"> package option has been omitted. It’s not needed because there are no locations in this amended document (whereas in the original sampleDB.tex locations are created with \glsaddall). The starred \newglossary* is used since the is used since the makeindex//xindy extensions are now + id="dx1-180026"> extensions are now irrelevant. -

    Instead of using

    Instead of using makeglossaries you need to use you need to use bib2gls when you build the document: -

    
    + id="dx1-180028"> when you build the document:
    +

    
        
    pdflatex sampleDB
    bib2gls sampleDB
    pdflatex sampleDB @@ -30577,30 +30681,30 @@ class="cmtt-10">bib2gls
    bib2gls call processes all the indexing (rather than one call per glossary). Unlike call processes all the indexing (rather than one call per glossary). Unlike makeindex and + id="dx1-180030"> and xindy, , bib2gls processes each resource set in turn, but the resource sets aren’t linked to a specific glossary. + id="dx1-180032"> processes each resource set in turn, but the resource sets aren’t linked to a specific glossary. Multiple glossaries may be processed in a single resource set or sub-blocks of a single glossary may be processed by multiple resource sets. In this example, there happens to be one resource set per glossary because each glossary requires a different sort method. (A locale-sensitive alphabetical sort for the first and a character code sort for the second.) -

    If you want letter groups, you need to use the

    If you want letter groups, you need to use the --group switch: -

    
    + id="dx1-180033"> switch:
    +

    
        
    bib2gls --group sampleDB

    and use an appropriate glossary style. -

    See also

    See also bib2gls gallery: sorting, glossaries-extra and bib2gls: An Introductory Guide and the bib2gls user + id="dx1-180034"> user manual. -

    +

    -

    Top

    18.2 Acronyms and First Use

    -

    + id="x1-181001r3"> +

    🔗sampleAcr.tex

    -

    This document has some sample abbreviations. It also adds the glossary to the table of contents, so an extra run +

    This document has some sample abbreviations. It also adds the glossary to the table of contents, so an extra run through LaTeX is required to ensure the document is up to date: -

    
    +

    
                                                                                           
                                                                                           
        
    pdflatex sampleAcr @@ -30637,25 +30741,25 @@ through LaTeX is required to ensure the document is up to date: (or use makeglossaries-lite). -

    Note that if the glossary is at the start of the document and spans across multiple pages, then this can cause + id="dx1-182001">). +

    Note that if the glossary is at the start of the document and spans across multiple pages, then this can cause the locations to be shifted. In that case, an extra makeglossaries and LaTeX call are required. In + id="dx1-182002"> and LaTeX call are required. In this particular example, the glossary is at the end of the document so it’s not a problem. It’s also not a problem for a glossary at the start of the document if the page numbering is reset at the end of the glossary. For example, if the glossary is at the end of the front matter in a book-style document. -

    This document uses

    This document uses \ifglsused to determine whether to use “a” or “an” in:

    + id="dx1-182003"> to determine whether to use “a” or “an” in:

     is \ifglsused{svm}{an}{a} \gls{svm} 
    This clumsy bit of code can be tidied up with the glossaries-prefix package. Since that package automatically + id="dx1-182005"> package. Since that package automatically loads glossaries and passes all its options to the base package it’s possible to do a simple replacement of: -
    +   
     \usepackage[style=long,toc]{glossaries}
     
    -

    with:

    +

    with:

    \usepackage[style=long,toc]{svm now needs an adjustment:
    \newacronym[description={statistical pattern recognition @@ -30692,7 +30796,7 @@ class="cmtt-10"> recognition class="cmtt-10">technique~\protect\cite{svm}},
    prefixfirst={a~},prefix={an\space}
    ]{svm}{svm}{support machine} class="cmtt-10">… is \pgls{svm} 
    -



    glossaries-extraIf you want to convert this sample document to use glossaries-extra, you may want the patched version of the styles provided in glossary-long, in which case you can also add , in which case you can also add stylemods: + id="dx1-182010">:

    }
    If you want to suppress all the other glossary style packages with nostyles, then you need to specify exactly + id="dx1-182011">, then you need to specify exactly which package (or packages) that you do want:
    ,style=long]{glossaries-extra} href="#glo:glossaries-extra">glossaries-extra is being used, there are more available “long” styles in the glossary-longextra package, + id="dx1-182012"> package, which you may prefer.) -

    If you want to use

    If you want to use glossaries-prefix, you can either load it after , you can either load it after glossaries-extra or (with at least glossaries-extra v1.42) you can simply use the prefix package option. -

    Note that the package option. +

    Note that the toc package option has been dropped. This is the default with package option has been dropped. This is the default with glossaries-extra, so it doesn’t need to be specified now. The document build is now shorter: -

    
    +

    
        
    pdflatex sampleAcr
    makeglossaries sampleAcr
    pdflatex sampleAcr @@ -30779,115 +30883,115 @@ href="#glo:glossaries-extra">glossaries-extra provides boilerplate text on the first LaTeX call when the glossary files are missing. This means that the glossary header is added to the toc file on the first LaTeX call, whereas with just the base file on the first LaTeX call, whereas with just the base glossaries package, the header isn’t present until the second LaTeX call. (As with just the base glossaries package, if the glossary occurs at the start of the document without a page reset after it then part of the build process needs repeating to ensure all referenced page numbers are up-to-date. This problem isn’t specific to the glossaries + id="dx1-182017"> package.) -

    The other different default setting is the post-description punctuation. The base package has

    The other different default setting is the post-description punctuation. The base package has nopostdot=false + id="dx1-182018"> as the default. This means that a full stop (period) is automatically inserted after the description in the glossary. The extension package has nopostdot=true as the default. If you want the original behaviour then you + id="dx1-182019"> as the default. If you want the original behaviour then you can use nopostdot=false or the shorter synonym or the shorter synonym postdot. -

    The . +

    The glossaries-extra package has different abbreviation handling that’s far more flexible than that provided by the base glossaries package. The style now needs to be set with \setabbreviationstyle instead of + id="dx1-182022"> instead of \setacronymstyle:

    + id="dx1-182023">:

    \setabbreviationstyle[acronym]{long-short-sc}
    \newacronym{svm}{svm}{support vector machine}
    (Note the different style name long-short-sc instead of instead of long-sc-short and the optional argument and the optional argument acronym.) If + id="dx1-182028">.) If you prefer to replace \newacronym with with \newabbreviation then omit the optional argument: + id="dx1-182030"> then omit the optional argument:
    \setabbreviationstyle{long-short-sc}
    \newabbreviation{svm}{svm}{support vector machine}
    (The optional argument of \setabbreviationstyle is the category to which the style should be + id="dx1-182033"> is the category to which the style should be applied. If it’s omitted, abbreviation is assumed. You can therefore have different styles for different + id="dx1-182034"> is assumed. You can therefore have different styles for different categories.) -

    Finally, you need to replace

    Finally, you need to replace \acrshort, , \acrlong and and \acrfull and their variants with and their variants with \glsxtrshort, + id="dx1-182038">, \glsxtrlong and and \glsxtrfull etc. + id="dx1-182040"> etc. + id="x1-182041r4"> -

    +

    🔗sampleAcrDesc.tex

    -

    This is similar to the previous example, except that the abbreviations have an associated description. As with +

    This is similar to the previous example, except that the abbreviations have an associated description. As with the previous example, the glossary is added to the table of contents, so an extra run through LaTeX is required: -

    
    +

    
        
    pdflatex sampleAcrDesc
    makeglossaries sampleAcrDesc
    pdflatex sampleAcrDesc @@ -30896,21 +31000,21 @@ required:
    This document uses the acronym package option, which creates a new glossary used by package option, which creates a new glossary used by \newacronym. This leaves the default main glossary available for general terms. However, in this case there are no general terms so the main glossary is redundant. The nomain package option will prevent its creation. Obviously, if you decide to + id="dx1-183002"> package option will prevent its creation. Obviously, if you decide to add some terms with \newglossaryentry you will need to remove the nomain option as the option as the main glossary will now be required. -



    glossaries-extraAs with the previous example, if you want to convert this document to use glossaries-extra in the \usepackage argument. Again you can omit toc as this is the default for as this is the default for glossaries-extra. As in the previous example, you may want to use the patched styles. This document uses altlist which is provided by which is provided by glossary-list, so + id="dx1-183006">, so the style can be patched with stylemods.

    + id="dx1-183007">.

    \usepackage[acronym,nomain,style=altlist}
    You may prefer to replace the acronym option with option with abbreviations, but this will change the file + id="dx1-183009">, but this will change the file extensions. If you use makeglossaries or or makeglossaries-lite you don’t need to worry about + id="dx1-183011"> you don’t need to worry about it. -

    Again the style command needs to be changed:

    +

    Again the style command needs to be changed:

    \setabbreviationstyle[acronym]{long-short-sc-desc}
    (Note the change in style name long-short-sc-desc instead of instead of long-sc-short-desc and the optional argument + id="dx1-183014"> and the optional argument acronym.) -

    As with the previous example, if you prefer to use .) +

    As with the previous example, if you prefer to use \newabbreviation instead of instead of \newacronym then you need + id="dx1-183017"> then you need to omit the optional argument:

    \setabbreviationstyle{long-short-sc-desc} @@ -30987,44 +31091,44 @@ class="cmtt-10">{long-short-sc-desc}
    \renewcommand*{\glsseeitemformat}[1]{%
     \acronymfont{\glsentrytext{#1}}}
    to ensure that the cross-references (from the see key) use the acronym font. The new abbreviation styles don’t + id="dx1-183022"> key) use the acronym font. The new abbreviation styles don’t use \acronymfont so this isn’t appropriate with so this isn’t appropriate with glossaries-extra. If you’re using at least version 1.42 of glossaries-extra, you don’t need to do anything as it automatically redefines \glsseeitemformat to take the + id="dx1-183024"> to take the style formatting into account. If you have an earlier version you can redefine this command as follows:
    \renewcommand*{\glsseeitemformat}[1]{%
     \ifglshasshort{#1}{\glsfmttext{#1}}{\glsfmtname{#1}}%
    } @@ -31034,29 +31138,29 @@ short and long form) you can use:
    \renewcommand*{\glsseeitemformat}[1]{\glsfmtname{#1}}
    -

    The

    The glossaries-extra package provides two additional cross-referencing keys seealso and and alias, so , so see={[see also]{svm}} can be replaced with a more appropriate key:

    \newacronym[description={Statistical pattern recognition @@ -31068,7 +31172,7 @@ class="cmtt-10"> ``kernel trick''},
    seealso={svm},
     vector machine}
    -

    Finally, as with the previous example, you need to replace

    Finally, as with the previous example, you need to replace \acrshort, , \acrlong and and \acrfull etc with + id="dx1-183038"> etc with \glsxtrshort, , \glsxtrlong and and \glsxtrfull etc. -

    etc. +

    bib2glsIf you want to convert this document so that it uses If you want to convert this document so that it uses bib2gls, you first need to convert it to use + id="dx1-183043">, you first need to convert it to use glossaries-extra, as above, but remember that you now need the record option:

    + id="dx1-183044"> option:

    @@ -31122,26 +31226,26 @@ class="cmtt-10">}
    Now you need to convert the abbreviation definitions to the bib format required by format required by bib2gls. This can be done + id="dx1-183046">. This can be done with: -

    
    +

    
        
    convertgls2bib --preamble-only sampleAcrDesc.tex entries.bib

    If you retained \newacronym from the original example file, then the new from the original example file, then the new entries.bib file will contain entries defined with @acronym. For example:

    + id="dx1-183048">. For example:

    @acronym{ksvm,
     }
    If you switched to \newabbreviation then the entries will instead be defined with then the entries will instead be defined with @abbreviation. -

    Next replace . +

    Next replace \makeglossaries with the resource command, but note that the abbreviation style must be set first:

    \setabbreviationstyle[acronym]{long-short-sc-desc}
    \GlsXtrLoadResources[src=entries,% terms defined]
    Another possibility is to make @acronym behave as though it was actually behave as though it was actually @abbreviation:
    + id="dx1-183056">:
    \setabbreviationstyle{long-short-sc-desc}
    \GlsXtrLoadResources[src=entries,abbreviation-sort-fallback=long,
    ]
    Note that the category is now abbreviation not not acronym so the optional argument of so the optional argument of \setabbreviationstyle + id="dx1-183063"> needs adjusting. -

    If the

    If the sort field is missing (which should usually be the case), then both field is missing (which should usually be the case), then both @acronym and and @abbreviation will + id="dx1-183066"> will fallback on the short field (not the field (not the name field, which is usually set by the style and therefore not visible to + id="dx1-183068"> field, which is usually set by the style and therefore not visible to bib2gls). For some styles, as in this example, it’s more appropriate to sort by the long form so the fallback is + id="dx1-183069">). For some styles, as in this example, it’s more appropriate to sort by the long form so the fallback is changed. (Remember that you will break this fallback mechanism if you explicitly set the sort value.) See the bib2gls manual for further details and other examples. -

    Remember to delete any manual for further details and other examples. +

    Remember to delete any \newacronym or \newabbreviation in the tex file. Finally replace file. Finally replace \printglossary with \printunsrtglossary. The document build is now: -

    
    + id="dx1-183072">. The document build is now:
    +

    
        
    pdflatex sampleAcrDesc
    bib2gls sampleAcrDesc
    pdflatex sampleAcrDesc

    -

    Note that it’s now much easier to revert back to the descriptionless style used in

    Note that it’s now much easier to revert back to the descriptionless style used in sampleAcr.tex:

    \setabbreviationstyle[acronym]{long-short-sc}
    \GlsXtrLoadResources[src=entries,ignore-fields=description]
    With the other options it would be necessary to delete all the description fields from the abbreviation + id="dx1-183077"> fields from the abbreviation definitions in order to omit them, but with bib2gls you can simply instruct you can simply instruct bib2gls to ignore the description. + id="dx1-183079"> to ignore the description. This makes it much easier to have a large database of abbreviations for use across multiple documents that may or may not require the description. -

    + id="x1-183080r5"> +

    🔗sampleDesc.tex

    -

    This is similar to the previous example, except that it defines the abbreviations using

    This is similar to the previous example, except that it defines the abbreviations using \newglossaryentry + id="dx1-184001"> instead of \newacronym. As with the previous example, the glossary is added to the table of contents, so an + id="dx1-184002">. As with the previous example, the glossary is added to the table of contents, so an extra run through LaTeX is required: -

    
    +

    
        
    pdflatex sampleDesc
    makeglossaries sampleDesc
    pdflatex sampleDesc @@ -31340,14 +31444,14 @@ extra run through LaTeX is required:
    This sample file demonstrates the use of the first and and text keys but in general it’s better to use keys but in general it’s better to use \newacronym + id="dx1-184005"> instead as it’s more flexible. For even greater flexibility use \newabbreviation provided by provided by glossaries-extra. For other variations, such as showing the symbol on glossaries-extra and bib2gls: An Introductory Guide. + id="x1-184007r6"> -

    +

    🔗sampleFnAcrDesc.tex

    -

    This document has some sample abbreviations that use the

    This document has some sample abbreviations that use the footnote-sc-desc acronym style. As with the + id="dx1-185001"> acronym style. As with the previous example, the glossary is added to the table of contents, so an extra run through LaTeX is required: -

    
    +

    
        
    pdflatex sampleFnAcrDesc
    makeglossaries sampleFnAcrDesc
    pdflatex sampleFnAcrDesc @@ -31388,30 +31492,30 @@ the same steps as for sampleAcr.tex with a slight modification. This time the short-sc-footnote-desc + id="dx1-185002"> abbreviation style is needed:

    \setabbreviationstyle[acronym]{short-sc-footnote-desc}
    The command redefinitions (performed with \renewcommand) should now all be deleted as they are no longer applicable. -

    You may prefer to use the

    You may prefer to use the short-sc-postfootnote-desc style instead. There are subtle differences between the + id="dx1-185004"> style instead. There are subtle differences between the postfootnote and and footnote set of styles. Try changing the abbreviation style to set of styles. Try changing the abbreviation style to short-sc-footnote and compare the + id="dx1-185007"> and compare the location of the footnote marker with the two styles. -

    This modified sample file now has a shorter build: -

    
    +

    This modified sample file now has a shorter build: +

    
        
    pdflatex sampleFnAcrDesc
    makeglossaries sampleFnAcrDesc
    pdflatex sampleFnAcrDesc @@ -31422,18 +31526,18 @@ href="#glo:glossaries-extra">glossaries-extra package produces boilerplate text when the glossary file is missing (on the first LaTeX run) which adds the glossary title to the table of contents (toc) file. + id="dx1-185008">) file. -

    + id="x1-185009r7"> +

    🔗sampleCustomAcr.tex

    -

    This document has some sample abbreviations with a custom acronym style. It also adds the glossary to the +

    This document has some sample abbreviations with a custom acronym style. It also adds the glossary to the table of contents, so an extra run through LaTeX is required: -

    
    +

    
        
    pdflatex sampleCustomAcr
    makeglossaries sampleCustomAcr @@ -31449,15 +31553,15 @@ class="cmti-10">short
    ⟩ (⟨long⟩), and the sort key is set to the long form instead of the short form. On key is set to the long form instead of the short form. On first use, the footnote text is in the form ⟨long⟩: ⟨description⟩ (instead of just the long form). This requires defining a new acronym style that inherits from the footnote-sc-desc style. -


    style. +


    glossaries-extraThe conversion to }

    The abbreviation styles have associated helper commands that may be redefined to make minor modifications. These redefinitions should be done before the abbreviations are defined. -

    The

    The short-sc-footnote-desc abbreviation style is the closest match to the requirement, so replace the + id="dx1-186003"> abbreviation style is the closest match to the requirement, so replace the \setacronymstyle command with:

    \setabbreviationstyle[acronym]{short-sc-footnote-desc}
    Again, you may prefer short-sc-postfootnote-desc. Both styles use the same helper commands. -

    Next some adjustments need to be made to fit the new requirements. The name needs to be ⟨. Both styles use the same helper commands. +

    Next some adjustments need to be made to fit the new requirements. The name needs to be ⟨long⟩ (⟨short⟩):

    @@ -31500,35 +31604,35 @@ class="cmti-10">short⟩): \renewcommand*{\glsxtrfootnotedescname}{%
      \protect\glslongfont{\the\glslongtok}%
      \protect\glsxtrfullsep{\the\glslabeltok}%
      \protect\glsxtrparen{\protect\glsabbrvfont{\the\glsshorttok}}%
    \renewcommand*{\glsxtrfootnotedescsort}{\the\glslongtok
    } @@ -31554,7 +31658,7 @@ class="cmtt-10">}
    \glsxtrabbrvfootnote{label}{\glspl etc). This can simply be redefined as:
    \renewcommand*{\glsxtrabbrvfootnote}[2]{\footnote{%
      #2: \glsentrydesc{#1}}}
    This will mimic the result from the original sample document. -

    You may prefer to replace

    You may prefer to replace #2 with a reference to a specific field (or fields). For example:

    \renewcommand*{\glsxtrabbrvfootnote}[2]{\footnote{%
     \Glsfmtlong{#1} (\glsfmtshort{#1}): \glsentrydesc{#1}.}}
    As with the earlier sampleAcrDesc.tex, you need to remove or change the redefinition of \glsseeitemformat + id="dx1-186025"> since \acronymfont is no longer appropriate. -

    In the original

    In the original sampleCustomAcr.tex source code, I started the description with a capital:

    -
    +   
     \newacronym[description={Statistical pattern recognition
     technique using the ``kernel trick''},
     see={[see also]{svm}},
     ]{ksvm}{ksvm}{kernel support vector machine}
     
    -

    This leads to a capital letter after the colon in the footnote, which is undesirable, but I would like to +

    This leads to a capital letter after the colon in the footnote, which is undesirable, but I would like to have the description start with a capital in the glossary. The solution to this problem is easy with glossaries-extra. I start the description with a lowercase letter and set the glossdesc attribute to attribute to firstuc:

    \glssetcategoryattribute{acronym}{glossdesc}{firstuc}
    The abbreviation definitions are modified slightly:
    \newacronym[description={statistical ``kernel trick''},
    seealso={svm},
     machine}
    Note the use of the seealso key, which is only available with key, which is only available with glossaries-extra. -

    If you prefer to use

    If you prefer to use \newabbreviation instead of instead of \newacronym, then the category needs to be , then the category needs to be abbreviation + id="dx1-186033"> rather than acronym:

    + id="dx1-186034">:

    \glssetcategoryattribute{abbreviation}{glossdesc}{firstuc} @@ -31693,23 +31797,23 @@ class="cmtt-10">}{glossdesc}{firstuc}
    \setabbreviationstyle{short-sc-postfootnote-desc}
    + id="x1-186037r8"> -

    +

    🔗sample-FnDesc.tex

    -

    This example defines a custom display format that puts the description in a footnote on

    This example defines a custom display format that puts the description in a footnote on first use. -

    
    +

    
        
    pdflatex sample-FnDesc
    makeglossaries sample-FnDesc
    pdflatex sample-FnDesc @@ -31719,26 +31823,26 @@ In order to prevent nested hyperlinks, this document uses the hyperfirst=false package option (otherwise the + id="dx1-187001"> package option (otherwise the footnote marker hyperlink would be inside the hyperlink around the link text which would result in a nested + id="dx1-187002"> which would result in a nested hyperlink). -



    glossaries-extraThe glossaries-extra package has category post-link hooks that make it easier to adjust the formatting. The post-link hook is placed after the hyperlink around the link text, so a hyperlink created by + id="dx1-187003">, so a hyperlink created by \footnote in the post-link hook won’t cause a nested link. This means that the in the post-link hook won’t cause a nested link. This means that the hyperfirst=false option isn’t + id="dx1-187005"> option isn’t required:

    glossaries-extra}
    -

    Never use commands like

    Never use commands like \gls or \glsdesc in the post-link hook as you can end up with infinite recursion. Use commands that don’t themselves have a post-link hook, such as \glsentrydesc or \glossentrydesc, instead.
    -

    -

    In the original

    +

    In the original sample-FnDesc.tex file, the format was adjusted with:

    \renewcommand*{\glsentryfmt}{%
      \glsgenentryfmt + id="dx1-187007">
      \ifglsused{\glslabel}{}{\footnote{\glsentrydesc{\glslabel}}}%
    } @@ -31790,7 +31894,7 @@ class="cmtt-10">}
    \glsdefpostlink + id="dx1-187013">
    {general}% category label
    {\glsxtrifwasfirstuse{\footnote{\glsentrydesc{\glslabel}}}{}}
    This sets the post-link hook for the general category (which is the default category for entries defined with + id="dx1-187018"> category (which is the default category for entries defined with \newglossaryentry). If I added some abbreviations (which have a different category) then this change wouldn’t + id="dx1-187019">). If I added some abbreviations (which have a different category) then this change wouldn’t apply to them. -

    The first paragraph in the document is: +

    The first paragraph in the document is:

    -
    +   
     First use: \gls{sample}.
     
    -

    So the PDF will have the word “sample” (the

    So the PDF will have the word “sample” (the link text created by created by \gls{sample}) as a hyperlink to the entry in the glossary followed by the footnote marker, which is a hyperlink to the footnote. This is then followed by the sentence terminator. “First use: sample1.” -

    It would look tidier if the footnote marker could be shifted after the full stop. “First use: sample.

    It would look tidier if the footnote marker could be shifted after the full stop. “First use: sample.1” This can easily be achieved with a minor modification:

    \glsdefpostlink + id="dx1-187021">
    {general}% category label
    {\glsxtrifwasfirstuse + id="dx1-187022">
     {\glsxtrdopostpunc{\footnote{\glsentrydesc{\glslabel}}}}%
     {}% @@ -31863,26 +31967,26 @@ class="cmtt-10">}
    You may prefer to use \glossentrydesc instead of instead of \glsentrydesc. This will obey the . This will obey the glossdesc attribute. If + id="dx1-187029"> attribute. If you append \glspostdescription, you can also pick up the , you can also pick up the postdot package option. For example: + id="dx1-187031"> package option. For example:
    \glssetcategoryattribute{general}{glossdesc}{firstuc}

    \glsdefpostlink + id="dx1-187033">
    {general}% category label
    {\glsxtrifwasfirstuse + id="dx1-187034">
     {\glsxtrdopostpunc{\footnote{%
        \glossentrydesc{\glslabel}\glspostdescription
    }}}%
     {}% @@ -31918,20 +32022,20 @@ class="cmtt-10">}
    Alternatively, you could just use \Glsentrydesc and explicitly append the full stop. + id="dx1-187040"> and explicitly append the full stop. -

    + id="x1-187041r9"> +

    🔗sample-custom-acronym.tex

    -

    This document illustrates how to define your own acronym style if the predefined styles don’t suit your +

    This document illustrates how to define your own acronym style if the predefined styles don’t suit your requirements. -

    
    +

    
        
    pdflatex sample-custom-acronym
    makeglossaries sample-custom-acronym
    pdflatex sample-custom-acronym @@ -31941,36 +32045,36 @@ In this case, a style is defined to show the short form in the text with the lon footnote on first use. The long form is used for the sort value. The short form is displayed in value. The short form is displayed in small caps in the + id="dx1-188002"> in the main part of the document but in uppercase in the list of acronyms. (So it’s a slight variation of some of the examples above.) The name is set to the long form (starting with an initial capital) followed by the all caps short + id="dx1-188003"> is set to the long form (starting with an initial capital) followed by the all caps short form in parentheses. The final requirement is that the inline form should show the long form followed by the short form in parentheses. -



    glossaries-extraAs with sampleFnAcrDesc.tex, the short-sc-footnote-desc and and short-sc-postfootnote-desc + id="dx1-188005"> abbreviation styles produce almost the required effect so one of those can be used as a starting point. However the final requirement doesn’t fit. It’s now necessary to actually define a custom abbreviation style, but it can mostly inherit from the short-sc-footnote-desc or or short-sc-postfootnote-desc style: + id="dx1-188007"> style:

    \newabbreviationstyle{custom-fn}%
    {% @@ -31978,7 +32082,7 @@ class="cmtt-10">{%
    class="cmtt-10">  \GlsXtrUseAbbrStyleSetup{short-sc-footnote-desc}%
    }% @@ -31988,13 +32092,13 @@ class="cmtt-10">{%
    class="cmtt-10">  \GlsXtrUseAbbrStyleFmts{short-sc-footnote-desc}%
      \renewcommand*{\glsxtrinlinefullformat}[2]{%
        \glsfirstlongfootnotefont{\glsaccesslong{##1}%
       \ifglsxtrinsertinside##2\fi}%
        \ifglsxtrinsertinside\else##2\fi\glsxtrfullsep{##1}%
        \glsxtrparen{\glsfirstabbrvscfont{\glsaccessshort{##1}}}%
     }% class="cmtt-10"> 
     \renewcommand*{\glsxtrinlinefullplformat}[2]{%
        \glsfirstlongfootnotefont{\glsaccesslongpl{##1}%
       \ifglsxtrinsertinside##2\fi}%
        \ifglsxtrinsertinside\else##2\fi\glsxtrfullsep{##1}%
        \glsxtrparen{\glsfirstabbrvscfont{\glsaccessshortpl{##1}}}%
     }% class="cmtt-10"> 
     \renewcommand*{\Glsxtrinlinefullformat}[2]{%
        \glsfirstlongfootnotefont{\Glsaccesslong{##1}%
       \ifglsxtrinsertinside##2\fi}%
        \ifglsxtrinsertinside\else##2\fi\glsxtrfullsep{##1}%
        \glsxtrparen{\glsfirstabbrvscfont{\glsaccessshort{##1}}}%
     }% class="cmtt-10"> 
     \renewcommand*{\Glsxtrinlinefullplformat}[2]{%
        \glsfirstlongfootnotefont{\Glsaccesslongpl{##1}% @@ -32195,7 +32299,7 @@ class="cmtt-10">   \ifglsxtrinsertinside##2\fi}%
        \ifglsxtrinsertinside\else##2\fi\glsxtrfullsep{##1}%
        \glsxtrparen{\glsfirstabbrvscfont{\glsaccessshortpl{##1}}}%
    }
    (See the glossaries-extra user manual for further details.) -

    This new custom style now needs to be set:

    +

    This new custom style now needs to be set:

    \setabbreviationstyle[acronym]{custom-fn}
    Remember that if you decide to use \newabbreviation instead of instead of \newacronym then the category will be + id="dx1-188049"> then the category will be abbreviation not not acronym:
    + id="dx1-188051">:
    \setabbreviationstyle{custom-fn}
    This custom style simply adjusts the inline full form. There are other adjustments to be made that apply to the @@ -32263,13 +32367,13 @@ long form followed by the description. This is the same as the modification to a \renewcommand*{\glsxtrabbrvfootnote}[2]{\footnote{#2:
    \glsentrydesc{#1}.}}
    As with \renewcommand*{\glsxtrabbrvfootnote}[2]{\footnote + id="dx1-188057">
     {\Glsfmtlong{#1}: \glsentrydesc{#1}.}}
    -

    The

    The name now needs to be the long form followed by the short form in parentheses, but note the new + id="dx1-188060"> now needs to be the long form followed by the short form in parentheses, but note the new requirement that the short form should now be in all capitals not small caps and the long form should start with + id="dx1-188061"> and the long form should start with a capital letter.

    @@ -32306,68 +32410,68 @@ a capital letter.

    \renewcommand*{\glsxtrfootnotedescname}{%
      \protect\glsfirstlongfootnotefont + id="dx1-188063">
        {\makefirstuc{\the\glslongtok}}
      (\protect\MakeTextUppercase{\the\glsshorttok})%
    }
    The inherited abbreviation style uses the short form as the sort value by default. This needs to be changed to + id="dx1-188068"> value by default. This needs to be changed to the long form:
    \renewcommand*{\glsxtrfootnotedescsort}{\the\glslongtok}
    -

    If you want to switch to using

    If you want to switch to using bib2gls, remember to set the abbreviation style before the + id="dx1-188071">, remember to set the abbreviation style before the resource command and change the default sort fallback field to long, as with , as with sampleAcrDesc.tex.
    -

    +

    -

    + id="x1-188073r10"> +

    🔗sample-dot-abbr.tex

    -

    This document illustrates how to use the base post link hook to adjust the space factor after abbreviations. -

    
    +

    This document illustrates how to use the base post link hook to adjust the space factor after abbreviations. +

    
        
    pdflatex sample-dot-abbr
    makeglossaries sampledot-abbrf
    pdflatex sample-dot-abbr @@ -32377,9 +32481,9 @@ This example creates a custom storage key that provides a similar function to glossaries-extra’s category + id="dx1-189001">
    key. -



    glossaries-extraThis example is much simpler with

    \glsaddstoragekey{abbrtype}{word}{\abbrtype}
    can now be removed. -

    The

    The category key is set to key is set to initials for the initialisms (which are defined with the custom \newacr command). The abbreviation styles can be set with:

    @@ -32403,33 +32507,33 @@ command). The abbreviation styles can be set with:

    \setabbreviationstyle[acronym]{long-short}
    \setabbreviationstyle[initials]{long-short}
    The discardperiod attribute will discard any full stop (period) following commands like attribute will discard any full stop (period) following commands like \gls:
    \glssetcategoryattribute{initials}{discardperiod}{true}
    (If you want to use the noshortplural attribute then you will also need to set the attribute then you will also need to set the pluraldiscardperiod + id="dx1-189009"> attribute.) -

    The

    The first use is governed by the retainfirstuseperiod attribute. If set, the period won’t be discarded if it + id="dx1-189010"> attribute. If set, the period won’t be discarded if it follows the first use of commands like \gls. This is useful for styles where the first use doesn’t end with the short form. In this case, the first use of the long-short style ends with a closing parenthesis, so the end of + id="dx1-189011"> style ends with a closing parenthesis, so the end of sentence might be clearer if the period is retained:

    \glssetcategoryattribute{initials}{retainfirstuseperiod}{true}
    -

    The

    The insertdots attribute can automatically insert dots into the short form with a final space factor + id="dx1-189013"> attribute can automatically insert dots into the short form with a final space factor adjustment:

    \glssetcategoryattribute{initials}{insertdots}{true}
    -

    The custom helper command defined in the example needs to be slightly modified:

    +

    The custom helper command defined in the example needs to be slightly modified:

    \newcommand*{\newabbr}[1][]{%
     \newabbreviation[category=initials,#1]}
    The definitions need to be slightly modified to work with the insertdots attribute:
    + id="dx1-189016"> attribute:
    \newabbr{eg}{}{AGM}
    (This makes it much easier to change your mind if you decide at a later date to omit the dots, especially if you are storing all your definitions in a file that’s shared across multiple documents, but note the need to group “Sc”.) -

    The “laser” definition remains unchanged: +

    The “laser” definition remains unchanged:

    -
    +   
     \newacronym{laser}{laser}{light amplification by stimulated
     emission of radiation}
     
    -

    The remaining code in the preamble must now be removed. (It will interfere with

    The remaining code in the preamble must now be removed. (It will interfere with glossaries-extra’s category post-link hooks.) No change is required in the document body. -

    See the

    See the glossaries-extra user manual for further details about category attributes and post-link hooks. -

    + id="x1-189017r11"> +

    🔗sample-font-abbr.tex

    -

    This document illustrates how to have different fonts for abbreviations within the style. The document build +

    This document illustrates how to have different fonts for abbreviations within the style. The document build is: -

    
    +

    
        
    pdflatex sample-font-abbr
    makeglossaries sample-font-abbr
    pdflatex sample-font-abbr @@ -32537,35 +32641,35 @@ The acronym mechanism provided by the base glossaries package isn’t well suited to having a mixture of styles. This example provides a workaround that involves defining a new storage key with \glsaddstoragekey that’s + id="dx1-190001"> that’s used to hold the font declaration (such as \em).

    -
    +   
     \glsaddstoragekey{font}{}{\entryfont}
     
    -

    A new custom acronym style is defined that fetches the font information from this new key so that it can be +

    A new custom acronym style is defined that fetches the font information from this new key so that it can be applied to the abbreviation. Some helper commands are also provided to define the different types of abbreviation:

    -
    +   
     \newcommand*{\newitabbr}[1][]{\newacronym[font=\em,#1]}
     \newcommand*{\newupabbr}{\newacronym}
     \newitabbr{eg}{e.g.}{exempli gratia}
     \newupabbr{bsc}{BSc}{Bachelor of Science}
     
    -

    This makes the

    This makes the first use of \gls{eg} appear as “exempli gratia (e.g.)” whereas the first use of \gls{bsc} is “Bachelor of Science (BSc)”. -



    glossaries-extraThis example document is much simpler with }

    The custom storage key can now be removed and also the custom acronym style. Now replace the \setacronymstyle line with:
    + id="dx1-190002"> line with:
    \setabbreviationstyle[acronym]{long-short-em}
    and change the definition of the helper commands:
    \newcommand*{\newitabbr}{\newacronym}
    \newcommand*{\newupabbr}{\newabbreviation
    }
    Note that the font=\em, part has been removed from the definition of the first command and the second command uses \newabbreviation instead of instead of \newacronym. This means that . This means that \newitabbr will default to category=acronym and \newupabbr will default to category=abbreviation. The default style for the abbreviation category is category is long-short, which is the required style for this example. This just means that + id="dx1-190011">, which is the required style for this example. This just means that only the acronym category needs to have the style set (with the above category needs to have the style set (with the above \setabbreviationstyle + id="dx1-190013"> command). -

    Finally, the

    Finally, the \acrshort, , \acrlong and and \acrfull commands need to be replaced with \glsxtrshort, + id="dx1-190016">, \glsxtrlong and and \glsxtrfull. -

    You may notice that the spacing after “e.g.” and “i.e.” isn’t correct. This is similar to the . +

    You may notice that the spacing after “e.g.” and “i.e.” isn’t correct. This is similar to the sample-dot-abbr.tex example where the space factor needs adjusting. In this case I’ve inserted the dots manually (rather than relying on the insertdots attribute). You can either remove the dots and use attribute). You can either remove the dots and use insertdots with with discardperiod: + id="dx1-190021">:

    \glssetcategoryattribute{acronym}{insertdots}{true}
    \glssetcategoryattribute{acronym}{discardperiod}{true}

     est}
    Or you can manually insert the space factor adjustment and only use the discardperiod attribute: + id="dx1-190024"> attribute:
    \glssetcategoryattribute{acronym}{discardperiod}{true}

    \newitabbr{eg}{e.g.\@}{exempli gratia}
    \newitabbr{ie}{i.e.\@}{id est}
    -

    You don’t have to use the

    You don’t have to use the acronym category. You may prefer a different label that fits better semantically. + id="dx1-190028"> category. You may prefer a different label that fits better semantically. For example:

    \setabbreviationstyle[latinabbr]{long-short-em} @@ -32719,7 +32823,7 @@ class="cmtt-10">\newcommand*{\newlatinabbr}[1][]{\newabbreviation[category=latinabbr,#1]}
    \glssetcategoryattribute{latinabbr}{insertdots}{true}
    \glssetcategoryattribute{latinabbr}{discardperiod}{true} @@ -32743,7 +32847,7 @@ class="cmtt-10">\newlatinabbr{eg}{e.g.\@}{exempli gratia}
    \newlatinabbr{ie}{i.e.\@}{id est}
    -

    +

    -

    Top

    18.3 Non-Page Locations

    -

    + id="x1-191001r12"> +

    🔗sampleEq.tex

    -

    This document illustrates how to change the location to something other than the page number. In this case, +

    This document illustrates how to change the location to something other than the page number. In this case, the equation counter is used since all glossary entries appear inside an equation environment. To create the + id="dx1-192001"> environment. To create the document do: -

    
    +

    
        
    pdflatex sampleEq
    makeglossaries sampleEq
    pdflatex sampleEq @@ -32787,45 +32891,45 @@ document do: The glossaries package provides some location formats, such as \hyperrm and and \hyperbf, that allow the + id="dx1-192004">, that allow the locations in the number list to hyperlink to the appropriate place in the document (if to hyperlink to the appropriate place in the document (if hyperref has + id="dx1-192006"> has been used). Since it’s not possible to include the hyperlink name in the indexing information with makeindex and and xindy, the , the glossaries package has to reform the name from a prefix and the location value. -

    Unfortunately it’s not always possible to split the link name into a prefix and location. That happens with +

    Unfortunately it’s not always possible to split the link name into a prefix and location. That happens with the equation counter in certain classes, such as the report class (which is used in this example). This means that it’s necessary to redefine \theHequation so that it has a format that fits the + id="dx1-192009"> so that it has a format that fits the requirement:

    -
    +   
     \renewcommand*\theHequation{\theHchapter.\arabic{equation}}
     
    -

    If you don’t do this, the equation locations in the glossary won’t form valid hyperlinks. -

    Each glossary entry represents a mathematical symbol. This means that with Options 

    If you don’t do this, the equation locations in the glossary won’t form valid hyperlinks. +

    Each glossary entry represents a mathematical symbol. This means that with Options 13 it’s necessary to use the sort key. For example:

    + id="dx1-192010"> key. For example:

    \newglossaryentry{Gamma}{name=\ensuremath{\Gamma(z)}, @@ -32836,38 +32940,38 @@ class="cmtt-10">sort=Gamma}
    -

    bib2glsIf you want to switch to using If you want to switch to using bib2gls, the first change you need to make is to switch from + id="dx1-192012">, the first change you need to make is to switch from explicitly loading glossaries to loading glossaries-extra with the record package option. If package option. If record=only (or (or record + id="dx1-192015"> without a value) is used, then the above redefinition of \theHequation is still required. If record=nameref is used + id="dx1-192016"> is used instead then the redefinition of \theHequation isn’t required. You may also want to use the stylemods and + id="dx1-192017"> and postdot options:

    + id="dx1-192018"> options:

    \usepackage[}
    The entries now need to be converted into the bib format required by format required by bib2gls, which can be done with + id="dx1-192020">, which can be done with convertgls2bib: -

    
    + id="dx1-192021">:
    +

    
        
    convertgls2bib --preamble-only sampleEq.tex entries.bib

    @@ -32905,7 +33009,7 @@ class="cmtt-10"> Encoding: UTF-8
    @entry{Gamma,
     }
    You may prefer to change @entry to to @symbol. (This should be easy to do with your text editor’s search and + id="dx1-192024">. (This should be easy to do with your text editor’s search and replace function.) -

    Note that the

    Note that the sort key has been omitted. This is because it typically shouldn’t be used. The difference + id="dx1-192025"> key has been omitted. This is because it typically shouldn’t be used. The difference between using @entry and and @symbol is that with is that with @entry the sort value will be obtained from the the sort value will be obtained from the name but with + id="dx1-192029"> but with @symbol the sort value will be obtained from the label. If you explicitly use the the sort value will be obtained from the label. If you explicitly use the sort key then you will break + id="dx1-192031"> key then you will break this behaviour. (If you try this example out, notice the difference in the ordering if you switch between @entry + id="dx1-192032"> and @symbol. See also . See also bib2gls gallery: sorting.) -

    Next replace

    Next replace \makeglossaries with:

    \GlsXtrLoadResources[src=entries]
    If you have used record=nameref then you can remove the redefinition of then you can remove the redefinition of \theHequation. Next remove all the lines defining the glossary entries (since they’re now defined in the bib file). -

    Finally, replace file). +

    Finally, replace \printglossary with with \printunsrtglossary:

    + id="dx1-192039">:

    \printunsrtglossary[title={Index of SpecialNotations}]
    The rest of the document remains unchanged (unless you want to use \glsxtrfmt as described in the following + id="dx1-192041"> as described in the following example). -

    + id="x1-192042r13"> +

    🔗sampleEqPg.tex

    -

    This is similar to the previous example, but the

    This is similar to the previous example, but the number lists are a mixture of page numbers and + id="dx1-193001">s are a mixture of page numbers and equation numbers. This example adds the glossary to the table of contents, so an extra LaTeX run is required: -

    
    +

    
        
    pdflatex sampleEqPg
    makeglossaries sampleEqPg
    pdflatex sampleEqPg @@ -33019,55 +33123,55 @@ As with the previous example, entries are defined like this:

    -
    +   
     \newglossaryentry{Gamma}{name=\ensuremath{\Gamma(z)},
     description=Gamma function,sort=Gamma}
     
    -

    The

    The counter=equation package option is used to set the default indexing counter to package option is used to set the default indexing counter to equation. This means that it has to be changed for indexing outside of any numbered equation. For example:

    -
    +   
     \glslink[format=hyperbf,counter=page]{Gamma}{gamma function}
     
    -

    I’ve set the

    I’ve set the format to to hyperbf to indicate that this is a primary reference. (Note that I’m using to indicate that this is a primary reference. (Note that I’m using \hyperbf not + id="dx1-193005"> not \textbf in order to include a hyperlink in the location.) -

    The in order to include a hyperlink in the location.) +

    The link text here is almost identical to the description. The only difference is that the description starts + id="dx1-193007"> here is almost identical to the description. The only difference is that the description starts with a capital. If it started with a lowercase character instead, I could simply use \glsdesc instead of + id="dx1-193008"> instead of \glslink. If I change the entry descriptions so that they all start with a lowercase letter then I would need to + id="dx1-193009">. If I change the entry descriptions so that they all start with a lowercase letter then I would need to create a custom glossary style that used \Glossentrydesc instead of instead of \glossentrydesc. -


    . +


    glossaries-extraIf I switch to using glossaries-extra I wouldn’t need a new glossary style. Instead I could just use the glossdesc attribute to perform the case change. Remember that the first change to make is to replace + id="dx1-193012"> attribute to perform the case change. Remember that the first change to make is to replace glossaries with

    \newglossaryentry{Gamma}{name=\ensuremath{\Gamma(z)},
    description= function,sort=Gamma}
    The glossdesc attribute needs setting:
    + id="dx1-193014"> attribute needs setting:
    \glssetcategoryattribute{general}{glossdesc}{firstuc}
    This means that I can now use \glsdesc instead of instead of \glslink. -

    It’s a bit cumbersome typing . +

    It’s a bit cumbersome typing [format=hyperbf,counter=page] for each primary reference, but + which are already in use). For example:

    \GlsXtrSetAltModifier{!}{format=hyperbf,counter=page} @@ -33145,13 +33249,13 @@ class="cmtt-10">}{format=hyperbf,counter=page}
    Now \glsdesc!{Gamma} is equivalent to:
    \glsdesc[format=hyperbf,counter=page]{Gamma}
    So the text at the start of the “Gamma Functions” chapter is now just:
    @@ -33159,7 +33263,7 @@ class="cmtt-10">[format=hyperbf,counter=page]{Gamma} The \glsdesc!{Gamma} is defined as
    which is much more compact. Similar changes can be made for the other instance of \glslink where the where the link text is just the description:
    + id="dx1-193023"> is just the description:
    The \glsdesc!{erf} is defined as
    -

    There are three other instances of

    There are three other instances of \glslink, such as:

    + id="dx1-193025">, such as:

    \glslink{Gamma}{\Gamma(x+1)}
    If I just use \gls{Gamma} then I would get Γ(z) as the link text. For entries like this that represent functions + id="dx1-193027">. For entries like this that represent functions with variable parameters it would be more convenient (and help with consistency) if a command was available to easily replace the parameters. -

    With the base

    With the base glossaries package, one simple solution that works for this example is to save just the function symbol in the symbol field, for example:

    + id="dx1-193028"> field, for example:

    \newglossaryentry{Gamma}{name=\ensuremath{\Gamma(z)},
    symbol={\ensuremath{\Gamma}}, @@ -33218,7 +33322,7 @@ class="cmtt-10"> function,sort=Gamma}
    \glssymbol{Gamma}[(\Gamma(x+1))]
    (which includes the function parameter inside the link text) or just:
    + id="dx1-193031">) or just:
    \glssymbol{Gamma}(\Gamma(x+1))
    (which has the function parameter after the link text). This is a convenient approach where the extra material + id="dx1-193033">). This is a convenient approach where the extra material can simply follow the symbol, and it can also be used with glossaries-extra. -

    The

    The glossaries-extra package provides another possibility. It requires a command that takes a single argument, for example:

    -
    +   
     \newcommand{\Gammafunction}[1]{\Gamma(#1)}
     
    -

    The control sequence name (the command name without the leading backslash) is stored in the field identified +

    The control sequence name (the command name without the leading backslash) is stored in the field identified by the command \GlsXtrFmtField (this should be the internal field name not the key name, see + id="dx1-193034"> (this should be the internal field name not the key name, see table ??tab:fieldmap). The default is 4.1). The default is useri which corresponds to the which corresponds to the user1 key. This means that the key. This means that the Gamma entry would need to be defined with user1=Gammafunction. With this approach, each function entry would need a separate associated command. -

    Another approach is to store the parameterless function in the

    Another approach is to store the parameterless function in the symbol key (as earlier) and have a more + id="dx1-193037"> key (as earlier) and have a more generic command that uses this symbol. This requires the entry label, which can be obtained with \glslabel within the link text:

    + id="dx1-193038">:

    \newcommand{\entryfunc}[1]{\glsentrysymbol{\glslabel}(#1)}
    (Obviously, this command can’t be used outside of the link text or post-link hooks since it uses + id="dx1-193041"> or post-link hooks since it uses \glslabel.) -

    So the entry now needs the parameterless function in .) +

    So the entry now needs the parameterless function in symbol and the control sequence name of this generic + id="dx1-193043"> and the control sequence name of this generic command in user1. For example:

    + id="dx1-193044">. For example:

    \newglossaryentry{Gamma}{name=\ensuremath{\Gamma(z)},
    symbol={\ensuremath{\Gamma}},user1=entryfunc, @@ -33308,12 +33412,12 @@ class="cmtt-10"> function,sort=Gamma}
    (This doesn’t need to be done for the C and G entries since they’re constants not functions.) -

    You may want to consider providing helper commands to make the functions easier to define. For +

    You may want to consider providing helper commands to make the functions easier to define. For example:

    -
    +   
     \newcommand{\func}[2]{#1(#2)}
     \newcommand{\entryfunc}[1]{\func{\glsentrysymbol{\glslabel}}{#1}}
     \newcommand{\newfunc}[5][]{%
    @@ -33325,55 +33429,55 @@ example:
      }%
     }
     
    -

    The entries can now be defined using this custom

    The entries can now be defined using this custom \newfunc command. For example:

    -
    +   
     \newfunc{Gamma}{\Gamma}{z}{gamma function}
     \newfunc[sort=gamma1]{gamma}{\gamma}{\alpha,x}{lower
       incomplete gamma function}
     \newfunc[sort=Gamma2]{iGamma}{\Gamma}{\alpha,x}{upper
       incomplete gamma function}
     
    -

    -

    Note that in

    +

    Note that in \newfunc the symbol key doesn’t have its value encapsulated with key doesn’t have its value encapsulated with \ensuremath so so \glssymbol will need to explicitly be placed in math mode. If you switch to a glossary style that displays the symbol, you will either need to adjust the definition of \newfunc to use \ensuremath in the in the symbol field or you can add the + id="dx1-193049"> field or you can add the encapsulation with the glosssymbolfont attribute. -

    Now attribute. +

    Now \glslink{Znu}{Z_\nu} can simply be replaced with \glssymbol{Znu} (no parameter is required in this case). For the other cases, where the parameter is different from that given in the text field (which is + id="dx1-193052"> field (which is obtained from the name), you can use ), you can use \glsxtrfmt. For example, . For example, \glslink{Gamma}{\Gamma(x+1)} can now be replaced with:

    \glsxtrfmt{Gamma}{x+1}
    This effectively works like \glslink but omits the post-link hook. (See the glossaries-extra user manual for further details.) -

    Don’t use

    Don’t use \glsxtrfmt within the argument of another within the argument of another \glsxtrfmt command (or inside any other command (or inside any other link text).
    -

    -

    Similarly ).

    +

    +

    Similarly \glslink{Gamma}{\Gamma(\alpha)} can now be replaced with:

    \glsxtrfmt{Gamma}{\alpha}
    Note that it’s still possible to use:
    \glssymbol{Gamma}[(\alpha)]
    You may prefer to define a helper command that makes it easier to switch between your preferred method. For example: -
    +   
     \newcommand*{\Fn}[3][]{\glssymbol[#1]{#2}[(#3)]}
     
    -

    or:

    +

    or:

    \newcommand*{\Fn}[3][]{\glsxtrfmt[#1]{#2}{#3}}
    -

    bib2glsIf you want to convert this example so that it works with If you want to convert this example so that it works with bib2gls, first convert it to use + id="dx1-193063">, first convert it to use glossaries-extra (as described above), and then follow the instructions from sampleEq.tex. The convertgls2bib application recognises application recognises \newcommand so it will be able to parse the custom \newfunc commands. -

    Note that

    Note that bib2gls allows you to separate the locations in the allows you to separate the locations in the number list into different groups according to + id="dx1-193066"> into different groups according to the counter used for the location. This can be done with the loc-counters resource option. It’s also possible to + id="dx1-193067"> resource option. It’s also possible to identify primary formats (such as hyperbf used in this example) using the used in this example) using the primary-location-formats option. + id="dx1-193069"> option. The primary locations can then be given a more prominent position in the number list. See the . See the bib2gls user + id="dx1-193071"> user manual for further details. -

    + id="x1-193072r14"> +

    🔗sampleSec.tex

    -

    This document also illustrates how to change the location to something other than the page number. In this +

    This document also illustrates how to change the location to something other than the page number. In this case, the section counter is used. This example adds the glossary to the table of contents, so an extra LaTeX run is required: -

    
    +

    
        
    pdflatex sampleSec
    makeglossaries sampleSec
    pdflatex sampleSec @@ -33483,11 +33587,11 @@ LaTeX run is required: Note that there are conflicting location formats, which trigger a warning from makeindex: + id="dx1-194001">:

    -
    +   
     ## Warning (input = sampleSec.glo, line = 6; output =
     sampleSec.gls, line = 9):
        -- Conflicting entries: multiple encaps for the same page
    @@ -33497,73 +33601,73 @@ sampleSec.gls, line = 10):
        -- Conflicting entries: multiple encaps for the same page
     under same key.
     
    -

    This is the result of indexing an entry multiple times for the same +

    This is the result of indexing an entry multiple times for the same location18.1 + id="x1-194002f1"> with different values of the format key. In this case, it’s caused by three references to the key. In this case, it’s caused by three references to the ident entry in section 2.1:

    -
    +   
     \gls[format=hyperit]{ident}
     \glspl{ident} % default format=glsnumberformat
     \gls*[format=hyperbf]{ident}
     
    -

    -

    If you use the

    +

    If you use the makeglossaries Perl script it will detect the warnings in the Perl script it will detect the warnings in the makeindex transcript file and + id="dx1-194006"> transcript file and attempt to fix the conflict by removing entries from the glo file: + id="dx1-194007"> file:

    -
    +   
     Multiple encaps detected. Attempting to remedy.
     Reading sampleSec.glo...
     Writing sampleSec.glo...
     Retrying
     
    -

    (Range formats have highest precedence. The default

    (Range formats have highest precedence. The default glsnumberformat has the lowest precedence.) -

    If you use has the lowest precedence.) +

    If you use makeglossaries-lite or call or call makeindex directly then the problem won’t be fixed and the + id="dx1-194010"> directly then the problem won’t be fixed and the glossary will end up with the rather odd number list for the identity matrix entry consisting of three references + id="dx1-194011"> for the identity matrix entry consisting of three references to section 2.1: the first in the default font, followed by bold (hyperbf) and then italic () and then italic (hyperit), + id="dx1-194013">), which results in 2.1, 2.1, 2.1. If you use makeglossaries then only the bold entry ( then only the bold entry (2.1) will be present. -

    If you switch to

    If you switch to xindy:

    + id="dx1-194015">:

    \usepackage[,style=altlist,toc,counter=section]{glossaries}
    then the conflict will be resolved using the number format attribute list order of priority. In this case, glsnumberformat has the highest priority. This means that only the upright medium weight entry (2.1) will be + id="dx1-194016"> has the highest priority. This means that only the upright medium weight entry (2.1) will be present. The simplest way of altering this is to provide your own custom format. For example:
    @@ -33581,11 +33685,11 @@ present. The simplest way of altering this is to provide your own custom format. class="cmtt-10">\newcommand*{\primary}[1]{\hyperit{#1}}
    \GlsAddXdyAttribute{primary} @@ -33596,26 +33700,26 @@ class="cmtt-10">\gls[format=primary] etc. This will give format=primary the highest + id="dx1-194020"> the highest priority. (It’s also better practice to provide this kind of semantic command.) -

    With

    With bib2gls, you can supply rules to deal with location format conflicts, as illustrated below. -

    , you can supply rules to deal with location format conflicts, as illustrated below. +

    bib2glsIn order to switch to In order to switch to bib2gls, first replace , first replace glossaries with glossaries-extra, and add the record + id="dx1-194024"> package option. Remember that glossaries-extra has a different set of defaults and you may also want to patch @@ -33633,40 +33737,40 @@ class="cmtt-10">glossaries-extra}

    -

    The entry definitions now need to be converted into

    The entry definitions now need to be converted into bib2gls format and saved in a format and saved in a bib file (say, + id="dx1-194026"> file (say, entries.bib). You can use convertgls2bib: + id="dx1-194027">: -

    
    +

    
        
    convertgls2bib --preamble-only sampleSec.tex entries.bib

    -

    Next replace

    Next replace \makeglossaries with:

    + id="dx1-194028"> with:

    \GlsXtrLoadResources[src=entries]
    and remove all the \newglossaryentry commands. -

    Finally, replace

    Finally, replace \printglossaries with with \printunsrtglossaries. The document build is now: -

    
    + id="dx1-194031">. The document build is now:
    +

    
        
    pdflatex sampleSec
    bib2gls sampleSec
    pdflatex sampleSec @@ -33675,46 +33779,46 @@ class="cmtt-10">\printunsrtglossaries
    bib2gls warns about: + id="dx1-194032"> warns about:

    -
    +   
     Warning: Entry location conflict for formats: hyperbf and hyperit
     Discarding: {ident}{}{section}{hyperbf}{2.1}
     Conflicts with: {ident}{}{section}{hyperit}{2.1}
     
    -

    This means that it has discarded the bold location and kept the italic one. (As with

    This means that it has discarded the bold location and kept the italic one. (As with makeglossaries, range + id="dx1-194033">, range formats have the highest priority and glsnumberformat has the lowest.) -

    It would be better if the conflict could be merged into a single location that was both bold and italic. To + id="dx1-194034"> has the lowest.) +

    It would be better if the conflict could be merged into a single location that was both bold and italic. To achieve this, it’s first necessary to define a command that produces this effect:

    \newcommand*{\hyperbfit}[1]{\textbf{\hyperit{#1}}}
    Now bib2gls needs to be invoked with the appropriate mapping with the needs to be invoked with the appropriate mapping with the --map-format or or -m + id="dx1-194038"> switch: -

    
    +

    
        
    bib2gls -m ”hyperbf:hyperbfit,hyperit:hyperbfit” sampleSec

    If you are using arara the directive should be:

    + id="dx1-194039"> the directive should be:

    % ] }
    -

    If you try out this example, notice the difference between

    If you try out this example, notice the difference between record=only and and record=nameref. If you use the + id="dx1-194041">. If you use the latter, the locations will now be the section titles rather than the section numbers. If you use the nameref setting you can customize the location by defining the command:

    @@ -33752,7 +33856,7 @@ you can customize the location by defining the command:

    class="cmtt-10">\glsxtr⟨counterlocfmt{location}{title}
    -

    In this case the counter is

    In this case the counter is section, so the command should be \glsxtrsectionlocfmt. It takes two + id="dx1-194043">. It takes two arguments: the first is the location and the second is the title. For example:

    \newcommand*{\glsxtrsectionlocfmt}[2]{\S#1 #2} @@ -33781,31 +33885,31 @@ class="cmtt-10"> #2} class="cmss-10">equation counter, \glsxtrequationlocfmt.) Make sure that you have at least version 1.42 of .) Make sure that you have at least version 1.42 of glossaries-extra. -

    +

    -

    Top

    18.4 Multiple Glossaries

    -

    See also

    See also sampleSort.tex in §??sec:samplessort 18.5 Sorting, which has three glossaries. -

    + id="x1-195001r15"> +

    🔗sampleNtn.tex

    -

    This document illustrates how to create an additional glossary type. This example adds the glossary to the table +

    This document illustrates how to create an additional glossary type. This example adds the glossary to the table of contents, so an extra LaTeX run is required: -

    
    +

    
        
    pdflatex sampleNtn
    makeglossaries sampleNtn
    pdflatex sampleNtn @@ -33815,41 +33919,41 @@ of contents, so an extra LaTeX run is required: Note that if you want to call makeindex explicitly instead of using the explicitly instead of using the makeglossaries or or makeglossaries-lite + id="dx1-196003"> scripts then you need to call makeindex twice: + id="dx1-196004"> twice:

    1. -

      Create the main glossary (all on one line): -

      
      +  class="enumerate" id="x1-196006x1">
      +     

      Create the main glossary (all on one line): +

      
            
      makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo

    2. -

      Create the secondary glossary (all on one line): -

      
      +  class="enumerate" id="x1-196008x2">
      +     

      Create the secondary glossary (all on one line): +

      
            
      makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn

    -

    This document creates a new glossary using:

    +

    This document creates a new glossary using:

    \newglossary[nlg]{notation}{not}{ntn}{Notation}
    This defines a glossary that can be identified with the label glossaries package needs to know the input and output files required by makeindex or or xindy. -

    (The optional argument is the file extension of the indexing transcript file, which . +

    (The optional argument is the file extension of the indexing transcript file, which glossaries doesn’t need to know about, but it writes the information to the aux file for the benefit of file for the benefit of makeglossaries and + id="dx1-196013"> and makeglossaries-lite.) -

    If you switch to a different indexing option then these file extensions aren’t required, in which case it’s + id="dx1-196014">.) +

    If you switch to a different indexing option then these file extensions aren’t required, in which case it’s simpler to use the starred form:

    \newglossary*{notation}{Notation}
    -

    This example uses a label prefixing system

    This example uses a label prefixing system18.2 to + id="x1-196016f2"> to differentiate between the different types of entries. For example, the term “set” is defined as:

    -
    +   
     \newglossaryentry{gls:set}{name=set,
     description={A collection of distinct objects}}
     
    -

    and the set notation is defined as: +

    and the set notation is defined as:

    -
    +   
     \newglossaryentry{not:set}{type=notation,
     name={\ensuremath{\mathcal{S}}},
     description={A \gls{gls:set}},sort={S}}
     
    -

    Notice that the latter description contains

    Notice that the latter description contains \gls. This means you shouldn’t use \glsdesc with this entry + id="dx1-196018"> with this entry otherwise you will end up with nested links. -



    glossaries-extraThe glossaries-extra package provides a command for use in within field values to prevent nested link text:

    + id="dx1-196019">:

    \glsxtrp{field}{}
    There are convenient shortcuts for common fields: \glsps{label} (for the short field) and field) and \glspt{label} (for the text field). So the set notation definition can be modified:
    + id="dx1-196024"> field). So the set notation definition can be modified:
    \newglossaryentry{not:set}{type=notation, @@ -33954,16 +34058,16 @@ class="cmtt-10">name={\ensuremath{\mathcal{S}}}, class="cmtt-10">description={A \glspt{gls:set}},sort=S}
    This will stop the inner reference from causing interference if you use \glsdesc. It will also suppress indexing + id="dx1-196026">. It will also suppress indexing within the glossary but will have a hyperlink (if hyperref is used). -

    The

    The glossaries-extra package provides a way of defining commands like \gls that automatically insert a @@ -33971,11 +34075,11 @@ prefix. For example:

    \glsxtrnewgls{not:}{\sym}
    \glsxtrnewglslike{gls:}{\term}{\termpl}{\Term}{\Termpl}
    (there’s no point providing commands for plural or case-changing with symbols). Now \sym{set} and \gls{gls:set} can be replaced with \term{set}. -

    bib2glsThese two commands are primarily provided for the benefit of These two commands are primarily provided for the benefit of bib2gls as the information is written + id="dx1-196030"> as the information is written to the aux file. This allows file. This allows bib2gls to recognise the custom commands if they have been used in the to recognise the custom commands if they have been used in the bib files. + id="dx1-196033"> files. When combined with label-prefix and and ext-prefixes (see below) this makes it much simpler to change the + id="dx1-196035"> (see below) this makes it much simpler to change the prefixes if necessary. -

    If you want to convert this document to use

    If you want to convert this document to use bib2gls, remember that you need the , remember that you need the record or or record=nameref + id="dx1-196038"> option. For example:

    @@ -34031,28 +34135,28 @@ class="cmtt-10">]{glossaries-extra}
    As with earlier examples, convertgls2bib can be used to convert the entry definitions into + id="dx1-196039"> can be used to convert the entry definitions into the required bib format. You may prefer to split the entries into separate files according to + id="dx1-196040"> format. You may prefer to split the entries into separate files according to type.18.3 + id="x1-196041f3"> This is useful if you want to reuse a large database of entries across multiple documents as it doesn’t lock you into using a specific glossary. For example: -

    
    +

    
        
    convertgls2bib --split-on-type --preamble-only sampleNtn.tex entries.bib

    This will create a file called entries.bib that contains the entries that didn’t have a type assigned in the + id="dx1-196043"> assigned in the original file, such as:

    @entry{gls:set,
     }
    It will also create a file called notation.bib that contains the entries that had the type set to set to notation in the original file, such as:
    @entry{not:set,
      = {A \glspt{gls:set}}
    }
    Note that the type field has been removed. The above entry in the field has been removed. The above entry in the notation.bib file references a term in the entries.bib file. It’s possible to strip all the prefixes from the bib files and get files and get bib2gls to + id="dx1-196050"> to automatically insert them. In which case, this cross-reference needs adjusting to indicate that it’s referring to an entry in another file. This can be done with one of the special ext. prefixes:
    @entry{set, @@ -34135,7 +34239,7 @@ class="cmtt-10"> = {A \glspt{ext1.set}} @@ -34149,7 +34253,7 @@ class="cmtt-10">entries.bib file is now:
    @entry{set, @@ -34171,28 +34275,28 @@ class="cmtt-10"> objects} class="cmtt-10">}
    -

    Now you can replace

    Now you can replace \makeglossaries with:

    \GlsXtrLoadResources[src={entries},label-prefix={gls:}]
    \GlsXtrLoadResources[src={notation},type=notation,
     ] class="cmtt-10">\newglossaryentry definitions and replace \printglossaries with \printunsrtglossaries. -

    Regardless of how many resource sets the document contains, only one . +

    Regardless of how many resource sets the document contains, only one bib2gls call is required: -

    
    + id="dx1-196060"> call is required:
    +

    
        
    pdflatex sampleNtn
    bib2gls sampleNtn
    pdflatex sampleNtn

    -

    You may notice that the ordering in the notations list has changed from the original. This is because the +

    You may notice that the ordering in the notations list has changed from the original. This is because the sort field was automatically removed by field was automatically removed by convertgls2bib, so the entries are now sorted according to the , so the entries are now sorted according to the name + id="dx1-196063"> field (since they are defined with @entry). You can use your text editor’s search and replace function to replace + id="dx1-196064">). You can use your text editor’s search and replace function to replace all instances of @entry with with @symbol in the in the notations.bib file so that, for example, the set definition becomes:

    @symbol{set,
      = {A \glspt{ext1.set}} @@ -34263,30 +34367,30 @@ class="cmtt-10">}
    Now these @symbol entries will be sorted according to their label. (The original label in the entries will be sorted according to their label. (The original label in the bib file, not the + id="dx1-196070"> file, not the prefixed label.) This will put them in the same order as the original document. (See the “Examples” chapter of the bib2gls user manual for examples of varying the sorting and also user manual for examples of varying the sorting and also bib2gls gallery: sorting.) + id="x1-196072r16"> -

    +

    🔗sample-dual.tex

    -

    This document illustrates how to define an entry that both appears in the list of acronyms and in the main +

    This document illustrates how to define an entry that both appears in the list of acronyms and in the main glossary. To create the document do: -

    
    +

    
        
    pdflatex sample-dual
    makeglossaries sample-dual
    pdflatex sample-dual @@ -34294,15 +34398,15 @@ glossary. To create the document do:
    This defines a custom command \newdualentry that defines two entries at once (a normal entry and + id="dx1-197001"> that defines two entries at once (a normal entry and an abbreviation). It uses \glsadd to ensure that if one is used then the other is automatically + id="dx1-197002"> to ensure that if one is used then the other is automatically indexed:

    -
    +   
     \newcommand*{\newdualentry}[5][]{%
       % main entry:
       \newglossaryentry{main-#2}{name={#4},%
    @@ -34314,17 +34418,17 @@ indexed:
       \newacronym{#2}{#3\glsadd{main-#2}}{#4}%
     }
     
    -

    A sample dual entry is defined with this command: +

    A sample dual entry is defined with this command:

    -
    +   
     \newdualentry{svm}% label
       {SVM}% abbreviation
       {support vector machine}% long form
       {Statistical pattern recognition technique}% description
     
    -

    This defines an acronym with the label

    This defines an acronym with the label svm that can be referenced with \gls{svm} but it also defines an entry with the label \gls but it’s automatically added from the \glsadd{main-svm} in the short form of svm. -

    For this trivial document, this kind of dual entry is redundant and unnecessarily leads the +

    For this trivial document, this kind of dual entry is redundant and unnecessarily leads the reader down a trail, first to the list of acronyms and from there the reader then has to go to the main glossary to look up the description. It’s better to simply include the description in the list of acronyms. -

    bib2glsIf you want to switch over to If you want to switch over to bib2gls, first change to , first change to glossaries-extra:

    @@ -34360,53 +34464,53 @@ class="cmtt-10">}
    Next, the definition needs to be converted to the bib format required by format required by bib2gls. If you do: -

    
    + id="dx1-197006">. If you do:
    +

    
        
    convertgls2bib --preamble-only sample-dual.tex entries.bib

    then convertgls2bib will report the following: + id="dx1-197007"> will report the following:

    -
    +   
     Overriding default definition of \newdualentry with custom
     definition. (Change \newcommand to \providecommand if you want
     \newdualentry[options]{label}{short}{long}{description}
     converted to @dualabbreviationentry.)
     
    -

    This is because

    This is because convertgls2bib has its own internal definition of has its own internal definition of \newdualentry, but if it encounters a new definition that will override its default. If you want to retain convertgls2bib’s definition + id="dx1-197009">’s definition (recommended) then just replace \newcommand with \providecommand in the document source and rerun convertgls2bib. -

    With . +

    With \providecommand, the new entries.bib file created by convertgls2bib contains:

    + id="dx1-197011"> contains:

    @dualabbreviationentry{svm,
     \newcommand is retained, it will instead contain:
    @entry{main-svm,
     }

    @acronym{svm,
     }
    In the first case, bib2gls creates two linked entries using its primary-dual mechanism. In the second case, + id="dx1-197015"> creates two linked entries using its primary-dual mechanism. In the second case, bib2gls creates two entries that simply reference each other. -

    Assuming that your creates two entries that simply reference each other. +

    Assuming that your entries.bib file just contains @dualabbreviationentry, now replace + id="dx1-197017">, now replace \makeglossaries with:

    \GlsXtrLoadResources[src=entries,% entries.bib
      type=acronym,dual-type=main,dual-prefix={main-}]
    -

    Then remove the definition of

    Then remove the definition of \newdualentry and the entry definition. Finally, replace \printglossaries with \printunsrtglossaries. The document build is: -

    
    + id="dx1-197022">. The document build is:
    +

    
        
    pdflatex sample-dual
    bib2gls sample-dual
    pdflatex sample-dual

    -

    If, instead, your

    If, instead, your entries.bib file contains separate @entry and and @acronym, then you need:

    + id="dx1-197024">, then you need:

    \setabbreviationstyle[acronym]{long-short}
    \GlsXtrLoadResources[src=entries]
    If you need number lists, the document build is now -

    
    + id="dx1-197028">s, the document build is now
    +

    
        
    pdflatex sample-dual
    bib2gls sample-dual
    pdflatex sample-dual @@ -34562,40 +34666,40 @@ href="#glo:numberlist">number listbib2gls complains about the use of complains about the use of \glsadd within the within the short and and text fields as + id="dx1-197032"> fields as this can be problematic. (The extra bib2gls and LaTeX calls are to ensure the and LaTeX calls are to ensure the number list is + id="dx1-197034"> is up to date for the main-svm entry, which can only be indexed with \glsadd after svm has been defined.) -

    Dual entries make much more sense when one entry is for a glossary with the description displayed but +

    Dual entries make much more sense when one entry is for a glossary with the description displayed but no number list, and the other is for the index without the description but with a , and the other is for the index without the description but with a number list. + id="dx1-197036">. This can be created with by replacing @dualabbreviationentry with with @dualindexabbreviation: + id="dx1-197038">:

    @dualindexabbreviation{svm,
     }
    This can be mixed with @index terms for example:
    + id="dx1-197040"> terms for example:
    @index{machlearn,
     \documentclass{article}

    \usepackage[record, acronym]{glossaries-extra}

    \setabbreviationstyle{long-short-desc}
    \GlsXtrLoadResources[src=entries,% entries.bib
     dual-type=acronym,
     ={idx.},dual-prefix={},
     combine-dual-locations={primary}]

    \glsxtrnewglslike{idx.}{{machlearn}.

    \printunsrtglossary[type=main,style=altlist]
    \printunsrtglossary[style=bookindex,title={Index}]
    \end{document} @@ -34730,18 +34834,18 @@ class="cmtt-10">\end{document}
    See the bib2gls manual for further details. + id="dx1-197052"> manual for further details. -

    + id="x1-197053r17"> +

    🔗sample-langdict.tex

    -

    This document illustrates how to use the glossaries package to create English to French and French to English +

    This document illustrates how to use the glossaries package to create English to French and French to English dictionaries. To create the document do: -

    
    +

    
        
    pdflatex sample-langdict
    makeglossaries sample-langdict
    pdflatex sample-langdict @@ -34751,22 +34855,22 @@ dictionaries. To create the document do:
    This example uses the nomain package option to prevent the creation of the package option to prevent the creation of the main glossary. This means that the document must provide its own glossaries:

    -
    +   
     \newglossary[glg]{english}{gls}{glo}{English to French}
     \newglossary[flg]{french}{flx}{flo}{French to English}
     
    -

    This means that if you want to call

    This means that if you want to call makeindex explicitly you need to take these new extensions into + id="dx1-198002"> explicitly you need to take these new extensions into account: -

    
    +

    
        
    makeindex -s sample-langdict.ist -t sample-langdict.glg -o sample-langdict.gls sample-langdict.glo
    makeindex -s sample-langdict.ist -t sample-langdict.flg -o sample-langdict.flx sample-langdict.flo
    @@ -34776,14 +34880,14 @@ entries:

    -
    +   
     \newcommand*{\newword}[4]{%
       \newglossaryentry{en-#1}{type=english,name={#2},description={#3 #4}}%
       \newglossaryentry{fr-#1}{type=french,name={#3 #4},text={#4},sort={#4},
         description={#2}}%
     }
     
    -

    This has the syntax:

    +

    This has the syntax:

    \newword{label⟩ (for the French term). So -
    +   
     \newword{cat}{cat}{le}{chat}
     
    -

    is equivalent to: +

    is equivalent to:

    -
    +   
     \newglossaryentry{en-cat}{type=english,name={cat},description={le chat}}
     \newglossaryentry{fr-cat}{type=french,name={le chat},sort={chat},
       description={cat}}
     
    -

    -

    Unlike the previous example (

    +

    Unlike the previous example (sample-dual.tex), there’s no link between these two entries. If the document only uses english glossary but the fr-cat entry won’t appear in the french one. -

    bib2glsIf you want to switch to If you want to switch to bib2gls then you first need to convert the document so that it + id="dx1-198004"> then you first need to convert the document so that it uses glossaries-extra, but include the prefix option to ensure that option to ensure that glossaries-prefix is also loaded: + id="dx1-198006"> is also loaded:

     English}
    Next the entries need to be converted to the bib format required by format required by bib2gls: -

    
    + id="dx1-198008">:
    +

    
        
    convertgls2bib --only-preamble sample-langdict.tex entries.bib

    @@ -34889,7 +34993,7 @@ class="cmtt-10">entries.bib that contains entries defined like:

    @entry{en-cat,
     }

    @entry{fr-cat,
     }
    (Note that the sort field has been omitted.) -

    This would be more flexible, and much briefer, if these entries were defined using field has been omitted.) +

    This would be more flexible, and much briefer, if these entries were defined using bib2gls’s dual entry + id="dx1-198012">’s dual entry system combined with the glossaries-prefix package:

    + id="dx1-198013"> package:

    @dualentry{cat,
      {cat},
      prefix = {le},
      prefixplural = {les}
    }
    @dualentry{chair,
      {chair},
      prefix = {la},
      prefixplural = {les}
    }
    -

    With

    With @dualentry, the English and French terms are now automatically linked from , the English and French terms are now automatically linked from bib2gls’s point of view. + id="dx1-198021">’s point of view. If only one is referenced in the document, the other will also be added by default. -

    Now that the determiner has been moved out of the description, it won’t show in the glossary. However, it’s +

    Now that the determiner has been moved out of the description, it won’t show in the glossary. However, it’s possible to include it by providing a command to encapsulate the description (which can also apply the language change as well).

    @@ -35027,10 +35131,10 @@ change as well).
    \GlsXtrLoadResources[src=entries,% entries.bib
    ={space},
     category={same as type},dual-category={same as type}, @@ -35054,23 +35158,23 @@ class="cmtt-10"> label-prefix={en-},dual-prefix={fr-},
     type=english,dual-type=french,
     sort=en,dual-sort=fr] @@ -35079,36 +35183,36 @@ class="cmtt-10">=fr] class="cmtt-10">\newcommand{\FrEncap}[1]{%
     \foreignlanguage{french}{\glsentryprefix{\glscurrententrylabel}#1}}
    \newcommand{\EnEncap}[1]{\foreignlanguage{english}{#1}}

    \glssetcategoryattribute{english}{glossnamefont}{EnEncap}
    \glssetcategoryattribute{english}{glossdescfont}{FrEncap}
    \glssetcategoryattribute{french}{glossnamefont}{FrEncap}
    \glssetcategoryattribute{french}{glossdescfont}{EnEncap}
    -

    Remember to remove

    Remember to remove \makeglossaries, the definition of \newword and the entry definitions from the document preamble, and replace \printglossary with:

    \printunsrtglossary + id="dx1-198039">
    -

    Other refinements that you might like to make include using

    Other refinements that you might like to make include using \glsxtrnewglslike so you don’t have to worry + id="dx1-198040"> so you don’t have to worry about the label prefix (“en-” and “fr-”). -

    + id="x1-198041r18"> +

    🔗sample-index.tex

    -

    This document uses the

    This document uses the glossaries package to create both a glossary and an index. This requires two makeglossaries (or (or makeglossaries-lite) calls to ensure the document is up to date: -

    
    + id="dx1-199002">) calls to ensure the document is up to date:
    +

    
        
    pdflatex sample-index
    makeglossaries sample-index
    pdflatex sample-index @@ -35148,24 +35252,24 @@ class="cmtt-10">makeglossaries-lite
    pdflatex sample-index

    -

    +

    -

    Top

    18.5 Sorting

    + id="x1-200001r19"> -

    +

    🔗samplePeople.tex

    -

    This document illustrates how you can hook into the standard sort mechanism to adjust the way the sort key is +

    This document illustrates how you can hook into the standard sort mechanism to adjust the way the sort key is set. This requires an additional run to ensure the table of contents is up-to-date: -

    
    +

    
        
    pdflatex samplePeople
    makeglossaries samplePeople
    pdflatex samplePeople @@ -35176,29 +35280,29 @@ This provides two commands for typesetting a name:

    -
    +   
     \newcommand{\sortname}[2]{#2, #1}
     \newcommand{\textname}[2]{#1 #2}
     
    -

    where the first argument contains the forenames and the second is the surname. The first command is the one +

    where the first argument contains the forenames and the second is the surname. The first command is the one required for sorting the name and the second is the one required for displaying the name in the document. A synonym is then defined:

    -
    +   
     \let\name\textname
     
    -

    This command defaults to the display name command (

    This command defaults to the display name command (\textname) but is temporarily redefined to the sort name command (\sortname) within the sort field assignment hook:

    + id="dx1-201001"> field assignment hook:

    \renewcommand{\glsprestandardsort}[3]{%
      \let\name\textname
     \glsdosanitizesort + id="dx1-201003">
    }
    @@ -35227,20 +35331,20 @@ class="cmtt-10"> description={\nopostdesc}}
    Since \name is temporarily changed while the sort key is being assigned, the sort value for this entry ends up + id="dx1-201004"> key is being assigned, the sort value for this entry ends up as “Bloggs, Joe”, but the name appears in the document as “Joe Bloggs”. -

    bib2glsIf you want to use If you want to use bib2gls, you first need to convert the document to use , you first need to convert the document to use glossaries-extra but make sure you include the record option:

    + id="dx1-201007"> option:

    \usepackage[}
    Next it’s necessary to convert the entry definitions to the bib format required by format required by bib2gls. You can simply + id="dx1-201009">. You can simply do: -

    
    +

    
        
    convertgls2bib --preamble-only samplePeople people.bib

    @@ -35269,7 +35373,7 @@ class="cmtt-10">people.bib that contains definitions like:

    @entry{joebloggs,
       description = {\nopostdesc}
    } @@ -35289,30 +35393,30 @@ class="cmtt-10">}
    However, you may prefer to use the --index-conversion (-i) switch: -

    
    +

    
        
    convertgls2bib -i --preamble-only samplePeople people.bib

    This will discard the description field and use field and use @index instead of instead of @entry if the if the description is either empty or + id="dx1-201015"> is either empty or simply set to \nopostdesc or or \glsxtrnopostpunc. The . The people.bib file now contains definitions like:

    @index{joebloggs,
     }
    Regardless of which approach you used to create the bib file, you now need to edit it to provide a definition of + id="dx1-201019"> file, you now need to edit it to provide a definition of the custom \name command for bib2gls’s use:
    + id="dx1-201020">’s use:
    @preamble{"\providecommand{\name}[2]{#2, #1}"}
    Note the use of \providecommand instead of \newcommand. -

    In the document (

    In the document (samplePeople.tex) you now need to delete \makeglossaries, the definitions of \newcommand{\name}[2]{#1 #2}
    \GlsXtrLoadResources[src=people]

    Next, use your text editor’s search and replace function to subsitute all instances of \glsentrytext in the chapter headings with \glsfmttext. For example:
    + id="dx1-201025">. For example:
    \chapter{\glsfmttext{joebloggs}}
    Finally, replace \printunsrtglossaries with:
    \printunsrtglossaries + id="dx1-201028">
    The document build is now: -

    
    +

    
        
    pdflatex samplePeople
    bib2gls samplePeople
    pdflatex samplePeople @@ -35399,44 +35503,44 @@ The third LaTeX call is required to ensure that the PDF bookmarks are up aren’t defined until after the bib2gls run (which is why you have to use run (which is why you have to use \glsfmttext instead of + id="dx1-201030"> instead of \glsentrytext). -

    This again leads to a list sorted by surname. The reason this works is because

    This again leads to a list sorted by surname. The reason this works is because bib2gls only sees the + id="dx1-201031"> only sees the definition of \name provided in @preamble, but the document uses the definition of , but the document uses the definition of \name provided before \GlsXtrLoadResources. The use of \providecommand in in @preamble prevents prevents \name from being redefined within the document. -

    See also the “Examples” chapter of the

    See also the “Examples” chapter of the bib2gls user manual, which provides another “people” + id="dx1-201035"> user manual, which provides another “people” example. -

    + id="x1-201036r20"> +

    🔗sampleSort.tex

    -

    This is another document that illustrates how to hook into the standard sort mechanism. An additional run is +

    This is another document that illustrates how to hook into the standard sort mechanism. An additional run is required to ensure the table of contents is up-to-date: -

    
    +

    
        
    pdflatex sampleSort
    makeglossaries sampleSort
    pdflatex sampleSort @@ -35450,12 +35554,12 @@ class="cmtt-10">notation
    ), so if you want to use makeindex explicitly you will need to have three explicitly you will need to have three makeindex calls with the appropriate file + id="dx1-202002"> calls with the appropriate file extensions: -

    
    +

    
        
    pdflatex sampleSort
    makeindex -s sampleSort.ist -t sampleSort.alg -o sampleSort.acr sampleSort.acn
    makeindex -s sampleSort.ist -t sampleSort.glg -o sampleSort.gls sampleSort.glo @@ -35469,26 +35573,26 @@ extensions: It’s much simpler to just use makeglossaries or or makeglossaries-lite. -

    In this example, the sort hook is adjusted to ensure the list of notation is sorted according to the order of + id="dx1-202004">. +

    In this example, the sort hook is adjusted to ensure the list of notation is sorted according to the order of definition. A new counter is defined to keep track of the entry number:

    -
    +   
     \newcounter{sortcount}
     
    -

    The sort hook is then redefined to increment this counter and assign the sort key to that numerical +

    The sort hook is then redefined to increment this counter and assign the sort key to that numerical value, but only for the notation glossary. The other two glossaries have their sort keys assigned as normal:

    -
    +   
     \renewcommand{\glsprestandardsort}[3]{%
       \ifdefstring{#2}{notation}%
       {%
    @@ -35500,11 +35604,11 @@ normal:
       }%
     }
     
    -

    This means that

    This means that makeindex will sort the notation in numerical order. -


    will sort the notation in numerical order. +


    glossaries-extraIf you want to convert this document to use } class="cmtt-10">\setacronymstyle and replace all instances of \newacronym with \newabbreviation or + id="dx1-202006"> or replace: -

    +   
     \setacronymstyle{long-short}
     
    -

    with:

    +

    with:

    \setabbreviationstyle[acronym]{long-short}
    -

    The custom counter and redefinition of

    The custom counter and redefinition of \glsprestandardsort can now be removed. The file extensions for the custom notation glossary are no longer relevant so the glossary definition can be changed to: @@ -35552,11 +35656,11 @@ class="cmtt-10">{notation}{Notation}

    The \makeglossaries command now needs to be adjusted to indicate which glossaries need to be processed by + id="dx1-202008"> command now needs to be adjusted to indicate which glossaries need to be processed by makeindex:
    + id="dx1-202009">:
    \makeglossaries[main,acronym]
    Finally, \printglossaries needs to be replaced with:
    + id="dx1-202010"> needs to be replaced with:
    \printglossary @@ -35582,22 +35686,22 @@ class="cmtt-10">notation glossary, which hasn’t been listed in the class="cmtt-10">\makeglossaries, must be displayed with \printnoidxglossary. -

    This means that . +

    This means that makeindex only needs to process the only needs to process the main and acronym glossaries. No actual sorting is performed for the notation glossary because, when used with sort=def, \printnoidxglossary simply iterates over the list of entries that have been indexed. -

    The document build doesn’t need the third LaTeX call now (since none of the glossaries extend beyond a +

    The document build doesn’t need the third LaTeX call now (since none of the glossaries extend beyond a page break): -

    
    +

    
        
    pdflatex sampleSort
    makeglossaries sampleSort @@ -35608,37 +35712,37 @@ page break): This time makeglossaries will include the message: + id="dx1-202014"> will include the message:

    -
    +   
     only processing subset 'main,acronym'
     
    -

    This means that although

    This means that although makeglossaries has noticed the has noticed the notation glossary, it will be skipped. -

    If you are explicitly calling

    If you are explicitly calling makeindex then you need to drop the call for the then you need to drop the call for the notation glossary: -

    
    +

    
        
    pdflatex sampleSort
    makeindex -s sampleSort.ist -t sampleSort.alg -o sampleSort.acr sampleSort.acn
    makeindex -s sampleSort.ist -t sampleSort.glg -o sampleSort.gls sampleSort.glo
    pdflatex sampleSort

    -

    bib2glsIf you prefer to use If you prefer to use bib2gls, the package loading line needs to be changed to:

    + id="dx1-202018">, the package loading line needs to be changed to:

    \usepackage[}
    Next the entry definitions need to be convert to the bib format required by format required by bib2gls. -

    For this example, it’s simpler to split the entries into different files according to the glossary type. This can + id="dx1-202020">. +

    For this example, it’s simpler to split the entries into different files according to the glossary type. This can be done with the --split-on-type or -t switch: -

    
    +

    
        
    convertgls2bib -t --preamble-only sampleSort.tex entries.bib

    This will create three files:

    -

    +

    entries.bib

    -

    which contains the entries that were defined with

    which contains the entries that were defined with \newglossaryentry. For example:

    + id="dx1-202021">. For example:

    @entry{gls:set,
     }
    -

    +

    abbreviations.bib

    -

    which contains the entries that were defined with

    which contains the entries that were defined with \newacronym. For example:

    + id="dx1-202023">. For example:

    @acronym{zfc,
     }
    If you changed \newacronym to to \newabbreviation then then @abbreviation will be used instead: + id="dx1-202027"> will be used instead:
    @abbreviation{zfc,
     }
    -

    +

    notation.bib

    -

    which contains the entries that were defined with

    which contains the entries that were defined with type=notation. For example:

    @entry{not:set,
     }
    You may prefer to replace @entry with with @symbol in this file.
    -

    in this file. +

    After the definition of the notation glossary (\newglossary), add:

    @@ -35815,21 +35919,21 @@ class="cmtt-10"> set first:
    \setabbreviationstyle[acronym]{long-short}
    \GlsXtrLoadResources[src={entries,abbreviations}]
    \GlsXtrLoadResources[src={notation},% notation.bib
    type
    =notation
    ,sort=unsrt]
    Delete the remainder of the preamble (\makeglossaries and entry definitions). -

    Finally, replace the lines that display the glossaries with:

    +

    Finally, replace the lines that display the glossaries with:

    \printunsrtglossaries + id="dx1-202039">
    The build process is now: -

    
    +

    
        
    pdflatex sampleSort
    bib2gls sampleSort
    pdflatex sampleSort

    -

    In this case, I have one resource command that processes two glossaries (

    In this case, I have one resource command that processes two glossaries (main and acronym) at the same time. The entries in these glossaries are ordered alphabetically. The second resource command processes the @@ -35866,34 +35970,34 @@ time. The entries in these glossaries are ordered alphabetically. The second res class="cmtt-10">notation glossary but the entries in this glossary aren’t sorted (and so will appear in the order of definition within the bib file). -

    See also file). +

    See also sampleNtn.tex, bib2gls gallery: sorting and the bib2gls user manual for more examples. -

    + id="dx1-202041"> user manual for more examples. +

    -

    Top

    18.6 Child Entries

    -

    + id="x1-203001r21"> +

    🔗sample.tex

    -

    This document illustrates some of the basics, including how to create child entries that use the same name as +

    This document illustrates some of the basics, including how to create child entries that use the same name as the parent entry. This example adds the glossary to the table of contents and it also uses \glsrefentry, so an + id="dx1-204001">, so an extra LaTeX run is required: -

    
    +

    
        
    pdflatex sample @@ -35906,21 +36010,21 @@ You can see the difference between word and letter ordering if you add the packa class="cmss-10">order
    =letter. (Note + id="dx1-204002">. (Note that this will only have an effect if you use makeglossaries or or makeglossaries-lite. If you use . If you use makeindex + id="dx1-204005"> explicitly, you will need to use the -l switch to indicate letter ordering.) -

    One of the entries has its name encapsulated with a semantic command:

    + id="dx1-204006"> switch to indicate letter ordering.) +

    One of the entries has its name encapsulated with a semantic command:

    \newcommand{ language}}
    This means that this entry needs to have the sort key set otherwise key set otherwise makeindex will assign it + id="dx1-204008"> will assign it to the “symbol” letter group, since it starts with a backslash (which makeindex simply treats as + id="dx1-204009"> simply treats as punctuation). -

    The homograph entries “glossary” and “bravo” are defined as sub-entries that inherit the name from the +

    The homograph entries “glossary” and “bravo” are defined as sub-entries that inherit the name from the parent entry. The parent entry doesn’t have a description, but with the default nopostdot=false setting this will + id="dx1-204010"> setting this will lead to a spurious dot. This can be removed by adding \nopostdesc to the description, which suppresses the + id="dx1-204011"> to the description, which suppresses the post-description hook for that entry. -

    Since the child entries have the same name as the parent, this means that the child entries will have +

    Since the child entries have the same name as the parent, this means that the child entries will have duplicate sort values unless the default is changed with the sort key:

    + id="dx1-204012"> key:

    \newglossaryentry{glossary}{name=glossary,
     description={\nopostdesc
    },plural={glossaries}}

    \newglossaryentry{glossarycol}{
     description={collectionglossary entry. -



    glossaries-extraIf you switch to using glossaries-extra}

    -

    You may now want to consider replacing

    You may now want to consider replacing \nopostdesc in the descriptions with in the descriptions with \glsxtrnopostpunc (using + id="dx1-204016"> (using your text editor’s search and replace function). This suppresses the post-description punctuation but not the category post-description hook. -

    You may have noticed that some of the descriptions include the plural form, but it’s not done very +

    You may have noticed that some of the descriptions include the plural form, but it’s not done very consistently. For example:

    -
    +   
     \newglossaryentry{cow}{name=cow,
       plural=cows,% not required as this is the default
       user1=kine,
    @@ -36055,47 +36159,47 @@ consistently. For example:
     female of any bovine animal}
     }
     
    -

    which has the parenthetical material at the start of the description with emphasis, +

    which has the parenthetical material at the start of the description with emphasis,

    -
    +   
     \newglossaryentry{bravocry}{
       description={cry of approval (pl.\ bravos)},
       sort={1},
       parent={bravo}
     }
     
    -

    which has the parenthetical material at the end of the description without emphasis even though it’s a regular +

    which has the parenthetical material at the end of the description without emphasis even though it’s a regular plural,

    -
    +   
     \newglossaryentry{bravoruffian}{
       description={hired ruffian or killer (pl.\ bravoes)},
       sort={2},
       plural={bravoes},
       parent=bravo}
     
    -

    which has the parenthetical material at the end of the description without emphasis, and +

    which has the parenthetical material at the end of the description without emphasis, and

    -
    +   
     \newglossaryentry{glossary}{name=glossary,
       description={\nopostdesc},
       plural={glossaries}}
     
    -

    which doesn’t show the plural in the description. -

    With

    which doesn’t show the plural in the description. +

    With glossaries-extra, you can remove this parenthetical material and implement it using the category post-description hook instead. For example, the above definitions become:

    -
    +   
     \newglossaryentry{cow}{name=cow,
       user1=kine,
       description={an adult female of any bovine animal}
    @@ -36111,7 +36215,7 @@ post-description hook instead. For example, the above definitions become:
       plural={bravoes},
       parent=bravo}
     
    -

    +

    \newglossaryentry{glossary}{name=glossary, @@ -36119,7 +36223,7 @@ class="cmtt-10">\newglossaryentry{glossary}{name=glossary, class="cmtt-10">  description={\glsxtrnopostpunc},
      plural={glossaries}}
    The post-description hook for the general category can now be set:
    + id="dx1-204018"> category can now be set:
    \glsdefpostdesc{general}{%
    % set? class="cmtt-10"> 
     \glsxtrifhasfield{useri}{\glscurrententrylabel}%
      {\space(\emph{pl.}\ \glsentryplural{\glscurrententrylabel},
        \emph{archaic} \glscurrentfieldvalue)%
        \GlsXtrIfXpFieldEqXpStr{plural}{\glscurrententrylabel}%
        {\glsentrytext{\glscurrententrylabel}\glspluralsuffix}%
      with bib2gls (see below)
       \GlsXtrIfXpFieldEqXpStr{plural}{\glscurrententrylabel}%
        {\space(\emph{pl.}\ \glsentryplural{\glscurrententrylabel})}%
     glossary entry if you use \nopostdesc and then replace it with \glsxtrnopostpunc.) See the .) See the glossaries-extra user manual for further details and also glossaries-extra and bib2gls: An Introductory Guide. -

    The “bravo” homographs are an oddity where the singular form is identical but the plural is different +

    The “bravo” homographs are an oddity where the singular form is identical but the plural is different (“bravos” and “bravoes”). In the original, both descriptions included the plural term. The above modifications drop the display of the regular “bravos” plural (for the bravocry term) and only show the “bravoes” plural (for the bravoruffian term). In this particular case it might be useful to show the regular plural in order to highlight the difference. -

    While it’s straightforward to access an entry’s parent label (with

    While it’s straightforward to access an entry’s parent label (with \glsentryparent) it’s much harder to + id="dx1-204035">) it’s much harder to access entry’s children or siblings. The \ifglshaschildren command has to iterate over all entries to determine + id="dx1-204036"> command has to iterate over all entries to determine if any have a parent that matches the given label. This is obviously very time-consuming if you have a large database of entries. It also doesn’t provide a way of determining whether or not the child entries have been indexed. -

    With

    With bib2gls, it’s possible to save this information with the , it’s possible to save this information with the save-child-count and and save-sibling-count, + id="dx1-204039">, which not only save the total but also save the child or sibling labels in an etoolbox internal list. This makes the + id="dx1-204040"> internal list. This makes the information much faster to access and also only includes the labels of those entries that have actually been indexed. -

    In the above, the comment line:

    +

    In the above, the comment line:

    % with bib2gls (see below)
    indicates where to put the extra code. If you switch to bib2gls and make sure to use and make sure to use save-sibling-count + id="dx1-204043"> then you can insert the following code in the block above where that comment is:
    \GlsXtrIfFieldNonZero{siblingcount}{\glscurrententrylabel}%
    {% siblingcount field value non-zero
     \glsxtrfieldforlistloop % iterate}% class="cmtt-10">{}% siblingcount field value 0\newcommand{\siblinghandler}[1]{% class="cmtt-10">  \GlsXtrIfXpFieldEqXpStr*{plural}{\glscurrententrylabel}%
         \listbreak + id="dx1-204049">
      }% @@ -36555,39 +36659,39 @@ class="cmtt-10">}
    The \listbreak command is provided by etoolbox and is used for prematurely exiting a loop. The handler + id="dx1-204050"> and is used for prematurely exiting a loop. The handler tests if the sibling’s plural field is identical to the current entry’s field is identical to the current entry’s plural field. If they are the + id="dx1-204052"> field. If they are the same, it does nothing. If they are different, it displays the current entry’s plural and breaks the loop. -

    Note that this assumes that the parent entry hasn’t had the plural form explicitly set to “bravoes” instead of +

    Note that this assumes that the parent entry hasn’t had the plural form explicitly set to “bravoes” instead of the default “bravos”. In that case, the parent entry would show the plural but the bravoruffian child entry wouldn’t show the plural (since this case would led to the empty code block identified with the comment “child and parent plurals the same”). The “bravoes” plural form would instead be shown for the parent, which wouldn’t look right. -

    If you don’t use

    If you don’t use bib2gls or if you use it without the or if you use it without the save-sibling-count resource option then the sibling + id="dx1-204054"> resource option then the sibling information won’t be available. -

    bib2glsIn order to switch to using In order to switch to using bib2gls, it’s first necessary to switch to using , it’s first necessary to switch to using glossaries-extra (as above). Remember that the record option is required:

    + id="dx1-204057"> option is required:

    \usepackage[subentrycounter]{glossaries-extra}
    Next the entry definitions need to be converted to the bib format required by format required by bib2gls. This can be done with + id="dx1-204059">. This can be done with convertgls2bib:
    + id="dx1-204060">:
    @@ -36621,44 +36725,44 @@ class="cmtt-10"> entries.
    The semantic command may be moved to the bib file to ensure it’s defined:
    + id="dx1-204061"> file to ensure it’s defined:
    @preamble{"\providecommand{\scriptlang}[1]{\textsf{#1}}"}
    -

    The

    The sort field typically shouldn’t be set when using field typically shouldn’t be set when using bib2gls, so , so convertgls2bib strips it. If the strips it. If the sort field + id="dx1-204066"> field is missing, bib2gls will obtain it from the sort fallback for that entry type. In this case, will obtain it from the sort fallback for that entry type. In this case, @entry has the has the name + id="dx1-204069"> field as the sort fallback. If this is also missing then its value is obtained from the parent’s name field (see + id="dx1-204070"> field (see bib2gls gallery: sorting for other examples). -

    Therefore the “Perl” entry is simply defined as:

    +

    Therefore the “Perl” entry is simply defined as:

    @entry{Perl,
     }
    This isn’t a problem for bib2gls. In this case, the command has been provided in the . In this case, the command has been provided in the @preamble, but , but bib2gls + id="dx1-204074"> strips font information so the sort value becomes Perl. If the definition isn’t placed in @preamble then + id="dx1-204075"> then bib2gls will simply ignore the command (as will simply ignore the command (as xindy does) so the sort value will still end up as + id="dx1-204077"> does) so the sort value will still end up as Perl. -

    The homograph entries have also had their

    The homograph entries have also had their sort fields omitted:

    + id="dx1-204078"> fields omitted:

    @entry{glossarycol,
     }

    @entry{glossarylist,
     }
    -

    This means that the sort value for both these child entries is “glossary”. When

    This means that the sort value for both these child entries is “glossary”. When bib2gls encounters identical + id="dx1-204081"> encounters identical sort values it acts according to its identical-sort-action setting. The default action is to sort by the label + id="dx1-204082"> setting. The default action is to sort by the label using a simple string comparison. In this case, it would put glossarycol before glossarylist. In the original document, the sort value was manually chosen to ensure that the entries are ordered according to value was manually chosen to ensure that the entries are ordered according to first use. This ordering can easily be obtained by changing bib2gls’s identical sort action (requires at least ’s identical sort action (requires at least bib2gls + id="dx1-204085"> v2.0):

    \GlsXtrLoadResources[src={entries},identical-sort-action=use] class="cmtt-10">\makeglossaries. If you want the sibling information (see earlier), then you need to remember to add save-sibling-count to the list of options. -

    Note that this is a better solution than in the original example. If I edit the document so that to the list of options. +

    Note that this is a better solution than in the original example. If I edit the document so that glossarycol is used first, then the ordering will be updated accordingly, but with the original example, the sort keys would + id="dx1-204089"> keys would need to be manually changed. -

    The remainder of the preamble (that is, the definition of

    The remainder of the preamble (that is, the definition of \scriptlang and all the entry definitions) should now be removed. -

    Finally, replace

    Finally, replace \printglossaries with \printunsrtglossaries. The document build is now: -

    
    + id="dx1-204090">. The document build is now:
    +

    
        
    pdflatex sample
    bib2gls --group sample
    pdflatex sample @@ -36804,33 +36908,33 @@ class="cmtt-10">\printunsrtglossaries
    Note use of the --group (or (or -g) switch, which is needed to support the ) switch, which is needed to support the treenonamegroup style. The third + id="dx1-204093"> style. The third LaTeX call is needed because the document contains \glsrefentry. -

    Note that you can’t use the . +

    Note that you can’t use the order=letter package option with package option with bib2gls. Instead use the . Instead use the break-at=none + id="dx1-204097"> resource option:

    \GlsXtrLoadResources[src={entries},identical-sort-action=use, @@ -36844,21 +36948,21 @@ class="cmtt-10">]
    -

    + id="x1-204100r22"> +

    🔗sample-inline.tex

    -

    This document is like

    This document is like sample.tex, above, but uses the inline glossary style to put the glossary in a footnote. + id="dx1-205001"> glossary style to put the glossary in a footnote. The document build is: -

    
    +

    
        
    pdflatex sample-inline
    makeglossaries sample-inline
    pdflatex sample-inline @@ -36871,20 +36975,20 @@ class="cmss-10">glossaries-extra
    , follow the same procedure as above. bib2gls then you don’t need the then you don’t need the --group switch since no letter groups are required. + id="dx1-205003"> switch since no letter groups are required. -

    + id="x1-205004r23"> +

    🔗sampletree.tex

    -

    This document illustrates a hierarchical glossary structure where child entries have different names to their +

    This document illustrates a hierarchical glossary structure where child entries have different names to their corresponding parent entry. To create the document do: -

    
    +

    
        
    pdflatex sampletree
    makeglossaries sampletree
    pdflatex sampletree @@ -36892,31 +36996,31 @@ corresponding parent entry. To create the document do:
    The document uses the alttreehypergroup glossary style, which needs to know the widest name for each + id="dx1-206001"> glossary style, which needs to know the widest name for each hierarchical level. This has been assigned manually in the preamble with \glssetwidest: + id="dx1-206002">:

    -
    +   
     \glssetwidest{Roman letters} % level 0 widest name
     \glssetwidest[1]{Sigma}      % level 1 widest name
     
    -

    (Level 0 is the top-most level. That is, entries that don’t have a parent.) It’s possible to get

    (Level 0 is the top-most level. That is, entries that don’t have a parent.) It’s possible to get glossaries to compute the widest top-level entry with \glsfindwidesttoplevelname but this will iterate over all top-level + id="dx1-206003"> but this will iterate over all top-level entries, regardless of whether or not they appear in the glossary. If you have a large database of entries, this will firstly take time and secondly the width may be too large due to an unindexed entry with a big name. -

    This sample document doesn’t require any of the tabular styles so I’ve prevented those packages from being +

    This sample document doesn’t require any of the tabular styles so I’ve prevented those packages from being loaded with nolong and and nosuper. The reduces the overall package loading.

    + id="dx1-206005">. The reduces the overall package loading.

    \usepackage[style=alttreehypergroup,{glossaries}
    (This example glossary is actually better suited for one of the topic styles provided with glossary-topic, see + id="dx1-206006">, see below.) -

    This is obviously a contrived example since it’s strange to have the symbol names (such as “Sigma”) in the +

    This is obviously a contrived example since it’s strange to have the symbol names (such as “Sigma”) in the glossary. The purpose is to demonstrate the alttreehypergroup with an entry that’s noticeably wider than the + id="dx1-206007"> with an entry that’s noticeably wider than the others in the same hierarchical level. A more sensible document would have the symbol in the name + id="dx1-206008"> key. -



    glossaries-extraIf you want to switch to glossaries-extra, then you can instead use a combination of nostyles + id="dx1-206009"> and stylemods:

    + id="dx1-206010">:

    \usepackage[style=alttreehypergroup,}
    The stylemods package not only patches the original styles provided by the base package not only patches the original styles provided by the base glossaries package (such as glossary-tree used in this example) but also provides extra helper commands. In this case, it + id="dx1-206012"> used in this example) but also provides extra helper commands. In this case, it provides additional commands to calculate the widest name. For example, instead of manually setting the widest entry with \glssetwidest, you could add the following before the glossary: + id="dx1-206013">, you could add the following before the glossary:
    \glsFindWidestUsedTopLevelName + id="dx1-206014">
    \glsFindWidestUsedLevelTwo + id="dx1-206015">
    This will only take into account the entries that have actually been used in the document, but it can still be time-consuming if you have a large number of entries. -

    Note that the glossary must be at the end of the document (after all required entries have been used) with +

    Note that the glossary must be at the end of the document (after all required entries have been used) with this method. The alternative is to perform the calculation at the end of the document and save the results in the aux file for the next run.
    -

    -

    This example document is using top-level entries for topics without descriptions. This means that the + id="dx1-206016"> file for the next run.

    +

    +

    This example document is using top-level entries for topics without descriptions. This means that the descriptions simply contain \nopostdesc to prevent the post-description punctuation from being automatically + id="dx1-206017"> to prevent the post-description punctuation from being automatically inserted. For example:

    -
    +   
     \newglossaryentry{greekletter}{name={Greek letters},
     text={Greek letter},
     description={\nopostdesc}}
     
    -

    With

    With glossaries-extra, you can convert this to \glsxtrnopostpunc which will prevent the post-description + id="dx1-206018"> which will prevent the post-description punctuation without interfering with the category post-description hook. -

    In order to distinguish between the child entries, which are symbols, and the parent entries, which are topics, +

    In order to distinguish between the child entries, which are symbols, and the parent entries, which are topics, it’s useful to give these two different types of entries different categories. The topics can use the default general + id="dx1-206019"> category, but the symbol entries can be assigned to a different category. The value of the category key must be + id="dx1-206020"> key must be a label. For example:

    =symbol, class="cmtt-10">parent=romanletter}
    -

    There is some redundancy caused by a parenthetical note after the

    There is some redundancy caused by a parenthetical note after the first use in some of the symbol entries. For example:

    -
    +   
     \newglossaryentry{pi}{name={pi},
     text={\ensuremath{\pi}},
     first={\ensuremath{\pi} (lowercase pi)},
     description={Transcendental number},
     parent=greekletter}
     
    -

    With

    With glossaries-extra this can be dealt with through the category post-link hook:

    \glsdefpostlink{symbol}{%
      \glsxtrifwasfirstuse + id="dx1-206022">
      {%   \glsxtrifhasfield{useri}{\glslabel}%
        { (\glscurrentfieldvalue)}{}%
     }
    The parenthetical material is now stored in the user1 key. For example:
    + id="dx1-206026"> key. For example:
    \newglossaryentry{sigma}{name=Sigma, @@ -37114,30 +37218,30 @@ glossary:
    \glsdefpostdesc{symbol}{\space
      ($\glsentrytext{\glscurrententrylabel}$)}
    These modifications only affect entries with the category set to set to symbol. -

    With . +

    With glossaries-extra, it’s now possible to use the topic styles provided with the glossary-topic package: + id="dx1-206032"> package:

    @@ -37160,12 +37264,12 @@ class="cmtt-10">}
    The topic style is designed for this kind of hierarchy where all the top-level entries don’t have descriptions. This + id="dx1-206033"> style is designed for this kind of hierarchy where all the top-level entries don’t have descriptions. This means that the \nopostdot and and \glsxtrnopostpunc commands aren’t required. The top-level entries can + id="dx1-206035"> commands aren’t required. The top-level entries can simply be defined as:
     description={}}
    I’ve now loaded both the glossary-tree and and glossary-topic packages (via packages (via stylemods={tree,topic}). The glossary-topic package can be used without package can be used without glossary-tree, in which case it will behave more like the normal , in which case it will behave more like the normal tree + id="dx1-206041"> rather than alttree styles (but with different indentation and no description in the top-level). However, + id="dx1-206042"> styles (but with different indentation and no description in the top-level). However, if you use \glssetwidest (provided by (provided by glossary-tree) then the ) then the topic style will behave more like + id="dx1-206045"> style will behave more like alttree. -

    Since there’s no description for the top-level entries, the . +

    Since there’s no description for the top-level entries, the topic style ignores the widest name setting for the + id="dx1-206047"> style ignores the widest name setting for the top-level, so I can just have the level 1 setting:

    -
    +   
     \glssetwidest[1]{Sigma}
     
    -

    -

    +

    bib2glsIf you want to convert this document so that it uses If you want to convert this document so that it uses bib2gls, you first need to convert it + id="dx1-206049">, you first need to convert it to using glossaries-extra, as described above, but remember that you now need the record option. + id="dx1-206050"> option.

    }
    Next convert the entries to the bib format required by format required by bib2gls: -

    
    + id="dx1-206052">:
    +

    
        
    convertgls2bib --preamble-only sampletree.tex entries.bib

    @@ -37266,54 +37370,54 @@ class="cmtt-10">\makeglossaries with:

    \GlsXtrLoadResources[src=entries,set-widest]
    I’ve used the set-widest option here to get option here to get bib2gls to compute the widest name. (Obviously, it can only do + id="dx1-206056"> to compute the widest name. (Obviously, it can only do this if it can correctly interpret any commands contained in the name field.) -

    This means that the field.) +

    This means that the \glssetwidest commands can now be removed completely. All the commands can now be removed completely. All the \newglossaryentry commands also need to be removed from the preamble. Finally, \printunsrtglossaries needs to be replaced with \printunsrtglossaries. The document build is now: -

    
    + id="dx1-206059">. The document build is now:
    +

    
        
    pdflatex sampletree
    bib2gls sampletree
    pdflatex sampletree

    -

    This produces the same result as with just

    This produces the same result as with just glossaries-extra and makeglossaries. However, there are some + id="dx1-206060">. However, there are some modifications that can be made to the bib file to make it neater. -

    The top-level entries are defined as:

    + id="dx1-206061"> file to make it neater. +

    The top-level entries are defined as:

    @entry{greekletter,
     }

    @entry{romanletter,
     }
    This is a direct translation from the \newglossaryentry commands (after switching to the topic style). There’s + id="dx1-206064"> style). There’s a more appropriate entry type:
    @indexplural{greekletter,
     }

    @indexplural{romanletter,
     }
    The @indexplural entry type doesn’t require the entry type doesn’t require the description and will set the and will set the name field to the same as the + id="dx1-206069"> field to the same as the plural field. Since the field. Since the plural field hasn’t been set it’s obtained by appending “s” to the field hasn’t been set it’s obtained by appending “s” to the text + id="dx1-206072"> field. -

    Now let’s assume that the symbol entries are defined in a more rational manner, with the actual symbol in +

    Now let’s assume that the symbol entries are defined in a more rational manner, with the actual symbol in the name field. For example:

    + id="dx1-206073"> field. For example:

    @entry{sigma,
     }

    @entry{C,
     }
    The category post-description hook (provided with \glsdefpostdesc) should now be removed from the + id="dx1-206076">) should now be removed from the document. -

    If you make these changes and rebuild the document, you’ll find that the order has changed. Now the

    If you make these changes and rebuild the document, you’ll find that the order has changed. Now the sigma entry is before the pi entry. This is because bib2gls is obtaining the sort values from the is obtaining the sort values from the name field, + id="dx1-206078"> field, which is the sort fallback for @entry. This means that the sort values end up as Σ and . This means that the sort values end up as Σ and π (bib2gls + id="dx1-206080"> recognises the commands \Sigma and and \pi and converts them to the Unicode characters 0x1D6F4 and + id="dx1-206082"> and converts them to the Unicode characters 0x1D6F4 and 0x1D70B). -

    If you change

    If you change @entry to to @symbol then you will once again get the order from the original example ( then you will once again get the order from the original example (pi before Sigma). This is because the sort fallback for @symbol is the label not the is the label not the name. (Remember that the sort + id="dx1-206086">. (Remember that the sort fallback is only used if the sort field isn’t set. If you explicitly set the field isn’t set. If you explicitly set the sort field then no fallback is required. See + id="dx1-206088"> field then no fallback is required. See bib2gls gallery: sorting.) -

    You can further tidy the

    You can further tidy the bib file by removing the file by removing the category fields. For example:

    + id="dx1-206090"> fields. For example:

    @symbol{sigma,
     }
    You can then assign the category in the resource set:
    + id="dx1-206092"> in the resource set:
    \GlsXtrLoadResources[src=entries,set-widest,]
    This means that all the entries defined with @symbol will have the will have the category set to set to symbol and all the entries defined with @indexplural will have the will have the category set to set to indexplural. (Only the symbol category is significant + id="dx1-206099"> category is significant in this example.) -

    You can make the

    You can make the bib files even more flexible by introducing field and entry aliases with files even more flexible by introducing field and entry aliases with field-aliases and + id="dx1-206101"> and entry-type-aliases. See the . See the bib2gls manual for further details. -

    + id="dx1-206103"> manual for further details. +

    -

    Top

    18.7 Cross-Referencing

    + id="x1-207001r24"> -

    +

    🔗sample-crossref.tex

    -

    This document illustrates how to cross-reference entries in the glossary. -

    
    +

    This document illustrates how to cross-reference entries in the glossary. +

    
        
    pdflatex sample-crossref
    makeglossaries sample-crossref
    pdflatex sample-crossref @@ -37631,43 +37735,43 @@ class="cmtt-10">sample-crossref.tex

    The document provides a command \alsoname to produce some fixed text, which can be changed as + id="dx1-208001"> to produce some fixed text, which can be changed as appropriate (usually within a language hook):

    -
    +   
     \providecommand{\alsoname}{see also}
     
    -

    I’ve used

    I’ve used \providecommand as some packages define this command. This is used to create a “see also” cross-reference with the see key: + id="dx1-208002"> key:

    -
    +   
     \newglossaryentry{apple}{name=apple,description={firm, round fruit},
     see=[\alsoname]{pear}}
     \newglossaryentry{marrow}{name={marrow},
      description={long vegetable with thin green skin and white flesh},
      see={[\alsoname]courgette}}
     
    -

    -

    Note that “marrow” is included in the glossary even though it hasn’t been referenced in the text. This is +

    +

    Note that “marrow” is included in the glossary even though it hasn’t been referenced in the text. This is because the see key automatically triggers key automatically triggers \glssee which indexes the term. This behaviour is intended for + id="dx1-208004"> which indexes the term. This behaviour is intended for documents where only the terms that are actually required in the document are defined. It’s not suitable for a large database of terms shared across multiple documents that may or may not be used in a particular document. In that case, you may want to consider using glossaries-extra (see below). -



    glossaries-extraThis example is quite simple to convert to nopostdot=false or or postdot package option. You may also want to consider using the + id="dx1-208006"> package option. You may also want to consider using the stylemods option. -

    In order to prevent the “marrow” entry from being automatically being added to the glossary as a result of + id="dx1-208007"> option. +

    In order to prevent the “marrow” entry from being automatically being added to the glossary as a result of the cross-reference, you can use autoseeindex=false to prevent the automatic indexing triggered by the to prevent the automatic indexing triggered by the see key + id="dx1-208009"> key (or the seealso key provided by key provided by glossaries-extra).

    @@ -37710,16 +37814,16 @@ class="cmtt-10">]{glossaries-extra}
    The document build is the same, but now the “marrow” and “zucchini” entries aren’t present in the document. -

    Note that the “fruit” entry is still included even though it hasn’t been used in the document. This is because +

    Note that the “fruit” entry is still included even though it hasn’t been used in the document. This is because it was explicitly indexed with \glssee not via the not via the see key. -

    The entries that contains key. +

    The entries that contains see=[\alsoname] can be converted to use the seealso key:

    + id="dx1-208013"> key:

    \newglossaryentry{apple}{name=apple,description={firm,}
    (The provided \alsoname definition may be removed.) -

    The original example redefines the cross-referencing format to use

    The original example redefines the cross-referencing format to use small caps:

    + id="dx1-208014">:

    \renewcommand{\glsseeitemformat}[1]{\textsc{\glsentryname{#1}}}
    This will still produce the desired effect with sampleAcrDesc.tex, this redefinition isn’t necessary if you have at least glossaries-extra v1.42. -

    bib2glsIf you want to switch to If you want to switch to bib2gls then you first need to switch to then you first need to switch to glossaries-extra, as described above, but you now need the record option but no longer need the option but no longer need the autoseeindex=false option: + id="dx1-208020"> option:

    ]{glossaries-extra}
    Next the entry definitions need to be converted to the bib format required by format required by bib2gls. -

    
    + id="dx1-208022">.
    +

    
        
    convertgls2bib sample-crossref.tex entries.bib

    If you have at least v2.0 then convertgls2bib will absorb the cross-referencing information supplied + id="dx1-208023"> will absorb the cross-referencing information supplied by:

    -
    +   
     \glssee{fruit}{pear,apple,banana}
     
    -

    into the

    into the fruit definition:

    @entry{fruit,
     
    \GlsXtrLoadResources[src=entries.bib]
    Finally, replace \printglossaries with \printunsrtglossaries. The document build is now: -

    
    + id="dx1-208027">. The document build is now:
    +

    
        
    pdflatex sample-crossref
    bib2gls sample-crossref
    pdflatex sample-crossref @@ -37875,14 +37979,14 @@ class="cmtt-10">\printunsrtglossaries
    The glossary now contains: apple, banana, courgette and pear. Note that it doesn’t contain fruit, zucchini or marrow. -

    Now change the selection criteria:

    +

    Now change the selection criteria:

    \GlsXtrLoadResources[src=entries.bib,
      see}]
    The glossary now includes fruit, zucchini and marrow. -

    The fruit and zucchini use the

    The fruit and zucchini use the see key which is a simple redirection for the reader. There’s no key which is a simple redirection for the reader. There’s no number list + id="dx1-208031"> for either of these entries. Whereas marrow uses the seealso key, which is typically intended as a + id="dx1-208032"> key, which is typically intended as a supplement to a number list but in this case there are no locations as marrow hasn’t been used in the + id="dx1-208033"> but in this case there are no locations as marrow hasn’t been used in the text. -

    With at least v2.0, there’s an alternative:

    +

    With at least v2.0, there’s an alternative:

    \GlsXtrLoadResources[src=entries.bib,
     selection={recorded and deps also}]
    In this case, the glossary includes fruit and zucchini but not marrow. -

    +

    -

    Top

    18.8 Custom Keys

    -

    + id="x1-209001r25"> +

    🔗sample-newkeys.tex

    -

    This document illustrates how add custom keys (using

    This document illustrates how add custom keys (using \glsaddkey). There are two custom keys ). There are two custom keys ed, where the default value is the text field with “ed” appended, and field with “ed” appended, and ing, where the default value is the text field with “ing” + id="dx1-210003"> field with “ing” appended. Since the default value in both cases references the text field, the starred version field, the starred version \glsaddkey* is required to ensure that the default value is expanded on definition if no alternative has been provided. -

    The entries are then defined as follows: +

    The entries are then defined as follows:

    -
    +   
     \newglossaryentry{jump}{name={jump},description={}}
     \newglossaryentry{run}{name={run},%
      ed={ran},%
    @@ -37976,42 +38080,42 @@ provided.
      ing={waddling},%
      description={}}
     
    -

    -

    Each custom key is provided a set of commands analogous to

    +

    Each custom key is provided a set of commands analogous to \glsentrytext, that allows the key value to be accessed, and \glstext that allows the key value to be access with indexing and hyperlinking (where applicable). -

    If you find yourself wanting to create a lot of custom keys that produce minor variations of existing keys +

    If you find yourself wanting to create a lot of custom keys that produce minor variations of existing keys (such as different tenses) you may find it simpler to just use \glsdisp. When editing the document source, it’s usually simpler to read:

    -
    +   
     The dog \glsdisp{jump}{jumped} over the duck.
     
    -

    than +

    than

    -
    +   
     The dog \glsed{jump} over the duck.
     
    -

    -

    +

    bib2glsIf you want to convert this document to use If you want to convert this document to use bib2gls, you first need to switch to , you first need to switch to glossaries-extra, but remember that you need the record option:

    + id="dx1-210007"> option:

    \usepackage[glossaries-extra
    Next convert the entry definitions to the bib format required by format required by bib2gls: -

    
    + id="dx1-210009">:
    +

    
        
    convertgls2bib --index-conversion --preamble-only sample-newkeys.tex entries.bib

    @@ -38033,19 +38137,19 @@ The --index-conversion switch requires at least v2.0 and will convert entries without a description (or where the description is simply \nopostdesc or or \glsxtrnopostpunc) to ) to @index instead of instead of @entry. This means that + id="dx1-210013">. This means that the new entries.bib file will contain:

    @index{jump,
     }

    @index{run,
     }

    @index{waddle,
     \makeglossaries with
    \GlsXtrLoadResources[src=entries] @@ -38116,9 +38220,9 @@ class="cmtt-10">=entries] class="cmtt-10">\newglossaryentry commands. Finally replace \printglossaries with \printunsrtglossaries. -

    The document build is now: -

    
    + id="dx1-210019">.
    +

    The document build is now: +

    
        
    pdflatex sample-newkeys
    bib2gls sample-newkeys
    pdflatex sample-newkeys @@ -38126,30 +38230,30 @@ class="cmtt-10">\printunsrtglossaries
    Note that there’s no need for the nonumberlist package option when you don’t use package option when you don’t use bib2gls’s ’s --group switch. -

    + id="x1-210022r26"> +

    🔗sample-storage-abbr.tex

    -

    This document illustrates how add custom storage keys (using

    This document illustrates how add custom storage keys (using \glsaddstoragekey). The document build is: -

    
    +

    
        
    pdflatex sample-storage-abbr
    makeglossaries sample-storage-abbr
    pdflatex sample-storage-abbr

    -

    The custom storage key is called

    The custom storage key is called abbrtype which defaults to word if not explicitly set. Its value can be accessed with the provided custom command \abbrtype.

    \glsaddstoragekey{abbrtype}{word}{\abbrtype}
    A custom abbreviation style is then defined that checks the value of this key and makes certain adjustments depending on whether or not its value is the default word. -

    This essentially forms a very similar function to the

    This essentially forms a very similar function to the glossaries-extra package’s category key, which is also + id="dx1-211002"> key, which is also defined as a storage key:

    \glsaddstoragekey{category}{general}{\glscategory}
    -



    glossaries-extraThis document is much simpler with the } class="cmtt-10">\makeglossaries
    \setabbreviationstyle
    [acronym]{short-long}
    \newacronym{radar}{radar}{radio detecting and ranging}
    \newacronym{laser}{laser}{light amplification by of radiation}
    \newacronym{scuba}{scuba}{self-contained underwater breathing @@ -38230,13 +38334,13 @@ class="cmtt-10">apparatus}

    \newabbreviation{dsp}{DSP}{digital signal processing}
    \newabbreviation{atm}{ATM}{automated teller machine} @@ -38271,31 +38375,31 @@ class="cmtt-10">\end{document}

    -

    + id="x1-211010r27"> +

    🔗sample-storage-abbr-desc.tex

    -

    An extension of the previous example where the user needs to provide a description. +

    An extension of the previous example where the user needs to provide a description. -

    + id="x1-212001r28"> +

    🔗sample-chap-hyperfirst.tex

    -

    This document illustrates how to add a custom key using

    This document illustrates how to add a custom key using \glsaddstoragekey and hook into the \gls-like and \glstext-like mechanism used to determine whether or not to hyperlink an entry. The document build is: -

    
    +

    
        
    pdflatex sample-chap-hyperfirst @@ -38308,7 +38412,7 @@ class="cmtt-10">chapter
    used to store the chapter number.

    \glsaddstoragekey{chapter}{0}{}
    It’s initialised to 0 and the \glslinkpostsetkeys hook is used to check this value against the current chapter + id="dx1-213002"> hook is used to check this value against the current chapter number. If the values are the same then the hyperlink is switched off, otherwise the key value is updated unless the hyperlink has been switched off (through the optional argument of commands like \gls and \glstext).
    \renewcommand*{\glslinkpostsetkeys}{%
     \edef\currentchap{\arabic{chapter}}% @@ -38342,9 +38446,9 @@ class="cmtt-10"> \else

      \glsifhyperon{\glsfieldxdef{\glslabel}{chapter}{\currentchap}}{}% @@ -38356,12 +38460,12 @@ class="cmtt-10">}
    Since this key isn’t intended for use when the entry is being defined, it would be more appropriate to simply use an internal field that doesn’t have an associated key or helper command, but \glsfieldxdef requires the + id="dx1-213006"> requires the existence of the field. The glossaries-extra package provides utility commands designed to work on internal fields that don’t have an associated key and may not have had a value assigned. -



    glossaries-extraIf you want to switch to }

    The custom storage key (provided with \glsaddstoragekey) can be removed, and the \glslinkpostsetkeys + id="dx1-213007"> hook can be changed to:
    \renewcommand*{\glslinkpostsetkeys}{%
     \edef\currentchap{\arabic{chapter}}%
     \GlsXtrIfFieldEqNum*{chapter {% class="cmtt-10"> 
      \glsifhyperon{\xGlsXtrSetField
    {\glslabel}{chapter}{\currentchap}}{}% @@ -38425,91 +38529,91 @@ class="cmtt-10">}
    The field name is still called chapter but there’s no longer an associated key or command. -

    +

    -

    Top

    18.9 Xindy (Option 3)

    -

    Most of the earlier

    Most of the earlier makeindex sample files can be adapted to use sample files can be adapted to use xindy instead by adding the instead by adding the xindy package + id="dx1-214003"> package option. Situations that you need to be careful about are when the sort value (obtained from the name if the if the sort + id="dx1-214005"> key is omitted) contains commands (such as name={\pi}) or is identical to another value (or is identical after xindy has stripped all commands and braces). This section describes sample documents that use features which + id="dx1-214006"> has stripped all commands and braces). This section describes sample documents that use features which are unavailable with makeindex. + id="dx1-214007">. -

    + id="x1-214008r29"> +

    🔗samplexdy.tex

    -

    The document uses UTF8 encoding (with the

    The document uses UTF8 encoding (with the inputenc package). This is information that needs to be passed to + id="dx1-215001"> package). This is information that needs to be passed to xindy, so the encoding is picked up by , so the encoding is picked up by makeglossaries from the from the aux file. -

    By default, this document will create a file. +

    By default, this document will create a xindy style file called style file called samplexdy.xdy, but if you uncomment the lines

    -
    +   
     \setStyleFile{samplexdy-mc}
     \noist
     \GlsSetXdyLanguage{}
     
    -

    it will set the style file to

    it will set the style file to samplexdy-mc.xdy instead. This provides an additional letter group for entries starting with “Mc” or “Mac”. If you use makeglossaries or or makeglossaries-lite, you don’t need to supply + id="dx1-215007">, you don’t need to supply any additional information. If you don’t use makeglossaries, you will need to specify the required + id="dx1-215008">, you will need to specify the required information. Note that if you set the style file to samplexdy-mc.xdy you must also specify \noist, + id="dx1-215009">, otherwise the glossaries package will overwrite samplexdy-mc.xdy and you will lose the “Mc” letter group. -

    To create the document do: -

    
    +

    To create the document do: +

    
        
    pdflatex samplexdy
    makeglossaries samplexdy
    pdflatex samplexdy @@ -38518,85 +38622,85 @@ group. If you don’t have Perl installed then you can’t use makeglossaries, but you also can’t use , but you also can’t use xindy! However, if + id="dx1-215011">! However, if for some reason you want to call xindy explicitly instead of using explicitly instead of using makeglossaries (or (or makeglossaries-lite): + id="dx1-215014">):

    • -

      if you are using the default style file

      if you are using the default style file samplexdy.xdy, then do (no line breaks): -

      
      +     

      
            
      xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo

    • -

      if you are using

      if you are using samplexdy-mc.xdy, then do (no line breaks): -

      
      +     

      
            
      xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo

    -

    This document creates a new command to use with the

    This document creates a new command to use with the format key in the optional argument of commands + id="dx1-215015"> key in the optional argument of commands like \gls to format the location in the number list. The usual type of definition when a hyperlinked location is + id="dx1-215016">. The usual type of definition when a hyperlinked location is required should use one of the \hyperxx commands listed in commands listed in table ??tab:hyperxx: +class="cmbx-10">5.1:

    -
    +   
     \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}}
     
    -

    Unfortunately, this definition doesn’t work for this particular document and some adjustments are needed (see +

    Unfortunately, this definition doesn’t work for this particular document and some adjustments are needed (see below). As a result of the adjustments, this command doesn’t actually get used by TeX, even though hyperbfit is used in the format key. It does, however, need to be identified as an attribute so that key. It does, however, need to be identified as an attribute so that xindy can recognise + id="dx1-215019"> can recognise it:

    -
    +   
     \GlsAddXdyAttribute{hyperbfit}
     
    -

    This will add information to the

    This will add information to the xdy file when it’s created by file when it’s created by \makeglossaries. If you prevent the creation of this file with \noist then you will need to add the attribute to your custom then you will need to add the attribute to your custom xdy file (see the provided + id="dx1-215022"> file (see the provided samplexdy-mc.xdy file). -

    In order to illustrate unusual location formats, this sample document provides a command called +

    In order to illustrate unusual location formats, this sample document provides a command called \tallynum{nn⟩:

    -
    +   
     \newrobustcmd*{\tallynum}[1]{%
      \ifnum\number#1<7
       $\csname dice\romannumeral#1\endcsname$%
    @@ -38616,15 +38720,15 @@ class="cmti-10">n⟩:
      \fi
     }
     
    -

    This command needs to be robust to prevent it from being expanded when it’s written to any of the auxiliary +

    This command needs to be robust to prevent it from being expanded when it’s written to any of the auxiliary files. The \dicei, …, , …, \dicevi commands are provided by the stix package, so that needs to be + id="dx1-215024"> package, so that needs to be loaded. -

    An associated command

    An associated command \tally{counter} is defined that formats the value of the named ⟨\tallynum:

    -
    +   
     \newcommand*{\tally}[1]{\tallynum{\arabic{#1}}}
     
    -

    (This shouldn’t be robust as it needs the counter value to expand.) The page numbers are altered to use this +

    (This shouldn’t be robust as it needs the counter value to expand.) The page numbers are altered to use this format (by redefining \thepage). -

    This custom location format also needs to be identified in the ). +

    This custom location format also needs to be identified in the xdy file so that file so that xindy can recognise it and + id="dx1-215027"> can recognise it and determine how to form ranges if required.

    -
    +   
     \GlsAddXdyLocation{tally}{% tally location format
      :sep "\string\tallynum\space\glsopenbrace"
      "arabic-numbers"
      :sep "\glsclosebrace"
     }
     
    -

    Again this information is written to the

    Again this information is written to the xdy file by file by \makeglossaries so if you use \noist then you need to manually add it to your custom xdy file. -

    When file. +

    When xindy creates the associated glossary files, the locations will be written using:

    + id="dx1-215030"> creates the associated glossary files, the locations will be written using:

    \glsXcounterXformat{hyper-prefix}{\tally is changed so that it expands differently then these modifications won’t work. -

    Remember that in both cases, the second argument

    Remember that in both cases, the second argument #2 is in the form \tally{n}:

    -
    +   
     \renewcommand{\glsXpageXglsnumberformat}[2]{%
      \linkpagenumber#2%
     }
    @@ -38722,59 +38826,59 @@ class="cmtt-10">}:
      \textbf{\em\linkpagenumber#2}%
     }
     
    -

    These need a command that can grab the actual number and correctly encapsulate it: +

    These need a command that can grab the actual number and correctly encapsulate it:

    -
    +   
     \newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}}
     
    -

    -

    If you want to try out the

    +

    If you want to try out the samplexdy-mc.xdy file, the entries starting with “Mac” or “Mc” will be placed in their own “Mc” letter group. Ideally it should be possible to do this simply with \GlsAddLetterGroup (and not + id="dx1-215032"> (and not require a custom xdy file) but unfortunately the “M” letter group will have already been defined and take + id="dx1-215033"> file) but unfortunately the “M” letter group will have already been defined and take precedence over “Mc”, which is why a custom file is required and the normal language module must be suppressed:

    -
    +   
     \setStyleFile{samplexdy-mc}
     \noist
     \GlsSetXdyLanguage{}
     
    -

    -

    This “Mc” group is suitable for names like “Maclaurin” but not for “Mach”. To prevent this, the

    +

    This “Mc” group is suitable for names like “Maclaurin” but not for “Mach”. To prevent this, the sort key + id="dx1-215034"> key for that value is set to lower case:

    -
    +   
     \newglossaryentry{mach}{name={Mach, Ernst},
     first={Ernst Mach},text={Mach},
     sort={mach, Ernst},
     description={Czech/Austrian physicist and philosopher}}
     
    -

    -

    +

    bib2glsIf you want to convert this document so that it uses If you want to convert this document so that it uses bib2gls, you first need to switch to + id="dx1-215036">, you first need to switch to glossaries-extra and use the record package option:

    + id="dx1-215037"> package option:

    \usepackage[}
    The xindy-only commands can now all be removed (attribute -only commands can now all be removed (attribute \GlsAddXdyAttribute, location \GlsAddXdyLocation, language \glsXcounterXformat and the + id="dx1-215039"> and the custom helper \linkpagenumber). Also \noist and \setStyleFile aren’t relevant with bib2gls and so should + id="dx1-215040"> and so should be removed. -

    The definitions of

    The definitions of \hyperbfit should be retained (as well as \tallynum, \tally and the redefinition of \thepage). -

    The entries all need to be converted to the

    The entries all need to be converted to the bib format required by format required by bib2gls. -

    
    + id="dx1-215042">.
    +

    
        
    convertgls2bib --preamble-only samplexdy.tex entries.bib

    @@ -38827,29 +38931,29 @@ class="cmtt-10">\makeglossaries with:

    \GlsXtrLoadResources[src=entries]
    and remove all the entry definitions from the preamble. Use the search and replace function on your text editor to replace all instances of \glsentryfirst with with \glsfmtfirst, and all instances of , and all instances of \glsentryname with + id="dx1-215047"> with \glsfmtname. -

    Finally, replace . +

    Finally, replace \printglossaries with with \printunsrtglossaries. The document build is now: -

    
    + id="dx1-215050">. The document build is now:
    +

    
        
    pdflatex samplexdy
    bib2gls --group samplexdy
    pdflatex samplexdy @@ -38857,43 +38961,43 @@ class="cmtt-10">\printunsrtglossaries
    -

    This results in a slightly different ordering from the original document (without the “Mc” letter group). In +

    This results in a slightly different ordering from the original document (without the “Mc” letter group). In the original example, “Mach number” was listed before “Mach, Ernest”. The modified document now has “Mach, Ernest” before “Mach number”. This difference is due to bib2gls’s default ’s default break-at=word setting, + id="dx1-215052"> setting, which marks word boundaries with the pipe (|) character, so the sort values for bib2gls are are Mach|Earnest| and Mach|number|. See the bib2gls manual for further details of this option, and also see the + id="dx1-215054"> manual for further details of this option, and also see the examples chapter of that manual for alternative approaches when creating entries that contain people’s names. -

    If you want the “Mc” letter group, it can be obtained by providing a custom sort rule:

    +

    If you want the “Mc” letter group, it can be obtained by providing a custom sort rule:

    \GlsXtrLoadResources[src=entries,
       sort=custom, @@ -38904,34 +39008,34 @@ class="cmtt-10"> sort-rule={\glsxtrcontrolrules + id="dx1-215058">
       ;\glsxtrspacerules;\glsxtrnonprintablerules + id="dx1-215060">
       ;\glsxtrcombiningdiacriticrules,\glsxtrhyphenrules + id="dx1-215062">
       <\glsxtrgeneralpuncrules<\glsxtrdigitrules + id="dx1-215064">
      ]
    Unfortunately, as with xindy, this puts “Mach” into the “Mc” letter group. -

    One way to get around this problem is to define a custom command to help identify genuine “Mc”/“Mac” + id="dx1-215065">, this puts “Mach” into the “Mc” letter group. +

    One way to get around this problem is to define a custom command to help identify genuine “Mc”/“Mac” prefixes with names that happen to start with “Mac”. For example:

    @entry{mcadam,
     }

    @entry{maclaurin,
     }
    @entry{mach,
     }
    With LaTeX, this command should simply do its argument: -
    +   
     \newcommand{\Mac}[1]{#1}
     
    -

    However, when

    However, when bib2gls works out the works out the sort value, it needs to be defined with something unique that won’t + id="dx1-215070"> value, it needs to be defined with something unique that won’t happen to occur at the start of another term. For example:

    -
    +   
     \providecommand{\Mac}[1]{MC}
     
    -

    (Remember that

    (Remember that break-at=word will strip spaces and punctuation so don’t include them unless you switch to + id="dx1-215071"> will strip spaces and punctuation so don’t include them unless you switch to break-at=none.) -

    So add the first definition of .) +

    So add the first definition of \Mac to the tex file and modify file and modify entries.bib so that it includes the second definition:

    @preamble{"\providecommand{\Mac}[1]{MC}"}
    Then modify the “Mc”/“Mac” entries as appropriate (see the above “McAdam” and “Maclaurin” examples). -

    The custom sort rule needs to be modified:

    +

    The custom sort rule needs to be modified:

    \GlsXtrLoadResources[src=entries,
        sort=custom,
       sort-rule={\glsxtrcontrolrules + id="dx1-215079">
       ;\glsxtrspacerules;\glsxtrnonprintablerules + id="dx1-215081">
       ;\glsxtrcombiningdiacriticrules,\glsxtrhyphenrules + id="dx1-215083">
       <\glsxtrgeneralpuncrules<\glsxtrdigitrules + id="dx1-215085">
      ]
    This will create a “Mc” letter group that only includes the names that start with the custom \Mac command. -

    Other alternatives include moving

    Other alternatives include moving @preamble into a separate into a separate bib file, so that you can choose + id="dx1-215087"> file, so that you can choose whether or not to include it. See the “Examples” chapter of the bib2gls user manual for further + id="dx1-215088"> user manual for further examples. -

    + id="x1-215089r30"> +

    🔗samplexdy2.tex

    -

    This document illustrates how to use the

    This document illustrates how to use the glossaries package where the location numbers don’t follow a standard format. This example will only work with xindy. To create the document do: + id="dx1-216001">. To create the document do: -

    
    +

    
        
    pdflatex samplexdy2
    makeglossaries samplexdy2
    pdflatex samplexdy2 @@ -39217,8 +39321,8 @@ class="cmtt-10">xindy
    xindy call is: -

    
    + id="dx1-216002"> call is:
    +

    
        
    xindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.glg -o samplexdy2.gls samplexdy2.glo

    @@ -39226,74 +39330,74 @@ This example uses the section counter with xindy: + id="dx1-216003">:

    -
    +   
     \usepackage[xindy,counter=section]{glossaries}
     
    -

    The document employs an eccentric section numbering system for illustrative purposes. The section numbers +

    The document employs an eccentric section numbering system for illustrative purposes. The section numbers are prefixed by the chapter number in square brackets:

    -
    +   
     \renewcommand*{\thesection}{[\thechapter]\arabic{section}}
     
    -

    Parts use Roman numerals: +

    Parts use Roman numerals:

    -
    +   
     \renewcommand*{\thepart}{\Roman{part}}
     
    -

    The section hyperlink name includes the part: +

    The section hyperlink name includes the part:

    -
    +   
     \renewcommand*{\theHsection}{\thepart.\thesection}
     
    -

    This custom numbering scheme needs to be identified in the

    This custom numbering scheme needs to be identified in the xdy file: + id="dx1-216004"> file:

    -
    +   
     \GlsAddXdyLocation["roman-numbers-uppercase"]{section}{:sep "["
       "arabic-numbers" :sep "]" "arabic-numbers"
     }
     
    -

    If the part is 0 then

    If the part is 0 then \thepart will be empty (there isn’t a zero Roman numeral). An extra case is needed to catch this:

    -
    +   
     \GlsAddXdyLocation{zero.section}{:sep "["
       "arabic-numbers" :sep "]" "arabic-numbers"
     }
     
    -

    Note that this will stop xindy giving a warning, but the location hyperlinks will be invalid if no

    Note that this will stop xindy giving a warning, but the location hyperlinks will be invalid if no \part is used. -

    bib2glsIf you want to switch to If you want to switch to bib2gls, you first need to switch to , you first need to switch to glossaries-extra but remember to use record instead of instead of xindy:

    + id="dx1-216008">:

    \usepackage[}
    Next remove the \GlsAddXdyLocation commands and convert the entry definitions to the bib format required + id="dx1-216009"> format required by bib2gls: -

    
    + id="dx1-216010">:
    +

    
        
    convertgls2bib --preamble-only samplexdy2.tex entries.bib

    @@ -39319,10 +39423,10 @@ class="cmtt-10">\makeglossaries with:

    \GlsXtrLoadResources[src=entries]
    and remove the \newglossaryentry commands. Finally, replace \printglossaries with \printunsrtglossaries. -

    The document build is: -

    
    + id="dx1-216013">.
    +

    The document build is: +

    
        
    pdflatex samplexdy2
    bib2gls samplexdy2
    pdflatex samplexdy2

    -

    With unusual numbering systems, it’s sometimes better to use

    With unusual numbering systems, it’s sometimes better to use record=nameref:

    + id="dx1-216014">:

    \usepackage[ \newcommand*{\glsxtrsectionlocfmt}[2]{#1}
    (Make sure you have at least v1.42 of glossaries-extra.) See also the earlier sampleSec.tex. -

    + id="x1-216016r31"> +

    🔗samplexdy3.tex

    -

    This document is very similar to

    This document is very similar to samplexdy.tex but uses the command \Numberstring from the fmtcount package to format the page numbers instead of the package to format the page numbers instead of the \tally command from the earlier example. -

    + id="x1-217002r32"> +

    🔗sampleutf8.tex

    -

    This is another example that uses

    This is another example that uses xindy. Unlike . Unlike makeindex, , xindy can cope with can cope with non-Latin characters. This + id="dx1-218004">s. This document uses UTF-8 encoding. To create the document do: -

    
    +

    
        
    pdflatex sampleutf8
    makeglossaries sampleutf8
    pdflatex sampleutf8 @@ -39416,8 +39520,8 @@ href="#glo:UTF-8">UTF-8 encoding. To create the document do: The explicit xindy call is (no line breaks): -

    + id="dx1-218005"> call is (no line breaks): +

    
     
    xindy -L @@ -39437,18 +39541,18 @@ sampleutf8.gls sampleutf8.glo

    -

    If you remove the

    If you remove the xindy option from option from sampleutf8.tex and do: -

    
    +

    
        
    pdflatex sampleutf8
    makeglossaries sampleutf8
    pdflatex sampleutf8

    or -

    
    +

    
        
    pdflatex sampleutf8
    makeglossaries-lite sampleutf8
    pdflatex sampleutf8 @@ -39456,30 +39560,30 @@ or
    you will see that the entries that start with an extended Latin character now appear in the symbols group, and + id="dx1-218007"> now appear in the symbols group, and the word “manœuvre” is now after “manor” instead of before it. If you want to explicitly call makeindex (no + id="dx1-218008"> (no line breaks): -

    
    +

    
        
    makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo

    -

    bib2glsIf you want to switch to If you want to switch to bib2gls, you first need to switch to , you first need to switch to glossaries-extra but replace xindy with + id="dx1-218011"> with record:

    + id="dx1-218012">:

    \usepackage[}
    Note that you don’t need the nonumberlist option with option with bib2gls. You can instruct . You can instruct bib2gls to + id="dx1-218015"> to simply not save the number lists, but in this case there won’t be any locations as there’s no actual + id="dx1-218016">s, but in this case there won’t be any locations as there’s no actual indexing. -

    The entries need to be converted to the

    The entries need to be converted to the bib format required by format required by bib2gls: -

    
    + id="dx1-218018">:
    +

    
        
    convertgls2bib --preamble-only --texenc UTF-8 --bibenc UTF-8 sampleutf8.tex entries.bib

    @@ -39527,77 +39631,77 @@ class="cmtt-10"> UTF-8
    This is the encoding of the bib file. It doesn’t have to match the encoding of the file. It doesn’t have to match the encoding of the tex file, but it’s generally + id="dx1-218020"> file, but it’s generally better to be consistent. When bib2gls parses this file, it will look for this encoding line. (If the parses this file, it will look for this encoding line. (If the --texenc and --bibenc switches aren’t used, convertgls2bib will assume your system’s default encoding. See the will assume your system’s default encoding. See the bib2gls + id="dx1-218023"> manual for further details.) -

    Next replace

    Next replace \makeglossaries with:

    \GlsXtrLoadResources[src=entries,selection=all]
    and remove all the \newglossaryentry commands. -

    Iterative commands like

    Iterative commands like \glsaddall don’t work with don’t work with bib2gls. Instead, you can select all entries using the + id="dx1-218028">. Instead, you can select all entries using the selection=all option. This is actually better than option. This is actually better than \glsaddall, which enforces the selection of all entries by indexing each entry. As a result, with makeindex and and xindy (and (and Option 1), every entry will have the same location (which is the location of the \glsaddall command, in this case page 1). With selection=all, + id="dx1-218032">, bib2gls will automatically selection all entries even if they don’t have any records (indexing information) so in + id="dx1-218033"> will automatically selection all entries even if they don’t have any records (indexing information) so in this case there are no number lists. -

    Finally, replace s. +

    Finally, replace \printglossaries with \printunsrtglossaries. The build process is now: -

    
    + id="dx1-218035">. The build process is now:
    +

    
        
    pdflatex sampleutf8
    bib2gls --group sampleutf8
    pdflatex sampleutf8 @@ -39606,59 +39710,59 @@ class="cmtt-10">\printunsrtglossaries
    bib2gls picks up the encoding of the picks up the encoding of the tex file from the file from the aux file:

    + id="dx1-218038"> file:

    \glsxtr@texencoding{utf8}
    If you experience any encoding issues, check the aux file for this command and check the file for this command and check the bib file for the + id="dx1-218041"> file for the encoding comment line. Also check bib2gls’s ’s glg transcript file for encoding messages, which should look + id="dx1-218043"> transcript file for encoding messages, which should look like: -
    +   
     TeX character encoding: UTF-8
     
    -

    -

    The document language, if it has been set, is also added to the

    +

    The document language, if it has been set, is also added to the aux file when the file when the record option is used. In + id="dx1-218045"> option is used. In this case, no language package has been used, so bib2gls will fallback on the system’s default locale. If no sort + id="dx1-218046"> will fallback on the system’s default locale. If no sort method is set, the entries will be sorted according to the document language, if set, or the default locale. You can specify a specific locale using the sort key with a locale tag identifier. For example: + id="dx1-218047"> key with a locale tag identifier. For example:

    \GlsXtrLoadResources[src=entries,selection=all,]
    \GlsXtrLoadResources[src=entries,selection=all,=is]
    (Icelandic). -

    +

    -

    Top

    18.10 No Indexing Application (Option 1)

    -

    + id="x1-219001r33"> +

    🔗sample-noidxapp.tex

    -

    This document illustrates how to use the

    This document illustrates how to use the glossaries package without an external indexing application (Option 1). To create the complete document, you need to do: -

    
    +

    
        
    pdflatex sample-noidxapp
    pdflatex sample-noidxapp

    Note the need to group the accent command that occurs at the start of the name:

    + id="dx1-220001">:

    @@ -39720,7 +39824,7 @@ class="cmtt-10">\newglossaryentry{elite}{% class="cmtt-10">  name={{\'e}lite},
    }
    This is necessary to allow the term to work with \Gls. Notice also how the . Notice also how the number lists can’t be compacted + id="dx1-220004">s can’t be compacted into ranges. For example, the list “1, 2, 3” would be converted to “1–3” with a proper indexing application (Options 2 or 3 or, with glossaries-extra, Option 4). -

    The larger the list of entries, the longer the document build time. This method is very inefficient for large +

    The larger the list of entries, the longer the document build time. This method is very inefficient for large glossaries. See Gallery: glossaries performance for a comparison. -

    + id="x1-220005r34"> +

    🔗sample-noidxapp-utf8.tex

    -

    As the previous example, except that it uses the

    As the previous example, except that it uses the inputenc package. To create the complete document, you need + id="dx1-221001"> package. To create the complete document, you need to do: -

    
    +

    
        
    pdflatex sample-noidxapp-utf8
    pdflatex sample-noidxapp-utf8
    @@ -39770,22 +39874,22 @@ href="#glo:nonlatinalph">non-Latin alphabets. Use Options 3 or 4 instead. -

    +

    -

    Top

    18.11 Other

    -

    + id="x1-222001r35"> +

    🔗sample4col.tex

    -

    This document illustrates a four column glossary where the entries have a symbol in addition to the name and +

    This document illustrates a four column glossary where the entries have a symbol in addition to the name and description. To create the complete document, you need to do: -

    
    +

    
        
    pdflatex sample4col
    makeglossaries sample4col
    pdflatex sample4col @@ -39794,7 +39898,7 @@ description. To create the complete document, you need to do:

    or -

    
    +

    
        
    pdflatex sample4col
    makeglossaries-lite sample4col
    pdflatex sample4col @@ -39803,28 +39907,28 @@ or The vertical gap between entries is the gap created at the start of each group. This can be suppressed using the nogroupskip package option. (If you switch to package option. (If you switch to bib2gls, simply omit the , simply omit the --group command line option.) -

    This example uses the

    This example uses the long4colheaderborder. This style doesn’t allow multi-line descriptions. You may prefer + id="dx1-223003">. This style doesn’t allow multi-line descriptions. You may prefer to use altlong4colheaderborder with long descriptions. However, in either case a style that uses with long descriptions. However, in either case a style that uses booktabs is + id="dx1-223005"> is preferable. For example, long4col-booktabs or or altlongragged4col-booktabs. Note that this requires + id="dx1-223007">. Note that this requires glossary-longbooktabs, which needs to be explicitly loaded. The style can only be set once this package has been + id="dx1-223008">, which needs to be explicitly loaded. The style can only be set once this package has been loaded:

    \usepackage{glossary-longbooktabs} class="cmtt-10">\setglossarystyle{altlongragged4col-booktabs}
    -



    glossaries-extraThe glossaries-extra package provides a more compact way of doing this with the stylemods + id="dx1-223009"> option:

    } href="#glo:glossaries-extra">glossaries-extra package provides additional styles, including more “long” styles with the glossary-longextra + id="dx1-223010"> package. For example, the long-name-desc-sym-loc style:
    + id="dx1-223011"> style:
    \usepackage[style={glossaries-extra}
    If you use the stylemods option with an argument, you may prefer to use it with option with an argument, you may prefer to use it with nostyles to prevent unwanted + id="dx1-223013"> to prevent unwanted styles from being automatically loaded. For example:
    @@ -39898,18 +40002,18 @@ class="cmtt-10">{glossaries-extra}
    See also the gallery of predefined styles. -

    + id="x1-223014r36"> +

    🔗sample-numberlist.tex

    -

    This document illustrates how to reference the

    This document illustrates how to reference the number list in the document text. This requires an additional + id="dx1-224001"> in the document text. This requires an additional LaTeX run: -

    
    +

    
        
    pdflatex sample-numberlist
    makeglossaries sample-numberlist
    pdflatex sample-numberlist @@ -39918,39 +40022,39 @@ LaTeX run:
    This uses the savenumberlist package option, which enables package option, which enables \glsentrynumberlist and and \glsdisplaynumberlist + id="dx1-224004"> (with limitations). The location counter is set to chapter, so the number list refers to the chapter + id="dx1-224005"> refers to the chapter numbers.

    -
    +   
     \usepackage[savenumberlist,counter=chapter]{glossaries}
     
    -

    The

    The number list can’t be obtained until can’t be obtained until makeindex (or (or xindy) has created the glossary file. The ) has created the glossary file. The number list is + id="dx1-224009"> is picked up when this file is input by \printglossary and is then saved in the aux file so that it’s available on + id="dx1-224010"> file so that it’s available on the next LaTeX run. -

    This document contains both commands:

    +

    This document contains both commands:

    This discussed in chapters~\glsdisplaynumberlist{sample}
    (or \glsentrynumberlist{sample}).
    Without hyperref, the first list shows as “1–3, 5 & 6” and the second list shows as “1–3, 5, 6”. -

    Note that you can’t use , the first list shows as “1–3, 5 & 6” and the second list shows as “1–3, 5, 6”. +

    Note that you can’t use \glsdisplaynumberlist with with hyperref and Options  and Options 2 or 3. If you do, you will get the warning:

    -
    +   
     Package glossaries Warning: \glsdisplaynumberlist doesn't work with
     hyperref.
     Using \glsentrynumberlist instead
     
    -

    Now both lists show as “1–3, 5, 6”. -

    If you switch to

    Now both lists show as “1–3, 5, 6”. +

    If you switch to Option 1 (replace \makeglossaries with \makenoidxglossaries and replace \printglossaries with \printnoidxglossaries), then the document build is simply: -

    
    +

    
        
    pdflatex sample-numberlist
    pdflatex sample-numberlist

    Now \glsdisplaynumberlist works with works with hyperref, however there are no ranges, so the first list shows as “1, 2, + id="dx1-224017">, however there are no ranges, so the first list shows as “1, 2, 3, 5, & 6” and the second list shows as “1, 2, 3, 4, 5, 6”. -

    bib2glsIf you want to switch to If you want to switch to bib2gls, you first need to switch to , you first need to switch to glossaries-extra (at least v1.42) but remember to include the record option:

    + id="dx1-224020"> option:

    \usepackage[}
    Note that the savenumberlist option is no longer required. Next convert the entry to the option is no longer required. Next convert the entry to the bib format required by + id="dx1-224022"> format required by bib2gls: -

    
    + id="dx1-224023">:
    +

    
        
    convertgls2bib sample-numberlist.tex entries.bib

    @@ -40050,10 +40154,10 @@ class="cmtt-10">\makeglossaries with:

    \GlsXtrLoadResources[src=entries.bib]
    and remove the \newglossaryentry command from the document preamble. Fin \printglossaries with \printunsrtglossaries. The build process is now: -

    
    + id="dx1-224026">. The build process is now:
    +

    
        
    pdflatex sample-numberlist
    bib2gls sample-numberlist
    pdflatex sample-numberlist @@ -40075,93 +40179,93 @@ You can also use:

    \glsxtrfieldformatlist{sample}{loclist}
    which will show the complete list without ranges “1, 2, 3, 5 & 6”. -

    This method works much better than using the

    This method works much better than using the savenumberlist option because option because bib2gls saves the formatted + id="dx1-224029"> saves the formatted number list in the in the location field (which is an internal field provided by field (which is an internal field provided by glossaries-extra for the benefit of bib2gls) and the unformatted ) and the unformatted number list in the in the loclist internal field (which is also used by + id="dx1-224034"> internal field (which is also used by Option 1). -

    With Options 

    With Options 2 and 3, both makeindex and and xindy simply create a file containing the commands to typeset + id="dx1-224036"> simply create a file containing the commands to typeset the glossary, which is input by \printglossary. This means that it’s quite hard to gather information obtained by the indexing application. -

    bib2gls, on the other hand, doesn’t write a file containing the glossary. It writes a file containing the entry + id="dx1-224037">, on the other hand, doesn’t write a file containing the glossary. It writes a file containing the entry definitions and uses internal fields to save the indexing information. The glossary is then displayed with \printunsrtglossary, which simply iterates over all defined entries and fetches the required information from + id="dx1-224038">, which simply iterates over all defined entries and fetches the required information from those internal fields. -

    The

    The \glsdisplaynumberlist and and \glsentrynumberlist commands are redefined by commands are redefined by glossaries-extra-bib2gls + id="dx1-224041"> to simply access the location field. However, if you want a complete list without ranges you can use: + id="dx1-224042"> field. However, if you want a complete list without ranges you can use:

    \glsxtrfieldformatlist{sample}{loclist}
    In this example, this produces “1, 2, 3, 5 & 6”. -

    Note the difference if you use the

    Note the difference if you use the record=nameref package option instead of just package option instead of just record. + id="dx1-224045">. -

    + id="x1-224046r37"> +

    🔗sample-nomathhyper.tex

    -

    This document illustrates how to selectively enable and disable entry hyperlinks in

    This document illustrates how to selectively enable and disable entry hyperlinks in \glsentryfmt. The + id="dx1-225001">. The document build is: -

    
    +

    
        
    pdflatex sample-nomathhyper
    makeglossaries sample-nomathhyper
    pdflatex sample-nomathhyper @@ -40171,7 +40275,7 @@ This disables the hyperlinks for the main glossary with:

    \GlsDeclareNoHyperList{main} @@ -40180,9 +40284,9 @@ class="cmtt-10">{main} class="cmtt-10">\glsentryfmt so that it adds a hyperlink if not in maths mode and the hyperlinks haven’t been forced off (with the hyper=false key). -



    glossaries-extraIf you want to switch to \makeglossaries
    \renewcommand{\glslinkpresetkeys
    }{%
     \ifmmode definition

    -

    + id="x1-225005r38"> +

    🔗sample-entryfmt.tex

    -

    This document illustrates how to change the way an entry is displayed in the text. (This is just a test document. +

    This document illustrates how to change the way an entry is displayed in the text. (This is just a test document. For a real document, I recommend you use the siunitx package to typeset units.) The document build + id="dx1-226001"> package to typeset units.) The document build is: -

    
    +

    
        
    pdflatex sample-entryfmt
    makeglossaries sample-entryfmt
    pdflatex sample-entryfmt @@ -40235,7 +40339,7 @@ is:
    This redefines \glsentryfmt to add the symbol on to add the symbol on first use:

    \renewcommand*{\glsentryfmt}{%
      \glsgenentryfmt + id="dx1-226003">
      \ifglsused{\glslabel}{}{\space (\glsentrysymbol
    {\glslabel})}%
    } @@ -40261,8 +40365,8 @@ class="cmtt-10">\glsentrysymbol not \glssymbol (which would result in nested link text). -


    ). +


    glossaries-extraIf you want to switch to the \makeglossaries

    \glsdefpostlink
    {unit}{\glsxtrpostlinkAddSymbolOnFirstUse}

    symbol={km}}

    Note that in this case the symbol is now outside of the hyperlink. -

    + id="x1-226009r39"> +

    🔗sample-prefix.tex

    -

    This document illustrates the use of the

    This document illustrates the use of the glossaries-prefix package. An additional run is required to ensure the + id="dx1-227001"> package. An additional run is required to ensure the table of contents is up-to-date: -

    
    +

    
        
    pdflatex sample-prefix
    makeglossaries sample-prefix
    pdflatex sample-prefix @@ -40333,7 +40437,7 @@ Remember that the default separator between the prefix and \gls (or one of its variants) is empty, so if a space is required it must be inserted at the end of the prefix. However, the xkeyval package (which is used to parse the + id="dx1-227002"> package (which is used to parse the ⟨key=\space}}
    -



    glossaries-extraIf you want to convert this example to use glossaries-extra, then (as from v1.42) you can use the prefix option:

    + id="dx1-227003"> option:

    \usepackage[}
    (Alternatively load glossaries-prefix after after glossaries-extra.) The rest of the document is the same as for the base glossaries package, unless you want to switch to using bib2gls. -

    . +

    bib2glsIf you want to switch to If you want to switch to bib2gls, first switch to , first switch to glossaries-extra (as above) but make sure you include the record package option:

    + id="dx1-227008"> package option:

    \usepackage[,acronym]{glossaries-extra}
    Next convert the entries into the bib format required by format required by bib2gls: -

    
    + id="dx1-227010">:
    +

    
        
    convertgls2bib --preamble-only sample-prefix.tex entries.bib

    @@ -40444,14 +40548,14 @@ class="cmtt-10">\makeglossaries with

    \setabbreviationstyle[acronym]{long-short}
    \GlsXtrLoadResources[src=entries]
    remove the entry definitions from the preamble, and replace
    @@ -40465,29 +40569,29 @@ class="cmtt-10">\printacronyms
    \printunsrtglossary[style=plist]
    \printunsrtacronyms + id="dx1-227015">
    The document build is now: -

    
    +

    
        
    pdflatex sample-prefix
    bib2gls sample-prefix
    pdflatex sample-prefix

    -

    With

    With bib2gls v2.0+, you don’t need to manually insert the spaces at the end of the prefixes. Instead you + id="dx1-227016"> v2.0+, you don’t need to manually insert the spaces at the end of the prefixes. Instead you can instruct bib2gls to insert them. To try this out, remove the trailing to insert them. To try this out, remove the trailing ~ and \space from the entries.bib @@ -40495,7 +40599,7 @@ file:

    @entry{sample,
     }

    @entry{oeil,
     }

    @acronym{svm,
     }
    Now add the append-prefix-field={space or nbsp} resource option:
    + id="dx1-227021"> resource option:
    \GlsXtrLoadResources[src=entries,append-prefix-field={space]
    See the bib2gls manual for further details. + id="dx1-227024"> manual for further details. + id="x1-227025r40"> -

    +

    🔗sampleaccsupp.tex

    -

    This document uses the

    This document uses the glossaries-accsupp package (see package (see §??sec:accsupp 17 Accessibility Support). That package automatically loads glossaries and passes all options to the base package. So you can load both packages at once @@ -40626,37 +40730,37 @@ with just:

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

    This provides additional keys that aren’t available with just the base package, which may be used to provide +

    This provides additional keys that aren’t available with just the base package, which may be used to provide replacement text. The replacement text is inserted using accsupp’s ’s \BeginAccSupp and and \EndAccSupp + id="dx1-228004"> commands. See the accsupp package for further details of those commands. -

    Note that this example document is provided to demonstrate package for further details of those commands. +

    Note that this example document is provided to demonstrate glossaries-accsupp as succinctly as possible. The + id="dx1-228006"> as succinctly as possible. The resulting document isn’t fully accessible as it’s not tagged. See the accessibility and and tagpdf packages for further + id="dx1-228008"> packages for further information about tagging documents. -

    It’s not essential to use

    It’s not essential to use glossaries-accsupp. You can simply insert the replacement text directly into the field + id="dx1-228009">. You can simply insert the replacement text directly into the field values. For example:

    -
    +   
     \newglossaryentry{Drive}{
      name={\BeginAccSupp{Actual=Drive}Dr.\EndAccSupp{}},
      description={Drive}
    @@ -40668,34 +40772,34 @@ values. For example:
       [height=20pt]{example-image}\protect\EndAccSupp{}}
     }
     
    -

    However, this can cause interference (especially with case-changing). With

    However, this can cause interference (especially with case-changing). With glossaries-accsupp it’s possible to + id="dx1-228010"> it’s possible to obtain the field values without the accessibility information if required. (If in the future \includegraphics is given extra options to provide replacement text then the image example here won’t be necessary. However, the example can be adapted for images created with TeX code.) -

    The acronym style is set using: +

    The acronym style is set using:

    -
    +   
     \setacronymstyle{long-short}
     
    -

    The first abbreviation is straightforward: +

    The first abbreviation is straightforward:

    -
    +   
     \newacronym{eg}{e.g.}{for example}
     
    -

    The

    The shortaccess replacement text is automatically set to the long form. The next abbreviation is awkward as + id="dx1-228011"> replacement text is automatically set to the long form. The next abbreviation is awkward as the long form contains formatting commands which can’t be included in the replacement text. This means that the shortaccess key must be supplied:

    + id="dx1-228012"> key must be supplied:

    \newacronym[ Zeichenprogramm}
    In the above two cases, the short form obtained in \gls will use the “E” PDF element. -

    By way of comparison, there are some entries that are technically abbreviations but are defined using +

    By way of comparison, there are some entries that are technically abbreviations but are defined using \newglossaryentry instead of instead of \newacronym. The replacement text is provided in the . The replacement text is provided in the access key: + id="dx1-228015"> key:

    access={Drive}}
    These will use PDF’s “ActualText” element (not “E”). -

    The next entry is a symbol (the integration symbol

    The next entry is a symbol (the integration symbol ). This could be defined simply as:

    -
    +   
     \newglossaryentry{int}{name={int},description={integral},
      symbol={\ensuremath{\int}}}
     
    -

    and then referenced in the text like this: +

    and then referenced in the text like this:

    -
    +   
     Symbol: \gls{int} (\glssymbol{int}).
     
    -

    This results in the text “Symbol: integral (

    This results in the text “Symbol: integral ( ).” However if you copy and paste this from the PDF you will find the resulting text is “Symbol: int (R).” This is what’s actually read out by the text-to-speech system. -

    It would be better if the actual text was the Unicode character 0x222B. This would not only assist the +

    It would be better if the actual text was the Unicode character 0x222B. This would not only assist the text-to-speech system but also make it easier to copy and paste the text. The simplest method is to identify the character by its hexadecimal code, but in order to do this the \BeginAccSupp command needs to have the + id="dx1-228016"> command needs to have the options adjusted. -

    In order to determine whether to use “E”, “ActualText” or “Alt” for a particular field,

    In order to determine whether to use “E”, “ActualText” or “Alt” for a particular field, glossaries-accsupp will + id="dx1-228017"> will check if the command \glsfieldaccsupp exists (where ⟨ exists (where ⟨field⟩ is the internal field label, see table ??tab:fieldmap). +class="cmbx-10">4.1). Only two of these commands are predefined: \glsshortaccsupp and and \glsshortplaccsupp, which is why the + id="dx1-228020">, which is why the shortaccess field uses “E”. If the given command doesn’t exist then the generic field uses “E”. If the given command doesn’t exist then the generic \glsaccsupp command is used + id="dx1-228022"> command is used instead. -

    This means that in order to simply set

    This means that in order to simply set symbolaccess to the hexadecimal character code, I need to provide a + id="dx1-228023"> to the hexadecimal character code, I need to provide a command called \glssymbolaccsupp:

    + id="dx1-228024">:

    \newcommand{\glssymbolaccsupp}[2]{%
     \glsaccessibility[method=hex,unicode]{symbolaccess={222B} class="cmtt-10">}
    -

    The final entry has an image stored in the

    The final entry has an image stored in the user1 key. (The image file is provided with the key. (The image file is provided with the mwe + id="dx1-228027"> package.) This should use “Alt” instead of “ActualText” so I need to define \glsuseriaccsupp: + id="dx1-228028">:

    accsupp}[2]{%
      \glsaccessibility{Alt}{#1}{#2}% @@ -40848,7 +40952,7 @@ class="cmtt-10">}
    The image description is provided in the user1access key:
    + id="dx1-228030"> key:
    \newglossaryentry{sampleimage}{name={sample example image},
     user1={\protect\includegraphics[height=20pt]{example-image}},
     }
    (Note the need to protect the fragile \includegraphics. The alternative is to use . The alternative is to use \glsnoexpandfields before defining the command. See §??sec:expansion 4.4 Expansion.) -

    If you try this example and inspect the +

    If you try this example and inspect the PDF18.4 then + id="x1-228033f4"> then you will find content like:

    -
    +   
     /Span << /ActualText (Doctor) >> BDC
       BT
         /F8 9.9626 Tf
    @@ -40898,7 +41002,7 @@ you will find content like:
       ET
     EMC
     
    -

    This shows that “ActualText” was used for

    This shows that “ActualText” was used for \gls{Doctor}. The integral symbol ( ) created with @@ -40907,7 +41011,7 @@ class="cmtt-10">\glssymbol{int} is:

    -
    +   
     /Span << /ActualText (\376\377"+) >> BDC
       BT
         /F1 9.9626 Tf
    @@ -40916,13 +41020,13 @@ class="cmtt-10">\glssymbol{int} is:
       ET
     EMC
     
    -

    Again, “ActualText” has been used, but the character code has been supplied. The image created with +

    Again, “ActualText” has been used, but the character code has been supplied. The image created with \glsuseri{sampleimage} is:

    -
    +   
     /Span << /Alt (a boilerplate image used in examples) >> BDC
       1 0 0 1 106.588 618.391 cm
       q
    @@ -40934,14 +41038,14 @@ class="cmtt-10">\glsuseri{sampleimage} is:
       Q
     EMC
     
    -

    This shows that “Alt” has been used. -

    The first use of

    This shows that “Alt” has been used. +

    The first use of \gls{eg} produces the long form (not reproduced here) followed by the short form:

    -
    +   
     /Span << /E (for example) >> BDC
       BT
         /F8 9.9626 Tf
    @@ -40950,11 +41054,11 @@ form:
       ET
     EMC
     
    -

    The subsequent use also has the “E” element: +

    The subsequent use also has the “E” element:

    -
    +   
     /Span << /E (for example) >> BDC
       BT
         /F8 9.9626 Tf
    @@ -40963,42 +41067,42 @@ EMC
       ET
     EMC
     
    -

    Similarly for

    Similarly for \acrshort{eg}. You can also use the debug=showaccsupp package option. This will show + id="dx1-228034"> package option. This will show the replacement text in the document, but note that this is the content before it’s processed by \BeginAccSupp. -

    If the

    If the \setacronymstyle command is removed (or commented out) then the result would be different. The + id="dx1-228035"> command is removed (or commented out) then the result would be different. The first use of \gls uses “E” for the short form but the subsequent use has “ActualText” instead. This is because without \setacronymstyle the original acronym mechanism is used, which is less sophisticated than the newer + id="dx1-228036"> the original acronym mechanism is used, which is less sophisticated than the newer acronym mechanism that’s triggered with \setacronymstyle. -

    If you want to convert this example so that it uses . +

    If you want to convert this example so that it uses glossaries-extra, make sure you have at least version 1.42 of the extension package.
    -

    -


    +


    glossaries-extraIf you want to convert this example so that it uses glossaries-extra, you need to replace the explicit loading of glossaries-accsupp with an implicit load through the with an implicit load through the accsupp package option: + id="dx1-228039"> package option:

    }
    I’m switching from \newacronym to to \newabbreviation, which means that the default category is , which means that the default category is abbreviation + id="dx1-228042"> and also the file extensions are different. If you are using makeglossaries or or makeglossaries-lite you don’t + id="dx1-228044"> you don’t need to worry about it. However, if you’re not using those helper scripts then you will need to adjust the file extensions in your document build process. -

    The style command

    The style command \setacronymstyle{long-short} needs to be replaced with:

    \setabbreviationstyle{long-short}
    This is actually the default so you can simply delete the \setacronymstyle line. Substitute the two instances of \newacronym with with \newabbreviation. For example:
    + id="dx1-228047">. For example:
    \newabbreviation{eg}{e.g.}{for example} @@ -41053,7 +41157,7 @@ class="cmtt-10"> example}
    Note that for the tikz entry you can now remove the explicit assignment of shortaccess with with glossaries-extra v1.42 as it will strip formatting commands like \emph:
    \newabbreviation + id="dx1-228050">
     {tikz}{Ti\emph{k}Z}{Ti\emph{k}Z ist\acrshort, \acrlong and \acrfull with \glsxtrshort, , \glsxtrlong and + id="dx1-228052"> and \glsxtrfull. -

    You may notice a slight difference from the original example. The . +

    You may notice a slight difference from the original example. The shortaccess field now shows ⟨ field now shows ⟨long⟩ (⟨short⟩) instead of just ⟨long⟩. This is because glossaries-extra redefines \glsdefaultshortaccess to include the short + id="dx1-228055"> to include the short form. -

    Now that the extension package is being used, there are some other modifications that would tidy up the +

    Now that the extension package is being used, there are some other modifications that would tidy up the code and fix a few issues. -

    The “Doctor” and “Drive” entries should really be defined as abbreviations but they shouldn’t be +

    The “Doctor” and “Drive” entries should really be defined as abbreviations but they shouldn’t be expanded on first use. The short-nolong style can achieve this and it happens to be the default style + id="dx1-228056"> style can achieve this and it happens to be the default style for the acronym category. This means that you can simply replace the “Doctor” definition with: + id="dx1-228057"> category. This means that you can simply replace the “Doctor” definition with:

    \newacronym{Doctor}{Dr}{Doctor}
    The first use of \gls{Doctor}
    is just “Dr”. This means that the “E” element will be used instead of “ActualText”. Now I don’t need to supply the accessibility text as its obtained from the long form. -

    The “Drive” entry can be similarly defined but it has the awkward terminating full stop. This means that I +

    The “Drive” entry can be similarly defined but it has the awkward terminating full stop. This means that I had to omit the end of sentence terminator in:

    -
    +   
     \gls{Doctor} Smith lives at 2, Blueberry \gls{Drive}
     
    -

    This looks odd when reading the document source and it’s easy to forgot. This is very similar to the situation +

    This looks odd when reading the document source and it’s easy to forgot. This is very similar to the situation in the sample-dot-abbr.tex example. I can again use the discardperiod attribute, but I need to assign a + id="dx1-228059"> attribute, but I need to assign a different category so that it doesn’t interfere with the “Doctor” entry. -

    The category is simply a label that’s used in the construction of some internal command names. This means +

    The category is simply a label that’s used in the construction of some internal command names. This means that it must be fully expandable, but I can choose whatever label I like (general, , abbreviation, , acronym, , index, + id="dx1-228063">, symbol and and number are used by various commands provided by are used by various commands provided by glossaries-extra). -

    In this case, I’ve decided to have a category called

    In this case, I’ve decided to have a category called shortdotted to indicate an abbreviation that ends with a dot but only the short form is shown on first use:

    \setabbreviationstyle[shortdotted]{short-nolong-noreg}
    \glssetcategoryattribute{shortdotted}{discardperiod}{true}
    \newabbreviation[category=shortdotted]{Drive}{Dr.\@}{Drive}
    In the sample-dot-abbr.tex example, I also used the insertdots attribute to automatically insert the dots and + id="dx1-228069"> attribute to automatically insert the dots and add the space factor (which is adjusted if discardperiod discards a period). In this case I’m inserting the dot + id="dx1-228070"> discards a period). In this case I’m inserting the dot manually so I’ve also added the space factor with \@ in case the abbreviation is used mid-sentence. For + id="dx1-228071"> in case the abbreviation is used mid-sentence. For example: -
    +   
     \gls{Doctor} Smith lives at 2, Blueberry \gls{Drive}. Next sentence.
     \gls{Doctor} Smith lives at 2, Blueberry \gls{Drive} end of sentence.
     
    -

    (The spacing is more noticeable if you first switch to a monospaced font with

    (The spacing is more noticeable if you first switch to a monospaced font with \ttfamily.) -

    The “e.g.” abbreviation similarly ends with a dot. It’s not usual to write “for example (e.g.)” in a +

    The “e.g.” abbreviation similarly ends with a dot. It’s not usual to write “for example (e.g.)” in a document, so it really ought to have the same shortdotted category, but it has a long-short form for illustrative purposes in this test document. In this case I need to choose another category so that I can apply a different @@ -41190,51 +41294,51 @@ style. For example:

    \setabbreviationstyle[longshortdotted]{long-short}
    \glssetcategoryattribute{longshortdotted}{discardperiod}{true}
    \newabbreviation[category=longshortdotted]{e.g.}{e.g.\@}{for
    example}
    -

    To further illustrate categories, let’s suppose the symbol and image should be in the

    To further illustrate categories, let’s suppose the symbol and image should be in the name field instead of the + id="dx1-228075"> field instead of the symbol and and user1 fields. Now the fields. Now the \glssymbolaccsupp and \glsuseriaccsupp commands won’t be used. I can’t deal with both cases if I just provide \glsnameaccsupp. -

    I could provide category-field versions, such as

    I could provide category-field versions, such as \glsxtrsymbolnameaccsupp, but remember that this only covers accessing the name field, which is typically only done in the glossary. I would also need similar commands + id="dx1-228078"> field, which is typically only done in the glossary. I would also need similar commands for the first, , firstplural, , text and and plural keys. This is quite complicated, but since I don’t need to worry + id="dx1-228082"> keys. This is quite complicated, but since I don’t need to worry about any of the other fields it’s simpler to just provide the \glsxtrcategoryaccsupp version: + id="dx1-228083"> version:

    accsupp}[2]{%
     \glsaccessibility[method=hex,unicode]{ActualText}{#1}{#2}%
    } @@ -41258,7 +41362,7 @@ class="cmtt-10">}[2]{%

      \glsaccessibility{Alt}{#1}{#2}%
    } @@ -41314,23 +41418,23 @@ class="cmtt-10">\glsxtr
    category⟩⟨fieldaccsupp could be used to override the more general category command + id="dx1-228086"> could be used to override the more general category command \glsxtrcategoryaccsupp. + id="dx1-228087">. -

    + id="x1-228088r41"> +

    🔗sample-ignored.tex

    -

    This document defines an ignored glossary for common terms that don’t need a definition. The document build +

    This document defines an ignored glossary for common terms that don’t need a definition. The document build is: -

    
    +

    
        
    pdflatex sample-ignored
    makeglossaries sample-ignored
    pdflatex sample-ignored @@ -41340,40 +41444,40 @@ A new “ignored” glossary is defined with:

    \newignoredglossary{common}
    There are no associated files with an ignored glossary. An entry is defined with this as its glossary type: -
    +   
     \newglossaryentry{commonex}{type=common,name={common term}}
     
    -

    Note that the

    Note that the description key isn’t required. This term may be referenced with key isn’t required. This term may be referenced with \gls (which is useful for consistent formatting) but it won’t be indexed. -

    + id="x1-229003r42"> +

    🔗sample-entrycount.tex

    -

    This document uses

    This document uses \glsenableentrycount and and \cgls (described in (described in §??sec:enableentrycount 7.1 Counting the Number of Times an Entry has been Used (First Use Flag Unset)) so that acronyms only used once don’t appear in the list of acronyms. The document build is: -

    
    +

    
        
    pdflatex sample-entrycount
    pdflatex sample-entrycount
    makeglossaries sample-entrycount @@ -41383,32 +41487,32 @@ appear in the list of acronyms. The document build is: Note the need to call LaTeX twice before makeglossaries, and then a final LaTeX call is required at the + id="dx1-230003">, and then a final LaTeX call is required at the end. -

    The

    The glossaries-extra package has additions that extend this mechanism and comes with some other sample files related to entry counting.
    -

    -

    If you switch to

    +

    If you switch to bib2gls you can use record counting instead. See the you can use record counting instead. See the bib2gls manual for further details. + id="dx1-230005"> manual for further details.
    -

    +

    -

    -

    +

    Top

    19. Troubleshooting

    -

    In addition to the sample files listed in

    In addition to the sample files listed in §??sec:samples 18 Sample Documents, the glossaries package comes with some minimal example files, /usr/local/texlive/2014/texmf-dist/doc/latex/glossaries/. makeglossariesgui application can also be used to test for various problems. Further information on + id="dx1-231001"> application can also be used to test for various problems. Further information on debugging LaTeX code is available at http://www.dickimaw-books.com/latex/minexample/. -

    If you have any problems, please first consult the

    If you have any problems, please first consult the glossaries FAQ. If that doesn’t help, try posting your query to somewhere like the my package bug report for

    Top

    Index

    + id="x1-23200019">Index Symbols
    \’  1
    +href="glossaries-user.html#dx1-220002" >1
    \@  2, 3, 4, 5, 6
    +href="glossaries-user.html#dx1-190026" >2, 3, 4, 5, 6
    \@gls@codepage  7
    \@gls@reference  8
    \@glsorder  9
    \@glsxtr@altmodifier  10
    +href="glossaries-user.html#dx1-25024" >10
    \@glsxtr@newglslike  11
    +href="glossaries-user.html#dx1-25022" >11
    \@glsxtr@prefixlabellist  12
    +href="glossaries-user.html#dx1-25026" >12
    \@istfilename  13
    \@newglossary  14
    \@xdylanguage  15

    A \AA  16
    +href="glossaries-user.html#dx1-6007" >16
    abbreviation styles:
        footnote  17
    +href="glossaries-user.html#dx1-185006" >17
        long-noshort  18
    +href="glossaries-user.html#dx1-138002" >18
        long-short  19, 20, 21
    +href="glossaries-user.html#dx1-179029" >19, 20, 21
        long-short-sc  22
    +href="glossaries-user.html#dx1-182026" >22
        long-short-sc-desc  23
    +href="glossaries-user.html#dx1-183013" >23
        postfootnote  24
    +href="glossaries-user.html#dx1-185005" >24
        short-nolong  25, 26, 27
    +href="glossaries-user.html#dx1-136008" >25, 26, 27
        short-sc-footnote  28
    +href="glossaries-user.html#dx1-185007" >28
        short-sc-footnote-desc  29, 30, 31, 32
    +href="glossaries-user.html#dx1-185002" >29, 30, 31, 32
        short-sc-postfootnote-desc  33, 34, 35, 36
    +href="glossaries-user.html#dx1-185004" >33, 34, 35, 36
    \Ac  37
    +href="glossaries-user.html#dx1-137065" >37
    \ac  38
    +href="glossaries-user.html#dx1-137063" >38
    accessibility package  39, 40, 41
    +href="glossaries-user.html#dx1-176057" >39, 40, 41
    accsupp package  42, 43, 44, 45, 46
    +href="glossaries-user.html#dx1-176002" >42, 43, 44, 45, 46
    \Acf  47
    +href="glossaries-user.html#dx1-137057" >47
    \acf  48
    +href="glossaries-user.html#dx1-137055" >48
    \Acfp  49
    +href="glossaries-user.html#dx1-137061" >49
    \acfp  50
    +href="glossaries-user.html#dx1-137059" >50
    \Acl  51
    +href="glossaries-user.html#dx1-137049" >51
    \acl  52
    +href="glossaries-user.html#dx1-137047" >52
    \Aclp  53
    +href="glossaries-user.html#dx1-137053" >53
    \aclp  54
    +href="glossaries-user.html#dx1-137051" >54
    \Acp  55
    +href="glossaries-user.html#dx1-137069" >55
    \acp  56
    +href="glossaries-user.html#dx1-137067" >56
    \ACRfull  57
    \Acrfull  58, 59
    +href="glossaries-user.html#dx1-137058" >59
    \acrfull  60, 61, 62, 63, 64, 65, 66, 67, 68
    +href="glossaries-user.html#dx1-137056" >61, 62, 63, 64, 65, 66, 67, 68
    \acrfullfmt  69, 70, 71
    +href="glossaries-user.html#dx1-140018" >70, 71
    \acrfullformat  72, 73
    +href="glossaries-user.html#dx1-137085" >73
    \ACRfullpl  74
    \Acrfullpl  75, 76
    +href="glossaries-user.html#dx1-137062" >76
    \acrfullpl  77, 78
    +href="glossaries-user.html#dx1-137060" >78
    \ACRlong  79
    \Acrlong  80, 81
    +href="glossaries-user.html#dx1-137050" >81
    \acrlong  82, 83, 84, 85, 86
    +href="glossaries-user.html#dx1-137048" >83, 84, 85, 86
    \ACRlongpl  87
    \Acrlongpl  88, 89
    +href="glossaries-user.html#dx1-137054" >89
    \acrlongpl  90, 91
    +href="glossaries-user.html#dx1-137052" >91
    acronym styles:
        dua  92, 93, 94, 95, 96
    +href="glossaries-user.html#dx1-138003" >92, 93, 94, 95, 96
        dua-desc  97, 98
    +href="glossaries-user.html#dx1-139054" >97, 98
        footnote  99, 100, 101
    +href="glossaries-user.html#dx1-139020" >99, 100, 101
        footnote-desc  102
    +href="glossaries-user.html#dx1-139074" >102
        footnote-sc  103
    +href="glossaries-user.html#dx1-139065" >103
        footnote-sc-desc  104, 105, 106, 107, 108
    +href="glossaries-user.html#dx1-139075" >104, 105, 106, 107, 108
        footnote-sm  109
    +href="glossaries-user.html#dx1-139066" >109
        footnote-sm-desc  110
    +href="glossaries-user.html#dx1-139076" >110
        long-sc-short  111, 112, 113, 114, 115
    +href="glossaries-user.html#dx1-139007" >111, 112, 113, 114, 115
        long-sc-short-desc  116, 117
    +href="glossaries-user.html#dx1-139037" >116, 117
        long-short  118, 119, 120, 121, 122, 123
    +href="glossaries-user.html#dx1-133069" >118, 119, 120, 121, 122, 123
        long-short-desc  124, 125, 126
    +href="glossaries-user.html#dx1-139036" >124, 125, 126
        long-sm-short  127, 128, 129
    +href="glossaries-user.html#dx1-139012" >127, 128, 129
        long-sm-short-desc  130
    +href="glossaries-user.html#dx1-139038" >130
        long-sp-short  131, 132, 133
    +href="glossaries-user.html#dx1-139024" >131, 132, 133
        long-sp-short-desc  134
    +href="glossaries-user.html#dx1-139039" >134
        sc-short-long  135
    +href="glossaries-user.html#dx1-139031" >135
        sc-short-long-desc  136
    +href="glossaries-user.html#dx1-139050" >136
        short-long  137
    +href="glossaries-user.html#dx1-139030" >137
        short-long-desc  138
    +href="glossaries-user.html#dx1-139049" >138
        sm-short-long  139
    +href="glossaries-user.html#dx1-139032" >139
        sm-short-long-desc  140
    +href="glossaries-user.html#dx1-139051" >140
    \acronymentry  141, 142, 143, 144, 145, 146
    +href="glossaries-user.html#dx1-139035" >142, 143, 144, 145, 146
    \acronymfont  147, 148, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157
    +href="glossaries-user.html#dx1-139005" >150, 151, 152, 153, 154, 155, 156, 157
    \acronymname  158, 159
    +href="glossaries-user.html#dx1-15025" >158, 159
    \acronymsort  160, 161, 162, 163, 164
    +href="glossaries-user.html#dx1-139034" >161, 162, 163, 164
    \acronymtype  165, 166, 167, 168, 169, 170, 171, 172, 173, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177
    +href="glossaries-user.html#dx1-147006" >175, 176, 177
    \ACRshort  178
    \Acrshort  179, 180
    +href="glossaries-user.html#dx1-137042" >180
    \acrshort  181, 182, 183, 184, 185, 186, 182, 183, 184, 185, 186, 187
    \ACRshortpl  188
    \Acrshortpl  189, 190
    +href="glossaries-user.html#dx1-137046" >190
    \acrshortpl  191, 192
    +href="glossaries-user.html#dx1-137044" >192
    \Acs  193
    +href="glossaries-user.html#dx1-137041" >193
    \acs  194
    +href="glossaries-user.html#dx1-137039" >194
    \Acsp  195
    +href="glossaries-user.html#dx1-137045" >195
    \acsp  196
    +href="glossaries-user.html#dx1-137043" >196
    \addcontentsline  197
    +href="glossaries-user.html#dx1-42003" >197
    \alsoname  198
    +href="glossaries-user.html#dx1-208001" >198
    \altnewglossary  199
    amsgen package  200, 201, 202, 203, 204
    +href="glossaries-user.html#dx1-140081" >203, 204
    amsmath package  205, 206
    +href="glossaries-user.html#dx1-131006" >205, 206
    \andname  207
    +href="glossaries-user.html#dx1-149010" >207
    arara  208, 209, 210, 211, 212, 213, 214, 215, 216
    +href="glossaries-user.html#dx1-8041" >209, 210, 211, 212, 213, 214, 215, 216
    array package  217, 218
    +href="glossaries-user.html#dx1-159006" >217, 218
    \AtBeginDocument  219
    +href="glossaries-user.html#dx1-124010" >219
    atom  220
    +href="glossaries-user.html#dx1-39006" >220
    auto-completion  221
    +href="glossaries-user.html#dx1-36002" >221

    B babel package  222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252
    +href="glossaries-user.html#dx1-8018" >222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252
    beamer class  253, 254, 255, 256
    +href="glossaries-user.html#dx1-131004" >253, 254, 255, 256
    beamer package  257
    +href="glossaries-user.html#dx1-15048" >257
    \BeginAccSupp  258, 259, 260, 261
    +href="glossaries-user.html#dx1-176072" >258, 259, 260, 261
    bib2gls  263, 264, 265, 266, 267, 268, 269, 270, 271, 272, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295, 296, 297, 298, 299, 300, 301, 302, 303, 304, 305, 306, 307, 308, 309, 310, 311, 312, 313, 314, 315, 316, 317, 318, 319, 320, 321, 322, 323, 324, 325, 326, 327, 328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 425, 426, 427, 428, 429, 430, 431, 432, 433, 434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 449, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480, 481, 482, 483, 484, 485, 486, 487, 488, 489, 490, 491, 492, 493, 494, 495, 496, 497
    +href="glossaries-user.html#dx1-10001" >267, 268, 269, 270, 271, 272, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295, 296, 297, 298, 299, 300, 301, 302, 303, 304, 305, 306, 307, 308, 309, 310, 311, 312, 313, 314, 315, 316, 317, 318, 319, 320, 321, 322, 323, 324, 325, 326, 327, 328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 425, 426, 427, 428, 429, 430, 431, 432, 433, 434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 449, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480, 481, 482, 483, 484, 485, 486, 487, 488, 489, 490, 491, 492, 493, 494, 495, 496, 497
        --group  498, 499, 500, 501, 502
    +href="glossaries-user.html#dx1-10033" >498, 499, 500, 501, 502
        --map-format  503
    +href="glossaries-user.html#dx1-194037" >503
        -g  504
    +href="glossaries-user.html#dx1-204092" >504
        -m  505
    +href="glossaries-user.html#dx1-194038" >505
    bib2gls entry types
        @abbreviation  506, 507, 508, 509, 510, 511, 512
    +href="glossaries-user.html#dx1-10008" >506, 507, 508, 509, 510, 511, 512
        @acronym  513, 514, 515, 516, 517, 518, 519, 520
    +href="glossaries-user.html#dx1-183048" >513, 514, 515, 516, 517, 518, 519, 520
        @dualabbreviationentry  521, 522, 523
    +href="glossaries-user.html#dx1-197012" >521, 522, 523
        @dualentry  524, 525, 526
    +href="glossaries-user.html#dx1-198014" >524, 525, 526
        @dualindexabbreviation  527, 528
    +href="glossaries-user.html#dx1-197038" >527, 528
        @entry  529, 530, 531, 532, 533, 534, 535, 536, 537, 538, 539, 540, 541, 542, 543, 544, 545, 546, 547, 548, 549, 550, 551, 552, 553, 554, 555, 556, 557, 558, 559, 560, 561, 562, 563, 564, 565, 566, 567, 568, 569
    +href="glossaries-user.html#dx1-10006" >529, 530, 531, 532, 533, 534, 535, 536, 537, 538, 539, 540, 541, 542, 543, 544, 545, 546, 547, 548, 549, 550, 551, 552, 553, 554, 555, 556, 557, 558, 559, 560, 561, 562, 563, 564, 565, 566, 567, 568, 569
        @index  570, 571, 572, 573, 574, 575, 576, 577, 578, 579, 580
    +href="glossaries-user.html#dx1-12089" >570, 571, 572, 573, 574, 575, 576, 577, 578, 579, 580
        @indexplural  581, 582, 583, 584
    +href="glossaries-user.html#dx1-206065" >581, 582, 583, 584
        @preamble  585, 586, 587, 588, 589, 590, 591, 592
    +href="glossaries-user.html#dx1-201021" >585, 586, 587, 588, 589, 590, 591, 592
        @symbol  593, 594, 595, 596, 597, 598, 599, 600, 601, 602, 603, 604, 605, 606
    +href="glossaries-user.html#dx1-10007" >593, 594, 595, 596, 597, 598, 599, 600, 601, 602, 603, 604, 605, 606
    booktabs package  607, 608, 609, 610
    +href="glossaries-user.html#dx1-158006" >607, 608, 609, 610
    \bottomrule  611
    +href="glossaries-user.html#dx1-160014" >611

    C categories
        abbreviation  612, 613, 614, 615, 616, 617, 618, 619, 620
    +href="glossaries-user.html#dx1-179026" >612, 613, 614, 615, 616, 617, 618, 619, 620
        acronym  621, 622, 623, 624, 625, 626, 627, 628, 629, 630, 631, 632, 633
    +href="glossaries-user.html#dx1-179022" >621, 622, 623, 624, 625, 626, 627, 628, 629, 630, 631, 632, 633
        general  634, 635, 636, 637
    +href="glossaries-user.html#dx1-187018" >634, 635, 636, 637
        index  638
    +href="glossaries-user.html#dx1-228063" >638
        number  639
    +href="glossaries-user.html#dx1-228065" >639
        symbol  640, 641, 642
    +href="glossaries-user.html#dx1-206031" >640, 641, 642
    category attributes  643
    +href="glossaries-user.html#dx1-136038" >643
        discardperiod  644, 645, 646, 647, 648
    +href="glossaries-user.html#dx1-189006" >644, 645, 646, 647, 648
        glossdesc  649, 650, 651, 652, 653
    +href="glossaries-user.html#dx1-12039" >649, 650, 651, 652, 653
        glossdescfont  654
    +href="glossaries-user.html#dx1-12040" >654
        glossname  655
    +href="glossaries-user.html#dx1-12054" >655
        glosssymbolfont  656
    +href="glossaries-user.html#dx1-193050" >656
        hyperoutside  657
        indexonlyfirst  658
    +href="glossaries-user.html#dx1-66007" >658
        insertdots  659, 660, 661, 662, 663
    +href="glossaries-user.html#dx1-189013" >659, 660, 661, 662, 663
        nohyperfirst  664
    +href="glossaries-user.html#dx1-35024" >664
        noshortplural  665
    +href="glossaries-user.html#dx1-189008" >665
        pluraldiscardperiod  666
    +href="glossaries-user.html#dx1-189009" >666
        retainfirstuseperiod  667
    +href="glossaries-user.html#dx1-189010" >667
        textformat  668
    \cGls  669
    \cgls  670, 671
    +href="glossaries-user.html#dx1-230002" >671
    \cGlsformat  672
    \cglsformat  673
    \cGlspl  674
    \cglspl  675
    \cGlsplformat  676
    \cglsplformat  677
    \chapter  678, 679
    +href="glossaries-user.html#dx1-145077" >678, 679
    \chapter*  680, 681
    +href="glossaries-user.html#dx1-45012" >680, 681
    classicthesis package  682, 683, 684, 685, 686
    +href="glossaries-user.html#dx1-51002" >682, 683, 684, 685, 686
    convertgls2bib  687, 688, 689, 690, 691, 692, 693, 694, 695, 696, 697, 698, 699, 700, 701, 702, 703, 704
    +href="glossaries-user.html#dx1-179051" >689, 690, 691, 692, 693, 694, 695, 696, 697, 698, 699, 700, 701, 702, 703, 704
    \currentglossary  705

    D datatool package  706, 707, 708, 709, 710
    +href="glossaries-user.html#dx1-145054" >707, 708, 709, 710
    datatool-base package  711
    \DeclareAcronymList  712, 713, 714, 715
    +href="glossaries-user.html#dx1-133011" >713, 714, 715
    \defentryfmt  716
    +href="glossaries-user.html#dx1-137001" >716
    \defglsentry  717, 718
    +href="glossaries-user.html#dx1-132024" >718
    \defglsentryfmt  719, 720, 721, 719, 720, 721, 722, 723, 724, 725, 726, 727
    +href="glossaries-user.html#dx1-133009" >723, 724, 725, 726, 727
    \DefineAcronymSynonyms  728
    \delimN  729
    +href="glossaries-user.html#dx1-166055" >729
    \delimR  730
    +href="glossaries-user.html#dx1-166056" >730
    \descriptionname  731
    +href="glossaries-user.html#dx1-15028" >731
    \dgls  732
    +href="glossaries-user.html#dx1-25025" >732
    \dicei  733
    +href="glossaries-user.html#dx1-215023" >733
    doc package  734, 735, 736, 737
    +href="glossaries-user.html#dx1-109010" >737
    \dtlcompare  738
    +href="glossaries-user.html#dx1-145060" >738
    \dtlicompare  739
    +href="glossaries-user.html#dx1-145058" >739
    \dtlletterindexcompare  740
    +href="glossaries-user.html#dx1-145056" >740
    \dtlwordindexcompare  741
    +href="glossaries-user.html#dx1-145055" >741

    E \edef  742
    +href="glossaries-user.html#dx1-133014" >742
    \emph  743
    +href="glossaries-user.html#dx1-130045" >743
    encap  744
    +href="glossaries-user.html#dx1-151002" >744
    \EndAccSupp  745, 746
    +href="glossaries-user.html#dx1-176075" >745, 746
    \ensuremath  747, 748
    +href="glossaries-user.html#dx1-193047" >747, 748
    entry location  749
    \entryname  750
    +href="glossaries-user.html#dx1-15027" >750
    environments:
        theglossary  751
    etoolbox package  752, 753, 754, 755, 756, 757, 758, 759
    +href="glossaries-user.html#dx1-75041" >753, 754, 755, 756, 757, 758, 759
    Extended Latin Alphabet  760
    @@ -42649,6743 +42753,6779 @@ class="cmbx-10">762, 763, 764, 765, 766, 767
    +href="glossaries-user.html#dx1-114012" >766, 767

    F file types
        alg  768
    +href="glossaries-user.html#dx1-17082" >768
        aux  769, 770, 771, 772, 773, 774, 775, 776, 777, 778, 779, 780, 781, 782, 783, 784, 785, 786, 787, 788, 789, 790, 791, 792, 793, 794
    +href="glossaries-user.html#dx1-8039" >770, 771, 772, 773, 774, 775, 776, 777, 778, 779, 780, 781, 782, 783, 784, 785, 786, 787, 788, 789, 790, 791, 792, 793, 794, 795
        bib  795, 796, 797, 798, 799, 800, 801, 802, 803, 804, 805, 806, 807, 808, 809, 810, 811, 812, 813, 814, 815, 816, 817, 818, 819, 820, 821, 822, 823, 824, 825, 826, 796, 797, 798, 799, 800, 801, 802, 803, 804, 805, 806, 807, 808, 809, 810, 811, 812, 813, 814, 815, 816, 817, 818, 819, 820, 821, 822, 823, 824, 825, 826, 827, 828, 829, 830, 831, 832, 833, 834, 835, 836, 837, 838, 839, 840, 841, 842, 843, 844
    +href="glossaries-user.html#dx1-202019" >828, 829, 830, 831, 832, 833, 834, 835, 836, 837, 838, 839, 840, 841, 842, 843, 844, 845
        dict  845
    +href="glossaries-user.html#dx1-16004" >846
        docdefs  846, 847, 848
    +href="glossaries-user.html#dx1-32002" >847, 848, 849
        glg  849, 850, 851, 852
    +href="glossaries-user.html#dx1-17081" >850, 851, 852, 853
        glg2  853
    +href="glossaries-user.html#dx1-23" >854
        glo  854, 855, 856, 857, 858, 859, 860
    +href="glossaries-user.html#dx1-8025" >855, 856, 857, 858, 859, 860, 861
        glo2  861
    +href="glossaries-user.html#dx1-22" >862
        gls  862, 863
    +href="glossaries-user.html#dx1-20017" >863, 864
        gls2  864
    +href="glossaries-user.html#dx1-21" >865
        glsdefs  865, 866, 867, 868
    +href="glossaries-user.html#dx1-24004" >866, 867, 868, 869
        glslabels  869
    +href="glossaries-user.html#dx1-36001" >870
        glstex  870, 871
    +href="glossaries-user.html#dx1-25004" >871, 872
        ist  872, 873, 874, 875, 876, 877, 878
    +href="glossaries-user.html#dx1-8026" >873, 874, 875, 876, 877, 878, 879
        ldf  879
    +href="glossaries-user.html#dx1-16003" >880
        lua  880
    +href="glossaries-user.html#dx1-19005" >881
        tex  881, 882, 883, 884, 885, 886, 887, 888, 889
    +href="glossaries-user.html#dx1-3008" >882, 883, 884, 885, 886, 887, 888, 889, 890
        toc  890, 891
    +href="glossaries-user.html#dx1-182016" >891, 892
        xdy  892, 893, 894, 895, 896, 897, 898, 899, 900, 901, 902, 903, 904, 905, 906, 907
    +href="glossaries-user.html#dx1-9027" >893, 894, 895, 896, 897, 898, 899, 900, 901, 902, 903, 904, 905, 906, 907, 908
    first use  908
    +href="glossaries-user.html#dx1-3021" >909
        flag  909
    +href="glossaries-user.html#dx1-3029" >910
        text  910
    +href="glossaries-user.html#dx1-3030" >911
    \firstacronymfont  911, 912, 913, 914, 915, 916, 917
    +href="glossaries-user.html#dx1-133064" >912, 913, 914, 915, 916, 917, 918
    flowfram package  918
    +href="glossaries-user.html#dx1-161011" >919
    fmtcount package  919, 920, 921, 922
    +href="glossaries-user.html#dx1-169050" >920, 921, 922, 923
    fontspec package  923
    +href="glossaries-user.html#dx1-170006" >924
    \footnote  924, 925, 926, 927, 928, 929, 930, 931, 932, 933
    +href="glossaries-user.html#dx1-139067" >925, 926, 927, 928, 929, 930, 931, 932, 933, 934
    \forallabbreviationlists  934
    +href="glossaries-user.html#dx1-172005" >935
    \forallacronyms  935
    +href="glossaries-user.html#dx1-172002" >936
    \forallglossaries  936
    +href="glossaries-user.html#dx1-172001" >937
    \forallglsentries  937
    +href="glossaries-user.html#dx1-172008" >938
    \foreignlanguage  938, 939
    +href="glossaries-user.html#dx1-198031" >939, 940
    \forglsentries  940
    +href="glossaries-user.html#dx1-172006" >941

    G \Genacrfullformat  941
    +href="glossaries-user.html#dx1-133065" >942
    \genacrfullformat  942, 943, 944, 945, 946, 947
    +href="glossaries-user.html#dx1-133059" >943, 944, 945, 946, 947, 948
    \GenericAcronymFields  948, 949, 950
    +href="glossaries-user.html#dx1-140022" >949, 950, 951
    \Genplacrfullformat  951
    +href="glossaries-user.html#dx1-133066" >952
    \genplacrfullformat  952, 953
    +href="glossaries-user.html#dx1-133061" >953, 954
    +gettitlestring package  955
    \glolinkprefix  954, 955
    +href="glossaries-user.html#dx1-130086" >956, 957
    glossaries package  956, 957, 958, 959, 960, 961, 962, 963, 964, 965, 966, 967, 968, 969, 970, 971, 972
    +href="glossaries-user.html#dx1-5005" >958, 959, 960, 961, 962, 963, 964, 965, 966, 967, 968, 969, 970, 971, 972, 973, 974, 975
    glossaries-accsupp package  973, 974, 975, 976, 977, 978, 979, 980, 981, 982, 983, 984, 985, 986, 987, 988
    +href="glossaries-user.html#dx1-31014" >976, 977, 978, 979, 980, 981, 982, 983, 984, 985, 986, 987, 988, 989, 990, 991
    glossaries-babel package  989, 990
    +href="glossaries-user.html#dx1-33008" >992, 993
    glossaries-extra-bib2gls package  991
    +href="glossaries-user.html#dx1-224041" >994
    glossaries-extra-stylemods package  992, 993, 994
    +href="glossaries-user.html#dx1-62001" >995, 996, 997
    glossaries-polyglossia package  995
    +href="glossaries-user.html#dx1-33010" >998
    glossaries-prefix package  996, 997, 998, 999, 1000, 1001, 1002, 1003, 1004, 1005
    +href="glossaries-user.html#dx1-105001" >999, 1000, 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008
    \glossariesextrasetup  1006
    +href="glossaries-user.html#dx1-110019" >1009
    glossary counters:
        glossaryentry  1007
    +href="glossaries-user.html#dx1-48003" >1010
        glossarysubentry  1008
    +href="glossaries-user.html#dx1-50003" >1011
    glossary package  1009, 1010, 1011, 1012
    -glossary styles:
    +href="glossaries-user.html#dx1-109001" >1012, 1013, 1014, 1015
    +glossary styles:
        altlist  1013, 1014, 1015, 1016, 1017, 1018
    +href="glossaries-user.html#dx1-139048" >1016, 1017, 1018, 1019, 1020, 1021
        altlistgroup  1019, 1020
    +href="glossaries-user.html#dx1-157038" >1022, 1023
        altlisthypergroup  1021
    +href="glossaries-user.html#dx1-157040" >1024
        altlong4col  1022, 1023, 1024
    +href="glossaries-user.html#dx1-156025" >1025, 1026, 1027
        altlong4col-booktabs  1025
    +href="glossaries-user.html#dx1-160031" >1028
        altlong4colborder  1026
    +href="glossaries-user.html#dx1-158043" >1029
        altlong4colheader  1027, 1028
    +href="glossaries-user.html#dx1-158045" >1030, 1031
        altlong4colheaderborder  1029, 1030
    +href="glossaries-user.html#dx1-158047" >1032, 1033
        altlongragged4col  1031, 1032, 1033
    +href="glossaries-user.html#dx1-159030" >1034, 1035, 1036
        altlongragged4col-booktabs  1034, 1035
    +href="glossaries-user.html#dx1-160037" >1037, 1038
        altlongragged4colborder  1036
    +href="glossaries-user.html#dx1-159034" >1039
        altlongragged4colheader  1037, 1038, 1039
    +href="glossaries-user.html#dx1-159036" >1040, 1041, 1042
        altlongragged4colheaderborder  1040
    +href="glossaries-user.html#dx1-159038" >1043
        altsuper4col  1041, 1042, 1043
    +href="glossaries-user.html#dx1-156026" >1044, 1045, 1046
        altsuper4colborder  1044
    +href="glossaries-user.html#dx1-161048" >1047
        altsuper4colheader  1045
    +href="glossaries-user.html#dx1-161050" >1048
        altsuper4colheaderborder  1046
    +href="glossaries-user.html#dx1-161052" >1049
        altsuperragged4col  1047, 1048, 1049
    +href="glossaries-user.html#dx1-162031" >1050, 1051, 1052
        altsuperragged4colborder  1050
    +href="glossaries-user.html#dx1-162033" >1053
        altsuperragged4colheader  1051
    +href="glossaries-user.html#dx1-162035" >1054
        altsuperragged4colheaderborder  1052
    +href="glossaries-user.html#dx1-162037" >1055
        alttree  1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062
    +href="glossaries-user.html#dx1-156029" >1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065
        alttreegroup  1063, 1064, 1065
    +href="glossaries-user.html#dx1-163055" >1066, 1067, 1068
        alttreehypergroup  1066, 1067, 1068, 1069
    +href="glossaries-user.html#dx1-163057" >1069, 1070, 1071, 1072
        bookindex  1070, 1071, 1072
    +href="glossaries-user.html#dx1-12072" >1073, 1074, 1075
        index  1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084
    +href="glossaries-user.html#dx1-55004" >1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087
        indexgroup  1085, 1086, 1087, 1088
    +href="glossaries-user.html#dx1-145101" >1088, 1089, 1090, 1091
        indexhypergroup  1089, 1090, 1091
    +href="glossaries-user.html#dx1-163007" >1092, 1093, 1094
        inline  1092, 1093, 1094
    +href="glossaries-user.html#dx1-165002" >1095, 1096, 1097
        list  1095, 1096, 1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107
    +href="glossaries-user.html#dx1-54003" >1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107, 1108, 1109, 1110
        listdotted  1108, 1109, 1110, 1111, 1112
    +href="glossaries-user.html#dx1-156039" >1111, 1112, 1113, 1114, 1115
        listgroup  1113, 1114, 1115, 1116
    +href="glossaries-user.html#dx1-75020" >1116, 1117, 1118, 1119
        listhypergroup  1117, 1118, 1119, 1120, 1121, 1122, 1123, 1124
    +href="glossaries-user.html#dx1-157027" >1120, 1121, 1122, 1123, 1124, 1125, 1126, 1127
        long  1125, 1126, 1127, 1128, 1129, 1130
    +href="glossaries-user.html#dx1-156028" >1128, 1129, 1130, 1131, 1132, 1133
        long-booktabs  1131, 1132
    +href="glossaries-user.html#dx1-160024" >1134, 1135
        long-name-desc-sym-loc  1133
    +href="glossaries-user.html#dx1-223011" >1136
        long3col  1134, 1135, 1136, 1137, 1138
    +href="glossaries-user.html#dx1-156012" >1137, 1138, 1139, 1140, 1141
        long3col-booktabs  1139
    +href="glossaries-user.html#dx1-160026" >1142
        long3colborder  1140, 1141
    +href="glossaries-user.html#dx1-156014" >1143, 1144
        long3colheader  1142, 1143, 1144, 1145
    +href="glossaries-user.html#dx1-156013" >1145, 1146, 1147, 1148
        long3colheaderborder  1146, 1147
    +href="glossaries-user.html#dx1-156015" >1149, 1150
        long4col  1148, 1149, 1150, 1151, 1152
    +href="glossaries-user.html#dx1-156023" >1151, 1152, 1153, 1154, 1155
        long4col-booktabs  1153, 1154
    +href="glossaries-user.html#dx1-160029" >1156, 1157
        long4colborder  1155, 1156
    +href="glossaries-user.html#dx1-158033" >1158, 1159
        long4colheader  1157, 1158, 1159, 1160
    -    long4colheaderborder  1161, 1162, 1163
    +href="glossaries-user.html#dx1-158035" >1160, 1161, 1162, 1163
    +    long4colheaderborder  1164, 1165, 1166
        longborder  1164
    +href="glossaries-user.html#dx1-158013" >1167
        longheader  1165, 1166, 1167, 1168
    +href="glossaries-user.html#dx1-158015" >1168, 1169, 1170, 1171
        longheaderborder  1169, 1170
    +href="glossaries-user.html#dx1-158017" >1172, 1173
        longragged  1171, 1172, 1173, 1174
    +href="glossaries-user.html#dx1-159010" >1174, 1175, 1176, 1177
        longragged-booktabs  1175
    +href="glossaries-user.html#dx1-160033" >1178
        longragged3col  1176, 1177, 1178, 1179
    +href="glossaries-user.html#dx1-159019" >1179, 1180, 1181, 1182
        longragged3col-booktabs  1180
    +href="glossaries-user.html#dx1-160035" >1183
        longragged3colborder  1181
    +href="glossaries-user.html#dx1-159024" >1184
        longragged3colheader  1182, 1183, 1184
    +href="glossaries-user.html#dx1-159026" >1185, 1186, 1187
        longragged3colheaderborder  1185
    +href="glossaries-user.html#dx1-159028" >1188
        longraggedborder  1186
    +href="glossaries-user.html#dx1-159013" >1189
        longraggedheader  1187, 1188, 1189
    +href="glossaries-user.html#dx1-159015" >1190, 1191, 1192
        longraggedheaderborder  1190
    +href="glossaries-user.html#dx1-159017" >1193
        mcolalttree  1191
    +href="glossaries-user.html#dx1-164039" >1194
        mcolalttreegroup  1192
    +href="glossaries-user.html#dx1-164041" >1195
        mcolalttreehypergroup  1193
    +href="glossaries-user.html#dx1-164043" >1196
        mcolalttreespannav  1194
    +href="glossaries-user.html#dx1-164044" >1197
        mcolindex  1195, 1196
    +href="glossaries-user.html#dx1-164005" >1198, 1199
        mcolindexgroup  1197
    +href="glossaries-user.html#dx1-164020" >1200
        mcolindexhypergroup  1198
    +href="glossaries-user.html#dx1-164022" >1201
        mcolindexspannav  1199
    +href="glossaries-user.html#dx1-164023" >1202
        mcoltree  1200
    +href="glossaries-user.html#dx1-164025" >1203
        mcoltreegroup  1201
    +href="glossaries-user.html#dx1-164027" >1204
        mcoltreehypergroup  1202, 1203
    +href="glossaries-user.html#dx1-164029" >1205, 1206
        mcoltreenoname  1204
    +href="glossaries-user.html#dx1-164032" >1207
        mcoltreenonamegroup  1205
    +href="glossaries-user.html#dx1-164034" >1208
        mcoltreenonamehypergroup  1206
    +href="glossaries-user.html#dx1-164036" >1209
        mcoltreenonamespannav  1207
    +href="glossaries-user.html#dx1-164037" >1210
        mcoltreespannav  1208
    +href="glossaries-user.html#dx1-164030" >1211
        super  1209, 1210, 1211, 1212
    +href="glossaries-user.html#dx1-161012" >1212, 1213, 1214, 1215
        super3col  1213, 1214, 1215, 1216
    +href="glossaries-user.html#dx1-161024" >1216, 1217, 1218, 1219
        super3colborder  1217
    +href="glossaries-user.html#dx1-161029" >1220
        super3colheader  1218, 1219
    +href="glossaries-user.html#dx1-161031" >1221, 1222
        super3colheaderborder  1220
    +href="glossaries-user.html#dx1-161033" >1223
        super4col  1221, 1222, 1223, 1224, 1225
    +href="glossaries-user.html#dx1-156024" >1224, 1225, 1226, 1227, 1228
        super4colborder  1226, 1227
    +href="glossaries-user.html#dx1-161038" >1229, 1230
        super4colheader  1228, 1229, 1230
    +href="glossaries-user.html#dx1-161040" >1231, 1232, 1233
        super4colheaderborder  1231, 1232
    +href="glossaries-user.html#dx1-161042" >1234, 1235
        superborder  1233
    +href="glossaries-user.html#dx1-161018" >1236
        superheader  1234, 1235
    +href="glossaries-user.html#dx1-161020" >1237, 1238
        superheaderborder  1236, 1237
    +href="glossaries-user.html#dx1-145089" >1239, 1240
        superragged  1238, 1239, 1240, 1241
    +href="glossaries-user.html#dx1-162009" >1241, 1242, 1243, 1244
        superragged3col  1242, 1243, 1244, 1245
    +href="glossaries-user.html#dx1-162021" >1245, 1246, 1247, 1248
        superragged3colborder  1246
    +href="glossaries-user.html#dx1-162026" >1249
        superragged3colheader  1247
    -    superragged3colheaderborder  1248
    +href="glossaries-user.html#dx1-162028" >1250
    +    superragged3colheaderborder  1251
        superraggedborder  1249
    +href="glossaries-user.html#dx1-162015" >1252
        superraggedheader  1250, 1251
    +href="glossaries-user.html#dx1-162017" >1253, 1254
        superraggedheaderborder  1252
    +href="glossaries-user.html#dx1-162019" >1255
        topic  1253, 1254, 1255, 1256
    +href="glossaries-user.html#dx1-206033" >1256, 1257, 1258, 1259
        tree  1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264
    +href="glossaries-user.html#dx1-140067" >1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267
        treegroup  1265, 1266, 1267
    +href="glossaries-user.html#dx1-163035" >1268, 1269, 1270
        treehypergroup  1268, 1269, 1270
    +href="glossaries-user.html#dx1-157032" >1271, 1272, 1273
        treenoname  1271, 1272, 1273, 1274
    +href="glossaries-user.html#dx1-163012" >1274, 1275, 1276, 1277
        treenonamegroup  1275, 1276, 1277, 1278
    +href="glossaries-user.html#dx1-163042" >1278, 1279, 1280, 1281
        treenonamehypergroup  1279, 1280
    +href="glossaries-user.html#dx1-163044" >1282, 1283
    glossary-bookindex package  1281, 1282, 1283
    +href="glossaries-user.html#dx1-12073" >1284, 1285, 1286
    glossary-inline package  1284, 1285
    +href="glossaries-user.html#dx1-165001" >1287, 1288
    glossary-list package  1286, 1287, 1288, 1289, 1290, 1291
    +href="glossaries-user.html#dx1-5003" >1289, 1290, 1291, 1292, 1293, 1294, 1295
    +glossary-list.sty package  1296
    glossary-long package  1292, 1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300
    +href="glossaries-user.html#dx1-51005" >1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304, 1305
    glossary-longbooktabs package  1301, 1302, 1303, 1304
    +href="glossaries-user.html#dx1-160001" >1306, 1307, 1308, 1309
    glossary-longextra package  1305, 1306
    +href="glossaries-user.html#dx1-182012" >1310, 1311
    glossary-longextra package  1307
    +href="glossaries-user.html#dx1-156006" >1312
    glossary-longragged package  1308, 1309, 1310, 1311
    +href="glossaries-user.html#dx1-159001" >1313, 1314, 1315, 1316
    glossary-mcols package  1312, 1313, 1314, 1315, 1316, 1317, 1318
    +href="glossaries-user.html#dx1-56001" >1317, 1318, 1319, 1320, 1321, 1322, 1323
    glossary-ragged package  1319
    +href="glossaries-user.html#dx1-160010" >1324
    glossary-super package  1320, 1321, 1322, 1323, 1324, 1325
    +href="glossaries-user.html#dx1-51006" >1325, 1326, 1327, 1328, 1329, 1330
    glossary-superragged package  1326, 1327, 1328
    +href="glossaries-user.html#dx1-162001" >1331, 1332, 1333
    glossary-topic package  1329, 1330
    +href="glossaries-user.html#dx1-206006" >1334, 1335
    glossary-topic package  1331, 1332, 1333
    +href="glossaries-user.html#dx1-156005" >1336, 1337, 1338
    glossary-tree package  1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344, 1345
    +href="glossaries-user.html#dx1-51007" >1339, 1340, 1341, 1342, 1343, 1344, 1345, 1346, 1347, 1348, 1349, 1350
    glossaryentry (counter)  1346, 1347, 1348, 1349
    +href="glossaries-user.html#dx1-48002" >1351, 1352, 1353, 1354
    \glossaryentrynumbers  1350, 1351, 1352, 1353
    +href="glossaries-user.html#dx1-166053" >1355, 1356, 1357, 1358
    \glossaryheader  1354, 1355, 1356
    +href="glossaries-user.html#dx1-166016" >1359, 1360, 1361
    \glossaryname  1357, 1358
    +href="glossaries-user.html#dx1-15024" >1362, 1363
    \glossarypostamble  1359, 1360
    +href="glossaries-user.html#dx1-145086" >1364, 1365
    \glossarypreamble  1361, 1362, 1363, 1364
    +href="glossaries-user.html#dx1-49005" >1366, 1367, 1368, 1369
    \glossarysection  1365
    +href="glossaries-user.html#dx1-165004" >1370
    \glossarystyle  1366
    +href="glossaries-user.html#dx1-145034" >1371
    glossarysubentry (counter)  1367
    +href="glossaries-user.html#dx1-50002" >1372
    \glossentry  1368, 1369, 1370
    +href="glossaries-user.html#dx1-166039" >1373, 1374, 1375
    \Glossentrydesc  1371, 1372
    +href="glossaries-user.html#dx1-135030" >1376, 1377
    \glossentrydesc  1373, 1374, 1375, 1376, 1377, 1378
    +href="glossaries-user.html#dx1-12038" >1378, 1379, 1380, 1381, 1382, 1383
    \Glossentryname  1379, 1380
    +href="glossaries-user.html#dx1-135014" >1384, 1385
    \glossentryname  1381, 1382, 1383
    +href="glossaries-user.html#dx1-135013" >1386, 1387, 1388
    \glossentrynameother  1384
    +href="glossaries-user.html#dx1-12088" >1389
    \Glossentrysymbol  1385
    +href="glossaries-user.html#dx1-135037" >1390
    \glossentrysymbol  1386, 1387, 1388, 1389, 1390, 1391
    +href="glossaries-user.html#dx1-12014" >1391, 1392, 1393, 1394, 1395, 1396
    \GLS  1392, 1393, 1394, 1395
    +href="glossaries-user.html#dx1-3024" >1397, 1398, 1399, 1400
    \Gls  1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407
    -\gls  1408, 1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440
    +href="glossaries-user.html#dx1-3023" >1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412
    +\gls  1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445
    \gls*  1441
    +href="glossaries-user.html#dx1-35002" >1446
    \glsabbrvfont  1442
    +href="glossaries-user.html#dx1-186012" >1447
    \glsaccessibility  1443, 1444, 1445, 1446, 1447
    +href="glossaries-user.html#dx1-176073" >1448, 1449, 1450, 1451, 1452
    \Glsaccesslong  1448
    +href="glossaries-user.html#dx1-188031" >1453
    \glsaccesslong  1449
    +href="glossaries-user.html#dx1-188013" >1454
    \Glsaccesslongpl  1450
    +href="glossaries-user.html#dx1-188040" >1455
    \glsaccesslongpl  1451
    +href="glossaries-user.html#dx1-188022" >1456
    \glsaccessshort  1452, 1453
    +href="glossaries-user.html#dx1-188019" >1457, 1458
    \glsaccessshortpl  1454, 1455
    +href="glossaries-user.html#dx1-188028" >1459, 1460
    \glsaccsupp  1456, 1457
    +href="glossaries-user.html#dx1-176065" >1461, 1462
    \glsacrpluralsuffix  1458
    +href="glossaries-user.html#dx1-136037" >1463
    \glsacspace  1459
    +href="glossaries-user.html#dx1-139029" >1464
    \glsadd  1460, 1461, 1462, 1463, 1464, 1465, 1466, 1467
    +href="glossaries-user.html#dx1-12015" >1465, 1466, 1467, 1468, 1469, 1470, 1471, 1472
    \glsaddall  1468, 1469, 1470, 1471
    +href="glossaries-user.html#dx1-147004" >1473, 1474, 1475, 1476
    \glsaddall options
        types  1472
    +href="glossaries-user.html#dx1-147005" >1477
    \glsaddallunused  1473
    +href="glossaries-user.html#dx1-147011" >1478
    \glsaddkey  1474, 1475, 1476, 1477, 1478
    +href="glossaries-user.html#dx1-114121" >1479, 1480, 1481, 1482, 1483
    \GlsAddLetterGroup  1479
    +href="glossaries-user.html#dx1-215032" >1484
    \glsaddprotectedpagefmt  1480
    +href="glossaries-user.html#dx1-152016" >1485
    \glsaddstoragekey  1481, 1482, 1483, 1484, 1485, 1486, 1487, 1488
    +href="glossaries-user.html#dx1-114122" >1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493
    \GlsAddXdyAttribute  1489, 1490, 1491
    +href="glossaries-user.html#dx1-130049" >1494, 1495, 1496
    \GlsAddXdyCounters  1492, 1493
    +href="glossaries-user.html#dx1-169009" >1497, 1498
    \GlsAddXdyLocation  1494, 1495
    +href="glossaries-user.html#dx1-169027" >1499, 1500
    \glsautoprefix  1496
    +href="glossaries-user.html#dx1-45006" >1501
    \glsbackslash  1497
    +href="glossaries-user.html#dx1-167012" >1502
    +\glscapitalisewords  1503
    \glscapscase  1498, 1499, 1500
    +href="glossaries-user.html#dx1-133021" >1504, 1505, 1506
    \glscategory  1501
    +href="glossaries-user.html#dx1-211003" >1507
    \glsclearpage  1502
    +href="glossaries-user.html#dx1-43008" >1508
    \glsclosebrace  1503
    +href="glossaries-user.html#dx1-167008" >1509
    \glscurrententrylabel  1504, 1505, 1506, 1507, 1508, 1509, 1510
    +href="glossaries-user.html#dx1-198033" >1510, 1511, 1512, 1513, 1514, 1515, 1516
    \glscurrentfieldvalue  1511, 1512, 1513
    +href="glossaries-user.html#dx1-173031" >1517, 1518, 1519
    \glscustomtext  1514, 1515, 1516
    +href="glossaries-user.html#dx1-133015" >1520, 1521, 1522
    \GlsDeclareNoHyperList  1517, 1518, 1519
    +href="glossaries-user.html#dx1-85003" >1523, 1524, 1525
    \glsdefaultshortaccess  1520, 1521
    +href="glossaries-user.html#dx1-176063" >1526, 1527
    \glsdefaulttype  1522, 1523, 1524, 1525, 1526, 1527
    +href="glossaries-user.html#dx1-124005" >1528, 1529, 1530, 1531, 1532, 1533
    \glsdefpostdesc  1528, 1529, 1530
    +href="glossaries-user.html#dx1-204019" >1534, 1535, 1536
    \glsdefpostlink  1531, 1532, 1533, 1534, 1535, 1536
    +href="glossaries-user.html#dx1-114047" >1537, 1538, 1539, 1540, 1541, 1542
    \GLSdesc  1537
    +href="glossaries-user.html#dx1-132054" >1543
    \Glsdesc  1538, 1539
    +href="glossaries-user.html#dx1-132053" >1544, 1545
    \glsdesc  1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547, 1548, 1549
    +href="glossaries-user.html#dx1-132050" >1546, 1547, 1548, 1549, 1550, 1551, 1552, 1553, 1554, 1555
    \glsdescwidth  1550, 1551, 1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561
    +href="glossaries-user.html#dx1-156017" >1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564, 1565, 1566, 1567
    \glsdisablehyper  1562, 1563, 1564, 1565, 1566
    +href="glossaries-user.html#dx1-130036" >1568, 1569, 1570, 1571, 1572
    + + \glsdisp  1567, 1568, 1569, 1570, 1571, 1572
    +href="glossaries-user.html#dx1-3028" >1573, 1574, 1575, 1576, 1577, 1578
    \glsdisplay  1573, 1574
    +href="glossaries-user.html#dx1-114079" >1579, 1580
    \glsdisplayfirst  1575, 1576
    - - +href="glossaries-user.html#dx1-114080" >1581, 1582
    \glsdisplaynumberlist  1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584
    +href="glossaries-user.html#dx1-6002" >1583, 1584, 1585, 1586, 1587, 1588, 1589, 1590
    \glsdoifexists  1585
    +href="glossaries-user.html#dx1-173006" >1591
    \glsdoifexistsordo  1586
    +href="glossaries-user.html#dx1-173009" >1592
    \glsdoifexistsorwarn  1587
    +href="glossaries-user.html#dx1-173008" >1593
    \glsdoifnoexists  1588
    +href="glossaries-user.html#dx1-173007" >1594
    \glsdoifnoexistsordo  1589
    +href="glossaries-user.html#dx1-173010" >1595
    \glsdosanitizesort  1590, 1591
    +href="glossaries-user.html#dx1-75029" >1596, 1597
    \glsenableentrycount  1592, 1593
    +href="glossaries-user.html#dx1-144003" >1598, 1599
    \glsenablehyper  1594
    +href="glossaries-user.html#dx1-134006" >1600
    \glsentrycounterlabel  1595
    +href="glossaries-user.html#dx1-166049" >1601
    \GlsEntryCounterLabelPrefix  1596
    +href="glossaries-user.html#dx1-48005" >1602
    \glsentrycurrcount  1597
    +href="glossaries-user.html#dx1-144007" >1603
    \Glsentrydesc  1598, 1599, 1600, 1601, 1602
    +href="glossaries-user.html#dx1-12007" >1604, 1605, 1606, 1607, 1608
    \glsentrydesc  1603, 1604, 1605, 1606, 1607, 1608, 1609, 1610, 1611, 1612, 1613
    +href="glossaries-user.html#dx1-12036" >1609, 1610, 1611, 1612, 1613, 1614, 1615, 1616, 1617, 1618, 1619
    \Glsentrydescplural  1614
    +href="glossaries-user.html#dx1-135032" >1620
    \glsentrydescplural  1615
    +href="glossaries-user.html#dx1-135031" >1621
    \Glsentryfirst  1616
    +href="glossaries-user.html#dx1-135022" >1622
    \glsentryfirst  1617, 1618
    +href="glossaries-user.html#dx1-135021" >1623, 1624
    \Glsentryfirstplural  1619
    +href="glossaries-user.html#dx1-135025" >1625
    \glsentryfirstplural  1620
    +href="glossaries-user.html#dx1-135024" >1626
    \glsentryfmt  1621, 1622, 1623, 1624, 1625, 1626, 1627, 1628, 1629, 1630, 1631, 1632
    +href="glossaries-user.html#dx1-130026" >1627, 1628, 1629, 1630, 1631, 1632, 1633, 1634, 1635, 1636, 1637, 1638
    \Glsentryfull  1633
    +href="glossaries-user.html#dx1-137082" >1639
    \glsentryfull  1634, 1635, 1636, 1637, 1638, 1639
    +href="glossaries-user.html#dx1-137081" >1640, 1641, 1642, 1643, 1644, 1645
    \Glsentryfullpl  1640
    +href="glossaries-user.html#dx1-137084" >1646
    \glsentryfullpl  1641
    +href="glossaries-user.html#dx1-137083" >1647
    \glsentryitem  1642, 1643
    +href="glossaries-user.html#dx1-166046" >1648, 1649
    \Glsentrylong  1644, 1645, 1646, 1647
    +href="glossaries-user.html#dx1-133068" >1650, 1651, 1652, 1653
    \glsentrylong  1648, 1649, 1650
    +href="glossaries-user.html#dx1-137073" >1654, 1655, 1656
    \Glsentrylongpl  1651, 1652
    +href="glossaries-user.html#dx1-137076" >1657, 1658
    \glsentrylongpl  1653, 1654
    +href="glossaries-user.html#dx1-137075" >1659, 1660
    \Glsentryname  1655, 1656
    +href="glossaries-user.html#dx1-135009" >1661, 1662
    \glsentryname  1657, 1658, 1659, 1660, 1661
    +href="glossaries-user.html#dx1-135008" >1663, 1664, 1665, 1666, 1667
    \glsentrynumberlist  1662, 1663, 1664, 1665, 1666
    +href="glossaries-user.html#dx1-47003" >1668, 1669, 1670, 1671, 1672
    \glsentryparent  1667, 1668
    +href="glossaries-user.html#dx1-174002" >1673, 1674
    \Glsentryplural  1669
    +href="glossaries-user.html#dx1-135019" >1675
    \glsentryplural  1670, 1671, 1672
    +href="glossaries-user.html#dx1-135018" >1676, 1677, 1678
    \Glsentryprefix  1673
    +href="glossaries-user.html#dx1-175057" >1679
    \glsentryprefix  1674, 1675
    +href="glossaries-user.html#dx1-175048" >1680, 1681
    \Glsentryprefixfirst  1676
    +href="glossaries-user.html#dx1-175058" >1682
    \glsentryprefixfirst  1677
    +href="glossaries-user.html#dx1-175050" >1683
    \Glsentryprefixfirstplural  1678
    +href="glossaries-user.html#dx1-175060" >1684
    \glsentryprefixfirstplural  1679
    +href="glossaries-user.html#dx1-175054" >1685
    \Glsentryprefixplural  1680
    +href="glossaries-user.html#dx1-175059" >1686
    + + \glsentryprefixplural  1681
    +href="glossaries-user.html#dx1-175052" >1687
    \glsentryprevcount  1682
    +href="glossaries-user.html#dx1-144008" >1688
    \Glsentryshort  1683
    - - +href="glossaries-user.html#dx1-137078" >1689
    \glsentryshort  1684
    +href="glossaries-user.html#dx1-137077" >1690
    \Glsentryshortpl  1685
    +href="glossaries-user.html#dx1-137080" >1691
    \glsentryshortpl  1686
    +href="glossaries-user.html#dx1-137079" >1692
    \glsentrysort  1687
    +href="glossaries-user.html#dx1-174003" >1693
    \Glsentrysymbol  1688
    +href="glossaries-user.html#dx1-135034" >1694
    \glsentrysymbol  1689, 1690, 1691, 1692, 1693, 1694
    +href="glossaries-user.html#dx1-12006" >1695, 1696, 1697, 1698, 1699, 1700
    \Glsentrysymbolplural  1695
    +href="glossaries-user.html#dx1-135039" >1701
    \glsentrysymbolplural  1696
    +href="glossaries-user.html#dx1-135038" >1702
    \Glsentrytext  1697, 1698, 1699, 1700, 1701
    +href="glossaries-user.html#dx1-118005" >1703, 1704, 1705, 1706, 1707
    \glsentrytext  1702, 1703, 1704, 1705, 1706, 1707, 1708, 1709, 1710
    +href="glossaries-user.html#dx1-118004" >1708, 1709, 1710, 1711, 1712, 1713, 1714, 1715, 1716
    \glsentrytitlecase  1711, 1712
    +href="glossaries-user.html#dx1-132012" >1717, 1718
    \glsentrytype  1713
    +href="glossaries-user.html#dx1-174001" >1719
    \Glsentryuseri  1714
    +href="glossaries-user.html#dx1-135041" >1720
    \glsentryuseri  1715, 1716
    +href="glossaries-user.html#dx1-135040" >1721, 1722
    \Glsentryuserii  1717
    +href="glossaries-user.html#dx1-135043" >1723
    \glsentryuserii  1718
    +href="glossaries-user.html#dx1-135042" >1724
    \Glsentryuseriii  1719
    +href="glossaries-user.html#dx1-135045" >1725
    \glsentryuseriii  1720
    +href="glossaries-user.html#dx1-135044" >1726
    \Glsentryuseriv  1721
    +href="glossaries-user.html#dx1-135047" >1727
    \glsentryuseriv  1722
    +href="glossaries-user.html#dx1-135046" >1728
    \Glsentryuserv  1723
    +href="glossaries-user.html#dx1-135049" >1729
    \glsentryuserv  1724
    +href="glossaries-user.html#dx1-135048" >1730
    \Glsentryuservi  1725
    +href="glossaries-user.html#dx1-135051" >1731
    \glsentryuservi  1726
    +href="glossaries-user.html#dx1-135050" >1732
    \glsexpandfields  1727
    +href="glossaries-user.html#dx1-120022" >1733
    \glsfieldaccsupp  1728
    +href="glossaries-user.html#dx1-176066" >1734
    \glsfielddef  1729
    +href="glossaries-user.html#dx1-174010" >1735
    \glsfieldedef  1730
    +href="glossaries-user.html#dx1-174011" >1736
    \glsfieldfetch  1731
    +href="glossaries-user.html#dx1-174004" >1737
    \glsfieldgdef  1732
    +href="glossaries-user.html#dx1-174012" >1738
    \glsfieldxdef  1733, 1734, 1735, 1736
    +href="glossaries-user.html#dx1-134031" >1739, 1740, 1741, 1742
    \glsfindwidesttoplevelname  1737, 1738
    +href="glossaries-user.html#dx1-163051" >1743, 1744
    \glsFindWidestUsedLevelTwo  1739
    +href="glossaries-user.html#dx1-206015" >1745
    \glsFindWidestUsedTopLevelName  1740
    +href="glossaries-user.html#dx1-206014" >1746
    \GLSfirst  1741
    +href="glossaries-user.html#dx1-132017" >1747
    \Glsfirst  1742
    +href="glossaries-user.html#dx1-132016" >1748
    \glsfirst  1743
    +href="glossaries-user.html#dx1-132013" >1749
    \glsfirstabbrvscfont  1744, 1745, 1746, 1747
    +href="glossaries-user.html#dx1-188018" >1750, 1751, 1752, 1753
    \glsfirstlongfootnotefont  1748, 1749, 1750, 1751, 1752
    +href="glossaries-user.html#dx1-188012" >1754, 1755, 1756, 1757, 1758
    \GLSfirstplural  1753
    +href="glossaries-user.html#dx1-132037" >1759
    \Glsfirstplural  1754
    +href="glossaries-user.html#dx1-132036" >1760
    \glsfirstplural  1755
    +href="glossaries-user.html#dx1-132033" >1761
    \glsfmtfirst  1756
    +href="glossaries-user.html#dx1-215046" >1762
    + + \Glsfmtlong  1757, 1758
    +href="glossaries-user.html#dx1-186022" >1763, 1764
    \glsfmtname  1759, 1760, 1761
    +href="glossaries-user.html#dx1-183028" >1765, 1766, 1767
    \glsfmtshort  1762
    - - +href="glossaries-user.html#dx1-186023" >1768
    \glsfmttext  1763, 1764, 1765, 1766
    +href="glossaries-user.html#dx1-183027" >1769, 1770, 1771, 1772
    \glsgenacfmt  1767, 1768, 1769, 1770, 1771, 1772, 1773
    +href="glossaries-user.html#dx1-133050" >1773, 1774, 1775, 1776, 1777, 1778, 1779
    \glsgenentryfmt  1774, 1775, 1776, 1777, 1778
    +href="glossaries-user.html#dx1-133044" >1780, 1781, 1782, 1783, 1784
    \glsgetgrouptitle  1779
    +href="glossaries-user.html#dx1-166027" >1785
    \glsglossarymark  1780, 1781, 1782, 1783, 1784
    +href="glossaries-user.html#dx1-43003" >1786, 1787, 1788, 1789, 1790
    \glsgroupheading  1785, 1786
    +href="glossaries-user.html#dx1-166021" >1791, 1792
    \glsgroupskip  1787, 1788, 1789
    +href="glossaries-user.html#dx1-156033" >1793, 1794, 1795
    \glshyperlink  1790, 1791, 1792
    +href="glossaries-user.html#dx1-134022" >1796, 1797, 1798
    \glshypernavsep  1793
    +href="glossaries-user.html#dx1-157029" >1799
    \glsifhyper  1794
    +href="glossaries-user.html#dx1-133027" >1800
    \glsifhyperon  1795, 1796, 1797
    +href="glossaries-user.html#dx1-133022" >1801, 1802, 1803
    \glsIfListOfAcronyms  1798
    +href="glossaries-user.html#dx1-95006" >1804
    \glsifplural  1799, 1800, 1801, 1802
    +href="glossaries-user.html#dx1-133020" >1805, 1806, 1807, 1808
    \glsinlinedescformat  1803
    +href="glossaries-user.html#dx1-165020" >1809
    \glsinlineemptydescformat  1804
    +href="glossaries-user.html#dx1-165019" >1810
    \glsinlinenameformat  1805
    +href="glossaries-user.html#dx1-165016" >1811
    \glsinlineparentchildseparator  1806, 1807
    +href="glossaries-user.html#dx1-165012" >1812, 1813
    \glsinlineseparator  1808, 1809
    +href="glossaries-user.html#dx1-165008" >1814, 1815
    \glsinlinesubdescformat  1810
    +href="glossaries-user.html#dx1-165021" >1816
    \glsinlinesubnameformat  1811
    +href="glossaries-user.html#dx1-165018" >1817
    \glsinlinesubseparator  1812, 1813
    +href="glossaries-user.html#dx1-165010" >1818, 1819
    \glsinsert  1814, 1815
    +href="glossaries-user.html#dx1-133019" >1820, 1821
    \glslabel  1816, 1817, 1818, 1819, 1820, 1821, 1822, 1823, 1824, 1825, 1826, 1827, 1828, 1829
    +href="glossaries-user.html#dx1-35017" >1822, 1823, 1824, 1825, 1826, 1827, 1828, 1829, 1830, 1831, 1832, 1833, 1834, 1835
    \glslabeltok  1830, 1831
    +href="glossaries-user.html#dx1-140024" >1836, 1837
    \glsletentryfield  1832
    +href="glossaries-user.html#dx1-135035" >1838
    \glslink  1833, 1834, 1835, 1836, 1837, 1838, 1839, 1840, 1841, 1842
    +href="glossaries-user.html#dx1-35008" >1839, 1840, 1841, 1842, 1843, 1844, 1845, 1846, 1847, 1848
    \glslink options
        counter  1843, 1844
    +href="glossaries-user.html#dx1-130075" >1849, 1850
        format  1845, 1846, 1847, 1848, 1849, 1850, 1851, 1852, 1853, 1854, 1855, 1856, 1857, 1858
    +href="glossaries-user.html#dx1-130039" >1851, 1852, 1853, 1854, 1855, 1856, 1857, 1858, 1859, 1860, 1861, 1862, 1863, 1864
        hyper  1859, 1860, 1861, 1862, 1863, 1864, 1865, 1866
    +href="glossaries-user.html#dx1-35013" >1865, 1866, 1867, 1868, 1869, 1870, 1871, 1872
        hyperoutside  1867
    +href="glossaries-user.html#dx1-130078" >1873
        local  1868
    +href="glossaries-user.html#dx1-130076" >1874
        noindex  1869
    +href="glossaries-user.html#dx1-130077" >1875
        prefix  1870
    +href="glossaries-user.html#dx1-130085" >1876
        textformat  1871
    +href="glossaries-user.html#dx1-130082" >1877
        theHvalue  1872
    +href="glossaries-user.html#dx1-130088" >1878
        thevalue  1873
    +href="glossaries-user.html#dx1-130087" >1879
        wrgloss  1874
    +href="glossaries-user.html#dx1-130080" >1880
    \glslinkcheckfirsthyperhook  1875
    +href="glossaries-user.html#dx1-35015" >1881
    \glslinkpostsetkeys  1876, 1877, 1878, 1879, 1880, 1881, 1882, 1883, 1884
    +href="glossaries-user.html#dx1-35023" >1882, 1883, 1884, 1885, 1886, 1887, 1888, 1889, 1890
    \glslinkprefix  1885
    +href="glossaries-user.html#dx1-145071" >1891
    \glslinkpresetkeys  1886
    +href="glossaries-user.html#dx1-225004" >1892
    \glslinkvar  1887
    +href="glossaries-user.html#dx1-133028" >1893
    + + \glslistdottedwidth  1888
    +href="glossaries-user.html#dx1-157047" >1894
    +\glslistexpandedname  1895
    +\glslistinit  1896
    \glslistnavigationitem  1889
    +href="glossaries-user.html#dx1-157031" >1897
    \glslocalreset  1890
    - - +href="glossaries-user.html#dx1-143004" >1898
    \glslocalresetall  1891
    +href="glossaries-user.html#dx1-143008" >1899
    \glslocalunset  1892
    +href="glossaries-user.html#dx1-143006" >1900
    \glslocalunsetall  1893
    +href="glossaries-user.html#dx1-143010" >1901
    \glslongfont  1894
    +href="glossaries-user.html#dx1-186007" >1902
    \glslongtok  1895, 1896, 1897, 1898, 1899
    +href="glossaries-user.html#dx1-140025" >1903, 1904, 1905, 1906, 1907
    \glsmcols  1900
    +href="glossaries-user.html#dx1-164015" >1908
    \glsmoveentry  1901
    +href="glossaries-user.html#dx1-125001" >1909
    \GLSname  1902
    +href="glossaries-user.html#dx1-132044" >1910
    \Glsname  1903
    +href="glossaries-user.html#dx1-132043" >1911
    \glsname  1904
    +href="glossaries-user.html#dx1-132038" >1912
    \glsnamefont  1905, 1906, 1907
    +href="glossaries-user.html#dx1-139010" >1913, 1914, 1915
    \glsnavhypertarget  1908
    +href="glossaries-user.html#dx1-166031" >1916
    \glsnavigation  1909
    +href="glossaries-user.html#dx1-166032" >1917
    \glsnoexpandfields  1910
    +href="glossaries-user.html#dx1-120023" >1918
    \glsnoidxdisplayloc  1911
    +href="glossaries-user.html#dx1-153022" >1919
    \glsnumberformat  1912, 1913, 1914, 1915, 1916, 1917
    +href="glossaries-user.html#dx1-151003" >1920, 1921, 1922, 1923, 1924, 1925
    \glsnumberlistloop  1918
    +href="glossaries-user.html#dx1-153019" >1926
    \glsnumbersgroupname  1919
    +href="glossaries-user.html#dx1-15032" >1927
    \glsnumbersgrouptitle  1920
    +href="glossaries-user.html#dx1-166029" >1928
    \glsnumlistlastsep  1921
    +href="glossaries-user.html#dx1-135068" >1929
    \glsnumlistsep  1922
    +href="glossaries-user.html#dx1-135067" >1930
    \glsopenbrace  1923
    +href="glossaries-user.html#dx1-167007" >1931
    \glspagelistwidth  1924, 1925, 1926, 1927, 1928, 1929, 1930, 1931
    +href="glossaries-user.html#dx1-156018" >1932, 1933, 1934, 1935, 1936, 1937, 1938, 1939
    \glspar  1932
    +href="glossaries-user.html#dx1-114027" >1940
    \glspatchtabularx  1933
    +href="glossaries-user.html#dx1-131008" >1941
    \glspercentchar  1934
    +href="glossaries-user.html#dx1-167009" >1942
    \GLSpl  1935, 1936, 1937, 1938, 1939
    +href="glossaries-user.html#dx1-3027" >1943, 1944, 1945, 1946, 1947
    \Glspl  1940, 1941, 1942, 1943, 1944, 1945, 1946
    +href="glossaries-user.html#dx1-3026" >1948, 1949, 1950, 1951, 1952, 1953, 1954
    \glspl  1947, 1948, 1949, 1950, 1951, 1952, 1953, 1954, 1955, 1956, 1957, 1958
    +href="glossaries-user.html#dx1-3025" >1955, 1956, 1957, 1958, 1959, 1960, 1961, 1962, 1963, 1964, 1965, 1966
    \GLSplural  1959
    +href="glossaries-user.html#dx1-132032" >1967
    \Glsplural  1960
    +href="glossaries-user.html#dx1-132031" >1968
    \glsplural  1961
    +href="glossaries-user.html#dx1-132028" >1969
    \glspluralsuffix  1962, 1963, 1964, 1965, 1966, 1967
    +href="glossaries-user.html#dx1-114051" >1970, 1971, 1972, 1973, 1974, 1975
    \glspostdescription  1968, 1969, 1970
    +href="glossaries-user.html#dx1-156040" >1976, 1977, 1978
    \glspostinline  1971, 1972
    +href="glossaries-user.html#dx1-165014" >1979, 1980
    \glspostlinkhook  1973, 1974, 1975, 1976, 1977
    +href="glossaries-user.html#dx1-133037" >1981, 1982, 1983, 1984, 1985
    \glsprefixsep  1978
    +href="glossaries-user.html#dx1-175017" >1986
    \glsprestandardsort  1979, 1980, 1981
    +href="glossaries-user.html#dx1-75024" >1987, 1988, 1989
    \glsps  1982
    +href="glossaries-user.html#dx1-196021" >1990
    \glspt  1983, 1984, 1985, 1986, 1987
    +href="glossaries-user.html#dx1-196023" >1991, 1992, 1993, 1994, 1995
    \glsquote  1988
    +href="glossaries-user.html#dx1-167014" >1996
    + + \glsrefentry  1989, 1990, 1991, 1992, 1993, 1994
    +href="glossaries-user.html#dx1-48004" >1997, 1998, 1999, 2000, 2001, 2002
    \glsreset  1995, 1996, 1997
    +href="glossaries-user.html#dx1-66004" >2003, 2004, 2005
    \glsresetall  1998
    +href="glossaries-user.html#dx1-143007" >2006
    \glsresetentrycounter  1999
    +href="glossaries-user.html#dx1-49006" >2007
    \glsrestoreLToutput  2000
    - - +href="glossaries-user.html#dx1-160023" >2008
    \glssee  2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
    +href="glossaries-user.html#dx1-58005" >2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016
    \glsseeformat  2009, 2010
    +href="glossaries-user.html#dx1-149002" >2017, 2018
    \glsseeitemformat  2011, 2012, 2013, 2014, 2015, 2016, 2017
    +href="glossaries-user.html#dx1-149011" >2019, 2020, 2021, 2022, 2023, 2024, 2025
    \glsseelastsep  2018
    +href="glossaries-user.html#dx1-149009" >2026
    \glsseelist  2019
    +href="glossaries-user.html#dx1-149018" >2027
    \glsseesep  2020
    +href="glossaries-user.html#dx1-149008" >2028
    \glsSetAlphaCompositor  2021, 2022
    +href="glossaries-user.html#dx1-113019" >2029, 2030
    \glssetcategoryattribute  2023, 2024, 2025, 2026, 2027, 2028, 2029, 2030, 2031, 2032, 2033, 2034, 2035, 2036, 2037, 2038, 2039, 2040, 2041, 2042
    +href="glossaries-user.html#dx1-12055" >2031, 2032, 2033, 2034, 2035, 2036, 2037, 2038, 2039, 2040, 2041, 2042, 2043, 2044, 2045, 2046, 2047, 2048, 2049, 2050
    \glsSetCompositor  2043, 2044
    +href="glossaries-user.html#dx1-113018" >2051, 2052
    \glssetexpandfield  2045
    +href="glossaries-user.html#dx1-120007" >2053
    \glssetnoexpandfield  2046
    +href="glossaries-user.html#dx1-120008" >2054
    \GlsSetQuote  2047, 2048
    +href="glossaries-user.html#dx1-8017" >2055, 2056
    \glsSetSuffixF  2049
    +href="glossaries-user.html#dx1-153009" >2057
    \glsSetSuffixFF  2050
    +href="glossaries-user.html#dx1-153010" >2058
    \glssetwidest  2051, 2052, 2053, 2054, 2055
    +href="glossaries-user.html#dx1-163049" >2059, 2060, 2061, 2062, 2063
    \GlsSetWriteIstHook  2056
    +href="glossaries-user.html#dx1-154002" >2064
    \GlsSetXdyCodePage  2057, 2058, 2059
    +href="glossaries-user.html#dx1-17097" >2065, 2066, 2067
    \GlsSetXdyFirstLetterAfterDigits  2060
    +href="glossaries-user.html#dx1-170004" >2068
    \GlsSetXdyLanguage  2061, 2062, 2063, 2064
    +href="glossaries-user.html#dx1-17095" >2069, 2070, 2071, 2072
    \GlsSetXdyLocationClassOrder  2065
    +href="glossaries-user.html#dx1-169061" >2073
    \GlsSetXdyMinRangeLength  2066, 2067
    +href="glossaries-user.html#dx1-153004" >2074, 2075
    \GlsSetXdyNumberGroupOrder  2068
    +href="glossaries-user.html#dx1-170007" >2076
    \glsshortaccsupp  2069, 2070
    +href="glossaries-user.html#dx1-176070" >2077, 2078
    \glsshortplaccsupp  2071, 2072
    +href="glossaries-user.html#dx1-176071" >2079, 2080
    \glsshorttok  2073, 2074, 2075
    +href="glossaries-user.html#dx1-140026" >2081, 2082, 2083
    \glsshowaccsupp  2076
    +href="glossaries-user.html#dx1-31012" >2084
    \glsshowtarget  2077, 2078
    +href="glossaries-user.html#dx1-31008" >2085, 2086
    \glsshowtargetfont  2079
    +href="glossaries-user.html#dx1-31010" >2087
    \glsshowtargetouter  2080
    +href="glossaries-user.html#dx1-31009" >2088
    \glssortnumberfmt  2081
    +href="glossaries-user.html#dx1-75016" >2089
    \glssubentrycounterlabel  2082
    +href="glossaries-user.html#dx1-166068" >2090
    \glssubentryitem  2083, 2084
    +href="glossaries-user.html#dx1-166065" >2091, 2092
    \GLSsymbol  2085
    +href="glossaries-user.html#dx1-132049" >2093
    \Glssymbol  2086
    +href="glossaries-user.html#dx1-132048" >2094
    \glssymbol  2087, 2088, 2089, 2090, 2091, 2092
    +href="glossaries-user.html#dx1-132045" >2095, 2096, 2097, 2098, 2099, 2100
    \glssymbolaccsupp  2093
    +href="glossaries-user.html#dx1-228024" >2101
    \glssymbolsgroupname  2094, 2095, 2096
    +href="glossaries-user.html#dx1-15031" >2102, 2103, 2104
    \glstarget  2097, 2098
    +href="glossaries-user.html#dx1-166050" >2105, 2106
    \GLStext  2099, 2100
    +href="glossaries-user.html#dx1-118008" >2107, 2108
    \Glstext  2101, 2102
    +href="glossaries-user.html#dx1-118007" >2109, 2110
    \glstext  2103, 2104, 2105, 2106
    +href="glossaries-user.html#dx1-35009" >2111, 2112, 2113, 2114
    + + \glstextformat  2107, 2108, 2109, 2110, 2111, 2112
    +href="glossaries-user.html#dx1-130023" >2115, 2116, 2117, 2118, 2119, 2120
    \glstextup  2113
    +href="glossaries-user.html#dx1-140035" >2121
    \glstildechar  2114
    +href="glossaries-user.html#dx1-167010" >2122
    \glstocfalse  2115
    +href="glossaries-user.html#dx1-41002" >2123
    \glstoctrue  2116
    - - +href="glossaries-user.html#dx1-41001" >2124
    \glstreechildpredesc  2117
    +href="glossaries-user.html#dx1-163014" >2125
    \glstreegroupheaderfmt  2118
    +href="glossaries-user.html#dx1-163006" >2126
    \glstreeindent  2119
    +href="glossaries-user.html#dx1-163033" >2127
    \glstreeitem  2120
    +href="glossaries-user.html#dx1-163019" >2128
    \glstreenamebox  2121
    +href="glossaries-user.html#dx1-163054" >2129
    \glstreenamefmt  2122
    +href="glossaries-user.html#dx1-163004" >2130
    \glstreenavigationfmt  2123
    +href="glossaries-user.html#dx1-163008" >2131
    \glstreepredesc  2124
    +href="glossaries-user.html#dx1-163011" >2132
    \glstreesubitem  2125
    +href="glossaries-user.html#dx1-163020" >2133
    \glstreesubsubitem  2126
    +href="glossaries-user.html#dx1-163021" >2134
    \glstype  2127, 2128, 2129
    +href="glossaries-user.html#dx1-35018" >2135, 2136, 2137
    +\glsunexpandedfieldvalue  2138, 2139
    \glsunset  2130
    +href="glossaries-user.html#dx1-143005" >2140
    \glsunsetall  2131, 2132
    +href="glossaries-user.html#dx1-134016" >2141, 2142
    \GlsUseAcrEntryDispStyle  2133
    +href="glossaries-user.html#dx1-140031" >2143
    \GlsUseAcrStyleDefs  2134
    +href="glossaries-user.html#dx1-140032" >2144
    \GLSuseri  2135
    +href="glossaries-user.html#dx1-132059" >2145
    \Glsuseri  2136
    +href="glossaries-user.html#dx1-132058" >2146
    \glsuseri  2137
    +href="glossaries-user.html#dx1-132055" >2147
    \glsuseriaccsupp  2138
    +href="glossaries-user.html#dx1-228028" >2148
    \GLSuserii  2139
    +href="glossaries-user.html#dx1-132064" >2149
    \Glsuserii  2140
    +href="glossaries-user.html#dx1-132063" >2150
    \glsuserii  2141
    +href="glossaries-user.html#dx1-132060" >2151
    \GLSuseriii  2142
    +href="glossaries-user.html#dx1-132069" >2152
    \Glsuseriii  2143
    +href="glossaries-user.html#dx1-132068" >2153
    \glsuseriii  2144
    +href="glossaries-user.html#dx1-132065" >2154
    \GLSuseriv  2145
    +href="glossaries-user.html#dx1-132074" >2155
    \Glsuseriv  2146
    +href="glossaries-user.html#dx1-132073" >2156
    \glsuseriv  2147
    +href="glossaries-user.html#dx1-132070" >2157
    \GLSuserv  2148
    +href="glossaries-user.html#dx1-132079" >2158
    \Glsuserv  2149
    +href="glossaries-user.html#dx1-132078" >2159
    \glsuserv  2150
    +href="glossaries-user.html#dx1-132075" >2160
    \GLSuservi  2151
    +href="glossaries-user.html#dx1-132084" >2161
    \Glsuservi  2152
    +href="glossaries-user.html#dx1-132083" >2162
    \glsuservi  2153
    +href="glossaries-user.html#dx1-132080" >2163
    \glswrallowprimitivemodsfalse  2154
    +href="glossaries-user.html#dx1-152028" >2164
    \glswrite  2155
    +href="glossaries-user.html#dx1-154003" >2165
    \glswriteentry  2156
    +href="glossaries-user.html#dx1-66005" >2166
    \glsxtr@makeglossaries  2157
    +href="glossaries-user.html#dx1-23004" >2167
    \glsxtr@record  2158
    +href="glossaries-user.html#dx1-25015" >2168
    \glsxtr@record@nameref  2159
    +href="glossaries-user.html#dx1-25017" >2169
    + + \glsxtr@recordsee  2160
    +href="glossaries-user.html#dx1-25018" >2170
    \glsxtr@resource  2161, 2162
    +href="glossaries-user.html#dx1-25003" >2171, 2172
    \glsxtr@texencoding  2163
    +href="glossaries-user.html#dx1-218039" >2173
    \glsxtrabbrvfootnote  2164, 2165, 2166, 2167, 2168
    +href="glossaries-user.html#dx1-186016" >2174, 2175, 2176, 2177, 2178
    \glsxtrabbrvtype  2169, 2170, 2171
    +href="glossaries-user.html#dx1-92017" >2179, 2180, 2181
    \glsxtrbookindexname  2172
    - - +href="glossaries-user.html#dx1-12087" >2182
    \glsxtrcombiningdiacriticrules  2173, 2174
    +href="glossaries-user.html#dx1-215061" >2183, 2184
    \glsxtrcontrolrules  2175, 2176
    +href="glossaries-user.html#dx1-215058" >2185, 2186
    \glsxtrdigitrules  2177, 2178
    +href="glossaries-user.html#dx1-215064" >2187, 2188
    \glsxtrdopostpunc  2179, 2180
    +href="glossaries-user.html#dx1-187023" >2189, 2190
    \glsxtrequationlocfmt  2181
    +href="glossaries-user.html#dx1-194046" >2191
    \glsxtrfieldforlistloop  2182
    +href="glossaries-user.html#dx1-204046" >2192
    \glsxtrfieldformatlist  2183, 2184
    +href="glossaries-user.html#dx1-224027" >2193, 2194
    \glsxtrfmt  2185, 2186, 2187, 2188, 2189, 2190, 2191
    +href="glossaries-user.html#dx1-192041" >2195, 2196, 2197, 2198, 2199, 2200, 2201
    \GlsXtrFmtField  2192
    +href="glossaries-user.html#dx1-193034" >2202
    \glsxtrfootnotedescname  2193, 2194
    +href="glossaries-user.html#dx1-186006" >2203, 2204
    \glsxtrfootnotedescsort  2195, 2196
    +href="glossaries-user.html#dx1-186014" >2205, 2206
    \glsxtrfull  2197, 2198, 2199, 2200
    +href="glossaries-user.html#dx1-182040" >2207, 2208, 2209, 2210
    \glsxtrfullsep  2201, 2202, 2203, 2204, 2205
    +href="glossaries-user.html#dx1-186009" >2211, 2212, 2213, 2214, 2215
    \glsxtrgeneralpuncrules  2206, 2207
    +href="glossaries-user.html#dx1-215063" >2216, 2217
    \glsxtrglossentry  2208, 2209, 2210
    +href="glossaries-user.html#dx1-12005" >2218, 2219, 2220
    \glsxtrhiername  2211
    +href="glossaries-user.html#dx1-149016" >2221
    \glsxtrhyphenrules  2212, 2213
    +href="glossaries-user.html#dx1-215062" >2222, 2223
    \GlsXtrIfFieldEqNum  2214
    +href="glossaries-user.html#dx1-213009" >2224
    \GlsXtrIfFieldNonZero  2215
    +href="glossaries-user.html#dx1-204044" >2225
    \glsxtrifhasfield  2216, 2217
    +href="glossaries-user.html#dx1-204020" >2226, 2227
    \GlsXtrIfUnusedOrUndefined  2218
    +href="glossaries-user.html#dx1-143013" >2228
    \glsxtrifwasfirstuse  2219, 2220, 2221, 2222
    +href="glossaries-user.html#dx1-187014" >2229, 2230, 2231, 2232
    \GlsXtrIfXpFieldEqXpStr  2223, 2224, 2225
    +href="glossaries-user.html#dx1-204025" >2233, 2234, 2235
    \Glsxtrinlinefullformat  2226
    +href="glossaries-user.html#dx1-188029" >2236
    \glsxtrinlinefullformat  2227
    +href="glossaries-user.html#dx1-188011" >2237
    \Glsxtrinlinefullplformat  2228
    +href="glossaries-user.html#dx1-188038" >2238
    \glsxtrinlinefullplformat  2229
    +href="glossaries-user.html#dx1-188020" >2239
    \GlsXtrLoadResources  2230, 2231, 2232, 2233, 2234, 2235, 2236, 2237, 2238, 2239, 2240, 2241, 2242, 2243, 2244, 2245, 2246, 2247, 2248, 2249, 2250, 2251, 2252, 2253, 2254, 2255, 2256, 2257, 2258, 2259, 2260, 2261, 2262, 2263, 2264, 2265, 2266, 2267, 2268, 2269, 2270, 2271, 2272, 2273, 2274, 2275
    +href="glossaries-user.html#dx1-10003" >2240, 2241, 2242, 2243, 2244, 2245, 2246, 2247, 2248, 2249, 2250, 2251, 2252, 2253, 2254, 2255, 2256, 2257, 2258, 2259, 2260, 2261, 2262, 2263, 2264, 2265, 2266, 2267, 2268, 2269, 2270, 2271, 2272, 2273, 2274, 2275, 2276, 2277, 2278, 2279, 2280, 2281, 2282, 2283, 2284, 2285
    \GlsXtrLoadResources options
        abbreviation-sort-fallback  2276
    +href="glossaries-user.html#dx1-183060" >2286
        append-prefix-field  2277
    +href="glossaries-user.html#dx1-227021" >2287
        break-at  2278, 2279, 2280, 2281, 2282
    +href="glossaries-user.html#dx1-76008" >2288, 2289, 2290, 2291, 2292
        category  2283
    +href="glossaries-user.html#dx1-198024" >2293
        combine-dual-locations  2284
    +href="glossaries-user.html#dx1-197048" >2294
        dual-category  2285
    +href="glossaries-user.html#dx1-198025" >2295
        dual-prefix  2286, 2287, 2288
    +href="glossaries-user.html#dx1-197021" >2296, 2297, 2298
        dual-sort  2289
    +href="glossaries-user.html#dx1-198030" >2299
        dual-type  2290, 2291, 2292
    +href="glossaries-user.html#dx1-197020" >2300, 2301, 2302
        entry-type-aliases  2293
    +href="glossaries-user.html#dx1-206102" >2303
    + +     ext-prefixes  2294
    +href="glossaries-user.html#dx1-196035" >2304
        field-aliases  2295
    +href="glossaries-user.html#dx1-206101" >2305
        identical-sort-action  2296
    +href="glossaries-user.html#dx1-204082" >2306
        ignore-fields  2297
    +href="glossaries-user.html#dx1-183076" >2307
        label-prefix  2298
    +href="glossaries-user.html#dx1-196034" >2308
        loc-counters  2299
    - - +href="glossaries-user.html#dx1-193067" >2309
        name-case-change  2300
    +href="glossaries-user.html#dx1-12062" >2310
        primary-location-formats  2301
    +href="glossaries-user.html#dx1-193069" >2311
        replicate-fields  2302, 2303
    +href="glossaries-user.html#dx1-12061" >2312, 2313
        save-child-count  2304, 2305
    +href="glossaries-user.html#dx1-173014" >2314, 2315
        save-locations  2306, 2307, 2308
    +href="glossaries-user.html#dx1-12030" >2316, 2317, 2318
        save-loclist  2309
    +href="glossaries-user.html#dx1-47011" >2319
        save-sibling-count  2310, 2311, 2312, 2313
    +href="glossaries-user.html#dx1-204039" >2320, 2321, 2322, 2323
        save-locations  2314, 2315
    +href="glossaries-user.html#dx1-12012" >2324, 2325
        selection  2316, 2317, 2318, 2319, 2320, 2321, 2322, 2323
    +href="glossaries-user.html#dx1-10029" >2326, 2327, 2328, 2329, 2330, 2331, 2332, 2333
        set-widest  2324
    +href="glossaries-user.html#dx1-206055" >2334
        sort  2325, 2326, 2327, 2328, 2329, 2330, 2331, 2332, 2333, 2334, 2335, 2336
    +href="glossaries-user.html#dx1-10025" >2335, 2336, 2337, 2338, 2339, 2340, 2341, 2342, 2343, 2344, 2345, 2346
        sort-rule  2337
    +href="glossaries-user.html#dx1-215078" >2347
        src  2338, 2339, 2340, 2341, 2342, 2343, 2344, 2345, 2346, 2347, 2348, 2349, 2350, 2351, 2352, 2353, 2354, 2355, 2356, 2357, 2358, 2359, 2360, 2361, 2362, 2363, 2364, 2365, 2366, 2367, 2368, 2369, 2370, 2371, 2372, 2373, 2374, 2375, 2376, 2377, 2378, 2379
    +href="glossaries-user.html#dx1-10004" >2348, 2349, 2350, 2351, 2352, 2353, 2354, 2355, 2356, 2357, 2358, 2359, 2360, 2361, 2362, 2363, 2364, 2365, 2366, 2367, 2368, 2369, 2370, 2371, 2372, 2373, 2374, 2375, 2376, 2377, 2378, 2379, 2380, 2381, 2382, 2383, 2384, 2385, 2386, 2387, 2388, 2389
        type  2380, 2381, 2382
    +href="glossaries-user.html#dx1-196058" >2390, 2391, 2392
    \glsxtrlocalsetgrouptitle  2383
    +href="glossaries-user.html#dx1-145104" >2393
    \glsxtrlong  2384, 2385, 2386, 2387
    +href="glossaries-user.html#dx1-182039" >2394, 2395, 2396, 2397
    \glsxtrnewgls  2388
    +href="glossaries-user.html#dx1-196027" >2398
    \glsxtrnewglslike  2389, 2390, 2391, 2392
    +href="glossaries-user.html#dx1-25019" >2399, 2400, 2401, 2402
    \glsxtrnewnumber  2393
    +href="glossaries-user.html#dx1-88005" >2403
    \glsxtrnewsymbol  2394, 2395, 2396, 2397
    +href="glossaries-user.html#dx1-4009" >2404, 2405, 2406, 2407
    \glsxtrnonprintablerules  2398, 2399
    +href="glossaries-user.html#dx1-215060" >2408, 2409
    \glsxtrnopostpunc  2400, 2401, 2402, 2403, 2404, 2405, 2406, 2407
    +href="glossaries-user.html#dx1-114029" >2410, 2411, 2412, 2413, 2414, 2415, 2416, 2417
    \glsxtrp  2408
    +href="glossaries-user.html#dx1-196020" >2418
    \glsxtrparen  2409, 2410, 2411, 2412, 2413
    +href="glossaries-user.html#dx1-186011" >2419, 2420, 2421, 2422, 2423
    \glsxtrpostlinkAddSymbolOnFirstUse  2414
    +href="glossaries-user.html#dx1-226008" >2424
    \glsxtrsectionlocfmt  2415, 2416, 2417
    +href="glossaries-user.html#dx1-194043" >2425, 2426, 2427
    \GlsXtrSetAltModifier  2418, 2419
    +href="glossaries-user.html#dx1-25023" >2428, 2429
    \glsxtrsetgrouptitle  2420
    +href="glossaries-user.html#dx1-145103" >2430
    \glsxtrshort  2421, 2422, 2423, 2424, 2425
    +href="glossaries-user.html#dx1-182038" >2431, 2432, 2433, 2434, 2435
    \glsxtrspacerules  2426, 2427
    +href="glossaries-user.html#dx1-215059" >2436, 2437
    \GlsXtrUseAbbrStyleFmts  2428
    +href="glossaries-user.html#dx1-188010" >2438
    \GlsXtrUseAbbrStyleSetup  2429
    +href="glossaries-user.html#dx1-188009" >2439

    H html package  2430
    +href="glossaries-user.html#dx1-134002" >2440
    \hyperbf  2431, 2432, 2433, 2434, 2435, 2436
    +href="glossaries-user.html#dx1-130059" >2441, 2442, 2443, 2444, 2445, 2446
    \hyperbfit  2437
    +href="glossaries-user.html#dx1-194035" >2447
    \hyperbsf  2438
    +href="glossaries-user.html#dx1-130067" >2448
    + + \hyperemph  2439
    +href="glossaries-user.html#dx1-130065" >2449
    \hyperit  2440, 2441, 2442
    +href="glossaries-user.html#dx1-130061" >2450, 2451, 2452
    \hyperlink  2443, 2444
    +href="glossaries-user.html#dx1-130066" >2453, 2454
    \hypermd  2445
    +href="glossaries-user.html#dx1-130060" >2455
    \hyperpage  2446
    +href="glossaries-user.html#dx1-130051" >2456
    hyperref package  2447, 2448, 2449, 2450, 2451, 2452, 2453, 2454, 2455, 2456, 2457, 2458, 2459, 2460, 2461, 2462, 2463, 2464, 2465, 2466, 2467, 2468, 2469, 2470, 2471, 2472, 2473, 2474, 2475, 2476, 2477, 2478, 2479
    - - +href="glossaries-user.html#dx1-16" >2457, 2458, 2459, 2460, 2461, 2462, 2463, 2464, 2465, 2466, 2467, 2468, 2469, 2470, 2471, 2472, 2473, 2474, 2475, 2476, 2477, 2478, 2479, 2480, 2481, 2482, 2483, 2484, 2485, 2486, 2487, 2488, 2489, 2490, 2491
    \hyperrm  2480, 2481, 2482
    +href="glossaries-user.html#dx1-130056" >2492, 2493, 2494
    \hypersc  2483
    +href="glossaries-user.html#dx1-130064" >2495
    \hypersf  2484
    +href="glossaries-user.html#dx1-130057" >2496
    \hypersl  2485
    +href="glossaries-user.html#dx1-130062" >2497
    \hypertarget  2486
    +href="glossaries-user.html#dx1-134008" >2498
    \hypertt  2487
    +href="glossaries-user.html#dx1-130058" >2499
    \hyperup  2488
    +href="glossaries-user.html#dx1-130063" >2500

    I \ifglossaryexists  2489
    +href="glossaries-user.html#dx1-173001" >2501
    \ifglsdescsuppressed  2490
    +href="glossaries-user.html#dx1-173027" >2502
    \ifglsentryexists  2491
    +href="glossaries-user.html#dx1-173003" >2503
    \ifglsfieldcseq  2492
    +href="glossaries-user.html#dx1-173038" >2504
    \ifglsfielddefeq  2493
    +href="glossaries-user.html#dx1-173036" >2505
    \ifglsfieldeq  2494, 2495
    +href="glossaries-user.html#dx1-140085" >2506, 2507
    \ifglshaschildren  2496, 2497
    +href="glossaries-user.html#dx1-173012" >2508, 2509
    \ifglshasdesc  2498
    +href="glossaries-user.html#dx1-173025" >2510
    \ifglshasfield  2499
    +href="glossaries-user.html#dx1-173030" >2511
    \ifglshaslong  2500, 2501, 2502, 2503, 2504
    +href="glossaries-user.html#dx1-35021" >2512, 2513, 2514, 2515, 2516
    \ifglshasparent  2505
    +href="glossaries-user.html#dx1-173016" >2517
    \ifglshasprefix  2506
    +href="glossaries-user.html#dx1-175041" >2518
    \ifglshasprefixfirst  2507
    +href="glossaries-user.html#dx1-175045" >2519
    \ifglshasprefixfirstplural  2508
    +href="glossaries-user.html#dx1-175047" >2520
    \ifglshasprefixplural  2509
    +href="glossaries-user.html#dx1-175043" >2521
    \ifglshasshort  2510, 2511, 2512
    +href="glossaries-user.html#dx1-140012" >2522, 2523, 2524
    \ifglshassymbol  2513, 2514, 2515
    +href="glossaries-user.html#dx1-12052" >2525, 2526, 2527
    \ifglsucmark  2516
    +href="glossaries-user.html#dx1-44011" >2528
    \ifglsused  2517, 2518, 2519, 2520, 2521, 2522, 2523, 2524, 2525, 2526
    +href="glossaries-user.html#dx1-35019" >2529, 2530, 2531, 2532, 2533, 2534, 2535, 2536, 2537, 2538
    \ifglsxtrinsertinside  2527, 2528, 2529, 2530, 2531, 2532, 2533, 2534
    +href="glossaries-user.html#dx1-188014" >2539, 2540, 2541, 2542, 2543, 2544, 2545, 2546
    \ifignoredglossary  2535
    +href="glossaries-user.html#dx1-146014" >2547
    imakeidx package  2536
    +href="glossaries-user.html#dx1-89011" >2548
    \include  2537
    +href="glossaries-user.html#dx1-124008" >2549
    \includegraphics  2538, 2539
    +href="glossaries-user.html#dx1-228031" >2550, 2551
    \index  2540, 2541, 2542, 2543
    +href="glossaries-user.html#dx1-89008" >2552, 2553, 2554, 2555
    index package  2544
    +href="glossaries-user.html#dx1-89010" >2556
    \indexname  2545
    +href="glossaries-user.html#dx1-146027" >2557
    \indexspace  2546, 2547, 2548, 2549
    +href="glossaries-user.html#dx1-157023" >2558, 2559, 2560, 2561
    \input  2550, 2551
    +href="glossaries-user.html#dx1-13002" >2562, 2563
    + + inputenc package  2552, 2553, 2554, 2555, 2556, 2557, 2558
    +href="glossaries-user.html#dx1-14015" >2564, 2565, 2566, 2567, 2568, 2569, 2570
    \inputencodingname  2559
    +href="glossaries-user.html#dx1-168009" >2571
    internal fields:
        childcount  2560
    +href="glossaries-user.html#dx1-173015" >2572
        location  2561, 2562, 2563
    +href="glossaries-user.html#dx1-6009" >2573, 2574, 2575
        loclist  2564
    - - +href="glossaries-user.html#dx1-224034" >2576
        siblingcount  2565, 2566
    +href="glossaries-user.html#dx1-204045" >2577, 2578
        useri  2567
    +href="glossaries-user.html#dx1-193035" >2579
    \item  2568, 2569
    +href="glossaries-user.html#dx1-157021" >2580, 2581

    J \jobname  2570, 2571
    +href="glossaries-user.html#dx1-113011" >2582, 2583

    L \label  2572
    +href="glossaries-user.html#dx1-45005" >2584
    latex  2573, 2574
    +href="glossaries-user.html#dx1-27" >2585, 2586
    latexmk  2575, 2576, 2577
    +href="glossaries-user.html#dx1-17019" >2587, 2588, 2589
    +latexrelease package  2590
    Latin alphabet  2578, 2579, 2580
    +class="cmbx-10">2591, 2592, 2593
    Latin character  2581, 2582, 2583, 2584, 2594, 2595, 2596, 2597, 2585, 2586, 2587
    +class="cmbx-10">2598, 2599, 2600
    link text  2588, 2589, 2590, 2591, 2592, 2593, 2594, 2595, 2596, 2597, 2598, 2599, 2600, 2601, 2602, 2603, 2604, 2605, 2606, 2607, 2608, 2609, 2610, 2611, 2612, 2613, 2614, 2615, 2616, 2617, 2618, 2619, 2620, 2621, 2622, 2623, 2624, 2625, 2626, 2627, 2628, 2629, 2630, 2631, 2632, 2633, 2634, 2635, 2636, 2637, 2638, 2639, 2640, 2641, 2642, 2643, 2644, 2645, 2646, 2647, 2648, 2649, 2650, 2651, 2652, 2653, 2654
    +class="cmbx-10">2601, 2602, 2603, 2604, 2605, 2606, 2607, 2608, 2609, 2610, 2611, 2612, 2613, 2614, 2615, 2616, 2617, 2618, 2619, 2620, 2621, 2622, 2623, 2624, 2625, 2626, 2627, 2628, 2629, 2630, 2631, 2632, 2633, 2634, 2635, 2636, 2637, 2638, 2639, 2640, 2641, 2642, 2643, 2644, 2645, 2646, 2647, 2648, 2649, 2650, 2651, 2652, 2653, 2654, 2655, 2656, 2657, 2658, 2659, 2660, 2661, 2662, 2663, 2664, 2665, 2666, 2667
    \listbreak  2655
    +href="glossaries-user.html#dx1-204049" >2668
    \loadglsentries  2656, 2657, 2658, 2659, 2660, 2661, 2662, 2663, 2664
    +href="glossaries-user.html#dx1-7003" >2669, 2670, 2671, 2672, 2673, 2674, 2675, 2676, 2677
    location list  see number list
    +href="glossaries-user.html#dx1-150004" >number list
    \longnewglossaryentry  2666, 2667, 2668, 2669
    +href="glossaries-user.html#dx1-114009" >2679, 2680, 2681, 2682
    \longprovideglossaryentry  2670
    +href="glossaries-user.html#dx1-114011" >2683
    longtable package  2671, 2672
    +href="glossaries-user.html#dx1-52002" >2684, 2685

    M \makeatletter  2673
    +href="glossaries-user.html#dx1-140086" >2686
    \makeatother  2674
    +href="glossaries-user.html#dx1-140087" >2687
    \makefirstuc  2675, 2676, 2677, 2678
    +href="glossaries-user.html#dx1-131023" >2688, 2689, 2690, 2691
    makeglossaries  2679, 2680, 2681, 2682, 2683, 2684, 2685, 2686, 2687, 2688, 2689, 2690, 2691, 2692, 2693, 2694, 2695, 2696, 2697, 2698, 2699, 2700, 2701, 2702, 2703, 2704, 2705, 2706, 2707, 2708, 2709, 2710, 2711, 2712, 2713, 2714, 2715, 2716, 2717, 2718, 2719, 2720, 2721, 2722, 2723, 2724, 2725, 2726, 2727, 2728, 2729, 2730, 2731, 2732, 2733, 2734, 2735, 2736, 2737, 2738, 2739, 2740, 2741, 2742, 2743, 2744, 2745, 2746, 2747, 2748, 2749, 2750, 2751, 2752, 2753, 2754, 2755, 2756, 2757, 2758, 2759, 2760, 2761, 2762, 2763, 2764, 2765, 2766, 2767, 2768, 2769, 2770, 2771, 2772, 2773, 2774, 2775, 2776, 2777, 2778
    +class="cmbx-10">2692, 2693, 2694, 2695, 2696, 2697, 2698, 2699, 2700, 2701, 2702, 2703, 2704, 2705, 2706, 2707, 2708, 2709, 2710, 2711, 2712, 2713, 2714, 2715, 2716, 2717, 2718, 2719, 2720, 2721, 2722, 2723, 2724, 2725, 2726, 2727, 2728, 2729, 2730, 2731, 2732, 2733, 2734, 2735, 2736, 2737, 2738, 2739, 2740, 2741, 2742, 2743, 2744, 2745, 2746, 2747, 2748, 2749, 2750, 2751, 2752, 2753, 2754, 2755, 2756, 2757, 2758, 2759, 2760, 2761, 2762, 2763, 2764, 2765, 2766, 2767, 2768, 2769, 2770, 2771, 2772, 2773, 2774, 2775, 2776, 2777, 2778, 2779, 2780, 2781, 2782, 2783, 2784, 2785, 2786, 2787, 2788, 2789, 2790, 2791
        -d  2779
    +href="glossaries-user.html#dx1-19004" >2792
        -k  2780
    +href="glossaries-user.html#dx1-18015" >2793
        -m  2781
    +href="glossaries-user.html#dx1-18023" >2794
        -Q  2782
    +href="glossaries-user.html#dx1-18014" >2795
        -q  2783
    +href="glossaries-user.html#dx1-18017" >2796
        -x  2784
    +href="glossaries-user.html#dx1-18025" >2797
    \makeglossaries  2785, 2786, 2787, 2788, 2789, 2790, 2791, 2792, 2793, 2794, 2795, 2796, 2797, 2798, 2799, 2800, 2801, 2802, 2803, 2804, 2805, 2806, 2807, 2808, 2809, 2810, 2811, 2812, 2813, 2814, 2815, 2816, 2817, 2818, 2819, 2820, 2821
    +href="glossaries-user.html#dx1-8001" >2798, 2799, 2800, 2801, 2802, 2803, 2804, 2805, 2806, 2807, 2808, 2809, 2810, 2811, 2812, 2813, 2814, 2815, 2816, 2817, 2818, 2819, 2820, 2821, 2822, 2823, 2824, 2825, 2826, 2827, 2828, 2829, 2830, 2831, 2832, 2833, 2834
    + + makeglossaries-lite  2822, 2823, 2824, 2825, 2826, 2827, 2828, 2829, 2830, 2831, 2832, 2833, 2834, 2835, 2836, 2837, 2838, 2839, 2840, 2841, 2842, 2843, 2844, 2845, 2846, 2847, 2848
    +class="cmbx-10">2835, 2836, 2837, 2838, 2839, 2840, 2841, 2842, 2843, 2844, 2845, 2846, 2847, 2848, 2849, 2850, 2851, 2852, 2853, 2854, 2855, 2856, 2857, 2858, 2859, 2860, 2861
    makeglossariesgui  2849, 2850, 2851
    +class="cmbx-10">2862, 2863, 2864
    makeidx package  2852
    +href="glossaries-user.html#dx1-89009" >2865
    makeindex  2853, 2854, 2855, 2856, 2866, 2867, 2868, 2869, 2857, 2858, 2859, 2860, 2861, 2862, 2863, 2864, 2865, 2866, 2867, 2868, 2869, 2870, 2871, 2872, 2873, 2874, 2875, 2876, 2877, 2878, 2879, 2880, 2881, 2882, 2883, 2884, 2885, 2886, 2887, 2888, 2889, 2890, 2891, 2892, 2893, 2894, 2895, 2896, 2897, 2898, 2899, 2900, 2901, 2902, 2903, 2904, 2905, 2906, 2907, 2908, 2909, 2910, 2911, 2912, 2913, 2914, 2915, 2916, 2917, 2918, 2919, 2920, 2921, 2922, 2923, 2924, 2925, 2926, 2927, 2928, 2929, 2930, 2931, 2932, 2933, 2934, 2935, 2936, 2937, 2938, 2939, 2940, 2941, 2942, 2943, 2944, 2945, 2946, 2947, 2948, 2949, 2950, 2951, 2952, 2953, 2954, 2955, 2956, 2957, 2958, 2959, 2960, 2961, 2962, 2963, 2964, 2965, 2966, 2967, 2968, 2969, 2970, 2971, 2972, 2973, 2974, 2975, 2976, 2977, 2978, 2979, 2980, 2981, 2982, 2983, 2984, 2985, 2986, 2987, 2988, 2989, 2990, 2991, 2992, 2993, 2994, 2995, 2996, 2997, 2998, 2999, 3000, 3001
    +class="cmbx-10">2870, 2871, 2872, 2873, 2874, 2875, 2876, 2877, 2878, 2879, 2880, 2881, 2882, 2883, 2884, 2885, 2886, 2887, 2888, 2889, 2890, 2891, 2892, 2893, 2894, 2895, 2896, 2897, 2898, 2899, 2900, 2901, 2902, 2903, 2904, 2905, 2906, 2907, 2908, 2909, 2910, 2911, 2912, 2913, 2914, 2915, 2916, 2917, 2918, 2919, 2920, 2921, 2922, 2923, 2924, 2925, 2926, 2927, 2928, 2929, 2930, 2931, 2932, 2933, 2934, 2935, 2936, 2937, 2938, 2939, 2940, 2941, 2942, 2943, 2944, 2945, 2946, 2947, 2948, 2949, 2950, 2951, 2952, 2953, 2954, 2955, 2956, 2957, 2958, 2959, 2960, 2961, 2962, 2963, 2964, 2965, 2966, 2967, 2968, 2969, 2970, 2971, 2972, 2973, 2974, 2975, 2976, 2977, 2978, 2979, 2980, 2981, 2982, 2983, 2984, 2985, 2986, 2987, 2988, 2989, 2990, 2991, 2992, 2993, 2994, 2995, 2996, 2997, 2998, 2999, 3000, 3001, 3002, 3003, 3004, 3005, 3006, 3007, 3008, 3009, 3010, 3011, 3012, 3013, 3014
        -g  3002, 3003, 3004
    - - +href="glossaries-user.html#dx1-8016" >3015, 3016, 3017
        -l  3005, 3006, 3007, 3008, 3009
    +href="glossaries-user.html#dx1-8042" >3018, 3019, 3020, 3021, 3022
    \makenoidxglossaries  3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020
    +href="glossaries-user.html#dx1-7001" >3023, 3024, 3025, 3026, 3027, 3028, 3029, 3030, 3031, 3032, 3033
    \MakeTextUppercase  3021, 3022
    +href="glossaries-user.html#dx1-44005" >3034, 3035
    \markboth  3023
    +href="glossaries-user.html#dx1-43006" >3036
    memoir class  3024, 3025, 3026, 3027
    +href="glossaries-user.html#dx1-44002" >3037, 3038, 3039, 3040
    \memUChead  3028
    +href="glossaries-user.html#dx1-44015" >3041
    mfirstuc package  3029, 3030, 3031, 3032, 3033, 3034, 3035
    +href="glossaries-user.html#dx1-6" >3042, 3043, 3044, 3045, 3046, 3047, 3048, 3049
    \mfirstucMakeUppercase  3036
    +href="glossaries-user.html#dx1-44007" >3050
    \midrule  3037
    +href="glossaries-user.html#dx1-160013" >3051
    multicol package  3038
    +href="glossaries-user.html#dx1-164004" >3052
    mwe package  3039, 3040, 3041
    +href="glossaries-user.html#dx1-13010" >3053, 3054, 3055

    N nameref package  3042
    +href="glossaries-user.html#dx1-45014" >3056
    \newabbreviation  3043, 3044, 3045, 3046, 3047, 3048, 3049, 3050, 3051, 3052, 3053, 3054, 3055, 3056, 3057, 3058, 3059, 3060, 3061, 3062, 3063, 3064, 3065, 3066, 3067, 3068, 3069, 3070, 3071, 3072, 3073, 3074
    +href="glossaries-user.html#dx1-4008" >3057, 3058, 3059, 3060, 3061, 3062, 3063, 3064, 3065, 3066, 3067, 3068, 3069, 3070, 3071, 3072, 3073, 3074, 3075, 3076, 3077, 3078, 3079, 3080, 3081, 3082, 3083, 3084, 3085, 3086, 3087, 3088
    \newabbreviationstyle  3075
    +href="glossaries-user.html#dx1-188008" >3089
    \newacronym  3076, 3077, 3078, 3079, 3080, 3081, 3082, 3083, 3084, 3085, 3086, 3087, 3088, 3089, 3090, 3091, 3092, 3093, 3094, 3095, 3096, 3097, 3098, 3099, 3100, 3101, 3102, 3103, 3104, 3105, 3106, 3107, 3108, 3109, 3110, 3111, 3112, 3113, 3114, 3115, 3116, 3117, 3118, 3119, 3120, 3121, 3122, 3123, 3124, 3125, 3126, 3127, 3128, 3129, 3130, 3131, 3132, 3133, 3134, 3135, 3136, 3137, 3138
    +href="glossaries-user.html#dx1-13011" >3090, 3091, 3092, 3093, 3094, 3095, 3096, 3097, 3098, 3099, 3100, 3101, 3102, 3103, 3104, 3105, 3106, 3107, 3108, 3109, 3110, 3111, 3112, 3113, 3114, 3115, 3116, 3117, 3118, 3119, 3120, 3121, 3122, 3123, 3124, 3125, 3126, 3127, 3128, 3129, 3130, 3131, 3132, 3133, 3134, 3135, 3136, 3137, 3138, 3139, 3140, 3141, 3142, 3143, 3144, 3145, 3146, 3147, 3148, 3149, 3150, 3151, 3152
    \newacronymstyle  3139, 3140, 3141
    +href="glossaries-user.html#dx1-140001" >3153, 3154, 3155
    \newdualentry  3142, 3143
    +href="glossaries-user.html#dx1-147018" >3156, 3157
    \newglossary  3144, 3145, 3146, 3147, 3148, 3149, 3150
    +href="glossaries-user.html#dx1-20020" >3158, 3159, 3160, 3161, 3162, 3163, 3164
    \newglossary*  3151, 3152, 3153, 3154
    +href="glossaries-user.html#dx1-146007" >3165, 3166, 3167, 3168
    \newglossaryentry  3155, 3156, 3157, 3158, 3159, 3160, 3161, 3162, 3163, 3164, 3165, 3166, 3167, 3168, 3169, 3170, 3171, 3172, 3173, 3174, 3175, 3176, 3177, 3178, 3179, 3180, 3181, 3182, 3183, 3184, 3185, 3186
    +href="glossaries-user.html#dx1-3033" >3169, 3170, 3171, 3172, 3173, 3174, 3175, 3176, 3177, 3178, 3179, 3180, 3181, 3182, 3183, 3184, 3185, 3186, 3187, 3188, 3189, 3190, 3191, 3192, 3193, 3194, 3195, 3196, 3197, 3198, 3199, 3200
    \newglossaryentry options
        access  3187, 3188
    +href="glossaries-user.html#dx1-176013" >3201, 3202
        alias  3189, 3190, 3191, 3192
    +href="glossaries-user.html#dx1-12093" >3203, 3204, 3205, 3206
        category  3193, 3194, 3195, 3196, 3197, 3198, 3199, 3200, 3201, 3202, 3203, 3204, 3205, 3206, 3207
    +href="glossaries-user.html#dx1-13013" >3207, 3208, 3209, 3210, 3211, 3212, 3213, 3214, 3215, 3216, 3217, 3218, 3219, 3220, 3221
        description  3208, 3209, 3210, 3211, 3212, 3213, 3214, 3215, 3216, 3217, 3218, 3219, 3220, 3221, 3222, 3223, 3224, 3225, 3226, 3227, 3228, 3229, 3230
    +href="glossaries-user.html#dx1-13014" >3222, 3223, 3224, 3225, 3226, 3227, 3228, 3229, 3230, 3231, 3232, 3233, 3234, 3235, 3236, 3237, 3238, 3239, 3240, 3241, 3242, 3243, 3244
        descriptionaccess  3231
    +href="glossaries-user.html#dx1-176027" >3245
        descriptionplural  3232, 3233, 3234, 3235
    +href="glossaries-user.html#dx1-114031" >3246, 3247, 3248, 3249
        descriptionpluralaccess  3236
    +href="glossaries-user.html#dx1-176029" >3250
        entrycounter  3237, 3238
    +href="glossaries-user.html#dx1-145044" >3251, 3252
        first  3239, 3240, 3241, 3242, 3243, 3244, 3245, 3246, 3247, 3248, 3249, 3250, 3251, 3252, 3253, 3254, 3255, 3256, 3257, 3258, 3259, 3260, 3261, 3262, 3263, 3264, 3265, 3266, 3267, 3268, 3269
    +href="glossaries-user.html#dx1-3031" >3253, 3254, 3255, 3256, 3257, 3258, 3259, 3260, 3261, 3262, 3263, 3264, 3265, 3266, 3267, 3268, 3269, 3270, 3271, 3272, 3273, 3274, 3275, 3276, 3277, 3278, 3279, 3280, 3281, 3282, 3283
        firstaccess  3270
    +href="glossaries-user.html#dx1-176017" >3284
    + +     firstplural  3271, 3272, 3273, 3274, 3275, 3276, 3277, 3278, 3279, 3280, 3281, 3282, 3283, 3284, 3285, 3286, 3287, 3288, 3289
    +href="glossaries-user.html#dx1-3032" >3285, 3286, 3287, 3288, 3289, 3290, 3291, 3292, 3293, 3294, 3295, 3296, 3297, 3298, 3299, 3300, 3301, 3302, 3303
        firstpluralaccess  3290
    +href="glossaries-user.html#dx1-176021" >3304
        format  3291
    +href="glossaries-user.html#dx1-147003" >3305
        long  3292, 3293, 3294, 3295, 3296, 3297, 3298, 3299, 3300, 3301, 3302, 3303, 3304, 3305
    +href="glossaries-user.html#dx1-35020" >3306, 3307, 3308, 3309, 3310, 3311, 3312, 3313, 3314, 3315, 3316, 3317, 3318, 3319
        longaccess  3306
    +href="glossaries-user.html#dx1-176031" >3320
        longplural  3307, 3308, 3309, 3310, 3311, 3312, 3313, 3314, 3315, 3316, 3317, 3318
    +href="glossaries-user.html#dx1-16009" >3321, 3322, 3323, 3324, 3325, 3326, 3327, 3328, 3329, 3330, 3331, 3332
        longpluralaccess  3319
    - - +href="glossaries-user.html#dx1-176037" >3333
        name  3320, 3321, 3322, 3323, 3324, 3325, 3326, 3327, 3328, 3329, 3330, 3331, 3332, 3333, 3334, 3335, 3336, 3337, 3338, 3339, 3340, 3341, 3342, 3343, 3344, 3345, 3346, 3347, 3348, 3349, 3350, 3351, 3352, 3353, 3354, 3355, 3356, 3357, 3358, 3359, 3360, 3361, 3362, 3363, 3364, 3365, 3366, 3367, 3368, 3369, 3370, 3371, 3372, 3373, 3374, 3375, 3376, 3377, 3378, 3379, 3380
    +href="glossaries-user.html#dx1-7016" >3334, 3335, 3336, 3337, 3338, 3339, 3340, 3341, 3342, 3343, 3344, 3345, 3346, 3347, 3348, 3349, 3350, 3351, 3352, 3353, 3354, 3355, 3356, 3357, 3358, 3359, 3360, 3361, 3362, 3363, 3364, 3365, 3366, 3367, 3368, 3369, 3370, 3371, 3372, 3373, 3374, 3375, 3376, 3377, 3378, 3379, 3380, 3381, 3382, 3383, 3384, 3385, 3386, 3387, 3388, 3389, 3390, 3391, 3392, 3393, 3394
        nonumberlist  3381
    +href="glossaries-user.html#dx1-114123" >3395
        parent  3382, 3383, 3384, 3385
    +href="glossaries-user.html#dx1-114017" >3396, 3397, 3398, 3399
        plural  3386, 3387, 3388, 3389, 3390, 3391, 3392, 3393, 3394, 3395, 3396, 3397, 3398, 3399, 3400, 3401, 3402, 3403, 3404, 3405, 3406, 3407, 3408, 3409, 3410
    +href="glossaries-user.html#dx1-16008" >3400, 3401, 3402, 3403, 3404, 3405, 3406, 3407, 3408, 3409, 3410, 3411, 3412, 3413, 3414, 3415, 3416, 3417, 3418, 3419, 3420, 3421, 3422, 3423, 3424
        pluralaccess  3411
    +href="glossaries-user.html#dx1-176019" >3425
        prefix  3412, 3413, 3414, 3415, 3416, 3417, 3418, 3419, 3420
    +href="glossaries-user.html#dx1-175003" >3426, 3427, 3428, 3429, 3430, 3431, 3432, 3433, 3434
        prefixfirst  3421, 3422, 3423, 3424, 3425
    +href="glossaries-user.html#dx1-175007" >3435, 3436, 3437, 3438, 3439
        prefixfirstplural  3426, 3427, 3428, 3429
    +href="glossaries-user.html#dx1-175010" >3440, 3441, 3442, 3443
        prefixplural  3430, 3431, 3432, 3433, 3434, 3435, 3436, 3437
    +href="glossaries-user.html#dx1-175005" >3444, 3445, 3446, 3447, 3448, 3449, 3450, 3451
        see  3438, 3439, 3440, 3441, 3442, 3443, 3444, 3445, 3446, 3447, 3448, 3449, 3450, 3451, 3452, 3453, 3454, 3455, 3456, 3457, 3458, 3459, 3460, 3461, 3462, 3463, 3464, 3465, 3466
    +href="glossaries-user.html#dx1-13028" >3452, 3453, 3454, 3455, 3456, 3457, 3458, 3459, 3460, 3461, 3462, 3463, 3464, 3465, 3466, 3467, 3468, 3469, 3470, 3471, 3472, 3473, 3474, 3475, 3476, 3477, 3478, 3479, 3480
        seealso  3467, 3468, 3469, 3470, 3471, 3472, 3473, 3474, 3475, 3476, 3477
    +href="glossaries-user.html#dx1-13030" >3481, 3482, 3483, 3484, 3485, 3486, 3487, 3488, 3489, 3490, 3491
        short  3478, 3479, 3480, 3481, 3482, 3483, 3484, 3485, 3486, 3487, 3488, 3489, 3490, 3491, 3492, 3493
    +href="glossaries-user.html#dx1-10016" >3492, 3493, 3494, 3495, 3496, 3497, 3498, 3499, 3500, 3501, 3502, 3503, 3504, 3505, 3506, 3507
        shortaccess  3494, 3495, 3496, 3497, 3498, 3499, 3500
    +href="glossaries-user.html#dx1-176034" >3508, 3509, 3510, 3511, 3512, 3513, 3514
        shortplural  3501, 3502, 3503, 3504, 3505, 3506, 3507, 3508, 3509, 3510, 3511, 3512, 3513, 3514, 3515
    +href="glossaries-user.html#dx1-16010" >3515, 3516, 3517, 3518, 3519, 3520, 3521, 3522, 3523, 3524, 3525, 3526, 3527, 3528, 3529
        shortpluralaccess  3516
    +href="glossaries-user.html#dx1-176040" >3530
        sort  3517, 3518, 3519, 3520, 3521, 3522, 3523, 3524, 3525, 3526, 3527, 3528, 3529, 3530, 3531, 3532, 3533, 3534, 3535, 3536, 3537, 3538, 3539, 3540, 3541, 3542, 3543, 3544, 3545, 3546, 3547, 3548, 3549, 3550, 3551, 3552, 3553, 3554, 3555, 3556, 3557, 3558, 3559, 3560, 3561, 3562, 3563, 3564, 3565, 3566, 3567, 3568, 3569, 3570, 3571, 3572, 3573, 3574, 3575, 3576, 3577, 3578
    +href="glossaries-user.html#dx1-3062" >3531, 3532, 3533, 3534, 3535, 3536, 3537, 3538, 3539, 3540, 3541, 3542, 3543, 3544, 3545, 3546, 3547, 3548, 3549, 3550, 3551, 3552, 3553, 3554, 3555, 3556, 3557, 3558, 3559, 3560, 3561, 3562, 3563, 3564, 3565, 3566, 3567, 3568, 3569, 3570, 3571, 3572, 3573, 3574, 3575, 3576, 3577, 3578, 3579, 3580, 3581, 3582, 3583, 3584, 3585, 3586, 3587, 3588, 3589, 3590, 3591, 3592
        subentrycounter  3579
    +href="glossaries-user.html#dx1-145045" >3593
        symbol  3580, 3581, 3582, 3583, 3584, 3585, 3586, 3587, 3588, 3589, 3590, 3591, 3592, 3593, 3594, 3595, 3596, 3597, 3598, 3599
    +href="glossaries-user.html#dx1-12051" >3594, 3595, 3596, 3597, 3598, 3599, 3600, 3601, 3602, 3603, 3604, 3605, 3606, 3607, 3608, 3609, 3610, 3611, 3612, 3613
        symbolaccess  3600, 3601
    +href="glossaries-user.html#dx1-176023" >3614, 3615
        symbolplural  3602, 3603, 3604
    +href="glossaries-user.html#dx1-114078" >3616, 3617, 3618
        symbolpluralaccess  3605
    +href="glossaries-user.html#dx1-176025" >3619
        text  3606, 3607, 3608, 3609, 3610, 3611, 3612, 3613, 3614, 3615, 3616, 3617, 3618, 3619, 3620, 3621, 3622, 3623, 3624, 3625, 3626, 3627, 3628, 3629, 3630, 3631, 3632, 3633, 3634, 3635, 3636, 3637, 3638, 3639, 3640
    +href="glossaries-user.html#dx1-12064" >3620, 3621, 3622, 3623, 3624, 3625, 3626, 3627, 3628, 3629, 3630, 3631, 3632, 3633, 3634, 3635, 3636, 3637, 3638, 3639, 3640, 3641, 3642, 3643, 3644, 3645, 3646, 3647, 3648, 3649, 3650, 3651, 3652, 3653, 3654
        textaccess  3641
    +href="glossaries-user.html#dx1-176015" >3655
        type  3642, 3643, 3644, 3645, 3646, 3647, 3648, 3649, 3650
    +href="glossaries-user.html#dx1-8031" >3656, 3657, 3658, 3659, 3660, 3661, 3662, 3663, 3664
        user1  3651, 3652, 3653, 3654, 3655, 3656, 3657, 3658, 3659, 3660, 3661, 3662, 3663, 3664, 3665, 3666, 3667, 3668
    +href="glossaries-user.html#dx1-13009" >3665, 3666, 3667, 3668, 3669, 3670, 3671, 3672, 3673, 3674, 3675, 3676, 3677, 3678, 3679, 3680, 3681, 3682
        user1access  3669, 3670
    +href="glossaries-user.html#dx1-176043" >3683, 3684
        user2  3671, 3672, 3673, 3674, 3675
    +href="glossaries-user.html#dx1-114117" >3685, 3686, 3687, 3688, 3689
        user2access  3676
    +href="glossaries-user.html#dx1-176045" >3690
        user3  3677, 3678, 3679, 3680
    +href="glossaries-user.html#dx1-114118" >3691, 3692, 3693, 3694
        user3access  3681
    +href="glossaries-user.html#dx1-176047" >3695
        user4  3682, 3683, 3684, 3685
    +href="glossaries-user.html#dx1-114119" >3696, 3697, 3698, 3699
        user4access  3686
    +href="glossaries-user.html#dx1-176049" >3700
        user5  3687, 3688, 3689, 3690
    +href="glossaries-user.html#dx1-114120" >3701, 3702, 3703, 3704
        user5access  3691
    +href="glossaries-user.html#dx1-176051" >3705
    + +     user6  3692, 3693, 3694, 3695, 3696
    +href="glossaries-user.html#dx1-114116" >3706, 3707, 3708, 3709, 3710
        user6access  3697
    +href="glossaries-user.html#dx1-176053" >3711
    \newglossarystyle  3698, 3699, 3700, 3701
    +href="glossaries-user.html#dx1-156036" >3712, 3713, 3714, 3715
    \newignoredglossary  3702, 3703, 3704, 3705, 3706, 3707
    +href="glossaries-user.html#dx1-35012" >3716, 3717, 3718, 3719, 3720, 3721
    \newline  3708, 3709
    +href="glossaries-user.html#dx1-114028" >3722, 3723
    \newterm  3710, 3711
    +href="glossaries-user.html#dx1-89001" >3724, 3725
    ngerman package  3712, 3713, 3714, 3715
    - - +href="glossaries-user.html#dx1-14029" >3726, 3727, 3728, 3729
    \nohyperpage  3716
    +href="glossaries-user.html#dx1-153013" >3730
    \noist  3717, 3718, 3719, 3720, 3721, 3722, 3723, 3724, 3725, 3726, 3727, 3728
    +href="glossaries-user.html#dx1-113008" >3731, 3732, 3733, 3734, 3735, 3736, 3737, 3738, 3739, 3740, 3741, 3742
    Non-Latin Alphabet  3729
    +class="cmbx-10">3743
    non-Latin character  3730, 3731, 3744, 3745, 3732, 3733, 3734, 3735, 3736, 3737, 3738, 3739, 3740
    +class="cmbx-10">3746, 3747, 3748, 3749, 3750, 3751, 3752, 3753, 3754
    \nopostdesc  3741, 3742, 3743, 3744, 3745, 3746, 3747, 3748, 3749, 3750, 3751, 3752, 3753
    +href="glossaries-user.html#dx1-89003" >3755, 3756, 3757, 3758, 3759, 3760, 3761, 3762, 3763, 3764, 3765, 3766, 3767
    \nopostdot  3754
    +href="glossaries-user.html#dx1-206034" >3768
    \null  3755, 3756
    +href="glossaries-user.html#dx1-145011" >3769, 3770
    \number  3757
    +href="glossaries-user.html#dx1-152027" >3771
    number list  3758, 3759, 3760, 3761, 3762, 3763, 3764, 3765, 3766, 3767, 3768, 3769, 3770, 3771, 3772, 3773, 3774, 3775, 3776, 3777, 3778, 3779, 3780, 3781, 3782, 3783, 3784, 3785, 3786, 3787, 3788, 3789, 3790, 3791, 3792, 3793, 3794, 3795, 3796, 3797, 3798, 3799, 3800, 3801, 3802, 3803, 3804, 3805, 3806, 3807, 3808, 3809, 3810, 3811, 3812, 3813, 3814, 3815, 3816, 3817, 3818, 3819, 3820, 3821, 3822, 3823, 3824, 3825, 3826, 3827, 3828, 3829, 3830, 3831, 3832, 3833, 3834, 3835, 3836, 3837, 3838, 3839, 3840, 3841, 3842, 3843, 3844, 3845, 3846, 3847, 3848
    +class="cmbx-10">3772, 3773, 3774, 3775, 3776, 3777, 3778, 3779, 3780, 3781, 3782, 3783, 3784, 3785, 3786, 3787, 3788, 3789, 3790, 3791, 3792, 3793, 3794, 3795, 3796, 3797, 3798, 3799, 3800, 3801, 3802, 3803, 3804, 3805, 3806, 3807, 3808, 3809, 3810, 3811, 3812, 3813, 3814, 3815, 3816, 3817, 3818, 3819, 3820, 3821, 3822, 3823, 3824, 3825, 3826, 3827, 3828, 3829, 3830, 3831, 3832, 3833, 3834, 3835, 3836, 3837, 3838, 3839, 3840, 3841, 3842, 3843, 3844, 3845, 3846, 3847, 3848, 3849, 3850, 3851, 3852, 3853, 3854, 3855, 3856, 3857, 3858, 3859, 3860, 3861, 3862
    \numberline  3849
    +href="glossaries-user.html#dx1-42002" >3863

    O \oldacronym  3850, 3851
    +href="glossaries-user.html#dx1-142004" >3864, 3865

    P package options:
        abbreviations  3852, 3853, 3854, 3855, 3856, 3857, 3858, 3859
    +href="glossaries-user.html#dx1-4011" >3866, 3867, 3868, 3869, 3870, 3871, 3872, 3873
        accsupp  3860, 3861, 3862
    +href="glossaries-user.html#x1-1040002.9" >3874, 3875, 3876
        acronym  3863, 3864, 3865, 3866, 3867, 3868, 3869, 3870, 3871, 3872, 3873, 3874, 3875, 3876, 3877, 3878, 3879, 3880, 3881, 3882, 3883, 3884, 3885, 3886, 3887, 3888, 3889, 3890, 3891, 3892, 3893, 3894, 3895, 3896, 3897
    +href="glossaries-user.html#dx1-15026" >3877, 3878, 3879, 3880, 3881, 3882, 3883, 3884, 3885, 3886, 3887, 3888, 3889, 3890, 3891, 3892, 3893, 3894, 3895, 3896, 3897, 3898, 3899, 3900, 3901, 3902, 3903, 3904, 3905, 3906, 3907, 3908, 3909, 3910, 3911
            true  3898, 3899
    +href="glossaries-user.html#dx1-26002" >3912, 3913
        acronymlists  3900, 3901, 3902, 3903, 3904, 3905, 3906
    +href="glossaries-user.html#x1-950002.7" >3914, 3915, 3916, 3917, 3918, 3919, 3920
        acronyms  3907, 3908, 3909
    +href="glossaries-user.html#dx1-86003" >3921, 3922, 3923
        automake  3910, 3911, 3912, 3913
    +href="glossaries-user.html#dx1-8010" >3924, 3925, 3926, 3927
            false  3914
    +href="glossaries-user.html#dx1-81021" >3928
            immediate  3915, 3916, 3917
    +href="glossaries-user.html#dx1-81005" >3929, 3930, 3931
            true  3918, 3919
    +href="glossaries-user.html#dx1-81001" >3932, 3933
        autoseeindex  3920
    +href="glossaries-user.html#x1-680002.4" >3934
            false  3921, 3922
    +href="glossaries-user.html#dx1-208008" >3935, 3936
        compatible-2.07  3923, 3924, 3925
    +href="glossaries-user.html#x1-1070002.9" >3937, 3938, 3939
        compatible-3.07  3926, 3927, 3928
    +href="glossaries-user.html#dx1-92003" >3940, 3941, 3942
        counter  3929, 3930, 3931, 3932, 3933
    +href="glossaries-user.html#x1-590002.3" >3943, 3944, 3945, 3946, 3947
            equation  3934
    +href="glossaries-user.html#dx1-193002" >3948
            page  3935
    +href="glossaries-user.html#dx1-59001" >3949
        counterwithin  3936, 3937, 3938, 3939, 3940
    +href="glossaries-user.html#x1-490002.3" >3950, 3951, 3952, 3953, 3954
        debug  3941, 3942, 3943, 3944
    +href="glossaries-user.html#dx1-28002" >3955, 3956, 3957, 3958
    + +         all  3945
    +href="glossaries-user.html#dx1-31004" >3959
            false  3946, 3947
    +href="glossaries-user.html#dx1-31001" >3960, 3961
            showaccsupp  3948, 3949, 3950
    +href="glossaries-user.html#dx1-31011" >3962, 3963, 3964
            showtargets  3951
    +href="glossaries-user.html#dx1-31007" >3965
            showwrgloss  3952
    +href="glossaries-user.html#dx1-31003" >3966
            true  3953
    +href="glossaries-user.html#dx1-31002" >3967
        description (deprecated)  3954, 3955, 3956, 3957, 3958, 3959, 3960, 3961, 3962
    - - +href="glossaries-user.html#x1-980002.8" >3968, 3969, 3970, 3971, 3972, 3973, 3974, 3975, 3976
        disablemakegloss  3963, 3964
    +href="glossaries-user.html#x1-820002.5" >3977, 3978
        docdef  3965
    +href="glossaries-user.html#x1-390002.1" >3979
            atom  3966, 3967
    +href="glossaries-user.html#dx1-24003" >3980, 3981
            false  3968
    +href="glossaries-user.html#dx1-6013" >3982
            restricted  3969, 3970, 3971, 3972
    +href="glossaries-user.html#dx1-6012" >3983, 3984, 3985, 3986
            true  3973, 3974
    +href="glossaries-user.html#dx1-6011" >3987, 3988
        dua (deprecated)  3975, 3976
    +href="glossaries-user.html#dx1-98009" >3989, 3990
    +    entercounter  3991
        entrycounter  3977, 3978, 3979, 3980, 3981
    +href="glossaries-user.html#x1-480002.3" >3992, 3993, 3994, 3995, 3996
            false  3982
    +href="glossaries-user.html#dx1-48001" >3997
            true  3983
    +href="glossaries-user.html#dx1-49001" >3998
        equations  3984
    +href="glossaries-user.html#x1-700002.4" >3999
        esclocations  3985
    +href="glossaries-user.html#x1-650002.4" >4000
            false  3986, 3987, 3988
    +href="glossaries-user.html#dx1-65003" >4001, 4002, 4003
            true  3989
    +href="glossaries-user.html#dx1-65001" >4004
        floats  3990
    +href="glossaries-user.html#x1-710002.4" >4005
        footnote (deprecated)  3991, 3992, 3993, 3994, 3995, 3996
    +href="glossaries-user.html#dx1-98004" >4006, 4007, 4008, 4009, 4010, 4011
        hyperfirst  3997, 3998, 3999, 4000
    +href="glossaries-user.html#x1-350002.1" >4012, 4013, 4014, 4015
            false  4001, 4002, 4003, 4004, 4005, 4006, 4007
    +href="glossaries-user.html#dx1-35014" >4016, 4017, 4018, 4019, 4020, 4021, 4022
            true  4008, 4009
    +href="glossaries-user.html#dx1-35001" >4023, 4024
        index  4010, 4011, 4012, 4013, 4014, 4015, 4016
    +href="glossaries-user.html#dx1-86006" >4025, 4026, 4027, 4028, 4029, 4030, 4031
        indexcounter  4017
    +href="glossaries-user.html#x1-720002.4" >4032
        indexcrossrefs  4018
    +href="glossaries-user.html#x1-670002.4" >4033
        indexonlyfirst  4019, 4020, 4021, 4022
    +href="glossaries-user.html#x1-660002.4" >4034, 4035, 4036, 4037
            false  4023
    +href="glossaries-user.html#dx1-66001" >4038
        kernelglossredefs  4024
    +href="glossaries-user.html#x1-1090002.9" >4039
            false  4025
    +href="glossaries-user.html#dx1-109002" >4040
        makeindex  4026, 4027, 4028
    +href="glossaries-user.html#dx1-26004" >4041, 4042, 4043
        noglossaryindex  4029
    +href="glossaries-user.html#x1-900002.6" >4044
        nogroupskip  4030, 4031, 4032, 4033, 4034, 4035, 4036, 4037
    +href="glossaries-user.html#x1-610002.3" >4045, 4046, 4047, 4048, 4049, 4050, 4051, 4052
            false  4038
    +href="glossaries-user.html#dx1-61001" >4053
        nohyperfirst  4039
    +href="glossaries-user.html#dx1-35025" >4054
        nohypertypes  4040, 4041, 4042, 4043, 4044, 4045, 4046, 4047, 4048
    +href="glossaries-user.html#dx1-35003" >4055, 4056, 4057, 4058, 4059, 4060, 4061, 4062, 4063
            index  4049
    +href="glossaries-user.html#dx1-89013" >4064
        nolangwarn  4050, 4051
    +href="glossaries-user.html#dx1-3" >4065, 4066
        nolist  4052, 4053, 4054
    +href="glossaries-user.html#x1-540002.3" >4067, 4068, 4069
        nolong  4055, 4056, 4057, 4058, 4059
    +href="glossaries-user.html#x1-520002.3" >4070, 4071, 4072, 4073, 4074
        nomain  4060, 4061, 4062, 4063, 4064, 4065, 4066, 4067, 4068, 4069, 4070, 4071
    +href="glossaries-user.html#x1-860002.6" >4075, 4076, 4077, 4078, 4079, 4080, 4081, 4082, 4083, 4084, 4085, 4086
        nomissingglstext  4072
    +href="glossaries-user.html#x1-1060002.9" >4087
    + +     nonumberlist  4073, 4074, 4075, 4076, 4077, 4078, 4079, 4080, 4081, 4082, 4083, 4084, 4085
    +href="glossaries-user.html#dx1-3060" >4088, 4089, 4090, 4091, 4092, 4093, 4094, 4095, 4096, 4097, 4098, 4099, 4100
        nopostdot  4086, 4087
    +href="glossaries-user.html#x1-600002.3" >4101, 4102
            false  4088, 4089, 4090, 4091, 4092, 4093
    +href="glossaries-user.html#dx1-60003" >4103, 4104, 4105, 4106, 4107, 4108
            true  4094, 4095, 4096, 4097
    +href="glossaries-user.html#dx1-60001" >4109, 4110, 4111, 4112
        noredefwarn  4098
    +href="glossaries-user.html#x1-300002.1" >4113
        nostyles  4099, 4100, 4101, 4102, 4103, 4104, 4105, 4106, 4107, 4108, 4109, 4110
    +href="glossaries-user.html#dx1-5002" >4114, 4115, 4116, 4117, 4118, 4119, 4120, 4121, 4122, 4123, 4124, 4125, 4126
        nosuper  4111, 4112, 4113, 4114, 4115
    +href="glossaries-user.html#x1-530002.3" >4127, 4128, 4129, 4130, 4131
        notranslate  4116, 4117, 4118
    - - +href="glossaries-user.html#dx1-15010" >4132, 4133, 4134
        notree  4119, 4120, 4121, 4122
    +href="glossaries-user.html#x1-550002.3" >4135, 4136, 4137, 4138
        nowarn  4123, 4124, 4125
    +href="glossaries-user.html#x1-280002.1" >4139, 4140, 4141
        numberedsection  4126, 4127, 4128, 4129, 4130, 4131
    +href="glossaries-user.html#dx1-43001" >4142, 4143, 4144, 4145, 4146, 4147
            autolabel  4132, 4133, 4134
    +href="glossaries-user.html#dx1-45004" >4148, 4149, 4150
            false  4135
    +href="glossaries-user.html#dx1-45002" >4151
            nameref  4136
    +href="glossaries-user.html#dx1-45010" >4152
            nolabel  4137
    +href="glossaries-user.html#dx1-45003" >4153
        numberline  4138, 4139
    +href="glossaries-user.html#x1-420002.2" >4154, 4155
        numbers  4140, 4141, 4142
    +href="glossaries-user.html#dx1-86005" >4156, 4157, 4158
        order  4143, 4144, 4145, 4146
    +href="glossaries-user.html#dx1-73002" >4159, 4160, 4161, 4162
            letter  4147, 4148, 4149, 4150, 4151, 4152
    +href="glossaries-user.html#dx1-8047" >4163, 4164, 4165, 4166, 4167, 4168
            word  4153, 4154
    +href="glossaries-user.html#dx1-17091" >4169, 4170
        p
            record  4155
    +href="glossaries-user.html#dx1-10042" >4171
        postdot  4156, 4157, 4158, 4159, 4160, 4161
    +href="glossaries-user.html#dx1-4012" >4172, 4173, 4174, 4175, 4176, 4177
        postpunc  4162
    +href="glossaries-user.html#dx1-60007" >4178
        prefix  4163, 4164, 4165, 4166
    +href="glossaries-user.html#x1-1050002.9" >4179, 4180, 4181, 4182
        record  4167, 4168, 4169, 4170, 4171, 4172, 4173, 4174, 4175, 4176, 4177, 4178, 4179, 4180, 4181, 4182, 4183, 4184, 4185, 4186, 4187
    +href="glossaries-user.html#dx1-10018" >4183, 4184, 4185, 4186, 4187, 4188, 4189, 4190, 4191, 4192, 4193, 4194, 4195, 4196, 4197, 4198, 4199, 4200, 4201, 4202, 4203
            hybrid  4188, 4189
    +href="glossaries-user.html#dx1-10021" >4204, 4205
            nameref  4190, 4191, 4192, 4193, 4194, 4195, 4196, 4197, 4198, 4199, 4200
    +href="glossaries-user.html#dx1-10020" >4206, 4207, 4208, 4209, 4210, 4211, 4212, 4213, 4214, 4215, 4216
            only  4201, 4202, 4203, 4204, 4205, 4206
    +href="glossaries-user.html#dx1-6016" >4217, 4218, 4219, 4220, 4221, 4222
        record  4207, 4208
    +href="glossaries-user.html#dx1-218045" >4223, 4224
        restoremakegloss  4209, 4210
    +href="glossaries-user.html#x1-830002.5" >4225, 4226
        sanitizesort  4211, 4212, 4213
    +href="glossaries-user.html#dx1-6006" >4227, 4228, 4229
            false  4214, 4215, 4216, 4217, 4218, 4219
    +href="glossaries-user.html#dx1-7005" >4230, 4231, 4232, 4233, 4234, 4235
            true  4220, 4221, 4222, 4223, 4224, 4225, 4226, 4227, 4228
    +href="glossaries-user.html#dx1-7007" >4236, 4237, 4238, 4239, 4240, 4241, 4242, 4243, 4244
        savenumberlist  4229, 4230, 4231, 4232, 4233
    +href="glossaries-user.html#x1-470002.3" >4245, 4246, 4247, 4248, 4249
            false  4234
    +href="glossaries-user.html#dx1-47002" >4250
        savewrites  4235, 4236, 4237
    +href="glossaries-user.html#x1-320002.1" >4251, 4252, 4253
            false  4238
    +href="glossaries-user.html#dx1-32001" >4254
        section  4239, 4240
    +href="glossaries-user.html#x1-430002.2" >4255, 4256
        seeautonumberlist  4241, 4242, 4243, 4244
    +href="glossaries-user.html#x1-580002.3" >4257, 4258, 4259, 4260
        seenoindex  4245, 4246
    +href="glossaries-user.html#x1-640002.4" >4261, 4262
            ignore  4247
    +href="glossaries-user.html#dx1-64006" >4263
            warn  4248
    +href="glossaries-user.html#dx1-64005" >4264
        shortcuts  4249, 4250
    +href="glossaries-user.html#x1-960002.7" >4265, 4266
        smallcaps (deprecated)  4251, 4252, 4253, 4254, 4255, 4256
    +href="glossaries-user.html#dx1-98002" >4267, 4268, 4269, 4270, 4271, 4272
        smaller (deprecated)  4257, 4258, 4259, 4260, 4261
    +href="glossaries-user.html#dx1-98003" >4273, 4274, 4275, 4276, 4277
    + +     sort  4262, 4263
    +href="glossaries-user.html#dx1-73001" >4278, 4279
            def  4264, 4265, 4266, 4267, 4268, 4269, 4270, 4271, 4272, 4273, 4274
    +href="glossaries-user.html#dx1-7010" >4280, 4281, 4282, 4283, 4284, 4285, 4286, 4287, 4288, 4289, 4290
            none  4275, 4276, 4277, 4278, 4279, 4280
    +href="glossaries-user.html#dx1-6008" >4291, 4292, 4293, 4294, 4295, 4296
            standard  4281, 4282, 4283
    +href="glossaries-user.html#dx1-75005" >4297, 4298, 4299
            use  4284, 4285, 4286, 4287, 4288, 4289, 4290, 4291, 4292, 4293, 4294
    +href="glossaries-user.html#dx1-7009" >4300, 4301, 4302, 4303, 4304, 4305, 4306, 4307, 4308, 4309, 4310
        style  4295, 4296, 4297, 4298, 4299, 4300, 4301, 4302
    +href="glossaries-user.html#x1-510002.3" >4311, 4312, 4313, 4314, 4315, 4316, 4317, 4318
            index  4303
    +href="glossaries-user.html#dx1-51003" >4319
            list  4304
    - - +href="glossaries-user.html#dx1-51001" >4320
        stylemods  4305, 4306, 4307, 4308, 4309, 4310, 4311, 4312, 4313, 4314, 4315, 4316
    +href="glossaries-user.html#dx1-4013" >4321, 4322, 4323, 4324, 4325, 4326, 4327, 4328, 4329, 4330, 4331, 4332
        subentrycounter  4317, 4318, 4319, 4320, 4321, 4322
    +href="glossaries-user.html#x1-500002.3" >4333, 4334, 4335, 4336, 4337, 4338
            false  4323
    +href="glossaries-user.html#dx1-50001" >4339
        symbols  4324, 4325, 4326, 4327, 4328, 4329, 4330, 4331
    +href="glossaries-user.html#dx1-4015" >4340, 4341, 4342, 4343, 4344, 4345, 4346, 4347
        toc  4332, 4333, 4334, 4335, 4336, 4337, 4338
    +href="glossaries-user.html#dx1-8051" >4348, 4349, 4350, 4351, 4352, 4353, 4354
            false  4339
    +href="glossaries-user.html#dx1-41003" >4355
            true  4340, 4341
    +href="glossaries-user.html#dx1-41004" >4356, 4357
        translate  4342, 4343, 4344, 4345
    +href="glossaries-user.html#x1-330002.1" >4358, 4359, 4360, 4361
            babel  4346, 4347, 4348, 4349, 4350, 4351, 4352, 4353
    +href="glossaries-user.html#dx1-15012" >4362, 4363, 4364, 4365, 4366, 4367, 4368, 4369
            false  4354, 4355, 4356, 4357
    +href="glossaries-user.html#dx1-15011" >4370, 4371, 4372, 4373
            true  4358, 4359, 4360, 4361
    +href="glossaries-user.html#dx1-33001" >4374, 4375, 4376, 4377
        ucmark  4362, 4363, 4364
    +href="glossaries-user.html#dx1-43007" >4378, 4379, 4380
            false  4365
    +href="glossaries-user.html#dx1-44001" >4381
            true  4366
    +href="glossaries-user.html#dx1-44003" >4382
        undefaction  4367
    +href="glossaries-user.html#x1-380002.1" >4383
        writeglslabelnames  4368, 4369, 4370
    +href="glossaries-user.html#dx1-24002" >4384, 4385, 4386
        writeglslabels  4371, 4372
    +href="glossaries-user.html#dx1-24001" >4387, 4388
        xindy  4373, 4374, 4375, 4376, 4377, 4378, 4379, 4380, 4381, 4382, 4383, 4384, 4385, 4386, 4387, 4388, 4389
    +href="glossaries-user.html#dx1-9021" >4389, 4390, 4391, 4392, 4393, 4394, 4395, 4396, 4397, 4398, 4399, 4400, 4401, 4402, 4403, 4404, 4405
        xindygloss  4390, 4391
    +href="glossaries-user.html#x1-790002.5" >4406, 4407
        xindynoglsnumbers  4392, 4393
    +href="glossaries-user.html#x1-800002.5" >4408, 4409
    page (counter)  4394, 4395
    +href="glossaries-user.html#dx1-169039" >4410, 4411
    page type precedence  4396
    +href="glossaries-user.html#dx1-154005" >4412
    \pagelistname  4397
    +href="glossaries-user.html#dx1-15030" >4413
    pdflatex  4398, 4399
    +href="glossaries-user.html#dx1-26" >4414, 4415
    \PGLS  4400
    +href="glossaries-user.html#dx1-175028" >4416
    \Pgls  4401
    +href="glossaries-user.html#dx1-175024" >4417
    \pgls  4402, 4403
    +href="glossaries-user.html#dx1-175021" >4418, 4419
    \PGLSpl  4404
    +href="glossaries-user.html#dx1-175037" >4420
    \Pglspl  4405
    +href="glossaries-user.html#dx1-175033" >4421
    \pglspl  4406
    +href="glossaries-user.html#dx1-175030" >4422
    \pi  4407
    +href="glossaries-user.html#dx1-206082" >4423
    polyglossia package  4408, 4409, 4410, 4411, 4412, 4413, 4414
    +href="glossaries-user.html#dx1-15002" >4424, 4425, 4426, 4427, 4428, 4429, 4430
    \primary  4415
    +href="glossaries-user.html#dx1-194020" >4431
    \printacronyms  4416, 4417, 4418
    +href="glossaries-user.html#dx1-92001" >4432, 4433, 4434
    \printglossaries  4419, 4420, 4421, 4422, 4423, 4424, 4425, 4426, 4427
    +href="glossaries-user.html#dx1-125002" >4435, 4436, 4437, 4438, 4439, 4440, 4441, 4442, 4443
    \printglossary  4428, 4429, 4430, 4431, 4432, 4433, 4434, 4435, 4436, 4437, 4438, 4439, 4440, 4441, 4442, 4443
    +href="glossaries-user.html#dx1-8002" >4444, 4445, 4446, 4447, 4448, 4449, 4450, 4451, 4452, 4453, 4454, 4455, 4456, 4457, 4458, 4459
    \printglossary options
        entrycounter  4444
    +href="glossaries-user.html#dx1-145041" >4460
    + +     groups  4445
    +href="glossaries-user.html#dx1-145072" >4461
        label  4446
    +href="glossaries-user.html#dx1-145064" >4462
        leveloffset  4447
    +href="glossaries-user.html#dx1-145073" >4463
        nogroupskip  4448
    +href="glossaries-user.html#dx1-145039" >4464
        nonumberlist  4449
    +href="glossaries-user.html#dx1-145038" >4465
        nopostdot  4450
    +href="glossaries-user.html#dx1-145040" >4466
        numberedsection  4451
    +href="glossaries-user.html#dx1-145035" >4467
        prefix  4452
    - - +href="glossaries-user.html#dx1-145068" >4468
        style  4453, 4454, 4455, 4456, 4457
    +href="glossaries-user.html#dx1-56004" >4469, 4470, 4471, 4472, 4473
        subentrycounter  4458
    +href="glossaries-user.html#dx1-145043" >4474
        target  4459, 4460
    +href="glossaries-user.html#dx1-12081" >4475, 4476
        targetnameprefix  4461
    +href="glossaries-user.html#dx1-145070" >4477
        title  4462, 4463, 4464, 4465, 4466
    +href="glossaries-user.html#dx1-4" >4478, 4479, 4480, 4481, 4482
        toctitle  4467
    +href="glossaries-user.html#dx1-145029" >4483
        type  4468, 4469
    +href="glossaries-user.html#dx1-145024" >4484, 4485
    \printindex  4470
    +href="glossaries-user.html#dx1-89004" >4486
    \printnoidxglossaries  4471, 4472
    +href="glossaries-user.html#dx1-141009" >4487, 4488
    \printnoidxglossary  4473, 4474, 4475, 4476, 4477, 4478, 4479, 4480, 4481, 4482, 4483, 4484, 4485
    +href="glossaries-user.html#dx1-7002" >4489, 4490, 4491, 4492, 4493, 4494, 4495, 4496, 4497, 4498, 4499, 4500, 4501
    \printnoidxglossary options
        sort  4486, 4487, 4488, 4489, 4490
    +href="glossaries-user.html#dx1-75001" >4502, 4503, 4504, 4505, 4506
    \printnumbers  4491
    +href="glossaries-user.html#dx1-88001" >4507
    \printsymbols  4492
    +href="glossaries-user.html#dx1-87001" >4508
    \printunsrtacronyms  4493
    +href="glossaries-user.html#dx1-227015" >4509
    \printunsrtglossaries  4494, 4495, 4496, 4497, 4498, 4499, 4500, 4501, 4502, 4503, 4504, 4505, 4506, 4507, 4508, 4509, 4510
    +href="glossaries-user.html#dx1-4010" >4510, 4511, 4512, 4513, 4514, 4515, 4516, 4517, 4518, 4519, 4520, 4521, 4522, 4523, 4524, 4525, 4526
    \printunsrtglossaries  4511
    +href="glossaries-user.html#dx1-145005" >4527
    \printunsrtglossary  4512, 4513, 4514, 4515, 4516, 4517, 4518, 4519, 4520, 4521, 4522, 4523, 4524, 4525, 4526, 4527, 4528
    +href="glossaries-user.html#dx1-10005" >4528, 4529, 4530, 4531, 4532, 4533, 4534, 4535, 4536, 4537, 4538, 4539, 4540, 4541, 4542, 4543, 4544
    \printunsrtinnerglossary  4529
    +href="glossaries-user.html#dx1-145023" >4545
    \providecommand  4530, 4531
    +href="glossaries-user.html#dx1-201022" >4546, 4547
    \provideglossaryentry  4532, 4533
    +href="glossaries-user.html#dx1-114010" >4548, 4549
    \provideignoredglossary  4534
    +href="glossaries-user.html#dx1-146013" >4550

    R relsize package  4535, 4536, 4537
    +href="glossaries-user.html#dx1-3065" >4551, 4552, 4553
    \Roman  4538
    +href="glossaries-user.html#dx1-169035" >4554

    S \S  4539
    +href="glossaries-user.html#dx1-194045" >4555
    sanitize  4540, 4541, 4542, 4543, 4544
    +class="cmbx-10">4556, 4557, 4558, 4559, 4560
    scrwfile package  4545
    +href="glossaries-user.html#dx1-32007" >4561
    \section*  4546, 4547
    +href="glossaries-user.html#dx1-45013" >4562, 4563
    \seealsoname  4548, 4549
    +href="glossaries-user.html#dx1-114152" >4564, 4565
    \seename  4550, 4551, 4552
    +href="glossaries-user.html#dx1-148014" >4566, 4567, 4568
    \setabbreviationstyle  4553, 4554, 4555, 4556, 4557, 4558, 4559, 4560, 4561, 4562, 4563, 4564, 4565, 4566, 4567, 4568, 4569, 4570, 4571, 4572, 4573, 4574, 4575, 4576, 4577, 4578, 4579, 4580, 4581, 4582, 4583, 4584, 4585, 4586, 4587
    +href="glossaries-user.html#dx1-4007" >4569, 4570, 4571, 4572, 4573, 4574, 4575, 4576, 4577, 4578, 4579, 4580, 4581, 4582, 4583, 4584, 4585, 4586, 4587, 4588, 4589, 4590, 4591, 4592, 4593, 4594, 4595, 4596, 4597, 4598, 4599, 4600, 4601, 4602, 4603
    + + \setabbreviationstyle  4588
    +href="glossaries-user.html#dx1-228045" >4604
    \SetAcronymLists  4589
    +href="glossaries-user.html#dx1-95005" >4605
    \setacronymstyle  4590, 4591, 4592, 4593, 4594, 4595, 4596, 4597, 4598, 4599
    +href="glossaries-user.html#dx1-97001" >4606, 4607, 4608, 4609, 4610, 4611, 4612, 4613, 4614, 4615
    \setentrycounter  4600, 4601
    +href="glossaries-user.html#dx1-166054" >4616, 4617
    \setglossarypreamble  4602, 4603
    +href="glossaries-user.html#dx1-49008" >4618, 4619
    \setglossarysection  4604, 4605
    +href="glossaries-user.html#dx1-43002" >4620, 4621
    \setglossarystyle  4606, 4607, 4608, 4609, 4610, 4611, 4612
    +href="glossaries-user.html#dx1-56003" >4622, 4623, 4624, 4625, 4626, 4627, 4628
    \setStyleFile  4613, 4614, 4615
    - - +href="glossaries-user.html#dx1-20014" >4629, 4630, 4631
    \setupglossaries  4616
    +href="glossaries-user.html#dx1-110001" >4632
    \Sigma  4617
    +href="glossaries-user.html#dx1-206081" >4633
    siunitx package  4618, 4619
    +href="glossaries-user.html#dx1-4006" >4634, 4635
    small caps  4620, 4621, 4622, 4623, 4624, 4625, 4626, 4627, 4628, 4629
    +class="cmbx-10">4636, 4637, 4638, 4639, 4640, 4641, 4642, 4643, 4644, 4645
    \space  4630
    +href="glossaries-user.html#dx1-182007" >4646
    standard LaTeX extended Latin character  4631, 4632
    +class="cmbx-10">4647, 4648
    stix package  4633, 4634
    +href="glossaries-user.html#dx1-169038" >4649, 4650
    \subglossentry  4635
    +href="glossaries-user.html#dx1-166063" >4651
    supertabular package  4636, 4637, 4638
    +href="glossaries-user.html#dx1-53002" >4652, 4653, 4654
    \symbolname  4639
    +href="glossaries-user.html#dx1-15029" >4655

    T tabularx package  4640, 4641, 4642, 4643
    +href="glossaries-user.html#dx1-131005" >4656, 4657, 4658, 4659
    tagpdf package  4644, 4645, 4646
    +href="glossaries-user.html#dx1-176058" >4660, 4661, 4662
    \texorpdfstring  4647, 4648
    +href="glossaries-user.html#dx1-12050" >4663, 4664
    \textbf  4649, 4650
    +href="glossaries-user.html#dx1-130044" >4665, 4666
    textcase package  4651, 4652, 4653
    +href="glossaries-user.html#dx1-9" >4667, 4668, 4669
    \textrm  4654
    +href="glossaries-user.html#dx1-169012" >4670
    \textsc  4655, 4656, 4657, 4658, 4659, 4660, 4661
    +href="glossaries-user.html#dx1-3064" >4671, 4672, 4673, 4674, 4675, 4676, 4677
    \textsmaller  4662, 4663, 4664, 4665
    +href="glossaries-user.html#dx1-3066" >4678, 4679, 4680, 4681
    \textulc  4666
    +href="glossaries-user.html#dx1-140037" >4682
    \textup  4667
    +href="glossaries-user.html#dx1-140038" >4683
    \the  4668, 4669
    +href="glossaries-user.html#dx1-140027" >4684, 4685
    theglossary (environment)  4670
    +href="glossaries-user.html#dx1-166003" >4686
    \theHequation  4671
    +href="glossaries-user.html#dx1-192009" >4687
    \thepage  4672, 4673
    +href="glossaries-user.html#dx1-169051" >4688, 4689
    \toprule  4674
    +href="glossaries-user.html#dx1-160012" >4690
    tracklang package  4675, 4676, 4677
    +href="glossaries-user.html#dx1-5" >4691, 4692, 4693
    translator package  4678, 4679, 4680, 4681, 4682, 4683, 4684, 4685, 4686, 4687, 4688, 4689, 4690, 4691, 4692, 4693, 4694, 4695, 4696, 4697, 4698, 4699, 4700, 4701, 4702
    +href="glossaries-user.html#dx1-15009" >4694, 4695, 4696, 4697, 4698, 4699, 4700, 4701, 4702, 4703, 4704, 4705, 4706, 4707, 4708, 4709, 4710, 4711, 4712, 4713, 4714, 4715, 4716, 4717, 4718

    U \usepackage  4703
    +href="glossaries-user.html#dx1-197042" >4719
    UTF-8  4704
    +class="cmbx-10">4720

    W + + \write18  4705, 4706
    +href="glossaries-user.html#dx1-32012" >4721, 4722
    \writeist  4707
    +href="glossaries-user.html#dx1-154001" >4723

    X xfor package  4708
    +href="glossaries-user.html#dx1-10" >4724
    \xGlsXtrSetField  4709
    - - +href="glossaries-user.html#dx1-213011" >4725
    xindy  4710, 4711, 4712, 4713, 4726, 4727, 4728, 4729, 4714, 4715, 4716, 4717, 4718, 4719, 4720, 4721, 4722, 4723, 4724, 4725, 4726, 4727, 4728, 4729, 4730, 4731, 4732, 4733, 4734, 4735, 4736, 4737, 4738, 4739, 4740, 4741, 4742, 4743, 4744, 4745, 4746, 4747, 4748, 4749, 4750, 4751, 4752, 4753, 4754, 4755, 4756, 4757, 4758, 4759, 4760, 4761, 4762, 4763, 4764, 4765, 4766, 4767, 4768, 4769, 4770, 4771, 4772, 4773, 4774, 4775, 4776, 4777, 4778, 4779, 4780, 4781, 4782, 4783, 4784, 4785, 4786, 4787, 4788, 4789, 4790, 4791, 4792, 4793, 4794, 4795, 4796, 4797, 4798, 4799, 4800, 4801, 4802, 4803, 4804, 4805, 4806, 4807, 4808, 4809, 4810, 4811, 4812, 4813, 4814, 4815, 4816, 4817, 4818, 4819, 4820, 4821, 4822, 4823, 4824, 4825, 4826, 4827, 4828, 4829, 4830, 4831, 4832, 4833, 4834, 4835, 4836, 4837, 4838, 4839, 4840, 4841, 4842, 4843, 4844, 4845, 4846, 4847, 4848, 4849, 4850, 4851, 4852, 4853, 4854, 4855, 4856, 4857, 4858, 4859, 4860, 4861, 4862, 4863, 4864, 4865, 4866, 4867, 4868, 4869, 4870, 4871, 4872, 4873, 4874, 4875, 4876, 4877, 4878, 4879, 4880, 4881, 4882, 4883, 4884, 4885, 4886, 4887, 4888, 4889, 4890, 4891, 4892, 4893, 4894
    +class="cmbx-10">4730, 4731, 4732, 4733, 4734, 4735, 4736, 4737, 4738, 4739, 4740, 4741, 4742, 4743, 4744, 4745, 4746, 4747, 4748, 4749, 4750, 4751, 4752, 4753, 4754, 4755, 4756, 4757, 4758, 4759, 4760, 4761, 4762, 4763, 4764, 4765, 4766, 4767, 4768, 4769, 4770, 4771, 4772, 4773, 4774, 4775, 4776, 4777, 4778, 4779, 4780, 4781, 4782, 4783, 4784, 4785, 4786, 4787, 4788, 4789, 4790, 4791, 4792, 4793, 4794, 4795, 4796, 4797, 4798, 4799, 4800, 4801, 4802, 4803, 4804, 4805, 4806, 4807, 4808, 4809, 4810, 4811, 4812, 4813, 4814, 4815, 4816, 4817, 4818, 4819, 4820, 4821, 4822, 4823, 4824, 4825, 4826, 4827, 4828, 4829, 4830, 4831, 4832, 4833, 4834, 4835, 4836, 4837, 4838, 4839, 4840, 4841, 4842, 4843, 4844, 4845, 4846, 4847, 4848, 4849, 4850, 4851, 4852, 4853, 4854, 4855, 4856, 4857, 4858, 4859, 4860, 4861, 4862, 4863, 4864, 4865, 4866, 4867, 4868, 4869, 4870, 4871, 4872, 4873, 4874, 4875, 4876, 4877, 4878, 4879, 4880, 4881, 4882, 4883, 4884, 4885, 4886, 4887, 4888, 4889, 4890, 4891, 4892, 4893, 4894, 4895, 4896, 4897, 4898, 4899, 4900, 4901, 4902, 4903, 4904, 4905, 4906, 4907, 4908, 4909, 4910
        -C  4895, 4896, 4897, 4898, 4899
    +href="glossaries-user.html#dx1-9033" >4911, 4912, 4913, 4914, 4915
        -I  4900, 4901
    +href="glossaries-user.html#dx1-20007" >4916, 4917
        -L  4902, 4903, 4904, 4905
    +href="glossaries-user.html#dx1-9032" >4918, 4919, 4920, 4921
        -M  4906
    +href="glossaries-user.html#dx1-17090" >4922
    xindy attributes  4907, 4908, 4909, 4910, 4911
    +href="glossaries-user.html#dx1-17049" >4923, 4924, 4925, 4926, 4927
        :locref  4912
    +href="glossaries-user.html#dx1-152022" >4928
    xkeyval package  4913, 4914, 4915
    +href="glossaries-user.html#dx1-8" >4929, 4930, 4931
    \xspace  4916
    +href="glossaries-user.html#dx1-142018" >4932
    xspace package  4917, 4918, 4919, 4920, 4921, 4922, 4923
    +href="glossaries-user.html#dx1-142014" >4933, 4934, 4935, 4936, 4937, 4938, 4939

    @@ -49393,15 +49533,13 @@ href="glossaries-user.html#dx1-141024" >4923
    href="#fn1x1-bk" id="fn1x1">1.1That is, if the entry has been referenced using any of the commands described in §??sec:glslink 5.1 Links to Glossary Entries and §??sec:glsadd 10 Adding an Entry to the Glossary Without Generating Text or via or \glsxtrshort.

    -

    1.2Except for Klingon, which is supported by xindy, but not by the CLDR.

    -

    1.3You can just use the base glossaries package for the first case, but it’s less convenient. You entry target before the sectioning command and use \glsentryname{label} or \Glsentryname{label} to display the entry name.

    name.

    1.4\glossentrysymbol is defined by the base package but is redefined by glossaries-extra.

    -

    1.5deprecated, use babel instead

    -

    1.6Added to version makeglossaries 2.18.

    -

    1.7As from v3.01 \gls is no longer fragile and doesn’t need protecting.

    -

    1.8The batch file makeglossaries.bat  distributions for Windows provide makeglossaries.exe.

    -

    2.1These figures don’t include standard files and registers provided by the kernel or hyperref, such as aux and out.

    .

    2.2unless memoir is loaded, which case it uses \markboth

    -

    +

    2.3Actually it uses \mfirstucMakeUppercase which is set to textcase’s \MakeTextUppercase by the package. This makes it consistent with \makefirstuc. (The textcase package is automatically loaded by glossaries.)

    -

    2.4bug fix in v4.16 has corrected the code to ensure this.

    -

    2.5Actually it sets \acronymtype to \glsdefaulttype if the acronym package option is not used, but \glsdefaulttype usually has the value main unless the nomain option has been used.

    -

    4.1This is because \acronymtype is set to \glsdefaulttype if the acronym package option is not used.

    -

    5.1See also “Displaying the glossary” in the documented code, glossaries-code.pdf.

    -

    5.2I’ve used \MakeUppercase in all the examples for clarity, but it will actually use \mfirstucMakeUppercase.

    -

    5.3\glsdisplayfirst and \glsdisplay are now deprecated. Backwards compatibility should be preserved but you may need to use the compatible-3.07 option

    -

    5.4versions before 3.0 used \glsentryname as the default, but this could cause problems when name had been sanitized.

    .

    6.1as from version 1.18

    -

    6.2See David Carlisle’s explanation in Drawbacks of xspace

    -

    8.1you can’t use the longheaderborder style for this example as you can’t use the longtable environment in two column mode.

    mode.

    11.1makeindex will always assign a location number, even if it’s not needed, so it needs to be discarded.

    -

    11.2If you redefine \glsseeformat, keep the default value of the optional argument as \seename as both see and \glssee explicitly write [\seename] in the output file if no optional argument is given.

    -

    11.3In versions before 3.0, \glsentryname was used, but this could cause problems when the name key was sanitized.

    .

    13.1These lengths will not be available if you use both the nolong and nosuper package options or if you use the nostyles package option unless you explicitly load the relevant package.

    -

    13.2This style was supplied by Axel Menzel.

    -

    13.3e.g. with the flowfram package.

    -

    14.1see \glsSetCompositor described in §??sec:setup 3 Setting Up

    -

    14.2see \glsSetAlphaCompositor described in §??sec:setup 3 Setting Up

    -

    14.3With glossaries-extra seealso is appended to the end of the list.

    -

    16.1Single letter words, such as “a” and “I” should typically not appear at the end of a line, hence the non-breakable space after “a” in the prefix field.

    -

    16.2The earlier caveats about initial non-Latin characters apply.

    -

    18.1makeindex assumes that the location is a page number

    -

    18.2If you use babel with a language that makes the colon character : active you will need to change the prefix.

    -

    18.3Requires at least bib2gls v2.0.

    -

    18.4You can either uncompress the PDF file and view it in a text editor or you can use a tool such as the PDFDebugger glossaries.sty" % -src "glossaries-prefix.sty\Z=>glossaries-prefix.sty" % -src "(glossary-.+)\.(sty)\Z=>\1.\2" @@ -13,17 +11,19 @@ % -src "(glossaries-babel)\.(sty)\Z=>\1.\2" % -src "(glossaries-polyglossia)\.(sty)\Z=>\1.\2" % -src "(example-glossaries-.*\.tex)\Z=>\1" -% -src "(glossaries-2020-03-19\.sty)\Z=>\1" +% -src "(glossar.*-2020-03-19\.sty)\Z=>\1" % -src "(.*\.perl)\Z=>\1" % -setambles ".*\.perl=>\nopreamble\nopostamble" % -setambles ".*\.tex=>\nopreamble\nopostamble" % -doc "glossaries-manual.tex" -% -section "chapter" -% -codetitle "Main Package Code" +% -comment ".*\.perl" +% -comment ".*\.tex" +% -author "Nicola Talbot" % -macrocode ".*\.perl" % -macrocode ".*\.tex" +% -codetitle "Main Package Code" % glossaries -% Created on 2021/9/23 17:22 +% Created on 2021/10/20 10:44 %\fi %\iffalse %<*package> @@ -137,7 +137,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \setcounter{IndexColumns}{2} -\CheckSum{34113} +\CheckSum{34471} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{\gls{firstuse}} @@ -164,12 +164,12 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of %\fi %\MakeShortVerb{"} % -% \title{Documented Code For glossaries v4.47} +% \title{Documented Code For glossaries v4.48} % \author{Nicola L.C. Talbot\\[10pt] %Dickimaw Books\\ %\url{http://www.dickimaw-books.com/}} % -% \date{2021-09-20} +% \date{2021-10-19} % \maketitle % %This is the documented code for the \styfmt{glossaries} package. @@ -185,7 +185,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of %glossaries package}. % %\item[\url{glossaries-user.pdf}] -%For the main user guide, read \qt{glossaries.sty v4.47: +%For the main user guide, read \qt{glossaries.sty v4.48: %\LaTeX2e\ Package to Assist Generating Glossaries}. % %\item[\url{mfirstuc-manual.pdf}] @@ -244,11 +244,11 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of % Rollback releases: % \begin{macrocode} \DeclareRelease{v4.46}{2020-03-19}{glossaries-2020-03-19.sty} -\DeclareCurrentRelease{v4.47}{2021-09-20} +\DeclareCurrentRelease{v4.48}{2021-10-19} % \end{macrocode} % Declare package: % \begin{macrocode} -\ProvidesPackage{glossaries}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossaries}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} %\changes{4.18}{2015-09-09}{split mfirstuc into separate bundle} % Required packages: @@ -6360,6 +6360,23 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\glsunexpandedfieldvalue} +%\changes{4.48}{2021-10-19}{new} +%\begin{definition} +%\cs{glsunexpandedfieldvalue}\marg{label}\marg{field} +%\end{definition} +%For use in expandable contexts where the field value is required, +%but the contents should not be expanded. The \meta{field} argument +%must be the internal field name. +% \begin{macrocode} +\newcommand*{\glsunexpandedfieldvalue}[2]{% + \ifcsname glo@\glsdetoklabel{#1}@#2\endcsname + \expandafter\expandonce\csname glo@\glsdetoklabel{#1}@#2\expandafter\endcsname + \fi +} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\ifglsfieldeq} %\begin{definition} %\cs{ifglsfieldeq}\marg{label}\marg{field}\marg{string}\marg{true}\marg{false} @@ -12094,6 +12111,17 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\glscapitalisewords} +%\changes{4.48}{2021-10-19}{new} +% Make it easier to switch from \cs{capitalisewords} to +% \cs{capitalisefmtwords}. +% \begin{macrocode} +\newcommand{\glscapitalisewords}[1]{% + \capitalisewords{#1}% +} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\glsentrytitlecase} %\changes{4.22}{2016-04-19}{new} %\changes{4.45}{2020-02-13}{added existence check} @@ -12102,7 +12130,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% \glsdoifexists{#1}% {% \glsfieldfetch{#1}{#2}{\@gls@value}% - \xcapitalisewords{\@gls@value}% + \expandafter\glscapitalisewords\expandafter{\@gls@value}% }% } \ifdef\texorpdfstring @@ -19865,7 +19893,7 @@ you % \cs{gls}\marg{label}} on subsequent use. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-prefix}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossaries-prefix}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % Pass all options to \sty{glossaries}: % \begin{macrocode} @@ -20330,7 +20358,7 @@ you %\label{sec:code:hypernav} % Package Definition: % \begin{macrocode} -\ProvidesPackage{glossary-hypernav}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossary-hypernav}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % % The commands defined in this package are provided to @@ -20529,7 +20557,7 @@ you % This defines an in-line style where the entries are % comma-separated with just the name and description displayed. % \begin{macrocode} -\ProvidesPackage{glossary-inline}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossary-inline}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % %\begin{style}{inline} @@ -20710,6 +20738,95 @@ you %\fi %\iffalse % \begin{macrocode} +%<*glossary-list-2020-03-19.sty> +% \end{macrocode} +%\fi +% \section{Rollback v4.46 (glossary-list-2020-03-19.sty)} +% Version 4.46 preserved for rollback. +% \begin{macrocode} +\ProvidesPackage{glossary-list}[2020/03/19 v4.46 (NLCT)] +\providecommand{\indexspace}{% + \par \vskip 10\p@ \@plus 5\p@ \@minus 3\p@ \relax +} +\newcommand*{\glslistgroupheaderfmt}[1]{#1} +\newcommand*{\glslistnavigationitem}[1]{\item[#1]} +\newglossarystyle{list}{% + \renewenvironment{theglossary}% + {\begin{description}}{\end{description}}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand*{\glossentry}[2]{% + \item[\glsentryitem{##1}% + \glstarget{##1}{\glossentryname{##1}}] + \glossentrydesc{##1}\glspostdescription\space ##2}% + \renewcommand*{\subglossentry}[3]{% + \glssubentryitem{##2}% + \glstarget{##2}{\strut}\space + \glossentrydesc{##2}\glspostdescription\space ##3.}% + \renewcommand*{\glsgroupskip}{\ifglsnogroupskip\else\indexspace\fi}% +} +\newglossarystyle{listgroup}{% + \setglossarystyle{list}% + \renewcommand*{\glsgroupheading}[1]{% + \item[\glslistgroupheaderfmt{\glsgetgrouptitle{##1}}]}} +\newglossarystyle{listhypergroup}{% + \setglossarystyle{list}% + \renewcommand*{\glossaryheader}{% + \glslistnavigationitem{\glsnavigation}}% + \renewcommand*{\glsgroupheading}[1]{% + \item[\glslistgroupheaderfmt + {\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}]}} +\newglossarystyle{altlist}{% + \setglossarystyle{list}% + \renewcommand*{\glossentry}[2]{% + \item[\glsentryitem{##1}% + \glstarget{##1}{\glossentryname{##1}}]% + \mbox{}\par\nobreak\@afterheading + \glossentrydesc{##1}\glspostdescription\space ##2}% + \renewcommand{\subglossentry}[3]{% + \par + \glssubentryitem{##2}% + \glstarget{##2}{\strut}\glossentrydesc{##2}\glspostdescription\space ##3}% +} +\newglossarystyle{altlistgroup}{% + \setglossarystyle{altlist}% + \renewcommand*{\glsgroupheading}[1]{% + \item[\glslistgroupheaderfmt{\glsgetgrouptitle{##1}}]}} +\newglossarystyle{altlisthypergroup}{% + \setglossarystyle{altlist}% + \renewcommand*{\glossaryheader}{% + \glslistnavigationitem{\glsnavigation}}% + \renewcommand*{\glsgroupheading}[1]{% + \item[\glslistgroupheaderfmt + {\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}]}} +\newglossarystyle{listdotted}{% + \setglossarystyle{list}% + \renewcommand*{\glossentry}[2]{% + \item[]\makebox[\glslistdottedwidth][l]{% + \glsentryitem{##1}% + \glstarget{##1}{\glossentryname{##1}}% + \unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}\glossentrydesc{##1}}% + \renewcommand*{\subglossentry}[3]{% + \item[]\makebox[\glslistdottedwidth][l]{% + \glssubentryitem{##2}% + \glstarget{##2}{\glossentryname{##2}}% + \unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}\glossentrydesc{##2}}% +} +\newlength\glslistdottedwidth +\setlength{\glslistdottedwidth}{.5\hsize} +\newglossarystyle{sublistdotted}{% + \setglossarystyle{listdotted}% + \renewcommand*{\glossentry}[2]{% + \item[\glsentryitem{##1}\glstarget{##1}{\glossentryname{##1}}]}% +} +% \end{macrocode} +%\iffalse +% \begin{macrocode} +% +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} %<*glossary-list.sty> % \end{macrocode} %\fi @@ -20720,7 +20837,16 @@ you % \ics{item} command, it will appear in a bold font by % default. % \begin{macrocode} -\ProvidesPackage{glossary-list}[2021/09/20 v4.47 (NLCT)] +\NeedsTeXFormat{LaTeX2e} +% \end{macrocode} +% Rollback releases: +% \begin{macrocode} +\DeclareRelease{v4.46}{2020-03-19}{glossary-list-2020-03-19.sty} +\DeclareCurrentRelease{v4.48}{2021-10-19} +% \end{macrocode} +%Declare package: +% \begin{macrocode} +\ProvidesPackage{glossary-list}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} %\begin{macro}{\indexspace} %\changes{4.13}{2015-02-03}{new} @@ -20755,6 +20881,38 @@ you % \end{macrocode} %\end{macro} % +%\begin{macro}{\glslistinit} +%\changes{4.48}{2021-10-19}{new} +%Provide a way to ensure appropriate expansion of the name if +%\pkgopt{entrycounter} is used with \sty{gettitlestring}: +% \begin{macrocode} +\newcommand{\glslistinit}{% + \ifdef\GetTitleStringDisableCommands + {% + \GetTitleStringSetup{expand}% + \GetTitleStringDisableCommands{% + \let\glsentryitem\@gobble + \let\glstarget\@secondoftwo + \let\glossentryname\glslistexpandedname + \let\glslistgroupheaderfmt\@firstofone + \let\glsgetgrouptitle\@firstofone + \let\glsnavhypertarget\@secondoftwo + }% + }% + {}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glslistexpandedname} +%\changes{4.48}{2021-10-19}{new} +% \begin{macrocode} +\newcommand{\glslistexpandedname}[1]{% + \glsunexpandedfieldvalue{#1}{name}% +} +% \end{macrocode} +%\end{macro} +% %\begin{style}{list} % The \glostyle{list} glossary style % uses the \env{description} environment. The group separator @@ -20770,7 +20928,7 @@ you % Use \env{description} environment: % \begin{macrocode} \renewenvironment{theglossary}% - {\begin{description}}{\end{description}}% + {\glslistinit\begin{description}}{\end{description}}% % \end{macrocode} % No header at the start of the environment: % \begin{macrocode} @@ -21002,7 +21160,7 @@ you % The glossary styles defined in the \isty{glossary-long} package % used the \env{longtable} environment in the glossary. % \begin{macrocode} -\ProvidesPackage{glossary-long}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossary-long}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % Requires the \isty{longtable} package: % \begin{macrocode} @@ -21499,7 +21657,7 @@ you % \url{http://tex.stackexchange.com/a/56890} % % \begin{macrocode} -\ProvidesPackage{glossary-longbooktabs}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossary-longbooktabs}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % Requires \sty{booktabs} package: % \begin{macrocode} @@ -21840,7 +21998,7 @@ you % used the \env{longtable} environment in the glossary and use % ragged right formatting for the multiline columns. % \begin{macrocode} -\ProvidesPackage{glossary-longragged}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossary-longragged}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % Requires the \isty{array} package: % \begin{macrocode} @@ -22273,7 +22431,7 @@ you %use the \sty{multicol} package. These use the tree-like glossary %styles in a multicol environment. % \begin{macrocode} -\ProvidesPackage{glossary-mcols}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossary-mcols}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % Required packages: % \begin{macrocode} @@ -22710,7 +22868,7 @@ you % The glossary styles defined in the \isty{glossary-super} package % use the \env{supertabular} environment. % \begin{macrocode} -\ProvidesPackage{glossary-super}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossary-super}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % Requires the \isty{supertabular} package: % \begin{macrocode} @@ -23242,7 +23400,7 @@ you % are like those provided by the \isty{glossary-super} package, % except that the multiline columns have ragged right justification. % \begin{macrocode} -\ProvidesPackage{glossary-superragged}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossary-superragged}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % Requires the \isty{array} package: % \begin{macrocode} @@ -23682,7 +23840,7 @@ you % that have a tree-like structure. These are designed for % hierarchical glossaries. % \begin{macrocode} -\ProvidesPackage{glossary-tree}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossary-tree}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % %\begin{macro}{\indexspace} @@ -24403,7 +24561,7 @@ you % hyperlinks may not work properly. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-207}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossaries-compatible-207}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} %\begin{macro}{\GlsAddXdyAttribute} % Adds an attribute in old format. @@ -24764,7 +24922,7 @@ you %\section{glossaries-compatible-307} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-307}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossaries-compatible-307}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % % Compatibility macros for predefined glossary styles: @@ -25572,7 +25730,7 @@ you % \end{macrocode} % Package version number now in line with main glossaries package number. % \begin{macrocode} -\ProvidesPackage{glossaries-accsupp}[2021/09/20 v4.47 (NLCT) +\ProvidesPackage{glossaries-accsupp}[2021/10/19 v4.48 (NLCT) Experimental glossaries accessibility] % \end{macrocode} % Pass all options to \sty{glossaries}: @@ -28880,7 +29038,7 @@ you % modules. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-babel}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossaries-babel}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % Load \sty{tracklang} to obtain language settings. % \begin{macrocode} @@ -28924,7 +29082,7 @@ you % modules. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-polyglossia}[2021/09/20 v4.47 (NLCT)] +\ProvidesPackage{glossaries-polyglossia}[2021/10/19 v4.48 (NLCT)] % \end{macrocode} % Load \sty{tracklang} to obtain language settings. % \begin{macrocode} @@ -30847,7 +31005,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% \newcommand*{\@gls@loadsuper}{\RequirePackage{glossary-super}}}{% \newcommand*{\@gls@loadsuper}{}} \@gls@declareoption{nosuper}{\renewcommand*{\@gls@loadsuper}{}} -\newcommand*{\@gls@loadlist}{\RequirePackage{glossary-list}} +\newcommand*{\@gls@loadlist}{\RequirePackage{glossary-list}[=v4.46]} \@gls@declareoption{nolist}{% \renewcommand*{\@gls@loadlist}{% \ifdefstring{\@glossary@default@style}{list}% @@ -38816,6 +38974,95 @@ you %\fi %\iffalse % \begin{macrocode} +%<*glossary-list-2020-03-19.sty> +% \end{macrocode} +%\fi +% \section{Rollback v4.46 (glossary-list-2020-03-19.sty)} +% Version 4.46 preserved for rollback. +% \begin{macrocode} +\ProvidesPackage{glossary-list}[2020/03/19 v4.46 (NLCT)] +\providecommand{\indexspace}{% + \par \vskip 10\p@ \@plus 5\p@ \@minus 3\p@ \relax +} +\newcommand*{\glslistgroupheaderfmt}[1]{#1} +\newcommand*{\glslistnavigationitem}[1]{\item[#1]} +\newglossarystyle{list}{% + \renewenvironment{theglossary}% + {\begin{description}}{\end{description}}% + \renewcommand*{\glossaryheader}{}% + \renewcommand*{\glsgroupheading}[1]{}% + \renewcommand*{\glossentry}[2]{% + \item[\glsentryitem{##1}% + \glstarget{##1}{\glossentryname{##1}}] + \glossentrydesc{##1}\glspostdescription\space ##2}% + \renewcommand*{\subglossentry}[3]{% + \glssubentryitem{##2}% + \glstarget{##2}{\strut}\space + \glossentrydesc{##2}\glspostdescription\space ##3.}% + \renewcommand*{\glsgroupskip}{\ifglsnogroupskip\else\indexspace\fi}% +} +\newglossarystyle{listgroup}{% + \setglossarystyle{list}% + \renewcommand*{\glsgroupheading}[1]{% + \item[\glslistgroupheaderfmt{\glsgetgrouptitle{##1}}]}} +\newglossarystyle{listhypergroup}{% + \setglossarystyle{list}% + \renewcommand*{\glossaryheader}{% + \glslistnavigationitem{\glsnavigation}}% + \renewcommand*{\glsgroupheading}[1]{% + \item[\glslistgroupheaderfmt + {\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}]}} +\newglossarystyle{altlist}{% + \setglossarystyle{list}% + \renewcommand*{\glossentry}[2]{% + \item[\glsentryitem{##1}% + \glstarget{##1}{\glossentryname{##1}}]% + \mbox{}\par\nobreak\@afterheading + \glossentrydesc{##1}\glspostdescription\space ##2}% + \renewcommand{\subglossentry}[3]{% + \par + \glssubentryitem{##2}% + \glstarget{##2}{\strut}\glossentrydesc{##2}\glspostdescription\space ##3}% +} +\newglossarystyle{altlistgroup}{% + \setglossarystyle{altlist}% + \renewcommand*{\glsgroupheading}[1]{% + \item[\glslistgroupheaderfmt{\glsgetgrouptitle{##1}}]}} +\newglossarystyle{altlisthypergroup}{% + \setglossarystyle{altlist}% + \renewcommand*{\glossaryheader}{% + \glslistnavigationitem{\glsnavigation}}% + \renewcommand*{\glsgroupheading}[1]{% + \item[\glslistgroupheaderfmt + {\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}}]}} +\newglossarystyle{listdotted}{% + \setglossarystyle{list}% + \renewcommand*{\glossentry}[2]{% + \item[]\makebox[\glslistdottedwidth][l]{% + \glsentryitem{##1}% + \glstarget{##1}{\glossentryname{##1}}% + \unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}\glossentrydesc{##1}}% + \renewcommand*{\subglossentry}[3]{% + \item[]\makebox[\glslistdottedwidth][l]{% + \glssubentryitem{##2}% + \glstarget{##2}{\glossentryname{##2}}% + \unskip\leaders\hbox to 2.9mm{\hss.}\hfill\strut}\glossentrydesc{##2}}% +} +\newlength\glslistdottedwidth +\setlength{\glslistdottedwidth}{.5\hsize} +\newglossarystyle{sublistdotted}{% + \setglossarystyle{listdotted}% + \renewcommand*{\glossentry}[2]{% + \item[\glsentryitem{##1}\glstarget{##1}{\glossentryname{##1}}]}% +} +% \end{macrocode} +%\iffalse +% \begin{macrocode} +% +% \end{macrocode} +%\fi +%\iffalse +% \begin{macrocode} %<*glossaries.perl> % \end{macrocode} %\fi diff --git a/macros/latex/contrib/glossaries/glossaries.ins b/macros/latex/contrib/glossaries/glossaries.ins index 0c8f90881b..7c92550963 100644 --- a/macros/latex/contrib/glossaries/glossaries.ins +++ b/macros/latex/contrib/glossaries/glossaries.ins @@ -1,4 +1,4 @@ -% glossaries.ins generated using makedtx version 1.2 2021/9/23 17:22 +% glossaries.ins generated using makedtx version 1.2 2021/10/20 10:44 \input docstrip \preamble @@ -18,7 +18,7 @@ The Current Maintainer of this work is Nicola Talbot. - This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, glossaries-prefix.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list.sty, glossary-long.sty, glossary-longbooktabs.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-compatible-307.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, example-glossaries-acronym-desc.tex, example-glossaries-acronym.tex, example-glossaries-acronyms-lang.tex, example-glossaries-brief.tex, example-glossaries-childmultipar.tex, example-glossaries-childnoname.tex, example-glossaries-cite.tex, example-glossaries-images.tex, example-glossaries-long.tex, example-glossaries-longchild.tex, example-glossaries-multipar.tex, example-glossaries-parent.tex, example-glossaries-symbolnames.tex, example-glossaries-symbols.tex, example-glossaries-url.tex, glossaries-2020-03-19.sty, glossaries.perl. + This work consists of the files glossaries.dtx and glossaries.ins and the derived files glossaries.sty, glossaries-prefix.sty, glossary-hypernav.sty, glossary-inline.sty, glossary-list-2020-03-19.sty, glossary-list.sty, glossary-long.sty, glossary-longbooktabs.sty, glossary-longragged.sty, glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty, glossary-tree.sty, glossaries-compatible-207.sty, glossaries-compatible-307.sty, glossaries-accsupp.sty, glossaries-babel.sty, glossaries-polyglossia.sty, example-glossaries-acronym-desc.tex, example-glossaries-acronym.tex, example-glossaries-acronyms-lang.tex, example-glossaries-brief.tex, example-glossaries-childmultipar.tex, example-glossaries-childnoname.tex, example-glossaries-cite.tex, example-glossaries-images.tex, example-glossaries-long.tex, example-glossaries-longchild.tex, example-glossaries-multipar.tex, example-glossaries-parent.tex, example-glossaries-symbolnames.tex, example-glossaries-symbols.tex, example-glossaries-url.tex, glossaries-2020-03-19.sty, glossary-list-2020-03-19.sty, glossaries.perl. \endpreamble @@ -32,6 +32,8 @@ \usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-hypernav.sty,package}} \file{glossary-inline.sty}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-inline.sty,package}} +\file{glossary-list-2020-03-19.sty}{\usepreamble\defaultpreamble +\usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-list-2020-03-19.sty,package}} \file{glossary-list.sty}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-list.sty,package}} \file{glossary-long.sty}{\usepreamble\defaultpreamble @@ -75,6 +77,8 @@ \file{example-glossaries-url.tex}{\nopreamble\nopostamble\from{glossaries.dtx}{example-glossaries-url.tex}} \file{glossaries-2020-03-19.sty}{\usepreamble\defaultpreamble \usepostamble\defaultpostamble\from{glossaries.dtx}{glossaries-2020-03-19.sty,package}} +\file{glossary-list-2020-03-19.sty}{\usepreamble\defaultpreamble +\usepostamble\defaultpostamble\from{glossaries.dtx}{glossary-list-2020-03-19.sty,package}} \file{glossaries.perl}{\nopreamble\nopostamble\from{glossaries.dtx}{glossaries.perl}} } diff --git a/macros/latex/contrib/glossaries/glossariesbegin.html b/macros/latex/contrib/glossaries/glossariesbegin.html index 85fd72607d..04ea3b6b3f 100644 --- a/macros/latex/contrib/glossaries/glossariesbegin.html +++ b/macros/latex/contrib/glossaries/glossariesbegin.html @@ -63,7 +63,6 @@ img.math{vertical-align:middle;} div.par-math-display, div.math-display{text-align:center;} li p.indent { text-indent: 0em } li p:first-child{ margin-top:0em; } -li p:first-child{ margin-bottom; } li p:last-child, li div:last-child { margin-bottom:0.5em; } li p:first-child{ margin-bottom:0; } li p~ul:last-child, li p~ol:last-child{ margin-bottom:0.5em; } @@ -117,6 +116,7 @@ table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } .hline hr, .cline hr{ height : 0px; margin:0px; } .hline td, .cline td{ padding: 0; } .hline hr, .cline hr{border:none;border-top:1px solid black;} +.hline {border-top: 1px solid black;} .tabbing-right {text-align:right;} div.float, div.figure {margin-left: auto; margin-right: auto;} div.float img {text-align:center;} @@ -179,6 +179,7 @@ table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } .hline hr, .cline hr{ height : 0px; margin:0px; } .hline td, .cline td{ padding: 0; } .hline hr, .cline hr{border:none;border-top:1px solid black;} +.hline {border-top: 1px solid black;} div.array {text-align:center;} .equation td{text-align:center; } .equation-star td{text-align:center; } @@ -262,7 +263,7 @@ span#textcolor40{color:#00FF00} >

    The glossaries package v4.47: a guide for +class="cmr-17">The glossaries package v4.48: a guide for beginners

    @@ -280,7 +281,7 @@ href="https://www.dickimaw-books.com/" >dickimaw-books.com

    2021-09-20

    +class="cmr-12">2021-10-19

    @@ -873,7 +874,7 @@ the recommended methods. These methods are described in more detail in §??sec:printglossaries 4 Displaying a List of Entries.

    The rest of this document briefly describes the main commands provided by the Top

    In §??sec:start 1 Getting Started, I mentioned that there are three options you can choose from to create an automatically sorted glossary with the base glossaries @@ -1784,8 +1785,8 @@ package. These are also available with the extension package glossaries-extra along with a fourth option. These four options are listed below in a little more detail. Table ??tab:optionsp+c summarises the main advantages and disadvantages. +href="#x1-50011">Table +c summarises the main advantages and disadvantages. (There’s a more detailed summary in the main glossaries user manual.) See also .



    @@ -2019,7 +2020,7 @@ class="cmtt-10">\makenoidxglossaries to your preamble (before you st defining your entries, as described in §??sec:defterm 2 Defining Terms).

  • 2 or 3 described in §??sec:printglossaries 4 Displaying a List of Entries or Option 4 (with main glossary. When you define an entry (using one of the commands described in §??sec:defterm 2 Defining Terms), that entry is automatically assigned to the default glossary, unless you indicate otherwise using the xindy (described in §??sec:printglossaries 4 Displaying a List of Entries). If you use Option 1 described above (or Nicola L.C. Talbot
  • 2021-09-20

    +class="cmr-12">2021-10-19

    @@ -231,19 +231,19 @@ class="cmr-9">package.  1 Why the Need for a New Package?
     2 Package Options +href="#packageoptions" id="QQ2-1-3">Package Options
     3 Defining new glossary types +href="#definingnewglossarytypes" id="QQ2-1-5">Defining new glossary types
     4 \makeglossary name
     5 Storing glossary information +href="#storingglossaryinformation" id="QQ2-1-7">Storing glossary information
     6 Adding an entry to the glossary +href="#addinganentrytotheglossary" id="QQ2-1-8">Adding an entry to the glossary
      6.1 \useglosentry @@ -255,10 +255,10 @@ class="cmtt-10">\useGlosentry href="#x1-100006.3" id="QQ2-1-11">\gls
      6.4 \glossary
     7 Acronyms +href="#acronyms" id="QQ2-1-13">Acronyms
      7.1 \acrln and \resetacronym and \unsetacronym
     8 Displaying the glossary +href="#displayingtheglossary" id="QQ2-1-17">Displaying the glossary
     9 Processing Your Document +href="#processingyourdocument" id="QQ2-1-18">Processing Your Document
     10 Troubleshooting +href="#troubleshooting" id="QQ2-1-19">Troubleshooting

    @@ -361,7 +361,7 @@ href="#fn2x0" id="fn2x0-bk">2

    Top

    2 Package Options

    + id="packageoptions">Package Options

    When converting a document that currently uses the obsolete glossary package to the replacement no corresponding option

    Top

    3 Defining new glossary types

    + id="definingnewglossarytypes">Defining new glossary types

    If you have created new glossary types, you will need to replace all instances of


    Top

    5 Storing glossary information

    + id="storingglossaryinformation">Storing glossary information

    With the old glossary package you could optionally store glossary information for later use, or you could simply use \newglossaryentry\glossary, then see §??sec:csglossary 6.4 \glossary.

    Substitute all instances of


    \newglossaryentry

    Top

    6 Adding an entry to the glossary

    + id="addinganentrytotheglossary">Adding an entry to the glossary

    The glossary package provided two basic means to add information to the glossary: firstly, the term was defined using glossaries package.

    Top

    6.1 \useglosentry

    The glossary package allows you to add information to the glossary for a predefined @@ -953,10 +953,10 @@ The mapping from ⟨old options⟩ to ⟨new options⟩ is the same as that given §??sec:useglosentry 6.1 \useglosentry.

    @@ -983,7 +983,7 @@ text.

    Top

    6.4 \glossary

    When using the glossaries package, you should not use

    Top

    7 Acronyms

    + id="acronyms">Acronyms

    In the glossary package, acronyms were treated differently to glossary entries. This resulted in inconsistencies and sprawling unmaintainable code. The new ]

    Top

    8 Displaying the glossary

    + id="displayingtheglossary">Displaying the glossary

    The glossary package provides the command \printglossary

    Top

    9 Processing Your Document

    + id="processingyourdocument">Processing Your Document

    If you convert your document from using the glossary package to the glossaries @@ -1710,7 +1710,7 @@ documentation.

    Top

    10 Troubleshooting

    + id="troubleshooting">Troubleshooting

    Please check the FAQ for the glossaries package if you have any problems. diff --git a/macros/latex/contrib/glossaries/glossary2glossaries.pdf b/macros/latex/contrib/glossaries/glossary2glossaries.pdf index f129eb3c65..5883ad0f66 100644 Binary files a/macros/latex/contrib/glossaries/glossary2glossaries.pdf and b/macros/latex/contrib/glossaries/glossary2glossaries.pdf differ diff --git a/macros/latex/contrib/glossaries/glossary2glossaries.tex b/macros/latex/contrib/glossaries/glossary2glossaries.tex index 5eff3c4fdd..e8671059a3 100644 --- a/macros/latex/contrib/glossaries/glossary2glossaries.tex +++ b/macros/latex/contrib/glossaries/glossary2glossaries.tex @@ -34,7 +34,7 @@ \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} -\date{2021-09-20} +\date{2021-10-19} \newenvironment{oldway}{% \begin{labelledbox}{\styfmt{glossary}}\ttfamily\obeylines diff --git a/macros/latex/contrib/glossaries/makeglossaries b/macros/latex/contrib/glossaries/makeglossaries index 2d60ff6688..08f9c2047d 100755 --- a/macros/latex/contrib/glossaries/makeglossaries +++ b/macros/latex/contrib/glossaries/makeglossaries @@ -2,7 +2,7 @@ # File : makeglossaries # Author : Nicola Talbot -# Version : 4.47 +# Version : 4.48 # Description: simple Perl script that calls makeindex or xindy. # Intended for use with "glossaries.sty" (saves having to remember # all the various switches) @@ -31,9 +31,11 @@ # glossaries-babel.sty, glossaries-polyglossia.sty, glossaries.perl. # Also makeglossaries and makeglossaries-lite.lua. -my $version="4.47 (2021-09-20)"; +my $version="4.48 (2021-10-19)"; # History: +# v4.48: +# * No change. (Version number updated in line with glossaries.sty) # v4.47: # * Added hybrid instructions if record option detected but not # \makeglossaries diff --git a/macros/latex/contrib/glossaries/makeglossaries-lite.1 b/macros/latex/contrib/glossaries/makeglossaries-lite.1 index 4032c86bc4..8908f9ea8b 100644 --- a/macros/latex/contrib/glossaries/makeglossaries-lite.1 +++ b/macros/latex/contrib/glossaries/makeglossaries-lite.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "MAKEGLOSSARIES-LITE 1" -.TH MAKEGLOSSARIES-LITE 1 "2021-09-23" "perl v5.32.1" "makeglossaries-lite Lua Script" +.TH MAKEGLOSSARIES-LITE 1 "2021-10-19" "perl v5.32.1" "makeglossaries-lite Lua Script" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/macros/latex/contrib/glossaries/makeglossaries-lite.lua b/macros/latex/contrib/glossaries/makeglossaries-lite.lua index bee21d2cfc..1d820a5e59 100755 --- a/macros/latex/contrib/glossaries/makeglossaries-lite.lua +++ b/macros/latex/contrib/glossaries/makeglossaries-lite.lua @@ -36,6 +36,8 @@ Also makeglossaries and makeglossaries-lite.lua. History: + * 4.48: + - no change. * 4.47: - Added hybrid instructions if record option detected but not \makeglossaries - Added extra info to error message on -d @@ -68,7 +70,7 @@ - changed first line from lua to texlua --]] -thisversion = "4.47 (2021-09-20)" +thisversion = "4.48 (2021-10-19)" quiet = false dryrun = false diff --git a/macros/latex/contrib/glossaries/makeglossaries.1 b/macros/latex/contrib/glossaries/makeglossaries.1 index 00b3dc50c7..ed38ab0006 100644 --- a/macros/latex/contrib/glossaries/makeglossaries.1 +++ b/macros/latex/contrib/glossaries/makeglossaries.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "MAKEGLOSSARIES 1" -.TH MAKEGLOSSARIES 1 "2021-09-23" "perl v5.32.1" "makeglossaries Perl Script" +.TH MAKEGLOSSARIES 1 "2021-10-19" "perl v5.32.1" "makeglossaries Perl Script" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/macros/latex/contrib/glossaries/samples/glossary-lipsum-examples.pdf b/macros/latex/contrib/glossaries/samples/glossary-lipsum-examples.pdf index 1a65598f02..3095d669b4 100644 Binary files a/macros/latex/contrib/glossaries/samples/glossary-lipsum-examples.pdf and b/macros/latex/contrib/glossaries/samples/glossary-lipsum-examples.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/minimalgls.pdf b/macros/latex/contrib/glossaries/samples/minimalgls.pdf index 640631a1eb..d3fdcc87b4 100644 Binary files a/macros/latex/contrib/glossaries/samples/minimalgls.pdf and b/macros/latex/contrib/glossaries/samples/minimalgls.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/mwe-acr-desc.pdf b/macros/latex/contrib/glossaries/samples/mwe-acr-desc.pdf index 33500b13b0..ec38fcfa95 100644 Binary files a/macros/latex/contrib/glossaries/samples/mwe-acr-desc.pdf and b/macros/latex/contrib/glossaries/samples/mwe-acr-desc.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/mwe-acr.pdf b/macros/latex/contrib/glossaries/samples/mwe-acr.pdf index 72a102b1a5..a83957fb36 100644 Binary files a/macros/latex/contrib/glossaries/samples/mwe-acr.pdf and b/macros/latex/contrib/glossaries/samples/mwe-acr.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/mwe-gls.pdf b/macros/latex/contrib/glossaries/samples/mwe-gls.pdf index f369987cd7..acd4d643e3 100644 Binary files a/macros/latex/contrib/glossaries/samples/mwe-gls.pdf and b/macros/latex/contrib/glossaries/samples/mwe-gls.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-FnDesc.pdf b/macros/latex/contrib/glossaries/samples/sample-FnDesc.pdf index 5aff90266f..6d45dc1394 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-FnDesc.pdf and b/macros/latex/contrib/glossaries/samples/sample-FnDesc.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-chap-hyperfirst.pdf b/macros/latex/contrib/glossaries/samples/sample-chap-hyperfirst.pdf index 9e6d071e44..799e534ed2 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-chap-hyperfirst.pdf and b/macros/latex/contrib/glossaries/samples/sample-chap-hyperfirst.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-crossref.pdf b/macros/latex/contrib/glossaries/samples/sample-crossref.pdf index f3cb6b7e2b..7ec8e402e9 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-crossref.pdf and b/macros/latex/contrib/glossaries/samples/sample-crossref.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-custom-acronym.pdf b/macros/latex/contrib/glossaries/samples/sample-custom-acronym.pdf index 4a5a72f4b1..1af96a0426 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-custom-acronym.pdf and b/macros/latex/contrib/glossaries/samples/sample-custom-acronym.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-dot-abbr.pdf b/macros/latex/contrib/glossaries/samples/sample-dot-abbr.pdf index c7516f95b5..70cbddbb93 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-dot-abbr.pdf and b/macros/latex/contrib/glossaries/samples/sample-dot-abbr.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-dual.pdf b/macros/latex/contrib/glossaries/samples/sample-dual.pdf index a3efd9a6ee..6737b49fd3 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-dual.pdf and b/macros/latex/contrib/glossaries/samples/sample-dual.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-entrycount.pdf b/macros/latex/contrib/glossaries/samples/sample-entrycount.pdf index df1ff6c742..7e49082cee 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-entrycount.pdf and b/macros/latex/contrib/glossaries/samples/sample-entrycount.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-entryfmt.pdf b/macros/latex/contrib/glossaries/samples/sample-entryfmt.pdf index f2c2bfcfad..89593e49a9 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-entryfmt.pdf and b/macros/latex/contrib/glossaries/samples/sample-entryfmt.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-font-abbr.pdf b/macros/latex/contrib/glossaries/samples/sample-font-abbr.pdf index d066d60284..bc823c789a 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-font-abbr.pdf and b/macros/latex/contrib/glossaries/samples/sample-font-abbr.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-ignored.pdf b/macros/latex/contrib/glossaries/samples/sample-ignored.pdf index 11b1229470..cabbe7a65b 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-ignored.pdf and b/macros/latex/contrib/glossaries/samples/sample-ignored.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-index.pdf b/macros/latex/contrib/glossaries/samples/sample-index.pdf index 6a9b34124c..8daf3a909c 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-index.pdf and b/macros/latex/contrib/glossaries/samples/sample-index.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-inline.pdf b/macros/latex/contrib/glossaries/samples/sample-inline.pdf index e814486676..ec66a71c8c 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-inline.pdf and b/macros/latex/contrib/glossaries/samples/sample-inline.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-langdict.pdf b/macros/latex/contrib/glossaries/samples/sample-langdict.pdf index af1555e9ff..73fa79cd1e 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-langdict.pdf and b/macros/latex/contrib/glossaries/samples/sample-langdict.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-newkeys.pdf b/macros/latex/contrib/glossaries/samples/sample-newkeys.pdf index cbce49de84..a90219ba91 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-newkeys.pdf and b/macros/latex/contrib/glossaries/samples/sample-newkeys.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-noidxapp-utf8.pdf b/macros/latex/contrib/glossaries/samples/sample-noidxapp-utf8.pdf index f22c15d4c9..59f43eec1b 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-noidxapp-utf8.pdf and b/macros/latex/contrib/glossaries/samples/sample-noidxapp-utf8.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-noidxapp.pdf b/macros/latex/contrib/glossaries/samples/sample-noidxapp.pdf index 573100d011..fc50936463 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-noidxapp.pdf and b/macros/latex/contrib/glossaries/samples/sample-noidxapp.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-nomathhyper.pdf b/macros/latex/contrib/glossaries/samples/sample-nomathhyper.pdf index 89136e7228..462d07eee0 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-nomathhyper.pdf and b/macros/latex/contrib/glossaries/samples/sample-nomathhyper.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-numberlist.pdf b/macros/latex/contrib/glossaries/samples/sample-numberlist.pdf index 06f90a7d64..eec39aac3e 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-numberlist.pdf and b/macros/latex/contrib/glossaries/samples/sample-numberlist.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-prefix.pdf b/macros/latex/contrib/glossaries/samples/sample-prefix.pdf index 437a5ffbc9..55b68d153f 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-prefix.pdf and b/macros/latex/contrib/glossaries/samples/sample-prefix.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-si.pdf b/macros/latex/contrib/glossaries/samples/sample-si.pdf index b64598dd6d..de1b6531fd 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-si.pdf and b/macros/latex/contrib/glossaries/samples/sample-si.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-storage-abbr-desc.pdf b/macros/latex/contrib/glossaries/samples/sample-storage-abbr-desc.pdf index 630fcf10f3..ca0906d9bd 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-storage-abbr-desc.pdf and b/macros/latex/contrib/glossaries/samples/sample-storage-abbr-desc.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample-storage-abbr.pdf b/macros/latex/contrib/glossaries/samples/sample-storage-abbr.pdf index d556c94e3b..c89298d927 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample-storage-abbr.pdf and b/macros/latex/contrib/glossaries/samples/sample-storage-abbr.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample.pdf b/macros/latex/contrib/glossaries/samples/sample.pdf index 29e713d287..7308e76e9c 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample.pdf and b/macros/latex/contrib/glossaries/samples/sample.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sample4col.pdf b/macros/latex/contrib/glossaries/samples/sample4col.pdf index dd7fe8e2c6..18bd974c29 100644 Binary files a/macros/latex/contrib/glossaries/samples/sample4col.pdf and b/macros/latex/contrib/glossaries/samples/sample4col.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleAcr.pdf b/macros/latex/contrib/glossaries/samples/sampleAcr.pdf index 1bd305864b..2cb3f4df33 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleAcr.pdf and b/macros/latex/contrib/glossaries/samples/sampleAcr.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleAcrDesc.pdf b/macros/latex/contrib/glossaries/samples/sampleAcrDesc.pdf index 44ef7fb5be..39cbb82261 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleAcrDesc.pdf and b/macros/latex/contrib/glossaries/samples/sampleAcrDesc.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleCustomAcr.pdf b/macros/latex/contrib/glossaries/samples/sampleCustomAcr.pdf index 9e6af363a3..154cdef90c 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleCustomAcr.pdf and b/macros/latex/contrib/glossaries/samples/sampleCustomAcr.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleDB.pdf b/macros/latex/contrib/glossaries/samples/sampleDB.pdf index bf24d05cad..1c733aa875 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleDB.pdf and b/macros/latex/contrib/glossaries/samples/sampleDB.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleDesc.pdf b/macros/latex/contrib/glossaries/samples/sampleDesc.pdf index e88a539966..199dc02062 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleDesc.pdf and b/macros/latex/contrib/glossaries/samples/sampleDesc.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleEq.pdf b/macros/latex/contrib/glossaries/samples/sampleEq.pdf index 9a4bd3cac5..a20f686e1a 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleEq.pdf and b/macros/latex/contrib/glossaries/samples/sampleEq.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleEqPg.pdf b/macros/latex/contrib/glossaries/samples/sampleEqPg.pdf index aba5a2c89b..955b4dd2a1 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleEqPg.pdf and b/macros/latex/contrib/glossaries/samples/sampleEqPg.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleFnAcrDesc.pdf b/macros/latex/contrib/glossaries/samples/sampleFnAcrDesc.pdf index 6c2291ada3..ef040cb2d7 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleFnAcrDesc.pdf and b/macros/latex/contrib/glossaries/samples/sampleFnAcrDesc.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleNtn.pdf b/macros/latex/contrib/glossaries/samples/sampleNtn.pdf index e339d2a91c..82dc07cebf 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleNtn.pdf and b/macros/latex/contrib/glossaries/samples/sampleNtn.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/samplePeople.pdf b/macros/latex/contrib/glossaries/samples/samplePeople.pdf index 4b56859d0c..ab12d2c182 100644 Binary files a/macros/latex/contrib/glossaries/samples/samplePeople.pdf and b/macros/latex/contrib/glossaries/samples/samplePeople.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleSec.pdf b/macros/latex/contrib/glossaries/samples/sampleSec.pdf index b7683a71d6..c10ecf2c80 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleSec.pdf and b/macros/latex/contrib/glossaries/samples/sampleSec.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleSort.pdf b/macros/latex/contrib/glossaries/samples/sampleSort.pdf index 916bdd25bc..31bbfc606c 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleSort.pdf and b/macros/latex/contrib/glossaries/samples/sampleSort.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleaccsupp.pdf b/macros/latex/contrib/glossaries/samples/sampleaccsupp.pdf index 0a00240e25..6343c9e1a1 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleaccsupp.pdf and b/macros/latex/contrib/glossaries/samples/sampleaccsupp.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleacronyms.pdf b/macros/latex/contrib/glossaries/samples/sampleacronyms.pdf index f04927587e..b4e5ba7e14 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleacronyms.pdf and b/macros/latex/contrib/glossaries/samples/sampleacronyms.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampletree.pdf b/macros/latex/contrib/glossaries/samples/sampletree.pdf index ce9e4cb360..3507645ec6 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampletree.pdf and b/macros/latex/contrib/glossaries/samples/sampletree.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/sampleutf8.pdf b/macros/latex/contrib/glossaries/samples/sampleutf8.pdf index d99b3536f8..4b14d2f0aa 100644 Binary files a/macros/latex/contrib/glossaries/samples/sampleutf8.pdf and b/macros/latex/contrib/glossaries/samples/sampleutf8.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/samplexdy.pdf b/macros/latex/contrib/glossaries/samples/samplexdy.pdf index 1346e57359..dcdde1352a 100644 Binary files a/macros/latex/contrib/glossaries/samples/samplexdy.pdf and b/macros/latex/contrib/glossaries/samples/samplexdy.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/samplexdy2.pdf b/macros/latex/contrib/glossaries/samples/samplexdy2.pdf index 61a1b71e7c..5802357a77 100644 Binary files a/macros/latex/contrib/glossaries/samples/samplexdy2.pdf and b/macros/latex/contrib/glossaries/samples/samplexdy2.pdf differ diff --git a/macros/latex/contrib/glossaries/samples/samplexdy3.pdf b/macros/latex/contrib/glossaries/samples/samplexdy3.pdf index 6724b925bd..5bc0728c30 100644 Binary files a/macros/latex/contrib/glossaries/samples/samplexdy3.pdf and b/macros/latex/contrib/glossaries/samples/samplexdy3.pdf differ diff --git a/macros/latex/contrib/incgraph/CHANGES b/macros/latex/contrib/incgraph/CHANGES deleted file mode 100644 index 14901dbd11..0000000000 --- a/macros/latex/contrib/incgraph/CHANGES +++ /dev/null @@ -1,62 +0,0 @@ -%% The LaTeX package incgraph - version 1.12 (2015/03/12) -%% -%% ------------------------------------------------------------------------------------------- -%% Copyright (c) 2012-2015 by Prof. Dr. Dr. Thomas F. Sturm -%% ------------------------------------------------------------------------------------------- -%% -%% 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 `author-maintained'. -%% -%% This work consists of all files listed in README -%% - -version 1.00 (2012/06/21): initial public release - -version 1.01 (2012/07/04): -- the code of the hypertarget setting is rewritten to place it at - the top left corner of the page (previously it was placed at the - top left corner of the text area). -- new macro '\igrtargetset' to set hypertarget values manually -- new key 'target' to set hypertarget values manually - -version 1.02 (2012/07/06): -- bug fixed in '\igrboxtikz' which caused a small shift. -- key 'nohyper' renamed to 'no hyper' -- new macro '\igrboxtikzcenter' to support tikz pictures with a centered box. -- option key 'include command' now has a default. -- new feature to overlay included graphics with tikz picture code - using the new option keys 'overlay', 'overlay page number at', - 'overlay page number at bottom', 'overlay page number at top', - 'no overlay'. - -version 1.10 (2012/09/28): -- overlay code and graphics inclusion decoupled internally -- interlineskip problem fixed -- output macro implementation rewritten -- new macro '\igrcenterfit' for an arbitrary paper size -- new user interface environment 'inctext' to support - arbitrary internal graphics -- documentation structure changed -- introduction of various paper format options with the key 'paper' -- new 'landscape' and 'portrait' keys -- new keys 'currentpaper', 'graphicspaper' and 'documentpaper' - to replace the deprecated keys 'page' and 'center' -- various internal code changes - -version 1.11 (2013/01/16): -- bug fixed: positioning on even pages for twosided documents -- bug fixed: option 'paper=document' could not be used inside the preamble -- added clearpage at begin of inctext - -version 1.12 (2015/03/12): -- ugly pictures of the documentation exchanged by not so ugly ones. -- new options: - 'left border', 'bottom border', 'right border', 'top border', - 'horizontal border', 'vertical border', 'border' diff --git a/macros/latex/contrib/incgraph/CHANGES.md b/macros/latex/contrib/incgraph/CHANGES.md new file mode 100644 index 0000000000..0b6698f210 --- /dev/null +++ b/macros/latex/contrib/incgraph/CHANGES.md @@ -0,0 +1,138 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on +[Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to +[Semantic Versioning](http://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +### Changed +### Deprecated +### Removed +### Fixed +### Security + + + +## [1.2.0] - 2021-10-20 + +### Added +- Option `overlay page number options` (issue #2) +- `\igrGetPageSize` +- `\igrPageWidth` +- `\igrPageHeight` +- `\igrSetPageSize` +- `\igrGetLastPage` +- `\igrLastPage` +- Adding/Guessing file name extensions (issue #1): + - Option `extensions` + - Option `extensions add` + - Option `extensions from graphics` + - Option `ignore on not found with extensions` + - Option `ignore on not found with extensions*` +- Option `no existence check` + +### Changed +- Changelog moved from CHANGES to CHANGES.md and adapted to + [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) +- From now on version numbers adhere to + [Semantic Versioning](http://semver.org/spec/v2.0.0.html) +- Readme moved from README to README.md and adapted to +- Documentation code revised +- Internal package creation process modernized (invisible to the user) +- Adaption of paper size made compatible with lualatex +- Implementation of `\incgraph` and `\incmultigraph` changed (to LaTeX3) + +### Fixed +- Documentation typos corrected (issue #3) +- `\incgraph` ignored option settings for not existing files. + + + +## [1.12] - 2015-03-12 + +### Added +- Option `left border` +- Option `bottom border` +- Option `right border` +- Option `top border` +- Option `horizontal border` +- Option `vertical border` +- Option `border` + +### Changed +- ugly pictures of the documentation exchanged by not so ugly ones. + + + +## [1.11] - 2013-01-16 + +### Added +- added `clearpage` at begin of `inctext` + +### Fixed +- Positioning on even pages for twosided documents +- Option `paper=document` could not be used inside the preamble + + + +## [1.10] - 2012-09-28 + +### Added +- new macro `\igrcenterfit` for an arbitrary paper size +- new user interface environment `inctext` to support + arbitrary internal graphics +- introduction of various paper format options with the key `paper` +- new `landscape` and `portrait` keys +- new keys `currentpaper`, `graphicspaper` and `documentpaper` + to replace the deprecated keys `page` and `center` + +### Changed +- overlay code and graphics inclusion decoupled internally +- output macro implementation rewritten +- documentation structure changed +- various internal code changes + +### Fixed +- interlineskip problem fixed + + + +## [1.02] - 2012-07-06 + +### Added +- new macro `\igrboxtikzcenter` to support tikz pictures with a centered box. +- new feature to overlay included graphics with tikz picture code + using the new option keys `overlay`, `overlay page number at`, + `overlay page number at bottom`, `overlay page number at top`, + `no overlay`. + +### Changed +- key `nohyper` renamed to `no hyper` +- option key `include command` now has a default. + +### Fixed +- bug fixed in `\igrboxtikz` which caused a small shift. + + + +## [1.01] - 2012-07-04 + +### Added +- new macro `\igrtargetset` to set hypertarget values manually +- new key `target` to set hypertarget values manually + +### Changed +- the code of the hypertarget setting is rewritten to place it at + the top left corner of the page (previously it was placed at the + top left corner of the text area). + + + +## [1.00] - 2012-06-21 + +### Added +- initial public release diff --git a/macros/latex/contrib/incgraph/README b/macros/latex/contrib/incgraph/README deleted file mode 100644 index 4acfe46fbe..0000000000 --- a/macros/latex/contrib/incgraph/README +++ /dev/null @@ -1,52 +0,0 @@ -%% The LaTeX package incgraph - version 1.12 (2015/03/12) -%% -%% ------------------------------------------------------------------------------------------- -%% Copyright (c) 2012-2015 by Prof. Dr. Dr. Thomas F. Sturm -%% ------------------------------------------------------------------------------------------- -%% -%% 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 `author-maintained'. -%% -%% This work consists of all files listed in README -%% - -incgraph provides tools for including graphics on full paper size. The graphics -can be centered for a given paper format or the paper may be resized to the -graphics dimensions. The main use case for the package incgraph is to transform -one or many scans or taken pictures to a PDF document. It can also be applied -for full paper size LaTeX created graphics. The package incgraph provides a tool -box with basic macros and a convenience user interface which wraps the -well-known includegraphics. Also, bookmarking is especially supported. - -Contents of the package -======================= - 'README' this file - 'CHANGES' log of changes (history) - 'incgraph.sty' LaTeX package file (style file) - 'incgraph.pdf' documentation for csvsimple - 'incgraph.tex' source code of the documentation - 'incgraph-example-a.tex' example file A for package usage - 'incgraph-example-a.pdf' compiled example A - 'incgraph-example-b.tex' example file B for package usage - 'incgraph-example-b.pdf' compiled example B - 'incgraph-example-c.tex' example file C for package usage - 'incgraph-example-c.pdf' compiled example C - 'example.jpg' example image file - 'exaimage-0001.png' example image file - 'exaimage-0037.png' example image file - 'exaimage-0123.png' example image file - -Installation -============ -Copy the contents of the 'incgraph.tds.zip' from CTAN to your local TeX file tree. - -Alternatively, put the files to their respective locations within the TeX installation: - 'incgraph.sty' -> /tex/latex/incgraph - all other files -> /doc/latex/incgraph diff --git a/macros/latex/contrib/incgraph/README.md b/macros/latex/contrib/incgraph/README.md new file mode 100644 index 0000000000..78e1983b50 --- /dev/null +++ b/macros/latex/contrib/incgraph/README.md @@ -0,0 +1,55 @@ +# The LaTeX package incgraph - version 1.2.0 (2021/10/20) + + +> Copyright (c) 2012-2021 by Prof. Dr. Dr. Thomas F. Sturm + +> 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 `author-maintained`. + +> This work consists of all files listed in README.md + + +`incgraph` provides tools for including graphics on full paper size. The graphics +can be centered for a given paper format or the paper may be resized to the +graphics dimensions. The main use case for the package `incgraph` is to transform +one or many scans or taken pictures to a PDF document. It can also be applied +for full paper size *LaTeX* created graphics. The package `incgraph` provides a tool +box with basic macros and a convenience user interface which wraps the +well-known `includegraphics`. Also, bookmarking is especially supported. + + +## Contents of the package + +- `README.md` this file +- `CHANGES.md` log of changes (history) +- `incgraph.sty` LaTeX package file (style file) +- `incgraph.pdf` documentation for csvsimple +- `incgraph.tex` source code of the documentation +- `incgraph-doc.sty` style file of the documentation +- `incgraph-example-a.tex` example file A for package usage +- `incgraph-example-a.pdf` compiled example A +- `incgraph-example-b.tex` example file B for package usage +- `incgraph-example-b.pdf` compiled example B +- `incgraph-example-c.tex` example file C for package usage +- `incgraph-example-c.pdf` compiled example C +- `example.jpg` example image file +- `exaimage-0001.png` example image file +- `exaimage-0037.png` example image file +- `exaimage-0123.png` example image file + + +## Installation + +Copy the contents of the `incgraph.tds.zip` from CTAN to your local TeX file tree. + +Alternatively, put the files to their respective locations within the TeX installation: + +- `incgraph.sty` -> /tex/latex/incgraph +- all other files -> /doc/latex/incgraph diff --git a/macros/latex/contrib/incgraph/incgraph-doc.sty b/macros/latex/contrib/incgraph/incgraph-doc.sty new file mode 100644 index 0000000000..efa2c71447 --- /dev/null +++ b/macros/latex/contrib/incgraph/incgraph-doc.sty @@ -0,0 +1,140 @@ +% \LaTeX-Main\ +% !TeX encoding=UTF-8 +%% The LaTeX package incgraph - version 1.2.0 (2021/10/20) +%% incgraph.tex: Manual +%% +%% ------------------------------------------------------------------------------------------- +%% Copyright (c) 2012-2021 by Prof. Dr. Dr. Thomas F. Sturm +%% ------------------------------------------------------------------------------------------- +%% +%% 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 `author-maintained'. +%% +%% This work consists of all files listed in README +%% +\def\version{1.2.0}% +\def\datum{2021/10/20}% + +\IfFileExists{incgraph-doc.cfg}{\input{incgraph-doc.cfg}}{}\providecommand\igrpkgprefix{} + +\RequirePackage[T1]{fontenc} +\RequirePackage[english]{babel} +\RequirePackage{lmodern,parskip,array,makeidx} +\RequirePackage{amsmath,amssymb} +\RequirePackage[svgnames,table,hyperref]{xcolor} +\RequirePackage{tikz} + +\RequirePackage[bookmarks,raiselinks,pageanchor,hyperindex,colorlinks]{hyperref} +\urlstyle{sf} +\RequirePackage{cleveref} + +\RequirePackage[a4paper,left=2.5cm,right=2.5cm,top=1.5cm,bottom=1.5cm, + marginparsep=3mm,marginparwidth=18mm, + headheight=0mm,headsep=0cm, + footskip=1.5cm,includeheadfoot]{geometry} +\RequirePackage{fancyhdr} +\fancyhf{} +\fancyfoot[C]{\thepage}% +\renewcommand{\headrulewidth}{0pt} +\renewcommand{\footrulewidth}{0pt} +\pagestyle{fancy} +\tolerance=2000% +\setlength{\emergencystretch}{20pt}% + +\RequirePackage[many,minted,documentation]{tcolorbox} +\RequirePackage{csquotes} +\RequirePackage[style=numeric-comp,sorting=nyt, + maxnames=8,minnames=8,abbreviate=false,backend=biber]{biblatex} +\DeclareFieldFormat{url}{\newline\url{#1}}% +\DeclareListFormat{language}{}% +\setlength{\bibitemsep}{\smallskipamount} +\addbibresource{\jobname.bib} + +\tcbset{skin=enhanced, + doc head={colback=yellow!10!white,interior style=fill}, + doc head key={colback=magenta!5!white,interior style=fill}, + color key=DarkViolet, + color value=Teal, + color color=Teal, + color counter=Orange!85!black, + color length=Orange!85!black, + index colorize, + index annotate, + beforeafter example/.style={ + before skip=4pt plus 2pt minus 1pt, + after skip=8pt plus 4pt minus 2pt + }, +} +\renewcommand*{\tcbdocnew}[1]{\textcolor{green!50!black}{\sffamily\bfseries N} #1} +\renewcommand*{\tcbdocupdated}[1]{\textcolor{blue!75!black}{\sffamily\bfseries U} #1} + +\RequirePackage{\igrpkgprefix incgraph} + +\hypersetup{ + pdftitle={Manual for the incgraph package}, + pdfauthor={Thomas F. Sturm}, + pdfsubject={graphics inclusion}, + pdfkeywords={graphics inclusion page} +} + +\RequirePackage{tikz,multicol} + +\tcbset{ + docexample/.style={bicolor, + beforeafter example, + fonttitle=\bfseries, + fontlower=\footnotesize, + colframe=Navy!50!ExampleFrame, + colback=Navy!5!ExampleBack!50!white, + colbacklower=ExampleBack!5!white, + drop fuzzy shadow, + listing engine=minted, + documentation minted style=colorful, + documentation minted options={fontsize=\footnotesize}, + }, + example/.style={ + docexample, + listing only, + before title={\hypersetup{linkcolor=white}}, + }, +} + +\tcbmakedocSubKey{docIgrKey}{igr} +\tcbmakedocSubKeys{docIgrKeys}{igr} + +\newcounter{texexp} + +\newtcblisting[use counter=texexp]{texexptitled}[3][]{% + example, + title={Example~\thetcbcounter: #2}, + listing file={\jobname.\thetcbcounter.listing}, + label={#3},#1 +} + +\newtcbinputlisting[use counter from=texexptitled]{\inputexamplelisting}[3][]{ + example, + title={Example~\thetcbcounter: \texttt{#2}}, + listing file={#2}, + label={#3},#1 +} + +\newcommand{\inputlisting}[1]{\input{\jobname.#1.listing}} +\newcommand{\inputlastlisting}{\inputlisting{\thetexexp}} + +\def\tikzname{Ti\emph{k}Z} + +\makeindex + +\ExplSyntaxOn +\sys_if_engine_pdftex:T + { + \pdfsuppresswarningpagegroup=1 + } +\ExplSyntaxOff diff --git a/macros/latex/contrib/incgraph/incgraph-example-a.pdf b/macros/latex/contrib/incgraph/incgraph-example-a.pdf index cc78605606..1e5b76d304 100644 Binary files a/macros/latex/contrib/incgraph/incgraph-example-a.pdf and b/macros/latex/contrib/incgraph/incgraph-example-a.pdf differ diff --git a/macros/latex/contrib/incgraph/incgraph-example-b.pdf b/macros/latex/contrib/incgraph/incgraph-example-b.pdf index 9934a81f58..9ee06ea60d 100644 Binary files a/macros/latex/contrib/incgraph/incgraph-example-b.pdf and b/macros/latex/contrib/incgraph/incgraph-example-b.pdf differ diff --git a/macros/latex/contrib/incgraph/incgraph-example-c.pdf b/macros/latex/contrib/incgraph/incgraph-example-c.pdf index 7609eccc31..67ca683b62 100644 Binary files a/macros/latex/contrib/incgraph/incgraph-example-c.pdf and b/macros/latex/contrib/incgraph/incgraph-example-c.pdf differ diff --git a/macros/latex/contrib/incgraph/incgraph.pdf b/macros/latex/contrib/incgraph/incgraph.pdf index 4cbee4db69..1dd52b2d1d 100644 Binary files a/macros/latex/contrib/incgraph/incgraph.pdf and b/macros/latex/contrib/incgraph/incgraph.pdf differ diff --git a/macros/latex/contrib/incgraph/incgraph.sty b/macros/latex/contrib/incgraph/incgraph.sty index 09bde04275..43a2aac9a3 100644 --- a/macros/latex/contrib/incgraph/incgraph.sty +++ b/macros/latex/contrib/incgraph/incgraph.sty @@ -1,8 +1,8 @@ -%% The LaTeX package incgraph - version 1.12 (2015/03/12) +%% The LaTeX package incgraph - version 1.2.0 (2021/10/20) %% incgraph.sty: Graphics inclusion page %% %% ------------------------------------------------------------------------------------------- -%% Copyright (c) 2012-2015 by Prof. Dr. Dr. Thomas F. Sturm +%% Copyright (c) 2012-2021 by Prof. Dr. Dr. Thomas F. Sturm %% ------------------------------------------------------------------------------------------- %% %% This work may be distributed and/or modified under the @@ -18,7 +18,7 @@ %% This work consists of all files listed in README %% \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{incgraph}[2015/03/12 version 1.12 LaTeX special graphics inclusion] +\ProvidesPackage{incgraph}[2021/10/20 version 1.2.0 LaTeX special graphics inclusion] \DeclareOption{pgf}{\def\igrreq@pgf{\RequirePackage{pgf}[2008/01/15]\RequirePackage{pgffor}}}% \DeclareOption{nopgf}{\def\igrreq@pgf{}}% @@ -44,9 +44,82 @@ \newdimen\igr@length \newcounter{igrtarget} +\ExplSyntaxOn + +\sys_if_engine_pdftex:TF + { + \NewDocumentCommand \igrGetPageSize {} + { + \cs_gset_nopar:Npx \igrPageWidth { \the\pdfpagewidth } + \cs_gset_nopar:Npx \igrPageHeight { \the\pdfpageheight } + } + \NewDocumentCommand \igrSetPageSize { m m } + { + \pdfpagewidth #1 + \pdfpageheight #2 + } + \NewDocumentCommand \igrGetLastPage { m } + { + \pdfximage{#1} + \cs_gset_nopar:Npx \igrLastPage { \the\pdflastximagepages } + } + } + { + \sys_if_engine_luatex:TF + { + \NewDocumentCommand \igrGetPageSize {} + { + \cs_gset_nopar:Npx \igrPageWidth { \the\pagewidth } + \cs_gset_nopar:Npx \igrPageHeight { \the\pageheight } + } + \NewDocumentCommand \igrSetPageSize { m m } + { + \pagewidth #1 + \pageheight #2 + } + \NewDocumentCommand \igrGetLastPage { m } + { + \saveimageresource{#1} + \cs_gset_nopar:Npx \igrLastPage { \the\lastsavedimageresourcepages } + } + } + { + \cs_if_exist:NTF \pdfpagewidth + { + \NewDocumentCommand \igrGetPageSize {} + { + \cs_gset_nopar:Npx \igrPageWidth { \the\pdfpagewidth } + \cs_gset_nopar:Npx \igrPageHeight { \the\pdfpageheight } + } + \NewDocumentCommand \igrSetPageSize { m m } + { + \pdfpagewidth #1 + \pdfpageheight #2 + } + } + { + \NewDocumentCommand \igrGetPageSize {} + { + \cs_gset_nopar:Npx \igrPageWidth { \the\paperwidth } + \cs_gset_nopar:Npx \igrPageHeight { \the\paperheight } + } + \NewDocumentCommand \igrSetPageSize { m m } + { + } + } + \NewDocumentCommand \igrGetLastPage { m } + { + \cs_gset_nopar:Npx \igrLastPage { 1 } + } + } + } + +\ExplSyntaxOff + \AtBeginDocument{% - \edef\igrOrginalPageWidth{\the\pdfpagewidth}% - \edef\igrOrginalPageHeight{\the\pdfpageheight}% + \igrGetPageSize% + \let\igrOrginalPageWidth\igrPageWidth% + \let\igrOrginalPageHeight\igrPageHeight% } \def\igr@target@auto{% @@ -60,7 +133,7 @@ \let\igr@target@next=\igr@target@auto -\def\igrtargetset#1{% +\NewDocumentCommand\igrtargetset{m}{% \def\igr@usertarget{#1}% \let\igr@target@next=\igr@target@user% } @@ -100,10 +173,7 @@ \fi% } -\long\def\igrboxset#1{% - \igr@nextAutoTarget% - \setbox\igrbox\color@hbox#1\color@endbox% - \igr@rebox% +\def\igr@get@box@dimensions{% \igr@length=\wd\igrbox% \edef\igrBoxWidth{\the\igr@length}% \igr@length=\ht\igrbox% @@ -114,11 +184,18 @@ \edef\igrBoxHeight{\the\igr@length}% } +\NewDocumentCommand\igrboxset{+m}{% + \igr@nextAutoTarget% + \setbox\igrbox\color@hbox#1\color@endbox% + \igr@rebox% + \igr@get@box@dimensions% +} + \def\igr@hyper{\hypertarget{\igrAutoTarget}{}} -\def\igr@empty{} -\def\igrboxcenter{% +\NewDocumentCommand\igrboxcenter{}{% + \igrGetPageSize% \thispagestyle{\igrpagestyle}% % \igr@length=-1in% @@ -128,7 +205,7 @@ \advance\igr@length by -\headsep% \edef\igr@offy@top{\the\igr@length}% % - \igr@length=\pdfpageheight% + \igr@length=\igrPageHeight% \advance\igr@length by -\igrBoxHeight% \divide\igr@length by 2% \edef\igr@offy@abs{\the\igr@length}% @@ -146,7 +223,7 @@ \fi% \edef\igr@offx@left{\the\igr@length}% % - \igr@length=\pdfpagewidth% + \igr@length=\igrPageWidth% \advance\igr@length by -\igrBoxWidth% \divide\igr@length by 2% \advance\igr@length by \igr@offx@left% @@ -160,7 +237,7 @@ \break% } -\def\igrboxtikz{% +\NewDocumentCommand\igrboxtikz{}{% \path[use as bounding box] (0,0) rectangle (\igrBoxWidth,\igrBoxHeight); \node[line width=0mm,inner sep=0,rectangle,above right] (box) at (0,0) {\box\igrbox}; \node[minimum width=\igrBoxWidth,minimum height=\igrBoxHeight,line width=0mm,inner sep=0mm,above right] (page) at (0,0) {};% @@ -168,11 +245,12 @@ \let\igrboxtikzpage=\igrboxtikz -\def\igrboxtikzcenter{% - \path[use as bounding box] (0,0) rectangle (\pdfpagewidth,\pdfpageheight); - \node[line width=0mm,inner sep=0,rectangle,above right] (box) at ({(\pdfpagewidth-\igrBoxWidth)/2},{(\pdfpageheight-\igrBoxHeight)/2}) {\box\igrbox}; - \edef\igrBoxWidth{\the\pdfpagewidth}% - \edef\igrBoxHeight{\the\pdfpageheight}% +\NewDocumentCommand\igrboxtikzcenter{}{% + \igrGetPageSize% + \path[use as bounding box] (0,0) rectangle (\igrPageWidth,\igrPageHeight); + \node[line width=0mm,inner sep=0,rectangle,above right] (box) at ({(\igrPageWidth-\igrBoxWidth)/2},{(\igrPageHeight-\igrBoxHeight)/2}) {\box\igrbox}; + \let\igrBoxWidth\igrPageWidth% + \let\igrBoxHeight\igrPageHeight% \node[minimum width=\igrBoxWidth,minimum height=\igrBoxHeight,line width=0mm,inner sep=0mm,above right] (page) at (0,0) {};% } @@ -186,16 +264,15 @@ % Output macros \def\igr@out@resize#1#2{% - \edef\igrCurrentPageWidth{\the\pdfpagewidth}% - \edef\igrCurrentPageHeight{\the\pdfpageheight}% + \igrGetPageSize% + \let\igrCurrentPageWidth\igrPageWidth% + \let\igrCurrentPageHeight\igrPageHeight% \eject% - \pdfpagewidth=#1% - \pdfpageheight=#2% + \igrSetPageSize{#1}{#2}% \igr@overlay% \edef\theigrpage{\thepage}% \igrboxcenter% - \pdfpagewidth=\igrCurrentPageWidth% - \pdfpageheight=\igrCurrentPageHeight% + \igrSetPageSize{\igrCurrentPageWidth}{\igrCurrentPageHeight}% } \def\igr@out@center@fit@port{% @@ -222,7 +299,9 @@ } \def\igr@out@center@land{% - \edef\igr@temp@w{\the\pdfpagewidth}\edef\igr@temp@h{\the\pdfpageheight}% + \igrGetPageSize% + \let\igr@temp@w\igrPageWidth% + \let\igr@temp@h\igrPageHeight% \igr@out@resize{\igr@temp@h}{\igr@temp@w}% } @@ -232,17 +311,17 @@ % Toolbox output -\long\def\igrcenterfit#1#2#3{% +\NewDocumentCommand\igrcenterfit{mm+m}{% \igrboxset{#3}% \igr@out@resize{#1}{#2}% } -\long\def\igrpage#1{% +\NewDocumentCommand\igrpage{+m}{% \igrboxset{#1}% \igr@out@page% } -\long\def\igrcenter#1{% +\NewDocumentCommand\igrcenter{+m}{% \igrboxset{#1}% \igr@out@center@port% } @@ -250,85 +329,245 @@ % include macros -\def\incgraph{% - \@ifnextchar[{\inc@graph}{\inc@graph[]}} - -\def\inc@graph[#1]{% - \@ifnextchar[{\inc@@graph[#1]}{\inc@@graph[#1][]}} - -\long\def\inc@@graph[#1][#2]#3{% - \begingroup% - \def\nt{#3}% - \igr@if@file@exists{\nt}{% - \igrset{#1}% - \igr@match@hook% - \edef\igr@incgraph{\noexpand\igr@include@graphics[\igr@options,#2]}% - \igrboxset{\igr@incgraph{\nt}\ifx\igr@label@text\igr@empty\else\label{\igr@label@text}\fi}% - \igr@output% - \ifx\igr@bookmark@text\igr@empty\else% - \edef\igr@bookmark{\noexpand\bookmark[\igr@bookmark@options,dest=\noexpand\igrAutoTarget]}% - \igr@bookmark{\igr@bookmark@text}\fi% - }{}% - \endgroup% -} +\ExplSyntaxOn + + +\bool_new:N \g__incgra_first_include +\bool_new:N \g__incgra_multi_include +\clist_new:N \l__incgra_extensions_clist +\tl_new:N \l__incgra_bookmark_heading_options_tl +\tl_new:N \l__incgra_bookmark_heading_text_tl +\tl_new:N \l__incgra_bookmark_options_tl +\tl_new:N \l__incgra_bookmark_text_tl +\tl_new:N \l__incgra_label_text_tl +\tl_new:N \l__incgra_options_tl + + +\cs_new_protected_nopar:Npn \__incgra_if_file_exist_extensions:nTF #1 + { + \bool_set_false:N \l_tmpa_bool + \clist_map_inline:Nn \l__incgra_extensions_clist + { + \file_if_exist:nTF { #1 ##1 } + { + \tl_put_right:Nn \nt {##1} + \bool_set_true:N \l_tmpa_bool + \clist_map_break: + } + } + \bool_if:NTF \l_tmpa_bool + } + + +\cs_new_protected_nopar:Npn \__incgra_if_file_exist_extensions_star:nTF #1#2#3 + { + \file_if_exist:nTF { #1 } + { + #2 + } + { + \__incgra_if_file_exist_extensions:nTF {#1}{#2}{#3} + } + } + + +\cs_new_protected_nopar:Npn \__incgra_includegraphics:nn #1#2 + { + \igr@match@hook + + \tl_set:Nn \l_tmpa_tl { \__incgra_include_graphics:w [ } + \tl_put_right:NV \l_tmpa_tl \l__incgra_options_tl + \tl_put_right:Nn \l_tmpa_tl { ,#1] } + + \bool_if:NTF \g__incgra_multi_include + { + \bool_if:NTF \g__incgra_first_include + { + \tl_if_empty:NTF \l__incgra_label_text_tl + { + \igrboxset{\l_tmpa_tl{#2}} + } + { + \igrboxset{\l_tmpa_tl{#2}\label{\l__incgra_label_text_tl}} + } + \igr@output + \tl_if_empty:NF \l__incgra_bookmark_heading_text_tl + { + \tl_set:Nn \l_tmpa_tl { \bookmark[ } + \tl_put_right:NV \l_tmpa_tl \l__incgra_bookmark_heading_options_tl + \tl_put_right:Nn \l_tmpa_tl { ,dest=\igrAutoTarget] } + \l_tmpa_tl { \l__incgra_bookmark_heading_text_tl } + } + \bool_gset_false:N \g__incgra_first_include + } + { + \igrboxset{\l_tmpa_tl{#2}} + \igr@output + } + } + { + \tl_if_empty:NTF \l__incgra_label_text_tl + { + \igrboxset{\l_tmpa_tl{#2}} + } + { + \igrboxset{\l_tmpa_tl{#2} + \label{\l__incgra_label_text_tl}} + } + \igr@output + } + \tl_if_empty:NF \l__incgra_bookmark_text_tl + { + \tl_set:Nn \l_tmpa_tl { \bookmark[ } + \tl_put_right:NV \l_tmpa_tl \l__incgra_bookmark_options_tl + \tl_put_right:Nn \l_tmpa_tl { ,dest=\igrAutoTarget] } + \l_tmpa_tl{\l__incgra_bookmark_text_tl} + } + } + +\cs_generate_variant:Nn \__incgra_includegraphics:nn { nV } + + +\NewDocumentCommand \incgraph { +O{} O{} m } + { + \group_begin: + \igrset{#1} + \bool_gset_false:N \g__incgra_multi_include + \tl_clear_new:N \nt + \tl_set:Nn \nt {#3} + \__incgra_if_file_exist:nTF{#3} + { + \__incgra_includegraphics:nV {#2} \nt + } + {} + \group_end: + } + + +\NewDocumentCommand \incmultigraph { +O{} O{} m m } + { + \group_begin: + \igrset{#1} + \bool_gset_true:N \g__incgra_multi_include + \bool_gset_true:N \g__incgra_first_include + \tl_clear_new:N \nt + \tl_clear_new:N \nn + \foreach \n [count=\ni] in {#4} + { + \tl_set:Nn \nt {#3} + \tl_set:Nx \nn {\igr@zero@fill{\n}} + \__incgra_if_file_exist:nTF{#3} + { + \__incgra_includegraphics:nV {#2} \nt + } + {} + } + \group_end: + } + + +\NewDocumentEnvironment{inctext}{ +O{} } + { + \igrset{#1} + \igr@match@hook + \igr@nextAutoTarget + \clearpage + \begin{lrbox}{\igrbox} + } + { + \unskip + \tl_if_empty:NF \l__incgra_label_text_tl + { + \label{\l__incgra_label_text_tl} + } + \end{lrbox} + \igr@rebox + \igr@get@box@dimensions + \igr@output + \tl_if_empty:NF \l__incgra_bookmark_text_tl + { + \tl_set:Nn \l_tmpa_tl { \bookmark[ } + \tl_put_right:NV \l_tmpa_tl \l__incgra_bookmark_options_tl + \tl_put_right:Nn \l_tmpa_tl { ,dest=\igrAutoTarget] } + \l_tmpa_tl { \l__incgra_bookmark_text_tl } + } + } + + +\igrset + { + include~command/.code = + { + \cs_set_eq:NN \__incgra_include_graphics:w #1 + }, + include~command/.default = \includegraphics, + extensions/.code = + { + \clist_set:Nn \l__incgra_extensions_clist {#1} + }, + extensions~add/.code = + { + \clist_put_right:Nn \l__incgra_extensions_clist {#1} + }, + extensions~from~graphics/.code= + { + \cs_if_exist:NT \Gin@extensions + { + \clist_set:NV \l__incgra_extensions_clist \Gin@extensions + } + }, + existence~check/.code = + { + \cs_set_eq:NN \__incgra_if_file_exist:nTF #1 + }, + ignore~on~not~found/.style = + { + existence~check = \file_if_exist:nTF + }, + ignore~on~not~found~with~extensions/.code = + { + \cs_set_eq:NN \__incgra_if_file_exist:nTF \__incgra_if_file_exist_extensions:nTF + \quark_if_nil:NF { #1 } + { + \clist_set:Nn \l__incgra_extensions_clist {#1} + } + }, + ignore~on~not~found~with~extensions/.default = \q_nil, + ignore~on~not~found~with~extensions*/.code = + { + \cs_set_eq:NN \__incgra_if_file_exist:nTF \__incgra_if_file_exist_extensions_star:nTF + \quark_if_nil:NF { #1 } + { + \clist_set:Nn \l__incgra_extensions_clist {#1} + } + }, + ignore~on~not~found~with~extensions*/.default = \q_nil, + no~existence~check/.style = + { + existence~check = \use_ii:nnn + }, + fail~on~not~found/.style = no~existence~check, + options/.store~in = \l__incgra_options_tl, + options~add/.code = + { + \tl_if_empty:NTF \l__incgra_options_tl + { + \tl_set:Nn \l__incgra_options_tl { #1 } + } + { + \tl_put_right:Nn \l__incgra_options_tl { ,#1 } + } + }, + bookmark/.store~in = \l__incgra_bookmark_text_tl, + bookmark~options/.store~in = \l__incgra_bookmark_options_tl, + bookmark~heading/.store~in = \l__incgra_bookmark_heading_text_tl, + bookmark~heading~options/.store~in = \l__incgra_bookmark_heading_options_tl, + label/.store~in = \l__incgra_label_text_tl, + } + +\ExplSyntaxOff -\def\igr@bookmark@heading{% - \global\let\igr@process@label=\igr@empty% - \ifx\igr@bookmark@heading@text\igr@empty\else% - \edef\igr@bookmark{\noexpand\bookmark[\igr@bookmark@heading@options,dest=\noexpand\igrAutoTarget]}% - \igr@bookmark{\igr@bookmark@heading@text}\fi% - \global\let\igr@process@bookmark@heading=\igr@empty% -} -\def\incmultigraph{% - \@ifnextchar[{\inc@multigraph}{\inc@multigraph[]}} - -\def\inc@multigraph[#1]{% - \@ifnextchar[{\inc@@multigraph[#1]}{\inc@@multigraph[#1][]}} - -\long\def\inc@@multigraph[#1][#2]#3#4{% - \begingroup% - \igrset{#1}% - \ifx\igr@label@text\igr@empty\global\let\igr@process@label=\igr@empty\else% - \global\def\igr@process@label{\label{\igr@label@text}}\fi% - \global\let\igr@process@bookmark@heading=\igr@bookmark@heading% - \foreach \n [count=\ni] in {#4} {% - \edef\nn{\igr@zero@fill{\n}}% - \def\nt{#3}% - \igr@if@file@exists{\nt}{% - \igr@match@hook% - \edef\igr@incgraph{\noexpand\igr@include@graphics[\igr@options,#2]}% - \igrboxset{\igr@incgraph{\nt}\igr@process@label}% - \igr@output% - \igr@process@bookmark@heading% - \ifx\igr@bookmark@text\igr@empty\else% - \edef\igr@bookmark{\noexpand\bookmark[\igr@bookmark@options,dest=\noexpand\igrAutoTarget]}% - \igr@bookmark{\igr@bookmark@text}\fi% - }{}}\endgroup% -} - - -\newenvironment{inctext}[1][]{% - \igrset{#1}% - \igr@match@hook% - \igr@nextAutoTarget% - \clearpage\begin{lrbox}{\igrbox}% -}{% - \unskip\ifx\igr@label@text\igr@empty\else\label{\igr@label@text}\fi\end{lrbox}% - \igr@rebox% - \igr@length=\wd\igrbox% - \edef\igrBoxWidth{\the\igr@length}% - \igr@length=\ht\igrbox% - \edef\igrBoxht{\the\igr@length}% - \igr@length=\dp\igrbox% - \edef\igrBoxdp{\the\igr@length}% - \advance\igr@length by \igrBoxht% - \edef\igrBoxHeight{\the\igr@length}% - \igr@output% - \ifx\igr@bookmark@text\igr@empty\else% - \edef\igr@bookmark{\noexpand\bookmark[\igr@bookmark@options,dest=\noexpand\igrAutoTarget]}% - \igr@bookmark{\igr@bookmark@text}\fi% -} \def\igr@make@zerofill#1#2#3#4#5#6#7#8#9{% @@ -347,7 +586,7 @@ }% } -\def\igrmakezerofill#1#2{% +\NewDocumentCommand\igrmakezerofill{mm}{% \def\igr@zerofill##1{##1}% \ifcase#2\or\or\igr@make@zerofill{0}{}{}{}{}{}{}{}{}% \or\igr@make@zerofill{00}{0}{}{}{}{}{}{}{}% @@ -362,11 +601,11 @@ \let#1=\igr@zerofill% } -\newcommand{\igrsetmatchvalue}[2]{% +\NewDocumentCommand\igrsetmatchvalue{mm}{% \pgfkeyssetvalue{/igrmatch/#1}{#2}% } -\newcommand{\igrifmatch}[3]{% +\NewExpandableDocumentCommand\igrifmatch{mmm}{% \pgfkeysifdefined{/igrmatch/#1}{% \pgfkeysgetvalue{/igrmatch/#1}{\igrmatchvalue}#2}{#3}% } @@ -378,41 +617,26 @@ }% } -\newcommand{\igrsetmatches}[1]{\pgfkeys{/igrsetmatch/.cd,#1}} - -\newcommand{\igr@no@existence@check}[3]{#2} +\NewDocumentCommand\igrsetmatches{m}{\pgfkeys{/igrsetmatch/.cd,#1}} \igrset{% - options/.store in=\igr@options, - options add/.code={% - \toks0=\expandafter{\igr@options}% - \def\temp{#1}\toks1=\expandafter{\temp}% - \edef\igr@options{\the\toks0,\the\toks1}}, - bookmark/.store in=\igr@bookmark@text, - bookmark options/.store in=\igr@bookmark@options, - bookmark heading/.store in=\igr@bookmark@heading@text, - bookmark heading options/.store in=\igr@bookmark@heading@options, - label/.store in=\igr@label@text, zerofill/.code={\igrmakezerofill{\igr@zero@fill}{#1}}, set matches/.code=\igrsetmatches{#1}, hyper/.code={\let\igr@hypertarget=\igr@hyper}, - no hyper/.code={\let\igr@hypertarget=\igr@empty}, + no hyper/.code={\def\igr@hypertarget{}}, if match code/.code args={#1#2#3}{\def\igr@match@hook{\igrifmatch{#1}{#2}{#3}}}, if match set/.style args={#1#2#3}{if match code={#1}{\igrset{#2}}{\igrset{#3}}}, if match set bookmark/.style args={#1#2#3}{if match code={#1}{\igrset{bookmark={#2}}}{\igrset{bookmark={#3}}}}, - disable match/.code={\let\igr@match@hook=\igr@empty}, - include command/.code={\let\igr@include@graphics=#1}, - include command/.default=\includegraphics, - existence check/.code={\let\igr@if@file@exists=#1}, - fail on not found/.style={existence check=\igr@no@existence@check}, - ignore on not found/.style={existence check=\IfFileExists}, + disable match/.code={\def\igr@match@hook{}}, pagestyle/.store in=\igrpagestyle, target/.code={\igrtargetset{#1}}, overlay@code/.store in=\igr@tikz@hook, overlay/.code={\let\igr@overlay=\igr@overlay@on\igrset{overlay@code={#1}}}, - overlay page number at/.style={overlay={\node[fill opacity=0.35,draw opacity=0.5,text opacity=1, - inner xsep=1em,rounded corners,fill=white,draw=black] at (#1) {\thepage};}}, + overlay page number options/.store in=\igr@overlay@pagenumber@options, + overlay page number at/.style={overlay={% + \expandafter\node\expandafter[\igr@overlay@pagenumber@options] + at (#1) {\thepage};}}, overlay page number at top/.style={overlay page number at={\igrBoxWidth/2,\igrBoxHeight-#1}}, overlay page number at top/.default=1.5cm, overlay page number at bottom/.style={overlay page number at={\igrBoxWidth/2,#1}}, @@ -492,11 +716,13 @@ disable match, include command, ignore on not found, + extensions={.jpg,.png}, pagestyle=empty, overlay@code=, no overlay, portrait, border=0pt, + overlay page number options={fill opacity=0.35,draw opacity=0.5,text opacity=1, + inner xsep=1em,rounded corners,fill=white,draw=black}, } - diff --git a/macros/latex/contrib/incgraph/incgraph.tex b/macros/latex/contrib/incgraph/incgraph.tex index 7425a75ab2..1b739cfaf8 100644 --- a/macros/latex/contrib/incgraph/incgraph.tex +++ b/macros/latex/contrib/incgraph/incgraph.tex @@ -1,9 +1,10 @@ % \LaTeX-Main\ -%% The LaTeX package incgraph - version 1.12 (2015/03/12) +% !TeX encoding=UTF-8 +%% The LaTeX package incgraph - version 1.2.0 (2021/10/20) %% incgraph.tex: Manual %% %% ------------------------------------------------------------------------------------------- -%% Copyright (c) 2012-2013 by Prof. Dr. Dr. Thomas F. Sturm +%% Copyright (c) 2012-2021 by Prof. Dr. Dr. Thomas F. Sturm %% ------------------------------------------------------------------------------------------- %% %% This work may be distributed and/or modified under the @@ -20,111 +21,7 @@ %% \documentclass[a4paper,11pt]{ltxdoc} -\usepackage[T1]{fontenc} -\usepackage[latin1]{inputenc} -\usepackage[english]{babel} -\usepackage{lmodern,parskip,array,ifthen,calc,makeidx} -\usepackage{amsmath,amssymb} -\usepackage[svgnames,table,hyperref]{xcolor} -\usepackage{tikz} -\usepackage[pdftex,bookmarks,raiselinks,pageanchor,hyperindex,colorlinks]{hyperref} -\urlstyle{sf} - -\usepackage[a4paper,left=2.5cm,right=2.5cm,top=1.5cm,bottom=1.5cm, - marginparsep=3mm,marginparwidth=18mm, - headheight=0mm,headsep=0cm, - footskip=1.5cm,includeheadfoot]{geometry} -\usepackage{fancyhdr} -\fancyhf{} -\fancyfoot[C]{\thepage}% -\renewcommand{\headrulewidth}{0pt} -\renewcommand{\footrulewidth}{0pt} -\pagestyle{fancy} -\tolerance=2000% -\setlength{\emergencystretch}{20pt}% - -\RequirePackage{csquotes} -\RequirePackage[style=numeric-comp,sorting=nyt, - maxnames=8,minnames=8,abbreviate=false,backend=biber]{biblatex} -\DeclareFieldFormat{url}{\newline\url{#1}}% -\DeclareListFormat{language}{}% -\setlength{\bibitemsep}{\smallskipamount} -\addbibresource{\jobname.bib} - -\usepackage[many,listings,documentation]{tcolorbox} - -\tcbset{skin=enhanced, - doc head={colback=yellow!10!white,interior style=fill}, - doc head key={colback=magenta!5!white,interior style=fill}, - color key=DarkViolet, - color value=Teal, - color color=Teal, - color counter=Orange!85!black, - color length=Orange!85!black, - index colorize, - index annotate, - %external/externalizer=tcolorbox.doc.externalizer, -} -\renewcommand*{\tcbdocnew}[1]{\textcolor{green!50!black}{\sffamily\bfseries N} #1} -\renewcommand*{\tcbdocupdated}[1]{\textcolor{blue!75!black}{\sffamily\bfseries U} #1} - -\usepackage{incgraph} - -\hypersetup{ - pdftitle={Manual for the incgraph package}, - pdfauthor={Thomas F. Sturm}, - pdfsubject={graphics inclusion}, - pdfkeywords={graphics inclusion page} -} - -\usepackage{tikz,multicol} - -\lstdefinestyle{mydocumentation}{style=tcbdocumentation, - classoffset=0, - texcsstyle=\color{blue}, - % LaTeX and other packages - moretexcs={arrayrulecolor,draw,path,fill,includegraphics,ifthenelse,isodd,lipsum,path,pgfkeysalso,foreach}, - classoffset=1, - moretexcs={% - incgraph,incmultigraph,n,ni,nn,nt,igrset,igrpage,igrcenter,igrcenterfit, - igrtargetset,igrboxset,igrboxcenter,igrpagestyle,igrboxtikz,igrboxtikzpage, - igrboxtikzcenter,igrsetmatchvalue,igrsetmatches,igrifmatch,igrmakezerofill, - }, - texcsstyle=\color{Definition}\bfseries, - classoffset=2, - keywordstyle=\color{Option}\bfseries, - % option list - morekeywords={% - }, - classoffset=0% restore default - } - -\tcbset{documentation listing style=mydocumentation,% - docexample/.style={enhanced,colframe=Navy!50!ExampleFrame,colback=Navy!5!ExampleBack,fontlower=\footnotesize, - bicolor,colbacklower=ExampleBack!5!white,drop fuzzy shadow}, -} - -\tcbmakedocSubKey{docIgrKey}{igr} - -\newcounter{texexp} - -\tcbset{ - example/.code 2 args={\refstepcounter{texexp}% - \pgfkeysalso{label={#2},docexample,listing style=mydocumentation,fonttitle=\bfseries,title={Example \thetexexp: #1}}}, -} - -\newenvironment{texexptitled}[3][]{% - \hypersetup{linkcolor=white}% - \tcbset{example={#2}{#3},listing file={\jobname.\thetexexp.listing},#1}% - \tcblisting{}}{\endtcblisting} - - -\newcommand{\inputlisting}[1]{\input{\jobname.#1.listing}} -\newcommand{\inputlastlisting}{\inputlisting{\thetexexp}} - -\def\version{1.12}% -\def\datum{2015/03/12}% -\makeindex +\usepackage{incgraph-doc} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -140,7 +37,10 @@ {\large Thomas F.~Sturm% \footnote{Prof.~Dr.~Dr.~Thomas F.~Sturm, Institut f\"{u}r Mathematik und Informatik, Universit\"{a}t der Bundeswehr M\"{u}nchen, D-85577 Neubiberg, Germany; - email: \href{mailto:thomas.sturm@unibw.de}{thomas.sturm@unibw.de}} } + email: \href{mailto:thomas.sturm@unibw.de}{thomas.sturm@unibw.de}}\par\medskip +\normalsize\url{https://www.ctan.org/pkg/incgraph}\par +\url{https://github.com/T-F-S/incgraph} +} \end{center} \bigskip \begin{absquote} @@ -185,11 +85,13 @@ An important use case for the package |incgraph| is to transform one or many sca or taken pictures to a PDF document. Optionally, the included graphics can be commented with bookmarks for the resulting PDF document. -The well-known |graphicx| package \cite{carlisle:1999a} allows the inclusion +The well-known |graphicx| package \cite{carlisle:graphics} allows the inclusion of several types of external graphics files. The convenience user interface of |incgraph| described in Section \ref{sec:interface} relies on this package and adds assistance for the described purpose. Note that the package is designed for and -tested with |pdflatex| to produce PDF directly. Some features like the paper +tested with |pdflatex| to produce PDF directly. Also, the package is +intended to harmonize with |lualatex|. +Some features like the paper resizing may not be applicable for other work-flows. Many of the features of the convenience user interface can be used directly @@ -197,7 +99,7 @@ with various basic macros. These are collected and described as a 'basic tool box' in Section \ref{sec:basictoolbox}. If this package does not aid your intended purpose, you may take a look -at the |pdfpages| package \cite{matthias:2012a} which also supports the insertion of +at the |pdfpages| package \cite{matthias:pdfpages} which also supports the insertion of external multi-page PDF documents. @@ -208,10 +110,10 @@ external multi-page PDF documents. \end{dispListing} The package |incgraph| loads the package -|pgfkeys| \cite{tantau:2013a}. If no options are given, it also -loads the packages |pgf|, |pgffor| \cite{tantau:2013a}, -the package |graphicx| \cite{carlisle:1999a}, and the -package |bookmark| \cite{oberdiek:2011a}. +|pgfkeys| \cite{tantau:tikz}. If no options are given, it also +loads the packages |pgf|, |pgffor| \cite{tantau:tikz}, +the package |graphicx| \cite{carlisle:graphics}, and the +package |bookmark| \cite{oberdiek:bookmark}. \begin{itemize} \item The option |nopgf| prevents the loading of |pgf| and |pgffor|.\\ @@ -231,13 +133,13 @@ Note that you can always load the mentioned packages yourself. This is intended to avoid possible option clashes the easy way. - +\clearpage %-------------------------------------- \section{User Interface}\label{sec:interface} \subsection{Inclusion Macros for External Graphics} The macros of this section rely on the |\includegraphics| command from -the package |graphicx| \cite{carlisle:1999a}. +the package |graphicx| \cite{carlisle:graphics}. %Section \ref{sec:basictoolbox} describes more basic commands. \begin{docCommand}{incgraph}{\oarg{options}\oarg{graphics options}\marg{file name}} @@ -247,22 +149,22 @@ the package |graphicx| \cite{carlisle:1999a}. The applicable \meta{options} are listed in Section \ref{sec:keys}. If \meta{graphics options} are given, these are added to the options for the underlying |\includegraphics| command. See the documentation of - |graphicx| \cite{carlisle:1999a} for a list of applicable \meta{graphics options}. + |graphicx| \cite{carlisle:graphics} for a list of applicable \meta{graphics options}. -\begin{texexptitled}[listing only,before={\par\medskip}]% +\begin{texexptitled}% {The hand-drawn example (centered); see page~\pageref{exacenter}}{exacenter.listing} \incgraph[paper=current,label={exacenter},overlay page number at bottom, bookmark={The hand-drawn example (centered)}]{example.jpg} \end{texexptitled} -\begin{texexptitled}[listing only,before={\par\medskip}]% +\begin{texexptitled}% {The hand-drawn example (resized page); see page~\pageref{exaresized}}{exaresized.listing} \incgraph[paper=graphics,label={exaresized}, bookmark={The hand-drawn example (resized page)}]{example.jpg} \end{texexptitled} -\begin{texexptitled}[listing only,before={\par\medskip}]% +\begin{texexptitled}% {The hand-drawn example (rotated and oversized); see page~\pageref{exarotated}}{exarotated.listing} \incgraph[paper=current,label={exarotated},target=oversized, bookmark={The hand-drawn example (rotated and oversized)}]% @@ -279,8 +181,8 @@ the package |graphicx| \cite{carlisle:1999a}. The applicable \meta{options} are listed in Section \ref{sec:keys}. If \meta{graphics options} are given, these are added to the options for the underlying |\includegraphics| command. See the documentation of - |graphicx| \cite{carlisle:1999a} for a list of applicable \meta{graphics options}.\\ - The \meta{list} may contain any construction allowed for the |\foreach| statement \cite{tantau:2013a}, + |graphicx| \cite{carlisle:graphics} for a list of applicable \meta{graphics options}.\\ + The \meta{list} may contain any construction allowed for the |\foreach| statement \cite{tantau:tikz}, especially a list of numbers. The elements of the list can be used inside the \meta{file name pattern} with the following macros: @@ -297,7 +199,7 @@ the package |graphicx| \cite{carlisle:1999a}. \end{itemize} In the default behavior, non existing files are ignored. -\begin{texexptitled}[listing only,before={\par\medskip}]% +\begin{texexptitled}% {A series of pictures; see from page~\pageref{exaseries.1}. The image files exaimage-0001.png to exaimage-0150.png are included but only three of them exist.}{exaseries.listing} @@ -315,7 +217,7 @@ the package |graphicx| \cite{carlisle:1999a}. The applicable \meta{options} are listed in Section \ref{sec:keys}. -\begin{texexptitled}[listing only,before={\par\medskip}]% +\begin{texexptitled}% {Some text on a shrunk paper; see page~\pageref{inctext1}}{inctext1.listing} \begin{inctext}[paper=graphics,label={inctext1},bookmark={A huge ABC}] \Huge ABC @@ -323,7 +225,7 @@ the package |graphicx| \cite{carlisle:1999a}. \end{texexptitled} -\begin{texexptitled}[listing only,before={\par\medskip}]% +\begin{texexptitled}% {A tikzpicture as text content; see page~\pageref{inctext2}}{inctext2.listing} \begin{inctext}[paper=a6,landscape,label={inctext2},bookmark={Graph}, overlay page number at bottom=8mm] @@ -397,7 +299,7 @@ the package |graphicx| \cite{carlisle:1999a}. |b0|, |b1|, |b2|, |b3|, |b4|, |b5|, |b6|, |b7|, |b8|, |b9|, |b10|, |c0|, |c1|, |c2|, |c3|, |c4|, |c5|, |c6|, |c7|, |c8|, |c9|, |c10|, |d0|, |d1|, |d2|, |d3|, |d4|, |d5|, |d6|, |d7|, - executive, letter, legal, ledger. + |executive|, |letter|, |legal|, |ledger|. \end{docIgrKey} \begin{docIgrKey}{landscape}{}{no value} @@ -437,10 +339,10 @@ the package |graphicx| \cite{carlisle:1999a}. \subsection{Graphics Inclusion} \begin{docIgrKey}{options}{=\marg{graphics options}}{no default, initially empty} - The \meta{graphics options} are applied to the underlying |\includegraphics| command. + The \meta{graphics options} are applied to the underlying \docAuxCommand*{includegraphics} command. See the documentation of - |graphicx| \cite{carlisle:1999a} for a list of applicable \meta{graphics options}. -\begin{texexptitled}[listing only,before={\par\medskip}]% + |graphicx| \cite{carlisle:graphics} for a list of applicable \meta{graphics options}. +\begin{texexptitled}% {A resized image; see page~\pageref{exagraphresize}}{exagraphresize.listing} \igrset{options={width=10cm,height=10cm}, paper=graphics, overlay page number at top=5mm @@ -453,31 +355,116 @@ the package |graphicx| \cite{carlisle:1999a}. \begin{docIgrKey}{options add}{=\marg{graphics options}}{no default, initially empty} The \meta{graphics options} are added to the current list of options - for the underlying |\includegraphics| command. + for the underlying \docAuxCommand*{includegraphics} command. \end{docIgrKey} \begin{docIgrKey}{include command}{\colOpt{=\meta{macro}}}{default and initially \cs{includegraphics}} - Replaces the internally used \cs{includegraphics} command by the given \meta{macro}. - Note that \meta{macro} has to have the same signature as \cs{includegraphics}, + Replaces the internally used \docAuxCommand*{includegraphics} command by the given \meta{macro}. + Note that \meta{macro} has to have the same signature as \docAuxCommand*{includegraphics}, i.\,e.\ it has to take two arguments where the first argument is optional. \end{docIgrKey} \begin{docIgrKey}{existence check}{=\meta{macro}}{no default} - Replaces the internally used \cs{IfFileExists} command by the given \meta{macro}. - Note that \meta{macro} has to have the same signature as \cs{IfFileExists}, + Replaces the internally used \docAuxCommand*{IfFileExists} + (in truth \docAuxCommand*{file_if_exist:nTF}) + command by the given \meta{macro}. + Note that \meta{macro} has to have the same signature as \docAuxCommand*{IfFileExists}, i.\,e.\ it has to take three arguments. \end{docIgrKey} -\begin{docIgrKey}{fail on not found}{}{no value} - Stops the compilation with an error if the included file does not exist. -\end{docIgrKey} +\begin{docIgrKeys}[ + doc parameter = {}, + doc description = {no value} + ] + { + { + doc name = no existence check, + doc new = 2021-10-16, + }, + { + doc name = fail on not found, + }, + } + Omits any existence checks by the package, i.e. the underlying + \docAuxCommand*{includegraphics} is called directly any may + stop the compilation with an error if the included file does not exist. + Both options are equal, but the newer \refKey{/igr/no existence check} + is considered to be more comprehensible. +\end{docIgrKeys} \begin{docIgrKey}{ignore on not found}{}{no value, initially set} - Not existing included files are ignored without warning. + Not existing included files are ignored without warning. This is the default + setting and is intended to be used with fragmentary file lists. +\end{docIgrKey} + +\clearpage + +\begin{docIgrKeys}[ + doc parameter = \colOpt{=\marg{extension list}}, + doc description = {initially unset}, + doc new = 2021-10-16, + ] + { + { + doc name = ignore on not found with extensions, + }, + { + doc name = ignore on not found with extensions*, + }, + } + Tests, if the included file with an added \emph{extension} exists and + performs the inclusion on existence. Otherwise, included files are ignored without warning. + Tested \emph{extensions} are taken from the optional comma separated \meta{extension list} + or (exclusively) from the configured list from \refKey{/igr/extensions} and friends + (only, if \meta{extension list} is not given).\par + \refKey{/igr/ignore on not found with extensions*} also tests, if the included + file without added \emph{extension} exists and takes it on existence.\par + Note that if a file is included with a given extension, this extension is not + replaced by the listed extension, but prolonged with it.\par + These options are intended for mixed file lists, e.g. |.jpg| and |.png|, or + unkown type file lists. + Note that if you \emph{know} the (singular) extension of your files, you are + encouraged to use \refKey{/igr/ignore on not found} instead for performance reasons. +\begin{dispListing} +\incmultigraph[ignore on not found with extensions={.jpg,.png}]{myfile\n}{1,...,100} + % includes e.g. `myfile1.jpg`, `myfile2.png`, `myfile42.jpg`, ... +\incmultigraph[ignore on not found with extensions={.jpg,.png}]{myfile\n.xy}{1,...,100} + % includes e.g. `myfile1.xy.jpg`, `myfile2.xy.png`, `myfile42.xy.jpg`, ... +\incgraph[ignore on not found with extensions={.jpg,.png}]{myfile} + % tests `myfile.jpg` and `myfile.png` for existence (and inclusion) +\incgraph[ignore on not found with extensions*={.jpg,.png}]{myfile} + % tests `myfile`, `myfile.jpg`, and `myfile.png` for existence (and inclusion) +\incmultigraph[ignore on not found with extensions]{myfile\n}{1,...,100} + % includes files with extensions given by /igr/extensions +\end{dispListing} +\end{docIgrKeys} + + +\begin{docIgrKey}[][doc new=2021-10-16]{extensions}{=\marg{extension list}}{initially |.jpg,.png|} + Specifies a comma separated \meta{extension list} to be used in combination with + \refKey{/igr/ignore on not found with extensions}. +\end{docIgrKey} + + +\begin{docIgrKey}[][doc new=2021-10-16]{extensions add}{=\marg{extension list}}{initially unset} + Adds a comma separated \meta{extension list} to an already defined list from + \refKey{/igr/extensions}. \end{docIgrKey} +\begin{docIgrKey}[][doc new=2021-10-16]{extensions from graphics}{}{initially unset} + Takes the list of extensions from \docAuxCommand*{DeclareGraphicsExtensions} + of the |graphics| \cite{carlisle:graphics} package as setup for \refKey{/igr/extensions}. + While this looks like the most comfortable options, this can significantely + increase compilation time when used for fragmentary file lists, because + every non-existing file from the file list will induce a lot of existence checks. + Also note that this options uses internals from |graphics| and is not + guaranteed to work with future versions of |graphics|. +\end{docIgrKey} + + +\clearpage \subsection{Hypertargets, Labels, and Bookmarks} \begin{docIgrKey}{hyper}{}{no value, initially set} @@ -515,8 +502,8 @@ see page~\pageref{exarotated.listing}. \begin{docIgrKey}{bookmark options}{=\marg{bookmark options}}{no default, initially empty} Sets the options for a bookmark. See the documentation of - |bookmark| \cite{oberdiek:2011a} for a list of applicable \meta{bookmark options}. -\begin{texexptitled}[listing only,before={\par\medskip}]% + |bookmark| \cite{oberdiek:bookmark} for a list of applicable \meta{bookmark options}. +\begin{texexptitled}% {Bookmark options; see page~\pageref{exabookmark}}{exabookmark.listing} % not every PDF reader will show the effect! \igrset{bookmark options={bold,color={red}},currentpaper} @@ -528,7 +515,7 @@ see page~\pageref{exarotated.listing}. \begin{docIgrKey}{bookmark heading}{=\meta{text}}{no default, initially empty} For \refCom{incmultigraph}, an additional bookmark with the given \meta{text} is set as a heading before the images are included. -\begin{texexptitled}[listing only,before={\par\medskip}]% +\begin{texexptitled}% {A series of pictures; see from page~\pageref{exaheading.1}}{exaheading.listing} \incmultigraph[zerofill=4,currentpaper, bookmark heading={A series of pictures}, @@ -542,7 +529,7 @@ see page~\pageref{exarotated.listing}. \begin{docIgrKey}{bookmark heading options}{=\marg{bookmark options}}{no default, initially empty} Sets the options for a \refKey{/igr/bookmark heading}. See the documentation of - |bookmark| \cite{oberdiek:2011a} for a list of applicable \meta{bookmark options}. + |bookmark| \cite{oberdiek:bookmark} for a list of applicable \meta{bookmark options}. \end{docIgrKey} \clearpage @@ -593,15 +580,15 @@ Adds a space of \meta{length} at all four sides. \refKey{/igr/if match set}, and \refKey{/igr/if match set bookmark}. -\begin{tcblisting}{docexample,listing only} +\begin{dispListing} \igrset{set matches={ foo = bar, 1 = A very red image, 37 = A not so centered number, 123 = A greenish example}} -\end{tcblisting} +\end{dispListing} \end{docIgrKey} -\tcbuselistingtext +\tcbusetemp \begin{docIgrKey}{if match code}{=\marg{key}\marg{then}\marg{else}}{no default} If the \meta{key} was defined by \refKey{/igr/set matches}, @@ -626,7 +613,7 @@ Adds a space of \meta{length} at all four sides. the corresponding value is put in the macro |\igrmatchvalue| and the current PDF bookmark is set to \meta{then}. If the \meta{key} is unknown, the current PDF bookmark is set to \meta{else}. -\begin{texexptitled}[listing only,before={\par\medskip}]% +\begin{texexptitled}% {Map and match example; see from page~\pageref{examatch.1}}{examatch.listing} \incmultigraph[zerofill=4,paper=graphics, bookmark heading={Map and match example}, @@ -651,12 +638,12 @@ Adds a space of \meta{length} at all four sides. \begin{docIgrKey}{overlay}{=\marg{tikz code}}{no default, initially unset} Introduces arbitrary \meta{tikz code} to be drawn over the included image. - Note that the |tikz| package \cite{tantau:2013a} has to be loaded separately. + Note that the \tikzname\ package \cite{tantau:tikz} has to be loaded separately. To support positioning inside the picture, two |tikz| nodes named |box| and |page| are defined. |box| takes the dimensions of the included image and |page| takes the dimensions of the image or of the page depending on the usage of \refKey{/igr/paper}. -\begin{texexptitled}[listing only,before={\par\medskip}]% +\begin{texexptitled}% {Overlay; see page~\pageref{overlay}}{overlay.listing} \igrset{bookmark options={level=subsection}, paper=current} \incgraph[bookmark={Picture with overlay},label={overlay}, @@ -694,11 +681,21 @@ Adds a space of \meta{length} at all four sides. and the result on page~\pageref{exagraphresize}. \end{docIgrKey} + +\begin{docIgrKey}[][doc new=2021-10-11]{overlay page number options}{=\marg{tikz options}}{no default, initially\\ + \texttt{fill opacity=0.35,draw opacity=0.5,text opacity=1,inner xsep=1em,\\ + rounded corners,fill=white,draw=black}} + Defines the \tikzname\ node style for drawing the page number with one + of the options above, e.g. \refKey{/igr/overlay page number at} +\end{docIgrKey} + + \begin{docIgrKey}{no overlay}{}{no value, initially set} Removes the overlay setting. \end{docIgrKey} +\clearpage \subsection{Miscellaneous} @@ -742,9 +739,12 @@ Here, the images |example.jpg|, All included images are automatically bookmarked with the page number and the file name of the source image. -\def\thecurrentexample{\jobname-example-a.tex} -\tcbinputlisting{listing file=\thecurrentexample,listing only, - example={\texttt{\thecurrentexample}}{somescans}} + +\inputexamplelisting{\jobname-example-a.tex}{somescans} + +%\def\thecurrentexample{\jobname-example-a.tex} +%\tcbinputlisting{listing file=\thecurrentexample,listing only, +% example={\texttt{\thecurrentexample}}{somescans}} The compiled result of this stand-alone source code is not found in this document but as a separate file in the documentation directory of the package. @@ -769,9 +769,12 @@ The example shows a mixed usage of the macros. Note that the bookmarks of the multi-page part are matched with the numbers contained in the file names of |exaimage-0001.png| to |exaimage-0150.png|. -\def\thecurrentexample{\jobname-example-b.tex} -\tcbinputlisting{listing file=\thecurrentexample,listing only, - example={\texttt{\thecurrentexample}}{picturebook}} + +\inputexamplelisting{\jobname-example-b.tex}{picturebook} + +%\def\thecurrentexample{\jobname-example-b.tex} +%\tcbinputlisting{listing file=\thecurrentexample,listing only, +% example={\texttt{\thecurrentexample}}{picturebook}} The compiled result of this stand-alone source code is not found in this document but as a separate file in the documentation directory of the package. @@ -780,7 +783,7 @@ a separate file in the documentation directory of the package. \clearpage \subsection{Reformatting from Letter to DIN A4 (and vice versa)} In this scenario, we assume to have a PDF document with the 'wrong' paper size. -Here, |incgraph-example-a.pdf| has the letter format, but DIN A4 paper +Here, |incgraph-example-a.pdf| has the letter format, but A4 paper is needed. |incgraph| is used to reformat to the desired paper size. Of course, it also works the other way around. @@ -793,9 +796,12 @@ shrunk or enlarged easily by adding a |scale| option for the underlying |\includegraphics| macro. -\def\thecurrentexample{\jobname-example-c.tex} -\tcbinputlisting{listing file=\thecurrentexample,listing only, - example={\texttt{\thecurrentexample}}{reformatting}} +\inputexamplelisting{\jobname-example-c.tex}{reformatting} + +%\def\thecurrentexample{\jobname-example-c.tex} +%\tcbinputlisting{listing file=\thecurrentexample,listing only, +% example={\texttt{\thecurrentexample}}{reformatting}} + The compiled result of this stand-alone source code is not found in this document but as a separate file in the documentation directory of the package. @@ -817,7 +823,7 @@ In Example \ref{fullpaperdrawing1}, a |tikzpicture| is drawn. The whole picture is put inside an \refEnv{inctext} environment which puts the drawing on a separate page which gets the dimensions of the drawing. -\begin{texexptitled}[listing only]{Creation of a special text page (resized)}{fullpaperdrawing1} +\begin{texexptitled}{Creation of a special text page (resized)}{fullpaperdrawing1} \begin{inctext}[paper=graphics, bookmark=My special text page (resized)] \begin{tikzpicture}% \coordinate (A) at (0,0); \coordinate (B) at (16,16); @@ -848,7 +854,7 @@ To draw seamlessly, the document paper size of 21cm to 29.7cm is used directly inside the |tikzpicture|. -\begin{texexptitled}[listing only]{Creation of a special text page (fitted)}{fullpaperdrawing2} +\begin{texexptitled}{Creation of a special text page (fitted)}{fullpaperdrawing2} \begin{inctext}[paper=current, target=mytarget, bookmark=My special text page (fitted)] \begin{tikzpicture}% @@ -885,6 +891,59 @@ It is assumed that most users will only need the macros from the user interface described in Section \ref{sec:interface} and Section \ref{sec:keys}. +\subsection{Page Size Commands} + +The following macros are auxiliary tools which wrap corresponding length registers +from |pdflatex| and |lualatex|. + +\begin{docCommand}[doc new=2021-10-12]{igrGetPageSize}{} + Reads the current page dimensions and stores them into the macros + \refCom{igrPageWidth} and \refCom{igrPageHeight}. +\end{docCommand} + +\begin{docCommand}[doc new=2021-10-12]{igrPageWidth}{} + After using \refCom{igrGetPageSize}, \refCom{igrPageWidth} contains + the current page width. This is |\pdfpagewidth| for |pdflatex|, + |\pagewidth| for |lualatex| and a choice of |\pdfpagewidth| or |\paperwidth| + for other engines. +\end{docCommand} + +\begin{docCommand}[doc new=2021-10-12]{igrPageHeight}{} + After using \refCom{igrGetPageSize}, \refCom{igrPageHeight} contains + the current page height. This is |\pdfpageheight| for |pdflatex|, + |\pageheight| for |lualatex| and a choice of |\pdfpageheight| or |\paperheight| + for other engines. +\end{docCommand} + + +\begin{docCommand}[doc new=2021-10-12]{igrSetPageSize}{\marg{width}\marg{height}} + Sets the current page dimensions to \meta{width} and \meta{height}. + In depends on the used engine, if a call to this command has success or + not. This should work for |pdflatex| and |lualatex|. +\end{docCommand} + + +\subsection{Last Page Commands (Number of Pages)} + +The following macros are auxiliary tools which wrap corresponding functions +from |pdflatex| and |lualatex|. + +\begin{docCommand}[doc new=2021-10-18]{igrGetLastPage}{\marg{file}} + Reads the last page (page count) from the given (PDF-)\meta{file} + and stores it into the macro \refCom{igrLastPage}. +\end{docCommand} + + +\begin{docCommand}[doc new=2021-10-18]{igrLastPage}{} + After using \refCom{igrGetLastPage}, \refCom{igrLastPage} contains + the last page of the currently tested file. + This is |\pdflastximagepages| for |pdflatex|, + |\lastsavedimageresourcepages| for |lualatex| and simply $1$ + for other engines. +\end{docCommand} + + +\clearpage \subsection{Full Page Commands} \begin{docCommand}{igrpage}{\marg{text}} @@ -967,7 +1026,7 @@ user interface described in Section \ref{sec:interface} and Section \ref{sec:key \clearpage \begin{docCommand}{igrboxtikz}{} The current content of the |\igrbox| is embedded into a |\node| command - from the |tikz| package \cite{tantau:2013a} which has to be loaded separately. + from the |tikz| package \cite{tantau:tikz} which has to be loaded separately. Also, the bounding box is adjusted to the |\igrbox|.\\ To support positioning inside the picture, two |tikz| nodes named |box| and |page| are defined which both take the dimensions of the |\igrbox|. @@ -1002,7 +1061,7 @@ The boxing macros can also be used nested (see the result on the following page) \begin{docCommand}{igrboxtikzcenter}{} The current content of the |\igrbox| is embedded into a |\node| command - from the |tikz| package \cite{tantau:2013a} which has to be loaded separately. + from the |tikz| package \cite{tantau:tikz} which has to be loaded separately. This node is placed in the center of a bounding box which takes the current page dimensions. Afterwards, |\igrBoxWidth| and |\igrBoxHeight| are redefined to the dimensions of the total page.\\ @@ -1037,7 +1096,7 @@ See the result on the following page. \igrsetmatchvalue{my key A}{my value A} \def\keytester#1{\igrifmatch{#1}{Hurray: '\igrmatchvalue'}{'#1' unknown}} -\keytester{foo}\\ +\keytester{something}\\ \keytester{my key A} \end{dispExample} \end{docCommand} @@ -1050,7 +1109,7 @@ See the result on the following page. \igrsetmatches{my key A = my value A, bar = Shakespeare} \def\keytester#1{\igrifmatch{#1}{Hurray: '\igrmatchvalue'}{'#1' unknown}} -\keytester{foo}\\ +\keytester{something}\\ \keytester{bar}\\ \keytester{my key A} \end{dispExample} @@ -1117,33 +1176,33 @@ See the result on the following page. % Do not follow this bad example ... \begin{tcbverbatimwrite}{\jobname.bib} -@manual{tantau:2013a, +@manual{tantau:tikz, author = {Till Tantau}, title = {The TikZ and PGF Packages}, - subtitle = {Manual for version 3.0.0}, - url = {http://sourceforge.net/projects/pgf/}, - date = {2013-12-20}, + subtitle = {Manual for version 3.1.9a}, + url = {https://mirrors.ctan.org/graphics/pgf/base/doc/pgfmanual.pdf}, + date = {2021-05-15}, } -@manual{carlisle:1999a, - author = {D. P. Carlisle and S. P. Q. Rahtz}, - title = {The graphicx package}, - url = {http://mirror.ctan.org/macros/latex/required/graphics/}, - date = {1999-02-16}, +@manual{carlisle:graphics, + author = {D. P. Carlisle}, + title = {Packages in the ‘graphics’ bundle}, + url = {https://mirrors.ctan.org/macros/latex/required/graphics/grfguide.pdf}, + date = {2021-03-05}, } -@manual{matthias:2012a, +@manual{matthias:pdfpages, author = {Andreas Matthias}, title = {The pdfpages Package}, - url = {http://mirror.ctan.org/macros/latex/contrib/pdfpages/pdfpages.pdf}, - date = {2012-04-03}, + url = {https://mirrors.ctan.org/macros/latex/contrib/pdfpages/pdfpages.pdf}, + date = {2021-03-06}, } -@manual{oberdiek:2011a, +@manual{oberdiek:bookmark, author = {Heiko Oberdiek}, title = {The bookmark Package}, - url = {http://mirror.ctan.org/macros/latex/contrib/oberdiek/bookmark.pdf}, - date = {2011-12-02}, + url = {https://mirrors.ctan.org/macros/latex/contrib/bookmark/bookmark.pdf}, + date = {2020-11-06}, } \end{tcbverbatimwrite} diff --git a/macros/latex/contrib/unicodefonttable/README.md b/macros/latex/contrib/unicodefonttable/README.md new file mode 100644 index 0000000000..b1f92c1fd0 --- /dev/null +++ b/macros/latex/contrib/unicodefonttable/README.md @@ -0,0 +1,29 @@ +# The unicodefonttable package + +----- + +This package produces font tables for unicode fonts as well as for +8bit fonts. The table layout can be adjusted in various ways +including restricting the range of output to show only a portion of a +specific font. + +To quickly produce a one-off table there is a stand-alone version +`unicodefont.tex` that asks you a few questions and then generates the +table --- somewhat similar to `nfssfont.tex` for 8-bit fonts. + + +The official package source can be found at: + + https://github.com/FrankMittelbach/fmitex-unicodefonttable/ + +The license is LPPL. + +For version information see the .dtx file. + +----- + +Copyright (C) Frank Mittelbach (for copyright date see the .dtx file)
    +
    +All rights reserved. + + diff --git a/macros/latex/contrib/unicodefonttable/TODO.md b/macros/latex/contrib/unicodefonttable/TODO.md new file mode 100644 index 0000000000..6cee8ebf49 --- /dev/null +++ b/macros/latex/contrib/unicodefonttable/TODO.md @@ -0,0 +1,20 @@ +# Collection of possible todos + +These are an unsorted collection of thoughts by others or myself and may or may not get done depending ... + + +## Comparing + +- When comparing, I suggest writing the log file with the + the list of glyphs found only in the comparison font. That way, people + developing a font who want to have equal coverage can easily see what + glyphs they are missing. Since you are already discovering the + information, why not log it ... + + +- Also, if there are first-font-only symbols (maybe not in + this case -- is there a way to get a textual list of the differing code + points?), I'd suggest trying an open box (cf. the shaded box for + second-font-only). + + diff --git a/macros/latex/contrib/unicodefonttable/changes.txt b/macros/latex/contrib/unicodefonttable/changes.txt new file mode 100644 index 0000000000..a632e273f8 --- /dev/null +++ b/macros/latex/contrib/unicodefonttable/changes.txt @@ -0,0 +1,20 @@ +2021-10-19 Frank Mittelbach + + * unicodefonttable.dtx + Extended support up to U+FFFFF after all, but not plane 16. + A bit more explanation in different places. + Some speed improvements (could be improved further) + +2021-10-17 Frank Mittelbach + + * unicodefonttable.dtx: + Extend support to the higher planes of Unicode by allowing a + range from U+0000 to U+EFFFF + +2021-10-08 Frank Mittelbach + + * unicodefonttable.dtx (subsection{Keys and their values}): + Added statistics-compare-format key. + Use longtable* from the caption package when not showing a + header with a \caption. + diff --git a/macros/latex/contrib/unicodefonttable/l3doc-TUB.cls b/macros/latex/contrib/unicodefonttable/l3doc-TUB.cls new file mode 100644 index 0000000000..50a8a9a9d9 --- /dev/null +++ b/macros/latex/contrib/unicodefonttable/l3doc-TUB.cls @@ -0,0 +1,2306 @@ +%% +%% This is file `l3doc-TUB.cls' +%% +%% The original source files were: +%% +%% l3doc.dtx (with options: `class') + several manual changes! +%% +%% Copyright (C) 1990-2018 The LaTeX3 Project +%% +%% It may be distributed and/or modified under the conditions of +%% the LaTeX Project Public License (LPPL), either version 1.3c of +%% this license or (at your option) any later version. The latest +%% version of this license is in the file: +%% +%% https://www.latex-project.org/lppl.txt +%% +%% File: l3doc.dtx Copyright (C) 1990-2018 The LaTeX3 project +%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% +%% This is really a temporary file intended for a single article +%% written for TugBoat It is a copy of l3doc.cls with a couple of +%% changes, nothing more. Eventually this will get replaced by a real +%% class once l3doc.cls gets properly split into a class part and a +%% support part. +%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% +%% If you use this for anything other than processing the documents it +%% was meant for (which so far is 2) you are on your own :-) +%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\RequirePackage{expl3,xparse,calc} +\ProvidesExplClass{l3doc-TUB}{2021/03/02}{} + {L3 Experimental documentation class (special version for TUGboat with fixes)} +\clist_new:N \g_docinput_clist +\seq_new:N \g_doc_functions_seq +\seq_new:N \g_doc_macros_seq +\bool_new:N \l__codedoc_detect_internals_bool +\bool_set_true:N \l__codedoc_detect_internals_bool +\tl_new:N \l__codedoc_detect_internals_tl +\tl_new:N \l__codedoc_detect_internals_cs_tl +\coffin_new:N \l__codedoc_output_coffin +\coffin_new:N \l__codedoc_functions_coffin +\coffin_new:N \l__codedoc_descr_coffin +\coffin_new:N \l__codedoc_syntax_coffin +\box_new:N \g__codedoc_syntax_box +\bool_new:N \l__codedoc_in_function_bool +\bool_new:N \l__codedoc_long_name_bool +\dim_new:N \l__codedoc_trial_width_dim +\int_new:N \l__codedoc_nested_macro_int +\bool_new:N \l__codedoc_macro_tested_bool +\prop_new:N \g__codedoc_missing_tests_prop +\seq_new:N \g__codedoc_not_tested_seq +\seq_new:N \g__codedoc_testfiles_seq +\bool_new:N \l__codedoc_macro_internal_set_bool +\bool_new:N \l__codedoc_macro_internal_bool +\bool_new:N \l__codedoc_macro_TF_bool +\bool_new:N \l__codedoc_macro_pTF_bool +\bool_new:N \l__codedoc_macro_noTF_bool +\bool_new:N \l__codedoc_macro_EXP_bool +\bool_new:N \l__codedoc_macro_rEXP_bool +\bool_new:N \l__codedoc_macro_var_bool +\tl_new:N \l__codedoc_override_module_tl +\tl_set:Nn \l__codedoc_override_module_tl { \q_no_value } +\tl_new:N \l__codedoc_macro_documented_tl +\bool_new:N \g__codedoc_lmodern_bool +\bool_new:N \g__codedoc_checkfunc_bool +\bool_new:N \g__codedoc_checktest_bool +\bool_new:N \g__codedoc_kernel_bool +\tl_new:N \l__codedoc_tmpa_tl +\tl_new:N \l__codedoc_tmpb_tl +\int_new:N \l__codedoc_tmpa_int +\int_new:N \l__codedoc_tmpa_seq +\tl_new:N \l__codedoc_names_block_tl +\seq_new:N \g__codedoc_variants_seq +\bool_new:N \l__codedoc_names_verb_bool +\seq_new:N \l__codedoc_names_seq +\seq_new:N \g__codedoc_nested_names_seq +\tl_const:Nx \c__codedoc_backslash_tl { \iow_char:N \\ } +\exp_last_unbraced:NNo + \cs_new_eq:NN \c__codedoc_backslash_token { \c__codedoc_backslash_tl } +\tl_new:N \l__codedoc_index_macro_tl +\tl_new:N \l__codedoc_index_key_tl +\tl_new:N \l__codedoc_index_module_tl +\bool_new:N \l__codedoc_index_internal_bool +\tl_new:N \g__codedoc_module_name_tl +\tl_const:Nn \c__codedoc_iow_rule_tl + { ======================================== } +\tl_const:Nn \c__codedoc_iow_mid_rule_tl + { -------------------------------------- } +\box_new:N \l__codedoc_macro_box +\box_new:N \l__codedoc_macro_index_box +\int_new:N \l__codedoc_macro_int +\tl_new:N \l__codedoc_cmd_tl +\tl_new:N \l__codedoc_cmd_index_tl +\tl_new:N \l__codedoc_cmd_module_tl +\bool_new:N \l__codedoc_cmd_noindex_bool +\bool_new:N \l__codedoc_cmd_replace_bool +\bool_new:N \l__codedoc_in_implementation_bool +\bool_new:N \g__codedoc_typeset_documentation_bool +\bool_new:N \g__codedoc_typeset_implementation_bool +\bool_set_true:N \g__codedoc_typeset_documentation_bool +\bool_set_true:N \g__codedoc_typeset_implementation_bool +\tl_new:N \g__codedoc_base_name_tl +\prop_new:N \l__codedoc_variants_prop +\clist_new:N \l__codedoc_function_label_clist +\bool_new:N \l__codedoc_no_label_bool +\tl_new:N \l__codedoc_date_added_tl +\tl_new:N \l__codedoc_date_updated_tl +\tl_new:N \l__codedoc_macro_argument_tl +\cs_new_eq:NN \__codedoc_tmpa:w ? +\cs_new_eq:NN \__codedoc_tmpb:w ? +\cs_generate_variant:Nn \seq_set_split:Nnn { NoV } +\cs_generate_variant:Nn \seq_gput_right:Nn { Nf } +\cs_generate_variant:Nn \str_case:nn { fn } +\cs_generate_variant:Nn \tl_count:n { f } +\cs_generate_variant:Nn \tl_greplace_all:Nnn { Nx , Nno } +\cs_generate_variant:Nn \tl_if_empty:nTF { f } +\cs_generate_variant:Nn \tl_if_head_eq_charcode:nNTF { o } +\cs_generate_variant:Nn \tl_if_head_eq_charcode:nNT { o } +\cs_generate_variant:Nn \tl_if_head_eq_charcode:nNF { o } +\cs_generate_variant:Nn \tl_if_head_eq_meaning:nNF { V } +\cs_generate_variant:Nn \tl_if_in:nnTF { no , oo } +\cs_generate_variant:Nn \tl_if_in:NnTF { No } +\cs_generate_variant:Nn \tl_if_in:NnT { No } +\cs_generate_variant:Nn \tl_if_in:NnF { No } +\cs_generate_variant:Nn \tl_remove_all:Nn { Nx } +\cs_generate_variant:Nn \tl_replace_all:Nnn { Nx , Nnx, No , Nno } +\cs_generate_variant:Nn \tl_replace_once:Nnn { Noo } +\cs_generate_variant:Nn \tl_to_str:n { f , o } +\cs_generate_variant:Nn \prop_get:NnNTF { Nx } +\cs_generate_variant:Nn \prop_put:Nnn { Nx } +\cs_generate_variant:Nn \prop_gput:Nnn { NVx } +\prg_new_protected_conditional:Npnn \__codedoc_if_almost_str:n #1 { TF , T , F } + { + \int_compare:nNnTF + { \tl_count:n {#1} } + < { \tl_count:f { \tl_to_str:f {#1} } } + { \prg_return_false: } + { \prg_return_true: } + } +\cs_generate_variant:Nn \__codedoc_if_almost_str:nT { V } +\cs_new_protected:Npn \__codedoc_trim_right:Nn #1#2 + { + \cs_set:Npn \__codedoc_tmp:w ##1 #2 ##2 \q_stop { \exp_not:n {##1} } + \tl_set:Nx #1 { \exp_after:wN \__codedoc_tmp:w #1 #2 \q_stop } + } +\cs_generate_variant:Nn \__codedoc_trim_right:Nn { No } +\prg_new_protected_conditional:Npnn \__codedoc_str_if_begin:nn #1#2 { TF , T , F } + { + \tl_if_in:ooTF + { \exp_after:wN \scan_stop: \tl_to_str:n {#1} } + { \exp_after:wN \scan_stop: \tl_to_str:n {#2} } + { \prg_return_true: } + { \prg_return_false: } + } +\prg_generate_conditional_variant:Nnn \__codedoc_str_if_begin:nn + { oo } { TF , T , F } +\cs_new_protected:Npn \__codedoc_replace_at_at:N #1 + { + \bool_if:NT \l__codedoc_in_implementation_bool + { + \bool_if:NT \l__codedoc_detect_internals_bool + { \__codedoc_detect_internals:N #1 } + } + \tl_if_empty:NF \g__codedoc_module_name_tl + { + \exp_args:NNo \__codedoc_replace_at_at_aux:Nn + #1 \g__codedoc_module_name_tl + } + } +\cs_new_protected:Npx \__codedoc_replace_at_at_aux:Nn #1#2 + { + \tl_replace_all:Nnn #1 { \token_to_str:N @ } { @ } + \tl_replace_all:Nnn #1 { \token_to_str:N _ } { _ } + \tl_replace_all:Nnn #1 { @ @ @ @ } { \token_to_str:N a a } + \tl_replace_all:Nnn #1 { _ _ @ @ } { _ _ #2 } + \tl_replace_all:Nnn #1 { _ @ @ } { _ _ #2 } + \tl_replace_all:Nnn #1 { @ @ } { _ _ #2 } + \tl_replace_all:Nnn #1 { \token_to_str:N a a } { @ @ } + } +\group_begin: + \char_set_catcode_active:N \^^M + \cs_new_protected:Npn \__codedoc_detect_internals:N #1 + { + \tl_set_eq:NN \l__codedoc_detect_internals_tl #1 + \tl_replace_all:Non \l__codedoc_detect_internals_tl { \token_to_str:N _ } { _ } + \seq_set_split:NnV \l__codedoc_tmpa_seq { _ _ } \l__codedoc_detect_internals_tl + \seq_pop_left:NN \l__codedoc_tmpa_seq \l__codedoc_detect_internals_tl + \seq_map_variable:NNn \l__codedoc_tmpa_seq \l__codedoc_detect_internals_tl + { + \__codedoc_trim_right:No \l__codedoc_detect_internals_tl + \c_catcode_active_space_tl + \__codedoc_trim_right:Nn \l__codedoc_detect_internals_tl ^^M + \__codedoc_if_detect_internals_ok:NF \l__codedoc_detect_internals_tl + { + \tl_set_eq:NN \l__codedoc_detect_internals_cs_tl \l__codedoc_detect_internals_tl + \__codedoc_trim_right:Nn \l__codedoc_detect_internals_tl _ + \__codedoc_trim_right:Nn \l__codedoc_detect_internals_tl : + \__codedoc_trim_right:No \l__codedoc_detect_internals_tl { \token_to_str:N : } + \msg_warning:nnxxx { l3doc-TUB } { foreign-internal } + { \tl_to_str:N \l__codedoc_detect_internals_cs_tl } + { \tl_to_str:N \l__codedoc_detect_internals_tl } + { \tl_to_str:N \g__codedoc_module_name_tl } + } + } + } +\group_end: +\prg_new_protected_conditional:Npnn \__codedoc_if_detect_internals_ok:N #1 { F } + { + \__codedoc_str_if_begin:ooTF {#1} { \g__codedoc_module_name_tl _ } + { \prg_return_true: } + { + \__codedoc_str_if_begin:ooTF {#1} { \g__codedoc_module_name_tl : } + { \prg_return_true: } + { + \bool_if:NTF \g__codedoc_kernel_bool + { + \__codedoc_str_if_begin:ooTF {#1} { kernel _ } + { \prg_return_true: } + { \prg_return_false: } + } + { \prg_return_false: } + } + } + } +\cs_new:Npn \__codedoc_signature_base_form:n #1 + { \__codedoc_signature_base_form_aux:n #1 \q_stop } +\cs_new:Npn \__codedoc_signature_base_form_aux:n #1 + { + \str_case:nnTF {#1} + { + { N } { N } + { c } { N } + { n } { n } + { o } { n } + { f } { n } + { x } { n } + { V } { n } + { v } { n } + } + { \__codedoc_signature_base_form_aux:n } + { \__codedoc_signature_base_form_aux:w #1 } + } +\cs_new:Npn \__codedoc_signature_base_form_aux:w #1 \q_stop + { \exp_not:n {#1} } +\cs_new:Npn \__codedoc_predicate_from_base:n #1 + { + \__codedoc_get_function_name:n {#1} + \tl_to_str:n { _p: } + \__codedoc_get_function_signature:n {#1} + } +\cs_new:Npn \__codedoc_get_function_name:n #1 + { \__codedoc_split_function_do:nn {#1} { \use_i:nnn } } +\cs_new:Npn \__codedoc_get_function_signature:n #1 + { \__codedoc_split_function_do:nn {#1} { \use_ii:nnn } } +\cs_set_protected:Npn \__codedoc_tmpa:w #1 + { + \cs_new:Npn \__codedoc_split_function_do:nn ##1 + { + \exp_after:wN \__codedoc_split_function_auxi:w + \tl_to_str:n {##1} \q_mark \c_true_bool + #1 \q_mark \c_false_bool + \q_stop + } + \cs_new:Npn \__codedoc_split_function_auxi:w + ##1 #1 ##2 \q_mark ##3##4 \q_stop ##5 + { \__codedoc_split_function_auxii:w {##5} ##1 \q_mark \q_stop {##2} ##3 } + \cs_new:Npn \__codedoc_split_function_auxii:w + ##1##2 \q_mark ##3 \q_stop + { ##1 {##2} } + } +\exp_args:No \__codedoc_tmpa:w { \token_to_str:N : } +\cs_generate_variant:Nn \__codedoc_split_function_do:nn { o } +\cs_new_protected:Npn \__codedoc_key_get_base:nN #1#2 + { + \__codedoc_if_almost_str:nTF {#1} + { + \__codedoc_key_get_base_TF:nN {#1} \l__codedoc_tmpa_tl + \tl_set:Nx #2 + { \__codedoc_split_function_do:on \l__codedoc_tmpa_tl { \__codedoc_base_form_aux:nnN } } + } + { \tl_set:Nn #2 {#1} } + } +\cs_new:Npx \__codedoc_key_get_base_TF:nN #1#2 + { + \tl_set:Nx #2 { \exp_not:N \tl_to_str:n {#1} \scan_stop: } + \tl_if_in:NnTF #2 { \tl_to_str:n { F } \scan_stop: } + { + \tl_if_in:NnF #2 { \tl_to_str:n { TF } \scan_stop: } + { + \tl_replace_once:Nnn #2 + { \tl_to_str:n { F } \scan_stop: } + { \tl_to_str:n { TF } \scan_stop: } + } + } + { + \tl_replace_once:Nnn #2 + { \tl_to_str:n { T } \scan_stop: } + { \tl_to_str:n { TF } \scan_stop: } + } + \tl_remove_once:Nn #2 { \scan_stop: } + } +\cs_new:Npn \__codedoc_base_form_aux:nnN #1#2#3 + { + \exp_not:n {#1} + \bool_if:NT #3 + { + \token_to_str:N : + \str_if_eq:nnTF { #1 ~ } { \exp_args } + { \exp_not:n {#2} } + { \__codedoc_signature_base_form:n {#2} } + } + } +\cs_new_protected:Npn \__codedoc_base_form_signature_do:nnn #1#2#3 + { + \__codedoc_split_function_do:nn {#1} + { \__codedoc_base_form_aux:nnnnnN {#1} {#2} {#3} } + } +\cs_new_protected:Npn \__codedoc_base_form_aux:nnnnnN #1#2#3#4#5#6 + { + \bool_if:NTF #6 + { + \tl_if_head_eq_charcode:nNTF {#4} : + { #2 {#1} } + { + \use:x + { + \exp_not:n {#3} + { \__codedoc_base_form_aux:nnN {#4} {#5} #6 } + } + {#4} {#5} + } + } + { #2 {#1} } + } +\prg_new_conditional:Npnn \__codedoc_date_compare:nNn #1#2#3 { TF , T , F , p } + { \__codedoc_date_compare_aux:w #1--- \q_mark #2 #3--- \q_stop } +\cs_new:Npn \__codedoc_date_compare_aux:w + #1 - #2 - #3 - #4 \q_mark #5 #6 - #7 - #8 - #9 \q_stop + { + \__codedoc_date_compare_aux:nnnNnnn + { \tl_if_empty:nTF {#1} { 0 } {#1} } + { \tl_if_empty:nTF {#2} { 0 } {#2} } + { \tl_if_empty:nTF {#3} { 0 } {#3} } + #5 + { \tl_if_empty:nTF {#6} { 0 } {#6} } + { \tl_if_empty:nTF {#7} { 0 } {#7} } + { \tl_if_empty:nTF {#8} { 0 } {#8} } + } +\cs_new:Npn \__codedoc_date_compare_aux:nnnNnnn #1#2#3#4#5#6#7 + { + \int_compare:nNnTF {#1} = {#5} + { + \int_compare:nNnTF {#2} = {#6} + { + \int_compare:nNnTF {#3} #4 {#7} + { \prg_return_true: } { \prg_return_false: } + } + { + \int_compare:nNnTF {#2} #4 {#6} + { \prg_return_true: } { \prg_return_false: } + } + } + { + \int_compare:nNnTF {#1} #4 {#5} + { \prg_return_true: } { \prg_return_false: } + } + \use_none:n + \q_stop + } +\cs_new:Npn \__codedoc_gprop_name:n #1 { g__codedoc ~ \tl_to_str:n {#1} } +\cs_new:Npn \__codedoc_lseq_name:n #1 { l__codedoc ~ \tl_to_str:n {#1} } +\msg_new:nnnn { l3doc-TUB } { no-signature-TF } + { Function/macro~'#1'~cannot~be~turned~into~a~conditional. } + { + A~function~or~macro~environment~with~option~pTF,~TF~or~noTF~ + received~the~argument~'#1'.~This~function's~name~has~no~ + ':'~hence~it~is~not~clear~where~to~add~'_p'~or~'TF'.~ + Please~follow~expl3~naming~conventions. + } +\msg_new:nnn { l3doc-TUB } { deprecated-function } + { The~deprecated~function(s)~'#1'~should~have~been~removed~on~#2. } +\msg_new:nnn { l3doc-TUB } { date-format } + { The~date~'#1'~should~be~given~in~YYYY-MM-DD~format. } +\msg_new:nnn { l3doc-TUB } { syntax-nested-function } + { + The~'syntax'~environment~should~be~used~in~the~ + innermost~'function'~environment. + } +\msg_new:nnn { l3doc-TUB } { multiple-syntax } + { + The~'syntax'~environment~should~only~be~used~once~in~ + a~'function'~environment. + } +\msg_new:nnn { l3doc-TUB } { deprecated-option } + { The~option~'#1'~has~been~deprecated~for~'#2'. } +\msg_new:nnn { l3doc-TUB } { foreign-internal } + { + A~control~sequence~of~the~form~'...__#1'~was~used.~ + It~should~only~be~used~in~the~module~'#2' + \tl_if_empty:nF {#3} { ,~not~in~'#3' } . + } +\DeclareOption { a5paper } { \@latexerr { Option~not~supported } { } } +\DeclareOption { full } + { + \bool_gset_true:N \g__codedoc_typeset_documentation_bool + \bool_gset_true:N \g__codedoc_typeset_implementation_bool + } +\DeclareOption { onlydoc } + { + \bool_gset_true:N \g__codedoc_typeset_documentation_bool + \bool_gset_false:N \g__codedoc_typeset_implementation_bool + } +\DeclareOption { check } + { \bool_gset_true:N \g__codedoc_checkfunc_bool } +\DeclareOption { nocheck } + { \bool_gset_false:N \g__codedoc_checkfunc_bool } +\DeclareOption { checktest } + { \bool_gset_true:N \g__codedoc_checktest_bool } +\DeclareOption { nochecktest } + { \bool_gset_false:N \g__codedoc_checktest_bool } +\DeclareOption { kernel } + { \bool_gset_true:N \g__codedoc_kernel_bool } +\DeclareOption { stdmodule } + { \bool_gset_false:N \g__codedoc_kernel_bool } +\DeclareOption { cm-default } + { \bool_gset_false:N \g__codedoc_lmodern_bool } +\DeclareOption { lm-default } + { \bool_gset_true:N \g__codedoc_lmodern_bool } +\DeclareOption* { \PassOptionsToClass { \CurrentOption } { ltugboat } } +\ExecuteOptions { full, kernel, nocheck, nochecktest, lm-default } +%%FMi \PassOptionsToClass { a4paper } { article } +\msg_new:nnn { l3doc-TUB } { input-cfg } + { Local~config~file~l3doc-TUB.cfg~loaded. } +\file_if_exist:nT { l3doc-TUB.cfg } + { + \file_input:nT { l3doc-TUB.cfg } + { + \cs_if_exist:cF { ExplMakeTitle } + { \msg_info:nn { l3doc-TUB } { input-cfg } } + } + } +\ProcessOptions +\LoadClass[final]{ltugboat} +\RequirePackage{doc} + +\newcommand\bibname{References} % otherwise \bibname is undefined at \Finale +\TBtocsectionspace=0pt plus 1pt + +\IndexPrologue + {\section*{Index} + \markboth{Index}{Index} + \addcontentsline{toc}{section}{Index} + \noindent + Underlined numbers point to the definition, + italicized numbers denote the pages where the + corresponding entry is described, + all others indicate the places where it is used.} +%\EnableCrossrefs +%\CodelineIndex + +\RequirePackage + { + microtype, + array, + alphalph, + amsmath, + amssymb, + booktabs, + color, + colortbl, + hologo, + enumitem, + pifont, + textcomp, + trace, + underscore, + csquotes, + fancyvrb, + verbatim + } +\raggedbottom +\bool_if:NT \g__codedoc_lmodern_bool + { + \RequirePackage[T1]{fontenc} + \RequirePackage{lmodern} + \group_begin: + \ttfamily + \DeclareFontShape{T1}{lmtt}{m}{it}{<->ec-lmtto10}{} + \group_end: + } + +\RequirePackage{hypdoc} + +%%FMi: +\hypersetup{allcolors=black} + +\cs_gset:Npn \MakePrivateLetters + { + \char_set_catcode_letter:N \@ + \char_set_catcode_letter:N \_ + \char_set_catcode_letter:N \: + } +\setcounter{StandardModuleDepth}{1} +\@addtoreset{CodelineNo}{part} +\tl_replace_once:Nnn \theCodelineNo + { \HDorg@theCodelineNo } + { \textcolor[gray]{0.5} { \sffamily\tiny\arabic{CodelineNo} } } +\fvset{gobble=2} +\cs_gset_eq:NN \verbatim \Verbatim +\cs_gset_eq:NN \endverbatim \endVerbatim +\cs_set_protected:Npn \ifnot@excluded + { + \exp_args:Nxx \expanded@notin + { \c__codedoc_backslash_tl \tl_to_str:N \macro@namepart , } + { \exp_args:NV \tl_to_str:n \index@excludelist } + } +\cs_new:Npn \pdfstringnewline { : ~ } +\DeclareExpandableDocumentCommand + { \__codedoc_pdfstring_newline:w } { s o m } { \pdfstringnewline #3 } +\pdfstringdefDisableCommands + { \cs_set_eq:NN \\ \__codedoc_pdfstring_newline:w } +\setlength \textwidth { 385pt } +\addtolength \marginparwidth { 30pt } +\addtolength \oddsidemargin { 20pt } +\addtolength \evensidemargin { 20pt } +\cs_new_eq:NN \__codedoc_oldlist:nn \list +\cs_gset:Npn \list #1 #2 + { \__codedoc_oldlist:nn {#1} { #2 \dim_zero:N \listparindent } } +\setlength \parindent { 2em } +\setlength \itemindent { 0pt } +\setlength \parskip { 1pt plus 3pt minus 0pt } +\tl_gset:Nn \partname {File} +\@addtoreset{section}{part} +\cs_gset:Npn \l@section #1#2 + { + \ifnum \c@tocdepth >\z@ + \addpenalty\@secpenalty + \addvspace{\TBtocsectionspace}% + \setlength\@tempdima{2.5em} % was 1.5em + \begingroup + \parindent \z@ \rightskip \@pnumwidth + \parfillskip -\@pnumwidth + \leavevmode \TBtocsectionfont + \advance\leftskip\@tempdima + \hskip -\leftskip + #1\nobreak\hfil \nobreak\hb@xt@\@pnumwidth{\hss #2}\par + \endgroup + \fi + } +\cs_gset:Npn \l@subsection + { \@dottedtocline{2}{2.5em}{2.3em} } % #2 = 1.5em +\AtBeginDocument + { + \MakeShortVerb \" + \MakeShortVerb \| + \onecolumn + \SelfDocumenting + } +\AtEndDocument + { + \DeleteShortVerb \" + \DeleteShortVerb \| + } +\providecommand*\eTeX{\hologo{eTeX}} +\providecommand*\IniTeX{\hologo{iniTeX}} +\providecommand*\Lua{Lua} +\providecommand*\LuaTeX{\hologo{LuaTeX}} +\providecommand*\pdfTeX{\hologo{pdfTeX}} +\providecommand*\XeTeX{\hologo{XeTeX}} +\providecommand*\pTeX{p\kern-.2em\hologo{TeX}} +\providecommand*\upTeX{up\kern-.2em\hologo{TeX}} +\providecommand*\epTeX{$\varepsilon$-\pTeX} +\providecommand*\eupTeX{$\varepsilon$-\upTeX} +\DeclareDocumentCommand \cmd { O{} m } + { \__codedoc_cmd:no {#1} { \token_to_str:N #2 } } +\DeclareDocumentCommand \cs { O{} m } + { \__codedoc_cmd:no {#1} { \c__codedoc_backslash_tl #2 } } +\DeclareDocumentCommand \tn { O{} m } + { + \__codedoc_cmd:no + { module = TeX , replace = false , #1 } + { \c__codedoc_backslash_tl #2 } + } +\DeclareDocumentCommand \meta { m } + { \__codedoc_meta:n {#1} } +\DeclareExpandableDocumentCommand + { \__codedoc_pdfstring_cmd:w } { o m } { \token_to_str:N #2 } +\DeclareExpandableDocumentCommand + { \__codedoc_pdfstring_cs:w } { o m } { \textbackslash \tl_to_str:n {#2} } +\cs_new:Npn \__codedoc_pdfstring_meta:w #1 + { < \tl_to_str:n {#1} > } +\pdfstringdefDisableCommands + { + \cs_set_eq:NN \cmd \__codedoc_pdfstring_cmd:w + \cs_set_eq:NN \cs \__codedoc_pdfstring_cs:w + \cs_set_eq:NN \tn \__codedoc_pdfstring_cs:w + \cs_set_eq:NN \meta \__codedoc_pdfstring_meta:w + } +\newcommand\Arg[1] + { \texttt{\char`\{} \meta{#1} \texttt{\char`\}} } +\providecommand\marg[1]{ \Arg{#1} } +\providecommand\oarg[1]{ \texttt[ \meta{#1} \texttt] } +\providecommand\parg[1]{ \texttt( \meta{#1} \texttt) } +\DeclareRobustCommand \file {\nolinkurl} +\DeclareRobustCommand \env {\texttt} +\DeclareRobustCommand \pkg {\textsf} +\DeclareRobustCommand \cls {\textsf} +\NewDocumentCommand \EnableDocumentation { } + { \bool_gset_true:N \g__codedoc_typeset_documentation_bool } +\NewDocumentCommand \EnableImplementation { } + { \bool_gset_true:N \g__codedoc_typeset_implementation_bool } +\NewDocumentCommand \DisableDocumentation { } + { \bool_gset_false:N \g__codedoc_typeset_documentation_bool } +\NewDocumentCommand \DisableImplementation { } + { \bool_gset_false:N \g__codedoc_typeset_implementation_bool } +\NewDocumentEnvironment { documentation } { } + { + \bool_if:NTF \g__codedoc_typeset_documentation_bool + { \bool_set_false:N \l__codedoc_in_implementation_bool } + { \comment } + } + { \bool_if:NF \g__codedoc_typeset_documentation_bool { \endcomment } } +\NewDocumentEnvironment { implementation } { } + { + \bool_if:NTF \g__codedoc_typeset_implementation_bool + { \bool_set_true:N \l__codedoc_in_implementation_bool } + { \comment } + } + { \bool_if:NF \g__codedoc_typeset_implementation_bool { \endcomment } } +\DeclareDocumentEnvironment { variable } { O{} +v } + { + \bool_if:NTF \l__codedoc_in_implementation_bool + { \__codedoc_macro:nnw { var , #1 } {#2} } + { \__codedoc_function:nnw {#1} {#2} } + } + { + \bool_if:NTF \l__codedoc_in_implementation_bool + { \__codedoc_macro_end: } + { \__codedoc_function_end: } + } +\DeclareDocumentEnvironment { function } { O{} +v } + { \__codedoc_function:nnw {#1} {#2} } + { \__codedoc_function_end: } +\DeclareDocumentEnvironment { macro } { O{} +v } + { \__codedoc_macro:nnw {#1} {#2} } + { \__codedoc_macro_end: } +\NewDocumentEnvironment { syntax } { } + { \__codedoc_syntax:w } + { + \__codedoc_syntax_end: + \ignorespacesafterend + } +\NewDocumentEnvironment { texnote } { } + { + \endgraf + \vspace{3mm} + \small\textbf{\TeX~hackers~note:} + } + { + \vspace{3mm} + } +\NewDocumentEnvironment { arguments } { } + { + \enumerate [ + nolistsep , + label = \texttt{\#\arabic*} ~ : , + labelsep = * , + ] + } + { + \endenumerate + } +\NewDocumentCommand { \CodedocExplain } { } + { \CodedocExplainEXP \ \CodedocExplainREXP \ \CodedocExplainTF } +\NewDocumentCommand { \CodedocExplainEXP } { } + { + \raisebox{\baselineskip}[0pt][0pt]{\hypertarget{expstar}{}}% + \__codedoc_typeset_exp:\ indicates~fully~expandable~functions,~which~ + can~be~used~within~an~\texttt{x}-type~argument~(in~plain~ + \TeX{}~terms,~inside~an~\cs{edef}),~as~well~as~within~an~ + \texttt{f}-type~argument. + } +\NewDocumentCommand { \CodedocExplainREXP } { } + { + \raisebox{\baselineskip}[0pt][0pt]{\hypertarget{rexpstar}{}}% + \__codedoc_typeset_rexp:\ indicates~ + restricted~expandable~functions,~which~can~be~used~within~an~ + \texttt{x}-type~argument~but~cannot~be~fully~expanded~within~an~ + \texttt{f}-type~argument. + } +\NewDocumentCommand { \CodedocExplainTF } { } + { + \raisebox{\baselineskip}[0pt][0pt]{\hypertarget{explTF}{}}% + \__codedoc_typeset_TF:\ indicates~conditional~(\texttt{if})~functions~ + whose~variants~with~\texttt{T},~\texttt{F}~and~\texttt{TF}~ + argument~specifiers~expect~different~ + \enquote{true}/\enquote{false}~branches. + } +\keys_define:nn { l3doc-TUB/cmd } + { + index .tl_set:N = \l__codedoc_cmd_index_tl , + module .tl_set:N = \l__codedoc_cmd_module_tl , + no-index .bool_set:N = \l__codedoc_cmd_noindex_bool , + replace .bool_set:N = \l__codedoc_cmd_replace_bool , + } +\cs_new_protected:Npn \__codedoc_cmd:nn #1#2 + { + \bool_set_false:N \l__codedoc_cmd_noindex_bool + \bool_set_true:N \l__codedoc_cmd_replace_bool + \tl_set:Nn \l__codedoc_cmd_index_tl { \q_no_value } + \tl_set:Nn \l__codedoc_cmd_module_tl { \q_no_value } + \keys_set:nn { l3doc-TUB/cmd } {#1} + \tl_set:Nn \l__codedoc_cmd_tl {#2} + \bool_if:NT \l__codedoc_cmd_replace_bool + { + \tl_set_rescan:Nnn \l__codedoc_tmpb_tl { } { _ } + \tl_replace_all:Non \l__codedoc_cmd_tl \l__codedoc_tmpb_tl { _ } + \__codedoc_replace_at_at:N \l__codedoc_cmd_tl + \tl_replace_all:Nno \l__codedoc_cmd_tl { _ } \l__codedoc_tmpb_tl + } + \mode_if_math:T { \mbox } + { + \verbatim@font + \__codedoc_if_almost_str:VT \l__codedoc_cmd_tl + { + \tl_set:Nx \l__codedoc_cmd_tl { \tl_to_str:N \l__codedoc_cmd_tl } + \tl_replace_all:Non \l__codedoc_cmd_tl + { \token_to_str:N _ } { \_ } + } + \tl_replace_all:Nnn \l__codedoc_cmd_tl { ~ } { \@xobeysp } + \l__codedoc_cmd_tl + \@ + } + \bool_if:NF \l__codedoc_cmd_noindex_bool + { + \quark_if_no_value:NF \l__codedoc_cmd_index_tl + { + \tl_set:Nx \l__codedoc_cmd_tl + { \c_backslash_str \exp_not:o { \l__codedoc_cmd_index_tl } } + } + + \exp_args:No \__codedoc_key_get:n { \l__codedoc_cmd_tl } + \quark_if_no_value:NF \l__codedoc_cmd_module_tl + { + \tl_set:Nx \l__codedoc_index_module_tl + { \tl_to_str:N \l__codedoc_cmd_module_tl } + } + \__codedoc_special_index_module:ooonN + { \l__codedoc_index_key_tl } + { \l__codedoc_index_macro_tl } + { \l__codedoc_index_module_tl } + { usage } + \l__codedoc_index_internal_bool + } + } +\cs_generate_variant:Nn \__codedoc_cmd:nn { no } +\cs_new_protected:Npn \__codedoc_meta:n #1 + { + \tl_set:Nn \l__codedoc_tmpa_tl {#1} + \tl_map_inline:nn + { { 3 } { 4 } { 7 } { 8 } { 11 } { 12 } { 13 } } + { + \tl_set_rescan:Nnn \l__codedoc_tmpb_tl + { \char_set_catcode:nn { `_ } {##1} } { _ } + \tl_replace_all:Non \l__codedoc_tmpa_tl \l__codedoc_tmpb_tl + { \__codedoc_ensuremath_sb:n } + } + \exp_args:NV \__codedoc_meta_original:n \l__codedoc_tmpa_tl + } +\cs_new_protected:Npn \__codedoc_ensuremath_sb:n #1 + { \ensuremath { \sb {#1} } } +\cs_new_protected:Npn \__codedoc_meta_original:n #1 + { + \ensuremath \langle + \mode_if_math:T { \nfss@text } + { + \meta@font@select + \edef \meta@hyphen@restore + { \hyphenchar \the \font \the \hyphenchar \font } + \hyphenchar \font \m@ne + \language \l@nohyphenation + #1 \/ + \meta@hyphen@restore + } + \ensuremath \rangle + } +\cs_new_protected:Npn \__codedoc_typeset_exp: + { \hyperlink{expstar} {$\star$} } +\cs_new_protected:Npn \__codedoc_typeset_rexp: + { \hyperlink{rexpstar} {\ding{73}} } % hollow star +\cs_new_protected:Npn \__codedoc_typeset_TF: + { + \hyperlink{explTF} + { + \color{black} + \itshape TF + \makebox[0pt][r] + { + \color{red} + \underline { \phantom{\itshape TF} \kern-0.1em } + } + } + } +\cs_new_protected:Npn \__codedoc_typeset_aux:n #1 + { + { \color[gray]{0.5} #1 } + } +\cs_new_protected:Npn \__codedoc_get_hyper_target:nN #1#2 + { + \tl_set:Nx #2 { \tl_to_str:n {#1} } + \tl_replace_all:Nxn #2 { \iow_char:N \_ } { / } + \tl_remove_all:Nx #2 { \iow_char:N \\ } + \tl_put_left:Nn #2 { doc/function// } + } +\cs_generate_variant:Nn \__codedoc_get_hyper_target:nN { o , x } +\cs_new_protected:Npn \__codedoc_names_get_seq:nN #1#2 + { + \tl_set:Nx \l__codedoc_tmpa_tl { \tl_to_str:n {#1} } + \bool_if:NTF \l__codedoc_names_verb_bool + { + \seq_clear:N #2 + \seq_put_right:NV #2 \l__codedoc_tmpa_tl + } + { + \tl_remove_all:Nx \l__codedoc_tmpa_tl + { \iow_char:N \^^M \iow_char:N \% } + \tl_remove_all:Nx \l__codedoc_tmpa_tl { \tl_to_str:n { ^ ^ A } } + \tl_remove_all:Nx \l__codedoc_tmpa_tl { \iow_char:N \^^I } + \tl_remove_all:Nx \l__codedoc_tmpa_tl { \iow_char:N \^^M } + \__codedoc_replace_at_at:N \l__codedoc_tmpa_tl + \exp_args:NNx \seq_set_from_clist:Nn #2 + { \tl_to_str:N \l__codedoc_tmpa_tl } + } + } +\cs_new_protected:Npn \__codedoc_names_parse: + { + \tl_clear:N \l__codedoc_names_block_tl + \seq_map_function:NN + \l__codedoc_names_seq + \__codedoc_names_parse_one:n + } +\cs_new_protected:Npn \__codedoc_names_parse_one:n #1 + { + \__codedoc_split_function_do:nn {#1} + { \__codedoc_names_parse_one_aux:nnNn } + {#1} + } +\cs_new_protected:Npn \__codedoc_names_parse_one_aux:nnNn #1#2#3#4 + { + \bool_if:NTF #3 + { + \tl_if_head_eq_charcode:nNTF {#2} : + { \__codedoc_names_parse_aux:nnn {#4} {#4} { \scan_stop: } } + { + \exp_args:Nx \__codedoc_names_parse_aux:nnn + { \__codedoc_base_form_aux:nnN {#1} {#2} #3 } + {#1} {#2} + } + } + { + \bool_if:NT \l__codedoc_macro_TF_bool + { \msg_error:nnx { l3doc-TUB } { no-signature-TF } {#4} } + \__codedoc_names_parse_aux:nnn {#4} {#4} { \scan_stop: } + } + } +\cs_new_protected:Npn \__codedoc_names_parse_aux:nnn #1 + { \exp_args:Nc \__codedoc_names_parse_aux:Nnn { \__codedoc_lseq_name:n {#1} } } +\cs_new_protected:Npn \__codedoc_names_parse_aux:Nnn #1#2#3 + { + \tl_if_in:NnF \l__codedoc_names_block_tl {#1} + { + \tl_put_right:Nn \l__codedoc_names_block_tl {#1} + \seq_clear_new:N #1 + \seq_put_right:Nn #1 {#2} + } + \seq_put_right:Nn #1 {#3} + } +\cs_new_protected:Npn \__codedoc_names_typeset: + { + \tl_map_function:NN \l__codedoc_names_block_tl + \__codedoc_names_typeset_auxi:n + } +\cs_new_protected:Npn \__codedoc_names_typeset_auxi:n #1 + { + \seq_pop:NN #1 \l__codedoc_tmpa_tl + \tl_gset_eq:NN \g__codedoc_base_name_tl \l__codedoc_tmpa_tl + \tl_greplace_all:Nno \g__codedoc_base_name_tl + { ~ } { \c_catcode_other_space_tl } + \seq_get:NN #1 \l__codedoc_tmpa_tl + \str_if_eq:eeTF { \l__codedoc_tmpa_tl } { \scan_stop: } + { + \seq_gclear:N \g__codedoc_variants_seq + \__codedoc_names_typeset_auxii:x { \g__codedoc_base_name_tl } + } + { + \seq_gset_eq:NN \g__codedoc_variants_seq #1 + \seq_gpop:NN \g__codedoc_variants_seq \l__codedoc_tmpb_tl + \__codedoc_names_typeset_auxii:x + { \g__codedoc_base_name_tl : \l__codedoc_tmpb_tl } + } + } +\cs_new_protected:Npn \__codedoc_names_typeset_auxii:n #1 + { + \bool_if:NT \l__codedoc_macro_pTF_bool + { + \__codedoc_names_typeset_block:xN + { \__codedoc_predicate_from_base:n {#1} } + \c_false_bool + } + \bool_if:NT \l__codedoc_macro_noTF_bool + { \__codedoc_names_typeset_block:nN {#1} \c_false_bool } + \__codedoc_names_typeset_block:nN {#1} \l__codedoc_macro_TF_bool + } +\cs_generate_variant:Nn \__codedoc_names_typeset_auxii:n { x } +\cs_new_protected:Npn \__codedoc_names_typeset_block:nN + { + \int_compare:nNnTF \l__codedoc_nested_macro_int = 0 + { \__codedoc_typeset_function_block:nN } + { \__codedoc_macro_typeset_block:nN } + } +\cs_generate_variant:Nn \__codedoc_names_typeset_block:nN { x } +\prg_new_conditional:Npnn \__codedoc_if_macro_internal:n #1 { p , T , F , TF } + { + \bool_if:NTF \l__codedoc_macro_internal_set_bool + { + \bool_if:NTF \l__codedoc_macro_internal_bool + { \prg_return_true: } { \prg_return_false: } + } + { + \tl_if_empty:fTF + { + \exp_after:wN \__codedoc_if_macro_internal_aux:w + \tl_to_str:n { #1 ~ __ } + } + { \prg_return_false: } { \prg_return_true: } + } + } +\exp_last_unbraced:NNNNo + \cs_new:Npn \__codedoc_if_macro_internal_aux:w #1 { \tl_to_str:n { __ } } { } +\cs_new_protected:Npn \__codedoc_names_block_base_map:N #1 + { + \tl_map_inline:Nn \l__codedoc_names_block_tl + { + \group_begin: + \seq_set_eq:NN \l__codedoc_tmpa_seq ##1 + \seq_pop:NN \l__codedoc_tmpa_seq \l__codedoc_tmpa_tl + \seq_get:NN \l__codedoc_tmpa_seq \l__codedoc_tmpb_tl + \exp_args:NNx + \group_end: + #1 + { + \l__codedoc_tmpa_tl + \str_if_eq:eeF { \l__codedoc_tmpb_tl } { \scan_stop: } + { : \l__codedoc_tmpb_tl } + \bool_if:NT \l__codedoc_macro_TF_bool { TF } + } + } + } +\keys_define:nn { l3doc-TUB/function } + { + TF .value_forbidden:n = true , + TF .code:n = + { + \bool_set_true:N \l__codedoc_macro_TF_bool + } , + EXP .value_forbidden:n = true , + EXP .code:n = + { + \bool_set_true:N \l__codedoc_macro_EXP_bool + \bool_set_false:N \l__codedoc_macro_rEXP_bool + } , + rEXP .value_forbidden:n = true , + rEXP .code:n = + { + \bool_set_false:N \l__codedoc_macro_EXP_bool + \bool_set_true:N \l__codedoc_macro_rEXP_bool + } , + pTF .value_forbidden:n = true , + pTF .code:n = + { + \bool_set_true:N \l__codedoc_macro_pTF_bool + \bool_set_true:N \l__codedoc_macro_TF_bool + \bool_set_true:N \l__codedoc_macro_EXP_bool + \bool_set_false:N \l__codedoc_macro_rEXP_bool + } , + noTF .value_forbidden:n = true , + noTF .code:n = + { + \bool_set_true:N \l__codedoc_macro_noTF_bool + \bool_set_true:N \l__codedoc_macro_TF_bool + } , + added .code:n = { \__codedoc_date_set:Nn \l__codedoc_date_added_tl {#1} }, + updated .code:n = { \__codedoc_date_set:Nn \l__codedoc_date_updated_tl {#1} } , + deprecated .code:n = { \__codedoc_deprecated_on:n {#1} } , + tested .code:n = { } , + label .code:n = + { + \clist_set:Nn \l__codedoc_function_label_clist {#1} + \bool_set_true:N \l__codedoc_no_label_bool + } , + verb .value_forbidden:n = true , + verb .bool_set:N = \l__codedoc_names_verb_bool , + module .tl_set:N = \l__codedoc_override_module_tl , + } +\cs_new_protected:Npn \__codedoc_date_set:Nn #1#2 + { + \tl_set:Nn #1 {#2} + \regex_replace_once:nnNF + { \A(\d\d\d\d)[-/](\d\d?)[-/](\d\d?)\Z } { \1-\2-\3 } #1 + { + \msg_error:nnn { l3doc-TUB } { date-format } {#2} + \tl_set:Nn #1 { 1970-01-01 } + } + } +\cs_new_protected:Npn \__codedoc_deprecated_on:n #1 + { + \__codedoc_date_set:Nn \l__codedoc_tmpa_tl {#1} + \exp_args:No \__codedoc_date_compare:nNnT + { \l__codedoc_tmpa_tl } < { \tex_year:D - \tex_month:D - \tex_day:D } + { + \msg_error:nnxx { l3doc-TUB } { deprecated-function } + { \tl_to_str:N \l__codedoc_macro_argument_tl } + { \l__codedoc_tmpa_tl } + } + \bool_set_true:N \l__codedoc_macro_internal_bool + \bool_set_true:N \l__codedoc_macro_internal_set_bool + } +\cs_new_protected:Npn \__codedoc_function:nnw #1#2 + { + \__codedoc_function_typeset_start: + \__codedoc_function_init: + \tl_set:Nn \l__codedoc_macro_argument_tl {#2} + \keys_set:nn { l3doc-TUB/function } {#1} + \__codedoc_names_get_seq:nN {#2} \l__codedoc_names_seq + \__codedoc_names_parse: + \__codedoc_function_typeset: + \__codedoc_function_reset: + \__codedoc_function_descr_start:w + } +\cs_new_protected:Npn \__codedoc_function_end: + { + \__codedoc_function_descr_stop: + \__codedoc_function_assemble: + \__codedoc_function_typeset_stop: + } +\cs_new_protected:Npn \__codedoc_function_typeset_start: + { + \par \bigskip \noindent + } +\cs_new_protected:Npn \__codedoc_function_typeset_stop: + { + \par + \allowbreak + } +\cs_new_protected:Npn \__codedoc_function_init: + { + \box_if_empty:NF \g__codedoc_syntax_box + { \msg_error:nn { l3doc-TUB } { syntax-nested-function } } + \coffin_clear:N \l__codedoc_descr_coffin + \box_gclear:N \g__codedoc_syntax_box + \coffin_clear:N \l__codedoc_syntax_coffin + \coffin_clear:N \l__codedoc_functions_coffin + \bool_set_false:N \l__codedoc_macro_TF_bool + \bool_set_false:N \l__codedoc_macro_pTF_bool + \bool_set_false:N \l__codedoc_macro_noTF_bool + \bool_set_false:N \l__codedoc_macro_EXP_bool + \bool_set_false:N \l__codedoc_macro_rEXP_bool + \bool_set_false:N \l__codedoc_no_label_bool + \bool_set_false:N \l__codedoc_names_verb_bool + \bool_set_true:N \l__codedoc_in_function_bool + \clist_clear:N \l__codedoc_function_label_clist + \tl_set:Nn \l__codedoc_override_module_tl { \q_no_value } + \char_set_active_eq:NN \< \__codedoc_shorthand_meta: + \char_set_catcode_active:N \< + } +\cs_new_protected:Npn \__codedoc_shorthand_meta: + { \mode_if_math:TF { < } { \__codedoc_shorthand_meta:w } } +\cs_new_protected_nopar:Npn \__codedoc_shorthand_meta:w #1 > { \meta {#1} } +\cs_new_protected:Npn \__codedoc_function_reset: + { + \tl_set:Nn \l__codedoc_override_module_tl { \q_no_value } + } +\cs_new_protected:Npn \__codedoc_function_typeset: + { + \dim_zero:N \l__codedoc_trial_width_dim + \hcoffin_set:Nn \l__codedoc_functions_coffin { \__codedoc_typeset_functions: } + \dim_set:Nn \l__codedoc_trial_width_dim + { \box_wd:N \l__codedoc_functions_coffin } + \bool_set:Nn \l__codedoc_long_name_bool + { \dim_compare_p:nNn \l__codedoc_trial_width_dim > {\marginparwidth + 1cm} } % FMi crude fix + } +\cs_new_protected:Npn \__codedoc_function_descr_start:w + { + \vcoffin_set:Nnw \l__codedoc_descr_coffin { \textwidth } + \noindent \ignorespaces + } +\cs_new_protected:Npn \__codedoc_function_descr_stop: + { \vcoffin_set_end: } +\cs_new_protected:Npn \__codedoc_function_assemble: + { + \hcoffin_set:Nn \l__codedoc_syntax_coffin + { \box_use_drop:N \g__codedoc_syntax_box } + \bool_if:NTF \l__codedoc_long_name_bool + { + \coffin_join:NnnNnnnn + \l__codedoc_output_coffin {hc} {vc} + \l__codedoc_syntax_coffin {l} {T} + {0pt} {0pt} + \coffin_join:NnnNnnnn + \l__codedoc_output_coffin {l} {t} + \l__codedoc_functions_coffin {r} {t} + {-\marginparsep} {0pt} + \coffin_join:NnnNnnnn + \l__codedoc_output_coffin {l} {b} + \l__codedoc_descr_coffin {l} {t} + {0.75\marginparwidth + \marginparsep} {-\medskipamount} + \coffin_typeset:Nnnnn \l__codedoc_output_coffin + {\l__codedoc_descr_coffin-l} {\l__codedoc_descr_coffin-t} + {0pt} {0pt} + } + { + \coffin_join:NnnNnnnn + \l__codedoc_output_coffin {hc} {vc} + \l__codedoc_syntax_coffin {l} {t} + {0pt} {0pt} + \coffin_join:NnnNnnnn + \l__codedoc_output_coffin {l} {b} + \l__codedoc_descr_coffin {l} {t} + {0pt} {-\medskipamount} + \coffin_join:NnnNnnnn + \l__codedoc_output_coffin {l} {t} + \l__codedoc_functions_coffin {r} {t} + {-\marginparsep} {0pt} + \coffin_typeset:Nnnnn \l__codedoc_output_coffin + {\l__codedoc_syntax_coffin-l} {\l__codedoc_syntax_coffin-T} + {0pt} {0pt} + } + } +\cs_new_protected:Npn \__codedoc_typeset_functions: + { + \small\ttfamily + \HD@savedestfalse + \HD@target + \Hy@MakeCurrentHref { HD. \int_use:N \c@HD@hypercount } + \begin{tabular} [t] { @{} l @{} >{\hspace{\tabcolsep}} r @{} } + \toprule + \__codedoc_function_extra_labels: + \__codedoc_names_typeset: + \__codedoc_typeset_dates: + \bottomrule + \end{tabular} + \normalfont\normalsize + } +\cs_new_protected:Npn \__codedoc_typeset_function_block:nN #1#2 + { + \__codedoc_function_index:x + { #1 \bool_if:NT #2 { \tl_to_str:n {TF} } } + \__codedoc_function_label:xN {#1} #2 + #1 + \bool_if:NT #2 { \__codedoc_typeset_TF: } + \__codedoc_typeset_expandability: + \seq_if_empty:NF \g__codedoc_variants_seq + { \__codedoc_typeset_variant_list:nN {#1} #2 } + \\ + } +\cs_generate_variant:Nn \__codedoc_typeset_function_block:nN { x } +\cs_new_protected:Npn \__codedoc_function_index:n #1 + { + \seq_gput_right:Nn \g_doc_functions_seq {#1} + \__codedoc_special_index:nn {#1} { usage } + } +\cs_generate_variant:Nn \__codedoc_function_index:n { x } +\cs_new_protected:Npn \__codedoc_typeset_expandability: + { + & + \bool_if:NT \l__codedoc_macro_EXP_bool { \__codedoc_typeset_exp: } + \bool_if:NT \l__codedoc_macro_rEXP_bool { \__codedoc_typeset_rexp: } + } +\cs_new_protected:Npn \__codedoc_typeset_variant_list:nN #1#2 + { + \\ + \__codedoc_typeset_aux:n { \__codedoc_get_function_name:n {#1} } + : + \int_compare:nTF { \seq_count:N \g__codedoc_variants_seq == 1 } + { \seq_use:Nn \g__codedoc_variants_seq { } } + { + \textrm( + \seq_use:Nn \g__codedoc_variants_seq { \textrm| } + \textrm) + } + \bool_if:NT #2 { \__codedoc_typeset_TF: } + \__codedoc_typeset_expandability: + } +\cs_new_protected:Npn \__codedoc_function_extra_labels: + { + \bool_if:NT \l__codedoc_no_label_bool + { + \clist_map_inline:Nn \l__codedoc_function_label_clist + { + \__codedoc_get_hyper_target:oN { \token_to_str:N ##1 } + \l__codedoc_tmpa_tl + \exp_args:No \label { \l__codedoc_tmpa_tl } + } + } + } +\cs_new_protected:Npn \__codedoc_function_label:nN #1#2 + { + \bool_if:NF \l__codedoc_no_label_bool + { + \__codedoc_get_hyper_target:xN + { + \exp_not:n {#1} + \bool_if:NT #2 { \tl_to_str:n {TF} } + } + \l__codedoc_tmpa_tl + \exp_args:No \label { \l__codedoc_tmpa_tl } + } + } +\cs_generate_variant:Nn \__codedoc_function_label:nN { x } +\cs_new:Npn \__codedoc_typeset_dates: + { + \bool_lazy_and:nnF + { \tl_if_empty_p:N \l__codedoc_date_added_tl } + { \tl_if_empty_p:N \l__codedoc_date_updated_tl } + { \midrule } + \tl_if_empty:NF \l__codedoc_date_added_tl + { + \multicolumn { 2 } { @{} r @{} } + { \scriptsize New: \, \l__codedoc_date_added_tl } \\ + } + + \tl_if_empty:NF \l__codedoc_date_updated_tl + { + \multicolumn { 2 } { @{} r @{} } + { \scriptsize Updated: \, \l__codedoc_date_updated_tl } \\ + } + } +\dim_new:N \l__codedoc_syntax_dim +\cs_new_protected:Npn \__codedoc_syntax:w + { + \box_if_empty:NF \g__codedoc_syntax_box + { \msg_error:nn { l3doc-TUB } { multiple-syntax } } + \dim_set:Nn \l__codedoc_syntax_dim + { + \textwidth + \bool_if:NT \l__codedoc_long_name_bool + { + 0.75 \marginparwidth - \l__codedoc_trial_width_dim } + } + \hbox_gset:Nw \g__codedoc_syntax_box + \small \ttfamily + \arrayrulecolor{white} + \begin{tabular} { @{} l @{} } + \toprule + \begin{minipage}[t]{\l__codedoc_syntax_dim} + \raggedright + \obeyspaces + \obeylines + } +\cs_new_protected:Npn \__codedoc_syntax_end: + { + \end{minipage} + \end{tabular} + \arrayrulecolor{black} + \hbox_gset_end: + \bool_if:NF \l__codedoc_in_function_bool + { + \begin{quote} + \mode_leave_vertical: + \box_use_drop:N \g__codedoc_syntax_box + \end{quote} + } + } +\keys_define:nn { l3doc-TUB/macro } + { + aux .value_forbidden:n = true , + aux .code:n = + { + \msg_warning:nnnn { l3doc-TUB } { deprecated-option } + { aux } { function/macro } + } , + internal .value_forbidden:n = true , + internal .code:n = + { + \bool_set_true:N \l__codedoc_macro_internal_bool + \bool_set_true:N \l__codedoc_macro_internal_set_bool + } , + int .value_forbidden:n = true , + int .code:n = + { + \bool_set_true:N \l__codedoc_macro_internal_bool + \bool_set_true:N \l__codedoc_macro_internal_set_bool + } , + var .value_forbidden:n = true , + var .code:n = + { \bool_set_true:N \l__codedoc_macro_var_bool } , + TF .value_forbidden:n = true , + TF .code:n = + { \bool_set_true:N \l__codedoc_macro_TF_bool } , + pTF .value_forbidden:n = true , + pTF .code:n = + { + \bool_set_true:N \l__codedoc_macro_TF_bool + \bool_set_true:N \l__codedoc_macro_pTF_bool + \bool_set_true:N \l__codedoc_macro_EXP_bool + \bool_set_false:N \l__codedoc_macro_rEXP_bool + } , + noTF .value_forbidden:n = true , + noTF .code:n = + { + \bool_set_true:N \l__codedoc_macro_TF_bool + \bool_set_true:N \l__codedoc_macro_noTF_bool + } , + EXP .value_forbidden:n = true , + EXP .code:n = + { + \bool_set_true:N \l__codedoc_macro_EXP_bool + \bool_set_false:N \l__codedoc_macro_rEXP_bool + } , + rEXP .value_forbidden:n = true , + rEXP .code:n = + { + \bool_set_false:N \l__codedoc_macro_EXP_bool + \bool_set_true:N \l__codedoc_macro_rEXP_bool + } , + tested .code:n = + { + \bool_set_true:N \l__codedoc_macro_tested_bool + } , + added .code:n = {} , % TODO + updated .code:n = {} , % TODO + deprecated .code:n = { \__codedoc_deprecated_on:n {#1} } , + verb .bool_set:N = \l__codedoc_names_verb_bool , + module .tl_set:N = \l__codedoc_override_module_tl , + documented-as .tl_set:N = \l__codedoc_macro_documented_tl , + } +\cs_new_protected:Npn \__codedoc_macro:nnw #1#2 + { + \__codedoc_macro_init: + \tl_set:Nn \l__codedoc_macro_argument_tl {#2} + \keys_set:nn { l3doc-TUB/macro } {#1} + \__codedoc_names_get_seq:nN {#2} \l__codedoc_names_seq + \__codedoc_names_parse: + \__codedoc_macro_save_names: + \__codedoc_names_typeset: + \__codedoc_macro_dump: + \__codedoc_macro_reset: + } +\cs_new_protected:Npn \__codedoc_macro_init: + { + \int_incr:N \l__codedoc_nested_macro_int + \bool_set_false:N \l__codedoc_macro_internal_bool + \bool_set_false:N \l__codedoc_macro_internal_set_bool + \bool_set_false:N \l__codedoc_macro_TF_bool + \bool_set_false:N \l__codedoc_macro_pTF_bool + \bool_set_false:N \l__codedoc_macro_noTF_bool + \bool_set_false:N \l__codedoc_macro_EXP_bool + \bool_set_false:N \l__codedoc_macro_rEXP_bool + \bool_set_false:N \l__codedoc_macro_var_bool + \bool_set_false:N \l__codedoc_macro_tested_bool + \bool_set_false:N \l__codedoc_names_verb_bool + \tl_set:Nn \l__codedoc_override_module_tl { \q_no_value } + \tl_clear:N \l__codedoc_macro_documented_tl + \cs_set_eq:NN \testfile \__codedoc_print_testfile:n + \box_clear:N \l__codedoc_macro_index_box + \vbox_set:Nn \l__codedoc_macro_box + { + \hbox:n + { + \strut + \int_compare:nNnT \l__codedoc_macro_int = 0 + { \HD@target } + } + \vskip \int_eval:n { \l__codedoc_macro_int - 1 } \baselineskip + } + } +\cs_new_protected:Npn \__codedoc_macro_reset: + { + \tl_set:Nn \l__codedoc_override_module_tl { \q_no_value } + } +\cs_new_protected:Npn \__codedoc_macro_save_names: + { + \tl_if_empty:NTF \l__codedoc_macro_documented_tl + { \__codedoc_names_block_base_map:N \__codedoc_macro_save_names_aux:n } + { + \seq_gput_right:Nf \g__codedoc_nested_names_seq + { \exp_after:wN \token_to_str:N \l__codedoc_macro_documented_tl } + } + } +\cs_new_protected:Npn \__codedoc_macro_save_names_aux:n #1 + { \seq_gput_right:Nn \g__codedoc_nested_names_seq {#1} } +\cs_new_protected:Npn \__codedoc_macro_dump: + { + \topsep\MacroTopsep + \trivlist + \cs_set:Npn \makelabel ##1 + { + \llap + { + \hbox_unpack_drop:N \l__codedoc_macro_index_box + \vtop to \baselineskip + { + \vbox_unpack_drop:N \l__codedoc_macro_box + \vss + } + } + } + \item [ ] + } +\cs_new_protected:Npn \__codedoc_macro_typeset_block:nN #1#2 + { + \__codedoc_macro_single:nNN {#1} \c_true_bool #2 + \seq_if_empty:NF \g__codedoc_variants_seq + { + \__codedoc_macro_typeset_variant_list:xN + { \__codedoc_get_function_name:n {#1} } #2 + } + } +\cs_generate_variant:Nn \__codedoc_macro_typeset_block:nN { x } +\cs_new_protected:Npn \__codedoc_macro_typeset_variant_list:nN #1#2 + { + \seq_map_inline:Nn \g__codedoc_variants_seq + { \__codedoc_macro_single:nNN { #1 : ##1 } \c_false_bool #2 } + } +\cs_generate_variant:Nn \__codedoc_macro_typeset_variant_list:nN { x } +\cs_new_protected:Npn \__codedoc_macro_single:nNN #1#2#3 + { + \tl_set:Nn \saved@macroname {#1} + \__codedoc_macro_typeset_one:nN {#1} #3 + \bool_if:NT #3 { \DoNotIndex {#1} } + \exp_args:Nx \__codedoc_macro_index:nN + { #1 \bool_if:NT #3 { \tl_to_str:n { TF } } } + #2 + } +\cs_new_protected:Npn \__codedoc_macro_index:nN #1#2 + { + \DoNotIndex {#1} + \bool_if:NT #2 + { + \__codedoc_if_macro_internal:nF {#1} + { \seq_gput_right:Nn \g_doc_macros_seq {#1} } + \hbox_set:Nw \l__codedoc_macro_index_box + \hbox_unpack_drop:N \l__codedoc_macro_index_box + \int_gincr:N \c@CodelineNo + \__codedoc_special_index:nn {#1} { main } + \int_gdecr:N \c@CodelineNo + \exp_args:NNNo \hbox_set_end: + \tl_set:Nn \saved@indexname { \l__codedoc_index_key_tl } + } + } +\cs_new_protected:Npn \__codedoc_macro_typeset_one:nN #1#2 + { + \vbox_set:Nn \l__codedoc_macro_box + { + \vbox_unpack_drop:N \l__codedoc_macro_box + \hbox { \llap { \__codedoc_print_macroname:nN {#1} #2 \ } } + } + \int_incr:N \l__codedoc_macro_int + } +\cs_new_protected:Npn \__codedoc_print_macroname:nN #1#2 + { + \strut + \__codedoc_get_hyper_target:xN + { + \exp_not:n {#1} + \bool_if:NT #2 { \tl_to_str:n {TF} } + } + \l__codedoc_tmpa_tl + \cs_if_exist:cTF { r@ \l__codedoc_tmpa_tl } + { \exp_last_unbraced:NNo \hyperref [ \l__codedoc_tmpa_tl ] } + { \use:n } + { + \int_compare:nTF { \str_count:n {#1} <= 28 } + { \MacroFont } { \MacroLongFont } + \tl_set:Nn \l__codedoc_tmpa_tl {#1} + \tl_replace_all:Nno \l__codedoc_tmpa_tl + { ~ } { \c_catcode_other_space_tl } + \__codedoc_macroname_prefix:o \l__codedoc_tmpa_tl + \__codedoc_macroname_suffix:N #2 + } + } +\cs_new_protected:Npn \__codedoc_macroname_prefix:n #1 + { + \__codedoc_if_macro_internal:nTF {#1} + { \__codedoc_typeset_aux:n {#1} } {#1} + } +\cs_generate_variant:Nn \__codedoc_macroname_prefix:n { o } +\cs_new_protected:Npn \__codedoc_macroname_suffix:N #1 + { \bool_if:NTF #1 { \__codedoc_typeset_TF: } { } } +\providecommand \MacroLongFont + { + \fontfamily{lmtt}\fontseries{lc}\small + } +\cs_new_protected:Npn \__codedoc_print_testfile:n #1 + { + \bool_set_true:N \l__codedoc_macro_tested_bool + \tl_if_eq:nnF {#1} {*} + { + \seq_if_in:NnF \g__codedoc_testfiles_seq {#1} + { + \seq_gput_right:Nn \g__codedoc_testfiles_seq {#1} + \par + \__codedoc_print_testfile_aux:n {#1} + } + } + } +\cs_new_protected:Npn \__codedoc_print_testfile_aux:n #1 + { + \footnotesize + ( + \textit + { + The~ test~ suite~ for~ this~ command,~ + and~ others~ in~ this~ file,~ is~ \textsf{#1} + }. + )\par + } +\DeclareDocumentCommand \TestFiles {m} + { + \par + \textit + { + The~ following~ test~ files~ are~ + used~ for~ this~ code:~ \textsf{#1}. + } + \par \ignorespaces + } +\DeclareDocumentCommand \UnitTested { } { \testfile* } +\DeclareDocumentCommand \TestMissing { m } + { \__codedoc_test_missing:n {#1} } +\cs_new_protected:Npn \__codedoc_test_missing:n #1 + { + \__codedoc_test_missing_aux:Nxn + \g__codedoc_missing_tests_prop + { \seq_use:Nn \l__codedoc_names_seq { , } } + { { \g_file_curr_name_str \iow_char:N \ (#1) } } + } +\cs_new_protected:Npn \__codedoc_test_missing_aux:Nnn #1#2#3 + { + \prop_get:NnNTF #1 {#2} \l__codedoc_tmpa_tl + { \tl_put_right:Nn \l__codedoc_tmpa_tl { , #3 } } + { \tl_set:Nn \l__codedoc_tmpa_tl {#3} } + \prop_put:Nno #1 {#2} \l__codedoc_tmpa_tl + } +\cs_generate_variant:Nn \__codedoc_test_missing_aux:Nnn { Nx } +\cs_new_protected:Npn \__codedoc_macro_end: + { + \endtrivlist + \__codedoc_macro_end_check_tested: + \int_compare:nNnT \l__codedoc_nested_macro_int = 1 + { \__codedoc_macro_end_style:n { \__codedoc_print_end_definition: } } + } +\cs_new_protected:Npn \__codedoc_macro_end_check_tested: + { + \bool_lazy_all:nT + { + { \g__codedoc_checktest_bool } + { ! \l__codedoc_macro_var_bool } + { ! \l__codedoc_macro_tested_bool } + } + { + \seq_set_filter:NNn \l__codedoc_tmpa_seq \l__codedoc_names_seq + { ! \__codedoc_if_macro_internal_p:n {##1} } + \seq_gput_right:Nx \g__codedoc_not_tested_seq + { + \seq_use:Nn \l__codedoc_tmpa_seq { , } + \bool_if:NTF \l__codedoc_macro_pTF_bool {~(pTF)} + { \bool_if:NT \l__codedoc_macro_TF_bool {~(TF)} } + } + } + } +\cs_new_protected:Npn \__codedoc_macro_end_style:n #1 + { + \nobreak \noindent + { \footnotesize ( \emph{#1} ) \par } + } +\cs_new_protected:Npn \__codedoc_macro_end_wrap_item:n #1 + { + \tl_set:Nn \l__codedoc_tmpa_tl {#1} + \tl_replace_all:Non \l__codedoc_tmpa_tl + { \token_to_str:N _ } { \_ } + \texttt { \l__codedoc_tmpa_tl } + } +\cs_new_protected:Npn \__codedoc_print_end_definition: + { + \seq_set_map:NNn \l__codedoc_tmpa_seq + \g__codedoc_nested_names_seq + { \exp_not:n { \__codedoc_macro_end_wrap_item:n {##1} } } + End~ definition~ for~ + \int_compare:nTF { \seq_count:N \l__codedoc_tmpa_seq <= 3 } + { + \seq_use:Nnnn \l__codedoc_tmpa_seq + { \,~and~ } { \,,~ } { \,,~and~ } + } + { \seq_item:Nn \l__codedoc_tmpa_seq {1}\,~and~others } + \@. + \__codedoc_print_documented: + } +\cs_new_protected:Npn \__codedoc_print_documented: + { + \seq_gset_filter:NNn \g__codedoc_nested_names_seq + \g__codedoc_nested_names_seq + { ! \__codedoc_if_macro_internal_p:n {##1} } + \seq_if_empty:NF \g__codedoc_nested_names_seq + { + \int_set:Nn \l__codedoc_tmpa_int + { \seq_count:N \g__codedoc_nested_names_seq } + \int_compare:nNnTF \l__codedoc_tmpa_int = 1 {~This~} {~These~} + \bool_if:NTF \l__codedoc_macro_var_bool {variable} {function} + \int_compare:nNnTF \l__codedoc_tmpa_int = 1 {~is~} {s~are~} + documented~on~page~ + \__codedoc_get_hyper_target:xN + { \seq_item:Nn \g__codedoc_nested_names_seq { 1 } } + \l__codedoc_tmpa_tl + \exp_args:Nx \pageref { \l__codedoc_tmpa_tl } . + } + \seq_gclear:N \g__codedoc_nested_names_seq + } +\newcommand*{\DescribeOption} + { + \leavevmode + \@bsphack + \begingroup + \MakePrivateLetters + \Describe@Option + } +\newcommand*{\Describe@Option}[1] + { + \endgroup + \marginpar{ + \raggedleft + \PrintDescribeEnv{#1} + } + \SpecialOptionIndex{#1} + \@esphack + \ignorespaces + } +\newcommand*{\SpecialOptionIndex}[1] + { + \@bsphack + \begingroup + \HD@target + \let\HDorg@encapchar\encapchar + \edef\encapchar usage + { + \HDorg@encapchar hdclindex{\the\c@HD@hypercount}{usage} + } + \index + { + #1\actualchar{\protect\ttfamily#1}~(option) + \encapchar usage + } + \index + { + options:\levelchar#1\actualchar{\protect\ttfamily#1} + \encapchar usage + } + \endgroup + \@esphack + } +\font \manual = manfnt \scan_stop: +\cs_gset:Npn \dbend { {\manual\char127} } +\newenvironment {danger} + { + \begin{trivlist}\item[]\noindent + \begingroup\hangindent=2pc\hangafter=-2 + \cs_set:Npn \par{\endgraf\endgroup} + \hbox to0pt{\hskip-\hangindent\dbend\hfill}\ignorespaces + } + { + \par\end{trivlist} + } +\newenvironment {ddanger} + { + \begin{trivlist}\item[]\noindent + \begingroup\hangindent=3.5pc\hangafter=-2 + \cs_set:Npn \par{\endgraf\endgroup} + \hbox to0pt{\hskip-\hangindent\dbend\kern2pt\dbend\hfill}\ignorespaces + }{ + \par\end{trivlist} + } +\newenvironment{TemplateInterfaceDescription}[1] + { + \subsection{The~object~type~`#1'} + \begingroup + \@beginparpenalty\@M + \description + \def\TemplateArgument##1##2{\item[Arg:~##1]##2\par} + \def\TemplateSemantics + { + \enddescription\endgroup + \subsubsection*{Semantics:} + } + } + { + \par\bigskip + } +\newenvironment{TemplateDescription}[2] + { + \subsection{The~template~`#2'~(object~type~#1)} + \subsubsection*{Attributes:} + \begingroup + \@beginparpenalty\@M + \description + \def\TemplateKey##1##2##3##4 + { + \item[##1~(##2)]##3% + \ifx\TemplateKey##4\TemplateKey\else + \hfill\penalty500\hbox{}\hfill Default:~##4% + \nobreak\hskip-\parfillskip\hskip0pt\relax + \fi + \par + } + \def\TemplateSemantics + { + \enddescription\endgroup + \subsubsection*{Semantics~\&~Comments:} + } + } + { \par \bigskip } +\newenvironment{InstanceDescription}[4][xxxxxxxxxxxxxxx] + { + \subsubsection{The~instance~`#3'~(template~#2/#4)} + \subsubsection*{Attribute~values:} + \begingroup + \@beginparpenalty\@M + \def\InstanceKey##1##2{\>\textbf{##1}\>##2\\} + \def\InstanceSemantics{\endtabbing\endgroup + \vskip-30pt\vskip0pt + \subsubsection*{Layout~description~\&~Comments:}} + \tabbing + xxxx\=#1\=\kill + } + { \par \bigskip } +\DeclareDocumentCommand \OnlyDescription { } + { \bool_gset_false:N \g__codedoc_typeset_implementation_bool } +\DeclareDocumentCommand \AlsoImplementation { } + { \bool_gset_true:N \g__codedoc_typeset_implementation_bool } +\DeclareDocumentCommand \StopEventually { m } + { + \bool_if:NTF \g__codedoc_typeset_implementation_bool + { + \@bsphack + \tl_gset:Nn \g__codedoc_finale_tl { #1 \check@checksum } + \init@checksum + \@esphack + } + { #1 \endinput } + } +\DeclareDocumentCommand \Finale { } + { \tl_use:N \g__codedoc_finale_tl } +\tl_new:N \g__codedoc_finale_tl +\cs_new_protected:Npn \__codedoc_input:n #1 + { + \tl_gclear:N \g__codedoc_module_name_tl + \MakePercentIgnore + \input{#1} + \MakePercentComment + } +\DeclareDocumentCommand \DocInput { m } + { + \clist_map_inline:nn {#1} + { + \clist_put_right:Nn \g_docinput_clist {##1} + \__codedoc_input:n {##1} + } + } +\DeclareDocumentCommand \DocInputAgain { } + { \clist_map_function:NN \g_docinput_clist \__codedoc_input:n } +\NewDocumentCommand \DocInclude { m } + { + \relax\clearpage + \docincludeaux + \IfFileExists{#1.fdd} + { \cs_set:Npn \currentfile{#1.fdd} } + { \cs_set:Npn \currentfile{#1.dtx} } + \int_compare:nNnTF \@auxout = \@partaux + { \@latexerr{\string\include\space cannot~be~nested}\@eha } + { \@docinclude #1 } + } +\cs_gset:Npn \@docinclude #1 + { + \clearpage + \immediate\write\@mainaux{\string\@input{#1.aux}} + \@tempswatrue + \if@partsw + \@tempswafalse + \cs_set:Npx \@tempb{#1} + \@for\@tempa:=\@partlist\do + { + \ifx\@tempa\@tempb\@tempswatrue\fi + } + \fi + \if@tempswa + \cs_set_eq:NN \@auxout \@partaux + \immediate\openout\@partaux #1.aux + \immediate\write\@partaux{\relax} + \cs_set_eq:NN \@ltxdoc@PrintIndex \PrintIndex + \cs_set_eq:NN \PrintIndex \relax + \cs_set_eq:NN \@ltxdoc@PrintChanges \PrintChanges + \cs_set_eq:NN \PrintChanges \relax + \cs_set_eq:NN \@ltxdoc@theglossary \theglossary + \cs_set_eq:NN \@ltxdoc@endtheglossary \endtheglossary + \part{\currentfile} + { + \cs_set_eq:NN \ttfamily\relax + \cs_gset:Npx \filekey + { \filekey, \thepart = { \ttfamily \currentfile } } + } + \DocInput{\currentfile} + \cs_set_eq:NN \PrintIndex \@ltxdoc@PrintIndex + \cs_set_eq:NN \PrintChanges \@ltxdoc@PrintChanges + \cs_set_eq:NN \theglossary \@ltxdoc@theglossary + \cs_set_eq:NN \endtheglossary \@ltxdoc@endtheglossary + \clearpage + \@writeckpt{#1} + \immediate \closeout \@partaux + \else + \@nameuse{cp@#1} + \fi + \cs_set_eq:NN \@auxout \@mainaux + } +\cs_gset:Npn \codeline@wrindex #1 + { + \immediate\write\@indexfile + { + \string\indexentry{#1} + { \filesep \int_use:N \c@CodelineNo } + } + } +\tl_gclear:N \filesep +\cs_gset:Npn \docincludeaux + { + \tl_set:Nn \thepart { \alphalph { part } } + \tl_set:Nn \filesep { \thepart - } + \cs_set_eq:NN \filekey \use_none:n + \tl_gput_right:Nn \index@prologue + { + \cs_gset:Npn \@oddfoot + { + \parbox { \textwidth } + { + \strut \footnotesize + \raggedright { \bfseries File~Key: } ~ \filekey + } + } + \cs_set_eq:NN \@evenfoot \@oddfoot + } + \cs_gset_eq:NN \docincludeaux \relax + \cs_gset:Npn \@oddfoot + { + \cs_if_exist:cTF { ver @ \currentfile } + { File~\thepart :~{\ttfamily\currentfile}~ } + { + \GetFileInfo{\currentfile} + File~\thepart :~{\ttfamily\filename}~ + Date:~\ExplFileDate\ % space + Version~\ExplFileVersion + } + \hfill \thepage + } + \cs_set_eq:NN \@evenfoot \@oddfoot + } +\group_begin: + \char_set_catcode_other:N \^^A + \char_set_catcode_active:N \^^S + \char_set_catcode_active:N \^^B + \char_set_catcode_other:N \^^L + \char_set_catcode_other:N \^^R + \char_set_lccode:nn { `\^^A } { `\% } + \char_set_lccode:nn { `\^^S } { `\ } + \char_set_lccode:nn { `\^^B } { `\\ } + \char_set_lccode:nn { `\^^L } { `\{ } + \char_set_lccode:nn { `\^^R } { `\} } + \tex_lowercase:D + { + \group_end: + \cs_set_protected:Npn \xmacro@code + #1 ^^A ^^S^^S^^S^^S ^^Bend ^^Lmacrocode^^R + { \__codedoc_xmacro_code:n {#1} \end{macrocode} } + } +\group_begin: + \char_set_catcode_active:N \< + \char_set_catcode_active:N \> + \cs_new_protected:Npn \__codedoc_xmacro_code:n #1 + { + \tl_if_in:nnTF {#1} { < @ @ = } + { \__codedoc_xmacro_code:w #1 \q_stop } + { + \tl_set:Nn \l__codedoc_tmpa_tl {#1} + \__codedoc_replace_at_at:N \l__codedoc_tmpa_tl + \tl_use:N \l__codedoc_tmpa_tl + } + } + \cs_new_protected:Npn \__codedoc_xmacro_code:w #1 < @ @ = #2 > #3 \q_stop + { + \tl_set:Nn \l__codedoc_tmpa_tl {#1} + \__codedoc_replace_at_at:N \l__codedoc_tmpa_tl + + \tl_gset:Nn \g__codedoc_module_name_tl {#2} + \tl_put_right:Nn \l__codedoc_tmpa_tl { < @ @ = #2 > } + + \tl_set:Nn \l__codedoc_tmpb_tl {#3} + \__codedoc_replace_at_at:N \l__codedoc_tmpb_tl + \tl_put_right:No \l__codedoc_tmpa_tl { \l__codedoc_tmpb_tl } + + \tl_use:N \l__codedoc_tmpa_tl + } +\group_end: +\iow_new:N \g__codedoc_func_iow +\tl_new:N \l__codedoc_doc_def_tl +\tl_new:N \l__codedoc_doc_undef_tl +\tl_new:N \l__codedoc_undoc_def_tl +\cs_new_protected:Npn \__codedoc_show_functions_defined: + { + \bool_lazy_and:nnT + { \g__codedoc_typeset_implementation_bool } { \g__codedoc_checkfunc_bool } + { + \iow_term:x { \c__codedoc_iow_separator_tl \iow_newline: } + \iow_open:Nn \g__codedoc_func_iow { \c_sys_jobname_str .cmds } + + \tl_clear:N \l__codedoc_doc_def_tl + \tl_clear:N \l__codedoc_doc_undef_tl + \tl_clear:N \l__codedoc_undoc_def_tl + \seq_map_inline:Nn \g_doc_functions_seq + { + \seq_if_in:NnTF \g_doc_macros_seq {##1} + { + \tl_put_right:Nx \l__codedoc_doc_def_tl + { ##1 \iow_newline: } + \iow_now:Nn \g__codedoc_func_iow { > ~ ##1 } + } + { + \tl_put_right:Nx \l__codedoc_doc_undef_tl + { ##1 \iow_newline: } + \iow_now:Nn \g__codedoc_func_iow { ! ~ ##1 } + } + } + \seq_map_inline:Nn \g_doc_macros_seq + { + \seq_if_in:NnF \g_doc_functions_seq {##1} + { + \tl_put_right:Nx \l__codedoc_undoc_def_tl + { ##1 \iow_newline: } + \iow_now:Nn \g__codedoc_func_iow { ? ~ ##1 } + } + } + \__codedoc_functions_typeout:nN + { + Functions~both~documented~and~defined: \iow_newline: + (In~order~of~being~documented) + } + \l__codedoc_doc_def_tl + \__codedoc_functions_typeout:nN + { Functions~documented~but~not~defined: } + \l__codedoc_doc_undef_tl + \__codedoc_functions_typeout:nN + { Functions~defined~but~not~documented: } + \l__codedoc_undoc_def_tl + + \iow_close:N \g__codedoc_func_iow + \iow_term:x { \c__codedoc_iow_separator_tl } + } + } +\AtEndDocument { \__codedoc_show_functions_defined: } +\cs_new_protected:Npn \__codedoc_functions_typeout:nN #1#2 + { + \tl_if_empty:NF #2 + { + \typeout + { + \c__codedoc_iow_midrule_tl \iow_newline: + #1 \iow_newline: + \c__codedoc_iow_midrule_tl \iow_newline: + #2 + } + \tl_clear:N #2 + } + } +\cs_new_protected:Npn \__codedoc_show_not_tested: + { + \bool_if:NT \g__codedoc_checktest_bool + { + \tl_clear:N \l__codedoc_tmpa_tl + \prop_if_empty:NF \g__codedoc_missing_tests_prop + { + \cs_set:Npn \__codedoc_tmpa:w ##1##2 + { + \iow_newline: + \space\space\space\space \exp_not:n {##1} + \clist_map_function:nN {##2} \__codedoc_tmpb:w + } + \cs_set:Npn \__codedoc_tmpb:w ##1 + { + \iow_newline: + \space\space\space\space\space\space * ~ ##1 + } + \tl_put_right:Nx \l__codedoc_tmpa_tl + { + \iow_newline: \iow_newline: + The~ following~ macro(s)~ have~ incomplete~ tests: + \iow_newline: + \prop_map_function:NN + \g__codedoc_missing_tests_prop \__codedoc_tmpa:w + } + } + \seq_if_empty:NF \g__codedoc_not_tested_seq + { + \cs_set:Npn \__codedoc_tmpa:w ##1 + { \clist_map_function:nN {##1} \__codedoc_tmpb:w } + \cs_set:Npn \__codedoc_tmpb:w ##1 + { + \iow_newline: + \space\space\space\space ##1 + } + \tl_put_right:Nx \l__codedoc_tmpa_tl + { + \iow_newline: + \iow_newline: + The~ following~ macro(s)~ do~ not~ have~ any~ tests: + \iow_newline: + \seq_map_function:NN + \g__codedoc_not_tested_seq \__codedoc_tmpa:w + } + } + \tl_if_empty:NF \l__codedoc_tmpa_tl + { + \int_set:Nn \l__codedoc_tmpa_int { \etex_interactionmode:D } + \errorstopmode + \ClassError { l3doc-TUB } { \l__codedoc_tmpa_tl } { } + \int_set:Nn \etex_interactionmode:D { \l__codedoc_tmpa_int } + } + } + } +\AtEndDocument { \__codedoc_show_not_tested: } +\g@addto@macro \theindex { \MakePrivateLetters } +\cs_gset:Npn \verbatimchar {&} +\setcounter { IndexColumns } { 2 } +\IndexPrologue + { + \section*{Index} + \markboth{Index}{Index} + \addcontentsline{toc}{section}{Index} + The~italic~numbers~denote~the~pages~where~the~ + corresponding~entry~is~described,~ + numbers~underlined~point~to~the~definition,~ + all~others~indicate~the~places~where~it~is~used. + } +\cs_gset_protected:Npn \SpecialIndex #1 + { + \@bsphack + \__codedoc_special_index:nn {#1} { } + \@esphack + } +\msg_new:nnn { l3doc-TUB } { print-index-howto } + { + Generate~the~index~by~executing\\ + \iow_indent:n + { makeindex~-s~gind.ist~-o~\c_sys_jobname_str.ind~\c_sys_jobname_str.idx } + } +\tl_gput_right:Nn \PrintIndex + { \AtEndDocument { \msg_info:nn { l3doc-TUB } { print-index-howto } } } +\cs_gset_protected:Npn \it@is@a #1 + { + \use:x + { + \__codedoc_special_index_module:nnnnN + {#1} + { \bslash #1 } + { } + { } + \c_false_bool + } + } +\cs_new_protected:Npn \__codedoc_special_index:nn #1#2 + { + \__codedoc_key_get:n {#1} + \quark_if_no_value:NF \l__codedoc_override_module_tl + { \tl_set_eq:NN \l__codedoc_index_module_tl \l__codedoc_override_module_tl } + \__codedoc_special_index_module:ooonN + { \l__codedoc_index_key_tl } + { \l__codedoc_index_macro_tl } + { \l__codedoc_index_module_tl } + {#2} + \l__codedoc_index_internal_bool + } +\cs_generate_variant:Nn \__codedoc_special_index:nn { o } +\tl_new:N \l__codedoc_index_escaped_macro_tl +\tl_new:N \l__codedoc_index_escaped_key_tl +\cs_new_protected:Npn \__codedoc_special_index_module:nnnnN #1#2#3#4#5 + { + \use:x + { + \exp_not:n { \__codedoc_special_index_aux:nnnnnn {#1} {#2} } + \tl_if_empty:nTF {#3} + { { } { } { } } + { + \str_if_eq:eeTF {#3} { TeX } + { + { TeX~and~LaTeX2e } + { \string\TeX{}~and~\string\LaTeXe{} } + } + { + {#3} + { \string\pkg{#3} } + } + { \bool_if:NT #5 { ~internal } ~commands: } + } + } + {#4} + } +\cs_generate_variant:Nn \__codedoc_special_index_module:nnnnN { ooo } +\cs_new_protected:Npn \__codedoc_special_index_aux:nnnnnn #1#2#3#4#5#6 + { + \tl_set:Nn \l__codedoc_index_escaped_key_tl {#1} + \__codedoc_quote_special_char:N \l__codedoc_index_escaped_key_tl + \__codedoc_special_index_set:Nn \l__codedoc_index_escaped_macro_tl {#2} + \str_if_eq:onTF { \@currenvir } { macrocode } + { \codeline@wrindex } + { + \str_case:nnF {#6} + { + { main } { \codeline@wrindex } + { usage } { \index } + } + { \HD@target \index } + } + { + \tl_if_empty:nF { #3 #4 #5 } + { #3 #5 \actualchar #4 #5 \levelchar } + \l__codedoc_index_escaped_key_tl + \actualchar + { + \token_to_str:N \verbatim@font \c_space_tl + \l__codedoc_index_escaped_macro_tl + } + \encapchar + hdclindex{\the\c@HD@hypercount}{#6} + } + } +\cs_new_protected:Npn \__codedoc_special_index_set:Nn #1#2 + { + \tl_set:Nx #1 { \tl_to_str:n {#2} } + \__codedoc_if_almost_str:nTF {#2} + { + \tl_replace_all:Non #1 { \tl_to_str:n { __ } } + { + \verbatimchar + \token_to_str:N \_ \token_to_str:N \_ + \token_to_str:N \verb * \verbatimchar + } + \exp_args:Nx \tl_map_inline:nn + { \tl_to_str:N \verbatimchar \token_to_str:N _ } + { + \tl_replace_all:Nnn #1 {##1} + { + \verbatimchar \c__codedoc_backslash_tl ##1 + \token_to_str:N \verb * \verbatimchar + } + } + \tl_set:Nx #1 + { + \token_to_str:N \verb * \verbatimchar + #1 \verbatimchar + } + } + { + \tl_set:Nn #1 {#2} + \tl_replace_all:Non #1 + { \c__codedoc_backslash_tl } + { \token_to_str:N \bslash \c_space_tl } + } + \__codedoc_quote_special_char:N #1 + } +\cs_new_protected:Npn \__codedoc_quote_special_char:N #1 + { + \tl_map_inline:nn { \quotechar \actualchar \encapchar \levelchar } + { + \tl_replace_all:Nxn #1 + { \tl_to_str:N ##1 } { \quotechar \tl_to_str:N ##1 } + } + } +\cs_new_protected:Npn \__codedoc_key_get:n #1 + { + \__codedoc_key_get_base:nN {#1} \l__codedoc_index_macro_tl + \tl_set:Nx \l__codedoc_index_key_tl + { \tl_to_str:N \l__codedoc_index_macro_tl } + \tl_clear:N \l__codedoc_index_module_tl + \tl_if_in:NoTF \l__codedoc_index_key_tl { \tl_to_str:n { __ } } + { \bool_set_true:N \l__codedoc_index_internal_bool } + { \bool_set_false:N \l__codedoc_index_internal_bool } + \tl_if_head_eq_charcode:oNT + { \l__codedoc_index_key_tl } \c__codedoc_backslash_token + { \__codedoc_key_pop: } + \tl_if_in:NoTF \l__codedoc_index_key_tl { \token_to_str:N : } + { \__codedoc_key_func: } + { + \tl_if_in:NoTF \l__codedoc_index_key_tl { \token_to_str:N _ } + { \__codedoc_key_var: } + { + \tl_if_in:NoT \l__codedoc_index_key_tl { \token_to_str:N @ } + { \tl_set:Nn \l__codedoc_index_module_tl { TeX } } + } + } + } +\cs_new_protected:Npn \__codedoc_key_pop: + { + \tl_set:Nx \l__codedoc_index_key_tl + { \tl_tail:N \l__codedoc_index_key_tl } + } +\cs_new_protected:Npn \__codedoc_key_trim_module:n #1 + { + \cs_set:Npn \__codedoc_tmpa:w ##1 #1 ##2 \q_stop + { \exp_not:n {##1} } + \tl_set:Nx \l__codedoc_index_module_tl + { \exp_after:wN \__codedoc_tmpa:w \l__codedoc_index_module_tl #1 \q_stop } + } +\cs_new_protected:Npn \__codedoc_key_drop_underscores: + { + \tl_if_head_eq_charcode:oNT { \l__codedoc_index_key_tl } _ + { \__codedoc_key_pop: \__codedoc_key_drop_underscores: } + } +\cs_new_protected:Npn \__codedoc_key_func: + { + \tl_if_head_eq_charcode:oNT { \l__codedoc_index_key_tl } . + { \__codedoc_key_pop: } + \__codedoc_key_drop_underscores: + \tl_set_eq:NN \l__codedoc_index_module_tl \l__codedoc_index_key_tl + \exp_args:No \__codedoc_key_trim_module:n { \token_to_str:N : } + \exp_args:No \__codedoc_key_trim_module:n { \token_to_str:N _ } + } +\cs_new_protected:Npn \__codedoc_key_var: + { + \exp_args:Nx \tl_if_head_eq_charcode:nNTF + { \exp_args:No \str_tail:n \l__codedoc_index_key_tl } _ + { + \str_case:fn { \str_head:N \l__codedoc_index_key_tl } + { + { q } { \tl_set:Nn \l__codedoc_index_module_tl { quark } } + { s } { \tl_set:Nn \l__codedoc_index_module_tl { quark } } + } + \__codedoc_key_pop: + \__codedoc_key_pop: + \__codedoc_key_drop_underscores: + \tl_if_empty:NT \l__codedoc_index_module_tl + { + \seq_set_split:NoV \l__codedoc_tmpa_seq + { \token_to_str:N _ } \l__codedoc_index_key_tl + \tl_set:Nx \l__codedoc_index_module_tl + { + \int_case:nnF { \seq_count:N \l__codedoc_tmpa_seq } + { + { 0 } { } + { 1 } { int } + { 2 } { \seq_item:Nn \l__codedoc_tmpa_seq { 2 } } + } + { \seq_item:Nn \l__codedoc_tmpa_seq { 1 } } + } + } + } + { + \tl_set_eq:NN \l__codedoc_index_module_tl \l__codedoc_index_key_tl + \exp_args:No \__codedoc_key_trim_module:n { \token_to_str:N _ } + } + } +\GlossaryPrologue + { + \part*{Change~History} + {\GlossaryParms\ttfamily\hyphenchar\font=`\-} + \markboth{Change~History}{Change~History} + \addcontentsline{toc}{part}{Change~History} + } +\msg_new:nnn { l3doc-TUB } { print-changes-howto } + { + Generate~the~change~list~by~executing\\ + \iow_indent:n + { makeindex~-s~gglo.ist~-o~\c_sys_jobname_str.gls~\c_sys_jobname_str.glo } + } +\tl_gput_right:Nn \PrintChanges + { \AtEndDocument { \msg_info:nn { l3doc-TUB } { print-changes-howto } } } +\bool_if:NTF \g__codedoc_typeset_implementation_bool + { + \RecordChanges + \CodelineIndex + \EnableCrossrefs + \AlsoImplementation + } + { + \CodelineNumbered + \DisableCrossrefs + \OnlyDescription + } + +%%FMi + +\def\maketitle{\@ifstar + {\@articletitlefalse\@r@maketitle}% + {\@articletitletrue\@r@maketitle}% +} + +%% +%% +%% End of file `l3doc-TUB.cls'. diff --git a/macros/latex/contrib/unicodefonttable/unicodefonttable-code.pdf b/macros/latex/contrib/unicodefonttable/unicodefonttable-code.pdf new file mode 100644 index 0000000000..17a9c6bc61 Binary files /dev/null and b/macros/latex/contrib/unicodefonttable/unicodefonttable-code.pdf differ diff --git a/macros/latex/contrib/unicodefonttable/unicodefonttable-code.tex b/macros/latex/contrib/unicodefonttable/unicodefonttable-code.tex new file mode 100644 index 0000000000..7f9a488219 --- /dev/null +++ b/macros/latex/contrib/unicodefonttable/unicodefonttable-code.tex @@ -0,0 +1,4 @@ +% this will typeset documentation + code + +\AtBeginDocument{\AlsoImplementation} +\input{unicodefonttable.dtx} diff --git a/macros/latex/contrib/unicodefonttable/unicodefonttable-doc.pdf b/macros/latex/contrib/unicodefonttable/unicodefonttable-doc.pdf new file mode 100644 index 0000000000..87914ad496 Binary files /dev/null and b/macros/latex/contrib/unicodefonttable/unicodefonttable-doc.pdf differ diff --git a/macros/latex/contrib/unicodefonttable/unicodefonttable-doc.tex b/macros/latex/contrib/unicodefonttable/unicodefonttable-doc.tex new file mode 100644 index 0000000000..4b98461ade --- /dev/null +++ b/macros/latex/contrib/unicodefonttable/unicodefonttable-doc.tex @@ -0,0 +1,6 @@ +% this will typeset only documentation but not the code + +\AtBeginDocument{\OnlyDescription +% \let\tableofcontents\relax + } +\input{unicodefonttable.dtx} diff --git a/macros/latex/contrib/unicodefonttable/unicodefonttable-samples.pdf b/macros/latex/contrib/unicodefonttable/unicodefonttable-samples.pdf new file mode 100644 index 0000000000..b5a4d6399a Binary files /dev/null and b/macros/latex/contrib/unicodefonttable/unicodefonttable-samples.pdf differ diff --git a/macros/latex/contrib/unicodefonttable/unicodefonttable.dtx b/macros/latex/contrib/unicodefonttable/unicodefonttable.dtx new file mode 100644 index 0000000000..67cb3a8d64 --- /dev/null +++ b/macros/latex/contrib/unicodefonttable/unicodefonttable.dtx @@ -0,0 +1,2295 @@ +%%%%% \iffalse meta-comment +% +%% File: unicodefonttable.dtx (C) Copyright 2019-2021 Frank Mittelbach +% +% It may be distributed and/or modified under the conditions of the +% LaTeX Project Public License (LPPL), either version 1.3c of this +% license or (at your option) any later version. The latest version +% of this license is in the file +% +% https://www.latex-project.org/lppl.txt +% +% +% The development version of the bundle can be found below +% +% https://github.com/FrankMittelbach/fmitex/ +% +% for those people who are interested or want to report an issue. +% + +\def\unicodefonttabledate {2021/10/19} +\def\unicodefonttableversion{v1.0e} + + +%<*driver> +\documentclass{l3doc-TUB} + +% some fixes local to this documentation + +\ExplSyntaxOn + \cs_new:Npn\IfImplementationShownTF + {\bool_if:NTF \g__codedoc_typeset_implementation_bool} +\ExplSyntaxOff + +\makeatletter +\def\meta@font@select{\normalfont\itshape} + +\IndexPrologue{% + \IfImplementationShownTF{\section*{Index}% + Numbers written in italic refer to the page + where the corresponding entry is described + or mentioned. Numbers underlined refer to the + code line of the + definition; numbers in Roman refer to the + code lines where the entry is used.}% + {\section{Index}% + Numbers written in italic refer to the page + where the corresponding entry is described + or mentioned.}} + +\makeatother + + +\usepackage{graphicx,unicodefonttable} + +\EnableCrossrefs +\CodelineIndex +\begin{document} + \DocInput{unicodefonttable.dtx} +\advance\signaturewidth by 40pt +\makesignature +\end{document} +% +% +% \fi +% +% \tracinglostchars=3 +% +% \newcommand\key [1]{\texttt{#1}} +% \newcommand\kval[1]{\texttt{#1}} +% +% \newcommand\keysetup[1]{\noindent\marginpar{\raggedleft Key setup: #1}\ignorespaces} +% \renewcommand\keysetup[1]{\paragraph*{\hspace*{-8pc}Key setup (#1)}} +% +% +% \title{The \texttt{unicodefonttable} package\thanks{This is +% version \unicodefonttableversion\ of the package, dated +% \unicodefonttabledate; the license is LPPL.}} +% \author{Frank Mittelbach} +% \address{Mainz, Germany} +% \netaddress{https://www.latex-project.org} +% \personalURL{https://ctan.org/pkg/unicodefonttable} +% \raggedbottom +% +% \maketitle +% +% +% \begin{abstract} +% A package for typesetting font tables for larger fonts, e.g., +% TrueType or OpenType Unicode fonts. +% To produce a one-off table, a standalone version is available as well. +% \end{abstract} +% +% +% \tableofcontents +% +% +% +% \section{Introduction} +% +% When I started to write a new chapter for the third edition of +% \emph{The \LaTeX{} Companion} on modern fonts available for +% different \LaTeX{} engines, I was a bit surprised that I couldn't +% find a way to easily typeset tables showing the glyphs available in +% TrueType or OpenType fonts. The \pkg{nfssfont} package available +% with \LaTeX{} only supports fonts from the 8-bit world, but +% modern fonts that can be used with \XeTeX{} or \LuaTeX{} can +% contain thousands of glyphs and having a method to display what +% is available in them was important for me. +% +% I therefore set out to write my own little package and what +% started as an afternoon exercise ended up being this package, +% offering plenty of bells and whistles for typesetting such +% font tables. +% +% As there can be many glyphs in such fonts a tabular +% representation of them might run for several pages, so the +% package internally uses the \pkg{longtable} package to handle +% that. +% +% In most cases the glyphs inside the fonts are indexed by their +% Unicode numbers so it is natural to display them sorted by their +% position in the Unicode character set. +% +% Unicode is organized in named blocks such as ``Basic Latin'', +% ``Latin-1~Supplement'', etc., typically consisting of 265 +% characters each.\footnote{Some blocks are smaller, while those +% containing the Asian ideographs are much larger.} It is therefore +% helpful to use these block names as subtitles within the table, +% to more easily find the information one is looking for. +% +% A common way to represent the number of a single Unicode +% character is \texttt{U+} followed by four (or more) +% hexadecimal digits. For example, \texttt{U+0041} represents the letter +% ``A'' and \texttt{U+20AC} the Euro currency symbol ``\texteuro''. +% We use this convention by showing a Unicode range of sixteen +% characters at the left of each table row, e.g., \texttt{U+0040 - +% 004F}, followed by the sixteen glyphs in the range. Thus that +% particular table row from the ``Basic Latin'' block would show +% something like +% +% \displayfonttable*[noheader,range-start=0040, range-end=004F, +% color=black!50]{Latin Modern Sans} +% +% If a Unicode character has no glyph representation in a given +% font then this is indicated by a special symbol (by default a +% colored hyphen). By default some color is used, but we've grayscaled +% the output for \TUB. +% +% In order to easily locate any Unicode character the table shows by +% default sixteen hex digits as a column heading. For example, to find +% Euro currency symbol (\texttt{U+20AC}) one first finds the +% right row, which is the range \texttt{U+20A0 - 20AF}, and then +% the \texttt{C} column in that row, and the glyph is there (or an +% indication that the font is missing that glyph; +% the line shows that for some of the other slots). +% +% \displayfonttable*[noheader,range-start=20A0, range-end=20AF, +% color=black!50]{Latin Modern Sans} +% +% It can be useful to compare two fonts with each other by +% filling the table with glyphs from a secondary font if the +% primary font is missing them. For example, the next display shows +% two rows of Latin Modern Math (black glyphs) and instead of showing +% a missing glyph symbol in most slots, we use the glyphs from New +% Computer Modern Math, which has a much larger glyph set +% (normally red glyphs with gray background but again, grayscaled for +% \TUB). +% +% +% \displayfonttable[noheader,nostatistics,display-block=none, +% compare-with=NewCMMath-Regular.otf,range-start=2A00,range-end=2A1F, +% color=black!50,compare-color=none] +% {latinmodern-math.otf} +% +% +% \section{The user interface} +% +% The package offers one command to typeset a font table. The +% appearance of the table can be customized by specifying key/value +% pairs. +% +% \begin{function}{\displayfonttable} +% \begin{syntax} +% \cs{displayfonttable} \texttt{*} \oarg{key/value-list} \Arg{font-name} \oarg{font-features} +% \end{syntax} +% The \meta{font-name} is the font to be displayed. This and the +% \meta{font-features} argument are passed to \pkg{fontspec}, thus they +% should follow the conventions of that package for specifying a +% font. The \meta{key/value-list} offers customization +% possibilities discussed below. +% +% The \cs{displayfonttable*} is a variant of the command, intended +% for use with 8-bit legacy fonts. It presets some keys, but +% otherwise behaves identically. The preset values are: +%\begin{verbatim} +% nostatistics, display-block=none, hex-digits=head, range-end=FF +%\end{verbatim} +% For details see the next section. +% \end{function} +% +% +% +% \begin{function}{\fonttablesetup} +% \begin{syntax} +% \cs{fonttablesetup} \Arg{key/value-list} +% \end{syntax} +% Instead of or in addition to specifying key/values to +% \cs{displayfonttable} it is possible to set them up as +% defaults. Inside \cs{displayfonttable} the defaults are applied first, +% so one can still overwrite their values for an individual table. +% \end{function} +% +% +% \begin{function}{\fonttableglyphcount} +% \begin{syntax} +% \cs{fonttableglyphcount} +% \end{syntax} +% While typesetting a font table the package keeps track of the +% number of glyphs it finds in the font. After the table has finished, +% this value is available in \cs{fonttableglyphcount} and it is, for +% example, used when statistics are produced. At the start of the +% next table it is reset to zero. +% \end{function} +% +% +% +% +% \subsection{Keys and their values} +% +% Several of the available keys are booleans accepting \texttt{true} +% or \texttt{false}. They usually exist in pairs so that one can +% specify the desired behavior without needing to provide a value, +% e.g., specifying \key{header} is equivalent to specifying +% \key{header}\texttt{=true} or \key{noheader}\texttt{=false}, etc. +% In the lists below the default settings are indicated by an +% underline. +% +% \begin{variable}{ +% header, noheader, +% title-format, title-format-cont, +% } +% The first set of keys is concerned with the overall look and +% feel of the generated table. +% \begin{description} +% \item[\underline{\key{header}}, \key{noheader}] +% These keys determine whether a header to the table is +% produced. +% +% \item[\key{title-format}, \key{title-format-cont}] +% These keys define what is provided as a header title or +% continuation title if the table consists of several pages. +% They expect code as their value. This code can contain \verb=#1= +% and \verb=#2= to denote the \meta{font-name} and +% \meta{font-features} arguments, respectively. +% +% By default a title using the \cs{caption} command is produced; on +% continuation titles, the \meta{font-features} are not shown. +% This is typeset as a \env{longtable} header row, so you either need to use +% \cs{multicolumn} or a \cs{caption} command\Dash otherwise everything +% ends up in the first column. +% +% \end{description} +% +% \end{variable} +% +% +% \begin{variable}{ +% display-block, +% hex-digits, color, +% } +% These keys handle the inner parts of the table. +% +% \begin{description} +% \item[\key{display-block}] +% The Unicode dataset is organized in named blocks that are typically 128 or +% 256 characters, though some are noticeably larger and a few are +% smaller. With the \key{display-block} key it is +% possible to specify if and how such blocks should be made visible. +% The following values are supported: +% \begin{description} +% \item[\underline{\kval{titles}}] +% Above each display block that contains glyphs the Unicode title +% of the block is displayed. +% +% \item[\kval{rules}] +% Display blocks are indicated only by a \cs{midrule}. +% +% \item[\kval{none}] +% Display blocks are not indicated at all. +% \end{description} +% +% \item[\key{hex-digits}] +% To ease reading the table, rows of hex digits are added to +% it. Where or if this happens is controlled by this key. Allowed +% values for it are the following: +% \begin{description} +% \item[\kval{block}] +% A row of hex digits is placed at the beginning of each Unicode +% block containing glyphs in the displayed font. +% +% \item[\kval{foot}] +% A row is added to the foot of each table page. +% +% \item[\underline{\kval{head}}] +% A row is added to the top of each table page. +% +% \item[\kval{head+foot}] +% A row is added to the top and the foot of each table page. +% +% \item[\kval{none}] +% All hex digit rows are suppressed. +% \end{description}% +% +% \item[\key{hex-digits-font}] +% The font to use for the hex digits, by default +% \underline{\cs{ttfamily}\cs{scriptsize}}.{\hfuzz=2.7pt\par} +% +% \item[\key{color}] +% This key determines the color for parts of the table (hex digits +% and Unicode ranges). It can be either \kval{none} or a color +% specification as understood by the \cs{color} command. +% The default is \underline{\texttt{blue}}. +% +% \end{description} +% +% \end{variable} +% +% +% \begin{variable}{ +% statistics, nostatistics, +% statistics-font,statistics-format, +% } +% The next set of keys allows altering the statistics that are produced. +% \begin{description} +% +% \item[\underline{\key{statistics}}, \key{nostatistics}] +% These keys determine whether some statistics are listed at +% the end of the table. +% +% \item[\key{statistics-font}] +% The font used to typeset the statistics; the default is\\ +% \underline{\cs{normalfont}\cs{small}}. +% +% +% \item[\key{statistics-format}] +% Code (text) to specify what should be typeset in the +% statistics. One can use \verb=#1= for the \meta{font-name} and +% \verb=#2= for the glyph count. +% The material is typeset on a single line at the end of the +% table. If several lines are needed you need to use \cs{parbox} +% or a similar construct. +% \end{description} +% \end{variable} +% +% +% +% \begin{variable}{ +% glyph-width, +% missing-glyph, missing-glyph-font, missing-glyph-color, +% } +% Another set of keys deals with customization on the glyph level. +% \begin{description} +% \item[\key{glyph-width}] +% All glyphs are typeset in a box with the same width, the default +% value is \underline{\texttt{6pt}} which is suitable for most 10pt +% fonts +% and make the table fit comfortably into the text width of +% a typical document. +% +% \item[\key{missing-glyph}] +% If a slot in a row doesn't have a glyph in the font you may still +% want display something to indicate this state. By giving the key +% a value any arbitrary glyph or material can be typeset. The +% default is to typeset a \kval{-} (hyphen) in a special color. +% +% Rows that contain no glyph whatsoever are not displayed at +% all. Instead a small vertical space is added to indicate the one +% or more rows are omitted. +% +% \item[\key{missing-glyph-font}] +% +% The font used for the missing glyphs (the default value is +% \underline{\cs{ttfamily}\cs{scriptsize}}). +% +% \item[\key{missing-glyph-color}] +% If not specified it uses the value specified with the \key{color} +% key. If you want a different color, e.g., \texttt{red}, you can +% use a color value or you can specify \kval{none} to use no coloring. +% +% \end{description} +% +% \end{variable} +% +% +% \begin{variable}{ +% compare-with,compare-color, compare-bgcolor,statistics-compare-format +% } +% +% You can make comparisons between two fonts, which is useful, for +% example when dealing with incomplete math fonts and you need to +% see how well the symbols from one font blend with the supplementary +% symbols from another font. +% +% \begin{description} +% \item[\key{compare-with}] +% +% If given, the value is a \meta{comparison-font-name} that is used +% to supply missing glyphs. This means that if the \meta{font-name} +% to be displayed is missing a glyph in a slot, then the +% \meta{comparison-font-name} is checked, and if that font has the +% glyph in question, it will be displayed instead of showing a +% missing glyph indicator. +% +% \item[\key{compare-color}, \key{compare-bgcolor}] +% +% To distinguish real glyphs from missing but substituted glyphs, +% they can be colored specially (default \underline{\texttt{red}}) +% and/or you can have their background colored (default is +% \underline{\texttt{black!10}}, i.e., a light gray). +% +% \item[\key{statistics-compare-format}] +% +% Code (text) to specify what should be typeset in the statistics +% when comparing two fonts. One can use \verb=#1= for the +% \meta{font-name} and \verb=#2= for its glyph count, \verb=#3= is +% the name of the comparison font, \verb=#4= its glyph count, +% \verb=#5= for the number of glyphs missing in this font and +% \verb=#6= the number of extra glyphs in it. This code is used +% instead of \key{statistics-format} when comparisons are made. +% +% The material is typeset on a single line at the end of the +% table. If several lines are needed you need to use \cs{parbox} +% or a similar construct. +% +% \end{description} +% \end{variable} +% +% +% \begin{variable}{ +% range-start, range-end, +% } +% Finally there are two keys for restricting the display range. +% \begin{description} +% \item[\key{range-start}, \key{range-end}] +% The full Unicode set of characters is huge and checking every +% slot to see if the current font contains a glyph in the slot +% takes a long time. If you know that font contains only a +% certain subset then you can speed up the table generation +% considerably by limiting the search (and consequently the output +% generation). +% The \key{range-start} specifies where to start with the search +% (default \underline{\texttt{0000}}) and \key{range-end} gives +% the last slot that is tested (default +% \underline{\texttt{FFFF}}). +% +% Thus, by default we restrict the display to slots below +% \texttt{10000}, because text fonts seldom contain glyphs in the +% higher planes. But if you want to see everything of the font (as +% far as supported by this package) and are prepared to wait for +% the higher +% planes to be scanned, you can go up to a value of \texttt{FFFFF}. +% +% These keys are also quite useful in combination with the previous +% \key{compare-with} key, to display only, for example, the Greek +% letters and see how glyphs from two fonts blend with each other. + +% \end{description} +% \end{variable} +% +% +% +% \subsection{A standalone interactive version} +% +% If you want to quickly display a single font, you can run +% \texttt{unicodefont.tex} through \LuaTeX{} (or \XeTeX{}). Similar to +% \texttt{nfssfont.tex} (which is for 8-bit fonts with \pdfTeX) it +% asks you a few questions and then generates the font table for +% you. There are fewer configuration options available, +% but this workflow saves you writing a document to get a +% one-off table. +% +% Most font tables need several runs due to the use of +% \pkg{longtable}, which has to find the right width for the columns +% across several pages. The \texttt{unicodefont} file therefore +% remembers your selection from the previous run and asks you if +% you want to reapply it to speed up the process. +% +% +% +% \section{Notes on the table data} +% +% If you look at some parts of a Unicode font table you see a number of slots that +% do not show a \enquote{missing glyph} sign, but nonetheless appear +% to be empty. For example: +% +% \displayfonttable[noheader,nostatistics,display-block=none, +% range-start=0020,range-end=00BF, +% color=black!50] +% {TeX Gyre Pagella} +% +% +% The reason is that Unicode contains a lot of special +% spaces or otherwise invisible characters, e.g., \texttt{U+0020} +% is the normal space, \texttt{U+00A0} is a non-breaking space, +% \texttt{U+00AD} is a soft-hyphen (what \LaTeX{} users would +% indicate with \cs{-}), and so forth. Especially the row +% \texttt{U+2000-200F} in Table~1 looks strange as it appears to be totally +% empty, but in fact most of its slots contain spaces of different +% width. +% +%\displayfonttable[noheader,nostatistics,hex-digits=foot, +% range-start=2000,range-end=202F, +% color=black!50] +% {latinmodern-math.otf} +% +% +% Another somewhat surprising area is the \enquote{Mathematical +% Alphanumeric Symbols} block in math fonts, starting at \texttt{U+1D400}. +% There you see a number of missing characters, the first two being +% \texttt{U+1D455} (math italic small h) and \texttt{U+1D49D} (math +% script B). +% +% \displayfonttable[noheader,nostatistics,hex-digits=foot, +% range-start=1D400,range-end=1D4AF, +% color=black!50] +% {latinmodern-math.otf} +% +% In this case the reason is \emph{not} that the font +% fails to implement the characters, but that these characters have +% already been defined in earlier revisions of the Unicode standard in the +% lower Unicode plane. For example, the \enquote{h} is the +% Planck constant \texttt{U+210E} and \texttt{U+212C} is +% the script capital B, etc. The Unicode Consortium decided not +% to encode the \emph{same} character twice, hence the apparent +% holes. +% +% +% \IfImplementationShownTF{} +% {\appendix +% \def\theHsection{Appendix.\thesection} +% \addtocontents{toc}{\smallskip} +% \setlength\IndexMin{200pt} +% \PrintIndex +% } +% +% +% \section{Examples} +% +% In this section we show the results of a few calls to +% \cs{displayfonttable}. +% The tables are a bit easier to navigate if they use color in some +% places, but for \TUB{} this is not practical, so we +% use black and gray. +% +% \subsection{Computer Modern Sans --- 8-bit font} +% +% Our first example is an 8-bit font which gives a concise table. +% Command used: \begin{verbatim} +% \displayfonttable*[color=none, range-end=7F]{cmss10} +% \end{verbatim} +% +% \displayfonttable*[color=none, range-end=7F]{cmss10} +% +% +% \iffalse +% +%\subsection{\TeX{} Gyre Pagella (Palatino) oldstyle figures --- OTF font} +% +% This example shows Pagella with oldstyle numerals. +% Command used: +%\begin{verbatim} +%\displayfonttable{TeX Gyre Pagella}[Numbers=OldStyle] +%\end{verbatim} +% +%\displayfonttable{TeX Gyre Pagella}[Numbers=OldStyle] +% +% \fi +% +% +% +% \subsection{Latin Modern Math compared to New Computer Modern Math} +% +% This example shows the extra symbols available in New Computer +% Modern Math in comparison to Latin Modern Math as the base font. +% We use the following setup (including settings for the +% grayscaled \TUB\ output, as an example of color overrides): +%\begin{verbatim} +% \displayfonttable[hex-digits=head+foot, range-end=1FFFF, +% compare-with=New Computer Modern Math, +% compare-color=black, compare-bgcolor=black!5, +% missing-glyph-color=black!50, color=black!75] +% {Latin Modern Math} +%\end{verbatim} +% That is, glyphs only in \texttt{NewCM} are shown with a light gray +% background. +% +% We also extended the range to cover \texttt{U+10000} to +% \texttt{U+1FFFF} in order to include the Unicode Math alphabets. +% +% \displayfonttable[hex-digits=head+foot, range-end=1FFFF, +% compare-with=New Computer Modern Math, +% compare-color=black, compare-bgcolor=black!5, +% missing-glyph-color=black!50, color=black!75] +% {Latin Modern Math} +% +% +%\subsection{Garamond Libre's Byzantine Musical Symbols} +% +% As a final example we exhibit the Byzantine Musical Symbols as provided by +% Garamond Libre. +% Command used: +%\begin{verbatim} +% \displayfonttable[range-start=1D000, range-end=1D0FF, +% hex-digits=block, +% missing-glyph-color=black!50, color=black!75, +% statistics-format=Total number of glyphs in +% this block of #1 is #2] +% {Garamond Libre} +%\end{verbatim} +% +% Note that we have altered the text produced by the statistics, +% because the default is somewhat misleading if only a portion of +% the font is displayed. This produces the following table: +% +% \displayfonttable[range-start=1D000, range-end=1D0FF, +% hex-digits=foot, +% missing-glyph-color=black!50, color=black!75, +% statistics-format=Total number of glyphs in +% this block of #1 is #2] +% {Garamond Libre} +% +% +% +% \IfImplementationShownTF +% {\StopEventually{\setlength\IndexMin{200pt} \PrintIndex }} +% {\StopEventually{}} +% +% +% +% \section{The package implementation} +% +% \hfuzz=10pt ^^A lots of slightly overfull tt lines +% +% \begin{macrocode} +%<*package> +% \end{macrocode} +% +% By default the package uses coloring to improve the table +% appearance and therefore requires a color package. +% \begin{macrocode} +\RequirePackage{xcolor} +% \end{macrocode} +% + +% \begin{macrocode} +%<@@=fmuft> +% \end{macrocode} +% +% We need the package \pkg{xparse} for specifying the document-level +% interface commands and \pkg{l3keys2e} to use the \pkg{expl3} key +% value methods within \LaTeXe{}. These packages automatically +% require \pkg{expl3} so there is no need to load that explicitly. +% Actually, \pkg{expl3}, \pkg{l3keys2e} and the \pkg{xparse} +% functionality is now all part of the \LaTeX{} kernel so the next +% line is actually not needed at all with a current \LaTeX{} kernel, but +% in order to support older installations we keep it for now. +% +% \begin{macrocode} +\RequirePackage{xparse,l3keys2e} +% \end{macrocode} +% +% Here we introduce the package and specify its version number: +% \begin{macrocode} +\ProvidesExplPackage{unicodefonttable} + {\unicodefonttabledate} + {\unicodefonttableversion} + {Producing font tables for Unicode and other fonts} +% \end{macrocode} +% +% \newcommand\hex[1]{$\langle\textit{hex}_{#1}\rangle$} +% +% +% +% +% +% \subsection{User interface commands} +% +% +% Throughout the implementation we will define a number of keys (and +% their allowed values). We introduce them at the point where they are +% used, so they are sprinkled throughout the code.\footnote{This fits +% with the way this package was developed. I first implemented a +% single rigid table layout without configuration possibilities and +% then thought about which parts I wanted to have flexible. I then +% replaced the rigid code with code that is affected by setting +% key/value pairs.} + +% \begin{macro}{\fonttablesetup} +% To set up user defaults for the keys we provide a standard +% interface. The command \cs{unicodefonttabletablesetup} expects a +% key/value list and can be called as often as necessary. +% \begin{macrocode} +\NewDocumentCommand \fonttablesetup { m } + { \keys_set:nn {@@} {#1} \ignorespaces } +% \end{macrocode} +% \end{macro} +% +% +% +% \begin{macro}{\displayfonttable} +% The document-level command for generating a font table. +% \begin{macrocode} +\NewDocumentCommand\displayfonttable {s O{} m o}{% + \IfBooleanTF #1 + { +% \end{macrocode} +% For the starred form we preset a number of keys with values +% suitable when displaying 8-bit legacy fonts. +% With such fonts Unicode block headers make little +% sense (as the fonts do not conform to the Unicode layout and +% since they have at most 265 glyphs). It is therefore also unnecessary to +% loop over the whole Unicode range of the first plane. +% If necessary all of them can still be overwritten in the optional argument. +% \begin{macrocode} + \@@_display_fonttable:nnn + {nostatistics,display-block=none,hex-digits=head,range-end=FF,#2} + {#3}{#4} + } + { + \@@_display_fonttable:nnn {#2}{#3}{#4} + } +} +% \end{macrocode} +% \end{macro} +% +% +% \begin{macro}{\@@_display_fonttable:nnn} +% This command is the main workhorse of the +% package. It produces a \texttt{longtable} containing all font +% glyphs with 16 glyphs per row. The first optional argument is +% used to configure the table through key/value pairs, the +% mandatory argument is the font name to display (in +% \texttt{fontspec} conventions) and the final optional argument is +% the font feature list if any. If the latter is not provided it +% will get a special value (\texttt{--NoValue--}) assigned by +% \texttt{xparse}, which is something that can be tested for. +% \begin{macrocode} +\cs_new:Npn \@@_display_fonttable:nnn #1#2#3 { + \group_begin: +% \end{macrocode} +% First initialize the font that should be displayed (perhaps with a +% feature list) and then update the key/value list using \verb=#1=. +% \begin{macrocode} + \fontspec{#2}[#3] + \keys_set:nn{@@}{#1} +% \end{macrocode} +% If the user has asked for a comparsion to some other font we need to set this up: +% \begin{macrocode} + \tl_if_empty:NTF \l_@@_compare_with_tl + { \tl_clear:N \l_@@_compare_font_tl } + { + \setfontface \l_@@_compare_font_tl {\l_@@_compare_with_tl}[] + \cs_set_eq:NN \@@_handle_missing_glyph:n + \@@_handle_missing_glyph_compare:n + } +% \end{macrocode} +% Then we start the table with 17 columns. We use \texttt{longtable} +% if we produce a caption and \texttt{longtable*} if not (so that +% the table number is not increased, which would look odd if you +% have other tables in your document). +% \begin{macrocode} + \begin{longtable\bool_if:NF\l_@@_display_header_bool{*}} + {@{}r@{\quad}*{16}{c}@{}} +% \end{macrocode} +% Special headers and footers are set up first: +% \begin{macrocode} + \@@_setup_header_footer:nn{#2}{#3} +% \end{macrocode} +% Then we produce all table rows with the glyphs. +% \begin{macrocode} + \@@_produce_table_rows: +% \end{macrocode} +% At the very end we may typeset some statistics. This can't be +% done in the table footer, because the data is dynamic (e.g., +% number of glyphs processed) and the table footers are static and +% do not change based on the table content. +% \begin{macrocode} + \@@_handle_table_ending:n {#2} + \end{longtable\bool_if:NF\l_@@_display_header_bool{*}} + \group_end: +} +% \end{macrocode} +% \end{macro} + + +% +% \begin{macro}{\fonttableglyphcount} +% \begin{macro}{\g_@@_glyph_int,\g_@@_glyph_only_B_int,\g_@@_glyph_also_B_int} +% While generating the font table we count the number of glyphs we +% see (and typeset). The total is available in the command +% \cs{fonttableglyphcount} after the table got finished and will be reset to +% zero when the next table starts. +% \begin{macrocode} +\DeclareDocumentCommand \fonttableglyphcount {} + { \int_use:N \g_@@_glyph_int } +% \end{macrocode} +% +% \begin{macrocode} +\int_new:N \g_@@_glyph_int +% \end{macrocode} +% When comparing fonts we also record data for the second font: the +% number of glyphs in both and the number of glyphs only in the +% second one. +% \begin{macrocode} +\int_new:N \g_@@_glyph_only_B_int +\int_new:N \g_@@_glyph_also_B_int +% \end{macrocode} +% \end{macro} +% \end{macro} + + + + +% \subsection{The overall table layout} +% +% +% \begin{macro}{\@@_setup_header_footer:nn} +% Setting up header and footer lines of the table. +% This macro receives the \textit{font name} and the \textit{font +% features} specified by the user as its arguments. +% \begin{macrocode} +\cs_new:Npn \@@_setup_header_footer:nn #1#2{ +% \end{macrocode} +% On the first page of the table the header may show a caption or +% some other sort of title based on the value of +% \cs{l_@@_display_header_bool}. The formatting is handled by +% \cs{@@_format_table_title:nn} which can be customized through the +% key \key{title-format}. +% \begin{macrocode} + \bool_if:NT \l_@@_display_header_bool + { \@@_format_table_title:nn{#1}{#2} \@@_debug_nl:n{T}\\*[6pt] } +% \end{macrocode} +% We may also want to display a line of hex digits. This is +% controlled through the key \key{hex-digits} that accepts different +% values: \kval{head}, \kval{foot}, \kval{head+foo}, \kval{block} +% (after a block title) or \kval{none}. +% \begin{macrocode} + \bool_if:NT \l_@@_header_hex_digits_bool + { \@@_display_row_of_hex_digits: \@@_debug_nl:n{H}\\* } + \endfirsthead +% \end{macrocode} +% Headers for later table pages have a continuation title and +% maybe a row of hex digits. +% \begin{macrocode} + \bool_if:NT \l_@@_display_header_bool + { \@@_format_table_cont:nn{#1}{#2} \@@_debug_nl:n{T}\\*[6pt] } + \bool_if:NT \l_@@_header_hex_digits_bool + { \@@_display_row_of_hex_digits: \@@_debug_nl:n{H}\\* } + \endhead +% \end{macrocode} +% Footers of the table are either empty or show a row of hex digits. +% \begin{macrocode} + \bool_if:NT \l_@@_footer_hex_digits_bool + { \@@_display_row_of_hex_digits: \@@_debug_nl:n{H}\\* } + \endfoot +% \end{macrocode} +% The footer of the last page of the table will always be +% empty. Any special row, such as a row of hex digits, will be +% provided in the table body. The reason is that we may want to +% display statistics at the very end of the table and those can't be +% placed into a static footer. +% \begin{macrocode} + \endlastfoot +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\l_@@_header_hex_digits_bool} +% \begin{macro}{\l_@@_footer_hex_digits_bool} +% \begin{macro}{\l_@@_blockwise_hex_digits_bool} +% Here are the booleans we use in the code. +% \begin{macrocode} +\bool_new:N \l_@@_header_hex_digits_bool +\bool_new:N \l_@@_footer_hex_digits_bool +\bool_new:N \l_@@_blockwise_hex_digits_bool +% \end{macrocode} +% \end{macro} +% \end{macro} +% \end{macro} +% +% +% \begin{macro}{\@@_display_row_of_hex_digits:} +% \begin{macro}{\@@_format_hex_digit:n} +% Producing a row of hex digits is simple. +% \begin{macrocode} +\cs_new:Npn \@@_display_row_of_hex_digits: { + & \@@_format_hex_digit:n{0} & \@@_format_hex_digit:n{1} + & \@@_format_hex_digit:n{2} & \@@_format_hex_digit:n{3} + & \@@_format_hex_digit:n{4} & \@@_format_hex_digit:n{5} + & \@@_format_hex_digit:n{6} & \@@_format_hex_digit:n{7} + & \@@_format_hex_digit:n{8} & \@@_format_hex_digit:n{9} + & \@@_format_hex_digit:n{A} & \@@_format_hex_digit:n{B} + & \@@_format_hex_digit:n{C} & \@@_format_hex_digit:n{D} + & \@@_format_hex_digit:n{E} & \@@_format_hex_digit:n{F} } +% \end{macrocode} +% Each digit is typeset in typewriter and in script size. We offer +% font and color +% customizations. Note that it is important to set an explicit +% family. Otherwise the hex digits are formatted using the current +% table font (which may or may not work at all). +% \begin{macrocode} +\cs_new:Npn \@@_format_hex_digit:n #1 { + \l_@@_hex_digits_font_tl \l_@@_color_tl #1 } +% \end{macrocode} +% \end{macro} +% \end{macro} +% + +% \begin{macro}{\l_@@_color_tl} +% The token list to hold definition if set up. +% \begin{macrocode} +\tl_new:N \l_@@_color_tl +% \end{macrocode} +% \end{macro} +% +% +% \keysetup{overall table} +% Here are the definitions for the keys used in the code above: +% \begin{macrocode} +\keys_define:nn {@@} { +% \end{macrocode} +% The \key{header} key is a boolean that determines if a header +% title should be produced (default) +% \begin{macrocode} + ,header .bool_set:N = \l_@@_display_header_bool + ,header .default:n = true + ,header .initial:n = true +% \end{macrocode} +% To ease the setup we also support the key \key{noheader} which is +% a short form for \texttt{header=false}. +% \begin{macrocode} + ,noheader .bool_set_inverse:N = \l_@@_display_header_bool + ,noheader .default:n = true +% \end{macrocode} +% The default for the \key{title-format} key is to produce a +% \cs{caption} listing the font name and any features (if +% given). Note the \cs{IfValueTF} command (provided by +% \texttt{xparse}) that checks if the second argument got any value +% or has the special \texttt{--NoValue--} value. +% \begin{macrocode} + ,title-format .cs_set:Np = \@@_format_table_title:nn #1#2 + ,title-format .initial:n = + \IfValueTF{#2} { \caption{ #1~ (features:~ \texttt{\small#2}) } } + { \caption{ #1 } } +% \end{macrocode} +% The default continuation title ignores the given features, so the +% formatting is somewhat simpler. It uses \verb=\caption[]{...}= to +% make a caption that doesn't alter the table number. +% \begin{macrocode} + ,title-cont-format .cs_set:Np = \@@_format_table_cont:nn #1#2 + ,title-cont-format .initial:n = \caption[]{#1~ \emph{cont.}} +% \end{macrocode} +% The key \key{hex-digits} is implemented as a choice, where each +% allowed value sets different booleans that are then used in the code. +% \begin{macrocode} + ,hex-digits .choice: + ,hex-digits / block .code:n = + \bool_set_true:N \l_@@_blockwise_hex_digits_bool + \bool_set_false:N \l_@@_header_hex_digits_bool + \bool_set_false:N \l_@@_footer_hex_digits_bool + ,hex-digits / foot .code:n = + \bool_set_true:N \l_@@_footer_hex_digits_bool + \bool_set_false:N \l_@@_header_hex_digits_bool + \bool_set_false:N \l_@@_blockwise_hex_digits_bool + ,hex-digits / head .code:n = + \bool_set_true:N \l_@@_header_hex_digits_bool + \bool_set_false:N \l_@@_footer_hex_digits_bool + \bool_set_false:N \l_@@_blockwise_hex_digits_bool + ,hex-digits / head+foot .code:n = + \bool_set_true:N \l_@@_header_hex_digits_bool + \bool_set_true:N \l_@@_footer_hex_digits_bool + \bool_set_false:N \l_@@_blockwise_hex_digits_bool + ,hex-digits / none .code:n = + \bool_set_false:N \l_@@_header_hex_digits_bool + \bool_set_false:N \l_@@_footer_hex_digits_bool + \bool_set_false:N \l_@@_blockwise_hex_digits_bool + ,hex-digits .initial:n = head +% \end{macrocode} +% The font for hex digits are set with \key{hex-digits-font}. +% \begin{macrocode} + ,hex-digits-font .tl_set:N = \l_@@_hex_digits_font_tl + ,hex-digits-font .initial:n = \ttfamily \scriptsize +% \end{macrocode} +% The \key{color} key is used in most places that get colored; some +% have their own key but default to the main color. +% \begin{macrocode} + ,color .choice: + ,color / none .code:n = \tl_clear:N \l_@@_color_tl + ,color / unknown .code:n = \tl_set:Nn \l_@@_color_tl { \color {#1} } + ,color .initial:n = blue + } +% \end{macrocode} +% +% +% +% +% \begin{macro}{\@@_handle_table_ending:n} +% At the end of the table we may want to display a final row of +% hex digits and perhaps some statistics, i.e., the number of +% typeset glyphs. +% \begin{macrocode} +\cs_new:Npn \@@_handle_table_ending:n #1 { +% \end{macrocode} +% +% \begin{macrocode} + \@@_debug_nl:n{H} \\* + \bool_if:NT \l_@@_footer_hex_digits_bool + { \@@_display_row_of_hex_digits: \@@_debug_nl:n{H} \\* } + \bool_if:NT \l_@@_display_statistics_bool + { \\*[2pt] + \multicolumn{17}{l}{ \l_@@_stats_font_tl +% \end{macrocode} +% If we do font comparison, we use a different command for +% displaying statistics and pass more data to it. +% \begin{macrocode} + \tl_if_empty:NTF \l_@@_compare_with_tl + { + \@@_format_stats:nn{#1}{\fonttableglyphcount} + } + { + \@@_format_compare_stats:nnnnnn{#1}{\fonttableglyphcount} + { \l_@@_compare_with_tl } +% \end{macrocode} +% The extra arguments are total glyph number in second font, glyphs +% missing in second font and glyphs only in second font. +% \begin{macrocode} + { \int_eval:n { \int_use:N\g_@@_glyph_also_B_int + + \int_use:N\g_@@_glyph_only_B_int } + } + { \int_eval:n { \fonttableglyphcount - + \int_use:N\g_@@_glyph_also_B_int } + } + { \int_use:N\g_@@_glyph_only_B_int } + } +% \end{macrocode} +% We don't know exactly how wide the table is (and nor does the +% user) but one may need to use \cs{parbox} when formatting +% the statistic line(s). So we back up a bit (rather random) which +% allows us to use \verb=\parbox{\linewidth}{...= in the key +% without thinking too much about it. +% \begin{macrocode} + \hspace*{-3cm} + } + } +} +% \end{macrocode} +% +% \keysetup{for statistics} +% Here are the keys used above. By default we produce statistics. +% \begin{macrocode} +\keys_define:nn {@@} { + ,statistics .bool_set:N = \l_@@_display_statistics_bool + ,statistics .default:n = true + ,statistics .initial:n = true +% \end{macrocode} +% the key \key{nostatistics} is just short for \texttt{statistics=false}: +% \begin{macrocode} + ,nostatistics .bool_set_inverse:N = \l_@@_display_statistics_bool + ,nostatistics .default:n = true +% \end{macrocode} +% The default font we use is \cs{normalfont}. Again we need to +% supply a family to avoid getting the font used in the table body. +% \begin{macrocode} + ,statistics-font .tl_set:N = \l_@@_stats_font_tl + ,statistics-font .initial:n = \normalfont\small +% \end{macrocode} +% And here we have the default text. There is only space for a +% single line. If more text is needed one needs to provide some +% explicit \cs{parbox}. +% \begin{macrocode} + ,statistics-format .cs_set:Np = \@@_format_stats:nn #1#2 + ,statistics-format .initial:n = Total~ number~ of~ glyphs~ in~ #1:~#2 + } +% \end{macrocode} +% \end{macro} +% +% +% +% +% +% \begin{macro}{\@@_debug_nl:n} +% While developing the code I had a bit of trouble getting the line +% endings correct, so I added a little macro that made them visible +% (displaying its argument in the table margin when the key +% \key{debug} is used. By default it does nothing. +% \begin{macrocode} +\cs_new:Npn \@@_debug_nl:n #1 {} +% \end{macrocode} +% +% \keysetup{debugging} +% This key is really internal and is therefore not documented above +% (and its behavior may changes over time). +% \begin{macrocode} +\keys_define:nn {@@} { + debug .code:n = \cs_set:Npn \@@_debug_nl:n ##1 + {\rlap{\normalfont\scriptsize \qquad ##1}} } +% \end{macrocode} +% \end{macro} +% +% +% +% +% +% +% +% \subsection{The producing the table content} +% +% +% The body of the table consists of rows with sixteen glyphs each +% and to produce it we loop through all possible Unicode points +% starting at \texttt{U+0000} and ending with \texttt{U+FFFF}. +% +% This is implemented with a four-level nested loop that runs through the +% values \texttt{0}, \texttt{1}, \ldots, \texttt{F} with the +% current hex value in each of the four positions stored in some variable. + + +% \begin{macro}{\g_@@_hex_H_tl,\g_@@_hex_A_tl, +% \g_@@_hex_B_tl,\g_@@_hex_C_tl} +% \cs{g_@@_hex_H_tl} is a bit special because, it is initially not +% zero, but empty, so that slots in the lower plane are denoted by 4 +% hex digits. +% We really only need three further variables, as the value in the +% innermost loop can used directly. +% \begin{macrocode} +\tl_new:N \g_@@_hex_H_tl % higher plane +\tl_new:N \g_@@_hex_A_tl +\tl_new:N \g_@@_hex_B_tl +\tl_new:N \g_@@_hex_C_tl +% \end{macrocode} +% \end{macro} +% +% +% \begin{macro}{\c_@@_hex_digits_clist} +% Here is the sequence we loop through on each level, except the +% one for the outer level. +% \begin{macrocode} +\clist_const:Nn\c_@@_hex_digits_clist{0,1,2,3,4,5,6,7,8,9,A,B,C,D,E,F} +% \end{macrocode} +% \end{macro} +% +% +% +% \begin{macro}{\@@_produce_table_rows:,\@@_handle_hex_H:n, +% \@@_handle_hex_A:n,\@@_handle_hex_B:n, +% \@@_handle_hex_C:n,\@@_handle_hex_D:n} +% The overall code layout is then fairly simply: +% \begin{macrocode} +\cs_new:Npn \@@_produce_table_rows: { +% \end{macrocode} +% First to some general initialization +% \begin{macrocode} + \@@_initialize_table_rows: +% \end{macrocode} +% and then loop we start the loop. The outer level is a bit special +% as currently Unicode has only slots allocated in plane 0, 1, 2 +% and E (well, and F, but that is a private area) so we loop only +% over those and instead of \texttt{0} we use an empty value. +% Not covered is the whole of plane 16 which too is now a +% private area. +% +% \begin{macrocode} + \clist_map_function:nN { { } , 1, 2, E, F } \@@_handle_hex_H:n } +% \end{macrocode} +% +% Most fonts do not have glyphs in the higher planes, which is why +% by default we don't loop using a nonempty \cs{@@_handle_hex_H:n}. +% But if the user wants to scan and display the higher slots they +% can by setting \key{range-end} appropriatly. +% +% So after setting \cs{@@_handle_hex_H:n} we loop over +% \cs{c_@@_hex_digits_clist} for the next +% hex digit (which we call \enquote{A}). +% \begin{macrocode} +\cs_new:Npn \@@_handle_hex_H:n #1 { \tl_gset:Nn\g_@@_hex_H_tl{#1} + \clist_map_function:NN \c_@@_hex_digits_clist \@@_handle_hex_A:n } +% \end{macrocode} +% +% Handling \enquote{A} means storing its value for later use and +% then start a loop for setting the second (or third on higher planes) hex digits: +% \begin{macrocode} +\cs_new:Npn \@@_handle_hex_A:n #1 { \tl_gset:Nn\g_@@_hex_A_tl{#1} + \clist_map_function:NN \c_@@_hex_digits_clist \@@_handle_hex_B:n } +% \end{macrocode} +% +% Same game for \enquote{B} and \enquote{C}\footnote{Actually this +% is a white lie. In reality we do a lot of extra stuff when +% handling \enquote{C} so later one we give a second definition for +% \cs{@@_handle_hex_C:n} but for understanding the overall picture +% the simpler one shown here is better.}: +% \begin{macrocode} +\cs_new:Npn \@@_handle_hex_B:n #1 { \tl_gset:Nn\g_@@_hex_B_tl{#1} + \clist_map_function:NN \c_@@_hex_digits_clist \@@_handle_hex_C:n } +% \end{macrocode} +% +% \begin{macrocode} +\cs_new:Npn \@@_handle_hex_C:n #1 { \tl_gset:Nn\g_@@_hex_C_tl{#1} + \clist_map_function:NN \c_@@_hex_digits_clist \@@_handle_hex_D:n } +% \end{macrocode} +% In the innermost loop we now have the full Unicode number +% available, so there we have to decide what to do with it. This is +% done by \cs{@@_handle_hex_D:n} that receives the full number, +% e.g., \texttt{1A7C} or \texttt{1AD00}, as its argument. +% \begin{macrocode} +\cs_new:Npn \@@_handle_hex_D:n #1 { + \@@_handle_slot:x + { " \g_@@_hex_H_tl \g_@@_hex_A_tl + \g_@@_hex_B_tl \g_@@_hex_C_tl #1 } +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\g_@@_row_tl} +% We first collect the glyphs for a whole row before deciding to +% typeset it, because if the row is entirely empty we want to omit +% it. The data for the row is collected slot by slot and the typesetting +% information (the glyph or the indication for a missing glyph is +% appended to \cs{g_@@_row_tl}. +% \begin{macrocode} +\tl_new:N \g_@@_row_tl +% \end{macrocode} +% \end{macro} + + +% \begin{macro}{\@@_handle_slot:n,\@@_handle_slot:x} +% If the current slot number under inspection contains a glyph in +% our font we want to typeset it. But we don't do this immediately, +% instead we build up the whole row and typeset it later. We +% therefore append a \verb=&= and the glyph (including the necessary +% formatting) to the token list \cs{g_@@_row_tl}. +% \begin{macrocode} +\cs_new:Npn \@@_handle_slot:n #1 { + \@@_if_uchar_exists:nTF { #1 } + { \tl_gput_right:Nn \g_@@_row_tl + { & \@@_format_glyph:n { \symbol{#1} } } +% \end{macrocode} +% We then increment the overall glyph count and record that we have +% seen at least one glyph in the current row. There is not much +% point in displaying rows that are completely empty; indeed, +% we'd end up with extremely large tables which are +% mostly empty. +% \begin{macrocode} + \int_gincr:N\g_@@_glyph_int + \bool_gset_true:N \g_@@_glyph_seen_bool +% \end{macrocode} +% If we do font comparison we also check if the glyph is in the +% second font and if so record that fact. +% \begin{macrocode} + \tl_if_empty:NF \l_@@_compare_font_tl + { + \group_begin: + \l_@@_compare_font_tl + \@@_if_uchar_exists:nT { #1 } + { \int_gincr:N \g_@@_glyph_also_B_int } + \group_end: + } + } +% \end{macrocode} +% If the current slot has no glyph in the font we also add a +% \verb=&= followed by something that indicates the glyph is +% missing. If we do font comparison, it may show the glyph from +% the other font (if it exists there) in some special way to indicate which glyph +% should be in this slot. +% \begin{macrocode} + { \@@_handle_missing_glyph:n {#1} } +} +% \end{macrocode} +% +% \begin{macrocode} +\cs_generate_variant:Nn \@@_handle_slot:n {x} +% \end{macrocode} +% \end{macro} +% + +% \begin{macro}{\@@_handle_missing_glyph:n, +% \@@_handle_missing_glyph_std:n, +% \@@_handle_missing_glyph_compare:n} +% +% In the standard case we typeset a special symbol to indicate that the glyph is missing. +% For this case we provide some customization through keys: +% \cs{l_@@_missing_glyph_tl} holds the symbol for a missing glyph +% (default: a hyphen). It is typeset in a specific color and we allow for +% setting it in a special font. The actual symbol number in +% \verb=#1= is not needed in this scenario. +% \begin{macrocode} +\cs_new:Npn \@@_handle_missing_glyph_std:n #1 { + \tl_gput_right:Nn \g_@@_row_tl + { & + \@@_format_glyph:n { +% \colorbox{black!30} % <--- povide interface + {\l_@@_missing_glyph_color_tl + \l_@@_missing_glyph_font_tl + \l_@@_missing_glyph_tl } + } + } +} +% \end{macrocode} +% +% \keysetup{missing glyphs} +% Here are the keys for customizing the missing glyph representation. +% \begin{macrocode} +\keys_define:nn {@@} { + missing-glyph-color .choice: + ,missing-glyph-color / none .code:n = + \tl_clear:N \l_@@_missing_glyph_color_tl + ,missing-glyph-color / unknown .code:n = + \tl_set:Nn \l_@@_missing_glyph_color_tl { \color {#1} } +% + ,missing-glyph-font .tl_set:N = \l_@@_missing_glyph_font_tl + ,missing-glyph-font .initial:n = \ttfamily \scriptsize + ,missing-glyph .tl_set:N = \l_@@_missing_glyph_tl + ,missing-glyph .initial:n = - } +% \end{macrocode} +% +% +% The default definition for the color is to use the same as the +% one specified by the \key{color} key. We therefore define the +% default outside of the \pkg{l3keys} method. +% \begin{macrocode} +\tl_new:N \l_@@_missing_glyph_color_tl +\tl_set:Nn \l_@@_missing_glyph_color_tl {\l_@@_color_tl} +% \end{macrocode} +% +% This is the version that handles a missing glyph by checking +% the \key{compare-with} font to see if that font contains the +% glyph. +% If yes, the substitute glyph will be typeset, otherwise the missing +% glyph symbol is shown by calling \cs{@@_handle_missing_glyph_std:n}. +% \begin{macrocode} +\cs_new:Npn \@@_handle_missing_glyph_compare:n #1 { + \group_begin: +% \end{macrocode} +% Locally switch to the other font, then check for the glyph: +% \begin{macrocode} + \l_@@_compare_font_tl + \@@_if_uchar_exists:nTF { #1 } + { +% \end{macrocode} +% If available, format it (together with the \texttt{\&}) but use a +% special color and perhaps a background color. +% \begin{macrocode} + \tl_gput_right:Nn \g_@@_row_tl + { & + \@@_format_glyph:n + { \l_@@_compare_bgcolor_tl { \l_@@_compare_color_tl + \l_@@_compare_font_tl + \symbol {#1} } + } + } +% \end{macrocode} +% Having seen a glyph only in the second font we record this fact. +% \begin{macrocode} + \int_gincr:N \g_@@_glyph_only_B_int +% \end{macrocode} +% Also tell the algorithm that we have seen a glyph to typeset. If +% we don't do this then a row consisting of only substitute glyphs is not +% typeset. However, we don't update the glyph count, because this +% is not a glyph from the main font we display. +% \begin{macrocode} + \bool_gset_true:N \g_@@_glyph_seen_bool + } +% \end{macrocode} +% If the alternate font doesn't have the glyph either we +% typeset the missing glyph symbol. +% \begin{macrocode} + { \@@_handle_missing_glyph_std:n {} } + \group_end: +} +% \end{macrocode} +% +% \keysetup{comparison} +% +% In order to display glyphs from a secondary font we need a +% secondary color for the glyph itself and possibly some background color. +% \begin{macrocode} +\tl_new:N \l_@@_compare_with_tl +\tl_new:N \l_@@_compare_color_tl +\tl_new:N \l_@@_compare_bgcolor_tl +% \end{macrocode} +% +% \begin{macrocode} +\keys_define:nn {@@} + { + ,compare-with .tl_set:N = \l_@@_compare_with_tl + ,compare-with .initial:n = + ,compare-color .choice: + ,compare-color / none .code:n + = \tl_clear:N \l_@@_compare_color_tl + ,compare-color / unknown .code:n + = \tl_set:Nn \l_@@_compare_color_tl { \color {#1} } + ,compare-color .initial:n = red + ,compare-bgcolor .choice: + ,compare-bgcolor / none .code:n + = \tl_clear:N \l_@@_compare_bgcolor_tl + ,compare-bgcolor / unknown .code:n + = \tl_set:Nn \l_@@_compare_bgcolor_tl { \colorbox {#1} } + ,compare-bgcolor .initial:n = black!10 +% \end{macrocode} +% If we run a comparison we show different statistics that have +% their own key. +% \begin{macrocode} + ,statistics-compare-format .cs_set:Np + = \@@_format_compare_stats:nnnnnn #1#2#3#4#5#6 + ,statistics-compare-format .initial:n + = \parbox{\linewidth}{ + Total~ number~ of~ glyphs~ in~ \texttt{#1}:~#2\\ + Comparison~ font~ \texttt{#3}~ has~ #5~ missing~ and~ #6~ + extra~ glyphs} + } +% \end{macrocode} +% +% +% By default, i.e., if no font for comparison has been specified, we +% handle missing glyphs by displaying a missing glyph symbol. +% \begin{macrocode} +\cs_new_eq:NN \@@_handle_missing_glyph:n + \@@_handle_missing_glyph_std:n +% \end{macrocode} +% \end{macro} +% + + +% \begin{macro}{\@@_format_glyph:n} +% Every glyph is typeset in a box of equal width with the glyph +% centered and if necessary protruding on both sides. +% \begin{macrocode} +\cs_new:Npn \@@_format_glyph:n #1 { + \hbox_to_wd:nn {\l_@@_glyph_box_dim} { \hss #1 \hss } } +% \end{macrocode} +% +% \keysetup{glyph typesetting} +% The key to customize the width. The 6pt are fine for most cases. +% \begin{macrocode} +\dim_new:N\l_@@_glyph_box_dim +% \end{macrocode} +% +% \begin{macrocode} +\keys_define:nn {@@} { + glyph-width .dim_set:N = \l_@@_glyph_box_dim + ,glyph-width .initial:n = 6pt +} +% \end{macrocode} +% \end{macro} + + +% \begin{macro}{\@@_if_uchar_exists:n} +% For testing whether or not a slot position contains a glyph we +% need to resort to low-level methods, because so far +% \texttt{expl3} doesn't offer an interface. +% \begin{macrocode} +\prg_set_conditional:Npnn \@@_if_uchar_exists:n #1 { TF , T } + { \tex_iffontchar:D \tex_font:D #1 \scan_stop: + \prg_return_true: + \else: + \prg_return_false: + \fi: + } +% \end{macrocode} +% \end{macro} +% +% +% +% +% \subsection{Handling a single row} +% +% +% \begin{macro}{\@@_handle_hex_C:n} +% As promised here is the read definition for +% \cs{@@_handle_hex_C:n} in all its glory. +% \begin{macrocode} +\cs_set:Npn \@@_handle_hex_C:n #1 { +% \end{macrocode} +% We are now at the start of a new row (but with the last row not +% yet typeset) and this last row may need a Unicode block heading +% before it. This is the reason why we have to delay the +% typesetting, because in case the line doesn't contain any glyphs +% we want to typeset neither and that is only known after all +% slots in the row have been processed. +% \begin{macrocode} + \@@_maybe_typeset_a_row_and_display_a_block_title: +% \end{macrocode} +% We then store away the value for the third hex digit (denoted as +% C) in order to start with the next row. +% \begin{macrocode} + \tl_gset:Nn\g_@@_hex_C_tl{#1} +% \end{macrocode} +% Being at the start of a new row we might be at the start of a new +% Unicode block. If so we have to update the block title to add in +% front of the row when we typeset it (or in front of one of the +% next rows if the first rows in the is block have no glyphs). If +% we are still in the same block no update happens. +% \begin{macrocode} + \@@_update_block_title:n { \g_@@_hex_H_tl + \g_@@_hex_A_tl + \g_@@_hex_B_tl + \g_@@_hex_C_tl } +% \end{macrocode} +% We now check if this row is within the requested range, i.e., +% greater than or equal to \cs{l_@@_range_start_tl} and not greater than +% \cs{l_@@_range_end_tl}. +% \begin{macrocode} + \int_compare:nNnF + { " \g_@@_hex_H_tl \g_@@_hex_A_tl + \g_@@_hex_B_tl \g_@@_hex_C_tl 0 } + < { "\l_@@_range_start_tl } + { + \int_compare:nNnTF + { " \g_@@_hex_H_tl \g_@@_hex_A_tl + \g_@@_hex_B_tl \g_@@_hex_C_tl 0 } + > { "\l_@@_range_end_tl } +% \end{macrocode} +% If we are past the \texttt{end-range} we break out the clist +% mapping, to avoind unnecessary repetition. This should be +% propagated back to the outer clists as well (not done). +% \begin{macrocode} + { \clist_map_break: } +% \end{macrocode} +% If we are within range we process the slots in the row by first +% initializing \cs{g_@@_row_tl} with the row title (the info on the +% left) and then loop through all slots the row to append glyphs +% (or missing glyphs) to \cs{g_@@_row_tl} to build up everything we +% need to finally typeset it. +% \begin{macrocode} + { + \tl_gset:Nx \g_@@_row_tl + { + \exp_not:N \@@_format_row_title:n + { \g_@@_hex_H_tl \g_@@_hex_A_tl + \g_@@_hex_B_tl \g_@@_hex_C_tl } + } + \clist_map_function:NN \c_@@_hex_digits_clist + \@@_handle_hex_D:n + } + } +} +% \end{macrocode} +% \end{macro} +% +% +% \begin{macro}{\@@_format_row_title:n} +% The function to format the row title on the left, as used above. +% \begin{macrocode} +\cs_new:Npn \@@_format_row_title:n #1 { + \texttt { \footnotesize \l_@@_color_tl U+#1 0 \, - \, #1 F } +} +% \end{macrocode} +% \end{macro} +% +% +% +% \keysetup{ranges} +% +% For the range we have two keys, its start and the end. By default the +% whole range from 0 to FFFF is processed. +% +% \begin{macrocode} +\tl_new:N \l_@@_range_start_tl +\tl_new:N \l_@@_range_end_tl +% \end{macrocode} +% +% \begin{macrocode} +\keys_define:nn {@@} + { + ,range-start .tl_set:N = \l_@@_range_start_tl + ,range-start .initial:n = 0000 + ,range-end .tl_set:N = \l_@@_range_end_tl + ,range-end .initial:n = FFFF + } +% \end{macrocode} +% +% +% +% +% +% \begin{macro}{\@@_maybe_typeset_a_row_and_display_a_block_title:} +% The function handles the just-finished row and, if the row does not +% consist only of missing glyphs, typesets it. If necessary it also typesets +% a Unicode block name first. +% \begin{macrocode} +\cs_new:Npn \@@_maybe_typeset_a_row_and_display_a_block_title: { +% \end{macrocode} +% We first check if the row had any real glyphs. +% \begin{macrocode} + \bool_if:NTF \g_@@_glyph_seen_bool + { +% \end{macrocode} +% If the row needs typesetting the fun part starts. We first look +% at the content of \cs{g_@@_block_title_tl}. +% \begin{macrocode} + \tl_if_empty:NTF \g_@@_block_title_tl + { +% \end{macrocode} +% It is empty we are in the middle of a block and we can ignore +% the Unicode title. However, we have to see if the previous row +% (or several) was missing (i.e., contained no glyphs). In that +% case we leave a little extra space, otherwise we just finish the +% previous row +% \begin{macrocode} + \bool_if:NTF \g_@@_row_missing_bool + { \@@_debug_nl:n{A}\\[6pt] } + { \@@_debug_nl:n{B}\\ } + } + { +% \end{macrocode} +% Otherwise we first have to typeset the Unicode block title (or +% whatever should happen instead). +% \begin{macrocode} + \typeout{ Processing~ \tl_use:N \g_@@_block_title_tl } + \bool_if:NTF \l_@@_display_block_bool + { +% \end{macrocode} +% If we are to typeset the title the action depends a bit on +% whether we are at the very first row or typesetting a later block. +% \begin{macrocode} + \bool_if:NTF \g_@@_first_row_bool + { + \bool_gset_false:N \g_@@_first_row_bool + \@@_debug_nl:n{C}\\[-4pt] + } + { + \@@_debug_nl:n{D}\\[8pt] + \noalign{\vskip 1pt plus 1pt} % space above block: customizable? + } +% \noalign{\smallskip} % space above block: customizable? + \multicolumn{17}{c}{\normalfont \bfseries + \tl_use:N \g_@@_block_title_tl} +% \end{macrocode} +% After the block title is typeset we may want to add a row of hex +% digits as well if that was requested, otherwise we only leave a +% bit of extra space. +% \begin{macrocode} + \bool_if:NTF \l_@@_blockwise_hex_digits_bool + { \@@_debug_nl:n{E}\\* + \@@_display_row_of_hex_digits: + \@@_debug_nl:n{H}\\*[2pt] + } + { \@@_debug_nl:n{F}\\*[2pt] } + } + { +% \end{macrocode} +% If the Unicode block title is not typeset we may still have to do +% someting special and again it differs if we at the very beginning +% of the table (because there we do nothing except changing the +% state of \cs{g_@@_first_row_bool}). +% \begin{macrocode} + \bool_if:NTF \g_@@_first_row_bool + { \bool_gset_false:N \g_@@_first_row_bool } + { + \@@_debug_nl:n{G~ (new~ block)} + \l_@@_display_block_action_tl + } + } +% \end{macrocode} +% Once we are past the block title we clear it, so that it is not +% retypeset before the next row. +% \begin{macrocode} + \tl_gclear:N \g_@@_block_title_tl + } +% \end{macrocode} +% The final action is to typeset the row and reset the booleans (in +% case they were true; if they are false already then we do this +% unnecessarily, but that is probably faster than testing first). +% \begin{macrocode} + \bool_gset_false:N \g_@@_glyph_seen_bool + \bool_gset_false:N \g_@@_row_missing_bool + \tl_use:N \g_@@_row_tl + } +% \end{macrocode} +% Current row had no glyphs; remember that fact, and that is all we +% have to do in that case. +% \begin{macrocode} + { + \bool_gset_true:N \g_@@_row_missing_bool + } +} +% \end{macrocode} +% \end{macro} + +% +% +% \subsection{Initialisation at the start of the table} +% +% +% \begin{macro}{\g_@@_first_row_bool,\g_@@_glyph_seen_bool,\g_@@_row_missing_bool} +% Declare the three booleans used in the code below. They will tell +% us answers to the following questions: +% \begin{itemize} +% \item Are we processing the first row? +% \item Have we seen any glyph so far (in the current row)? +% \item Did we have one or more missing rows recently? +% \end{itemize} +% \begin{macrocode} +\bool_new:N \g_@@_first_row_bool +\bool_new:N \g_@@_glyph_seen_bool +\bool_new:N \g_@@_row_missing_bool +% \end{macrocode} +% \end{macro} + + + + + + +% \begin{macro}{\@@_initialize_table_rows:} +% At the start of a table we are processing the first row +% and so we (obviously) haven't seen a glyph yet and there wasn't a +% missing row recently. +% \begin{macrocode} +\cs_new:Npn \@@_initialize_table_rows: { + \bool_gset_true:N \g_@@_first_row_bool + \bool_gset_false:N \g_@@_glyph_seen_bool + \bool_gset_false:N \g_@@_row_missing_bool +% \end{macrocode} +% And clearly the glyph count for the font(s) is zero. +% \begin{macrocode} + \int_gzero:N \g_@@_glyph_int + \int_gzero:N \g_@@_glyph_only_B_int + \int_gzero:N \g_@@_glyph_also_B_int +} +% \end{macrocode} +% \end{macro} + + +% +% +% \subsection{Handling block titles} +% +% \begin{macro}{g_@@_block_title_tl} +% We keep the current block title in this token list. +% \begin{macrocode} +\tl_new:N \g_@@_block_title_tl +% \end{macrocode} +% \end{macro} + + +% \begin{macro}{\@@_update_block_title:n} +% A block title is updated when the hex digits A,B,C have a certain +% value, so this is nothing more than a huge case switch. +% \begin{macrocode} +\cs_new:Npn \@@_update_block_title:n #1 { + \tl_gset:Nx \g_@@_block_title_tl { + \int_case:nnF{ "#1 } + { + { "000 }{ Basic~ Latin } + { "008 }{ Latin-1~ Supplement } + { "010 }{ Latin~ Extended-A } + { "018 }{ Latin~ Extended-B } + { "025 }{ IPA~ Extensions } + { "02B }{ Spacing~ Modifier~ Letters } + { "030 }{ Combining~ Diacritical~ Marks } + { "037 }{ Greek~ and~ Coptic } + { "040 }{ Cyrillic } + { "053 }{ Armenian } + { "059 }{ Hebrew } + { "060 }{ Arabic } + { "070 }{ Syriac } + { "075 }{ Arabic~ Supplement } + { "078 }{ Thaana } + { "07C }{ NKo } + { "090 }{ Devanagari } + { "098 }{ Bengali } + { "0A0 }{ Gurmukhi } + { "0A8 }{ Gujarati } + { "0B0 }{ Oriya } + { "0B8 }{ Tamil } + { "0C0 }{ Telugu } + { "0C8 }{ Kannada } + { "0D0 }{ Malayalm } + { "0D8 }{ Sinhala } + { "0E0 }{ Thai } + { "0E8 }{ Lao } + { "0F0 }{ Tibetan } + { "100 }{ Myanmar } + { "10A }{ Georgian } + { "110 }{ Hangul~ Jamo } + { "120 }{ Ethiopic } + { "138 }{ Ethiopic~ Supplement } + { "13A }{ Cherokee } + { "140 }{ Unified~ Canadian~ Aboriginal~ Syllabics } + { "168 }{ Ogham } + { "16A }{ Runic } + { "170 }{ Tagalog } + { "172 }{ Hanunoo } + { "174 }{ Buhid } + { "176 }{ Tagbanwa } + { "178 }{ Khmer } + { "180 }{ Mongolian } + { "190 }{ Limbu } + { "195 }{ Tai~ Le } + { "198 }{ New~ Tai~ Le } + { "19E }{ Khmer~ Symbols } + { "1A0 }{ Buginese } + { "1B0 }{ Balinese } + { "1D0 }{ Phonetic~ Extensions } + { "1D8 }{ Phonetic~ Extensions~ Supplement } + { "1DC }{ Combining~ Diacritical~ Marks~ Supplement } + { "1E0 }{ Latin~ Extended~ Additional } + { "1F0 }{ Greek~ Extended } + { "200 }{ General~ Punctuation } + { "207 }{ Superscripts~ and~ Subscripts } + { "20A }{ Currency~ Symbols } + { "20D }{ Combining~ Diacritical~ Marks~ for~ Symbols } + { "210 }{ Letterlike~ Symbols } + { "215 }{ Number~ Forms } + { "219 }{ Arrows } + { "220 }{ Mathematical~ Operators } + { "230 }{ Miscellaneous~ Technical } + { "240 }{ Control~ Pictures } + { "244 }{ Optical~ Character~ Recognition } + { "246 }{ Enclosed~ Alphanumerics } + { "250 }{ Box~ Drawing } + { "258 }{ Block~ Elements } + { "25A }{ Geometric~ Shapes } + { "260 }{ Miscellaneous~ Shapes } + { "270 }{ Dingbats } + { "27C }{ Miscellaneous~ Mathematical~ Symbols-A } + { "27F }{ Supplemental~ Arrows-A } + { "280 }{ Braille~ Patterns } + { "290 }{ Supplemental~ Arrows-B } + { "298 }{ Miscellaneous~ Mathematical~ Symbols-B } + { "2A0 }{ Supplemental~ Mathematical~ Operators } + { "2B0 }{ Miscellaneous~ Symbols~ and~ Arrows } + { "2C0 }{ Glagolitic } + { "2C6 }{ Latin~ Extended-C } + { "2C8 }{ Coptic } + { "2D0 }{ Georgian~ Supplement } + { "2D3 }{ Tifinagh } + { "2D8 }{ Ethiopic~ Extended } + { "2E0 }{ Supplemental~ Punctuation } + { "2E8 }{ CJK~ Radicals~ Supplement } + { "2F0 }{ Kangxi~ Radicals } + { "2FF }{ Ideographic~ Description~ Characters } + { "300 }{ CJK~ Symbols~ and~ Punctuation } + { "304 }{ Hiragana } + { "30A }{ Katakana } + { "310 }{ Bopomofo } + { "313 }{ Hangul~ Compatibility~ Jamo } + { "319 }{ Kanbun } + { "31A }{ Bopomofo~ Extended } + { "31C }{ CJK~ Strokes } + { "31F }{ Katakana~ Phonetic~ Extensions } + { "320 }{ Enclosed~ CJK~ Letters~ and~ Months } + { "330 }{ CJK~ Compatibility } + { "4DC }{ Yijing~ Hexagram~ Symbols } + { "A00 }{ Yi~ Syllables } + { "A49 }{ Yi~ Radicals } + { "A70 }{ Modifier~ Tone~ Letters } + { "A72 }{ Latin~ Extended-D } + { "A80 }{ Syloti~ Nagri } + { "A84 }{ Phags-pa } + { "A88 }{ Saurashtra } + { "A8E }{ Devanagari Extended } + { "A90 }{ Kayah Li } + { "A93 }{ Rejang } + { "A96 }{ Hangul Jamo Extended-A } + { "A98 }{ Javanese } + { "A9E }{ Myanmar Extended-B } + { "AA0 }{ Cham } + { "AA6 }{ Myanmar Extended-A } + { "AA8 }{ Tai Viet } + { "AAE }{ Meetei Mayek Extensions } + { "AB0 }{ Ethiopic Extended-A } + { "AB3 }{ Latin Extended-E } + { "AB7 }{ Cherokee Supplement } + { "ABC }{ Meetei Mayek } + { "AC0 }{ Hangul Syllables } + { "D7B }{ Hangul Jamo Extended-B } + { "D80 }{ High Surrogates } + { "DB8 }{ High Private Use Surrogates } + { "DC0 }{ Low Surrogates } + { "E00 }{ Private~ Use~ Area } + { "F90 }{ CJK~ Compatibility~ Ideographs } + { "FB0 }{ Alphabetic~ Presentation~ Forms } + { "FB5 }{ Arabic~ Presentation~ Forms-A } + { "FE0 }{ Variation~ Selectors } + { "FE1 }{ Vertical~ Forms } + { "FE2 }{ Combining~ Half~ Marks } + { "FE3 }{ CJK~ Compatibility~ Forms } + { "FE5 }{ Small~ Form~ Variants } + { "FE7 }{ Arabic~ Presentation~ Forms-B } + { "FF0 }{ Halfwidth~ and Fullwidth~ Forms } + { "FFF }{ Specials~ ... } +%% ... Plane 1 ... + { "1000 }{ Linear~ B~ Syllabary } + { "1008 }{ Linear~ B~ Ideograms } + { "1010 }{ Aegean~ Numbers } + { "1014 }{ Ancient~ Greek~ Numbers } + { "1019 }{ Ancient~ Symbols } + { "101D }{ Phaistos~ Disc } + { "1028 }{ Lycian } + { "102A }{ Carian } + { "102E }{ Coptic~ Epact~ Numbers } + { "1030 }{ Old~ Italic } + { "1033 }{ Gothic } + { "1035 }{ Old~ Permic } + { "1038 }{ Ugaritic } + { "103A }{ Old~ Persian } + { "1040 }{ Deseret } + { "1045 }{ Shavian } + { "1048 }{ Osmanya } + { "104B }{ Osage } + { "1050 }{ Elbasan } + { "1053 }{ Caucasian~ Albanian } + { "1060 }{ Linear~ A } + { "1080 }{ Cypriot~ Syllabary } + { "1084 }{ Imperial~ Aramaic } + { "1086 }{ Palmyrene } + { "1088 }{ Nabataean } + { "108E }{ Hatran } + { "1090 }{ Phoenician } + { "1092 }{ Lydian } + { "1098 }{ Meroitic~ Hieroglyphs } + { "109A }{ Meroitic~ Cursive } + { "10A0 }{ Kharoshthi } + { "10A6 }{ Old~ South~ Arabian } + { "10A8 }{ Old~ North~ Arabian } + { "10AC }{ Manichaean } + { "10B0 }{ Avestan } + { "10B4 }{ Inscriptional~ Parthian } + { "10B6 }{ Inscriptional~ Pahlavi } + { "10B8 }{ Psalter~ Pahlavi } + { "10C0 }{ Old~ Turkic } + { "10C8 }{ Old~ Hungarian } + { "10E6 }{ Rumi~ Numeral~ Symbols } + { "1100 }{ Brahmi } + { "1108 }{ Kaithi } + { "110D }{ Sora~ Sompeng } + { "1110 }{ Chakma } + { "1115 }{ Mahajani } + { "1118 }{ Sharada } + { "111E }{ Sinhala~ Archaic~ Numbers } + { "1120 }{ Khojki } + { "1128 }{ Multani } + { "112B }{ Khudawadi } + { "1130 }{ Grantha } + { "1140 }{ Newa } + { "1148 }{ Tirhuta } + { "1158 }{ Siddham } + { "1160 }{ Modi } + { "1166 }{ Mongolian~ Supplement } + { "1168 }{ Takri } + { "1170 }{ Ahom } + { "118A }{ Warang~ Citi } + { "11A0 }{ Zanabazar~ Square } + { "11A5 }{ Soyombo } + { "11AC }{ Pau~ Cin~ Hau } + { "11C0 }{ Bhaiksuki } + { "11C7 }{ Marchen } + { "11D0 }{ Masaram~ Gondi } + { "1200 }{ Cuneiform } + { "1240 }{ Cuneiform~ Numbers~ and~ Punctuation } + { "1248 }{ Early~ Dynastic~ Cuneiform } + { "1300 }{ Egyptian~ Hieroglyphs } + { "1440 }{ Anatolian~ Hieroglyphs } + { "1680 }{ Bamum~ Supplement } + { "16A4 }{ Mro } + { "16AD }{ Bassa~ Vah } + { "16B0 }{ Pahawh~ Hmong } + { "16F0 }{ Miao } + { "16FE }{ Ideographic~ Symbols~ and~ Punctuation } + { "1700 }{ Tangut } + { "1880 }{ Tangut~ Components } + { "1B00 }{ Kana~ Supplement } + { "1B10 }{ Kana~ Extended-A } + { "1B17 }{ Nushu } + { "1BC0 }{ Duployan } + { "1BCA }{ Shorthand~ Format~ Controls } + { "1D00 }{ Byzantine~ Musical~ Symbols } + { "1D10 }{ Musical~ Symbols } + { "1D20 }{ Ancient~ Greek~ Musical~ Notation } + { "1D30 }{ Tai~ Xuan~ Jing~ Symbols } + { "1D36 }{ Counting~ Rod~ Numerals } + { "1D40 }{ Mathematical~ Alphanumeric~ Symbols } + { "1D80 }{ Sutton~ SignWriting } + { "1E00 }{ Glagolitic~ Supplement } + { "1E80 }{ Mende~ Kikakui } + { "1E90 }{ Adlam } + { "1EE0 }{ Arabic~ Mathematical~ Alphabetic~ Symbols } + { "1F00 }{ Mahjong~ Tiles } + { "1F03 }{ Domino~ Tiles } + { "1F0A }{ Playing~ Cards } + { "1F10 }{ Enclosed~ Alphanumeric~ Supplement } + { "1F20 }{ Enclosed~ Ideographic~ Supplement } + { "1F30 }{ Miscellaneous~ Symbols~ and~ Pictographs } + { "1F60 }{ Emoticons } + { "1F65 }{ Ornamental~ Dingbats } + { "1F68 }{ Transport~ and~ Map~ Symbols } + { "1F70 }{ Alchemical~ Symbols } + { "1F78 }{ Geometric~ Shapes~ Extended } + { "1F80 }{ Supplemental~ Arrows-C } + { "1F90 }{ Supplemental~ Symbols~ and~ Pictographs } + { "2000 }{ CJK~ Unified~ Ideographs~ Extension~ B } + { "2A70 }{ CJK~ Unified~ Ideographs~ Extension~ C } + { "2B74 }{ CJK~ Unified~ Ideographs~ Extension~ D } + { "2B82 }{ CJK~ Unified~ Ideographs~ Extension~ E } + { "2CEB }{ CJK~ Unified~ Ideographs~ Extension~ F } + { "2F80 }{ CJK~ Compatibility~ Ideographs~ Supplement } + { "E010 }{ Tags } + { "E000 }{ Variation~ Selectors~ Supplement } + { "F000 }{ Supplementary~ Private~ Use~ Area-A } +% higher up not covered! + } +% \end{macrocode} +% If none of the above has matched we are somewhere within a block +% so we want keep the current name. However, since the case +% statement was executed within a |\tl_gset:Nx| we have to do this +% by passing the current block name back. +% \begin{macrocode} + { \tl_use:N \g_@@_block_title_tl } + } +} +% \end{macrocode} +% \end{macro} +% +% +% \keysetup{display blocks} +% +% The Unicode blocks may get indicated in different ways: with titles, +% only through rules, or not at all. Here is the necessary setup. +% +% \begin{macrocode} +\bool_new:N \l_@@_display_block_bool +\tl_new:N \l_@@_display_block_action_tl +% \end{macrocode} +% +% \begin{macrocode} +\keys_define:nn {@@} + { + ,display-block .choice: + ,display-block / titles .code:n = + \bool_set_true:N \l_@@_display_block_bool + \tl_set:Nn \l_@@_display_block_action_tl {\\} + ,display-block / rules .code:n = + \bool_set_false:N \l_@@_display_block_bool + \tl_set:Nn \l_@@_display_block_action_tl {\\ \midrule} + ,display-block / none .code:n = + \bool_set_false:N \l_@@_display_block_bool + \tl_set:Nn \l_@@_display_block_action_tl {\\} + ,display-block .initial:n = titles + } +% \end{macrocode} +% +% +% That's all of the programming using the L3 layer. +% \begin{macrocode} +\ExplSyntaxOff +% \end{macrocode} +% What remains is to require all packages needed \ldots +% \begin{macrocode} +\RequirePackage{longtable,booktabs,caption,fontspec} +% \end{macrocode} +% \ldots and executing all options passed to the +% package via \cs{usepackage}. +% \begin{macrocode} +\ProcessKeysPackageOptions{@@} +% +% \end{macrocode} +% +% +% +% +% +% \section{The standalone \texttt{unicodefont.tex} file} +% +% \begin{macrocode} +%<*standalone> +\documentclass{article} +% \end{macrocode} +% +% \begin{macrocode} +\setlength\textwidth{470pt} +\setlength\oddsidemargin{0pt} +\addtolength\textheight{7\baselineskip} +\addtolength\topmargin{-3\baselineskip} +% \end{macrocode} +% +% \begin{macrocode} +\usepackage{unicodefonttable} +% \end{macrocode} +% +% \begin{macrocode} +\def\DEFAULTfontname{Latin Modern Roman} +\def\DEFAULTfontfeatures{} +\def\DEFAULTtableconfig{} +\def\DEFAULTunicodefont{} +\begin{document} +% \end{macrocode} +% +% \begin{macrocode} +\typeout{^^J} +% \end{macrocode} +% +% \begin{macrocode} +\ifx\generatetable\undefined +\else + \typein[\answer]{^^JReuse settings from last time (default yes)?^^J^^J% + [ font name = \DEFAULTfontname^^J + \space unicode? = \ifx\DEFAULTunicodefont\empty yes^^J + \space font features = \DEFAULTfontfeatures + \else no\fi^^J + \space table config = \DEFAULTtableconfig \space]} +\fi +% \end{macrocode} +% +% \begin{macrocode} +\ifx\answer\empty + \let\FontNameToTable\DEFAULTfontname + \let\IsUnicodeFont\DEFAULTunicodefont + \let\FontFeaturesToApply\DEFAULTfontfeatures + \let\TableConfigurationToApply\DEFAULTtableconfig +\else +% \end{macrocode} +% +% \begin{macrocode} +\typein[\FontNameToTable]% + {^^JInput external font name as understood by fontspec, e.g.,^^J% + 'TeX Gyre Pagella' or 'lmroman10-regular.otf'% + \ifx\DEFAULTfontname\empty\else + ^^J^^J[default \DEFAULTfontname]\fi:} +\ifx\FontNameToTable\empty \let\FontNameToTable\DEFAULTfontname \fi +% \end{macrocode} +% +% \begin{macrocode} +\typein[\IsUnicodeFont]% + {^^JIs this a Unicode font?^^J^^J% + \ifx\DEFAULTunicodefont\empty [default yes]\else [default no]\fi:} +% \end{macrocode} +% +% \begin{macrocode} +\ifx\IsUnicodeFont\empty +% \ifx\DEFAULTunicodefont\empty +% \else + \let\IsUnicodeFont\DEFAULTunicodefont +% \fi +\else + \ifx\DEFAULTunicodefont\empty + \else + \let\IsUnicodeFont\empty + \fi +\fi +% \end{macrocode} +% +% \begin{macrocode} +\ifx\IsUnicodeFont\empty + \typein[\FontFeaturesToApply]% + {^^JInput font feature key/value list to apply% + \ifx\DEFAULTfontfeatures\empty\else + ^^J^^J[default \DEFAULTfontfeatures]\fi:} + \ifx\FontFeaturesToApply\empty \let\FontFeaturesToApply\DEFAULTfontfeatures \fi +\else + \let\FontFeaturesToApply\DEFAULTfontfeatures +\fi +% \end{macrocode} +% +% \begin{macrocode} +\typein[\TableConfigurationToApply]% + {^^JInput table configuration key/value list to apply% + \ifx\DEFAULTtableconfig\empty\else + ^^J^^J[default + \expandafter\detokenize\expandafter{\DEFAULTtableconfig}]\fi:} +\ifx\TableConfigurationToApply\empty + \let\TableConfigurationToApply\DEFAULTtableconfig +\fi +% \end{macrocode} +% +% \begin{macrocode} +\edef\generatetable{\noexpand\displayfonttable + \ifx\IsUnicodeFont\empty\else *\fi + \ifx\TableConfigurationToApply\empty\else + [\expandafter\unexpanded\expandafter{\TableConfigurationToApply}]\fi + {\FontNameToTable}% + \ifx\FontFeaturesToApply\empty\else[\FontFeaturesToApply]\fi +} +% \end{macrocode} +% +% \begin{macrocode} +\fi +% \end{macrocode} +% +% \begin{macrocode} +\makeatletter +\protected@write\@auxout{}{\gdef\string\generatetable + {\expandafter\detokenize\expandafter{\generatetable}}} +\protected@write\@auxout{}{\gdef\string\DEFAULTfontname{\FontNameToTable}} +\protected@write\@auxout{}{\gdef\string\DEFAULTunicodefont{\IsUnicodeFont}} +\protected@write\@auxout{}{\gdef\string\DEFAULTfontfeatures{\FontFeaturesToApply}} +\protected@write\@auxout{}{\gdef\string\DEFAULTtableconfig + {\expandafter\detokenize\expandafter{\TableConfigurationToApply}}} +\makeatother +% \end{macrocode} +% +% \begin{macrocode} +\generatetable +\end{document} +% +% \end{macrocode} +% +% +% +% \section{A samples file} +% +% \begin{macrocode} +%<*samples> +% \end{macrocode} +% +% \begin{macrocode} +%< +% \end{macrocode} +% +% \Finale +% + + +\endinput + +%%%%%%%%%%%%%%%%%%% diff --git a/macros/latex/contrib/unicodefonttable/unicodefonttable.ins b/macros/latex/contrib/unicodefonttable/unicodefonttable.ins new file mode 100644 index 0000000000..b87cb4e13f --- /dev/null +++ b/macros/latex/contrib/unicodefonttable/unicodefonttable.ins @@ -0,0 +1,72 @@ +%% +%% This file will generate fast loadable files and documentation +%% driver files from the dtx file(s) in this package when run through +%% LaTeX or TeX. +%% +%% Copyright 2019-2021 Frank Mittelbach +%% +%% +%% This file is part of the unicodefonttable Bundle for LaTeX. +%% ------------------------------------------------------- +%% +%% It may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either version 1.3c +%% of this license or (at your option) any later version. +%% The latest version of this license is in +%% https://www.latex-project.org/lppl.txt +%% and version 1.3c or later is part of all distributions of LaTeX +%% version 2008 or later. +%% +%% As this file contains legal notices, it is NOT PERMITTED to modify +%% this file in any way that the legal information placed into +%% generated files is changed (i.e., the files generated when the +%% original file is executed). This restriction does not apply if +%% (parts of) the content is reused in a different WORK producing its +%% own generated files. +%% +%% +%% --------------- start of docstrip commands ------------------ +%% +\input docstrip + +\keepsilent +\askforoverwritefalse + +\usedir{tex/latex/unicodefonttable} + +\preamble + +This is a generated file. + +Copyright 2019-2021 Frank Mittelbach + +This file was generated from file(s) of the LaTeX `unicodefonttable Bundle'. +-------------------------------------------------------------------------- + +It may be distributed and/or modified under the +conditions of the LaTeX Project Public License, either version 1.3c +of this license or (at your option) any later version. +The latest version of this license is in + https://www.latex-project.org/lppl.txt +and version 1.3c or later is part of all distributions of LaTeX +version 2008 or later. + +This file may only be distributed together with a copy of the LaTeX +`unicodefonttable Bundle'. You may however distribute the `unicodefonttable Bundle' +without such generated files. + +The newest sources can be found below + + https://github.com/FrankMittelbach/fmitex-unicodetable + +where one can also log issues in case there are any. + + +\endpreamble + +\generate{\file{unicodefonttable.sty}{\from{unicodefonttable.dtx}{package}}} +\generate{\file{unicodefonttable-samples.tex}{\from{unicodefonttable.dtx}{samples}}} + +\generate{\file{unicodefont.tex}{\from{unicodefonttable.dtx}{standalone}}} + +\endbatchfile diff --git a/macros/luatex/latex/unitipa/README.txt b/macros/luatex/latex/unitipa/README.txt deleted file mode 100644 index ac566a58dc..0000000000 --- a/macros/luatex/latex/unitipa/README.txt +++ /dev/null @@ -1,9 +0,0 @@ --------------------------------------------------------------------------- -Package: unitipa -Author: Niranjan -Version: 0.3 (3 April, 2021) -Description: TIPA typefaces with Unicode characters. -Repository: https://gitlab.com/niruvt/unitipa -Bug tracker: https://gitlab.com/niruvt/unitipa/-/issues -License: The LaTeX Project Public License v1.3c or later. --------------------------------------------------------------------------- diff --git a/macros/luatex/latex/unitipa/unitipa.dtx b/macros/luatex/latex/unitipa/unitipa.dtx deleted file mode 100644 index 19722de1cf..0000000000 --- a/macros/luatex/latex/unitipa/unitipa.dtx +++ /dev/null @@ -1,524 +0,0 @@ -% \iffalse meta-comment -% -% File: unitipa.dtx -% --------------------------------------------------------------------------- -% Package: unitipa -% Author: Niranjan -% Version: 0.3 (3 April, 2021) -% Description: TIPA typefaces with Unicode characters. -% Repository: https://gitlab.com/niruvt/unitipa -% Bug tracker: https://gitlab.com/niruvt/unitipa/-/issues -% License: The LaTeX Project Public License v1.3c or later. -% --------------------------------------------------------------------------- -% This work may be distributed and/or modified under the conditions of the -% LaTeX Project Public License, either version 1.3c 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. -% -% This work has the LPPL maintenance status `maintained'. -% -% The Current Maintainer of this work is Niranjan. -% -% This work consists of the files unitipa.dtx -% unitipa.ins -% and the derived file unitipa.sty. -% \fi -% \iffalse -%<*internal> -\iffalse -% -%<*readme> --------------------------------------------------------------------------- -Package: unitipa -Author: Niranjan -Version: 0.3 (3 April, 2021) -Description: TIPA typefaces with Unicode characters. -Repository: https://gitlab.com/niruvt/unitipa -Bug tracker: https://gitlab.com/niruvt/unitipa/-/issues -License: The LaTeX Project Public License v1.3c or later. --------------------------------------------------------------------------- -% -%<*internal> -\fi -% -%<*driver|package> -\def\unitipaname{unitipa} -\def\unitipaversion{0.3} -\def\unitipadate{2021/04/03} -\def\unitipadescription{TIPA typefaces with Unicode characters.} -% -%<*driver> -\documentclass{l3doc} -\usepackage{tipa} -\usepackage{graphicx} -\usepackage{unitipa} -\usepackage{hyperref} -\usepackage{xcolor} -\hypersetup{% -colorlinks,% -linkcolor=red!60!black,% -citecolor=green!60!black,% -urlcolor=blue!60!black% -}% -\usepackage{fontawesome5} -\begin{document} - \DocInput{\unitipaname.dtx} -\end{document} -% -% \fi -% \title{The \pkg{\unitipaname} package} -% \author{Niranjan} -% \date^^A -% {^^A -% Version \unitipaversion\ --- \unitipadate\\[1ex]^^A -% {\small\faIcon{link}\quad\url{https://ctan.org/pkg/unitipa}}\\^^A -% {\small\faIcon{gitlab}\quad\url{https://gitlab.com/niruvt/unitipa}}^^A -% } -% \maketitle -% -% This package converts Unicode characters into TIPA commands, which gives us -% \pkg{tipa} typefaces, without actually learning the \pkg{tipa} commands in -% much details. This package needs Lua\LaTeX\ as the compiler for correctly -% typesetting the IPA diacritics. TIPA was designed to match with the Computer -% Modern design, no other IPA font matches with traditional \LaTeX\ font. This -% package is helpful for getting the beautiful \pkg{tipa} shapes with Unicode -% characters. This package assumes that the user knows how to type IPA -% Unicode. Following is the list of symbols that \textit{cannot} be used with -% the traditional \LaTeX\ font. Every other symbol in the IPA chart is present -% in the current \LaTeX\ font. -% \begin{description} -% \item[Plosives] ʈ ɖ ɟ ɢ ʔ -% \item[Nasals] ɱ ɳ ɲ\footnote{Added in v0.2} ɴ -% \item[Trills] ʙ ʀ -% \item[Taps or flaps] ⱱ ɾ ɽ -% \item[Fricatives] ɸ β θ ʃ ʒ ʂ ʐ ɣ χ ʁ ʕ ɦ -% \item[Lateral fricatives] ɬ ɮ -% \item[Approximants] ʋ ɹ ɻ ɰ -% \item[Lateral approximants] ɭ ʎ ʟ -% \item[Affricates] ʧ ʤ ʦ ʣ -% \item[Close vowels] ɨ ʉ ɯ -% \item[Near-close vowels] ɪ ʏ ʊ -% \item[Close-mid vowels] ɵ ɤ -% \item[Open-mid vowels] ɛ ɜ ɞ ʌ ɔ -% \item[Near-open vowels] ɐ ɶ ɒ -% \item[Open vowels] ɑ\footnote{Reported \textit{\&} added by Heller, Thomas in -% v0.2. -% -% Bug report - \url{https://gitlab.com/niruvt/unitipa/-/issues/1} -% -% MR - \url{https://gitlab.com/niruvt/unitipa/-/merge_requests/1} -% } -% \item[Clicks] ʘ ǀ ǃ ǂ ǁ -% \item[Voiced Implosives] ɓ ɗ ʄ ɠ ʛ -% \item[Ejective] ʼ -% \item[Suprasegmentals] ˈ ˌ ː ˑ -% \item[Other symbols] ʍ ɥ ʜ ʢ ʡ ɕ ʑ ɺ ɧ -% \item[Dependent diacritics] k̥ e̬ o̹ o̜ u̟ l̠ e̽ m̩ a̯ b̤ t̼ l̴ ɛ̝ e̞ e̘ e̙ t̪ t̺ n̻ p̚ -% \item[Independent diacritics] kʰ gʱ kʷ cʲ kˠ pˤ -% \item[Tie bars] t͜s k͡p -% \item[Tones] ꜜ ꜛ a᷄ e᷅ e᷈ -% \end{description} -% \begin{documentation} -% \section{Package options} -% \begin{function}{nodiacritics} -% If you are very sure that you don't need any IPA diacritics in your document, -% you can load the package with this option. If this option is loaded, package -% can be compiled with other compilers too, but no IPA diacritic will be -% printed. -% \end{function} -% \begin{function}{ipafont} -% IPA character [ⱱ] is not available in \pkg{tipa}, but for the convenience of -% users, this character is coded with Doulos SIL as it seemed to me the closest -% match to \pkg{tipa} typeface. If you don't have this font, please install -% package \pkg{\href{https://ctan.org/pkg/doulossil}{doulossil}} or download the -% font from \href{https://software.sil.org/doulos/}{here}. If users want to -% change the font used for this character, they can simply add the font name as -% the value to this option. -% \begin{syntax} -% ipafont=\meta{font name} -% \end{syntax} -% \end{function} -% \end{documentation} -% \begin{implementation} -% \section{Implementation} -% \begin{macrocode} -%<@@=unitipa> -%<*package> -% \end{macrocode} -% \begin{macrocode} -\ProvidesPackage{unitipa}[2021/04/03 v0.3 -TIPA typefaces with unicode characters] -\RequirePackage{tipa} -% \end{macrocode} -% Provide package with its basic information and load package \pkg{tipa}. -% \begin{macrocode} -\RequirePackage{graphicx} -% \end{macrocode} -% Package \pkg{graphicx} is needed for printing [ɞ] correctly. See line no.\ -% 295. -% \begin{macrocode} -\RequirePackage{newunicodechar} -\RequirePackage{fontspec} -\RequirePackage{pgfkeys} -\pgfkeys{% - unitipa/.is family, unitipa/.cd,% - ipafont/.code={\setfontfamily{\ipa}{#1}},% - ipafont=DoulosSIL% -}% -\DeclareTextFontCommand{\ipatext}{\ipa} -\def\unitipa@ipafont#1{\pgfkeys{unitipa/.cd,#1}} -\DeclareOption*{\expandafter\unitipa@ipafont\expandafter{\CurrentOption}} -% \end{macrocode} -% Option \verb|ipafont| provided using \pkg{pgfkeys}. -% \begin{macrocode} -\newif\ifnodiacritics -\nodiacriticsfalse -\DeclareOption{nodiacritics}{\nodiacriticstrue} -\ProcessOptions\relax -\ifnodiacritics -\relax -\else -\RequirePackage{iftex} -\RequirePackage{luacode} -\RequireLuaTeX -%% Dependent diacritic marks -\begin{luacode} - function voiceless ( s ) - s = unicode.utf8.gsub ( s , '(%a)̥', '\\textsubring{%1}' ) - return s - end -\end{luacode} -\directlua{luatexbase.add_to_callback("process_input_buffer", - voiceless, "voiceless")} -\begin{luacode} - function voiced ( s ) - s = unicode.utf8.gsub ( s , '(%a)̬', '\\textsubwedge{%1}' ) - return s - end -\end{luacode} -\directlua{luatexbase.add_to_callback("process_input_buffer", - voiced, "voiced")} -\begin{luacode} - function morerounded ( s ) - s = unicode.utf8.gsub ( s , '(%a)̹', '\\textsubrhalfring{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - morerounded, "morerounded")} - \begin{luacode} - function lessrounded ( s ) - s = unicode.utf8.gsub ( s , '(%a)̜', '\\textsublhalfring{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - lessrounded, "lessrounded")} - \begin{luacode} - function advanced ( s ) - s = unicode.utf8.gsub ( s , '(%a)̟', '\\textsubplus{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - advanced, "advanced")} - \begin{luacode} - function retracted ( s ) - s = unicode.utf8.gsub ( s , '(%a)̠', '\\textsubbar{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - retracted, "retracted")} - \begin{luacode} - function midcentralized ( s ) - s = unicode.utf8.gsub ( s , '(%a)̽', '\\textovercross{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - midcentralized, "midcentralized")} - \begin{luacode} - function syllabic ( s ) - s = unicode.utf8.gsub ( s , '(%a)̩', '\\textsyllabic{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - syllabic, "syllabic")} - \begin{luacode} - function nonsyllabic ( s ) - s = unicode.utf8.gsub ( s , '(%a)̯', '\\textsubarch{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - nonsyllabic, "nonsyllabic")} - \begin{luacode} - function breathyvoiced ( s ) - s = unicode.utf8.gsub ( s , '(%a)̤', '\\textsubumlaut{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - breathyvoiced, "breathyvoiced")} - \begin{luacode} - function linguolabial ( s ) - s = unicode.utf8.gsub ( s , '(%a)̼', '\\textseagull{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - linguolabial, "linguolabial")} - \begin{luacode} - function velarized ( s ) - s = unicode.utf8.gsub ( s , '(%a)̴', '\\textsuperimposetilde{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - velarized, "velarized")} - \begin{luacode} - function raised ( s ) - s = unicode.utf8.gsub ( s , '(%a)̝', '\\textraising{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - raised, "raised")} - \begin{luacode} - function lowered ( s ) - s = unicode.utf8.gsub ( s , '(%a)̞', '\\textlowering{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - lowered, "lowered")} - \begin{luacode} - function advancedtr ( s ) - s = unicode.utf8.gsub ( s , '(%a)̘', '\\textadvancing{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - advancedtr, "advancedtr")} - \begin{luacode} - function retractedtr ( s ) - s = unicode.utf8.gsub ( s , '(%a)̙', '\\textretracting{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - retractedtr, "retractedtr")} - \begin{luacode} - function dental ( s ) - s = unicode.utf8.gsub ( s , '(%a)̪', '\\textsubbridge{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - dental, "dental")} - \begin{luacode} - function apical ( s ) - s = unicode.utf8.gsub ( s , '(%a)̺', '\\textinvsubbridge{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - apical, "apical")} - \begin{luacode} - function laminal ( s ) - s = unicode.utf8.gsub ( s , '(%a)̻', '\\textsubsquare{%1}' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - laminal, "laminal")} - \begin{luacode} - function unaudible ( s ) - s = unicode.utf8.gsub ( s , '(%a)̚', '%1\\textcorner' ) - return s - end - \end{luacode} - \directlua{luatexbase.add_to_callback("process_input_buffer", - unaudible, "unaudible")} -%% Tie bars -\begin{luacode} - function tiebarup ( s ) - s = unicode.utf8.gsub ( s , '(%a)͡(%a)', '\\texttoptiebar{%1%2}' ) - return s - end -\end{luacode} -\directlua{luatexbase.add_to_callback("process_input_buffer", - tiebarup, "tiebarup")} -\begin{luacode} - function tiebardown ( s ) - s = unicode.utf8.gsub ( s , '(%a)͜(%a)', '\\textbottomtiebar{%1%2}' ) - return s - end -\end{luacode} -\directlua{luatexbase.add_to_callback("process_input_buffer", - tiebardown, "tiebardown")} -\begin{luacode} - function risefall ( s ) - s = unicode.utf8.gsub ( s , '(%a)᷈', '\\textrisefall{%1}' ) - return s - end -\end{luacode} -\directlua{luatexbase.add_to_callback("process_input_buffer", - risefall, "risefall")} -\begin{luacode} - function rising ( s ) - s = unicode.utf8.gsub ( s , '(%a)᷄', '\\texthighrise{%1}' ) - return s - end -\end{luacode} -\directlua{luatexbase.add_to_callback("process_input_buffer", - rising, "rising")} -\begin{luacode} - function falling ( s ) - s = unicode.utf8.gsub ( s , '(%a)᷅', '\\textlowrise{%1}' ) - return s - end -\end{luacode} -\directlua{luatexbase.add_to_callback("process_input_buffer", - falling, "falling")} -\fi -% \end{macrocode} -% Option \verb|nodiacritics| provided for using the package without -% Lua\LaTeX. Enabling this option won't print any diacritics. Help from -% Samcarter and Mico Loretan on different platforms\footnote{Samcarter's -% \href{https://topanswers.xyz/tex?q=1332\#a1577}{answer} on TopAnswer \& Mico -% Loretan's \href{https://tex.stackexchange.com/a/563447/174620}{answer} on -% TeX.SE.} gave a right direction to this code. -% \begin{macrocode} -%% Pulmonic Consonants -%% Plosives -\newunicodechar{ʈ}{\textrtailt} -\newunicodechar{ɖ}{\textrtaild} -\newunicodechar{ɟ}{\textbardotlessj} -\newunicodechar{ɢ}{\textscg} -\newunicodechar{ʔ}{\textglotstop} -%% Nasals -\newunicodechar{ɱ}{\textltailm} -\newunicodechar{ɳ}{\textrtailn} -\newunicodechar{ɲ}{\textltailn} %% Added in v0.2 -\newunicodechar{ɴ}{\textscn} -%% Trills -\newunicodechar{ʙ}{\textscb} -\newunicodechar{ʀ}{\textscr} -%% Taps or flaps -\newunicodechar{ⱱ}{\ipatext{ⱱ}} %% Sorry for the bad typography! -\newunicodechar{ɾ}{\textfishhookr} -\newunicodechar{ɽ}{\textrtailr} -%% Fricatives -\newunicodechar{ɸ}{\textphi} -\newunicodechar{β}{\textbeta} -\newunicodechar{θ}{\texttheta} -\newunicodechar{ʃ}{\textesh} -\newunicodechar{ʒ}{\textyogh} -\newunicodechar{ʂ}{\textrtails} -\newunicodechar{ʐ}{\textrtailz} -\newunicodechar{ʝ}{\textctj} -\newunicodechar{ɣ}{\textgamma} -\newunicodechar{χ}{\textchi} -\newunicodechar{ʁ}{\textinvscr} -\newunicodechar{ʕ}{\textrevglotstop} -\newunicodechar{ɦ}{\texthth} -%% Lateral fricatives -\newunicodechar{ɬ}{\textbeltl} -\newunicodechar{ɮ}{\textlyoghlig} -%% Approximants -\newunicodechar{ʋ}{\textscriptv} -\newunicodechar{ɹ}{\textturnr} -\newunicodechar{ɻ}{\textturnrrtail} -\newunicodechar{ɰ}{\textturnmrleg} -%% Lateral approximants -\newunicodechar{ɭ}{\textrtaill} -\newunicodechar{ʎ}{\textturny} -\newunicodechar{ʟ}{\textscl} -%% Affricates -\newunicodechar{ʧ}{\textteshlig} -\newunicodechar{ʤ}{\textdyoghlig} -\newunicodechar{ʦ}{\texttslig} -\newunicodechar{ʣ}{\textdzlig} -%% Vowels -%% Close -\newunicodechar{ɨ}{\textbari} -\newunicodechar{ʉ}{\textbaru} -\newunicodechar{ɯ}{\textturnm} -%% Near-close -\newunicodechar{ɪ}{\textsci} -\newunicodechar{ʏ}{\textscy} -\newunicodechar{ʊ}{\textupsilon} -%% Close-mid -\newunicodechar{ɵ}{\textbaro} -\newunicodechar{ɤ}{\textramshorns} -%% Open-mid -\newunicodechar{ɛ}{\textepsilon} -\newunicodechar{ɜ}{\textrevepsilon} -\newunicodechar{ɞ}{\reflectbox{\textcloseepsilon}} %% Latest changes -\newunicodechar{ʌ}{\textturnv} -\newunicodechar{ɔ}{\textopeno} -%% Near-open -\newunicodechar{ɐ}{\textturna} -\newunicodechar{ɶ}{\textscoelig} -\newunicodechar{ɒ}{\textturnscripta} -%% Open -%% Reported and added by Heller, Thomas on 2021/03/13 -%% Bug report - https://gitlab.com/niruvt/unitipa/-/issues/1 -%% MR - https://gitlab.com/niruvt/unitipa/-/merge_requests/1 -\newunicodechar{ɑ}{\textscripta} -%% Non-Pulmonic -\newunicodechar{ʘ}{\textbullseye} -\newunicodechar{ǀ}{\textpipe} -\newunicodechar{ǃ}{\textipa{!}} -\newunicodechar{ǂ}{\textdoublebarpipe} -\newunicodechar{ǁ}{\textdoublepipe} -%% Voiced Implosives -\newunicodechar{ɓ}{\texthtb} -\newunicodechar{ɗ}{\texthtd} -\newunicodechar{ʄ}{\texthtbardotlessj} -\newunicodechar{ɠ}{\texthtg} -\newunicodechar{ʛ}{\texthtscg} -\newunicodechar{ʼ}{'} -%% Suprasegmentals -\newunicodechar{ˈ}{\textprimstress} -\newunicodechar{ˌ}{\textsecstress} -\newunicodechar{ː}{\textlengthmark} -\newunicodechar{ˑ}{\texthalflength} -\newunicodechar{ʍ}{\textturnw} -\newunicodechar{ɥ}{\textturnh} -\newunicodechar{ʜ}{\textsch} -\newunicodechar{ʢ}{\textbarrevglotstop} -\newunicodechar{ʡ}{\textbarglotstop} -\newunicodechar{ɕ}{\textctc} -\newunicodechar{ʑ}{\textctz} -\newunicodechar{ɺ}{\textturnlonglegr} -\newunicodechar{ɧ}{\texththeng} -%% Diacritics -\newunicodechar{ʰ}{\textsuperscript{h}} -\newunicodechar{ʱ}{\textsuperscript{ɦ}} -\newunicodechar{ʷ}{\textsuperscript{w}} -\newunicodechar{ʲ}{\textsuperscript{j}} -\newunicodechar{ˠ}{\textsuperscript{ɣ}} -\newunicodechar{ˤ}{\textsuperscript{ʕ}} -%% Tones independent diacritics -\newunicodechar{ꜜ}{\textdownstep} -\newunicodechar{ꜛ}{\textupstep} -%% \newunicodechar{︎↗}{\textglobrise} %% Not working :'( -%% \newunicodechar{↘}{\textglobfall} %% Need help here -% \end{macrocode} -% \begin{macrocode} -% -% \end{macrocode} -% \end{implementation} -% \RecordChanges -% \changes{v0.1}{2020/09/21}{Initial version} -% \changes{v0.2}{2021/03/13}{Added characters `ɑ' and `ɲ'} -% \changes{v0.3}{2021/04/03}{Updated repository path} -% \PrintChanges -% \Finale \ No newline at end of file diff --git a/macros/luatex/latex/unitipa/unitipa.ins b/macros/luatex/latex/unitipa/unitipa.ins deleted file mode 100644 index cf7d5c8061..0000000000 --- a/macros/luatex/latex/unitipa/unitipa.ins +++ /dev/null @@ -1,47 +0,0 @@ -% File: unitipa.ins -\input l3docstrip.tex - -\keepsilent -\askforoverwritefalse - -\preamble - ---------------------------------------------------------------------------- -Package: unitipa -Author: Niranjan -Description: TIPA typefaces with Unicode characters. -Repository: https://gitlab.com/niruvt/unitipa -Bug tracker: https://gitlab.com/niruvt/unitipa/-/issues -License: The LaTeX Project Public License v1.3c or later. ---------------------------------------------------------------------------- -This work may be distributed and/or modified under the conditions of the -LaTeX Project Public License, either version 1.3c 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. - -This work has the LPPL maintenance status `maintained'. - -The Current Maintainer of this work is Niranjan. - -This work consists of the files unitipa.dtx - unitipa.ins -and the derived file unitipa.sty. ---------------------------------------------------------------------------- - -\endpreamble - -\usedir{tex/latex/\jobname} -\generate{ - \file{\jobname.sty}{\from{\jobname.dtx}{package}} -} - -\nopreamble\nopostamble -\usedir{doc/latex/\jobname} -\generate{ - \file{README.txt}{\from{\jobname.dtx}{readme}} -} - -\endbatchfile \ No newline at end of file diff --git a/macros/luatex/latex/unitipa/unitipa.pdf b/macros/luatex/latex/unitipa/unitipa.pdf deleted file mode 100644 index bc8a58090a..0000000000 Binary files a/macros/luatex/latex/unitipa/unitipa.pdf and /dev/null differ diff --git a/macros/unicodetex/latex/fontsetup/README b/macros/unicodetex/latex/fontsetup/README index d6b9fbda54..e2666d576f 100644 --- a/macros/unicodetex/latex/fontsetup/README +++ b/macros/unicodetex/latex/fontsetup/README @@ -1,5 +1,5 @@ The fontsetup package - (Version 1.02, GPL3) + (Version 1.03, GPL3) This simple package makes it trivial to switch quickly between different quality fonts supporting Mathematics. diff --git a/macros/unicodetex/latex/fontsetup/doc/fontsetup-doc.pdf b/macros/unicodetex/latex/fontsetup/doc/fontsetup-doc.pdf index 720e85cb92..bfc3fb5ec3 100644 Binary files a/macros/unicodetex/latex/fontsetup/doc/fontsetup-doc.pdf and b/macros/unicodetex/latex/fontsetup/doc/fontsetup-doc.pdf differ diff --git a/macros/unicodetex/latex/fontsetup/doc/fontsetup-doc.tex b/macros/unicodetex/latex/fontsetup/doc/fontsetup-doc.tex index 3618ae8d75..a473973606 100644 --- a/macros/unicodetex/latex/fontsetup/doc/fontsetup-doc.tex +++ b/macros/unicodetex/latex/fontsetup/doc/fontsetup-doc.tex @@ -1,6 +1,7 @@ \documentclass{book} \usepackage[default]{fontsetup} \usepackage{graphicx,fullpage,supertabular} +\AtBeginDocument{\def\varnothing{\char"2300}\def\emptyset{\char"2205}} \begin{document} @@ -9,8 +10,8 @@ \textit{by}\\[1ex] {\large Antonis Tsolomitis}\\ University of the Aegean\\ Department of Mathematics\\[1ex] - \textsc{3} May \textsc{2021}\\[1ex] - Version 1.02, \textsc{gpl3} + \textsc{19} Oct \textsc{2021}\\[1ex] + Version 1.03, \textsc{gpl3} \end{center} This package is a simple wrapper-type package that makes the setup of fonts easy and @@ -44,7 +45,9 @@ University of the Aegean\\ Department of Mathematics\\[1ex] which is an assembly of cm fonts plus more fonts to support Greek (cbgreek) and Cyrillic languages. It also provides \begin{itemize} - \item the option ``upint'' for switching to upright integrals in mathmode. + \item the option ``upint'' for switching to upright integrals in mathmode. + \item the option ``varnothing'' for changing the default symbol for + the empty set ($\emptyset$) to the \verb|\varnothing| symbol ($\varnothing$) in mathmode. \item commands to access prosgegrammeni instead of ypogegrammeni for capitals and small capitals, by writing \verb|\textprosgegrammeni{}| or \verb|{\prosgegrammeni }|. \item commands to access 4th and 6th century bce Greek by writing diff --git a/macros/unicodetex/latex/fontsetup/fontsetup.sty b/macros/unicodetex/latex/fontsetup/fontsetup.sty index 5a0bb2b50b..fd33a3ec47 100644 --- a/macros/unicodetex/latex/fontsetup/fontsetup.sty +++ b/macros/unicodetex/latex/fontsetup/fontsetup.sty @@ -47,6 +47,9 @@ \newif\if@upint \DeclareOption{upint}{\@upinttrue} % +\newif\if@varnothing +\DeclareOption{varnothing}{\@varnothingtrue} +% \ProcessOptions %provide a test to know if a 16bits TeX is used. @@ -68,9 +71,17 @@ \RequirePackage{fspdefault} % \if@upint -\setmathfont[StylisticSet=2]{NewCMMath-Book.otf} + \if@varnothing + \setmathfont[StylisticSet=2,CharacterVariant=1]{NewCMMath-Book.otf} + \else + \setmathfont[StylisticSet=2]{NewCMMath-Book.otf} + \fi \else -\setmathfont{NewCMMath-Book.otf} + \if@varnothing + \setmathfont[CharacterVariant=1]{NewCMMath-Book.otf} + \else + \setmathfont{NewCMMath-Book.otf} + \fi \fi % \or @@ -109,14 +120,20 @@ \or \RequirePackage{libertinus-otf} \or -\RequirePackage{fspolddefault} -% + \RequirePackage{fspolddefault} \if@upint -\setmathfont[StylisticSet=2]{NewCMMath-Regular.otf} + \if@varnothing + \setmathfont[StylisticSet=2,CharacterVariant=1]{NewCMMath-Book.otf} + \else + \setmathfont[StylisticSet=2]{NewCMMath-Regular.otf} + \fi \else -\setmathfont{NewCMMath-Regular.otf} + \if@varnothing + \setmathfont[CharacterVariant=1]{NewCMMath-Book.otf} + \else + \setmathfont{NewCMMath-Regular.otf} + \fi \fi -% \fi }{%the user runs 8bit engine \relax} diff --git a/macros/unicodetex/latex/fontsetup/fspdefault.sty b/macros/unicodetex/latex/fontsetup/fspdefault.sty index 686a045394..77148fe43a 100644 --- a/macros/unicodetex/latex/fontsetup/fspdefault.sty +++ b/macros/unicodetex/latex/fontsetup/fspdefault.sty @@ -74,6 +74,8 @@ BoldSlantedFeatures={FakeSlant=0.25}, SmallCapsFeatures={Numbers=OldStyle}]{NewCMMono10-Book.otf} \setmathfont{NewCMMath-Book.otf} +\DeclareOption{varnothing}{\setmathfont[CharacterVariant=1]{NewCMMath-Book.otf}} +\ProcessOptions \newcommand{\tttextsc}[1]{{\ttscshape#1}} % diff --git a/macros/unicodetex/latex/fontsetup/fspolddefault.sty b/macros/unicodetex/latex/fontsetup/fspolddefault.sty index 3660ec706e..ecea2a5026 100644 --- a/macros/unicodetex/latex/fontsetup/fspolddefault.sty +++ b/macros/unicodetex/latex/fontsetup/fspolddefault.sty @@ -64,6 +64,8 @@ BoldSlantedFeatures={FakeSlant=0.25}, SmallCapsFeatures={Numbers=OldStyle}]{NewCMMono10-Regular.otf} \setmathfont{NewCMMath-Regular.otf} +\DeclareOption{varnothing}{\setmathfont[CharacterVariant=1]{NewCMMath-Regular.otf}} +\ProcessOptions \newcommand{\tttextsc}[1]{{\ttscshape#1}} % -- cgit v1.2.3