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.bib3293
1 files changed, 2660 insertions, 633 deletions
diff --git a/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib b/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib
index 0696be2b875..a9a463f98a0 100644
--- a/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib
+++ b/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib
@@ -42,59 +42,70 @@
category={common}
}
+@abbreviation{CJK,
+ short = {CJK},
+ long = {Chinese, Japanese, Korean languages},
+ category={common}
+}
+
+@abbreviation{encap,
+ short = {encap},
+ long = {encapsulating command}
+}
+
@dualindexentry{bibglsnewentry,
name={\csfmt{bib\-gls\-new\-entry}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
- description={defines terms provided with \gls[noindex]{dual.entry.entry}},
+ description={defines terms provided with \atentry{entry}},
category={command}
}
@dualindexentry{bibglsnewsymbol,
name={\csfmt{bib\-gls\-new\-symbol}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
- description={defines terms provided with \gls[noindex]{dual.entry.symbol}},
+ description={defines terms provided with \atentry{symbol}},
category={command}
}
@dualindexentry{bibglsnewnumber,
name={\csfmt{bib\-gls\-new\-number}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
- description={defines terms provided with \gls[noindex]{dual.entry.number}},
+ description={defines terms provided with \atentry{number}},
category={command}
}
@dualindexentry{bibglsnewindex,
name={\csfmt{bib\-gls\-new\-index}},
user1={\margm{label}\margm{options}},
- description={defines terms provided with \gls[noindex]{dual.entry.index}},
+ description={defines terms provided with \atentry{index}},
category={command}
}
@dualindexentry{bibglsnewindexplural,
name={\csfmt{bib\-gls\-new\-index\-plural}},
user1={\margm{label}\margm{options}\margm{name}},
- description={defines terms provided with \gls[noindex]{dual.entry.index}},
+ description={defines terms provided with \atentry{index}},
category={command}
}
@dualindexentry{bibglsnewabbreviation,
name={\csfmt{bib\-gls\-new\-abbreviation}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}},
- description={defines terms provided with \gls[noindex]{dual.entry.abbreviation}},
+ description={defines terms provided with \atentry{abbreviation}},
category={command}
}
@dualindexentry{bibglsnewacronym,
name={\csfmt{bib\-gls\-new\-acronym}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}},
- description={defines terms provided with \gls[noindex]{dual.entry.acronym}},
+ description={defines terms provided with \atentry{acronym}},
category={command}
}
@dualindexentry{bibglsnewdualentry,
name={\csfmt{bib\-gls\-new\-dual\-entry}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
- description={defines terms provided with \gls[noindex]{dual.entry.dualentry}},
+ description={defines terms provided with \atentry{dualentry}},
category={command}
}
@@ -102,7 +113,7 @@
name={\csfmt{bib\-gls\-new\-dual\-index\-entry}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines primary terms provided with
-\gls[noindex]{dual.entry.dualindexentry}},
+\atentry{dualindexentry}},
category={command}
}
@@ -110,7 +121,7 @@
name={\csfmt{bib\-gls\-new\-dual\-index\-entry\-secondary}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines secondary terms provided with
-\gls[noindex]{dual.entry.dualindexentry}},
+\atentry{dualindexentry}},
category={command}
}
@@ -118,7 +129,7 @@
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
-\gls[noindex]{dual.entry.dualindexsymbol}},
+\atentry{dualindexsymbol}},
category={command}
}
@@ -126,7 +137,7 @@
name={\csfmt{bib\-gls\-new\-dual\-index\-symbol\-secondary}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines secondary terms provided with
-\gls[noindex]{dual.entry.dualindexsymbol}},
+\atentry{dualindexsymbol}},
category={command}
}
@@ -134,7 +145,7 @@
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
-\gls[noindex]{dual.entry.dualindexnumber}},
+\atentry{dualindexnumber}},
category={command}
}
@@ -142,7 +153,7 @@
name={\csfmt{bib\-gls\-new\-dual\-index\-number\-secondary}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines secondary terms provided with
-\gls[noindex]{dual.entry.dualindexnumber}},
+\atentry{dualindexnumber}},
category={command}
}
@@ -150,7 +161,7 @@
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
-\gls[noindex]{dual.entry.dualindexabbreviation}},
+\atentry{dualindexabbreviation}},
category={command}
}
@@ -158,7 +169,7 @@
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
-\gls[noindex]{dual.entry.dualindexabbreviation}},
+\atentry{dualindexabbreviation}},
category={command}
}
@@ -166,7 +177,7 @@
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
-\gls[noindex]{dual.entry.dualabbreviationentry}},
+\atentry{dualabbreviationentry}},
category={command}
}
@@ -174,7 +185,7 @@
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
-\gls[noindex]{dual.entry.dualabbreviationentry}},
+\atentry{dualabbreviationentry}},
category={command}
}
@@ -182,7 +193,7 @@
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)
-\gls[noindex]{dual.entry.dualentryabbreviation}},
+\atentry{dualentryabbreviation}},
category={command}
}
@@ -190,21 +201,21 @@
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)
-\gls[noindex]{dual.entry.dualentryabbreviation}},
+\atentry{dualentryabbreviation}},
category={command}
}
@dualindexentry{bibglsnewdualsymbol,
name={\csfmt{bib\-gls\-new\-dual\-symbol}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
- description={defines terms provided with \gls[noindex]{dual.entry.dualsymbol}},
+ description={defines terms provided with \atentry{dualsymbol}},
category={command}
}
@dualindexentry{bibglsnewdualnumber,
name={\csfmt{bib\-gls\-new\-dual\-number}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
- description={defines terms provided with \gls[noindex]{dual.entry.dualnumber}},
+ description={defines terms provided with \atentry{dualnumber}},
category={command}
}
@@ -212,14 +223,14 @@
name={\csfmt{bib\-gls\-new\-dual\-abbre\-via\-tion}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}},
description={defines terms provided with
-\gls[noindex]{dual.entry.dualabbreviation}},
+\atentry{dualabbreviation}},
category={command}
}
@dualindexentry{bibglsnewdualacronym,
name={\csfmt{bib\-gls\-new\-dual\-acronym}},
user1={\margm{label}\margm{options}\margm{short}\margm{long}},
- description={defines terms provided with \gls[noindex]{dual.entry.dualacronym}},
+ description={defines terms provided with \atentry{dualacronym}},
category={command}
}
@@ -227,7 +238,7 @@
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
-\gls[noindex]{dual.entry.tertiaryindexabbreviationentry}},
+\atentry{tertiaryindexabbreviationentry}},
category={command}
}
@@ -235,14 +246,14 @@
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
-\gls[noindex]{dual.entry.tertiaryindexabbreviationentry}},
+\atentry{tertiaryindexabbreviationentry}},
category={command}
}
@dualindexentry{bibglsnewbibtexentry,
name={\csfmt{bib\-gls\-new\-bib\-tex\-entry}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
- description={defines terms provided with \gls[noindex]{dual.entry.bibtexentry}},
+ description={defines terms provided with \atentry{bibtexentry}},
category={command}
}
@@ -250,7 +261,7 @@
name={\csfmt{bib\-gls\-new\-con\-trib\-u\-tor}},
user1={\margm{label}\margm{options}\margm{name}\margm{description}},
description={defines terms provided with
- \gls[noindex]{dual.entry.contributor}},
+ \atentry{contributor}},
category={command}
}
@@ -267,7 +278,20 @@
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={provided by \styfmt{glossaries-extra} v1.21+},
+ note={\styfmt{glossaries-extra} v1.21+},
+ category={command}
+}
+
+@index{GlsXtrAutoAddOnFormat,
+ name={\csfmt{GlsXtrAutoAddOnFormat}},
+ user1={\oargm{label}\margm{format list}\margm{glsadd options}},
+ description={makes commands like \cs{gls} and \cs{glslink}
+ (but not \cs{glsadd}) automatically insert \cs{glsadd}\oargm{glsadd
+ options}\margm{label} if the format (supplied in the optional
+ argument of the invoking \cs{gls}, \cs{glslink} etc) matches any in the given
+ comma-separated elements of \meta{format list}. The format isn't automatically
+ applied to the \cs{glsadd} options},
+ note={\styfmt{glossaries-extra} v1.37+},
category={command}
}
@@ -284,7 +308,7 @@
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={provided by \styfmt{glossaries-extra} v1.21+},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -363,7 +387,7 @@
@dualindexentry{bibglsrange,
name={\csfmt{bib\-gls\-range}},
- user1={\marg{\meta{start}\gls{delimR} \meta{end}}},
+ user1={\marg{\meta{start}\cs{delimR} \meta{end}}},
description={Explicit range format},
category={command}
}
@@ -389,6 +413,14 @@
category={command}
}
+@dualindexentry{bibglsprimary,
+ name={\csfmt{bib\-gls\-primary}},
+ user1={\margm{n}\margm{locations}},
+ description={location list encapsulator used in the
+\field{primarylocations} field},
+ category={command}
+}
+
@dualindexentry{bibglspagename,
name={\csfmt{bib\-gls\-page\-name}},
user1={},
@@ -465,13 +497,13 @@
user1={\margm{label}},
description={formats the heading for the group identified by the
given label},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@dualindexentry{bibglssetlastgrouptitle,
name={\csfmt{bib\-gls\-set\-last\-group\-title}},
- user1={\margm{cs}\margm{group specs}},
+ user1={\margm{cs}\margm{specs}},
description={sets the last group title},
category={command}
}
@@ -487,7 +519,7 @@ given label},
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},
- note={provided by \styfmt{glossaries-extra} version 1.14+},
+ note={\styfmt{glossaries-extra} v1.14+},
category={command}
}
@@ -495,7 +527,7 @@ given label},
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},
- note={provided by \styfmt{glossaries-extra} version 1.24+},
+ note={\styfmt{glossaries-extra} v1.24+},
category={command}
}
@@ -600,6 +632,13 @@ character code},
category={command}
}
+@dualindexentry{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},
+ category={command}
+}
+
@dualindexentry{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}},
@@ -614,6 +653,13 @@ character code},
category={command}
}
+@dualindexentry{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},
+ category={command}
+}
+
@dualindexentry{bibglsdategroup,
name={\csfmt{bib\-gls\-date\-group}},
user1={\margm{YYYY}\margm{MM}\margm{DD}\margm{G}\margm{title}\margm{group\dhyphen id}\margm{type}},
@@ -628,6 +674,13 @@ character code},
category={command}
}
+@dualindexentry{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},
+ category={command}
+}
+
@dualindexentry{bibglstimegroup,
name={\csfmt{bib\-gls\-time\-group}},
user1={\margm{hh}\margm{mm}\margm{ss}\margm{zone}\margm{title}\margm{group\dhyphen id}\margm{type}},
@@ -688,24 +741,28 @@ name},
@dualindexentry{bibglssetwidesttoplevelfallback,
name={\csfmt{bib\-gls\-set\-widest\-top\-level\-fallback}},
user1={\margm{glossary list}},
- description={fallback used instead of \gls{bibglssetwidest}
+ description={fallback used instead of \csref{bibglssetwidest}
in the event that \bibgls\ can't determine the widest name
- where there are only top level entries},
+ where there are only top level entries,
+ where \meta{glossary list} is a comma-separated list
+ of glossary labels},
category={command}
}
@dualindexentry{bibglssetwidestfallback,
name={\csfmt{bib\-gls\-set\-widest\-fallback}},
user1={\margm{glossary list}},
- description={fallback used instead of \gls{bibglssetwidest}
- in the event that \bibgls\ can't determine the widest name},
+ 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},
category={command}
}
@dualindexentry{bibglssetwidestfortypefallback,
name={\csfmt{bib\-gls\-set\-widest\-for\-type\-fallback}},
user1={\margm{type}},
- description={fallback used instead of \gls{bibglssetwidestfortype}
+ description={fallback used instead of \csref{bibglssetwidestfortype}
in the event that \bibgls\ can't determine the widest name},
category={command}
}
@@ -713,7 +770,7 @@ name},
@dualindexentry{bibglssetwidesttoplevelfortypefallback,
name={\csfmt{bib\-gls\-set\-widest\-top\-level\-for\-type\-fallback}},
user1={\margm{type}},
- description={fallback used instead of \gls{bibglssetwidestfortype}
+ 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},
category={command}
@@ -738,29 +795,29 @@ name},
@dualindexentry{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}\marg{original}},
+ 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},
category={command}
}
@dualindexentry{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}\marg{original}},
+ 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},
category={command}
}
@dualindexentry{bibglsdatetimeremainder,
name={\csfmt{bib\-gls\-date\-time\-remainder}},
- user1={\margm{millisec}\margm{dst}\margm{zone}\marg{original}},
+ user1={\margm{millisec}\margm{dst}\margm{zone}\margm{original}},
description={used internally to pick up the final four arguments of
- \gls{bibglsdatetime}},
+ \csref{bibglsdatetime}},
category={command}
}
@dualindexentry{bibglstime,
name={\csfmt{bib\-gls\-time}},
- user1={\margm{hour}\margm{minute}\margm{second}\margm{millisec}\margm{dst}\margm{zone}\marg{original}},
+ 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},
category={command}
}
@@ -800,11 +857,86 @@ name},
category={command}
}
+@dualindexentry{bibglshrefchar,
+ name={\csfmt{bib\-gls\-href\-char}},
+ user1={\margm{hex}\margm{char}},
+ description={expands to a literal percent character followed by
+\meta{hex}},
+ category={command}
+}
+
+@dualindexentry{bibglshrefunicode,
+ name={\csfmt{bib\-gls\-href\-unicode}},
+ user1={\margm{hex}\margm{char}},
+ description={expands to \meta{char} by default},
+ category={command}
+}
+
+@dualindexentry{bibglsprimaryprefixlabel,
+ name={\csfmt{bib\-gls\-primary\-prefix\-label}},
+ user1={\margm{prefix}},
+ description={hook provided to pick up the primary prefix, if
+ required},
+ category={command}
+}
+
+@dualindexentry{bibglsdualprefixlabel,
+ name={\csfmt{bib\-gls\-dual\-prefix\-label}},
+ user1={\margm{prefix}},
+ description={hook provided to pick up the dual prefix, if
+ required},
+ category={command}
+}
+
+@dualindexentry{bibglstertiaryprefixlabel,
+ name={\csfmt{bib\-gls\-tertiary\-prefix\-label}},
+ user1={\margm{prefix}},
+ description={hook provided to pick up the tertiary prefix, if
+ required},
+ category={command}
+}
+
+@dualindexentry{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},
+ category={command}
+}
+
+@dualindexentry{bibglsuppercase,
+ name={\csfmt{bib\-gls\-upper\-case}},
+ user1={\margm{text}},
+ description={converts \meta{text} to \idx{uppercase}},
+ category={command}
+}
+
+@dualindexentry{bibglslowercase,
+ name={\csfmt{bib\-gls\-lower\-case}},
+ user1={\margm{text}},
+ description={converts \meta{text} to \idx{lowercase}},
+ category={command}
+}
+
+@dualindexentry{bibglstitlecase,
+ name={\csfmt{bib\-gls\-title\-case}},
+ user1={\margm{text}},
+ description={converts \meta{text} to \idx{titlecase}},
+ category={command}
+}
+
+@dualindexentry{bibglsfirstuc,
+ name={\csfmt{bib\-gls\-first\-uc}},
+ user1={\margm{text}},
+ description={converts the first letter of \meta{text} to \idx{uppercase}},
+ category={command}
+}
+
@dualindexentry{glsexpandfields,
name={\csfmt{gls\-expand\-fields}},
user1={},
description={switches on field expansion},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -812,7 +944,7 @@ name},
name={\csfmt{gls\-no\-expand\-fields}},
user1={},
description={switches off field expansion},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -820,7 +952,7 @@ name},
name={\csfmt{gls\-set\-expand\-field}},
user1={\margm{field}},
description={switches on field expansion for the given field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -828,7 +960,7 @@ name},
name={\csfmt{gls\-set\-no\-expand\-field}},
user1={\margm{field}},
description={switches off field expansion for the given field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -836,7 +968,7 @@ name},
name={\csfmt{new\-glossary\-entry}},
user1={\margm{label}\margm{\keyvallist}},
description={defines a new glossary entry},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -844,9 +976,9 @@ name},
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}\gls{nopostdesc} at the end of
+ \csfmt{leavemode}\csfmt{unskip}\cs{nopostdesc} at the end of
\meta{description}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -855,7 +987,7 @@ name},
user1={\margm{label}\margm{\keyvallist}\margm{description}},
description={defines a new glossary entry without appending any
extra code to the end of \meta{description}},
- note={provided by \styfmt{glossaries-extra} v1.12+},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@@ -864,7 +996,7 @@ extra code to the end of \meta{description}},
user1={\margm{label}\margm{\keyvallist}},
description={defines a new glossary entry if one doesn't
already exist with the given label},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -873,7 +1005,7 @@ extra code to the end of \meta{description}},
user1={\margm{label}\margm{\keyvallist}\margm{description}},
description={defines a new glossary entry if one doesn't
already exist with the given label},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -882,25 +1014,27 @@ extra code to the end of \meta{description}},
user1={\oargm{\keyvallist}\margm{label}},
description={defines a new glossary entry where the
\field{description} field defaults to empty},
- note={provided by the \styfmt{glossaries}'s \styopt{index} package
+ note={the \styfmt{glossaries}'s \styopt{index} package
option},
category={command}
}
@dualindexentry{newabbreviation,
- name={\csfmt{new\-abbreviation}},
+ name={\csfmt{new\-abbre\-vi\-a\-tion}},
user1={\oargm{\keyvallist}\margm{label}\margm{short}\margm{long}},
description={defines a new abbreviation},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@dualindexentry{newacronym,
name={\csfmt{new\-acronym}},
user1={\oargm{\keyvallist}\margm{label}\margm{short}\margm{long}},
- description={defines a new abbreviation with the
- \field{category} set to \code{acronym}},
- note={provided by \styfmt{glossaries}},
+ description={defines a new abbreviation. The
+ \styfmt{glossaries-extra} package redefines this to use
+ \csref{newabbreviation} with the \field{category} set to
+ \code{acronym}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -908,8 +1042,7 @@ option},
name={\csfmt{gls\-xtr\-new\-symbol}},
user1={\oargm{\keyvallist}\margm{label}\margm{symbol}},
description={defines a new symbol},
- note={provided by \styfmt{glossaries-extra}'s \styopt{symbols}
-package option},
+ note={\styfmt{glossaries-extra} \styopt{symbols}},
category={command}
}
@@ -917,8 +1050,7 @@ package option},
name={\csfmt{gls\-xtr\-new\-number}},
user1={\oargm{\keyvallist}\margm{label}},
description={defines a new number},
- note={provided by \styfmt{glossaries-extra}'s \styopt{numbers}
-package option},
+ note={\styfmt{glossaries-extra} \styopt{numbers}},
category={command}
}
@@ -932,9 +1064,9 @@ package option},
@dualindexentry{@gls@hypergroup,
name={\csfmt{@gls@hypergroup}},
user1={\margm{type}\margm{group id}},
- description={identifies that the given group was used in the
+ description={command written to the \ext{aux} file that identifies that the given group was used in the
glossary on the previous run},
- note={internal command provided by \styfmt{glossary-hypernav}},
+ note={\styfmt{glossary-hypernav}},
category={command}
}
@@ -942,9 +1074,9 @@ package option},
name={\csfmt{glsxtr@resource}},
user1={\margm{options}\margm{filename}},
description={this internal command is written to the \ext{aux}
-file by \gls{glsxtrresourcefile}
+file by \csref{glsxtrresourcefile}
to provide \bibgls\ with the resource information},
- note={internal command provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.08+},
category={command}
}
@@ -953,8 +1085,7 @@ file by \gls{glsxtrresourcefile}
user1={\margm{n}\margm{page}},
description={This command simply expands to \meta{n}, the value of
the \counter{wrglossary} counter for the given page},
- note={internal command provided by
- \styfmt{glossaries-extra-bib2gls} v1.29+},
+ note={\styfmt{glossaries-extra-bib2gls} v1.29+},
category={command}
}
@@ -963,8 +1094,7 @@ the \counter{wrglossary} counter for the given page},
user1={\margm{text}\margm{label}},
description={Creates a hyperlink to the \counter{wrglossary}
location obtained from the \field{indexcounter} field},
- note={internal command provided by
- \styfmt{glossaries-extra-bib2gls} v1.29+},
+ note={\styfmt{glossaries-extra-bib2gls} v1.29+},
category={command}
}
@@ -972,9 +1102,8 @@ location obtained from the \field{indexcounter} field},
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 \gls{GlsXtrDualField}},
- note={internal command provided by
- \styfmt{glossaries-extra-bib2gls} v1.30+},
+ obtained from the field given by \csref{GlsXtrDualField}},
+ note={\styfmt{glossaries-extra-bib2gls} v1.30+},
category={command}
}
@@ -982,10 +1111,9 @@ location obtained from the \field{indexcounter} field},
name={\csfmt{Gls\-Xtr\-Dual\-Field}},
user1={},
description={The field used to store the dual label. This defaults
- to \gls{field.dual} but will need to be redefined if a different
+ to \field{dual} but will need to be redefined if a different
value is given by \csopt{dual-field}},
- note={internal command provided by
- \styfmt{glossaries-extra-bib2gls} v1.30+},
+ note={\styfmt{glossaries-extra-bib2gls} v1.30+},
category={command}
}
@@ -995,37 +1123,37 @@ location obtained from the \field{indexcounter} field},
description={formats the given text according to the formatting
command identified by the value of the field obtained
from \cs{GlsXtrFmtField}},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@dualindexentry{glsxtrfmt*,
name={\csfmt{gls\-xtr\-fmt*}},
user1={\oargm{options}\margm{label}\margm{text}\oargm{insert}},
- description={like \cs{glsxtrfmt} but inserts extra
+ description={like \csref{glsxtrfmt} but inserts extra
material into the link text but outside of the formatting command},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.23+},
category={command}
}
@dualindexentry{glsxtrentryfmt,
name={\csfmt{gls\-xtr\-entry\-fmt}},
user1={\margm{label}\margm{text}},
- description={alternative to \cs{glsxtrfmt} for use in
+ description={alternative to \csref{glsxtrfmt} for use in
section headings},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@index{glsxtrfmtdisplay,
name={\csfmt{gls\-xtr\-fmt\-display}},
- user1={\margm{cs-name}\margm{text}\oargm{insert}},
- description={used by \cs{glsxtrfmt} to format the given
+ user1={\margm{cs-name}\margm{text}\margm{insert}},
+ description={used by \csref{glsxtrfmt} to format the given
\meta{text} where \meta{cs-name} is obtained from the field
identified by \cs{GlsXtrFmtField} and \meta{insert} is empty for the
-unstarred \gls{glsxtrfmt} and the final optional argument of the
-starred version \gls{glsxtrfmt*}},
- note={provided by \styfmt{glossaries-extra}},
+unstarred \csref{glsxtrfmt} and the final optional argument of the
+starred version \csref{glsxtrfmt*}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -1034,11 +1162,12 @@ starred version \gls{glsxtrfmt*}},
user1={\oargm{options}\margm{filename}},
description={input the \ext{glstex} file created by \bibgls\ and
write resource instructions to the \ext{aux} file},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.08+},
seealso={resourceoptions,GlsXtrLoadResources},
category={command}
}
+
@index{resourceoptions,
name={resource options},
text={resource option}
@@ -1163,6 +1292,13 @@ starred version \gls{glsxtrfmt*}},
parent={resourceoptions}
}
+@dualindexentry{opt.dependency-fields,
+ name={\csoptfmt{dependency\dhyphen fields}},
+ user1={\meta{list}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@dualindexentry{opt.labelify-replace,
name={\csoptfmt{labelify\dhyphen replace}},
user1={\meta{list}},
@@ -1479,6 +1615,13 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@dualindexentry{opt.long-case-change,
+ name={\csoptfmt{long\dhyphen case\dhyphen change}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@dualindexentry{opt.name-case-change,
name={\csoptfmt{name\dhyphen case\dhyphen change}},
user1={\meta{value}},
@@ -1493,6 +1636,13 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@dualindexentry{opt.word-boundaries,
+ name={\csoptfmt{word\dhyphen boundaries}},
+ user1={\meta{list}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@dualindexentry{opt.post-description-dot,
name={\csoptfmt{post\dhyphen description\dhyphen dot}},
user1={\meta{value}},
@@ -1502,7 +1652,7 @@ field\dhyphen locale}},
@dualindexentry{opt.strip-trailing-nopost,
name={\csoptfmt{strip\dhyphen trailing\dhyphen nopost}},
- user1={\meta{value}},
+ user1={\meta{boolean}},
category={resourceoption},
parent={resourceoptions}
}
@@ -1514,6 +1664,13 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@dualindexentry{opt.sort-label-list,
+ name={\csoptfmt{sort\dhyphen label\dhyphen list}},
+ user1={\meta{list}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@dualindexentry{opt.group,
name={\csoptfmt{group}},
user1={\meta{label}},
@@ -1577,6 +1734,20 @@ field\dhyphen locale}},
parent={resourceoptions}
}
+@dualindexentry{opt.save-primary-locations,
+ name={\csoptfmt{save\dhyphen primary\dhyphen locations}},
+ user1={\meta{value}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
+@dualindexentry{opt.primary-location-formats,
+ name={\csoptfmt{primary\dhyphen location\dhyphen formats}},
+ user1={\meta{list}},
+ category={resourceoption},
+ parent={resourceoptions}
+}
+
@dualindexentry{opt.min-loc-range,
name={\csoptfmt{min\dhyphen loc\dhyphen range}},
user1={\meta{value}},
@@ -2031,6 +2202,13 @@ format}},
parent={resourceoptions}
}
+@dualindexentry{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,
name={\csoptfmt{dual\dhyphen field}},
user1={\meta{value}},
@@ -2350,8 +2528,8 @@ pattern}},
@dualindexentry{GlsXtrLoadResources,
name={\csfmt{Gls\-Xtr\-Load\-Resources}},
user1={\oargm{options}},
- description={a shortcut command that uses \gls[noindex]{glsxtrresourcefile}},
- note={provided by \styfmt{glossaries-extra}},
+ description={a shortcut command that uses \csref{glsxtrresourcefile}},
+ note={\styfmt{glossaries-extra} v1.11+},
seealso={resourceoptions,glsxtrresourcefile},
category={command}
}
@@ -2361,7 +2539,7 @@ pattern}},
user1={\margm{label}\margm{type}},
description={copies the entry given by \meta{label} to the
glossary given by \meta{type}},
- note={provided by \styfmt{glossaries-extra} v1.12+},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@@ -2372,7 +2550,7 @@ 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},
- note={provided by \styfmt{glossaries-extra} v1.21+},
+ note={\styfmt{glossaries-extra} v1.21+},
seealso={glsxtrnewgls},
category={command}
}
@@ -2382,7 +2560,7 @@ cs}\margm{Glspl-like cs}},
user1={\oargm{options}\margm{prefix}\margm{cs}},
description={defines the command \meta{cs} to behave like
\ics{gls} with the given label prefix},
- note={provided by \styfmt{glossaries-extra} v1.21+},
+ note={\styfmt{glossaries-extra} v1.21+},
seealso={gls},
category={command}
}
@@ -2390,9 +2568,18 @@ cs}\margm{Glspl-like cs}},
@dualindexentry{glsnoidxdisplayloc,
name={\csfmt{gls\-no\-idx\-display\-loc}},
user1={\margm{prefix}\margm{counter}\margm{format}\margm{location}},
- description={handler used to display the number list stored in
- the \field{loclist} field},
- note={provided by \styfmt{glossaries}},
+ description={used to display a regular location in the
+ \field{location} field},
+ note={\styfmt{glossaries} v4.04+},
+ category={command}
+}
+
+@dualindexentry{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},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
category={command}
}
@@ -2401,16 +2588,50 @@ cs}\margm{Glspl-like cs}},
user1={\margm{prefix}\margm{counter}\margm{format}\margm{src}\margm{location}},
description={used to display an external location in the
supplementary list},
- note={provided by \styfmt{glossaries-extra-bib2gls} v1.36+},
+ note={\styfmt{glossaries-extra-bib2gls} v1.36+},
category={command}
}
@dualindexentry{glsxtrmultisupplocation,
name={\csfmt{gls\-xtr\-multi\-supp\-location}},
user1={\margm{location}\margm{src}\margm{format}},
- description={used by \gls{glsxtrdisplaysupploc} to format the
+ description={used by \csref{glsxtrdisplaysupploc} to format the
external location},
- note={provided by \styfmt{glossaries-extra-bib2gls} v1.36+},
+ note={\styfmt{glossaries-extra-bib2gls} v1.36+},
+ category={command}
+}
+
+@index{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}},
+ note={\styfmt{glossaries-extra} v1.14+},
+ seealso={glshypernumber,glsxtrsupphypernumber,glsxtrmultisupplocation,glsxtrlocationhyperlink},
+ category={command}
+}
+
+@index{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}},
+ note={\styfmt{glossaries-extra} v1.14+},
+ seealso={glsxtrsupphypernumber,glsxtrsupplocationurl},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossaries-extra} v1.14+},
+ seealso={glsxtrlocationhyperlink,glsxtrsupplocationurl},
category={command}
}
@@ -2419,7 +2640,16 @@ cs}\margm{Glspl-like cs}},
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},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries-extra} v1.08+},
+ category={command}
+}
+
+@dualindexentry{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},
+ note={\styfmt{glossaries-extra} v1.37+},
category={command}
}
@@ -2428,7 +2658,7 @@ cs}\margm{Glspl-like cs}},
user1={\margm{label}\margm{field}\margm{item}},
description={adds the given item to the given field that contains
an \styfmt{etoolbox} internal list},
- note={provided by \styfmt{glossaries-extra} v1.12+},
+ note={\styfmt{glossaries-extra} v1.12+},
seealso={glsxtrfieldifinlist,glsxtrfieldforlistloop,glsxtrfielddolistloop},
category={command}
}
@@ -2438,7 +2668,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},
- note={provided by \styfmt{glossaries-extra} v1.12+},
+ note={\styfmt{glossaries-extra} v1.12+},
seealso={glsxtrfieldxifinlist,glsxtrfieldlistadd,glsxtrfieldforlistloop,glsxtrfielddolistloop},
category={command}
}
@@ -2448,16 +2678,210 @@ 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},
- note={provided by \styfmt{glossaries-extra} v1.12+},
+ note={\styfmt{glossaries-extra} v1.12+},
seealso={glsxtrfieldifinlist},
category={command}
}
+@index{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)},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{glsxtrspacerules,
+ name={\csfmt{gls\-xtr\-space\-rules}},
+ user1={},
+ description={collation sub-rule for space characters},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{glsxtrnonprintablerules,
+ name={\csfmt{gls\-xtr\-non\-printable\-rules}},
+ user1={},
+ description={collation sub-rule for non-printable characters},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{glsxtrcombiningdiacriticrules,
+ name={\csfmt{gls\-xtr\-combining\-diacritic\-rules}},
+ user1={},
+ description={collation sub-rule for combining diacritic characters},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{glsxtrhyphenrules,
+ name={\csfmt{gls\-xtr\-hyphen\-rules}},
+ user1={},
+ description={collation sub-rule for hyphen characters},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{glsxtrgeneralpuncrules,
+ name={\csfmt{gls\-xtr\-general\-punc\-rules}},
+ user1={},
+ description={collation sub-rule for general punctuation characters},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{glsxtrfractionrules,
+ name={\csfmt{gls\-xtr\-fraction\-rules}},
+ user1={},
+ description={collation sub-rule for vulgar fraction characters},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{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)},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{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)},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ seealso={glsxtrGeneralLatinIIrules,glsxtrGeneralLatinIIIrules,glsxtrGeneralLatinIVrules,glsxtrGeneralLatinVrules,glsxtrGeneralLatinVIrules,glsxtrGeneralLatinVIIrules,glsxtrGeneralLatinVIIIrules},
+ category={command}
+}
+
+@index{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})},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{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})},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{glsxtrGeneralLatinIVrules,
+ name={\csfmt{gls\-xtr\-General\-Latin\-IV\-rules}},
+ user1={},
+ description={collation sub-rule for Latin characters
+(as \cs{glsxtrGeneralLatinIrules} but includes \DH/\dh\ between D/d
+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})},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{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})},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{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})},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{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
+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\
+(wynn) as W/w},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{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
+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},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{glsxtrLatinAA,
+ name={\csfmt{gls\-xtr\-Latin\-AA}},
+ user1={},
+ description={collation sub-rule for \AA/\aa},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{glsxtrLatinOslash,
+ name={\csfmt{gls\-xtr\-Latin\-O\-slash}},
+ user1={},
+ description={collation sub-rule for \O/\o},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
@index{alpha,
name={\csfmt{alpha}},
user1={},
description={Greek letter alpha $\alpha$},
- note={kernel command (maths mode only)},
+ note={kernel command (maths mode)},
+ category={command}
+}
+
+@index{pi,
+ name={\csfmt{pi}},
+ user1={},
+ description={Greek letter pi $\pi$},
+ note={kernel command (maths mode)},
category={command}
}
@@ -2465,7 +2889,7 @@ cs}\margm{Glspl-like cs}},
name={\csfmt{omicron}},
user1={},
description={Greek letter omicron $\omicron$},
- note={provided by \styfmt{glossaries-extra-bib2gls}},
+ note={\styfmt{glossaries-extra-bib2gls}},
category={command}
}
@@ -2473,21 +2897,61 @@ cs}\margm{Glspl-like cs}},
name={\csfmt{Alpha}},
user1={},
description={Greek letter alpha $\Alpha$},
- note={provided by \styfmt{glossaries-extra-bib2gls}},
+ note={\styfmt{glossaries-extra-bib2gls}},
+ category={command}
+}
+
+@index{approx,
+ name={\csfmt{approx}},
+ user1={},
+ description={approximate symbol $\approx$},
+ note={kernel command (maths mode)},
+ category={command}
+}
+
+@index{surd,
+ name={\csfmt{surd}},
+ user1={},
+ description={surd symbol $\surd$},
+ note={kernel command (maths mode)},
+ category={command}
+}
+
+@index{triangleright,
+ name={\csfmt{triangle\-right}},
+ user1={},
+ description={right-pointing triangle $\triangleright$},
+ note={kernel command (maths mode)},
+ category={command}
+}
+
+@index{textstyle,
+ name={\csfmt{text\-style}},
+ user1={},
+ description={switch to in-line maths style (vertically compact)},
+ note={kernel command (maths mode)},
category={command}
}
-@index{bigoperatornamefmt,
- name={\csfmt{bigoperatornamefmt}},
+@index{displaystyle,
+ name={\csfmt{display\-style}},
+ user1={},
+ description={switch to display maths style},
+ note={kernel command (maths mode)},
+ category={command}
+}
+
+@dualindexentry{bigoperatornamefmt,
+ name={\csfmt{big\-operator\-name\-fmt}},
user1={\margm{text}},
- description={custom command},
+ description={example command},
category={command}
}
-@index{nary,
+@dualindexentry{nary,
name={\csfmt{nary}},
user1={\margm{text}},
- description={custom command},
+ description={example command},
category={command}
}
@@ -2498,6 +2962,13 @@ cs}\margm{Glspl-like cs}},
category={command}
}
+@dualindexentry{parenswap,
+ name={\csfmt{parenswap}},
+ user1={\margm{text1}\margm{text2}},
+ description={example command},
+ category={command}
+}
+
@dualindexentry{sortop,
name={\csfmt{sortop}},
user1={\margm{text1}\margm{text2}},
@@ -2608,73 +3079,79 @@ cs}\margm{Glspl-like cs}},
text={file format}
}
-@index{tex,
+@index{ext.tex,
name={\extfmt{tex}},
category={fileformat},
parent={fileformats}
}
-@index{bib,
+@index{ext.bib,
name={\extfmt{bib}},
category={fileformat},
parent={fileformats}
}
-@index{aux,
+@index{ext.aux,
name={\extfmt{aux}},
category={fileformat},
parent={fileformats}
}
-@index{out,
+@index{ext.out,
name={\extfmt{out}},
category={fileformat},
parent={fileformats}
}
-@index{sh,
+@index{ext.sh,
name={\extfmt{sh}},
category={fileformat},
parent={fileformats}
}
-@index{bat,
+@index{ext.bat,
name={\extfmt{bat}},
category={fileformat},
parent={fileformats}
}
-@index{jar,
+@index{ext.jar,
name={\extfmt{jar}},
category={fileformat},
parent={fileformats}
}
-@index{glg,
+@index{ext.glg,
name={\extfmt{glg}},
category={fileformat},
parent={fileformats}
}
-@index{log,
+@index{ext.log,
name={\extfmt{log}},
category={fileformat},
parent={fileformats}
}
-@index{toc,
+@index{ext.toc,
name={\extfmt{toc}},
category={fileformat},
parent={fileformats}
}
-@index{glstex,
+@index{ext.glstex,
name={\extfmt{glstex}},
category={fileformat},
parent={fileformats}
}
-@index{bbl,
+@index{ext.gls,
+ name={\extfmt{gls}},
+ category={fileformat},
+ parent={fileformats}
+}
+
+@index{ext.bbl,
name={\extfmt{bbl}},
category={fileformat},
parent={fileformats}
@@ -2698,7 +3175,7 @@ cs}\margm{Glspl-like cs}},
}
@index{makeindex,
- name={\appfmt{makeindex}},
+ name={\appfmt{make\-index}},
category={application},
parent={applications}
}
@@ -2852,6 +3329,12 @@ cs}\margm{Glspl-like cs}},
parent={packages}
}
+@index{mfirstuc-english,
+ name={\styfmt{mfirstuc-english}},
+ category={package},
+ parent={packages}
+}
+
@index{hyperref,
name={\styfmt{hyperref}},
category={package},
@@ -2924,6 +3407,12 @@ cs}\margm{Glspl-like cs}},
parent={packages}
}
+@index{glossary-longextra,
+ name={\styfmt{glossary\dhyphen longextra}},
+ category={package},
+ parent={packages}
+}
+
@index{booktabs,
name={\styfmt{booktabs}},
category={package},
@@ -3089,7 +3578,10 @@ cs}\margm{Glspl-like cs}},
}
@index{cs.hash,
- name={\csfmt{\#}}
+ name={\csfmt{\#}},
+ description={produces the hash symbol \#},
+ note={kernel command},
+ category={command}
}
@index{colsep,
@@ -3103,7 +3595,10 @@ cs}\margm{Glspl-like cs}},
}
@index{cs.amp,
- name={\csfmt{\&}}
+ name={\csfmt{\&}},
+ description={produces the ampersand symbol \&},
+ note={kernel command},
+ category={command}
}
@index{bgroupchar,
@@ -3117,7 +3612,10 @@ cs}\margm{Glspl-like cs}},
}
@index{cs.openbrace,
- name={\csfmt{\{}}
+ name={\csfmt{\{}},
+ description={produces the open brace symbol \{},
+ note={kernel command},
+ category={command}
}
@index{egroupchar,
@@ -3131,7 +3629,10 @@ cs}\margm{Glspl-like cs}},
}
@index{cs.closebrace,
- name={\csfmt{\}}}
+ name={\csfmt{\}}},
+ description={produces the close brace symbol \}},
+ note={kernel command},
+ category={command}
}
@index{commentchar,
@@ -3145,7 +3646,10 @@ cs}\margm{Glspl-like cs}},
}
@index{cs.percent,
- name={\csfmt{\%}}
+ name={\csfmt{\%}},
+ description={produces the percent symbol \%},
+ note={kernel command},
+ category={command}
}
@index{sbchar,
@@ -3159,7 +3663,10 @@ cs}\margm{Glspl-like cs}},
}
@index{cs.underscore,
- name={\csfmt{\_}}
+ name={\csfmt{\_}},
+ description={produces the underscore symbol \_},
+ note={kernel command},
+ category={command}
}
@index{spchar,
@@ -3191,7 +3698,10 @@ cs}\margm{Glspl-like cs}},
}
@index{cs.dollar,
- name={\csfmt{\$}}
+ name={\csfmt{\$}},
+ description={produces the dollar symbol \_},
+ note={kernel command},
+ category={command}
}
@index{escchar,
@@ -3208,6 +3718,14 @@ cs}\margm{Glspl-like cs}},
name={\csfmt{\glsbackslash}}
}
+@index{tabularnewline,
+ name={\csfmt{tabular\-new\-line}},
+ description={tabular version of \idx{cs.backslash} (avoids conflict
+with forced line breaks in paragraph column formats)},
+ note={kernel command},
+ category={command}
+}
+
@index{nbspchar,
name={\code{\glstildechar} (non-breakable space)},
text={\code{\glstildechar}}
@@ -3218,8 +3736,34 @@ cs}\margm{Glspl-like cs}},
text={\code{\glstildechar}}
}
+@index{doublequotechardelim,
+ name = {\code{"} (delimiter)},
+ text = {\code{"}}
+}
+
+@index{doublequotecharhex,
+ name = {\code{"} (hexadecimal identifier)},
+ text = {\code{"}}
+}
+
+@index{doublequoteactivechar,
+ name = {\code{"} (active)},
+ text = {\code{"}}
+}
+
@index{doublequotechar,
- name = {\code{"}}
+ name = {\code{"} (literal)},
+ text = {\code{"}}
+}
+
+@index{openrange,
+ name = {\code{(} (start range)},
+ text = {\code{(}}
+}
+
+@index{closerange,
+ name = {\code{)} (end range)},
+ text = {\code{)}}
}
@index{cs.tilde,
@@ -3230,12 +3774,29 @@ cs}\margm{Glspl-like cs}},
category={command}
}
+@index{comma,
+ name={\csfmt{,}},
+ description={thin space},
+ note={kernel command},
+ category={command}
+}
+
+@index{vec,
+ name={\csfmt{vec}},
+ user1={\margm{character}},
+ description={puts right arrow accent over \meta{character}},
+ note={kernel command (maths mode)},
+ category={command}
+}
+
@index{zeroormore,
- name={\code{*} (regular expression, zero or more)}
+ name={\code{*} (regular expression, zero or more)},
+ text={\code{*}}
}
@index{matchanydot,
- name={\code{.}\ (regular expression, match any)}
+ name={\code{.}\ (regular expression, match any)},
+ text={\code{.}}
}
@index{periodchar,
@@ -3249,14 +3810,65 @@ cs}\margm{Glspl-like cs}},
}
@index{cs.space,
- name={\csfmt{\textvisiblespace}}
+ name={\csfmt{\textvisiblespace}},
+ description={produces an inter-word space},
+ note={kernel command},
+ category={command}
+}
+
+@index{space,
+ name={\csfmt{space}},
+ description={produces a space},
+ note={kernel command},
+ category={command}
+}
+
+@index{aposchar,
+ name={\code{'} (apostrophe)},
+ text={\code{'}},
+ alias={apostrophe}
+}
+
+@index{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},
+ category={command}
+}
+
+@index{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},
+ category={command}
+}
+
+@index{ifstrempty,
+ name={\csfmt{if\-str\-empty}},
+ user1={\margm{string}\margm{true}\margm{false}},
+ description={tests if \meta{string} is empty},
+ note={\styfmt{etoolbox}},
+ category={command}
+}
+
+@index{ifstrequal,
+ name={\csfmt{if\-str\-equal}},
+ user1={\margm{string1}\margm{string2}\margm{true}\margm{false}},
+ description={tests if \meta{string1} equals \meta{string2}},
+ note={\styfmt{etoolbox}},
+ category={command}
}
@index{undef,
name={\csfmt{undef}},
user1={\meta{cs}},
description={undefines the control sequence \meta{cs}},
- note={provided by \styfmt{etoolbox}},
+ note={\styfmt{etoolbox}},
category={command}
}
@@ -3266,7 +3878,26 @@ cs}\margm{Glspl-like cs}},
description={defines the control sequence whose name
is given by \meta{cs-name}, without checking if the command
already exists},
- note={provided by \styfmt{etoolbox}},
+ note={\styfmt{etoolbox}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{newrobustcmd,
+ name={\csfmt{new\-robust\-cmd}},
+ user1={\margm{cs}\oargm{n}\oargm{def}\margm{code}},
+ description={behaves like \cs{newcommand} but the newly defined
+command will be robust},
+ note={\styfmt{etoolbox}},
category={command}
}
@@ -3274,7 +3905,7 @@ cs}\margm{Glspl-like cs}},
name={\csfmt{if\-def\-empty}},
user1={\margm{cs}\margm{true}\margm{false}},
description={tests if the control sequence \meta{cs} is empty},
- note={provided by \styfmt{etoolbox}},
+ note={\styfmt{etoolbox}},
category={command}
}
@@ -3283,7 +3914,7 @@ cs}\margm{Glspl-like cs}},
user1={\margm{cs-name}\margm{true}\margm{false}},
description={tests if the control sequence given by \meta{cs-name}
is undefined},
- note={provided by \styfmt{etoolbox}},
+ note={\styfmt{etoolbox}},
category={command}
}
@@ -3292,7 +3923,15 @@ is undefined},
user1={\margm{cs-name}\margm{true}\margm{false}},
description={tests if the control sequence given by \meta{cs-name}
is defined},
- note={provided by \styfmt{etoolbox}},
+ note={\styfmt{etoolbox}},
+ category={command}
+}
+
+@index{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}},
category={command}
}
@@ -3301,7 +3940,7 @@ is defined},
user1={\margm{element}\margm{list cs}\margm{true}\margm{false}},
description={tests if the expansion of \meta{element} is in the list stored
in the control sequence \meta{list cs}},
- note={provided by \styfmt{etoolbox}},
+ note={\styfmt{etoolbox}},
category={command}
}
@@ -3310,7 +3949,7 @@ is defined},
user1={\margm{element}\margm{list cs}\margm{true}\margm{false}},
description={tests if \meta{element} is in the list stored
in the control sequence \meta{list cs}},
- note={provided by \styfmt{etoolbox}},
+ note={\styfmt{etoolbox}},
category={command}
}
@@ -3319,7 +3958,7 @@ is defined},
user1={\margm{list cs}\margm{element}},
description={globally adds (expanded) \meta{element} to the list stored
in the control sequence \meta{list cs}},
- note={provided by \styfmt{etoolbox}},
+ note={\styfmt{etoolbox}},
category={command}
}
@@ -3328,7 +3967,26 @@ is defined},
user1={\margm{list cs}\margm{element}},
description={globally adds \meta{element} to the list stored
in the control sequence \meta{list cs}},
- note={provided by \styfmt{etoolbox}},
+ note={\styfmt{etoolbox}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{forlistloop,
+ name={\csfmt{for\-list\-loop}},
+ user1={\margm{handler cs}\margm{list cs}},
+ description={iterates over the internal list given by the command
+ \meta{list cs} and performs \meta{handler cs}\margm{element} for
+ each element},
+ note={\styfmt{etoolbox}},
category={command}
}
@@ -3337,7 +3995,39 @@ is defined},
user1={\margm{language name}\margm{text}},
description={typesets \meta{text} according to the rules of the
given language},
- note={provided by \styfmt{babel}},
+ note={\styfmt{babel}},
+ category={command}
+}
+
+@index{selectlanguage,
+ name={\csfmt{select\-language}},
+ user1={\margm{language name}},
+ description={switch to the rules of the given language},
+ note={\styfmt{babel} and \styfmt{polyglossia}},
+ category={command}
+}
+
+@index{setmainlanguage,
+ name={\csfmt{set\-main\-language}},
+ user1={\oargm{options}\margm{language name}},
+ description={load the main document language},
+ note={\styfmt{polyglossia}},
+ category={command}
+}
+
+@index{setotherlanguage,
+ name={\csfmt{set\-other\-language}},
+ user1={\oargm{options}\margm{language name}},
+ description={load a secondary document language},
+ note={\styfmt{polyglossia}},
+ category={command}
+}
+
+@index{textlanguage,
+ name={\csfmt{text\-\meta{language}}},
+ user1={\oargm{options}\margm{text}},
+ description={typeset \meta{text} according to \meta{language}},
+ note={\styfmt{polyglossia}},
category={command}
}
@@ -3454,6 +4144,12 @@ given language},
parent={abbreviationstyles}
}
+@index{long-em-short-em,
+ name={\abbrstylefmt{long\dhyphen em\dhyphen short\dhyphen em}},
+ category={abbreviationstyle},
+ parent={abbreviationstyles}
+}
+
@index{long-short-desc,
name={\abbrstylefmt{long\dhyphen short\dhyphen desc}},
category={abbreviationstyle},
@@ -3798,6 +4494,11 @@ hyphen}},
category={counter}
}
+@index{ctr.chapter,
+ name={\counterfmt{chapter}},
+ category={counter}
+}
+
@index{ctr.wrglossary,
name={\counterfmt{wrglossary}},
category={counter}
@@ -3847,10 +4548,12 @@ hyphen}},
user1={\meta{value}},
description={unless the value is \styoptfmt{off}, this option sets
up \styfmt{glossaries-extra} for use with \bibgls: \styoptfmt{only}
- (assumed if no \meta{value} supplied, indexing performed by
- \bibgls) and \styoptfmt{alsoindex} (\bibgls\ is used to provide
+ (assumed if no \meta{value} supplied) indexing is performed by
+ \bibgls; \styoptfmt{nameref} (\sty{glossaries-extra} v1.37+)
+ like \styoptfmt{only} but includes extra information in the records;
+ \styoptfmt{alsoindex} (hybrid method) \bibgls\ is used to provide
the entry definitions but \idx{makeindex} or \idx{xindy} is used
- for the indexing)},
+ for the indexing},
package={glossaries-extra},
category={packageoption},
parent={packageoptions}
@@ -3878,7 +4581,7 @@ hyphen}},
package={glossaries,glossaries-extra},
description={defines the \code{symbols} glossary; with
\styfmt{glossaries-extra} additionally defines
- \gls{glsxtrnewsymbol}},
+ \csref{glsxtrnewsymbol}},
category={packageoption},
parent={packageoptions}
}
@@ -3888,7 +4591,7 @@ hyphen}},
package={glossaries,glossaries-extra},
description={defines the \code{numbers} glossary; with
\styfmt{glossaries-extra} additionally defines
- \gls{glsxtrnewnumber}},
+ \csref{glsxtrnewnumber}},
category={packageoption},
parent={packageoptions}
}
@@ -3965,7 +4668,7 @@ hyphen}},
@dualindexentry{styopt.indexcounter,
name={\styoptfmt{index\-counter}},
- description={creates the \gls{ctr.wrglossary} counter, which is
+ description={creates the \counter{wrglossary} counter, which is
incremented every time an entry is indexed with that counter, and sets
that as the default location counter},
package={glossaries-extra},
@@ -4005,7 +4708,7 @@ hyphen}},
@dualindexentry{styopt.stylemods,
name={\styoptfmt{stylemods}},
user1={\meta{value}},
- description={load the \gls{glossaries-extra-stylemods} package with the
+ description={load the \sty{glossaries-extra-stylemods} package with the
supplied options (which should be a list of suffix parts
identifying glossary style packages \styfmt{glossary-}\meta{suffix});
there are two keyword values: \styoptfmt{default}
@@ -4201,8 +4904,8 @@ hyphen}},
If no value is supplied then \styopt[section]{section} is assumed.
If this option is omitted, then the default is either
\styopt[chapter]{section} or \styopt[section]{section}, depending
- on whether or not \gls{chapter} has been defined. The starred or
- unstarred version is determined by \gls{styopt.numberedsection}}
+ on whether or not \cs{chapter} has been defined. The starred or
+ unstarred version is determined by \styopt{numberedsection}}
}
@dualindexentry{styopt.ucmark,
@@ -4320,7 +5023,7 @@ hyphen}},
description={prevents all the default styles from being loaded. If
this option is used a style must be defined in the document or a package
providing a style needs to be loaded (either
- through \gls{styopt.stylemods} or with \gls{usepackage})},
+ through \styopt{stylemods} or with \ics{usepackage})},
category={packageoption},
parent={packageoptions}
}
@@ -4343,8 +5046,8 @@ hyphen}},
description={suppresses the location lists from being
displayed in the glossary lists (the package
option isn't boolean, but the option of the same name for
- \gls{printglossary}, \gls{printunsrtglossary} and
- \gls{printnoidxglossary} is boolean); with \bibgls\ you can use
+ \cs{printglossary}, \cs{printunsrtglossary} and
+ \cs{printnoidxglossary} is boolean); with \bibgls\ you can use
\csopt[false]{save-locations} instead},
category={packageoption},
parent={packageoptions}
@@ -4377,7 +5080,7 @@ hyphen}},
name={\styoptfmt{nogroupskip}},
user1={\meta{boolean}},
description={if true, suppresses the visual separation between
- letter groups},
+ letter groups in glossary styles that support this option},
package={glossaries},
category={packageoption},
parent={packageoptions}
@@ -4501,9 +5204,9 @@ hyphen}},
\styopt[ac]{shortcuts}, \styopt[abbreviations]{shortcuts} and
\styopt[other]{shortcuts}), \styoptfmt{acronyms}\extstyopt\
(equivalent to base \styopt[true]{shortcuts}, synonym
- \styoptfmt{acro}), \styoptfmt{ac}\extstyopt\ (provides \gls{ac}
+ \styoptfmt{acro}), \styoptfmt{ac}\extstyopt\ (provides \cs{ac}
shortcuts that use \styfmt{glossaries-extra}'s new abbreviation
- commands), \styoptfmt{abbreviations}\extstyopt\ (provides \gls{ab}
+ commands), \styoptfmt{abbreviations}\extstyopt\ (provides \cs{ab}
shortcuts), \styoptfmt{other}\extstyopt\ (provides other shortcut
commands), \styoptfmt{all}\extstyopt\ (synonym for
\styopt[true]{shortcuts}) and \styoptfmt{none}\extstyopt\ (synonym
@@ -4515,7 +5218,7 @@ hyphen}},
@dualindexentry{styopt.index,
name={\styoptfmt{index}},
package={glossaries},
- description={defines the \code{index} glossary and \gls{newterm}},
+ description={defines the \code{index} glossary and \csref{newterm}},
category={packageoption},
parent={packageoptions}
}
@@ -4529,7 +5232,7 @@ hyphen}},
name={\fieldfmt{alias}},
description={The entry with this field set is a synonym of the
entry whose label is given by this field.},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={extrafield},
parent={fields}
}
@@ -4537,7 +5240,7 @@ hyphen}},
@dualindexentry{field.category,
name={\fieldfmt{category}},
description={The entry's category label.},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={extrafield},
parent={fields}
}
@@ -4545,7 +5248,7 @@ hyphen}},
@dualindexentry{field.description,
name={\fieldfmt{description}},
description={The description displayed in the glossary.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4553,23 +5256,23 @@ hyphen}},
@dualindexentry{field.descriptionplural,
name={\fieldfmt{descriptionplural}},
description={The plural form of the description.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@dualindexentry{field.first,
name={\fieldfmt{first}},
- description={The text to display on first use of \gls{gls}\margm{label}.},
- note={provided by \styfmt{glossaries}},
+ description={The text to display on first use with \cs{gls}\margm{label}.},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@dualindexentry{field.firstplural,
name={\fieldfmt{firstplural}},
- description={The text to display on first use of \gls{glspl}\margm{label}.},
- note={provided by \styfmt{glossaries}},
+ description={The text to display on first use with \cs{glspl}\margm{label}.},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4577,8 +5280,8 @@ hyphen}},
@dualindexentry{field.long,
name={\fieldfmt{long}},
description={The long form of an abbreviation. (Set internally
- by commands like \gls{newabbreviation}.)},
- note={provided by \styfmt{glossaries}},
+ by commands like \csref{newabbreviation}.)},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4586,7 +5289,7 @@ hyphen}},
@dualindexentry{field.longplural,
name={\fieldfmt{longplural}},
description={The plural long form of an abbreviation.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4594,7 +5297,7 @@ hyphen}},
@dualindexentry{field.name,
name={\fieldfmt{name}},
description={The name displayed in the glossary.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4602,7 +5305,7 @@ hyphen}},
@dualindexentry{field.parent,
name={\fieldfmt{parent}},
description={The parent entry's label.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4610,8 +5313,8 @@ hyphen}},
@dualindexentry{field.plural,
name={\fieldfmt{plural}},
description={The text to display on subsequent use of
- \gls{glspl}\margm{label}.},
- note={provided by \styfmt{glossaries}},
+ \cs{glspl}\margm{label}.},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4620,7 +5323,7 @@ hyphen}},
name={\fieldfmt{see}},
description={General purpose cross-reference
(syntax: \code{see=\marg{\oargm{tag}\meta{xr-list}}}).},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4629,7 +5332,7 @@ hyphen}},
name={\fieldfmt{seealso}},
description={Cross-reference related entries
(syntax: \code{seealso=\margm{xr-list}}).},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={extrafield},
parent={fields}
}
@@ -4637,8 +5340,8 @@ hyphen}},
@dualindexentry{field.short,
name={\fieldfmt{short}},
description={The short form of an abbreviation. (Set internally
- by commands like \gls{newabbreviation}.)},
- note={provided by \styfmt{glossaries}},
+ by commands like \csref{newabbreviation}.)},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4646,7 +5349,7 @@ hyphen}},
@dualindexentry{field.shortplural,
name={\fieldfmt{shortplural}},
description={The plural short form of an abbreviation.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4654,7 +5357,7 @@ hyphen}},
@dualindexentry{field.symbol,
name={\fieldfmt{symbol}},
description={The associated symbol.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4662,7 +5365,7 @@ hyphen}},
@dualindexentry{field.symbolplural,
name={\fieldfmt{symbolplural}},
description={The plural form of the associated symbol.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4670,8 +5373,8 @@ hyphen}},
@dualindexentry{field.text,
name={\fieldfmt{text}},
description={The text to display on subsequent use of
- \gls{gls}\margm{label}.},
- note={provided by \styfmt{glossaries}},
+ \cs{gls}\margm{label}.},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4679,7 +5382,7 @@ hyphen}},
@dualindexentry{field.user1,
name={\fieldfmt{user1}},
description={A general purpose user field.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4687,7 +5390,7 @@ hyphen}},
@dualindexentry{field.user2,
name={\fieldfmt{user2}},
description={A general purpose user field.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4695,7 +5398,7 @@ hyphen}},
@dualindexentry{field.user3,
name={\fieldfmt{user3}},
description={A general purpose user field.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4703,7 +5406,7 @@ hyphen}},
@dualindexentry{field.user4,
name={\fieldfmt{user4}},
description={A general purpose user field.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4711,7 +5414,7 @@ hyphen}},
@dualindexentry{field.user5,
name={\fieldfmt{user5}},
description={A general purpose user field.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4719,7 +5422,7 @@ hyphen}},
@dualindexentry{field.user6,
name={\fieldfmt{user6}},
description={A general purpose user field.},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={basefield},
parent={fields}
}
@@ -4728,7 +5431,7 @@ hyphen}},
name={\fieldfmt{duallong}},
description={The long form of a dual
abbreviation mapped by \atentry{dualabbreviation}.},
- note={provided by \appfmt{bib2gls}},
+ note={\appfmt{bib2gls}},
category={bib2glsfield},
parent={fields}
}
@@ -4737,7 +5440,7 @@ hyphen}},
name={\fieldfmt{duallongplural}},
description={The plural long form of a dual
abbreviation mapped by \atentry{dualabbreviation}.},
- note={provided by \appfmt{bib2gls}},
+ note={\appfmt{bib2gls}},
category={bib2glsfield},
parent={fields}
}
@@ -4746,7 +5449,7 @@ hyphen}},
name={\fieldfmt{dualshort}},
description={The short form of a dual
abbreviation mapped by \atentry{dualabbreviation}.},
- note={provided by \appfmt{bib2gls}},
+ note={\appfmt{bib2gls}},
category={bib2glsfield},
parent={fields}
}
@@ -4755,7 +5458,7 @@ hyphen}},
name={\fieldfmt{dualshortplural}},
description={The plural short form of a dual abbreviation
mapped by \atentry{dualabbreviation}.},
- note={provided by \appfmt{bib2gls}},
+ note={\appfmt{bib2gls}},
category={bib2glsfield},
parent={fields}
}
@@ -4764,7 +5467,7 @@ hyphen}},
name={\fieldfmt{prefix}},
description={The prefix associated with the \field{text}
field.},
- note={provided by \styfmt{glossaries-prefix}},
+ note={\styfmt{glossaries-prefix}},
category={prefixfield},
parent={fields}
}
@@ -4773,7 +5476,7 @@ hyphen}},
name={\fieldfmt{prefixfirst}},
description={The prefix associated with the \field{first}
field.},
- note={provided by \styfmt{glossaries-prefix}},
+ note={\styfmt{glossaries-prefix}},
category={prefixfield},
parent={fields}
}
@@ -4782,7 +5485,7 @@ field.},
name={\fieldfmt{prefixfirstplural}},
description={The prefix associated with the
\field{firstplural} field.},
- note={provided by \styfmt{glossaries-prefix}},
+ note={\styfmt{glossaries-prefix}},
category={prefixfield},
parent={fields}
}
@@ -4791,7 +5494,7 @@ field.},
name={\fieldfmt{prefixplural}},
description={The prefix associated with the
\field{plural} field.},
- note={provided by \styfmt{glossaries-prefix}},
+ note={\styfmt{glossaries-prefix}},
category={prefixfield},
parent={fields}
}
@@ -4799,7 +5502,7 @@ field.},
@dualindexentry{field.access,
name={\fieldfmt{access}},
description={The replacement text for the \field{name} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4808,7 +5511,7 @@ field.},
name={\fieldfmt{descriptionaccess}},
description={The replacement text for the
\field{description} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4817,7 +5520,7 @@ field.},
name={\fieldfmt{descriptionpluralaccess}},
description={The replacement text for the
\field{descriptionplural} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4825,7 +5528,7 @@ field.},
@dualindexentry{field.firstaccess,
name={\fieldfmt{firstaccess}},
description={The replacement text for the \field{first} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4834,7 +5537,7 @@ field.},
name={\fieldfmt{firstpluralaccess}},
description={The replacement text for the
\field{firstplural} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4842,7 +5545,7 @@ field.},
@dualindexentry{field.longaccess,
name={\fieldfmt{longaccess}},
description={The replacement text for the \field{long} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4851,7 +5554,7 @@ field.},
name={\fieldfmt{longpluralaccess}},
description={The replacement text for the
\field{longplural} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4859,7 +5562,7 @@ field.},
@dualindexentry{field.pluralaccess,
name={\fieldfmt{pluralaccess}},
description={The replacement text for the \field{plural} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4867,7 +5570,7 @@ field.},
@dualindexentry{field.shortaccess,
name={\fieldfmt{shortaccess}},
description={The replacement text for the \field{short} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4876,7 +5579,7 @@ field.},
name={\fieldfmt{shortpluralaccess}},
description={The replacement text for the
\field{shortplural} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4884,7 +5587,7 @@ field.},
@dualindexentry{field.symbolaccess,
name={\fieldfmt{symbolaccess}},
description={The replacement text for the \field{symbol} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4893,7 +5596,7 @@ field.},
name={\fieldfmt{symbolpluralaccess}},
description={The replacement text for the
\field{symbolplural} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4902,7 +5605,7 @@ field.},
name={\fieldfmt{textaccess}},
description={The replacement text for the
\field{text} field.},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={accessfield},
parent={fields}
}
@@ -4930,6 +5633,15 @@ field.},
parent={internalfields}
}
+@dualindexentry{field.primarylocations,
+ name={\fieldfmt{primarylocations}},
+ description={Stores the locations that use one of the designated
+primary formats, if enabled.},
+ note={internal field set by \appfmt{bib2gls}},
+ category={internalfield},
+ parent={internalfields}
+}
+
@dualindexentry{field.indexcounter,
name={\fieldfmt{index\-counter}},
description={Stores the location corresponding to the matching
@@ -4942,7 +5654,7 @@ field.},
@dualindexentry{field.counter,
name={\fieldfmt{counter}},
description={The default counter used for indexing (assigned by
- the \gls{dual.opt.counter} option).},
+ the \csopt{counter} option).},
note={internal field set by \appfmt{bib2gls}},
category={internalfield},
parent={internalfields}
@@ -4951,7 +5663,7 @@ field.},
@dualindexentry{field.group,
name={\fieldfmt{group}},
description={The letter group determined by the comparator
- (or assigned by the \gls{dual.opt.group} option).},
+ (or assigned by the \csopt{group} option).},
note={internal field set by \appfmt{bib2gls}},
category={internalfield},
parent={internalfields}
@@ -5003,7 +5715,7 @@ field.},
@dualindexentry{field.secondarygroup,
name={\fieldfmt{secondarygroup}},
description={The letter group determined by the
- comparator used with the \gls{dual.opt.secondary} sort.},
+ comparator used with the \csopt{secondary} sort.},
note={internal field set by \appfmt{bib2gls}},
category={internalfield},
parent={internalfields}
@@ -5012,7 +5724,7 @@ field.},
@dualindexentry{field.secondarysort,
name={\fieldfmt{secondarysort}},
description={The sort value determined by the
- comparator used with the \gls{dual.opt.secondary} sort.},
+ comparator used with the \csopt{secondary} sort.},
note={internal field set by \appfmt{bib2gls}},
category={internalfield},
parent={internalfields}
@@ -5038,7 +5750,7 @@ field.},
@dualindexentry{field.type,
name={\fieldfmt{type}},
description={The glossary this entry belongs to (assigned by
- the \gls{dual.opt.type} option).},
+ the \csopt{type} option).},
note={internal field set by \appfmt{bib2gls}},
category={internalfield},
parent={internalfields}
@@ -5046,7 +5758,7 @@ field.},
@dualindexentry{field.fieldendpunc,
name={\meta{field}\fieldfmt{endpunc}},
- description={Used with the \gls{dual.opt.check-end-punctuation}
+ description={Used with the \csopt{check-end-punctuation}
option.},
note={internal field set by \appfmt{bibgls}},
category={internalfield},
@@ -5584,6 +6296,13 @@ field.},
parent={commandlineoptions}
}
+@dualindexentry{switch.merge-nameref-on,
+ name={\longargfmt{merge\dhyphen nameref\dhyphen on}},
+ user1={\meta{rule}},
+ category={switch},
+ parent={commandlineoptions}
+}
+
@dualindexentry{switch.force-cross-resource-refs,
name={\longargfmt{force\dhyphen cross\dhyphen resource\dhyphen refs}},
symbol={\shortargfmt{x}},
@@ -5851,6 +6570,40 @@ field.},
name={post-description hook}
}
+@index{languagexml,
+ name={language resource file (\extfmt{xml})}
+}
+
+@index{tag.page,
+ name={\xmltagfmt{tag.page}},
+ parent={languagexml}
+}
+
+@index{tag.pages,
+ name={\xmltagfmt{tag.pages}},
+ parent={languagexml}
+}
+
+@index{tag.passim,
+ name={\xmltagfmt{tag.passim}},
+ parent={languagexml}
+}
+
+@index{sentence.terminators,
+ name={\xmltagfmt{sentence.terminators}},
+ parent={languagexml}
+}
+
+@index{grouptitle.case.lc,
+ name={\xmltagfmt{grouptitle.case.}\meta{lc}},
+ parent={languagexml}
+}
+
+@index{xmlsee,
+ name={XML resource file},
+ see={languagexml}
+}
+
@index{encoding}
@index{digraph}
@@ -5877,6 +6630,11 @@ field.},
alias={full-stop}
}
+@index{apostrophe,
+ name={apostrophe (\code{'})},
+ text={apostrophe}
+}
+
@index{resourceset,
name={resource set}
}
@@ -5936,9 +6694,17 @@ field.},
name={lower case}
}
+@index{titlecase,
+ name={title case}
+}
+
+@index{sentencecase,
+ name={sentence case}
+}
+
@index{case-change,
- name = {case change},
- seealso = {uppercase,lowercase}
+ name = {case-change},
+ seealso = {uppercase,lowercase,titlecase,sentencecase}
}
@index{unicodecategories,
@@ -5997,6 +6763,11 @@ field.},
parent={unicodecategories}
}
+@index{punctuationdash,
+ name={\unicodecategoryfmt{Punctuation, Dash}},
+ parent={unicodecategories}
+}
+
@index{texmfcnf.openinany,
name={\texmfcnffmt{openin\_any}}
}
@@ -6173,8 +6944,8 @@ field.},
name={\filefmt{markuplanguages.bib}}
}
-@dualindexentry{file.sample-languages.tex,
- name={\filefmt{sample\dhyphen languages.tex}}
+@dualindexentry{file.sample-markuplanguages.tex,
+ name={\filefmt{sample\dhyphen markuplanguages.tex}}
}
@dualindexentry{file.usergroups.bib,
@@ -6214,7 +6985,7 @@ field.},
user1={\oargm{link text}\margm{label}},
description={creates a hyperlink to the entry information in the
glossary},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6223,7 +6994,7 @@ field.},
user1={\margm{label}\margm{field}},
description={iterates over the items the given field, which contains
an \styfmt{etoolbox} internal list},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.12+},
seealso={glsxtrfieldforlistloop,glsxtrfieldifinlist,glsxtrfieldlistadd},
category={command}
}
@@ -6233,8 +7004,7 @@ field.},
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},
- note={provided by \styfmt{glossaries-extra}, use at least v1.29 to
-avoid a bug},
+ note={\styfmt{glossaries-extra} v1.29+},
seealso={glsxtrfielddolistloop,glsxtrfieldifinlist,glsxtrfieldlistadd},
category={command}
}
@@ -6244,7 +7014,7 @@ avoid a bug},
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={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6253,7 +7023,7 @@ avoid a bug},
user1={\margm{cs}\margm{label}},
description={assigns the sort value for \cs{index} when
using auto-indexing},
- note={provided by \styfmt{glossaries-extra} v1.16+},
+ note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
@@ -6262,7 +7032,7 @@ avoid a bug},
user1={\margm{label}},
description={used for the actual value in \cs{index} when
using auto-indexing},
- note={provided by \styfmt{glossaries-extra} v1.16+},
+ note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
@@ -6270,8 +7040,56 @@ avoid a bug},
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},
- note={provided by \styfmt{glossaries}},
+ 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}},
+ note={\styfmt{glossaries}},
+ seealso={glsseeitem,glsseeitemformat,glsseesep,glsseelastsep},
+ category={command}
+}
+
+@index{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}}},
+ note={\styfmt{glossaries}},
+ seealso={glsseeformat,glsseeitemformat},
+ category={command}
+}
+
+@index{glsseeitemformat,
+ name={\csfmt{gls\-see\-item\-format}},
+ user1={\margm{label}},
+ description={formats an element of the cross-reference list.
+ With the base \styfmt{glossaries} package this just does
+ \code{\cs{glsentrytext}\margm{label}}. With
+ \styfmt{glossaries-extra} this uses either \cs{glsentryshort}
+ or \cs{glsentryname} depending on whether or not the
+ \field{short} field has been set},
+ note={\styfmt{glossaries} v3.0+},
+ seealso={glsseeformat,glsseeitem},
+ category={command}
+}
+
+@index{glsseesep,
+ name={\csfmt{gls\-see\-sep}},
+ description={the separator used between all but the last
+ entries of a cross-reference list},
+ note={\styfmt{glossaries}},
+ seealso={glsseeformat,glsseelastsep},
+ category={command}
+}
+
+@index{glsseelastsep,
+ name={\csfmt{gls\-see\-last\-sep}},
+ description={the separator used between the penultimate and
+ ultimate entries of a cross-reference list},
+ note={\styfmt{glossaries}},
+ seealso={glsseeformat,glsseesep},
category={command}
}
@@ -6280,7 +7098,77 @@ avoid a bug},
user1={\margm{tag}\margm{labels}},
description={formats the entries identified in the comma separated
list of labels as a set of cross-references},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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+},
+ seealso={glsxtrhiernamesep},
+ category={command}
+}
+
+@index{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+},
+ seealso={glsxtrhiername},
+ category={command}
+}
+
+@index{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+},
+ seealso={glsxtrhiername,glsxtrhiernamesep},
+ category={command}
+}
+
+@index{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+},
+ seealso={glsxtrhiername,glsxtrhiernamesep},
+ category={command}
+}
+
+@index{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+},
+ seealso={glsxtrhiername,glsxtrhiernamesep},
+ category={command}
+}
+
+@index{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+},
+ seealso={glsxtrhiername,glsxtrhiernamesep},
category={command}
}
@@ -6289,7 +7177,7 @@ avoid a bug},
user1={\margm{label}},
description={additional category-independent code for the
post-name hook},
- note={provided by \styfmt{glossaries-extra} version 1.25+},
+ note={\styfmt{glossaries-extra} v1.25+},
category={command}
}
@@ -6298,7 +7186,16 @@ post-name hook},
user1={\margm{label}},
description={expands to the value of the
\field{text} field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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}},
category={command}
}
@@ -6307,7 +7204,55 @@ post-name hook},
user1={\margm{label}},
description={expands to the value of the
\field{plural} field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{glsentryfirst,
+ name={\csfmt{gls\-entry\-first}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{first} field},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{glsentryfirstplural,
+ name={\csfmt{gls\-entry\-first\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{firstplural} field},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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}},
category={command}
}
@@ -6316,7 +7261,7 @@ post-name hook},
user1={\margm{label}},
description={expands to the value of the
\field{name} field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6326,7 +7271,7 @@ post-name hook},
description={displays the value of the
\field{name} field with the first character
converted to upper case},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6335,7 +7280,17 @@ post-name hook},
user1={\margm{label}},
description={expands to the value of the
\field{description} field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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}},
category={command}
}
@@ -6344,7 +7299,112 @@ post-name hook},
user1={\margm{label}},
description={expands to the value of the
\field{symbol} field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{glsentrysymbolplural,
+ name={\csfmt{gls\-entry\-symbol\-plural}},
+ user1={\margm{label}},
+ description={expands to the value of the
+ \field{symbolplural} field},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
category={command}
}
@@ -6353,7 +7413,7 @@ post-name hook},
user1={\margm{label}},
description={expands to the value of the
\field{user1} field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6362,7 +7422,7 @@ post-name hook},
user1={\margm{label}},
description={expands to the value of the
\field{user2} field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6371,7 +7431,7 @@ post-name hook},
user1={\margm{label}},
description={expands to the value of the
\field{user3} field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6380,7 +7440,7 @@ post-name hook},
user1={\margm{label}},
description={expands to the value of the
\field{user4} field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6389,7 +7449,7 @@ post-name hook},
user1={\margm{label}},
description={expands to the value of the
\field{user5} field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6398,7 +7458,67 @@ post-name hook},
user1={\margm{label}},
description={expands to the value of the
\field{user6} field},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
+ category={command}
+}
+
+@index{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}},
category={command}
}
@@ -6407,7 +7527,7 @@ post-name hook},
user1={\margm{category}\margm{attribute}\margm{value}},
description={sets the value of the attribute for the given
category},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -6418,7 +7538,7 @@ category},
\field{description} field in parentheses
if the entry that was just referenced was used for the
first time},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -6429,7 +7549,7 @@ category},
\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},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -6440,7 +7560,7 @@ category},
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},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
@@ -6448,7 +7568,7 @@ category},
name={\csfmt{gls\-plural\-suffix}},
user1={},
description={the suffix used to construct the default plural},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6457,7 +7577,7 @@ category},
user1={},
description={the suffix used to construct the default plural for
the short form of acronyms},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6466,7 +7586,7 @@ category},
user1={},
description={the style sensitive suffix used to construct the
default plural for the short form of abbreviations},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
seealso={glsxtrabbrvpluralsuffix},
category={command}
}
@@ -6476,31 +7596,44 @@ category},
user1={},
description={the default suffix used to construct the plural for
the short form of abbreviations},
- note={provided by \styfmt{glossaries-extra}},
+ 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}},
category={command}
}
@index{glsdefpostlink,
name={\csfmt{gls\-def\-post\-link}},
user1={\margm{category}\margm{definition}},
- description={define the post-link hook for the given category},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ description={define the post-link hook
+ \cs{glsxtrpostlinkcategory} for the given category},
+ note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
@index{glsdefpostname,
name={\csfmt{gls\-def\-post\-name}},
user1={\margm{category}\margm{definition}},
- description={define the post-name hook for the given category},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ description={define the post-name hook
+ \cs{glsxtrpostnamecategory} for the given category},
+ note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
@index{glsdefpostdesc,
name={\csfmt{gls\-def\-post\-desc}},
user1={\margm{category}\margm{definition}},
- description={define the post-description hook for the given category},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ description={define the post-description hook
+ \csfmt{glsxtrpostdesc}\meta{category} for the given category},
+ note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
@@ -6509,7 +7642,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},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -6521,7 +7654,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},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
seealso={GlsXtrIfUnusedOrUndefined,glsxtrifwasfirstuse},
category={command}
}
@@ -6533,17 +7666,26 @@ category},
hasn't been
used or is undefined, otherwise it does \meta{false}.
This command is not for use in the post-link hooks},
- note={provided by \styfmt{glossaries-extra} v1.34+},
+ note={\styfmt{glossaries-extra} v1.34+},
seealso={ifglsused,glsxtrifwasfirstuse},
category={command}
}
+@index{GlsXtrLocationField,
+ name={\csfmt{GlsXtrLocationField}},
+ user1={},
+ description={expands to the internal name of the field storing the
+location list, defaulting to \field{location}},
+ note={\styfmt{glossaries-extra} v1.37+},
+ category={command}
+}
+
@index{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},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6553,7 +7695,7 @@ hasn't been
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},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6563,7 +7705,35 @@ 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},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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+},
+ category={command}
+}
+
+@index{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+},
+ category={command}
+}
+
+@index{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+},
category={command}
}
@@ -6572,7 +7742,25 @@ field value},
user1={\margm{entry label}\margm{field label}},
description={expands to the value of the given field for the given
entry},
- note={provided by \styfmt{glossaries-extra} v1.12+},
+ note={\styfmt{glossaries-extra} v1.12+},
+ category={command}
+}
+
+@index{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+},
+ category={command}
+}
+
+@index{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+},
category={command}
}
@@ -6582,7 +7770,17 @@ field value},
description={assigns the given \meta{value} to the field
identified by \meta{field label} for the
entry identified by \meta{entry label}},
- note={provided by \styfmt{glossaries-extra} v1.12+},
+ note={\styfmt{glossaries-extra} v1.12+},
+ category={command}
+}
+
+@index{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}},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@@ -6593,7 +7791,7 @@ field value},
(defined and not empty)
without testing if the entry exists and adds implicit scoping
to \meta{true} and \meta{false}},
- note={provided by \styfmt{glossaries-extra} v1.19+},
+ note={\styfmt{glossaries-extra} v1.19+},
seealso={GlsXtrIfFieldUndef},
category={command}
}
@@ -6605,7 +7803,7 @@ field value},
(defined and not empty)
without testing if the entry exists and without introducing
an implicit scope},
- note={provided by \styfmt{glossaries-extra} v1.19+},
+ note={\styfmt{glossaries-extra} v1.19+},
seealso={GlsXtrIfFieldUndef},
category={command}
}
@@ -6615,7 +7813,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},
- note={provided by \styfmt{glossaries-extra} v1.23+},
+ note={\styfmt{glossaries-extra} v1.23+},
category={command}
}
@@ -6624,7 +7822,7 @@ field value},
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},
- note={provided by \styfmt{glossaries-extra} v1.21+},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -6633,7 +7831,7 @@ field value},
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)},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
@@ -6642,7 +7840,7 @@ fully expands \meta{text} (but not the field value)},
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}},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
@@ -6651,7 +7849,7 @@ fully expands both the field value and \meta{text}},
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={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
seealso={glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
}
@@ -6662,7 +7860,7 @@ fully expands both the field value and \meta{text}},
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}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
seealso={ifglshasdesc,glsxtrifhasfield,GlsXtrIfFieldUndef},
category={command}
}
@@ -6672,7 +7870,7 @@ fully expands both the field value and \meta{text}},
user1={\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry, which must be defined, has the
\field{description} field set},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
seealso={ifglshassymbol,ifglshasdescsuppressed},
category={command}
}
@@ -6682,7 +7880,7 @@ fully expands both the field value and \meta{text}},
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}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
seealso={ifglshasdesc},
category={command}
}
@@ -6692,7 +7890,7 @@ fully expands both the field value and \meta{text}},
user1={\margm{entry label}\margm{true}\margm{false}},
description={tests if the given entry, which must be defined, has the
\field{parent} field set},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6706,7 +7904,25 @@ 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},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6718,7 +7934,7 @@ 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}},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ note={\styfmt{glossaries-extra} v1.31+},
seealso={GlsXtrIfFieldEqNum},
category={command}
}
@@ -6731,7 +7947,7 @@ integer \meta{number}. If the field is undefined or empty, the value is assumed
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}},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ note={\styfmt{glossaries-extra} v1.31+},
seealso={GlsXtrIfFieldNonZero},
category={command}
}
@@ -6744,7 +7960,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}},
- note={provided by \styfmt{glossaries-extra-bib2gls} v1.31+},
+ note={\styfmt{glossaries-extra-bib2gls} v1.31+},
seealso={GlsXtrIfFieldNonZero},
category={command}
}
@@ -6755,7 +7971,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}},
- note={provided by \styfmt{glossaries-extra} v1.23+},
+ note={\styfmt{glossaries-extra} v1.23+},
category={command}
}
@@ -6764,7 +7980,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={},
description={governs the way the \field{name} field is set
by the \abbrstyle{long-short-desc} abbreviation styles},
- note={provided by \styfmt{glossaries-extra} v1.17+},
+ note={\styfmt{glossaries-extra} v1.17+},
category={command}
}
@@ -6773,7 +7989,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={},
description={governs the way the \field{name} field is set
by the \abbrstyle{long-short} abbreviation styles},
- note={provided by \styfmt{glossaries-extra} v1.25+},
+ note={\styfmt{glossaries-extra} v1.25+},
category={command}
}
@@ -6782,7 +7998,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={},
description={governs the way the \field{name} field is set
by the \abbrstyle{long-only-short-only} abbreviation styles},
- note={provided by \styfmt{glossaries-extra} v1.25+},
+ note={\styfmt{glossaries-extra} v1.25+},
category={command}
}
@@ -6791,27 +8007,28 @@ can be referenced in \meta{true} or \meta{false} with
user1={},
description={governs the way the \field{name} field is set
by the \abbrstyle{long-only-short-only} abbreviation styles},
- note={provided by \styfmt{glossaries-extra} v1.17+},
+ note={\styfmt{glossaries-extra} v1.17+},
category={command}
}
@index{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 \cs{newglossaryentry}
+ description={adds a new key for use in \csref{newglossaryentry}
and associated commands to access it},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@index{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 \cs{newglossaryentry}
+ description={adds a new key, if not already defined, for use in
+\csref{newglossaryentry}
and an associated command
to access it where (unlike \cs{glsaddstoragekey})
the \meta{no link cs} part may be empty if unrequired},
- note={provided by \styfmt{glossaries-extra} v1.12+},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@@ -6819,8 +8036,8 @@ can be referenced in \meta{true} or \meta{false} with
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
- \cs{newglossaryentry}},
- note={provided by \styfmt{glossaries}},
+ \csref{newglossaryentry}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6830,7 +8047,7 @@ can be referenced in \meta{true} or \meta{false} with
description={defines the control sequence \meta{cs}
to be used with abbreviation tagging
with the given categories},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -6839,7 +8056,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={\margm{text}},
description={font used by tagging command defined by
\cs{GlsXtrEnableInitialTagging}},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command},
seealso={GlsXtrEnableInitialTagging}
}
@@ -6849,33 +8066,31 @@ can be referenced in \meta{true} or \meta{false} with
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},
- note={provided by \styfmt{glossary-hypernav}},
+ note={\styfmt{glossary-hypernav}},
category={command}
}
@index{newentry,
name={\csfmt{newentry}},
user1={\margm{label}\margm{\keyvallist}},
- description={equivalent to \csref[noindex]{newglossaryentry}},
- note={provided by \styfmt{glossaries-extra}'s shortcuts},
+ description={equivalent to \csref{newglossaryentry}},
+ note={\styfmt{glossaries-extra}'s shortcuts},
category={command}
}
@index{newsym,
name={\csfmt{newsym}},
user1={\margm{label}\margm{\keyvallist}\margm{symbol}},
- description={equivalent to \gls{glsxtrnewsymbol}},
- note={provided by \styfmt{glossaries-extra}'s
- \styopt{shortcuts} package option},
+ description={equivalent to \csref{glsxtrnewsymbol}},
+ note={\styfmt{glossaries-extra} \styopt{shortcuts}},
category={command}
}
@index{newnum,
name={\csfmt{newnum}},
user1={\margm{label}\margm{\keyvallist}},
- description={equivalent to \gls{glsxtrnewnumber}},
- note={provided by \styfmt{glossaries-extra}'s
- \styopt{shortcuts} package option},
+ description={equivalent to \csref{glsxtrnewnumber}},
+ note={\styfmt{glossaries-extra} \styopt{shortcuts}},
category={command}
}
@@ -6883,8 +8098,8 @@ can be referenced in \meta{true} or \meta{false} with
name={\csfmt{acronym\-type}},
user1={},
description={expands to the default acronym glossary type when using
- \cs{newacronym}},
- note={provided by \styfmt{glossaries}},
+ \csref{newacronym}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6892,8 +8107,8 @@ can be referenced in \meta{true} or \meta{false} with
name={\csfmt{gls\-xtr\-abbrv\-type}},
user1={},
description={expands to the default glossary type when using
- \cs{newabbreviation}},
- note={provided by \styfmt{glossaries-extra}},
+ \csref{newabbreviation}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -6901,7 +8116,7 @@ can be referenced in \meta{true} or \meta{false} with
name={\csfmt{no\-post\-desc}},
user1={},
description={suppresses the post-description hook},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6910,7 +8125,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={},
description={suppresses the post-description punctuation
without suppressing the post-description hook},
- note={provided by \styfmt{glossaries-extra} v1.22+},
+ note={\styfmt{glossaries-extra} v1.22+},
category={command}
}
@@ -6920,7 +8135,7 @@ can be referenced in \meta{true} or \meta{false} with
description={used within post-description category hooks,
this restores the post-description punctuation
if it's been suppressed with \cs{glsxtrnopostpunc}},
- note={provided by \styfmt{glossaries-extra} v1.23+},
+ note={\styfmt{glossaries-extra} v1.23+},
category={command}
}
@@ -6929,7 +8144,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={\oargm{type}\margm{file}},
description={locally redefines \cs{glsdefaulttype}
to \meta{type} and inputs \meta{file}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6939,7 +8154,7 @@ can be referenced in \meta{true} or \meta{false} with
description={defines a new glossary identified by \meta{type}
with the given title and associated file extensions used by
\appfmt{makeindex} or \appfmt{xindy}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6948,7 +8163,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={\margm{type}\margm{title}},
description={defines a new glossary identified by \meta{type}
with the given title},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -6959,7 +8174,7 @@ can be referenced in \meta{true} or \meta{false} with
suppressed) identified by \meta{type}
that's not included in the list used by commands, such
as \cs{printunsrtglossaries}, that iterate over defined glossaries},
- note={provided by \styfmt{glossaries} v4.08+},
+ note={\styfmt{glossaries} v4.08+},
category={command}
}
@@ -6970,7 +8185,7 @@ can be referenced in \meta{true} or \meta{false} with
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},
- note={provided by \styfmt{glossaries-extra} v1.11+},
+ note={\styfmt{glossaries-extra} v1.11+},
category={command}
}
@@ -6979,7 +8194,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={\margm{type}},
description={as \cs{newignoredglossary} but does nothing
if a glossary identified by \meta{type} already exists},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@@ -6988,7 +8203,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={\margm{type}},
description={as \ics{provideignoredglossary} but doesn't
suppress hyperlinks},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@@ -6996,7 +8211,7 @@ can be referenced in \meta{true} or \meta{false} with
name={\csfmt{delimN}},
user1={},
description={used to delimited individual locations},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7005,7 +8220,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={},
description={used as a separator between the start and end locations
of a range},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7014,7 +8229,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},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7023,7 +8238,7 @@ can be referenced in \meta{true} or \meta{false} with
description={the handler used by the internal list loop function used
in \cs{glsnoidxloclist}},
user1={\margm{location}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7031,7 +8246,7 @@ can be referenced in \meta{true} or \meta{false} with
name={\csfmt{glossentry}},
user1={\margm{label}\margm{location list}},
description={used in the glossary to display a top-level entry},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries} v3.08a+},
category={command}
}
@@ -7039,7 +8254,122 @@ can be referenced in \meta{true} or \meta{false} with
name={\csfmt{subglossentry}},
user1={\margm{level}\margm{label}\margm{location list}},
description={used in the glossary to display a sub-entry},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries} v3.08a+},
+ category={command}
+}
+
+@index{newglossarystyle,
+ name={\csfmt{new\-glossary\-style}},
+ user1={\margm{name}\margm{definition}},
+ description={defines a new glossary style called \meta{name}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{setglossarystyle,
+ name={\csfmt{set\-glossary\-style}},
+ user1={\margm{name}},
+ description={sets the glossary style identified by \meta{name}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{glossaryheader,
+ name={\csfmt{glossary\-header}},
+ description={implemented at the start of a glossary (modified by
+glossary styles)},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{glsentryitem,
+ name={\csfmt{gls\-entry\-item}},
+ user1={\margm{label}},
+ description={increments and displays the \counter{glossaryentry}
+counter, if appropriate},
+ note={\styfmt{glossaries} v3.0+},
+ category={command}
+}
+
+@index{glssubentryitem,
+ name={\csfmt{gls\-sub\-entry\-item}},
+ user1={\margm{label}},
+ description={increments and displays the \counter{glossarysubentry}
+counter, if appropriate},
+ note={\styfmt{glossaries} v3.0+},
+ category={command}
+}
+
+@index{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}},
+ note={\styfmt{glossaries} v1.18+},
+ category={command}
+}
+
+@index{glsnamefont,
+ name={\csfmt{gls\-name\-font}},
+ user1={\margm{text}},
+ description={used by \cs{glossentryname} to format the name},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{glossentryname,
+ name={\csfmt{gloss\-entry\-name}},
+ user1={\margm{label}},
+ description={used by glossary styles to display the name},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{glossentrysymbol,
+ name={\csfmt{gloss\-entry\-symbol}},
+ user1={\margm{label}},
+ description={used by glossary styles to display the symbol},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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}},
+ note={\styfmt{glossaries} and modified by
+\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossaries-extra} v1.22+},
+ category={command}
+}
+
+@index{glossentrydesc,
+ name={\csfmt{gloss\-entry\-desc}},
+ user1={\margm{label}},
+ description={used by glossary styles to display the description},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{Glossentrydesc,
+ name={\csfmt{Gloss\-entry\-desc}},
+ user1={\margm{label}},
+ description={like \cs{glossentrydesc} but converts the first
+letter to uppercase},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7049,7 +8379,7 @@ can be referenced in \meta{true} or \meta{false} with
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},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7059,8 +8389,8 @@ can be referenced in \meta{true} or \meta{false} with
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 \gls[noindex]{glsadd.format} set to \code{glsignore}},
- note={provided by \styfmt{glossaries}},
+ the \glsaddopt{format} set to \code{glsignore}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7068,7 +8398,7 @@ can be referenced in \meta{true} or \meta{false} with
name={\csfmt{glsadd}},
user1={\oargm{options}\margm{label}},
description={indexes the entry without displaying any text},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7077,7 +8407,7 @@ can be referenced in \meta{true} or \meta{false} with
user1={\oargm{options}\margm{label list}},
description={indexes each entry identified in the comma-separated
list of labels without displaying any text},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
@@ -7109,7 +8439,7 @@ can be referenced in \meta{true} or \meta{false} with
name={\csfmt{theglossaryentry}},
description={textual representation of the \counter{glossaryentry}
counter, which is defined with the \styopt{entrycounter} option},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7117,7 +8447,7 @@ counter, which is defined with the \styopt{entrycounter} option},
name={\csfmt{theHglossaryentry}},
description={hypertarget associated with the \counter{glossaryentry}
counter, which is defined with the \styopt{entrycounter} option},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7127,7 +8457,7 @@ counter, which is defined with the \styopt{entrycounter} option},
description={increments the \counter{glossaryentry} counter, which
is defined with the \styopt{entrycounter} option, and automatically
labels it with \cs{label}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7135,7 +8465,7 @@ labels it with \cs{label}},
name={\csfmt{currentglossary}},
description={defined within the glossary to the current glossary
type, this has no meaning outside of the glossary list},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7143,7 +8473,7 @@ type, this has no meaning outside of the glossary list},
name={\csfmt{front\-matter}},
user1={},
description={switches to front matter},
- note={provided by book-like classes},
+ note={book-like classes},
category={command}
}
@@ -7151,7 +8481,7 @@ type, this has no meaning outside of the glossary list},
name={\csfmt{main\-matter}},
user1={},
description={switches to main matter},
- note={provided by book-like classes},
+ note={book-like classes},
category={command}
}
@@ -7159,7 +8489,7 @@ type, this has no meaning outside of the glossary list},
name={\csfmt{back\-matter}},
user1={},
description={switches to back matter},
- note={provided by book-like classes},
+ note={book-like classes},
category={command}
}
@@ -7167,8 +8497,8 @@ type, this has no meaning outside of the glossary list},
name={\csfmt{Gls\-Xtr\-Set\-Default\-Number\-Format}},
user1={\margm{format}},
description={set the default format to use if the
- \gls[noindex]{glsadd.format} key isn't set},
- note={provided by \styfmt{glossaries-extra} v1.19+},
+ \glsaddopt{format} key isn't set},
+ note={\styfmt{glossaries-extra} v1.19+},
category={command}
}
@@ -7176,7 +8506,7 @@ type, this has no meaning outside of the glossary list},
name={\csfmt{Gls\-Xtr\-Set\-Default\-Gls\-Opts}},
user1={\margm{options}},
description={set the default options for commands like \cs{gls}},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -7185,7 +8515,7 @@ type, this has no meaning outside of the glossary list},
user1={\margm{text}},
description={default location format, uses \cs{glshypernumber} if
hyperlinks enabled otherwise just does \meta{text}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7193,7 +8523,7 @@ hyperlinks enabled otherwise just does \meta{text}},
name={\csfmt{gls\-hyper\-number}},
user1={\margm{text}},
description={a location format that has a hyperlink (if enabled)},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7202,7 +8532,7 @@ hyperlinks enabled otherwise just does \meta{text}},
user1={\margm{text}},
description={a location format that uses the sans-serif
font that also has a hyperlink (if enabled)},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7211,7 +8541,7 @@ hyperlinks enabled otherwise just does \meta{text}},
user1={\margm{text}},
description={a location format that uses the italic
font that also has a hyperlink (if enabled)},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7220,7 +8550,25 @@ hyperlinks enabled otherwise just does \meta{text}},
user1={\margm{text}},
description={a location format that uses the bold
font that also has a hyperlink (if enabled)},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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)},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{hyperrm,
+ name={\csfmt{hyperrm}},
+ user1={\margm{text}},
+ description={a location format that uses the serif (Roman)
+ font that also has a hyperlink (if enabled)},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7234,6 +8582,21 @@ hyperlinks enabled otherwise just does \meta{text}},
category={command}
}
+@index{em,
+ name={\csfmt{em}},
+ description={switch to emphasized font (until end of current scope)},
+ note={kernel command},
+ category={command}
+}
+
+@index{textsf,
+ name={\csfmt{textsf}},
+ user1={\margm{text}},
+ description={displays the given text in sans-serif},
+ note={kernel command},
+ category={command}
+}
+
@index{textbf,
name={\csfmt{textbf}},
user1={\margm{text}},
@@ -7242,6 +8605,13 @@ hyperlinks enabled otherwise just does \meta{text}},
category={command}
}
+@index{bfseries,
+ name={\csfmt{bfseries}},
+ description={switch to bold (until end of current scope)},
+ note={kernel command},
+ category={command}
+}
+
@index{textit,
name={\csfmt{textit}},
user1={\margm{text}},
@@ -7251,6 +8621,49 @@ hyperlinks enabled otherwise just does \meta{text}},
category={command}
}
+@index{texttt,
+ name={\csfmt{texttt}},
+ user1={\margm{text}},
+ description={displays the given text in monospaced font},
+ note={kernel command},
+ category={command}
+}
+
+@index{@firstofone,
+ name={\csfmt{@first\-of\-one}},
+ user1={\margm{code}},
+ description={does \meta{code}},
+ note={kernel command},
+ category={command}
+}
+
+@index{@gobble,
+ name={\csfmt{@gobble}},
+ user1={\margm{code}},
+ description={does nothing (the argument is discarded)},
+ note={kernel command},
+ category={command}
+}
+
+@index{@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},
+ category={command}
+}
+
+@index{alph,
+ name={\csfmt{alph}},
+ user1={\margm{counter}},
+ description={displays the given counter as an alphabetic character
+from \qt{a} to \qt{z}},
+ note={kernel command},
+ category={command}
+}
+
@index{footnote,
name={\csfmt{footnote}},
user1={\oargm{number}\margm{text}},
@@ -7264,7 +8677,7 @@ hyperlinks enabled otherwise just does \meta{text}},
user1={\margm{text}},
description={indexes the given term by writing the relevant
information to an associated file that can then be processed
-by \gls{makeindex} or \gls{xindy}},
+by \idx{makeindex} or \idx{xindy}},
note={kernel command},
category={command}
}
@@ -7274,7 +8687,7 @@ by \gls{makeindex} or \gls{xindy}},
user1={\margm{text}},
description={does nothing but when used as a location format
\bibgls\ recognises it as an \idx{ignoredrecord}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7284,7 +8697,7 @@ by \gls{makeindex} or \gls{xindy}},
description={identifies the style file in the \ext{aux}
file for the benefit of external tools like
\idx{makeglossaries} and \idx{makeglossaries-lite}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7293,8 +8706,8 @@ by \gls{makeindex} or \gls{xindy}},
user1={\margm{text}},
description={does nothing but when used as a location format
\bibgls\ recognises it as an \idx{ignoredrecord} indexed by
- commands like \cs{rgls}},
- note={provided by \styfmt{glossaries-extra} v1.21+},
+ commands like \csref{rgls}},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -7395,6 +8808,14 @@ usual delay},
category={command}
}
+@index{detokenize,
+ name={\csfmt{detokenize}},
+ user1={\margm{general text}},
+ description={expands the argument to a list of character tokens},
+ note={{}\eTeX\ primitive},
+ category={command}
+}
+
@index{input,
name={\csfmt{input}},
user1={\margm{file}},
@@ -7403,6 +8824,15 @@ usual delay},
category={command}
}
+@index{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},
+ category={command}
+}
+
@index{jobname,
name={\csfmt{jobname}},
user1={},
@@ -7428,8 +8858,16 @@ usual delay},
category={command}
}
+@index{ifnum,
+ name={\csfmt{ifnum}},
+ user1={\meta{number1}\meta{comparison}\meta{number2}},
+ description={integer conditional},
+ note={\TeX\ primitive},
+ category={command}
+}
+
@index{renewcommand,
- name={\csfmt{renewcommand}},
+ name={\csfmt{re\-new\-com\-mand}},
user1={\margm{cs}\oargm{n}\oargm{def}\margm{code}},
description={redefines an existing command},
note={kernel command},
@@ -7437,7 +8875,7 @@ usual delay},
}
@index{newcommand,
- name={\csfmt{newcommand}},
+ name={\csfmt{new\-com\-mand}},
user1={\margm{cs}\oargm{n}\oargm{def}\margm{code}},
description={defines a new command},
note={kernel command},
@@ -7445,7 +8883,7 @@ usual delay},
}
@index{providecommand,
- name={\csfmt{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},
@@ -7497,7 +8935,15 @@ usual delay},
user1={\margm{symbol}},
description={renders given maths symbol in bold if supported by
the current font},
- note={provided by \styfmt{amsmath}},
+ note={\styfmt{amsmath}},
+ category={command}
+}
+
+@index{mathcal,
+ name={\csfmt{mathcal}},
+ user1={\margm{character}},
+ description={renders the given (\idx!{uppercase}) maths character in a calligraphic font},
+ note={kernel command (maths mode)},
category={command}
}
@@ -7505,7 +8951,7 @@ usual delay},
name={\csfmt{ifglsentryexists}},
user1={\margm{label}\margm{true}\margm{false}},
description={tests if the entry given by \meta{label} exists},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7513,7 +8959,7 @@ usual delay},
name={\csfmt{gls\-default\-type}},
user1={},
description={the default glossary type},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7521,7 +8967,7 @@ usual delay},
name={\csfmt{gls\-symbols\-group\-name}},
user1={},
description={the name used for the symbols group},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7529,7 +8975,7 @@ usual delay},
name={\csfmt{gls\-numbers\-group\-name}},
user1={},
description={the name used for the numbers group},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7539,7 +8985,7 @@ usual delay},
description={display the glossary by iterating over all entries
associated with that glossary in the order in which they were
defined},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.08+},
category={command}
}
@@ -7549,7 +8995,7 @@ usual delay},
description={as \cs{printunsrtglossary} but performs
\meta{code} first (scoped to localise any assignments within
\meta{code})},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@@ -7558,7 +9004,7 @@ usual delay},
user1={},
description={iterates over all non-ignored defined glossaries
and performs \cs{printunsrtglossary} for each one},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.08+},
category={command}
}
@@ -7566,24 +9012,24 @@ usual delay},
name={\csfmt{print\-unsrt\-glos\-sary\-entry\-process\-hook}},
user1={\margm{label}},
description={performed at each iteration of the internal loop used
-by \gls{printunsrtglossary}},
- note={provided by \styfmt{glossaries-extra} v1.21+},
+by \cs{printunsrtglossary}},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@index{printunsrtglossaryskipentry,
name={\csfmt{print\-unsrt\-glos\-sary\-skip\-entry}},
description={only allowed within
- \gls{printunsrtglossaryentryprocesshook} this command
+ \cs{printunsrtglossaryentryprocesshook} this command
indicates that the current entry should be skipped},
- note={provided by \styfmt{glossaries-extra} v1.21+},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@index{printunsrtglossarypredoglossary,
name={\csfmt{print\-unsrt\-glos\-sary\-pre\-do\-glos\-sary}},
- description={hook performed by \gls{printunsrtglossary}},
- note={provided by \styfmt{glossaries-extra} v1.21+},
+ description={hook performed by \cs{printunsrtglossary}},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -7593,7 +9039,7 @@ by \gls{printunsrtglossary}},
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},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -7602,7 +9048,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}},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -7613,7 +9059,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} which should be fully expandable},
- note={provided by \styfmt{glossaries-extra} v1.21+},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -7665,20 +9111,37 @@ hasn't been defined},
category={commandoption},
}
+@index{printgloss.nogroupskip,
+ parent = {printunsrtglossary},
+ name = {\csoptfmt{no\-group\-skip}},
+ category={commandoption},
+}
+
@index{cs.makeglossaries,
name={\csfmt{make\-glos\-saries}},
user1={},
description={opens associated glossary files to be processed
- by \gls{makeindex} or \gls{xindy}},
- note={provided by \styfmt{glossaries}},
+ by \idx{makeindex} or \idx{xindy}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossaries} v4.04+},
category={command}
}
@index{printglossary,
name={\csfmt{print\-glos\-sary}},
user1={\oargm{options}},
- description={inputs file created by \gls{makeindex} or \gls{xindy}},
- note={provided by \styfmt{glossaries}},
+ description={inputs file created by \idx{makeindex} or \idx{xindy}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7687,7 +9150,7 @@ hasn't been defined},
user1={},
description={iterates over all non-ignored defined glossaries
and performs \cs{printglossary} for each one},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7695,7 +9158,7 @@ hasn't been defined},
name={\csfmt{print\-noidx\-glos\-sary}},
user1={\oargm{options}},
description={uses \TeX\ to sort, collate and list the glossary},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries} v4.04+},
category={command}
}
@@ -7704,7 +9167,7 @@ hasn't been defined},
user1={},
description={iterates over all non-ignored defined glossaries
and performs \cs{printnoidxglossary} for each one},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries} v4.04+},
category={command}
}
@@ -7712,7 +9175,16 @@ hasn't been defined},
name={\csfmt{make\-first\-uc}},
user1={\margm{text}},
description={converts the first letter of \meta{text} to upper case},
- note={provided by \styfmt{mfirstuc}},
+ note={\styfmt{mfirstuc}},
+ category={command}
+}
+
+@index{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+},
category={command}
}
@@ -7720,7 +9192,7 @@ hasn't been defined},
name={\csfmt{ac}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={equivalent to \cs{gls}},
- note={provided by \styfmt{glossaries-extra} \styopt{shortcuts} package
+ note={\styfmt{glossaries-extra} \styopt{shortcuts} package
option},
category={command}
}
@@ -7729,8 +9201,8 @@ option},
name={\csfmt{ab}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={equivalent to \cs{gls}},
- note={provided by \styfmt{glossaries-extra}
- \styopt[abbreviations]{shortcuts} package option},
+ note={\styfmt{glossaries-extra}
+ \styopt[abbreviations]{shortcuts}},
category={command}
}
@@ -7738,7 +9210,23 @@ option},
name={\csfmt{glsxtrp}},
user1={\margm{field}\margm{label}},
description={displays the given field for the entry given by label},
- note={provided by \styfmt{glossaries-extra} v1.07+},
+ note={\styfmt{glossaries-extra} v1.07+},
+ category={command}
+}
+
+@index{glsps,
+ name={\csfmt{glsps}},
+ user1={\margm{label}},
+ description={shortcut for \code{\cs{glsxtrp}\marg{short}\margm{label}}},
+ note={\styfmt{glossaries-extra} v1.07+},
+ category={command}
+}
+
+@index{glspt,
+ name={\csfmt{glspt}},
+ user1={\margm{label}},
+ description={shortcut for \code{\cs{glsxtrp}\marg{text}\margm{label}}},
+ note={\styfmt{glossaries-extra} v1.07+},
category={command}
}
@@ -7746,8 +9234,8 @@ option},
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 \cs{glsxtrfmt}},
- note={provided by \styfmt{glossaries-extra} v1.12},
+ to store the control sequence name for use with \csref{glsxtrfmt}},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@@ -7756,7 +9244,7 @@ option},
user1={\margm{label}},
description={applies \cs{glsseeformat} to the entry's
\field{see} field if not empty},
- note={provided by \styfmt{glossaries-extra} v1.06+},
+ note={\styfmt{glossaries-extra} v1.06+},
category={command}
}
@@ -7765,15 +9253,15 @@ option},
user1={\margm{label}},
description={applies \cs{glsseeformat} to the entry's
\field{seealso} field if not empty},
- note={provided by \styfmt{glossaries-extra} v1.16+},
+ note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
@index{glsxtrsetaliasnoindex,
name={\csfmt{gls\-xtr\-set\-alias\-noindex}},
user1={},
- description={hooks into the alias \gls{gls.noindex} setting},
- note={provided by \styfmt{glossaries-extra} v1.12+},
+ description={hooks into the alias \glsopt{noindex} setting},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@@ -7783,7 +9271,7 @@ option},
description={used to format the entries whose labels are
given in \meta{xr list} as a list of \qt{see also}
cross-references},
- note={provided by \styfmt{glossaries-extra} v1.16+},
+ note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
@@ -7791,7 +9279,7 @@ cross-references},
name={\csfmt{gls\-xtr\-index\-seealso}},
user1={\margm{label}\margm{xr list}},
description={indexes a \qt{see also} cross-reference},
- note={provided by \styfmt{glossaries-extra} v1.16+},
+ note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
@@ -7799,7 +9287,7 @@ cross-references},
name={\csfmt{glssee}},
user1={\oargm{tag}\margm{label}\margm{xr label list}},
description={indexes a \qt{see} cross-reference},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7808,7 +9296,7 @@ cross-references},
user1={\margm{xr label list}},
description={formats the list of cross-reference labels, without
the initial \qt{see} tag},
- note={provided by \styfmt{glossaries-extra} v1.16+},
+ note={\styfmt{glossaries-extra} v1.16+},
category={command}
}
@@ -7818,7 +9306,7 @@ the initial \qt{see} tag},
description={sets the abbreviation style to \meta{style-name} for the
given \meta{category}, must be used before the abbreviation is
defined},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -7826,7 +9314,7 @@ defined},
name={\csfmt{glshex}},
user1={},
description={expands to \cs{cs.string}\cs{u}},
- note={provided by \styfmt{glossaries-extra} v1.21+ (moved to
+ note={\styfmt{glossaries-extra} v1.21+ (moved to
\styfmt{glossaries-extra-bib2gls} in v1.27)},
category={command}
}
@@ -7834,8 +9322,8 @@ defined},
@index{glscapturedgroup,
name={\csfmt{glscapturedgroup}},
user1={},
- description={expands to \cs{cs.string}\gls{dollarchar}},
- note={provided by \styfmt{glossaries-extra-bib2gls} v1.31+},
+ description={expands to \cs{cs.string}\idx{dollarchar}},
+ note={\styfmt{glossaries-extra-bib2gls} v1.31+},
category={command}
}
@@ -7844,7 +9332,7 @@ defined},
user1={},
description={expands to the set of common entry aliases for
\atentry{bibtexentry}},
- note={provided by \styfmt{glossaries-extra-bib2gls} v1.29+},
+ note={\styfmt{glossaries-extra-bib2gls} v1.29+},
category={command}
}
@@ -7853,16 +9341,25 @@ defined},
user1={},
description={defines the standard \BibTeX\ fields using
\cs{glsaddstoragekey}},
- note={provided by \styfmt{glossaries-extra-bib2gls} v1.29+},
+ note={\styfmt{glossaries-extra-bib2gls} v1.29+},
category={command}
}
@index{glsxtrprovidecommand,
- name={\csfmt{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={provided by \styfmt{glossaries-extra-bib2gls} v1.27+},
+ note={\styfmt{glossaries-extra-bib2gls} v1.27+},
+ category={command}
+}
+
+@index{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+},
category={command}
}
@@ -7871,8 +9368,8 @@ defined},
user1={},
description={provides code that locally redefines commands
during the protected write operation performed by
- \cs{glsxtrresourcefile}},
- note={provided by \styfmt{glossaries-extra} v1.21+},
+ \csref{glsxtrresourcefile}},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -7881,7 +9378,7 @@ defined},
user1={},
description={expands to the field label used to store the
entry group labels},
- note={provided by \styfmt{glossaries-extra} v1.21+},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -7889,7 +9386,7 @@ defined},
name={\csfmt{glo\-link\-prefix}},
user1={},
description={target name prefix used in entry hyperlinks},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7898,16 +9395,26 @@ defined},
user1={\oargm{type}\margm{code}},
description={appends \meta{code} to the preamble for the given
glossary},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@index{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}},
+ seealso={apptoglossarypreamble},
category={command}
}
@index{glsbackslash,
name={\csfmt{glsbackslash}},
user1={},
- description={expands to a literal backslash \texttt{\glsbackslash}
+ description={expands to a literal backslash \idx{backslashchar}
character},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7916,7 +9423,7 @@ glossary},
user1={\margm{text}},
description={encapsulates \meta{text} with literal straight
double-quotes \texttt{\glsquote{\meta{text}}}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7924,7 +9431,7 @@ glossary},
name={\csfmt{glstildechar}},
user1={},
description={expands to a literal tilde \texttt{\glstildechar} character},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7933,7 +9440,7 @@ glossary},
user1={},
description={language-sensitive name used for the location list
header for some glossary styles},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -7941,7 +9448,7 @@ glossary},
name={\csfmt{seealsoname}},
user1={},
description={language sensitive \qt{see also} text},
- note={provided by \styfmt{glossaries-extra} or language
+ note={\styfmt{glossaries-extra} or language
packages},
category={command}
}
@@ -7952,7 +9459,7 @@ packages},
description={used by the parenthetical abbreviation styles, this
expands to the label of the field used to store the parenthetical
material},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra} v1.04+},
category={command}
}
@@ -7964,9 +9471,9 @@ packages},
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 \gls{glsxtruserfield} and, if set, the \meta{text} is
+ by \cs{glsxtruserfield} and, if set, the \meta{text} is
followed by a comma and the user value},
- note={provided by \styfmt{glossaries-extra} v1.04+},
+ note={\styfmt{glossaries-extra} v1.04+},
category={command}
}
@@ -7974,7 +9481,7 @@ packages},
name={\csfmt{gls\-xtr\-full\-sep}},
user1={\margm{label}},
description={the separator used in the full format for the parenthetical styles},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -7983,16 +9490,16 @@ packages},
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 \gls{GlsXtrForeignTextField}},
- note={provided by \styfmt{glossaries-extra} v1.32+},
+ given in the field identified by \cs{GlsXtrForeignTextField}},
+ note={\styfmt{glossaries-extra} v1.32+},
category={command}
}
@index{GlsXtrForeignTextField,
name={\csfmt{Gls\-Xtr\-Foreign\-Text\-Field}},
- description={used by \gls{GlsXtrForeignText} to identify
+ description={used by \cs{GlsXtrForeignText} to identify
the field containing the locale tag},
- note={provided by \styfmt{glossaries-extra} v1.32+},
+ note={\styfmt{glossaries-extra} v1.32+},
category={command}
}
@@ -8000,7 +9507,7 @@ packages},
name={\csfmt{gls\-xtr\-paren}},
user1={\margm{text}},
description={used to markup parenthetical material},
- note={provided by \styfmt{glossaries-extra} v1.17+},
+ note={\styfmt{glossaries-extra} v1.17+},
category={command}
}
@@ -8010,7 +9517,7 @@ packages},
description={hook used after the description is displayed in the
glossary for entries that have the
\field{category} set to \code{abbreviation}},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -8020,7 +9527,7 @@ packages},
description={hook used after the description is displayed in the
glossary for entries that have the
\field{category} set to \code{symbol}},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -8030,7 +9537,7 @@ packages},
description={hook used after the description is displayed in the
glossary for entries that have the
\field{category} set to \code{general}},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -8039,21 +9546,18 @@ packages},
user1={},
description={hook used after the description is displayed in the
glossary for entries that have the
- \field{category} set to \meta{category}},
- note={common category hooks such as
- \cs{glsxtrpostdescgeneral} are provided by
-\styfmt{glossaries-extra}, custom categories need the hook defined},
+ \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},
category={command}
}
@index{glsxtrpostnamecategory,
name={\csfmt{gls\-xtr\-post\-name\-\meta{category}}},
user1={},
- description={hook used after the name is displayed in the
- glossary for entries that have the
- \field{category} set to \meta{category}},
- note={user needs to define hook for use with
- \styfmt{glossaries-extra}},
+ 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}},
category={command}
}
@@ -8062,40 +9566,59 @@ packages},
user1={},
description={hook used after commands like \cs{gls}
for entries that have the
- \field{category} set to \meta{category}},
- note={user needs to define hook for use with
- \styfmt{glossaries-extra}},
+ \field{category} set to \meta{category}. If required,
+ this hook can be defined with \cs{glsdefpostlink}},
category={command}
}
@index{GlsXtrFmtDefaultOptions,
name={\csfmt{Gls\-Xtr\-Fmt\-Default\-Options}},
user1={},
- description={the default options used by \cs{glsxtrfmt}},
- note={provided by \styfmt{glossaries-extra}},
+ description={the default options used by \csref{glsxtrfmt}},
+ note={\styfmt{glossaries-extra} v1.12+},
category={command}
}
@index{glslink,
name={\csfmt{glslink}},
- user1={\oargm{options}\margm{label}\oargm{text}},
+ user1={\oargm{options}\margm{label}\margm{text}},
description={links to the entry's location in the glossary with
the given link text without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
seealso={glsdisp},
category={command}
}
@index{glsdisp,
name={\csfmt{glsdisp}},
- user1={\oargm{options}\margm{label}\oargm{text}},
+ 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},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
seealso={glslink},
category={command}
}
+@index{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}},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ seealso={dglsdisp},
+ category={command}
+}
+
+@index{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}},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ seealso={dglsdisp},
+ category={command}
+}
+
@index{glsxtrshort,
name={\csfmt{glsxtrshort}},
user1={\oargm{options}\margm{label}},
@@ -8103,7 +9626,7 @@ packages},
the link text obtained from the \field{short} field (using the
appropriate abbreviation style)
without altering the first use flag},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -8114,7 +9637,7 @@ packages},
the link text obtained from the \field{long} field (using the
appropriate abbreviation style)
without altering the first use flag},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -8126,7 +9649,7 @@ packages},
fields (using the
appropriate abbreviation style)
without altering the first use flag},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -8135,7 +9658,7 @@ fields (using the
user1={\margm{text}},
description={used to encapsulate each word in the long form of an
abbreviation by the \catattr{markwords} attribute},
- note={provided by \styfmt{glossaries-extra} v1.17+},
+ note={\styfmt{glossaries-extra} v1.17+},
category={command}
}
@@ -8143,7 +9666,7 @@ abbreviation by the \catattr{markwords} attribute},
name={\csfmt{glsxtrwordsep}},
description={used to mark spaces between each word in the long form of an
abbreviation by the \catattr{markwords} attribute},
- note={provided by \styfmt{glossaries-extra} v1.17+},
+ note={\styfmt{glossaries-extra} v1.17+},
category={command}
}
@@ -8153,7 +9676,16 @@ abbreviation by the \catattr{markwords} attribute},
description={links to the entry's location in the glossary with
the link text obtained from the \field{text} field
without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{Glstext,
+ name={\csfmt{Glstext}},
+ user1={\oargm{options}\margm{label}\oargm{insert}},
+ description={as \cs{glstext} but converts the first letter to
+ \idx{uppercase}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8163,7 +9695,7 @@ abbreviation by the \catattr{markwords} attribute},
description={links to the entry's location in the glossary with
the link text obtained from the \field{name} field
without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8173,7 +9705,7 @@ abbreviation by the \catattr{markwords} attribute},
description={links to the entry's location in the glossary with
the link text obtained from the \field{first} field
without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8183,7 +9715,7 @@ abbreviation by the \catattr{markwords} attribute},
description={links to the entry's location in the glossary with
the link text obtained from the \field{symbol} field
without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8193,7 +9725,7 @@ abbreviation by the \catattr{markwords} attribute},
description={links to the entry's location in the glossary with
the link text obtained from the \field{description} field
without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8203,7 +9735,7 @@ abbreviation by the \catattr{markwords} attribute},
description={links to the entry's location in the glossary with
the link text obtained from the \field{user1} field
without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8213,7 +9745,7 @@ abbreviation by the \catattr{markwords} attribute},
description={links to the entry's location in the glossary with
the link text obtained from the \field{user2} field
without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8223,7 +9755,7 @@ abbreviation by the \catattr{markwords} attribute},
description={links to the entry's location in the glossary with
the link text obtained from the \field{user3} field
without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8233,7 +9765,7 @@ abbreviation by the \catattr{markwords} attribute},
description={links to the entry's location in the glossary with
the link text obtained from the \field{user4} field
without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8243,7 +9775,7 @@ abbreviation by the \catattr{markwords} attribute},
description={links to the entry's location in the glossary with
the link text obtained from the \field{user5} field
without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8253,7 +9785,7 @@ abbreviation by the \catattr{markwords} attribute},
description={links to the entry's location in the glossary with
the link text obtained from the \field{user6} field
without altering the first use flag},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8262,16 +9794,16 @@ abbreviation by the \catattr{markwords} attribute},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={like \cs{gls} but checks for the record
count trigger setting},
- note={provided by \styfmt{glossaries-extra} version 1.21+},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@dualindexentry{rglsformat,
name={\csfmt{rglsformat}},
user1={\margm{label}\oargm{insert}},
- description={used by \cs{rgls} if the record count
+ description={used by \csref{rgls} if the record count
switch is triggered},
- note={provided by \styfmt{glossaries-extra} version 1.21+},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -8279,8 +9811,8 @@ abbreviation by the \catattr{markwords} attribute},
name={\csfmt{glsxtr\-enable\-record\-count}},
user1={},
description={redefines \cs{gls} etc to their
- \cs{rgls} counterpart},
- note={provided by \styfmt{glossaries-extra} version 1.21+},
+ \csref{rgls} counterpart},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -8289,7 +9821,7 @@ abbreviation by the \catattr{markwords} attribute},
user1={\margm{category list}\margm{value}},
description={sets the \catattr{recordcount} attribute to
\meta{value} for the given categories},
- note={provided by \styfmt{glossaries-extra} version 1.21+},
+ note={\styfmt{glossaries-extra} v1.21+},
category={command}
}
@@ -8303,7 +9835,7 @@ abbreviation by the \catattr{markwords} attribute},
\field{text} field
for general entries) where the text is optionally hyperlinked
to the relevant place in the glossary},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8325,6 +9857,12 @@ abbreviation by the \catattr{markwords} attribute},
parent={gls}
}
+@index{gls.hyper,
+ name={\csoptfmt{hyper}},
+ category={commandoption},
+ parent={gls}
+}
+
@index{gls.textformat,
name={\csoptfmt{text\-format}},
category={commandoption},
@@ -8347,7 +9885,7 @@ abbreviation by the \catattr{markwords} attribute},
name={\csfmt{glspl}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={as \cs{gls} but shows the plural form},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8356,7 +9894,7 @@ abbreviation by the \catattr{markwords} attribute},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={as \cs{gls} but converts the first letter
of the link text to upper case},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8364,7 +9902,7 @@ abbreviation by the \catattr{markwords} attribute},
name={\csfmt{Glspl}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={as \cs{Gls} but shows the plural form},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8372,7 +9910,7 @@ abbreviation by the \catattr{markwords} attribute},
name={\csfmt{GLS}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={as \cs{gls} but converts the link text to upper case},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8380,17 +9918,88 @@ abbreviation by the \catattr{markwords} attribute},
name={\csfmt{GLSpl}},
user1={\oargm{options}\margm{label}\oargm{insert}},
description={as \cs{GLS} but shows the plural form},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@index{pgls,
name={\csfmt{pgls}},
user1={\oargm{options}\margm{label}\oargm{insert}},
- description={does \meta{prefix}\gls{gls}\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},
- note={provided by \styfmt{glossaries-prefix}},
+ note={\styfmt{glossaries-prefix}},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ seealso={glsxtraddlabelprefix,glsxtrprependlabelprefix},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ seealso={glsxtraddlabelprefix,glsxtrprependlabelprefix},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ seealso={glsxtraddlabelprefix,glsxtrprependlabelprefix},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ seealso={glsxtraddlabelprefix,glsxtrprependlabelprefix},
+ category={command}
+}
+
+@index{glsxtraddlabelprefix,
+ name={\csfmt{gls\-xtr\-add\-label\-prefix}},
+ user1={\margm{prefix}},
+ description={appends \meta{prefix} to the prefix label list},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ seealso={dgls,glsxtrprependlabelprefix,glsxtrclearlabelprefixes},
+ category={command}
+}
+
+@index{glsxtrprependlabelprefix,
+ name={\csfmt{gls\-xtr\-prepend\-label\-prefix}},
+ user1={\margm{prefix}},
+ description={prepends \meta{prefix} to the prefix label list},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ seealso={dgls,glsxtraddlabelprefix,glsxtrclearlabelprefixes},
+ category={command}
+}
+
+@index{glsxtrclearlabelprefixes,
+ name={\csfmt{gls\-xtr\-clear\-label\-prefixes}},
+ user1={\margm{prefix}},
+ description={clears the prefix label list},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ seealso={glsxtraddlabelprefix,glsxtrprependlabelprefix},
category={command}
}
@@ -8399,7 +10008,51 @@ abbreviation by the \catattr{markwords} attribute},
user1={\oargm{level}\margm{text}},
description={used with the \glostyle{alttree} style to set the
widest entry name for the given level},
- note={provided by \styfmt{glossary-tree}},
+ note={\styfmt{glossary-tree}},
+ category={command}
+}
+
+@index{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}},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ seealso={glssetwidest,glslongextraSetWidest},
+ category={command}
+}
+
+@index{glsxtrSetWidestFallback,
+ name={\csfmt{gls\-xtr\-Set\-Widest\-Fallback}},
+ user1={\margm{max depth}\margm{list}},
+ description={used by \csref{bibglssetwidesttoplevelfallback} and
+ \csref{bibglssetwidestfallback} to set the
+ 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}},
+ note={\styfmt{glossaries-extra-bib2gls} v1.37+},
+ seealso={glsFindWidestTopLevelName,glsFindWidestLevelTwo},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossary-longextra} v1.37+},
+ seealso={glslongextraUpdateWidest},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossary-longextra} v1.37+},
category={command}
}
@@ -8408,8 +10061,7 @@ abbreviation by the \catattr{markwords} attribute},
user1={\oargm{level}\margm{text}},
description={as \cs{glssetwidest} but only sets if \meta{text} is
wider than the current value},
- note={provided by \styfmt{glossaries-extra-stylemods} version
-1.23+},
+ note={\styfmt{glossaries-extra-stylemods} v1.23+},
seealso={glssetwidest,eglsupdatewidest},
category={command}
}
@@ -8418,8 +10070,7 @@ wider than the current value},
name={\csfmt{egls\-update\-widest}},
user1={\oargm{level}\margm{text}},
description={as \cs{glsupdatewidest} but expands \meta{text}},
- note={provided by \styfmt{glossaries-extra-stylemods} version
-1.23+},
+ note={\styfmt{glossaries-extra-stylemods} v1.23+},
seealso={glssetwidest,glsupdatewidest},
category={command}
}
@@ -8428,7 +10079,7 @@ wider than the current value},
name={\csfmt{gls\-Find\-Widest\-Top\-Level\-Name}},
user1={\oargm{glossary list}},
description={CamelCase synonym for \cs{glsfindwidesttoplevelname}},
- note={provided by \styfmt{glossaries-extra-stylemods}},
+ note={\styfmt{glossaries-extra-stylemods}},
seealso={glsfindwidesttoplevelname},
category={command}
}
@@ -8438,7 +10089,7 @@ wider than the current value},
user1={\oargm{glossary list}},
description={finds the widest top-level name in the given
glossaries},
- note={provided by \styfmt{glossary-tree}},
+ note={\styfmt{glossary-tree}},
category={command}
}
@@ -8447,7 +10098,7 @@ glossaries},
user1={\oargm{glossary list}},
description={finds the widest name in the given glossaries
for the top level and first two sub-levels},
- note={provided by \styfmt{glossaries-extra-stylemods}},
+ note={\styfmt{glossaries-extra-stylemods}},
seealso={glsfindwidesttoplevelname},
category={command}
}
@@ -8457,7 +10108,27 @@ glossaries},
user1={\margm{label}},
description={used with the \glostyle{bookindex} style to
format the entry's name},
- note={provided by \styfmt{glossary-bookindex}},
+ note={\styfmt{glossary-bookindex}},
+ category={command}
+}
+
+@index{glsxtrbookindexprelocation,
+ name={\csfmt{glsxtr\-book\-index\-pre\-location}},
+ user1={\margm{label}},
+ description={used with the \glostyle{bookindex} style before the
+location list},
+ note={\styfmt{glossary-bookindex}},
+ category={command}
+}
+
+@index{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}},
+ note={\styfmt{glossary-bookindex} v1.21+ and
+ \styfmt{glossaries-extra-stylemods} v1.21+},
category={command}
}
@@ -8465,27 +10136,123 @@ glossaries},
name={\csfmt{gls\-abbrv\-sc\-font}},
user1={\margm{text}},
description={used with \qt{sc} abbreviation styles to format the
-short form using \gls{textsc}},
- note={provided by \styfmt{glossaries-extra} v1.17+},
+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,
+ name={\csfmt{gls\-abbrv\-font}},
+ user1={\margm{text}},
+ description={generic abbreviation font command for the short form},
+ note={\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@index{glslongfont,
+ name={\csfmt{gls\-long\-font}},
+ user1={\margm{text}},
+ description={generic abbreviation font command for the long form},
+ note={\styfmt{glossaries-extra} v1.04+},
+ category={command}
+}
+
+@index{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},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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},
+ 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,
name={\csfmt{gls\-xtr\-if\-in\-mark}},
user1={\margm{true}\margm{true}},
- description={used by commands like \gls{glsfmtshort}, this expands
+ 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}},
- note={provided by \styfmt{glossaries-extra} v1.07+},
+ note={\styfmt{glossaries-extra} v1.07+},
category={command}
}
@index{glsxtrRevertTocMarks,
name={\csfmt{gls\-xtr\-Revert\-Toc\-Marks}},
- description={restores original behaviour of \gls{tableofcontents}
- so that \gls{glsxtrifinmark} expands to \meta{false} in the table
+ description={restores original behaviour of \cs{tableofcontents}
+ so that \cs{glsxtrifinmark} expands to \meta{false} in the table
of contents},
- note={provided by \styfmt{glossaries-extra} v1.07+},
+ note={\styfmt{glossaries-extra} v1.07+},
category={command}
}
@@ -8493,7 +10260,7 @@ of contents},
name={\csfmt{gls\-tree\-name\-fmt}},
user1={\margm{text}},
description={used with the tree styles to format the entry's name},
- note={provided by \styfmt{glossary-tree} v4.08+ and redefined by
+ note={\styfmt{glossary-tree} v4.08+ and
\styfmt{glossaries-extra-stylemods} v1.31+},
seealso={glstreegroupheaderfmt,glstreenavigationfmt,glstreedefaultnamefmt},
category={command}
@@ -8504,8 +10271,8 @@ of contents},
user1={\margm{text}},
description={used with the tree styles to format the group
headings},
- note={provided by \styfmt{glossary-tree} v4.22+ and redefined
- by \styfmt{glossaries-extra-stylemods} v1.31+},
+ note={\styfmt{glossary-tree} v4.22+ and
+ \styfmt{glossaries-extra-stylemods} v1.31+},
category={command}
}
@@ -8514,8 +10281,8 @@ headings},
user1={\margm{text}},
description={used with the tree styles to format the navigation
elements},
- note={provided by \styfmt{glossary-tree} v4.22+ and redefined
- by \styfmt{glossaries-extra-stylemods} v1.31+},
+ note={\styfmt{glossary-tree} v4.22+ and
+ \styfmt{glossaries-extra-stylemods} v1.31+},
category={command}
}
@@ -8524,7 +10291,15 @@ elements},
user1={\margm{text}},
description={used as the default format for \cs{glstreenamefmt},
\cs{glstreegroupheaderfmt} and \cs{glstreenavigationfmt}},
- note={provided by \styfmt{glossaries-extra-stylemods} v1.31+},
+ note={\styfmt{glossaries-extra-stylemods} v1.31+},
+ category={command}
+}
+
+@index{glstreeprelocation,
+ name={\csfmt{gls\-tree\-pre\-location}},
+ description={inserted before the location list for top-level
+entries in the \glostyle{tree}-like styles},
+ note={\styfmt{glossaries-extra-stylemods} v1.21+},
category={command}
}
@@ -8533,7 +10308,7 @@ elements},
user1={},
description={length register used by the tabular styles to specify
the width of the description column},
- note={provided by \styfmt{glossary-long} and
+ note={\styfmt{glossary-long} and
\styfmt{glossary-super}},
category={command}
}
@@ -8543,80 +10318,15 @@ the width of the description column},
user1={\margm{label}\margm{location list}},
description={used by the \glostyle{alttree} styles to format the
symbol, description and location},
- note={provided by \styfmt{glossaries-extra-stylemods}},
- category={command}
-}
-
-@index{glsentrylong,
- name={\csfmt{gls\-entry\-long}},
- user1={\margm{label}},
- description={displays the long form without any formatting or
-indexing},
- note={provided by \styfmt{glossaries}},
- category={command}
-}
-
-@index{glossentryname,
- name={\csfmt{gloss\-entry\-name}},
- user1={\margm{label}},
- description={used by glossary styles to display the name},
- note={provided by \styfmt{glossaries}},
- category={command}
-}
-
-@index{glsnamefont,
- name={\csfmt{gls\-name\-font}},
- user1={\margm{text}},
- description={used by \cs{glossentryname} to format the name},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries-extra-stylemods} v1.05+},
category={command}
}
-@index{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},
- note={provided by \styfmt{glossaries-extra} v1.22+},
- category={command}
-}
-
-@index{glossentrydesc,
- name={\csfmt{gloss\-entry\-desc}},
- user1={\margm{label}},
- description={used by glossary styles to display the description},
- note={provided by \styfmt{glossaries}},
- category={command}
-}
-
-@index{Glossentrydesc,
- name={\csfmt{Gloss\-entry\-desc}},
- user1={\margm{label}},
- description={like \cs{glossentrydesc} but converts the first
-letter to uppercase},
- note={provided by \styfmt{glossaries}},
- category={command}
-}
-
-@index{glossentrysymbol,
- name={\csfmt{gloss\-entry\-symbol}},
- user1={\margm{label}},
- description={used by glossary styles to display the symbol},
- note={provided by \styfmt{glossaries}},
- category={command}
-}
-
-@index{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
-\gls{styopt.nopostdot} package option for \sty{glossaries}
-and the \styopt{postpunc} option for \sty{glossaries-extra}},
- note={provided by \styfmt{glossaries} and modified by
-\styfmt{glossaries-extra}},
+@index{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},
+ note={\styfmt{glossaries-extra-stylemods} v1.05+},
category={command}
}
@@ -8625,7 +10335,7 @@ and the \styopt{postpunc} option for \sty{glossaries-extra}},
user1={\margm{accessible text}\margm{text}},
description={used by the accessibility support to interface with
the \sty{accsupp} package},
- note={provided by \styfmt{glossaries-accsupp}},
+ note={\styfmt{glossaries-accsupp}},
category={command}
}
@@ -8635,7 +10345,7 @@ the \sty{accsupp} package},
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},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8647,7 +10357,7 @@ 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},
- note={provided by \styfmt{glossaries-extra} version 1.24+},
+ note={\styfmt{glossaries-extra} v1.24+},
seealso={glsxtrendfor},
category={command}
}
@@ -8657,7 +10367,7 @@ the \sty{accsupp} package},
user1={},
description={may be used within the handler macro
of \cs{glsxtrforcsvfield} to prematurely break the loop},
- note={provided by \styfmt{glossaries-extra} version 1.24+},
+ note={\styfmt{glossaries-extra} v1.24+},
seealso={glsxtrforcsvfield},
category={command}
}
@@ -8666,7 +10376,7 @@ the \sty{accsupp} package},
name={\csfmt{Track\-Locale}},
user1={\margm{language tag}},
description={tracks the given language tag},
- note={provided by \styfmt{tracklang} version 1.3+},
+ note={\styfmt{tracklang} v1.3+},
category={command}
}
@@ -8677,16 +10387,16 @@ the \sty{accsupp} package},
given language tag and stores it in the command \meta{cs}. The
result will be empty if there's no tracked dialect associated with
the given language tag},
- note={provided by \styfmt{tracklang} version 1.3+},
+ note={\styfmt{tracklang} v1.3+},
category={command}
}
@index{TrackedDialectClosestSubMatch,
name={\csfmt{Tracked\-Dialect\-Closest\-Sub\-Match}},
- description={set by \gls{GetTrackedDialectFromLanguageTag}
+ description={set by \cs{GetTrackedDialectFromLanguageTag}
if an exact match isn't found but a partial match on the
root language is found},
- note={provided by \styfmt{tracklang} version 1.3.6+},
+ note={\styfmt{tracklang} v1.3.6+},
category={command}
}
@@ -8695,7 +10405,7 @@ the given language tag},
user1={\margm{tracklang label}\margm{true}\margm{false}},
description={tests if the \styfmt{tracklang} dialect label has
been assigned a mapping to a language hook label},
- note={provided by \styfmt{tracklang} version 1.3+},
+ note={\styfmt{tracklang} v1.3+},
category={command}
}
@@ -8704,7 +10414,7 @@ been assigned a mapping to a language hook label},
user1={\margm{tracklang label}},
description={the language hook label corresponding to the given
\sty{tracklang} label},
- note={provided by \styfmt{tracklang} version 1.3+},
+ note={\styfmt{tracklang} v1.3+},
category={command}
}
@@ -8713,7 +10423,7 @@ been assigned a mapping to a language hook label},
user1={\margm{text}},
description={used by commands like \cs{gls} to format the
\idx{link-text}},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8722,7 +10432,7 @@ been assigned a mapping to a language hook label},
user1={\margm{text}},
description={used by commands like \cs{gls} to format the
\idx{link-text} for regular terms},
- note={provided by \styfmt{glossaries-extra} v1.04+},
+ note={\styfmt{glossaries-extra} v1.04+},
category={command}
}
@@ -8731,7 +10441,7 @@ been assigned a mapping to a language hook label},
user1={\margm{text}},
description={used by commands like \cs{gls} to format the
\idx{link-text} for (non-regular) abbreviations},
- note={provided by \styfmt{glossaries-extra} v1.30+},
+ note={\styfmt{glossaries-extra} v1.30+},
category={command}
}
@@ -8740,7 +10450,7 @@ been assigned a mapping to a language hook label},
user1={\margm{cs}\margm{text}},
description={fully expands \meta{text} and then does
\meta{cs}\margm{expanded text}},
- note={provided by \styfmt{glossaries-extra} v1.30+},
+ note={\styfmt{glossaries-extra} v1.30+},
category={command}
}
@@ -8749,10 +10459,10 @@ been assigned a mapping to a language hook label},
description={starts buffering calls to \cs{glsunset}
for use in code where the boolean switch causes a problem.
The buffer can later be processed and cleared with
- \gls{GlsXtrStopUnsetBuffering}. The starred form
+ \cs{GlsXtrStopUnsetBuffering}. The starred form
(added to v1.31) avoids duplicate labels in the buffer's
internal list},
- note={provided by \styfmt{glossaries-extra} v1.30+},
+ note={\styfmt{glossaries-extra} v1.30+},
category={command}
}
@@ -8761,8 +10471,8 @@ been assigned a mapping to a language hook label},
description={unsets (locally with the starred form)
all the entry whose labels are stored in the
buffer that was started with
- \gls{GlsXtrStartUnsetBuffering} and clears the buffer},
- note={provided by \styfmt{glossaries-extra} v1.30+},
+ \cs{GlsXtrStartUnsetBuffering} and clears the buffer},
+ note={\styfmt{glossaries-extra} v1.30+},
category={command}
}
@@ -8772,9 +10482,9 @@ been assigned a mapping to a language hook label},
description={iterates over
all the entry whose labels are stored in the
buffer that was started with
- \gls{GlsXtrStartUnsetBuffering} and implements
+ \cs{GlsXtrStartUnsetBuffering} and implements
\meta{cs}\margm{label} at each iteration},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
@@ -8783,7 +10493,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},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8792,7 +10502,7 @@ marked as having been used},
user1 = {\margm{label}},
description={resets the \idx{firstuseflag} so that the entry is
marked as not used},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -8800,7 +10510,7 @@ marked as not used},
name={\csfmt{Track\-Lang\-Last\-Tracked\-Dialect}},
user1={},
description={set by commands like \cs{TrackLocale}},
- note={provided by \styfmt{tracklang}},
+ note={\styfmt{tracklang}},
category={command}
}
@@ -8809,7 +10519,7 @@ marked as not used},
user1={\margm{dialect}},
description={expands to the root language associated with the
given (\styfmt{tracklang}) dialect label},
- note={provided by \styfmt{tracklang}},
+ note={\styfmt{tracklang}},
category={command}
}
@@ -8818,7 +10528,7 @@ given (\styfmt{tracklang}) dialect label},
user1={\margm{year}\margm{month}\margm{day}\margm{dow}},
description={formats the given date where all arguments are
numeric},
- note={provided by \styfmt{datetime2}},
+ note={\styfmt{datetime2}},
category={command}
}
@@ -8826,7 +10536,7 @@ given (\styfmt{tracklang}) dialect label},
name={\csfmt{DTL\-format\-list}},
user1={\margm{list}},
description={formats a comma-separated list},
- note={provided by \styfmt{datatool-base}},
+ note={\styfmt{datatool-base}},
category={command}
}
@@ -8835,7 +10545,7 @@ given (\styfmt{tracklang}) dialect label},
user1={},
description={used by \ics{DTLformatlist} to separate items in the
list, except for the last pair},
- note={provided by \styfmt{datatool-base}},
+ note={\styfmt{datatool-base}},
seealso={DTLformatlist},
category={command}
}
@@ -8845,7 +10555,7 @@ list, except for the last pair},
user1={},
description={used by \ics{DTLformatlist} to separate the last two items in the
list},
- note={provided by \styfmt{datatool-base}},
+ note={\styfmt{datatool-base}},
seealso={DTLformatlist},
category={command}
}
@@ -8855,7 +10565,7 @@ list},
user1={},
description={insert before \ics{DTLlistformatlastsep} if the list
has three or more items},
- note={provided by \styfmt{datatool-base}},
+ note={\styfmt{datatool-base}},
seealso={DTLformatlist},
category={command}
}
@@ -8864,7 +10574,7 @@ has three or more items},
name={\csfmt{DTL\-and\-name}},
user1={},
description={used in the definition of \ics{DTLlistformatlastsep}},
- note={provided by \styfmt{datatool-base}},
+ note={\styfmt{datatool-base}},
seealso={DTLformatlist},
category={command}
}
@@ -8873,7 +10583,7 @@ has three or more items},
name={\csfmt{si}},
user1={\margm{unit}},
description={displays the unit with intelligent formatting},
- note={provided by \styfmt{siunitx}},
+ note={\styfmt{siunitx}},
category={command}
}
@@ -8881,7 +10591,52 @@ has three or more items},
name={\csfmt{ce}},
user1={\margm{formula}},
description={displays the chemical formula},
- note={provided by \styfmt{mhchem}},
+ note={\styfmt{mhchem}},
+ category={command}
+}
+
+@index{textweathersymbol,
+ name={\csfmt{text\-weather\-symbol}},
+ user1={\margm{number}},
+ description={displays weather symbol identified by \meta{number}},
+ note={\styfmt{ifsym}},
+ category={command}
+}
+
+@index{toprule,
+ name={\csfmt{top\-rule}},
+ description={horizontal rule for the top of a \envfmt{tabular}-like environment},
+ note={\styfmt{booktabs}},
+ category={command}
+}
+
+@index{midrule,
+ name={\csfmt{mid\-rule}},
+ description={horizontal rule for divider between header and main
+ content of a \envfmt{tabular}-like environment},
+ note={\styfmt{booktabs}},
+ category={command}
+}
+
+@index{bottomrule,
+ name={\csfmt{bottom\-rule}},
+ description={horizontal rule for the bottom of a
+ \envfmt{tabular}-like environment},
+ note={\styfmt{booktabs}},
+ category={command}
+}
+
+@index{endhead,
+ name={\csfmt{end\-head}},
+ description={ends the header section},
+ note={\styfmt{longtable}},
+ category={command}
+}
+
+@index{endfoot,
+ name={\csfmt{end\-foot}},
+ description={ends the footer section},
+ note={\styfmt{longtable}},
category={command}
}
@@ -8889,7 +10644,7 @@ has three or more items},
name={\csfmt{MakeTextLowercase}},
user1={\margm{text}},
description={converts \meta{text} to lower case},
- note={provided by \styfmt{textcase}},
+ note={\styfmt{textcase}},
category={command}
}
@@ -8897,7 +10652,7 @@ has three or more items},
name={\csfmt{MakeTextUppercase}},
user1={\margm{text}},
description={converts \meta{text} to upper case},
- note={provided by \styfmt{textcase}},
+ note={\styfmt{textcase}},
category={command}
}
@@ -8906,7 +10661,7 @@ has three or more items},
user1={\margm{text}},
description={prevents \cs{MakeTextUppercase} and
\cs{MakeTextLowercase} from converting \meta{text}},
- note={provided by \styfmt{textcase}},
+ note={\styfmt{textcase}},
category={command}
}
@@ -8921,7 +10676,29 @@ has three or more items},
@index{char,
name={\csfmt{char}},
user1={\meta{number}},
- description={accesses the character identified by \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},
+ category={command}
+}
+
+@index{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},
+ category={command}
+}
+
+@index{the,
+ name={\csfmt{the}},
+ user1={\meta{register}},
+ description={expands \meta{register} to the current value of the
+ register},
note={{}\TeX\ primitive},
category={command}
}
@@ -8975,6 +10752,146 @@ has three or more items},
category={command}
}
+@index{AA,
+ name={\csfmt{AA}},
+ description={produces the \idx!{uppercase} A-ring character \AA},
+ note={kernel command},
+ category={command}
+}
+
+@index{aa,
+ name={\csfmt{aa}},
+ description={produces the \idx!{lowercase} a-ring character \aa},
+ note={kernel command},
+ category={command}
+}
+
+@index{O,
+ name={\csfmt{O}},
+ description={produces the \idx!{uppercase} O-slash character \O},
+ note={kernel command},
+ category={command}
+}
+
+@index{o,
+ name={\csfmt{o}},
+ description={produces the \idx!{lowercase} o-slash character \o},
+ note={kernel command},
+ category={command}
+}
+
+@index{L,
+ name={\csfmt{L}},
+ description={produces the \idx!{uppercase} L-slash character \L},
+ note={kernel command},
+ category={command}
+}
+
+@index{l,
+ name={\csfmt{l}},
+ description={produces the \idx!{lowercase} l-slash character \l},
+ note={kernel command},
+ category={command}
+}
+
+@index{ae,
+ name={\csfmt{ae}},
+ description={produces the \idx!{lowercase} \ae-ligature},
+ note={kernel command},
+ category={command}
+}
+
+@index{AE,
+ name={\csfmt{AE}},
+ description={produces the \idx!{uppercase} \AE-ligature},
+ note={kernel command},
+ category={command}
+}
+
+@index{oe,
+ name={\csfmt{oe}},
+ description={produces the \idx!{lowercase} \oe-ligature},
+ note={kernel command},
+ category={command}
+}
+
+@index{OE,
+ name={\csfmt{OE}},
+ description={produces the \idx!{uppercase} \OE-ligature},
+ note={kernel command},
+ category={command}
+}
+
+@index{th,
+ name={\csfmt{th}},
+ description={produces the \idx!{lowercase} thorn \th},
+ note={kernel command},
+ category={command}
+}
+
+@index{TH,
+ name={\csfmt{TH}},
+ description={produces the \idx!{uppercase} thorn \TH},
+ note={kernel command},
+ category={command}
+}
+
+@index{ss,
+ name={\csfmt{ss}},
+ description={produces the \idx!{lowercase} eszett \ss},
+ note={kernel command},
+ category={command}
+}
+
+@index{SS,
+ name={\csfmt{SS}},
+ description={produces the \idx!{uppercase} eszett \SS},
+ note={kernel command},
+ category={command}
+}
+
+@index{ng,
+ name={\csfmt{ng}},
+ description={produces the \idx!{lowercase} eng \ng},
+ note={kernel command},
+ category={command}
+}
+
+@index{NG,
+ name={\csfmt{NG}},
+ description={produces the \idx!{uppercase} eng \NG},
+ note={kernel command},
+ category={command}
+}
+
+@index{dh,
+ name={\csfmt{dh}},
+ description={produces the \idx!{lowercase} eth \dh},
+ note={kernel command},
+ category={command}
+}
+
+@index{DH,
+ name={\csfmt{DH}},
+ description={produces the \idx!{uppercase} eth \DH},
+ note={kernel command},
+ category={command}
+}
+
+@index{dj,
+ name={\csfmt{dj}},
+ description={produces the \idx!{lowercase} d-stroke \dj},
+ note={kernel command},
+ category={command}
+}
+
+@index{DJ,
+ name={\csfmt{DJ}},
+ description={produces the \idx!{uppercase} d-stroke \DJ},
+ note={kernel command},
+ category={command}
+}
+
@index{textsuperscript,
name={\csfmt{textsuperscript}},
user1={\margm{text}},
@@ -9064,12 +10981,26 @@ by \meta{name}},
category={command}
}
+@index{cs.color,
+ name={\csfmt{color}},
+ user1={\oargm{model}\margm{spec}},
+ description={switches the current font colour},
+ note={\styfmt{color}},
+ category={command}
+}
+
+@index{textcolor,
+ name={\csfmt{textcolor}},
+ user1={\oargm{model}\margm{spec}\margm{text}},
+ description={typesets \meta{text} in the given colour},
+ note={\styfmt{color}},
+ category={command}
+}
+
@index{cjkname,
name={\csfmt{cjkname}},
user1={\margm{CJK characters}},
- description={displays \meta{CJK characters} in the appropriate
- encoding},
- note={provided by \styfmt{CJKutf8}},
+ description={example command},
category={command}
}
@@ -9077,7 +11008,7 @@ by \meta{name}},
name={\csfmt{citation}},
user1={\margm{label}},
description={written to the \ext{aux} file on each occurrence of
- \gls[noindex]{cite}},
+ \cs{cite}},
note={kernel command},
category={command}
}
@@ -9136,6 +11067,16 @@ occurred},
category={command}
}
+@index{autoref,
+ name={\csfmt{autoref}},
+ user1={\margm{id}},
+ description={cross-reference with textual tag inferred from the
+associated counter},
+ seealso={label},
+ note={\sty{hyperref}},
+ category={command}
+}
+
@index{par,
name={\csfmt{par}},
description={paragraph break},
@@ -9148,7 +11089,7 @@ occurred},
user1={\margm{target name}\margm{text}},
description={create a hyperlink to \meta{target name} with the given
\meta{text}},
- note={provided by \styfmt{hyperref}},
+ note={\styfmt{hyperref}},
category={command}
}
@@ -9157,10 +11098,58 @@ occurred},
user1={\margm{target name}\margm{text}},
description={create a hypertarget with the given \meta{target
name} and the displayed \meta{text}},
- note={provided by \styfmt{hyperref}},
+ note={\styfmt{hyperref}},
category={command}
}
+@index{cs.hyperref,
+ name={\csfmt{hyperref}},
+ note={\styfmt{hyperref}},
+ category={command}
+}
+
+@index{cs.hyperref.ext,
+ parent={cs.hyperref},
+ name={\csfmt{hyperref}},
+ user1={\margm{URL}\margm{category}\margm{name}\margm{text}},
+ description={create a hyperlink to an external location with
+ the anchor formed from \code{\meta{category}.\meta{name}}
+ and the displayed \meta{text}},
+ category={command}
+}
+
+@index{cs.hyperref.int,
+ parent={cs.hyperref},
+ name={\csfmt{hyperref}},
+ user1={\oargm{label}\margm{text}},
+ description={create an internal hyperlink with
+ the displayed \meta{text} to the same place
+ that \code{\cs{ref}\margm{label}} would be linked.
+ Note that the \meta{label} argument isn't optional. The
+ square bracket notation disambiguates from the
+ syntax for the external form of \cs{cs.hyperref.ext}},
+ category={command}
+}
+
+@index{@currentlabelname,
+ name={\csfmt{@current\-label\-name}},
+ user1={},
+ description={used to store the current title information for the next instance
+ of \cs{label}},
+ note={\styfmt{hyperref}},
+ category={command}
+}
+
+@index{@currentHref,
+ name={\csfmt{@current\-H\-ref}},
+ user1={},
+ description={used to store the current anchor for the next instance
+ of \cs{label}},
+ note={\styfmt{hyperref}},
+ category={command}
+}
+
+
@index{glsrefentry,
name={\csfmt{gls\-ref\-entry}},
user1={\margm{label}},
@@ -9168,7 +11157,7 @@ name} and the displayed \meta{text}},
\styopt{subentrycounter} may be used to cross-reference the
entry's number in the glossary list with \cs{ref}},
seealso={ref},
- note={provided by \styfmt{glossaries} v3.0+},
+ note={\styfmt{glossaries} v3.0+},
category={command}
}
@@ -9179,7 +11168,7 @@ name} and the displayed \meta{text}},
\styopt{subentrycounter} may be used to cross-reference the
entry's number in the glossary list with \cs{pageref}},
seealso={pageref},
- note={provided by \styfmt{glossaries-extra} v1.11},
+ note={\styfmt{glossaries-extra} v1.11},
category={command}
}
@@ -9188,8 +11177,8 @@ name} and the displayed \meta{text}},
user1={\margm{label}},
description={displays the given entry name including a hypertarget (if
\sty{hyperref} has been loaded) as the destination for commands like
-\gls{gls}},
- note={provided by \styfmt{glossaries-extra} v1.21},
+\cs{gls}},
+ note={\styfmt{glossaries-extra} v1.21},
category={command}
}
@@ -9200,7 +11189,7 @@ name} and the displayed \meta{text}},
in the supplied internal \meta{field} where \meta{header} is the
code
to use in the header (leave empty for default)},
- note={provided by \styfmt{glossaries-extra} v1.22+},
+ note={\styfmt{glossaries-extra} v1.22+},
category={command}
}
@@ -9209,16 +11198,16 @@ to use in the header (leave empty for default)},
user1={\margm{label}},
description={used to show the target name when the
\styopt[showtargets]{debug} option is on},
- note={provided by \styfmt{glossaries} v4.32+},
+ note={\styfmt{glossaries} v4.32+},
category={command}
}
@index{GlsEntryCounterLabelPrefix,
name={\csfmt{Gls\-Entry\-Counter\-Label\-Prefix}},
- description={used as a prefix in the \gls{label} command
+ description={used as a prefix in the \cs{label} command
automatically implemented by the \styopt{entrycounter}
and \styopt{subentrycounter} options},
- note={provided by \styfmt{glossaries} v4.38+},
+ note={\styfmt{glossaries} v4.38+},
category={command}
}
@@ -9226,7 +11215,7 @@ to use in the header (leave empty for default)},
name={\csfmt{Gls\-Xtr\-Stand\-alone\-Glossary\-Type}},
description={expands to the label for \gls{currentglossary}
within \gls{glsxtrglossentry} and \gls{glsxtrglossentryother}},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ note={\styfmt{glossaries-extra} v1.31+},
category={command}
}
@@ -9235,7 +11224,25 @@ to use in the header (leave empty for default)},
user1 = {\margm{label}},
description={used within \gls{glsxtrglossentry} and
\gls{glsxtrglossentryother} to display sub-item labels},
- note={provided by \styfmt{glossaries-extra} v1.31+},
+ note={\styfmt{glossaries-extra} v1.31+},
+ category={command}
+}
+
+@index{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)},
+ note={\styfmt{glossaries-extra} v1.37+},
+ category={command}
+}
+
+@index{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)},
+ note={\styfmt{glossaries-extra} v1.37+},
category={command}
}
@@ -9243,7 +11250,16 @@ to use in the header (leave empty for default)},
name={\csfmt{gls\-reset\-entry\-counter}},
description={resets the \counter{glossaryentry} counter if the
\styopt{entrycounter} setting is on},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
+ category={command}
+}
+
+@index{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}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -9252,7 +11268,7 @@ to use in the header (leave empty for default)},
user1 = {\margm{\keyvallist}},
description={applies the base \styfmt{glossaries} options
that are allowed to be changed after the package has loaded},
- note={provided by \styfmt{glossaries}},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -9261,7 +11277,7 @@ to use in the header (leave empty for default)},
user1 = {\margm{\keyvallist}},
description={applies the extension \styfmt{glossaries-extra} options
that are allowed to be changed after the package has loaded},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -9270,7 +11286,7 @@ to use in the header (leave empty for default)},
user1={\margm{label}},
description={separator used before the description for the
\glostyle{tree} styles},
- note={provided by \styfmt{glossary-tree} v4.26+},
+ note={\styfmt{glossary-tree} v4.26+},
category={command}
}
@@ -9280,7 +11296,7 @@ to use in the header (leave empty for default)},
description={displays the pre-description separator, the
description and the post-description hook for the
\glostyle{treenoname} styles},
- note={provided by \styfmt{glossaries-extra-stylemods} v1.31+},
+ note={\styfmt{glossaries-extra-stylemods} v1.31+},
category={command}
}
@@ -9289,7 +11305,7 @@ to use in the header (leave empty for default)},
user1={\margm{label}},
description={provided for use in section or caption titles, this
displays the short form of the given abbreviation},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -9298,7 +11314,7 @@ displays the short form of the given abbreviation},
user1={\margm{label}},
description={provided for use in section or caption titles, this
displays the long form of the given abbreviation},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -9307,7 +11323,7 @@ displays the long form of the given abbreviation},
user1={\margm{label}},
description={provided for use in section or caption titles, this
displays the full form of the given abbreviation},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -9316,7 +11332,7 @@ displays the full form of the given abbreviation},
user1={\margm{label}},
description={provided for use in section or caption titles, this
displays the given entry's name},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -9325,7 +11341,7 @@ displays the given entry's name},
user1={\margm{label}},
description={provided for use in section or caption titles, this
displays the given entry's \field{first} field},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
category={command}
}
@@ -9334,7 +11350,18 @@ displays the given entry's \field{first} field},
user1={\margm{label}},
description={provided for use in section or caption titles, this
displays the given entry's \field{text} field},
- note={provided by \styfmt{glossaries-extra}},
+ note={\styfmt{glossaries-extra}},
+ category={command}
+}
+
+@index{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})},
+ note={\styfmt{glossaries}},
category={command}
}
@@ -9359,7 +11386,7 @@ sectioning commands to write to it},
name={\csfmt{ul}},
user1={\margm{text}},
description={underlines the given text},
- note={provided by \styfmt{soul}},
+ note={\styfmt{soul}},
category={command}
}
@@ -9367,7 +11394,7 @@ sectioning commands to write to it},
name={\csfmt{ding}},
user1={\margm{number}},
description={displays the symbol associated with the given number},
- note={provided by \styfmt{pifont}},
+ note={\styfmt{pifont}},
category={command}
}