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

NAME

6       Biber::Config - Configuration items which need to be saved across the
7                       lifetime of a Biber object
8
9         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
13         * Biber options
14         * Biblatex options
15         * State information used by Biber as it processes entries
16         * displaymode date
17
18   _init
19           Reset internal hashes to defaults.
20
21   _initopts
22           Initialise default options, optionally with config file as argument
23
24   config_file
25       Returns the full path of the Biber configuration file.  It returns the
26       first file found among:
27
28       •   "biber.conf" or ".biber.conf" in the current directory
29
30       •   "$HOME/.biber.conf"
31
32       •   "$ENV{XDG_CONFIG_HOME}/biber/biber.conf"
33
34       •   "$HOME/.config/biber/biber.conf"
35
36       •   "$HOME/Library/biber/biber.conf" (Mac OSX only)
37
38       •   "$ENV{APPDATA}/biber.conf" (Windows only)
39
40       •   the output of "kpsewhich biber.conf" (if available on the system).
41
42       If no file is found, it returns "undef".
43
44   add_uniq_ignore
45           Track uniqueness ignore settings found in inheritance data
46
47   get_uniq_ignore
48           Retrieve uniqueness ignore settings found in inheritance data
49
50   postprocess_biber_opts
51           Place to postprocess biber options when they have been
52           gathered from all the possible places that set them
53
54   set_dm
55           Sets the data model information object
56
57   get_dm
58           Gets the data model information object
59
60   get_dm_helpers
61           Sets the datamodel helper lists
62
63   set_ctrlfile_path
64           Stores the path to the control file
65
66   get_ctrlfile_path
67           Retrieved the path to the control file
68
69   setoption
70           Store a Biber config option
71
72   getoption
73           Get a Biber option
74
75   setcmdlineoption
76           Store a Biber command-line option
77
78   setconfigfileoption
79           Store a Biber config-file option
80
81   iscmdlineoption
82           Check if an option is explicitly set by user on the command
83           line
84
85   isconfigfileoption
86           Check if an option is explicitly set by user in their
87           config file
88
89   isexplicitoption
90           Check if an option is explicitly set by user on the command
91           line or in the config file
92
93   addtoblxoption
94           Add to an array global biblatex option
95
96   setblxoption
97           Set a biblatex option on the appropriate scope
98
99   getblxoption
100           Get a biblatex option from the global, per-type or per entry scope
101
102           getblxoption('secnum', 'option', ['entrytype'], ['citekey'])
103
104           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
109           section number needs to be present only for per-entry options as these might
110           differ between sections
111
112   getblxentryoptions
113           Get all per-entry options for an entry
114
115   set_graph
116          Record node and arc connection types for .dot output
117
118   get_graph
119           Return an inheritance graph data structure for an inheritance type
120
121   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
126   get_inheritance
127           Check if $target directly inherited information from $source
128           Can be used for crossrefs and xdata
129
130   is_inheritance_path
131         Checks for an inheritance path from entry $e1 to $e2
132         Can be used for crossrefs and xdata
133
134       [
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

keyorder

145   set_keyorder
146         Set some key order information
147
148   get_keyorder
149         Get some key order information
150
151   get_keyorder_max
152         Get maximum key order number for a section
153
154   reset_keyorder
155         Reset keyorder - for use in tests where we switch to allkeys
156

crossrefkeys

158   get_crossrefkeys
159           Return ref to array of keys which are crossref targets
160

xrefkeys

162   get_xrefkeys
163           Return ref to array of keys which are xref targets
164
165   get_crossrefkey
166           Return an integer representing the number of times a
167           crossref target key has been ref'ed
168
169   get_xrefkey
170           Return an integer representing the number of times a
171           xref target key has been ref'ed
172
173   del_crossrefkey
174           Remove a crossref target key from the crossrefkeys state
175
176   del_xrefkey
177           Remove a xref target key from the xrefkeys state
178
179   incr_crossrefkey
180           Increment the crossreferences count for a target crossref key
181
182   incr_xrefkey
183           Increment the xreferences count for a target xref key
184
185   dump
186           Dump config information (for debugging)
187

AUTHORS

189       Philip Kime "<philip at kime.org.uk>"
190

BUGS

192       Please report any bugs or feature requests on our Github tracker at
193       <https://github.com/plk/biber/issues>.
194
196       Copyright 2012-2022 Philip Kime, all rights 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.36.0                      2022-07-20                  Biber::Config(3)
Impressum