.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Biber::Output::base 3pm"
.TH Biber::Output::base 3pm 2024-04-21 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Biber::Output::base \- base class for Biber output modules.
.SS new
.IX Subsection "new"
.Vb 1
\&    Initialize a Biber::Output::base object
.Ve
.SS set_output_target_file
.IX Subsection "set_output_target_file"
.Vb 3
\&    Set the output target file of a Biber::Output::base object
\&    A convenience around set_output_target so we can keep track of the
\&    filename. Returns an IO::File object for the target
.Ve
.SS get_output_target_file
.IX Subsection "get_output_target_file"
.Vb 1
\&  Get the output target file name
.Ve
.SS set_output_target
.IX Subsection "set_output_target"
.Vb 1
\&    Set the output target of a Biber::Output::base object
.Ve
.SS set_output_head
.IX Subsection "set_output_head"
.Vb 2
\&    Set the output head of a Biber::Output::base object
\&    $data could be anything \- the caller is expected to know.
.Ve
.SS set_output_tail
.IX Subsection "set_output_tail"
.Vb 2
\&    Set the output tail of a Biber::Output::base object
\&    $data could be anything \- the caller is expected to know.
.Ve
.SS get_output_head
.IX Subsection "get_output_head"
.Vb 3
\&    Get the output head of a Biber::Output object
\&    $data could be anything \- the caller is expected to know.
\&    Mainly used in debugging
.Ve
.SS get_output_tail
.IX Subsection "get_output_tail"
.Vb 3
\&    Get the output tail of a Biber::Output object
\&    $data could be anything \- the caller is expected to know.
\&    Mainly used in debugging
.Ve
.SS add_output_head
.IX Subsection "add_output_head"
.Vb 2
\&    Add to the head output data of a Biber::Output::base object
\&    The base class method just does a string append
.Ve
.SS add_output_tail
.IX Subsection "add_output_tail"
.Vb 2
\&    Add to the tail output data of a Biber::Output::base object
\&    The base class method just does a string append
.Ve
.SS set_output_section
.IX Subsection "set_output_section"
.Vb 2
\&  Records the section object in the output object
\&  We need some information from this when writing the output
.Ve
.SS get_output_section
.IX Subsection "get_output_section"
.Vb 1
\&  Retrieve the output section object
.Ve
.SS get_output_entries
.IX Subsection "get_output_entries"
.Vb 4
\&    Get the sorted order output data for all entries in a list as array ref
\&    Used really only in tests as it instantiates list dynamic information so
\&    we can see it in tests. As a result, we have to NFC() the result to mimic
\&    real output since UTF\-8 output is assumed in most tests.
.Ve
.SS get_output_macros
.IX Subsection "get_output_macros"
.Vb 1
\&    Get the output macros for tool mode tests
.Ve
.SS get_output_comments
.IX Subsection "get_output_comments"
.Vb 1
\&    Get the output comments for tool mode tests
.Ve
.SS clear_output_macros
.IX Subsection "clear_output_macros"
.Vb 1
\&    Clear the output macros
.Ve
.SS clear_output_comments
.IX Subsection "clear_output_comments"
.Vb 1
\&    Clear the output comments
.Ve
.SS get_output_entry
.IX Subsection "get_output_entry"
.Vb 4
\&    Get the output data for a specific entry.
\&    Used really only in tests as it instantiates list dynamic information so
\&    we can see it in tests. As a result, we have to NFC() the result to mimic
\&    real output since UTF\-8 output is assumed in most tests.
.Ve
.SS set_output_entry
.IX Subsection "set_output_entry"
.Vb 2
\&    Add an entry output to a Biber::Output::base object
\&    The base class method just does a dump
.Ve
.SS create_output_misc
.IX Subsection "create_output_misc"
.Vb 2
\&    Create the output for misc bits and pieces like preamble and closing
\&    macro call and add to output object.
.Ve
.SS create_output_section
.IX Subsection "create_output_section"
.Vb 2
\&    Create the output from the sections data and push it into the
\&    output object.
.Ve
.SS set_output_keyalias
.IX Subsection "set_output_keyalias"
.Vb 1
\&  Set the output for a key which is an alias to another key
.Ve
.SS set_output_undefkey
.IX Subsection "set_output_undefkey"
.Vb 1
\&  Set the output for an undefined key
.Ve
.SS output
.IX Subsection "output"
.Vb 1
\&    Generic base output method
.Ve
.SH AUTHORS
.IX Header "AUTHORS"
Philip Kime \f(CW\*(C`<philip at kime.org.uk>\*(C'\fR
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests on our Github tracker at
<https://github.com/plk/biber/issues>.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2009\-2012 François Charette and Philip Kime, all rights reserved.
Copyright 2012\-2024 Philip Kime, all rights reserved.
.PP
This module is free software.  You can redistribute it and/or
modify it under the terms of the Artistic License 2.0.
.PP
This program is distributed in the hope that it will be useful,
but without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.