NAME¶
Biber::Entry - Biber::Entry objects
new¶
Initialize a Biber::Entry object
There are three types of field possible in an entry:
* raw - These are direct copies of input fields with no processing performed on them.
Such fields are used for tool mode where we don't want to alter the fields as they
need to go back into the output as they are
* data - These are fields which derive directly from or are themselves fields in the
data souce. Things like YEAR, MONTH, DAY etc. are such fields which are derived from,
for example, the DATE field (which is itself a "raw" field). They are part of the
original data implicitly, derived from a "raw" field.
* other - These are fields, often meta-information like labelname, labelalpha etc. which are
more removed from the data fields.
The reason for this division is largely the entry cloning required for the related entry and
inheritance features. When we clone an entry or copy some fields from one entry to another
we generally don't want the "other" category as such derived meta-fields will often need
to be re-created or ignored so we need to know which are the actual "data" fields to copy/clone.
"raw" fields are important when we are writing bibtex format output (in tool mode for example)
since in such cases, we don't want to derive implicit fields like YEAR/MONTH from DATE.
relclone¶
Recursively create related entry clones starting with an entry
clone¶
Clone a Biber::Entry object and return a copy
Accepts optionally a key for the copy
notnull¶
Test for an empty object
set_labelname_info¶
Record the labelname information. This is special
meta-information so we have a seperate method for this
Takes a hash ref with the information.
get_labelname_info¶
Retrieve the labelname information. This is special
meta-information so we have a seperate method for this
Returns a hash ref with the information.
set_labelnamefh_info¶
Record the fullhash labelname information. This is special
meta-information so we have a seperate method for this
Takes a hash ref with the information.
get_labelnamefh_info¶
Retrieve the fullhash labelname information. This is special
meta-information so we have a seperate method for this
Returns a hash ref with the information.
set_labeltitle_info¶
Record the labeltitle information. This is special
meta-information so we have a seperate method for this
Takes a hash ref with the information.
get_labeltitle_info¶
Retrieve the labeltitle information. This is special
meta-information so we have a seperate method for this
Returns a hash ref with the information.
set_labeldate_info¶
Record the labeldate information. This is special
meta-information so we have a seperate method for this
Takes a hash ref with the information.
get_labeldate_info¶
Retrieve the labeldate information. This is special
meta-information so we have a seperate method for this
Returns a hash ref with the information.
set_field¶
Set a derived field for a Biber::Entry object, that is, a field
which was not an actual bibliography field
get_field¶
Get a field for a Biber::Entry object
Uses // as fields can be null (end dates etc).
Get all field forms for a Biber::Entry object field
Get all field form names for a Biber::Entry object field
Get all field lang names for a Biber::Entry object field and form
set_datafield¶
Set a field which is in the .bib data file
Set all forms of a field which is in the bib data file
set_rawfield¶
Save a copy of the raw field from the datasource
get_rawfield¶
Get a raw field
get_datafield¶
Get a field that was in the original data file
del_field¶
Delete a field in a Biber::Entry object
del_datafield¶
Delete an original data source data field in a Biber::Entry object
field_exists¶
Check whether a field exists (even if null)
Check whether a representation form for a field exists (even if null)
datafields¶
Returns a sorted array of the fields which came from the data source
rawfields¶
Returns a sorted array of the raw fields and contents
count_datafields¶
Returns the number of datafields
fields¶
Returns a sorted array of all field names, including ones
added during processing which are not necessarily fields
which came from the data file
count_fields¶
Returns the number of fields
has_keyword¶
Check if a Biber::Entry object has a particular keyword in
in the KEYWORDS field.
add_warning¶
Append a warning to a Biber::Entry object
set_inherit_from¶
Inherit fields from parent entry
$entry->set_inherit_from($parententry);
Takes a second Biber::Entry object as argument
Tailored for set inheritance which is a straight 1:1 inheritance,
excluding certain fields for backwards compatibility
resolve_xdata¶
Recursively resolve XDATA fields in an entry
$entry->resolve_xdata($xdata_entry);
inherit_from¶
Inherit fields from parent entry (as indicated by the crossref field)
$entry->inherit_from($parententry);
Takes a second Biber::Entry object as argument
Uses the crossref inheritance specifications from the .bcf
dump¶
Dump Biber::Entry object
AUTHORS¶
Francois Charette, "<firmicus at ankabut.net>" 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-2014 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.