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

AUTHORS

187       Francois Charette, "<firmicus at ankabut.net>" Philip Kime "<philip at
188       kime.org.uk>"
189

BUGS

191       Please report any bugs or feature requests on our Github tracker at
192       <https://github.com/plk/biber/issues>.
193
195       Copyright 2009-2018 Francois Charette and Philip Kime, all rights
196       reserved.
197
198       This module is free software.  You can redistribute it and/or modify it
199       under the terms of the Artistic License 2.0.
200
201       This program is distributed in the hope that it will be useful, but
202       without any warranty; without even the implied warranty of
203       merchantability or fitness for a particular purpose.
204
205
206
207perl v5.30.0                      2019-11-17                 Biber::Section(3)
Impressum