summaryrefslogtreecommitdiff
path: root/support/bib2gls/src/bib2gls.bib
diff options
context:
space:
mode:
Diffstat (limited to 'support/bib2gls/src/bib2gls.bib')
-rw-r--r--support/bib2gls/src/bib2gls.bib610
1 files changed, 517 insertions, 93 deletions
diff --git a/support/bib2gls/src/bib2gls.bib b/support/bib2gls/src/bib2gls.bib
index ec94ffe5d5..915cc0d110 100644
--- a/support/bib2gls/src/bib2gls.bib
+++ b/support/bib2gls/src/bib2gls.bib
@@ -42,6 +42,7 @@
% @topic -> topic
@preamble{"\providecommand{\dhyphen}{-}
+\providecommand{\longargfmt}[1]{-{}-#1}
\providecommand{\csfmt}[1]{\texttt{\glsbackslash #1}}
\providecommand{\derivfn}[1]{f'(#1)}
\providecommand{\rangestartmark}{\symbol{40}}
@@ -212,7 +213,7 @@
name={categories and attributes}
}
-@topic{regex,
+@index{regex,
name={regular expressions},
text={regular expression},
}
@@ -221,14 +222,14 @@
name={accessibility support}
}
-@topic{conditionals,
+@topic{conditional,
name={conditionals and boolean values},
text={conditional},
plural={conditionals}
}
@indexplural{booleanvals,
text={boolean value},
- alias={conditionals}
+ alias={conditional}
}
@topic{debugging,
@@ -242,9 +243,9 @@
}
@topic{hooks,name={hooks},text={hook}}
-@topic{loops,name={loops},text={loop}}
-@index{iteration,see={loops}}
-@indexplural{handler,seealso={loops}}
+@topic{loop,name={loops},text={loop}}
+@index{iteration,see={loop}}
+@indexplural{handler,seealso={loop}}
@topic{indexing}
@bibglscommand{bibglsnewentry,
@@ -695,7 +696,7 @@
(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},
+ topics={abbreviationcommands,conditional},
note={\styfmt{glossaries-extra} v1.02+},
category={command}
}
@@ -703,7 +704,7 @@
@glscommand{glsxtrinsertinsidefalse,
name={\csfmt{gls\-xtr\-insert\-inside\-false}},
description={sets the \cs{ifglsxtrinsertinside} switch to \optfmt{false}},
- topics={abbreviationcommands,conditionals},
+ topics={abbreviationcommands,conditional},
note={\styfmt{glossaries-extra} v1.02+},
category={command}
}
@@ -711,7 +712,7 @@
@glscommand{glsxtrinsertinsidetrue,
name={\csfmt{gls\-xtr\-insert\-inside\-true}},
description={sets the \cs{ifglsxtrinsertinside} switch to \optfmt{true}},
- topics={abbreviationcommands,conditionals},
+ topics={abbreviationcommands,conditional},
note={\styfmt{glossaries-extra} v1.02+},
category={command}
}
@@ -1675,6 +1676,17 @@ extra code to the end of \meta{description}},
category={command}
}
+@glscommand{oldacronym,
+ name={\csfmt{old\-acronym}},
+ user1={\oargm{label}\margm{short}\margm{long}\margm{options}},
+ description={Emulates the way the old \styfmt{glossary} package
+ defined acronyms},
+ topics={definingterms},
+ note={\styfmt{glossaries}},
+ seealso={newacronym},
+ category={command}
+}
+
@mainglscommand{glsxtrnewsymbol,
name={\csfmt{gls\-xtr\-new\-symbol}},
user1={\oargm{\keyvallist}\margm{label}\margm{symbol}},
@@ -2338,6 +2350,48 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@resourceoption{opt.prefix-fields,
+ name={\csoptfmt{prefix\dhyphen fields}},
+ user1={\meta{list}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.append-prefix-field,
+ name={\csoptfmt{append\dhyphen prefix\dhyphen field}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.append-prefix-field-cs,
+ name={\csoptfmt{append\dhyphen prefix\dhyphen field\dhyphen cs}},
+ user1={\meta{cs}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.append-prefix-field-exceptions,
+ name={\csoptfmt{append\dhyphen prefix\dhyphen field\dhyphen exceptions}},
+ user1={\meta{sequence}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.append-prefix-field-cs-exceptions,
+ name={\csoptfmt{append\dhyphen prefix\dhyphen field\dhyphen cs\dhyphen exceptions}},
+ user1={\meta{sequence}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.append-prefix-field-nbsp-match,
+ name={\csoptfmt{append\dhyphen prefix\dhyphen field\dhyphen nbsp\dhyphen match}},
+ user1={\meta{pattern}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@resourceoption{opt.interpret-fields,
name={\csoptfmt{interpret\dhyphen fields}},
user1={\margm{list}},
@@ -2345,6 +2399,13 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@resourceoption{opt.interpret-fields-action,
+ name={\csoptfmt{interpret\dhyphen fields\dhyphen action}},
+ user1={\margm{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@resourceoption{opt.post-description-dot,
name={\csoptfmt{post\dhyphen description\dhyphen dot}},
user1={\meta{value}},
@@ -2408,6 +2469,13 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@resourceoption{opt.save-sibling-count,
+ name={\csoptfmt{save\dhyphen sibling\dhyphen count}},
+ user1={\meta{boolean}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@resourceoption{opt.save-original-entrytype,
name={\csoptfmt{save\dhyphen original\dhyphen entrytype}},
user1={\meta{boolean}},
@@ -3426,7 +3494,7 @@ cs}\margm{Glspl-like cs}},
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},
+ topics={listcommands,conditional,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.12+},
seealso={glsxtrfieldxifinlist,glsxtrfieldlistadd,glsxtrfieldforlistloop,glsxtrfielddolistloop},
category={command}
@@ -3437,7 +3505,7 @@ cs}\margm{Glspl-like cs}},
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},
+ topics={listcommands,conditional,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.12+},
seealso={glsxtrfieldifinlist},
category={command}
@@ -4106,6 +4174,12 @@ and \L/\l\ treated as L/l},
parent={packages}
}
+@package{xkeyval,
+ name={\styfmt{xkeyval}},
+ category={package},
+ parent={packages}
+}
+
@package{textcomp,
name={\styfmt{textcomp}},
category={package},
@@ -4689,6 +4763,13 @@ with forced line breaks in paragraph column formats)},
category={command}
}
+@command{nobreakspace,
+ name={\csfmt{nobreakspace}},
+ description={produces a non-breakable space},
+ note={kernel command\texparserdefnote},
+ category={command}
+}
+
@symbol{aposchar,
name={\code{'} (apostrophe)},
text={\code{'}},
@@ -4951,6 +5032,13 @@ given language},
category={environment}
}
+@environment{env.document,
+ name={\envfmt{document}},
+ description={contains the entire document text},
+ note={kernel command\texparserdefnote},
+ category={environment}
+}
+
@environment{env.description,
name={\envfmt{description}},
description={list-like environment},
@@ -6867,6 +6955,12 @@ long form on \idx{firstuse}. The default definition just uses
parent={categoryattribute}
}
+@categoryattribute{catattr.glosssymbolfont,
+ name={\catattrfmt{gloss\-symbol\-font}},
+ category={categoryattribute},
+ parent={categoryattribute}
+}
+
@categoryattribute{catattr.textformat,
name={\catattrfmt{text\-format}},
category={categoryattribute},
@@ -7534,7 +7628,7 @@ long form on \idx{firstuse}. The default definition just uses
@packageoption{styopt.nosuper,
name={\styoptfmt{nosuper}},
package={glossaries},
- description={prevents the \sty{glossary-super} package (which
+ description={prevents the \isty{glossary-super} package (which
provides the \glostyle{super} styles) from being
automatically loaded},
category={packageoption},
@@ -8054,6 +8148,46 @@ field.},
parent={fields}
}
+@field{field.dualprefix,
+ name={\fieldfmt{dual\-prefix}},
+ description={The dual of the \field{prefix} field. This field
+ isn't provided with a key or associated command, but can be
+ accessed as an internal field},
+ note={\appfmt{bib2gls}},
+ category={bib2glsfield},
+ parent={fields}
+}
+
+@field{field.dualprefixplural,
+ name={\fieldfmt{dual\-prefix\-plural}},
+ description={The dual of the \field{prefixplural} field. This field
+ isn't provided with a key or associated command, but can be
+ accessed as an internal field},
+ note={\appfmt{bib2gls}},
+ category={bib2glsfield},
+ parent={fields}
+}
+
+@field{field.dualprefixfirst,
+ name={\fieldfmt{dual\-prefix\-first}},
+ description={The dual of the \field{prefixfirst} field. This field
+ isn't provided with a key or associated command, but can be
+ accessed as an internal field},
+ note={\appfmt{bib2gls}},
+ category={bib2glsfield},
+ parent={fields}
+}
+
+@field{field.dualprefixfirstplural,
+ name={\fieldfmt{dual\-prefix\-first\-plural}},
+ description={The dual of the \field{prefixfirstplural} field. This field
+ isn't provided with a key or associated command, but can be
+ accessed as an internal field},
+ note={\appfmt{bib2gls}},
+ category={bib2glsfield},
+ parent={fields}
+}
+
@field{field.access,
name={\fieldfmt{access}},
description={The replacement text for the \field{name} field.},
@@ -8188,6 +8322,24 @@ field.},
parent={internalfields}
}
+@field{field.siblingcount,
+ name={\fieldfmt{siblingcount}},
+ description={Stores the number of siblings this entry has
+ had selected.},
+ note={internal field set by \appfmt{bib2gls}},
+ category={internalfield},
+ parent={internalfields}
+}
+
+@field{field.siblinglist,
+ name={\fieldfmt{siblinglist}},
+ description={A list of labels (in \sty{etoolbox}'s internal list
+ format) of the siblings this entry has had selected.},
+ note={internal field set by \appfmt{bib2gls}},
+ category={internalfield},
+ parent={internalfields}
+}
+
@field{field.originalentrytype,
name={\fieldfmt{original\-entry\-type}},
description={The original entry type before any aliasing was
@@ -8460,10 +8612,14 @@ primary formats, if enabled.},
@field{field.nonumberlist,
name={\fieldfmt{nonumberlist}},
- description={Used to suppress the location list for a specific entry.},
- note={internal field set by \styfmt{glossaries}},
- category={baseinternalfield},
- parent={internalfields}
+ description={Used to suppress the location list for a specific entry.
+ Its value may only be \code{true} or \code{false}.
+ Technically this isn't actually a field as its value isn't saved
+ so it can't be referenced or modified after the entry has been
+ defined.},
+ note={\styfmt{glossaries}},
+ category={basefield},
+ parent={fields}
}
@field{field.prevcount,
@@ -8799,11 +8955,21 @@ primary formats, if enabled.},
name={switches},
text={switch},
plural={switches},
- see={commandlineoptions}
+ see={commandlineoptions,commandlineoptionsgls2bib}
+}
+
+@index{--switch,
+ name={\longargfmt{\meta{switch}}},
+ see={commandlineoptions,commandlineoptionsgls2bib}
}
@index{commandlineoptions,
- name={command line options},
+ name={command line options (\appfmt{bib2gls})},
+ text={command line option}
+}
+
+@index{commandlineoptionsgls2bib,
+ name={command line options (\appfmt{convertgls2bib})},
text={command line option}
}
@@ -9164,6 +9330,20 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
+@switch{switch.trim-only-fields,
+ name={\longargfmt{trim\dhyphen only\dhyphen fields}},
+ user1={\meta{list}},
+ category={switch},
+ parent={commandlineoptions}
+}
+
+@switch{switch.trim-except-fields,
+ name={\longargfmt{trim\dhyphen except\dhyphen fields}},
+ user1={\meta{list}},
+ category={switch},
+ parent={commandlineoptions}
+}
+
@switch{switch.no-trim-fields,
name={\longargfmt{no\dhyphen trim\dhyphen fields}},
user1={},
@@ -9171,6 +9351,206 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
+@switch{switch.gls2bib.help,
+ name={\longargfmt{help}},
+ symbol={\shortargfmt{h}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.version,
+ name={\longargfmt{version}},
+ symbol={\shortargfmt{v}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.debug,
+ name={\longargfmt{debug}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.silent,
+ name={\longargfmt{silent}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.verbose,
+ name={\longargfmt{verbose}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.texenc,
+ name={\longargfmt{texenc}},
+ user1={\meta{encoding}},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.bibenc,
+ name={\longargfmt{bibenc}},
+ user1={\meta{encoding}},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.ignore-sort,
+ name={\longargfmt{ignore\dhyphen sort}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.no-ignore-sort,
+ name={\longargfmt{no\dhyphen ignore\dhyphen sort}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.ignore-type,
+ name={\longargfmt{ignore\dhyphen type}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.no-ignore-type,
+ name={\longargfmt{no\dhyphen ignore\dhyphen type}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.split-on-type,
+ name={\longargfmt{split\dhyphen on\dhyphen type}},
+ symbol={\shortargfmt{t}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.no-split-on-type,
+ name={\longargfmt{no\dhyphen split\dhyphen on\dhyphen type}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.ignore-category,
+ name={\longargfmt{ignore\dhyphen category}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.no-ignore-category,
+ name={\longargfmt{no\dhyphen ignore\dhyphen category}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.ignore-fields,
+ name={\longargfmt{ignore\dhyphen fields}},
+ symbol={\shortargfmt{f}},
+ user1={\meta{list}},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.split-on-category,
+ name={\longargfmt{split\dhyphen on\dhyphen category}},
+ symbol={\shortargfmt{c}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.no-split-on-category,
+ name={\longargfmt{no\dhyphen split\dhyphen on\dhyphen category}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.overwrite,
+ name={\longargfmt{overwrite}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.no-overwrite,
+ name={\longargfmt{no\dhyphen overwrite}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.preamble-only,
+ name={\longargfmt{preamble\dhyphen only}},
+ symbol={\shortargfmt{p}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.no-preamble-only,
+ name={\longargfmt{no\dhyphen preamble\dhyphen only}},
+ user1={},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.space-sub,
+ name={\longargfmt{space\dhyphen sub}},
+ symbol={\shortargfmt{s}},
+ user1={\meta{replacement}},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.locale,
+ name={\longargfmt{locale}},
+ user1={\meta{language tag}},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.index-conversion,
+ name={\longargfmt{index\dhyphen conversion}},
+ symbol={\shortargfmt{i}},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.no-index-conversion,
+ name={\longargfmt{no\dhyphen index\dhyphen conversion}},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.absorb-see,
+ name={\longargfmt{absorb\dhyphen see}},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
+@switch{switch.gls2bib.no-absorb-see,
+ name={\longargfmt{no\dhyphen absorb\dhyphen see}},
+ category={switch},
+ parent={commandlineoptionsgls2bib}
+}
+
@index{lettergroup,
name={letter group}
}
@@ -9681,9 +10061,9 @@ primary formats, if enabled.},
user1={\margm{label}\margm{field}},
description={iterates over the items the given field, which contains
an \styfmt{etoolbox} internal list},
- topics={listcommands,loops,fieldrefcommands},
+ topics={listcommands,loop,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.12+},
- seealso={glsxtrfieldforlistloop,glsxtrfieldifinlist,glsxtrfieldlistadd},
+ seealso={glsxtrfieldforlistloop,glsxtrfieldifinlist,glsxtrfieldlistadd,listbreak},
category={command}
}
@@ -9692,9 +10072,33 @@ primary formats, if enabled.},
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},
+ topics={listcommands,loop,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.29+},
- seealso={glsxtrfielddolistloop,glsxtrfieldifinlist,glsxtrfieldlistadd},
+ seealso={glsxtrfielddolistloop,glsxtrfieldifinlist,glsxtrfieldlistadd,listbreak},
+ category={command}
+}
+
+@glscommand{glsxtrfieldformatlist,
+ name={\csfmt{gls\-xtr\-field\-format\-list}},
+ user1={\margm{label}\margm{field}},
+ description={formats the items in the given field, which contains
+ an \styfmt{etoolbox} internal list, using the same handler as
+ \ics{DTLformatlist}},
+ topics={listcommands,loop,fieldrefcommands},
+ note={\styfmt{glossaries-extra} v1.42+},
+ seealso={glsxtrfieldforlistloop,glsxtrfielddolistloop,DTLformatlist,glsxtrfieldformatcsvlist},
+ category={command}
+}
+
+@glscommand{glsxtrfieldformatcsvlist,
+ name={\csfmt{gls\-xtr\-field\-format\-csv\-list}},
+ user1={\margm{label}\margm{field}},
+ description={formats the items in the given field, which contains
+ a comma-separated list, using the same handler as
+ \ics{DTLformatlist}},
+ topics={listcommands,loop,fieldrefcommands},
+ note={\styfmt{glossaries-extra} v1.42+},
+ seealso={glsxtrfieldforlistloop,glsxtrfielddolistloop,DTLformatlist,glsxtrfieldformatlist},
category={command}
}
@@ -11076,7 +11480,7 @@ category},
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},
+ topics={hooks,conditional},
note={\styfmt{glossaries-extra}},
category={command}
}
@@ -11089,7 +11493,7 @@ 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},
+ topics={conditional,entryrefcommands},
note={\styfmt{glossaries}},
seealso={GlsXtrIfUnusedOrUndefined,glsxtrifwasfirstuse},
category={command}
@@ -11102,7 +11506,7 @@ category},
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},
+ topics={conditional},
note={\styfmt{glossaries-extra} v1.34+},
seealso={ifglsused,glsxtrifwasfirstuse},
category={command}
@@ -11145,7 +11549,7 @@ label of the current entry},
description={only for use in the \meta{true} part of
\cs{ifglshasfield} or \cs{glsxtrifhasfield}, this expands to the
field value},
- topics={conditionals},
+ topics={conditional},
note={\styfmt{glossaries}},
category={command}
}
@@ -11238,7 +11642,7 @@ field value},
(defined and not empty)
without testing if the entry exists and adds implicit scoping
to \meta{true} and \meta{false}},
- topics={conditionals,fieldrefcommands},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.19+},
seealso={GlsXtrIfFieldUndef},
category={command}
@@ -11251,7 +11655,7 @@ field value},
(defined and not empty)
without testing if the entry exists and without introducing
an implicit scope},
- topics={conditionals,fieldrefcommands},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.19+},
seealso={GlsXtrIfFieldUndef},
category={command}
@@ -11262,7 +11666,7 @@ field value},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.23+},
category={command}
}
@@ -11274,7 +11678,7 @@ field value},
\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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -11286,7 +11690,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
@@ -11298,7 +11702,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
@@ -11309,7 +11713,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
seealso={glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
}
@@ -11320,7 +11724,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries}},
seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
@@ -11331,7 +11735,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries}},
seealso={ifglshassymbol,ifglshasdescsuppressed},
category={command}
@@ -11342,7 +11746,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries}},
seealso={ifglshasdesc},
category={command}
@@ -11353,7 +11757,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries}},
category={command}
}
@@ -11368,7 +11772,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries}},
category={command}
}
@@ -11378,7 +11782,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands,abbreviationcommands},
note={\styfmt{glossaries}},
category={command}
}
@@ -11388,7 +11792,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands,abbreviationcommands},
note={\styfmt{glossaries}},
category={command}
}
@@ -11398,7 +11802,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-prefix}},
seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
@@ -11409,7 +11813,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-prefix}},
seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
@@ -11420,7 +11824,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-prefix}},
seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
@@ -11431,7 +11835,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-prefix}},
seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
@@ -11444,7 +11848,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries} v4.16+},
category={command}
}
@@ -11457,7 +11861,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries} v4.16+},
category={command}
}
@@ -11470,7 +11874,7 @@ doesn't},
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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries} v4.16+},
category={command}
}
@@ -11525,7 +11929,7 @@ 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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.31+},
seealso={GlsXtrIfFieldEqNum},
category={command}
@@ -11541,7 +11945,7 @@ 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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.31+},
seealso={GlsXtrIfFieldNonZero,GlsXtrIfFieldCmpNum},
category={command}
@@ -11558,7 +11962,7 @@ 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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-extra} v1.31+},
seealso={GlsXtrIfFieldNonZero},
category={command}
@@ -11572,7 +11976,7 @@ 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},
+ topics={conditional,fieldrefcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.31+},
seealso={GlsXtrIfFieldNonZero},
category={command}
@@ -11584,7 +11988,7 @@ can be referenced in \meta{true} or \meta{false} with
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},
+ topics={conditional,hooks},
note={\styfmt{glossaries-extra} v1.23+},
category={command}
}
@@ -11860,7 +12264,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={\margm{location list cs}},
description={iterates over the given internal location list using
the \cs{glsnoidxloclisthandler} handler},
- topics={glossarystylecommands,loops,loclistcommands},
+ topics={glossarystylecommands,loop,loclistcommands},
note={\styfmt{glossaries}},
category={command}
}
@@ -11869,7 +12273,7 @@ can be referenced in \meta{true} or \meta{false} with
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},
+ topics={glossarystylecommands,loop,loclistcommands},
user1={\margm{location}},
note={\styfmt{glossaries}},
category={command}
@@ -12078,7 +12482,7 @@ letter to \idx{uppercase}},
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},
+ topics={loop,indexing},
note={\styfmt{glossaries}},
category={command}
}
@@ -12092,7 +12496,7 @@ letter to \idx{uppercase}},
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},
+ topics={loop,indexing},
note={\styfmt{glossaries}},
category={command}
}
@@ -12704,7 +13108,7 @@ usual delay},
name={\csfmt{ifglsentryexists}},
user1={\margm{label}\margm{true}\margm{false}},
description={tests if the entry given by \meta{label} exists},
- topics={conditionals,entryrefcommands},
+ topics={conditional,entryrefcommands},
note={\styfmt{glossaries}},
category={command}
}
@@ -12748,7 +13152,7 @@ usual delay},
defined (which, with \bibgls, should correspond to the
order obtained from the sort settings given in the
\idx{resourceset} options)},
- topics={glossrefs,loops},
+ topics={glossrefs,loop},
note={\styfmt{glossaries-extra} v1.08+},
category={command}
}
@@ -12759,7 +13163,7 @@ usual delay},
description={as \cs{printunsrtglossary} but performs
\meta{code} first (scoped to localise any assignments within
\meta{code})},
- topics={glossrefs,loops},
+ topics={glossrefs,loop},
note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@@ -12769,7 +13173,7 @@ usual delay},
user1={},
description={iterates over all non-ignored defined glossaries
and performs \cs{printunsrtglossary} for each one},
- topics={glossrefs,loops},
+ topics={glossrefs,loop},
note={\styfmt{glossaries-extra} v1.08+},
category={command}
}
@@ -12779,7 +13183,7 @@ usual delay},
user1={\margm{label}},
description={performed at each iteration of the internal loop used
by \cs{printunsrtglossary}},
- topics={glossrefs,loops,hooks},
+ topics={glossrefs,loop,hooks},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -12789,7 +13193,7 @@ by \cs{printunsrtglossary}},
description={only allowed within
\cs{printunsrtglossaryentryprocesshook} this command
indicates that the current entry should be skipped},
- topics={glossrefs,loops,hooks},
+ topics={glossrefs,loop,hooks},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -12818,7 +13222,7 @@ hasn't been defined},
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},
+ topics={conditional,fieldrefcommands,catattrcommands},
note={\styfmt{glossaries-extra}},
category={command}
}
@@ -12830,7 +13234,7 @@ hasn't been defined},
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} that are fully expandable},
- topics={conditionals,listcommands},
+ topics={conditional,listcommands},
note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -13013,7 +13417,7 @@ hasn't been defined},
user1={},
description={iterates over all non-ignored defined glossaries
and performs \cs{printglossary} for each one},
- topics={glossrefs,loops},
+ topics={glossrefs,loop},
note={\styfmt{glossaries}},
category={command}
}
@@ -13032,7 +13436,7 @@ hasn't been defined},
user1={},
description={iterates over all non-ignored defined glossaries
and performs \cs{printnoidxglossary} for each one},
- topics={glossrefs,loops},
+ topics={glossrefs,loop},
note={\styfmt{glossaries} v4.04+},
category={command}
}
@@ -13222,7 +13626,7 @@ defined},
@glscommand{glscapturedgroup,
name={\csfmt{glscapturedgroup}},
description={expands to \cs{cs.string}\idx{dollarchar}},
- topics={charcommands,regex},
+ topics={charcommands},
note={\styfmt{glossaries-extra-bib2gls} v1.31+},
category={command}
}
@@ -13429,11 +13833,21 @@ glossary (or the default of \meta{type} is omitted)},
}
@command{seealsoname,
- name={\csfmt{seealsoname}},
+ name={\csfmt{see\-also\-name}},
user1={},
- description={language sensitive \qt{see also} text},
+ description={language sensitive \qt{see also} text (as from v1.42
+ this will be defined to \cs{alsoname} if that command exists)},
topics={fixedtextcommands,glossarystylecommands,loclistcommands},
- note={\styfmt{glossaries-extra} or language packages},
+ note={\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@command{alsoname,
+ name={\csfmt{also\-name}},
+ user1={},
+ description={language sensitive \qt{see also} text},
+ topics={fixedtextcommands},
+ note={language packages},
category={command}
}
@@ -14371,7 +14785,7 @@ location list},
description={used by commands like \cs{glsfmtshort}, this expands
to \meta{true} in page headings and the table of contents,
otherwise it expands to \meta{false}},
- topics={conditionals},
+ topics={conditional},
note={\styfmt{glossaries-extra} v1.07+},
category={command}
}
@@ -14442,8 +14856,7 @@ entries in the \glostyle{tree}-like styles},
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}},
+ note={\isty{glossary-long} and \isty{glossary-super}},
category={command}
}
@@ -14496,7 +14909,7 @@ paragraph break that retains the hanging indent},
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},
+ topics={loop,entryrefcommands},
note={\styfmt{glossaries}},
seealso={forallglsentries},
category={command}
@@ -14510,7 +14923,7 @@ paragraph break that retains the hanging indent},
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},
+ topics={loop,glossrefs,entryrefcommands},
note={\styfmt{glossaries}},
seealso={forglsentries,forallglossaries},
category={command}
@@ -14524,7 +14937,7 @@ paragraph break that retains the hanging indent},
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},
+ topics={loop,glossrefs},
note={\styfmt{glossaries}},
category={command}
}
@@ -14537,7 +14950,7 @@ paragraph break that retains the hanging indent},
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},
+ topics={loop,fieldrefcommands,listcommands},
note={\styfmt{glossaries}},
note={\styfmt{glossaries-extra} v1.24+},
seealso={glsxtrendfor},
@@ -14549,9 +14962,20 @@ paragraph break that retains the hanging indent},
user1={},
description={may be used within the handler macro
of \cs{glsxtrforcsvfield} to prematurely break the loop},
- topics={loops,listcommands},
+ topics={loop,listcommands},
note={\styfmt{glossaries-extra} v1.24+},
- seealso={glsxtrforcsvfield},
+ seealso={glsxtrforcsvfield,listbreak},
+ category={command}
+}
+
+@glscommand{listbreak,
+ name={\csfmt{list\-break}},
+ user1={},
+ description={may be used within the handler macro
+ of \sty{etoolbox}'s internal list loop commands to prematurely break the loop},
+ topics={loop,listcommands},
+ note={\styfmt{etoolbox}},
+ seealso={forlistloop,glsxtrfieldforlistloop,glsxtrfielddolistloop,glsxtrendfor},
category={command}
}
@@ -14560,7 +14984,7 @@ paragraph break that retains the hanging indent},
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},
+ topics={conditional,glossrefs},
note={\styfmt{glossaries}},
category={command}
}
@@ -14570,7 +14994,7 @@ paragraph break that retains the hanging indent},
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},
+ topics={conditional,glossrefs},
note={\styfmt{glossaries} v4.08+},
category={command}
}
@@ -14582,7 +15006,7 @@ paragraph break that retains the hanging indent},
is done, otherwise an error (or warning with
\sty{glossaries-extra}'s \styopt[warn]{undefaction} option) is
triggered},
- topics={conditionals,entryrefcommands},
+ topics={conditional,entryrefcommands},
note={\styfmt{glossaries}},
category={command}
}
@@ -14594,7 +15018,7 @@ paragraph break that retains the hanging indent},
is done, otherwise an error (or warning with
\sty{glossaries-extra}'s \styopt[warn]{undefaction} option) is
triggered},
- topics={conditionals,entryrefcommands},
+ topics={conditional,entryrefcommands},
note={\styfmt{glossaries}},
category={command}
}
@@ -14606,7 +15030,7 @@ paragraph break that retains the hanging indent},
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},
+ topics={conditional,entryrefcommands},
note={\styfmt{glossaries}},
category={command}
}
@@ -14618,7 +15042,7 @@ paragraph break that retains the hanging indent},
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},
+ topics={conditional,entryrefcommands},
note={\styfmt{glossaries}},
category={command}
}
@@ -14718,7 +15142,7 @@ been assigned a mapping to a language hook label},
\cs{GlsXtrStopUnsetBuffering}. The starred form
(added to v1.31) avoids duplicate labels in the buffer's
internal list},
- topics={entryrefcommands,conditionals},
+ topics={entryrefcommands,conditional},
note={\styfmt{glossaries-extra} v1.30+},
seealso={GlsXtrForUnsetBufferedList},
category={command}
@@ -14730,7 +15154,7 @@ been assigned a mapping to a language hook label},
\idx{firstuseflag} of all the entry whose labels are stored in the
buffer that was started with
\cs{GlsXtrStartUnsetBuffering} and then clears the buffer},
- topics={entryrefcommands,conditionals},
+ topics={entryrefcommands,conditional},
note={\styfmt{glossaries-extra} v1.30+},
seealso={GlsXtrForUnsetBufferedList},
category={command}
@@ -14754,7 +15178,7 @@ been assigned a mapping to a language hook label},
user1 = {\margm{label}},
description={unsets the \idx{firstuseflag} so that the entry is
marked as having been used},
- topics={conditionals},
+ topics={conditional},
note={\styfmt{glossaries}},
category={command}
}
@@ -14764,7 +15188,7 @@ marked as having been used},
user1 = {\margm{label}},
description={locally unsets the \idx{firstuseflag} so that the entry is
marked as having been used},
- topics={conditionals},
+ topics={conditional},
note={\styfmt{glossaries}},
category={command}
}
@@ -14774,7 +15198,7 @@ marked as having been used},
user1 = {\margm{label}},
description={resets the \idx{firstuseflag} so that the entry is
marked as not used},
- topics={conditionals},
+ topics={conditional},
note={\styfmt{glossaries}},
category={command}
}
@@ -14784,7 +15208,7 @@ marked as not used},
user1 = {\margm{label}},
description={locally resets the \idx{firstuseflag} so that the entry is
marked as not used},
- topics={conditionals},
+ topics={conditional},
note={\styfmt{glossaries}},
category={command}
}
@@ -14795,7 +15219,7 @@ marked as not used},
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)},
+ \isty{tabularx} hasn't been loaded)},
topics={hooks,entryrefcommands},
note={\styfmt{glossaries}},
category={command}
@@ -15684,7 +16108,7 @@ to use in the header (leave empty for default)},
user1={\margm{label}},
description={interrupts the document build and shows the value of
the \idx{firstuseflag} in the transcript},
- topics={debugging,fieldrefcommands,conditionals},
+ topics={debugging,fieldrefcommands,conditional},
note={\styfmt{glossaries}},
category={command}
}