relaton / relaton-models

Bibliographic models
4 stars 2 forks source link

= 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 LutaML-UML and as RelaxNG Compact (RNC) grammars; see discussion under https://github.com/metanorma/metanorma-model-iso/tree/master/grammars[Grammars]. This repository contains the RNC grammars for the base BibliographicItem model, Citation model and the Contributor model.

== Bibliography UML Models

=== Bibliographic Item

image::images/RelBib_BibliographicItem.png[]

=== Bibliographic Item Types

image::images/RelBib_BibItemType.png[]

=== Citation

image::images/RelBib_Citation.png[]

=== Contributor

image::images/RelBib_Contributor.png[] image::images/RelBib_Contribution.png[]

=== Date

image::images/RelBib_Date.png[]

=== Document Relations

image::images/RelBib_DocumentRelation.png[]

=== Series

image::images/RelBib_Series.png[]

=== Keyword

image::images/RelBib_Keyword.png[]

=== Data Types

image::images/RelBib_DataTypes.png[]

=== Collection

image::images/RelBib_Collection.png[]

== Example

[source,xml]

Collaboration Agreement between CalConnect and ISO/TC 211 standards/csd-datetime-explict/csd-datetime-explict.xml standards/csd-datetime-explict/csd-datetime-explict.html standards/csd-datetime-explict/cc-18001.xml CD 18XX 2018-10-17 CalConnect CalConnect en draft 2018 CalConnect PUBLISH Standard document requirements standards/csd-document-requirements/csd-document-requirements.xml CC/DIR 10002 2018-10-17 proposal TC PUBLISH

== Document Relations

=== 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.

=== Redundancy in related documents

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.

[source,xml]

Cereals and pulses -- Determination of the nitrogen content and calculation of the crude protein content -- Kjeldahl method 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 ISO 20483 International Organization for Standardization ISO www.iso.org en fr ISO/TC 34/SC 4 Cereals and pulses 67.060 Cereals, pulses and derived products https://www.iso.org/standard/59162.html https://www.iso.org/obp/ui/#!iso:std:59162:en https://www.iso.org/contents/data/standard/05/91/59162.detail.rss ISO 20483:2013 2013 2 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. 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. 2013 ISO ISO 20483:2006 ISO 20483 (WD):2013 2013-01-02 20 00