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_alpha
154         Gets alpha name list visibility
155
156   set_visible_alpha
157         Gets alpha name list visibility
158
159   get_numofuniquenames
160           Get the number of uniquenames entries for a visible name
161
162   get_numofuniquenames_all
163           Get the number of uniquenames entries for a name
164
165   get_unul_done
166           Return a boolean saying whether uniquenename+uniquelist processing is finished
167
168   set_unul_changed
169           Set a boolean saying whether uniquename+uniquelist has changed
170
171   reset_seen_extra
172           Reset the counters for extra*
173
174   incr_seen_extradate
175           Increment and return the counter for extradate
176
177   incr_seen_extratitle
178           Increment and return the counter for extratitle
179
180   incr_seen_extratitleyear
181           Increment and return the counter for extratitleyear
182
183   incr_seen_extraalpha
184           Increment and return the counter for extraalpha
185
186   get_seen_namedateparts
187           Get the count of an labelname/dateparts combination for tracking
188           extradate. It uses labelyear plus name as we need to disambiguate
189           entries with different labelyear (like differentiating 1984--1986 from
190           just 1984)
191
192   incr_seen_namedateparts
193           Increment the count of an labelname/dateparts combination for extradate
194
195           We pass in the name and date strings separately as we have to
196           be careful and only increment this counter beyond 1 if there is
197           a name component. Otherwise, extradate gets defined for all
198           entries with no name but the same year etc.
199
200   get_seen_nametitle
201           Get the count of an labelname/labeltitle combination for tracking
202           extratitle.
203
204   incr_seen_nametitle
205           Increment the count of an labelname/labeltitle combination for extratitle
206
207           We pass in the name and year strings separately as we have to
208           be careful and only increment this counter beyond 1 if there is
209           a title component. Otherwise, extratitle gets defined for all
210           entries with no title.
211
212   get_seen_titleyear
213           Get the count of an labeltitle/labelyear combination for tracking
214           extratitleyear
215
216   incr_seen_titleyear
217           Increment the count of an labeltitle/labelyear combination for extratitleyear
218
219           We pass in the title and year strings separately as we have to
220           be careful and only increment this counter beyond 1 if there is
221           a title component. Otherwise, extratitleyear gets defined for all
222           entries with no title.
223
224   reset_workuniqueness
225         Reset various work uniqueness counters
226
227   get_seenname
228           Get the count of occurrences of a labelname or labeltitle
229
230   incr_seenname
231           Increment the count of occurrences of a labelname or labeltitle
232
233   get_seentitle
234           Get the count of occurrences of a labeltitle
235
236   incr_seentitle
237           Increment the count of occurrences of a labeltitle
238
239   get_seenbaretitle
240           Get the count of occurrences of a labeltitle when there is
241           no labelname
242
243   incr_seenbaretitle
244           Increment the count of occurrences of a labeltitle
245           when there is no labelname
246
247   get_seenwork
248           Get the count of occurrences of a labelname and labeltitle
249
250   incr_seenwork
251           Increment the count of occurrences of a labelname and labeltitle
252
253   incr_la_disambiguation
254           Increment a counter to say we have seen this labelalpha
255
256   get_la_disambiguation
257           Get the disambiguation counter for this labelalpha.
258           Return a 0 for undefs to avoid spurious errors.
259
260   set_sortingtemplatename
261           Sets the sortingtemplate name of a data list
262
263   get_attrs
264           Gets the attributes of a data list
265
266   get_sortingtemplatename
267           Gets the sortingtemplatename of a data list
268
269   set_sortingnamekeytemplatename
270           Sets the sortingnamekeytemplate name of a data list
271
272   get_sortingnamekeytemplatename
273           Gets the sortingnamekeytemplatename of a data list
274
275   set_uniquenametemplatename
276           Sets the uniquenametemplate name of a data list
277
278   get_uniquenametemplatename
279           Gets the uniquenametemplate name of a data list
280
281   set_labelalphanametemplatename
282           Sets the labelalphanametemplate name of a data list
283
284   get_labelalphanametemplatename
285           Gets the labelalphanametemplate name of a data list
286
287   set_sortinit_collator
288           Sets the sortinit collator for this list
289
290   get_sortinit_collator
291           Gets the sortinit collator for this list
292
293   get_labelprefix
294           Gets the labelprefix setting of a data list
295
296   set_labelprefix
297           Sets the labelprefix setting of a data list
298
299   set_name
300           Sets the name of a data list
301
302   get_name
303           Gets the name of a data list
304
305   set_type
306           Sets the type of a data list
307
308   get_type
309           Gets the type of a section list
310
311   set_keys
312           Sets the keys for the list
313
314   get_keys
315           Gets the keys for the list
316
317   count_keys
318           Count the keys for the list
319
320   get_namelistdata
321         Gets  name list data
322
323   set_namelistdata
324         Saves name list data
325
326   get_labelalphadata
327         Gets  labelalpha field data
328
329   set_labelalphadata
330         Saves labelalpha data
331
332   get_labelalphadata_for_key
333         Gets  labelalpha field data for a key
334
335   set_labelalphadata_for_key
336         Saves labelalpha field data for a key
337
338   set_extradatedata_for_key
339         Saves extradate field data for a key
340
341   set_extradatedata
342           Saves extradate field data for all keys
343
344   get_extradatedata
345           Gets the extradate field data for a key
346
347   set_extratitledata_for_key
348         Saves extratitle field data for a key
349
350   set_extratitledata
351           Saves extratitle field data for all keys
352
353   get_extratitledata
354           Gets the extratitle field data for a key
355
356   set_extratitleyeardata_for_key
357         Saves extratitleyear field data for a key
358
359   set_extratitleyeardata
360           Saves extratitleyear field data for all keys
361
362   get_extratitleyeardata
363           Gets the extratitleyear field data for a key
364
365   set_extraalphadata_for_key
366           Saves extraalpha field data for a key
367
368   set_extraalphadata
369           Saves extraalpha field data for all keys
370
371   get_extraalphadata
372           Gets the extraalpha field data for a key
373
374   get_sortdataschema
375           Gets the sortdata schema for a sortlist
376
377   set_sortdataschema
378           Saves the sortdata schema for a sortlist
379
380   set_sortdata
381           Saves sorting data in a list for a key
382
383   get_sortdata_for_key
384           Gets the sorting data in a list for a key
385
386   set_sortinitdata_for_key
387        Saves sortinit data for a specific key
388
389   set_sortinitdata
390        Saves sortinit data for all keys
391
392   get_sortinit_for_key
393           Gets the sortinit in a list for a key
394
395   set_sortingtemplate
396           Sets the sortingtemplate of a list
397
398   get_sortingtemplate
399           Gets the sortingtemplate of a list
400
401   add_filter
402           Adds a filter to a list object
403
404   get_filters
405           Gets all filters for a list object
406
407   instantiate_entry
408         Do any dynamic information replacement for information
409         which varies in an entry between lists. This is information which
410         needs to be output to the .bbl for an entry but which is a property
411         of the reference context and not the entry per se so it cannot be stored
412         statically in the entry and must be retrieved from the specific datalist
413         when outputting the entry.
414
415   namelist_differs_index
416           Returns the index where the name list begins to differ from any other list
417
418           Assuming these lists
419
420           [a, b]
421           [a, b, d, e, f, g, h, i, j]
422           [a, b, d, e, f]
423           [a, b, e, z, z, y]
424
425           namelist_differs_index([a, b, c, d, e]) -> 2
426           namelist_differs_index([a]) -> 1
427
428   namelist_differs_nth
429           Returns true if some other name list differs at passed nth place
430           and is at least as long
431
432           namelist_differs_nth([a, b, c, d, e], 3) = 1
433
434           if there is another name list like any of these:
435
436           [a, b, d, e, f]
437           [a, b, e, z, z, y]
438

AUTHORS

440       Francois Charette, "<firmicus at ankabut.net>" Philip Kime "<philip at
441       kime.org.uk>"
442

BUGS

444       Please report any bugs or feature requests on our Github tracker at
445       <https://github.com/plk/biber/issues>.
446
448       Copyright 2009-2018 Francois Charette and Philip Kime, all rights
449       reserved.
450
451       This module is free software.  You can redistribute it and/or modify it
452       under the terms of the Artistic License 2.0.
453
454       This program is distributed in the hope that it will be useful, but
455       without any warranty; without even the implied warranty of
456       merchantability or fitness for a particular purpose.
457
458
459
460perl v5.28.0                      2018-10-18                Biber::DataList(3)
Impressum