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.  If returns the
26       first file found among:
27
28       •   "biber.conf" in the current directory
29
30       •   "$HOME/.biber.conf"
31
32       •   "$ENV{XDG_CONFIG_HOME}/biber/biber.conf"
33
34       •   "$HOME/Library/biber/biber.conf" (Mac OSX only)
35
36       •   "$ENV{APPDATA}/biber.conf" (Windows only)
37
38       •   the output of "kpsewhich biber.conf" (if available on the system).
39
40       If no file is found, it returns "undef".
41
42   add_uniq_ignore
43           Track uniqueness ignore settings found in inheritance data
44
45   get_uniq_ignore
46           Retrieve uniqueness ignore settings found in inheritance data
47
48   postprocess_biber_opts
49           Place to postprocess biber options when they have been
50           gathered from all the possible places that set them
51
52   set_dm
53           Sets the data model information object
54
55   get_dm
56           Gets the data model information object
57
58   get_dm_helpers
59           Sets the datamodel helper lists
60
61   set_ctrlfile_path
62           Stores the path to the control file
63
64   get_ctrlfile_path
65           Retrieved the path to the control file
66
67   setoption
68           Store a Biber config option
69
70   getoption
71           Get a Biber option
72
73   setcmdlineoption
74           Store a Biber command-line option
75
76   setconfigfileoption
77           Store a Biber config-file option
78
79   iscmdlineoption
80           Check if an option is explicitly set by user on the command
81           line
82
83   isconfigfileoption
84           Check if an option is explicitly set by user in their
85           config file
86
87   isexplicitoption
88           Check if an option is explicitly set by user on the command
89           line or in the config file
90
91   addtoblxoption
92           Add to an array global biblatex option
93
94   setblxoption
95           Set a biblatex option on the appropriate scope
96
97   getblxoption
98           Get a biblatex option from the global, per-type or per entry scope
99
100           getblxoption('secnum', 'option', ['entrytype'], ['citekey'])
101
102           Returns the value of option. In order of decreasing preference, returns:
103           1. Biblatex option defined for entry
104           2. Biblatex option defined for entry type
105           3. Biblatex option defined globally
106
107           section number needs to be present only for per-entry options as these might
108           differ between sections
109
110   getblxentryoptions
111           Get all per-entry options for an entry
112
113   set_graph
114          Record node and arc connection types for .dot output
115
116   get_graph
117           Return an inheritance graph data structure for an inheritance type
118
119   set_inheritance
120           Record that $target inherited information from $source
121           Can be used for crossrefs and xdata. This just records that an entry
122           inherited from another entry, for loop detection.
123
124   get_inheritance
125           Check if $target directly inherited information from $source
126           Can be used for crossrefs and xdata
127
128   is_inheritance_path
129         Checks for an inheritance path from entry $e1 to $e2
130         Can be used for crossrefs and xdata
131
132       [
133                    {s => 'A',
134                     t => 'B'},
135                    {s => 'A',
136                     t => 'E'},
137                    {s => 'B',
138                     t => 'C'},
139                    {s => 'C',
140                     t => 'D'} ];
141

keyorder

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

seenkey

156   get_seenkey
157           Get the count of a key
158
159   incr_seenkey
160           Increment the seen count of a key
161

crossrefkeys

163   get_crossrefkeys
164           Return ref to array of keys which are crossref targets
165

xrefkeys

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

AUTHORS

194       Philip Kime "<philip at kime.org.uk>"
195

BUGS

197       Please report any bugs or feature requests on our Github tracker at
198       <https://github.com/plk/biber/issues>.
199

201       Copyright 2012-2019 Philip Kime, all rights reserved.
202
203       This module is free software.  You can redistribute it and/or modify it
204       under the terms of the Artistic License 2.0.
205
206       This program is distributed in the hope that it will be useful, but
207       without any warranty; without even the implied warranty of
208       merchantability or fitness for a particular purpose.
209
210
211
212perl v5.32.1                      2021-05-18                  Biber::Config(3)
Impressum