AsciiBib

Defining bibliographic items using structured syntax in ASCII

AsciiBib provides an AsciiDoc-like syntax for entering a Relaton bibliographic entry based on the Relaton data model (similarly, to Relaton YAML representation).

There are two syntaxes for entering AsciiBib bibliographic entries:

AsciiBib is very useful when needing to define bibliographic items inside an AsciiDoc structure, such as within Metanorma AsciiDoc.

Note	Metanorma uses AsciiBib syntax. For those looking to enter bibliographic items in Metanorma, this is the article you want to read.

The following structure is in place for encoding bibitem as AsciiBib objects. The structure has not yet been generalised to bibdata/ext, the flavour-specific extensions of Relaton.

Note	Relaton AsciiBib can be used to represent bibliographic entries in Metanorma.

If an element in Relaton XML has attributes, the content of the element is represented in AsciiBib with a content key:

<title type="main">Geographic information</title>

title.type:: main
title.content:: Geographic information

Any elements with a cardinality of many can be represented as arrays. In case elements in array have multiple attributes they are prepended with empty name of element. For example, a Relaton can have multiple titles, and multiple languages:

title::
title.type:: main
title.content:: Geographic information
title.language:: en
title::
title.type:: main
title.content:: Information géographique
title.language:: fr
language:: en
language:: fr

The structure below is given in AsciiBib format:

[%bibitem]
== {blank}
id:: ISOTC211
fetched:: 2020-11-16
title::
title.type:: title-main
title.content:: Geographic information
title.format:: text/plain
title::
title.type:: main
title.content:: Geographic information
title.format:: text/plain
title::
title.content:: Information géographique
title.language:: fr
title.script:: Latn
title.format:: text/plain
type:: standard
docid::
docid.type:: ISO
docid.id:: TC211
docid::
docid.type:: isbn
docid.id:: ISBN
docid::
docid.type:: lccn
docid.id:: LCCN
docid::
docid.type:: issn
docid.scope:: series
docid.id:: ISSN
docid::
docid.type:: URN
docid.id:: urn:iso:std:iso:123:stage-90.93:ed-3:en,fr
docid:: XYZ
docnumber:: 123456
edition:: 1
language:: en
language:: fr
script:: Latn
version.revision_date:: 2019-04-01
version.draft:: draft
biblionote:: note
biblionote::
biblionote.type:: annote
biblionote.content:: An note
biblionote::
biblionote.type:: howpublished
biblionote.content:: How published
biblionote::
biblionote.type:: comment
biblionote.content:: Comment
biblionote::
biblionote.type:: tableOfContents
biblionote.content:: Table Of Contents
docstatus.stage:: 30
docstatus.substage:: substage
docstatus.iteration:: final
date::
date.type:: issued
date.on:: 2014
date::
date.type:: published
date.on:: 2014-04
date::
date.type:: accessed
date.on:: 2015-05-20
abstract::
abstract.content:: ISO 19115-1:2014 defines the schema required for ...
abstract.language:: en
abstract.script:: Latn
abstract.format:: text/plain
abstract::
abstract.content:: L'ISO 19115-1:2014 définit le schéma requis pour ...
abstract.language:: fr
abstract.script:: Latn
abstract.format:: text/plain
copyright.owner.name:: International Organization for Standardization
copyright.owner.abbreviation:: ISO
copyright.owner.url:: www.iso.org
copyright.role.type:: publisher
copyright.from:: 2014
copyright.to:: 2020
copyright.scope:: Scope
link::
link.type:: src
link.content:: https://www.iso.org/standard/53798.html
link::
link.type:: obp
link.content:: https://www.iso.org/obp/ui/#!iso:std:53798:en
link::
link.type:: rss
link.content:: https://www.iso.org/contents/data/standard/05/37/53798.detail.rss
link::
link.type:: doi
link.content:: https://doi.org/10.6028/NIST.HB.105-3-1997
link::
link.type:: file
link.content:: file://path/file
medium.form:: medium form
medium.size:: medium size
medium.scale:: medium scale
place::
place.name:: bib place
place::
place.city:: Geneva
place.region:: Switzelznd
extent::
extent.loclaity.type:: section
extent.loclaity.reference_from:: Reference from
extent.loclaity.reference_to:: Reference to
extent::
extent.loclaity.type:: chapter
extent.loclaity.reference_from:: 4
extent::
extent.loclaity.type:: page
extent.loclaity.reference_from:: 10
extent.loclaity.reference_to:: 20
extent::
extent.loclaity.type:: volume
extent.loclaity.reference_from:: 1
accesslocation:: accesslocation1
accesslocation:: accesslocation2
classification::
classification.type:: type
classification.value:: value
classification::
classification.type:: keyword
classification.value:: Keywords
classification::
classification.type:: mendeley
classification.value:: Mendeley Tags
validity.begins:: 2010-10-10 12:21
validity.ends:: 2011-02-03 18:30
validity.revision:: 2011-03-04 09:00
contributor::
contributor.organization.name:: International Organization for Standardization
contributor.organization.abbreviation:: ISO
contributor.organization.subdivision:: division
contributor.organization.url:: www.iso.org
contributor.role.description:: Publisher role
contributor.role.type:: publisher
contributor::
contributor.person.name.completename.content:: A. Bierman
contributor.person.name.completename.language:: en
contributor.person.affiliation.organization.name:: IETF
contributor.person.affiliation.organization.abbreviation:: IETF
contributor.person.affiliation.organization.identifier.type:: uri
contributor.person.affiliation.organization.identifier.value:: www.ietf.org
contributor.person.address.street:: Street
contributor.person.address.city:: City
contributor.person.address.state:: State
contributor.person.address.country:: Country
contributor.person.address.postcode:: 123456
contributor.person.contact.phone:: 223322
contributor.person.contact.type:: mobile
contributor.role.type:: author
contributor::
contributor.organization.name:: IETF
contributor.organization.abbreviation:: IETF
contributor.organization.identifier.type:: uri
contributor.organization.identifier.value:: www.ietf.org
contributor::
contributor.role.description:: Publisher description
contributor.role.type:: publisher
contributor::
contributor.role.description:: Editor description
contributor.role.type:: editor
contributor::
contributor.person.name.forename.content:: Forename
contributor.person.name.forename.language:: en
contributor.person.name.formatted_initials.content:: A.
contributor.person.name.formatted_initials.language:: en
contributor.person.name.surname.content:: Bierman
contributor.person.name.surname.language:: en
contributor.person.name.addition.content:: Addition
contributor.person.name.addition.language:: en
contributor.person.name.prefix.content:: Prefix
contributor.person.name.prefix.language:: en
contributor.person.affiliation.description.content:: Description
contributor.person.affiliation.description.language:: en
contributor.person.affiliation.organization.name:: IETF
contributor.person.affiliation.organization.abbreviation:: IETF
contributor.person.type:: uri
contributor.person.value:: www.person.com
contributor.person.address.street:: Street
contributor.person.address.city:: City
contributor.person.address.state:: State
contributor.person.address.country:: Country
contributor.person.address.postcode:: 123456
contributor.person.contact.phone:: 223322
contributor.person.contact.type:: mobile
contributor.role.type:: author
contributor::
contributor.organization.name:: Institution
contributor.role.description:: sponsor
contributor.role.type:: distributor
relation::
relation.type:: updates
relation.bibitem.formattedref:: ISO 19115:2003
relation::
relation.type:: obsoletes
relation.desctiption.content:: supersedes
relation.desctiption.format:: text/plain
relation.bibitem.type:: standard
relation.bibitem.formattedref:: ISO 19115:2003/Cor 1:2006
relation::
relation.type:: partOf
relation.bibitem.title.type:: main
relation.bibitem.title.content:: Book title
relation.bibitem.title.format:: text/plain
series::
series.type:: main
series.title.type:: original
series.title.content:: ISO/IEC FDIS 10118-3
series.title.language:: en
series.title.script:: Latn
series.title.format:: text/plain
series.place:: Serie's place
series.organization:: Serie's organization
series.abbreviation:: ABVR
series.from:: 2009-02-01
series.to:: 2010-12-20
series.number:: serie1234
series.partnumber:: part5678
series::
series.type:: alt
series.formattedref.content:: serieref
series.formattedref.language:: en
series.formattedref.script:: Latn
series.formattedref.format:: text/plain
series::
series.type:: journal
series.title.content:: Journal
series.title.format:: text/plain
series.number:: 7
series::
series.title.variant::
series.title.variant.content:: Series
series.title.variant.language:: en
series.title.variant.script:: Latn
series.title.variant::
series.title.variant.content:: Séries
series.title.variant.language:: fr
series.title.variant.script:: Latn
series.title.format:: text/plain
doctype:: document
keyword:: Keyword
keyword:: Key Word
editorialgroup.technical_committee.content:: Editorial group
editorialgroup.technical_committee.number:: 1
editorialgroup.technical_committee.type:: Type
ics.code:: 01
ics.text:: First
structured_identifier::
structured_identifier.docnumber:: 123
structured_identifier.agency:: agency 1
structured_identifier.agency:: agency 2
structured_identifier.type:: type 1
structured_identifier.class:: class 1
structured_identifier.partnumber:: 4
structured_identifier.edition:: 1
structured_identifier.version:: 2
structured_identifier.supplementtype:: type 2
structured_identifier.supplementnumber:: 5
structured_identifier.language:: en
structured_identifier.year:: 2020
structured_identifier::
structured_identifier.docnumber:: 456
structured_identifier.agency:: agency 3