GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Biber::Config(3) User Contributed Perl Documentation Biber::Config(3)
 

Biber::Config - Configuration items which need to be saved across the
lifetime of a Biber object
  This class contains a static object and static methods to access
  configuration and state data. There are several classes of data in here
  which have separate accessors:
  * Biber options
  * Biblatex options
  * State information used by Biber as it processes entries
  * displaymode date

    Reset internal hashes to defaults.

    Initialise default options, optionally with config file as argument

Returns the full path of the Biber configuration file. If returns the first file found among:
"biber.conf" in the current directory
"$HOME/.biber.conf"
"$ENV{XDG_CONFIG_HOME}/biber/biber.conf"
"$HOME/Library/biber/biber.conf" (Mac OSX only)
"$ENV{APPDATA}/biber.conf" (Windows only)
the output of "kpsewhich biber.conf" (if available on the system).
If no file is found, it returns "undef".

    Return a boolean saying whether uniquenename+uniquelist processing is finished

    Set a boolean saying whether uniquename+uniquelist has changed

    Place to postprocess biber options when they have been
    gathered from all the possible places that set them

    Sets the data model information object

    Gets the data model information object

    Stores the path to the control file

    Retrieved the path to the control file

    Store a Biber config option

    Get a Biber option

    Store a Biber command-line option

    Store a Biber config-file option

    Check if an option is explicitly set by user on the command
    line

    Check if an option is explicitly set by user in their
    config file

    Check if an option is explicitly set by user on the command
    line or in the config file

    Set a biblatex option on the appropriate scope

    Get a biblatex option from the global or per entry-type scope
    getblxoption('option', ['entrytype'], ['citekey'])
    Returns the value of option. In order of decreasing preference, returns:
    1. Biblatex option defined for entry
    2. Biblatex option defined for entry type
    3. Biblatex option defined globally

   Record node and arc connection types for .dot output

    Return an inheritance graph data structure for an inheritance type

  Record a parent->child set relationship

  Record a child->parent set relationship

  Return a boolean saying if there is a parent->child set relationship

  Return a boolean saying if there is a child->parent set relationship

  Return a list of children for a parent set

  Return a list of parents for a child of a set

    Record that $target inherited information from $source
    Can be used for crossrefs and xdata. This just records that an entry
    inherited from another entry, for loop detection.

    Check if $target directly inherited information from $source
    Can be used for crossrefs and xdata

  Checks for an inheritance path from entry $e1 to $e2
  Can be used for crossrefs and xdata
[
{s => 'A',
t => 'B'},
{s => 'A',
t => 'E'},
{s => 'B',
t => 'C'},
{s => 'C',
t => 'D'} ];

    Increment a counter to say we have seen this labelalpha

    Get the disambiguation counter for this labelalpha.
    Return a 0 for undefs to avoid spurious errors.

  Set some key order information

  Get some key order information

  Get maximum key order number for a section

  Reset keyorder - for use in tests where we switch to allkeys

    Get the count of a key

    Increment the seen count of a key

    Get the count of occurences of a labelname or labeltitle

    Increment the count of occurences of a labelname or labeltitle

    Reset the counters for extra*

    Increment and return the counter for extrayear

    Increment and return the counter for extratitle

    Increment and return the counter for extratitleyear

    Increment and return the counter for extraalpha

    Get the count of an labelname/labelyear combination for tracking
    extrayear. It uses labelyear plus name as we need to disambiguate
    entries with different labelyear (like differentiating 1984--1986 from
    just 1984)

    Increment the count of an labelname/labelyear combination for extrayear
    We pass in the name and year strings seperately as we have to
    be careful and only increment this counter beyond 1 if there is
    a name component. Otherwise, extrayear gets defined for all
    entries with no name but the same year etc.

    Get the count of an labelname/labeltitle combination for tracking
    extratitle.

    Increment the count of an labelname/labeltitle combination for extratitle
    We pass in the name and year strings seperately as we have to
    be careful and only increment this counter beyond 1 if there is
    a title component. Otherwise, extratitle gets defined for all
    entries with no title.

    Get the count of an labeltitle/labelyear combination for tracking
    extratitleyear

    Increment the count of an labeltitle/labelyear combination for extratitleyear
    We pass in the title and year strings seperately as we have to
    be careful and only increment this counter beyond 1 if there is
    a title component. Otherwise, extratitleyear gets defined for all
    entries with no title.

    Get the number of uniquelist entries for a (possibly partial) list

    Incremenent the count for a list part to the data for a name

    Incremenent the count for a complete list to the data for a name

    Incremenent the count for a list and year to the data for a name
    Used to track uniquelist = minyear

    Get the count for a list and year to the data for a name
    Used to track uniquelist = minyear

    Get the number of uniquelist entries for a full list

    Reset the count for list parts and complete lists

    Returns true if some other list differs at passed nth place
    and is at least as long
    list_differs_nth([a, b, c, d, e], 3) = 1
    if there is another list like any of these:
    [a, b, d, e, f]
    [a, b, e, z, z, y]

    Returns true if some list differs from passed list in its last place
    list_differs_last([a, b, c]) = 1
    if there is another list like any of these:
    [a, b, d]
    [a, b, d, e]

    Returns true if some list differs from passed list by being
    identical to the list up to the end of the list but also
    by having extra elements after this
    list_differs_superset([a, b, c]) = 1
    if there is another list like any of these:
    [a, b, c, d]
    [a, b, c, d, e]

    Get the number of uniquenames entries for a visible name

    Get the number of uniquenames entries for a name

    Add a name to the list of name contexts which have the name in it
    (only called for visible names)

    Add a name to the list of name contexts which have the name in it
    (called for all names)

    Reset the list of names which have the name part in it

    Get the list of name contexts which contain a name
    Mainly for use in tests

    Return ref to array of keys which are crossref targets

    Return an integer representing the number of times a
    crossref target key has been ref'ed

    Remove a crossref target key from the crossrefkeys state

    Increment the crossreferences count for a target crossref key

    Set the display mode for a field.
    setdisplaymode(['entrytype'], ['field'], ['citekey'], $value)
    This sets the desired displaymode to use for some data in the bib.
    Of course, this is entirey seperate semantically from the
    displaymodes *defined* in the bib which just tell you what to return
    for a particular displaymode request for some data.

    Get the display mode for a field.
    getdisplaymode(['entrytype'], ['field'], ['citekey'])
    Returns the displaymode. In order of decreasing preference, returns:
    1. Mode defined for a specific field in a specific citekey
    2. Mode defined for a citekey
    3. Mode defined for a fieldtype (any citekey)
    4. Mode defined for an entrytype (any citekey)
    5. Mode defined globally (any citekey)

    Dump config information (for debugging)

Francois Charette, "<firmicus at ankabut.net>" Philip Kime "<philip at kime.org.uk>"

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

Copyright 2009-2015 Francois Charette and 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.
2019-01-03 perl v5.28.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.