Debian Codegraph @

texmf-dist/source/support/bib2gls/bib2gls-terms.bib

raw
1 % Encoding: UTF-8
2
3 @entry{entrytype,
4 name={entry type},
5 description={an entry's identifying type, as specified by \atentryfmt{entry-type}.
6 (Not to be confused with the glossary label, which is identified by
7 the \field{type} field.) When referenced in a resource option, the
8 leading \code{@} is typically omitted. The \emph{original} entry type
9 refers to the entry type as specified in the \ext{bib} file. The
10 \emph{actual} entry type may be different and will be the result
11 of a conversion via resource options such as \csopt{entry-type-aliases}.
12 Although the \ext{bib} format is case-insensitive, references to the
13 entry type in resource options should typically be in \idx{lowercase}.}
14 }
15
16 @entry{primaryentry,
17 name={primary entry},
18 plural={primary entries},
19 user1={idx.primary},
20 description={The original entry created from a dual-\gls{entrytype}
21 (such as \atentry{dualentry}) or the entry from
22 single-\glspl{entrytype} (such as \atentry{entry}) or \glspl{spawnedentry}.}
23 }
24
25 @entry{dualentry,
26 name={dual entry},
27 plural={dual entries},
28 user1={idx.dual},
29 description={The duplicate entry created from a dual-\gls{entrytype}
30 (such as \atentry{dualentry}). This duplicate is based on the
31 \gls{primaryentry} with modifications made according to various
32 settings. With tertiary \glspl{entrytype}, the dual entry represents
33 two entries: the \glsdisp{secondaryentry}{secondary} and
34 \glsdisp{tertiaryentry}{tertiary}.
35 See \sectionref{sec:dualentry}.}
36 }
37
38 @entry{secondaryentry,
39 name={secondary entry},
40 plural={secondary entries},
41 user1={idx.secondary},
42 description={For the tertiary \glspl{entrytype}, such as
43 \atentry{tertiaryindexabbreviationentry}, there are only actually
44 two objects defined within \bibgls: the
45 \glsdisp{primaryentry}{primary} and the \glsdisp{dualentry}{dual},
46 but the code that is written in the \ext{glstex} file for the
47 \gls{dualentry} actually defines two entries, which are the
48 secondary and tertiary entries.
49 This should not be confused with the \gls{secondaryglossary}.
50 See \sectionref{sec:tertiaryentry}.}
51 }
52
53 @entry{tertiaryentry,
54 name={tertiary entry},
55 plural={tertiary entries},
56 user1={idx.tertiary},
57 description={An entry that isn't defined as a separated object
58 within \bibgls, but is defined within the \ext{glstex} file
59 as a by-product of the dual definition code for tertiary
60 \glspl{entrytype}.}
61 }
62
63 @entry{mainentry,
64 name={main entry},
65 plural={main entries},
66 description={The originating entry from which
67 the \glspl{spawnedentry} are created. A main entry may
68 be a dual-\gls{entrytype}, consisting of a \gls{primaryentry}
69 and \gls{dualentry}.
70 (Not to be confused with the main glossary or the \gls{compmainlabel}
71 of a \gls{compoundentry}.)}
72 }
73
74 @entry{progenitor,
75 name={progenitor},
76 user1={idx.progenitor},
77 description={The \gls{mainentry} for the \atentry{progenitor}
78 \gls{entrytype}.}
79 }
80
81 @entry{progeny,
82 name={progeny},
83 user1={idx.progeny},
84 description={The \glspl{spawnedentry} for the \atentry{progenitor}
85 \gls{entrytype}.}
86 }
87
88 @entry{multientrytype,
89 name={multi-entry type},
90 description={An \gls{entrytype} that can spawn multiple
91 \glspl{primaryentry}. Some multi-\glspl{entrytype} can also spawn a
92 \gls{dualentry}. See \sectionref{sec:multientry}.
93 For the \sty{glossaries-extra} \qt{multi (compound or combined) entries}
94 that are defined with \cs{multiglossaryentry} see \gls{compoundentry}.}
95 }
96
97 @entry{spawnedentry,
98 name={spawned entry},
99 plural={spawned entries},
100 description={A duplicate entry created from a \gls{multientrytype}
101 (such as \atentry{spawnentry}).}
102 }
103
104 @entry{principallocation,
105 name={principal (or primary) location},
106 text={principal location},
107 description={A special \gls{location} (\gls{record}) which indicates the principal
108 or primary place in the document where the entry is mentioned
109 or discussed. The \gls{location} is identified by the principal or
110 primary format (\csopt{principal-location-formats}).}
111 }
112
113 @entry{mainglossary,
114 name={main glossary},
115 description={The default glossary in the document identified by
116 \cs{glsdefaulttype} (which will have the label \code{main} unless
117 \styopt{nomain} is used). If \styopt{nomain} is used then
118 \cs{glsdefaulttype} will be set to the label of the first glossary
119 to be defined.}
120 }
121
122 @entry{mainlist,
123 name={main (or primary) list},
124 text={main list},
125 description={The \bibgls\ list of \glspl{primaryentry}, which is sorted
126 according to the \csopt{sort} resource option. The entries may or
127 may not be assigned to the same glossary, and the list may only be
128 a subset of entries. If \csopt[combine]{dual-sort} is used, then
129 the main list will also contain all the \glspl{dualentry}.}
130 }
131
132 @entry{duallist,
133 name={dual list},
134 description={The \bibgls\ list of \glspl{dualentry}, which is sorted
135 according to the \csopt{dual-sort} resource option. The entries may or
136 may not be assigned to the same glossary, and the list may only be
137 a subset of entries. If \csopt[combine]{dual-sort} is used then
138 all entries will be in the \gls{mainlist} and there won't be a dual
139 list.}
140 }
141
142 @entry{primaryglossary,
143 name={primary (or principal) glossary},
144 text={primary glossary},
145 plural={primary glossaries},
146 description={A glossary that contains entries that have the \field{type}
147 field set to that glossary's label. Note that a primary glossary
148 may contain both \glsdisp{primaryentry}{primary} and
149 \glspl{dualentry}.}
150 }
151
152 @entry{secondaryglossary,
153 name={secondary glossary},
154 plural={secondary glossaries},
155 description={A secondary glossary is one that contains labels of
156 entries that have been defined for another glossary. The actual
157 entry's \field{type} field will be set to the
158 \gls{primaryglossary}.}
159 }
160
161 @entry{record,
162 name={record},
163 description={Recording is \bibgls's equivalent of indexing.
164 When the \styopt{record} package option is set, each
165 time an entry is indexed in the document (using commands like
166 \cs{gls} or \cs{glstext}) a record is added to the \ext{aux}
167 file that makes a note of the entry label, the location, the
168 counter that was used to obtain the \gls{location}, and (optionally)
169 hyperlink information. A record may be \glsdisp{ignoredrecord}{ignored}
170 or \glsdisp{discardedrecord}{discarded} but, regardless of this,
171 if an entry has at least one record it will be considered for selection
172 for any of the \qt{recorded} selection options.}
173 }
174
175 @entry{location,
176 name={location},
177 description={The value of the indexing counter when an entry is
178 \glsdisp{record}{recorded}. By default, this is the \counter{page}
179 counter. Each location has an associated format or \idx{encap},
180 which is the name of a formatting command that should be used to
181 encapsulate the location's value in the \gls{locationlist}.
182 The default is \encap{glsnumberformat}.}
183 }
184
185 @entry{ignoredrecord,
186 name={ignored record},
187 user1={idx.ignoredrecord},
188 description={A record with the format \encap{glsignore} or
189 \encap{glstriggerrecordformat}. This record indicates that the
190 entry should be considered for selection
191 with any of the \qt{recorded} selection options, but the record
192 should not be added to the \gls{locationlist}.}
193 }
194
195 @entry{discardedrecord,
196 name={discarded record},
197 description={A record that is discarded because either it is
198 identical to another record or it conflicts with another record.}
199 }
200
201 @entry{supplementalrecord,
202 name={supplemental record},
203 description={A record obtained from another document.
204 See \sectionref{sec:supplementalopts}.}
205 }
206
207 @entry{supplementaldocument,
208 name={supplemental (or supplementary) document},
209 text={supplemental document},
210 description={A related document from which
211 \glspl{supplementalrecord} are obtained.}
212 }
213
214 @entry{maindocument,
215 name={main document},
216 description={The principal document that has its own glossary but
217 the \glspl{locationlist} may also contain external
218 \glspl{location} obtained from a \gls{supplementaldocument}.}
219 }
220
221 @entry{recordcount,
222 name={record count},
223 description={An entry's record count is the total number of records
224 (including \glsdisp{discardedrecord}{discarded} and
225 \glsdisp{ignoredrecord}{ignored}) written to the \ext{aux} file
226 that are associated with the entry. It's also possible to have
227 sub-totals for each record counter.}
228 }
229
230 @entry{recordedentry,
231 name={recorded entry},
232 plural={recorded entries},
233 description={An entry that has one or more \glspl{record}.}
234 }
235
236 @entry{unrecordedentry,
237 name={unrecorded entry},
238 plural={unrecorded entries},
239 description={An entry that doesn't have any \glspl{record}.}
240 }
241
242 @entry{locationlist,
243 name={location list},
244 user1={idx.locationlist},
245 description={Formatted list of \glspl{location} obtained from an entry's
246 \glspl{record}. This won't include \glsdisp{ignoredrecord}{ignored}
247 or \glsdisp{discardedrecord}{discarded} records, and a run of
248 \glspl{location} may be compressed into a range. See
249 \sectionref{sec:locationopts} and \sectionref{sec:loclistdefs}.}
250 }
251
252 @entry{parententry,
253 name={parent entry},
254 plural={parent entries},
255 user1={idx.hierarchical-entry},
256 description={An entry in a \gls{hierarchicalglossary}
257 that is linked to, but one level up from, its associated
258 \gls{childentry}. See \sectionref{sec:hierarchicalopts}.}
259 }
260
261 @entry{childentry,
262 name={child entry},
263 plural={child entries},
264 user1={idx.hierarchical-entry},
265 description={An entry in a \gls{hierarchicalglossary}
266 that is linked to, but one level down from, its associated
267 \gls{parententry}. See \sectionref{sec:hierarchicalopts}.}
268 }
269
270 @entry{sub-entry,
271 name={sub-entry},
272 plural={sub-entries},
273 user1={idx.hierarchical-entry},
274 description={A \gls{childentry}. More specifically, when
275 contrasted with sub-sub-entry etc, this may refer to level~1 entries
276 (which have a \glsdisp{parententry}{parent} that is a
277 \gls{top-levelentry}). See \sectionref{sec:hierarchicalopts}.}
278 }
279
280 @entry{hierarchicalglossary,
281 name={hierarchical glossary},
282 plural={hierarchical glossaries},
283 user1={idx.hierarchical-entry},
284 description={A glossary where the entries are ranked according to
285 some classification. Level~0 indicates \glspl{top-levelentry},
286 level~1 indicates \glspl{childentry} that have a
287 level~0 \glsdisp{parententry}{parent}, level~2 indicates
288 \glspl{childentry} that have a
289 level~1 \glsdisp{parententry}{parent}, and so on. See \sectionref{sec:hierarchicalopts}.}
290 }
291
292 @entry{flatglossary,
293 name={flat glossary},
294 description={A glossary that has no \glsdisp{hierarchicalglossary}{hierarchy}.
295 That is, there are no \glspl{childentry}. See \sectionref{sec:hierarchicalopts}.}
296 }
297
298 @entry{sibling,
299 name={sibling entry},
300 text={sibling},
301 description={Two or more \glspl{childentry} are siblings if
302 they all share the same \gls{parententry}.
303 See \sectionref{sec:hierarchicalopts}.}
304 }
305
306 @entry{lonelychildentry,
307 name={lonely child entry},
308 plural={lonely child entries},
309 user1={idx.hierarchical-entry},
310 description={A \gls{childentry} that has no selected \glspl{sibling}.
311 See \sectionref{sec:hierarchicalopts}.}
312 }
313
314 @entry{ancestor,
315 name={ancestor},
316 user1={idx.hierarchical-entry},
317 description={An entry's \glsdisp{parententry}{parent} or an ancestor of
318 the \glsdisp{parententry}{parent}. See \sectionref{sec:hierarchicalopts}.}
319 }
320
321 @entry{top-levelentry,
322 name={top-level entry},
323 plural={top-level entries},
324 user1={idx.hierarchical-entry},
325 description={An entry that doesn't have a \gls{parententry}.
326 This entry is the hierarchical root for all its descendents.
327 See \sectionref{sec:hierarchicalopts}.}
328 }
329
330 @entry{masterdocument,
331 name={master document},
332 description={A main or principal document that contains a glossary
333 with entries referenced by smaller documents that don't have their own
334 glossary. See \sectionref{sec:master}.}
335 }
336
337 @entry{primarycollatorstrength,
338 name={primary collator strength},
339 description={A collator strength value that indicates only primary
340 differences are considered significant during comparison.
341 This is locale dependant, but typically different base letters
342 are considered a primary difference.}
343 }
344
345 @entry{secondarycollatorstrength,
346 name={secondary collator strength},
347 description={A collator strength value that indicates only primary
348 and secondary differences are considered significant during comparison.
349 This is locale dependant. For example, in some languages different
350 accented forms of the same base letter may be considered a
351 secondary difference.}
352 }
353
354 @entry{tertiarycollatorstrength,
355 name={tertiary collator strength},
356 description={A collator strength value that indicates only
357 primary, secondary and tertiary differences are considered
358 significant during comparison. This is locale dependant. For
359 example, different cases of the same base letter may be considered a
360 tertiary difference.}
361 }
362
363 @entry{identicalcollatorstrength,
364 name={identical collator strength},
365 description={A collator strength value that indicates that all
366 differences are considered significant during comparison.}
367 }
368
369 @entry{definitionindex,
370 name={definition index},
371 description={An index (starting from 0) that's incremented
372 every time a new entry object is created within \bibgls.
373 This relates to the order of definitions within the \ext{bib}
374 files. Each \gls{dualentry} and \gls{spawnedentry} will increment
375 the underlying counter but only when they are created, which
376 may not happen until after all \ext{bib} files for the \gls{resourceset} have
377 been parsed.}
378 }
379
380 @entry{orderofuseindex,
381 name={order of use index},
382 description={The \gls{record} index is a value (starting from 0) that's incremented
383 every time a \gls{record} is created while parsing the \ext{aux} file.
384 The first time a non-\gls{ignoredrecord} is added to a given entry, the
385 \gls{record} index is assigned to that entry's order of use index. So the
386 index provides a relative order of use. So if entry1 is the first entry
387 to be indexed, it will have order of use index~0. If entry1 is
388 then indexed twice more and then entry2 is indexed, then entry2's
389 order of use index will be~3.}
390 }
391
392 @entry{resourceset,
393 name={resource set},
394 user1={idx.resourceset},
395 description={The set of options and entries associated with a
396 \gls{resourcecommand}. See \sectionref{sec:resourcesets}.}
397 }
398
399 @entry{resourcecommand,
400 name={resource command},
401 description={\gls{glsxtrresourcefile} or \gls{GlsXtrLoadResources}.}
402 }
403
404 @entry{resource-locale,
405 name = {resource locale},
406 user1={idx.locale-resource},
407 description={the default locale for the given \gls{resourceset}.
408 This can be set with the \csopt{locale} resource option. If not
409 explicitly set, then the default will be the document language, if
410 it has been detected by \sty{tracklang} or identified with
411 \commonlongarg{locale}, or the \idx{JRE} locale otherwise.}
412 }
413
414 @entry{document-locale,
415 name = {document locale},
416 user1={idx.locale-doc},
417 description={the locale associated with the document
418 language (or by \commonlongarg{locale}, if no document language has been
419 detected). In the case of a multi-lingual document, this
420 is the locale of the last language resource file to be loaded through
421 \isty{tracklang}'s interface. It's best to explicitly set the locale
422 for multi-lingual documents to avoid confusion (either with
423 the \csopt{locale} or as a language tag in options such as
424 \csopt{sort}).}
425 }
426
427 @entry{Java-locale,
428 name = {Java locale},
429 user1={idx.locale-Java},
430 description={the default locale for the \idx{JRE}, which usually
431 matches the operating system's locale.}
432 }
433
434 @entry{crossresourceref,
435 name={cross-resource reference},
436 user1={idx.crossresourceref},
437 description={A reference from a \gls{recordedentry} provided in
438 one \gls{resourceset} to an \gls{unrecordedentry} in another
439 \gls{resourceset}. See \sectionref{sec:resourcesets}.}
440 }
441
442 @entry{cross-referencefield,
443 name={cross-reference field},
444 description={A field used for cross-referencing another entry:
445 \field{see}, \field{seealso} and \field{alias}.
446 Other fields can be identified as a list of dependent entry labels
447 with \csopt{dependency-fields}.}
448 }
449
450 @entry{ignoredglossary,
451 name={ignored glossary},
452 plural={ignored glossaries},
453 user1={idx.ignoredglossary},
454 description={A glossary defined with commands like
455 \cs{newignoredglossary}. An ignored glossary doesn't have an
456 associated title (so if one is required it needs to be explicitly
457 set), and isn't picked up by iterative commands such as
458 \cs{printunsrtglossaries}. See \sectionref{sec:newglossary}.}
459 }
460
461 @entry{homograph,
462 name={homograph},
463 user1={idx.homograph},
464 description={Each word in a set of words that all have the same
465 spelling but different meanings. For example, lead (to guide
466 someone) and lead (metallic element) are homographs.}
467 }
468
469 @entry{encoding,
470 name={encoding},
471 user1={idx.encoding},
472 description={A text format that maps a byte or sequence of bytes
473 to a character. See \sectionref{sec:bibencoding} and \csopt{charset}
474 for the \ext{bib} file encoding, \longarg{tex-encoding} for the
475 \ext{aux} and \ext{glstex} file encoding, and
476 \sectionref{sec:defencoding} for the default encoding. See also the blog article
477 \href{https://dickimaw-books.com/blog/binary-files-text-files-and-file-encodings/}{Binary
478 Files, Text Files and File Encodings} for further information about
479 file encodings in general.}
480 }
481
482 @entry{compoundentry,
483 name={compound (combined or multi) entry},
484 text={compound entry},
485 plural={compound entries},
486 description={A compound entry corresponds to the \ics{multiglossaryentry}
487 command. This defines a label that represents a set of entries that have
488 already been defined. This label can then be used in commands like \ics{mgls}
489 as a shortcut for using \cs{gls} for each element in the set.
490 The \gls{compmainlabel} is the main element in the set.
491 The \qt{\glspl{compotherlabel}} are all the other (not-main) elements.
492 See \sectionref{sec:compoundsetentry}.}
493 }
494
495 @entry{compmainlabel,
496 name = {main label or element (compound entry)},
497 text = {main label},
498 description = {The main element in the set that defines a
499 \gls{compoundentry}.}
500 }
501
502 @entry{compotherlabel,
503 name = {other label or element (compound entry)},
504 text = {other label},
505 description = {The non-\glslink{compmainlabel}{main} elements in the
506 set that defines a \gls{compoundentry}.}
507 }
508
509 @entry{regular-expression,
510 name = {regular expression},
511 user1={idx.regex},
512 description={A pattern that specifies how to match text. Unless
513 indicated otherwise, resource options that use regular expressions
514 are \gls{anchored}. See
515 \href{http://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html}{Java's
516 Pattern class API}~\cite{pattern} for details of the regular
517 expression syntax.}
518 }
519
520 @entry{anchored,
521 name = {anchored (regular expression)},
522 text={anchored},
523 description={An anchored \gls{regular-expression} must match the entire
524 string, not a sub-string. For example, \code{l\idx{regex.question}op} matches \qt{lop}
525 and \qt{op} but doesn't match \qt{clop} or \qt{cop}.}
526 }
527
528 @entry{concatenation,
529 name={concatenation},
530 user1={idx.stringconcatenation},
531 description={This is where multiple fragments or substrings are
532 joined together to form a single value. The concatenation operator
533 is \idx{stringconcat} for \ext{bib} files (see
534 \sectionref{sec:bibstringconcat}) and \idx{concat-plus} for
535 resource option string concatenation (\sectionref{sec:optstringconcat}).}
536 }
537
538 @entry{field-reference,
539 name={field reference},
540 user1={idx.field-reference},
541 description={used in complex string concatenations (see
542 \sectionref{sec:optstringcont}) to reference field values}
543 }