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

NAME

6       Biber::Section
7
8   new
9           Initialize a Biber::Section object
10
11   reset_caches
12           Reset section caches which need it
13
14   set_np_length
15         Check and record max namepart length. Needed to construct sort keys for names
16
17   get_np_length
18         Return max namepart length. Needed to construct sort keys for names
19
20   set_set_pc
21         Record a parent->child set relationship
22
23   set_set_cp
24         Record a child->parent set relationship
25
26   get_set_pc
27         Return a boolean saying if there is a parent->child set relationship
28
29   get_set_cp
30         Return a boolean saying if there is a child->parent set relationship
31
32   get_set_children
33         Return a list of children for a parent set
34
35   get_set_parents
36         Return a list of parents for a child of a set
37
38   set_keytods
39         Save information about citekey->datasource name mapping. Used for error reporting.
40
41   get_keytods
42         Get information about citekey->datasource name mapping. Used for error reporting.
43
44   has_badcasekey
45           Returns a value to say if we've seen a key differing only in case before
46           <previouskey>  - we've seen a differently cased variant of this key so we can warn about this
47           undef  - Not seen this key at all in any case variant before
48
49   is_specificcitekey
50           Check if a key is specifically cited by \cite{key} or \nocite{key}
51
52   add_related
53           Record that a key is used as a related entry
54
55   is_related
56           Check if a key is used as a related entry key
57
58   keytorelclone
59           Record a key<->clone key mapping.
60
61   get_keytorelclone
62           Fetch a related entry clone key, given a cite key
63
64   get_relclonetokey
65           Fetch a related entry key, given a clone key
66
67   has_keytorelclone
68           Return boolean saying if a cite key has a related entry clone in the current section
69
70   has_relclonetokey
71           Return boolean saying if a related clone key has a citekey in the current section
72
73   add_cite
74           Adds a key to the list of those that came via \cite
75
76   is_cite
77           Returns a boolean to say if a key came via \cite
78
79   add_nocite
80           Adds a key to the list of those that came via \nocite
81
82   is_nocite
83           Returns a boolean to say if a key came via \nocite
84
85   add_everykey
86           Adds a datasource key to the section list of all datasource keys
87
88   del_everykeys
89         Delete everykey cache. For use in tests.
90
91   has_everykey
92           Returns a boolean to say if we've seen a key in any datasource for this section.
93           This used to be an array ref which was checked using first() and it
94           was twenty times slower.
95
96   set_allkeys_nocite
97           Sets flag to say citekey '*' occurred through \nocite
98           We allow setting it to false too because it's useful in tests
99
100   set_allkeys
101           Sets flag to say citekey '*' occurred in citekeys
102           We allow setting it to false too because it's useful in tests
103
104   is_allkeys_nocite
105           Checks flag which says citekey '*' occurred in via \nocite
106
107   is_allkeys
108           Checks flag which says citekey '*' occurred in citekeys
109
110   bibentry
111           Returns a Biber::Entry object for the given citation key
112           Understands citekey aliases
113
114   bibentries
115           Return Biber::Entries object for this section
116
117   del_bibentries
118           Delete all Biber::Entry objects from the Biber::Section object
119
120   set_citekeys
121           Sets the citekeys in a Biber::Section object
122
123   set_orig_order_citekeys
124           Sets the original order of citekeys in a Biber::Section object
125
126   get_citekeys
127           Gets the citekeys of a Biber::Section object
128           Returns a normal array
129
130   get_static_citekeys
131           Gets the citekeys of a Biber::Section object
132           excluding dynamic set entry keys
133           Returns a normal array
134
135   has_cited_citekey
136           Returns true when $key was one of the actually cited keys in the section
137
138   add_undef_citekey
139           Adds a citekey to the Biber::Section object as an undefined
140           key. This allows us to output this information to the .bbl and
141           so biblatex can do better reporting to external utils like latexmk
142
143   get_undef_citekeys
144           Gets the list of undefined citekeys of a Biber::Section object
145           Returns a normal array
146
147   get_orig_order_citekeys
148           Gets the citekeys of a Biber::Section object in their original order
149           This is just to ensure we have a method that will return this, just in
150           case we mess about with the order at some point. This is needed by
151           citeorder sorting.
152
153   has_citekey
154           Returns true when $key is in the Biber::Section object
155           Understands key alaises
156
157   del_citekey
158           Deletes a citekey from a Biber::Section object
159
160   del_citekeys
161           Deletes all citekeys from a Biber::Section object
162
163   add_citekeys
164           Adds citekeys to the Biber::Section object
165
166   set_citekey_alias
167           Set citekey alias information
168
169   get_citekey_alias
170           Get citekey alias information
171
172   del_citekey_alias
173           Delete citekey alias
174
175   get_citekey_aliases
176           Get a list of all citekey aliases for the section
177
178   set_labelcache_v
179           Sets the variable label disambiguation cache for a field
180
181   get_labelcache_v
182           Gets the variable label disambiguation cache for a field
183
184   set_labelcache_l
185           Sets the list label disambiguation cache for a field
186
187   get_labelcache_l
188           Gets the list label disambiguation cache for a field
189
190   is_dynamic_set
191           Test if a key is a dynamic set
192
193   set_dynamic_set
194           Record a mapping of dynamic key to member keys
195
196   get_dynamic_set
197           Retrieve member keys for a dynamic set key
198           Check that reference returning anything to stop spurious warnings
199           about empty dereference in return.
200
201   dynamic_set_keys
202           Retrieve all dynamic set keys
203
204   has_dynamic_sets
205           Returns true of false depending on whether the section has any dynamic set keys
206
207   add_datasource
208           Adds a data source to a section
209
210   set_datasources
211           Sets the data sources for a section
212
213   get_datasources
214           Gets an array of data sources for this section
215
216   number
217           Gets the section number of a Biber::Section object
218

AUTHORS

220       Philip Kime "<philip at kime.org.uk>"
221

BUGS

223       Please report any bugs or feature requests on our Github tracker at
224       <https://github.com/plk/biber/issues>.
225

227       Copyright 2009-2012 Francois Charette and Philip Kime, all rights
228       reserved.  Copyright 2012-2019 Philip Kime, all rights reserved.
229
230       This module is free software.  You can redistribute it and/or modify it
231       under the terms of the Artistic License 2.0.
232
233       This program is distributed in the hope that it will be useful, but
234       without any warranty; without even the implied warranty of
235       merchantability or fitness for a particular purpose.
236
237
238
239perl v5.32.1                      2021-05-18                 Biber::Section(3)
Impressum