.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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::Annotation 3pm"
.TH Biber::Annotation 3pm 2023-07-25 "perl v5.38.0" "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::Entry::Annotation \- Biber::Annotation objects
.SS set_annotation
.IX Subsection "set_annotation"
.Vb 1
\&  Record an annotation for a scope and citekey
.Ve
.SS copy_annotations
.IX Subsection "copy_annotations"
.Vb 1
\&  Copy all annotations from one entry to another
.Ve
.SS get_annotation_names
.IX Subsection "get_annotation_names"
.Vb 1
\&  Retrieve all annotation names for a citekey and field
.Ve
.SS get_annotations
.IX Subsection "get_annotations"
.Vb 1
\&  Retrieve all annotations for a scope and citekey
.Ve
.SS get_annotation
.IX Subsection "get_annotation"
.Vb 1
\&  Retrieve an specific annotation for a scope, citekey and name
.Ve
.SS is_literal_annotation
.IX Subsection "is_literal_annotation"
.Vb 1
\&  Check if an annotation is a literal annotation
.Ve
.SS is_annotated_field
.IX Subsection "is_annotated_field"
.Vb 1
\&  Returns boolean to say if a field is annotated
.Ve
.SS get_field_annotation
.IX Subsection "get_field_annotation"
.Vb 1
\&  Retrieve \*(Aqfield\*(Aq scope annotation for a field. There will only be one.
.Ve
.SS get_annotated_fields
.IX Subsection "get_annotated_fields"
.Vb 1
\&  Retrieve all annotated fields for a particular scope for a key
.Ve
.SS get_annotated_items
.IX Subsection "get_annotated_items"
.Vb 1
\&  Retrieve the itemcounts for a particular scope, key, field and nam3
.Ve
.SS get_annotated_parts
.IX Subsection "get_annotated_parts"
.Vb 1
\&  Retrieve the parts for a particular scope, key, field, name and itemcount
.Ve
.SS dump
.IX Subsection "dump"
.Vb 1
\&    Dump config information (for debugging)
.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 2012\-2023 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.