1Biber::Config(3) User Contributed Perl Documentation Biber::Config(3)
2
6 Biber::Config - Configuration items which need to be saved across the
7 lifetime of a Biber object
8 This class contains a static object and static methods to access
10 configuration and state data. There are several classes of data in here
11 which have separate accessors:
12 * Biber options
14 * Biblatex options
15 * State information used by Biber as it processes entries
16 * displaymode date
17 _init
19 Reset internal hashes to defaults.
20 _initopts
22 Initialise default options, optionally with config file as argument
23 config_file
25 Returns the full path of the Biber configuration file. If returns the
26 first file found among:
27 · "biber.conf" in the current directory
29 · "$HOME/.biber.conf"
31 · "$ENV{XDG_CONFIG_HOME}/biber/biber.conf"
33 · "$HOME/Library/biber/biber.conf" (Mac OSX only)
35 · "$ENV{APPDATA}/biber.conf" (Windows only)
37 · the output of "kpsewhich biber.conf" (if available on the system).
39 If no file is found, it returns "undef".
41 add_uniq_ignore
43 Track uniqueness ignore settings found in inheritance data
44 get_uniq_ignore
46 Retrieve uniqueness ignore settings found in inheritance data
47 postprocess_biber_opts
49 Place to postprocess biber options when they have been
50 gathered from all the possible places that set them
51 set_dm
53 Sets the data model information object
54 get_dm
56 Gets the data model information object
57 get_dm_helpers
59 Sets the datamodel helper lists
60 set_ctrlfile_path
62 Stores the path to the control file
63 get_ctrlfile_path
65 Retrieved the path to the control file
66 setoption
68 Store a Biber config option
69 getoption
71 Get a Biber option
72 setcmdlineoption
74 Store a Biber command-line option
75 setconfigfileoption
77 Store a Biber config-file option
78 iscmdlineoption
80 Check if an option is explicitly set by user on the command
81 line
82 isconfigfileoption
84 Check if an option is explicitly set by user in their
85 config file
86 isexplicitoption
88 Check if an option is explicitly set by user on the command
89 line or in the config file
90 setblxoption
92 Set a biblatex option on the appropriate scope
93 getblxoption
95 Get a biblatex option from the global, per-type or per entry scope
96 getblxoption('option', ['entrytype'], ['citekey'])
98 Returns the value of option. In order of decreasing preference, returns:
100 1. Biblatex option defined for entry
101 2. Biblatex option defined for entry type
102 3. Biblatex option defined globally
103 getblxentryoptions
105 Get all per-entry options for an entry
106 set_graph
108 Record node and arc connection types for .dot output
109 get_graph
111 Return an inheritance graph data structure for an inheritance type
112 set_set_pc
114 Record a parent->child set relationship
115 set_set_cp
117 Record a child->parent set relationship
118 get_set_pc
120 Return a boolean saying if there is a parent->child set relationship
121 get_set_cp
123 Return a boolean saying if there is a child->parent set relationship
124 get_set_children
126 Return a list of children for a parent set
127 get_set_parents
129 Return a list of parents for a child of a set
130 set_inheritance
132 Record that $target inherited information from $source
133 Can be used for crossrefs and xdata. This just records that an entry
134 inherited from another entry, for loop detection.
135 get_inheritance
137 Check if $target directly inherited information from $source
138 Can be used for crossrefs and xdata
139 is_inheritance_path
141 Checks for an inheritance path from entry $e1 to $e2
142 Can be used for crossrefs and xdata
143 [
145 {s => 'A',
146 t => 'B'},
147 {s => 'A',
148 t => 'E'},
149 {s => 'B',
150 t => 'C'},
151 {s => 'C',
152 t => 'D'} ];
153
155 set_keyorder
156 Set some key order information
157 get_keyorder
159 Get some key order information
160 get_keyorder_max
162 Get maximum key order number for a section
163 reset_keyorder
165 Reset keyorder - for use in tests where we switch to allkeys
166
168 get_seenkey
169 Get the count of a key
170 incr_seenkey
172 Increment the seen count of a key
173
175 get_crossrefkeys
176 Return ref to array of keys which are crossref targets
177
179 get_xrefkeys
180 Return ref to array of keys which are xref targets
181 get_crossrefkey
183 Return an integer representing the number of times a
184 crossref target key has been ref'ed
185 get_xrefkey
187 Return an integer representing the number of times a
188 xref target key has been ref'ed
189 del_crossrefkey
191 Remove a crossref target key from the crossrefkeys state
192 del_xrefkey
194 Remove a xref target key from the xrefkeys state
195 incr_crossrefkey
197 Increment the crossreferences count for a target crossref key
198 incr_xrefkey
200 Increment the xreferences count for a target xref key
201 dump
203 Dump config information (for debugging)
204
206 Francois Charette, "<firmicus at ankabut.net>" Philip Kime "<philip at
207 kime.org.uk>"
208
210 Please report any bugs or feature requests on our Github tracker at
211 <https://github.com/plk/biber/issues>.
212
214 Copyright 2009-2018 Francois Charette and Philip Kime, all rights
215 reserved.
216 This module is free software. You can redistribute it and/or modify it
218 under the terms of the Artistic License 2.0.
219 This program is distributed in the hope that it will be useful, but
221 without any warranty; without even the implied warranty of
222 merchantability or fitness for a particular purpose.
223perl v5.28.0 2018-10-18 Biber::Config(3)