metanorma-nist 0.0.7 → 0.0.8

data/lib/asciidoctor/nist/front.rb

@@ -11,7 +11,16 @@ module Asciidoctor
     class Converter < Standoc::Converter
 
       def datetypes
-        super << "abandoned"
+        super + %w(abandoned superseded)
+      end
+
+      def metadata_version(node, xml)
+        xml.edition node.attr("edition") if node.attr("edition")
+        xml.revision node.attr("revision") if node.attr("revision")
+        xml.version do |v|
+          v.revision_date node.attr("revdate") if node.attr("revdate")
+          v.draft node.attr("draft") if node.attr("draft")
+        end
       end
 
       def title_subtitle(node, t, at)
@@ -19,6 +28,10 @@ module Asciidoctor
         t.title(**attr_code(at.merge(type: "subtitle"))) do |t1|
           t1 << asciidoc_sub(node.attr("title-sub"))
         end
+        node.attr("title-sub-short") and
+          t.title(**attr_code(at.merge(type: "short-subtitle"))) do |t1|
+          t1 << asciidoc_sub(node.attr("title-sub-short"))
+        end
       end
 
       def title_document_class(node, t, at)
@@ -32,6 +45,10 @@ module Asciidoctor
         t.title(**attr_code(at.merge(type: "main"))) do |t1|
           t1 << asciidoc_sub(node.attr("title-main") || node.title)
         end
+        node.attr("title-main-short") and
+          t.title(**attr_code(at.merge(type: "short-title"))) do |t1|
+          t1 << asciidoc_sub(node.attr("title-main-short"))
+        end
       end
 
       def title(node, xml)
@@ -63,22 +80,34 @@ module Asciidoctor
 
       def metadata_id_compose(node, xml, dn0)
         return unless dn0
-        dn = add_id_parts(dn0, node.attr("series"), node.attr("edition"), false)
-        dn_long = add_id_parts(dn0, node.attr("series"), node.attr("edition"),
-                               true)
-        xml.docidentifier dn, **attr_code(type: "nist")
-        xml.docidentifier dn_long, **attr_code(type: "nist-long")
+        s = node.attr("series")
+        e = node.attr("revision")
+        v = node.attr("volume")
+        xml.docidentifier add_id_parts(dn0, s, e, v, false),
+          **attr_code(type: "nist")
+        xml.docidentifier add_id_parts(dn0, s, e, v, true),
+          **attr_code(type: "nist-long")
+        xml.docidentifier add_id_parts_mr(dn0, s, e, v, node.attr("revdate")),
+          **attr_code(type: "nist-mr")
       end
 
-      def add_id_parts(dn, series, edition, long)
+      def add_id_parts(dn, series, revision, vol, long)
+        vol_delim = " Volume "
         ed_delim = " Revision "
         series and series_name = long ? SERIES.dig(series.to_sym) :
           SERIES_ABBR.dig(series.to_sym)
         dn = (series_name || "NIST #{series}")  + " " + dn
-        dn += "#{ed_delim}#{edition}" if edition
+        dn += "#{vol_delim}#{vol}" if vol
+        dn += "," if vol && revision
+        dn += "#{ed_delim}#{revision}" if revision
         dn
       end
 
+      def add_id_parts_mr(dn, series, revision, vol, revdate)
+        series and name = SERIES_ABBR.dig(series.to_sym).sub(/^NIST /, "")
+        "NIST.#{name}.#{vol}.#{revision}.#{revdate}"
+      end
+
       def metadata_author(node, xml)
         personal_author(node, xml)
       end
@@ -88,13 +117,18 @@ module Asciidoctor
           c.role **{ type: "publisher" }
           c.organization do |a|
             a.name "NIST"
+            d = node.attr("nist-division") and a.subdivision d
           end
         end
       end
 
       def metadata_committee(node, xml)
+        return unless node.attr("technical-committee") ||
+          node.attr("subcommittee") ||
+          node.attr("workgroup") || node.attr("workinggroup")
         xml.editorialgroup do |a|
-          a.committee(node.attr("technical-committee"))
+          node.attr("technical-committee") and
+            a.committee(node.attr("technical-committee"))
           node.attr("subcommittee") and
             a.subcommittee(node.attr("subcommittee"),
                            **attr_code(type: node.attr("subcommittee-type"),
@@ -110,6 +144,7 @@ module Asciidoctor
         status = node.attr("status") || "final"
         xml.status do |s|
           s.stage status 
+          s.substage (node.attr("substage") || "active")
           s.iteration node.attr("iteration") if node.attr("iteration") 
         end
       end
@@ -161,68 +196,94 @@ module Asciidoctor
         end
       end
 
+      def relaton_relations
+        super + %w(obsoletes obsoleted-by supersedes superseded-by)
+      end
+
       def metadata_getrelation(node, xml, type)
-        docs = node.attr(type) || return
-        docs.split(/,/).each do |d|
-          xml.relation **{ type: type.sub(/-by$/, "By") } do |r|
-            fetch_ref(r, d, nil, {})
+        if type == "obsoleted-by" and node.attr("superseding-status")
+          metadata_superseding_doc(node, xml)
+        else
+          super
+        end
+      end
+
+      def metadata_superseding_doc(node, xml)
+        xml.relation **{ type: "obsoletedBy" } do |r|
+          r.bibitem do |b|
+            metadata_superseding_titles(b, node)
+            doi = node.attr("superseding-doi") and
+              b.uri doi, **{ type: "doi" }
+            url = node.attr("superseding-url") and
+              b.uri url, **{ type: "uri" }
+            did = xml&.parent&.at("./ancestor::bibdata/docidentifier"\
+                                  "[@type = 'nist']")&.text
+            didl = xml&.parent&.at("./ancestor::bibdata/docidentifier"\
+                                   "[@type = 'nist-long']")&.text
+            b.docidentifier did, **{ type: "nist" }
+            b.docidentifier didl, **{ type: "nist-long" }
+            metadata_superseding_authors(b, node)
+            metadata_superseding_dates(b, node)
+            b.status do |s|
+              s.stage node.attr("superseding-status")
+              iter = node.attr("superseding-iteration") and
+                s.iteration iter
+            end
           end
         end
       end
 
-      SERIES = {
-        "nist-ams": "NIST Advanced Manufacturing Series",
-        "building-science": "NIST Building Science Series",
-        "nist-fips": "NIST Federal Information Processing Standards",
-        "nist-gcr": "NIST Grant/Contract Reports",
-        "nist-hb": "NIST Handbook",
-        "itl-bulletin": "ITL Bulletin",
-        "jpcrd": "Journal of Physical and Chemical Reference Data",
-        "nist-jres": "NIST Journal of Research",
-        "letter-circular": "NIST Letter Circular",
-        "nist-monograph": "NIST Monograph",
-        "nist-ncstar": "NIST National Construction Safety Team Act Reports",
-        "nist-nsrds": "NIST National Standard Reference Data Series",
-        "nistir": "NIST Interagency/Internal Report",
-        "product-standards": "NIST Product Standards",
-        "nist-sp": "NIST Special Publication",
-        "nist-tn": "NIST Technical Note",
-        "other": "NIST Other",
-        "csrc-white-paper": "CSRC White Paper",
-        "csrc-book": "CSRC Book",
-        "csrc-use-case": "CSRC Use Case",
-        "csrc-building-block": "CSRC Building Block",
-      }.freeze
-
-      SERIES_ABBR = {
-        "nist-ams": "NIST AMS",
-        "building-science": "NIST Building Science Series",
-        "nist-fips": "NIST FIPS",
-        "nist-gcr": "NISTGCR",
-        "nist-hb": "NIST HB",
-        "itl-bulletin": "ITL Bulletin",
-        "jpcrd": "JPCRD",
-        "nist-jres": "NIST JRES",
-        "letter-circular": "NIST Letter Circular",
-        "nist-monograph": "NIST MN",
-        "nist-ncstar": "NIST NCSTAR",
-        "nist-nsrds": "NIST NSRDS",
-        "nistir": "NISTIR",
-        "product-standards": "NIST Product Standards",
-        "nist-sp": "NIST SP",
-        "nist-tn": "NIST TN",
-        "other": "NIST Other",
-        "csrc-white-paper": "CSRC White Paper",
-        "csrc-book": "CSRC Book",
-        "csrc-use-case": "CSRC Use Case",
-        "csrc-building-block": "CSRC Building Block",
-      }.freeze
+      def metadata_superseding_dates(b, node)
+        cdate = node.attr("superseding-circulated-date") and
+          b.date **{ type: "circulated" } do |d|
+          d.on cdate
+        end
+        cdate = node.attr("superseding-published-date") and
+          b.date **{ type: "published" } do |d|
+          d.on cdate
+        end
+      end
+
+      def metadata_superseding_titles(b, node)
+        if node.attr("superseding-title")
+          b.title asciidoc_sub(node.attr("superseding-title")),
+            **{ type: "main" }
+          node.attr("superseding-subtitle") and
+            b.title asciidoc_sub(node.attr("superseding-subtitle")),
+            **{ type: "subtitle" }
+        else
+          b.title asciidoc_sub(node.attr("title-main") || node.title),
+            **{ type: "main" }
+          node.attr("title-sub") and
+            b.title asciidoc_sub(node.attr("title-sub")), **{ type: "subtitle" }
+        end
+      end
+
+      def metadata_superseding_authors(b, node)
+        node.attr("superseding-authors") and
+          node.attr("superseding-authors").split(/,\s*/).each do |a|
+          b.contributor do |c|
+            c.role nil, **{ type: "author" }
+            c.person do |p|
+              p.name do |f|
+                f.completename a
+              end
+            end
+          end
+        end
+      end
+
+      def metadata_note(node, xml)
+        note = node.attr("bib-additional-note") and
+          xml.note note, **{ type: "additional-note" }
+        note = node.attr("bib-withdrawal-note") and
+          xml.note note, **{ type: "withdrawal-note" }
+        note = node.attr("bib-withdrawal-announcement-link") and
+          xml.note note, **{ type: "withdrawal-announcement-link" }
+      end
 
       def metadata(node, xml)
         super
-        %w(obsoletes obsoleted-by supersedes superseded-by).each do |t|
-          metadata_getrelation(node, xml, t)
-        end
         metadata_series(node, xml)
         metadata_keywords(node, xml)
         metadata_commentperiod(node, xml)

data/lib/asciidoctor/nist/isodoc.rng

@@ -735,6 +735,20 @@
       <ref name="bookmark"/>
     </choice>
   </define>
+  <define name="PureTextElement">
+    <choice>
+      <text/>
+      <ref name="em"/>
+      <ref name="strong"/>
+      <ref name="sub"/>
+      <ref name="sup"/>
+      <ref name="tt"/>
+      <ref name="keyword"/>
+      <ref name="strike"/>
+      <ref name="smallcap"/>
+      <ref name="br"/>
+    </choice>
+  </define>
   <define name="source">
     <element name="source">
       <ref name="TypedUri"/>
@@ -742,42 +756,58 @@
   </define>
   <define name="em">
     <element name="em">
-      <text/>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="strong">
     <element name="strong">
-      <text/>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="tt">
     <element name="tt">
-      <text/>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="keyword">
     <element name="keyword">
-      <text/>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="sub">
     <element name="sub">
-      <text/>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="sup">
     <element name="sup">
-      <text/>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="strike">
     <element name="strike">
-      <text/>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="smallcap">
     <element name="smallcap">
-      <text/>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="br">

data/lib/asciidoctor/nist/isostandard.rng

@@ -4,14 +4,6 @@
     <start>
       <ref name="iso-standard"/>
     </start>
-    <define name="language">
-      <element name="language">
-        <choice>
-          <value>en</value>
-          <value>fr</value>
-        </choice>
-      </element>
-    </define>
     <define name="script">
       <element name="script">
         <value>Latn</value>

data/lib/asciidoctor/nist/nist.rng

@@ -9,9 +9,9 @@
     <start>
       <ref name="nist-standard"/>
     </start>
-    <define name="language">
-      <element name="language">
-        <value>en</value>
+    <define name="btitle">
+      <element name="title">
+        <ref name="TypedTitleString"/>
       </element>
     </define>
     <define name="docidentifier">
@@ -65,6 +65,9 @@
     <define name="status">
       <element name="status">
         <ref name="stage"/>
+        <optional>
+          <ref name="substage"/>
+        </optional>
         <optional>
           <ref name="iteration"/>
         </optional>
@@ -73,18 +76,60 @@
     <define name="BibItemType" combine="choice">
       <value>standard</value>
     </define>
-    <define name="DocRelationType" combine="choice">
+    <!-- DocRelationType |= "obsoletedBy" | "supersedes" | "supersededBy" -->
+    <define name="DocRelationType">
       <choice>
+        <value>obsoletes</value>
+        <value>updates</value>
+        <value>updatedBy</value>
+        <value>complements</value>
+        <value>derivedFrom</value>
+        <value>translatedFrom</value>
+        <value>adoptedFrom</value>
+        <value>equivalent</value>
+        <value>identical</value>
+        <value>nonequivalent</value>
+        <value>includedIn</value>
+        <value>includes</value>
+        <value>instance</value>
+        <value>partOf</value>
+        <value>hasDraft</value>
         <value>obsoletedBy</value>
         <value>supersedes</value>
         <value>supersededBy</value>
       </choice>
     </define>
-    <define name="BibliographicDateType" combine="choice">
-      <value>abandoned</value>
+    <!-- BibliographicDateType |= "abandoned" | "superseded" -->
+    <define name="BibliographicDateType">
+      <choice>
+        <value>published</value>
+        <value>accessed</value>
+        <value>created</value>
+        <value>implemented</value>
+        <value>obsoleted</value>
+        <value>confirmed</value>
+        <value>updated</value>
+        <value>issued</value>
+        <value>transmitted</value>
+        <value>copied</value>
+        <value>unchanged</value>
+        <value>circulated</value>
+        <value>abandoned</value>
+        <value>superseded</value>
+      </choice>
     </define>
-    <define name="TitleType" combine="choice">
-      <value>document-class</value>
+    <!-- TitleType |= "document-class" -->
+    <define name="TitleType">
+      <choice>
+        <value>alternative</value>
+        <value>original</value>
+        <value>unofficial</value>
+        <value>subtitle</value>
+        <value>main</value>
+        <value>document-class</value>
+        <value>short-title</value>
+        <value>short-subtitle</value>
+      </choice>
     </define>
     <define name="editorialgroup">
       <element name="editorialgroup">
@@ -100,11 +145,17 @@
           <value>draft-wip</value>
           <value>draft-prelim</value>
           <value>draft-public</value>
-          <value>draft-retire</value>
-          <value>draft-withdrawn</value>
           <value>final</value>
           <value>final-review</value>
-          <value>final-withdrawn</value>
+        </choice>
+      </element>
+    </define>
+    <define name="substage">
+      <element name="substage">
+        <choice>
+          <value>active</value>
+          <value>retired</value>
+          <value>withdrawn</value>
         </choice>
       </element>
     </define>
@@ -138,6 +189,47 @@
         </optional>
       </element>
     </define>
+    <define name="annex">
+      <element name="annex">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="inline-header">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="obligation">
+            <choice>
+              <value>normative</value>
+              <value>informative</value>
+            </choice>
+          </attribute>
+        </optional>
+        <optional>
+          <ref name="section-title"/>
+        </optional>
+        <zeroOrMore>
+          <!--
+            allow hanging paragraps in annexes: they introduce lists
+            ( paragraph-with-footnote | table | note | formula | admonition | ol | ul | dl | figure | quote | sourcecode | review | example )*,
+          -->
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+        <choice>
+          <zeroOrMore>
+            <ref name="clause-hanging-paragraph-with-footnote"/>
+          </zeroOrMore>
+          <ref name="terms"/>
+        </choice>
+      </element>
+    </define>
     <define name="BibData">
       <optional>
         <attribute name="type">
@@ -168,6 +260,9 @@
       <optional>
         <ref name="edition"/>
       </optional>
+      <optional>
+        <ref name="revision"/>
+      </optional>
       <optional>
         <ref name="version"/>
       </optional>
@@ -196,7 +291,9 @@
       <optional>
         <ref name="nistsubseries"/>
       </optional>
-      <ref name="editorialgroup"/>
+      <optional>
+        <ref name="editorialgroup"/>
+      </optional>
       <zeroOrMore>
         <ref name="ics"/>
       </zeroOrMore>
@@ -228,7 +325,11 @@
   <define name="nistdocidentifier">
     <element name="docidentifier">
       <attribute name="type">
-        <value>nist</value>
+        <choice>
+          <value>nist</value>
+          <value>nist-long</value>
+          <value>nist-mr</value>
+        </choice>
       </attribute>
       <text/>
     </element>
@@ -260,27 +361,27 @@
   <define name="nistseriestitle">
     <element name="title">
       <choice>
-        <value>nist-ams</value>
-        <value>building-science</value>
-        <value>nist-fips</value>
-        <value>nist-gcr</value>
-        <value>nist-hb</value>
-        <value>itl-bulletin</value>
-        <value>jpcrd</value>
-        <value>nist-jres</value>
-        <value>letter-circular</value>
-        <value>nist-monograph</value>
-        <value>nist-ncstar</value>
-        <value>nist-nsrds</value>
-        <value>nistir</value>
-        <value>product-stadnards</value>
-        <value>nist-sp</value>
-        <value>nist-tn</value>
-        <value>other</value>
-        <value>csrc-white-paper</value>
-        <value>csrc-book</value>
-        <value>csrc-use-case</value>
-        <value>csrc-building-block</value>
+        <value>NIST Advanced Manufacturing Series</value>
+        <value>NIST Building Science Series</value>
+        <value>NIST Federal Information Processing Standards</value>
+        <value>NIST Grant/Contract Reports</value>
+        <value>NIST Handbook</value>
+        <value>ITL Bulletin</value>
+        <value>Journal of Physical and Chemical Reference Data</value>
+        <value>NIST Journal of Research</value>
+        <value>NIST Letter Circular</value>
+        <value>NIST Monograph</value>
+        <value>NIST National Construction Safety Team Act Reports</value>
+        <value>NIST National Standard Reference Data Series</value>
+        <value>NIST Interagency/Internal Report</value>
+        <value>NIST Product Standards</value>
+        <value>NIST Special Publication</value>
+        <value>NIST Technical Note</value>
+        <value>NIST Other</value>
+        <value>CSRC White Paper</value>
+        <value>CSRC Book</value>
+        <value>CSRC Use Case</value>
+        <value>CSRC Building Block</value>
       </choice>
     </element>
   </define>
@@ -321,6 +422,11 @@
   </define>
   <define name="authority">
     <element name="authority">
+      <optional>
+        <element name="title">
+          <text/>
+        </element>
+      </optional>
       <element name="authority1">
         <ref name="Basic-Section"/>
       </element>
@@ -340,6 +446,11 @@
       </element>
     </element>
   </define>
+  <define name="revision">
+    <element name="revision">
+      <text/>
+    </element>
+  </define>
   <define name="nist-standard">
     <element name="nist-standard">
       <ref name="bibdata"/>