PersonAuthor

class documenteer.citations.PersonAuthor(*, family_name, given_name=None, orcid=None, affiliation=None)

Bases: object

A person credited as an author of a cited work.

Parameters:

• family_name (str)

• given_name (str | None, default: None)

• orcid (str | None, default: None)

• affiliation (str | None, default: None)

Attributes Summary

affiliation	The person's affiliation, as a single display name.
bibtex_name	The name as a BibTeX author field entry, in BibTeX's Family, Given form so that a style can reorder or abbreviate it.
citation_name	The name as it appears in a rendered citation, family name first.
family_name	The person's family name (last name in western culture).
given_name	The person's given name (first name in western culture), if known.
key_component	The part of a BibTeX key this author contributes.
orcid	The person's ORCID, in whatever spelling the source provides.

Attributes Documentation

affiliation: str | None = None

The person’s affiliation, as a single display name.

Neither Citation.to_plain_text nor Citation.to_bibtex renders an affiliation — a bibliographic reference credits people, not their institutions. It is carried here because the metadata formats a citation is exchanged in do record it, one affiliation per creator: CFF’s Person has an affiliation string and DataCite’s creators have affiliations.

bibtex_name

The name as a BibTeX author field entry, in BibTeX’s Family, Given form so that a style can reorder or abbreviate it.

A person credited by family name alone is braced instead, for the same reason OrganizationAuthor.bibtex_name is: with no comma to mark where the family name starts, BibTeX reads the name as given names followed by a family name, and a style would render Rubin’s Survey Cadence Optimization Committee as something like “S. C. O. Committee”. The braces say that the whole string is the name. They are inert around a mononym, so the branch braces every family-only name rather than only the multi-word ones.

citation_name

The name as it appears in a rendered citation, family name first.

family_name: str = <dataclasses._MISSING_TYPE object>

The person’s family name (last name in western culture).

given_name: str | None = None

The person’s given name (first name in western culture), if known.

key_component

The part of a BibTeX key this author contributes.

orcid: str | None = None

The person’s ORCID, in whatever spelling the source provides.