serializers
: Serializing bibliographic data¶
Stock serializers for Relaton bibliographic items.
bibxml
: BibXML element tree¶
Serialization of relaton.models.bibdata.BibliographicItem
into BibXML (xml2rfc) format roughly per RFC 7991,
with bias towards existing xml2rfc documents where differs.
Primary API is serialize()
.
See also
- relaton.serializers.bibxml.serialize(item: BibliographicItem, anchor: Optional[str] = None) Element [source]¶
Converts a BibliographicItem to XML, trying to follow RFC 7991.
Returned root element is either a
<reference>
or a<referencegroup>
.- Parameters
anchor (str) – resulting root element
anchor
property.- Raises
ValueError – if there are different issues with given item’s structure that make it unrenderable per RFC 7991.
Abstracts¶
- relaton.serializers.bibxml.abstracts.create_abstract(abstracts: List[GenericStringValue]) Element [source]¶
Formats an
<abstract>
element.
Anchors¶
- relaton.serializers.bibxml.anchor.get_suitable_anchor(item: BibliographicItem) str [source]¶
From a
BibliographicItem
instance get best anchor value and return it as a string.- Parameters
item – a
bib_models.bibdata.BibliographicItem
instance- Returns str
a string to be used as anchor
- Return type
- Raises
ValueError – unable to obtain an anchor
References¶
- relaton.serializers.bibxml.reference.create_reference(item: BibliographicItem) Element [source]¶
- relaton.serializers.bibxml.reference.create_referencegroup(items: List[BibliographicItem]) Element [source]¶
Series¶
- relaton.serializers.bibxml.series.extract_doi_series(docid: DocID) Optional[Tuple[str, str]] [source]¶
- relaton.serializers.bibxml.series.extract_rfc_series(docid: DocID) Optional[Tuple[str, str]] [source]¶
- relaton.serializers.bibxml.series.extract_id_series(docid: DocID) Optional[Tuple[str, str]] [source]¶
- relaton.serializers.bibxml.series.extract_w3c_series(docid: DocID) Optional[Tuple[str, str]] [source]¶
- relaton.serializers.bibxml.series.extract_3gpp_tr_series(docid: DocID) Optional[Tuple[str, str]] [source]¶
Targets¶
bibxml_string
: BibXML string¶
- relaton.serializers.bibxml_string.serialize(item: BibliographicItem, **kwargs) bytes [source]¶
Passes given item and any kwargs through to
relaton.serializers.bibxml.serialize()
, and renders the obtained XML element as an UTF8-encoded string with pretty print.