1Biber::DataList(3)    User Contributed Perl Documentation   Biber::DataList(3)
2
3
4

NAME

6       Biber::DataList
7
8   new
9           Initialize a Biber::DataList object
10
11   set_section
12           Sets the section of a data list
13
14   get_section
15           Gets the section of a data list
16
17   reset_state
18           Resets all state data. Used mainly in tests which call Biber::prepare()
19           multiple times without re-creating datalists
20
21   incr_seenpa
22           Increment the count of occurrences of a primary author family name
23
24   get_seenpa
25           Get the count of occurrences of a primary author family name
26
27   reset_entryfields
28           Resets all entryfield data in a list
29
30   get_entryfield
31           Retrieves per-list datafield information for an entry
32
33   set_entryfield
34           Records per-list datafield information for an entry
35
36   add_uniquenamecount
37           Add a name to the list of name contexts which have the name in it
38           (only called for visible names)
39
40   add_uniquenamecount_all
41           Add a name to the list of name contexts which have the name in it
42           (called for all names)
43
44   get_uniquelistcount
45           Get the number of uniquelist entries for a (possibly partial) list
46
47   add_uniquelistcount
48           Incremenent the count for a list part to the data for a name
49
50   add_uniquelistcount_final
51           Incremenent the count for a complete list to the data for a name
52
53   add_uniquelistcount_minyear
54           Incremenent the count for a list and year to the data for a name
55           Used to track uniquelist = minyear
56
57   get_uniquelistcount_minyear
58           Get the count for a list and year to the data for a name
59           Used to track uniquelist = minyear
60
61   get_uniquelistcount_final
62           Get the number of uniquelist entries for a full list
63
64   reset_uniquelistcount
65           Reset the count for list parts and complete lists
66
67   reset_uniquenamecount
68           Reset the list of names which have the name part in it
69
70   get_basenamestring
71         Get a basenamestring for a particular name
72
73   get_namestring
74         Get a namestring for a particular name
75
76   get_namestrings
77         Get namestrings for a particular name
78
79   set_namedis
80         Set name disambiguation metadata
81
82   is_unbasepart
83         Return boolean to say if a namepart is a base part according to
84         template which created the information
85
86   get_namehash
87         Get hash for a name
88
89   set_namehash
90         Set hash for a name
91
92   get_unmininfo
93         Get uniquename minimalness info for a name
94
95   set_unmininfo
96         Set uniquename minimalness info for a name
97
98   get_namedisschema
99         Get a name disambiguation schema for a name
100
101   get_unsummary
102         Get legacy uniquename summary for a name
103
104   get_unpart
105         Get uniquename summary part for a name
106
107   get_unparts
108         Get uniquename parts for a name
109
110   set_unparts
111         Set uniquename parts for a name
112
113   _get_uniquename
114           Get the list of name contexts which contain a name
115           Mainly for use in tests
116
117   get_uniquename
118         Get uniquename for a name
119
120   set_uniquename
121         Set uniquename for a name
122
123   reset_uniquename
124         Reset uniquename for a name
125
126   get_uniquename_all
127         Get uniquename for a name, regardless of visibility
128
129   set_uniquename_all
130         Set uniquename for a name, regardless of visibility
131
132   count_uniquelist
133           Count the names in a string used to determine uniquelist.
134
135   get_uniquelist
136         Gets a uniquelist setting for a namelist
137
138   set_uniquelist
139         Sets a uniquelist setting for a namelist
140
141   get_visible_cite
142         Gets citation name list visibility
143
144   set_visible_cite
145         Gets citation name list visibility
146
147   get_visible_bib
148         Gets bib name list visibility
149
150   set_visible_bib
151         Gets bib name list visibility
152
153   get_visible_sort
154         Gets sort name list visibility
155
156   set_visible_sort
157         Gets sort name list visibility
158
159   get_visible_alpha
160         Gets alpha name list visibility
161
162   set_visible_alpha
163         Gets alpha name list visibility
164
165   get_numofuniquenames
166           Get the number of uniquenames entries for a visible name
167
168   get_numofuniquenames_all
169           Get the number of uniquenames entries for a name
170
171   get_unul_done
172           Return a boolean saying whether uniquenename+uniquelist processing is finished
173
174   set_unul_changed
175           Set a boolean saying whether uniquename+uniquelist has changed
176
177   reset_seen_extra
178           Reset the counters for extra*
179
180   incr_seen_extradate
181           Increment and return the counter for extradate
182
183   incr_seen_extraname
184           Increment and return the counter for extraname
185
186   incr_seen_labelname
187           Increment and return a counter used to track extraname
188
189   incr_seen_extratitle
190           Increment and return the counter for extratitle
191
192   incr_seen_extratitleyear
193           Increment and return the counter for extratitleyear
194
195   incr_seen_extraalpha
196           Increment and return the counter for extraalpha
197
198   get_seen_namedateparts
199           Get the count of an labelname/dateparts combination for tracking
200           extradate. It uses labelyear plus name as we need to disambiguate
201           entries with different labelyear (like differentiating 1984--1986 from
202           just 1984)
203
204   incr_seen_namedateparts
205           Increment the count of an labelname/dateparts combination for extradate
206
207           We pass in the name and date strings separately as we have to
208           be careful and only increment this counter beyond 1 if there is
209           a name component. Otherwise, extradate gets defined for all
210           entries with no name but the same year etc.
211
212   get_seen_labelname
213           Get the count of a labelname hash for tracking extraname
214
215   get_seen_nametitle
216           Get the count of an labelname/labeltitle combination for tracking
217           extratitle.
218
219   incr_seen_nametitle
220           Increment the count of an labelname/labeltitle combination for extratitle
221
222           We pass in the name and year strings separately as we have to
223           be careful and only increment this counter beyond 1 if there is
224           a title component. Otherwise, extratitle gets defined for all
225           entries with no title.
226
227   get_seen_titleyear
228           Get the count of an labeltitle/labelyear combination for tracking
229           extratitleyear
230
231   incr_seen_titleyear
232           Increment the count of an labeltitle/labelyear combination for extratitleyear
233
234           We pass in the title and year strings separately as we have to
235           be careful and only increment this counter beyond 1 if there is
236           a title component. Otherwise, extratitleyear gets defined for all
237           entries with no title.
238
239   reset_workuniqueness
240         Reset various work uniqueness counters
241
242   get_seenname
243           Get the count of occurrences of a labelname or labeltitle
244
245   incr_seenname
246           Increment the count of occurrences of a labelname or labeltitle
247
248   get_seentitle
249           Get the count of occurrences of a labeltitle
250
251   incr_seentitle
252           Increment the count of occurrences of a labeltitle
253
254   get_seenbaretitle
255           Get the count of occurrences of a labeltitle when there is
256           no labelname
257
258   incr_seenbaretitle
259           Increment the count of occurrences of a labeltitle
260           when there is no labelname
261
262   get_seenwork
263           Get the count of occurrences of a labelname and labeltitle
264
265   incr_seenwork
266           Increment the count of occurrences of a labelname and labeltitle
267
268   incr_la_disambiguation
269           Increment a counter to say we have seen this labelalpha
270
271   get_la_disambiguation
272           Get the disambiguation counter for this labelalpha.
273           Return a 0 for undefs to avoid spurious errors.
274
275   set_sortingtemplatename
276           Sets the sortingtemplate name of a data list
277
278   get_attrs
279           Gets the attributes of a data list
280
281   get_sortingtemplatename
282           Gets the sortingtemplatename of a data list
283
284   set_sortingnamekeytemplatename
285           Sets the sortingnamekeytemplate name of a data list
286
287   get_sortingnamekeytemplatename
288           Gets the sortingnamekeytemplatename of a data list
289
290   set_uniquenametemplatename
291           Sets the uniquenametemplate name of a data list
292
293   get_uniquenametemplatename
294           Gets the uniquenametemplate name of a data list
295
296   set_labelalphanametemplatename
297           Sets the labelalphanametemplate name of a data list
298
299   get_labelalphanametemplatename
300           Gets the labelalphanametemplate name of a data list
301
302   set_sortinit_collator
303           Sets the sortinit collator for this list
304
305   get_sortinit_collator
306           Gets the sortinit collator for this list
307
308   get_labelprefix
309           Gets the labelprefix setting of a data list
310
311   set_labelprefix
312           Sets the labelprefix setting of a data list
313
314   set_name
315           Sets the name of a data list
316
317   get_name
318           Gets the name of a data list
319
320   set_type
321           Sets the type of a data list
322
323   get_type
324           Gets the type of a section list
325
326   set_keys
327           Sets the keys for the list
328
329   get_keys
330           Gets the keys for the list
331
332   count_keys
333           Count the keys for the list
334
335   get_namelistdata
336         Gets  name list data
337
338   set_namelistdata
339         Saves name list data
340
341   get_labelalphadata
342         Gets  labelalpha field data
343
344   set_labelalphadata
345         Saves labelalpha data
346
347   get_labelalphadata_for_key
348         Gets  labelalpha field data for a key
349
350   set_labelalphadata_for_key
351         Saves labelalpha field data for a key
352
353   set_extradatedata_for_key
354         Saves extradate field data for a key
355
356   set_extranamedata_for_key
357         Saves extraname field data for a key
358
359   get_extranamedata_for_key
360           Gets the extraname field data for a key
361
362   set_extradatedata
363           Saves extradate field data for all keys
364
365   get_extradatedata_for_key
366           Gets the extradate field data for a key
367
368   set_extratitledata_for_key
369         Saves extratitle field data for a key
370
371   set_extratitledata
372           Saves extratitle field data for all keys
373
374   get_extratitledata
375           Gets the extratitle field data for a key
376
377   set_extratitleyeardata_for_key
378         Saves extratitleyear field data for a key
379
380   set_extratitleyeardata
381           Saves extratitleyear field data for all keys
382
383   get_extratitleyeardata
384           Gets the extratitleyear field data for a key
385
386   set_extraalphadata_for_key
387           Saves extraalpha field data for a key
388
389   set_extraalphadata
390           Saves extraalpha field data for all keys
391
392   get_extraalphadata
393           Gets the extraalpha field data for a key
394
395   get_sortdataschema
396           Gets the sortdata schema for a sortlist
397
398   set_sortdataschema
399           Saves the sortdata schema for a sortlist
400
401   set_sortdata
402           Saves sorting data in a list for a key
403
404   get_sortdata_for_key
405           Gets the sorting data in a list for a key
406
407   set_sortinitdata_for_key
408        Saves sortinit data for a specific key
409
410   set_sortinitdata
411        Saves sortinit data for all keys
412
413   get_sortinit_for_key
414           Gets the sortinit in a list for a key
415
416   set_sortingtemplate
417           Sets the sortingtemplate of a list
418
419   get_sortingtemplate
420           Gets the sortingtemplate of a list
421
422   add_filter
423           Adds a filter to a list object
424
425   get_filters
426           Gets all filters for a list object
427
428   instantiate_entry
429         Do any dynamic information replacement for information
430         which varies in an entry between lists. This is information which
431         needs to be output to the .bbl for an entry but which is a property
432         of the reference context and not the entry per se so it cannot be stored
433         statically in the entry and must be retrieved from the specific datalist
434         when outputting the entry.
435
436   namelist_differs_index
437           Returns the index where the name list begins to differ from any other list
438
439           Assuming these lists
440
441           [a, b]
442           [a, b, d, e, f, g, h, i, j]
443           [a, b, d, e, f]
444           [a, b, e, z, z, y]
445
446           namelist_differs_index([a, b, c, d, e]) -> 2
447           namelist_differs_index([a]) -> 1
448
449   namelist_differs_nth
450           Returns true if some other name list differs at passed nth place
451           and is at least as long
452
453           namelist_differs_nth([a, b, c, d, e], 3) = 1
454
455           if there is another name list like any of these:
456
457           [a, b, d, e, f]
458           [a, b, e, z, z, y]
459

AUTHORS

461       Francois Charette, "<firmicus at ankabut.net>" Philip Kime "<philip at
462       kime.org.uk>"
463

BUGS

465       Please report any bugs or feature requests on our Github tracker at
466       <https://github.com/plk/biber/issues>.
467
469       Copyright 2009-2018 Francois Charette and Philip Kime, all rights
470       reserved.
471
472       This module is free software.  You can redistribute it and/or modify it
473       under the terms of the Artistic License 2.0.
474
475       This program is distributed in the hope that it will be useful, but
476       without any warranty; without even the implied warranty of
477       merchantability or fitness for a particular purpose.
478
479
480
481perl v5.30.0                      2019-11-17                Biber::DataList(3)
Impressum