Skip to content
Bibliographic models
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
grammars
images
models
.gitignore
.travis.yml
Makefile
README.adoc

README.adoc

The Relaton Bibliographic Models

These bibliographic models are developed to consolidate and standardize the data models used for bibliographic and citation purposes.

These models are meant to be fully compatible with ISO 690 and ISO TC 46’s (and SC 4, SC 9) work on bibliography.

They are used extensively in the following projects as containers for bibliographic data management and for managing document metadata:

Below are the UML diagrams.

The document models are expressed as UML and as RelaxNG Compact (RNC) grammars; see discussion under Grammars. This repository contains the RNC grammars for the base BibliographicItem model, Citation model and the Contributor model.

The document models are currently used by IsoDoc-based authoring tools for standards, which convert Asciidoctor source to XML representations of the document models, and validate the XML generated against the RNC schemas:

They are also used by tools that render those XML representations of the document models, into HTML and Microsoft Word:

Bibliography UML Models

Bibliographic Item

RelBib BibliographicItem

Citation

RelBib Citation

Contributor

RelBib Contributor
RelBib Contribution

Date

RelBib Date

Document Relations

RelBib DocumentRelation

Series

RelBib Series

Data Types

RelBib DataTypes

Collection

RelBib Collection

Example

<bibdata type="standard">
  <title language="en" format="plain">Collaboration Agreement between CalConnect and ISO/TC 211</title>
  <uri type='xml'>standards/csd-datetime-explict/csd-datetime-explict.xml</uri>
  <uri type='html'>standards/csd-datetime-explict/csd-datetime-explict.html</uri>
  <uri type='relaton'>standards/csd-datetime-explict/cc-18001.xml</uri>
  <docidentifier>CD 18XX</docidentifier>
  <date type='published'><on>2018-10-17</on></date>

  <contributor>
    <role type="author"/>
    <organization>
      <name>CalConnect</name>
    </organization>
  </contributor>
  <contributor>
    <role type="publisher"/>
    <organization>
      <name>CalConnect</name>
    </organization>
  </contributor>

  <language>en</language>
  <script>Latn</script>
  <status format="plain">draft</status>
  <copyright>
    <from>2018</from>
    <owner>
      <organization>
        <name>CalConnect</name>
      </organization>
    </owner>
  </copyright>
  <editorialgroup>
    <technical-committee>PUBLISH</technical-committee>
  </editorialgroup>

  <relation type='partOf'>
    <bibdata type='governance'>
      <title>Standard document requirements</title>
      <uri type='xml'>standards/csd-document-requirements/csd-document-requirements.xml</uri>
      <docidentifier>CC/DIR 10002</docidentifier>
      <date type='updated'><on>2018-10-17</on></date>
      <status>proposal</status>
      <technical-committee>TC PUBLISH</technical-committee>
    </bibdata>
  </relation>

</bibdata>

Document Relations

Types

The document relation types are to be understood as follows:

obsoletes

The document described in the main record supersedes the document in the relation, which is no longer valid.

updates

The document described in the main record is an update of the document in the relation, which may or may not still be valid. (By default in the standards world, it is not.)

updatedBy

The document described in the main record is updated by the document in the relation.

complements

The document described in the main record is complementary to the document in the relation, and provides additional or contextual information to help understand the document in the relation.

derivedFrom

The document described in the main record is derived from the document in the relation.

translatedFrom

The document described in the main record is a translation of the document in the relation.

adoptedFrom

The document described in the main record corresponds to the document in the relation, and has been adopted in response to it. Typically it is a national standard body’s counterpart to an international standard.

equivalent

The document described in the main record corresponds to the document in the relation, and is equivalent to it in force and scope, though not in content. It is typically a subclass of the adoptedFrom relation.

identical

The document described in the main record corresponds to the document in the relation, is equivalent to it in force and scope, and is identical to it in content. It is typically a subclass of the adoptedFrom relation.

nonequivalent

The document described in the main record corresponds to the document in the relation, but is not equivalent to it in force and scope. It is typically a subclass of the adoptedFrom relation.

includedIn

The document described in the main record is a part (component) of the document in the relation (the host document); for example, chapter vs book, paper vs journal or proceedings, record track vs record. In general, text-based resources have components that can be considered a different kind of resource; components of non-textual resources are considered to be of the same type as their host.

includes

The document described in the main record contains the document in the relation. This is the inverse relation to includedIn.

instance

The document described in the main record is a generic reference to a work, and the document described in the relation is an instance of that work; for example, a specific edition or version of the main record. This is used for example to represent the relation bewteen generic ISO standards, and references to a particular edition of a standard, such as ISO 690 vs ISO 690:2010.

partOf

The document described in the main record is a multi-part document, and the document described in the relation is one of those parts. For example, ISO 639 refers to the ISO standard for language names; it has three parts ISO 639-1 (two-letter codes), ISO 639-2 (three-letter codes for major languages), and ISO 639-3 (three-letter codes for all natural languages). This relation is equivalent to includes, but is specific to multi-part textual documents, and understands the including and included documents to be of the same type.

hasDraft

The document described in the main record is a generic reference to a work (whether published or pre-published), and the document described in the relation is specific pre-publication version of the work. Is used to collect information about different drafts of a work, and gateway stages of standards, in the one record.

Relation scope

The relation between two items can include a locality element. This is used to indicate part of the first item is related to the second; for example, which part of the first item is superseded by the second. The locality in the relation element can be used with includedIn relations, to indicate the extent of the contained item within the host item; but for consistency, it is preferable to use the extent element in the contained item, which has the same meaning.

Many of the relations are between documents that are closely related, and can be considered different levels or forms of representation of the same content. This applies to a lesser extent to: obsoletes, updates, updatedBy, derivedFrom, nonequivalent, instance; it applies to a greater extent to: translatedFrom, adoptedFrom, identical, equivalent, hasDraft. (The remaining relations, complements, includedIn, includes, partOf, involve part-whole relations, which do not identify the two records in any way.)

Inasmuch as the related records represent the same content, they will have many of the same attributes in common, particularly title and authorship, and potentially also identifier, publisher, and abstract. It is not necessary to repeat the same information in the main and the related record: depending on the relation type, the common elements will usually be understood. If for example hasDraft is used to represent the various stages a standards document has gone through to date, the records contained in the hasDraft relations do not need to repeat the authors, publishers, abstract, or title given in the main record: typically the document identifier for the particular draft, and the date the draft was circulated, should be sufficient.

The following is an example of a description of a document, an instance of the document, and a draft of the instance. The document is ISO 20483, and its description is intended to apply generically to all editions (instances) of the document, including the 2006 and 2013 editions. The specific edition described is the 2013 edition, and the draft of the 2013 edition is the working draft. (The 2013 edition description also links to the 2006 edition description, which it supersedes.)

Those attributes that are common to all three levels of description, such as the title and the publisher, are stated only once, at the top level; the attributes that apply at lower levels, such as edition and abstract for the edition, and circulation date and status for the draft, are stated once at the first level they apply to. If an attribute value is overridden between levels of description, such as docidentifier, both the base value and the override value are given in their respective levels.

<bibitem type="international-standard" id="ISO20483-2013">
  <title format="text/plain" language="en" script="Latn">Cereals and pulses -- Determination of the nitrogen content and calculation of the crude protein content -- Kjeldahl method</title>
  <title format="text/plain" language="fr" script="Latn">Céréales et légumineuses -- Détermination de la teneur en azote et calcul de la
teneur en protéines brutes -- Méthode de Kjeldahl</title>
  <docidentifier type="ISO">ISO 20483</docidentifier>
  <contributor>
    <role type="publisher"/>
    <organization>
      <name>International Organization for Standardization</name>
      <abbreviation>ISO</abbreviation>
      <uri>www.iso.org</uri>
    </organization>
  </contributor>
  <language>en</language>
  <language>fr</language>
  <script>Latn</script>
  <editorialgroup>
    <technical_committee number="34" type="TC">ISO/TC 34/SC 4 Cereals and pulses</technical_committee>
  </editorialgroup>
  <ics>
    <code>67.060</code>
    <text>Cereals, pulses and derived products</text>
  </ics>

  <relation type="instance">
    <bibitem type="international-standard" id="ISO20483-2013">
      <uri type="src">https://www.iso.org/standard/59162.html</uri>
      <uri type="obp">https://www.iso.org/obp/ui/#!iso:std:59162:en</uri>
      <uri type="rss">https://www.iso.org/contents/data/standard/05/91/59162.detail.rss</uri>
      <docidentifier type="ISO">ISO 20483:2013</docidentifier>
      <date type="published">
        <on>2013</on>
      </date>
      <edition>2</edition>
      <abstract format="plain" language="en" script="Latn">ISO 20483:2013 specifies a method for the determination of the nitrogen content of cereals, pulses and derived products, according to the Kjeldahl method, and a method for calculating the crude protein content. The method does not distinguish between protein nitrogen and non-protein nitrogen.</abstract>
      <abstract format="plain" language="fr" script="Latn">L'ISO 20483:2013 spécifie une méthode pour la détermination de la teneur en azote dd
    es céréales, des légumineuses et des produits dérivés, selon la méthode de Kjeldahl, ainsi qu'une méthode de calcul de la teneur en prr
    otéines brutes. La méthode ne fait pas la distinction entre l'azote protéique et l'azote non protéique.</abstract>
      <copyright>
        <from>2013</from>
        <owner>
          <organization>
            <name>ISO</name>
          </organization>
        </owner>
      </copyright>
      <relation type="obsoletes">
        <bibitem>
          <formattedref>ISO 20483:2006</formattedref>
        </bibitem>
      </relation>

      <relation type="instance">
        <bibitem type="international-standard" id="ISO20483-2013">
          <docidentifier type="ISO">ISO 20483 (WD):2013</docidentifier>
          <date type="circulated">
            <on>2013-01-02</on>
          </date>
          <status>
            <stage>20</stage>
            <substage>00</substage>
          </status>
        </bibitem>
      </relation>
    </bibitem>
  </relation>
</bibitem>

Dates

Dates in Relaton are of different types. The following definitions should be understood with particular relation to standards documents..

:issued:

The date on which the standard was issued (authorised for publication by the issuing authority).

:published:

The date on which the standard was published (distributed by the publisher).

:implemented:

The date on which the standard became active.

:created:

The date on which the first version of the standard was created.

:updated:

The date on which the current version of the standard was updated.

:obsoleted:

The date on which the standard was obsoleted/revoked.

:confirmed:

The date on which the standard was reviewed and approved by the issuing authority.

:unchanged:

The date on which the standard was last renewed without any changes in content.

:circulated:

The date on which the unpublished standard was last circulated officially as a preprint. For standards, this is associated with the latest transition to a formally defined preparation stage, such as Working Draft or Committee Draft.

With relation to other classes of document, typically only the published date is of interest.

You can’t perform that action at this time.