--- name: "Biber::Output::base" section: "3pm" platform: "linux" package: "biber" version: "1:2.22-1" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/Biber::Output::base" --- # Biber::Output::base(3pm) base class for Biber output modules. ## NAME Biber::Output::base - base class for Biber output modules. ### new ``` Initialize a Biber::Output::base object ``` ### set\_output\_target\_file ``` 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 ``` ### get\_output\_target\_file ``` Get the output target file name ``` ### set\_output\_target ``` Set the output target of a Biber::Output::base object ``` ### set\_output\_head ``` Set the output head of a Biber::Output::base object $data could be anything - the caller is expected to know. ``` ### set\_output\_tail ``` Set the output tail of a Biber::Output::base object $data could be anything - the caller is expected to know. ``` ### get\_output\_head ``` Get the output head of a Biber::Output object $data could be anything - the caller is expected to know. Mainly used in debugging ``` ### get\_output\_tail ``` Get the output tail of a Biber::Output object $data could be anything - the caller is expected to know. Mainly used in debugging ``` ### add\_output\_head ``` Add to the head output data of a Biber::Output::base object The base class method just does a string append ``` ### add\_output\_tail ``` Add to the tail output data of a Biber::Output::base object The base class method just does a string append ``` ### set\_output\_section ``` Records the section object in the output object We need some information from this when writing the output ``` ### get\_output\_section ``` Retrieve the output section object ``` ### get\_output\_entries ``` 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. ``` ### get\_output\_macros ``` Get the output macros for tool mode tests ``` ### get\_output\_comments ``` Get the output comments for tool mode tests ``` ### clear\_output\_macros ``` Clear the output macros ``` ### clear\_output\_comments ``` Clear the output comments ``` ### get\_output\_entry ``` 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. ``` ### set\_output\_entry ``` Add an entry output to a Biber::Output::base object The base class method just does a dump ``` ### create\_output\_misc ``` Create the output for misc bits and pieces like preamble and closing macro call and add to output object. ``` ### create\_output\_section ``` Create the output from the sections data and push it into the output object. ``` ### set\_output\_keyalias ``` Set the output for a key which is an alias to another key ``` ### set\_output\_undefkey ``` Set the output for an undefined key ``` ### output ``` Generic base output method ``` ## AUTHORS Philip Kime `""` ## BUGS Please report any bugs or feature requests on our Github tracker at \. ## COPYRIGHT & LICENSE Copyright 2009-2012 François Charette and Philip Kime, all rights reserved. Copyright 2012-2026 Philip Kime, all rights reserved. This module is free software. You can redistribute it and/or modify it under the terms of the Artistic License 2.0. 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.