summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib')
-rw-r--r--Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib8481
1 files changed, 6588 insertions, 1893 deletions
diff --git a/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib b/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib
index a9a463f98a0..ec94ffe5d5c 100644
--- a/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib
+++ b/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib
@@ -1,8 +1,52 @@
% Encoding: UTF-8
+% Custom entry types will need aliasing.
+%
+% @bibglscommand -> \bibgls... command provided by bib2gls
+% @glscommand -> command provided by glossaries.sty,
+% glossaries-extra.sty or supplemental glossary packages.
+% @mainglscommand -> glossary-related command with formal syntax described
+% in the main matter.
+% @abbrvstylecommand -> command used by abbreviation styles.
+% @glostylecommand -> command used by glossary styles.
+% @resourceoption -> \GlsXtrLoadResources option
+% @command -> command provided by kernel or other package
+% @examplecommand -> custom command defined in the examples
+% @fileformat -> file format
+% @application -> application
+% @package -> package
+% @specialchar -> special character
+% @environment -> environment
+% @glsenvironment -> environment provided by glossaries.sty
+% @abbreviationstyle -> abbreviation style
+% @glossarystyle -> glossary style
+% @categoryattribute -> category attribute
+% @counter -> counter
+% @labelprefix -> label prefix
+% @packageoption -> package option
+% @field -> field
+% @entrytype -> entry type
+% @switch -> command line switch
+% @xmltag -> tag in XML language resource file
+% @unicodecategory -> Unicode category
+% @texmfcnf -> texmf.cnf setting
+% @file -> file
+% @samplefile -> sample file
+% @printglossoption -> \printunsrtglossary option
+% @glslinkoption -> \glslink option
+% @glsaddoption -> \glsadd option
+% @exampleentry -> example entry
+% @examplesymbol -> example symbol
+% @exampleindex -> example term
+% @exampleabbreviation -> example abbreviation
+% @topic -> topic
+
@preamble{"\providecommand{\dhyphen}{-}
-\providecommand{\csfmt}[1]{\texttt{\glsbackslash #1}}%
-\providecommand{\derivfn}[1]{f'(#1)}"}
+\providecommand{\csfmt}[1]{\texttt{\glsbackslash #1}}
+\providecommand{\derivfn}[1]{f'(#1)}
+\providecommand{\rangestartmark}{\symbol{40}}
+\providecommand{\rangeendmark}{\symbol{41}}
+\providecommand{\abbrvword}[1]{\textup{#1}}"}
@abbreviation{IETF,
short = {IETF},
@@ -30,7 +74,7 @@
}
@abbreviation{SIunit,
- short = {SI unit},
+ short = {SI \abbrvword{unit}},
long = {International System of Units},
longplural = {International System of Units},
category={common}
@@ -53,236 +97,637 @@
long = {encapsulating command}
}
-@dualindexentry{bibglsnewentry,
+@abbreviation{toc,
+ short = {TOC},
+ long = {table of contents}
+}
+
+@topic{definingterms,
+ name={defining terms}
+}
+
+@topic{formattingcommands,
+ name={formatting commands},
+ text={formatting command}
+}
+
+@topic{abbreviationcommands,
+ name={abbreviation commands (general)},
+ text={abbreviation command},
+ seealso={abbreviationstyles}
+}
+
+@topic{glossarystylecommands,
+ name={glossary style commands (general)},
+ text={glossary style command},
+ seealso={glossarystyle}
+}
+
+@topic{separatorcommands,
+ name={separator commands}
+}
+
+@topic{crossrefcommands,
+ name={cross-referencing commands}
+}
+
+@topic{loclistcommands,
+ name={location list commands (records)}
+}
+
+@topic{fixedtextcommands,
+ name={fixed text commands}
+}
+
+@topic{fieldrefcommands,
+ name={field reference commands}
+}
+
+@topic{entryrefcommands,
+ name={entry reference commands}
+}
+
+@topic{glossrefs,
+ name={glossary lists (\fieldfmt{type})}
+}
+
+@topic{standalonestyles,
+ name={standalone styles}
+}
+
+@topic{providingcommands,
+ name={defining or redefining commands}
+}
+
+@topic{linkcommands,
+ name={hyperlink-capable commands or targets}
+}
+
+@topic{supplementalrefs,
+ name={supplemental document references}
+}
+
+@topic{assigncommands,
+ name={assignment commands},
+ text={assignment command}
+}
+
+@topic{groupcommands,
+ name={glossary group commands}
+}
+
+@topic{charcommands,
+ name={character or symbol commands}
+}
+
+@topic{casecommands,
+ name={case-changing commands},
+ text={case-changing command}
+}
+
+@topic{internalcommands,
+ name={internal commands}
+}
+
+@topic{auxcommands,
+ name={auxiliary file commands},
+ text={auxiliary file command}
+}
+
+@topic{capheadcommands,
+ name={caption or heading commands},
+ text={caption or heading command}
+}
+
+@topic{listcommands,
+ name={list commands (internal or comma-separated)},
+ text={list command}
+}
+
+@topic{collationsubrules,
+ name={collation sub-rules}
+}
+
+@topic{catattrcommands,
+ name={categories and attributes}
+}
+
+@topic{regex,
+ name={regular expressions},
+ text={regular expression},
+}
+
+@topic{access-support,
+ name={accessibility support}
+}
+
+@topic{conditionals,
+ name={conditionals and boolean values},
+ text={conditional},
+ plural={conditionals}
+}
+@indexplural{booleanvals,
+ text={boolean value},
+ alias={conditionals}
+}
+
+@topic{debugging,
+ name={debugging commands},
+ text={debugging command}
+}
+
+@topic{shortcutcommands,
+ name={shortcut commands},
+ text={shortcut command}
+}
+
+@topic{hooks,name={hooks},text={hook}}
+@topic{loops,name={loops},text={loop}}
+@index{iteration,see={loops}}
+@indexplural{handler,seealso={loops}}
+@topic{indexing}
+
+@bibglscommand{bibglsnewentry,
name={\csfmt{bib\-gls\-new\-entry}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines terms provided with \atentry{entry}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewsymbol,
+@bibglscommand{bibglsnewsymbol,
name={\csfmt{bib\-gls\-new\-symbol}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines terms provided with \atentry{symbol}},
+ topics={definingterms},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsnewnumber,
+@bibglscommand{bibglsnewnumber,
name={\csfmt{bib\-gls\-new\-number}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines terms provided with \atentry{number}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewindex,
+@bibglscommand{bibglsnewindex,
name={\csfmt{bib\-gls\-new\-index}},
user1={\margm{label}\margm{options}},
description={defines terms provided with \atentry{index}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewindexplural,
+@bibglscommand{bibglsnewindexplural,
name={\csfmt{bib\-gls\-new\-index\-plural}},
user1={\margm{label}\margm{options}\margm{name}},
description={defines terms provided with \atentry{index}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewabbreviation,
+@bibglscommand{bibglsnewabbreviation,
name={\csfmt{bib\-gls\-new\-abbreviation}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}},
description={defines terms provided with \atentry{abbreviation}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewacronym,
+@bibglscommand{bibglsnewacronym,
name={\csfmt{bib\-gls\-new\-acronym}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}},
description={defines terms provided with \atentry{acronym}},
+ topics={definingterms},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsnewdualentry,
+@bibglscommand{bibglsnewdualentry,
name={\csfmt{bib\-gls\-new\-dual\-entry}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines terms provided with \atentry{dualentry}},
+ topics={definingterms},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsnewdualindexentry,
+@bibglscommand{bibglsnewdualindexentry,
name={\csfmt{bib\-gls\-new\-dual\-index\-entry}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines primary terms provided with
\atentry{dualindexentry}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualindexentrysecondary,
+@bibglscommand{bibglsnewdualindexentrysecondary,
name={\csfmt{bib\-gls\-new\-dual\-index\-entry\-secondary}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines secondary terms provided with
\atentry{dualindexentry}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualindexsymbol,
+@bibglscommand{bibglsnewdualindexsymbol,
name={\csfmt{bib\-gls\-new\-dual\-index\-symbol}},
user1={\margm{label}\margm{options}\margm{name}\margm{symbol}\margm{description}},
description={defines primary terms provided with
\atentry{dualindexsymbol}},
+ topics={definingterms},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsnewdualindexsymbolsecondary,
+@bibglscommand{bibglsnewdualindexsymbolsecondary,
name={\csfmt{bib\-gls\-new\-dual\-index\-symbol\-secondary}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines secondary terms provided with
\atentry{dualindexsymbol}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualindexnumber,
+@bibglscommand{bibglsnewdualindexnumber,
name={\csfmt{bib\-gls\-new\-dual\-index\-number}},
user1={\margm{label}\margm{options}\margm{name}\margm{symbol}\margm{description}},
description={defines primary terms provided with
\atentry{dualindexnumber}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualindexnumbersecondary,
+@bibglscommand{bibglsnewdualindexnumbersecondary,
name={\csfmt{bib\-gls\-new\-dual\-index\-number\-secondary}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines secondary terms provided with
\atentry{dualindexnumber}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualindexabbreviation,
+@bibglscommand{bibglsnewdualindexabbreviation,
name={\csfmt{bib\-gls\-new\-dual\-index\-abbre\-via\-tion}},
user1={\margm{label}\margm{dual-label}\margm{options}\margm{name}\margm{short}\margm{long}\margm{description}},
description={defines primary terms provided with
\atentry{dualindexabbreviation}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualindexabbreviationsecondary,
+@bibglscommand{bibglsnewdualindexabbreviationsecondary,
name={\csfmt{bib\-gls\-new\-dual\-index\-abbre\-via\-tion\-sec\-ond\-ary}},
user1={\margm{label}\margm{options}\margm{name}\margm{short}\margm{long}\margm{description}},
description={defines secondary terms provided with
\atentry{dualindexabbreviation}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualabbreviationentry,
+@bibglscommand{bibglsnewdualabbreviationentry,
name={\csfmt{bib\-gls\-new\-dual\-abbre\-via\-tion\-entry}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}\margm{description}},
description={defines primary terms provided with
\atentry{dualabbreviationentry}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualabbreviationentrysecondary,
+@bibglscommand{bibglsnewdualabbreviationentrysecondary,
name={\csfmt{bib\-gls\-new\-dual\-abbre\-via\-tion\-entry\-sec\-ond\-ary}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}\margm{description}},
description={defines secondary terms provided with
\atentry{dualabbreviationentry}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualentryabbreviation,
+@bibglscommand{bibglsnewdualentryabbreviation,
name={\csfmt{bib\-gls\-new\-dual\-entry\-abbre\-via\-tion}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}\margm{description}},
description={defines primary terms provided with (deprecated)
\atentry{dualentryabbreviation}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualentryabbreviationsecondary,
+@bibglscommand{bibglsnewdualentryabbreviationsecondary,
name={\csfmt{bib\-gls\-new\-dual\-entry\-abbre\-via\-tion\-sec\-ond\-ary}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}\margm{description}},
description={defines secondary terms provided with (deprecated)
\atentry{dualentryabbreviation}},
+ topics={definingterms},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsnewdualsymbol,
+@bibglscommand{bibglsnewdualsymbol,
name={\csfmt{bib\-gls\-new\-dual\-symbol}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines terms provided with \atentry{dualsymbol}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualnumber,
+@bibglscommand{bibglsnewdualnumber,
name={\csfmt{bib\-gls\-new\-dual\-number}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines terms provided with \atentry{dualnumber}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewdualabbreviation,
+@bibglscommand{bibglsnewdualabbreviation,
name={\csfmt{bib\-gls\-new\-dual\-abbre\-via\-tion}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}},
description={defines terms provided with
\atentry{dualabbreviation}},
+ topics={definingterms},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsnewdualacronym,
+@bibglscommand{bibglsnewdualacronym,
name={\csfmt{bib\-gls\-new\-dual\-acronym}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}},
description={defines terms provided with \atentry{dualacronym}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewtertiaryindexabbreviationentry,
+@bibglscommand{bibglsnewtertiaryindexabbreviationentry,
name={\csfmt{bib\-gls\-new\-tert\-iary\-index\-abbre\-via\-tion\-entry}},
user1={\margm{label}\margm{dual-label}\margm{options}\margm{name}\margm{short}\margm{long}\margm{description}},
description={defines primary terms provided with
\atentry{tertiaryindexabbreviationentry}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewtertiaryindexabbreviationentrysecondary,
+@bibglscommand{bibglsnewtertiaryindexabbreviationentrysecondary,
name={\csfmt{bib\-gls\-new\-tert\-iary\-index\-abbre\-via\-tion\-entry\-sec\-ond\-ary}},
user1={\margm{label}\margm{tertiary-label}\margm{options}\margm{tertiary-opts}\margm{primary-name}\margm{short}\margm{long}\margm{description}},
description={defines secondary and tertiary terms provided with
\atentry{tertiaryindexabbreviationentry}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewbibtexentry,
+@bibglscommand{bibglsnewbibtexentry,
name={\csfmt{bib\-gls\-new\-bib\-tex\-entry}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines terms provided with \atentry{bibtexentry}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsnewcontributor,
+@bibglscommand{bibglsnewcontributor,
name={\csfmt{bib\-gls\-new\-con\-trib\-u\-tor}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines terms provided with
\atentry{contributor}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewprogenitor,
+ name={\csfmt{bib\-gls\-new\-progenitor}},
+ user1={\margm{label}\margm{options}\margm{name}\margm{description}},
+ description={defines terms provided with \atentry{progenitor}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnindex,
+ name={\csfmt{bib\-gls\-new\-spawn\-index}},
+ user1={\margm{label}\margm{options}\margm{name}\margm{description}},
+ description={defines terms provided with \atentry{spawnindex}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawndualindexentry,
+ name={\csfmt{bib\-gls\-new\-spawn\-dual\-index\-entry}},
+ user1={\margm{label}\margm{options}\margm{name}\margm{description}},
+ description={defines terms provided with \atentry{spawndualindexentry}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawndualindexentrysecondary,
+ name={\csfmt{bib\-gls\-new\-spawn\-dual\-index\-entry\-secondary}},
+ user1={\margm{label}\margm{options}\margm{name}\margm{description}},
+ description={defines secondary terms provided with \atentry{spawndualindexentry}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnedindex,
+ name={\csfmt{bib\-gls\-new\-spawned\-index}},
+ user1={\margm{label}\margm{options}},
+ description={defines terms spawned from \atentry{progenitor}
+ or \atentry{spawnindex}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnindexplural,
+ name={\csfmt{bib\-gls\-new\-spawn\-index\-plural}},
+ user1={\margm{label}\margm{options}\margm{name}\margm{description}},
+ description={defines terms provided with \atentry{spawnindexplural}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnedindexplural,
+ name={\csfmt{bib\-gls\-new\-spawned\-index\-plural}},
+ user1={\margm{label}\margm{options}\margm{name}},
+ description={defines terms spawned from \atentry{spawnindexplural}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnentry,
+ name={\csfmt{bib\-gls\-new\-spawn\-entry}},
+ user1={\margm{label}\margm{options}\margm{name}\margm{description}},
+ description={defines terms provided with \atentry{spawnentry}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnedentry,
+ name={\csfmt{bib\-gls\-new\-spawned\-entry}},
+ user1={\margm{label}\margm{options}},
+ description={defines terms spawned from \atentry{spawnentry}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnabbreviation,
+ name={\csfmt{bib\-gls\-new\-spawn\-abbreviation}},
+ user1={\margm{label}\margm{options}\margm{short}\margm{long}},
+ description={defines terms provided with \atentry{spawnabbreviation}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnedabbreviation,
+ name={\csfmt{bib\-gls\-new\-spawned\-abbreviation}},
+ user1={\margm{label}\margm{options}\margm{short}\margm{long}},
+ description={defines terms spawned from \atentry{spawnabbreviation}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnacronym,
+ name={\csfmt{bib\-gls\-new\-spawn\-acronym}},
+ user1={\margm{label}\margm{options}\margm{short}\margm{long}},
+ description={defines terms provided with \atentry{spawnacronym}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnedacronym,
+ name={\csfmt{bib\-gls\-new\-spawned\-acronym}},
+ user1={\margm{label}\margm{options}\margm{short}\margm{long}},
+ description={defines terms spawned from \atentry{spawnacronym}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnsymbol,
+ name={\csfmt{bib\-gls\-new\-spawn\-symbol}},
+ user1={\margm{label}\margm{options}\margm{name}\margm{description}},
+ description={defines terms provided with \atentry{spawnsymbol}},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@dualindexentry{bibglsuselongfont,
+@bibglscommand{bibglsnewspawnedsymbol,
+ name={\csfmt{bib\-gls\-new\-spawned\-symbol}},
+ user1={\margm{label}\margm{options}\margm{name}\margm{description}},
+ description={defines terms spawned from \atentry{spawnsymbol}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnnumber,
+ name={\csfmt{bib\-gls\-new\-spawn\-number}},
+ user1={\margm{label}\margm{options}\margm{name}\margm{description}},
+ description={defines terms provided with \atentry{spawnnumber}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsnewspawnednumber,
+ name={\csfmt{bib\-gls\-new\-spawned\-number}},
+ user1={\margm{label}\margm{options}\margm{name}\margm{description}},
+ description={defines terms spawned from \atentry{spawnnumber}},
+ note={\bibgls},
+ topics={definingterms},
+ category={command}
+}
+
+@bibglscommand{bibglsuselongfont,
name={\csfmt{bib\-gls\-use\-long\-font}},
user1={\margm{text}\margm{category}},
description={ensures that the given text is formatted according to
the given category's long format},
+ note={\bibgls},
+ topics={definingterms},
category={command}
}
-@index{glsuselongfont,
+@glscommand{glsuselongfont,
name={\csfmt{gls\-use\-long\-font}},
user1={\margm{text}\margm{category}},
description={applies the formatting command used for the long
form for the abbreviation style associated with the given category},
note={\styfmt{glossaries-extra} v1.21+},
+ topics={formattingcommands,abbreviationcommands},
+ category={command}
+}
+
+@glscommand{ifglsxtrinsertinside,
+ name={\csfmt{if\-gls\-xtr\-insert\-inside}},
+ description={switch that determines whether or not inserted text
+ (provided in the final optional argument of commands like \cs{gls})
+ is inside or outside of the font changing commands in the predefined
+ abbreviation styles. The default is \optfmt{false}},
+ topics={abbreviationcommands,conditionals},
+ note={\styfmt{glossaries-extra} v1.02+},
category={command}
}
-@index{GlsXtrAutoAddOnFormat,
+@glscommand{glsxtrinsertinsidefalse,
+ name={\csfmt{gls\-xtr\-insert\-inside\-false}},
+ description={sets the \cs{ifglsxtrinsertinside} switch to \optfmt{false}},
+ topics={abbreviationcommands,conditionals},
+ note={\styfmt{glossaries-extra} v1.02+},
+ category={command}
+}
+
+@glscommand{glsxtrinsertinsidetrue,
+ name={\csfmt{gls\-xtr\-insert\-inside\-true}},
+ description={sets the \cs{ifglsxtrinsertinside} switch to \optfmt{true}},
+ topics={abbreviationcommands,conditionals},
+ note={\styfmt{glossaries-extra} v1.02+},
+ category={command}
+}
+
+@glscommand{glsxtrfullsep,
+ name={\csfmt{gls\-xtr\-full\-sep}},
+ user1={\margm{label}},
+ description={the separator used in the full format for the
+ parenthetical abbreviation styles or for inline parenthetical
+ styles. This just does a space by default},
+ topics={formattingcommands,abbreviationcommands},
+ note={\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@glscommand{GlsXtrAutoAddOnFormat,
name={\csfmt{GlsXtrAutoAddOnFormat}},
user1={\oargm{label}\margm{format list}\margm{glsadd options}},
description={makes commands like \cs{gls} and \cs{glslink}
@@ -292,453 +737,584 @@
comma-separated elements of \meta{format list}. The format isn't automatically
applied to the \cs{glsadd} options},
note={\styfmt{glossaries-extra} v1.37+},
+ topics={hooks,indexing},
category={command}
}
-@dualindexentry{bibglsuseabbrvfont,
+@bibglscommand{bibglsuseabbrvfont,
name={\csfmt{bib\-gls\-use\-abbrv\-font}},
user1={\margm{text}\margm{category}},
description={ensures that the given text is formatted according to
the given category's short format},
+ note={\bibgls},
+ topics={formattingcommands,abbreviationcommands},
category={command}
}
-@index{glsuseabbrvfont,
+@glscommand{glsuseabbrvfont,
name={\csfmt{gls\-use\-abbrv\-font}},
user1={\margm{text}\margm{category}},
description={applies the formatting command used for the short
form for the abbreviation style associated with the given category},
note={\styfmt{glossaries-extra} v1.21+},
+ topics={formattingcommands,abbreviationcommands},
category={command}
}
-@dualindexentry{bibglsseesep,
+@bibglscommand{bibglsseesep,
name={\csfmt{bib\-gls\-see\-sep}},
user1={},
description={separator between \field{see}
cross-references and location list},
+ note={\bibgls},
+ topics={glossarystylecommands,separatorcommands,crossrefcommands,loclistcommands},
category={command}
}
-@dualindexentry{bibglsaliassep,
+@bibglscommand{bibglsaliassep,
name={\csfmt{bib\-gls\-alias\-sep}},
user1={},
description={separator between \field{alias}
cross-reference and location list},
+ note={\bibgls},
+ topics={glossarystylecommands,separatorcommands,crossrefcommands,loclistcommands},
category={command}
}
-@dualindexentry{bibglsseealsosep,
+
+@bibglscommand{bibglsseealsosep,
name={\csfmt{bib\-gls\-see\-also\-sep}},
user1={},
description={separator between \field{seealso}
cross-references and location list},
+ note={\bibgls},
+ topics={glossarystylecommands,separatorcommands,crossrefcommands,loclistcommands},
category={command}
}
-@dualindexentry{bibglspassim,
+@bibglscommand{bibglscompact,
+ name={\csfmt{bib\-gls\-compact}},
+ user1={\margm{pattern}\margm{part1}\margm{part2}},
+ description={compaction used on the end range location},
+ note={\bibgls},
+ topics={glossarystylecommands,loclistcommands},
+ category={command}
+}
+
+@bibglscommand{bibglspassim,
name={\csfmt{bib\-gls\-passim}},
user1={},
description={passim range suffix},
+ note={\bibgls},
+ topics={glossarystylecommands,loclistcommands},
category={command}
}
-@dualindexentry{bibglspassimname,
+@bibglscommand{bibglspassimname,
name={\csfmt{bib\-gls\-passim\-name}},
user1={},
description={name used by passim range suffix},
+ note={\bibgls},
+ topics={glossarystylecommands,loclistcommands,fixedtextcommands},
category={command}
}
-@dualindexentry{bibglsusesee,
+@bibglscommand{bibglsusesee,
name={\csfmt{bib\-gls\-use\-see}},
user1={\margm{label}},
- description={display cross-reference list for given entry},
+ description={display \field{see} cross-reference list for given entry},
+ note={\bibgls},
+ topics={glossarystylecommands,crossrefcommands,loclistcommands,fieldrefcommands},
category={command}
}
-@dualindexentry{bibglsusealias,
+@bibglscommand{bibglsusealias,
name={\csfmt{bib\-gls\-use\-alias}},
user1={\margm{label}},
- description={display cross-reference list for given entry},
+ description={display the \field{alias} cross-reference for given entry},
+ topics={glossarystylecommands,crossrefcommands,loclistcommands,fieldrefcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsuseseealso,
+
+@bibglscommand{bibglsuseseealso,
name={\csfmt{bib\-gls\-use\-see\-also}},
user1={\margm{label}},
- description={display cross-reference list for given entry},
+ description={display the \field{seealso} cross-reference list for given entry},
+ topics={glossarystylecommands,crossrefcommands,loclistcommands,fieldrefcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsdelimN,
+@bibglscommand{bibglsdelimN,
name={\csfmt{bib\-gls\-delimN}},
user1={},
- description={delimit individual locations (except last)},
+ description={separator for individual locations (except last)},
seealso={bibglslastDelimN},
+ note={\bibgls},
+ topics={glossarystylecommands,loclistcommands,separatorcommands},
category={command}
}
-@dualindexentry{bibglslastDelimN,
+@bibglscommand{bibglslastDelimN,
name={\csfmt{bib\-gls\-last\-DelimN}},
user1={},
- description={delimit last location},
+ description={separator before the last location (where there is
+ more than one location)},
seealso={bibglsdelimN},
+ topics={glossarystylecommands,loclistcommands,separatorcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsrange,
+@bibglscommand{bibglsrange,
name={\csfmt{bib\-gls\-range}},
user1={\marg{\meta{start}\cs{delimR} \meta{end}}},
description={Explicit range format},
+ note={\bibgls},
+ topics={glossarystylecommands,loclistcommands},
category={command}
}
-@dualindexentry{bibglsinterloper,
+@bibglscommand{bibglsinterloper,
name={\csfmt{bib\-gls\-inter\-loper}},
user1={\margm{location}},
description={interloper location format},
+ note={\bibgls},
+ topics={glossarystylecommands,loclistcommands},
category={command}
}
-@dualindexentry{bibglspostlocprefix,
+@bibglscommand{bibglspostlocprefix,
name={\csfmt{bib\-gls\-post\-loc\-prefix}},
user1={},
description={location list post prefix},
+ note={\bibgls},
+ topics={glossarystylecommands,loclistcommands},
category={command}
}
-@dualindexentry{bibglslocprefix,
+@bibglscommand{bibglslocprefix,
name={\csfmt{bib\-gls\-loc\-prefix}},
user1={\margm{n}},
description={location list prefix},
+ topics={glossarystylecommands,loclistcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsprimary,
+@bibglscommand{bibglsprimary,
name={\csfmt{bib\-gls\-primary}},
user1={\margm{n}\margm{locations}},
description={location list encapsulator used in the
\field{primarylocations} field},
+ topics={loclistcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglspagename,
+@bibglscommand{bibglspagename,
name={\csfmt{bib\-gls\-page\-name}},
user1={},
description={name used for single page},
+ topics={glossarystylecommands,loclistcommands,fixedtextcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglspagesname,
+@bibglscommand{bibglspagesname,
name={\csfmt{bib\-gls\-pages\-name}},
user1={},
description={name used for multiple pages},
+ topics={glossarystylecommands,loclistcommands,fixedtextcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglslocsuffix,
+@bibglscommand{bibglslocsuffix,
name={\csfmt{bib\-gls\-loc\-suffix}},
user1={\margm{n}},
description={location list suffix},
+ topics={glossarystylecommands,loclistcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglshyperlink,
+@bibglscommand{bibglshyperlink,
name={\csfmt{bib\-gls\-hyper\-link}},
user1={\margm{text}\margm{label}},
description={displays \meta{text} with a hyperlink to the entry
given by \meta{label}, if supported},
+ topics={linkcommands,fieldrefcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglslocationgroup,
+@bibglscommand{bibglslocationgroup,
name={\csfmt{bib\-gls\-location\-group}},
user1={\margm{n}\margm{counter}\margm{list}},
description={location group encapsulator},
+ topics={glossarystylecommands,loclistcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglslocationgroupsep,
+@bibglscommand{bibglslocationgroupsep,
name={\csfmt{bib\-gls\-location\-group\-sep}},
user1={},
description={location group separator},
+ topics={glossarystylecommands,loclistcommands,separatorcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssupplemental,
+@bibglscommand{bibglssupplemental,
name={\csfmt{bib\-gls\-supple\-mental}},
user1={\margm{n}\margm{list}},
description={supplemental list encapsulator},
+ note={\bibgls},
+ topics={glossarystylecommands,loclistcommands,supplementalrefs},
category={command}
}
-@dualindexentry{bibglssupplementalsep,
+@bibglscommand{bibglssupplementalsep,
name={\csfmt{bib\-gls\-supple\-mental\-sep}},
user1={},
description={separator between main and supplementary locations},
+ topics={glossarystylecommands,loclistcommands,supplementalrefs,separatorcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssupplementalsublist,
+@bibglscommand{bibglssupplementalsublist,
name={\csfmt{bib\-gls\-supple\-mental\-sub\-list}},
user1={\margm{n}\margm{external document}\margm{list}},
description={supplemental sub-list encapsulator},
+ topics={glossarystylecommands,loclistcommands,supplementalrefs},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssupplementalsubsep,
+@bibglscommand{bibglssupplementalsubsep,
name={\csfmt{bib\-gls\-supple\-mental\-sub\-sep}},
user1={},
description={separator between supplementary sub-lists},
+ topics={glossarystylecommands,loclistcommands,supplementalrefs,separatorcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{glsgroupheading,
+@mainglscommand{glsgroupheading,
name={\csfmt{gls\-group\-heading}},
user1={\margm{label}},
description={formats the heading for the group identified by the
given label},
+ topics={glossarystylecommands,formattingcommands},
note={\styfmt{glossaries}},
category={command}
}
-@dualindexentry{bibglssetlastgrouptitle,
+@bibglscommand{bibglssetlastgrouptitle,
name={\csfmt{bib\-gls\-set\-last\-group\-title}},
user1={\margm{cs}\margm{specs}},
description={sets the last group title},
+ topics={glossarystylecommands,assigncommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetlettergrouptitle,
+@bibglscommand{bibglssetlettergrouptitle,
name={\csfmt{bib\-gls\-set\-letter\-group\-title}},
user1={\marg{\margm{title}\margm{letter}\margm{id}\margm{type}}},
description={sets the letter group title},
+ topics={glossarystylecommands,assigncommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{glsxtrsetgrouptitle,
+@mainglscommand{glsxtrsetgrouptitle,
name={\csfmt{gls\-xtr\-set\-group\-title}},
user1={\margm{group label}\margm{group title}},
description={globally sets the title for the group identified by the given label},
+ topics={glossarystylecommands,assigncommands,groupcommands},
note={\styfmt{glossaries-extra} v1.14+},
category={command}
}
-@dualindexentry{glsxtrlocalsetgrouptitle,
+@glscommand{glsxtrlocalsetgrouptitle,
name={\csfmt{gls\-xtr\-local\-set\-group\-title}},
user1={\margm{group label}\margm{group title}},
description={locally sets the title for the group identified by the given label},
+ topics={glossarystylecommands,assigncommands,groupcommands},
note={\styfmt{glossaries-extra} v1.24+},
category={command}
}
-@dualindexentry{bibglslettergroup,
+@bibglscommand{bibglslettergroup,
name={\csfmt{bib\-gls\-letter\-group}},
user1={\margm{title}\margm{letter}\margm{id}\margm{type}},
description={expands to the letter group label},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglslettergrouptitle,
+@bibglscommand{bibglslettergrouptitle,
name={\csfmt{bib\-gls\-letter\-group\-title}},
user1={\margm{title}\margm{letter}\margm{id}\margm{type}},
description={expands to the letter group title},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetothergrouptitle,
+@bibglscommand{bibglssetothergrouptitle,
name={\csfmt{bib\-gls\-set\-other\-group\-title}},
user1={\marg{\margm{character}\margm{id}\margm{type}}},
description={sets the non-letter group title},
+ topics={glossarystylecommands,assigncommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsothergroup,
+@bibglscommand{bibglsothergroup,
name={\csfmt{bib\-gls\-other\-group}},
user1={\margm{character}\margm{id}\margm{type}},
description={expands to the non-letter group label},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsothergrouptitle,
+@bibglscommand{bibglsothergrouptitle,
name={\csfmt{bib\-gls\-other\-group\-title}},
user1={\margm{character}\margm{id}\margm{type}},
description={expands to the non-letter group title},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetemptygrouptitle,
+@bibglscommand{bibglssetemptygrouptitle,
name={\csfmt{bib\-gls\-set\-empty\-group\-title}},
user1={\marg{\margm{type}}},
description={sets the empty group title},
+ topics={glossarystylecommands,assigncommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsemptygroup,
+@bibglscommand{bibglsemptygroup,
name={\csfmt{bib\-gls\-empty\-group}},
user1={\margm{type}},
description={expands to the empty group label},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsemptygrouptitle,
+@bibglscommand{bibglsemptygrouptitle,
name={\csfmt{bib\-gls\-empty\-group\-title}},
user1={\margm{type}},
description={expands to the empty group title},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetunicodegrouptitle,
+@bibglscommand{bibglssetunicodegrouptitle,
name={\csfmt{bib\-gls\-set\-unicode\-group\-title}},
user1={\marg{\margm{label}\margm{character}\margm{id}\margm{type}}},
description={sets the Unicode script, category or character code
title},
+ topics={glossarystylecommands,assigncommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsunicodegroup,
+@bibglscommand{bibglsunicodegroup,
name={\csfmt{bib\-gls\-unicode\-group}},
user1={\margm{label}\margm{character}\margm{id}\margm{type}},
description={expands to the Unicode script or category label or
character code},
+ note={\bibgls},
+ topics={glossarystylecommands,groupcommands},
category={command}
}
-@dualindexentry{bibglsunicodegrouptitle,
+@bibglscommand{bibglsunicodegrouptitle,
name={\csfmt{bib\-gls\-unicode\-group\-title}},
user1={\margm{label}\margm{character}\margm{id}\margm{type}},
description={expands to the Unicode script or category label or
character code},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetnumbergrouptitle,
+@bibglscommand{bibglssetnumbergrouptitle,
name={\csfmt{bib\-gls\-set\-number\-group\-title}},
user1={\marg{\margm{value}\margm{id}\margm{type}}},
description={sets the number group title},
+ topics={glossarystylecommands,assigncommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsnumbergroup,
+@bibglscommand{bibglsnumbergroup,
name={\csfmt{bib\-gls\-number\-group}},
user1={\margm{value}\margm{id}\margm{type}},
description={expands to the number group label},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsnumbergrouptitle,
+@bibglscommand{bibglsnumbergrouptitle,
name={\csfmt{bib\-gls\-number\-group\-title}},
user1={\margm{value}\margm{id}\margm{type}},
description={expands to the number group title},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetdatetimegrouptitle,
+@bibglscommand{bibglssetdatetimegrouptitle,
name={\csfmt{bib\-gls\-set\-date\-time\-group\-title}},
user1={\marg{\margm{YYYY}\margm{MM}\margm{DD}\margm{hh}\margm{mm}\margm{ss}\margm{zone}\margm{title}\margm{group\dhyphen id}\margm{type}}},
description={sets the date-time group title},
+ topics={glossarystylecommands,assigncommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsdatetimegroup,
+@bibglscommand{bibglsdatetimegroup,
name={\csfmt{bib\-gls\-date\-time\-group}},
user1={\margm{YYYY}\margm{MM}\margm{DD}\margm{hh}\margm{mm}\margm{ss}\margm{zone}\margm{title}\margm{group\dhyphen id}\margm{type}},
description={expands to the date-time group label},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsdatetimegrouptitle,
+@bibglscommand{bibglsdatetimegrouptitle,
name={\csfmt{bib\-gls\-date\-time\-group\-title}},
user1={\margm{YYYY}\margm{MM}\margm{DD}\margm{hh}\margm{mm}\margm{ss}\margm{zone}\margm{title}\margm{group\dhyphen id}\margm{type}},
description={expands to the date-time group title},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetdategrouptitle,
+@bibglscommand{bibglssetdategrouptitle,
name={\csfmt{bib\-gls\-set\-date\-group\-title}},
user1={\marg{\margm{YYYY}\margm{MM}\margm{DD}\margm{G}\margm{title}\margm{group\dhyphen id}\margm{type}}},
description={sets the date (no time) group title},
+ topics={glossarystylecommands,assigncommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsdategroup,
+@bibglscommand{bibglsdategroup,
name={\csfmt{bib\-gls\-date\-group}},
user1={\margm{YYYY}\margm{MM}\margm{DD}\margm{G}\margm{title}\margm{group\dhyphen id}\margm{type}},
description={expands to the date group label},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsdategrouptitle,
+@bibglscommand{bibglsdategrouptitle,
name={\csfmt{bib\-gls\-date\-group\-title}},
user1={\margm{YYYY}\margm{MM}\margm{DD}\margm{G}\margm{title}\margm{group\dhyphen id}\margm{type}},
description={expands to the date group title},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssettimegrouptitle,
+@bibglscommand{bibglssettimegrouptitle,
name={\csfmt{bib\-gls\-set\-time\-group\-title}},
user1={\marg{\margm{hh}\margm{mm}\margm{ss}\margm{zone}\margm{title}\margm{group\dhyphen id}\margm{type}}},
description={sets the time (no date) group title},
+ topics={glossarystylecommands,assigncommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglstimegroup,
+@bibglscommand{bibglstimegroup,
name={\csfmt{bib\-gls\-time\-group}},
user1={\margm{hh}\margm{mm}\margm{ss}\margm{zone}\margm{title}\margm{group\dhyphen id}\margm{type}},
description={expands to the time group label},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglstimegrouptitle,
+@bibglscommand{bibglstimegrouptitle,
name={\csfmt{bib\-gls\-time\-group\-title}},
user1={\margm{hh}\margm{mm}\margm{ss}\margm{zone}\margm{title}\margm{group\dhyphen id}\margm{type}},
description={expands to the time group title},
+ topics={glossarystylecommands,groupcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglshypergroup,
+@bibglscommand{bibglshypergroup,
name={\csfmt{bib\-gls\-hyper\-group}},
user1={\margm{type}\margm{group\dhyphen id}},
description={creates group navigation information},
+ topics={glossarystylecommands,groupcommands,linkcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsflattenedhomograph,
+@bibglscommand{bibglsflattenedhomograph,
name={\csfmt{bib\-gls\-flattened\-homograph}},
user1={\margm{name}\margm{parent label}},
description={expands to the flattened entry's new name},
+ topics={glossarystylecommands,formattingcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsflattenedchildpresort,
+@bibglscommand{bibglsflattenedchildpresort,
name={\csfmt{bib\-gls\-flattened\-child\-pre\-sort}},
user1={\margm{child name}\margm{parent name}},
description={expands to the pre-sort flattened child entry's new name},
+ topics={glossarystylecommands,formattingcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglsflattenedchildpostsort,
+@bibglscommand{bibglsflattenedchildpostsort,
name={\csfmt{bib\-gls\-flattened\-child\-post\-sort}},
user1={\margm{parent name}\margm{child name}},
description={expands to the post-sort flattened child entry's new
name},
+ topics={glossarystylecommands,formattingcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglssetwidest,
+@bibglscommand{bibglssetwidest,
name={\csfmt{bib\-gls\-set\-widest}},
user1={\margm{level}\margm{name}},
description={sets the widest name},
+ topics={glossarystylecommands,assigncommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetwidestfortype,
+@bibglscommand{bibglssetwidestfortype,
name={\csfmt{bib\-gls\-set\-widest\-for\-type}},
user1={\margm{type}\margm{level}\margm{name}},
description={sets the widest name for the given glossary type},
+ topics={glossarystylecommands,assigncommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetwidesttoplevelfallback,
+@bibglscommand{bibglssetwidesttoplevelfallback,
name={\csfmt{bib\-gls\-set\-widest\-top\-level\-fallback}},
user1={\margm{glossary list}},
description={fallback used instead of \csref{bibglssetwidest}
@@ -746,406 +1322,481 @@ name},
where there are only top level entries,
where \meta{glossary list} is a comma-separated list
of glossary labels},
+ topics={glossarystylecommands,assigncommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetwidestfallback,
+@bibglscommand{bibglssetwidestfallback,
name={\csfmt{bib\-gls\-set\-widest\-fallback}},
user1={\margm{glossary list}},
description={fallback used instead of \csref{bibglssetwidest}
in the event that \bibgls\ can't determine the widest name,
where \meta{glossary list} is a comma-separated list
of glossary labels},
+ topics={glossarystylecommands,assigncommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetwidestfortypefallback,
+@bibglscommand{bibglssetwidestfortypefallback,
name={\csfmt{bib\-gls\-set\-widest\-for\-type\-fallback}},
user1={\margm{type}},
description={fallback used instead of \csref{bibglssetwidestfortype}
in the event that \bibgls\ can't determine the widest name},
+ topics={glossarystylecommands,assigncommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglssetwidesttoplevelfortypefallback,
+@bibglscommand{bibglssetwidesttoplevelfortypefallback,
name={\csfmt{bib\-gls\-set\-widest\-top\-level\-for\-type\-fallback}},
user1={\margm{type}},
description={fallback used instead of \csref{bibglssetwidestfortype}
in the event that \bibgls\ can't determine the widest name
where there are only top-level entries},
+ topics={glossarystylecommands,assigncommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglscontributorlist,
+@bibglscommand{bibglscontributorlist,
name={\csfmt{bib\-gls\-contributor\-list}},
user1={\margm{list}\margm{number}},
description={used to markup a list of names from a field
that was converted from \BibTeX's contributor syntax},
+ topics={formattingcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglscontributor,
+@bibglscommand{bibglscontributor,
name={\csfmt{bib\-gls\-contributor}},
user1={\margm{forenames}\margm{von-part}\margm{surname}\margm{suffix}},
description={used to markup a contributor's name that was converted from
\BibTeX's contributor syntax},
+ topics={formattingcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglsdate,
+@bibglscommand{bibglsdate,
name={\csfmt{bib\-gls\-date}},
user1={\margm{year}\margm{month}\margm{day-of-month}\margm{day-of-week}\margm{day-of-year}\margm{era}\margm{original}},
description={used to markup a date converted from a field value},
+ topics={formattingcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsdatetime,
+@bibglscommand{bibglsdatetime,
name={\csfmt{bib\-gls\-date\-time}},
user1={\margm{year}\margm{month}\margm{day-of-month}\margm{day-of-week}\margm{day-of-year}\margm{era}\margm{hour}\margm{minute}\margm{second}\margm{millisec}\margm{dst}\margm{zone}\margm{original}},
description={used to markup a date-time instance converted from a field value},
+ topics={formattingcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsdatetimeremainder,
+@bibglscommand{bibglsdatetimeremainder,
name={\csfmt{bib\-gls\-date\-time\-remainder}},
user1={\margm{millisec}\margm{dst}\margm{zone}\margm{original}},
description={used internally to pick up the final four arguments of
\csref{bibglsdatetime}},
+ topics={formattingcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglstime,
+@bibglscommand{bibglstime,
name={\csfmt{bib\-gls\-time}},
user1={\margm{hour}\margm{minute}\margm{second}\margm{millisec}\margm{dst}\margm{zone}\margm{original}},
description={used to markup a time converted from a field value},
+ topics={formattingcommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglshashchar,
+@bibglscommand{bibglshashchar,
name={\csfmt{bib\-gls\-hash\-char}},
user1={},
description={expands to a literal hash character},
+ topics={charcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglsunderscorechar,
+@bibglscommand{bibglsunderscorechar,
name={\csfmt{bib\-gls\-under\-score\-char}},
user1={},
description={expands to a literal underscore character},
+ topics={charcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglsdollarchar,
+@bibglscommand{bibglsdollarchar,
name={\csfmt{bib\-gls\-dollar\-char}},
user1={},
description={expands to a literal dollar character},
+ topics={charcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglsampersandchar,
+@bibglscommand{bibglsampersandchar,
name={\csfmt{bib\-gls\-amper\-sand\-char}},
user1={},
description={expands to a literal ampersand character},
+ topics={charcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglscircumchar,
+@bibglscommand{bibglscircumchar,
name={\csfmt{bib\-gls\-circum\-char}},
user1={},
description={expands to a literal circumflex character},
+ topics={charcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglshrefchar,
+@bibglscommand{bibglshrefchar,
name={\csfmt{bib\-gls\-href\-char}},
user1={\margm{hex}\margm{char}},
description={expands to a literal percent character followed by
\meta{hex}},
+ topics={charcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglshrefunicode,
+@bibglscommand{bibglshrefunicode,
name={\csfmt{bib\-gls\-href\-unicode}},
user1={\margm{hex}\margm{char}},
description={expands to \meta{char} by default},
+ topics={charcommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglsprimaryprefixlabel,
+@bibglscommand{bibglsprimaryprefixlabel,
name={\csfmt{bib\-gls\-primary\-prefix\-label}},
user1={\margm{prefix}},
description={hook provided to pick up the primary prefix, if
required},
+ topics={hooks},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsdualprefixlabel,
+@bibglscommand{bibglsdualprefixlabel,
name={\csfmt{bib\-gls\-dual\-prefix\-label}},
user1={\margm{prefix}},
description={hook provided to pick up the dual prefix, if
required},
+ topics={hooks},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglstertiaryprefixlabel,
+@bibglscommand{bibglstertiaryprefixlabel,
name={\csfmt{bib\-gls\-tertiary\-prefix\-label}},
user1={\margm{prefix}},
description={hook provided to pick up the tertiary prefix, if
required},
+ topics={hooks},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsexternalprefixlabel,
+@bibglscommand{bibglsexternalprefixlabel,
name={\csfmt{bib\-gls\-external\-prefix\-label}},
user1={\margm{n}\margm{prefix}},
description={hook provided to pick up the \meta{n}th external prefix, if
required},
+ topics={hooks},
+ note={\bibgls},
category={command}
}
-@dualindexentry{bibglsuppercase,
+@bibglscommand{bibglsuppercase,
name={\csfmt{bib\-gls\-upper\-case}},
user1={\margm{text}},
description={converts \meta{text} to \idx{uppercase}},
+ topics={formattingcommands,casecommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglslowercase,
+@bibglscommand{bibglslowercase,
name={\csfmt{bib\-gls\-lower\-case}},
user1={\margm{text}},
description={converts \meta{text} to \idx{lowercase}},
+ topics={formattingcommands,casecommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglstitlecase,
+@bibglscommand{bibglstitlecase,
name={\csfmt{bib\-gls\-title\-case}},
user1={\margm{text}},
description={converts \meta{text} to \idx{titlecase}},
+ topics={formattingcommands,casecommands},
+ note={\bibgls\texparserdefnote},
category={command}
}
-@dualindexentry{bibglsfirstuc,
+@bibglscommand{bibglsfirstuc,
name={\csfmt{bib\-gls\-first\-uc}},
user1={\margm{text}},
description={converts the first letter of \meta{text} to \idx{uppercase}},
+ topics={formattingcommands,casecommands},
+ note={\bibgls},
category={command}
}
-@dualindexentry{glsexpandfields,
+@mainglscommand{glsexpandfields,
name={\csfmt{gls\-expand\-fields}},
user1={},
description={switches on field expansion},
+ topics={assigncommands,definingterms},
note={\styfmt{glossaries}},
category={command}
}
-@dualindexentry{glsnoexpandfields,
+@mainglscommand{glsnoexpandfields,
name={\csfmt{gls\-no\-expand\-fields}},
user1={},
description={switches off field expansion},
+ topics={assigncommands,definingterms},
note={\styfmt{glossaries}},
category={command}
}
-@dualindexentry{glssetexpandfield,
+@mainglscommand{glssetexpandfield,
name={\csfmt{gls\-set\-expand\-field}},
user1={\margm{field}},
description={switches on field expansion for the given field},
+ topics={assigncommands,definingterms},
note={\styfmt{glossaries}},
category={command}
}
-@dualindexentry{glssetnoexpandfield,
+@mainglscommand{glssetnoexpandfield,
name={\csfmt{gls\-set\-no\-expand\-field}},
user1={\margm{field}},
description={switches off field expansion for the given field},
+ topics={assigncommands,definingterms},
note={\styfmt{glossaries}},
category={command}
}
-@dualindexentry{newglossaryentry,
+@mainglscommand{newglossaryentry,
name={\csfmt{new\-glossary\-entry}},
user1={\margm{label}\margm{\keyvallist}},
description={defines a new glossary entry},
+ topics={definingterms},
note={\styfmt{glossaries}},
category={command}
}
-@dualindexentry{longnewglossaryentry,
+@mainglscommand{longnewglossaryentry,
name={\csfmt{long\-new\-glossary\-entry}},
user1={\margm{label}\margm{\keyvallist}\margm{description}},
description={defines a new glossary entry and appends
\csfmt{leavemode}\csfmt{unskip}\cs{nopostdesc} at the end of
\meta{description}},
+ topics={definingterms},
note={\styfmt{glossaries}},
category={command}
}
-@index{longnewglossaryentry*,
+@glscommand{longnewglossaryentry*,
name={\csfmt{long\-new\-glossary\-entry*}},
user1={\margm{label}\margm{\keyvallist}\margm{description}},
description={defines a new glossary entry without appending any
extra code to the end of \meta{description}},
+ topics={definingterms},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@dualindexentry{provideglossaryentry,
+@mainglscommand{provideglossaryentry,
name={\csfmt{provide\-glossary\-entry}},
user1={\margm{label}\margm{\keyvallist}},
description={defines a new glossary entry if one doesn't
already exist with the given label},
+ topics={definingterms},
note={\styfmt{glossaries}},
category={command}
}
-@dualindexentry{longprovideglossaryentry,
+@mainglscommand{longprovideglossaryentry,
name={\csfmt{long\-provide\-glossary\-entry}},
user1={\margm{label}\margm{\keyvallist}\margm{description}},
description={defines a new glossary entry if one doesn't
already exist with the given label},
+ topics={definingterms},
note={\styfmt{glossaries}},
category={command}
}
-@dualindexentry{newterm,
+@mainglscommand{newterm,
name={\csfmt{new\-term}},
user1={\oargm{\keyvallist}\margm{label}},
description={defines a new glossary entry where the
\field{description} field defaults to empty},
- note={the \styfmt{glossaries}'s \styopt{index} package
-option},
+ topics={definingterms},
+ note={\styfmt{glossaries}'s \styopt{index} package option},
category={command}
}
-@dualindexentry{newabbreviation,
+@mainglscommand{newabbreviation,
name={\csfmt{new\-abbre\-vi\-a\-tion}},
user1={\oargm{\keyvallist}\margm{label}\margm{short}\margm{long}},
description={defines a new abbreviation},
+ topics={definingterms},
note={\styfmt{glossaries-extra}},
category={command}
}
-@dualindexentry{newacronym,
+@mainglscommand{newacronym,
name={\csfmt{new\-acronym}},
user1={\oargm{\keyvallist}\margm{label}\margm{short}\margm{long}},
description={defines a new abbreviation. The
\styfmt{glossaries-extra} package redefines this to use
\csref{newabbreviation} with the \field{category} set to
\code{acronym}},
+ topics={definingterms},
note={\styfmt{glossaries}},
category={command}
}
-@dualindexentry{glsxtrnewsymbol,
+@mainglscommand{glsxtrnewsymbol,
name={\csfmt{gls\-xtr\-new\-symbol}},
user1={\oargm{\keyvallist}\margm{label}\margm{symbol}},
description={defines a new symbol},
+ topics={definingterms},
note={\styfmt{glossaries-extra} \styopt{symbols}},
category={command}
}
-@dualindexentry{glsxtrnewnumber,
+@mainglscommand{glsxtrnewnumber,
name={\csfmt{gls\-xtr\-new\-number}},
user1={\oargm{\keyvallist}\margm{label}},
description={defines a new number},
+ topics={definingterms},
note={\styfmt{glossaries-extra} \styopt{numbers}},
category={command}
}
-@dualindexentry{newdualentry,
+@mainglscommand{newdualentry,
name={\csfmt{new\-dual\-entry}},
user1={\oargm{\keyvallist}\margm{label}\margm{short}\margm{long}\margm{description}},
description={example given in \styfmt{glossaries} user manual},
+ topics={definingterms},
category={command}
}
-@dualindexentry{@gls@hypergroup,
+@mainglscommand{@gls@hypergroup,
name={\csfmt{@gls@hypergroup}},
user1={\margm{type}\margm{group id}},
description={command written to the \ext{aux} file that identifies that the given group was used in the
glossary on the previous run},
+ topics={groupcommands,internalcommands,auxcommands},
note={\styfmt{glossary-hypernav}},
category={command}
}
-@dualindexentry{glsxtr@resource,
+@mainglscommand{glsxtr@resource,
name={\csfmt{glsxtr@resource}},
user1={\margm{options}\margm{filename}},
description={this internal command is written to the \ext{aux}
file by \csref{glsxtrresourcefile}
to provide \bibgls\ with the resource information},
+ topics={internalcommands,auxcommands},
note={\styfmt{glossaries-extra} v1.08+},
category={command}
}
-@dualindexentry{glsxtr@wrglossarylocation,
+@mainglscommand{glsxtr@wrglossarylocation,
name={\csfmt{gls\-xtr\-@wr\-glossary\-location}},
user1={\margm{n}\margm{page}},
description={This command simply expands to \meta{n}, the value of
the \counter{wrglossary} counter for the given page},
+ topics={internalcommands,loclistcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.29+},
category={command}
}
-@dualindexentry{GlsXtrIndexCounterLink,
+@mainglscommand{GlsXtrIndexCounterLink,
name={\csfmt{Gls\-Xtr\-Index\-Counter\-Link}},
user1={\margm{text}\margm{label}},
description={Creates a hyperlink to the \counter{wrglossary}
location obtained from the \field{indexcounter} field},
+ topics={linkcommands,loclistcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.29+},
category={command}
}
-@dualindexentry{GlsXtrDualBackLink,
+@mainglscommand{GlsXtrDualBackLink,
name={\csfmt{Gls\-Xtr\-Dual\-Back\-Link}},
user1={\margm{text}\margm{label}},
description={Creates a hyperlink to the dual entry whose label is
obtained from the field given by \csref{GlsXtrDualField}},
+ topics={linkcommands,fieldrefcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.30+},
category={command}
}
-@dualindexentry{GlsXtrDualField,
+@mainglscommand{GlsXtrDualField,
name={\csfmt{Gls\-Xtr\-Dual\-Field}},
user1={},
description={The field used to store the dual label. This defaults
to \field{dual} but will need to be redefined if a different
value is given by \csopt{dual-field}},
+ topics={fieldrefcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.30+},
category={command}
}
-@dualindexentry{glsxtrfmt,
+@mainglscommand{glsxtrfmt,
name={\csfmt{gls\-xtr\-fmt}},
user1={\oargm{options}\margm{label}\margm{text}},
description={formats the given text according to the formatting
command identified by the value of the field obtained
from \cs{GlsXtrFmtField}},
+ topics={fieldrefcommands,linkcommands,formattingcommands},
note={\styfmt{glossaries-extra} v1.12+},
+ seealso={glsxtrfmtdisplay},
category={command}
}
-@dualindexentry{glsxtrfmt*,
+@mainglscommand{glsxtrfmt*,
name={\csfmt{gls\-xtr\-fmt*}},
user1={\oargm{options}\margm{label}\margm{text}\oargm{insert}},
description={like \csref{glsxtrfmt} but inserts extra
material into the link text but outside of the formatting command},
+ topics={fieldrefcommands,linkcommands,formattingcommands},
+ seealso={glsxtrfmtdisplay},
note={\styfmt{glossaries-extra} v1.23+},
category={command}
}
-@dualindexentry{glsxtrentryfmt,
+@mainglscommand{glsxtrentryfmt,
name={\csfmt{gls\-xtr\-entry\-fmt}},
user1={\margm{label}\margm{text}},
description={alternative to \csref{glsxtrfmt} for use in
section headings},
+ topics={fieldrefcommands,formattingcommands},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@index{glsxtrfmtdisplay,
+@glscommand{glsxtrfmtdisplay,
name={\csfmt{gls\-xtr\-fmt\-display}},
user1={\margm{cs-name}\margm{text}\margm{insert}},
description={used by \csref{glsxtrfmt} to format the given
@@ -1153,15 +1804,17 @@ location obtained from the \field{indexcounter} field},
identified by \cs{GlsXtrFmtField} and \meta{insert} is empty for the
unstarred \csref{glsxtrfmt} and the final optional argument of the
starred version \csref{glsxtrfmt*}},
+ topics={formattingcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@dualindexentry{glsxtrresourcefile,
+@mainglscommand{glsxtrresourcefile,
name={\csfmt{gls\-xtr\-resource\-file}},
user1={\oargm{options}\margm{filename}},
description={input the \ext{glstex} file created by \bibgls\ and
write resource instructions to the \ext{aux} file},
+ topics={indexing},
note={\styfmt{glossaries-extra} v1.08+},
seealso={resourceoptions,GlsXtrLoadResources},
category={command}
@@ -1173,336 +1826,350 @@ starred version \csref{glsxtrfmt*}},
text={resource option}
}
-@dualindexentry{opt.charset,
+@resourceoption{opt.charset,
name={\csoptfmt{charset}},
user1={\meta{encoding-name}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.interpret-preamble,
+@resourceoption{opt.interpret-preamble,
name={\csoptfmt{interpret\dhyphen preamble}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.interpret-label-fields,
+@resourceoption{opt.interpret-label-fields,
name={\csoptfmt{interpret\dhyphen label\dhyphen fields}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.primary-dual-dependency,
+@resourceoption{opt.primary-dual-dependency,
name={\csoptfmt{primary\dhyphen dual\dhyphen dependency}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.strip-missing-parents,
+@resourceoption{opt.strip-missing-parents,
name={\csoptfmt{strip\dhyphen missing\dhyphen parents}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.missing-parents,
+@resourceoption{opt.missing-parents,
name={\csoptfmt{missing\dhyphen parents}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.missing-parent-category,
+@resourceoption{opt.missing-parent-category,
name={\csoptfmt{missing\dhyphen parent\dhyphen category}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.copy-alias-to-see,
+@resourceoption{opt.copy-alias-to-see,
name={\csoptfmt{copy\dhyphen alias\dhyphen to\dhyphen see}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.write-preamble,
+@resourceoption{opt.write-preamble,
name={\csoptfmt{write\dhyphen preamble}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.set-widest,
+@resourceoption{opt.set-widest,
name={\csoptfmt{set\dhyphen widest}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.duplicate-label-suffix,
+@resourceoption{opt.duplicate-label-suffix,
name={\csoptfmt{duplicate\dhyphen label\dhyphen suffix}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.entry-type-aliases,
+@resourceoption{opt.entry-type-aliases,
name={\csoptfmt{entry\dhyphen type\dhyphen aliases}},
user1={\meta{\keyvallist}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.field-aliases,
+@resourceoption{opt.unknown-entry-alias,
+ name={\csoptfmt{unknown\dhyphen entry\dhyphen alias}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.field-aliases,
name={\csoptfmt{field\dhyphen aliases}},
user1={\meta{\keyvallist}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.replicate-fields,
+@resourceoption{opt.replicate-fields,
name={\csoptfmt{replicate\dhyphen fields}},
user1={\meta{\keyvallist}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.replicate-override,
+@resourceoption{opt.replicate-override,
name={\csoptfmt{replicate\dhyphen override}},
user1={\margm{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.labelify,
+@resourceoption{opt.replicate-missing-field-action,
+ name={\csoptfmt{replicate\dhyphen missing\dhyphen field\dhyphen action}},
+ user1={\margm{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.labelify,
name={\csoptfmt{labelify}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.labelify-list,
+@resourceoption{opt.labelify-list,
name={\csoptfmt{labelify\dhyphen list}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dependency-fields,
+@resourceoption{opt.dependency-fields,
name={\csoptfmt{dependency\dhyphen fields}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.labelify-replace,
+@resourceoption{opt.labelify-replace,
name={\csoptfmt{labelify\dhyphen replace}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.sort-replace,
+@resourceoption{opt.sort-replace,
name={\csoptfmt{sort\dhyphen replace}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-sort-replace,
+@resourceoption{opt.dual-sort-replace,
name={\csoptfmt{dual\dhyphen sort\dhyphen replace}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-sort-replace,
+@resourceoption{opt.secondary-sort-replace,
name={\csoptfmt{secondary\dhyphen sort\dhyphen replace}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.action,
+@resourceoption{opt.action,
name={\csoptfmt{action}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.copy-action-group-field,
+@resourceoption{opt.copy-action-group-field,
name={\csoptfmt{copy\dhyphen action\dhyphen group\dhyphen field}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.src,
+@resourceoption{opt.src,
name={\csoptfmt{src}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.selection,
+@resourceoption{opt.selection,
name={\csoptfmt{selection}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.match,
+@resourceoption{opt.match,
name={\csoptfmt{match}},
user1={\meta{\keyvallist}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.match-op,
+@resourceoption{opt.match-op,
name={\csoptfmt{match\dhyphen op}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.match-action,
+@resourceoption{opt.match-action,
name={\csoptfmt{match\dhyphen action}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.not-match,
+@resourceoption{opt.not-match,
name={\csoptfmt{not\dhyphen match}},
user1={\meta{\keyvallist}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.limit,
+@resourceoption{opt.limit,
name={\csoptfmt{limit}},
user1={\meta{number}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.flatten,
+@resourceoption{opt.flatten,
name={\csoptfmt{flatten}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.flatten-lonely,
+@resourceoption{opt.flatten-lonely,
name={\csoptfmt{flatten\dhyphen lonely}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.flatten-lonely-rule,
+@resourceoption{opt.flatten-lonely-rule,
name={\csoptfmt{flatten\dhyphen lonely\dhyphen rule}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.master,
+@resourceoption{opt.master,
name={\csoptfmt{master}},
user1={\meta{name}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.master-resources,
+@resourceoption{opt.master-resources,
name={\csoptfmt{master\dhyphen resources}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.ignore-fields,
+@resourceoption{opt.ignore-fields,
name={\csoptfmt{ignore\dhyphen fields}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.date-time-fields,
+@resourceoption{opt.date-time-fields,
name={\csoptfmt{date\dhyphen time\dhyphen fields}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.date-fields,
+@resourceoption{opt.date-fields,
name={\csoptfmt{date\dhyphen fields}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.time-fields,
+@resourceoption{opt.time-fields,
name={\csoptfmt{time\dhyphen fields}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.date-time-field-format,
+@resourceoption{opt.date-time-field-format,
name={\csoptfmt{date\dhyphen time\dhyphen field\dhyphen format}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-date-time-field-format,
+@resourceoption{opt.dual-date-time-field-format,
name={\csoptfmt{dual\dhyphen date\dhyphen time\dhyphen field\dhyphen format}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.date-field-format,
+@resourceoption{opt.date-field-format,
name={\csoptfmt{date\dhyphen field\dhyphen format}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-date-field-format,
+@resourceoption{opt.dual-date-field-format,
name={\csoptfmt{dual\dhyphen date\dhyphen field\dhyphen format}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.time-field-format,
+@resourceoption{opt.time-field-format,
name={\csoptfmt{time\dhyphen field\dhyphen format}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-time-field-format,
+@resourceoption{opt.dual-time-field-format,
name={\csoptfmt{dual\dhyphen time\dhyphen field\dhyphen format}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.date-time-field-locale,
+@resourceoption{opt.date-time-field-locale,
name={\csoptfmt{date\dhyphen time\dhyphen field\dhyphen locale}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-date-time-field-locale,
+@resourceoption{opt.dual-date-time-field-locale,
name={\csoptfmt{dual\dhyphen date\dhyphen time\dhyphen
field\dhyphen locale}},
user1={\meta{value}},
@@ -1510,588 +2177,665 @@ field\dhyphen locale}},
parent={resourceoptions}
}
-@dualindexentry{opt.date-field-locale,
+@resourceoption{opt.date-field-locale,
name={\csoptfmt{date\dhyphen field\dhyphen locale}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-date-field-locale,
+@resourceoption{opt.dual-date-field-locale,
name={\csoptfmt{dual\dhyphen date\dhyphen field\dhyphen locale}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.time-field-locale,
+@resourceoption{opt.time-field-locale,
name={\csoptfmt{time\dhyphen field\dhyphen locale}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-time-field-locale,
+@resourceoption{opt.dual-time-field-locale,
name={\csoptfmt{date\dhyphen time\dhyphen field\dhyphen locale}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.bibtex-contributor-fields,
+@resourceoption{opt.bibtex-contributor-fields,
name={\csoptfmt{bibtex\dhyphen contributor\dhyphen fields}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.contributor-order,
+@resourceoption{opt.contributor-order,
name={\csoptfmt{contributor\dhyphen order}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.category,
+@resourceoption{opt.category,
name={\csoptfmt{category}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.type,
+@resourceoption{opt.type,
name={\csoptfmt{type}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.counter,
+@resourceoption{opt.counter,
name={\csoptfmt{counter}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.label-prefix,
+@resourceoption{opt.label-prefix,
name={\csoptfmt{label\dhyphen prefix}},
user1={\meta{tag}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.cs-label-prefix,
+@resourceoption{opt.cs-label-prefix,
name={\csoptfmt{cs\dhyphen label\dhyphen prefix}},
user1={\meta{tag}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.record-label-prefix,
+@resourceoption{opt.record-label-prefix,
name={\csoptfmt{record\dhyphen label\dhyphen prefix}},
user1={\meta{tag}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.ext-prefixes,
+@resourceoption{opt.ext-prefixes,
name={\csoptfmt{ext\dhyphen prefixes}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.save-original-id,
+@resourceoption{opt.save-original-id,
name={\csoptfmt{save\dhyphen original\dhyphen id}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.short-case-change,
+@resourceoption{opt.short-case-change,
name={\csoptfmt{short\dhyphen case\dhyphen change}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.long-case-change,
+@resourceoption{opt.long-case-change,
name={\csoptfmt{long\dhyphen case\dhyphen change}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.name-case-change,
+@resourceoption{opt.name-case-change,
name={\csoptfmt{name\dhyphen case\dhyphen change}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.description-case-change,
+@resourceoption{opt.description-case-change,
name={\csoptfmt{description\dhyphen case\dhyphen change}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.word-boundaries,
+@resourceoption{opt.field-case-change,
+ name={\csoptfmt{field\dhyphen case\dhyphen change}},
+ user1={\margm{\keyvallist}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.word-boundaries,
name={\csoptfmt{word\dhyphen boundaries}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.post-description-dot,
+@resourceoption{opt.no-case-change-cs,
+ name={\csoptfmt{no\dhyphen case\dhyphen change\dhyphen cs}},
+ user1={\meta{list}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.encapsulate-fields,
+ name={\csoptfmt{encapsulate\dhyphen fields}},
+ user1={\margm{\keyvallist}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.encapsulate-fields*,
+ name={\csoptfmt{encapsulate\dhyphen fields*}},
+ user1={\margm{\keyvallist}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.interpret-fields,
+ name={\csoptfmt{interpret\dhyphen fields}},
+ user1={\margm{list}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.post-description-dot,
name={\csoptfmt{post\dhyphen description\dhyphen dot}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.strip-trailing-nopost,
+@resourceoption{opt.strip-trailing-nopost,
name={\csoptfmt{strip\dhyphen trailing\dhyphen nopost}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.check-end-punctuation,
+@resourceoption{opt.check-end-punctuation,
name={\csoptfmt{check\dhyphen end\dhyphen punctuation}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.sort-label-list,
+@resourceoption{opt.sort-label-list,
name={\csoptfmt{sort\dhyphen label\dhyphen list}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.group,
+@resourceoption{opt.group,
name={\csoptfmt{group}},
user1={\meta{label}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.group-formation,
+@resourceoption{opt.group-formation,
name={\csoptfmt{group\dhyphen formation}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-group-formation,
+@resourceoption{opt.secondary-group-formation,
name={\csoptfmt{secondary\dhyphen group\dhyphen formation}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-group-formation,
+@resourceoption{opt.dual-group-formation,
name={\csoptfmt{dual\dhyphen group\dhyphen formation}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.save-child-count,
+@resourceoption{opt.save-child-count,
name={\csoptfmt{save\dhyphen child\dhyphen count}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.short-plural-suffix,
+@resourceoption{opt.save-original-entrytype,
+ name={\csoptfmt{save\dhyphen original\dhyphen entrytype}},
+ user1={\meta{boolean}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.short-plural-suffix,
name={\csoptfmt{short\dhyphen plural\dhyphen suffix}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-short-plural-suffix,
+@resourceoption{opt.dual-short-plural-suffix,
name={\csoptfmt{dual\dhyphen short\dhyphen plural\dhyphen suffix}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.save-locations,
+@resourceoption{opt.save-locations,
name={\csoptfmt{save\dhyphen locations}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.save-loclist,
+@resourceoption{opt.save-loclist,
name={\csoptfmt{save\dhyphen loclist}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.save-primary-locations,
+@resourceoption{opt.save-primary-locations,
name={\csoptfmt{save\dhyphen primary\dhyphen locations}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.primary-location-formats,
+@resourceoption{opt.primary-location-formats,
name={\csoptfmt{primary\dhyphen location\dhyphen formats}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.min-loc-range,
+@resourceoption{opt.min-loc-range,
name={\csoptfmt{min\dhyphen loc\dhyphen range}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.max-loc-diff,
+@resourceoption{opt.max-loc-diff,
name={\csoptfmt{max\dhyphen loc\dhyphen diff}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.suffixF,
+@resourceoption{opt.suffixF,
name={\csoptfmt{suffixF}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.suffixFF,
+@resourceoption{opt.suffixFF,
name={\csoptfmt{suffixFF}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.see,
+@resourceoption{opt.compact-ranges,
+ name={\csoptfmt{compact-ranges}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.see,
name={\csoptfmt{see}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.seealso,
+@resourceoption{opt.seealso,
name={\csoptfmt{seealso}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.alias,
+@resourceoption{opt.alias,
name={\csoptfmt{alias}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.alias-loc,
+@resourceoption{opt.alias-loc,
name={\csoptfmt{alias\dhyphen loc}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.loc-prefix,
+@resourceoption{opt.loc-prefix,
name={\csoptfmt{loc\dhyphen prefix}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.loc-suffix,
+@resourceoption{opt.loc-suffix,
name={\csoptfmt{loc\dhyphen suffix}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.loc-counters,
+@resourceoption{opt.loc-counters,
name={\csoptfmt{loc\dhyphen counters}},
user1={\meta{list}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.save-index-counter,
+@resourceoption{opt.save-index-counter,
name={\csoptfmt{save\dhyphen index\dhyphen counter}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.supplemental-locations,
+@resourceoption{opt.supplemental-locations,
name={\csoptfmt{supplemental\dhyphen locations}},
user1={\meta{basename}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.supplemental-selection,
+@resourceoption{opt.supplemental-selection,
name={\csoptfmt{supplemental\dhyphen selection}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.supplemental-category,
+@resourceoption{opt.supplemental-category,
name={\csoptfmt{supplemental\dhyphen category}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.sort,
+@resourceoption{opt.sort,
name={\csoptfmt{sort}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.shuffle,
+@resourceoption{opt.shuffle,
name={\csoptfmt{shuffle}},
user1={\meta{seed}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.sort-field,
+@resourceoption{opt.sort-field,
name={\csoptfmt{sort\dhyphen field}},
user1={\meta{field}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.symbol-sort-fallback,
+@resourceoption{opt.entry-sort-fallback,
+ name={\csoptfmt{entry\dhyphen sort\dhyphen fallback}},
+ user1={\meta{field}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.symbol-sort-fallback,
name={\csoptfmt{symbol\dhyphen sort\dhyphen fallback}},
user1={\meta{field}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.abbreviation-sort-fallback,
+@resourceoption{opt.abbreviation-sort-fallback,
name={\csoptfmt{abbreviation\dhyphen sort\dhyphen fallback}},
user1={\meta{field}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.abbreviation-name-fallback,
+@resourceoption{opt.abbreviation-name-fallback,
name={\csoptfmt{abbreviation\dhyphen name\dhyphen fallback}},
user1={\meta{field}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.bibtexentry-sort-fallback,
+@resourceoption{opt.bibtexentry-sort-fallback,
name={\csoptfmt{bibtexentry\dhyphen sort\dhyphen fallback}},
user1={\meta{field}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.trim-sort,
+@resourceoption{opt.trim-sort,
name={\csoptfmt{trim\dhyphen sort}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.missing-sort-fallback,
+@resourceoption{opt.missing-sort-fallback,
name={\csoptfmt{missing\dhyphen sort\dhyphen fallback}},
user1={\meta{field}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-missing-sort-fallback,
+@resourceoption{opt.dual-missing-sort-fallback,
name={\csoptfmt{dual\dhyphen missing\dhyphen sort\dhyphen fallback}},
user1={\meta{field}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-missing-sort-fallback,
+@resourceoption{opt.secondary-missing-sort-fallback,
name={\csoptfmt{secondary\dhyphen missing\dhyphen sort\dhyphen fallback}},
user1={\meta{field}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.sort-rule,
+@resourceoption{opt.sort-rule,
name={\csoptfmt{sort\dhyphen rule}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.break-at,
+@resourceoption{opt.break-at,
name={\csoptfmt{break\dhyphen at}},
user1={\meta{option}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.break-marker,
+@resourceoption{opt.break-marker,
name={\csoptfmt{break\dhyphen marker}},
user1={\meta{marker}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.identical-sort-action,
+@resourceoption{opt.identical-sort-action,
name={\csoptfmt{identical\dhyphen sort\dhyphen action}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-identical-sort-action,
+@resourceoption{opt.dual-identical-sort-action,
name={\csoptfmt{dual\dhyphen identical\dhyphen sort\dhyphen action}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-identical-sort-action,
+@resourceoption{opt.secondary-identical-sort-action,
name={\csoptfmt{secondary\dhyphen identical\dhyphen sort\dhyphen action}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.sort-suffix,
+@resourceoption{opt.sort-suffix,
name={\csoptfmt{sort\dhyphen suffix}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.sort-suffix-marker,
+@resourceoption{opt.sort-suffix-marker,
name={\csoptfmt{sort\dhyphen suffix\dhyphen marker}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.strength,
+@resourceoption{opt.strength,
name={\csoptfmt{strength}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.decomposition,
+@resourceoption{opt.decomposition,
name={\csoptfmt{decomposition}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.letter-number-rule,
+@resourceoption{opt.letter-number-rule,
name={\csoptfmt{letter\dhyphen number\dhyphen rule}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.letter-number-punc-rule,
+@resourceoption{opt.letter-number-punc-rule,
name={\csoptfmt{letter\dhyphen number\dhyphen punc\dhyphen rule}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.numeric-sort-pattern,
+@resourceoption{opt.numeric-sort-pattern,
name={\csoptfmt{numeric\dhyphen sort\dhyphen pattern}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.numeric-locale,
+@resourceoption{opt.numeric-locale,
name={\csoptfmt{numeric\dhyphen locale}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.date-sort-locale,
+@resourceoption{opt.date-sort-locale,
name={\csoptfmt{date\dhyphen sort\dhyphen locale}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.date-sort-format,
+@resourceoption{opt.date-sort-format,
name={\csoptfmt{date\dhyphen sort\dhyphen format}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.trigger-type,
+@resourceoption{opt.trigger-type,
name={\csoptfmt{trigger\dhyphen type}},
user1={\meta{type}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary,
+@resourceoption{opt.progenitor-type,
+ name={\csoptfmt{progenitor\dhyphen type}},
+ user1={\meta{type}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.progeny-type,
+ name={\csoptfmt{progeny\dhyphen type}},
+ user1={\meta{type}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.adopted-parent-field,
+ name={\csoptfmt{adopted\dhyphen parent\dhyphen field}},
+ user1={\meta{type}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.secondary,
name={\csoptfmt{secondary}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-trim-sort,
+@resourceoption{opt.secondary-trim-sort,
name={\csoptfmt{secondary\dhyphen trim\dhyphen sort}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-sort-rule,
+@resourceoption{opt.secondary-sort-rule,
name={\csoptfmt{secondary\dhyphen sort\dhyphen rule}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-break-at,
+@resourceoption{opt.secondary-break-at,
name={\csoptfmt{secondary\dhyphen break\dhyphen at}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-break-marker,
+@resourceoption{opt.secondary-break-marker,
name={\csoptfmt{secondary\dhyphen break\dhyphen marker}},
user1={\meta{marker}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-sort-suffix,
+@resourceoption{opt.secondary-sort-suffix,
name={\csoptfmt{secondary\dhyphen sort\dhyphen suffix}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-sort-suffix-marker,
+@resourceoption{opt.secondary-sort-suffix-marker,
name={\csoptfmt{secondary\dhyphen sort\dhyphen suffix\dhyphen
marker}},
user1={\meta{value}},
@@ -2099,21 +2843,21 @@ marker}},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-strength,
+@resourceoption{opt.secondary-strength,
name={\csoptfmt{secondary\dhyphen strength}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-decomposition,
+@resourceoption{opt.secondary-decomposition,
name={\csoptfmt{secondary\dhyphen decomposition}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-letter-number-rule,
+@resourceoption{opt.secondary-letter-number-rule,
name={\csoptfmt{secondary\dhyphen letter\dhyphen number\dhyphen
rule}},
user1={\meta{value}},
@@ -2121,7 +2865,7 @@ rule}},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-letter-number-punc-rule,
+@resourceoption{opt.secondary-letter-number-punc-rule,
name={\csoptfmt{secondary\dhyphen letter\dhyphen number\dhyphen
punc\dhyphen rule}},
user1={\meta{value}},
@@ -2129,7 +2873,7 @@ punc\dhyphen rule}},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-numeric-sort-pattern,
+@resourceoption{opt.secondary-numeric-sort-pattern,
name={\csoptfmt{secondary\dhyphen numeric\dhyphen sort\dhyphen
pattern}},
user1={\meta{value}},
@@ -2137,14 +2881,14 @@ pattern}},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-numeric-locale,
+@resourceoption{opt.secondary-numeric-locale,
name={\csoptfmt{secondary\dhyphen numeric\dhyphen locale}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-date-sort-locale,
+@resourceoption{opt.secondary-date-sort-locale,
name={\csoptfmt{secondary\dhyphen date\dhyphen sort\dhyphen
locale}},
user1={\meta{value}},
@@ -2152,7 +2896,7 @@ locale}},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-date-sort-format,
+@resourceoption{opt.secondary-date-sort-format,
name={\csoptfmt{secondary\dhyphen date\dhyphen sort\dhyphen
format}},
user1={\meta{value}},
@@ -2160,147 +2904,147 @@ format}},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-prefix,
+@resourceoption{opt.dual-prefix,
name={\csoptfmt{dual\dhyphen prefix}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.combine-dual-locations,
+@resourceoption{opt.combine-dual-locations,
name={\csoptfmt{combine\dhyphen dual\dhyphen locations}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-type,
+@resourceoption{opt.dual-type,
name={\csoptfmt{dual\dhyphen type}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-category,
+@resourceoption{opt.dual-category,
name={\csoptfmt{dual\dhyphen category}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-counter,
+@resourceoption{opt.dual-counter,
name={\csoptfmt{dual\dhyphen counter}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-short-case-change,
+@resourceoption{opt.dual-short-case-change,
name={\csoptfmt{dual\dhyphen short\dhyphen case\dhyphen change}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-long-case-change,
+@resourceoption{opt.dual-long-case-change,
name={\csoptfmt{dual\dhyphen long\dhyphen case\dhyphen change}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-field,
+@resourceoption{opt.dual-field,
name={\csoptfmt{dual\dhyphen field}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-sort,
+@resourceoption{opt.dual-sort,
name={\csoptfmt{dual\dhyphen sort}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-sort-field,
+@resourceoption{opt.dual-sort-field,
name={\csoptfmt{dual\dhyphen sort\dhyphen field}},
user1={\meta{field}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-trim-sort,
+@resourceoption{opt.dual-trim-sort,
name={\csoptfmt{dual\dhyphen trim\dhyphen sort}},
user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-sort-rule,
+@resourceoption{opt.dual-sort-rule,
name={\csoptfmt{dual\dhyphen sort\dhyphen rule}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-break-at,
+@resourceoption{opt.dual-break-at,
name={\csoptfmt{dual\dhyphen break\dhyphen at}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-break-marker,
+@resourceoption{opt.dual-break-marker,
name={\csoptfmt{dual\dhyphen break\dhyphen marker}},
user1={\meta{marker}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-sort-suffix,
+@resourceoption{opt.dual-sort-suffix,
name={\csoptfmt{dual\dhyphen sort\dhyphen suffix}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-sort-suffix-marker,
+@resourceoption{opt.dual-sort-suffix-marker,
name={\csoptfmt{dual\dhyphen sort\dhyphen suffix\dhyphen marker}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-strength,
+@resourceoption{opt.dual-strength,
name={\csoptfmt{dual\dhyphen strength}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-decomposition,
+@resourceoption{opt.dual-decomposition,
name={\csoptfmt{dual\dhyphen decomposition}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-letter-number-rule,
+@resourceoption{opt.dual-letter-number-rule,
name={\csoptfmt{dual\dhyphen letter\dhyphen number\dhyphen rule}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-letter-number-punc-rule,
+@resourceoption{opt.dual-letter-number-punc-rule,
name={\csoptfmt{dual\dhyphen letter\dhyphen number\dhyphen punc\dhyphen rule}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-numeric-sort-pattern,
+@resourceoption{opt.dual-numeric-sort-pattern,
name={\csoptfmt{dual\dhyphen numeric\dhyphen sort\dhyphen
pattern}},
user1={\meta{value}},
@@ -2308,491 +3052,519 @@ pattern}},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-numeric-locale,
+@resourceoption{opt.dual-numeric-locale,
name={\csoptfmt{dual\dhyphen numeric\dhyphen locale}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-date-sort-locale,
+@resourceoption{opt.dual-date-sort-locale,
name={\csoptfmt{dual\dhyphen date\dhyphen sort\dhyphen locale}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-date-sort-format,
+@resourceoption{opt.dual-date-sort-format,
name={\csoptfmt{dual\dhyphen date\dhyphen sort\dhyphen format}},
user1={\meta{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-entry-map,
+@resourceoption{opt.dual-entry-map,
name={\csoptfmt{dual\dhyphen entry\dhyphen map}},
user1={\marg{\margm{list1},\margm{list2}}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-abbrv-map,
+@resourceoption{opt.dual-abbrv-map,
name={\csoptfmt{dual\dhyphen abbrv\dhyphen map}},
user1={\marg{\margm{list1},\margm{list2}}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-abbrventry-map,
+@resourceoption{opt.dual-abbrventry-map,
name={\csoptfmt{dual\dhyphen abbrventry\dhyphen map}},
user1={\marg{\margm{list1},\margm{list2}}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-symbol-map,
+@resourceoption{opt.dual-symbol-map,
name={\csoptfmt{dual\dhyphen symbol\dhyphen map}},
user1={\marg{\margm{list1},\margm{list2}}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-indexentry-map,
+@resourceoption{opt.dual-indexentry-map,
name={\csoptfmt{dual\dhyphen indexentry\dhyphen map}},
user1={\marg{\margm{list1},\margm{list2}}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-indexsymbol-map,
+@resourceoption{opt.dual-indexsymbol-map,
name={\csoptfmt{dual\dhyphen indexsymbol\dhyphen map}},
user1={\marg{\margm{list1},\margm{list2}}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-indexabbrv-map,
+@resourceoption{opt.dual-indexabbrv-map,
name={\csoptfmt{dual\dhyphen indexabbrv\dhyphen map}},
user1={\marg{\margm{list1},\margm{list2}}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-entry-backlink,
+@resourceoption{opt.dual-entry-backlink,
name={\csoptfmt{dual\dhyphen entry\dhyphen backlink}},
user1={\margm{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-abbrv-backlink,
+@resourceoption{opt.dual-abbrv-backlink,
name={\csoptfmt{dual\dhyphen abbrv\dhyphen backlink}},
user1={\margm{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-entryabbrv-backlink,
+@resourceoption{opt.dual-entryabbrv-backlink,
name={\csoptfmt{dual\dhyphen entryabbrv\dhyphen backlink}},
user1={\margm{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-abbrventry-backlink,
+@resourceoption{opt.dual-abbrventry-backlink,
name={\csoptfmt{dual\dhyphen abbrventry\dhyphen backlink}},
user1={\margm{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-symbol-backlink,
+@resourceoption{opt.dual-symbol-backlink,
name={\csoptfmt{dual\dhyphen symbol\dhyphen backlink}},
user1={\margm{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-indexentry-backlink,
+@resourceoption{opt.dual-indexentry-backlink,
name={\csoptfmt{dual\dhyphen indexentry\dhyphen backlink}},
user1={\margm{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-indexsymbol-backlink,
+@resourceoption{opt.dual-indexsymbol-backlink,
name={\csoptfmt{dual\dhyphen indexsymbol\dhyphen backlink}},
user1={\margm{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-indexabbrv-backlink,
+@resourceoption{opt.dual-indexabbrv-backlink,
name={\csoptfmt{dual\dhyphen indexabbrv\dhyphen backlink}},
user1={\margm{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-backlink,
+@resourceoption{opt.dual-backlink,
name={\csoptfmt{dual\dhyphen backlink}},
user1={\margm{boolean}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.tertiary-prefix,
+@resourceoption{opt.tertiary-prefix,
name={\csoptfmt{tertiary\dhyphen prefix}},
user1={\margm{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.tertiary-type,
+@resourceoption{opt.tertiary-type,
name={\csoptfmt{tertiary\dhyphen type}},
user1={\margm{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.tertiary-category,
+@resourceoption{opt.tertiary-category,
name={\csoptfmt{tertiary\dhyphen category}},
user1={\margm{value}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.sort-number-pad,
+@resourceoption{opt.sort-number-pad,
name={\csoptfmt{sort\dhyphen number\dhyphen pad}},
user1={\meta{number}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-sort-number-pad,
+@resourceoption{opt.dual-sort-number-pad,
name={\csoptfmt{dual\dhyphen sort\dhyphen number\dhyphen pad}},
user1={\meta{number}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-sort-number-pad,
+@resourceoption{opt.secondary-sort-number-pad,
name={\csoptfmt{secondary\dhyphen sort\dhyphen number\dhyphen pad}},
user1={\meta{number}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.sort-pad-plus,
+@resourceoption{opt.sort-pad-plus,
name={\csoptfmt{sort\dhyphen pad\dhyphen plus}},
user1={\meta{marker}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-sort-pad-plus,
+@resourceoption{opt.dual-sort-pad-plus,
name={\csoptfmt{dual\dhyphen sort\dhyphen pad\dhyphen plus}},
user1={\meta{marker}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-sort-pad-plus,
+@resourceoption{opt.secondary-sort-pad-plus,
name={\csoptfmt{secondary\dhyphen sort\dhyphen pad\dhyphen plus}},
user1={\meta{marker}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.sort-pad-minus,
+@resourceoption{opt.sort-pad-minus,
name={\csoptfmt{sort\dhyphen pad\dhyphen minus}},
user1={\meta{marker}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.dual-sort-pad-minus,
+@resourceoption{opt.dual-sort-pad-minus,
name={\csoptfmt{dual\dhyphen sort\dhyphen pad\dhyphen minus}},
user1={\meta{marker}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{opt.secondary-sort-pad-minus,
+@resourceoption{opt.secondary-sort-pad-minus,
name={\csoptfmt{secondary\dhyphen sort\dhyphen pad\dhyphen minus}},
user1={\meta{marker}},
category={resourceoption},
parent={resourceoptions}
}
-@dualindexentry{GlsXtrLoadResources,
+@mainglscommand{GlsXtrLoadResources,
name={\csfmt{Gls\-Xtr\-Load\-Resources}},
user1={\oargm{options}},
description={a shortcut command that uses \csref{glsxtrresourcefile}},
+ topics={indexing,shortcutcommands},
note={\styfmt{glossaries-extra} v1.11+},
seealso={resourceoptions,glsxtrresourcefile},
category={command}
}
-@dualindexentry{glsxtrcopytoglossary,
+@mainglscommand{glsxtrcopytoglossary,
name={\csfmt{gls\-xtr\-copy\-to\-glossary}},
user1={\margm{label}\margm{type}},
description={copies the entry given by \meta{label} to the
glossary given by \meta{type}},
+ topics={assigncommands,definingterms},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@dualindexentry{glsxtrnewglslike,
+@mainglscommand{glsxtrnewglslike,
name={\csfmt{gls\-xtr\-new\-gls\-like}},
user1={\oargm{options}\margm{prefix}\margm{gls-like
cs}\margm{glspl-like cs}\margm{Gls-like
cs}\margm{Glspl-like cs}},
description={defines commands to behave like \ics{gls}, \ics{glspl},
\ics{Gls} and \ics{Glspl} with the given label prefix},
+ topics={entryrefcommands,providingcommands},
note={\styfmt{glossaries-extra} v1.21+},
seealso={glsxtrnewgls},
category={command}
}
-@dualindexentry{glsxtrnewgls,
+@mainglscommand{glsxtrnewgls,
name={\csfmt{gls\-xtr\-new\-gls}},
user1={\oargm{options}\margm{prefix}\margm{cs}},
description={defines the command \meta{cs} to behave like
\ics{gls} with the given label prefix},
+ topics={entryrefcommands,providingcommands},
note={\styfmt{glossaries-extra} v1.21+},
seealso={gls},
category={command}
}
-@dualindexentry{glsnoidxdisplayloc,
+@mainglscommand{glsnoidxdisplayloc,
name={\csfmt{gls\-no\-idx\-display\-loc}},
user1={\margm{prefix}\margm{counter}\margm{format}\margm{location}},
description={used to display a regular location in the
- \field{location} field},
+ \field{location} field (with a hyperlink, if enabled)},
+ topics={loclistcommands,linkcommands},
note={\styfmt{glossaries} v4.04+},
category={command}
}
-@dualindexentry{glsxtrdisplaylocnameref,
+@mainglscommand{glsxtrdisplaylocnameref,
name={\csfmt{gls\-xtr\-display\-loc\-name\-ref}},
user1={\margm{prefix}\margm{counter}\margm{format}\margm{location}\margm{title}\margm{href}\margm{hcounter}\margm{file}},
description={used to display a \code{nameref} location in the
- \field{location} field},
+ \field{location} field (with a hyperlink, if enabled)},
+ topics={loclistcommands,linkcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
category={command}
}
-@dualindexentry{glsxtrdisplaysupploc,
+@mainglscommand{glsxtrdisplaysupploc,
name={\csfmt{gls\-xtr\-display\-supp\-loc}},
user1={\margm{prefix}\margm{counter}\margm{format}\margm{src}\margm{location}},
description={used to display an external location in the
- supplementary list},
+ supplementary list (with a hyperlink, if enabled)},
+ topics={loclistcommands,linkcommands,supplementalrefs},
note={\styfmt{glossaries-extra-bib2gls} v1.36+},
category={command}
}
-@dualindexentry{glsxtrmultisupplocation,
+@mainglscommand{glsxtrmultisupplocation,
name={\csfmt{gls\-xtr\-multi\-supp\-location}},
user1={\margm{location}\margm{src}\margm{format}},
description={used by \csref{glsxtrdisplaysupploc} to format the
- external location},
+ external location (with a hyperlink, if enabled)},
+ topics={loclistcommands,linkcommands,formattingcommands,supplementalrefs},
note={\styfmt{glossaries-extra-bib2gls} v1.36+},
category={command}
}
-@index{glsxtrsupplocationurl,
+@glscommand{glsxtrsupplocationurl,
name={\csfmt{gls\-xtr\-supp\-loc\-a\-tion\-url}},
description={set by \cs{glsxtrsupphypernumber}
and \csref{glsxtrmultisupplocation} to the
URL of the supplemental document for use by
\cs{glshypernumber}},
+ topics={loclistcommands,supplementalrefs},
note={\styfmt{glossaries-extra} v1.14+},
seealso={glshypernumber,glsxtrsupphypernumber,glsxtrmultisupplocation,glsxtrlocationhyperlink},
category={command}
}
-@index{glsxtrlocationhyperlink,
+@glscommand{glsxtrlocationhyperlink,
name={\csfmt{gls\-xtr\-loc\-a\-tion\-hyper\-link}},
user1={\margm{counter}\margm{prefix}\margm{location}},
description={used to create the location hyperlink,
this tests if an internal or external link is required
depending on the definition of \cs{glsxtrsupplocationurl}},
+ topics={loclistcommands,linkcommands,supplementalrefs},
note={\styfmt{glossaries-extra} v1.14+},
seealso={glsxtrsupphypernumber,glsxtrsupplocationurl},
category={command}
}
-@index{glsxtrsupphypernumber,
+@glscommand{glsxtrsupphypernumber,
name={\csfmt{gls\-xtr\-supp\-hyper\-num\-ber}},
user1={\margm{location}},
description={uses \cs{glshypernumber} to create a hyperlink
to the given location (if hyperlinks are supported) but
first checks the \catattr{externallocation} attribute to determine
if an external link is required},
+ topics={loclistcommands,linkcommands,supplementalrefs},
note={\styfmt{glossaries-extra} v1.14+},
seealso={glsxtrlocationhyperlink,glsxtrsupplocationurl},
category={command}
}
-@dualindexentry{glsxtr@record,
+@mainglscommand{glsxtr@record,
name={\csfmt{glsxtr@record}},
user1={\margm{label}\margm{prefix}\margm{counter}\margm{format}\margm{location}},
description={this command is written to the \ext{aux} file each
time an entry is indexed to provide \bibgls\ with the record information},
+ topics={internalcommands,auxcommands,indexing},
note={\styfmt{glossaries-extra} v1.08+},
category={command}
}
-@dualindexentry{glsxtr@record@nameref,
+@mainglscommand{glsxtr@record@nameref,
name={\csfmt{glsxtr@record@name\-ref}},
user1={\margm{label}\margm{prefix}\margm{counter}\margm{format}\margm{location}\margm{title}\margm{href}\margm{hcounter}},
description={used instead of \csref{glsxtr@record} when the
\styopt[nameref]{record} option is used},
+ topics={internalcommands,auxcommands,indexing},
note={\styfmt{glossaries-extra} v1.37+},
category={command}
}
-@dualindexentry{glsxtrfieldlistadd,
+@mainglscommand{glsxtrfieldlistadd,
name={\csfmt{gls\-xtr\-field\-list\-add}},
user1={\margm{label}\margm{field}\margm{item}},
description={adds the given item to the given field that contains
an \styfmt{etoolbox} internal list},
+ topics={listcommands,assigncommands,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.12+},
seealso={glsxtrfieldifinlist,glsxtrfieldforlistloop,glsxtrfielddolistloop},
category={command}
}
-@index{glsxtrfieldifinlist,
+@glscommand{glsxtrfieldifinlist,
name={\csfmt{gls\-xtr\-field\-if\-in\-list}},
user1={\margm{label}\margm{field}\margm{item}\margm{true}\margm{false}},
description={tests if the given item is in the given field that contains
an \styfmt{etoolbox} internal list},
+ topics={listcommands,conditionals,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.12+},
seealso={glsxtrfieldxifinlist,glsxtrfieldlistadd,glsxtrfieldforlistloop,glsxtrfielddolistloop},
category={command}
}
-@index{glsxtrfieldxifinlist,
+@glscommand{glsxtrfieldxifinlist,
name={\csfmt{gls\-xtr\-field\-x\-if\-in\-list}},
user1={\margm{label}\margm{field}\margm{item}\margm{true}\margm{false}},
description={tests if the expansion of the given item is in the given field that contains
an \styfmt{etoolbox} internal list},
+ topics={listcommands,conditionals,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.12+},
seealso={glsxtrfieldifinlist},
category={command}
}
-@index{glsxtrcontrolrules,
+@glscommand{glsxtrcontrolrules,
name={\csfmt{gls\-xtr\-control\-rules}},
user1={},
description={collation sub-rule for control characters usually
placed at the start of a rule in the \qt{ignored characters} section
(although there typically won't be any control codes in sort fields)},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrspacerules,
+@glscommand{glsxtrspacerules,
name={\csfmt{gls\-xtr\-space\-rules}},
user1={},
description={collation sub-rule for space characters},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrnonprintablerules,
+@glscommand{glsxtrnonprintablerules,
name={\csfmt{gls\-xtr\-non\-printable\-rules}},
user1={},
description={collation sub-rule for non-printable characters},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrcombiningdiacriticrules,
+@glscommand{glsxtrcombiningdiacriticrules,
name={\csfmt{gls\-xtr\-combining\-diacritic\-rules}},
user1={},
description={collation sub-rule for combining diacritic characters},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrhyphenrules,
+@glscommand{glsxtrhyphenrules,
name={\csfmt{gls\-xtr\-hyphen\-rules}},
user1={},
description={collation sub-rule for hyphen characters},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrgeneralpuncrules,
+@glscommand{glsxtrgeneralpuncrules,
name={\csfmt{gls\-xtr\-general\-punc\-rules}},
user1={},
description={collation sub-rule for general punctuation characters},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrdigitrules,
+@glscommand{glsxtrdigitrules,
name={\csfmt{gls\-xtr\-digit\-rules}},
user1={},
description={collation sub-rule for digits from the basic Latin
set (0, \ldots, 9) as well as their subscript and superscript variants},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrfractionrules,
+@glscommand{glsxtrfractionrules,
name={\csfmt{gls\-xtr\-fraction\-rules}},
user1={},
description={collation sub-rule for vulgar fraction characters},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrMathItalicGreekIrules,
+@glscommand{glsxtrMathItalicGreekIrules,
name={\csfmt{gls\-xtr\-Math\-Italic\-Greek\-I\-rules}},
user1={},
description={collation sub-rule for math-Greek characters
(includes upright digamma between epsilon and zeta)},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrGeneralLatinIrules,
+@glscommand{glsxtrGeneralLatinIrules,
name={\csfmt{gls\-xtr\-General\-Latin\-I\-rules}},
user1={},
description={collation sub-rule for Latin characters
(basic Latin set plus subscript and superscript Latin
characters)},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
seealso={glsxtrGeneralLatinIIrules,glsxtrGeneralLatinIIIrules,glsxtrGeneralLatinIVrules,glsxtrGeneralLatinVrules,glsxtrGeneralLatinVIrules,glsxtrGeneralLatinVIIrules,glsxtrGeneralLatinVIIIrules},
category={command}
}
-@index{glsxtrGeneralLatinIIrules,
+@glscommand{glsxtrGeneralLatinIIrules,
name={\csfmt{gls\-xtr\-General\-Latin\-II\-rules}},
user1={},
description={collation sub-rule for Latin characters
(as \cs{glsxtrGeneralLatinIrules} but includes \DH/\dh\ between D/d
and E/e
and \ss\ treated as \qt{ss})},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrGeneralLatinIIIrules,
+@glscommand{glsxtrGeneralLatinIIIrules,
name={\csfmt{gls\-xtr\-General\-Latin\-III\-rules}},
user1={},
description={collation sub-rule for Latin characters
(as \cs{glsxtrGeneralLatinIrules} but includes \DH/\dh\ between D/d
and E/e
and \ss\ treated as \qt{sz})},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrGeneralLatinIVrules,
+@glscommand{glsxtrGeneralLatinIVrules,
name={\csfmt{gls\-xtr\-General\-Latin\-IV\-rules}},
user1={},
description={collation sub-rule for Latin characters
@@ -2800,132 +3572,197 @@ and \ss\ treated as \qt{sz})},
and E/e
and \AE/\ae\ treated as AE/ae, \OE/\oe\ treated
as OE/oe, \TH/\th\ treated as TH/th and \ss\ treated as \qt{ss})},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrGeneralLatinVrules,
+@glscommand{glsxtrGeneralLatinVrules,
name={\csfmt{gls\-xtr\-General\-Latin\-V\-rules}},
user1={},
description={collation sub-rule for Latin characters
(as \cs{glsxtrGeneralLatinIrules} but includes \DH/\dh\ between D/d
and E/e
and \TH/\th\ treated as TH/th and \ss\ treated as \qt{ss})},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrGeneralLatinVIrules,
+@glscommand{glsxtrGeneralLatinVIrules,
name={\csfmt{gls\-xtr\-General\-Latin\-VI\-rules}},
user1={},
description={collation sub-rule for Latin characters
(as \cs{glsxtrGeneralLatinIrules} but includes \DH/\dh\ between D/d
and E/e
and \TH/\th\ treated as TH/th and \ss\ treated as \qt{sz})},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrGeneralLatinVIIrules,
+@glscommand{glsxtrGeneralLatinVIIrules,
name={\csfmt{gls\-xtr\-General\-Latin\-VII\-rules}},
user1={},
- description={collation sub-rule for Latin characters
-(as \cs{glsxtrGeneralLatinIrules} but includes \AE/\ae\ between A/a
+ description={collation sub-rule for Latin characters:
+as \cs{glsxtrGeneralLatinIrules} but includes \AE/\ae\ between A/a
and B/b,
\DH/\dh\ between D/d and E/e, \insularG/\insularg\ (insular G) as
G/g, \OE/\oe\
between O/o and P/p, \longs\ (long S)
-equivalent to S/s, \TH/\th\ between T/t and U/u and \char"01F7/\char"01BF\
+equivalent to S/s, \TH/\th\ between T/t and U/u and \Wynn/\wynn\
(wynn) as W/w},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrGeneralLatinVIIIrules,
+@glscommand{glsxtrGeneralLatinVIIIrules,
name={\csfmt{gls\-xtr\-General\-Latin\-VIII\-rules}},
user1={},
- description={collation sub-rule for Latin characters
-(as \cs{glsxtrGeneralLatinIrules} but includes \AE/\ae\ treated as
+ description={collation sub-rule for Latin characters:
+as \cs{glsxtrGeneralLatinIrules} but includes \AE/\ae\ treated as
A/a, \OE/\oe\ treated as OE/oe, \TH/\th\ treated as TH/th, \ss\
treated as \qt{ss}, \DH/\dh\ treated as D/d, \O/\o\ treated as O/o
and \L/\l\ treated as L/l},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrLatinAA,
+@glscommand{glsxtrLatinAA,
name={\csfmt{gls\-xtr\-Latin\-AA}},
user1={},
description={collation sub-rule for \AA/\aa},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{glsxtrLatinOslash,
+@glscommand{glsxtrLatinOslash,
name={\csfmt{gls\-xtr\-Latin\-O\-slash}},
user1={},
description={collation sub-rule for \O/\o},
+ topics={collationsubrules},
note={\styfmt{glossaries-extra-bib2gls} v1.27+},
category={command}
}
-@index{alpha,
+@command{alpha,
name={\csfmt{alpha}},
user1={},
description={Greek letter alpha $\alpha$},
- note={kernel command (maths mode)},
+ note={kernel command\texparserdefnote\ (maths mode)},
category={command}
}
-@index{pi,
+@command{pi,
name={\csfmt{pi}},
user1={},
description={Greek letter pi $\pi$},
- note={kernel command (maths mode)},
+ note={kernel command\texparserdefnote\ (maths mode)},
+ category={command}
+}
+
+@command{sigma,
+ name={\csfmt{sigma}},
+ user1={},
+ description={Greek letter sigma $\sigma$},
+ note={kernel command\texparserdefnote\ (maths mode)},
category={command}
}
-@index{omicron,
+@glscommand{omicron,
name={\csfmt{omicron}},
user1={},
description={Greek letter omicron $\omicron$},
- note={\styfmt{glossaries-extra-bib2gls}},
+ topics={charcommands},
+ note={\styfmt{glossaries-extra-bib2gls}\texparserdefnote},
category={command}
}
-@index{Alpha,
+@glscommand{Alpha,
name={\csfmt{Alpha}},
user1={},
description={Greek letter alpha $\Alpha$},
- note={\styfmt{glossaries-extra-bib2gls}},
+ topics={charcommands},
+ note={\styfmt{glossaries-extra-bib2gls}\texparserdefnote},
category={command}
}
-@index{approx,
+@command{approx,
name={\csfmt{approx}},
user1={},
description={approximate symbol $\approx$},
- note={kernel command (maths mode)},
+ note={kernel command\texparserdefnote\ (maths mode)},
category={command}
}
-@index{surd,
+@command{surd,
name={\csfmt{surd}},
user1={},
description={surd symbol $\surd$},
- note={kernel command (maths mode)},
+ note={kernel command\texparserdefnote\ (maths mode)},
category={command}
}
-@index{triangleright,
+@command{triangleright,
name={\csfmt{triangle\-right}},
user1={},
description={right-pointing triangle $\triangleright$},
- note={kernel command (maths mode)},
+ note={kernel command\texparserdefnote\ (maths mode)},
+ category={command}
+}
+
+@command{vert,
+ name={\csfmt{vert}},
+ user1={},
+ description={vertical bar delimiter $\vert$},
+ note={kernel command\texparserdefnote\ (maths mode)},
+ category={command}
+}
+
+@command{Vert,
+ name={\csfmt{Vert}},
+ user1={},
+ description={double vertical bar delimiter $\Vert$},
+ note={kernel command\texparserdefnote\ (maths mode)},
+ category={command}
+}
+
+@command{lvert,
+ name={\csfmt{lvert}},
+ user1={},
+ description={left vertical bar delimiter $\lvert$},
+ note={\styfmt{amsmath}\texparserdefnote\ (maths mode)},
+ category={command}
+}
+
+@command{rvert,
+ name={\csfmt{rvert}},
+ user1={},
+ description={right vertical bar delimiter $\rvert$},
+ note={\styfmt{amsmath}\texparserdefnote\ (maths mode)},
category={command}
}
-@index{textstyle,
+@command{lVert,
+ name={\csfmt{lVert}},
+ user1={},
+ description={left double vertical bar delimiter $\lVert$},
+ note={\styfmt{amsmath}\texparserdefnote\ (maths mode)},
+ category={command}
+}
+
+@command{rVert,
+ name={\csfmt{rVert}},
+ user1={},
+ description={right double vertical bar delimiter $\rVert$},
+ note={\styfmt{amsmath}\texparserdefnote\ (maths mode)},
+ category={command}
+}
+
+@command{textstyle,
name={\csfmt{text\-style}},
user1={},
description={switch to in-line maths style (vertically compact)},
@@ -2933,7 +3770,7 @@ and \L/\l\ treated as L/l},
category={command}
}
-@index{displaystyle,
+@command{displaystyle,
name={\csfmt{display\-style}},
user1={},
description={switch to display maths style},
@@ -2941,133 +3778,133 @@ and \L/\l\ treated as L/l},
category={command}
}
-@dualindexentry{bigoperatornamefmt,
+@examplecommand{bigoperatornamefmt,
name={\csfmt{big\-operator\-name\-fmt}},
user1={\margm{text}},
description={example command},
category={command}
}
-@dualindexentry{nary,
+@examplecommand{nary,
name={\csfmt{nary}},
user1={\margm{text}},
description={example command},
category={command}
}
-@dualindexentry{strong,
+@examplecommand{strong,
name={\csfmt{strong}},
user1={\margm{text}},
description={example command},
category={command}
}
-@dualindexentry{parenswap,
+@examplecommand{parenswap,
name={\csfmt{parenswap}},
user1={\margm{text1}\margm{text2}},
description={example command},
category={command}
}
-@dualindexentry{sortop,
+@examplecommand{sortop,
name={\csfmt{sortop}},
user1={\margm{text1}\margm{text2}},
description={example command},
category={command}
}
-@dualindexentry{sortname,
+@examplecommand{sortname,
name={\csfmt{sortname}},
user1={\margm{first name(s)}\margm{surname}},
description={example command},
category={command}
}
-@dualindexentry{sortvonname,
+@examplecommand{sortvonname,
name={\csfmt{sort\-von\-name}},
user1={\margm{first name(s)}\margm{von}\margm{surname}},
description={example command},
category={command}
}
-@dualindexentry{sortart,
+@examplecommand{sortart,
name={\csfmt{sortart}},
user1={\margm{article}\margm{text}},
description={example command},
category={command}
}
-@dualindexentry{sortmediacreator,
+@examplecommand{sortmediacreator,
name={\csfmt{sort\-media\-creator}},
user1={\margm{first name(s)}\margm{surname}},
description={example command},
category={command}
}
-@dualindexentry{setfmt,
+@examplecommand{setfmt,
name={\csfmt{setfmt}},
user1={\margm{symbol}},
description={example command},
category={command}
}
-@dualindexentry{setcontentsfmt,
+@examplecommand{setcontentsfmt,
name={\csfmt{setcontentsfmt}},
user1={\margm{contents}},
description={example command},
category={command}
}
-@dualindexentry{setmembershipfmt,
+@examplecommand{setmembershipfmt,
name={\csfmt{setmembershipfmt}},
user1={\margm{variable(s)}\margm{condition}},
description={example command},
category={command}
}
-@dualindexentry{setmembershiponeargfmt,
+@examplecommand{setmembershiponeargfmt,
name={\csfmt{setmembershiponeargfmt}},
user1={\marg{\margm{variable(s)}\margm{condition}}},
description={example command},
category={command}
}
-@dualindexentry{setcardfmt,
+@examplecommand{setcardfmt,
name={\csfmt{setcardfmt}},
user1={\margm{maths}},
description={example command},
category={command}
}
-@dualindexentry{numspacefmt,
+@examplecommand{numspacefmt,
name={\csfmt{numspacefmt}},
user1={\margm{symbol}},
description={example command},
category={command}
}
-@dualindexentry{transposefmt,
+@examplecommand{transposefmt,
name={\csfmt{transposefmt}},
user1={\margm{maths}},
description={example command},
category={command}
}
-@dualindexentry{invfmt,
+@examplecommand{invfmt,
name={\csfmt{invfmt}},
user1={\margm{maths}},
description={example command},
category={command}
}
-@dualindexentry{vecfmt,
+@examplecommand{vecfmt,
name={\csfmt{vecfmt}},
user1={\margm{symbol}},
description={example command},
category={command}
}
-@dualindexentry{mtxfmt,
+@examplecommand{mtxfmt,
name={\csfmt{mtxfmt}},
user1={\margm{symbol}},
description={example command},
@@ -3079,79 +3916,79 @@ and \L/\l\ treated as L/l},
text={file format}
}
-@index{ext.tex,
+@fileformat{ext.tex,
name={\extfmt{tex}},
category={fileformat},
parent={fileformats}
}
-@index{ext.bib,
+@fileformat{ext.bib,
name={\extfmt{bib}},
category={fileformat},
parent={fileformats}
}
-@index{ext.aux,
+@fileformat{ext.aux,
name={\extfmt{aux}},
category={fileformat},
parent={fileformats}
}
-@index{ext.out,
+@fileformat{ext.out,
name={\extfmt{out}},
category={fileformat},
parent={fileformats}
}
-@index{ext.sh,
+@fileformat{ext.sh,
name={\extfmt{sh}},
category={fileformat},
parent={fileformats}
}
-@index{ext.bat,
+@fileformat{ext.bat,
name={\extfmt{bat}},
category={fileformat},
parent={fileformats}
}
-@index{ext.jar,
+@fileformat{ext.jar,
name={\extfmt{jar}},
category={fileformat},
parent={fileformats}
}
-@index{ext.glg,
+@fileformat{ext.glg,
name={\extfmt{glg}},
category={fileformat},
parent={fileformats}
}
-@index{ext.log,
+@fileformat{ext.log,
name={\extfmt{log}},
category={fileformat},
parent={fileformats}
}
-@index{ext.toc,
+@fileformat{ext.toc,
name={\extfmt{toc}},
category={fileformat},
parent={fileformats}
}
-@index{ext.glstex,
+@fileformat{ext.glstex,
name={\extfmt{glstex}},
category={fileformat},
parent={fileformats}
}
-@index{ext.gls,
+@fileformat{ext.gls,
name={\extfmt{gls}},
category={fileformat},
parent={fileformats}
}
-@index{ext.bbl,
+@fileformat{ext.bbl,
name={\extfmt{bbl}},
category={fileformat},
parent={fileformats}
@@ -3162,55 +3999,55 @@ and \L/\l\ treated as L/l},
text={applications}
}
-@index{bibtex,
+@application{bibtex,
name={\appfmt{bibtex}},
category={application},
parent={applications}
}
-@index{biber,
+@application{biber,
name={\appfmt{biber}},
category={application},
parent={applications}
}
-@index{makeindex,
+@application{makeindex,
name={\appfmt{make\-index}},
category={application},
parent={applications}
}
-@index{xindy,
+@application{xindy,
name={\appfmt{xindy}},
category={application},
parent={applications}
}
-@index{makeglossaries,
+@application{makeglossaries,
name={\appfmt{make\-glos\-saries}},
category={application},
parent={applications}
}
-@index{makeglossaries-lite,
+@application{makeglossaries-lite,
name={\appfmt{make\-glos\-saries\dhyphen lite}},
category={application},
parent={applications}
}
-@index{kpsewhich,
+@application{kpsewhich,
name={\appfmt{kpsewhich}},
category={application},
parent={applications}
}
-@index{arara,
+@application{arara,
name={\appfmt{arara}},
category={application},
parent={applications}
}
-@index{convertgls2bib,
+@application{convertgls2bib,
name={\appfmt{convert\-gls2bib}},
category={application},
parent={applications}
@@ -3221,634 +4058,663 @@ and \L/\l\ treated as L/l},
text={package}
}
-@index{glossaries,
+@package{glossaries,
name={\styfmt{glossaries}},
category={package},
parent={packages}
}
-@index{glossaries-extra,
+@package{glossaries-extra,
name={\styfmt{glossaries-extra}},
category={package},
parent={packages}
}
-@index{pifont,
+@package{pifont,
name={\styfmt{pifont}},
category={package},
parent={packages}
}
-@index{upgreek,
+@package{upgreek,
name={\styfmt{upgreek}},
category={package},
parent={packages}
}
-@index{xspace,
+@package{xspace,
name={\styfmt{xspace}},
category={package},
parent={packages}
}
-@index{fourier,
+@package{fourier,
name={\styfmt{fourier}},
category={package},
parent={packages}
}
-@index{lipsum,
+@package{lipsum,
name={\styfmt{lipsum}},
category={package},
parent={packages}
}
-@index{natbib,
+@package{natbib,
name={\styfmt{natbib}},
category={package},
parent={packages}
}
-@index{textcomp,
+@package{textcomp,
name={\styfmt{textcomp}},
category={package},
parent={packages}
}
-@index{MnSymbol,
+@package{MnSymbol,
name={\styfmt{MnSymbol}},
category={package},
parent={packages}
}
-@index{wasysym,
+@package{wasysym,
name={\styfmt{wasysym}},
category={package},
parent={packages}
}
-@index{amssymb,
+@package{amssymb,
name={\styfmt{amssymb}},
category={package},
parent={packages}
}
-@index{stix,
+@package{stix,
name={\styfmt{stix}},
category={package},
parent={packages}
}
-@index{mhchem,
+@package{mhchem,
name={\styfmt{mhchem}},
category={package},
parent={packages}
}
-@index{bpchem,
+@package{bpchem,
name={\styfmt{bpchem}},
category={package},
parent={packages}
}
-@index{siunitx,
+@package{siunitx,
name={\styfmt{siunitx}},
category={package},
parent={packages}
}
-@index{tipa,
+@package{tipa,
name={\styfmt{tipa}},
category={package},
parent={packages}
}
-@index{mfirstuc,
+@package{mfirstuc,
name={\styfmt{mfirstuc}},
category={package},
parent={packages}
}
-@index{mfirstuc-english,
+@package{mfirstuc-english,
name={\styfmt{mfirstuc-english}},
category={package},
parent={packages}
}
-@index{hyperref,
+@package{hyperref,
name={\styfmt{hyperref}},
category={package},
parent={packages}
}
-@index{glossary-hypernav,
+@package{glossary-hypernav,
name={\styfmt{glossary\dhyphen hypernav}},
category={package},
parent={packages}
}
-@index{glossaries-prefix,
+@package{glossaries-prefix,
name={\styfmt{glossaries\dhyphen prefix}},
category={package},
parent={packages}
}
-@index{glossaries-accsupp,
+@package{glossaries-accsupp,
name={\styfmt{glossaries\dhyphen accsupp}},
category={package},
parent={packages}
}
-@index{glossaries-extra-stylemods,
+@package{glossaries-extra-stylemods,
name={\styfmt{glossaries\dhyphen extra\dhyphen stylemods}},
category={package},
parent={packages}
}
-@index{glossaries-extra-bib2gls,
+@package{glossaries-extra-bib2gls,
name={\styfmt{glossaries\dhyphen extra\dhyphen bib2gls}},
category={package},
parent={packages}
}
-@index{glossary-list,
+@package{glossary-list,
name={\styfmt{glossary\dhyphen list}},
category={package},
parent={packages}
}
-@index{glossary-tree,
+@package{glossary-tree,
name={\styfmt{glossary\dhyphen tree}},
category={package},
parent={packages}
}
-@index{glossary-mcols,
+@package{glossary-topic,
+ name={\styfmt{glossary\dhyphen topic}},
+ category={package},
+ parent={packages}
+}
+
+@package{glossary-mcols,
name={\styfmt{glossary\dhyphen mcols}},
category={package},
parent={packages}
}
-@index{glossary-long,
+@package{glossary-long,
name={\styfmt{glossary\dhyphen long}},
category={package},
parent={packages}
}
-@index{glossary-longbooktabs,
+@package{glossary-super,
+ name={\styfmt{glossary\dhyphen super}},
+ category={package},
+ parent={packages}
+}
+
+@package{glossary-longbooktabs,
name={\styfmt{glossary\dhyphen longbooktabs}},
category={package},
parent={packages}
}
-@index{glossary-bookindex,
+@package{glossary-bookindex,
name={\styfmt{glossary\dhyphen bookindex}},
category={package},
parent={packages}
}
-@index{glossary-longextra,
+@package{glossary-longextra,
name={\styfmt{glossary\dhyphen longextra}},
category={package},
parent={packages}
}
-@index{booktabs,
+@package{booktabs,
name={\styfmt{booktabs}},
category={package},
parent={packages}
}
-@index{color,
+@package{color,
name={\styfmt{color}},
category={package},
parent={packages}
}
-@index{graphics,
+@package{graphics,
name={\styfmt{graphics}},
category={package},
parent={packages}
}
-@index{graphicx,
+@package{graphicx,
name={\styfmt{graphicx}},
category={package},
parent={packages}
}
-@index{ifthen,
+@package{ifthen,
name={\styfmt{ifthen}},
category={package},
parent={packages}
}
-@index{probsoln,
+@package{probsoln,
name={\styfmt{probsoln}},
category={package},
parent={packages}
}
-@index{shortvrb,
+@package{shortvrb,
name={\styfmt{shortvrb}},
category={package},
parent={packages}
}
-@index{jmlrutils,
+@package{jmlrutils,
name={\styfmt{jmlrutils}},
category={package},
parent={packages}
}
-@index{inputenc,
+@package{inputenc,
name={\styfmt{inputenc}},
category={package},
parent={packages}
}
-@index{fontenc,
+@package{fontenc,
name={\styfmt{fontenc}},
category={package},
parent={packages}
}
-@index{slantsc,
+@package{slantsc,
name={\styfmt{slantsc}},
category={package},
parent={packages}
}
-@index{babel,
+@package{relsize,
+ name={\styfmt{relsize}},
+ category={package},
+ parent={packages}
+}
+
+@package{babel,
name={\styfmt{babel}},
category={package},
parent={packages}
}
-@index{polyglossia,
+@package{polyglossia,
name={\styfmt{polyglossia}},
category={package},
parent={packages}
}
-@index{fontspec,
+@package{fontspec,
name={\styfmt{fontspec}},
category={package},
parent={packages}
}
-@index{amsmath,
+@package{amsmath,
name={\styfmt{amsmath}},
category={package},
parent={packages}
}
-@index{textcase,
+@package{textcase,
name={\styfmt{textcase}},
category={package},
parent={packages}
}
-@index{datetime2,
+@package{datetime2,
name={\styfmt{datetime2}},
category={package},
parent={packages}
}
-@index{datatool-base,
+@package{datatool-base,
name={\styfmt{datatool\dhyphen base}},
category={package},
parent={packages}
}
-@index{datatool,
+@package{datatool,
name={\styfmt{datatool}},
category={package},
parent={packages}
}
-@index{etoolbox,
+@package{etoolbox,
name={\styfmt{etoolbox}},
category={package},
parent={packages}
}
-@index{soul,
+@package{soul,
name={\styfmt{soul}},
category={package},
parent={packages}
}
-@index{xcolor,
+@package{xcolor,
name={\styfmt{xcolor}},
category={package},
parent={packages}
}
-@index{tracklang,
+@package{tracklang,
name={\styfmt{tracklang}},
category={package},
parent={packages}
}
-@index{accsupp,
+@package{accsupp,
name={\styfmt{accsupp}},
category={package},
parent={packages}
}
-@index{stringconcat,
+@symbol{stringconcat,
name={\code{\#} (string concatenation)},
text={\code{\#}}
}
-@index{atchar,
+@symbol{atchar,
name={\code{@} (bib entry identifier)},
text={\code{@}}
}
-@index{param,
+@specialchar{param,
name={\code{\#} (parameter)},
text={\code{\#}}
}
-@index{hashchar,
+@symbol{hashchar,
name={\code{\#} (literal)},
text={\code{\#}}
}
-@index{cs.hash,
+@command{cs.hash,
name={\csfmt{\#}},
description={produces the hash symbol \#},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{colsep,
+@specialchar{colsep,
name={\code{\&} (alignment)},
text={\code{\&}}
}
-@index{ampchar,
+@symbol{ampchar,
name={\code{\&} (literal)},
text={\code{\&}}
}
-@index{cs.amp,
+@command{cs.amp,
name={\csfmt{\&}},
description={produces the ampersand symbol \&},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{bgroupchar,
- name={\code{\{} (begin group)},
- text={\code{\{}}
+@specialchar{bgroupchar,
+ name={\code{\glsopenbrace} (begin group)},
+ text={\code{\glsopenbrace}}
}
-@index{openbracechar,
- name={\code{\{} (literal)},
- text={\code{\{}}
+@symbol{openbracechar,
+ name={\code{\glsopenbrace} (literal)},
+ text={\code{\glsopenbrace}}
}
-@index{cs.openbrace,
- name={\csfmt{\{}},
- description={produces the open brace symbol \{},
- note={kernel command},
+@command{cs.openbrace,
+ name={\csfmt{\glsopenbrace}},
+ description={produces the open brace symbol \glsopenbrace},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{egroupchar,
- name={\code{\}} (end group)},
- text={\code{\}}}
+@specialchar{egroupchar,
+ name={\code{\glsclosebrace} (end group)},
+ text={\code{\glsclosebrace}}
}
-@index{closebracechar,
- name={\code{\}} (literal)},
- text={\code{\}}}
+@symbol{closebracechar,
+ name={\code{\glsclosebrace} (literal)},
+ text={\code{\glsclosebrace}}
}
-@index{cs.closebrace,
- name={\csfmt{\}}},
- description={produces the close brace symbol \}},
- note={kernel command},
+@command{cs.closebrace,
+ name={\csfmt{\glsclosebrace}},
+ description={produces the close brace symbol \glsclosebrace},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{commentchar,
+@specialchar{commentchar,
name={\code{\%} (comment)},
text={\code{\%}}
}
-@index{percentchar,
+@symbol{percentchar,
name={\code{\%} (literal)},
text={\code{\%}}
}
-@index{cs.percent,
+@command{cs.percent,
name={\csfmt{\%}},
description={produces the percent symbol \%},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{sbchar,
+@specialchar{sbchar,
name={\code{\_} (subscript)},
text={\code{\_}}
}
-@index{underscorechar,
+@symbol{underscorechar,
name={\code{\_} (literal)},
text={\code{\_}}
}
-@index{cs.underscore,
+@command{cs.underscore,
name={\csfmt{\_}},
description={produces the underscore symbol \_},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{spchar,
+@specialchar{spchar,
name={\code{\char`\^} (superscript)},
text={\code{\char`\^}}
}
-@index{circumchar,
+@symbol{circumchar,
name={\code{\char`\^} (literal)},
text={\code{\char`\^}}
}
-@index{cs.circum,
+@command{cs.circum,
name={\csfmt{\char`\^}},
user1={\margm{character}},
description={puts a circumflex accent over \meta{character}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{mshiftchar,
+@specialchar{mshiftchar,
name={\code{\$} (maths shift)},
text={\code{\$}}
}
-@index{dollarchar,
+@symbol{dollarchar,
name={\code{\$} (literal)},
text={\code{\$}}
}
-@index{cs.dollar,
+@command{cs.dollar,
name={\csfmt{\$}},
- description={produces the dollar symbol \_},
- note={kernel command},
+ description={produces the dollar symbol \$},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{escchar,
+@specialchar{escchar,
name={\code{\glsbackslash} (escape)},
text={\code{\glsbackslash}}
}
-@index{backslashchar,
+@symbol{backslashchar,
name={\code{\glsbackslash} (literal)},
text={\code{\glsbackslash}}
}
-@index{cs.backslash,
- name={\csfmt{\glsbackslash}}
+@command{cs.backslash,
+ name={\csfmt{\glsbackslash}},
+ user1={\oargm{len}},
+ description={starts a new row in a tabular or array context
+with an extra vertical space of length \meta{len} above it
+(starred form prohibits a page break)},
+ note={kernel command\texparserdefnote},
+ category={command}
}
-@index{tabularnewline,
+@command{tabularnewline,
name={\csfmt{tabular\-new\-line}},
+ user1={\oargm{len}},
description={tabular version of \idx{cs.backslash} (avoids conflict
with forced line breaks in paragraph column formats)},
note={kernel command},
category={command}
}
-@index{nbspchar,
+@specialchar{nbspchar,
name={\code{\glstildechar} (non-breakable space)},
text={\code{\glstildechar}}
}
-@index{tildechar,
+@symbol{tildechar,
name={\code{\glstildechar} (literal)},
text={\code{\glstildechar}}
}
-@index{doublequotechardelim,
+@symbol{doublequotechardelim,
name = {\code{"} (delimiter)},
text = {\code{"}}
}
-@index{doublequotecharhex,
+@symbol{doublequotecharhex,
name = {\code{"} (hexadecimal identifier)},
text = {\code{"}}
}
-@index{doublequoteactivechar,
+@specialchar{doublequoteactivechar,
name = {\code{"} (active)},
text = {\code{"}}
}
-@index{doublequotechar,
+@symbol{doublequotechar,
name = {\code{"} (literal)},
text = {\code{"}}
}
-@index{openrange,
- name = {\code{(} (start range)},
- text = {\code{(}}
+@symbol{openrange,
+ name = {\code{\rangestartmark} (start range)},
+ text = {\code{\rangestartmark}}
}
-@index{closerange,
- name = {\code{)} (end range)},
- text = {\code{)}}
+@symbol{closerange,
+ name = {\code{\rangeendmark} (end range)},
+ text = {\code{\rangeendmark}}
}
-@index{cs.tilde,
+@command{cs.tilde,
name={\csfmt{\glstildechar}},
user1={\margm{character}},
description={puts tilde accent over \meta{character}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{comma,
+@command{comma,
name={\csfmt{,}},
description={thin space},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{vec,
+@command{vec,
name={\csfmt{vec}},
user1={\margm{character}},
description={puts right arrow accent over \meta{character}},
- note={kernel command (maths mode)},
+ note={kernel command\texparserdefnote\ (maths mode)},
category={command}
}
-@index{zeroormore,
+@symbol{zeroormore,
name={\code{*} (regular expression, zero or more)},
text={\code{*}}
}
-@index{matchanydot,
+@symbol{matchanydot,
name={\code{.}\ (regular expression, match any)},
text={\code{.}}
}
-@index{periodchar,
+@symbol{periodchar,
name={\code{.}\ (end of sentence)},
text={\code{.}},
alias={full-stop}
}
-@index{cs.period,
- name={\csfmt{.}}
+@command{cs.period,
+ name={\csfmt{.}},
+ user1={\margm{character}},
+ description={puts a dot accent over \meta{character}},
+ note={kernel command\texparserdefnote},
+ category={command}
}
-@index{cs.space,
+@command{cs.space,
name={\csfmt{\textvisiblespace}},
description={produces an inter-word space},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{space,
+@command{space,
name={\csfmt{space}},
description={produces a space},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{aposchar,
+@symbol{aposchar,
name={\code{'} (apostrophe)},
text={\code{'}},
alias={apostrophe}
}
-@index{def,
+@command{def,
name={\csfmt{def}},
user1={\margm{cs}\meta{syntax}\margm{definition}},
description={defines the control sequence \meta{cs}, without checking if the command
already exists},
- note={\TeX\ primitive},
+ note={\TeX\ primitive\texparserdefnote},
category={command}
}
-@index{edef,
+@command{edef,
name={\csfmt{edef}},
user1={\margm{cs}\meta{syntax}\margm{definition}},
description={defines the control sequence \meta{cs} to the full
expansion of \meta{definition}, without checking if the command
already exists},
- note={\TeX\ primitive},
+ note={\TeX\ primitive\texparserdefnote},
category={command}
}
-@index{ifstrempty,
+@command{ifstrempty,
name={\csfmt{if\-str\-empty}},
user1={\margm{string}\margm{true}\margm{false}},
description={tests if \meta{string} is empty},
@@ -3856,7 +4722,7 @@ expansion of \meta{definition}, without checking if the command
category={command}
}
-@index{ifstrequal,
+@command{ifstrequal,
name={\csfmt{if\-str\-equal}},
user1={\margm{string1}\margm{string2}\margm{true}\margm{false}},
description={tests if \meta{string1} equals \meta{string2}},
@@ -3864,35 +4730,63 @@ expansion of \meta{definition}, without checking if the command
category={command}
}
-@index{undef,
+@command{ifcsstring,
+ name={\csfmt{if\-cs\-string}},
+ user1={\margm{cs-name}\margm{string}\margm{true}\margm{false}},
+ description={tests if the replacement text of the command
+ given by the control sequence name \meta{cs-name} equals \meta{string}},
+ note={\styfmt{etoolbox}},
+ category={command}
+}
+
+@command{ifdefstrequal,
+ name={\csfmt{if\-def\-str\-equal}},
+ user1={\margm{cs1}\margm{cs2}\margm{true}\margm{false}},
+ description={tests if the replacement text of the command
+ \meta{cs1} equals the replacement text of the command \meta{cs2}},
+ note={\styfmt{etoolbox}},
+ category={command}
+}
+
+@command{ifcsstrequal,
+ name={\csfmt{if\-cs\-str\-equal}},
+ user1={\margm{cs-name1}\margm{cs-name2}\margm{true}\margm{false}},
+ description={tests if the replacement text of the command given by
+ the control sequence name \meta{cs-name1} equals the replacement text
+ of the command given by the control sequence name \meta{cs-name2}},
+ note={\styfmt{etoolbox}},
+ category={command}
+}
+
+@command{undef,
name={\csfmt{undef}},
user1={\meta{cs}},
description={undefines the control sequence \meta{cs}},
- note={\styfmt{etoolbox}},
+ note={\styfmt{etoolbox}\texparserdefnote},
category={command}
}
-@index{csdef,
+@command{csdef,
name={\csfmt{csdef}},
user1={\margm{cs-name}\meta{syntax}\margm{definition}},
description={defines the control sequence whose name
is given by \meta{cs-name}, without checking if the command
already exists},
- note={\styfmt{etoolbox}},
+ note={\styfmt{etoolbox}\texparserdefnote},
category={command}
}
-@index{csuse,
+@command{csuse,
name={\csfmt{csuse}},
user1={\margm{cs-name}},
description={uses the control sequence whose name
is given by \meta{cs-name} or does nothing if the command
isn't defined},
- note={\styfmt{etoolbox}},
+ note={\styfmt{etoolbox}\texparserdefnote},
category={command}
}
-@index{newrobustcmd,
+@command{newrobustcmd,
name={\csfmt{new\-robust\-cmd}},
user1={\margm{cs}\oargm{n}\oargm{def}\margm{code}},
description={behaves like \cs{newcommand} but the newly defined
@@ -3901,15 +4795,15 @@ command will be robust},
category={command}
}
-@index{ifdefempty,
+@command{ifdefempty,
name={\csfmt{if\-def\-empty}},
user1={\margm{cs}\margm{true}\margm{false}},
description={tests if the control sequence \meta{cs} is empty},
- note={\styfmt{etoolbox}},
+ note={\styfmt{etoolbox}\texparserdefnote},
category={command}
}
-@index{ifcsundef,
+@command{ifcsundef,
name={\csfmt{if\-cs\-un\-def}},
user1={\margm{cs-name}\margm{true}\margm{false}},
description={tests if the control sequence given by \meta{cs-name}
@@ -3918,7 +4812,7 @@ is undefined},
category={command}
}
-@index{ifcsdef,
+@command{ifcsdef,
name={\csfmt{if\-cs\-def}},
user1={\margm{cs-name}\margm{true}\margm{false}},
description={tests if the control sequence given by \meta{cs-name}
@@ -3927,15 +4821,15 @@ is defined},
category={command}
}
-@index{ifdef,
+@command{ifdef,
name={\csfmt{if\-def}},
user1={\margm{cs}\margm{true}\margm{false}},
description={tests if the control sequence \meta{cs} is defined},
- note={\styfmt{etoolbox}},
+ note={\styfmt{etoolbox}\texparserdefnote},
category={command}
}
-@index{xifinlist,
+@command{xifinlist,
name={\csfmt{xifinlist}},
user1={\margm{element}\margm{list cs}\margm{true}\margm{false}},
description={tests if the expansion of \meta{element} is in the list stored
@@ -3944,7 +4838,7 @@ is defined},
category={command}
}
-@index{ifinlist,
+@command{ifinlist,
name={\csfmt{ifinlist}},
user1={\margm{element}\margm{list cs}\margm{true}\margm{false}},
description={tests if \meta{element} is in the list stored
@@ -3953,7 +4847,7 @@ is defined},
category={command}
}
-@index{listxadd,
+@command{listxadd,
name={\csfmt{listxadd}},
user1={\margm{list cs}\margm{element}},
description={globally adds (expanded) \meta{element} to the list stored
@@ -3962,7 +4856,7 @@ is defined},
category={command}
}
-@index{listgadd,
+@command{listgadd,
name={\csfmt{listgadd}},
user1={\margm{list cs}\margm{element}},
description={globally adds \meta{element} to the list stored
@@ -3971,16 +4865,16 @@ is defined},
category={command}
}
-@index{appto,
+@command{appto,
name={\csfmt{appto}},
user1={\margm{cs}\margm{code}},
description={appends \meta{code} to the definition of
the control sequence \meta{cs}},
- note={\styfmt{etoolbox}},
+ note={\styfmt{etoolbox}\texparserdefnote},
category={command}
}
-@index{forlistloop,
+@command{forlistloop,
name={\csfmt{for\-list\-loop}},
user1={\margm{handler cs}\margm{list cs}},
description={iterates over the internal list given by the command
@@ -3990,7 +4884,7 @@ is defined},
category={command}
}
-@index{foreignlanguage,
+@command{foreignlanguage,
name={\csfmt{foreign\-language}},
user1={\margm{language name}\margm{text}},
description={typesets \meta{text} according to the rules of the
@@ -3999,7 +4893,7 @@ given language},
category={command}
}
-@index{selectlanguage,
+@command{selectlanguage,
name={\csfmt{select\-language}},
user1={\margm{language name}},
description={switch to the rules of the given language},
@@ -4007,7 +4901,7 @@ given language},
category={command}
}
-@index{setmainlanguage,
+@command{setmainlanguage,
name={\csfmt{set\-main\-language}},
user1={\oargm{options}\margm{language name}},
description={load the main document language},
@@ -4015,7 +4909,7 @@ given language},
category={command}
}
-@index{setotherlanguage,
+@command{setotherlanguage,
name={\csfmt{set\-other\-language}},
user1={\oargm{options}\margm{language name}},
description={load a secondary document language},
@@ -4023,7 +4917,7 @@ given language},
category={command}
}
-@index{textlanguage,
+@command{textlanguage,
name={\csfmt{text\-\meta{language}}},
user1={\oargm{options}\margm{text}},
description={typeset \meta{text} according to \meta{language}},
@@ -4031,51 +4925,79 @@ given language},
category={command}
}
-@index{marvosym,
+@package{marvosym,
name={\styfmt{marvosym}},
category={package},
parent={packages}
}
-@index{ifsym,
+@package{ifsym,
name={\styfmt{ifsym}},
category={package},
parent={packages}
}
-@index{CJKutf8,
+@package{CJKutf8,
name={\styfmt{CJKutf8}},
category={package},
parent={packages}
}
-@index{env.CJK,
+@environment{env.CJK,
name={\envfmt{CJK}},
+ user1={\oargm{font encoding}\margm{encoding}\margm{family}},
+ description={sets up support for \idx{CJK} content},
+ note={\styfmt{CJK}},
category={environment}
}
-@index{env.description,
+@environment{env.description,
name={\envfmt{description}},
+ description={list-like environment},
+ note={provided by most classes},
category={environment}
}
-@index{longtable,
+@package{longtable,
name={\styfmt{longtable}},
category={package},
parent={packages}
}
-@index{env.longtable,
+@environment{env.longtable,
name={\envfmt{longtable}},
+ user1={\oargm{halign}\margm{column specs}},
+ description={a tabular-like environment that can span multiple
+pages (not available in multi-column or certain other contexts)},
+ note={\styfmt{longtable}},
category={environment}
}
-@index{env.tabular,
+@environment{env.tabular,
name={\envfmt{tabular}},
+ user1={\oargm{valign}\margm{column specs}},
+ description={aligns material in rows and columns with \idx{colsep}
+to separate columns and \cs{cs.backslash} to separate rows},
+ note={kernel environment},
category={environment}
}
-@index{supertabular,
+@package{tabularx,
+ name={\styfmt{tabularx}},
+ category={package},
+ parent={packages}
+}
+
+@environment{env.tabularx,
+ name={\envfmt{tabularx}},
+ user1={\margm{width}\oargm{valign}\margm{column specs}},
+ description={a tabular-like environment that's designed to fit the
+ given \meta{width})},
+ note={\styfmt{tabularx}},
+ category={environment}
+}
+
+@package{supertabular,
name={\styfmt{supertabular}},
category={package},
parent={packages}
@@ -4083,232 +5005,1824 @@ given language},
@index{env.supertabular,
name={\envfmt{supertabular}},
+ user1={\margm{column specs}},
+ description={a tabular-like environment that can span multiple
+pages (not available in multi-column or certain other contexts)},
+ note={\styfmt{supertabular}},
category={environment}
}
-@index{env.theglossary,
+@glsenvironment{env.theglossary,
name={\envfmt{theglossary}},
category={environment}
}
-@index{abbreviationstyles,
+@topic{abbreviationstyles,
name={abbreviation styles},
- text={abbreviation style}
+ text={abbreviation style},
+ description={abbreviation styles are set using
+ \ics{newabbreviation} and govern the format of commands like \ics{gls}
+ (display style) and \ics{glsxtrfull} (inline style). The inline
+ style may or may not match the first use format of the display
+ style. To allow for greater flexibility in abbreviation styles,
+ \cs{gls} (and its variants) normally treat abbreviations
+ differently to other terms, but some abbreviation styles can work better
+ if the abbreviation is treated as a general term so in those cases the
+ style sets the \catattr{regular} attribute to \qt{true} for
+ the entry's category. The \styfmt{glossaries-extra} package comes with the file
+\href{http://mirrors.ctan.org/macros/latex/contrib/glossaries-extra/samples/sample-abbr-styles.pdf}{\filefmt{sample-abbr-styles.pdf}}
+ that demonstrates all predefined styles}
+}
+
+@abbreviationstyle{abbrstyle.long-short,
+ name={\abbrstylefmt{long\dhyphen short}},
+ description={this abbreviation style displays the long form on
+ \idx{firstuse} of the \cs{gls}-like commands followed by the
+ short form in parentheses (formatted with \cs{glsxtrparen}).
+ Only the short form is shown on subsequent use. The
+ \field{description} field is set to the long form},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
}
-@index{long-noshort,
- name={\abbrstylefmt{long\dhyphen noshort}},
+@abbrvstylecommand{glsxtrlongshortname,
+ name={\csfmt{gls\-xtr\-long\-short\-name}},
+ description={hook for the \abbrstyle{long-short} abbreviation
+ styles that expands to the value that the \field{name} field is
+ assigned to when the abbreviation is defined with
+ \cs{newabbreviation} (defaults to the short form)},
+ topics={abbrstyle.long-short,abbrstyle.long-short-sc,abbrstyle.long-short-sm,abbrstyle.long-short-em,abbrstyle.long-em-short-em,abbrstyle.long-short-user,abbrstyle.long-postshort-user,abbrstyle.long-hyphen-short-hyphen,abbrstyle.long-hyphen-postshort-hyphen},
+ note={\styfmt{glossaries-extra} v1.25+},
+ category={command}
+}
+
+@abbrvstylecommand{glslongdefaultfont,
+ name={\csfmt{gls\-long\-default\-font}},
+ user1={\margm{text}},
+ description={used by the abbreviation styles that don't have a
+ specific font to format the long form. The default definition
+just does its argument without any formatting},
+ topics={abbrstyle.long-short,abbrstyle.short-long,abbrstyle.short-nolong,abbrstyle.nolong-short,abbrstyle.nolong-short-noreg,abbrstyle.short-nolong-desc,abbrstyle.long-noshort-desc,abbrstyle.long-noshort-desc-noreg,abbrstyle.long-short-sc,abbrstyle.long-short-sc-desc,abbrstyle.short-sc-long,abbrstyle.short-sc-long-desc,abbrstyle.short-sc-nolong,abbrstyle.short-sc-nolong-desc,abbrstyle.nolong-short-sc,abbrstyle.long-noshort-sc,abbrstyle.long-noshort-sc-desc,abbrstyle.long-short-sm,abbrstyle.long-short-sm-desc,abbrstyle.short-sm-long,abbrstyle.short-sm-long-desc,abbrstyle.short-sm-nolong,abbrstyle.short-sm-nolong-desc,abbrstyle.nolong-short-sm,abbrstyle.long-noshort-sm,abbrstyle.long-noshort-sm-desc,abbrstyle.long-short-em,abbrstyle.long-short-em-desc,abbrstyle.short-em-long,abbrstyle.short-em-long-desc,abbrstyle.short-em-nolong,abbrstyle.short-em-nolong-desc,abbrstyle.nolong-short-em,abbrstyle.long-noshort-em,abbrstyle.long-noshort-em-desc,abbrstyle.long-noshort,abbrstyle.long-noshort-noreg,abbrstyle.long-short-desc},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstlongdefaultfont,
+ name={\csfmt{gls\-first\-long\-default\-font}},
+ user1={\margm{text}},
+ description={used by the abbreviation styles that don't have a
+ specific font to format the long form on \idx{firstuse}. The
+ default definition uses \cs{glslongdefaultfont}},
+ topics={abbrstyle.long-short,abbrstyle.short-long,abbrstyle.short-nolong,abbrstyle.nolong-short,abbrstyle.nolong-short-noreg,abbrstyle.short-nolong-desc,abbrstyle.long-noshort-desc,abbrstyle.long-noshort-desc-noreg,abbrstyle.long-short-sc,abbrstyle.long-short-sc-desc,abbrstyle.short-sc-long,abbrstyle.short-sc-long-desc,abbrstyle.short-sc-nolong,abbrstyle.short-sc-nolong-desc,abbrstyle.nolong-short-sc,abbrstyle.long-noshort-sc,abbrstyle.long-noshort-sc-desc,abbrstyle.long-short-sm,abbrstyle.long-short-sm-desc,abbrstyle.short-sm-long,abbrstyle.short-sm-long-desc,abbrstyle.short-sm-nolong,abbrstyle.short-sm-nolong-desc,abbrstyle.nolong-short-sm,abbrstyle.long-noshort-sm,abbrstyle.long-noshort-sm-desc,abbrstyle.long-short-em,abbrstyle.long-short-em-desc,abbrstyle.short-em-long,abbrstyle.short-em-long-desc,abbrstyle.short-em-nolong,abbrstyle.short-em-nolong-desc,abbrstyle.nolong-short-em,abbrstyle.long-noshort-em,abbrstyle.long-noshort-em-desc,abbrstyle.long-noshort,abbrstyle.long-noshort-noreg,abbrstyle.long-short-desc},
+ note={\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@abbrvstylecommand{glsabbrvdefaultfont,
+ name={\csfmt{gls\-abbrv\-default\-font}},
+ user1={\margm{text}},
+ description={used by the abbreviation styles that don't have a
+ specific font to format the short form. The default definition
+just does its argument without any formatting},
+ topics={abbrstyle.long-short,abbrstyle.short-long,abbrstyle.short-footnote,abbrstyle.short-postfootnote,abbrstyle.short-nolong,abbrstyle.nolong-short,abbrstyle.nolong-short-noreg,abbrstyle.short-nolong-desc,abbrstyle.long-noshort-desc,abbrstyle.long-noshort-desc-noreg,abbrstyle.long-hyphen-noshort-desc-noreg,abbrstyle.long-hyphen-noshort-noreg,abbrstyle.long-noshort,abbrstyle.long-noshort-noreg,abbrstyle.long-short-desc},
+ note={\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstabbrvdefaultfont,
+ name={\csfmt{gls\-first\-abbrv\-default\-font}},
+ user1={\margm{text}},
+ description={used by the abbreviation styles that don't have a
+ specific font to format the short form on \idx{firstuse}. The
+ default definition uses \cs{glsabbrvdefaultfont}},
+ topics={abbrstyle.long-short,abbrstyle.short-long,abbrstyle.short-footnote,abbrstyle.short-postfootnote,abbrstyle.short-nolong,abbrstyle.nolong-short,abbrstyle.nolong-short-noreg,abbrstyle.short-nolong-desc,abbrstyle.long-noshort-desc,abbrstyle.long-noshort-desc-noreg,abbrstyle.long-hyphen-noshort-desc-noreg,abbrstyle.long-hyphen-noshort-noreg,abbrstyle.long-noshort,abbrstyle.long-noshort-noreg,abbrstyle.long-short-desc},
+ note={\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-short-desc,
+ name={\abbrstylefmt{long\dhyphen short\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-short} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsxtrlongshortdescname,
+ name={\csfmt{gls\-xtr\-long\-short\-desc\-name}},
+ description={hook for the \abbrstyle{long-short-desc} abbreviation
+ styles that expands to the value that the \field{name} field is
+ assigned to when the abbreviation is defined with
+ \cs{newabbreviation} (defaults to the long form followed by the
+ short form in parentheses)},
+ topics={abbrstyle.long-short-desc,abbrstyle.long-short-sc-desc,abbrstyle.long-short-sm-desc,abbrstyle.long-short-em-desc,abbrstyle.long-em-short-em-desc,abbrstyle.long-hyphen-short-hyphen-desc,abbrstyle.long-hyphen-postshort-hyphen-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.short-long,
+ name={\abbrstylefmt{short\dhyphen long}},
+ description={this abbreviation style displays the short form on
+ \idx{firstuse} of the \cs{gls}-like commands followed by the
+ long form in parentheses (formatted with \cs{glsxtrparen}).
+ Only the short form is shown on subsequent use. The
+ \field{description} field is set to the long form},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsxtrshortlongname,
+ name={\csfmt{gls\-xtr\-short\-long\-name}},
+ description={hook for the \abbrstyle{short-long} abbreviation styles
+ that expands to the value that the \field{name} field is assigned
+ to when the abbreviation is defined with \cs{newabbreviation}
+ (defaults to the short form)},
+ topics={abbrstyle.short-long,abbrstyle.short-sc-long,abbrstyle.short-sm-long,abbrstyle.short-em-long,abbrstyle.short-em-long-em,abbrstyle.short-postlong-user,abbrstyle.short-long-user,abbrstyle.short-hyphen-long-hyphen,abbrstyle.short-hyphen-postlong-hyphen},
+ note={\styfmt{glossaries-extra} v1.25+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.short-long-desc,
+ name={\abbrstylefmt{short\dhyphen long\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-long} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsxtrshortlongdescname,
+ name={\csfmt{gls\-xtr\-short\-long\-desc\-name}},
+ description={hook for the \abbrstyle{short-long-desc} abbreviation
+ styles that expands to the value that the \field{name} field is
+ assigned to when the abbreviation is defined with
+ \cs{newabbreviation} (defaults to the long form followed by the
+ short form in parentheses)},
+ topics={abbrstyle.short-long-desc,abbrstyle.short-sc-long-desc,abbrstyle.short-sm-long-desc,abbrstyle.short-em-long-desc,abbrstyle.short-em-long-em-desc,abbrstyle.short-hyphen-long-hyphen-desc,abbrstyle.short-hyphen-postlong-hyphen-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.short-footnote,
+ name={\abbrstylefmt{short\dhyphen footnote}},
+ description={this abbreviation style displays the short form on
+ \idx{firstuse} of the \cs{gls}-like commands with the long form as
+ a footnote. Only the short form is shown on subsequent use. The
+ \field{description} field is set to the long form. The inline full
+ form obtained with commands like \cs{glsxtrfull} uses a
+ parenthetical style. Since this can result in nested hyperlinks
+ (from the \idx{link-text} to the glossary and from the footnote
+ marker to the footnote) this style automatically sets the
+ \catattr{nohyperfirst} category attribute to \optfmt{true} for
+ the entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.footnote,
+ name={\abbrstylefmt{footnote}},
+ description={an alias for \abbrstyle{short-footnote}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glslongfootnotefont,
+ name={\csfmt{gls\-long\-foot\-note\-font}},
+ user1={\margm{text}},
+ description={used with the \qt{footnote} abbreviation styles to
+ format the long form},
+ topics={abbrstyle.short-footnote,abbrstyle.short-postfootnote,abbrstyle.short-sc-footnote,abbrstyle.short-sc-postfootnote,abbrstyle.short-sm-footnote,abbrstyle.short-sm-postfootnote,abbrstyle.short-em-footnote,abbrstyle.short-em-postfootnote},
+ note={\styfmt{glossaries-extra} v1.05+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstlongfootnotefont,
+ name={\csfmt{gls\-first\-long\-foot\-note\-font}},
+ user1={\margm{text}},
+ description={used with the \qt{footnote} abbreviation styles to
+ format the long form on first use},
+ topics={abbrstyle.short-footnote,abbrstyle.short-postfootnote,abbrstyle.short-sc-footnote,abbrstyle.short-sc-postfootnote,abbrstyle.short-sm-footnote,abbrstyle.short-sm-postfootnote,abbrstyle.short-em-footnote,abbrstyle.short-em-postfootnote},
+ note={\styfmt{glossaries-extra} v1.05+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtrabbrvfootnote,
+ name={\csfmt{gls\-xtr\-abbrv\-foot\-note}},
+ user1={\margm{label}\margm{long form}},
+ description={used with the \qt{footnote} abbreviation styles to
+ do the footnote. The \meta{label} is ignored by default. The
+ \meta{long form} includes the font changing command. This just
+ does \code{\cs{footnote}\margm{long form}}},
+ topics={abbrstyle.short-footnote,abbrstyle.short-postfootnote,abbrstyle.short-sc-footnote,abbrstyle.short-sc-postfootnote,abbrstyle.short-sm-footnote,abbrstyle.short-sm-postfootnote,abbrstyle.short-em-footnote,abbrstyle.short-em-postfootnote},
+ note={\styfmt{glossaries-extra} v1.07+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtrfootnotename,
+ name={\csfmt{gls\-xtr\-foot\-note\-name}},
+ description={hook for the \qt{footnote} abbreviation styles
+ that expands to the value that the \field{name} field is assigned
+ to when the abbreviation is defined with \cs{newabbreviation}
+ (defaults to the short form)},
+ topics={abbrstyle.short-footnote,abbrstyle.short-postfootnote,abbrstyle.short-sc-footnote,abbrstyle.short-sc-postfootnote,abbrstyle.short-sm-footnote,abbrstyle.short-sm-postfootnote,abbrstyle.short-em-footnote,abbrstyle.short-em-postfootnote},
+ note={\styfmt{glossaries-extra} v1.25+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.short-postfootnote,
+ name={\abbrstylefmt{short\dhyphen postfootnote}},
+ description={this abbreviation style is like
+ \abbrstyle{short-footnote} but the footnote is moved to the
+ \idx{postlinkhook} (outside of the hyperlink, if enabled) to
+ prevent nested hyperlinks. This means that, unlike
+ \abbrstyle{short-footnote} the \catattr{nohyperfirst} attribute
+ isn't changed},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.postfootnote,
+ name={\abbrstylefmt{postfootnote}},
+ description={an alias for \abbrstyle{short-postfootnote}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-nolong,
+ name={\abbrstylefmt{short\dhyphen nolong}},
+ description={this abbreviation style only displays the \field{short} form
+ with the \cs{gls}-like commands (regardless of the \idx{firstuseflag}).
+ The \field{long} form can be accessed with \cs{glsxtrlong}.
+ The \field{name} field is set to \cs{glsxtrshortnolongname} and the
+ \field{description} field is set to the \field{long} form (unless
+ overridden in the entry definition). The inline full form
+ displays the short form followed by the long form in parentheses.
+ This style sets the \catattr{regular} attribute to \optfmt{true}
+ for the entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short,
+ name={\abbrstylefmt{short}},
+ description={an alias for \abbrstyle{short-nolong}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
parent={abbreviationstyles}
}
-@index{long-noshort-desc,
+@abbreviationstyle{abbrstyle.short-nolong-noreg,
+ name={\abbrstylefmt{short\dhyphen nolong\dhyphen noreg}},
+ description={this abbreviation style is like \abbrstyle{short-nolong}
+ but doesn't set the \catattr{regular} attribute to \optfmt{true}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsxtrshortnolongname,
+ name={\csfmt{gls\-xtr\-short\-no\-long\-name}},
+ description={hook for the \abbrstyle{short-nolong} abbreviation styles
+ that expands to the value that the \field{name} field is assigned
+ to when the abbreviation is defined with \cs{newabbreviation}
+ (defaults to the short form)},
+ topics={abbrstyle.short-nolong,abbrstyle.short-nolong-noreg,abbrstyle.short-sc-nolong,abbrstyle.short-sm-nolong,abbrstyle.short-em-nolong},
+ note={\styfmt{glossaries-extra} v1.25+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.short-nolong-desc,
+ name={\abbrstylefmt{short\dhyphen nolong\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-nolong} style but the \field{description}
+ field must be provided in the entry definition. This style sets
+ the \catattr{regular} attribute to \optfmt{true} for the entry's
+ category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-desc,
+ name={\abbrstylefmt{short-desc}},
+ description={an alias for \abbrstyle{short-nolong-desc}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-nolong-desc-noreg,
+ name={\abbrstylefmt{short\dhyphen nolong\dhyphen desc\dhyphen noreg}},
+ description={this abbreviation style is like \abbrstyle{short-nolong-desc}
+ but doesn't set the \catattr{regular} attribute to \optfmt{true}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsxtrshortdescname,
+ name={\csfmt{gls\-xtr\-short\-desc\-name}},
+ description={hook for the \abbrstyle{short-nolong-desc} abbreviation styles
+ that expands to the value that the \field{name} field is assigned
+ to when the abbreviation is defined with \cs{newabbreviation}
+ (defaults to the short form followed by long form in parentheses)},
+ topics={abbrstyle.short-nolong-desc,abbrstyle.short-nolong-desc-noreg,abbrstyle.short-sc-nolong-desc,abbrstyle.short-sm-nolong-desc,abbrstyle.short-em-nolong-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.nolong-short,
+ name={\abbrstylefmt{nolong\dhyphen short}},
+ description={this abbreviation style only displays the \field{short} form
+ with the \cs{gls}-like commands (regardless of the \idx{firstuseflag}).
+ The \field{long} form can be accessed with \cs{glsxtrlong}.
+ The \field{name} field is set to \cs{glsxtrshortnolongname} and the
+ \field{description} field is set to the \field{long} form (unless
+ overridden in the entry definition). The inline full form
+ displays the long form followed by the short form in parentheses.
+ This style sets the \catattr{regular} attribute to \optfmt{true}
+ for the entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.21+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.nolong-short-noreg,
+ name={\abbrstylefmt{nolong\dhyphen short\dhyphen noreg}},
+ description={this abbreviation style is like \abbrstyle{nolong-short}
+ but doesn't set the \catattr{regular} attribute to \optfmt{true}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.21+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-noshort-desc,
name={\abbrstylefmt{long\dhyphen noshort\dhyphen desc}},
+ description={this abbreviation style only displays the \field{long}
+ form with the \cs{gls}-like commands (regardless of the
+ \idx{firstuseflag}). The \field{short}
+ form can be accessed with \cs{glsxtrshort}. The \field{name}
+ field is set to \cs{glsxtrlongnoshortdescname} and the \field{description}
+ field must be provided in the entry definition. The inline full
+ form displays the long form followed by the short form in
+ parentheses. This style sets the \catattr{regular} attribute to
+ \optfmt{true} for the entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-desc,
+ name={\abbrstylefmt{long-desc}},
+ description={an alias for \abbrstyle{long-noshort-desc}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsxtrlongnoshortdescname,
+ name={\csfmt{gls\-xtr\-long\-no\-short\-desc\-name}},
+ description={hook for the \abbrstyle{long-noshort-desc} abbreviation styles
+ that expands to the value that the \field{name} field is assigned
+ to when the abbreviation is defined with \cs{newabbreviation}
+ (defaults to the long form)},
+ topics={abbrstyle.long-noshort-desc,abbrstyle.long-noshort-desc-noreg,abbrstyle.long-em-noshort-em-desc,abbrstyle.long-hyphen-noshort-desc-noreg,abbrstyle.long-noshort-sc-desc,abbrstyle.long-noshort-sm-desc,abbrstyle.long-noshort-em-desc,abbrstyle.long-em-noshort-em-desc-noreg},
+ note={\styfmt{glossaries-extra} v1.25+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-noshort-desc-noreg,
+ name={\abbrstylefmt{long\dhyphen noshort\dhyphen desc\dhyphen noreg}},
+ description={this abbreviation style is like \abbrstyle{long-noshort-desc}
+ but doesn't set the \catattr{regular} attribute to \optfmt{true}},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
parent={abbreviationstyles}
}
-@index{long-short-sc,
+@abbreviationstyle{abbrstyle.long-noshort,
+ name={\abbrstylefmt{long\dhyphen noshort}},
+ description={this abbreviation style only displays the \field{long} form
+ with the \cs{gls}-like commands (regardless of the \idx{firstuseflag}).
+ The \field{short} form can be accessed with \cs{glsxtrshort}.
+ The \field{name} field is set to \cs{glsxtrlongnoshortname} and the
+ \field{description} field is set to the \field{long} form (unless
+ overridden in the entry definition). The inline full form
+ displays the long form followed by the short form in parentheses.
+ This style sets the \catattr{regular} attribute to \optfmt{true}
+ for the entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long,
+ name={\abbrstylefmt{long}},
+ description={an alias for \abbrstyle{long-noshort}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-noshort-noreg,
+ name={\abbrstylefmt{long\dhyphen noshort\dhyphen noreg}},
+ description={this abbreviation style is like \abbrstyle{long-noshort}
+ but doesn't set the \catattr{regular} attribute to \optfmt{true}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsxtrlongnoshortname,
+ name={\csfmt{gls\-xtr\-long\-no\-short\-name}},
+ description={hook for the \abbrstyle{long-noshort} abbreviation styles
+ that expands to the value that the \field{name} field is assigned
+ to when the abbreviation is defined with \cs{newabbreviation}
+ (defaults to the short form)},
+ topics={abbrstyle.long-noshort,abbrstyle.long-noshort-noreg,abbrstyle.long-noshort-sc,abbrstyle.long-noshort-sm,abbrstyle.long-noshort-em,abbrstyle.long-em-noshort-em,abbrstyle.long-em-noshort-em-noreg,abbrstyle.long-hyphen-noshort-noreg},
+ note={\styfmt{glossaries-extra} v1.25+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-short-sc,
name={\abbrstylefmt{long\dhyphen short\dhyphen sc}},
+ description={this abbreviation style is like \abbrstyle{long-short}
+ but the short form is displayed in small-caps (so it needs to be
+ in \idx{lowercase})},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsxtrscsuffix,
+ name={\csfmt{gls\-xtr\-sc\-suffix}},
+ user1={},
+ description={the suffix used to construct the plural for
+ the short form of abbreviations with the small-cap
+ \qt{sc} styles. This counteracts the effect of \cs{textsc}
+ using \ics{glstextup}},
+ topics={abbrstyle.long-short-sc,abbrstyle.long-short-sc-desc,abbrstyle.short-sc-long,abbrstyle.short-sc-long-desc,abbrstyle.short-sc-nolong,abbrstyle.short-sc-nolong-desc,abbrstyle.nolong-short-sc,abbrstyle.short-sc-footnote,abbrstyle.short-sc-postfootnote,abbrstyle.long-noshort-sc,abbrstyle.long-noshort-sc-desc},
+ note={\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@abbrvstylecommand{glsabbrvscfont,
+ name={\csfmt{gls\-abbrv\-sc\-font}},
+ user1={\margm{text}},
+ description={used with \qt{sc} abbreviation styles to format the
+short form using \cs{textsc}},
+ topics={abbrstyle.long-short-sc,abbrstyle.long-short-sc-desc,abbrstyle.short-sc-long,abbrstyle.short-sc-long-desc,abbrstyle.short-sc-nolong,abbrstyle.short-sc-nolong-desc,abbrstyle.nolong-short-sc,abbrstyle.short-sc-footnote,abbrstyle.short-sc-postfootnote,abbrstyle.long-noshort-sc,abbrstyle.long-noshort-sc-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstabbrvscfont,
+ name={\csfmt{gls\-first\-abbrv\-sc\-font}},
+ user1={\margm{text}},
+ description={used with \qt{sc} abbreviation styles to format the
+ short form on \idx{firstuse}. This defaults to \cs{glsabbrvscfont}},
+ topics={abbrstyle.long-short-sc,abbrstyle.long-short-sc-desc,abbrstyle.short-sc-long,abbrstyle.short-sc-long-desc,abbrstyle.short-sc-nolong,abbrstyle.short-sc-nolong-desc,abbrstyle.nolong-short-sc,abbrstyle.short-sc-footnote,abbrstyle.short-sc-postfootnote,abbrstyle.long-noshort-sc,abbrstyle.long-noshort-sc-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-short-sc-desc,
+ name={\abbrstylefmt{long\dhyphen short\dhyphen sc\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-short-sc} style but the \field{description}
+ field must be provided in the entry definition},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
parent={abbreviationstyles}
}
-@index{long-short-sm,
+@abbreviationstyle{abbrstyle.short-sc-long,
+ name={\abbrstylefmt{short\dhyphen sc\dhyphen long}},
+ description={this abbreviation style is like \abbrstyle{short-long}
+ but the short form is displayed in small-caps (so it needs to be
+ in \idx{lowercase})},
+ category={abbreviationstyle},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sc-long-desc,
+ name={\abbrstylefmt{short\dhyphen sc\dhyphen long\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-sc-long} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sc-nolong,
+ name={\abbrstylefmt{short\dhyphen sc\dhyphen nolong}},
+ description={this abbreviation style is like \abbrstyle{short-nolong}
+ but the short form is displayed in small-caps (so it needs to be
+ in \idx{lowercase}). This style sets the \catattr{regular}
+ attribute to \optfmt{true} for the entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sc,
+ name={\abbrstylefmt{short\dhyphen sc}},
+ description={an alias for \abbrstyle{short-sc-nolong}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sc-nolong-desc,
+ name={\abbrstylefmt{short\dhyphen sc\dhyphen nolong\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-sc-nolong} style but the \field{description}
+ field must be provided in the entry definition. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sc-desc,
+ name={\abbrstylefmt{short\dhyphen sc\dhyphen desc}},
+ description={an alias for \abbrstyle{short-sc-nolong-desc}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.nolong-short-sc,
+ name={\abbrstylefmt{nolong\dhyphen short\dhyphen sc}},
+ description={this abbreviation style is like \abbrstyle{nolong-short}
+ but the short form is displayed in small-caps (so it needs to be
+ in \idx{lowercase}). This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.21+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-noshort-sc,
+ name={\abbrstylefmt{long\dhyphen noshort\dhyphen sc}},
+ description={this abbreviation style is like \abbrstyle{long-noshort}
+ but the short form is displayed in small-caps (so it needs to be
+ in \idx{lowercase}). This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-noshort-sc-desc,
+ name={\abbrstylefmt{long\dhyphen noshort\dhyphen sc\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-noshort-sc} style but the \field{description}
+ field must be provided in the entry definition. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sc-footnote,
+ name={\abbrstylefmt{short\dhyphen sc\dhyphen footnote}},
+ description={this abbreviation style is like \abbrstyle{short-footnote}
+ but the short form is displayed in small-caps (so it needs to be
+ in \idx{lowercase})},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sc-postfootnote,
+ name={\abbrstylefmt{short\dhyphen sc\dhyphen postfootnote}},
+ description={this abbreviation style is like \abbrstyle{short-postfootnote}
+ but the short form is displayed in small-caps (so it needs to be
+ in \idx{lowercase})},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-short-sm,
name={\abbrstylefmt{long\dhyphen short\dhyphen sm}},
+ description={this abbreviation style is like \abbrstyle{long-short}
+ but the short form is displayed using a smaller font. The
+ \sty{relsize} package is required with this style},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsabbrvsmfont,
+ name={\csfmt{gls\-abbrv\-sm\-font}},
+ user1={\margm{text}},
+ description={used with \qt{sm} abbreviation styles to format the
+short form using \ics{textsmaller}},
+ topics={abbrstyle.long-short-sm,abbrstyle.long-short-sm-desc,abbrstyle.short-sm-long,abbrstyle.short-sm-long-desc,abbrstyle.short-sm-nolong,abbrstyle.short-sm-nolong-desc,abbrstyle.nolong-short-sm,abbrstyle.short-sm-footnote,abbrstyle.short-sm-postfootnote,abbrstyle.long-noshort-sm,abbrstyle.long-noshort-sm-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstabbrvsmfont,
+ name={\csfmt{gls\-first\-abbrv\-sm\-font}},
+ user1={\margm{text}},
+ description={used with \qt{sm} abbreviation styles to format the
+ short form on \idx{firstuse}. This defaults to \cs{glsabbrvsmfont}},
+ topics={abbrstyle.long-short-sm,abbrstyle.long-short-sm-desc,abbrstyle.short-sm-long,abbrstyle.short-sm-long-desc,abbrstyle.short-sm-nolong,abbrstyle.short-sm-nolong-desc,abbrstyle.nolong-short-sm,abbrstyle.short-sm-footnote,abbrstyle.short-sm-postfootnote,abbrstyle.long-noshort-sm,abbrstyle.long-noshort-sm-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtrsmsuffix,
+ name={\csfmt{gls\-xtr\-sm\-suffix}},
+ user1={},
+ description={the suffix used to construct the plural for
+ the short form of abbreviations with the \qt{sm} styles. This
+ defaults to \cs{glsxtrabbrvpluralsuffix}},
+ topics={abbrstyle.long-short-sm,abbrstyle.long-short-sm-desc,abbrstyle.short-sm-long,abbrstyle.short-sm-long-desc,abbrstyle.short-sm-nolong,abbrstyle.short-sm-nolong-desc,abbrstyle.nolong-short-sm,abbrstyle.short-sm-footnote,abbrstyle.short-sm-postfootnote,abbrstyle.long-noshort-sm,abbrstyle.long-noshort-sm-desc},
+ note={\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-short-sm-desc,
+ name={\abbrstylefmt{long\dhyphen short\dhyphen sm\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-short-sm} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sm-long,
+ name={\abbrstylefmt{short\dhyphen sm\dhyphen long}},
+ description={this abbreviation style is like \abbrstyle{short-long}
+ but the short form is displayed using a smaller font},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sm-long-desc,
+ name={\abbrstylefmt{short\dhyphen sm\dhyphen long\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-short-sm} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sm-nolong,
+ name={\abbrstylefmt{short\dhyphen sm\dhyphen nolong}},
+ description={this abbreviation style is like \abbrstyle{short-nolong}
+ but the short form is displayed using a smaller font. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sm,
+ name={\abbrstylefmt{short\dhyphen sm}},
+ description={an alias for \abbrstyle{short-sm-nolong}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sm-nolong-desc,
+ name={\abbrstylefmt{short\dhyphen sm\dhyphen nolong\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-sm-nolong} style but the \field{description}
+ field must be provided in the entry definition. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sm-desc,
+ name={\abbrstylefmt{short\dhyphen sm\dhyphen desc}},
+ description={an alias for \abbrstyle{short-sm-nolong-desc}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.nolong-short-sm,
+ name={\abbrstylefmt{nolong\dhyphen short\dhyphen sm}},
+ description={this abbreviation style is like \abbrstyle{nolong-short}
+ but the short form is displayed using a smaller font. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.21+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-noshort-sm,
+ name={\abbrstylefmt{long\dhyphen noshort\dhyphen sm}},
+ description={this abbreviation style is like \abbrstyle{long-noshort}
+ but the short form is displayed using a smaller font. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-noshort-sm-desc,
+ name={\abbrstylefmt{long\dhyphen noshort\dhyphen sm\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-noshort-sm} style but the \field{description}
+ field must be provided in the entry definition. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
parent={abbreviationstyles}
}
-@index{long-short-em,
+@abbreviationstyle{abbrstyle.short-sm-footnote,
+ name={\abbrstylefmt{short\dhyphen sm\dhyphen footnote}},
+ description={this abbreviation style is like \abbrstyle{short-footnote}
+ but the short form is displayed in a smaller font},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-sm-postfootnote,
+ name={\abbrstylefmt{short\dhyphen sm\dhyphen postfootnote}},
+ description={this abbreviation style is like \abbrstyle{short-postfootnote}
+ but the short form is displayed in a smaller font},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-short-em,
name={\abbrstylefmt{long\dhyphen short\dhyphen em}},
+ description={this abbreviation style is like \abbrstyle{long-short}
+ but the short form is displayed using an emphasized font},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
parent={abbreviationstyles}
}
-@index{long-short,
- name={\abbrstylefmt{long\dhyphen short}},
+@abbrvstylecommand{glsabbrvemfont,
+ name={\csfmt{gls\-abbrv\-em\-font}},
+ user1={\margm{text}},
+ description={used with \qt{em} abbreviation styles to format the
+short form using \ics{emph}},
+ topics={abbrstyle.long-em-short-em,abbrstyle.long-short-em,abbrstyle.long-short-em-desc,abbrstyle.short-em-long,abbrstyle.short-em-long-desc,abbrstyle.short-em-nolong,abbrstyle.short-em-nolong-desc,abbrstyle.nolong-short-em,abbrstyle.short-em-footnote,abbrstyle.short-em-postfootnote,abbrstyle.long-em-noshort-em,abbrstyle.long-em-noshort-em-desc,abbrstyle.long-em-noshort-em-desc-noreg,abbrstyle.long-em-noshort-em-noreg,abbrstyle.long-em-short-em-desc,abbrstyle.long-noshort-em,abbrstyle.long-noshort-em-desc},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstabbrvemfont,
+ name={\csfmt{gls\-first\-abbrv\-em\-font}},
+ user1={\margm{text}},
+ description={used with \qt{em} abbreviation styles to format the
+ short form on \idx{firstuse}. This defaults to \cs{glsabbrvemfont}},
+ topics={abbrstyle.long-em-short-em,abbrstyle.long-short-em,abbrstyle.long-short-em-desc,abbrstyle.short-em-long,abbrstyle.short-em-long-desc,abbrstyle.short-em-nolong,abbrstyle.short-em-nolong-desc,abbrstyle.nolong-short-em,abbrstyle.short-em-footnote,abbrstyle.short-em-postfootnote,abbrstyle.long-em-short-em-desc,abbrstyle.long-em-noshort-em,abbrstyle.long-em-noshort-em-desc,abbrstyle.long-em-noshort-em-desc-noreg,abbrstyle.long-em-noshort-em-noreg,abbrstyle.long-noshort-em,abbrstyle.long-noshort-em-desc},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtremsuffix,
+ name={\csfmt{gls\-xtr\-em\-suffix}},
+ description={the suffix used to construct the plural for
+ the short form of abbreviations with the \qt{em} styles. This
+ defaults to \cs{glsxtrabbrvpluralsuffix}},
+ topics={abbrstyle.long-em-short-em,abbrstyle.long-short-em,abbrstyle.long-short-em-desc,abbrstyle.short-em-long,abbrstyle.short-em-long-desc,abbrstyle.short-em-nolong,abbrstyle.short-em-nolong-desc,abbrstyle.nolong-short-em,abbrstyle.short-em-footnote,abbrstyle.short-em-postfootnote,abbrstyle.long-em-noshort-em,abbrstyle.long-em-noshort-em-desc,abbrstyle.long-em-noshort-em-desc-noreg,abbrstyle.long-em-noshort-em-noreg,abbrstyle.long-noshort-em,abbrstyle.long-noshort-em-desc},
+ note={\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@abbrvstylecommand{glslongemfont,
+ name={\csfmt{gls\-long\-em\-font}},
+ user1={\margm{text}},
+ description={used with \qt{long-em} abbreviation styles to format the
+long form using \ics{emph}},
+ topics={abbrstyle.long-em-short-em,abbrstyle.long-em-short-em-desc,abbrstyle.short-em-long-em,abbrstyle.short-em-long-em-desc,abbrstyle.long-em-noshort-em,abbrstyle.long-em-noshort-em-desc,abbrstyle.long-em-noshort-em-desc-noreg,abbrstyle.long-em-noshort-em-noreg},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstlongemfont,
+ name={\csfmt{gls\-first\-long\-em\-font}},
+ user1={\margm{text}},
+ description={used with \qt{long-em} abbreviation styles to format the
+ long form on \idx{firstuse}. This defaults to \cs{glslongemfont}},
+ topics={abbrstyle.long-em-short-em,abbrstyle.long-em-short-em-desc,abbrstyle.short-em-long-em,abbrstyle.short-em-long-em-desc,abbrstyle.long-em-noshort-em,abbrstyle.long-em-noshort-em-desc,abbrstyle.long-em-noshort-em-desc-noreg,abbrstyle.long-em-noshort-em-noreg},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-short-em-desc,
+ name={\abbrstylefmt{long\dhyphen short\dhyphen em\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-short-em} style but the \field{description}
+ field must be provided in the entry definition},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
parent={abbreviationstyles}
}
-@index{long-short-user,
+@abbreviationstyle{abbrstyle.long-em-short-em,
+ name={\abbrstylefmt{long\dhyphen em\dhyphen short\dhyphen em}},
+ description={this abbreviation style is like \abbrstyle{long-short}
+ but the short and long forms are displayed using an emphasized font},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-em-short-em-desc,
+ name={\abbrstylefmt{long\dhyphen em\dhyphen short\dhyphen em\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-em-short-em} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-em-long,
+ name={\abbrstylefmt{short\dhyphen em\dhyphen long}},
+ description={this abbreviation style is like \abbrstyle{short-long}
+ but the short form is displayed using an emphasized font},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-em-long-desc,
+ name={\abbrstylefmt{short\dhyphen em\dhyphen long\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-em-long} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-em-long-em,
+ name={\abbrstylefmt{short\dhyphen em\dhyphen long\dhyphen em}},
+ description={this abbreviation style is like \abbrstyle{short-long}
+ but the short and long forms are displayed using an emphasized font},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-em-long-em-desc,
+ name={\abbrstylefmt{short\dhyphen em\dhyphen long\dhyphen em\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-em-long-em} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-em-nolong,
+ name={\abbrstylefmt{short\dhyphen em\dhyphen nolong}},
+ description={this abbreviation style is like \abbrstyle{short-nolong}
+ but the short form is displayed using an emphasized font. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-em,
+ name={\abbrstylefmt{short\dhyphen em}},
+ description={an alias for \abbrstyle{short-em-nolong}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-em-nolong-desc,
+ name={\abbrstylefmt{short\dhyphen em\dhyphen nolong\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-em-nolong} style but the \field{description}
+ field must be provided in the entry definition. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-em-desc,
+ name={\abbrstylefmt{short\dhyphen em\dhyphen desc}},
+ description={an alias for \abbrstyle{short-em-nolong-desc}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra}},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.nolong-short-em,
+ name={\abbrstylefmt{nolong\dhyphen short\dhyphen em}},
+ description={this abbreviation style is like \abbrstyle{nolong-short}
+ but the short form is displayed using an emphasized font. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.21+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-noshort-em,
+ name={\abbrstylefmt{long\dhyphen noshort\dhyphen em}},
+ description={this abbreviation style is like \abbrstyle{long-noshort}
+ but the short form is displayed using an emphasized font. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-em-noshort-em,
+ name={\abbrstylefmt{long\dhyphen em\dhyphen noshort\dhyphen em}},
+ description={this abbreviation style is like \abbrstyle{long-noshort}
+ but the long and short forms are displayed using an emphasized font.
+ This style sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-em-noshort-em-noreg,
+ name={\abbrstylefmt{long\dhyphen em\dhyphen noshort\dhyphen em\dhyphen noreg}},
+ description={this abbreviation style is like \abbrstyle{long-noshort-noreg}
+ but the long and short forms are displayed using an emphasized font},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-noshort-em-desc,
+ name={\abbrstylefmt{long\dhyphen noshort\dhyphen em\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-noshort-em} style but the \field{description}
+ field must be provided in the entry definition. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-em-noshort-em-desc,
+ name={\abbrstylefmt{long\dhyphen em\dhyphen noshort\dhyphen em\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-em-noshort-em} style but the \field{description}
+ field must be provided in the entry definition. This style
+ sets the \catattr{regular} attribute to \optfmt{true} for the
+ entry's category},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-em-noshort-em-desc-noreg,
+ name={\abbrstylefmt{long\dhyphen em\dhyphen noshort\dhyphen em\dhyphen desc\dhyphen noreg}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-em-noshort-em-noreg} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-em-footnote,
+ name={\abbrstylefmt{short\dhyphen em\dhyphen footnote}},
+ description={this abbreviation style is like \abbrstyle{short-footnote}
+ but the short form is displayed in an emphasized font},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-em-postfootnote,
+ name={\abbrstylefmt{short\dhyphen em\dhyphen postfootnote}},
+ description={this abbreviation style is like \abbrstyle{short-postfootnote}
+ but the short form is displayed in an emphasized font},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-short-user,
name={\abbrstylefmt{long\dhyphen short\dhyphen user}},
+ description={this abbreviation style is like \abbrstyle{long-short}
+ but the parenthetical material is governed by \cs{glsxtruserparen}},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
parent={abbreviationstyles}
}
-@index{short-long-user,
- name={\abbrstylefmt{short\dhyphen long\dhyphen user}},
+@abbrvstylecommand{glsxtruserfield,
+ name={\csfmt{gls\-xtr\-user\-field}},
+ description={used by the parenthetical abbreviation styles, this
+ expands to the internal label of the field used to store the additional parenthetical
+ material. The default value is \field{useri}},
+ topics={abbrstyle.long-short-user,abbrstyle.short-long-user,abbrstyle.long-postshort-user,abbrstyle.long-postshort-user-desc,abbrstyle.short-postlong-user-desc,abbrstyle.long-short-user-desc,abbrstyle.short-long-user-desc},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtruserparen,
+ name={\csfmt{gls\-xtr\-user\-paren}},
+ user1={\margm{text}\margm{label}},
+ description={used by the \qt{user} abbreviation styles
+ to format the parenthetical material where \meta{text}
+ is the default parenthetical text and \meta{label}
+ is the entry's label. This checks the field given
+ by \cs{glsxtruserfield} and, if set, the \meta{text} is
+ followed by a comma and the user value},
+ topics={abbrstyle.long-short-user,abbrstyle.short-long-user,abbrstyle.long-postshort-user,abbrstyle.long-postshort-user-desc,abbrstyle.short-postlong-user-desc,abbrstyle.long-short-user-desc,abbrstyle.short-long-user-desc},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbrvstylecommand{glsabbrvuserfont,
+ name={\csfmt{gls\-abbrv\-user\-font}},
+ user1={\margm{text}},
+ description={used with \qt{user} abbreviation styles to
+ format the short form. The default definition just uses \cs{glsabbrvdefaultfont}},
+ topics={abbrstyle.long-short-user,abbrstyle.short-long-user,abbrstyle.long-postshort-user,abbrstyle.long-postshort-user-desc,abbrstyle.short-postlong-user-desc,abbrstyle.long-short-user-desc,abbrstyle.short-long-user-desc},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstabbrvuserfont,
+ name={\csfmt{gls\-first\-abbrv\-user\-font}},
+ user1={\margm{text}},
+ description={used with \qt{user} abbreviation styles to
+ format the short form on \idx{firstuse}. The default definition just uses
+\cs{glsabbrvuserfont}},
+ topics={abbrstyle.long-short-user,abbrstyle.short-long-user,abbrstyle.long-postshort-user,abbrstyle.long-postshort-user-desc,abbrstyle.short-postlong-user-desc,abbrstyle.long-short-user-desc,abbrstyle.short-long-user-desc},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbrvstylecommand{glslonguserfont,
+ name={\csfmt{gls\-long\-user\-font}},
+ user1={\margm{text}},
+ description={used with \qt{user} abbreviation styles to
+ format the long form. The default definition just uses \cs{glslongdefaultfont}},
+ topics={abbrstyle.long-short-user,abbrstyle.short-long-user,abbrstyle.long-postshort-user,abbrstyle.long-postshort-user-desc,abbrstyle.short-postlong-user-desc,abbrstyle.long-short-user-desc,abbrstyle.short-long-user-desc},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstlonguserfont,
+ name={\csfmt{gls\-first\-long\-user\-font}},
+ user1={\margm{text}},
+ description={used with \qt{user} abbreviation styles to
+ format the long form on first use. The default definition just uses
+\cs{glslonguserfont}},
+ topics={abbrstyle.long-short-user,abbrstyle.short-long-user,abbrstyle.long-postshort-user,abbrstyle.long-postshort-user-desc,abbrstyle.short-postlong-user-desc,abbrstyle.long-short-user-desc,abbrstyle.short-long-user-desc},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtrusersuffix,
+ name={\csfmt{gls\-xtr\-user\-suffix}},
+ description={the suffix used to construct the plural for
+ the short form of abbreviations with the \qt{user} styles.
+ The default definition just uses \cs{glsxtrabbrvpluralsuffix}},
+ topics={abbrstyle.long-short-user,abbrstyle.short-long-user,abbrstyle.long-postshort-user,abbrstyle.long-postshort-user-desc,abbrstyle.short-postlong-user-desc,abbrstyle.long-short-user-desc,abbrstyle.short-long-user-desc},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@abbrvstylecommand{glsuserdescription,
+ name={\csfmt{gls\-user\-description}},
+ user1={\margm{description}\margm{label}},
+ description={used with \qt{user} abbreviation styles to
+ encapsulate the description. Just does
+ \code{\cs{glslonguserfont}\margm{description}} by default},
+ topics={abbrstyle.long-short-user,abbrstyle.short-long-user,abbrstyle.long-postshort-user,abbrstyle.long-postshort-user-desc,abbrstyle.short-postlong-user-desc,abbrstyle.long-short-user-desc,abbrstyle.short-long-user-desc},
+ note={\styfmt{glossaries-extra} v1.30+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-postshort-user,
+ name={\abbrstylefmt{long\dhyphen postshort\dhyphen user}},
+ description={this abbreviation style is like \abbrstyle{long-short-user}
+ but the parenthetical material is moved to the \idx{postlinkhook}},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.12+},
parent={abbreviationstyles}
}
-@index{long-em-short-em,
- name={\abbrstylefmt{long\dhyphen em\dhyphen short\dhyphen em}},
+@abbrvstylecommand{glsxtrlongshortuserdescname,
+ name={\csfmt{gls\-xtr\-long\-short\-user\-desc\-name}},
+ description={hook for the \abbrstyle{long-short-user-desc} abbreviation
+ styles that expands to the value that the \field{name} field is
+ assigned to when the abbreviation is defined with
+ \cs{newabbreviation} (defaults to the long form followed by the
+ parenthetical material)},
+ topics={abbrstyle.long-postshort-user-desc,abbrstyle.long-short-user-desc},
+ note={\styfmt{glossaries-extra} v1.25+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-postshort-user-desc,
+ name={\abbrstylefmt{long\dhyphen postshort\dhyphen user\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-postshort-user} style but the \field{description}
+ field must be provided in the entry definition},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.12+},
parent={abbreviationstyles}
}
-@index{long-short-desc,
- name={\abbrstylefmt{long\dhyphen short\dhyphen desc}},
+@abbreviationstyle{abbrstyle.short-postlong-user,
+ name={\abbrstylefmt{short\dhyphen postlong\dhyphen user}},
+ description={this abbreviation style is like \abbrstyle{short-long-user}
+ but the parenthetical material is moved to the \idx{postlinkhook}},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.12+},
parent={abbreviationstyles}
}
-@index{long-short-user-desc,
+@abbrvstylecommand{glsxtrshortlonguserdescname,
+ name={\csfmt{gls\-xtr\-short\-long\-user\-desc\-name}},
+ description={hook for the \abbrstyle{short-long-user-desc} abbreviation
+ styles that expands to the value that the \field{name} field is
+ assigned to when the abbreviation is defined with
+ \cs{newabbreviation} (defaults to the short form followed by the
+ parenthetical material)},
+ topics={abbrstyle.short-postlong-user-desc,abbrstyle.short-long-user-desc},
+ note={\styfmt{glossaries-extra} v1.25+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.short-postlong-user-desc,
+ name={\abbrstylefmt{short\dhyphen postlong\dhyphen user\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-postlong-user} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.12+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-short-user-desc,
name={\abbrstylefmt{long\dhyphen short\dhyphen user\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-short-user} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-long-user,
+ name={\abbrstylefmt{short\dhyphen long\dhyphen user}},
+ description={this abbreviation style is like \abbrstyle{short-long}
+ but the parenthetical material is governed by \cs{glsxtruserparen}},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
parent={abbreviationstyles}
}
-@index{long-hyphen-short-hyphen,
+@abbreviationstyle{abbrstyle.short-long-user-desc,
+ name={\abbrstylefmt{short\dhyphen long\dhyphen user\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-long-user} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.04+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-hyphen-short-hyphen,
name={\abbrstylefmt{long\dhyphen hyphen\dhyphen short\dhyphen
hyphen}},
+ description={this abbreviation style is like \abbrstyle{long-short}
+ but is designed to work with the \catattr{markwords} attribute. If
+ the attribute is set, the style will check if the inserted
+ material (provided by the final optional argument of commands like
+ \cs{gls}) starts with a hyphen. If it does, the insert is added to
+ the parenthetical material},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
parent={abbreviationstyles}
}
-@index{long-postshort-user-desc,
- name={\abbrstylefmt{long\dhyphen postshort\dhyphen user\dhyphen desc}},
+@abbrvstylecommand{glsxtrifhyphenstart,
+ name={\csfmt{gls\-xtr\-if\-hyphen\-start}},
+ user1={\margm{text}\margm{true}\margm{false}},
+ description={used by the \qt{hyphen} abbreviation styles, this
+ checks if \meta{text} starts with a hyphen},
+ topics={abbrstyle.long-hyphen-short-hyphen,abbrstyle.long-hyphen-short-hyphen-desc,abbrstyle.long-hyphen-noshort-desc-noreg,abbrstyle.long-hyphen-noshort-noreg,abbrstyle.long-hyphen-postshort-hyphen,abbrstyle.long-hyphen-postshort-hyphen-desc,abbrstyle.short-hyphen-long-hyphen,abbrstyle.short-hyphen-long-hyphen-desc,abbrstyle.short-hyphen-postlong-hyphen,abbrstyle.short-hyphen-postlong-hyphen-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtrlonghyphenshort,
+ name={\csfmt{gls\-xtr\-long\-hyphen\-short}},
+ user1={\margm{label}\margm{long}\margm{short}\margm{insert}},
+ description={used by the \qt{long\dhyphen hyphen\dhyphen
+ short\dhyphen hyphen} abbreviation styles to format the full form},
+ topics={abbrstyle.long-hyphen-short-hyphen,abbrstyle.long-hyphen-short-hyphen-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsabbrvhyphenfont,
+ name={\csfmt{gls\-abbrv\-hyphen\-font}},
+ user1={\margm{text}},
+ description={used by the \qt{hyphen} abbreviation styles to format
+ the short form},
+ topics={abbrstyle.long-hyphen-short-hyphen,abbrstyle.long-hyphen-short-hyphen-desc,abbrstyle.long-hyphen-postshort-hyphen,abbrstyle.long-hyphen-postshort-hyphen-desc,abbrstyle.short-hyphen-long-hyphen,abbrstyle.short-hyphen-long-hyphen-desc,abbrstyle.short-hyphen-postlong-hyphen,abbrstyle.short-hyphen-postlong-hyphen-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstabbrvhyphenfont,
+ name={\csfmt{gls\-first\-abbrv\-hyphen\-font}},
+ user1={\margm{text}},
+ description={used by the \qt{hyphen} abbreviation styles to format
+ the short form on \idx{firstuse}},
+ topics={abbrstyle.long-hyphen-short-hyphen,abbrstyle.long-hyphen-postshort-hyphen,abbrstyle.long-hyphen-postshort-hyphen-desc,abbrstyle.long-hyphen-short-hyphen-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glslonghyphenfont,
+ name={\csfmt{gls\-long\-hyphen\-font}},
+ user1={\margm{text}},
+ description={used by the \qt{hyphen} abbreviation styles to format
+ the long form},
+ topics={abbrstyle.long-hyphen-short-hyphen,abbrstyle.long-hyphen-noshort-desc-noreg,abbrstyle.long-hyphen-noshort-noreg,abbrstyle.long-hyphen-postshort-hyphen,abbrstyle.long-hyphen-postshort-hyphen-desc,abbrstyle.long-hyphen-short-hyphen-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstlonghyphenfont,
+ name={\csfmt{gls\-first\-long\-hyphen\-font}},
+ user1={\margm{text}},
+ description={used by the \qt{hyphen} abbreviation styles to format
+ the long form on \idx{firstuse}},
+ topics={abbrstyle.long-hyphen-short-hyphen,abbrstyle.long-hyphen-noshort-desc-noreg,abbrstyle.long-hyphen-noshort-noreg,abbrstyle.long-hyphen-postshort-hyphen,abbrstyle.long-hyphen-postshort-hyphen-desc,abbrstyle.long-hyphen-short-hyphen-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtrhyphensuffix,
+ name={\csfmt{gls\-xtr\-hyphen\-suffix}},
+ description={the suffix used to construct the plural for
+ the short form of abbreviations with the \qt{hyphen} styles},
+ topics={abbrstyle.long-hyphen-short-hyphen,abbrstyle.long-hyphen-postshort-hyphen,abbrstyle.long-hyphen-postshort-hyphen-desc,abbrstyle.long-hyphen-short-hyphen-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-hyphen-short-hyphen-desc,
+ name={\abbrstylefmt{long\dhyphen hyphen\dhyphen short\dhyphen
+hyphen\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-hyphen-short-hyphen} style but the \field{description}
+ field must be provided in the entry definition},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
parent={abbreviationstyles}
}
-@index{short-long,
- name={\abbrstylefmt{short\dhyphen long}},
+@abbrvstylecommand{glsxtrlonghyphennoshort,
+ name={\csfmt{gls\-xtr\-long\-hyphen\-noshort}},
+ user1={\margm{label}\margm{long}\margm{insert}},
+ description={used by the \qt{long-hyphen-noshort} styles
+ to format the \idx{firstuse} form. This checks if the inserted
+ material starts with a hyphen and makes the appropriate
+ modifications},
+ topics={abbrstyle.long-hyphen-noshort-desc-noreg,abbrstyle.long-hyphen-noshort-noreg},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-hyphen-noshort-desc-noreg,
+ name={\abbrstylefmt{long\dhyphen hyphen\dhyphen noshort\dhyphen desc\dhyphen noreg}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-hyphen-noshort-noreg} style but the \field{description}
+ field must be provided in the entry definition. This
+ style won't work with the \catattr{regular} attribute set, as the
+ regular form isn't flexible enough},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
parent={abbreviationstyles}
}
-@index{short-nolong,
- name={\abbrstylefmt{short\dhyphen nolong}},
+@abbreviationstyle{abbrstyle.long-hyphen-noshort-noreg,
+ name={\abbrstylefmt{long\dhyphen hyphen\dhyphen noshort\dhyphen noreg}},
+ description={this abbreviation style is like \abbrstyle{long-noshort}
+ but is designed to work with the \catattr{markwords} attribute and
+ the \catattr{regular} attribute isn't set to \optfmt{true}. This
+ style won't work with the \catattr{regular} attribute set, as the
+ regular form isn't flexible enough},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
parent={abbreviationstyles}
}
-@index{short-sc-nolong,
- name={\abbrstylefmt{short\dhyphen sc\dhyphen nolong}},
+@abbreviationstyle{abbrstyle.long-hyphen-postshort-hyphen,
+ name={\abbrstylefmt{long\dhyphen hyphen\dhyphen postshort\dhyphen hyphen}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-hyphen-short-hyphen} style but the insert and
+ parenthetical material are moved into the \idx{postlinkhook}},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsxtrlonghyphen,
+ name={\csfmt{gls\-xtr\-long\-hyphen}},
+ user1={\margm{long}\margm{label}\margm{insert}},
+ description={used by the \abbrstyle{long-hyphen-postshort-hyphen} abbreviation
+ to format the long form and check if the \meta{insert} starts with
+ a hyphen},
+ topics={abbrstyle.long-hyphen-postshort-hyphen},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtrposthyphenshort,
+ name={\csfmt{gls\-xtr\-post\-hyphen\-short}},
+ user1={\margm{label}\margm{insert}},
+ description={used by the \abbrstyle{long-hyphen-postshort-hyphen}
+ style in the \idx{postlinkhook}},
+ topics={abbrstyle.long-hyphen-postshort-hyphen},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtrposthyphensubsequent,
+ name={\csfmt{gls\-xtr\-post\-hyphen\-sub\-sequent}},
+ user1={\margm{label}\margm{insert}},
+ description={used by the \abbrstyle{long-hyphen-postshort-hyphen} abbreviation
+ in the \idx{postlinkhook} for subsequent use},
+ topics={abbrstyle.long-hyphen-postshort-hyphen},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-hyphen-postshort-hyphen-desc,
+ name={\abbrstylefmt{long\dhyphen hyphen\dhyphen postshort\dhyphen
+hyphen\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-hyphen-postshort-hyphen} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-hyphen-long-hyphen,
+ name={\abbrstylefmt{short\dhyphen hyphen\dhyphen long\dhyphen hyphen}},
+ description={this abbreviation style is like \abbrstyle{short-long}
+ but is designed to work with the \catattr{markwords} attribute. If
+ the attribute is set, the style will check if the inserted
+ material (provided by the final optional argument of commands like
+ \cs{gls}) starts with a hyphen. If it does, the insert is added to
+ the parenthetical material},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsxtrshorthyphenlong,
+ name={\csfmt{gls\-xtr\-short\-hyphen\-long}},
+ user1={\margm{label}\margm{short}\margm{long}\margm{insert}},
+ description={used by the \abbrstyle{short-hyphen-long-hyphen} style
+ to format the full form},
+ topics={abbrstyle.short-hyphen-long-hyphen,abbrstyle.short-hyphen-long-hyphen-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.short-hyphen-long-hyphen-desc,
+ name={\abbrstylefmt{short\dhyphen hyphen\dhyphen long\dhyphen
+hyphen\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-hyphen-long-hyphen} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.short-hyphen-postlong-hyphen,
+ name={\abbrstylefmt{short\dhyphen hyphen\dhyphen postlong\dhyphen hyphen}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-hyphen-long-hyphen} style but the insert and
+ parenthetical material are moved into the \idx{postlinkhook}},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
parent={abbreviationstyles}
}
-@index{long-only-short-only,
+@abbrvstylecommand{glsxtrshorthyphen,
+ name={\csfmt{gls\-xtr\-short\-hyphen}},
+ user1={\margm{short}\margm{label}\margm{insert}},
+ description={used by the \qt{postlong-hyphen} styles
+ to format the short form and check if \meta{insert} starts with a hyphen},
+ topics={abbrstyle.short-hyphen-postlong-hyphen},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtrposthyphenlong,
+ name={\csfmt{gls\-xtr\-post\-hyphen\-long}},
+ user1={\margm{label}\margm{insert}},
+ description={used by the \qt{postlong-hyphen}
+ styles in the \idx{postlinkhook}},
+ topics={abbrstyle.short-hyphen-postlong-hyphen},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.short-hyphen-postlong-hyphen-desc,
+ name={\abbrstylefmt{short\dhyphen hyphen\dhyphen postlong\dhyphen
+hyphen\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{short-hyphen-postlong-hyphen} style but the \field{description}
+ field must be provided in the entry definition},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
+ parent={abbreviationstyles}
+}
+
+@abbreviationstyle{abbrstyle.long-only-short-only,
name={\abbrstylefmt{long\dhyphen only\dhyphen short\dhyphen only}},
+ description={this abbreviation style only displays the long form
+ on \idx{firstuse} and only the short form on subsequent use. The
+ inline full form shows the long form followed by the short form in
+ parentheses},
+ category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
+ parent={abbreviationstyles}
+}
+
+@abbrvstylecommand{glsabbrvonlyfont,
+ name={\csfmt{gls\-abbrv\-only\-font}},
+ user1={\margm{text}},
+ description={used with \qt{only} abbreviation styles to format the
+short form. The default definition just uses \cs{glsabbrvdefaultfont}},
+ topics={abbrstyle.long-only-short-only,abbrstyle.long-only-short-only-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstabbrvonlyfont,
+ name={\csfmt{gls\-first\-abbrv\-only\-font}},
+ user1={\margm{text}},
+ description={used with \qt{only} abbreviation styles to format the
+short form on \idx{firstuse}. The default definition just uses
+\cs{glsabbrvonlyfont}},
+ topics={abbrstyle.long-only-short-only,abbrstyle.long-only-short-only-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glslongonlyfont,
+ name={\csfmt{gls\-long\-only\-font}},
+ user1={\margm{text}},
+ description={used with \qt{only} abbreviation styles to format the
+long form. The default definition just uses \cs{glslongdefaultfont}},
+ topics={abbrstyle.long-only-short-only,abbrstyle.long-only-short-only-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsfirstlongonlyfont,
+ name={\csfmt{gls\-first\-long\-only\-font}},
+ user1={\margm{text}},
+ description={used with \qt{only} abbreviation styles to format the
+long form on \idx{firstuse}. The default definition just uses
+\cs{glslongonlyfont}},
+ topics={abbrstyle.long-only-short-only,abbrstyle.long-only-short-only-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtronlysuffix,
+ name={\csfmt{gls\-xtr\-only\-suffix}},
+ description={the suffix used to construct the plural for
+ the short form of abbreviations with the \qt{only} styles.
+ The default definition just uses \cs{glsxtrabbrvpluralsuffix}},
+ topics={abbrstyle.long-only-short-only},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtronlyname,
+ name={\csfmt{gls\-xtr\-only\-name}},
+ description={hook for the \abbrstyle{long-only-short-only} style
+ that expands to the value that the \field{name} field is assigned
+ to when the abbreviation is defined with \cs{newabbreviation}
+ (defaults to the short form)},
+ topics={abbrstyle.long-only-short-only},
+ note={\styfmt{glossaries-extra} v1.25+},
+ category={command}
+}
+
+@abbrvstylecommand{glsxtronlydescname,
+ name={\csfmt{gls\-xtr\-only\-desc\-name}},
+ description={hook for the \abbrstyle{long-only-short-only-desc} style
+ that expands to the value that the \field{name} field is assigned
+ to when the abbreviation is defined with \cs{newabbreviation}
+ (defaults to the long form)},
+ topics={abbrstyle.long-only-short-only-desc},
+ note={\styfmt{glossaries-extra} v1.17+},
+ category={command}
+}
+
+@abbreviationstyle{abbrstyle.long-only-short-only-desc,
+ name={\abbrstylefmt{long\dhyphen only\dhyphen short\dhyphen only\dhyphen desc}},
+ description={this abbreviation style is like the
+ \abbrstyle{long-only-short-only} style but the \field{description}
+ field must be provided in the entry definition},
category={abbreviationstyle},
+ note={\styfmt{glossaries-extra} v1.17+},
parent={abbreviationstyles}
}
-@index{glossarystyle,
+@topic{glossarystyle,
name={glossary styles},
- text={glossary style}
+ text={glossary style},
+ description={glossary styles are set using \ics{setglossarystyle}
+ or with the \styopt{style} package option or the
+ \printglossopt{style} option in \cs{printunsrtglossary}.
+ There are a number of styles provided in the supplementary packages. See the
+\href{https://www.dickimaw-books.com/gallery/glossaries-styles/}{\styfmt{glossaries}
+ gallery of predefined styles}~\cite{glossarystylesgallery} for
+ samples of each style}
+}
+
+@glossarystyle{glostyle.inline,
+ name={\glostylefmt{inline}},
+ description={this style is designed for inline glossaries. The
+ \field{symbol}, \idx{locationlist} and child \field{name} are omitted
+ by default, but associated style commands may be redefined to
+ change this},
+ category={glossarystyle},
+ note={\styfmt{glossary-inline} v3.03+},
+ parent={glossarystyle}
+}
+
+@glostylecommand{glsinlinedopostchild,
+ name={\csfmt{gls\-in\-line\-do\-post\-child}},
+ description={group headings aren't supported by default, but if
+ they are required, this command should be added to start of the definition
+ of \cs{glsgroupheading} in case a heading follows a child entry},
+ category={command},
+ note={\styfmt{glossary-inline} v3.03+},
+ topics={glostyle.inline}
+}
+
+@glostylecommand{glsinlineseparator,
+ name={\csfmt{gls\-in\-line\-separator}},
+ description={separator between entries},
+ category={command},
+ note={\styfmt{glossary-inline} v3.03+},
+ topics={glostyle.inline}
+}
+
+@glostylecommand{glsinlinesubseparator,
+ name={\csfmt{gls\-in\-line\-sub\-separator}},
+ description={separator between sub-entries},
+ category={command},
+ note={\styfmt{glossary-inline} v3.03+},
+ topics={glostyle.inline}
+}
+
+@glostylecommand{glsinlineparentchildseparator,
+ name={\csfmt{gls\-in\-line\-parent\-child\-separator}},
+ description={separator between parent and child entries},
+ category={command},
+ note={\styfmt{glossary-inline} v3.03+},
+ topics={glostyle.inline}
+}
+
+@glostylecommand{glsinlinepostchild,
+ name={\csfmt{gls\-in\-line\-post\-child}},
+ description={hook between child and next entry},
+ category={command},
+ note={\styfmt{glossary-inline} v3.03+},
+ topics={glostyle.inline}
+}
+
+@glostylecommand{glspostinline,
+ name={\csfmt{gls\-post-in\-line}},
+ description={glossary terminator},
+ category={command},
+ note={\styfmt{glossary-inline} v3.03+},
+ topics={glostyle.inline}
}
-@index{glostyle.indexgroup,
+@glostylecommand{glsinlinenameformat,
+ name={\csfmt{gls\-in\-line\-name\-format}},
+ user1={\margm{label}\margm{name}},
+ description={format's the entry's name including target, if
+ supported},
+ category={command},
+ note={\styfmt{glossary-inline} v3.03+},
+ topics={glostyle.inline}
+}
+
+@glostylecommand{glsinlinedescformat,
+ name={\csfmt{gls\-in\-line\-desc\-format}},
+ user1={\margm{description}\margm{symbol}\margm{location list}},
+ description={format's the entry's description, symbol and location
+ list. This ignores the symbol and location by default},
+ category={command},
+ note={\styfmt{glossary-inline} v3.03+},
+ topics={glostyle.inline}
+}
+
+@glossarystyle{glostyle.indexgroup,
name={\glostylefmt{indexgroup}},
+ description={},
category={glossarystyle},
+ note={\styfmt{glossary-tree}},
parent={glossarystyle}
}
-@index{glostyle.mcolindexgroup,
+@glossarystyle{glostyle.mcolindexgroup,
name={\glostylefmt{mcolindexgroup}},
category={glossarystyle},
+ note={\styfmt{glossary-mcols}},
parent={glossarystyle}
}
-@index{glostyle.indexhypergroup,
+@glossarystyle{glostyle.indexhypergroup,
name={\glostylefmt{indexhypergroup}},
category={glossarystyle},
+ note={\styfmt{glossary-tree}},
parent={glossarystyle}
}
-@index{glostyle.tree,
+@glossarystyle{glostyle.tree,
name={\glostylefmt{tree}},
category={glossarystyle},
+ note={\styfmt{glossary-tree}},
parent={glossarystyle}
}
-@index{glostyle.treegroup,
+@glossarystyle{glostyle.treegroup,
name={\glostylefmt{treegroup}},
category={glossarystyle},
+ note={\styfmt{glossary-tree}},
parent={glossarystyle}
}
-@index{glostyle.treenoname,
+@glossarystyle{glostyle.treenoname,
name={\glostylefmt{treenoname}},
category={glossarystyle},
+ note={\styfmt{glossary-tree}},
parent={glossarystyle}
}
-@index{glostyle.treenonamegroup,
+@glossarystyle{glostyle.treenonamegroup,
name={\glostylefmt{treenonamegroup}},
category={glossarystyle},
+ note={\styfmt{glossary-tree}},
parent={glossarystyle}
}
-@index{glostyle.alttree,
+@glossarystyle{glostyle.alttree,
name={\glostylefmt{alttree}},
category={glossarystyle},
+ note={\styfmt{glossary-tree}},
parent={glossarystyle}
}
-@index{glostyle.alttreegroup,
+@glossarystyle{glostyle.alttreegroup,
name={\glostylefmt{alttreegroup}},
category={glossarystyle},
+ note={\styfmt{glossary-tree}},
parent={glossarystyle}
}
-@index{glostyle.mcolalttree,
+@glossarystyle{glostyle.mcolalttree,
name={\glostylefmt{mcolalttree}},
category={glossarystyle},
+ note={\styfmt{glossary-mcols}},
parent={glossarystyle}
}
-@index{glostyle.mcolalttreegroup,
+@glossarystyle{glostyle.mcolalttreegroup,
name={\glostylefmt{mcolalttreegroup}},
category={glossarystyle},
+ note={\styfmt{glossary-mcols}},
+ parent={glossarystyle}
+}
+
+@glossarystyle{glostyle.topic,
+ name={\glostylefmt{topic}},
+ category={glossarystyle},
+ note={\styfmt{glossary-topic} v1.40+},
+ parent={glossarystyle}
+}
+
+@glossarystyle{glostyle.topicmcols,
+ name={\glostylefmt{topicmcols}},
+ category={glossarystyle},
+ note={\styfmt{glossary-topic} v1.40+},
parent={glossarystyle}
}
-@index{glostyle.list,
+@glossarystyle{glostyle.list,
name={\glostylefmt{list}},
category={glossarystyle},
+ note={\styfmt{glossary-list}},
parent={glossarystyle}
}
-@index{glostyle.altlist,
+@glossarystyle{glostyle.altlist,
name={\glostylefmt{altlist}},
category={glossarystyle},
+ note={\styfmt{glossary-list}},
parent={glossarystyle}
}
-@index{glostyle.altlistgroup,
+@glossarystyle{glostyle.altlistgroup,
name={\glostylefmt{altlistgroup}},
category={glossarystyle},
+ note={\styfmt{glossary-list}},
parent={glossarystyle}
}
-@index{glostyle.index,
+@glossarystyle{glostyle.index,
name={\glostylefmt{index}},
category={glossarystyle},
+ note={\styfmt{glossary-tree}},
parent={glossarystyle}
}
-@index{glostyle.bookindex,
+@glossarystyle{glostyle.bookindex,
name={\glostylefmt{bookindex}},
category={glossarystyle},
+ note={\styfmt{glossary-bookindex}},
parent={glossarystyle}
}
-@index{glostyle.long3col,
+@glossarystyle{glostyle.long,
+ name={\glostylefmt{long}},
+ category={glossarystyle},
+ note={\styfmt{glossary-long}},
+ parent={glossarystyle}
+}
+
+@glossarystyle{glostyle.super,
+ name={\glostylefmt{super}},
+ category={glossarystyle},
+ note={\styfmt{glossary-long}},
+ parent={glossarystyle}
+}
+
+@glossarystyle{glostyle.long3col,
name={\glostylefmt{long3col}},
category={glossarystyle},
+ note={\styfmt{glossary-long}},
parent={glossarystyle}
}
-@index{glostyle.long3col-booktabs,
+@glossarystyle{glostyle.long3col-booktabs,
name={\glostylefmt{long3col\dhyphen booktabs}},
category={glossarystyle},
+ note={\styfmt{glossary-longbooktabs}},
parent={glossarystyle}
}
@@ -4323,193 +6837,223 @@ hyphen}},
alias = {categoryattribute}
}
-@index{recordcount,
+@categoryattribute{catattr.recordcount,
name={\catattrfmt{record\-count}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{glossname,
+@categoryattribute{catattr.glossname,
name={\catattrfmt{gloss\-name}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{glossnamefont,
+@categoryattribute{catattr.glossnamefont,
name={\catattrfmt{gloss\-name\-font}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{glossdesc,
+@categoryattribute{catattr.glossdesc,
name={\catattrfmt{gloss\-desc}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{glossdescfont,
+@categoryattribute{catattr.glossdescfont,
name={\catattrfmt{gloss\-desc\-font}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{textformat,
+@categoryattribute{catattr.textformat,
name={\catattrfmt{text\-format}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{headuc,
+@categoryattribute{catattr.headuc,
name={\catattrfmt{headuc}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{aposplural,
+@categoryattribute{catattr.aposplural,
name={\catattrfmt{apos\-plural}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{accessaposplural,
+@categoryattribute{catattr.accessaposplural,
name={\catattrfmt{access\-apos\-plural}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{noshortplural,
+@categoryattribute{catattr.noshortplural,
name={\catattrfmt{no\-short\-plural}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{accessnoshortplural,
+@categoryattribute{catattr.accessnoshortplural,
name={\catattrfmt{access\-no\-short\-plural}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{nameshortaccess,
+@categoryattribute{catattr.nameshortaccess,
name={\catattrfmt{name\-short\-access}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{firstshortaccess,
+@categoryattribute{catattr.firstshortaccess,
name={\catattrfmt{first\-short\-access}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{textshortaccess,
+@categoryattribute{catattr.textshortaccess,
name={\catattrfmt{text\-short\-access}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{markwords,
+@categoryattribute{catattr.markwords,
name={\catattrfmt{mark\-words}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{markshortwords,
+@categoryattribute{catattr.markshortwords,
name={\catattrfmt{mark\-short\-words}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{targeturl,
+@categoryattribute{catattr.targeturl,
name={\catattrfmt{target\-url}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{targetname,
+@categoryattribute{catattr.targetname,
name={\catattrfmt{target\-name}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{externallocation,
+@categoryattribute{catattr.externallocation,
name={\catattrfmt{external\-location}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{discardperiod,
+@categoryattribute{catattr.discardperiod,
name={\catattrfmt{discard\-period}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{pluraldiscardperiod,
+@categoryattribute{catattr.pluraldiscardperiod,
name={\catattrfmt{plural\-discard\-period}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{retainfirstuseperiod,
+@categoryattribute{catattr.retainfirstuseperiod,
name={\catattrfmt{retain\-first\-use\-period}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{insertdots,
+@categoryattribute{catattr.insertdots,
name={\catattrfmt{insert\-dots}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{accessinsertdots,
+@categoryattribute{catattr.accessinsertdots,
name={\catattrfmt{access\-insert\-dots}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{tagging,
+@categoryattribute{catattr.tagging,
name={\catattrfmt{tagging}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{nohyperfirst,
+@categoryattribute{catattr.nohyperfirst,
name={\catattrfmt{no\-hyper\-first}},
category={categoryattribute},
parent={categoryattribute}
}
-@index{ctr.equation,
+@categoryattribute{catattr.nohyper,
+ name={\catattrfmt{no\-hyper}},
+ category={categoryattribute},
+ parent={categoryattribute}
+}
+
+@categoryattribute{catattr.entrycount,
+ name={\catattrfmt{entry\-count}},
+ category={categoryattribute},
+ parent={categoryattribute}
+}
+
+@categoryattribute{catattr.hyperoutside,
+ name={\catattrfmt{hyper\-outside}},
+ category={categoryattribute},
+ parent={categoryattribute}
+}
+
+@categoryattribute{catattr.regular,
+ name={\catattrfmt{regular}},
+ category={categoryattribute},
+ parent={categoryattribute}
+}
+
+@categoryattribute{catattr.wrgloss,
+ name={\catattrfmt{wrgloss}},
+ category={categoryattribute},
+ parent={categoryattribute}
+}
+
+@counter{ctr.equation,
name={\counterfmt{equation}},
category={counter}
}
-@index{ctr.page,
+@counter{ctr.page,
name={\counterfmt{page}},
category={counter}
}
-@index{ctr.section,
+@counter{ctr.section,
name={\counterfmt{section}},
category={counter}
}
-@index{ctr.chapter,
+@counter{ctr.chapter,
name={\counterfmt{chapter}},
category={counter}
}
-@index{ctr.wrglossary,
+@counter{ctr.wrglossary,
name={\counterfmt{wrglossary}},
category={counter}
}
-@index{ctr.glossaryentry,
+@counter{ctr.glossaryentry,
name={\counterfmt{glossaryentry}},
category={counter}
}
-@index{ctr.glossarysubentry,
+@counter{ctr.glossarysubentry,
name={\counterfmt{glossarysubentry}},
category={counter}
}
@@ -4520,19 +7064,19 @@ hyphen}},
plural={label prefixes}
}
-@index{idprefix.dual,
+@labelprefix{idprefix.dual,
name={\idprefixfmt{dual}},
category={idprefix},
parent={labelprefixes}
}
-@index{idprefix.tertiary,
+@labelprefix{idprefix.tertiary,
name={\idprefixfmt{tertiary}},
category={idprefix},
parent={labelprefixes}
}
-@index{idprefix.extn,
+@labelprefix{idprefix.extn,
name={\idprefixfmt{ext\meta{n}}},
category={idprefix},
parent={labelprefixes}
@@ -4543,7 +7087,7 @@ hyphen}},
text={package option}
}
-@dualindexentry{styopt.record,
+@packageoption{styopt.record,
name={\styoptfmt{record}},
user1={\meta{value}},
description={unless the value is \styoptfmt{off}, this option sets
@@ -4559,7 +7103,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.accsupp,
+@packageoption{styopt.accsupp,
name={\styoptfmt{accsupp}},
description={load the \sty{glossaries-accsupp} package to provide
accessibility support},
@@ -4568,7 +7112,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.abbreviations,
+@packageoption{styopt.abbreviations,
name={\styoptfmt{abbreviations}},
description={creates the \code{abbreviations} glossary},
package={glossaries-extra},
@@ -4576,7 +7120,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.symbols,
+@packageoption{styopt.symbols,
name={\styoptfmt{symbols}},
package={glossaries,glossaries-extra},
description={defines the \code{symbols} glossary; with
@@ -4586,7 +7130,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.numbers,
+@packageoption{styopt.numbers,
name={\styoptfmt{numbers}},
package={glossaries,glossaries-extra},
description={defines the \code{numbers} glossary; with
@@ -4596,7 +7140,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.undefaction,
+@packageoption{styopt.undefaction,
name={\styoptfmt{undefaction}},
user1={\meta{value}},
description={indicates what to do if an undefined entry is
@@ -4608,7 +7152,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.indexcrossrefs,
+@packageoption{styopt.indexcrossrefs,
name={\styoptfmt{indexcrossrefs}},
user1={\meta{boolean}},
package={glossaries-extra},
@@ -4620,7 +7164,7 @@ hyphen}},
note={not relevant with \bibgls}
}
-@dualindexentry{styopt.autoseeindex,
+@packageoption{styopt.autoseeindex,
name={\styoptfmt{autoseeindex}},
user1={\meta{boolean}},
package={glossaries-extra},
@@ -4631,7 +7175,7 @@ hyphen}},
automatically indexes the cross-referenced term}
}
-@dualindexentry{styopt.nopostdot,
+@packageoption{styopt.nopostdot,
name={\styoptfmt{nopostdot}},
user1={\meta{boolean}},
package={glossaries,glossaries-extra},
@@ -4644,7 +7188,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.postdot,
+@packageoption{styopt.postdot,
name={\styoptfmt{postdot}},
package={glossaries-extra},
description={equivalent to \styopt[dot]{postpunc}},
@@ -4652,7 +7196,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.postpunc,
+@packageoption{styopt.postpunc,
name={\styoptfmt{postpunc}},
user1={\meta{value}},
package={glossaries-extra},
@@ -4666,7 +7210,7 @@ hyphen}},
adjusted), \meta{punctuation} (use \meta{punctuation})}
}
-@dualindexentry{styopt.indexcounter,
+@packageoption{styopt.indexcounter,
name={\styoptfmt{index\-counter}},
description={creates the \counter{wrglossary} counter, which is
incremented every time an entry is indexed with that counter, and sets
@@ -4676,7 +7220,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.docdef,
+@packageoption{styopt.docdef,
name={\styoptfmt{docdef}},
user1={\meta{value}},
package={glossaries-extra},
@@ -4693,7 +7237,7 @@ hyphen}},
reference to the entry)}
}
-@dualindexentry{styopt.nomissingglstext,
+@packageoption{styopt.nomissingglstext,
name={\styoptfmt{nomissingglstext}},
user1={\meta{boolean}},
package={glossaries-extra},
@@ -4705,7 +7249,7 @@ hyphen}},
if the associated external file doesn't exist}
}
-@dualindexentry{styopt.stylemods,
+@packageoption{styopt.stylemods,
name={\styoptfmt{stylemods}},
user1={\meta{value}},
description={load the \sty{glossaries-extra-stylemods} package with the
@@ -4719,7 +7263,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.nowarn,
+@packageoption{styopt.nowarn,
name={\styoptfmt{nowarn}},
package={glossaries},
category={packageoption},
@@ -4727,7 +7271,7 @@ hyphen}},
description={suppresses all \styfmt{glossaries}-related warnings}
}
-@dualindexentry{styopt.nolangwarn,
+@packageoption{styopt.nolangwarn,
name={\styoptfmt{nolangwarn}},
package={glossaries},
category={packageoption},
@@ -4735,7 +7279,7 @@ hyphen}},
description={suppresses warnings generated by missing language modules}
}
-@dualindexentry{styopt.noredefwarn,
+@packageoption{styopt.noredefwarn,
name={\styoptfmt{noredefwarn}},
package={glossaries},
category={packageoption},
@@ -4744,7 +7288,7 @@ hyphen}},
provided by another class or package}
}
-@dualindexentry{styopt.debug,
+@packageoption{styopt.debug,
name={\styoptfmt{debug}},
user1={\meta{value}},
package={glossaries,glossaries-extra},
@@ -4760,7 +7304,7 @@ hyphen}},
\styoptfmt{showwrgloss})}
}
-@dualindexentry{styopt.seenoindex,
+@packageoption{styopt.seenoindex,
name={\styoptfmt{seenoindex}},
user1={\meta{value}},
package={glossaries},
@@ -4776,7 +7320,7 @@ hyphen}},
does nothing if used before \cs{cs.makeglossaries})}
}
-@dualindexentry{styopt.nomain,
+@packageoption{styopt.nomain,
name={\styoptfmt{nomain}},
package={glossaries},
category={packageoption},
@@ -4785,7 +7329,7 @@ hyphen}},
glossary. If used an alternative glossary must be created}
}
-@dualindexentry{styopt.sanitizesort,
+@packageoption{styopt.sanitizesort,
name={\styoptfmt{sanitizesort}},
user1={\meta{boolean}},
package={glossaries},
@@ -4793,10 +7337,10 @@ hyphen}},
parent={packageoptions},
note={not relevant with \bibgls},
description={determines whether or not
- to sanitize the \field{sort} key}
+ to sanitize the \field{sort} key (not relevant with \bibgls)}
}
-@dualindexentry{styopt.savewrites,
+@packageoption{styopt.savewrites,
name={\styoptfmt{savewrites}},
user1={\meta{boolean}},
package={glossaries},
@@ -4809,7 +7353,7 @@ hyphen}},
glossary indexing file}
}
-@dualindexentry{styopt.translate,
+@packageoption{styopt.translate,
name={\styoptfmt{translate}},
user1={\meta{value}},
package={glossaries},
@@ -4825,7 +7369,7 @@ hyphen}},
\styfmt{translator} package, just load \styfmt{glossaries-babel})}
}
-@dualindexentry{styopt.notranslate,
+@packageoption{styopt.notranslate,
name={\styoptfmt{notranslate}},
package={glossaries},
category={packageoption},
@@ -4833,7 +7377,7 @@ hyphen}},
description={equivalent to \styopt[false]{translate}}
}
-@dualindexentry{styopt.nohypertypes,
+@packageoption{styopt.nohypertypes,
name={\styoptfmt{nohypertypes}},
user1={\meta{list}},
package={glossaries},
@@ -4842,7 +7386,7 @@ hyphen}},
description={suppress hyperlinks for the listed glossary types}
}
-@dualindexentry{styopt.hyperfirst,
+@packageoption{styopt.hyperfirst,
name={\styoptfmt{hyperfirst}},
user1={\meta{boolean}},
package={glossaries},
@@ -4853,7 +7397,7 @@ hyphen}},
\catattr{nohyperfirst} category attribute can selectively apply this)}
}
-@dualindexentry{styopt.indexonlyfirst,
+@packageoption{styopt.indexonlyfirst,
name={\styoptfmt{indexonlyfirst}},
user1={\meta{boolean}},
package={glossaries},
@@ -4862,7 +7406,7 @@ hyphen}},
description={if true, only performs indexing on first use}
}
-@dualindexentry{styopt.savenumberlist,
+@packageoption{styopt.savenumberlist,
name={\styoptfmt{savenumberlist}},
user1={\meta{boolean}},
package={glossaries},
@@ -4872,27 +7416,27 @@ hyphen}},
\bibgls\ use the \csopt{save-locations} resource option instead)}
}
-@dualindexentry{styopt.toc,
+@packageoption{styopt.toc,
name={\styoptfmt{toc}},
user1={\meta{boolean}},
package={glossaries},
category={packageoption},
parent={packageoptions},
description={if true (default for \styfmt{glossaries-extra}),
- automatically add each glossary to the table of contents}
+ automatically add each glossary to the \glsxtrlong{toc}}
}
-@dualindexentry{styopt.numberline,
+@packageoption{styopt.numberline,
name={\styoptfmt{numberline}},
user1={\meta{boolean}},
package={glossaries},
category={packageoption},
parent={packageoptions},
description={when used with \styopt[true]{toc}, this will add
- \code{\csfmt{numberline}\marg{}} to the start of the TOC entry}
+ \code{\csfmt{numberline}\marg{}} to the start of the \idx{toc} entry}
}
-@dualindexentry{styopt.section,
+@packageoption{styopt.section,
name={\styoptfmt{section}},
user1={\meta{value}},
package={glossaries},
@@ -4908,17 +7452,17 @@ hyphen}},
unstarred version is determined by \styopt{numberedsection}}
}
-@dualindexentry{styopt.ucmark,
+@packageoption{styopt.ucmark,
name={\styoptfmt{ucmark}},
user1={\meta{boolean}},
package={glossaries},
category={packageoption},
parent={packageoptions},
description={if true, converts the glossary mark (used in page
- headings) to upper case with \cs{MakeTextUppercase}}
+ headings) to \idx{uppercase} with \cs{MakeTextUppercase}}
}
-@dualindexentry{styopt.numberedsection,
+@packageoption{styopt.numberedsection,
name={\styoptfmt{numberedsection}},
user1={\meta{value}},
package={glossaries},
@@ -4933,7 +7477,7 @@ hyphen}},
given \styoptfmt{nolabel} is assumed}
}
-@dualindexentry{styopt.entrycounter,
+@packageoption{styopt.entrycounter,
name={\styoptfmt{entrycounter}},
user1={\meta{boolean}},
package={glossaries},
@@ -4945,7 +7489,7 @@ hyphen}},
\cs{glsxtrpageref})}
}
-@dualindexentry{styopt.counterwithin,
+@packageoption{styopt.counterwithin,
name={\styoptfmt{counterwithin}},
user1={\meta{counter name}},
package={glossaries},
@@ -4955,7 +7499,7 @@ hyphen}},
indicates the master counter for \counter{glossaryentry}}
}
-@dualindexentry{styopt.subentrycounter,
+@packageoption{styopt.subentrycounter,
name={\styoptfmt{subentrycounter}},
user1={\meta{boolean}},
package={glossaries},
@@ -4968,7 +7512,7 @@ hyphen}},
independent of \styopt{entrycounter} and \counter{glossaryentry}}
}
-@dualindexentry{styopt.style,
+@packageoption{styopt.style,
name={\styoptfmt{style}},
user1={\meta{name}},
package={glossaries},
@@ -4977,7 +7521,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.nolong,
+@packageoption{styopt.nolong,
name={\styoptfmt{nolong}},
package={glossaries},
description={prevents the \sty{glossary-long} package (which
@@ -4987,7 +7531,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.nosuper,
+@packageoption{styopt.nosuper,
name={\styoptfmt{nosuper}},
package={glossaries},
description={prevents the \sty{glossary-super} package (which
@@ -4997,7 +7541,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.nolist,
+@packageoption{styopt.nolist,
name={\styoptfmt{nolist}},
package={glossaries},
description={prevents the \sty{glossary-list} package (which
@@ -5007,7 +7551,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.notree,
+@packageoption{styopt.notree,
name={\styoptfmt{notree}},
package={glossaries},
category={packageoption},
@@ -5017,7 +7561,7 @@ hyphen}},
automatically loaded}
}
-@dualindexentry{styopt.nostyles,
+@packageoption{styopt.nostyles,
name={\styoptfmt{nostyles}},
package={glossaries},
description={prevents all the default styles from being loaded. If
@@ -5028,7 +7572,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.esclocations,
+@packageoption{styopt.esclocations,
name={\styoptfmt{esclocations}},
user1={\meta{boolean}},
package={glossaries},
@@ -5040,7 +7584,7 @@ hyphen}},
locations}
}
-@dualindexentry{styopt.nonumberlist,
+@packageoption{styopt.nonumberlist,
name={\styoptfmt{nonumberlist}},
package={glossaries},
description={suppresses the location lists from being
@@ -5053,7 +7597,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.seeautonumberlist,
+@packageoption{styopt.seeautonumberlist,
name={\styoptfmt{seeautonumberlist}},
package={glossaries},
category={packageoption},
@@ -5064,7 +7608,7 @@ hyphen}},
for the associated entry}
}
-@dualindexentry{styopt.counter,
+@packageoption{styopt.counter,
name={\styoptfmt{counter}},
user1={\meta{value}},
description={sets the default location counter to \meta{value}
@@ -5076,7 +7620,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.nogroupskip,
+@packageoption{styopt.nogroupskip,
name={\styoptfmt{nogroupskip}},
user1={\meta{boolean}},
description={if true, suppresses the visual separation between
@@ -5086,7 +7630,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.sort,
+@packageoption{styopt.sort,
name={\styoptfmt{sort}},
user1={\meta{value}},
note={not relevant with \bibgls, use the \csopt{sort}
@@ -5104,7 +7648,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.order,
+@packageoption{styopt.order,
name={\styoptfmt{order}},
user1={\meta{value}},
note={not relevant with \bibgls, use the \csopt{break-at}
@@ -5115,7 +7659,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.makeindex,
+@packageoption{styopt.makeindex,
name={\styoptfmt{makeindex}},
note={not relevant with \bibgls},
description={write the indexing
@@ -5125,7 +7669,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.xindy,
+@packageoption{styopt.xindy,
name={\styoptfmt{xindy}},
user1={\meta{settings}},
note={not relevant with \bibgls},
@@ -5138,7 +7682,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.xindygloss,
+@packageoption{styopt.xindygloss,
name={\styoptfmt{xindygloss}},
package={glossaries},
category={packageoption},
@@ -5147,7 +7691,7 @@ hyphen}},
description={equivalent to \styopt[\empty]{xindy}}
}
-@dualindexentry{styopt.xindynoglsnumbers,
+@packageoption{styopt.xindynoglsnumbers,
name={\styoptfmt{xindynoglsnumbers}},
package={glossaries},
category={packageoption},
@@ -5156,7 +7700,7 @@ hyphen}},
description={equivalent to \styopt[glsnumbers=false]{xindy}}
}
-@dualindexentry{styopt.automake,
+@packageoption{styopt.automake,
name={\styoptfmt{automake}},
user1={\meta{boolean}},
description={if true, tries to use \TeX's shell escape to
@@ -5167,7 +7711,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.acronym,
+@packageoption{styopt.acronym,
name={\styoptfmt{acronym}},
user1={\meta{boolean}},
package={glossaries},
@@ -5176,7 +7720,7 @@ hyphen}},
description={if true, creates a new glossary with the label \code{acronym}}
}
-@dualindexentry{styopt.acronyms,
+@packageoption{styopt.acronyms,
name={\styoptfmt{acronyms}},
package={glossaries},
category={packageoption},
@@ -5184,7 +7728,7 @@ hyphen}},
description={equivalent to \styopt[true]{acronym}}
}
-@dualindexentry{styopt.acronymlists,
+@packageoption{styopt.acronymlists,
name={\styoptfmt{acronymlists}},
user1={\meta{list}},
package={glossaries},
@@ -5194,7 +7738,7 @@ hyphen}},
(don't use with \sty{glossaries-extra})}
}
-@dualindexentry{styopt.shortcuts,
+@packageoption{styopt.shortcuts,
name={\styoptfmt{shortcuts}},
package={glossaries,glossaries-extra},
user1={\meta{value}},
@@ -5215,7 +7759,7 @@ hyphen}},
parent={packageoptions}
}
-@dualindexentry{styopt.index,
+@packageoption{styopt.index,
name={\styoptfmt{index}},
package={glossaries},
description={defines the \code{index} glossary and \csref{newterm}},
@@ -5228,7 +7772,7 @@ hyphen}},
text={field}
}
-@dualindexentry{field.alias,
+@field{field.alias,
name={\fieldfmt{alias}},
description={The entry with this field set is a synonym of the
entry whose label is given by this field.},
@@ -5237,7 +7781,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.category,
+@field{field.category,
name={\fieldfmt{category}},
description={The entry's category label.},
note={\styfmt{glossaries-extra}},
@@ -5245,7 +7789,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.description,
+@field{field.description,
name={\fieldfmt{description}},
description={The description displayed in the glossary.},
note={\styfmt{glossaries}},
@@ -5253,7 +7797,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.descriptionplural,
+@field{field.descriptionplural,
name={\fieldfmt{descriptionplural}},
description={The plural form of the description.},
note={\styfmt{glossaries}},
@@ -5261,7 +7805,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.first,
+@field{field.first,
name={\fieldfmt{first}},
description={The text to display on first use with \cs{gls}\margm{label}.},
note={\styfmt{glossaries}},
@@ -5269,7 +7813,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.firstplural,
+@field{field.firstplural,
name={\fieldfmt{firstplural}},
description={The text to display on first use with \cs{glspl}\margm{label}.},
note={\styfmt{glossaries}},
@@ -5277,7 +7821,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.long,
+@field{field.long,
name={\fieldfmt{long}},
description={The long form of an abbreviation. (Set internally
by commands like \csref{newabbreviation}.)},
@@ -5286,7 +7830,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.longplural,
+@field{field.longplural,
name={\fieldfmt{longplural}},
description={The plural long form of an abbreviation.},
note={\styfmt{glossaries}},
@@ -5294,7 +7838,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.name,
+@field{field.name,
name={\fieldfmt{name}},
description={The name displayed in the glossary.},
note={\styfmt{glossaries}},
@@ -5302,15 +7846,16 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.parent,
+@field{field.parent,
name={\fieldfmt{parent}},
- description={The parent entry's label.},
+ description={The parent entry's label. See
+ \sectionref{sec:logicaldivisions}.},
note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
-@dualindexentry{field.plural,
+@field{field.plural,
name={\fieldfmt{plural}},
description={The text to display on subsequent use of
\cs{glspl}\margm{label}.},
@@ -5319,7 +7864,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.see,
+@field{field.see,
name={\fieldfmt{see}},
description={General purpose cross-reference
(syntax: \code{see=\marg{\oargm{tag}\meta{xr-list}}}).},
@@ -5328,7 +7873,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.seealso,
+@field{field.seealso,
name={\fieldfmt{seealso}},
description={Cross-reference related entries
(syntax: \code{seealso=\margm{xr-list}}).},
@@ -5337,7 +7882,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.short,
+@field{field.short,
name={\fieldfmt{short}},
description={The short form of an abbreviation. (Set internally
by commands like \csref{newabbreviation}.)},
@@ -5346,7 +7891,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.shortplural,
+@field{field.shortplural,
name={\fieldfmt{shortplural}},
description={The plural short form of an abbreviation.},
note={\styfmt{glossaries}},
@@ -5354,7 +7899,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.symbol,
+@field{field.symbol,
name={\fieldfmt{symbol}},
description={The associated symbol.},
note={\styfmt{glossaries}},
@@ -5362,7 +7907,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.symbolplural,
+@field{field.symbolplural,
name={\fieldfmt{symbolplural}},
description={The plural form of the associated symbol.},
note={\styfmt{glossaries}},
@@ -5370,7 +7915,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.text,
+@field{field.text,
name={\fieldfmt{text}},
description={The text to display on subsequent use of
\cs{gls}\margm{label}.},
@@ -5379,7 +7924,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.user1,
+@field{field.user1,
name={\fieldfmt{user1}},
description={A general purpose user field.},
note={\styfmt{glossaries}},
@@ -5387,7 +7932,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.user2,
+@field{field.user2,
name={\fieldfmt{user2}},
description={A general purpose user field.},
note={\styfmt{glossaries}},
@@ -5395,7 +7940,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.user3,
+@field{field.user3,
name={\fieldfmt{user3}},
description={A general purpose user field.},
note={\styfmt{glossaries}},
@@ -5403,7 +7948,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.user4,
+@field{field.user4,
name={\fieldfmt{user4}},
description={A general purpose user field.},
note={\styfmt{glossaries}},
@@ -5411,7 +7956,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.user5,
+@field{field.user5,
name={\fieldfmt{user5}},
description={A general purpose user field.},
note={\styfmt{glossaries}},
@@ -5419,7 +7964,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.user6,
+@field{field.user6,
name={\fieldfmt{user6}},
description={A general purpose user field.},
note={\styfmt{glossaries}},
@@ -5427,7 +7972,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.duallong,
+@field{field.duallong,
name={\fieldfmt{duallong}},
description={The long form of a dual
abbreviation mapped by \atentry{dualabbreviation}.},
@@ -5436,8 +7981,8 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.duallongplural,
- name={\fieldfmt{duallongplural}},
+@field{field.duallongplural,
+ name={\fieldfmt{dual\-long\-plural}},
description={The plural long form of a dual
abbreviation mapped by \atentry{dualabbreviation}.},
note={\appfmt{bib2gls}},
@@ -5445,7 +7990,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.dualshort,
+@field{field.dualshort,
name={\fieldfmt{dualshort}},
description={The short form of a dual
abbreviation mapped by \atentry{dualabbreviation}.},
@@ -5454,8 +7999,8 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.dualshortplural,
- name={\fieldfmt{dualshortplural}},
+@field{field.dualshortplural,
+ name={\fieldfmt{dual\-short\-plural}},
description={The plural short form of a dual abbreviation
mapped by \atentry{dualabbreviation}.},
note={\appfmt{bib2gls}},
@@ -5463,7 +8008,17 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.prefix,
+@field{field.adoptparents,
+ name={\fieldfmt{adopt\-parents}},
+ description={The list of adopted parents for entries spawned by
+ \atentry{progenitor}. (Field only available for use in
+ \ext{bib} file within \atentry{progenitor}-like entries.)},
+ note={\appfmt{bib2gls}},
+ category={bib2glsfield},
+ parent={fields}
+}
+
+@field{field.prefix,
name={\fieldfmt{prefix}},
description={The prefix associated with the \field{text}
field.},
@@ -5472,7 +8027,7 @@ hyphen}},
parent={fields}
}
-@dualindexentry{field.prefixfirst,
+@field{field.prefixfirst,
name={\fieldfmt{prefixfirst}},
description={The prefix associated with the \field{first}
field.},
@@ -5481,7 +8036,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.prefixfirstplural,
+@field{field.prefixfirstplural,
name={\fieldfmt{prefixfirstplural}},
description={The prefix associated with the
\field{firstplural} field.},
@@ -5490,7 +8045,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.prefixplural,
+@field{field.prefixplural,
name={\fieldfmt{prefixplural}},
description={The prefix associated with the
\field{plural} field.},
@@ -5499,7 +8054,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.access,
+@field{field.access,
name={\fieldfmt{access}},
description={The replacement text for the \field{name} field.},
note={\styfmt{glossaries-accsupp}},
@@ -5507,7 +8062,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.descriptionaccess,
+@field{field.descriptionaccess,
name={\fieldfmt{descriptionaccess}},
description={The replacement text for the
\field{description} field.},
@@ -5516,7 +8071,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.descriptionpluralaccess,
+@field{field.descriptionpluralaccess,
name={\fieldfmt{descriptionpluralaccess}},
description={The replacement text for the
\field{descriptionplural} field.},
@@ -5525,7 +8080,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.firstaccess,
+@field{field.firstaccess,
name={\fieldfmt{firstaccess}},
description={The replacement text for the \field{first} field.},
note={\styfmt{glossaries-accsupp}},
@@ -5533,7 +8088,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.firstpluralaccess,
+@field{field.firstpluralaccess,
name={\fieldfmt{firstpluralaccess}},
description={The replacement text for the
\field{firstplural} field.},
@@ -5542,7 +8097,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.longaccess,
+@field{field.longaccess,
name={\fieldfmt{longaccess}},
description={The replacement text for the \field{long} field.},
note={\styfmt{glossaries-accsupp}},
@@ -5550,7 +8105,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.longpluralaccess,
+@field{field.longpluralaccess,
name={\fieldfmt{longpluralaccess}},
description={The replacement text for the
\field{longplural} field.},
@@ -5559,7 +8114,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.pluralaccess,
+@field{field.pluralaccess,
name={\fieldfmt{pluralaccess}},
description={The replacement text for the \field{plural} field.},
note={\styfmt{glossaries-accsupp}},
@@ -5567,7 +8122,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.shortaccess,
+@field{field.shortaccess,
name={\fieldfmt{shortaccess}},
description={The replacement text for the \field{short} field.},
note={\styfmt{glossaries-accsupp}},
@@ -5575,7 +8130,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.shortpluralaccess,
+@field{field.shortpluralaccess,
name={\fieldfmt{shortpluralaccess}},
description={The replacement text for the
\field{shortplural} field.},
@@ -5584,7 +8139,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.symbolaccess,
+@field{field.symbolaccess,
name={\fieldfmt{symbolaccess}},
description={The replacement text for the \field{symbol} field.},
note={\styfmt{glossaries-accsupp}},
@@ -5592,7 +8147,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.symbolpluralaccess,
+@field{field.symbolpluralaccess,
name={\fieldfmt{symbolpluralaccess}},
description={The replacement text for the
\field{symbolplural} field.},
@@ -5601,7 +8156,7 @@ field.},
parent={fields}
}
-@dualindexentry{field.textaccess,
+@field{field.textaccess,
name={\fieldfmt{textaccess}},
description={The replacement text for the
\field{text} field.},
@@ -5615,7 +8170,7 @@ field.},
text={internal fields}
}
-@dualindexentry{field.childcount,
+@field{field.childcount,
name={\fieldfmt{childcount}},
description={Stores the number of children this entry has
had selected.},
@@ -5624,7 +8179,7 @@ field.},
parent={internalfields}
}
-@dualindexentry{field.childlist,
+@field{field.childlist,
name={\fieldfmt{childlist}},
description={A list of labels (in \sty{etoolbox}'s internal list
format) of the children this entry has had selected.},
@@ -5633,7 +8188,16 @@ field.},
parent={internalfields}
}
-@dualindexentry{field.primarylocations,
+@field{field.originalentrytype,
+ name={\fieldfmt{original\-entry\-type}},
+ description={The original entry type before any aliasing was
+ applied or the actual entry type if no aliasing.},
+ note={internal field set by \appfmt{bib2gls}},
+ category={internalfield},
+ parent={internalfields}
+}
+
+@field{field.primarylocations,
name={\fieldfmt{primarylocations}},
description={Stores the locations that use one of the designated
primary formats, if enabled.},
@@ -5642,7 +8206,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.indexcounter,
+@field{field.indexcounter,
name={\fieldfmt{index\-counter}},
description={Stores the location corresponding to the matching
\counter{wrglossary} reference.},
@@ -5651,7 +8215,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.counter,
+@field{field.counter,
name={\fieldfmt{counter}},
description={The default counter used for indexing (assigned by
the \csopt{counter} option).},
@@ -5660,16 +8224,17 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.group,
+@field{field.group,
name={\fieldfmt{group}},
description={The letter group determined by the comparator
- (or assigned by the \csopt{group} option).},
+ (or assigned by the \csopt{group} option). See
+ \sectionref{sec:logicaldivisions}.},
note={internal field set by \appfmt{bib2gls}},
category={internalfield},
parent={internalfields}
}
-@dualindexentry{field.location,
+@field{field.location,
name={\fieldfmt{location}},
description={The typeset location list.},
note={internal field set by \appfmt{bib2gls}},
@@ -5677,7 +8242,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.loclist,
+@field{field.loclist,
name={\fieldfmt{loclist}},
description={The internal list of locations.},
note={internal field set by \appfmt{bib2gls}},
@@ -5685,7 +8250,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.recordcount,
+@field{field.recordcount,
name={\fieldfmt{recordcount}},
description={Used with record counting to store the
total record count.},
@@ -5694,7 +8259,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.recordcount.counter,
+@field{field.recordcount.counter,
name={\fieldfmt{recordcount.\discretionary{}{}{}\meta{counter}}},
description={Used with record counting to store the
total number of records for a given counter.},
@@ -5703,7 +8268,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.recordcount.counter.location,
+@field{field.recordcount.counter.location,
name={\fieldfmt{recordcount.\discretionary{}{}{}\meta{counter}.\discretionary{}{}{}\meta{location}}},
description={Used with record counting to store the
total number of records for a given location.},
@@ -5712,7 +8277,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.secondarygroup,
+@field{field.secondarygroup,
name={\fieldfmt{secondarygroup}},
description={The letter group determined by the
comparator used with the \csopt{secondary} sort.},
@@ -5721,7 +8286,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.secondarysort,
+@field{field.secondarysort,
name={\fieldfmt{secondarysort}},
description={The sort value determined by the
comparator used with the \csopt{secondary} sort.},
@@ -5730,7 +8295,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.dual,
+@field{field.dual,
name={\fieldfmt{dual}},
description={Created by \csopt{dual-field} if set with no value,
this field is used to store the dual label.},
@@ -5739,7 +8304,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.sort,
+@field{field.sort,
name={\fieldfmt{sort}},
description={The sort value obtained by the comparator.},
note={internal field set by \appfmt{bib2gls}},
@@ -5747,16 +8312,17 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.type,
+@field{field.type,
name={\fieldfmt{type}},
description={The glossary this entry belongs to (assigned by
- the \csopt{type} option).},
+ the \csopt{type} option). See
+ \sectionref{sec:logicaldivisions}.},
note={internal field set by \appfmt{bib2gls}},
category={internalfield},
parent={internalfields}
}
-@dualindexentry{field.fieldendpunc,
+@field{field.fieldendpunc,
name={\meta{field}\fieldfmt{endpunc}},
description={Used with the \csopt{check-end-punctuation}
option.},
@@ -5765,7 +8331,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.bibtextype,
+@field{field.bibtextype,
name={\fieldfmt{bib\-tex\-type}},
description={Used by \bibgls\ as a substitution for \BibTeX's
\fieldfmt{type} field when parsing \atentry{bibtexentry}. Needs
@@ -5775,7 +8341,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.bibtexcontributor,
+@field{field.bibtexcontributor,
name={\fieldfmt{bib\-tex\-con\-trib\-u\-tor}},
description={An internal list field provided when a
\atentry{contributor} entry is automatically
@@ -5785,7 +8351,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.bibtexentry,
+@field{field.bibtexentry,
name={\fieldfmt{bib\-tex\-entry}},
description={An internal list field created by \atentry{bibtexentry}.},
note={internal field set by \bibgls},
@@ -5793,7 +8359,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.bibtexentry@entrytype,
+@field{field.bibtexentry@entrytype,
name={\fieldfmt{bib\-tex\-entry\-@\meta{entry-type}}},
description={An internal list field created by \atentry{bibtexentry}.},
note={internal field set by \bibgls},
@@ -5801,7 +8367,25 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.currcount,
+@field{field.progeny,
+ name={\fieldfmt{progeny}},
+ description={A comma-separated list of labels identifying
+ the entries spawned by \atentry{progenitor}.},
+ note={internal field set by \appfmt{bib2gls}},
+ category={internalfield},
+ parent={internalfields}
+}
+
+@field{field.progenitor,
+ name={\fieldfmt{progenitor}},
+ description={The label identifying the \atentry{progenitor}
+ that spawned this entry.},
+ note={internal field set by \appfmt{bib2gls}},
+ category={internalfield},
+ parent={internalfields}
+}
+
+@field{field.currcount,
name={\fieldfmt{currcount}},
description={Used with entry counting to store the current total.},
note={internal field set by \styfmt{glossaries}},
@@ -5809,7 +8393,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.currcountunit,
+@field{field.currcountunit,
name={\fieldfmt{currcount@}\meta{value}},
description={Used with unit entry counting (\styfmt{glossaries-extra}).},
note={internal field set by \styfmt{glossaries-extra}},
@@ -5817,7 +8401,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.desc,
+@field{field.desc,
name={\fieldfmt{desc}},
description={Corresponds to \field{description} key.},
note={internal field set by \styfmt{glossaries}},
@@ -5825,7 +8409,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.descplural,
+@field{field.descplural,
name={\fieldfmt{descplural}},
description={Corresponds to \field{descriptionplural} key.},
note={internal field set by \styfmt{glossaries}},
@@ -5833,7 +8417,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.firstpl,
+@field{field.firstpl,
name={\fieldfmt{firstpl}},
description={Corresponds to \field{firstplural} key.},
note={internal field set by \styfmt{glossaries}},
@@ -5841,7 +8425,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.flag,
+@field{field.flag,
name={\fieldfmt{flag}},
description={Boolean that determines if an entry has been used.},
note={internal field set by \styfmt{glossaries}},
@@ -5849,7 +8433,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.index,
+@field{field.index,
name={\fieldfmt{index}},
description={The main part of the indexing code
(\appfmt{makeindex} or \appfmt{xindy}).},
@@ -5858,7 +8442,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.level,
+@field{field.level,
name={\fieldfmt{level}},
description={Hierarchical level.},
note={internal field set by \styfmt{glossaries}},
@@ -5866,7 +8450,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.longpl,
+@field{field.longpl,
name={\fieldfmt{longpl}},
description={Corresponds to \field{longplural} key.},
note={internal field set by \styfmt{glossaries}},
@@ -5874,7 +8458,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.nonumberlist,
+@field{field.nonumberlist,
name={\fieldfmt{nonumberlist}},
description={Used to suppress the location list for a specific entry.},
note={internal field set by \styfmt{glossaries}},
@@ -5882,7 +8466,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.prevcount,
+@field{field.prevcount,
name={\fieldfmt{prevcount}},
description={Used with entry counting to store the total
from the previous run.},
@@ -5891,7 +8475,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.prevcountunit,
+@field{field.prevcountunit,
name={\fieldfmt{prevcount@}\meta{value}},
description={Used with unit entry counting
(\styfmt{glossaries-extra}).},
@@ -5900,7 +8484,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.prevunitmax,
+@field{field.prevunitmax,
name={\fieldfmt{prevunitmax}},
description={Used with unit entry counting
(\styfmt{glossaries-extra}).},
@@ -5909,7 +8493,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.prevunittotal,
+@field{field.prevunittotal,
name={\fieldfmt{prevunittotal}},
description={Used with unit entry counting
(\styfmt{glossaries-extra}).},
@@ -5918,7 +8502,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.shortpl,
+@field{field.shortpl,
name={\fieldfmt{shortpl}},
description={Corresponds to \field{shortplural} key.},
note={internal field set by \styfmt{glossaries}},
@@ -5926,7 +8510,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.sortvalue,
+@field{field.sortvalue,
name={\fieldfmt{sortvalue}},
description={Original \field{sort} value
(before sanitizing and escaping special characters).},
@@ -5935,7 +8519,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.unitlist,
+@field{field.unitlist,
name={\fieldfmt{unitlist}},
description={Used with unit entry counting
(\styfmt{glossaries-extra}).},
@@ -5944,7 +8528,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.useri,
+@field{field.useri,
name={\fieldfmt{useri}},
description={Corresponds to \field{user1} key.},
note={internal field set by \styfmt{glossaries}},
@@ -5952,7 +8536,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.userii,
+@field{field.userii,
name={\fieldfmt{userii}},
description={Corresponds to \field{user2} key.},
note={internal field set by \styfmt{glossaries}},
@@ -5960,7 +8544,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.useriii,
+@field{field.useriii,
name={\fieldfmt{useriii}},
description={Corresponds to \field{user3} key.},
note={internal field set by \styfmt{glossaries}},
@@ -5968,7 +8552,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.useriv,
+@field{field.useriv,
name={\fieldfmt{useriv}},
description={Corresponds to \field{user4} key.},
note={internal field set by \styfmt{glossaries}},
@@ -5976,7 +8560,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.userv,
+@field{field.userv,
name={\fieldfmt{userv}},
description={Corresponds to \field{user5} key.},
note={internal field set by \styfmt{glossaries}},
@@ -5984,7 +8568,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.uservi,
+@field{field.uservi,
name={\fieldfmt{uservi}},
description={Corresponds to \field{user6} key.},
note={internal field set by \styfmt{glossaries}},
@@ -5992,7 +8576,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.bib2gls@sort,
+@field{field.bib2gls@sort,
name={\fieldfmt{bib2gls@sort}},
description={Used by \bibgls\ to store the actual sort value.},
note={internal field set by \bibgls},
@@ -6000,7 +8584,7 @@ primary formats, if enabled.},
parent={internalfields}
}
-@dualindexentry{field.bib2gls@sortfallback,
+@field{field.bib2gls@sortfallback,
name={\fieldfmt{bib2gls@sortfallback}},
description={Used by \bibgls\ to store the sort fallback value.},
note={internal field set by \bibgls},
@@ -6013,144 +8597,204 @@ primary formats, if enabled.},
text={entry type}
}
-@dualindexentry{entry.string,
+@entrytype{entry.string,
name={\atentryfmt{string}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.preamble,
+@entrytype{entry.preamble,
name={\atentryfmt{preamble}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.entry,
+@entrytype{entry.comment,
+ name={\atentryfmt{comment}},
+ category={entrytype},
+ parent={entrytypes}
+}
+
+@entrytype{entry.entry,
name={\atentryfmt{entry}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.symbol,
+@entrytype{entry.symbol,
name={\atentryfmt{symbol}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.number,
+@entrytype{entry.number,
name={\atentryfmt{number}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.index,
+@entrytype{entry.index,
name={\atentryfmt{index}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.indexplural,
+@entrytype{entry.indexplural,
name={\atentryfmt{indexplural}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.abbreviation,
+@entrytype{entry.abbreviation,
name={\atentryfmt{abbreviation}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.acronym,
+@entrytype{entry.acronym,
name={\atentryfmt{acronym}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.dualentry,
+@entrytype{entry.dualentry,
name={\atentryfmt{dual\-entry}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.dualindexentry,
+@entrytype{entry.dualindexentry,
name={\atentryfmt{dual\-index\-entry}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.dualindexabbreviation,
+@entrytype{entry.dualindexabbreviation,
name={\atentryfmt{dual\-index\-abbre\-via\-tion}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.dualindexsymbol,
+@entrytype{entry.dualindexsymbol,
name={\atentryfmt{dual\-index\-symbol}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.dualindexnumber,
+@entrytype{entry.dualindexnumber,
name={\atentryfmt{dual\-index\-number}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.dualabbreviationentry,
+@entrytype{entry.dualabbreviationentry,
name={\atentryfmt{dual\-abbre\-via\-tion\-entry}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.dualentryabbreviation,
+@entrytype{entry.dualentryabbreviation,
name={\atentryfmt{dual\-entry\-abbre\-via\-tion}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.dualsymbol,
+@entrytype{entry.dualsymbol,
name={\atentryfmt{dual\-symbol}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.dualnumber,
+@entrytype{entry.dualnumber,
name={\atentryfmt{dual\-number}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.dualabbreviation,
+@entrytype{entry.dualabbreviation,
name={\atentryfmt{dual\-abbre\-via\-tion}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.dualacronym,
+@entrytype{entry.dualacronym,
name={\atentryfmt{dual\-acronym}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.tertiaryindexabbreviationentry,
+@entrytype{entry.tertiaryindexabbreviationentry,
name={\atentryfmt{tert\-iary\-index\-abbre\-via\-tion\-entry}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.bibtexentry,
+@entrytype{entry.bibtexentry,
name={\atentryfmt{bib\-tex\-entry}},
category={entrytype},
parent={entrytypes}
}
-@dualindexentry{entry.contributor,
+@entrytype{entry.contributor,
name={\atentryfmt{contributor}},
category={entrytype},
parent={entrytypes}
}
+@entrytype{entry.progenitor,
+ name={\atentryfmt{progenitor}},
+ category={entrytype},
+ parent={entrytypes}
+}
+
+@entrytype{entry.spawnindex,
+ name={\atentryfmt{spawn\-index}},
+ category={entrytype},
+ parent={entrytypes}
+}
+
+@entrytype{entry.spawnindexplural,
+ name={\atentryfmt{spawn\-index\-plural}},
+ category={entrytype},
+ parent={entrytypes}
+}
+
+@entrytype{entry.spawnentry,
+ name={\atentryfmt{spawn\-entry}},
+ category={entrytype},
+ parent={entrytypes}
+}
+
+@entrytype{entry.spawnsymbol,
+ name={\atentryfmt{spawn\-symbol}},
+ category={entrytype},
+ parent={entrytypes}
+}
+
+@entrytype{entry.spawnnumber,
+ name={\atentryfmt{spawn\-number}},
+ category={entrytype},
+ parent={entrytypes}
+}
+
+@entrytype{entry.spawnabbreviation,
+ name={\atentryfmt{spawn\-abbreviation}},
+ category={entrytype},
+ parent={entrytypes}
+}
+
+@entrytype{entry.spawnacronym,
+ name={\atentryfmt{spawn\-acronym}},
+ category={entrytype},
+ parent={entrytypes}
+}
+
+@entrytype{entry.spawndualindexentry,
+ name={\atentryfmt{spawn\-dual\-index\-entry}},
+ category={entrytype},
+ parent={entrytypes}
+}
+
@index{switches,
name={switches},
text={switch},
@@ -6163,7 +8807,7 @@ primary formats, if enabled.},
text={command line option}
}
-@dualindexentry{switch.help,
+@switch{switch.help,
name={\longargfmt{help}},
symbol={\shortargfmt{h}},
user1={},
@@ -6171,7 +8815,7 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.version,
+@switch{switch.version,
name={\longargfmt{version}},
symbol={\shortargfmt{v}},
user1={},
@@ -6179,14 +8823,14 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.debug,
+@switch{switch.debug,
name={\longargfmt{debug}},
user1={\oargm{n}},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-debug,
+@switch{switch.no-debug,
name={\longargfmt{no\dhyphen debug}},
symbol={\longargfmt{nodebug}},
user1={},
@@ -6194,14 +8838,14 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.verbose,
+@switch{switch.verbose,
name={\longargfmt{verbose}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-verbose,
+@switch{switch.no-verbose,
name={\longargfmt{no\dhyphen verbose}},
symbol={\longargfmt{noverbose}},
user1={},
@@ -6209,14 +8853,14 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.silent,
+@switch{switch.silent,
name={\longargfmt{silent}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.locale,
+@switch{switch.locale,
name={\longargfmt{locale}},
symbol={\shortargfmt{l}},
user1={\meta{lang}},
@@ -6224,7 +8868,7 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.log-file,
+@switch{switch.log-file,
name={\longargfmt{log\dhyphen file}},
symbol={\shortargfmt{t}},
user1={\meta{filename}},
@@ -6232,7 +8876,7 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.dir,
+@switch{switch.dir,
name={\longargfmt{dir}},
symbol={\shortargfmt{d}},
user1={\meta{dirname}},
@@ -6240,70 +8884,98 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.interpret,
+@switch{switch.interpret,
name={\longargfmt{interpret}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-interpret,
+@switch{switch.no-interpret,
name={\longargfmt{no\dhyphen interpret}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.break-space,
+@switch{switch.warn-non-bib-fields,
+ name={\longargfmt{warn\dhyphen non\dhyphen bib\dhyphen fields}},
+ user1={},
+ category={switch},
+ parent={commandlineoptions}
+}
+
+@switch{switch.no-warn-non-bib-fields,
+ name={\longargfmt{no\dhyphen warn\dhyphen non\dhyphen bib\dhyphen fields}},
+ user1={},
+ category={switch},
+ parent={commandlineoptions}
+}
+
+@switch{switch.warn-unknown-entry-types,
+ name={\longargfmt{warn\dhyphen unknown\dhyphen entry\dhyphen types}},
+ user1={},
+ category={switch},
+ parent={commandlineoptions}
+}
+
+@switch{switch.no-warn-unknown-entry-types,
+ name={\longargfmt{no\dhyphen warn\dhyphen unknown\dhyphen entry\dhyphen types}},
+ user1={},
+ category={switch},
+ parent={commandlineoptions}
+}
+
+@switch{switch.break-space,
name={\longargfmt{break\dhyphen space}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-break-space,
+@switch{switch.no-break-space,
name={\longargfmt{no\dhyphen break\dhyphen space}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.cite-as-record,
+@switch{switch.cite-as-record,
name={\longargfmt{cite\dhyphen as\dhyphen record}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-cite-as-record,
+@switch{switch.no-cite-as-record,
name={\longargfmt{no\dhyphen cite\dhyphen as\dhyphen record}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.merge-wrglossary-records,
+@switch{switch.merge-wrglossary-records,
name={\longargfmt{merge\dhyphen wrglossary\dhyphen records}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-merge-wrglossary-records,
+@switch{switch.no-merge-wrglossary-records,
name={\longargfmt{no\dhyphen merge\dhyphen wrglossary\dhyphen records}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.merge-nameref-on,
+@switch{switch.merge-nameref-on,
name={\longargfmt{merge\dhyphen nameref\dhyphen on}},
user1={\meta{rule}},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.force-cross-resource-refs,
+@switch{switch.force-cross-resource-refs,
name={\longargfmt{force\dhyphen cross\dhyphen resource\dhyphen refs}},
symbol={\shortargfmt{x}},
user1={},
@@ -6311,28 +8983,28 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-force-cross-resource-refs,
+@switch{switch.no-force-cross-resource-refs,
name={\longargfmt{no\dhyphen force\dhyphen cross\dhyphen resource\dhyphen refs}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.support-unicode-script,
+@switch{switch.support-unicode-script,
name={\longargfmt{support\dhyphen unicode\dhyphen script}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-support-unicode-script,
+@switch{switch.no-support-unicode-script,
name={\longargfmt{no\dhyphen support\dhyphen unicode\dhyphen script}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.packages,
+@switch{switch.packages,
name={\longargfmt{packages}},
symbol={\shortargfmt{p}},
user1={\meta{list}},
@@ -6340,7 +9012,7 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.ignore-packages,
+@switch{switch.ignore-packages,
name={\longargfmt{ignore-packages}},
symbol={\shortargfmt{k}},
user1={\meta{list}},
@@ -6348,20 +9020,20 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.custom-packages,
+@switch{switch.custom-packages,
name={\longargfmt{custom\dhyphen packages}},
user1={\meta{list}},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.list-known-packages,
+@switch{switch.list-known-packages,
name={\longargfmt{list\dhyphen known\dhyphen packages}},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.mfirstuc-protection,
+@switch{switch.mfirstuc-protection,
name={\longargfmt{mfirstuc\dhyphen protection}},
symbol={\shortargfmt{u}},
user1={\meta{list}\argor\code{all}},
@@ -6369,49 +9041,49 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-mfirstuc-protection,
+@switch{switch.no-mfirstuc-protection,
name={\longargfmt{no\dhyphen mfirstuc\dhyphen protection}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.mfirstuc-math-protection,
+@switch{switch.mfirstuc-math-protection,
name={\longargfmt{mfirstuc\dhyphen math\dhyphen protection}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-mfirstuc-math-protection,
+@switch{switch.no-mfirstuc-math-protection,
name={\longargfmt{no\dhyphen mfirstuc\dhyphen math\dhyphen protection}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.nested-link-check,
+@switch{switch.nested-link-check,
name={\longargfmt{nested\dhyphen link\dhyphen check}},
user1={\meta{list}\argor\code{none}},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-nested-link-check,
+@switch{switch.no-nested-link-check,
name={\longargfmt{no\dhyphen nested\dhyphen link\dhyphen check}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.shortcuts,
+@switch{switch.shortcuts,
name={\longargfmt{shortcuts}},
user1={\meta{value}},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.map-format,
+@switch{switch.map-format,
name={\longargfmt{map\dhyphen format}},
symbol={\shortargfmt{m}},
user1={\meta{map:value list}},
@@ -6419,7 +9091,7 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.group,
+@switch{switch.group,
name={\longargfmt{group}},
symbol={\shortargfmt{g}},
user1={},
@@ -6427,35 +9099,35 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-group,
+@switch{switch.no-group,
name={\longargfmt{no\dhyphen group}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.tex-encoding,
+@switch{switch.tex-encoding,
name={\longargfmt{tex\dhyphen encoding}},
user1={\meta{name}},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-expand-fields,
+@switch{switch.no-expand-fields,
name={\longargfmt{no\dhyphen expand\dhyphen fields}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.expand-fields,
+@switch{switch.expand-fields,
name={\longargfmt{expand\dhyphen fields}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.record-count,
+@switch{switch.record-count,
name={\longargfmt{record\dhyphen count}},
symbol={\shortargfmt{c}},
user1={},
@@ -6463,14 +9135,14 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-record-count,
+@switch{switch.no-record-count,
name={\longargfmt{no\dhyphen record\dhyphen count}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.record-count-unit,
+@switch{switch.record-count-unit,
name={\longargfmt{record\dhyphen count\dhyphen unit}},
symbol={\shortargfmt{n}},
user1={},
@@ -6478,21 +9150,21 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-record-count-unit,
+@switch{switch.no-record-count-unit,
name={\longargfmt{no\dhyphen record\dhyphen count\dhyphen unit}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.trim-fields,
+@switch{switch.trim-fields,
name={\longargfmt{trim\dhyphen fields}},
user1={},
category={switch},
parent={commandlineoptions}
}
-@dualindexentry{switch.no-trim-fields,
+@switch{switch.no-trim-fields,
name={\longargfmt{no\dhyphen trim\dhyphen fields}},
user1={},
category={switch},
@@ -6574,27 +9246,27 @@ primary formats, if enabled.},
name={language resource file (\extfmt{xml})}
}
-@index{tag.page,
+@xmltag{tag.page,
name={\xmltagfmt{tag.page}},
parent={languagexml}
}
-@index{tag.pages,
+@xmltag{tag.pages,
name={\xmltagfmt{tag.pages}},
parent={languagexml}
}
-@index{tag.passim,
+@xmltag{tag.passim,
name={\xmltagfmt{tag.passim}},
parent={languagexml}
}
-@index{sentence.terminators,
+@xmltag{sentence.terminators,
name={\xmltagfmt{sentence.terminators}},
parent={languagexml}
}
-@index{grouptitle.case.lc,
+@xmltag{grouptitle.case.lc,
name={\xmltagfmt{grouptitle.case.}\meta{lc}},
parent={languagexml}
}
@@ -6681,6 +9353,12 @@ primary formats, if enabled.},
@index{non-regular}
@index{variant}
@index{homograph}
+@index{progeny}
+@index{progenitor}
+
+@index{StackOverflowError,
+ name={\code{Stack\-Over\-flow\-Error}}
+}
@index{moving-argument,
name={moving argument}
@@ -6713,330 +9391,344 @@ primary formats, if enabled.},
plural={Unicode categories}
}
-@index{numberdecimaldigit,
+@unicodecategory{numberdecimaldigit,
name={\unicodecategoryfmt{Number, Decimal Digit}},
parent={unicodecategories}
}
-@index{separatorspace,
+@unicodecategory{separatorspace,
name={\unicodecategoryfmt{Separator, Space}},
parent={unicodecategories}
}
-@index{letteruppercase,
+@unicodecategory{letteruppercase,
name={\unicodecategoryfmt{Letter, Uppercase}},
parent={unicodecategories}
}
-@index{letterlowercase,
+@unicodecategory{letterlowercase,
name={\unicodecategoryfmt{Letter, Lowercase}},
parent={unicodecategories}
}
-@index{lettertitlecase,
+@unicodecategory{lettertitlecase,
name={\unicodecategoryfmt{Letter, Titlecase}},
parent={unicodecategories}
}
-@index{lettermodifier,
+@unicodecategory{lettermodifier,
name={\unicodecategoryfmt{Letter, Modifier}},
parent={unicodecategories}
}
-@index{letterother,
+@unicodecategory{letterother,
name={\unicodecategoryfmt{Letter, Other}},
parent={unicodecategories}
}
-@index{punctuationclose,
+@unicodecategory{punctuationclose,
name={\unicodecategoryfmt{Punctuation, Close}},
parent={unicodecategories}
}
-@index{punctuationfinalquote,
+@unicodecategory{punctuationfinalquote,
name={\unicodecategoryfmt{Punctuation, Final quote}},
parent={unicodecategories}
}
-@index{punctuationother,
+@unicodecategory{punctuationother,
name={\unicodecategoryfmt{Punctuation, Other}},
parent={unicodecategories}
}
-@index{punctuationdash,
+@unicodecategory{punctuationdash,
name={\unicodecategoryfmt{Punctuation, Dash}},
parent={unicodecategories}
}
-@index{texmfcnf.openinany,
+@texmfcnf{texmfcnf.openinany,
name={\texmfcnffmt{openin\_any}}
}
-@index{texmfcnf.openoutany,
+@texmfcnf{texmfcnf.openoutany,
name={\texmfcnffmt{openout\_any}}
}
-@index{file.bib2gls-en.xml,
+@file{file.bib2gls-en.xml,
name={\filefmt{bib2gls-en.xml}}
}
-@index{file.bib2gls.sh,
+@file{file.bib2gls.sh,
name={\filefmt{bib2gls.sh}}
}
-@index{file.convertgls2bib.sh,
+@file{file.convertgls2bib.sh,
name={\filefmt{convert\-gls2bib.sh}}
}
-@index{file.texparserlib.jar,
+@file{file.texparserlib.jar,
name={\filefmt{texparserlib.jar}}
}
-@index{file.bib2gls.jar,
+@file{file.bib2gls.jar,
name={\filefmt{bib2gls.jar}}
}
-@index{file.convertgls2bib.jar,
+@file{file.convertgls2bib.jar,
name={\filefmt{convert\-gls2bib.jar}}
}
-@index{file.bib2gls.bat,
+@file{file.bib2gls.bat,
name={\filefmt{bib2gls.bat}}
}
-@index{file.xampl.bib,
+@file{file.xampl.bib,
name={\filefmt{xampl.bib}}
}
-@index{file.sample-dual.tex,
+@file{file.sample-dual.tex,
name={\filefmt{sample\dhyphen dual.tex}}
}
-@dualindexentry{file.no-interpret-preamble.bib,
+@samplefile{file.no-interpret-preamble.bib,
name={\filefmt{no\dhyphen interpret\dhyphen preamble.bib}}
}
-@dualindexentry{file.interpret-preamble.bib,
+@samplefile{file.interpret-preamble.bib,
name={\filefmt{interpret\dhyphen preamble.bib}}
}
-@dualindexentry{file.interpret-preamble2.bib,
+@samplefile{file.interpret-preamble2.bib,
name={\filefmt{interpret\dhyphen preamble2.bib}}
}
-@dualindexentry{file.people.bib,
+@samplefile{file.people.bib,
name={\filefmt{people.bib}}
}
-@dualindexentry{file.sample-people.tex,
+@samplefile{file.sample-people.tex,
name={\filefmt{sample\dhyphen people.tex}}
}
-@dualindexentry{file.sample-authors.tex,
+@samplefile{file.sample-authors.tex,
name={\filefmt{sample\dhyphen authors.tex}}
}
-@dualindexentry{file.sample-citations.tex,
+@samplefile{file.sample-citations.tex,
name={\filefmt{sample\dhyphen citations.tex}}
}
-@dualindexentry{file.citations.bib,
+@samplefile{file.citations.bib,
name={\filefmt{citations.bib}}
}
-@dualindexentry{file.bacteria.bib,
+@samplefile{file.bacteria.bib,
name={\filefmt{bacteria.bib}}
}
-@dualindexentry{file.sample-bacteria.tex,
+@samplefile{file.sample-bacteria.tex,
name={\filefmt{sample\dhyphen bacteria.tex}}
}
-@dualindexentry{file.chemicalformula.bib,
+@samplefile{file.chemicalformula.bib,
name={\filefmt{chemicalformula.bib}}
}
-@dualindexentry{file.sample-chemical.tex,
+@samplefile{file.sample-chemical.tex,
name={\filefmt{sample\dhyphen chemical.tex}}
}
-@dualindexentry{file.constants.bib,
+@samplefile{file.constants.bib,
name={\filefmt{constants.bib}}
}
-@dualindexentry{file.sample-constants.tex,
+@samplefile{file.sample-constants.tex,
name={\filefmt{sample\dhyphen constants.tex}}
}
-@dualindexentry{file.baseunits.bib,
+@samplefile{file.baseunits.bib,
name={\filefmt{baseunits.bib}}
}
-@dualindexentry{file.derivedunits.bib,
+@samplefile{file.derivedunits.bib,
name={\filefmt{derivedunits.bib}}
}
-@dualindexentry{file.sample-units1.tex,
+@samplefile{file.sample-units1.tex,
name={\filefmt{sample-units1.tex}}
}
-@dualindexentry{file.sample-units2.tex,
+@samplefile{file.sample-units2.tex,
name={\filefmt{sample-units2.tex}}
}
-@dualindexentry{file.sample-units3.tex,
+@samplefile{file.sample-units3.tex,
name={\filefmt{sample-units3.tex}}
}
-@dualindexentry{file.books.bib,
+@samplefile{file.books.bib,
name={\filefmt{books.bib}}
}
-@dualindexentry{file.films.bib,
+@samplefile{file.films.bib,
name={\filefmt{films.bib}}
}
-@dualindexentry{file.sample-media.tex,
+@samplefile{file.sample-media.tex,
name={\filefmt{sample\dhyphen media.tex}}
}
-@dualindexentry{file.bigmathsymbols.bib,
+@samplefile{file.bigmathsymbols.bib,
name={\filefmt{bigmathsymbols.bib}}
}
-@dualindexentry{file.mathgreek.bib,
+@samplefile{file.mathgreek.bib,
name={\filefmt{mathgreek.bib}}
}
-@dualindexentry{file.mathsrelations.bib,
+@samplefile{file.mathsrelations.bib,
name={\filefmt{mathsrelations.bib}}
}
-@dualindexentry{file.binaryoperators.bib,
+@samplefile{file.binaryoperators.bib,
name={\filefmt{binaryoperators.bib}}
}
-@dualindexentry{file.unaryoperators.bib,
+@samplefile{file.unaryoperators.bib,
name={\filefmt{unaryoperators.bib}}
}
-@dualindexentry{file.mathsobjects.bib,
+@samplefile{file.mathsobjects.bib,
name={\filefmt{mathsobjects.bib}}
}
-@dualindexentry{file.sample-msymbols.tex,
+@samplefile{file.sample-msymbols.tex,
name={\filefmt{sample\dhyphen msymbols.tex}}
}
-@dualindexentry{file.sample-maths.tex,
+@samplefile{file.sample-maths.tex,
name={\filefmt{sample\dhyphen maths.tex}}
}
-@dualindexentry{file.miscsymbols.bib,
+@samplefile{file.miscsymbols.bib,
name={\filefmt{miscsymbols.bib}}
}
-@dualindexentry{file.sample-textsymbols.tex,
+@samplefile{file.sample-textsymbols.tex,
name={\filefmt{sample\dhyphen textsymbols.tex}}
}
-@dualindexentry{file.markuplanguages.bib,
+@samplefile{file.sample-textsymbols2.tex,
+ name={\filefmt{sample\dhyphen textsymbols2.tex}}
+}
+
+@samplefile{file.markuplanguages.bib,
name={\filefmt{markuplanguages.bib}}
}
-@dualindexentry{file.sample-markuplanguages.tex,
+@samplefile{file.sample-markuplanguages.tex,
name={\filefmt{sample\dhyphen markuplanguages.tex}}
}
-@dualindexentry{file.usergroups.bib,
+@samplefile{file.usergroups.bib,
name={\filefmt{usergroups.bib}}
}
-@dualindexentry{file.sample-usergroups.tex,
+@samplefile{file.sample-usergroups.tex,
name={\filefmt{sample\dhyphen usergroups.tex}}
}
-@dualindexentry{file.animals.bib,
+@samplefile{file.animals.bib,
name={\filefmt{animals.bib}}
}
-@dualindexentry{file.vegetables.bib,
+@samplefile{file.vegetables.bib,
name={\filefmt{vegetables.bib}}
}
-@dualindexentry{file.minerals.bib,
+@samplefile{file.minerals.bib,
name={\filefmt{minerals.bib}}
}
-@dualindexentry{file.terms.bib,
+@samplefile{file.terms.bib,
name={\filefmt{terms.bib}}
}
-@dualindexentry{file.sample-multi1.tex,
+@samplefile{file.topics.bib,
+ name={\filefmt{topics.bib}}
+}
+
+@samplefile{file.sample-multi1.tex,
name={\filefmt{sample\dhyphen multi1.tex}}
}
-@dualindexentry{file.sample-multi2.tex,
+@samplefile{file.sample-multi2.tex,
name={\filefmt{sample\dhyphen multi2.tex}}
}
-@index{glshyperlink,
+@glscommand{glshyperlink,
name={\csfmt{gls\-hyper\-link}},
user1={\oargm{link text}\margm{label}},
description={creates a hyperlink to the entry information in the
glossary},
- note={\styfmt{glossaries}},
+ topics={linkcommands,entryrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsxtrfielddolistloop,
+@glscommand{glsxtrfielddolistloop,
name={\csfmt{gls\-xtr\-field\-do\-list\-loop}},
user1={\margm{label}\margm{field}},
description={iterates over the items the given field, which contains
an \styfmt{etoolbox} internal list},
+ topics={listcommands,loops,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.12+},
seealso={glsxtrfieldforlistloop,glsxtrfieldifinlist,glsxtrfieldlistadd},
category={command}
}
-@index{glsxtrfieldforlistloop,
+@glscommand{glsxtrfieldforlistloop,
name={\csfmt{gls\-xtr\-field\-for\-list\-loop}},
user1={\margm{label}\margm{field}\margm{handler}},
description={iterates over the items the given field, which contains
an \styfmt{etoolbox} internal list, using the given handler},
+ topics={listcommands,loops,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.29+},
seealso={glsxtrfielddolistloop,glsxtrfieldifinlist,glsxtrfieldlistadd},
category={command}
}
-@index{glsfieldfetch,
+@glscommand{glsfieldfetch,
name={\csfmt{gls\-field\-fetch}},
user1={\margm{label}\margm{field}\margm{cs}},
description={fetches the value of the given field for the given
label and stores it in the command \meta{cs}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries} v4.16+},
category={command}
}
-@index{glsxtrautoindexassignsort,
+@glscommand{glsxtrautoindexassignsort,
name={\csfmt{gls\-xtr\-auto\-index\-assign\-sort}},
user1={\margm{cs}\margm{label}},
description={assigns the sort value for \cs{index} when
using auto-indexing},
+ topics={hooks,indexing},
note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
-@index{glsxtrautoindexentry,
+@glscommand{glsxtrautoindexentry,
name={\csfmt{gls\-xtr\-auto\-index\-entry}},
user1={\margm{label}},
description={used for the actual value in \cs{index} when
using auto-indexing},
+ topics={hooks,indexing},
note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
-@index{glsseeformat,
+@glscommand{glsseeformat,
name={\csfmt{gls\-see\-format}},
user1={\margm{tag}\margm{labels}\margm{location (ignored)}},
description={formats the entries identified in the comma separated
@@ -7044,24 +9736,26 @@ primary formats, if enabled.},
item in the list is encapsulated with \cs{glsseeitem} and
each element is separated with \cs{glsseesep} or
\cs{glsseelastsep}},
+ topics={formattingcommands,crossrefcommands,loclistcommands},
note={\styfmt{glossaries}},
seealso={glsseeitem,glsseeitemformat,glsseesep,glsseelastsep},
category={command}
}
-@index{glsseeitem,
+@glscommand{glsseeitem,
name={\csfmt{gls\-see\-item}},
user1={\margm{label}},
description={formats an element of the cross-reference list.
The default behaviour is to create a hyperlink (if enabled) to the
referenced entry with the link text given by
\code{\cs{glsseeitemformat}\margm{label}}},
+ topics={formattingcommands,crossrefcommands,loclistcommands,linkcommands},
note={\styfmt{glossaries}},
seealso={glsseeformat,glsseeitemformat},
category={command}
}
-@index{glsseeitemformat,
+@glscommand{glsseeitemformat,
name={\csfmt{gls\-see\-item\-format}},
user1={\margm{label}},
description={formats an element of the cross-reference list.
@@ -7070,583 +9764,1324 @@ primary formats, if enabled.},
\styfmt{glossaries-extra} this uses either \cs{glsentryshort}
or \cs{glsentryname} depending on whether or not the
\field{short} field has been set},
+ topics={formattingcommands,crossrefcommands,loclistcommands},
note={\styfmt{glossaries} v3.0+},
seealso={glsseeformat,glsseeitem},
category={command}
}
-@index{glsseesep,
+@glscommand{glsseesep,
name={\csfmt{gls\-see\-sep}},
description={the separator used between all but the last
entries of a cross-reference list},
note={\styfmt{glossaries}},
+ topics={separatorcommands,crossrefcommands,loclistcommands},
seealso={glsseeformat,glsseelastsep},
category={command}
}
-@index{glsseelastsep,
+@glscommand{glsseelastsep,
name={\csfmt{gls\-see\-last\-sep}},
description={the separator used between the penultimate and
ultimate entries of a cross-reference list},
+ topics={separatorcommands,crossrefcommands,loclistcommands},
note={\styfmt{glossaries}},
seealso={glsseeformat,glsseesep},
category={command}
}
-@index{glsxtruseseeformat,
+@glscommand{glsxtruseseeformat,
name={\csfmt{gls\-xtr\-use\-see\-format}},
user1={\margm{tag}\margm{labels}},
description={formats the entries identified in the comma separated
list of labels as a set of cross-references},
+ topics={separatorcommands,crossrefcommands,loclistcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsxtrhiername,
+@glscommand{glsxtrhiername,
name={\csfmt{gls\-xtr\-hier\-name}},
user1={\margm{label}},
description={Displays the hierarchical name for the entry
identified by \meta{label} with each level separated by
\cs{glsxtrhiernamesep}},
- note={\styfmt{glossaries-extra} v1.37+},
+ topics={formattingcommands,entryrefcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote\ v1.37+},
seealso={glsxtrhiernamesep},
category={command}
}
-@index{glsxtrhiernamesep,
+@glscommand{glsxtrhiernamesep,
name={\csfmt{gls\-xtr\-hier\-name\-sep}},
description={Separator between hierarchical levels displayed with
\cs{glsxtrhiername} (and case-changing variants). This defaults
to \qt{\glsxtrhiernamesep} with the \styfmt{glossaries-extra}
package, but the \bibgls\ interpreter has a different definition
to assist sorting},
- note={\styfmt{glossaries-extra} v1.37+},
+ topics={separatorcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote\ v1.37+},
seealso={glsxtrhiername},
category={command}
}
-@index{Glsxtrhiername,
+@glscommand{Glsxtrhiername,
name={\csfmt{Gls\-xtr\-hier\-name}},
user1={\margm{label}},
description={Displays the hierarchical name for the entry
identified by \meta{label} with each level separated by
\cs{glsxtrhiernamesep} where the top-most name has the
first letter converted to \idx{uppercase}},
- note={\styfmt{glossaries-extra} v1.37+},
+ topics={formattingcommands,entryrefcommands,casecommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote\ v1.37+},
seealso={glsxtrhiername,glsxtrhiernamesep},
category={command}
}
-@index{GlsXtrhiername,
+@glscommand{GlsXtrhiername,
name={\csfmt{Gls\-Xtr\-hier\-name}},
user1={\margm{label}},
description={Displays the hierarchical name for the entry
identified by \meta{label} with each level separated by
\cs{glsxtrhiernamesep} where each name has the
first letter converted to \idx{uppercase}},
- note={\styfmt{glossaries-extra} v1.37+},
+ topics={formattingcommands,entryrefcommands,casecommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote\ v1.37+},
seealso={glsxtrhiername,glsxtrhiernamesep},
category={command}
}
-@index{GLSxtrhiername,
+@glscommand{GLSxtrhiername,
name={\csfmt{GLS\-xtr\-hier\-name}},
user1={\margm{label}},
description={Displays the hierarchical name for the entry
identified by \meta{label} with each level separated by
\cs{glsxtrhiernamesep} where the top-most name is converted to \idx{uppercase}},
- note={\styfmt{glossaries-extra} v1.37+},
+ topics={formattingcommands,entryrefcommands,casecommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote\ v1.37+},
seealso={glsxtrhiername,glsxtrhiernamesep},
category={command}
}
-@index{GLSXTRhiername,
+@glscommand{GLSXTRhiername,
name={\csfmt{GLS\-XTR\-hier\-name}},
user1={\margm{label}},
description={Displays the hierarchical name for the entry
identified by \meta{label} with each level separated by
\cs{glsxtrhiernamesep} where each name is converted
to \idx{uppercase}},
- note={\styfmt{glossaries-extra} v1.37+},
+ topics={formattingcommands,entryrefcommands,casecommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote\ v1.37+},
seealso={glsxtrhiername,glsxtrhiernamesep},
category={command}
}
-@index{glsextrapostnamehook,
+@glscommand{glsextrapostnamehook,
name={\csfmt{gls\-extra\-post\-name\-hook}},
user1={\margm{label}},
description={additional category-independent code for the
post-name hook},
+ topics={hooks},
note={\styfmt{glossaries-extra} v1.25+},
category={command}
}
-@index{glsentrytext,
+@glscommand{glsentrytext,
name={\csfmt{gls\-entry\-text}},
user1={\margm{label}},
description={expands to the value of the
\field{text} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentrytext,
+@glscommand{Glsentrytext,
name={\csfmt{Gls\-entry\-text}},
user1={\margm{label}},
description={displays the value of the \field{text} field with
the first letter converted to \idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryplural,
+@glscommand{glsentryplural,
name={\csfmt{gls\-entry\-plural}},
user1={\margm{label}},
description={expands to the value of the
\field{plural} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryplural,
+@glscommand{Glsentryplural,
name={\csfmt{Gls\-entry\-plural}},
user1={\margm{label}},
description={displays the value of the
\field{plural} field with the first letter converted to
\idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryfirst,
+@glscommand{glsentryfirst,
name={\csfmt{gls\-entry\-first}},
user1={\margm{label}},
description={expands to the value of the
\field{first} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryfirst,
+@glscommand{Glsentryfirst,
name={\csfmt{Gls\-entry\-first}},
user1={\margm{label}},
description={displays the value of the
\field{first} field with the first letter converted to
\idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryfirstplural,
+@glscommand{glsentryfirstplural,
name={\csfmt{gls\-entry\-first\-plural}},
user1={\margm{label}},
description={expands to the value of the
\field{firstplural} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryfirstplural,
+@glscommand{Glsentryfirstplural,
name={\csfmt{Gls\-entry\-first\-plural}},
user1={\margm{label}},
description={displays the value of the
\field{firstplural} field with the first letter converted to
\idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryname,
+@glscommand{glsentryname,
name={\csfmt{gls\-entry\-name}},
user1={\margm{label}},
description={expands to the value of the
\field{name} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryname,
+@glscommand{Glsentryname,
name={\csfmt{Gls\-entry\-name}},
user1={\margm{label}},
description={displays the value of the
\field{name} field with the first character
- converted to upper case},
- note={\styfmt{glossaries}},
+ converted to \idx{uppercase}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentrydesc,
+@glscommand{glsentrydesc,
name={\csfmt{gls\-entry\-desc}},
user1={\margm{label}},
description={expands to the value of the
\field{description} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentrydesc,
+@glscommand{glsentrydescplural,
+ name={\csfmt{gls\-entry\-desc\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{descriptionplural} field},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsentrydesc,
name={\csfmt{Gls\-entry\-desc}},
user1={\margm{label}},
description={displays the value of the
\field{description} field with the first letter converted to
- upper case},
- note={\styfmt{glossaries}},
+ \idx{uppercase}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsentrydescplural,
+ name={\csfmt{Gls\-entry\-desc\-plural}},
+ user1={\margm{label}},
+ description={displays the value of the
+ \field{descriptionplural} field with the first letter converted to
+ \idx{uppercase}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentrysymbol,
+@glscommand{glsentrysymbol,
name={\csfmt{gls\-entry\-symbol}},
user1={\margm{label}},
description={expands to the value of the
\field{symbol} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentrysymbol,
+@glscommand{Glsentrysymbol,
name={\csfmt{Gls\-entry\-symbol}},
user1={\margm{label}},
description={displays the value of the
\field{symbol} field with the first letter converted to
\idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentrysymbolplural,
+@glscommand{glsentrysymbolplural,
name={\csfmt{gls\-entry\-symbol\-plural}},
user1={\margm{label}},
description={expands to the value of the
\field{symbolplural} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentrysymbolplural,
+@glscommand{Glsentrysymbolplural,
name={\csfmt{Gls\-entry\-symbol\-plural}},
user1={\margm{label}},
description={displays the value of the
\field{symbolplural} field with the first letter converted to
\idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentrylong,
+@glscommand{glsentrylong,
name={\csfmt{gls\-entry\-long}},
user1={\margm{label}},
description={expands to the value of the \field{long} field
without any formatting or indexing},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,abbreviationcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentrylongpl,
+@glscommand{glsentrylongpl,
name={\csfmt{gls\-entry\-long\-pl}},
user1={\margm{label}},
description={expands to the value of the \field{longplural} field
without any formatting or indexing},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,abbreviationcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentrylong,
+@glscommand{Glsentrylong,
name={\csfmt{Gls\-entry\-long}},
user1={\margm{label}},
description={displays the value of the
\field{long} field without any formatting or indexing but
with the first letter converted to \idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,abbreviationcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentrylongpl,
+@glscommand{Glsentrylongpl,
name={\csfmt{Gls\-entry\-long\-pl}},
user1={\margm{label}},
description={displays the value of the
\field{longplural} field without any formatting or indexing but
with the first letter converted to \idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,abbreviationcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryshort,
+@glscommand{glsentryshort,
name={\csfmt{gls\-entry\-short}},
user1={\margm{label}},
description={expands to the value of the
\field{short} field without any formatting or indexing},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,abbreviationcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryshortpl,
+@glscommand{glsentryshortpl,
name={\csfmt{gls\-entry\-short\-pl}},
user1={\margm{label}},
description={expands to the value of the
\field{shortplural} field without any formatting or indexing},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,abbreviationcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryshort,
+@glscommand{Glsentryshort,
name={\csfmt{Gls\-entry\-short}},
user1={\margm{label}},
description={displays the value of the
\field{short} field without any formatting or indexing but
with the first letter converted to \idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,abbreviationcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryshortpl,
+@glscommand{Glsentryshortpl,
name={\csfmt{Gls\-entry\-short\-pl}},
user1={\margm{label}},
description={displays the value of the
\field{shortplural} field without any formatting or indexing
but with the first letter converted to \idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,abbreviationcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryuseri,
+@glscommand{glsentryuseri,
name={\csfmt{gls\-entry\-useri}},
user1={\margm{label}},
description={expands to the value of the
\field{user1} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryuserii,
+@glscommand{glsentryuserii,
name={\csfmt{gls\-entry\-userii}},
user1={\margm{label}},
description={expands to the value of the
\field{user2} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryuseriii,
+@glscommand{glsentryuseriii,
name={\csfmt{gls\-entry\-useriii}},
user1={\margm{label}},
description={expands to the value of the
\field{user3} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryuseriv,
+@glscommand{glsentryuseriv,
name={\csfmt{gls\-entry\-useriv}},
user1={\margm{label}},
description={expands to the value of the
\field{user4} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryuserv,
+@glscommand{glsentryuserv,
name={\csfmt{gls\-entry\-userv}},
user1={\margm{label}},
description={expands to the value of the
\field{user5} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsentryuservi,
+@glscommand{glsentryuservi,
name={\csfmt{gls\-entry\-uservi}},
user1={\margm{label}},
description={expands to the value of the
\field{user6} field},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryuseri,
+@glscommand{Glsentryuseri,
name={\csfmt{Gls\-entry\-useri}},
user1={\margm{label}},
description={displays the value of the
\field{user1} field with the first letter converted to
\idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryuserii,
+@glscommand{Glsentryuserii,
name={\csfmt{Gls\-entry\-userii}},
user1={\margm{label}},
description={displays the value of the
\field{user2} field with the first letter converted to
\idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryuseriii,
+@glscommand{Glsentryuseriii,
name={\csfmt{Gls\-entry\-useriii}},
user1={\margm{label}},
description={displays the value of the
\field{user3} field with the first letter converted to
\idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryuseriv,
+@glscommand{Glsentryuseriv,
name={\csfmt{Gls\-entry\-useriv}},
user1={\margm{label}},
description={displays the value of the
\field{user4} field with the first letter converted to
\idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryuserv,
+@glscommand{Glsentryuserv,
name={\csfmt{Gls\-entry\-userv}},
user1={\margm{label}},
description={displays the value of the
\field{user5} field with the first letter converted to
\idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{Glsentryuservi,
+@glscommand{Glsentryuservi,
name={\csfmt{Gls\-entry\-uservi}},
user1={\margm{label}},
description={displays the value of the
\field{user6} field with the first letter converted to
\idx{uppercase}},
- note={\styfmt{glossaries}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccessname,
+ name={\csfmt{gls\-access\-name}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{name} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentryname})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccessname,
+ name={\csfmt{Gls\-access\-name}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{name} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentryname})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccesstext,
+ name={\csfmt{gls\-access\-text}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{text} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentrytext})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccesstext,
+ name={\csfmt{Gls\-access\-text}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{text} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentrytext})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccessplural,
+ name={\csfmt{gls\-access\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{plural} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentryplural})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccessplural,
+ name={\csfmt{Gls\-access\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{plural} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentryplural})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccessfirst,
+ name={\csfmt{gls\-access\-first}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{first} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentryfirst})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccessfirst,
+ name={\csfmt{Gls\-access\-first}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{first} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentryfirst})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccessfirstplural,
+ name={\csfmt{gls\-access\-first\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{firstplural} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentryfirstplural})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccessfirstplural,
+ name={\csfmt{Gls\-access\-first\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{firstplural} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentryfirstplural})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccesssymbol,
+ name={\csfmt{gls\-access\-symbol}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{symbol} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentrysymbol})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccesssymbol,
+ name={\csfmt{Gls\-access\-symbol}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{symbol} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentrysymbol})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccesssymbolplural,
+ name={\csfmt{gls\-access\-symbol\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{symbolplural} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentrysymbolplural})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccesssymbolplural,
+ name={\csfmt{Gls\-access\-symbol\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{symbolplural} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentrysymbolplural})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccessdesc,
+ name={\csfmt{gls\-access\-desc}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{description} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentrydesc})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccessdesc,
+ name={\csfmt{Gls\-access\-desc}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{description} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentrydesc})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccessdescplural,
+ name={\csfmt{gls\-access\-desc\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{descriptionplural} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentrydescplural})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccessdescplural,
+ name={\csfmt{Gls\-access\-desc\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{descriptionplural} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentrydescplural})},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccessshort,
+ name={\csfmt{gls\-access\-short}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{short} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentryshort})},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccessshort,
+ name={\csfmt{Gls\-access\-short}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{short} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentryshort})},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccessshortpl,
+ name={\csfmt{gls\-access\-shortpl}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{shortplural} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentryshortpl})},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccessshortpl,
+ name={\csfmt{Gls\-access\-shortpl}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{shortplural} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentryshortpl})},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccesslong,
+ name={\csfmt{gls\-access\-long}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{long} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentrylong})},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccesslong,
+ name={\csfmt{Gls\-access\-long}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{long} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentrylong})},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsaccesslongpl,
+ name={\csfmt{gls\-access\-longpl}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{longplural} field with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{glsentrylongpl})},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{Glsaccesslongpl,
+ name={\csfmt{Gls\-access\-longpl}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{longplural} field with the first letter converted to
+ \idx{uppercase} and with the accessibility support
+ for that field, if provided (otherwise behaves the same as
+ \cs{Glsentrylongpl})},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsxtrentryparentname,
+ name={\csfmt{gls\-xtr\-entry\-parent\-name}},
+ user1={\margm{label}},
+ description={expands to the entry's parent's name},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote\ v1.39+},
+ category={command}
+}
+
+@glscommand{glsentryprefix,
+ name={\csfmt{gls\-entry\-prefix}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{prefix} field},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{glsentryprefixplural,
+ name={\csfmt{gls\-entry\-prefix\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{prefixplural} field},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{glsentryprefixfirst,
+ name={\csfmt{gls\-entry\-prefix\-first}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{prefixfirst} field},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{glsentryprefixfirstplural,
+ name={\csfmt{gls\-entry\-prefix\-first\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{prefixfirstplural} field},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{Glsentryprefix,
+ name={\csfmt{Gls\-entry\-prefix}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{prefix} field
+ with the first letter converted to \idx{uppercase}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{Glsentryprefixplural,
+ name={\csfmt{Gls\-entry\-prefix\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{prefixplural} field
+ with the first letter converted to \idx{uppercase}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{Glsentryprefixfirst,
+ name={\csfmt{Gls\-entry\-prefix\-first}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{prefixfirst} field
+ with the first letter converted to \idx{uppercase}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{Glsentryprefixfirstplural,
+ name={\csfmt{Gls\-entry\-prefix\-first\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{prefixfirstplural} field
+ with the first letter converted to \idx{uppercase}},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries-prefix}},
category={command}
}
-@index{glssetcategoryattribute,
+@glscommand{glssetcategoryattribute,
name={\csfmt{gls\-set\-cat\-e\-gory\-at\-tribute}},
user1={\margm{category}\margm{attribute}\margm{value}},
description={sets the value of the attribute for the given
category},
+ topics={assigncommands,catattrcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtrpostlinkAddDescOnFirstUse,
+@glscommand{glsentryaccess,
+ name={\csfmt{gls\-entry\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{access} field},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentrytextaccess,
+ name={\csfmt{gls\-entry\-text\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{textaccess} field},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentryfirstaccess,
+ name={\csfmt{gls\-entry\-first\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{firstaccess} field},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentrypluralaccess,
+ name={\csfmt{gls\-entry\-plural\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{pluralaccess} field},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentryfirstpluralaccess,
+ name={\csfmt{gls\-entry\-first\-plural\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{firstpluralaccess} field},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentrysymbolaccess,
+ name={\csfmt{gls\-entry\-symbol\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{symbolaccess} field},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentrysymbolpluralaccess,
+ name={\csfmt{gls\-entry\-symbol\-plural\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{symbolpluralaccess} field},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentrydescaccess,
+ name={\csfmt{gls\-entry\-desc\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{descriptionaccess} field},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentrydescpluralaccess,
+ name={\csfmt{gls\-entry\-desc\-plural\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{descriptionpluralaccess} field},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentryshortaccess,
+ name={\csfmt{gls\-entry\-short\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{shortaccess} field},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentryshortpluralaccess,
+ name={\csfmt{gls\-entry\-short\-plural\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{shortpluralaccess} field},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentrylongaccess,
+ name={\csfmt{gls\-entry\-long\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{longaccess} field},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsentrylongpluralaccess,
+ name={\csfmt{gls\-entry\-long\-plural\-access}},
+ user1={\margm{label}},
+ description={expands to the value of the \field{longpluralaccess} field},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsnameaccessdisplay,
+ name={\csfmt{gls\-name\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentryaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glstextaccessdisplay,
+ name={\csfmt{gls\-text\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentrytextaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glspluralaccessdisplay,
+ name={\csfmt{gls\-plural\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentrypluralaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsfirstaccessdisplay,
+ name={\csfmt{gls\-first\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentryfirstaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsfirstpluralaccessdisplay,
+ name={\csfmt{gls\-first\-plural\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentryfirstpluralaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glssymbolaccessdisplay,
+ name={\csfmt{gls\-symbol\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentrysymbolaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glssymbolpluralaccessdisplay,
+ name={\csfmt{gls\-symbol\-plural\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentrysymbolpluralaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsdescriptionaccessdisplay,
+ name={\csfmt{gls\-descrip\-tion\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentrydescaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsdescriptionpluralaccessdisplay,
+ name={\csfmt{gls\-descrip\-tion\-plural\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentrydescpluralaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsshortaccessdisplay,
+ name={\csfmt{gls\-short\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentryshortaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsshortpluralaccessdisplay,
+ name={\csfmt{gls\-short\-plural\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentryshortpluralaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glslongaccessdisplay,
+ name={\csfmt{gls\-long\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentrylongaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glslongpluralaccessdisplay,
+ name={\csfmt{gls\-long\-plural\-access\-display}},
+ user1={\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\cs{glsentrylongpluralaccess}\margm{label}}},
+ topics={fieldrefcommands,access-support,abbreviationcommands},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsaccessdisplay,
+ name={\csfmt{gls\-access\-display}},
+ user1={\margm{field}\margm{text}\margm{label}},
+ description={displays \meta{text} with the accessibility support
+ provided by \code{\csfmt{glsentry\meta{field}access}\margm{label}}},
+ topics={fieldrefcommands,access-support},
+ note={\styfmt{glossaries-access}},
+ category={command}
+}
+
+@glscommand{glsxtrpostlinkAddDescOnFirstUse,
name={\csfmt{gls\-xtr\-post\-link\-Add\-Desc\-On\-First\-Use}},
description={only for use in the post-link hooks,
this appends a space and the value of the
\field{description} field in parentheses
if the entry that was just referenced was used for the
first time},
+ topics={hooks},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtrpostlinkAddSymbolOnFirstUse,
+@glscommand{glsxtrpostlinkAddSymbolOnFirstUse,
name={\csfmt{gls\-xtr\-post\-link\-Add\-Symbol\-On\-First\-Use}},
description={only for use in the post-link hooks,
this appends a space and the value of the
\field{symbol} field in parentheses
if the entry that was just referenced was used for the
first time and has the \field{symbol} field set},
+ topics={hooks},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtrpostlinkAddSymbolDescOnFirstUse,
+@glscommand{glsxtrpostlinkAddSymbolDescOnFirstUse,
name={\csfmt{gls\-xtr\-post\-link\-Add\-Symbol\-Desc\-On\-First\-Use}},
description={only for use in the post-link hooks, if the
entry that was just referenced was used for the first time,
this appends a space and, in parentheses, the value of the
\field{symbol} field (if set)
followed by the value of the \field{description} field},
+ topics={hooks},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
-@index{glspluralsuffix,
+@glscommand{glspluralsuffix,
name={\csfmt{gls\-plural\-suffix}},
user1={},
description={the suffix used to construct the default plural},
- note={\styfmt{glossaries}},
+ topics={fixedtextcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{acrpluralsuffix,
+@glscommand{acrpluralsuffix,
name={\csfmt{acr\-plural\-suffix}},
user1={},
description={the suffix used to construct the default plural for
- the short form of acronyms},
- note={\styfmt{glossaries}},
+ the short form of acronyms using the base \sty{glossaries}
+ package's acronym mechanism (not used with the
+ \sty{glossaries-extra} enhanced abbreviation mechanism)},
+ topics={fixedtextcommands,abbreviationcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{abbrvpluralsuffix,
+@glscommand{abbrvpluralsuffix,
name={\csfmt{abbrv\-plural\-suffix}},
user1={},
description={the style sensitive suffix used to construct the
default plural for the short form of abbreviations},
- note={\styfmt{glossaries-extra}},
+ topics={fixedtextcommands,abbreviationcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
seealso={glsxtrabbrvpluralsuffix},
category={command}
}
-@index{glsxtrabbrvpluralsuffix,
+@abbrvstylecommand{glsxtrabbrvpluralsuffix,
name={\csfmt{gls\-xtr\-abbrv\-plural\-suffix}},
user1={},
description={the default suffix used to construct the plural for
- the short form of abbreviations},
- note={\styfmt{glossaries-extra}},
- category={command}
-}
-
-@index{glsxtrscsuffix,
- name={\csfmt{gls\-xtr\-sc\-suffix}},
- user1={},
- description={the suffix used to construct the plural for
- the short form of abbreviations with one of the small-cap
- (\code{sc}) styles},
- note={\styfmt{glossaries-extra}},
+ the short form of abbreviations. This just uses
+ \cs{glspluralsuffix}. If you don't want a plural suffix, you can
+ use the \catattr{noshortplural} attribute},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
+ topics={abbrstyle.long-short,abbrstyle.short-long,abbrstyle.short-footnote,abbrstyle.short-postfootnote,abbrstyle.short-nolong,abbrstyle.nolong-short,abbrstyle.nolong-short-noreg,abbrstyle.short-nolong-desc,abbrstyle.long-noshort-desc,abbrstyle.long-noshort-desc-noreg,abbrstyle.long-hyphen-noshort-desc-noreg,abbrstyle.long-hyphen-noshort-noreg,abbrstyle.long-noshort,abbrstyle.long-noshort-noreg,abbrstyle.long-short-desc},
category={command}
}
-@index{glsdefpostlink,
+@glscommand{glsdefpostlink,
name={\csfmt{gls\-def\-post\-link}},
user1={\margm{category}\margm{definition}},
description={define the post-link hook
\cs{glsxtrpostlinkcategory} for the given category},
+ topics={hooks,providingcommands},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
-@index{glsdefpostname,
+@glscommand{glsdefpostname,
name={\csfmt{gls\-def\-post\-name}},
user1={\margm{category}\margm{definition}},
description={define the post-name hook
\cs{glsxtrpostnamecategory} for the given category},
+ topics={hooks,providingcommands},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
-@index{glsdefpostdesc,
+@glscommand{glsdefpostdesc,
name={\csfmt{gls\-def\-post\-desc}},
user1={\margm{category}\margm{definition}},
description={define the post-description hook
\csfmt{glsxtrpostdesc}\meta{category} for the given category},
+ topics={hooks,providingcommands},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
-@index{glsxtrifwasfirstuse,
+@glscommand{glsxtrifwasfirstuse,
name={\csfmt{glsxtr\-if\-was\-first\-use}},
user1={\margm{true}\margm{false}},
description={only for use in the post-link hooks this
tests if the entry just referenced was used for the first time},
+ topics={hooks,conditionals},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{ifglsused,
+@glscommand{ifglsused,
name={\csfmt{if\-gls\-used}},
user1={\margm{label}\margm{true}\margm{false}},
description={does \meta{true} if the entry given by \meta{label} has been
@@ -7654,247 +11089,276 @@ category},
if the entry doesn't exist (an error or warning message will
occur and ?? will appear in the document).
This command is not for use in the post-link hooks},
+ topics={conditionals,entryrefcommands},
note={\styfmt{glossaries}},
seealso={GlsXtrIfUnusedOrUndefined,glsxtrifwasfirstuse},
category={command}
}
-@index{GlsXtrIfUnusedOrUndefined,
+@glscommand{GlsXtrIfUnusedOrUndefined,
name={\csfmt{Gls\-Xtr\-If\-Un\-used\-Or\-Un\-defined}},
user1={\margm{label}\margm{true}\margm{false}},
description={does \meta{true} if the entry given by \meta{label}
hasn't been
used or is undefined, otherwise it does \meta{false}.
This command is not for use in the post-link hooks},
+ topics={conditionals},
note={\styfmt{glossaries-extra} v1.34+},
seealso={ifglsused,glsxtrifwasfirstuse},
category={command}
}
-@index{GlsXtrLocationField,
+@glscommand{GlsXtrLocationField,
name={\csfmt{GlsXtrLocationField}},
user1={},
description={expands to the internal name of the field storing the
location list, defaulting to \field{location}},
+ topics={fieldrefcommands,loclistcommands},
note={\styfmt{glossaries-extra} v1.37+},
category={command}
}
-@index{glslabel,
+@glscommand{glslabel,
name={\csfmt{glslabel}},
user1={},
description={only for use in the post-link hooks, this
expands to the label of the entry that was last referenced},
+ topics={hooks},
note={\styfmt{glossaries}},
category={command}
}
-@index{glscurrententrylabel,
+@glscommand{glscurrententrylabel,
name={\csfmt{gls\-current\-entry\-label}},
user1={},
description={only for use in the glossary, such as in the style or
in the post-name or post-description hooks, this expands to the
label of the current entry},
+ topics={hooks},
note={\styfmt{glossaries}},
category={command}
}
-@index{glscurrentfieldvalue,
+@glscommand{glscurrentfieldvalue,
name={\csfmt{gls\-current\-field\-value}},
user1={},
description={only for use in the \meta{true} part of
\cs{ifglshasfield} or \cs{glsxtrifhasfield}, this expands to the
field value},
+ topics={conditionals},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsentrytitlecase,
+@glscommand{glsentrytitlecase,
name={\csfmt{gls\-entry\-title\-case}},
user1={\margm{entry label}\margm{field label}},
description={fetches the given field and applies
\ics{capitalisewords} to it},
- note={\styfmt{glossaries} v4.22+},
+ topics={casecommands,fieldrefcommands},
+ note={\styfmt{glossaries}\texparserdefnote\ v4.22+},
category={command}
}
-@index{capitalisewords,
+@command{capitalisewords,
name={\csfmt{capitalise\-words}},
user1={\margm{text}},
description={converts the first letter of each word to
\idx{uppercase} using \ics{makefirstuc}},
- note={\styfmt{mfirstuc} v1.06+},
+ note={\styfmt{mfirstuc}\texparserdefnote\ v1.06+},
category={command}
}
-@index{MFUnocap,
+@command{MFUnocap,
name={\csfmt{MFU\-no\-cap}},
user1={\margm{word}},
description={identifies \meta{word} as one that
should not have its case-changed by \ics{capitalisewords}
unless it occurs at the start},
- note={\styfmt{mfirstuc} v1.09+},
+ note={\styfmt{mfirstuc}\texparserdefnote\ v1.09+},
category={command}
}
-@index{glsxtrusefield,
+@glscommand{glsxtrusefield,
name={\csfmt{gls\-xtr\-use\-field}},
user1={\margm{entry label}\margm{field label}},
description={expands to the value of the given field for the given
entry},
- note={\styfmt{glossaries-extra} v1.12+},
+ topics={fieldrefcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote\ v1.12+},
category={command}
}
-@index{Glsxtrusefield,
+@glscommand{Glsxtrusefield,
name={\csfmt{Gls\-xtr\-use\-field}},
user1={\margm{entry label}\margm{field label}},
description={like \cs{glsxtrusefield} but converts the first
letter to \idx!{uppercase}},
- note={\styfmt{glossaries-extra} v1.12+},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote\ v1.12+},
category={command}
}
-@index{GLSxtrusefield,
+@glscommand{GLSxtrusefield,
name={\csfmt{GLS\-xtr\-use\-field}},
user1={\margm{entry label}\margm{field label}},
description={as \cs{glsxtrusefield} but converts the value to
\idx{uppercase}},
- note={\styfmt{glossaries-extra} v1.37+},
+ topics={fieldrefcommands,casecommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote\ v1.37+},
category={command}
}
-@index{GlsXtrSetField,
+@glscommand{GlsXtrSetField,
name={\csfmt{Gls\-Xtr\-Set\-Field}},
user1={\margm{entry label}\margm{field label}\margm{value}},
description={assigns the given \meta{value} to the field
identified by \meta{field label} for the
entry identified by \meta{entry label}},
+ topics={assigncommands},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@index{xGlsXtrSetField,
+@glscommand{xGlsXtrSetField,
name={\csfmt{xGls\-Xtr\-Set\-Field}},
user1={\margm{entry label}\margm{field label}\margm{value}},
description={globally assigns the (protected) full expansion of the given \meta{value} to the field
identified by \meta{field label} for the
entry identified by \meta{entry label}},
+ topics={assigncommands},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@index{glsxtrifhasfield,
+@glscommand{glsxtrifhasfield,
name={\csfmt{gls\-xtr\-if\-has\-field}},
user1={\margm{field label}\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry has the given \emph{internal} field set
(defined and not empty)
without testing if the entry exists and adds implicit scoping
to \meta{true} and \meta{false}},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.19+},
seealso={GlsXtrIfFieldUndef},
category={command}
}
-@index{glsxtrifhasfield*,
+@glscommand{glsxtrifhasfield*,
name={\csfmt{gls\-xtr\-if\-has\-field*}},
user1={\margm{field label}\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry has the given field set
(defined and not empty)
without testing if the entry exists and without introducing
an implicit scope},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.19+},
seealso={GlsXtrIfFieldUndef},
category={command}
}
-@index{GlsXtrIfFieldUndef,
+@glscommand{GlsXtrIfFieldUndef,
name={\csfmt{Gls\-Xtr\-If\-Field\-Undef}},
user1={\margm{field label}\margm{entry label}\margm{true}\margm{false}},
description={tests if the given field isn't defined for the given
entry, which may also not exist},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.23+},
category={command}
}
-@index{GlsXtrIfFieldEqStr,
+@glscommand{GlsXtrIfFieldEqStr,
name={\csfmt{Gls\-Xtr\-If\-Field\-Eq\-Str}},
user1={\margm{field label}\margm{entry label}\margm{text}\margm{true}\margm{false}},
description={tests if the given field value is the same as
- \meta{text} for the given entry, which may not exist},
+ \meta{text} for the given entry, which may not exist. The unstarred
+form adds implicit grouping. The starred form (new to v1.39)
+doesn't},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@index{GlsXtrIfFieldEqXpStr,
+@glscommand{GlsXtrIfFieldEqXpStr,
name={\csfmt{Gls\-Xtr\-If\-Field\-Eq\-Xp\-Str}},
user1={\margm{field label}\margm{entry label}\margm{text}\margm{true}\margm{false}},
description={like \cs{GlsXtrIfFieldEqStr} but first (protected)
-fully expands \meta{text} (but not the field value)},
+fully expands \meta{text} (but not the field value). The unstarred
+form adds implicit grouping. The starred form (new to v1.39)
+doesn't},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
-@index{GlsXtrIfXpFieldEqXpStr,
+@glscommand{GlsXtrIfXpFieldEqXpStr,
name={\csfmt{Gls\-Xtr\-If\-Xp\-Field\-Eq\-Xp\-Str}},
user1={\margm{field label}\margm{entry label}\margm{text}\margm{true}\margm{false}},
description={like \cs{GlsXtrIfFieldEqStr} but first (protected)
-fully expands both the field value and \meta{text}},
+fully expands both the field value and \meta{text}. The unstarred
+form adds implicit grouping. The starred form (new to v1.39)
+doesn't},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
-@index{ifglshasfield,
+@glscommand{ifglshasfield,
name={\csfmt{if\-gls\-has\-field}},
user1={\margm{field label}\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry, which must be defined, has the
given field set to a non-empty value},
note={\styfmt{glossaries}},
+ topics={conditionals,fieldrefcommands},
seealso={glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
}
-@index{ifglshassymbol,
+@glscommand{ifglshassymbol,
name={\csfmt{if\-gls\-has\-symbol}},
user1={\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry, which must be defined, has the
\field{symbol} field set to value that's not empty and not
\csfmt{relax}},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries}},
seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
}
-@index{ifglshasdesc,
+@glscommand{ifglshasdesc,
name={\csfmt{if\-gls\-has\-desc}},
user1={\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry, which must be defined, has the
\field{description} field set},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries}},
seealso={ifglshassymbol,ifglshasdescsuppressed},
category={command}
}
-@index{ifglshasdescsuppressed,
+@glscommand{ifglshasdescsuppressed,
name={\csfmt{if\-gls\-has\-suppressedesc}},
user1={\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry, which must be defined, has the
\field{description} field set to \cs{nopostdesc}},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries}},
seealso={ifglshasdesc},
category={command}
}
-@index{ifglshasparent,
+@glscommand{ifglshasparent,
name={\csfmt{if\-gls\-has\-parent}},
user1={\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry, which must be defined, has the
\field{parent} field set},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{ifglshaschildren,
+@glscommand{ifglshaschildren,
name={\csfmt{if\-gls\-has\-children}},
user1={\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry, which must be defined, has
@@ -7904,55 +11368,203 @@ fully expands both the field value and \meta{text}},
field. With \bibgls, a more efficient approach is to
use \csopt{save-child-count} and test the value of
the \field{childcount} field},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{ifglshasshort,
+@glscommand{ifglshasshort,
name={\csfmt{if\-gls\-has\-short}},
user1={\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry, which must be defined, has the
\field{short} field set},
+ topics={conditionals,fieldrefcommands,abbreviationcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{ifglshaslong,
+@glscommand{ifglshaslong,
name={\csfmt{if\-gls\-has\-long}},
user1={\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry, which must be defined, has the
\field{long} field set},
+ topics={conditionals,fieldrefcommands,abbreviationcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{GlsXtrIfFieldNonZero,
+@glscommand{ifglshasprefix,
+ name={\csfmt{if\-gls\-has\-prefix}},
+ user1={\margm{entry label}\margm{true}\margm{false}},
+ description={tests if the given entry, which must be defined, has the
+ \field{prefix} field set to value that's not empty},
+ topics={conditionals,fieldrefcommands},
+ note={\styfmt{glossaries-prefix}},
+ seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
+ category={command}
+}
+
+@glscommand{ifglshasprefixplural,
+ name={\csfmt{if\-gls\-has\-prefix\-plural}},
+ user1={\margm{entry label}\margm{true}\margm{false}},
+ description={tests if the given entry, which must be defined, has the
+ \field{prefixplural} field set to value that's not empty},
+ topics={conditionals,fieldrefcommands},
+ note={\styfmt{glossaries-prefix}},
+ seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
+ category={command}
+}
+
+@glscommand{ifglshasprefixfirst,
+ name={\csfmt{if\-gls\-has\-prefix\-first}},
+ user1={\margm{entry label}\margm{true}\margm{false}},
+ description={tests if the given entry, which must be defined, has the
+ \field{prefixfirst} field set to value that's not empty},
+ topics={conditionals,fieldrefcommands},
+ note={\styfmt{glossaries-prefix}},
+ seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
+ category={command}
+}
+
+@glscommand{ifglshasprefixfirstplural,
+ name={\csfmt{if\-gls\-has\-prefix\-first\-plural}},
+ user1={\margm{entry label}\margm{true}\margm{false}},
+ description={tests if the given entry, which must be defined, has the
+ \field{prefixfirstplural} field set to value that's not empty},
+ topics={conditionals,fieldrefcommands},
+ note={\styfmt{glossaries-prefix}},
+ seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
+ category={command}
+}
+
+@glscommand{ifglsfieldeq,
+ name={\csfmt{if\-gls\-field\-eq}},
+ user1={\margm{entry label}\margm{field label}\margm{string}\margm{true}\margm{false}},
+ description={tests if the given entry has the
+ given field value equal to \meta{string}, where \meta{field label}
+ is the internal field label (not the key name). No expansion is
+ performed in the test (which just uses \cs{ifcsstring})},
+ topics={conditionals,fieldrefcommands},
+ note={\styfmt{glossaries} v4.16+},
+ category={command}
+}
+
+@glscommand{ifglsfielddefeq,
+ name={\csfmt{if\-gls\-field\-def\-eq}},
+ user1={\margm{entry label}\margm{field label}\margm{cs}\margm{true}\margm{false}},
+ description={tests if the given entry has the
+ given field value equal to the replacement text of the command
+ given by \meta{cs}, where \meta{field label}
+ is the internal field label (not the key name). The test
+ uses \cs{ifdefstrequal}},
+ topics={conditionals,fieldrefcommands},
+ note={\styfmt{glossaries} v4.16+},
+ category={command}
+}
+
+@glscommand{ifglsfieldcseq,
+ name={\csfmt{if\-gls\-field\-cs\-eq}},
+ user1={\margm{entry label}\margm{field label}\margm{cs-name}\margm{true}\margm{false}},
+ description={tests if the given entry has the
+ given field value equal to the replacement text of the command
+ given by the control sequence name \meta{cs-name}, where \meta{field label}
+ is the internal field label (not the key name). The test
+ uses \cs{ifcsstrequal}},
+ topics={conditionals,fieldrefcommands},
+ note={\styfmt{glossaries} v4.16+},
+ category={command}
+}
+
+@glscommand{glsfielddef,
+ name={\csfmt{gls\-field\-def}},
+ user1={\margm{entry label}\margm{field label}\margm{definition}},
+ description={changes the value of the given
+ entry's field to \meta{definition} (localised by any scope)},
+ topics={fieldrefcommands,assigncommands},
+ note={\styfmt{glossaries} v4.16+},
+ category={command}
+}
+
+@glscommand{glsfieldgdef,
+ name={\csfmt{gls\-field\-gdef}},
+ user1={\margm{entry label}\margm{field label}\margm{definition}},
+ description={globally changes the value of the given
+ entry's field to \meta{definition}},
+ topics={fieldrefcommands,assigncommands},
+ note={\styfmt{glossaries} v4.16+},
+ category={command}
+}
+
+@glscommand{glsfieldedef,
+ name={\csfmt{gls\-field\-edef}},
+ user1={\margm{entry label}\margm{field label}\margm{definition}},
+ description={changes the value of the given entry's field to the
+ full expansion of \meta{definition} (localised by any scope)},
+ topics={fieldrefcommands,assigncommands},
+ note={\styfmt{glossaries} v4.16+},
+ category={command}
+}
+
+@glscommand{glsfieldxdef,
+ name={\csfmt{gls\-field\-xdef}},
+ user1={\margm{entry label}\margm{field label}\margm{definition}},
+ description={globally changes the value of the given entry's field to the
+ full expansion of \meta{definition}},
+ topics={fieldrefcommands,assigncommands},
+ note={\styfmt{glossaries} v4.16+},
+ category={command}
+}
+
+@glscommand{GlsXtrIfFieldNonZero,
name={\csfmt{Gls\-Xtr\-If\-Field\-Non\-Zero}},
user1={\margm{field}\margm{entry label}\margm{true}\margm{false}},
description={tests if the given field value expands to a non-zero
integer. If the field is undefined or empty, the value is assumed to
be 0. If the field is set, it must expand to an integer value.
The value can be referenced in \meta{true} or \meta{false}
-with \cs{glscurrentfieldvalue}},
+with \cs{glscurrentfieldvalue}. The unstarred
+form adds implicit grouping. The starred form (new to v1.39)
+doesn't},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.31+},
seealso={GlsXtrIfFieldEqNum},
category={command}
}
-@index{GlsXtrIfFieldEqNum,
+@glscommand{GlsXtrIfFieldEqNum,
name={\csfmt{Gls\-Xtr\-If\-Field\-Eq\-Num}},
user1={\margm{field}\margm{entry label}\margm{number}\margm{true}\margm{false}},
description={tests if the given field value expands to the given
integer \meta{number}. If the field is undefined or empty, the value is assumed to
be 0. If the field is set, it must expand to an integer value.
The value can be referenced in \meta{true} or \meta{false}
-with \cs{glscurrentfieldvalue}},
+with \cs{glscurrentfieldvalue}. The unstarred
+form adds implicit grouping. The starred form (new to v1.39)
+doesn't},
+ topics={conditionals,fieldrefcommands},
+ note={\styfmt{glossaries-extra} v1.31+},
+ seealso={GlsXtrIfFieldNonZero,GlsXtrIfFieldCmpNum},
+ category={command}
+}
+
+@glscommand{GlsXtrIfFieldCmpNum,
+ name={\csfmt{Gls\-Xtr\-If\-Field\-Cmp\-Num}},
+ user1={\margm{field}\margm{entry label}\margm{comparison}\margm{number}\margm{true}\margm{false}},
+ description={compares the given (numerical) field value to the given
+integer \meta{number}. The \meta{comparison} may be one of:
+\code{=}, \code{<} or \code{>}. If the field is undefined or empty, the value is assumed to
+be 0. If the field is set, it must expand to an integer value.
+The value can be referenced in \meta{true} or \meta{false}
+with \cs{glscurrentfieldvalue}. The unstarred
+form adds implicit grouping. The starred form (new to v1.39)
+doesn't},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.31+},
seealso={GlsXtrIfFieldNonZero},
category={command}
}
-@dualindexentry{GlsXtrIfHasNonZeroChildCount,
+@mainglscommand{GlsXtrIfHasNonZeroChildCount,
name={\csfmt{Gls\-Xtr\-If\-Has\-Non\-Zero\-Child\-Count}},
user1={\margm{entry label}\margm{true}\margm{false}},
description={for use with the \csopt{save-child-count} resource
@@ -7960,67 +11572,34 @@ option, this uses \cs{GlsXtrIfFieldNonZero} to test if the
\field{childcount} field has a non-zero value. The value
can be referenced in \meta{true} or \meta{false} with
\cs{glscurrentfieldvalue}},
+ topics={conditionals,fieldrefcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.31+},
seealso={GlsXtrIfFieldNonZero},
category={command}
}
-@dualindexentry{glsxtrifcustomdiscardperiod,
+@mainglscommand{glsxtrifcustomdiscardperiod,
name={\csfmt{gls\-xtr\-if\-custom\-discard\-period}},
user1={\margm{true}\margm{false}},
description={should expand to \meta{true} if the post-link hook
should check for a following full stop (in addition to attribute
checks) otherwise should expand to \meta{false}},
+ topics={conditionals,hooks},
note={\styfmt{glossaries-extra} v1.23+},
category={command}
}
-@index{glsxtrlongshortdescname,
- name={\csfmt{gls\-xtr\-long\-short\-desc\-name}},
- user1={},
- description={governs the way the \field{name} field is set
- by the \abbrstyle{long-short-desc} abbreviation styles},
- note={\styfmt{glossaries-extra} v1.17+},
- category={command}
-}
-
-@index{glsxtrlongshortname,
- name={\csfmt{gls\-xtr\-long\-short\-name}},
- user1={},
- description={governs the way the \field{name} field is set
- by the \abbrstyle{long-short} abbreviation styles},
- note={\styfmt{glossaries-extra} v1.25+},
- category={command}
-}
-
-@index{glsxtronlyname,
- name={\csfmt{gls\-xtr\-only\-name}},
- user1={},
- description={governs the way the \field{name} field is set
- by the \abbrstyle{long-only-short-only} abbreviation styles},
- note={\styfmt{glossaries-extra} v1.25+},
- category={command}
-}
-
-@index{glsxtronlydescname,
- name={\csfmt{gls\-xtr\-only\-desc\-name}},
- user1={},
- description={governs the way the \field{name} field is set
- by the \abbrstyle{long-only-short-only} abbreviation styles},
- note={\styfmt{glossaries-extra} v1.17+},
- category={command}
-}
-
-@index{glsaddkey,
+@glscommand{glsaddkey,
name={\csfmt{gls\-add\-key}},
user1={\margm{key}\margm{default value}\margm{no link cs}\margm{no link ucfirst cs}\margm{link cs}\margm{link ucfirst cs}\margm{link allcaps cs}},
description={adds a new key for use in \csref{newglossaryentry}
and associated commands to access it},
+ topics={definingterms,providingcommands,linkcommands,fieldrefcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsxtrprovidestoragekey,
+@glscommand{glsxtrprovidestoragekey,
name={\csfmt{gls\-xtr\-provide\-storage\-key}},
user1={\margm{key}\margm{default value}\margm{no link cs}},
description={adds a new key, if not already defined, for use in
@@ -8028,448 +11607,593 @@ can be referenced in \meta{true} or \meta{false} with
and an associated command
to access it where (unlike \cs{glsaddstoragekey})
the \meta{no link cs} part may be empty if unrequired},
+ topics={definingterms,providingcommands,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@index{glsaddstoragekey,
+@glscommand{glsaddstoragekey,
name={\csfmt{gls\-add\-storage\-key}},
user1={\margm{key}\margm{default value}\margm{no link cs}},
description={adds a new key for internal use that can be set in
\csref{newglossaryentry}},
+ topics={definingterms,providingcommands,fieldrefcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{GlsXtrEnableInitialTagging,
+@glscommand{glsautoprefix,
+ name={\csfmt{gls\-auto\-prefix}},
+ description={prefix used for the automatically labelling triggered
+ by the \styopt[autolabel]{numberedsection} option},
+ topics={hooks,crossrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glsenablehyper,
+ name={\csfmt{gls\-enable\-hyper}},
+ description={enables the creation of hyperlinks and targets for
+ the glossary commands that support them (automatically implemented
+ if \sty{hyperref} is loaded before \sty{glossaries})},
+ topics={linkcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glsdisablehyper,
+ name={\csfmt{gls\-disable\-hyper}},
+ description={disables the creation of hyperlinks and targets for
+ the glossary commands that support them (automatically implemented
+ if \sty{hyperref} isn't loaded before \sty{glossaries})},
+ topics={linkcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{GlsXtrEnableInitialTagging,
name={\csfmt{Gls\-Xtr\-Enable\-Initial\-Tagging}},
user1={\margm{category list}\margm{cs}},
description={defines the control sequence \meta{cs}
to be used with abbreviation tagging
with the given categories},
- note={\styfmt{glossaries-extra}},
+ topics={abbreviationcommands,formattingcommands},
+ note={\styfmt{glossaries-extra}\texparserdefnote},
category={command}
}
-@index{glsxtrtagfont,
+@glscommand{glsxtrtagfont,
name={\csfmt{gls\-xtr\-tag\-font}},
user1={\margm{text}},
description={font used by tagging command defined by
\cs{GlsXtrEnableInitialTagging}},
note={\styfmt{glossaries-extra}},
+ topics={abbreviationcommands,formattingcommands},
category={command},
seealso={GlsXtrEnableInitialTagging}
}
-@index{glsnavhypertarget,
+@glscommand{glsnavhypertarget,
name={\csfmt{gls\-nav\-hyper\-target}},
user1={\oargm{type}\margm{label}\margm{text}},
description={creates a hyper target for the group given by
- \meta{label} for the given glossary type and displays the text},
+ \meta{label} for the given glossary type and uses \meta{text}
+ for the hyperlink text},
+ topics={linkcommands,entryrefcommands},
note={\styfmt{glossary-hypernav}},
category={command}
}
-@index{newentry,
+@glscommand{newentry,
name={\csfmt{newentry}},
user1={\margm{label}\margm{\keyvallist}},
description={equivalent to \csref{newglossaryentry}},
- note={\styfmt{glossaries-extra}'s shortcuts},
+ topics={definingterms,shortcutcommands},
+ note={\styfmt{glossaries-extra} \styopt{shortcuts}},
category={command}
}
-@index{newsym,
+@glscommand{newsym,
name={\csfmt{newsym}},
user1={\margm{label}\margm{\keyvallist}\margm{symbol}},
description={equivalent to \csref{glsxtrnewsymbol}},
note={\styfmt{glossaries-extra} \styopt{shortcuts}},
+ topics={definingterms,shortcutcommands},
category={command}
}
-@index{newnum,
+@glscommand{newnum,
name={\csfmt{newnum}},
user1={\margm{label}\margm{\keyvallist}},
description={equivalent to \csref{glsxtrnewnumber}},
+ topics={definingterms,shortcutcommands},
note={\styfmt{glossaries-extra} \styopt{shortcuts}},
category={command}
}
-@index{acronymtype,
+@glscommand{acronymtype,
name={\csfmt{acronym\-type}},
user1={},
description={expands to the default acronym glossary type when using
\csref{newacronym}},
+ topics={glossrefs},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsxtrabbrvtype,
+@glscommand{glsxtrabbrvtype,
name={\csfmt{gls\-xtr\-abbrv\-type}},
user1={},
description={expands to the default glossary type when using
\csref{newabbreviation}},
+ topics={glossrefs},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{nopostdesc,
+@glscommand{nopostdesc,
name={\csfmt{no\-post\-desc}},
user1={},
description={suppresses the post-description hook},
+ topics={hooks},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsxtrnopostpunc,
+@glscommand{glsxtrnopostpunc,
name={\csfmt{gls\-xtr\-no\-post\-punc}},
user1={},
description={suppresses the post-description punctuation
without suppressing the post-description hook},
+ topics={hooks},
note={\styfmt{glossaries-extra} v1.22+},
category={command}
}
-@index{glsxtrrestorepostpunc,
+@glscommand{glsxtrrestorepostpunc,
name={\csfmt{gls\-xtr\-restore\-post\-punc}},
user1={},
description={used within post-description category hooks,
this restores the post-description punctuation
if it's been suppressed with \cs{glsxtrnopostpunc}},
+ topics={hooks},
note={\styfmt{glossaries-extra} v1.23+},
category={command}
}
-@index{loadglsentries,
+@glscommand{loadglsentries,
name={\csfmt{load\-gls\-entries}},
user1={\oargm{type}\margm{file}},
description={locally redefines \cs{glsdefaulttype}
to \meta{type} and inputs \meta{file}},
+ topics={definingterms},
note={\styfmt{glossaries}},
category={command}
}
-@index{newglossary,
+@glscommand{newglossary,
name={\csfmt{newglossary}},
user1={\oargm{log}\margm{type}\margm{gls}\margm{glo}\margm{title}},
description={defines a new glossary identified by \meta{type}
with the given title and associated file extensions used by
\appfmt{makeindex} or \appfmt{xindy}},
+ topics={glossrefs},
note={\styfmt{glossaries}},
category={command}
}
-@index{newglossary*,
+@glscommand{newglossary*,
name={\csfmt{newglossary*}},
user1={\margm{type}\margm{title}},
description={defines a new glossary identified by \meta{type}
with the given title},
+ topics={glossrefs},
note={\styfmt{glossaries}},
category={command}
}
-@index{newignoredglossary,
+@glscommand{newignoredglossary,
name={\csfmt{new\-ignored\-glossary}},
user1={\margm{type}},
description={defines a new ignored glossary (with hyperlinks
suppressed) identified by \meta{type}
that's not included in the list used by commands, such
as \cs{printunsrtglossaries}, that iterate over defined glossaries},
+ topics={glossrefs},
note={\styfmt{glossaries} v4.08+},
category={command}
}
-@index{newignoredglossary*,
+@glscommand{newignoredglossary*,
name={\csfmt{new\-ignored\-glossary*}},
user1={\margm{type}},
description={defines a new ignored glossary (without
suppressing hyperlinks) identified by \meta{type}
that's not included in the list used by commands, such
as \cs{printunsrtglossaries}, that iterate over defined glossaries},
+ topics={glossrefs},
note={\styfmt{glossaries-extra} v1.11+},
category={command}
}
-@index{provideignoredglossary,
+@glscommand{provideignoredglossary,
name={\csfmt{provide\-ignored\-glossary}},
user1={\margm{type}},
description={as \cs{newignoredglossary} but does nothing
if a glossary identified by \meta{type} already exists},
+ topics={glossrefs},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@index{provideignoredglossary*,
+@glscommand{provideignoredglossary*,
name={\csfmt{provide\-ignored\-glossary*}},
user1={\margm{type}},
description={as \ics{provideignoredglossary} but doesn't
suppress hyperlinks},
+ topics={glossrefs},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@index{delimN,
+@glscommand{delimN,
name={\csfmt{delimN}},
user1={},
description={used to delimited individual locations},
+ topics={glossarystylecommands,separatorcommands,loclistcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{delimR,
+@glscommand{delimR,
name={\csfmt{delimR}},
user1={},
description={used as a separator between the start and end locations
of a range},
+ topics={glossarystylecommands,separatorcommands,loclistcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsnoidxloclist,
+@glscommand{glsnoidxloclist,
name={\csfmt{gls\-noidx\-loc\-list}},
user1={\margm{location list cs}},
description={iterates over the given internal location list using
the \cs{glsnoidxloclisthandler} handler},
+ topics={glossarystylecommands,loops,loclistcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsnoidxloclisthandler,
+@glscommand{glsnoidxloclisthandler,
name={\csfmt{gls\-noidx\-loc\-list\-handler}},
description={the handler used by the internal list loop function used
in \cs{glsnoidxloclist}},
+ topics={glossarystylecommands,loops,loclistcommands},
user1={\margm{location}},
note={\styfmt{glossaries}},
category={command}
}
-@index{glossentry,
+@glscommand{glossentry,
name={\csfmt{glossentry}},
user1={\margm{label}\margm{location list}},
description={used in the glossary to display a top-level entry},
+ topics={glossarystylecommands},
note={\styfmt{glossaries} v3.08a+},
category={command}
}
-@index{subglossentry,
+@glscommand{subglossentry,
name={\csfmt{subglossentry}},
user1={\margm{level}\margm{label}\margm{location list}},
description={used in the glossary to display a sub-entry},
+ topics={glossarystylecommands},
note={\styfmt{glossaries} v3.08a+},
category={command}
}
-@index{newglossarystyle,
+@glscommand{newglossarystyle,
name={\csfmt{new\-glossary\-style}},
user1={\margm{name}\margm{definition}},
description={defines a new glossary style called \meta{name}},
+ topics={glossarystylecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{setglossarystyle,
+@glscommand{setglossarystyle,
name={\csfmt{set\-glossary\-style}},
user1={\margm{name}},
description={sets the glossary style identified by \meta{name}},
+ topics={glossarystylecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glossaryheader,
+@glscommand{glossaryheader,
name={\csfmt{glossary\-header}},
description={implemented at the start of a glossary (modified by
glossary styles)},
+ topics={glossarystylecommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glsgroupskip,
+ name={\csfmt{gls\-group\-skip}},
+ description={inserted between groups to create some vertical
+ spacing (this command is modified by
+ glossary styles, and may be switched off with the
+ \styopt{nogroupskip} option)},
+ topics={glossarystylecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsentryitem,
+@glscommand{glsentryitem,
name={\csfmt{gls\-entry\-item}},
user1={\margm{label}},
description={increments and displays the \counter{glossaryentry}
counter, if appropriate},
+ topics={glossarystylecommands},
note={\styfmt{glossaries} v3.0+},
category={command}
}
-@index{glssubentryitem,
+@glscommand{glsentrycounterlabel,
+ name={\csfmt{gls\-entry\-counter\-label}},
+ description={governs the way the \counter{glossaryentry}
+ counter is displayed by \cs{glsentryitem}},
+ topics={glossarystylecommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glssubentryitem,
name={\csfmt{gls\-sub\-entry\-item}},
user1={\margm{label}},
description={increments and displays the \counter{glossarysubentry}
counter, if appropriate},
+ topics={glossarystylecommands},
note={\styfmt{glossaries} v3.0+},
category={command}
}
-@index{glstarget,
+@glscommand{glssubentrycounterlabel,
+ name={\csfmt{gls\-sub\-entry\-counter\-label}},
+ description={governs the way the \counter{glossarysubentry}
+ counter is displayed by \cs{glssubentryitem}},
+ topics={glossarystylecommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glstarget,
name={\csfmt{gls\-target}},
user1={\margm{label}\margm{text}},
description={creates a hypertarget for the entry given by
\meta{label} (the target for commands like \cs{gls}) and displays \meta{text}},
+ topics={glossarystylecommands,linkcommands},
note={\styfmt{glossaries} v1.18+},
category={command}
}
-@index{glsnamefont,
+@glscommand{glsnamefont,
name={\csfmt{gls\-name\-font}},
user1={\margm{text}},
description={used by \cs{glossentryname} to format the name},
+ topics={glossarystylecommands,formattingcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glossentryname,
+@glscommand{glossentryname,
name={\csfmt{gloss\-entry\-name}},
user1={\margm{label}},
description={used by glossary styles to display the name},
+ topics={glossarystylecommands,fieldrefcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glossentrysymbol,
+@glscommand{glossentrysymbol,
name={\csfmt{gloss\-entry\-symbol}},
user1={\margm{label}},
description={used by glossary styles to display the symbol},
+ topics={glossarystylecommands,fieldrefcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glspostdescription,
+@glscommand{glspostdescription,
name={\csfmt{glspostdescription}},
description={a hook added after the description in some glossary
styles (all if the \sty{glossaries-extra-stylemods} package is
loaded to patch them). This hook is used to reflect the
\styopt{nopostdot} package option for \sty{glossaries}
and the \styopt{postpunc} option for \sty{glossaries-extra}},
+ topics={glossarystylecommands,hooks},
note={\styfmt{glossaries} and modified by
\styfmt{glossaries-extra}},
category={command}
}
-@index{glossentrynameother,
+@glscommand{glossentrynameother,
name={\csfmt{gloss\-entry\-name\-other}},
user1={\margm{label}\margm{field}},
description={acts like \ics{glossentryname} (obeys
\catattr{glossname} and \catattr{glossnamefont}
or \cs{glsnamefont} and the post-name hook) but uses
the given \meta{field} instead of the \field{name} field},
+ topics={glossarystylecommands,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.22+},
category={command}
}
-@index{glossentrydesc,
+@glscommand{glossentrydesc,
name={\csfmt{gloss\-entry\-desc}},
user1={\margm{label}},
description={used by glossary styles to display the description},
+ topics={glossarystylecommands,fieldrefcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{Glossentrydesc,
+@glscommand{Glossentrydesc,
name={\csfmt{Gloss\-entry\-desc}},
user1={\margm{label}},
description={like \cs{glossentrydesc} but converts the first
-letter to uppercase},
+letter to \idx{uppercase}},
+ topics={glossarystylecommands,fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{Glossentryname,
+ name={\csfmt{Gloss\-entry\-name}},
+ user1={\margm{label}},
+ description={like \cs{glossentryname} but converts the first
+letter to \idx{uppercase}},
+ topics={glossarystylecommands,fieldrefcommands,casecommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{Glossentrysymbol,
+ name={\csfmt{Gloss\-entry\-symbol}},
+ user1={\margm{label}},
+ description={like \cs{glossentrysymbol} but converts the first
+letter to \idx{uppercase}},
+ topics={glossarystylecommands,fieldrefcommands,casecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsaddall,
+@glscommand{glsaddall,
name={\csfmt{glsaddall}},
user1={\oargm{options}},
description={iterates over all entries defined for all glossaries
- (or for the sub-list provided in the options) and performs
- \cs{glsadd} for each entry},
+ (or for the sub-list provided by \optfmt{types=\margm{list}} in the options)
+ and performs \code{\cs{glsadd}\oargm{options}} for each entry.
+ This command isn't suitable for use with \bibgls. Use the
+ \csopt{selection} option instead},
+ topics={loops,indexing},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsaddallunused,
+@glscommand{glsaddallunused,
name={\csfmt{gls\-add\-all\-unused}},
user1={\oargm{list}},
description={iterates over all entries defined for all glossaries
(or for the sub-list provided in the options) and performs
\cs{glsadd} for each entry that hasn't been used with
- the \glsaddopt{format} set to \code{glsignore}},
+ the \glsaddopt{format} set to \code{glsignore}.
+ This command isn't suitable for use with \bibgls. Use the
+ \csopt{selection} option instead},
+ topics={loops,indexing},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsadd,
+@glscommand{glsadd,
name={\csfmt{glsadd}},
user1={\oargm{options}\margm{label}},
description={indexes the entry without displaying any text},
+ topics={indexing},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsaddeach,
+@glscommand{glsaddeach,
name={\csfmt{gls\-add\-each}},
user1={\oargm{options}\margm{label list}},
description={indexes each entry identified in the comma-separated
list of labels without displaying any text},
+ topics={indexing},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
-@index{glsadd.thevalue,
+@glsaddoption{glsadd.thevalue,
name={\csoptfmt{thevalue}},
+ user1={\margm{value}},
+ description={overrides the record value so that it's the
+ given \meta{value} not obtained from the associated counter},
category={commandoption},
+ note={\styfmt{glossaries-extra} v1.14+},
parent={glsadd}
}
-@index{glsadd.theHvalue,
+@glsaddoption{glsadd.theHvalue,
name={\csoptfmt{theHvalue}},
+ user1={\margm{value}},
+ description={the hyperlink target corresponding to the value
+ of \glsopt{thevalue}, if appropriate},
category={commandoption},
+ note={\styfmt{glossaries-extra} v1.14+},
parent={glsadd}
}
-@index{glsadd.format,
+@glsaddoption{glsadd.format,
name={\csoptfmt{format}},
+ user1={\margm{encap}},
+ description={sets the \gls{encap} for the record to
+ \meta{encap}, optionally with the start or end range markers},
category={commandoption},
+ note={\styfmt{glossaries}},
parent={glsadd}
}
-@index{glsadd.counter,
+@glsaddoption{glsadd.counter,
name={\csoptfmt{counter}},
+ user1={\margm{counter-name}},
+ description={sets the counter to use for the record},
category={commandoption},
+ note={\styfmt{glossaries}},
parent={glsadd}
}
-@index{theglossaryentry,
+@glscommand{theglossaryentry,
name={\csfmt{theglossaryentry}},
description={textual representation of the \counter{glossaryentry}
counter, which is defined with the \styopt{entrycounter} option},
+ topics={glossarystylecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{theHglossaryentry,
+@glscommand{theHglossaryentry,
name={\csfmt{theHglossaryentry}},
description={hypertarget associated with the \counter{glossaryentry}
counter, which is defined with the \styopt{entrycounter} option},
+ topics={glossarystylecommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsstepentry,
+@glscommand{glsstepentry,
name={\csfmt{gls\-step\-entry}},
user1 = {\margm{label}},
description={increments the \counter{glossaryentry} counter, which
is defined with the \styopt{entrycounter} option, and automatically
labels it with \cs{label}},
+ topics={glossarystylecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{currentglossary,
+@glscommand{currentglossary,
name={\csfmt{currentglossary}},
description={defined within the glossary to the current glossary
type, this has no meaning outside of the glossary list},
+ topics={glossarystylecommands,glossrefs},
note={\styfmt{glossaries}},
category={command}
}
-@index{frontmatter,
+@command{frontmatter,
name={\csfmt{front\-matter}},
user1={},
description={switches to front matter},
@@ -8477,7 +12201,7 @@ type, this has no meaning outside of the glossary list},
category={command}
}
-@index{mainmatter,
+@command{mainmatter,
name={\csfmt{main\-matter}},
user1={},
description={switches to main matter},
@@ -8485,7 +12209,7 @@ type, this has no meaning outside of the glossary list},
category={command}
}
-@index{backmatter,
+@command{backmatter,
name={\csfmt{back\-matter}},
user1={},
description={switches to back matter},
@@ -8493,86 +12217,96 @@ type, this has no meaning outside of the glossary list},
category={command}
}
-@index{GlsXtrSetDefaultNumberFormat,
+@glscommand{GlsXtrSetDefaultNumberFormat,
name={\csfmt{Gls\-Xtr\-Set\-Default\-Number\-Format}},
user1={\margm{format}},
description={set the default format to use if the
\glsaddopt{format} key isn't set},
+ topics={formattingcommands,indexing},
note={\styfmt{glossaries-extra} v1.19+},
category={command}
}
-@index{GlsXtrSetDefaultGlsOpts,
+@glscommand{GlsXtrSetDefaultGlsOpts,
name={\csfmt{Gls\-Xtr\-Set\-Default\-Gls\-Opts}},
user1={\margm{options}},
description={set the default options for commands like \cs{gls}},
+ topics={formattingcommands,indexing},
+ seealso={GlsXtrSetDefaultNumberFormat},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsnumberformat,
+@glscommand{glsnumberformat,
name={\csfmt{gls\-number\-format}},
user1={\margm{text}},
description={default location format, uses \cs{glshypernumber} if
hyperlinks enabled otherwise just does \meta{text}},
+ topics={formattingcommands,indexing,loclistcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glshypernumber,
+@glscommand{glshypernumber,
name={\csfmt{gls\-hyper\-number}},
user1={\margm{text}},
description={a location format that has a hyperlink (if enabled)},
+ topics={formattingcommands,indexing,loclistcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{hypersf,
+@glscommand{hypersf,
name={\csfmt{hypersf}},
user1={\margm{text}},
description={a location format that uses the sans-serif
font that also has a hyperlink (if enabled)},
+ topics={formattingcommands,indexing,loclistcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{hyperit,
+@glscommand{hyperit,
name={\csfmt{hyperit}},
user1={\margm{text}},
description={a location format that uses the italic
font that also has a hyperlink (if enabled)},
+ topics={formattingcommands,indexing,loclistcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{hyperbf,
+@glscommand{hyperbf,
name={\csfmt{hyperbf}},
user1={\margm{text}},
description={a location format that uses the bold
font that also has a hyperlink (if enabled)},
+ topics={formattingcommands,indexing,loclistcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{hyperemph,
+@glscommand{hyperemph,
name={\csfmt{hyperemph}},
user1={\margm{text}},
description={a location format that uses \ics{emph} to set the
font and also has a hyperlink (if enabled)},
+ topics={formattingcommands,indexing,loclistcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{hyperrm,
+@glscommand{hyperrm,
name={\csfmt{hyperrm}},
user1={\margm{text}},
description={a location format that uses the serif (Roman)
font that also has a hyperlink (if enabled)},
+ topics={formattingcommands,indexing,loclistcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{emph,
+@command{emph,
name={\csfmt{emph}},
user1={\margm{text}},
description={emphasizes the given text (italic or slanted
@@ -8582,14 +12316,14 @@ hyperlinks enabled otherwise just does \meta{text}},
category={command}
}
-@index{em,
+@command{em,
name={\csfmt{em}},
description={switch to emphasized font (until end of current scope)},
note={kernel command},
category={command}
}
-@index{textsf,
+@command{textsf,
name={\csfmt{textsf}},
user1={\margm{text}},
description={displays the given text in sans-serif},
@@ -8597,7 +12331,7 @@ hyperlinks enabled otherwise just does \meta{text}},
category={command}
}
-@index{textbf,
+@command{textbf,
name={\csfmt{textbf}},
user1={\margm{text}},
description={displays the given text in bold},
@@ -8605,14 +12339,14 @@ hyperlinks enabled otherwise just does \meta{text}},
category={command}
}
-@index{bfseries,
+@command{bfseries,
name={\csfmt{bfseries}},
description={switch to bold (until end of current scope)},
note={kernel command},
category={command}
}
-@index{textit,
+@command{textit,
name={\csfmt{textit}},
user1={\margm{text}},
description={displays the given text in italic},
@@ -8621,7 +12355,7 @@ hyperlinks enabled otherwise just does \meta{text}},
category={command}
}
-@index{texttt,
+@command{texttt,
name={\csfmt{texttt}},
user1={\margm{text}},
description={displays the given text in monospaced font},
@@ -8629,33 +12363,33 @@ hyperlinks enabled otherwise just does \meta{text}},
category={command}
}
-@index{@firstofone,
+@command{@firstofone,
name={\csfmt{@first\-of\-one}},
user1={\margm{code}},
description={does \meta{code}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{@gobble,
+@command{@gobble,
name={\csfmt{@gobble}},
user1={\margm{code}},
description={does nothing (the argument is discarded)},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{@for,
+@command{@for,
name={\csfmt{@for}},
user1={\meta{cs}:=\meta{list}\csfmt{do}\margm{code}},
description={iterates over each item in the comma-separated
\meta{list}, and on each iteration sets \meta{cs} to the current
element and performs \meta{code}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{alph,
+@command{alph,
name={\csfmt{alph}},
user1={\margm{counter}},
description={displays the given counter as an alphabetic character
@@ -8664,7 +12398,7 @@ from \qt{a} to \qt{z}},
category={command}
}
-@index{footnote,
+@command{footnote,
name={\csfmt{footnote}},
user1={\oargm{number}\margm{text}},
description={displays the given text as a footnote},
@@ -8672,7 +12406,7 @@ from \qt{a} to \qt{z}},
category={command}
}
-@index{index,
+@command{index,
name={\csfmt{index}},
user1={\margm{text}},
description={indexes the given term by writing the relevant
@@ -8682,36 +12416,39 @@ by \idx{makeindex} or \idx{xindy}},
category={command}
}
-@index{glsignore,
+@glscommand{glsignore,
name={\csfmt{gls\-ignore}},
user1={\margm{text}},
description={does nothing but when used as a location format
\bibgls\ recognises it as an \idx{ignoredrecord}},
+ topics={formattingcommands,indexing,loclistcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{@istfilename,
+@glscommand{@istfilename,
name={\csfmt{@istfilename}},
user1={\margm{filename}},
description={identifies the style file in the \ext{aux}
file for the benefit of external tools like
\idx{makeglossaries} and \idx{makeglossaries-lite}},
+ topics={internalcommands,auxcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glstriggerrecordformat,
+@glscommand{glstriggerrecordformat,
name={\csfmt{gls\-trigger\-record\-format}},
user1={\margm{text}},
description={does nothing but when used as a location format
\bibgls\ recognises it as an \idx{ignoredrecord} indexed by
commands like \csref{rgls}},
+ topics={formattingcommands,indexing,loclistcommands},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@index{at,
+@command{at,
name={\csfmt{@}},
user1={},
description={adjusts the space factor to indicate the following
@@ -8720,26 +12457,42 @@ by \idx{makeindex} or \idx{xindy}},
category={command}
}
-@index{forall,
+@command{forall,
name={\csfmt{forall}},
user1={},
description={for all symbol ($\forall$)},
- note={kernel command},
+ note={kernel command\texparserdefnote\ (maths mode)},
+ category={command}
+}
+
+@command{heartsuit,
+ name={\csfmt{heartsuit}},
+ user1={},
+ description={heart symbol ($\heartsuit$)},
+ note={kernel command\texparserdefnote\ (maths mode)},
+ category={command}
+}
+
+@command{diamondsuit,
+ name={\csfmt{diamondsuit}},
+ user1={},
+ description={diamond symbol ($\diamondsuit$)},
+ note={kernel command\texparserdefnote\ (maths mode)},
category={command}
}
-@index{ensuremath,
+@command{ensuremath,
name={\csfmt{ensuremath}},
user1={\margm{maths}},
description={ensures the argument is in math mode. As a general
rule this should only be used if you know for certain that
the argument just contains mathematical markup and doesn't cause a
change in mode},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{mathord,
+@command{mathord,
name={\csfmt{mathord}},
user1={\margm{maths}},
description={assigns the character or sub-formula in the
@@ -8748,7 +12501,7 @@ change in mode},
category={command}
}
-@index{mathop,
+@command{mathop,
name={\csfmt{mathop}},
user1={\margm{maths}},
description={assigns the character or sub-formula in the
@@ -8757,7 +12510,7 @@ change in mode},
category={command}
}
-@index{mathpunct,
+@command{mathpunct,
name={\csfmt{mathpunct}},
user1={\margm{maths}},
description={assigns the character or sub-formula in the
@@ -8766,7 +12519,7 @@ change in mode},
category={command}
}
-@index{mathrel,
+@command{mathrel,
name={\csfmt{mathrel}},
user1={\margm{maths}},
description={assigns the character or sub-formula in the
@@ -8775,7 +12528,7 @@ change in mode},
category={command}
}
-@index{write18,
+@command{write18,
name={\csfmt{write18}},
user1={\margm{system call}},
description={perform shell escape if permitted},
@@ -8783,7 +12536,7 @@ change in mode},
category={command}
}
-@index{immediate,
+@command{immediate,
name={\csfmt{immediate}},
user1={\meta{file operation}},
description={perform the file operation immediately instead of the
@@ -8792,7 +12545,7 @@ usual delay},
category={command}
}
-@index{AtEndDocument,
+@command{AtEndDocument,
name={\csfmt{AtEndDocument}},
user1={\margm{code}},
description={perform \meta{code} at the end of the document},
@@ -8800,40 +12553,40 @@ usual delay},
category={command}
}
-@index{unexpanded,
+@command{unexpanded,
name={\csfmt{unexpanded}},
user1={\margm{general text}},
description={expands to the argument},
- note={{}\eTeX\ primitive},
+ note={{}\eTeX\ primitive\texparserdefnote},
category={command}
}
-@index{detokenize,
+@command{detokenize,
name={\csfmt{detokenize}},
user1={\margm{general text}},
description={expands the argument to a list of character tokens},
- note={{}\eTeX\ primitive},
+ note={{}\eTeX\ primitive\texparserdefnote},
category={command}
}
-@index{input,
+@command{input,
name={\csfmt{input}},
user1={\margm{file}},
description={input the given file},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{IfFileExists,
+@command{IfFileExists,
name={\csfmt{IfFileExists}},
user1={\margm{file}\margm{true}\margm{false}},
description={if the given \meta{file} exists does \meta{true}
otherwise does \meta{false}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{jobname,
+@command{jobname,
name={\csfmt{jobname}},
user1={},
description={the current job name, which is usually the name of
@@ -8842,63 +12595,63 @@ usual delay},
category={command}
}
-@index{protect,
+@command{protect,
name={\csfmt{protect}},
user1={\meta{token}},
description={protects \meta{token} from expansion},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{ifcase,
+@command{ifcase,
name={\csfmt{ifcase}},
user1={\meta{number}},
description={case conditional},
- note={\TeX\ primitive},
+ note={\TeX\ primitive\texparserdefnote},
category={command}
}
-@index{ifnum,
+@command{ifnum,
name={\csfmt{ifnum}},
user1={\meta{number1}\meta{comparison}\meta{number2}},
description={integer conditional},
- note={\TeX\ primitive},
+ note={\TeX\ primitive\texparserdefnote},
category={command}
}
-@index{renewcommand,
+@command{renewcommand,
name={\csfmt{re\-new\-com\-mand}},
user1={\margm{cs}\oargm{n}\oargm{def}\margm{code}},
description={redefines an existing command},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{newcommand,
+@command{newcommand,
name={\csfmt{new\-com\-mand}},
user1={\margm{cs}\oargm{n}\oargm{def}\margm{code}},
description={defines a new command},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{providecommand,
+@command{providecommand,
name={\csfmt{pro\-vide\-com\-mand}},
user1={\margm{cs}\oargm{n}\oargm{def}\margm{code}},
description={defines a command if it's not already defined},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{section,
+@command{section,
name={\csfmt{section}},
- user1={\oargm{toc title}\margm{title}},
+ user1={\oargm{\idx{toc} title}\margm{title}},
description={section heading},
note={most classes that have a concept of document sections},
category={command}
}
-@index{section*,
+@command{section*,
name={\csfmt{section*}},
user1={\margm{title}},
description={unnumbered section heading},
@@ -8906,15 +12659,15 @@ usual delay},
category={command}
}
-@index{chapter,
+@command{chapter,
name={\csfmt{chapter}},
- user1={\oargm{toc title}\margm{title}},
+ user1={\oargm{\idx{toc} title}\margm{title}},
description={chapter heading},
note={book or report classes},
category={command}
}
-@index{chapter*,
+@command{chapter*,
name={\csfmt{chapter*}},
user1={\margm{title}},
description={unnumbered chapter heading},
@@ -8922,7 +12675,7 @@ usual delay},
category={command}
}
-@index{caption,
+@command{caption,
name={\csfmt{caption}},
user1={\oargm{list title}\margm{title}},
description={caption title},
@@ -8930,7 +12683,7 @@ usual delay},
category={command}
}
-@index{boldsymbol,
+@command{boldsymbol,
name={\csfmt{boldsymbol}},
user1={\margm{symbol}},
description={renders given maths symbol in bold if supported by
@@ -8939,7 +12692,7 @@ usual delay},
category={command}
}
-@index{mathcal,
+@command{mathcal,
name={\csfmt{mathcal}},
user1={\margm{character}},
description={renders the given (\idx!{uppercase}) maths character in a calligraphic font},
@@ -8947,1083 +12700,1516 @@ usual delay},
category={command}
}
-@index{ifglsentryexists,
+@glscommand{ifglsentryexists,
name={\csfmt{ifglsentryexists}},
user1={\margm{label}\margm{true}\margm{false}},
description={tests if the entry given by \meta{label} exists},
+ topics={conditionals,entryrefcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsdefaulttype,
+@glscommand{glsdefaulttype,
name={\csfmt{gls\-default\-type}},
user1={},
description={the default glossary type},
+ topics={glossrefs},
note={\styfmt{glossaries}},
category={command}
}
-@index{glssymbolsgroupname,
+@glscommand{glssymbolsgroupname,
name={\csfmt{gls\-symbols\-group\-name}},
user1={},
- description={the name used for the symbols group},
+ description={language-sensitive name used for the symbols group and
+ also used for the title of the glossary created with the \styopt{symbols}
+ package option},
+ topics={fixedtextcommands,glossarystylecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsnumbersgroupname,
+@glscommand{glsnumbersgroupname,
name={\csfmt{gls\-numbers\-group\-name}},
user1={},
- description={the name used for the numbers group},
+ description={language-sensitive name used for the numbers group
+ and also used for the title of the glossary created with the
+ \styopt{numbers} package option},
+ topics={fixedtextcommands,glossarystylecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{printunsrtglossary,
+@glscommand{printunsrtglossary,
name={\csfmt{print\-unsrt\-glos\-sary}},
user1={\oargm{options}},
- description={display the glossary by iterating over all entries
+ description={display a glossary by iterating over all entries
associated with that glossary in the order in which they were
- defined},
+ defined (which, with \bibgls, should correspond to the
+ order obtained from the sort settings given in the
+ \idx{resourceset} options)},
+ topics={glossrefs,loops},
note={\styfmt{glossaries-extra} v1.08+},
category={command}
}
-@index{printunsrtglossary*,
+@glscommand{printunsrtglossary*,
name={\csfmt{print\-unsrt\-glos\-sary*}},
user1={\oargm{options}\margm{code}},
description={as \cs{printunsrtglossary} but performs
\meta{code} first (scoped to localise any assignments within
\meta{code})},
+ topics={glossrefs,loops},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@index{printunsrtglossaries,
+@glscommand{printunsrtglossaries,
name={\csfmt{print\-unsrt\-glos\-saries}},
user1={},
description={iterates over all non-ignored defined glossaries
and performs \cs{printunsrtglossary} for each one},
+ topics={glossrefs,loops},
note={\styfmt{glossaries-extra} v1.08+},
category={command}
}
-@index{printunsrtglossaryentryprocesshook,
+@glscommand{printunsrtglossaryentryprocesshook,
name={\csfmt{print\-unsrt\-glos\-sary\-entry\-process\-hook}},
user1={\margm{label}},
description={performed at each iteration of the internal loop used
by \cs{printunsrtglossary}},
+ topics={glossrefs,loops,hooks},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@index{printunsrtglossaryskipentry,
+@glscommand{printunsrtglossaryskipentry,
name={\csfmt{print\-unsrt\-glos\-sary\-skip\-entry}},
description={only allowed within
\cs{printunsrtglossaryentryprocesshook} this command
indicates that the current entry should be skipped},
+ topics={glossrefs,loops,hooks},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@index{printunsrtglossarypredoglossary,
+@glscommand{printunsrtglossarypredoglossary,
name={\csfmt{print\-unsrt\-glos\-sary\-pre\-do\-glos\-sary}},
description={hook performed by \cs{printunsrtglossary}},
+ topics={glossrefs,hooks},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@index{glscategory,
+@glscommand{glscategory,
name={\csfmt{gls\-cat\-e\-gory}},
user1={\margm{label}},
description={expands to the value of the \field{category} field
for the entry identified by \meta{label} or nothing if the entry
hasn't been defined},
+ topics={fieldrefcommands,catattrcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsifcategory,
+@glscommand{glsifcategory,
name={\csfmt{gls\-if\-cat\-e\-gory}},
user1={\margm{label}\margm{category}\margm{true}\margm{false}},
description={does \meta{true} if the \field{category} field for
the entry given by \meta{label} is \meta{category}},
+ topics={conditionals,fieldrefcommands,catattrcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtriflabelinlist,
+@glscommand{glsxtriflabelinlist,
name={\csfmt{gls\-xtr\-if\-label\-in\-list}},
user1={\margm{label}\margm{list}\margm{true}\margm{false}},
description={tests if the \meta{label} is contained
in the comma-separated \meta{list}, where both \meta{label}
and \meta{list} are fully expanded before testing. This test
- is designed for \emph{labels} which should be fully expandable},
+ is designed for \emph{labels} that are fully expandable},
+ topics={conditionals,listcommands},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@index{printgloss.type,
+@printglossoption{printgloss.type,
parent = {printunsrtglossary},
name = {\csoptfmt{type}},
+ user1 = {\margm{glossary-label}},
+ description={identifies the glossary list (\cs{glsdefaulttype}, if
+ omitted)},
category={commandoption},
}
-@index{printgloss.style,
+@printglossoption{printgloss.style,
parent = {printunsrtglossary},
name = {\csoptfmt{style}},
+ user1 = {\margm{style-name}},
+ description={use the glossary style identified by \meta{style-name}
+ (overrides current style setting)},
+ category={commandoption},
+}
+
+@printglossoption{printgloss.entrycounter,
+ parent = {printunsrtglossary},
+ name = {\csoptfmt{entrycounter}},
+ user1 = {\margm{boolean}},
+ description = {locally enable or disable top-level enumeration
+ (overrides \styopt{entrycounter} package option)},
+ category={commandoption},
+}
+
+@printglossoption{printgloss.subentrycounter,
+ parent = {printunsrtglossary},
+ name = {\csoptfmt{subentrycounter}},
+ user1 = {\margm{boolean}},
+ description = {locally enable or disable level~1 enumeration
+ (overrides \styopt{subentrycounter} package option)},
+ category={commandoption},
+}
+
+@printglossoption{printgloss.nopostdot,
+ parent = {printunsrtglossary},
+ name = {\csoptfmt{nopostdot}},
+ user1 = {\margm{boolean}},
+ description = {locally omit the post-description punctuation (overrides
+ \styopt{nopostdot} and related package options)},
+ category={commandoption},
+}
+
+@printglossoption{printgloss.numberedsection,
+ parent = {printunsrtglossary},
+ name = {\csoptfmt{numbered\-section}},
+ user1={\margm{value}},
+ description={locally change whether or not to use a numbered
+ sectioning command (overrides \styopt{numberedsection} package
+ option)},
category={commandoption},
}
-@index{printgloss.title,
+@printglossoption{printgloss.title,
parent = {printunsrtglossary},
name = {\csoptfmt{title}},
+ user1={\margm{text}},
+ description = {locally sets the title for this glossary},
category={commandoption},
}
-@index{printgloss.toctitle,
+@printglossoption{printgloss.toctitle,
parent = {printunsrtglossary},
name = {\csoptfmt{toctitle}},
+ description = {locally sets the \idx{toc} title for this glossary},
+ user1={\margm{text}},
category={commandoption},
}
-@index{printgloss.target,
+@printglossoption{printgloss.target,
parent = {printunsrtglossary},
name = {\csoptfmt{target}},
+ user1={\margm{boolean}},
+ description = {locally enables or disables the hypertargets for
+ each item},
category={commandoption},
}
-@index{printgloss.targetnameprefix,
+@printglossoption{printgloss.targetnameprefix,
parent = {printunsrtglossary},
name = {\csoptfmt{target\-name\-prefix}},
+ user1={\margm{label}},
+ description = {locally assign a prefix for the hypertargets
+ assigned to each item (if \printglossopt[true]{target})
+ to avoid duplicate target names},
category={commandoption},
}
-@index{printgloss.prefix,
+@printglossoption{printgloss.prefix,
parent = {printunsrtglossary},
name = {\csoptfmt{prefix}},
+ user1 = {\margm{label}},
+ description = {locally redefine \cs{glolinkprefix} for the item
+ hypertargets and for any entry reference or cross-reference hyperlinks},
category={commandoption},
}
-@index{printgloss.nonumberlist,
+@printglossoption{printgloss.nonumberlist,
parent = {printunsrtglossary},
name = {\csoptfmt{no\-number\-list}},
+ user1 = {\margm{boolean}},
+ description={locally change whether or not to display the
+ \idxpl{locationlist} (overrides \styopt{nonumberlist} package
+ option)},
category={commandoption},
}
-@index{printgloss.nogroupskip,
+@printglossoption{printgloss.nogroupskip,
parent = {printunsrtglossary},
name = {\csoptfmt{no\-group\-skip}},
+ user1 = {\margm{boolean}},
+ description={locally change whether or not to separate groups
+ with a vertical space if the glossary style that support this option
+ (overrides \styopt{nogroupskip} package option)},
+ category={commandoption},
+}
+
+@printglossoption{printgloss.label,
+ parent = {printunsrtglossary},
+ name = {\csoptfmt{label}},
+ user1 = {\margm{label}},
+ description = {creates a label for this glossary by locally
+ using \code{\ics{glsxtrsetglossarylabel}\margm{label}}},
category={commandoption},
}
-@index{cs.makeglossaries,
+@glscommand{glsxtrsetglossarylabel,
+ name={\csfmt{gls\-xtr\-set\-glos\-sary\-label}},
+ user1={\margm{label}},
+ description={sets the label for subsequent glossaries
+ (should be scoped or updated per glossary to prevent
+ duplicate labels) and defines \ics{@currentlabelname} to the
+ glossary's \idx{toc} title. This is an alternative to the
+ \styopt[nameref]{numberedsection} package option or
+ \printglossopt{label} \ics{printunsrtglossary} option},
+ topics={crossrefcommands},
+ note={\styfmt{glossaries-extra} v1.39+},
+ category={command}
+}
+
+@glscommand{cs.makeglossaries,
name={\csfmt{make\-glos\-saries}},
user1={},
description={opens associated glossary files to be processed
by \idx{makeindex} or \idx{xindy}},
+ topics={indexing},
note={\styfmt{glossaries}},
category={command}
}
-@index{makenoidxglossaries,
+@glscommand{makenoidxglossaries,
name={\csfmt{make\-noidx\-glos\-saries}},
user1={},
description={indicates that \TeX\ should be used to sort and
collate the glossary information instead of using an
external application; this command should not be used
with \bibgls},
+ topics={indexing},
note={\styfmt{glossaries} v4.04+},
category={command}
}
-@index{printglossary,
+@glscommand{printglossary,
name={\csfmt{print\-glos\-sary}},
user1={\oargm{options}},
description={inputs file created by \idx{makeindex} or \idx{xindy}},
+ topics={glossrefs},
note={\styfmt{glossaries}},
category={command}
}
-@index{printglossaries,
+@glscommand{printglossaries,
name={\csfmt{print\-glos\-saries}},
user1={},
description={iterates over all non-ignored defined glossaries
and performs \cs{printglossary} for each one},
+ topics={glossrefs,loops},
note={\styfmt{glossaries}},
category={command}
}
-@index{printnoidxglossary,
+@glscommand{printnoidxglossary,
name={\csfmt{print\-noidx\-glos\-sary}},
user1={\oargm{options}},
description={uses \TeX\ to sort, collate and list the glossary},
+ topics={glossrefs},
note={\styfmt{glossaries} v4.04+},
category={command}
}
-@index{printnoidxglossaries,
+@glscommand{printnoidxglossaries,
name={\csfmt{print\-noidx\-glos\-saries}},
user1={},
description={iterates over all non-ignored defined glossaries
and performs \cs{printnoidxglossary} for each one},
+ topics={glossrefs,loops},
note={\styfmt{glossaries} v4.04+},
category={command}
}
-@index{makefirstuc,
+@command{makefirstuc,
name={\csfmt{make\-first\-uc}},
user1={\margm{text}},
- description={converts the first letter of \meta{text} to upper case},
- note={\styfmt{mfirstuc}},
+ description={converts the first letter of \meta{text} to \idx{uppercase}},
+ note={\styfmt{mfirstuc}\texparserdefnote},
category={command}
}
-@index{xmakefirstuc,
+@command{xmakefirstuc,
name={\csfmt{xmake\-first\-uc}},
user1={\margm{text}},
description={applies \cs{makefirstuc} with one level expansion
of the first token of \meta{text}},
- note={\styfmt{mfirstuc} v1.01+},
+ note={\styfmt{mfirstuc}\texparserdefnote\ v1.01+},
category={command}
}
-@index{ac,
+@glscommand{ac,
name={\csfmt{ac}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={equivalent to \cs{gls}},
- note={\styfmt{glossaries-extra} \styopt{shortcuts} package
-option},
+ topics={entryrefcommands,linkcommands,indexing,abbreviationcommands,shortcutcommands},
+ note={\styfmt{glossaries-extra} \styopt{shortcuts}},
category={command}
}
-@index{ab,
+@glscommand{ab,
name={\csfmt{ab}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={equivalent to \cs{gls}},
+ topics={entryrefcommands,linkcommands,indexing,abbreviationcommands,shortcutcommands},
note={\styfmt{glossaries-extra}
\styopt[abbreviations]{shortcuts}},
category={command}
}
-@index{glsxtrp,
+@glscommand{glsxtrp,
name={\csfmt{glsxtrp}},
user1={\margm{field}\margm{label}},
- description={displays the given field for the entry given by label},
+ description={displays the given \meta{field} value for the entry given by
+ \meta{label} (no hyperlinks, except in the glossary, and no indexing
+ by default, but includes formatting, if appropriate)},
+ topics={fieldrefcommands},
note={\styfmt{glossaries-extra} v1.07+},
category={command}
}
-@index{glsps,
+@glscommand{glsps,
name={\csfmt{glsps}},
user1={\margm{label}},
description={shortcut for \code{\cs{glsxtrp}\marg{short}\margm{label}}},
+ topics={fieldrefcommands,shortcutcommands},
note={\styfmt{glossaries-extra} v1.07+},
category={command}
}
-@index{glspt,
+@glscommand{glspt,
name={\csfmt{glspt}},
user1={\margm{label}},
description={shortcut for \code{\cs{glsxtrp}\marg{text}\margm{label}}},
+ topics={fieldrefcommands,shortcutcommands},
note={\styfmt{glossaries-extra} v1.07+},
category={command}
}
-@index{GlsXtrFmtField,
+@glscommand{glsxtrsetpopts,
+ name={\csfmt{glsxtrsetpopts}},
+ user1={\margm{options}},
+ description={sets the default options for \cs{glsxtrp}},
+ topics={assigncommands},
+ note={\styfmt{glossaries-extra} v1.07+},
+ category={command}
+}
+
+@glscommand{glossxtrsetpopts,
+ name={\csfmt{glossxtrsetpopts}},
+ description={glossary hook that uses \cs{glsxtrsetpopts}
+ to enable hyperlinks by default for \cs{glsxtrp}},
+ topics={assigncommands,hooks},
+ note={\styfmt{glossaries-extra} v1.07+},
+ category={command}
+}
+
+@glscommand{GlsXtrFmtField,
name={\csfmt{Gls\-Xtr\-Fmt\-Field}},
user1={},
description={expands to the internal label of the field used
to store the control sequence name for use with \csref{glsxtrfmt}},
+ topics={fieldrefcommands,formattingcommands},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@index{glsxtrusesee,
+@glscommand{glsxtrusesee,
name={\csfmt{gls\-xtr\-use\-see}},
user1={\margm{label}},
description={applies \cs{glsseeformat} to the entry's
\field{see} field if not empty},
+ topics={glossarystylecommands,crossrefcommands,loclistcommands,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.06+},
category={command}
}
-@index{glsxtruseseealso,
+@glscommand{glsxtruseseealso,
name={\csfmt{gls\-xtr\-use\-seealso}},
user1={\margm{label}},
description={applies \cs{glsseeformat} to the entry's
\field{seealso} field if not empty},
+ topics={glossarystylecommands,crossrefcommands,loclistcommands,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
-@index{glsxtrsetaliasnoindex,
+@glscommand{glsxtrsetaliasnoindex,
name={\csfmt{gls\-xtr\-set\-alias\-noindex}},
user1={},
description={hooks into the alias \glsopt{noindex} setting},
+ topics={hooks,crossrefcommands},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@index{glsxtruseseealsoformat,
+@glscommand{glsxtruseseealsoformat,
name={\csfmt{gls\-xtr\-use\-seealso\-format}},
user1={\margm{xr list}},
description={used to format the entries whose labels are
given in \meta{xr list} as a list of \qt{see also}
cross-references},
+ topics={glossarystylecommands,crossrefcommands,loclistcommands,formattingcommands},
note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
-@index{glsxtrindexseealso,
+@glscommand{glsxtrindexseealso,
name={\csfmt{gls\-xtr\-index\-seealso}},
user1={\margm{label}\margm{xr list}},
description={indexes a \qt{see also} cross-reference},
+ topics={indexing,crossrefcommands},
note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
-@index{glssee,
+@glscommand{glssee,
name={\csfmt{glssee}},
user1={\oargm{tag}\margm{label}\margm{xr label list}},
description={indexes a \qt{see} cross-reference},
+ topics={indexing,crossrefcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsxtrseelist,
+@glscommand{glsxtrseelist,
name={\csfmt{gls\-xtr\-see\-list}},
user1={\margm{xr label list}},
description={formats the list of cross-reference labels, without
the initial \qt{see} tag},
+ topics={glossarystylecommands,crossrefcommands,loclistcommands,formattingcommands},
note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
-@index{setabbreviationstyle,
+@glscommand{setabbreviationstyle,
name={\csfmt{setabbreviationstyle}},
user1={\oargm{category}\margm{style-name}},
description={sets the abbreviation style to \meta{style-name} for the
given \meta{category}, must be used before the abbreviation is
defined},
+ topics={abbreviationcommands,assigncommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glshex,
+@glscommand{glshex,
name={\csfmt{glshex}},
user1={},
description={expands to \cs{cs.string}\cs{u}},
+ topics={charcommands,collationsubrules},
note={\styfmt{glossaries-extra} v1.21+ (moved to
\styfmt{glossaries-extra-bib2gls} in v1.27)},
category={command}
}
-@index{glscapturedgroup,
+@glscommand{glscapturedgroup,
name={\csfmt{glscapturedgroup}},
- user1={},
description={expands to \cs{cs.string}\idx{dollarchar}},
+ topics={charcommands,regex},
note={\styfmt{glossaries-extra-bib2gls} v1.31+},
category={command}
}
-@index{GlsXtrBibTeXEntryAliases,
+@glscommand{GlsXtrBibTeXEntryAliases,
name={\csfmt{Gls\-Xtr\-Bib\-TeX\-Entry\-Aliases}},
user1={},
description={expands to the set of common entry aliases for
\atentry{bibtexentry}},
+ topics={definingterms},
note={\styfmt{glossaries-extra-bib2gls} v1.29+},
category={command}
}
-@index{GlsXtrProvideBibTeXFields,
+@glscommand{GlsXtrProvideBibTeXFields,
name={\csfmt{Gls\-Xtr\-Provide\-Bib\-TeX\-Fields}},
user1={},
description={defines the standard \BibTeX\ fields using
\cs{glsaddstoragekey}},
+ topics={definingterms,fieldrefcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.29+},
category={command}
}
-@index{glsxtrprovidecommand,
+@glscommand{glsxtrprovidecommand,
name={\csfmt{gls\-xtr\-provide\-command}},
user1={\margm{cs}\oargm{n}\oargm{def}\margm{code}},
description={behaves like \cs{providecommand} in the document but
like \cs{renewcommand} in \bibgls},
- note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ topics={providingcommands},
+ note={\styfmt{glossaries-extra-bib2gls}\texparserdefnote\ v1.27+},
category={command}
}
-@index{glsrenewcommand,
+@glscommand{glsrenewcommand,
name={\csfmt{gls\-re\-new\-command}},
user1={\margm{cs}\oargm{n}\oargm{def}\margm{code}},
description={behaves like \cs{renewcommand} but only generates a
warning rather than an error if the command isn't already defined},
- note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ topics={providingcommands},
+ note={\styfmt{glossaries-extra-bib2gls}\texparserdefnote\ v1.37+},
category={command}
}
-@index{glsxtrresourceinit,
+@glscommand{glsxtrresourceinit,
name={\csfmt{gls\-xtr\-resource\-init}},
user1={},
description={provides code that locally redefines commands
during the protected write operation performed by
\csref{glsxtrresourcefile}},
+ topics={hooks},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@index{glsxtrgroupfield,
+@mainglscommand{GlsXtrDefaultResourceOptions,
+ name={\csfmt{Gls\-Xtr\-Default\-Resource\-Options}},
+ user1={},
+ description={provides default options for
+ \csref{glsxtrresourcefile}},
+ topics={hooks},
+ note={\styfmt{glossaries-extra} v1.40+},
+ category={command}
+}
+
+@glscommand{glsxtrgroupfield,
name={\csfmt{gls\-xtr\-group\-field}},
user1={},
description={expands to the field label used to store the
entry group labels},
+ topics={fieldrefcommands,groupcommands},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@index{glolinkprefix,
+@glscommand{glolinkprefix,
name={\csfmt{glo\-link\-prefix}},
user1={},
description={target name prefix used in entry hyperlinks},
+ topics={linkcommands,hooks},
note={\styfmt{glossaries}},
category={command}
}
-@index{apptoglossarypreamble,
+@glscommand{setglossarypreamble,
+ name={\csfmt{set\-glossary\-preamble}},
+ user1={\oargm{type}\margm{code}},
+ description={sets \meta{code} as the preamble for the given
+glossary (or the default of \meta{type} is omitted)},
+ topics={glossrefs,hooks,glossarystylecommands},
+ note={\styfmt{glossaries}},
+ seealso={glossarypreamble},
+ category={command}
+}
+
+@glscommand{apptoglossarypreamble,
name={\csfmt{app\-to\-glossary\-preamble}},
user1={\oargm{type}\margm{code}},
description={appends \meta{code} to the preamble for the given
-glossary},
+glossary (or the default of \meta{type} is omitted)},
+ topics={glossrefs,hooks,glossarystylecommands},
note={\styfmt{glossaries-extra}},
+ seealso={glossarypreamble},
category={command}
}
-@index{glossarypreamble,
+@glscommand{glossarypreamble,
name={\csfmt{glossary\-preamble}},
description={the preamble for all glossaries except
those that have the preamble explicitly set with
\cs{apptoglossarypreamble}},
- note={\styfmt{glossaries-extra}},
+ topics={glossrefs,hooks,glossarystylecommands},
+ note={\styfmt{glossaries}},
+ seealso={apptoglossarypreamble},
+ category={command}
+}
+
+@glscommand{glossarypostamble,
+ name={\csfmt{glossary\-post\-amble}},
+ description={the postamble that's placed after each glossary},
+ topics={glossrefs,hooks,glossarystylecommands},
+ note={\styfmt{glossaries}},
seealso={apptoglossarypreamble},
category={command}
}
-@index{glsbackslash,
+@glscommand{glsbackslash,
name={\csfmt{glsbackslash}},
user1={},
description={expands to a literal backslash \idx{backslashchar}
character},
- note={\styfmt{glossaries}},
+ topics={charcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsopenbrace,
+ name={\csfmt{glsopenbrace}},
+ user1={},
+ description={expands to a literal open brace \idx{openbracechar}
+ character},
+ topics={charcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glsclosebrace,
+ name={\csfmt{glsclosebrace}},
+ user1={},
+ description={expands to a literal close brace \idx{closebracechar}
+ character},
+ topics={charcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{glspercentchar,
+ name={\csfmt{glspercentchar}},
+ user1={},
+ description={expands to a literal percent character \idx{percentchar}
+ character},
+ topics={charcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
-@index{glsquote,
+@glscommand{glsquote,
name={\csfmt{glsquote}},
user1={\margm{text}},
description={encapsulates \meta{text} with literal straight
double-quotes \texttt{\glsquote{\meta{text}}}},
+ topics={charcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glstildechar,
+@glscommand{glstildechar,
name={\csfmt{glstildechar}},
user1={},
description={expands to a literal tilde \texttt{\glstildechar} character},
+ topics={charcommands},
+ note={\styfmt{glossaries}\texparserdefnote},
+ category={command}
+}
+
+@glscommand{descriptionname,
+ name={\csfmt{description\-name}},
+ user1={},
+ description={language-sensitive name used for the description
+ header for some glossary styles},
+ topics={fixedtextcommands,glossarystylecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{pagelistname,
- name={\csfmt{pagelistname}},
+@glscommand{pagelistname,
+ name={\csfmt{page\-list\-name}},
user1={},
description={language-sensitive name used for the location list
header for some glossary styles},
+ topics={fixedtextcommands,glossarystylecommands,loclistcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{seealsoname,
+@command{seealsoname,
name={\csfmt{seealsoname}},
user1={},
description={language sensitive \qt{see also} text},
- note={\styfmt{glossaries-extra} or language
-packages},
+ topics={fixedtextcommands,glossarystylecommands,loclistcommands},
+ note={\styfmt{glossaries-extra} or language packages},
category={command}
}
-@index{glsxtruserfield,
- name={\csfmt{gls\-xtr\-user\-field}},
+@glscommand{glossaryname,
+ name={\csfmt{glossary\-name}},
user1={},
- description={used by the parenthetical abbreviation styles, this
- expands to the label of the field used to store the parenthetical
- material},
- note={\styfmt{glossaries-extra} v1.04+},
+ description={language-sensitive name used for the title of the default
+ \code{main} glossary},
+ topics={fixedtextcommands,glossarystylecommands},
+ note={\styfmt{glossaries} or language packages},
category={command}
}
-@index{glsxtruserparen,
- name={\csfmt{gls\-xtr\-user\-paren}},
- user1={\margm{text}\margm{label}},
- description={used by the \abbrstyle{long-short-user} and
- \abbrstyle{short-long-user} abbreviation styles
- to format the parenthetical material where \meta{text}
- is the default parenthetical text and \meta{label}
- is the entry's label. This checks the field given
- by \cs{glsxtruserfield} and, if set, the \meta{text} is
- followed by a comma and the user value},
- note={\styfmt{glossaries-extra} v1.04+},
+@glscommand{indexname,
+ name={\csfmt{index\-name}},
+ user1={},
+ description={language-sensitive name used for the title of the
+ glossary created with the \styopt{index} package option},
+ topics={fixedtextcommands,glossarystylecommands},
+ note={\styfmt{glossaries} or language packages},
category={command}
}
-@index{glsxtrfullsep,
- name={\csfmt{gls\-xtr\-full\-sep}},
- user1={\margm{label}},
- description={the separator used in the full format for the parenthetical styles},
+@glscommand{acronymname,
+ name={\csfmt{acronym\-name}},
+ user1={},
+ description={language-sensitive name used for the title of the
+ glossary created with the \styopt{acronym} or \styopt{acronyms}
+ package option},
+ topics={fixedtextcommands,glossarystylecommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{abbreviationname,
+ name={\csfmt{ab\-bre\-vi\-a\-tion\-name}},
+ user1={},
+ description={language-sensitive name used for the title of the
+ glossary created with the \styopt{abbreviations} package option},
+ topics={fixedtextcommands,glossarystylecommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{GlsXtrForeignText,
+@glscommand{GlsXtrForeignText,
name={\csfmt{Gls\-Xtr\-Foreign\-Text}},
user1={\margm{label}\margm{text}},
description={encapsulates \meta{text} in \csfmt{foreignlanguage}
where the language label is obtained from the locale tag
given in the field identified by \cs{GlsXtrForeignTextField}},
+ topics={formattingcommands,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.32+},
category={command}
}
-@index{GlsXtrForeignTextField,
+@glscommand{GlsXtrForeignTextField,
name={\csfmt{Gls\-Xtr\-Foreign\-Text\-Field}},
description={used by \cs{GlsXtrForeignText} to identify
the field containing the locale tag},
+ topics={fieldrefcommands},
note={\styfmt{glossaries-extra} v1.32+},
category={command}
}
-@index{glsxtrparen,
+@glscommand{glsxtrparen,
name={\csfmt{gls\-xtr\-paren}},
user1={\margm{text}},
- description={used to markup parenthetical material},
+ description={used to markup parenthetical material, such as
+ in \cs{glsxtrpostlinkAddDescOnFirstUse} or in the
+ \abbrstyle{long-short} and \abbrstyle{short-long} abbreviation
+ styles},
+ topics={formattingcommands},
note={\styfmt{glossaries-extra} v1.17+},
category={command}
}
-@index{glsxtrpostdescabbreviation,
+@glscommand{glsxtrpostdescabbreviation,
name={\csfmt{gls\-xtr\-post\-desc\-abbreviation}},
user1={},
description={hook used after the description is displayed in the
glossary for entries that have the
\field{category} set to \code{abbreviation}},
+ topics={hooks,abbreviationcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtrpostdescsymbol,
+@glscommand{glsxtrpostdescsymbol,
name={\csfmt{gls\-xtr\-post\-desc\-symbol}},
user1={},
description={hook used after the description is displayed in the
glossary for entries that have the
\field{category} set to \code{symbol}},
+ topics={hooks},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtrpostdescgeneral,
+@glscommand{glsxtrpostdescgeneral,
name={\csfmt{gls\-xtr\-post\-desc\-general}},
user1={},
description={hook used after the description is displayed in the
glossary for entries that have the
\field{category} set to \code{general}},
+ topics={hooks},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtrpostdesccategory,
+@glscommand{glsxtrpostdesccategory,
name={\csfmt{gls\-xtr\-post\-desc\-\meta{category}}},
user1={},
description={hook used after the description is displayed in the
glossary for entries that have the
\field{category} set to \meta{category}. Common category hooks
such as \cs{glsxtrpostdescgeneral} are provided by
- \styfmt{glossaries-extra}, custom categories need the hook defined},
+ \styfmt{glossaries-extra}. If required,
+ this hook can be defined with \cs{glsdefpostdesc}},
+ topics={hooks,glossarystylecommands},
+ note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtrpostnamecategory,
+@glscommand{glsxtrpostnamecategory,
name={\csfmt{gls\-xtr\-post\-name\-\meta{category}}},
user1={},
description={hook used by \cs{glossentryname} for entries
that have the \field{category} set to \meta{category}.
If required, this hook can be defined with \cs{glsdefpostname}},
+ topics={hooks,glossarystylecommands},
+ note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtrpostlinkcategory,
+@glscommand{glsxtrpostlinkcategory,
name={\csfmt{gls\-xtr\-post\-link\-\meta{category}}},
user1={},
description={hook used after commands like \cs{gls}
for entries that have the
\field{category} set to \meta{category}. If required,
this hook can be defined with \cs{glsdefpostlink}},
+ topics={hooks},
+ note={\styfmt{glossaries-extra}},
category={command}
}
-@index{GlsXtrFmtDefaultOptions,
+@glscommand{GlsXtrFmtDefaultOptions,
name={\csfmt{Gls\-Xtr\-Fmt\-Default\-Options}},
user1={},
description={the default options used by \csref{glsxtrfmt}},
+ topics={formattingcommands,indexing},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
-@index{glslink,
+@glscommand{glslink,
name={\csfmt{glslink}},
user1={\oargm{options}\margm{label}\margm{text}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the given link text without altering the first use flag},
+ topics={entryrefcommands,linkcommands},
note={\styfmt{glossaries}},
seealso={glsdisp},
category={command}
}
-@index{glsdisp,
+@glscommand{glsdisp,
name={\csfmt{glsdisp}},
user1={\oargm{options}\margm{label}\margm{text}},
- description={links to the entry's location in the glossary with
- the given link text and marks the entry as having been used},
+ description={links to the entry's definition in the glossary with
+ the given link text and marks the entry as having been used.
+ The options are the same as for \cs{glslink}},
+ topics={entryrefcommands,linkcommands},
note={\styfmt{glossaries}},
seealso={glslink},
category={command}
}
-@index{dglslink,
+@glscommand{dglslink,
name={\csfmt{dgls\-link}},
user1={\oargm{options}\margm{label}\margm{text}},
description={like \cs{glslink} but tries the prefixes
identified with commands like \cs{glsxtraddlabelprefix}},
+ topics={entryrefcommands,linkcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
seealso={dglsdisp},
category={command}
}
-@index{dglsdisp,
+@glscommand{dglsdisp,
name={\csfmt{dgls\-disp}},
user1={\oargm{options}\margm{label}\margm{text}},
description={like \cs{glsdisp} but tries the prefixes
identified with commands like \cs{glsxtraddlabelprefix}},
+ topics={entryrefcommands,linkcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
seealso={dglsdisp},
category={command}
}
-@index{glsxtrshort,
+@glscommand{glsxtrshort,
name={\csfmt{glsxtrshort}},
user1={\oargm{options}\margm{label}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{short} field (using the
- appropriate abbreviation style)
- without altering the first use flag},
+ appropriate abbreviation style) without altering the first use flag},
+ topics={entryrefcommands,linkcommands,abbreviationcommands,fieldrefcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtrlong,
+@glscommand{glsxtrlong,
name={\csfmt{glsxtrlong}},
user1={\oargm{options}\margm{label}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{long} field (using the
appropriate abbreviation style)
without altering the first use flag},
+ topics={entryrefcommands,linkcommands,abbreviationcommands,fieldrefcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtrfull,
+@glscommand{glsxtrfull,
name={\csfmt{glsxtrfull}},
user1={\oargm{options}\margm{label}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{long} and \field{short}
-fields (using the
- appropriate abbreviation style)
+ fields (using the appropriate abbreviation style)
without altering the first use flag},
+ topics={entryrefcommands,linkcommands,abbreviationcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsxtrword,
+@glscommand{glsxtrword,
name={\csfmt{glsxtrword}},
user1={\margm{text}},
description={used to encapsulate each word in the long form of an
abbreviation by the \catattr{markwords} attribute},
+ topics={formattingcommands,abbreviationcommands},
note={\styfmt{glossaries-extra} v1.17+},
category={command}
}
-@index{glsxtrwordsep,
+@glscommand{glsxtrwordsep,
name={\csfmt{glsxtrwordsep}},
description={used to mark spaces between each word in the long form of an
-abbreviation by the \catattr{markwords} attribute},
+ abbreviation by the \catattr{markwords} attribute},
+ topics={separatorcommands,abbreviationcommands},
note={\styfmt{glossaries-extra} v1.17+},
category={command}
}
-@index{glstext,
+@glscommand{glstext,
name={\csfmt{glstext}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{text} field
without altering the first use flag},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{Glstext,
+@glscommand{Glstext,
name={\csfmt{Glstext}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={as \cs{glstext} but converts the first letter to
\idx{uppercase}},
+ topics={entryrefcommands,fieldrefcommands,linkcommands,casecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsname,
+@glscommand{glsname,
name={\csfmt{glsname}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{name} field
without altering the first use flag},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsfirst,
+@glscommand{glsfirst,
name={\csfmt{glsfirst}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{first} field
without altering the first use flag},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glssymbol,
+@glscommand{Glsfirst,
+ name={\csfmt{Glsfirst}},
+ user1={\oargm{options}\margm{label}\oargm{insert}},
+ description={as \cs{glsfirst} but converts the first letter to
+ \idx{uppercase}},
+ topics={entryrefcommands,fieldrefcommands,linkcommands,casecommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glssymbol,
name={\csfmt{glssymbol}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{symbol} field
without altering the first use flag},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsdesc,
+@glscommand{glsdesc,
name={\csfmt{glsdesc}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{description} field
without altering the first use flag},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsuseri,
+@glscommand{glsuseri,
name={\csfmt{glsuseri}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{user1} field
without altering the first use flag},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsuserii,
+@glscommand{glsuserii,
name={\csfmt{glsuserii}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{user2} field
without altering the first use flag},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsuseriii,
+@glscommand{glsuseriii,
name={\csfmt{glsuseriii}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{user3} field
without altering the first use flag},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsuseriv,
+@glscommand{glsuseriv,
name={\csfmt{glsuseriv}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{user4} field
without altering the first use flag},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsuserv,
+@glscommand{glsuserv,
name={\csfmt{glsuserv}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{user5} field
without altering the first use flag},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsuservi,
+@glscommand{glsuservi,
name={\csfmt{glsuservi}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={links to the entry's location in the glossary with
+ description={links to the entry's definition in the glossary with
the link text obtained from the \field{user6} field
without altering the first use flag},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@dualindexentry{rgls,
+@mainglscommand{rgls,
name={\csfmt{rgls}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={like \cs{gls} but checks for the record
- count trigger setting},
+ count trigger setting (the formatting is governed by \cs{rglsformat})},
+ topics={entryrefcommands,linkcommands},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@dualindexentry{rglsformat,
+@mainglscommand{rglsformat,
name={\csfmt{rglsformat}},
user1={\margm{label}\oargm{insert}},
description={used by \csref{rgls} if the record count
switch is triggered},
+ topics={formattingcommands},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@index{glsxtrenablerecordcount,
+@glscommand{glsxtrenablerecordcount,
name={\csfmt{glsxtr\-enable\-record\-count}},
user1={},
- description={redefines \cs{gls} etc to their
- \csref{rgls} counterpart},
+ description={redefines \cs{gls} etc to their \csref{rgls} counterpart},
+ topics={providingcommands},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@dualindexentry{GlsXtrSetRecordCountAttribute,
+@mainglscommand{GlsXtrSetRecordCountAttribute,
name={\csfmt{Gls\-Xtr\-Set\-Record\-Count\-Attribute}},
user1={\margm{category list}\margm{value}},
description={sets the \catattr{recordcount} attribute to
\meta{value} for the given categories},
+ topics={assigncommands},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
-@index{gls,
+@glscommand{gls,
name={\csfmt{gls}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={on first use displays the first use text
(the value of the \field{first} field
for general entries) and on subsequent use displays
- the subsequent use text (the value of the
- \field{text} field
+ the subsequent use text (the value of the \field{text} field
for general entries) where the text is optionally hyperlinked
- to the relevant place in the glossary},
+ to the relevant place in the glossary. The options are
+ the same as for \cs{glslink}},
+ topics={entryrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{gls.format,
+@glslinkoption{gls.format,
name={\csoptfmt{format}},
+ user1={\margm{encap}},
category={commandoption},
- parent={gls}
+ description={sets the \gls{encap} for the record to
+ \meta{encap}, optionally with the start or end range markers},
+ note={\styfmt{glossaries}},
+ parent={glslink}
}
-@index{gls.counter,
+@glslinkoption{gls.counter,
name={\csoptfmt{counter}},
+ user1={\margm{counter-name}},
+ description={sets the counter to use for the record},
category={commandoption},
- parent={gls}
+ note={\styfmt{glossaries}},
+ parent={glslink}
}
-@index{gls.noindex,
+@glslinkoption{gls.noindex,
name={\csoptfmt{noindex}},
+ user1={\margm{boolean}},
+ description={indicates whether or not to suppress indexing},
+ category={commandoption},
+ note={\styfmt{glossaries-extra}},
+ parent={glslink}
+}
+
+@glslinkoption{gls.wrgloss,
+ name={\csoptfmt{wrgloss}},
+ user1={\margm{value}},
+ description={indicates whether to write the glossary information
+ before (\csoptfmt{wrgloss\dequals before}) or after
+ (\csoptfmt{wrgloss\dequals after}) the link text (default:
+ \csoptfmt{before})},
+ category={commandoption},
+ note={\styfmt{glossaries-extra} v1.14+},
+ parent={glslink}
+}
+
+@glslinkoption{gls.thevalue,
+ name={\csoptfmt{thevalue}},
+ user1={\margm{value}},
+ description={overrides the record value so that it's the
+ given \meta{value} not obtained from the associated counter},
+ category={commandoption},
+ note={\styfmt{glossaries-extra} v1.19+},
+ parent={glslink}
+}
+
+@glslinkoption{gls.theHvalue,
+ name={\csoptfmt{theHvalue}},
+ user1={\margm{value}},
+ description={the hyperlink target corresponding to the value
+ of \glsopt{thevalue}, if appropriate},
category={commandoption},
- parent={gls}
+ note={\styfmt{glossaries-extra} v1.19+},
+ parent={glslink}
}
-@index{gls.hyper,
+@glslinkoption{gls.hyper,
name={\csoptfmt{hyper}},
+ user1={\margm{boolean}},
+ description={indicates whether or not to make a hyperlink to the
+ relevant glossary entry},
category={commandoption},
- parent={gls}
+ note={\styfmt{glossaries}},
+ parent={glslink}
}
-@index{gls.textformat,
+@glslinkoption{gls.local,
+ name={\csoptfmt{local}},
+ user1={\margm{boolean}},
+ description={if \csoptfmt{true} indicates to use \ics{glslocalunset}
+ instead of the default global \cs{glsunset} to unset the
+ \idx{firstuseflag}},
+ category={commandoption},
+ note={\styfmt{glossaries}},
+ parent={glslink}
+}
+
+@glslinkoption{gls.textformat,
name={\csoptfmt{text\-format}},
+ user1={\margm{cs-name}},
+ description={if set, replaces \cs{glstextformat} with
+ the command given by the control sequence name
+ \meta{cs-name} to format the \idx{link-text}},
category={commandoption},
- parent={gls}
+ note={\styfmt{glossaries-extra} v1.30+},
+ parent={glslink}
}
-@index{gls.prefix,
+@glslinkoption{gls.prefix,
name={\csoptfmt{prefix}},
+ user1={\margm{label}},
+ description={locally changes \ics{glolinkprefix} to the
+ given \meta{label}},
category={commandoption},
- parent={gls}
+ note={\styfmt{glossaries-extra} v1.31+},
+ parent={glslink}
}
-@index{gls.hyperoutside,
- name={\csoptfmt{hyperoutside}},
+@glslinkoption{gls.hyperoutside,
+ name={\csoptfmt{hyper\-out\-side}},
+ user1={\margm{boolean}},
+ description={determines whether \cs{hyperlink} should
+ be outside of \cs{glstextformat} (default
+ \csoptfmt{hyperoutside\dequals true}) or inside
+ (\csoptfmt{hyperoutside\dequals false})},
category={commandoption},
- parent={gls}
+ note={\styfmt{glossaries-extra} v1.21+},
+ parent={glslink}
}
-@index{glspl,
+@glscommand{glspl,
name={\csfmt{glspl}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={as \cs{gls} but shows the plural form},
+ topics={entryrefcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{Gls,
+@glscommand{Gls,
name={\csfmt{Gls}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={as \cs{gls} but converts the first letter
- of the link text to upper case},
+ of the link text to \idx{uppercase}},
+ topics={entryrefcommands,linkcommands,casecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{Glspl,
+@glscommand{Glspl,
name={\csfmt{Glspl}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={as \cs{Gls} but shows the plural form},
+ topics={entryrefcommands,linkcommands,casecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{GLS,
+@glscommand{GLS,
name={\csfmt{GLS}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={as \cs{gls} but converts the link text to upper case},
+ description={as \cs{gls} but converts the link text to \idx{uppercase}},
+ topics={entryrefcommands,linkcommands,casecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{GLSpl,
+@glscommand{GLSpl,
name={\csfmt{GLSpl}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={as \cs{GLS} but shows the plural form},
+ topics={entryrefcommands,linkcommands,casecommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{pgls,
+@glscommand{pgls,
name={\csfmt{pgls}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={does \meta{prefix}\cs{gls}\oargm{options}\margm{label}\oargm{insert},
where the \meta{prefix} is obtained from the appropriate prefix
field},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{Pgls,
+ name={\csfmt{Pgls}},
+ user1={\oargm{options}\margm{label}\oargm{insert}},
+ description={does \meta{prefix}\cs{gls}\oargm{options}\margm{label}\oargm{insert},
+ where the \meta{prefix} is obtained from the appropriate prefix
+ field with the first letter converted to \idx{uppercase}},
+ topics={entryrefcommands,fieldrefcommands,linkcommands,casecommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{PGLS,
+ name={\csfmt{PGLS}},
+ user1={\oargm{options}\margm{label}\oargm{insert}},
+ description={does \meta{prefix}\cs{GLS}\oargm{options}\margm{label}\oargm{insert},
+ where the \meta{prefix} is obtained from the appropriate prefix
+ field with the text converted to \idx{uppercase}},
+ topics={entryrefcommands,fieldrefcommands,linkcommands,casecommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{pglspl,
+ name={\csfmt{pglspl}},
+ user1={\oargm{options}\margm{label}\oargm{insert}},
+ description={does \meta{prefix}\cs{glspl}\oargm{options}\margm{label}\oargm{insert},
+ where the \meta{prefix} is obtained from the appropriate prefix
+ field},
+ topics={entryrefcommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries-prefix}},
category={command}
}
-@index{dgls,
+@glscommand{Pglspl,
+ name={\csfmt{Pglspl}},
+ user1={\oargm{options}\margm{label}\oargm{insert}},
+ description={does \meta{prefix}\cs{glspl}\oargm{options}\margm{label}\oargm{insert},
+ where the \meta{prefix} is obtained from the appropriate prefix
+ field with the first letter converted to \idx{uppercase}},
+ topics={entryrefcommands,fieldrefcommands,linkcommands,casecommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{PGLSpl,
+ name={\csfmt{PGLSpl}},
+ user1={\oargm{options}\margm{label}\oargm{insert}},
+ description={does \meta{prefix}\cs{GLSpl}\oargm{options}\margm{label}\oargm{insert},
+ where the \meta{prefix} is obtained from the appropriate prefix
+ field with the text converted to \idx{uppercase}},
+ topics={entryrefcommands,fieldrefcommands,linkcommands,casecommands},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@glscommand{dgls,
name={\csfmt{dgls}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={intended for documents with a mixture of
single and dual entries, this is like \cs{gls} but tries to
determine the label prefix from the label prefix list},
+ topics={entryrefcommands,linkcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
seealso={glsxtraddlabelprefix,glsxtrprependlabelprefix},
category={command}
}
-@index{dglspl,
+@glscommand{dglspl,
name={\csfmt{dglspl}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={intended for documents with a mixture of
single and dual entries, this is like \cs{glspl} but tries to
determine the label prefix from the label prefix list},
+ topics={entryrefcommands,linkcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
seealso={glsxtraddlabelprefix,glsxtrprependlabelprefix},
category={command}
}
-@index{dGls,
+@glscommand{dGls,
name={\csfmt{dGls}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={intended for documents with a mixture of
single and dual entries, this is like \cs{Gls} but tries to
determine the label prefix from the label prefix list},
+ topics={entryrefcommands,linkcommands,casecommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
seealso={glsxtraddlabelprefix,glsxtrprependlabelprefix},
category={command}
}
-@index{dGlspl,
+@glscommand{dGlspl,
name={\csfmt{dGlspl}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={intended for documents with a mixture of
single and dual entries, this is like \cs{Glspl} but tries to
determine the label prefix from the label prefix list},
+ topics={entryrefcommands,linkcommands,casecommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
seealso={glsxtraddlabelprefix,glsxtrprependlabelprefix},
category={command}
}
-@index{glsxtraddlabelprefix,
+@glscommand{glsxtraddlabelprefix,
name={\csfmt{gls\-xtr\-add\-label\-prefix}},
user1={\margm{prefix}},
description={appends \meta{prefix} to the prefix label list},
+ topics={listcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
seealso={dgls,glsxtrprependlabelprefix,glsxtrclearlabelprefixes},
category={command}
}
-@index{glsxtrprependlabelprefix,
+@glscommand{glsxtrprependlabelprefix,
name={\csfmt{gls\-xtr\-prepend\-label\-prefix}},
user1={\margm{prefix}},
description={prepends \meta{prefix} to the prefix label list},
+ topics={listcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
seealso={dgls,glsxtraddlabelprefix,glsxtrclearlabelprefixes},
category={command}
}
-@index{glsxtrclearlabelprefixes,
+@glscommand{glsxtrclearlabelprefixes,
name={\csfmt{gls\-xtr\-clear\-label\-prefixes}},
user1={\margm{prefix}},
description={clears the prefix label list},
+ topics={listcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
seealso={glsxtraddlabelprefix,glsxtrprependlabelprefix},
category={command}
}
-@index{glssetwidest,
+@glscommand{glssetwidest,
name={\csfmt{gls\-set\-widest}},
user1={\oargm{level}\margm{text}},
description={used with the \glostyle{alttree} style to set the
widest entry name for the given level},
+ topics={assigncommands,glossarystylecommands},
note={\styfmt{glossary-tree}},
category={command}
}
-@index{glsxtrSetWidest,
+@glscommand{glsxtrSetWidest,
name={\csfmt{gls\-xtr\-Set\-Widest}},
user1={\margm{type}\margm{level}\margm{text}},
description={used by \csref{bibglssetwidest} to set the
widest entry name for the given level for the \glostyle{alttree}
style and the styles provided by \sty{glossary-longextra}},
+ topics={assigncommands,glossarystylecommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
seealso={glssetwidest,glslongextraSetWidest},
category={command}
}
-@index{glsxtrSetWidestFallback,
+@glscommand{glsxtrSetWidestFallback,
name={\csfmt{gls\-xtr\-Set\-Widest\-Fallback}},
user1={\margm{max depth}\margm{list}},
description={used by \csref{bibglssetwidesttoplevelfallback} and
@@ -10031,325 +14217,319 @@ abbreviation by the \catattr{markwords} attribute},
widest entry name for the \glostyle{alttree}
style and the styles provided by \sty{glossary-longextra}
using the commands provided by \sty{glossaries-extra-stylemods}},
+ topics={assigncommands,glossarystylecommands},
note={\styfmt{glossaries-extra-bib2gls} v1.37+},
seealso={glsFindWidestTopLevelName,glsFindWidestLevelTwo},
category={command}
}
-@index{glslongextraSetWidest,
+@glscommand{glslongextraSetWidest,
name={\csfmt{gls\-long\-extra\-Set\-Widest}},
user1={\margm{text}},
description={used with the styles provided by the
\sty{glossary-longextra} package to set the
widest entry name},
+ topics={assigncommands,glossarystylecommands},
note={\styfmt{glossary-longextra} v1.37+},
seealso={glslongextraUpdateWidest},
category={command}
}
-@index{glslongextraUpdateWidest,
+@glscommand{glslongextraUpdateWidest,
name={\csfmt{gls\-long\-extra\-Update\-Widest}},
user1={\margm{text}},
description={as \cs{glslongextraSetWidest} but only sets if \meta{text} is
wider than the current value},
+ topics={assigncommands,glossarystylecommands},
note={\styfmt{glossary-longextra} v1.37+},
category={command}
}
-@index{glsupdatewidest,
+@glscommand{glsupdatewidest,
name={\csfmt{gls\-update\-widest}},
user1={\oargm{level}\margm{text}},
description={as \cs{glssetwidest} but only sets if \meta{text} is
wider than the current value},
+ topics={assigncommands,glossarystylecommands},
note={\styfmt{glossaries-extra-stylemods} v1.23+},
seealso={glssetwidest,eglsupdatewidest},
category={command}
}
-@index{eglsupdatewidest,
+@glscommand{eglsupdatewidest,
name={\csfmt{egls\-update\-widest}},
user1={\oargm{level}\margm{text}},
description={as \cs{glsupdatewidest} but expands \meta{text}},
+ topics={assigncommands,glossarystylecommands},
note={\styfmt{glossaries-extra-stylemods} v1.23+},
seealso={glssetwidest,glsupdatewidest},
category={command}
}
-@index{glsFindWidestTopLevelName,
+@glscommand{glsFindWidestTopLevelName,
name={\csfmt{gls\-Find\-Widest\-Top\-Level\-Name}},
user1={\oargm{glossary list}},
description={CamelCase synonym for \cs{glsfindwidesttoplevelname}},
+ topics={assigncommands,glossarystylecommands},
note={\styfmt{glossaries-extra-stylemods}},
seealso={glsfindwidesttoplevelname},
category={command}
}
-@index{glsfindwidesttoplevelname,
+@glscommand{glsfindwidesttoplevelname,
name={\csfmt{gls\-find\-widest\-top\-level\-name}},
user1={\oargm{glossary list}},
description={finds the widest top-level name in the given
glossaries},
+ topics={assigncommands,glossarystylecommands},
note={\styfmt{glossary-tree}},
category={command}
}
-@index{glsFindWidestLevelTwo,
+@glscommand{glsFindWidestLevelTwo,
name={\csfmt{gls\-Find\-Widest\-Level\-Two}},
user1={\oargm{glossary list}},
description={finds the widest name in the given glossaries
for the top level and first two sub-levels},
+ topics={assigncommands,glossarystylecommands},
note={\styfmt{glossaries-extra-stylemods}},
seealso={glsfindwidesttoplevelname},
category={command}
}
-@index{glsxtrbookindexname,
+@glscommand{glsxtrbookindexname,
name={\csfmt{glsxtr\-book\-index\-name}},
user1={\margm{label}},
description={used with the \glostyle{bookindex} style to
format the entry's name},
+ topics={formattingcommands,glossarystylecommands},
note={\styfmt{glossary-bookindex}},
category={command}
}
-@index{glsxtrbookindexprelocation,
+@glscommand{glsxtrbookindexprelocation,
name={\csfmt{glsxtr\-book\-index\-pre\-location}},
user1={\margm{label}},
description={used with the \glostyle{bookindex} style before the
location list},
+ topics={formattingcommands,separatorcommands,glossarystylecommands},
note={\styfmt{glossary-bookindex}},
category={command}
}
-@index{glsxtrprelocation,
+@glscommand{glsxtrprelocation,
name={\csfmt{glsxtr\-pre\-location}},
user1={},
description={used before the location list in the
\glostyle{bookindex} style and the styles patched by
\styfmt{glossaries-extra-stylemods}},
+ topics={formattingcommands,separatorcommands,glossarystylecommands},
note={\styfmt{glossary-bookindex} v1.21+ and
\styfmt{glossaries-extra-stylemods} v1.21+},
category={command}
}
-@index{glsabbrvscfont,
- name={\csfmt{gls\-abbrv\-sc\-font}},
- user1={\margm{text}},
- description={used with \qt{sc} abbreviation styles to format the
-short form using \cs{textsc}},
- note={\styfmt{glossaries-extra} v1.17+},
- category={command}
-}
-
-@index{glsabbrvonlyfont,
- name={\csfmt{gls\-abbrv\-only\-font}},
- user1={\margm{text}},
- description={used with \qt{only} abbreviation styles to format the
-short form},
- note={\styfmt{glossaries-extra} v1.17+},
- category={command}
-}
-
-@index{glslongonlyfont,
- name={\csfmt{gls\-long\-only\-font}},
- user1={\margm{text}},
- description={used with \qt{only} abbreviation styles to format the
-long form},
- note={\styfmt{glossaries-extra} v1.17+},
- category={command}
-}
-
-@index{glsabbrvfont,
+@glscommand{glsabbrvfont,
name={\csfmt{gls\-abbrv\-font}},
user1={\margm{text}},
description={generic abbreviation font command for the short form},
+ topics={formattingcommands,abbreviationcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glslongfont,
+@glscommand{glslongfont,
name={\csfmt{gls\-long\-font}},
user1={\margm{text}},
description={generic abbreviation font command for the long form},
+ topics={formattingcommands,abbreviationcommands},
note={\styfmt{glossaries-extra} v1.04+},
category={command}
}
-@index{glsshorttok,
+@glscommand{glsshorttok,
name={\csfmt{gls\-short\-tok}},
description={token register used in the construction of
acronyms or abbreviations to allow the style hooks to access the short form},
+ topics={hooks,abbreviationcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glslongtok,
+@glscommand{glslongtok,
name={\csfmt{gls\-long\-tok}},
description={token register used in the construction of
acronyms or abbreviations to allow the style hooks to access the long form},
+ topics={hooks,abbreviationcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsuserdescription,
- name={\csfmt{gls\-user\-description}},
- user1={\margm{description}\margm{label}},
- description={used with \qt{user} abbreviation styles to
- encapsulate the description. Just does
- \code{\cs{glslonguserfont}\margm{description}} by default},
- note={\styfmt{glossaries-extra} v1.30+},
- category={command}
-}
-
-@index{glslonguserfont,
- name={\csfmt{gls\-long\-user\-font}},
- user1={\margm{text}},
- description={used with \qt{user} abbreviation styles to
- format the long form},
- note={\styfmt{glossaries-extra} v1.04+},
- category={command}
-}
-
-@index{glsfirstlonguserfont,
- name={\csfmt{gls\-first\-long\-user\-font}},
- user1={\margm{text}},
- description={used with \qt{user} abbreviation styles to
- format the long form on first use},
- note={\styfmt{glossaries-extra} v1.04+},
- category={command}
-}
-
-@index{glsabbrvuserfont,
- name={\csfmt{gls\-abbrv\-user\-font}},
- user1={\margm{text}},
- description={used with \qt{user} abbreviation styles to
- format the short form},
- note={\styfmt{glossaries-extra} v1.04+},
- category={command}
-}
-
-@index{glsfirstabbrvuserfont,
- name={\csfmt{gls\-first\-abbrv\-user\-font}},
- user1={\margm{text}},
- description={used with \qt{user} abbreviation styles to
- format the short form on first use},
- note={\styfmt{glossaries-extra} v1.04+},
- category={command}
-}
-
-@index{glsxtrifinmark,
+@glscommand{glsxtrifinmark,
name={\csfmt{gls\-xtr\-if\-in\-mark}},
user1={\margm{true}\margm{true}},
description={used by commands like \cs{glsfmtshort}, this expands
-to \meta{true} in page headings and the table of contents,
+ to \meta{true} in page headings and the table of contents,
otherwise it expands to \meta{false}},
+ topics={conditionals},
note={\styfmt{glossaries-extra} v1.07+},
category={command}
}
-@index{glsxtrRevertTocMarks,
+@glscommand{glsxtrRevertTocMarks,
name={\csfmt{gls\-xtr\-Revert\-Toc\-Marks}},
description={restores original behaviour of \cs{tableofcontents}
so that \cs{glsxtrifinmark} expands to \meta{false} in the table
-of contents},
+ of contents},
+ topics={providingcommands},
note={\styfmt{glossaries-extra} v1.07+},
category={command}
}
-@index{glstreenamefmt,
+@glscommand{glstreenamefmt,
name={\csfmt{gls\-tree\-name\-fmt}},
user1={\margm{text}},
description={used with the tree styles to format the entry's name},
+ topics={formattingcommands,glossarystylecommands},
note={\styfmt{glossary-tree} v4.08+ and
\styfmt{glossaries-extra-stylemods} v1.31+},
seealso={glstreegroupheaderfmt,glstreenavigationfmt,glstreedefaultnamefmt},
category={command}
}
-@index{glstreegroupheaderfmt,
+@glscommand{glstreegroupheaderfmt,
name={\csfmt{gls\-tree\-group\-header\-fmt}},
user1={\margm{text}},
- description={used with the tree styles to format the group
-headings},
+ description={used with the tree styles to format the group headings},
+ topics={formattingcommands,glossarystylecommands},
note={\styfmt{glossary-tree} v4.22+ and
\styfmt{glossaries-extra-stylemods} v1.31+},
category={command}
}
-@index{glstreenavigationfmt,
+@glscommand{glstreenavigationfmt,
name={\csfmt{gls\-tree\-navigation\-fmt}},
user1={\margm{text}},
- description={used with the tree styles to format the navigation
-elements},
+ description={used with the tree styles to format the navigation elements},
+ topics={formattingcommands,glossarystylecommands},
note={\styfmt{glossary-tree} v4.22+ and
\styfmt{glossaries-extra-stylemods} v1.31+},
category={command}
}
-@index{glstreedefaultnamefmt,
+@glscommand{glstreedefaultnamefmt,
name={\csfmt{gls\-tree\-default\-name\-fmt}},
user1={\margm{text}},
description={used as the default format for \cs{glstreenamefmt},
\cs{glstreegroupheaderfmt} and \cs{glstreenavigationfmt}},
+ topics={formattingcommands,glossarystylecommands},
note={\styfmt{glossaries-extra-stylemods} v1.31+},
category={command}
}
-@index{glstreeprelocation,
+@glscommand{glstreeprelocation,
name={\csfmt{gls\-tree\-pre\-location}},
description={inserted before the location list for top-level
entries in the \glostyle{tree}-like styles},
+ topics={formattingcommands,separatorcommands,glossarystylecommands},
note={\styfmt{glossaries-extra-stylemods} v1.21+},
category={command}
}
-@index{glsdescwidth,
+@glscommand{glsdescwidth,
name={\csfmt{gls\-desc\-width}},
user1={},
description={length register used by the tabular styles to specify
the width of the description column},
+ topics={glossarystylecommands},
note={\styfmt{glossary-long} and
\styfmt{glossary-super}},
category={command}
}
-@index{glsxtralttreeSymbolDescLocation,
+@glscommand{glsxtralttreeSymbolDescLocation,
name={\csfmt{gls\-xtr\-alt\-tree\-Symbol\-Desc\-Location}},
user1={\margm{label}\margm{location list}},
description={used by the \glostyle{alttree} styles to format the
symbol, description and location},
+ topics={formattingcommands,glossarystylecommands},
note={\styfmt{glossaries-extra-stylemods} v1.05+},
category={command}
}
-@index{glsxtrAltTreePar,
+@glscommand{glsxtrAltTreePar,
name={\csfmt{gls\-xtr\-Alt\-Tree\-Par}},
description={used by the \glostyle{alttree} styles to indicate a
paragraph break that retains the hanging indent},
+ topics={formattingcommands,glossarystylecommands},
note={\styfmt{glossaries-extra-stylemods} v1.05+},
category={command}
}
-@index{glsaccsupp,
+@glscommand{glsaccsupp,
name={\csfmt{gls\-acc\-supp}},
user1={\margm{accessible text}\margm{text}},
description={used by the accessibility support to interface with
-the \sty{accsupp} package},
+ the \sty{accsupp} package (use \cs{xglsaccsupp} if \meta{text}
+ needs to be fully expanded first)},
+ topics={access-support},
+ note={\styfmt{glossaries-accsupp}},
+ seealso={xglsaccsupp},
+ category={command}
+}
+
+@glscommand{xglsaccsupp,
+ name={\csfmt{xgls\-acc\-supp}},
+ user1={\margm{accessible text}\margm{text}},
+ description={used by the accessibility support to interface with
+ the \sty{accsupp} package, where \meta{text} is fully expanded},
+ topics={access-support},
note={\styfmt{glossaries-accsupp}},
+ seealso={glsaccsupp},
category={command}
}
-@index{forglsentries,
+@glscommand{forglsentries,
name={\csfmt{for\-gls\-entries}},
+ user1={\oargm{type}\margm{cs}\margm{body}},
+ description={iterates over all entries defined in the glossary
+ identified by \meta{type} (or the default, if \meta{type}
+ is omitted) and perform \meta{body} where you can use the
+ control sequence \meta{cs} to reference the current entry label},
+ topics={loops,entryrefcommands},
+ note={\styfmt{glossaries}},
+ seealso={forallglsentries},
+ category={command}
+}
+
+@glscommand{forallglsentries,
+ name={\csfmt{for\-all\-gls\-entries}},
user1={\oargm{glossary-list}\margm{cs}\margm{body}},
- description={iterates over all entries defined in the listed
- glossaries and perform \meta{body} where you can use the
- control sequence \meta{cs} to reference the current label},
+ description={iterates over all entries defined in the
+ comma-separated \meta{glossary-list} (or all defined non-ignored
+ glossaries if the optional argument is omitted) and perform
+ \meta{body} where you can use the control sequence \meta{cs} to
+ reference the current entry label},
+ topics={loops,glossrefs,entryrefcommands},
note={\styfmt{glossaries}},
+ seealso={forglsentries,forallglossaries},
category={command}
}
-@index{glsxtrforcsvfield,
+@glscommand{forallglossaries,
+ name={\csfmt{for\-all\-glos\-saries}},
+ user1={\oargm{glossary-list}\margm{cs}\margm{body}},
+ description={iterates over all glossaries identified in the
+ comma-separated \meta{glossary-list} (or all defined non-ignored
+ glossaries if the optional argument is omitted) and performs \meta{body}
+ where you can use the control sequence \meta{cs} to reference
+ the current glossary label},
+ topics={loops,glossrefs},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glsxtrforcsvfield,
name={\csfmt{gls\-xtr\-for\-csv\-field}},
user1={\margm{label}\margm{field}\margm{handler}},
description={iterates over the comma-separated list
@@ -10357,22 +14537,93 @@ the \sty{accsupp} package},
by \meta{label} and performs \meta{handler}\margm{element}
on each element of the list, where \meta{handler} is
a control sequence which takes a single argument},
+ topics={loops,fieldrefcommands,listcommands},
+ note={\styfmt{glossaries}},
note={\styfmt{glossaries-extra} v1.24+},
seealso={glsxtrendfor},
category={command}
}
-@index{glsxtrendfor,
+@glscommand{glsxtrendfor,
name={\csfmt{gls\-xtr\-end\-for}},
user1={},
description={may be used within the handler macro
of \cs{glsxtrforcsvfield} to prematurely break the loop},
+ topics={loops,listcommands},
note={\styfmt{glossaries-extra} v1.24+},
seealso={glsxtrforcsvfield},
category={command}
}
-@index{TrackLocale,
+@glscommand{ifglossaryexists,
+ name={\csfmt{if\-glossary\-exists}},
+ user1={\margm{type}\margm{true}\margm{false}},
+ description={tests if the glossary given by \meta{type} exists
+ and does \meta{true} if it does exists, otherwise does \meta{false}},
+ topics={conditionals,glossrefs},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{ifignoredglossary,
+ name={\csfmt{if\-ignored\-glossary}},
+ user1={\margm{type}\margm{true}\margm{false}},
+ description={tests if the glossary given by \meta{type} was
+ defined as an ignored glossary},
+ topics={conditionals,glossrefs},
+ note={\styfmt{glossaries} v4.08+},
+ category={command}
+}
+
+@glscommand{glsdoifexists,
+ name={\csfmt{gls\-do\-if\-exists}},
+ user1={\margm{label}\margm{code}},
+ description={if the entry given by \meta{label} exists, \meta{code}
+ is done, otherwise an error (or warning with
+ \sty{glossaries-extra}'s \styopt[warn]{undefaction} option) is
+ triggered},
+ topics={conditionals,entryrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glsdoifnoexists,
+ name={\csfmt{gls\-do\-if\-no\-exists}},
+ user1={\margm{label}\margm{code}},
+ description={if the entry given by \meta{label} doesn't exist, \meta{code}
+ is done, otherwise an error (or warning with
+ \sty{glossaries-extra}'s \styopt[warn]{undefaction} option) is
+ triggered},
+ topics={conditionals,entryrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glsdoifexistsordo,
+ name={\csfmt{gls\-do\-if\-exists\-or\-do}},
+ user1={\margm{label}\margm{code}\margm{else code}},
+ description={if the entry given by \meta{label} exists, \meta{code}
+ is done, otherwise an error (or warning with
+ \sty{glossaries-extra}'s \styopt[warn]{undefaction} option) is
+ triggered and \meta{else code} is done},
+ topics={conditionals,entryrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glsdoifnoexistsordo,
+ name={\csfmt{gls\-do\-if\-no\-exists\-or\-do}},
+ user1={\margm{label}\margm{code}\margm{else code}},
+ description={if the entry given by \meta{label} doesn't exist, \meta{code}
+ is done, otherwise an error (or warning with
+ \sty{glossaries-extra}'s \styopt[warn]{undefaction} option) is
+ triggered and \meta{else code} is done},
+ topics={conditionals,entryrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@command{TrackLocale,
name={\csfmt{Track\-Locale}},
user1={\margm{language tag}},
description={tracks the given language tag},
@@ -10380,7 +14631,7 @@ the \sty{accsupp} package},
category={command}
}
-@index{GetTrackedDialectFromLanguageTag,
+@command{GetTrackedDialectFromLanguageTag,
name={\csfmt{Get\-Tracked\-Dialect\-From\-Language\-Tag}},
user1={\margm{language tag}\margm{cs}},
description={gets the \styfmt{tracklang} dialect label from the
@@ -10391,7 +14642,7 @@ the given language tag},
category={command}
}
-@index{TrackedDialectClosestSubMatch,
+@command{TrackedDialectClosestSubMatch,
name={\csfmt{Tracked\-Dialect\-Closest\-Sub\-Match}},
description={set by \cs{GetTrackedDialectFromLanguageTag}
if an exact match isn't found but a partial match on the
@@ -10400,7 +14651,7 @@ the given language tag},
category={command}
}
-@index{IfTrackedDialectHasMapping,
+@command{IfTrackedDialectHasMapping,
name={\csfmt{If\-Tracked\-Dialect\-Has\-Mapping}},
user1={\margm{tracklang label}\margm{true}\margm{false}},
description={tests if the \styfmt{tracklang} dialect label has
@@ -10409,7 +14660,7 @@ been assigned a mapping to a language hook label},
category={command}
}
-@index{GetTrackedDialectToMapping,
+@command{GetTrackedDialectToMapping,
name={\csfmt{Get\-Tracked\-Dialect\-To\-Mapping}},
user1={\margm{tracklang label}},
description={the language hook label corresponding to the given
@@ -10418,65 +14669,74 @@ been assigned a mapping to a language hook label},
category={command}
}
-@index{glstextformat,
+@glscommand{glstextformat,
name={\csfmt{glstextformat}},
user1={\margm{text}},
description={used by commands like \cs{gls} to format the
\idx{link-text}},
+ topics={formattingcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsxtrregularfont,
+@glscommand{glsxtrregularfont,
name={\csfmt{gls\-xtr\-reg\-u\-lar\-font}},
user1={\margm{text}},
description={used by commands like \cs{gls} to format the
\idx{link-text} for regular terms},
+ topics={formattingcommands},
note={\styfmt{glossaries-extra} v1.04+},
category={command}
}
-@index{glsxtrabbreviationfont,
+@glscommand{glsxtrabbreviationfont,
name={\csfmt{gls\-xtr\-abbre\-vi\-a\-tion\-font}},
user1={\margm{text}},
description={used by commands like \cs{gls} to format the
\idx{link-text} for (non-regular) abbreviations},
+ topics={formattingcommands,abbreviationcommands},
note={\styfmt{glossaries-extra} v1.30+},
category={command}
}
-@index{GlsXtrExpandedFmt,
+@glscommand{GlsXtrExpandedFmt,
name={\csfmt{Gls\-Xtr\-Expanded\-Fmt}},
user1={\margm{cs}\margm{text}},
description={fully expands \meta{text} and then does
\meta{cs}\margm{expanded text}},
+ topics={formattingcommands},
note={\styfmt{glossaries-extra} v1.30+},
category={command}
}
-@index{GlsXtrStartUnsetBuffering,
+@glscommand{GlsXtrStartUnsetBuffering,
name={\csfmt{Gls\-Xtr\-Start\-Unset\-Buffer\-ing}},
description={starts buffering calls to \cs{glsunset}
+ (which is internally used by commands like \cs{gls})
for use in code where the boolean switch causes a problem.
The buffer can later be processed and cleared with
\cs{GlsXtrStopUnsetBuffering}. The starred form
(added to v1.31) avoids duplicate labels in the buffer's
internal list},
+ topics={entryrefcommands,conditionals},
note={\styfmt{glossaries-extra} v1.30+},
+ seealso={GlsXtrForUnsetBufferedList},
category={command}
}
-@index{GlsXtrStopUnsetBuffering,
+@glscommand{GlsXtrStopUnsetBuffering,
name={\csfmt{Gls\-Xtr\-Stop\-Unset\-Buffer\-ing}},
- description={unsets (locally with the starred form)
- all the entry whose labels are stored in the
+ description={unsets (locally with the starred form) the
+ \idx{firstuseflag} of all the entry whose labels are stored in the
buffer that was started with
- \cs{GlsXtrStartUnsetBuffering} and clears the buffer},
+ \cs{GlsXtrStartUnsetBuffering} and then clears the buffer},
+ topics={entryrefcommands,conditionals},
note={\styfmt{glossaries-extra} v1.30+},
+ seealso={GlsXtrForUnsetBufferedList},
category={command}
}
-@index{GlsXtrForUnsetBufferedList,
+@glscommand{GlsXtrForUnsetBufferedList,
name={\csfmt{Gls\-Xtr\-For\-Unset\-Buffered\-List}},
user1 = {\margm{cs}},
description={iterates over
@@ -10484,29 +14744,64 @@ been assigned a mapping to a language hook label},
buffer that was started with
\cs{GlsXtrStartUnsetBuffering} and implements
\meta{cs}\margm{label} at each iteration},
+ topics={entryrefcommands,listcommands},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
-@index{glsunset,
+@glscommand{glsunset,
name={\csfmt{gls\-unset}},
user1 = {\margm{label}},
description={unsets the \idx{firstuseflag} so that the entry is
marked as having been used},
+ topics={conditionals},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glslocalunset,
+ name={\csfmt{gls\-local\-unset}},
+ user1 = {\margm{label}},
+ description={locally unsets the \idx{firstuseflag} so that the entry is
+marked as having been used},
+ topics={conditionals},
note={\styfmt{glossaries}},
category={command}
}
-@index{glsreset,
+@glscommand{glsreset,
name={\csfmt{gls\-reset}},
user1 = {\margm{label}},
description={resets the \idx{firstuseflag} so that the entry is
marked as not used},
+ topics={conditionals},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{glslocalreset,
+ name={\csfmt{gls\-local\-reset}},
+ user1 = {\margm{label}},
+ description={locally resets the \idx{firstuseflag} so that the entry is
+marked as not used},
+ topics={conditionals},
note={\styfmt{glossaries}},
category={command}
}
-@index{TrackLangLastTrackedDialect,
+@glscommand{glspatchtabularx,
+ name={\csfmt{gls\-patch\-tab\-ularx}},
+ description={preamble command that will patch the \env{tabularx}
+ environment to deal with the problem of unsetting the
+ \idx{firstuseflag} either explicitly with \cs{glsunset} or
+ implicitly through commands like \cs{gls} (does nothing if
+ \sty{tabularx} hasn't been loaded)},
+ topics={hooks,entryrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@command{TrackLangLastTrackedDialect,
name={\csfmt{Track\-Lang\-Last\-Tracked\-Dialect}},
user1={},
description={set by commands like \cs{TrackLocale}},
@@ -10514,7 +14809,7 @@ marked as not used},
category={command}
}
-@index{TrackedLanguageFromDialect,
+@command{TrackedLanguageFromDialect,
name={\csfmt{Tracked\-Language\-From\-Dialect}},
user1={\margm{dialect}},
description={expands to the root language associated with the
@@ -10523,7 +14818,7 @@ given (\styfmt{tracklang}) dialect label},
category={command}
}
-@index{DTMdisplaydate,
+@command{DTMdisplaydate,
name={\csfmt{DTM\-display\-date}},
user1={\margm{year}\margm{month}\margm{day}\margm{dow}},
description={formats the given date where all arguments are
@@ -10532,70 +14827,128 @@ given (\styfmt{tracklang}) dialect label},
category={command}
}
-@index{DTLformatlist,
+@command{DTLformatlist,
name={\csfmt{DTL\-format\-list}},
user1={\margm{list}},
description={formats a comma-separated list},
- note={\styfmt{datatool-base}},
+ note={\styfmt{datatool-base}\texparserdefnote\ v2.28+},
+ seealso={ifDTLlistskipempty},
+ category={command}
+}
+
+@command{DTLlistformatitem,
+ name={\csfmt{DTL\-list\-format\-item}},
+ user1={\margm{element}},
+ description={used by \ics{DTLformatlist} to format each
+ element in the list},
+ note={\styfmt{datatool-base}\texparserdefnote\ v2.28+},
+ seealso={DTLformatlist},
category={command}
}
-@index{DTLlistformatsep,
+@command{DTLlistformatsep,
name={\csfmt{DTL\-list\-format\-sep}},
user1={},
description={used by \ics{DTLformatlist} to separate items in the
list, except for the last pair},
- note={\styfmt{datatool-base}},
+ note={\styfmt{datatool-base}\texparserdefnote\ v2.28+},
seealso={DTLformatlist},
category={command}
}
-@index{DTLlistformatlastsep,
+@command{DTLlistformatlastsep,
name={\csfmt{DTL\-list\-format\-last\-sep}},
user1={},
description={used by \ics{DTLformatlist} to separate the last two items in the
list},
- note={\styfmt{datatool-base}},
+ note={\styfmt{datatool-base}\texparserdefnote\ v2.28+},
seealso={DTLformatlist},
category={command}
}
-@index{DTLlistformatoxford,
+@command{DTLlistformatoxford,
name={\csfmt{DTL\-list\-format\-oxford}},
user1={},
description={insert before \ics{DTLlistformatlastsep} if the list
has three or more items},
- note={\styfmt{datatool-base}},
+ note={\styfmt{datatool-base}\texparserdefnote\ v2.28+},
seealso={DTLformatlist},
category={command}
}
-@index{DTLandname,
+@command{DTLandname,
name={\csfmt{DTL\-and\-name}},
user1={},
description={used in the definition of \ics{DTLlistformatlastsep}},
- note={\styfmt{datatool-base}},
+ note={\styfmt{datatool-base}\texparserdefnote\ v2.28+},
seealso={DTLformatlist},
category={command}
}
-@index{si,
+@command{DTLlistelement,
+ name={\csfmt{DTL\-list\-element}},
+ user1={\margm{list}\margm{index}},
+ description={does the \meta{index}th element (starting from 1 for
+ the first element) in the comma-separated \meta{list}},
+ note={\styfmt{datatool-base}\texparserdefnote\ v2.31+},
+ seealso={DTLfetchlistelement,ifDTLlistskipempty},
+ category={command}
+}
+
+@command{DTLfetchlistelement,
+ name={\csfmt{DTL\-fetch\-list\-element}},
+ user1={\margm{list}\margm{index}\margm{cs}},
+ description={fetches the \meta{index}th element (starting from 1 for
+ the first element) in the comma-separated \meta{list} and stores
+ it in the command given by \meta{cs}},
+ note={\styfmt{datatool-base}\texparserdefnote\ v2.31+},
+ seealso={DTLlistelement,ifDTLlistskipempty},
+ category={command}
+}
+
+@command{ifDTLlistskipempty,
+ name={\csfmt{if\-DTL\-list\-skip\-empty}},
+ description={conditional that determines whether or not commands
+ like \cs{DTLformatlist} should skip empty elements},
+ note={\styfmt{datatool-base}\texparserdefnote\ v2.31+},
+ category={command}
+}
+
+@command{DTLnumitemsinlist,
+ name={\csfmt{DTL\-num\-items\-in\-list}},
+ user1={\margm{list}\margm{cs}},
+ description={counts the number of elements in the comma-separated
+ \meta{list} and stores the value in the command given by \meta{cs}},
+ note={\styfmt{datatool-base}\texparserdefnote\ v2.31+},
+ seealso={DTLformatlist,DTLlistelement,ifDTLlistskipempty},
+ category={command}
+}
+
+@command{DTLifinlist,
+ name={\csfmt{DTL\-if\-in\-list}},
+ user1={\margm{element}\margm{list}\margm{true}\margm{false}},
+ description={tests if \meta{element} is in the comma-separated \meta{list}},
+ note={\styfmt{datatool-base}\texparserdefnote},
+ category={command}
+}
+
+@command{si,
name={\csfmt{si}},
user1={\margm{unit}},
description={displays the unit with intelligent formatting},
- note={\styfmt{siunitx}},
+ note={\styfmt{siunitx}\texparserdefnote},
category={command}
}
-@index{ce,
+@command{ce,
name={\csfmt{ce}},
user1={\margm{formula}},
description={displays the chemical formula},
- note={\styfmt{mhchem}},
+ note={\styfmt{mhchem}\texparserdefnote},
category={command}
}
-@index{textweathersymbol,
+@command{textweathersymbol,
name={\csfmt{text\-weather\-symbol}},
user1={\margm{number}},
description={displays weather symbol identified by \meta{number}},
@@ -10603,14 +14956,14 @@ has three or more items},
category={command}
}
-@index{toprule,
+@command{toprule,
name={\csfmt{top\-rule}},
description={horizontal rule for the top of a \envfmt{tabular}-like environment},
note={\styfmt{booktabs}},
category={command}
}
-@index{midrule,
+@command{midrule,
name={\csfmt{mid\-rule}},
description={horizontal rule for divider between header and main
content of a \envfmt{tabular}-like environment},
@@ -10618,7 +14971,7 @@ has three or more items},
category={command}
}
-@index{bottomrule,
+@command{bottomrule,
name={\csfmt{bottom\-rule}},
description={horizontal rule for the bottom of a
\envfmt{tabular}-like environment},
@@ -10626,297 +14979,297 @@ has three or more items},
category={command}
}
-@index{endhead,
+@command{endhead,
name={\csfmt{end\-head}},
description={ends the header section},
note={\styfmt{longtable}},
category={command}
}
-@index{endfoot,
+@command{endfoot,
name={\csfmt{end\-foot}},
description={ends the footer section},
note={\styfmt{longtable}},
category={command}
}
-@index{MakeTextLowercase,
+@command{MakeTextLowercase,
name={\csfmt{MakeTextLowercase}},
user1={\margm{text}},
description={converts \meta{text} to lower case},
- note={\styfmt{textcase}},
+ note={\styfmt{textcase}\texparserdefnote},
category={command}
}
-@index{MakeTextUppercase,
+@command{MakeTextUppercase,
name={\csfmt{MakeTextUppercase}},
user1={\margm{text}},
- description={converts \meta{text} to upper case},
- note={\styfmt{textcase}},
+ description={converts \meta{text} to \idx{uppercase}},
+ note={\styfmt{textcase}\texparserdefnote},
category={command}
}
-@index{NoCaseChange,
+@command{NoCaseChange,
name={\csfmt{NoCaseChange}},
user1={\margm{text}},
description={prevents \cs{MakeTextUppercase} and
\cs{MakeTextLowercase} from converting \meta{text}},
- note={\styfmt{textcase}},
+ note={\styfmt{textcase}\texparserdefnote},
category={command}
}
-@index{MakeUppercase,
+@command{MakeUppercase,
name={\csfmt{MakeUppercase}},
user1={\margm{text}},
- description={converts \meta{text} to upper case},
- note={kernel command},
+ description={converts \meta{text} to \idx{uppercase}},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{char,
+@command{char,
name={\csfmt{char}},
user1={\meta{number}},
description={accesses the character identified by \meta{number}
(use \code{\csfmt{char}\idx{doublequotecharhex}\meta{hex}} if the
number is hexadecimal)},
- note={{}\TeX\ primitive},
+ note={{}\TeX\ primitive\texparserdefnote},
category={command}
}
-@index{number,
+@command{number,
name={\csfmt{number}},
user1={\meta{value}},
description={expands the given numerical \meta{value} to
a base~10 integer number stripping any leading
zeros (use \code{\csfmt{char}\idx{doublequotecharhex}\meta{hex}}
if the value is hexadecimal)},
- note={{}\TeX\ primitive},
+ note={{}\TeX\ primitive\texparserdefnote},
category={command}
}
-@index{the,
+@command{the,
name={\csfmt{the}},
user1={\meta{register}},
description={expands \meta{register} to the current value of the
register},
- note={{}\TeX\ primitive},
+ note={{}\TeX\ primitive\texparserdefnote},
category={command}
}
-@index{cs.string,
+@command{cs.string,
name={\csfmt{string}},
user1={\meta{token}},
description={if \meta{token} is a control sequence it expands
to the escape character followed by the control sequence name},
- note={{}\TeX\ primitive},
+ note={{}\TeX\ primitive\texparserdefnote},
category={command}
}
-@index{let,
+@command{let,
name={\csfmt{let}},
user1={\meta{token1}\meta{token2}},
description={assigns \meta{token1} to \meta{token2}},
- note={{}\TeX\ primitive},
+ note={{}\TeX\ primitive\texparserdefnote},
category={command}
}
-@index{u,
+@command{u,
name={\csfmt{u}},
user1={\margm{character}},
description={puts a breve accent over \meta{character}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{acute,
+@command{acute,
name={\csfmt{'}},
user1={\margm{character}},
description={puts an acute accent over \meta{character}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{umlaut,
+@command{umlaut,
name={\csfmt{"}},
user1={\margm{character}},
description={puts an umlaut accent over \meta{character}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{c,
+@command{c,
name={\csfmt{c}},
user1={\margm{character}},
description={puts a cedilla accent over \meta{character}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{AA,
+@command{AA,
name={\csfmt{AA}},
description={produces the \idx!{uppercase} A-ring character \AA},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{aa,
+@command{aa,
name={\csfmt{aa}},
description={produces the \idx!{lowercase} a-ring character \aa},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{O,
+@command{O,
name={\csfmt{O}},
description={produces the \idx!{uppercase} O-slash character \O},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{o,
+@command{o,
name={\csfmt{o}},
description={produces the \idx!{lowercase} o-slash character \o},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{L,
+@command{L,
name={\csfmt{L}},
description={produces the \idx!{uppercase} L-slash character \L},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{l,
+@command{l,
name={\csfmt{l}},
description={produces the \idx!{lowercase} l-slash character \l},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{ae,
+@command{ae,
name={\csfmt{ae}},
description={produces the \idx!{lowercase} \ae-ligature},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{AE,
+@command{AE,
name={\csfmt{AE}},
description={produces the \idx!{uppercase} \AE-ligature},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{oe,
+@command{oe,
name={\csfmt{oe}},
description={produces the \idx!{lowercase} \oe-ligature},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{OE,
+@command{OE,
name={\csfmt{OE}},
description={produces the \idx!{uppercase} \OE-ligature},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{th,
+@command{th,
name={\csfmt{th}},
description={produces the \idx!{lowercase} thorn \th},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{TH,
+@command{TH,
name={\csfmt{TH}},
description={produces the \idx!{uppercase} thorn \TH},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{ss,
+@command{ss,
name={\csfmt{ss}},
description={produces the \idx!{lowercase} eszett \ss},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{SS,
+@command{SS,
name={\csfmt{SS}},
description={produces the \idx!{uppercase} eszett \SS},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{ng,
+@command{ng,
name={\csfmt{ng}},
description={produces the \idx!{lowercase} eng \ng},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{NG,
+@command{NG,
name={\csfmt{NG}},
description={produces the \idx!{uppercase} eng \NG},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{dh,
+@command{dh,
name={\csfmt{dh}},
description={produces the \idx!{lowercase} eth \dh},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{DH,
+@command{DH,
name={\csfmt{DH}},
description={produces the \idx!{uppercase} eth \DH},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{dj,
+@command{dj,
name={\csfmt{dj}},
description={produces the \idx!{lowercase} d-stroke \dj},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{DJ,
+@command{DJ,
name={\csfmt{DJ}},
description={produces the \idx!{uppercase} d-stroke \DJ},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{textsuperscript,
+@command{textsuperscript,
name={\csfmt{textsuperscript}},
user1={\margm{text}},
description={displays \meta{text} as a superscript},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{textsubscript,
+@command{textsubscript,
name={\csfmt{textsubscript}},
user1={\margm{text}},
description={displays \meta{text} as a subscript},
- note={kernel command as from 2015/01/01},
+ note={kernel command\texparserdefnote\ as from 2015/01/01},
category={command}
}
-@index{MakeLowercase,
+@command{MakeLowercase,
name={\csfmt{MakeLowercase}},
user1={\margm{text}},
description={converts \meta{text} to lower case},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{textsc,
+@command{textsc,
name={\csfmt{textsc}},
user1={\margm{text}},
description={applies small-caps font to \meta{text}},
@@ -10924,64 +15277,84 @@ number is hexadecimal)},
category={command}
}
-@index{usepackage,
+@command{textsmaller,
+ name={\csfmt{text\-smaller}},
+ user1={\margm{text}},
+ description={typesets \meta{text} in a font size that's smaller
+ than the surrounding text},
+ note={\styfmt{relsize}},
+ category={command}
+}
+
+@glscommand{glstextup,
+ name={\csfmt{gls\-text\-up}},
+ user1={\margm{text}},
+ description={typesets \meta{text} in an upright font (used to
+cancel the effect of \cs{textsc} in abbreviation styles that use
+\ics{glsabbrvscfont})},
+ note={\styfmt{glossaries} v3.09a+},
+ topics={abbreviationcommands,formattingcommands},
+ category={command}
+}
+
+@command{usepackage,
name={\csfmt{use\-pack\-age}},
user1={\oargm{options}\margm{name}\oargm{min version}},
description={loads the package identified by \meta{name}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{RequirePackage,
+@command{RequirePackage,
name={\csfmt{Require\-Pack\-age}},
user1={\oargm{options}\margm{name}\oargm{min version}},
description={loads the package identified by \meta{name} from
within another package},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{ProvidesPackage,
+@command{ProvidesPackage,
name={\csfmt{Provides\-Pack\-age}},
user1={\margm{name}\oargm{version}},
description={identifies a package},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{DeclareOption,
+@command{DeclareOption,
name={\csfmt{Declare\-Opt\-ions}},
user1={\margm{name}\margm{code}},
description={declares an option with the given \meta{name}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{DeclareOption*,
+@command{DeclareOption*,
name={\csfmt{Declare\-Opt\-ions*}},
user1={\margm{code}},
description={indicates what to do with unknown options},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{ProcessOptions,
+@command{ProcessOptions,
name={\csfmt{Process\-Opt\-ions}},
description={processes supplied options},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{PackageError,
+@command{PackageError,
name={\csfmt{Pack\-age\-Err\-or}},
user1={\margm{name}\margm{code}\margm{help}},
description={generates an error message for the package identified
by \meta{name}},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{cs.color,
+@command{cs.color,
name={\csfmt{color}},
user1={\oargm{model}\margm{spec}},
description={switches the current font colour},
@@ -10989,7 +15362,7 @@ by \meta{name}},
category={command}
}
-@index{textcolor,
+@command{textcolor,
name={\csfmt{textcolor}},
user1={\oargm{model}\margm{spec}\margm{text}},
description={typesets \meta{text} in the given colour},
@@ -10997,14 +15370,14 @@ by \meta{name}},
category={command}
}
-@index{cjkname,
+@examplecommand{cjkname,
name={\csfmt{cjkname}},
user1={\margm{CJK characters}},
description={example command},
category={command}
}
-@index{citation,
+@command{citation,
name={\csfmt{citation}},
user1={\margm{label}},
description={written to the \ext{aux} file on each occurrence of
@@ -11013,102 +15386,111 @@ by \meta{name}},
category={command}
}
-@index{cite,
+@command{cite,
name={\csfmt{cite}},
user1={\margm{label}},
description={cross-reference a bibliographic citation},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{bibliography,
+@command{bibliography,
name={\csfmt{bibliography}},
user1={\margm{file list}},
description={display bibliography created by \BibTeX},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{refstepcounter,
+@command{refstepcounter,
name={\csfmt{refstepcounter}},
user1={\margm{counter name}},
description={increments the given counter in a manner compatible
with the \cs{label} cross-referencing mechanism},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{label,
+@command{label,
name={\csfmt{label}},
user1={\margm{id}},
description={creates a label that can be referenced with \ics{ref}
or \ics{pageref}},
seealso={ref,pageref},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{pageref,
+@command{pageref,
name={\csfmt{pageref}},
user1={\margm{id}},
description={cross-reference the page where \cs{label}\margm{id}
occurred},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{ref,
+@command{ref,
name={\csfmt{ref}},
user1={\margm{id}},
description={cross-reference the location where \cs{label}\margm{id}
occurred},
seealso={label},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{autoref,
+@command{autoref,
name={\csfmt{autoref}},
user1={\margm{id}},
description={cross-reference with textual tag inferred from the
associated counter},
seealso={label},
- note={\sty{hyperref}},
+ note={\styfmt{hyperref}},
category={command}
}
-@index{par,
+@command{par,
name={\csfmt{par}},
description={paragraph break},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{hyperlink,
+@command{hyperlink,
name={\csfmt{hyperlink}},
user1={\margm{target name}\margm{text}},
description={create a hyperlink to \meta{target name} with the given
\meta{text}},
- note={\styfmt{hyperref}},
+ note={\styfmt{hyperref}\texparserdefnote},
category={command}
}
-@index{hypertarget,
+@command{hypertarget,
name={\csfmt{hypertarget}},
user1={\margm{target name}\margm{text}},
description={create a hypertarget with the given \meta{target
name} and the displayed \meta{text}},
+ note={\styfmt{hyperref}\texparserdefnote},
+ category={command}
+}
+
+@command{texorpdfstring,
+ name={\csfmt{texorpdfstring}},
+ user1={\margm{\TeX\ code}\margm{PDF text}},
+ description={does \meta{PDF text} if used in a PDF bookmark,
+ otherwise does \meta{\TeX\ code}},
note={\styfmt{hyperref}},
category={command}
}
-@index{cs.hyperref,
+@command{cs.hyperref,
name={\csfmt{hyperref}},
note={\styfmt{hyperref}},
category={command}
}
-@index{cs.hyperref.ext,
+@command{cs.hyperref.ext,
parent={cs.hyperref},
name={\csfmt{hyperref}},
user1={\margm{URL}\margm{category}\margm{name}\margm{text}},
@@ -11118,7 +15500,7 @@ name} and the displayed \meta{text}},
category={command}
}
-@index{cs.hyperref.int,
+@command{cs.hyperref.int,
parent={cs.hyperref},
name={\csfmt{hyperref}},
user1={\oargm{label}\margm{text}},
@@ -11131,7 +15513,7 @@ name} and the displayed \meta{text}},
category={command}
}
-@index{@currentlabelname,
+@command{@currentlabelname,
name={\csfmt{@current\-label\-name}},
user1={},
description={used to store the current title information for the next instance
@@ -11140,7 +15522,7 @@ name} and the displayed \meta{text}},
category={command}
}
-@index{@currentHref,
+@command{@currentHref,
name={\csfmt{@current\-H\-ref}},
user1={},
description={used to store the current anchor for the next instance
@@ -11150,231 +15532,544 @@ name} and the displayed \meta{text}},
}
-@index{glsrefentry,
+@glscommand{glsrefentry,
name={\csfmt{gls\-ref\-entry}},
user1={\margm{label}},
description={when used with \styopt{entrycounter} or
\styopt{subentrycounter} may be used to cross-reference the
entry's number in the glossary list with \cs{ref}},
+ topics={crossrefcommands},
seealso={ref},
note={\styfmt{glossaries} v3.0+},
category={command}
}
-@index{glsxtrpageref,
+@glscommand{glsxtrpageref,
name={\csfmt{gls\-xtr\-page\-ref}},
user1={\margm{label}},
description={when used with \styopt{entrycounter} or
\styopt{subentrycounter} may be used to cross-reference the
entry's number in the glossary list with \cs{pageref}},
seealso={pageref},
+ topics={crossrefcommands},
note={\styfmt{glossaries-extra} v1.11},
category={command}
}
-@index{glsxtrglossentry,
+@glscommand{glsxtrglossentry,
name={\csfmt{gls\-xtr\-gloss\-entry}},
user1={\margm{label}},
- description={displays the given entry name including a hypertarget (if
+ description={displays the given entry \field{name} including a hypertarget (if
\sty{hyperref} has been loaded) as the destination for commands like
\cs{gls}},
+ topics={linkcommands,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.21},
category={command}
}
-@index{glsxtrglossentryother,
+@glscommand{glsxtrglossentryother,
name={\csfmt{gls\-xtr\-gloss\-entry\-other}},
user1={\margm{header}\margm{label}\margm{field}},
description={like \gls{glsxtrglossentry} but uses the value given
in the supplied internal \meta{field} where \meta{header} is the
code
to use in the header (leave empty for default)},
+ topics={linkcommands,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.22+},
category={command}
}
-@index{glsshowtarget,
+@glscommand{glsshowtarget,
name={\csfmt{gls\-show\-target}},
user1={\margm{label}},
description={used to show the target name when the
-\styopt[showtargets]{debug} option is on},
+ \styopt[showtargets]{debug} option is on},
+ topics={debugging,linkcommands},
note={\styfmt{glossaries} v4.32+},
category={command}
}
-@index{GlsEntryCounterLabelPrefix,
+@glscommand{showgloparent,
+ name={\csfmt{show\-glo\-parent}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{parent} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglolevel,
+ name={\csfmt{show\-glo\-level}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the entry's
+ hierarchical level in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showgloname,
+ name={\csfmt{show\-glo\-name}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{name} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglosort,
+ name={\csfmt{show\-glo\-sort}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{sort} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglosymbol,
+ name={\csfmt{show\-glo\-symbol}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{symbol} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglosymbolplural,
+ name={\csfmt{show\-glo\-symbol\-plural}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{symbolplural} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showgloshort,
+ name={\csfmt{show\-glo\-short}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{short} field in the transcript},
+ topics={debugging,fieldrefcommands,abbreviationcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglolong,
+ name={\csfmt{show\-glo\-long}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{long} field in the transcript},
+ topics={debugging,fieldrefcommands,abbreviationcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showgloloclist,
+ name={\csfmt{show\-glo\-loc\-list}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{loclist} field in the transcript},
+ topics={debugging,fieldrefcommands,loclistcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showgloflag,
+ name={\csfmt{show\-glo\-flag}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \idx{firstuseflag} in the transcript},
+ topics={debugging,fieldrefcommands,conditionals},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglodesc,
+ name={\csfmt{show\-glo\-desc}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{description} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglodescplural,
+ name={\csfmt{show\-glo\-desc\-plural}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{descriptionplural} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglotext,
+ name={\csfmt{show\-glo\-text}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{text} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showgloplural,
+ name={\csfmt{show\-glo\-plural}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{plural} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglofirst,
+ name={\csfmt{show\-glo\-first}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{first} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglofirstpl,
+ name={\csfmt{show\-glo\-firstpl}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{firstplural} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglotype,
+ name={\csfmt{show\-glo\-type}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{type} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglocounter,
+ name={\csfmt{show\-glo\-counter}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{counter} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglouseri,
+ name={\csfmt{show\-glo\-useri}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{user1} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglouserii,
+ name={\csfmt{show\-glo\-userii}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{user2} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglouseriii,
+ name={\csfmt{show\-glo\-useriii}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{user3} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglouseriv,
+ name={\csfmt{show\-glo\-useriv}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{user4} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglouserv,
+ name={\csfmt{show\-glo\-userv}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{user5} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglouservi,
+ name={\csfmt{show\-glo\-uservi}},
+ user1={\margm{label}},
+ description={interrupts the document build and shows the value of
+ the \field{user6} field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglofield,
+ name={\csfmt{show\-glo\-field}},
+ user1={\margm{entry label}\margm{internal field}},
+ description={interrupts the document build and shows the value of
+ the given field in the transcript},
+ topics={debugging,fieldrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showgloglossaries,
+ name={\csfmt{show\-glo\-glossaries}},
+ description={interrupts the document build and shows the list
+ of all non-ignored glossary types in the transcript},
+ topics={debugging,glossrefs},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglossarytitle,
+ name={\csfmt{show\-glos\-sary\-title}},
+ user1={\margm{type}},
+ description={interrupts the document build and shows the title
+ of the given glossary in the transcript},
+ topics={debugging,glossrefs},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglossarycounter,
+ name={\csfmt{show\-glos\-sary\-counter}},
+ user1={\margm{type}},
+ description={interrupts the document build and shows the default
+ counter for the given glossary in the transcript},
+ topics={debugging,glossrefs},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{showglossaryentries,
+ name={\csfmt{show\-glos\-sary\-entries}},
+ user1={\margm{type}},
+ description={interrupts the document build and shows the list of
+ entry labels for the given glossary in the transcript},
+ topics={debugging,glossrefs},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@glscommand{GlsEntryCounterLabelPrefix,
name={\csfmt{Gls\-Entry\-Counter\-Label\-Prefix}},
description={used as a prefix in the \cs{label} command
automatically implemented by the \styopt{entrycounter}
and \styopt{subentrycounter} options},
+ topics={hooks,crossrefcommands},
note={\styfmt{glossaries} v4.38+},
category={command}
}
-@index{GlsXtrStandaloneGlossaryType,
+@glscommand{GlsXtrStandaloneGlossaryType,
name={\csfmt{Gls\-Xtr\-Stand\-alone\-Glossary\-Type}},
description={expands to the label for \gls{currentglossary}
within \gls{glsxtrglossentry} and \gls{glsxtrglossentryother}},
+ topics={hooks,glossrefs,standalonestyles},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
-@index{GlsXtrStandaloneSubEntryItem,
+@glscommand{GlsXtrStandaloneSubEntryItem,
name={\csfmt{Gls\-Xtr\-Stand\-alone\-Sub\-Entry\-Item}},
user1 = {\margm{label}},
description={used within \gls{glsxtrglossentry} and
\gls{glsxtrglossentryother} to display sub-item labels},
+ topics={hooks,glossarystylecommands},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
-@index{GlsXtrStandaloneEntryName,
+@glscommand{GlsXtrStandaloneEntryName,
name={\csfmt{Gls\-Xtr\-Stand\-alone\-Entry\-Name}},
user1 = {\margm{label}},
description={used within \gls{glsxtrglossentry} to
display the name (with a hypertarget, if supported)},
+ topics={hooks,glossarystylecommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries-extra} v1.37+},
category={command}
}
-@index{GlsXtrStandaloneEntryOther,
+@glscommand{GlsXtrStandaloneEntryOther,
name={\csfmt{Gls\-Xtr\-Stand\-alone\-Entry\-Other}},
user1 = {\margm{label}\margm{field}},
description={used within \gls{glsxtrglossentryother} to
display the given field value (with a hypertarget, if supported)},
+ topics={hooks,glossarystylecommands,fieldrefcommands,linkcommands},
note={\styfmt{glossaries-extra} v1.37+},
category={command}
}
-@index{glsresetentrycounter,
+@glscommand{glsresetentrycounter,
name={\csfmt{gls\-reset\-entry\-counter}},
description={resets the \counter{glossaryentry} counter if the
\styopt{entrycounter} setting is on},
+ topics={hooks,glossarystylecommands,assigncommands,crossrefcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{setentrycounter,
+@glscommand{setentrycounter,
name={\csfmt{set\-entry\-counter}},
user1={\oargm{prefix}\margm{counter}},
description={sets up the entry's associated counter and prefix
required by \cs{glshypernumber}},
+ topics={glossarystylecommands,assigncommands,loclistcommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{setupglossaries,
+@glscommand{setupglossaries,
name={\csfmt{set\-up\-glossaries}},
user1 = {\margm{\keyvallist}},
description={applies the base \styfmt{glossaries} options
that are allowed to be changed after the package has loaded},
+ topics={assigncommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{glossariesextrasetup,
+@glscommand{glossariesextrasetup,
name={\csfmt{glossaries\-extra\-setup}},
user1 = {\margm{\keyvallist}},
description={applies the extension \styfmt{glossaries-extra} options
that are allowed to be changed after the package has loaded},
+ topics={assigncommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glstreepredesc,
+@glscommand{glstreepredesc,
name={\csfmt{gls\-tree\-pre\-desc}},
user1={\margm{label}},
description={separator used before the description for the
\glostyle{tree} styles},
+ topics={glossarystylecommands,separatorcommands,formattingcommands},
note={\styfmt{glossary-tree} v4.26+},
category={command}
}
-@index{glstreenonamedesc,
+@glscommand{glstreenonamedesc,
name={\csfmt{gls\-tree\-no\-name\-desc}},
user1={\margm{label}},
description={displays the pre-description separator, the
description and the post-description hook for the
\glostyle{treenoname} styles},
+ topics={glossarystylecommands,separatorcommands,formattingcommands},
note={\styfmt{glossaries-extra-stylemods} v1.31+},
category={command}
}
-@index{glsfmtshort,
+@glscommand{glsfmtshort,
name={\csfmt{gls\-fmt\-short}},
user1={\margm{label}},
description={provided for use in section or caption titles, this
displays the short form of the given abbreviation},
+ topics={formattingcommands,entryrefcommands,fieldrefcommands,abbreviationcommands,capheadcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsfmtlong,
+@glscommand{glsfmtlong,
name={\csfmt{gls\-fmt\-long}},
user1={\margm{label}},
description={provided for use in section or caption titles, this
displays the long form of the given abbreviation},
+ topics={formattingcommands,entryrefcommands,fieldrefcommands,abbreviationcommands,capheadcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsfmtfull,
+@glscommand{glsfmtfull,
name={\csfmt{gls\-fmt\-full}},
user1={\margm{label}},
description={provided for use in section or caption titles, this
-displays the full form of the given abbreviation},
+ displays the full form of the given abbreviation (using the inline
+ style that matches \cs{glsxtrfull})},
+ topics={formattingcommands,entryrefcommands,abbreviationcommands,capheadcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsfmtname,
+@glscommand{glsfmtname,
name={\csfmt{gls\-fmt\-name}},
user1={\margm{label}},
description={provided for use in section or caption titles, this
displays the given entry's name},
+ topics={formattingcommands,entryrefcommands,fieldrefcommands,capheadcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsfmtfirst,
+@glscommand{glsfmtfirst,
name={\csfmt{gls\-fmt\-first}},
user1={\margm{label}},
description={provided for use in section or caption titles, this
displays the given entry's \field{first} field},
+ topics={formattingcommands,entryrefcommands,fieldrefcommands,capheadcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{glsfmttext,
+@glscommand{glsfmttext,
name={\csfmt{gls\-fmt\-text}},
user1={\margm{label}},
description={provided for use in section or caption titles, this
displays the given entry's \field{text} field},
+ topics={formattingcommands,entryrefcommands,fieldrefcommands,capheadcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
-@index{theHentrycounter,
+@glscommand{theHentrycounter,
name={\csfmt{the\-H\-entry\-counter}},
user1={},
description={when indexing, this is set to the
\csfmt{theH}\meta{counter} command corresponding to the
current indexing counter (or, if undefined,
\csfmt{the}\meta{counter})},
+ topics={glossarystylecommands,linkcommands},
note={\styfmt{glossaries}},
category={command}
}
-@index{tableofcontents,
+@command{tableofcontents,
name={\csfmt{table\-of\-contents}},
- description={displays the table of contents (by reading in the
+ description={displays the \glsxtrlong{toc} (by reading in the
\ext{toc} file) and then opens \ext{toc} file to allow the
sectioning commands to write to it},
- note={kernel command},
+ note={kernel command\texparserdefnote},
category={command}
}
-@index{underline,
+@command{underline,
name={\csfmt{under\-line}},
user1={\margm{text}},
description={underlines the given text},
@@ -11382,7 +16077,7 @@ sectioning commands to write to it},
category={command}
}
-@index{ul,
+@command{ul,
name={\csfmt{ul}},
user1={\margm{text}},
description={underlines the given text},
@@ -11390,11 +16085,11 @@ sectioning commands to write to it},
category={command}
}
-@index{ding,
+@command{ding,
name={\csfmt{ding}},
user1={\margm{number}},
description={displays the symbol associated with the given number},
- note={\styfmt{pifont}},
+ note={\styfmt{pifont}\texparserdefnote},
category={command}
}
@@ -11402,14 +16097,14 @@ sectioning commands to write to it},
name = {example terms}
}
-@entry{ex1.duck,
+@exampleentry{ex1.duck,
parent={exampleterms},
name={duck},
description={a waterbird with webbed feet},
identifier={animal}
}
-@entry{ex1.goose,
+@exampleentry{ex1.goose,
parent={exampleterms},
name={goose},
plural={geese},
@@ -11418,7 +16113,7 @@ sectioning commands to write to it},
identifier={animal}
}
-@entry{ex2.duck,
+@exampleentry{ex2.duck,
parent={exampleterms},
name={Duck (noun)},
first={duck (quack, quack)},
@@ -11428,7 +16123,7 @@ sectioning commands to write to it},
identifier={animal}
}
-@entry{ex2.goose,
+@exampleentry{ex2.goose,
parent={exampleterms},
name={Goose (noun, pl.\ geese)},
first={goose (honk, honk)},
@@ -11440,7 +16135,7 @@ sectioning commands to write to it},
identifier={animal}
}
-@entry{ex.fleuron,
+@exampleentry{ex.fleuron,
parent={exampleterms},
name = {fleuron},
symbol = {\ding{167}},
@@ -11448,7 +16143,7 @@ sectioning commands to write to it},
description = {typographic ornament}
}
-@entry{ex.pi,
+@exampleentry{ex.pi,
parent={exampleterms},
name = {Archimedes' constant},
symbol = {\ensuremath{\pi}},
@@ -11456,68 +16151,68 @@ sectioning commands to write to it},
description = {ratio of a circle's circumference to its diameter}
}
-@entry{ex.thetai,
+@exampleentry{ex.thetai,
parent = {exampleterms},
name = {theta parameter},
symbol = {\ensuremath{\theta_i}},
description = {one of the model parameters}
}
-@abbreviation{ex.tug,
+@exampleabbreviation{ex.tug,
parent={exampleterms},
category = {longshortem},
short = {TUG},
long = {\TeX\ Users Group}
}
-@abbreviation{ex.ascii,
+@exampleabbreviation{ex.ascii,
short = {ascii},
long = {American Standard Code for Information Interchange},
category={shortsc}
}
-@abbreviation{ex.svm,
+@exampleabbreviation{ex.svm,
parent={exampleterms},
short = {SVM},
long = {support vector machine}
}
-@abbreviation{ex.ssl,
+@exampleabbreviation{ex.ssl,
parent={exampleterms},
category = {markwordsexample},
short = {SSL},
long = {Secure Sockets Layer}
}
-@abbreviation{ex.xml,
+@exampleabbreviation{ex.xml,
parent={exampleterms},
category = {taggingexample},
short = {XML},
long = {e\itag{x}tensible \itag{m}arkup \itag{l}anguage}
}
-@abbreviation{ex.dante,
+@exampleabbreviation{ex.dante,
parent={exampleterms},
category = {discardperiodexample},
short = {DANTE e.V.},
long = {Deutschsprachige Anwendervereinigung \TeX\ e.V.}
}
-@abbreviation{ex.gp,
+@exampleabbreviation{ex.gp,
parent={exampleterms},
category = {discardperiodexample},
short = {G.P.},
long = {General Practitioner}
}
-@abbreviation{ex2.gp,
+@exampleabbreviation{ex2.gp,
parent={exampleterms},
category = {initialism},
short = {GP},
long = {General Practitioner}
}
-@abbreviation{ex.rna,
+@exampleabbreviation{ex.rna,
parent={exampleterms},
short = {RNA},
long = {ribonukleins\"aure},
@@ -11525,107 +16220,107 @@ sectioning commands to write to it},
category = {abbrvtrans}
}
-@entry{ex.length,
+@exampleentry{ex.length,
parent={exampleterms},
name = {length},
symbol = {\si{\metre}},
description = {measurement between two points}
}
-@entry{ex.area,
+@exampleentry{ex.area,
parent={exampleterms},
name = {area},
symbol = {\si{\metre\squared}},
description = {measurement of a surface}
}
-@symbol{ex2.length,
+@examplesymbol{ex2.length,
parent={exampleterms},
description = {length},
name = {\si{\metre}}
}
-@symbol{ex2.area,
+@examplesymbol{ex2.area,
parent={exampleterms},
description = {area},
name = {\si{\metre\squared}}
}
-@symbol{ex.deriv,
+@examplesymbol{ex.deriv,
parent={exampleterms},
description = {derivative},
name = {\ensuremath{\derivfn{x}}},
user1 = {derivfn}
}
-@index{hom.bow1,
+@exampleindex{hom.bow1,
name={bow},
description={(rhymes with toe)},
category = {homograph}
}
-@entry{hom.bowknot,
+@exampleentry{hom.bowknot,
parent={hom.bow1},
description = {a knot tied with two loops and loose ends},
category = {homograph}
}
-@entry{hom.bowweapon,
+@exampleentry{hom.bowweapon,
parent={hom.bow1},
description = {a weapon for shooting arrows, made of curved wood
joined at both ends with taut string},
category = {homograph}
}
-@index{hom.bow2,
+@exampleindex{hom.bow2,
name={bow},
description={(rhymes with cow)},
category = {homograph}
}
-@index{hom.bowbend,
+@exampleindex{hom.bowbend,
parent={hom.bow2},
description={bend head or upper body},
category = {homograph}
}
-@index{hom.bowpressure,
+@exampleindex{hom.bowpressure,
parent={hom.bow2},
description={give in to pressure},
category = {homograph}
}
-@index{hom.bow3,
+@exampleindex{hom.bow3,
name={bow},
description={(also bows) the front end of a ship},
category = {homograph}
}
-@index{hom.glossary,
+@exampleindex{hom.glossary,
name={glossary},
category = {homograph}
}
-@entry{hom.glossarycol,
+@exampleentry{hom.glossarycol,
parent = {hom.glossary},
description = {collection of glosses},
category = {homograph}
}
-@entry{hom.glossarylist,
+@exampleentry{hom.glossarylist,
parent = {hom.glossary},
description = {list of technical words},
category = {homograph}
}
-@entry{hier.animal,
+@exampleentry{hier.animal,
name = {animal},
description = {living organism with a nervous system and sense organs
that can move independently},
category = {hierarchical}
}
-@entry{hier.bird,
+@exampleentry{hier.bird,
parent = {hier.animal},
name = {bird},
description = {warm-blooded egg-laying animal with feathers, wings
@@ -11633,14 +16328,14 @@ sectioning commands to write to it},
category = {hierarchical}
}
-@entry{hier.duck,
+@exampleentry{hier.duck,
parent = {hier.bird},
name = {duck},
description={a waterbird with webbed feet},
category = {hierarchical}
}
-@entry{hier.goose,
+@exampleentry{hier.goose,
parent = {hier.bird},
name = {goose},
description = {a large waterbird with a long neck, short legs,
@@ -11648,34 +16343,34 @@ sectioning commands to write to it},
category = {hierarchical}
}
-@entry{hier.mineral,
+@exampleentry{hier.mineral,
name = {mineral},
description = {natural inorganic substance},
category = {hierarchical}
}
-@entry{hier.calcite,
+@exampleentry{hier.calcite,
parent = {hier.mineral},
name = {calcite},
description = {a carbonate mineral},
category = {hierarchical}
}
-@entry{hier.quartz,
+@exampleentry{hier.quartz,
parent = {hier.mineral},
name = {quartz},
description = {hard mineral consisting of silica},
category = {hierarchical}
}
-@entry{hier.amethyst,
+@exampleentry{hier.amethyst,
parent = {hier.quartz},
name = {amethyst},
description = {a purple type of quartz},
category = {hierarchical}
}
-@entry{hier.citrine,
+@exampleentry{hier.citrine,
parent = {hier.quartz},
name = {citrine},
description = {a form of quartz with a colour ranging
@@ -11683,7 +16378,7 @@ from pale yellow to brown due to ferric impurities},
category = {hierarchical}
}
-@entry{ex2.amethyst,
+@exampleentry{ex2.amethyst,
name = {amethyst},
description = {a purple type of quartz},
symbol = {\ce{SiO2}},
@@ -11692,7 +16387,7 @@ from pale yellow to brown due to ferric impurities},
category = {standalone}
}
-@entry{ex3.goose,
+@exampleentry{ex3.goose,
name={goose},
user3={G},
user4={G},
@@ -11702,7 +16397,7 @@ from pale yellow to brown due to ferric impurities},
category={standalone}
}
-@entry{ex3.duck,
+@exampleentry{ex3.duck,
name={duck},
user3={D},
user4={D},
@@ -11710,7 +16405,7 @@ from pale yellow to brown due to ferric impurities},
category={standalone}
}
-@entry{standalone.pi,
+@exampleentry{standalone.pi,
name = {\ensuremath{\pi}},
description = {Archimedes' constant},
user3={glssymbols},
@@ -11718,7 +16413,7 @@ from pale yellow to brown due to ferric impurities},
category = {standalone}
}
-@entry{standalone.area,
+@exampleentry{standalone.area,
name = {\ensuremath{A}},
description = {area},
user3={glssymbols},
@@ -11726,7 +16421,7 @@ from pale yellow to brown due to ferric impurities},
category = {standalone}
}
-@entry{standalone.radius,
+@exampleentry{standalone.radius,
name = {\ensuremath{r}},
description = {radius},
user3={glssymbols},
@@ -11734,7 +16429,7 @@ from pale yellow to brown due to ferric impurities},
category = {standalone}
}
-@entry{standalone.circumference,
+@exampleentry{standalone.circumference,
name = {\ensuremath{C}},
user3={glssymbols},
user4={C},