1Biber::Output::base(3)User Contributed Perl DocumentationBiber::Output::base(3)
2
3
4

NAME

6       Biber::Output::base - base class for Biber output modules.
7
8   new
9           Initialize a Biber::Output::base object
10
11   set_output_target_file
12           Set the output target file of a Biber::Output::base object
13           A convenience around set_output_target so we can keep track of the
14           filename. Returns an IO::File object for the target
15
16   get_output_target_file
17         Get the output target file name
18
19   set_output_target
20           Set the output target of a Biber::Output::base object
21
22   set_output_head
23           Set the output head of a Biber::Output::base object
24           $data could be anything - the caller is expected to know.
25
26   set_output_tail
27           Set the output tail of a Biber::Output::base object
28           $data could be anything - the caller is expected to know.
29
30   get_output_head
31           Get the output head of a Biber::Output object
32           $data could be anything - the caller is expected to know.
33           Mainly used in debugging
34
35   get_output_tail
36           Get the output tail of a Biber::Output object
37           $data could be anything - the caller is expected to know.
38           Mainly used in debugging
39
40   add_output_head
41           Add to the head output data of a Biber::Output::base object
42           The base class method just does a string append
43
44   add_output_tail
45           Add to the tail output data of a Biber::Output::base object
46           The base class method just does a string append
47
48   set_output_section
49         Records the section object in the output object
50         We need some information from this when writing the output
51
52   get_output_section
53         Retrieve the output section object
54
55   get_output_entries
56           Get the sorted order output data for all entries in a list as array ref
57           Used really only in tests as it instantiates list dynamic information so
58           we can see it in tests. As a result, we have to NFC() the result to mimic
59           real output since UTF-8 output is assumed in most tests.
60
61   get_output_macros
62           Get the output macros for tool mode tests
63
64   get_output_comments
65           Get the output comments for tool mode tests
66
67   clear_output_macros
68           Clear the output macros
69
70   clear_output_comments
71           Clear the output comments
72
73   get_output_entry
74           Get the output data for a specific entry.
75           Used really only in tests as it instantiates list dynamic information so
76           we can see it in tests. As a result, we have to NFC() the result to mimic
77           real output since UTF-8 output is assumed in most tests.
78
79   set_output_entry
80           Add an entry output to a Biber::Output::base object
81           The base class method just does a dump
82
83   create_output_misc
84           Create the output for misc bits and pieces like preamble and closing
85           macro call and add to output object.
86
87   create_output_section
88           Create the output from the sections data and push it into the
89           output object.
90
91   set_output_keyalias
92         Set the output for a key which is an alias to another key
93
94   set_output_undefkey
95         Set the output for an undefined key
96
97   output
98           Generic base output method
99

AUTHORS

101       Philip Kime "<philip at kime.org.uk>"
102

BUGS

104       Please report any bugs or feature requests on our Github tracker at
105       <https://github.com/plk/biber/issues>.
106

108       Copyright 2009-2012 François Charette and Philip Kime, all rights
109       reserved.  Copyright 2012-2022 Philip Kime, all rights reserved.
110
111       This module is free software.  You can redistribute it and/or modify it
112       under the terms of the Artistic License 2.0.
113
114       This program is distributed in the hope that it will be useful, but
115       without any warranty; without even the implied warranty of
116       merchantability or fitness for a particular purpose.
117
118
119
120perl v5.36.0                      2023-01-18            Biber::Output::base(3)
Impressum