metanorma-nist 1.2.0 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0def1e8573338383bf4e456fc4fc092a232c08ef46b676facc570908ad9fd9aa
-  data.tar.gz: 820cf042c13235a0519ee6818573d9fb445bb6e0d368265a7e72753ea7e40c94
+  metadata.gz: 6a69082cb58bde5a1305caea0316414723f519a71c550efe43ac3e894f028436
+  data.tar.gz: 73b99485a31a90a15e6936d688fc4c677a2d948e95bc1896d822d7b02cda37f6
 SHA512:
-  metadata.gz: 0c5a2abc6a91c220a19917f5b314a18fa06067263c391fbe4d97897d16461b11af49c61feaf8a737264c355627aa42a202981a1b8c40ed7fb37bb8c39791b2e0
-  data.tar.gz: 0fc41aabba065a26cef8e432bf32b2c5c2927e9a3826cf89c578905e9154b51085ca447463e8feddff9ed7f21ae32ed5f79b65981dee54921f86d976c0b4b40d
+  metadata.gz: 59de2efb8bb15621e6479ba749b94228d0c61b0b244da02a6c95dc63668797c890090c49abe386a913ef096664b771a42e99b53d39ed698d4d30e45b2e324393
+  data.tar.gz: 108786af3a06da4539acb195f2d42c21b66fb0d7b05543ed800202c117a98531c1cd83ec1f31f3a8249ef7429458407c7d7991fc41052cb3c522ed47762d9afd

data/README.adoc

@@ -659,6 +659,20 @@ Errata tables must have a header row containing the headings _Date, Type, Change
 |===
 ----
 
+=== Lists
+
+If an ordered list is intended to describe “steps” within a process, it should start with Arabic numbers and should be encoded with the class `steps`:
+
+Encoding an ordered list as steps:
+
+[source, asciidoctor]
+----
+[class=steps]
+. First Step
+. Second Step
+. Third Step
+----
+
 === Glosaries
 
 Glossaries are given as definition lists with role attribute `[.glossary]`:

data/lib/asciidoctor/nist/basicdoc.rng

@@ -402,6 +402,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -429,6 +439,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -998,6 +1018,9 @@
           <value>alphabet_upper</value>
         </choice>
       </attribute>
+      <optional>
+        <attribute name="start"/>
+      </optional>
       <oneOrMore>
         <ref name="li"/>
       </oneOrMore>

data/lib/asciidoctor/nist/converter.rb

@@ -61,6 +61,15 @@ module Asciidoctor
         super
       end
 
+      def olist(node)
+        id = Asciidoctor::Standoc::Utils::anchor_or_uuid(node)
+        noko do |xml|
+          xml.ol **attr_code(id: id, class: node.attr("class")) do |xml_ol|
+            node.items.each { |item| li(xml_ol, item) }
+          end
+        end.join("\n")
+      end
+
       def glossary(node)
         noko do |xml|
           xml.dl **{id: Asciidoctor::Standoc::Utils::anchor_or_uuid(node),
@@ -79,8 +88,8 @@ module Asciidoctor
       end
 
       def doctype(node)
-        d = node.attr("doctype")
-        d = "standard" if d == "article" # article is Asciidoctor default
+        d = super || "standard"
+        d =  "standard" if d == "article" # article is Asciidoctor default
         d
       end
 
@@ -140,6 +149,8 @@ module Asciidoctor
         case ret
         when "glossary", "terminology"
           "terms and definitions"
+        when "introduction"
+          "donotrecognise_introduction"
         else
           super
         end

data/lib/asciidoctor/nist/front.rb

@@ -5,14 +5,7 @@ require_relative "./front_id.rb"
 
 module Asciidoctor
   module NIST
-    # A {Converter} implementation that generates RSD output, and a document
-    # schema encapsulation of the document for validation
-
     class Converter < Standoc::Converter
-      def doctype(node)
-        node.attr("doctype") || "sp-800"
-      end
-
       def datetypes
         super + %w(abandoned superseded)
       end
@@ -72,13 +65,21 @@ module Asciidoctor
         personal_author(node, xml)
       end
 
+      def default_publisher
+        "National Institute of Standards and Technology"
+      end
+
       def metadata_publisher(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "publisher" }
-          c.organization do |a|
-            a.name "National Institute of Standards and Technology"
-            a.abbreviation "NIST"
-            d = node.attr("nist-division") and a.subdivision d
+        publishers = node.attr("publisher") || default_publisher
+        csv_split(publishers)&.each do |p|
+          xml.contributor do |c|
+            c.role **{ type: "publisher" }
+            c.organization do |a|
+              a.name p
+              if p == default_publisher
+                d = node.attr("nist-division") and a.subdivision d
+              end
+            end
           end
         end
       end
@@ -111,20 +112,6 @@ module Asciidoctor
         end
       end
 
-      def metadata_copyright(node, xml)
-        from = node.attr("copyright-year") || node.attr("copyrightyear") ||
-          Date.today.year
-        xml.copyright do |c|
-          c.from from
-          c.owner do |owner|
-            owner.organization do |o|
-              o.name "National Institute of Standards and Technology"
-              o.abbreviation "NIST"
-            end
-          end
-        end
-      end
-
       def metadata_source(node, xml)
         super
         node.attr("doc-email") && xml.uri(node.attr("doc-email"), type: "email")
@@ -157,7 +144,7 @@ module Asciidoctor
 
       def relaton_relation_descriptions
         super.merge({ "supersedes" => "obsoletes",
-          "superseded-by" => "obsoleted-by", })
+                      "superseded-by" => "obsoleted-by", })
       end
 
       def metadata_getrelation(node, xml, type, desc = nil)

data/lib/asciidoctor/nist/isodoc.rng

@@ -43,7 +43,9 @@
     <define name="xref">
       <element name="xref">
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -61,6 +63,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -578,6 +585,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +670,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -697,6 +716,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -834,6 +863,13 @@
   </define>
   <define name="standard-document">
     <element name="standard-document">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <optional>
         <ref name="boilerplate"/>
@@ -855,7 +891,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -1049,14 +1085,17 @@
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1453,11 +1492,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>
@@ -1507,4 +1541,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>

data/lib/asciidoctor/nist/nist.rng

@@ -9,6 +9,24 @@
     <start>
       <ref name="nist-standard"/>
     </start>
+    <define name="ol">
+      <element name="ol">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="class">
+            <value>steps</value>
+          </attribute>
+        </optional>
+        <oneOrMore>
+          <ref name="li"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="DocumentType">
       <value>standard</value>
     </define>
@@ -16,7 +34,7 @@
     <define name="preface">
       <element name="preface">
         <optional>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
         </optional>
         <optional>
           <ref name="foreword"/>
@@ -164,6 +182,13 @@
   </define>
   <define name="nist-standard">
     <element name="nist-standard">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <zeroOrMore>
         <ref name="termdocsource"/>

data/lib/isodoc/nist/base_convert.rb

@@ -6,18 +6,6 @@ require "fileutils"
 module IsoDoc
   module NIST
     module BaseConvert
-      def keywords(docxml, out)
-        f = docxml.at(ns("//preface/clause[@type = 'keywords']")) || return
-        intro_clause(f, out)
-      end
-
-      def skip_render(c, isoxml)
-        return false unless c.name == "reviewernote"
-        status = isoxml&.at(ns("//bibdata/status/stage"))&.text
-        return true if status.nil?
-        /^final/.match status
-      end
-
       def requirement_cleanup(docxml)
         docxml.xpath("//div[@class = 'recommend' or @class = 'require' "\
                      "or @class = 'permission']").each do |d|
@@ -33,6 +21,7 @@ module IsoDoc
 
       def dl_parse(node, out)
         return glossary_parse(node, out) if node["type"] == "glossary"
+        return glossary_parse(node, out) if node.parent.name == "definitions"
         super
       end
 
@@ -63,9 +52,20 @@ module IsoDoc
       end
 
       def boilerplate(node, out)
-        super
-        page_break(out)
+      boilerplate = node.at(ns("//boilerplate")) or return
+      out.div **{class: "authority"} do |s|
+        boilerplate.children.each do |n|
+          if n.name == "title"
+            s.h1 do |h|
+              n.children.each { |nn| parse(nn, h) }
+            end
+          else
+            parse(n, s)
+          end
+        end
+        page_break(s)
       end
+    end
 
       def children_parse(node, out)
         node.children.each do |n|
@@ -127,7 +127,6 @@ module IsoDoc
       def info(isoxml, out)
         @meta.series isoxml, out
         @meta.commentperiod isoxml, out
-        @meta.note isoxml, out
         super
       end
 
@@ -180,6 +179,18 @@ module IsoDoc
           out << " &mdash; "
         node.at(ns("./p")).children.each { |n| parse(n, out) }
       end
+
+      def ol_depth(node)
+        return super unless node["class"] == "steps" or
+          node.at(".//ancestor::xmlns:ol[@class = 'steps']")
+        depth = node.ancestors("ul, ol").size + 1
+        type = :arabic
+        type = :alphabet if [2, 7].include? depth
+        type = :roman if [3, 8].include? depth
+        type = :alphabet_upper if [4, 9].include? depth
+        type = :roman_upper if [5, 10].include? depth
+        ol_style(type)
+      end
     end
   end
 end