relaton-bib 1.4.0 → 2.1.7

data/docs/hash.adoc

@@ -49,7 +49,7 @@ The structure below is given in YAML format:
 # bibliographic item anchor, used to crossreference within document
 id: ISO/TC211
 # date record was created
-fetched: 2019-06-30
+fetched: '2019-06-30'
 # titles are an array, with a mandatory type and content, and optional format, language and script
 title:
   - type: main
@@ -66,9 +66,9 @@ docid:
   type: ISO
   id: TC211
 # document number
-docnumber: 211
+docnumber: '211'
 # edition
-edition: 1
+edition: '1'
 # language is an array
 language:
   - en
@@ -78,7 +78,7 @@ script:
   Latn
 # version contains revision date and draft (as array)
 version:
-  revision_date: 2019-04-01
+  revision_date: '2019-04-01'
   draft: draft
 # note is an array of type and content
 biblionote:
@@ -88,18 +88,21 @@ biblionote:
       home run record in 1998.
 # document status has stage, and optional substage and iteration
 docstatus:
-  stage: stage
-  substage: substage
-  iteration: iteration
+  stage:
+    value: '30'
+    abbreviation: CD
+  substage:
+    value: '00'
+  iteration: final
 # date is an array, with mandatory type, and either an "on" value or a "from" and optional "to" value
 date:
   - type: issued
-    value: 2014
+    value: '2014'
   - type: published
-    from: 2014-04
-    to: 2014-05
+    from: '2014-04'
+    to: '2014-05'
   - type: accessed
-    value: 2015-05-20
+    value: '2015-05-20'
 # abstract is an array, with content, and optional language, script, format
 abstract:
   - content: >
@@ -112,16 +115,16 @@ abstract:
 # contributors are an array of entity/role pairs, where entity is either person or organization.
 # The role is an array of type and description; it can be a an array of just string, which are treated
 # as the type.
-# Organisations have attributes name, url, abbreviation, subdivision, contacts, identifiers
+# Organisations have attributes name, url, abbreviation, subdivision, contacts, identifiers, logo.
 # Persons have attributes name, affiliation, contacts
-# Person names have attributes surname, completename, initials, forename, additions, prefixes.
+# Person names have attributes abbreviation, surname, completename, initials, forename, additions, prefixes.
 # Initials, forename, additions, prefixes are arrays.
 # Name field values are either strings, or hashes, with content and language and script attributes.
 # The language and script attribute can also be given on the name.
 # Contacts are an array, containing either addresses, or other fields.
 # Addresses are identified as hashes containing a city attribute; they can also contain a street
 # (which is an array), a postcode, a state, and a country. The other contact fields
-# are phones, emails, uris; they contain a type giving the field name, and a value.
+# are phones, emails, uris; they can contain a type.
 # Affiliations are an array, and they contains an organization, and an optional description.
 # The affiliation description can be a single string, or a hash of content, language, script, and format.
 contributor:
@@ -130,6 +133,17 @@ contributor:
       url: www.iso.org
       abbreviation: ISO
       subdivision: division
+      logo:
+        image:
+          id: logo1
+          src: logo1.png
+          mimetype: image/png
+          filename: logo1.png
+          height: "100%"
+          width: "200"
+          alt: Logo 1
+          title: "Logo #1"
+          longdesc: Logo number 1
     role:
       type: publisher
       description: Publisher role
@@ -142,21 +156,22 @@ contributor:
         - organization:
             name: IETF
             abbreviation: IETF
-             identifier:
-               - type: uri
-                 id: www.ietf.org
+            identifier:
+              - type: uri
+                id: www.ietf.org
           description: Affiliation description
       contact:
-        - street:
-          - 8 Street St
-          city: City
-          postcode: 123456
-          country: Country
-          state: State
-        - type: phone
-          value: 223322
+        - address:
+            street:
+              - 8 Street St
+            city: City
+            postcode: '123456'
+            country: Country
+            state: State
+        - phone: '223322'
+          type: mobile
     role: author
-  - person:
+  - organization:
       name: IETF
       abbreviation: IETF
       identifier:
@@ -166,6 +181,7 @@ contributor:
       publisher
   - person:
       name:
+        abbreviation: AB
         language: en
         initial:
           - A.
@@ -190,8 +206,8 @@ copyright:
      name: International Organization for Standardization
      abbreviation: ISO
      url: www.iso.org
-   from: 2014
-   to: 2020
+   from: '2014'
+   to: '2020'
 # link is an array of URIs, with a type and content
 link:
   - type: src
@@ -200,24 +216,45 @@ link:
     content: https://www.iso.org/obp/ui/#!iso:std:53798:en
   - type: rss
     content: https://www.iso.org/contents/data/standard/05/37/53798.detail.rss
-# relations are an array of type, bibitem, and bib_locality.
+# relations are an array of type, bibitem, locality, source_locality, and description.
 # bibitem contains any of the attributes of a bibliographic item.
-# bib_locality is an array that contains a type, a reference_from, and optionally a reference_to
+# locality is an array of locality_stack which is an array of hash of type,
+#   reference_from, and optionally reference_to
+# source_locality is an array of source_locality_stack which is similar to locality_stack
+# description is optional and contains content and optional format, language, ans script.
 relation:
   - type: updates
     bibitem:
       formattedref: ISO 19115:2003
-    bib_locality:
-      type: page
-      reference_from: 7
-      reference_to: 10
+    locality:
+      locality_stack:
+        type: page
+        reference_from: '7'
+        reference_to: '10'
+    source_locality:
+      source_locality_stack:
+        - type: volume
+          reference_from: '1'
+        - type: chapter
+          reference_from: '2'
   - type: updates
     bibitem:
       type: standard
-      formattedref: ISO 19115:2003/Cor 1:2006
-# series are an array, containing a type, and either a formattedref, or:
-# a title, a place, an organization (string),
-# an abbreviation, a from, a to, a number, and a partnumber.
+      formattedref:
+        content: ISO 19115:2003/Cor 1:2006
+        format: text/plain
+    description:
+      content: supersedes
+      format: text/plain
+  - type: partOf
+    bibitem:
+      title:
+        type: main
+        content: Book title
+        format: text/plain
+# series are an array, containing a title, a type, a formattedref, a place,
+# an organization (string), an abbreviation, a from, a to, a number, and a partnumber.
+# The title is mandatory, and all other fields are optional.
 # The series title, like the titles of bibliographic items, contains a type,
 # content, and optional language, script, and format attributes.
 # The abbreviation and formattedref are either a string,
@@ -236,26 +273,41 @@ series:
       content: ABVR
       language: en
       script: Latn
-    from: 2009-02-01
-    to: 2010-12-20
+    from: '2009-02-01'
+    to: '2010-12-20'
     number: serie1234
     partnumber: part5678
-  - type: alt
-    formattedref:
-      content: serieref
-      language: en
-      script: Latn
+  - title:
+      - content: Series
+        language: en
+        script: Latn
+      - content: Séries
+        language: fr
+        script: Latn
+        format: text/plain
 # medium contains a form, a size, and a scale
 medium:
   form: medium form
   size: medium size
   scale: medium scale
-# place is an array of strings
-place: bib place
-# extent is an array, containing type, a reference_from, and an optional reference_to
+# place is an array of strings or hashes. Can have name or city, region and country.
+# Name or city is mandatory, region and country are optional.
+# String and hash with name are equivalent.
+place:
+  - bib place
+  - city: Geneva
+    region:
+      - name: Region
+    country:
+      - iso: CH
+        name: Switzelznd
+        recommended: true
+# extent is an array, localities are an array of locality_stack
 extent:
-  type: section
-  reference_from: 7
+  locality:
+    type: section
+    reference_from: '7'
+    reference_to: '10'
 # accesslocation is an array of strings
 accesslocation:
   - accesslocation1
@@ -266,9 +318,15 @@ classification:
   value: value
 # validity contains a begins date, an ends date, and a revision date
 validity:
-  begins: 2010-10-10 12:21
-  ends: 2011-02-03 18:30
-  revision: 2011-03-04 09:00
+  begins: '2010-10-10 12:21'
+  ends: '2011-02-03 18:30'
+  revision: '2011-03-04 09:00'
+# keyword is an array of strings or hashes of content, language, script, and format
+keyword:
+  - Keyword
+  - Key Word
+# license is a string
+license: License
 ----
 
 == Metanorma structure (AsciiBib): nested definition list
@@ -528,8 +586,9 @@ medium::
   scale::: medium scale
 place:: bib place
 extent::
-  type::: section
-  reference_from::: 7
+  locality:::
+    type::: section
+    reference_from::: 7
 accesslocation::
   . accesslocation1
   . accesslocation2
@@ -571,7 +630,7 @@ type::: uri
 id::: www.ietf.org
 --
     description:::: Affiliation description
-  contact:::
+  address:::
     street::::
       . 8 Street St
     city:::: City
@@ -579,8 +638,8 @@ id::: www.ietf.org
     country:::: Country
     state:::: State
   contact:::
-    type:::: phone
-    value:::: 223322
+    mobile:::: 223322
+    phone:::: mobile
 role:: author
 
 ==== Contributor
@@ -699,7 +758,6 @@ docid::
 docid::
   type::: ABC
   id::: 32784
-type:: standard
 ----
 
 can instead be represented as:
@@ -726,15 +784,11 @@ Embedded elements can also repeat:
 ==== Contributor
 person::
   contact:::
-    street::::
-      . 8 Street St
-    city:::: City
-    postcode:::: 123456
-    country:::: Country
-    state:::: State
+    phone:::: 223322
+    type:::: mobile
   contact:::
-    type:::: phone
-    value:::: 223322
+    phone:::: 332233
+    type:::: work
 ----
 
 can instead be represented as:
@@ -744,14 +798,11 @@ can instead be represented as:
 [%bibitem]
 ...
 contributor.person.contact::
-contributor.person.contact.street:: 8 Street St
-contributor.person.contact.city:: City
-contributor.person.contact.postcode:: 123456
-contributor.person.contact.country:: Country
-contributor.person.contact.state:: State
+contributor.person.contact.phone:: 223322
+contributor.person.contact.type:: mobile
 contributor.person.contact::
-contributor.person.contact.type:: phone
-contributor.person.contact.value:: 223322
+contributor.person.contact.phone:: 332233
+contributor.person.contact.type:: work
 ----
 
 The following is Metanorma AsciiDoc markup corresponding to the YAML
@@ -856,15 +907,13 @@ contributor.person.affiliation.organization.abbreviation:: IETF
 contributor.person.affiliation.organization.identifier.type:: uri
 contributor.person.affiliation.organization.identifier.id:: www.ietf.org
 contributor.person.affiliation.description:: Affiliation description
-contributor.person.contact::
-contributor.person.contact.street:: 8 Street St
-contributor.person.contact.city:: City
-contributor.person.contact.postcode:: 123456
-contributor.person.contact.country:: Country
-contributor.person.contact.state:: State
-contributor.person.contact::
-contributor.person.contact.type:: phone
-contributor.person.contact.value:: 223322
+contributor.person.address.street:: 8 Street St
+contributor.person.address.city:: City
+contributor.person.address.postcode:: 123456
+contributor.person.address.country:: Country
+contributor.person.address.state:: State
+contributor.person.contact.phone:: 223322
+contributor.person.contact.type:: mobile
 contributor.role:: author
 contributor::
 contributor.organization.name:: IETF