metanorma-nist 0.0.4 → 0.0.5

data/lib/asciidoctor/nist/front.rb

@@ -10,13 +10,65 @@ module Asciidoctor
     #
     class Converter < Standoc::Converter
 
-      def metadata_author(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "author" }
-          c.organization do |a|
-            a.name "NIST"
+      def title_subtitle(node, t, at)
+        return unless node.attr("title-sub")
+        t.title_sub(**attr_code(at)) do |t1|
+          t1 << asciidoc_sub(node.attr("title-sub"))
+        end
+      end
+
+      def title_main(node, t, at)
+        t.title_main **attr_code(at) do |t1|
+          t1 << asciidoc_sub(node.attr("title-main") || node.title)
+        end
+      end
+
+      def title(node, xml)
+        ["en"].each do |lang|
+          xml.title do |t|
+            at = { language: lang, format: "text/plain" }
+            title_main(node, t, at)
+            title_subtitle(node, t, at)
           end
         end
+      end
+
+      def metadata_id(node, xml)
+        did = node.attr("docidentifier")
+        dn = node.attr("docnumber")
+        if did
+          xml.docidentifier did, **attr_code(type: "nist")
+          xml.docidentifier unabbreviate(did), **attr_code(type: "nist-long")
+        else
+          metadata_id_compose(node, xml, dn)
+        end
+        xml.docnumber node.attr("docnumber")
+      end
+
+      def unabbreviate(did)
+        SERIES_ABBR.each { |k, v| did = did.sub(/^#{v} /, "#{k} ") }
+        SERIES.each { |k, v| did = did.sub(/^#{k} /, "#{v} ") }
+        did
+      end
+
+      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")
+      end
+
+      def add_id_parts(dn, series, edition, long)
+        ed_delim = "-"
+        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
+      end
+
+      def metadata_author(node, xml)
         personal_author(node, xml)
       end
 
@@ -29,19 +81,6 @@ module Asciidoctor
         end
       end
 
-      def metadata_id(node, xml)
-        docstatus = node.attr("status")
-        dn = node.attr("docnumber")
-        if docstatus
-          abbr = IsoDoc::NIST::Metadata.new("en", "Latn", {}).
-            status_abbr(docstatus)
-          dn = "#{dn}(#{abbr})" unless abbr.empty?
-        end
-        dn and dn = "NIST " + dn
-        xml.docidentifier dn, **{type: "nist"}
-        xml.docnumber { |i| i << node.attr("docnumber") }
-      end
-
       def metadata_committee(node, xml)
         xml.editorialgroup do |a|
           a.committee(node.attr("technical-committee"))
@@ -57,8 +96,11 @@ module Asciidoctor
       end
 
       def metadata_status(node, xml)
-        status = node.attr("status") || "published"
-        xml.status(**{ format: "plain" }) { |s| s << status }
+        status = node.attr("status") || "final"
+        xml.status do |s|
+          s.stage status 
+          s.iteration node.attr("iteration") if node.attr("iteration") 
+        end
       end
 
       def metadata_copyright(node, xml)
@@ -84,28 +126,87 @@ module Asciidoctor
       def metadata_source(node, xml)
         super
         node.attr("doc-email") && xml.uri(node.attr("doc-email"), type: "email")
+        node.attr("doi") && xml.uri(node.attr("doi"), type: "doi")
       end
 
-      def title(node, xml)
-        super
-        subtitle(node, xml)
+      def metadata_series(node, xml)
+        series = node.attr("series")
+        subseries = node.attr("subseries")
+        series || subseries || return
+        series and xml.series **{ type: "main" } do |s|
+          s.title (SERIES.dig(series.to_sym) || series)
+          SERIES_ABBR.dig(series.to_sym) and s.abbreviation SERIES_ABBR.dig(series.to_sym)
+        end
+        subseries and xml.series **{ type: "secondary" } do |s|
+          s.title subseries.split(/-/).map{ |w| w.capitalize }.join(" ")
+        end
       end
 
-      def subtitle(node, xml)
-        return unless node.attr("subtitle")
-        ["en"].each do |lang|
-          at = { language: lang, format: "text/plain" }
-          xml.subtitle **attr_code(at) do |t|
-            t << asciidoc_sub(node.attr("subtitle"))
-          end
+      def metadata_commentperiod(node, xml)
+        from = node.attr("comment-from") or return
+        to = node.attr("comment-to")
+        extended = node.attr("comment-extended")
+        xml.commentperiod do |c|
+          c.from from
+          c.to to if to
+          c.extended extended if extended
         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(node, xml)
         super
+        metadata_series(node, xml)
         metadata_keywords(node, xml)
+        metadata_commentperiod(node, xml)
       end
-
     end
   end
 end

data/lib/asciidoctor/nist/isodoc.rng

@@ -18,6 +18,7 @@
   of this.
 -->
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <include href="reqt.rng"/>
   <include href="biblio.rng">
     <define name="status">
       <element name="status">

data/lib/asciidoctor/nist/nist.rng

@@ -22,11 +22,6 @@
         <text/>
       </element>
     </define>
-    <define name="btitle">
-      <element name="title">
-        <ref name="FormattedString"/>
-      </element>
-    </define>
     <define name="figure">
       <element name="figure">
         <attribute name="id">
@@ -69,16 +64,10 @@
     </define>
     <define name="status">
       <element name="status">
-        <choice>
-          <value>proposal</value>
-          <value>working-draft</value>
-          <value>committee-draft</value>
-          <value>draft-standard</value>
-          <value>final-draft</value>
-          <value>published</value>
-          <value>withdrawn</value>
-          <ref name="LocalizedString"/>
-        </choice>
+        <ref name="stage"/>
+        <optional>
+          <ref name="iteration"/>
+        </optional>
       </element>
     </define>
     <define name="BibItemType" combine="choice">
@@ -100,6 +89,40 @@
         </oneOrMore>
       </element>
     </define>
+    <define name="btitle">
+      <element name="title">
+        <choice>
+          <ref name="FormattedString"/>
+          <group>
+            <ref name="title-main"/>
+            <optional>
+              <ref name="title-sub"/>
+            </optional>
+          </group>
+        </choice>
+      </element>
+    </define>
+    <define name="stage">
+      <element name="stage">
+        <choice>
+          <value>internal-draft</value>
+          <value>public-draft</value>
+          <value>final</value>
+          <value>retired-draft</value>
+          <value>withdrawn</value>
+        </choice>
+      </element>
+    </define>
+    <define name="iteration">
+      <element name="iteration">
+        <text/>
+      </element>
+    </define>
+    <define name="title-main">
+      <element name="title-main">
+        <ref name="FormattedString"/>
+      </element>
+    </define>
     <define name="BibData">
       <optional>
         <attribute name="type">
@@ -116,7 +139,7 @@
         <ref name="bsource"/>
       </zeroOrMore>
       <zeroOrMore>
-        <ref name="docidentifier"/>
+        <ref name="nistdocidentifier"/>
       </zeroOrMore>
       <optional>
         <ref name="docnumber"/>
@@ -152,6 +175,12 @@
       <zeroOrMore>
         <ref name="docrelation"/>
       </zeroOrMore>
+      <optional>
+        <ref name="nistseries"/>
+      </optional>
+      <optional>
+        <ref name="nistsubseries"/>
+      </optional>
       <ref name="editorialgroup"/>
       <zeroOrMore>
         <ref name="ics"/>
@@ -159,6 +188,10 @@
       <optional>
         <ref name="security"/>
       </optional>
+      <oneOrMore>
+        <ref name="keyword"/>
+      </oneOrMore>
+      <ref name="commentperiod"/>
     </define>
   </include>
   <define name="committee">
@@ -172,11 +205,95 @@
       <text/>
     </element>
   </define>
+  <define name="title-sub">
+    <element name="title-sub">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="nistdocidentifier">
+    <element name="docidentifier">
+      <attribute name="type">
+        <value>nist</value>
+      </attribute>
+      <text/>
+    </element>
+  </define>
   <define name="security">
     <element name="security">
       <text/>
     </element>
   </define>
+  <define name="nistseries">
+    <element name="series">
+      <attribute name="type">
+        <value>main</value>
+      </attribute>
+      <ref name="nistseriestitle"/>
+      <optional>
+        <ref name="abbreviation"/>
+      </optional>
+    </element>
+  </define>
+  <define name="nistsubseries">
+    <element name="series">
+      <attribute name="type">
+        <value>secondary</value>
+      </attribute>
+      <ref name="nistsubseriestitle"/>
+    </element>
+  </define>
+  <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>
+      </choice>
+    </element>
+  </define>
+  <define name="nistsubseriestitle">
+    <element name="title">
+      <choice>
+        <value>computer-security</value>
+        <value>information-security</value>
+      </choice>
+    </element>
+  </define>
+  <define name="commentperiod">
+    <element name="commentperiod">
+      <element name="from">
+        <ref name="ISO8601Date"/>
+      </element>
+      <optional>
+        <element name="to">
+          <ref name="ISO8601Date"/>
+        </element>
+      </optional>
+      <optional>
+        <element name="extended">
+          <ref name="ISO8601Date"/>
+        </element>
+      </optional>
+    </element>
+  </define>
   <define name="nist-standard">
     <element name="nist-standard">
       <ref name="bibdata"/>

data/lib/asciidoctor/nist/reqt.rng

@@ -0,0 +1,157 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Presupposes isodoc.rnc, is included in it
+    include "isodoc.rnc" { }
+  -->
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="recommendation">
+    <element name="recommendation">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="permission">
+    <element name="permission">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="RequirementType">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <optional>
+      <ref name="subject"/>
+    </optional>
+    <optional>
+      <ref name="reqinherit"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+      </choice>
+    </zeroOrMore>
+    <optional>
+      <ref name="reqt_references"/>
+    </optional>
+    <zeroOrMore>
+      <choice>
+        <ref name="requirement"/>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="reqtitle">
+    <element name="title">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="label">
+    <element name="label">
+      <text/>
+    </element>
+  </define>
+  <define name="subject">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="measurementtarget">
+    <element name="measurement-target">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="specification">
+    <element name="specification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="verification">
+    <element name="verification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="import">
+    <element name="import">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="description">
+    <element name="description">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="reqt_references">
+    <element name="references">
+      <oneOrMore>
+        <ref name="bibitem"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="RequirementSubpart">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="exclude">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="ObligationType">
+    <choice>
+      <value>requirement</value>
+      <value>recommendation</value>
+      <value>permission</value>
+    </choice>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
+</grammar>