relaton-bib 0.3.3 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c666eff3590a39978b0d0e4547096284b8eedb28c9bb87d819491adc19ad3181
-  data.tar.gz: 9fe53d79fbca6cb27d0febfbb79981b8cee85ee1f4954db53664bc5f5769394d
+SHA1:
+  metadata.gz: cc017393109ff9a548ad8e9a95fec12ae434564e
+  data.tar.gz: 4dec785eebbd91e0b9e38db886099bf772c1806e
 SHA512:
-  metadata.gz: e70371f853c3ab10c91cffea4a96453f9929b5979d5947541d8bea21116e236c7eb063968e72ead587af2f0fbd9e3c9a7489e4d83e5c729cbd6571b5ce1f4a2e
-  data.tar.gz: 96dc61bc07a449c64877fd94e86e9228259c084e5ddef22e4540133b4adc95321caeff297dff3aef3847df5213ffc17d9c874555d7ab13929c6a5e7c7c28abf2
+  metadata.gz: 223b2d76ea441457e9f014ec6c4213ed910fdaba8e4c9ebec5aa8d14d296fb238f2392550fab2212173f5ef73a4b1827bc46aaf5e5637a058e89ea8f09ec9fdb
+  data.tar.gz: 96f84017b46c2d48c01dbde0359b5396137e7a066694d7e9cf9515b18657fb76511a84d66ebc5dae0a052bb20c8f97bffdd8b5d2584a56059587ed70793c8692

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    relaton-bib (0.3.3)
+    relaton-bib (0.3.8)
       addressable
-      nokogiri (~> 1.10)
+      nokogiri
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     byebug (11.0.1)
     debase (0.2.3)
       debase-ruby_core_source (>= 0.10.2)
@@ -22,7 +22,7 @@ GEM
     mini_portile2 (2.4.0)
     nokogiri (1.10.3)
       mini_portile2 (~> 2.4.0)
-    public_suffix (3.1.1)
+    public_suffix (4.0.1)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)

data/docs/hash.adoc

@@ -1,5 +1,7 @@
 = Relaton YAML
 
+== YAML
+
 The following structure is in place for encoding bibitem as YAML objects, and is also used 
 to represent bibliographic entries in Metanorma Asciidoctor. The structure has not yet been
 generalised to `bibdata/ext`, the flavour specific extensions of relaton.
@@ -252,11 +254,14 @@ validity:
   revision: 2011-03-04 09:00
 ....
 
+== Metanorma structure: nested definition list
+
 The Metanorma Asciidoctor representation of this hash structure
 in a bibliography
 is as a definition list, with nested definition lists for nested structures.
 Repeating elements in a hash can be realised as ordered or unordered lists.
-However, given how awkward lists of definition lists are in Asciidoctor,
+However, given how awkward lists of definition lists are in Asciidoctor
+(with a limitation of three nesting levels),
 Metanorma Asciidoctor also supports representing repeating elements 
 by repeating the key for that entry.
 
@@ -355,20 +360,20 @@ docid::
 docnumber:: 211
 edition:: 1
 language::
-  * en
-  * fr
+  . en
+  . fr
 script:: Latn
 version::
   revision_date::: 2019-04-01
   draft::: draft
 biblionote::
   type::: bibnote
-  content::: 
+  content:::
 +
----
+--
 Mark set a major league
 home run record in 1998.
----
+--
 docstatus::
   stage::: stage
   substage::: substage
@@ -384,11 +389,11 @@ date::
   type::: accessed
   value::: 2015-05-20
 abstract::
-  content::: 
+  content:::
 +
----
-      ISO 19115-1:2014 defines the schema required for ...
----
+--
+ISO 19115-1:2014 defines the schema required for ...
+--
 abstract::
   content::: L'ISO 19115-1:2014 définit le schéma requis pour ...
   language::: fr
@@ -419,8 +424,8 @@ extent::
   type::: section
   reference_from::: 7
 accesslocation::
-  * accesslocation1
-  * accesslocation2
+  . accesslocation1
+  . accesslocation2
 classification::
   type::: type
   value::: value
@@ -430,12 +435,12 @@ validity::
 
 
 ==== Contributor
-person::
+organization::
   name::: International Organization for Standardization
   url::: www.iso.org
   abbreviation::: ISO
   subdivision::: division
-role::
+role:: 
   type::: publisher
   description::: Publisher role
 
@@ -443,22 +448,25 @@ role::
 person::
   name:::
     completename::::
-      content::::: A. Bierman
-      language::::: en
++
+--
+content:: A. Bierman
+language:: en
+--
   affiliation:::
     organization::::
-      name::::: IETF
-      abbreviation::::: IETF
-      identifier:::::
 +
----
-type:: uri
-id:: www.ietf.org
----
+--
+name:: IETF
+abbreviation:: IETF
+identifier::
+type::: uri
+id::: www.ietf.org
+--
     description:::: Affiliation description
   contact:::
     street::::
-      * 8 Street St
+      . 8 Street St
     city:::: City
     postcode:::: 123456
     country:::: Country
@@ -469,7 +477,7 @@ id:: www.ietf.org
 role:: author
 
 ==== Contributor
-person::
+organization::
   name::: IETF
   abbreviation::: IETF
   identifier:::
@@ -484,13 +492,16 @@ person::
     initial:::: A.
     surname:::: Bierman
   affiliation:::
-    organization::::
-      name::::: IETF
-      abbreviation::::: IETF
-    description::::
-      content::::: Affiliation description
-      language::::: en
-      script::::: Latn
++
+--
+organization::
+  name::: IETF
+  abbreviation::: IETF
+description::
+  content::: Affiliation description
+  language::: en
+  script::: Latn
+--
   identifier:::
     type:::: uri
     id:::: www.person.com
@@ -506,8 +517,8 @@ bibitem::
     reference_to:::: 10
 
 ==== Relation
-type::: updates
-bibitem:::
+type:: updates
+bibitem::
   type::: standard
   formattedref::: ISO 19115:2003/Cor 1:2006
 
@@ -538,7 +549,260 @@ formattedref::
   script::: Latn
 ....
 
+== JSON Path style definition lists
+
+The foregoing structure requires frequent breakouts into open blocks, to deal
+with the limitation on Asciidoctor nested definition lists. An alternative is to
+represent the nested structure of Relaton records in a simple, one-level definition list, and to use the key for each key-value pair to represent the hierarchical nesting of entries, as a dot-delimited path of keys. For example,
+
+[source,asciidoctor]
+----
+[%bibitem]
+=== Rubber latex -- Sampling
+id:: iso123
+docid:: 
+  type::: ISO
+  id::: ISO 123
+----
+
+can instead be represented as:
+
+[source,asciidoctor]
+----
+[%bibitem]
+=== Rubber latex -- Sampling
+id:: iso123
+docid.type:: ISO
+docid.id::: ISO 123
+----
+
+Whenever part of the key is repeated between entries, the entries are assumed to attach to the same parent. If an array of hashes is needed, a blank entry is required for the key of each repeating element: For example,
+
+[source,asciidoctor]
+----
+[%bibitem]
+=== Rubber latex -- Sampling
+id:: iso123
+docid:: 
+  type::: ISO
+  id::: ISO 123
+docid::
+  type::: ABC
+  id::: 32784
+type:: standard
+----
+
+can instead be represented as:
+
+[source,asciidoctor]
+----
+[%bibitem]
+=== Rubber latex -- Sampling
+id:: iso123
+docid::
+docid.type:: ISO
+docid.id::: ISO 123
+docid::
+docid.type:: ABC
+docid.id:: 32784
+----
+
+Embedded elements can also repeat:
+
+[source,asciidoctor]
+----
+[%bibitem]
+...
+==== Contributor
+person::
+  contact:::
+    street::::
+      . 8 Street St
+    city:::: City
+    postcode:::: 123456
+    country:::: Country
+    state:::: State
+  contact:::
+    type:::: phone
+    value:::: 223322
+----
 
+can instead be represented as:
 
+[source,asciidoctor]
+----
+[%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::
+contributor.person.contact.type:: phone
+contributor.person.contact.value:: 223322
+----
 
+The following is Metanorma Asciidoctor markup corresponding to the YAML
+given above, using JSON Path style definition lists instead of nested definition lists:
 
+[source,asciidoc]
+....
+[[ISO/TC211]]
+[%bibitem]
+=== {blank}
+fetched:: 2019-06-30
+title::
+title.type:: main
+title.content:: Geographic information
+title::
+title.type:: subtitle
+title.content:: Geographic information subtitle
+title.language:: en
+title.script:: Latn
+title.format:: text/plain
+type:: standard
+docid::
+docid.type:: ISO
+docid.id:: TC211
+docnumber:: 211
+edition:: 1
+language:: en
+language:: fr
+script:: Latn
+version.revision_date:: 2019-04-01
+version.draft:: draft
+biblionote.type:: bibnote
+biblionote.content::
++
+--
+Mark set a major league
+home run record in 1998.
+--
+docstatus.stage:: stage
+docstatus.substage:: substage
+docstatus.iteration:: iteration
+date::
+date.type:: issued
+date.value:: 2014
+date::
+date.type:: published
+date.from:: 2014-04
+date.to:: 2014-05
+date::
+date.type:: accessed
+date.value:: 2015-05-20
+abstract::
+abstract.content::
++
+--
+ISO 19115-1:2014 defines the schema required for ...
+--
+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.from:: 2014
+copyright.to:: 2020
+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
+medium::
+medium.form:: medium form
+medium.size:: medium size
+medium.scale:: medium scale
+place:: bib place
+extent.type:: section
+extent.reference_from:: 7
+accesslocation:: accesslocation1
+accesslocation:: accesslocation2
+classification.type:: type
+classification.value:: value
+validity.begins:: 2010-10-10 12:21
+validity.ends:: 2011-02-03 18:30
+contributor::
+contributor.organization.name:: International Organization for Standardization
+contributor.organization.url:: www.iso.org
+contributor.organization.abbreviation:: ISO
+contributor.organization.subdivision:: division
+contributor.role.type:: publisher
+contributor.role.description:: Publisher role
+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.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.role:: author
+contributor::
+contributor.organization.name:: IETF
+contributor.organization.abbreviation:: IETF
+contributor.organization.identifier.type:: uri
+contributor.organization.identifier.id:: www.ietf.org
+contributor.role:: publisher
+contributor::
+contributor.person.name.language:: en
+contributor.person.name.initial:: A.
+contributor.person.name.surname:: Bierman
+contributor.person.affiliation.organization.name:: IETF
+contributor.person.affiliation.organization.abbreviation:: IETF
+contributor.person.affiliation.description.content:: Affiliation description
+contributor.person.affiliation.description.language:: en
+contributor.person.affiliation.description.script:: Latn
+contributor.person.identifier.type:: uri
+contributor.person.identifier.id:: www.person.com
+contributor.role:: author
+relation::
+relation.type:: updates
+relation.bibitem.formattedref:: ISO 19115:2003
+relation.bibitem.bib_locality.type:: page
+relation.bibitem.bib_locality.reference_from:: 7
+relation.bibitem.bib_locality.reference_to:: 10
+relation::
+relation.type:: updates
+relation.bibitem.type:: standard
+relation.bibitem.formattedref:: ISO 19115:2003/Cor 1:2006
+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.content:: ABVR
+series.abbreviation.language:: en
+series.abbreviation.script:: Latn
+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
+----