1Biber::Section(3) User Contributed Perl Documentation Biber::Section(3)
2
6 Biber::Section - Biber::Section objects
7 new
9 Initialize a Biber::Section object
10
12 set_citecount
13 Set the citecount of a key. This comes from biblatex via the
14 citecounter option and reflects the actual number of citations using
15 this key, taking into account things like \citeauthor etc. which are not
16 real citations.
17 get_keycount
19 Get the citecount of a key. This comes from biblatex via the
20 citecounter option and reflects the actual number of citations using
21 this key, taking into account things like \citeauthor etc. which are not
22 real citations. A zero or undef value needs to be less than 0 which does
23 not fail if() checks - required for the delicate sorting dispatch logic
24
26 get_seenkey
27 Get the count of a key
28 incr_seenkey
30 Increment the seen count of a key
31 reset_caches
33 Reset section caches which need it
34 set_np_length
36 Check and record max namepart length. Needed to construct sort keys for names
37 get_np_length
39 Return max namepart length. Needed to construct sort keys for names
40 set_set_pc
42 Record a parent->child set relationship
43 set_set_cp
45 Record a child->parent set relationship
46 get_set_pc
48 Return a boolean saying if there is a parent->child set relationship
49 get_set_cp
51 Return a boolean saying if there is a child->parent set relationship
52 get_set_children
54 Return a list of children for a parent set
55 get_set_parents
57 Return a list of parents for a child of a set
58 set_keytods
60 Save information about citekey->datasource name mapping. Used for error reporting.
61 get_keytods
63 Get information about citekey->datasource name mapping. Used for error reporting.
64 has_badcasekey
66 Returns a value to say if we've seen a key differing only in case before
67 <previouskey> - we've seen a differently cased variant of this key so we can warn about this
68 undef - Not seen this key at all in any case variant before
69 is_specificcitekey
71 Check if a key is specifically cited by \cite{key} or \nocite{key}
72 add_related
74 Record that a key is used as a related entry
75 is_related
77 Check if a key is used as a related entry key
78 keytorelclone
80 Record a key<->clone key mapping.
81 get_keytorelclone
83 Fetch a related entry clone key, given a cite key
84 get_relclonetokey
86 Fetch a related entry key, given a clone key
87 has_keytorelclone
89 Return boolean saying if a cite key has a related entry clone in the current section
90 has_relclonetokey
92 Return boolean saying if a related clone key has a citekey in the current section
93 add_cite
95 Adds a key to the list of those that came via \cite
96 is_cite
98 Returns a boolean to say if a key came via \cite
99 add_nocite
101 Adds a key to the list of those that came via \nocite
102 is_nocite
104 Returns a boolean to say if a key came via \nocite
105 add_everykey
107 Adds a datasource key to the section list of all datasource keys
108 del_everykeys
110 Delete everykey cache. For use in tests.
111 has_everykey
113 Returns a boolean to say if we've seen a key in any datasource for this section.
114 This used to be an array ref which was checked using first() and it
115 was twenty times slower.
116 set_allkeys_nocite
118 Sets flag to say citekey '*' occurred through \nocite
119 We allow setting it to false too because it's useful in tests
120 set_allkeys
122 Sets flag to say citekey '*' occurred in citekeys
123 We allow setting it to false too because it's useful in tests
124 is_allkeys_nocite
126 Checks flag which says citekey '*' occurred in via \nocite
127 is_allkeys
129 Checks flag which says citekey '*' occurred in citekeys
130 bibentry
132 Returns a Biber::Entry object for the given citation key
133 Understands citekey aliases
134 bibentries
136 Return Biber::Entries object for this section
137 del_bibentries
139 Delete all Biber::Entry objects from the Biber::Section object
140 set_citekeys
142 Sets the citekeys in a Biber::Section object
143 set_orig_order_citekeys
145 Sets the original order of citekeys in a Biber::Section object
146 get_citekeys
148 Gets the citekeys of a Biber::Section object
149 Returns a normal array
150 get_static_citekeys
152 Gets the citekeys of a Biber::Section object
153 excluding dynamic set entry keys
154 Returns a normal array
155 has_cited_citekey
157 Returns true when $key was one of the actually cited keys in the section
158 add_undef_citekey
160 Adds a citekey to the Biber::Section object as an undefined
161 key. This allows us to output this information to the .bbl and
162 so biblatex can do better reporting to external utils like latexmk
163 get_undef_citekeys
165 Gets the list of undefined citekeys of a Biber::Section object
166 Returns a normal array
167 get_orig_order_citekeys
169 Gets the citekeys of a Biber::Section object in their original order
170 This is just to ensure we have a method that will return this, just in
171 case we mess about with the order at some point. This is needed by
172 citeorder sorting.
173 has_citekey
175 Returns true when $key is in the Biber::Section object
176 Understands key alaises
177 del_citekey
179 Deletes a citekey from a Biber::Section object
180 del_citekeys
182 Deletes all citekeys from a Biber::Section object
183 add_citekeys
185 Adds citekeys to the Biber::Section object
186 set_citekey_alias
188 Set citekey alias information
189 get_citekey_alias
191 Get citekey alias information
192 del_citekey_alias
194 Delete citekey alias
195 get_citekey_aliases
197 Get a list of all citekey aliases for the section
198 set_labelcache_v
200 Sets the variable label disambiguation cache for a field
201 get_labelcache_v
203 Gets the variable label disambiguation cache for a field
204 set_labelcache_l
206 Sets the list label disambiguation cache for a field
207 get_labelcache_l
209 Gets the list label disambiguation cache for a field
210 is_dynamic_set
212 Test if a key is a dynamic set
213 set_dynamic_set
215 Record a mapping of dynamic key to member keys
216 get_dynamic_set
218 Retrieve member keys for a dynamic set key
219 Check that reference returning anything to stop spurious warnings
220 about empty dereference in return.
221 dynamic_set_keys
223 Retrieve all dynamic set keys
224 has_dynamic_sets
226 Returns true of false depending on whether the section has any dynamic set keys
227 add_datasource
229 Adds a data source to a section
230 set_datasources
232 Sets the data sources for a section
233 get_datasources
235 Gets an array of data sources for this section
236 number
238 Gets the section number of a Biber::Section object
239
241 Philip Kime "<philip at kime.org.uk>"
242
244 Please report any bugs or feature requests on our Github tracker at
245 <https://github.com/plk/biber/issues>.
246
248 Copyright 2009-2012 François Charette and Philip Kime, all rights
249 reserved. Copyright 2012-2022 Philip Kime, all rights reserved.
250 This module is free software. You can redistribute it and/or modify it
252 under the terms of the Artistic License 2.0.
253 This program is distributed in the hope that it will be useful, but
255 without any warranty; without even the implied warranty of
256 merchantability or fitness for a particular purpose.
257perl v5.36.0 2023-01-18 Biber::Section(3)