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. It returns the
26 first file found among:
27 • "biber.conf" or ".biber.conf" in the current directory
29 • "$HOME/.biber.conf"
31 • "$ENV{XDG_CONFIG_HOME}/biber/biber.conf"
33 • "$HOME/.config/biber/biber.conf"
35 • "$HOME/Library/biber/biber.conf" (Mac OSX only)
37 • "$ENV{APPDATA}/biber.conf" (Windows only)
39 • the output of "kpsewhich biber.conf" (if available on the system).
41 If no file is found, it returns "undef".
43 add_uniq_ignore
45 Track uniqueness ignore settings found in inheritance data
46 get_uniq_ignore
48 Retrieve uniqueness ignore settings found in inheritance data
49 postprocess_biber_opts
51 Place to postprocess biber options when they have been
52 gathered from all the possible places that set them
53 set_dm
55 Sets the data model information object
56 get_dm
58 Gets the data model information object
59 get_dm_helpers
61 Sets the datamodel helper lists
62 set_ctrlfile_path
64 Stores the path to the control file
65 get_ctrlfile_path
67 Retrieved the path to the control file
68 setoption
70 Store a Biber config option
71 getoption
73 Get a Biber option
74 setcmdlineoption
76 Store a Biber command-line option
77 setconfigfileoption
79 Store a Biber config-file option
80 iscmdlineoption
82 Check if an option is explicitly set by user on the command
83 line
84 isconfigfileoption
86 Check if an option is explicitly set by user in their
87 config file
88 isexplicitoption
90 Check if an option is explicitly set by user on the command
91 line or in the config file
92 addtoblxoption
94 Add to an array global biblatex option
95 setblxoption
97 Set a biblatex option on the appropriate scope
98 getblxoption
100 Get a biblatex option from the global, per-type or per entry scope
101 getblxoption('secnum', 'option', ['entrytype'], ['citekey'])
103 Returns the value of option. In order of decreasing preference, returns:
105 1. Biblatex option defined for entry
106 2. Biblatex option defined for entry type
107 3. Biblatex option defined globally
108 section number needs to be present only for per-entry options as these might
110 differ between sections
111 getblxentryoptions
113 Get all per-entry options for an entry
114 set_graph
116 Record node and arc connection types for .dot output
117 get_graph
119 Return an inheritance graph data structure for an inheritance type
120 set_inheritance
122 Record that $target inherited information from $source
123 Can be used for crossrefs and xdata. This just records that an entry
124 inherited from another entry, for loop detection.
125 get_inheritance
127 Check if $target directly inherited information from $source
128 Can be used for crossrefs and xdata
129 is_inheritance_path
131 Checks for an inheritance path from entry $e1 to $e2
132 Can be used for crossrefs and xdata
133 [
135 {s => 'A',
136 t => 'B'},
137 {s => 'A',
138 t => 'E'},
139 {s => 'B',
140 t => 'C'},
141 {s => 'C',
142 t => 'D'} ];
143
145 set_keyorder
146 Set key order information
147 set_internal_keyorder
149 Set key order information for keys with the same order
150 get_keyorder
152 Get key order information
153 get_internal_keyorder
155 Get key order information for keys with the same order
156 get_keyorder_max
158 Get maximum key order number for a section
159 reset_keyorder
161 Reset keyorder - for use in tests where we switch to allkeys
162
164 get_crossrefkeys
165 Return ref to array of keys which are crossref targets
166
168 get_xrefkeys
169 Return ref to array of keys which are xref targets
170 get_crossrefkey
172 Return an integer representing the number of times a
173 crossref target key has been ref'ed
174 get_xrefkey
176 Return an integer representing the number of times a
177 xref target key has been ref'ed
178 del_crossrefkey
180 Remove a crossref target key from the crossrefkeys state
181 del_xrefkey
183 Remove a xref target key from the xrefkeys state
184 incr_crossrefkey
186 Increment the crossreferences count for a target crossref key
187 incr_xrefkey
189 Increment the xreferences count for a target xref key
190 dump
192 Dump config information (for debugging)
193
195 Philip Kime "<philip at kime.org.uk>"
196
198 Please report any bugs or feature requests on our Github tracker at
199 <https://github.com/plk/biber/issues>.
200
202 Copyright 2012-2022 Philip Kime, all rights reserved.
203 This module is free software. You can redistribute it and/or modify it
205 under the terms of the Artistic License 2.0.
206 This program is distributed in the hope that it will be useful, but
208 without any warranty; without even the implied warranty of
209 merchantability or fitness for a particular purpose.
210perl v5.36.0 2023-01-18 Biber::Config(3)