---
name: "Biber::Annotation"
section: "3pm"
platform: "linux"
package: "biber"
version: "1:2.22-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Biber::Annotation"
---

# Biber::Annotation(3pm)

Biber::Annotation objects

## NAME

Biber::Entry::Annotation - Biber::Annotation objects

### set\_annotation

```
  Record an annotation for a scope and citekey
```

### inherit\_annotations

```
  Inherit, in a granular manner, annotations for a particular entryfield from
  one entry to another for all annotation names, reindxeing any item counts using
  an offset since annotations might be copied due to xdata inheritance which can
  change the item positions of annotations
```

### copy\_annotations

```
  Copy all annotations from one entry to another
```

### get\_annotation\_names

```
  Retrieve all annotation names for a citekey and field
```

### get\_annotations

```
  Retrieve all annotations for a scope and citekey
```

### get\_annotation

```
  Retrieve an specific annotation for a scope, citekey and name
```

### is\_literal\_annotation

```
  Check if an annotation is a literal annotation
```

### is\_annotated\_field

```
  Returns boolean to say if a field is annotated
```

### get\_field\_annotation

```
  Retrieve 'field' scope annotation for a field. There will only be one.
```

### get\_annotated\_fields

```
  Retrieve all annotated fields for a particular scope for a key
```

### get\_annotated\_items

```
  Retrieve the itemcounts for a particular scope, key, field and nam3
```

### get\_annotated\_parts

```
  Retrieve the parts for a particular scope, key, field, name and itemcount
```

### dump

```
    Dump config information (for debugging)
```

## 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 2012-2026 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.