NAME¶

Biber::Output::base - base class for Biber output modules.

    Initialize a Biber::Output::base object

    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 the output target file name

    Set the output target of a Biber::Output::base object

    Set the output head of a Biber::Output::base object
    $data could be anything - the caller is expected to know.

    Set the output tail of a Biber::Output::base object
    $data could be anything - the caller is expected to know.

    Get the output head of a Biber::Output object
    $data could be anything - the caller is expected to know.
    Mainly used in debugging

    Get the output tail of a Biber::Output object
    $data could be anything - the caller is expected to know.
    Mainly used in debugging

    Add to the head output data of a Biber::Output::base object
    The base class method just does a string append

    Add to the tail output data of a Biber::Output::base object
    The base class method just does a string append

  Records the section object in the output object
  We need some information from this when writing the output

  Retrieve the output section object

    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 the output macros for tool mode tests

    Get the output comments for tool mode tests

    Clear the output macros

    Clear the output comments

    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.

    Add an entry output to a Biber::Output::base object
    The base class method just does a dump

    Create the output for misc bits and pieces like preamble and closing
    macro call and add to output object.

    Create the output from the sections data and push it into the
    output object.

  Set the output for a key which is an alias to another key

  Set the output for an undefined key

    Generic base output method

AUTHORS¶

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

BUGS¶

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

COPYRIGHT & LICENSE¶

Copyright 2009-2012 François Charette and Philip Kime, all rights reserved. Copyright 2012-2024 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.