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.bib309
1 files changed, 284 insertions, 25 deletions
diff --git a/support/bib2gls/src/bib2gls.bib b/support/bib2gls/src/bib2gls.bib
index 6f4f6e5c4f..5d8ed65bd3 100644
--- a/support/bib2gls/src/bib2gls.bib
+++ b/support/bib2gls/src/bib2gls.bib
@@ -1568,6 +1568,28 @@ name},
category={command}
}
+@bibglscommand{bibglsdefinitionindex,
+ name={\csfmt{bib\-gls\-definition\-index}},
+ user1={\margm{label}},
+ description={expands to the definition index of the entry
+ identified \meta{label} if \csopt{save-definition-index} is set
+ otherwise expands to empty},
+ topics={fieldrefcommands},
+ note={\bibgls\texparserdefnote},
+ category={command}
+}
+
+@bibglscommand{bibglsuseindex,
+ name={\csfmt{bib\-gls\-use\-index}},
+ user1={\margm{label}},
+ description={expands to the order of use index of the entry
+ identified \meta{label} if \csopt{save-use-index} is set and
+ the entry has records otherwise expands to empty},
+ topics={fieldrefcommands},
+ note={\bibgls\texparserdefnote},
+ category={command}
+}
+
@mainglscommand{glsexpandfields,
name={\csfmt{gls\-expand\-fields}},
user1={},
@@ -2071,6 +2093,34 @@ starred version \csref{glsxtrfmt*}},
parent={resourceoptions}
}
+@resourceoption{opt.secondary-match,
+ name={\csoptfmt{secondary\dhyphen match}},
+ user1={\meta{\keyvallist}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.secondary-match-op,
+ name={\csoptfmt{secondary\dhyphen match\dhyphen op}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.secondary-match-action,
+ name={\csoptfmt{secondary\dhyphen match\dhyphen action}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.secondary-not-match,
+ name={\csoptfmt{secondary\dhyphen not\dhyphen match}},
+ user1={\meta{\keyvallist}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@resourceoption{opt.limit,
name={\csoptfmt{limit}},
user1={\meta{number}},
@@ -2303,6 +2353,34 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@resourceoption{opt.save-definition-index,
+ name={\csoptfmt{save\dhyphen definition\dhyphen index}},
+ user1={\meta{boolean}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.save-use-index,
+ name={\csoptfmt{save\dhyphen use\dhyphen index}},
+ user1={\meta{boolean}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.format-integer-fields,
+ name={\csoptfmt{format\dhyphen integer\dhyphen fields}},
+ user1={\margm{\keyvallist}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.format-decimal-fields,
+ name={\csoptfmt{format\dhyphen decimal\dhyphen fields}},
+ user1={\margm{\keyvallist}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@resourceoption{opt.short-case-change,
name={\csoptfmt{short\dhyphen case\dhyphen change}},
user1={\meta{value}},
@@ -2366,6 +2444,13 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@resourceoption{opt.encapsulate-sort,
+ name={\csoptfmt{encapsulate\dhyphen sort}},
+ user1={\marg{csname}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@resourceoption{opt.prefix-fields,
name={\csoptfmt{prefix\dhyphen fields}},
user1={\meta{list}},
@@ -2548,6 +2633,13 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@resourceoption{opt.save-principal-locations,
+ name={\csoptfmt{save\dhyphen principal\dhyphen locations}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@resourceoption{opt.primary-location-formats,
name={\csoptfmt{primary\dhyphen location\dhyphen formats}},
user1={\meta{list}},
@@ -2555,6 +2647,13 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@resourceoption{opt.principal-location-formats,
+ name={\csoptfmt{principal\dhyphen location\dhyphen formats}},
+ user1={\meta{list}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@resourceoption{opt.min-loc-range,
name={\csoptfmt{min\dhyphen loc\dhyphen range}},
user1={\meta{value}},
@@ -2646,6 +2745,34 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@resourceoption{opt.save-from-alias,
+ name={\csoptfmt{save\dhyphen from\dhyphen alias}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.save-from-seealso,
+ name={\csoptfmt{save\dhyphen from\dhyphen seealso}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.save-from-see,
+ name={\csoptfmt{save\dhyphen from\dhyphen see}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@resourceoption{opt.save-crossref-tail,
+ name={\csoptfmt{save\dhyphen crossref\dhyphen tail}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@resourceoption{opt.supplemental-locations,
name={\csoptfmt{supplemental\dhyphen locations}},
user1={\meta{basename}},
@@ -3016,6 +3143,13 @@ format}},
parent={resourceoptions}
}
+@resourceoption{opt.prefix-only-existing,
+ name={\csoptfmt{prefix\dhyphen only\dhyphen existing}},
+ user1={\meta{boolean}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@resourceoption{opt.dual-prefix,
name={\csoptfmt{dual\dhyphen prefix}},
user1={\meta{value}},
@@ -8237,6 +8371,14 @@ field.},
parent={fields}
}
+@field{field.dualdescription,
+ name={\fieldfmt{dual\-description}},
+ description={May be used to identify a dual description},
+ note={\appfmt{bib2gls}},
+ category={bib2glsfield},
+ parent={fields}
+}
+
@field{field.access,
name={\fieldfmt{access}},
description={The replacement text for the \field{name} field.},
@@ -8389,6 +8531,22 @@ field.},
parent={internalfields}
}
+@field{field.definitionindex,
+ name={\fieldfmt{definitionindex}},
+ description={Stores the definition index.},
+ note={internal field set by \appfmt{bib2gls}},
+ category={internalfield},
+ parent={internalfields}
+}
+
+@field{field.useindex,
+ name={\fieldfmt{useindex}},
+ description={Stores the order of use index.},
+ 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
@@ -9177,6 +9335,20 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
+@switch{switch.collapse-same-location-range,
+ name={\longargfmt{collapse\dhyphen same\dhyphen location\dhyphen range}},
+ user1={},
+ category={switch},
+ parent={commandlineoptions}
+}
+
+@switch{switch.no-collapse-same-location-range,
+ name={\longargfmt{no\dhyphen collapse\dhyphen same\dhyphen location\dhyphen range}},
+ user1={},
+ category={switch},
+ parent={commandlineoptions}
+}
+
@switch{switch.merge-wrglossary-records,
name={\longargfmt{merge\dhyphen wrglossary\dhyphen records}},
user1={},
@@ -9314,6 +9486,19 @@ primary formats, if enabled.},
parent={commandlineoptions}
}
+@switch{switch.retain-formats,
+ name={\longargfmt{retain\dhyphen formats}},
+ user1={\meta{list}},
+ category={switch},
+ parent={commandlineoptions}
+}
+
+@switch{switch.no-retain-formats,
+ name={\longargfmt{no\dhyphen retain\dhyphen formats}},
+ category={switch},
+ parent={commandlineoptions}
+}
+
@switch{switch.group,
name={\longargfmt{group}},
symbol={\shortargfmt{g}},
@@ -10215,10 +10400,8 @@ primary formats, if enabled.},
name={\csfmt{gls\-see\-format}},
user1={\margm{tag}\margm{labels}\margm{location (ignored)}},
description={formats the entries identified in the comma separated
- list of labels as a set of cross-references, where each
- item in the list is encapsulated with \cs{glsseeitem} and
- each element is separated with \cs{glsseesep} or
- \cs{glsseelastsep}},
+ list of labels as a set of cross-references. This just does
+ the tag (emphasized) followed by \cs{glsseelist}\margm{labels}},
topics={formattingcommands,crossrefcommands,loclistcommands},
note={\styfmt{glossaries}},
seealso={glsseeitem,glsseeitemformat,glsseesep,glsseelastsep},
@@ -10238,6 +10421,17 @@ primary formats, if enabled.},
category={command}
}
+@glscommand{glsseefirstitem,
+ name={\csfmt{gls\-see\-first\-item}},
+ user1={\margm{label}},
+ description={as \cs{glsseeitem} but is used for the first label in
+ the list. This just does \cs{glsseeitem} by default},
+ topics={formattingcommands,crossrefcommands,loclistcommands,linkcommands},
+ note={\styfmt{glossaries-extra} v1.47+},
+ seealso={glsseeformat,glsseeitemformat},
+ category={command}
+}
+
@glscommand{glsseeitemformat,
name={\csfmt{gls\-see\-item\-format}},
user1={\margm{label}},
@@ -10273,6 +10467,16 @@ primary formats, if enabled.},
category={command}
}
+@glscommand{glsseelastoxfordsep,
+ name={\csfmt{gls\-see\-last\-oxford\-sep}},
+ description={used instead of \cs{glsseelastsep} if the list
+ contains three or more labels. This defaults to \cs{glsseelastsep}},
+ topics={separatorcommands,crossrefcommands,loclistcommands},
+ note={\styfmt{glossaries-extra} v1.47+},
+ seealso={glsseeformat,glsseesep},
+ category={command}
+}
+
@glscommand{glsxtruseseeformat,
name={\csfmt{gls\-xtr\-use\-see\-format}},
user1={\margm{tag}\margm{labels}},
@@ -11662,6 +11866,28 @@ field value},
category={command}
}
+@command{MFUwordbreak,
+ name={\csfmt{MFU\-word\-break}},
+ user1={\margm{punctuation}},
+ description={if \idx{capitalisewords} contains punctuation that
+ should be treated as a word break then \meta{punctuation}
+ should be encapsulated with this command to apply the case-change
+ to the following character},
+ note={\styfmt{mfirstuc} v2.07+\texparserdefnote},
+ category={command}
+}
+
+@command{MFUskippunc,
+ name={\csfmt{MFU\-skip\-punc}},
+ user1={\margm{punctuation}},
+ description={if \idx{makefirstuc} starts with a punctuation
+ character it should be encapsulated with this command to skip
+ \meta{punctuation} and apply the case-change to the following
+ character},
+ note={\styfmt{mfirstuc} v2.07+\texparserdefnote},
+ category={command}
+}
+
@glscommand{glsxtrusefield,
name={\csfmt{gls\-xtr\-use\-field}},
user1={\margm{entry label}\margm{field label}},
@@ -11714,6 +11940,18 @@ field value},
category={command}
}
+@glscommand{glsxtrapptocsvfield,
+ name={\csfmt{gls\-xtr\-app\-to\-csv\-field}},
+ user1={\margm{entry label}\margm{field label}\margm{value}},
+ description={appends a comma followed by \meta{value} to the given
+ field for the given entry, it that field has already been set,
+ otherwise it sets the field to just \meta{value} (there's no check
+ for the existence of either the entry or the field)},
+ topics={assigncommands},
+ note={\styfmt{glossaries-extra} v1.47+},
+ category={command}
+}
+
@glscommand{glsxtrifhasfield,
name={\csfmt{gls\-xtr\-if\-has\-field}},
user1={\margm{field label}\margm{entry label}\margm{true}\margm{false}},
@@ -11722,7 +11960,7 @@ field value},
without testing if the entry exists and adds implicit scoping
to \meta{true} and \meta{false}},
topics={conditional,fieldrefcommands},
- note={\styfmt{glossaries-extra} v1.19+},
+ note={\styfmt{glossaries-extra} v1.19+\texparserdefnote},
seealso={GlsXtrIfFieldUndef},
category={command}
}
@@ -11735,7 +11973,7 @@ field value},
without testing if the entry exists and without introducing
an implicit scope},
topics={conditional,fieldrefcommands},
- note={\styfmt{glossaries-extra} v1.19+},
+ note={\styfmt{glossaries-extra} v1.19+\texparserdefnote},
seealso={GlsXtrIfFieldUndef},
category={command}
}
@@ -11758,7 +11996,7 @@ field value},
form adds implicit grouping. The starred form (new to v1.39)
doesn't},
topics={conditional,fieldrefcommands},
- note={\styfmt{glossaries-extra} v1.21+},
+ note={\styfmt{glossaries-extra} v1.21+\texparserdefnote},
category={command}
}
@@ -11770,7 +12008,7 @@ 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={conditional,fieldrefcommands},
- note={\styfmt{glossaries-extra} v1.31+},
+ note={\styfmt{glossaries-extra} v1.31+\texparserdefnote},
category={command}
}
@@ -11782,7 +12020,7 @@ 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={conditional,fieldrefcommands},
- note={\styfmt{glossaries-extra} v1.31+},
+ note={\styfmt{glossaries-extra} v1.31+\texparserdefnote},
category={command}
}
@@ -11790,8 +12028,9 @@ doesn't},
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}},
+ given field set to a non-empty value. This is implemented in
+ \bibgls\ in the same way as \cs{glsxtrifhasfield*}},
+ note={\styfmt{glossaries}\texparserdefnote},
topics={conditional,fieldrefcommands},
seealso={glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
@@ -11804,7 +12043,7 @@ doesn't},
\field{symbol} field set to value that's not empty and not
\csfmt{relax}},
topics={conditional,fieldrefcommands},
- note={\styfmt{glossaries}},
+ note={\styfmt{glossaries}\texparserdefnote},
seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
}
@@ -11815,7 +12054,7 @@ doesn't},
description={tests if the given entry, which must be defined, has the
\field{description} field set},
topics={conditional,fieldrefcommands},
- note={\styfmt{glossaries}},
+ note={\styfmt{glossaries}\texparserdefnote},
seealso={ifglshassymbol,ifglshasdescsuppressed},
category={command}
}
@@ -11837,7 +12076,7 @@ doesn't},
description={tests if the given entry, which must be defined, has the
\field{parent} field set},
topics={conditional,fieldrefcommands},
- note={\styfmt{glossaries}},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
@@ -11850,9 +12089,11 @@ doesn't},
have \meta{entry label} as the value of the \field{parent}
field. With \bibgls, a more efficient approach is to
use \csopt{save-child-count} and test the value of
- the \field{childcount} field},
+ the \field{childcount} field. The \TeX\ parser library recognises
+ this command and will simply use the child count (regardless of
+ whether or not the child count is saved)},
topics={conditional,fieldrefcommands},
- note={\styfmt{glossaries}},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
@@ -11862,7 +12103,7 @@ doesn't},
description={tests if the given entry, which must be defined, has the
\field{short} field set},
topics={conditional,fieldrefcommands,abbreviationcommands},
- note={\styfmt{glossaries}},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
@@ -11872,7 +12113,7 @@ doesn't},
description={tests if the given entry, which must be defined, has the
\field{long} field set},
topics={conditional,fieldrefcommands,abbreviationcommands},
- note={\styfmt{glossaries}},
+ note={\styfmt{glossaries}\texparserdefnote},
category={command}
}
@@ -11928,7 +12169,7 @@ doesn't},
is the internal field label (not the key name). No expansion is
performed in the test (which just uses \cs{ifcsstring})},
topics={conditional,fieldrefcommands},
- note={\styfmt{glossaries} v4.16+},
+ note={\styfmt{glossaries} v4.16+\texparserdefnote},
category={command}
}
@@ -12054,9 +12295,10 @@ doesn't},
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}},
+\cs{glscurrentfieldvalue}. The \TeX\ parser library recognises
+ this command regardless of whether or not the child count is saved},
topics={conditional,fieldrefcommands},
- note={\styfmt{glossaries-extra-bib2gls} v1.31+},
+ note={\styfmt{glossaries-extra-bib2gls} v1.31+\texparserdefnote},
seealso={GlsXtrIfFieldNonZero},
category={command}
}
@@ -13694,6 +13936,23 @@ hasn't been defined},
category={command}
}
+@glscommand{glsseelist,
+ name={\csfmt{gls\-see\-list}},
+ user1={\margm{label list}},
+ description={iterates through the comma-separated list of entry
+ labels to produce a formatted list, where each
+ item in the list is encapsulated with \cs{glsseeitem} and
+ each element is separated with \cs{glsseesep} or
+ \cs{glsseelastsep}. This command was provided for
+ the use of \cs{glsseeformat} to format cross-reference lists
+ but may be used for any list of entry labels. This command is
+ redefined by \styfmt{glossaries-extra} (v1.47+) to additionally
+ use \cs{glsseefirstitem} and \cs{glsseelastoxfordsep}},
+ topics={formattingcommands,crossrefcommands},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
@glscommand{glsxtrsetaliasnoindex,
name={\csfmt{gls\-xtr\-set\-alias\-noindex}},
user1={},
@@ -15569,7 +15828,7 @@ has three or more items},
}
@command{MakeTextLowercase,
- name={\csfmt{MakeTextLowercase}},
+ name={\csfmt{Make\-Text\-Lower\-case}},
user1={\margm{text}},
description={converts \meta{text} to lower case},
note={\styfmt{textcase}\texparserdefnote},
@@ -15577,7 +15836,7 @@ has three or more items},
}
@command{MakeTextUppercase,
- name={\csfmt{MakeTextUppercase}},
+ name={\csfmt{Make\-Text\-Upper\-case}},
user1={\margm{text}},
description={converts \meta{text} to \idx{uppercase}},
note={\styfmt{textcase}\texparserdefnote},
@@ -15585,7 +15844,7 @@ has three or more items},
}
@command{NoCaseChange,
- name={\csfmt{NoCaseChange}},
+ name={\csfmt{No\-Case\-Change}},
user1={\margm{text}},
description={prevents \cs{MakeTextUppercase} and
\cs{MakeTextLowercase} from converting \meta{text}},
@@ -15594,7 +15853,7 @@ has three or more items},
}
@command{MakeUppercase,
- name={\csfmt{MakeUppercase}},
+ name={\csfmt{Make\-Upper\-case}},
user1={\margm{text}},
description={converts \meta{text} to \idx{uppercase}},
note={kernel command\texparserdefnote},