.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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::Section 3pm"
.TH Biber::Section 3pm 2025-03-09 "perl v5.40.1" "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::Section \- Biber::Section objects
.SS new
.IX Subsection "new"
.Vb 1
\&    Initialize a Biber::Section object
.Ve
.SH citecount
.IX Header "citecount"
.SS set_citecount
.IX Subsection "set_citecount"
.Vb 4
\&    Set the citecount of a key. This comes from biblatex via the
\&    citecounter option and reflects the actual number of citations using
\&    this key, taking into account things like \eciteauthor etc. which are not
\&    real citations.
.Ve
.SS get_keycount
.IX Subsection "get_keycount"
.Vb 5
\&    Get the citecount of a key. This comes from biblatex via the
\&    citecounter option and reflects the actual number of citations using
\&    this key, taking into account things like \eciteauthor etc. which are not
\&    real citations. A zero or undef value needs to be less than 0 which does
\&    not fail if() checks \- required for the delicate sorting dispatch logic
.Ve
.SH seenkey
.IX Header "seenkey"
.SS get_seenkey
.IX Subsection "get_seenkey"
.Vb 1
\&    Get the count of a key
.Ve
.SS incr_seenkey
.IX Subsection "incr_seenkey"
.Vb 1
\&    Increment the seen count of a key
.Ve
.SS reset_caches
.IX Subsection "reset_caches"
.Vb 1
\&    Reset section caches which need it
.Ve
.SS set_np_length
.IX Subsection "set_np_length"
.Vb 1
\&  Check and record max namepart length. Needed to construct sort keys for names
.Ve
.SS get_np_length
.IX Subsection "get_np_length"
.Vb 1
\&  Return max namepart length. Needed to construct sort keys for names
.Ve
.SS set_set_pc
.IX Subsection "set_set_pc"
.Vb 1
\&  Record a parent\->child set relationship
.Ve
.SS set_set_cp
.IX Subsection "set_set_cp"
.Vb 1
\&  Record a child\->parent set relationship
.Ve
.SS get_set_pc
.IX Subsection "get_set_pc"
.Vb 1
\&  Return a boolean saying if there is a parent\->child set relationship
.Ve
.SS get_set_cp
.IX Subsection "get_set_cp"
.Vb 1
\&  Return a boolean saying if there is a child\->parent set relationship
.Ve
.SS get_set_children
.IX Subsection "get_set_children"
.Vb 1
\&  Return a list of children for a parent set
.Ve
.SS get_set_parents
.IX Subsection "get_set_parents"
.Vb 1
\&  Return a list of parents for a child of a set
.Ve
.SS set_keytods
.IX Subsection "set_keytods"
.Vb 1
\&  Save information about citekey\->datasource name mapping. Used for error reporting.
.Ve
.SS get_keytods
.IX Subsection "get_keytods"
.Vb 1
\&  Get information about citekey\->datasource name mapping. Used for error reporting.
.Ve
.SS has_badcasekey
.IX Subsection "has_badcasekey"
.Vb 3
\&    Returns a value to say if we\*(Aqve seen a key differing only in case before
\&    <previouskey>  \- we\*(Aqve seen a differently cased variant of this key so we can warn about this
\&    undef  \- Not seen this key at all in any case variant before
.Ve
.SS is_specificcitekey
.IX Subsection "is_specificcitekey"
.Vb 1
\&    Check if a key is specifically cited by \ecite{key} or \enocite{key}
.Ve
.SS add_related
.IX Subsection "add_related"
.Vb 1
\&    Record that a key is used as a related entry
.Ve
.SS is_related
.IX Subsection "is_related"
.Vb 1
\&    Check if a key is used as a related entry key
.Ve
.SS keytorelclone
.IX Subsection "keytorelclone"
.Vb 1
\&    Record a key<\->clone key mapping.
.Ve
.SS get_keytorelclone
.IX Subsection "get_keytorelclone"
.Vb 1
\&    Fetch a related entry clone key, given a cite key
.Ve
.SS get_relclonetokey
.IX Subsection "get_relclonetokey"
.Vb 1
\&    Fetch a related entry key, given a clone key
.Ve
.SS has_keytorelclone
.IX Subsection "has_keytorelclone"
.Vb 1
\&    Return boolean saying if a cite key has a related entry clone in the current section
.Ve
.SS has_relclonetokey
.IX Subsection "has_relclonetokey"
.Vb 1
\&    Return boolean saying if a related clone key has a citekey in the current section
.Ve
.SS add_cite
.IX Subsection "add_cite"
.Vb 1
\&    Adds a key to the list of those that came via \ecite
.Ve
.SS is_cite
.IX Subsection "is_cite"
.Vb 1
\&    Returns a boolean to say if a key came via \ecite
.Ve
.SS add_nocite
.IX Subsection "add_nocite"
.Vb 1
\&    Adds a key to the list of those that came via \enocite
.Ve
.SS is_nocite
.IX Subsection "is_nocite"
.Vb 1
\&    Returns a boolean to say if a key came via \enocite
.Ve
.SS add_everykey
.IX Subsection "add_everykey"
.Vb 1
\&    Adds a datasource key to the section list of all datasource keys
.Ve
.SS del_everykeys
.IX Subsection "del_everykeys"
.Vb 1
\&  Delete everykey cache. For use in tests.
.Ve
.SS has_everykey
.IX Subsection "has_everykey"
.Vb 3
\&    Returns a boolean to say if we\*(Aqve seen a key in any datasource for this section.
\&    This used to be an array ref which was checked using first() and it
\&    was twenty times slower.
.Ve
.SS set_allkeys_nocite
.IX Subsection "set_allkeys_nocite"
.Vb 2
\&    Sets flag to say citekey \*(Aq*\*(Aq occurred through \enocite
\&    We allow setting it to false too because it\*(Aqs useful in tests
.Ve
.SS set_allkeys
.IX Subsection "set_allkeys"
.Vb 2
\&    Sets flag to say citekey \*(Aq*\*(Aq occurred in citekeys
\&    We allow setting it to false too because it\*(Aqs useful in tests
.Ve
.SS is_allkeys_nocite
.IX Subsection "is_allkeys_nocite"
.Vb 1
\&    Checks flag which says citekey \*(Aq*\*(Aq occurred in via \enocite
.Ve
.SS is_allkeys
.IX Subsection "is_allkeys"
.Vb 1
\&    Checks flag which says citekey \*(Aq*\*(Aq occurred in citekeys
.Ve
.SS bibentry
.IX Subsection "bibentry"
.Vb 2
\&    Returns a Biber::Entry object for the given citation key
\&    Understands citekey aliases
.Ve
.SS bibentries
.IX Subsection "bibentries"
.Vb 1
\&    Return Biber::Entries object for this section
.Ve
.SS del_bibentries
.IX Subsection "del_bibentries"
.Vb 1
\&    Delete all Biber::Entry objects from the Biber::Section object
.Ve
.SS set_citekeys
.IX Subsection "set_citekeys"
.Vb 1
\&    Sets the citekeys in a Biber::Section object
.Ve
.SS set_orig_order_citekeys
.IX Subsection "set_orig_order_citekeys"
.Vb 1
\&    Sets the original order of citekeys in a Biber::Section object
.Ve
.SS get_citekeys
.IX Subsection "get_citekeys"
.Vb 2
\&    Gets the citekeys of a Biber::Section object
\&    Returns a normal array
.Ve
.SS get_static_citekeys
.IX Subsection "get_static_citekeys"
.Vb 3
\&    Gets the citekeys of a Biber::Section object
\&    excluding dynamic set entry keys
\&    Returns a normal array
.Ve
.SS has_cited_citekey
.IX Subsection "has_cited_citekey"
.Vb 1
\&    Returns true when $key was one of the actually cited keys in the section
.Ve
.SS add_undef_citekey
.IX Subsection "add_undef_citekey"
.Vb 3
\&    Adds a citekey to the Biber::Section object as an undefined
\&    key. This allows us to output this information to the .bbl and
\&    so biblatex can do better reporting to external utils like latexmk
.Ve
.SS get_undef_citekeys
.IX Subsection "get_undef_citekeys"
.Vb 2
\&    Gets the list of undefined citekeys of a Biber::Section object
\&    Returns a normal array
.Ve
.SS get_orig_order_citekeys
.IX Subsection "get_orig_order_citekeys"
.Vb 4
\&    Gets the citekeys of a Biber::Section object in their original order
\&    This is just to ensure we have a method that will return this, just in
\&    case we mess about with the order at some point. This is needed by
\&    citeorder sorting.
.Ve
.SS has_citekey
.IX Subsection "has_citekey"
.Vb 2
\&    Returns true when $key is in the Biber::Section object
\&    Understands key alaises
.Ve
.SS del_citekey
.IX Subsection "del_citekey"
.Vb 1
\&    Deletes a citekey from a Biber::Section object
.Ve
.SS del_citekeys
.IX Subsection "del_citekeys"
.Vb 1
\&    Deletes all citekeys from a Biber::Section object
.Ve
.SS add_citekeys
.IX Subsection "add_citekeys"
.Vb 1
\&    Adds citekeys to the Biber::Section object
.Ve
.SS set_citekey_alias
.IX Subsection "set_citekey_alias"
.Vb 1
\&    Set citekey alias information
.Ve
.SS get_citekey_alias
.IX Subsection "get_citekey_alias"
.Vb 1
\&    Get citekey alias information
.Ve
.SS del_citekey_alias
.IX Subsection "del_citekey_alias"
.Vb 1
\&    Delete citekey alias
.Ve
.SS get_citekey_aliases
.IX Subsection "get_citekey_aliases"
.Vb 1
\&    Get a list of all citekey aliases for the section
.Ve
.SS set_labelcache_v
.IX Subsection "set_labelcache_v"
.Vb 1
\&    Sets the variable label disambiguation cache for a field
.Ve
.SS get_labelcache_v
.IX Subsection "get_labelcache_v"
.Vb 1
\&    Gets the variable label disambiguation cache for a field
.Ve
.SS set_labelcache_l
.IX Subsection "set_labelcache_l"
.Vb 1
\&    Sets the list label disambiguation cache for a field
.Ve
.SS get_labelcache_l
.IX Subsection "get_labelcache_l"
.Vb 1
\&    Gets the list label disambiguation cache for a field
.Ve
.SS is_dynamic_set
.IX Subsection "is_dynamic_set"
.Vb 1
\&    Test if a key is a dynamic set
.Ve
.SS set_dynamic_set
.IX Subsection "set_dynamic_set"
.Vb 1
\&    Record a mapping of dynamic key to member keys
.Ve
.SS get_dynamic_set
.IX Subsection "get_dynamic_set"
.Vb 3
\&    Retrieve member keys for a dynamic set key
\&    Check that reference returning anything to stop spurious warnings
\&    about empty dereference in return.
.Ve
.SS dynamic_set_keys
.IX Subsection "dynamic_set_keys"
.Vb 1
\&    Retrieve all dynamic set keys
.Ve
.SS has_dynamic_sets
.IX Subsection "has_dynamic_sets"
.Vb 1
\&    Returns true of false depending on whether the section has any dynamic set keys
.Ve
.SS add_datasource
.IX Subsection "add_datasource"
.Vb 1
\&    Adds a data source to a section
.Ve
.SS set_datasources
.IX Subsection "set_datasources"
.Vb 1
\&    Sets the data sources for a section
.Ve
.SS get_datasources
.IX Subsection "get_datasources"
.Vb 1
\&    Gets an array of data sources for this section
.Ve
.SS number
.IX Subsection "number"
.Vb 1
\&    Gets the section number of a Biber::Section object
.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.