metanorma-nist 1.1.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f29234e459eb059f01e81e23fbaad3f788a1645d7e7c407f9496a9c7587dff7
-  data.tar.gz: c9ffc00ad8eccde516c2cc427d7c25f77ca923c19c197cae90b73e3c6dbbb972
+  metadata.gz: bf785a903733a43d512bf78b6a9ed63b1366d3608e64cdb7a107b0af44c83d3f
+  data.tar.gz: edbff6b8f91a32ea9c2866c35d50ce17802626d5c1edc26f73f3429195c9b497
 SHA512:
-  metadata.gz: 5066e5bd7efa1d87613770a63ac69ee358f66571480a81913bf8c3b846febffdf6b6d27bc724dfe4ae5ec5ca0797a4b3096eaf80ade75afa9eed7392389faa04
-  data.tar.gz: e62e662cc55d6c0c113fc8c91e7765d524c0917e4424c51c5774692acee1426529b9334a94faf4750b247573f64b98ec14d22078e94b79f9f0cf381b5cab30f8
+  metadata.gz: b6cca2e46cd13198d8e21ee48231c7046e0578c2eda603857d015ecd3944302b785d433f9fbccb1d28f45bbc1857a3bd0d33d1167f4a252589a9a1b038ac45c3
+  data.tar.gz: 88f9452e81d23d1029dc6030b3a851d6a6332b09c2726a4dce3125974f570d7aa0bf63f6701e19f3e9ee1b7992242f9a43884ba02124228b13b092d86d923347

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

@@ -158,7 +158,17 @@
         <data type="ID"/>
       </attribute>
       <oneOrMore>
-        <ref name="paragraph"/>
+        <choice>
+          <ref name="formula"/>
+          <ref name="ul"/>
+          <ref name="ol"/>
+          <ref name="dl"/>
+          <ref name="quote"/>
+          <ref name="sourcecode"/>
+          <ref name="paragraph"/>
+          <ref name="table"/>
+          <ref name="figure"/>
+        </choice>
       </oneOrMore>
     </element>
   </define>
@@ -402,6 +412,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 +449,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"/>

data/lib/asciidoctor/nist/boilerplate.rb

@@ -94,8 +94,8 @@ module Asciidoctor
 
       def boilerplate_isodoc(xmldoc)
         conv = super
-        conv.labels = conv.labels.merge({nist_division: @nistdivision,
-                       nist_division_address: @nistdivisionaddress})
+        conv.i18n.set(:nist_division, @nistdivision)
+        conv.i18n.set(:nist_division_address, @nistdivisionaddress)
         conv
       end
 

data/lib/asciidoctor/nist/cleanup.rb

@@ -3,9 +3,15 @@ module Asciidoctor
     class Converter < Standoc::Converter
       def cleanup(xmldoc)
         sourcecode_cleanup(xmldoc)
+        annex_rename(xmldoc)
         super
       end
 
+      def annex_rename(xmldoc)
+        return unless xmldoc.xpath("//references").size == 1
+        replace_title(xmldoc, "//annex[references]", @i18n&.normref, true)
+      end
+
       def sourcecode_cleanup(xmldoc)
         xmldoc.xpath("//sourcecode").each do |x|
           x.traverse do |n|
@@ -37,7 +43,7 @@ module Asciidoctor
         move_execsummary_into_preface(x, preface)
       end
 
-       def move_clauses_into_preface1(x, preface)
+      def move_clauses_into_preface1(x, preface)
         x.xpath("//clause[@preface]").each do |c|
           c.delete("preface")
           title = c&.at("./title")&.text.downcase
@@ -45,9 +51,9 @@ module Asciidoctor
           c.name = "executivesummary" if title == "executive summary"
           preface.add_child c.remove
         end
-       end
+      end
 
-       def move_execsummary_into_preface(x, preface)
+      def move_execsummary_into_preface(x, preface)
         x.xpath("//clause[@executivesummary]").each do |c|
           c.delete("executivesummary")
           title = c&.at("./title")&.text.downcase
@@ -150,7 +156,7 @@ module Asciidoctor
         elsif metaid = bib&.at("./docidentifier[@type = 'NIST']")&.text
           key = metaid.sub(/-(\d+)/) {|m| sprintf "-%09d", ($1.to_i) }
         elsif metaid = bib&.at("./docidentifier[not(@type = 'DOI' or "\
-                           "@type = 'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")&.text
+                               "@type = 'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")&.text
           key = metaid.sub(/-(\d+)/) {|m| sprintf "-%09d", ($1.to_i) }
         else # no usable docid
           key = "000000000" + bib["id"]
@@ -171,6 +177,30 @@ module Asciidoctor
         end
         acc
       end
+
+      def section_names_refs_cleanup(x)
+        replace_title(x, "//bibliography//references[@normative = 'true']",
+                      @i18n&.normref, true)
+        replace_title(x, "//bibliography//references[@normative = 'false']",
+                      @i18n&.bibliography, true)
+      end
+
+      def section_names_terms_cleanup(x)
+        replace_title(x, "//definitions[@type = 'symbols']", @i18n&.symbols)
+        replace_title(x, "//definitions[@type = 'abbreviated_terms']", @i18n&.abbrev)
+        replace_title(x, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
+        replace_title(x, "//sections//terms#{SYMnoABBR} | //sections//clause[.//terms]#{SYMnoABBR}",
+                      @i18n&.termsdefsymbols, true)
+        replace_title(x, "//sections//terms#{ABBRnoSYM} | //sections//clause[.//terms]#{ABBRnoSYM}",
+                      @i18n&.termsdefabbrev, true)
+        replace_title(x, "//sections//terms#{SYMABBR} | //sections//clause[.//terms]#{SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(x, "//sections//terms#{NO_SYMABBR} | //sections//clause[.//terms]#{NO_SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(
+          x, "//sections//terms[not(.//definitions)] | //sections//clause[.//terms][not(.//definitions)]",
+          @i18n&.termsdef, true)
+      end
     end
   end
 end

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
 
@@ -100,9 +109,12 @@ module Asciidoctor
       def outputs(node, ret)
         File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
           presentation_xml_converter(node).convert(@filename + ".xml")
-          html_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.html")
-          doc_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.doc")
-          pdf_converter(node)&.convert(@filename + ".presentation.xml", nil, false, "#{@filename}.pdf")
+          html_converter(node).convert(@filename + ".presentation.xml", 
+                                       nil, false, "#{@filename}.html")
+          doc_converter(node).convert(@filename + ".presentation.xml", 
+                                      nil, false, "#{@filename}.doc")
+          pdf_converter(node)&.convert(@filename + ".presentation.xml", 
+                                       nil, false, "#{@filename}.pdf")
       end
 
       def clause_parse(attrs, xml, node)
@@ -137,6 +149,8 @@ module Asciidoctor
         case ret
         when "glossary", "terminology"
           "terms and definitions"
+        when "introduction"
+          "donotrecognise_introduction"
         else
           super
         end
@@ -159,7 +173,7 @@ module Asciidoctor
       def bibliography_annex_parse(attrs, xml, node)
         attrs1 = attrs.merge(id: "_" + UUIDTools::UUID.random_create)
         xml.annex **attr_code(attrs1) do |xml_section|
-          xml_section.title { |t| t << "Bibliography" }
+          xml_section.title { |t| t << node.title }
           @biblio = true
           xml.references **attr_code(attrs.merge(normative: true)) do |r|
             r << node.content

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
@@ -27,31 +20,35 @@ module Asciidoctor
         end
       end
 
+      def asciidoc_sub(text)
+        Asciidoctor::Standoc::Utils::asciidoc_sub(text)
+      end
+
       def title_subtitle(node, t, at)
         return unless node.attr("title-sub")
         t.title(**attr_code(at.merge(type: "subtitle"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-sub"))
+          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 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-sub-short"))
+          t1 << asciidoc_sub(node.attr("title-sub-short"))
         end
       end
 
       def title_document_class(node, t, at)
         return unless node.attr("title-document-class")
         t.title(**attr_code(at.merge(type: "document-class"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-document-class"))
+          t1 << asciidoc_sub(node.attr("title-document-class"))
         end
       end
 
       def title_main(node, t, at)
         t.title(**attr_code(at.merge(type: "main"))) do |t1|
-          t1 << (Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-main")) || node.title)
+          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 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-main-short"))
+          t1 << asciidoc_sub(node.attr("title-main-short"))
         end
       end
 
@@ -68,12 +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 "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
@@ -86,9 +92,10 @@ module Asciidoctor
           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"),
-                                       number: node.attr("subcommittee-number")))
+            a.subcommittee(
+              node.attr("subcommittee"),
+              **attr_code(type: node.attr("subcommittee-type"),
+                          number: node.attr("subcommittee-number")))
           (node.attr("workgroup") || node.attr("workinggroup")) and
             a.workgroup(node.attr("workgroup") || node.attr("workinggroup"),
                         **attr_code(type: node.attr("workgroup-type"),
@@ -105,19 +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 "NIST"
-            end
-          end
-        end
-      end
-
       def metadata_source(node, xml)
         super
         node.attr("doc-email") && xml.uri(node.attr("doc-email"), type: "email")
@@ -149,14 +143,13 @@ module Asciidoctor
       end
 
       def relaton_relation_descriptions
-        super.merge({
-          "supersedes" => "obsoletes",
-          "superseded-by" => "obsoleted-by",
-        })
+        super.merge({ "supersedes" => "obsoletes",
+                      "superseded-by" => "obsoleted-by", })
       end
 
       def metadata_getrelation(node, xml, type, desc = nil)
-        if type == "obsoleted-by" and desc.nil? and node.attr("superseding-status")
+        if type == "obsoleted-by" and desc.nil? and 
+            node.attr("superseding-status")
           metadata_superseding_doc(node, xml)
         end
         super
@@ -166,10 +159,8 @@ module Asciidoctor
         xml.relation **{ type: "obsoletedBy" } do |r|
           r.bibitem **{ type: "standard" } 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" }
+            doi = node.attr("superseding-doi") and b.uri doi, **{ type: "doi" }
+            url = node.attr("superseding-url") and b.uri url, **{ type: "uri" }
             metadata_superseding_ids(b, xml)
             metadata_superseding_authors(b, node)
             metadata_superseding_dates(b, node)
@@ -205,19 +196,19 @@ module Asciidoctor
       def metadata_superseding_titles(b, node)
         if node.attr("superseding-title")
           b.title **{ type: "main" } do |t|
-            t << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("superseding-title"))
+            t << asciidoc_sub(node.attr("superseding-title"))
           end
           node.attr("superseding-subtitle") and
             b.title **{ type: "subtitle" } do |t|
-            t << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("superseding-subtitle"))
+            t << asciidoc_sub(node.attr("superseding-subtitle"))
           end
         else
           b.title **{ type: "main" } do |t|
-            t << (Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-main")) || node.title)
+            t << (asciidoc_sub(node.attr("title-main")) || node.title)
           end
           node.attr("title-sub") and
             b.title **{ type: "subtitle" } do |t|
-            t << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-sub"))
+            t << asciidoc_sub(node.attr("title-sub"))
           end
         end
       end

data/lib/asciidoctor/nist/front_id.rb

@@ -64,7 +64,7 @@ module Asciidoctor
       end
 
       def status_abbr(stage, iter)
-        IsoDoc::NIST::Metadata.new(nil, nil, {}).status_abbr(stage, iter)
+        IsoDoc::NIST::Metadata.new(nil, nil, @i18n).status_abbr(stage, iter)
       end
 
       def add_id_parts(args, long)

data/lib/asciidoctor/nist/isodoc.rng

@@ -42,8 +42,11 @@
     </define>
     <define name="xref">
       <element name="xref">
+        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -578,6 +581,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +666,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 +712,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>
@@ -922,6 +947,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +989,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1017,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1039,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1067,24 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <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"/>
@@ -1180,6 +1211,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1501,4 +1535,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>