metanorma-nist 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2a45509c5a48e8cc1fe2bbe746de40897468aa8c2bcf89ee859d96818c31e8d
-  data.tar.gz: da5c38b20db3591806e7b8604890706147beb2be63a37376cf73776a9d6ac2cb
+  metadata.gz: 6120113a1a25fe7c901041b783738db95eec32d26fa63c3265a65e46a8da9352
+  data.tar.gz: 1b239f36b6030165b2c5558e1fc16f3fb5cd382639086fdad6d7137ee3df3bbd
 SHA512:
-  metadata.gz: 29dbbbb218046401e3c6e3ff0f3c6fec171fa32191cac8984f9a80d302857964fc6fa828a15ff39a9d2791a85ce68bb8b118ce3c5ae293b1c2ad101c397145c5
-  data.tar.gz: 41f297662d5c2b4ae9ddfc33988558b7b26291f7f78b2888afcb82912b4a879262141be42a45648a8328ac5a30a83f2a8802d2a2f203270908e8dcca4d10732a
+  metadata.gz: ca4c404c621a96f42795694bb73b993bb397d2ed2bbb37a995d5af1e153934eb6f1e9d1a094c5969294fdf1889d28070365a407d62d9d4ec84f56eedcbff5ac3
+  data.tar.gz: 30d92c0a8e10d5e1ad630f7894b844b9ff7a092a2eb567a034a176bafd91643f6f38aef9ed5f219a3d7953b705bb5f65d5902e7657a990d22c263d06981d00c8

data/README.adoc

@@ -223,6 +223,10 @@ Used to indicate the date of errata releases.
 The date at which a draft is circulated. Displayed on the cover page of drafts.
 MANDATORY FOR DRAFTS.
 
+`:language:`::
+Two-letter code (ISO 639-1) of the language the document is written in. Defaults to `en`.
+If multiple languages are used in the document, comma-delimited; e.g. `en,fr`.
+
 === NIST-specific attributes
 
 The following document attributes are specific to this document class:
@@ -239,11 +243,29 @@ Added to authority statement as document contact. Use line breaks (in Asciidocto
 `:revision:`:: The document revision; e.g. `1` (Revision 1). Will be stored in Metanorma XML
 under the `<edition>` tag, with the prefix `Revision `.
 
+`:version:`:: The document version, when titled as version. Will be stored in Metanorma XML
+under the `<edition>` tag, with the prefix `Version `.
+
 `:volume:`::
 The number of the volume of a standard. Is ignored if a precomposed
 document identifier (`:docidentifier:`) is supplied.
 Is prefixed with "Volume" or "Vol." in display.
 
+`:part:`::
+The part number of a standard. Is only used to generate machine readable NIST identifier (nist-mr).
+
+`:section:`::
+The section number of a standard. Is only used to generate machine readable NIST identifier (nist-mr).
+
+`:supplement:`::
+The supplement number of a standard. Is only used to generate machine readable NIST identifier (nist-mr).
+
+`:index:`::
+The index number of a standard. Is only used to generate machine readable NIST identifier (nist-mr).
+
+`:update:`::
+The update number of a standard. Is only used to generate machine readable NIST identifier (nist-mr).
+
 `:title-main:`:: The title of the document.
 `:title-sub:`:: The subtitle of the document.
 

data/lib/asciidoctor/nist/biblio.rng

@@ -661,9 +661,9 @@
     <optional>
       <ref name="status"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="copyright"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="docrelation"/>
     </zeroOrMore>
@@ -1021,7 +1021,17 @@
       <optional>
         <ref name="to"/>
       </optional>
-      <ref name="owner"/>
+      <oneOrMore>
+        <ref name="owner"/>
+      </oneOrMore>
+      <optional>
+        <ref name="copyright_scope"/>
+      </optional>
+    </element>
+  </define>
+  <define name="copyright_scope">
+    <element name="scope">
+      <text/>
     </element>
   </define>
   <define name="from">

data/lib/asciidoctor/nist/front.rb

@@ -20,6 +20,7 @@ module Asciidoctor
       def metadata_version(node, xml)
         xml.edition node.attr("edition") if node.attr("edition")
         xml.edition "Revision #{node.attr("revision")}" if node.attr("revision")
+        xml.edition "Version #{node.attr("version")}" if node.attr("version")
         xml.version do |v|
           v.revision_date node.attr("revdate") if node.attr("revdate")
           v.draft node.attr("draft") if node.attr("draft")

data/lib/asciidoctor/nist/front_id.rb

@@ -1,17 +1,16 @@
+require "iso-639"
+
 module Asciidoctor
   module NIST
     class Converter < Standoc::Converter
       def metadata_id(node, xml)
         did = node.attr("docidentifier")
         dn = node.attr("docnumber")
-        dn = Iso690Render.MMMddyyyy(node.attr("issued-date")) if @series == "nist-cswp" and !dn
-        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")
+        @series == "nist-cswp" && !node.attr("docnumber") and
+          dn = Iso690Render.MMMddyyyy(node.attr("issued-date"))
+        metadata_id_compose(node, xml, dn, did)
+        xml.docnumber node.attr("docnumber") ||
+          did&.sub(/^[^0-9]*/, "")&.sub(/[ -].*$/, "")
       end
 
       def unabbreviate(did)
@@ -21,26 +20,42 @@ module Asciidoctor
       end
 
       def id_args(node, dn0)
+        return nil unless dn0
         {
           id: dn0,
           series: node.attr("series"),
+          edition: node.attr("edition"),
+          version: node.attr("version"),
           revision: node.attr("revision"),
+          update: node.attr("update"),
+          year: (node.attr("copyright-year") || node.attr("updated-date") ||
+                 node.attr("revdate") || node.attr("circulated-date") || 
+                 Date.today.year.to_s).sub(/^(....).*$/, "\\1"),
           vol: node.attr("volume"),
+          part: node.attr("part") || node.attr("part-number"),
+          section: node.attr("section") || node.attr("section-number"),
+          supplement: node.attr("supplement") || node.attr("supplement-number"),
+          index: node.attr("index") || node.attr("index-number"),
           stage: node.attr("status") || node.attr("docstage"),
           iter: node.attr("iteration"),
+          language: node.attr("language") || "en",
           date: /^draft/.match(node.attr("status") || node.attr("docstage")) ?
           (node.attr("circulated-date") || node.attr("revdate")) :
           node.attr("updated-date")
         }
       end
 
-      def metadata_id_compose(node, xml, dn0)
-        return unless dn0
-        args = id_args(node, dn0)
-        xml.docidentifier add_id_parts(args, false), **attr_code(type: "NIST")
-        xml.docidentifier add_id_parts(args, true),
-          **attr_code(type: "nist-long")
-        xml.docidentifier add_id_parts_mr(args), **attr_code(type: "nist-mr")
+      def metadata_id_compose(node, xml, dn0, did)
+        if did
+          xml.docidentifier did, **attr_code(type: "NIST")
+          xml.docidentifier unabbreviate(did), **attr_code(type: "nist-long")
+        else
+          args = id_args(node, dn0) || return
+          xml.docidentifier add_id_parts(args, false), **attr_code(type: "NIST")
+          xml.docidentifier add_id_parts(args, true),
+            **attr_code(type: "nist-long")
+          xml.docidentifier add_id_parts_mr(args), **attr_code(type: "nist-mr")
+        end
       end
 
       def MMMddyyyy(isodate)
@@ -48,26 +63,61 @@ module Asciidoctor
         Date.parse(isodate).strftime("%B %d, %Y")
       end
 
+      def status_abbr(stage, iter)
+        IsoDoc::NIST::Metadata.new(nil, nil, {}).status_abbr(stage, iter)
+      end
+
       def add_id_parts(args, long)
-        vol_delim = " Volume "
-        ed_delim = " Revision "
         args[:series] and series_name = long ?
           SERIES.dig(args[:series].to_sym) :
           SERIES_ABBR.dig(args[:series].to_sym)
         dn = (series_name || "NIST #{args[:series]}")  + " " + args[:id]
-        dn += "#{vol_delim}#{args[:vol]}" if args[:vol]
+        dn += " Volume #{args[:vol]}" if args[:vol]
         dn += "," if args[:vol] && args[:revision]
-        dn += "#{ed_delim}#{args[:revision]}" if args[:revision]
-        stage = IsoDoc::NIST::Metadata.new(nil, nil, {}).status_abbr(args[:stage], args[:iter])
-        dn += " (#{stage})" if stage
+        dn += " Revision #{args[:revision]}" if args[:revision]
+        dn += "/Upd #{args[:update]}:#{args[:year]}" if args[:update]
+        stage = status_abbr(args[:stage], args[:iter]) and dn += " (#{stage})"
         dn += " (#{MMMddyyyy(args[:date])})" if args[:date]
         dn
       end
 
+      def id_parts_mr(args)
+        part = []
+        part << "v-#{args[:vol]}" if args[:vol]
+        part << "pt-#{args[:part]}" if args[:part]
+        part << "sec-#{args[:section]}" if args[:section]
+        part << "sup-#{args[:supplement]}" if args[:supplement]
+        part << "indx-#{args[:index]}" if args[:index]
+        part
+      end
+
+      def id_editions_mr(args)
+        part = []
+        part << "e-#{args[:edition]}" if args[:edition]
+        part << "r-#{args[:revision]}" if args[:revision]
+        part << "ver-#{args[:version]}" if args[:version]
+        part
+      end
+
+      def id_lang_mr(args)
+        ret = args[:language].split(/,\s*/).map do |l|
+          ISO_639.find(l).alpha3
+        end.join(",")
+      end
+
       def add_id_parts_mr(args)
+        ret = ["NIST"]
         args[:series] and
-          name = SERIES_ABBR&.dig(args[:series].to_sym)&.sub(/^NIST /, "")
-        "NIST.#{name}.#{args[:id]}.#{args[:vol]}.#{args[:revision]}.#{args[:date]}"
+          ret << SERIES_ABBR&.dig(args[:series].to_sym)&.sub(/^NIST /, "")
+        stage = status_abbr(args[:stage], nil) || ""
+        stage += "[-#{args[:iter]}]" if args[:iter]
+        ret << stage unless stage.empty?
+        ret << args[:id]
+        ret += id_parts_mr(args)
+        ret += id_editions_mr(args)
+        ret << id_lang_mr(args)
+        args[:update] and ret << "upd-#{args[:update]}:#{args[:year]}"
+        ret.join(".")
       end
     end
   end

data/lib/asciidoctor/nist/isodoc.rng

@@ -53,6 +53,14 @@
         <optional>
           <attribute name="alt"/>
         </optional>
+        <optional>
+          <attribute name="case">
+            <choice>
+              <value>capital</value>
+              <value>lowercase</value>
+            </choice>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -902,7 +910,15 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
-      <ref name="paragraph"/>
+      <oneOrMore>
+        <choice>
+          <ref name="paragraph"/>
+          <ref name="ul"/>
+          <ref name="ol"/>
+          <ref name="dl"/>
+          <ref name="formula"/>
+        </choice>
+      </oneOrMore>
     </element>
   </define>
   <define name="termexample">

data/lib/isodoc/nist/base_convert.rb

@@ -2,20 +2,12 @@ require "isodoc"
 require_relative "metadata"
 require_relative "xrefs"
 require_relative "refs"
+require_relative "section"
 require "fileutils"
 
 module IsoDoc
   module NIST
     module BaseConvert
-      def abstract(isoxml, out)
-        f = isoxml.at(ns("//preface/abstract")) || return
-        #page_break(out)
-        out.div **attr_code(id: f["id"]) do |s|
-          clause_name(nil, @abstract_lbl, s, class: "AbstractTitle")
-          f.elements.each { |e| parse(e, s) unless e.name == "title" }
-        end
-      end
-
       def keywords(_docxml, out)
         kw = @meta.get[:keywords]
         kw.empty? and return
@@ -25,27 +17,8 @@ module IsoDoc
         end
       end
 
-      FRONT_CLAUSE = "//*[parent::preface][not(local-name() = 'abstract' or local-name() = 'foreword')]".freeze
-
-      # All "[preface]" sections should have class "IntroTitle" to prevent
-      # page breaks
-      # But for the Exec Summary
-      def preface(isoxml, out)
-        isoxml.xpath(ns(FRONT_CLAUSE)).each do |c|
-          next if skip_render(c, isoxml)
-          title = c&.at(ns("./title"))
-          patent = ["Call for Patent Claims", "Patent Disclosure Notice"].include? title&.text
-          out.div **attr_code(id: c["id"]) do |s|
-            page_break(s) if patent
-            clause_name(anchor(c['id'], :label), title, s,
-                        class: (c.name == "executivesummary") ? "NormalTitle" :
-                        "IntroTitle")
-            c.elements.reject { |c1| c1.name == "title" }.each do |c1|
-              parse(c1, s)
-            end
-          end
-        end
-      end
+      FRONT_CLAUSE = "//*[parent::preface][not(local-name() = 'abstract' or "\
+        "local-name() = 'foreword')]".freeze
 
       def skip_render(c, isoxml)
         return false unless c.name == "reviewernote"
@@ -157,13 +130,13 @@ module IsoDoc
         "//terms[parent::sections]".freeze
 
       def middle(isoxml, out)
+        middle_admonitions(isoxml, out)
         clause isoxml, out
         bibliography isoxml, out
         annex isoxml, out
       end
 
       def info(isoxml, out)
-        @meta.keywords isoxml, out
         @meta.series isoxml, out
         @meta.commentperiod isoxml, out
         @meta.note isoxml, out
@@ -176,13 +149,15 @@ module IsoDoc
       end
 
       def get_linkend(node)
-        link = anchor_linkend(node, docid_l10n(node["target"] || wrap_brackets(node['citeas'])))
-        link += eref_localities(node.xpath(ns("./locality | ./localityStack")), link)
-        contents = node.children.select { |c| !%w{locality localityStack}.include? c.name }
+        link = anchor_linkend(node, docid_l10n(node["target"] || 
+                                               wrap_brackets(node['citeas'])))
+        link += eref_localities(node.xpath(ns("./locality | ./localityStack")),
+                                link)
+        contents = node.children.select do |c|
+          !%w{locality localityStack}.include? c.name 
+        end
         return link if contents.nil? || contents.empty?
         Nokogiri::XML::NodeSet.new(node.document, contents).to_xml
-        # so not <origin bibitemid="ISO7301" citeas="ISO 7301">
-        # <locality type="section"><reference>3.1</reference></locality></origin>
       end
 
       def load_yaml(lang, script)
@@ -205,38 +180,45 @@ module IsoDoc
         end
       end
 
-      def bibliography_parse(node, out)
-        title = node&.at(ns("./title"))&.text || ""
-        out.div do |div|
-          unless suppress_biblio_title(node)
-            anchor(node['id'], :label, false) and
-          clause_parse_title(node, div, node.at(ns("./title")), out) or
-            div.h2 title, **{ class: "Section3" }
-          end
-          biblio_list(node, div, true)
+      def termref_parse(node, out)
+      end
+
+      def term_cleanup(docxml)
+        docxml.xpath("//table[@class = 'terms_dl']").each do |d|
+          prev = d.previous_element
+          next unless prev && prev.name == "table" &&
+            prev["class"] == "terms_dl"
+          d.children.each { |n| prev.add_child(n.remove) }
+          d.remove
         end
+        docxml
       end
 
-      def suppress_biblio_title(node)
-        return false unless node.parent.name == "annex"
-        return false if node.parent.xpath("./references | ./clause | "\
-                                          "./terms | ./definitions").size > 1
-        title1 = node&.at(ns("./title"))&.text
-        return true unless title1
-        title2 = node&.parent&.at(ns("./title"))&.text
-        title1&.casecmp(title2) == 0
+      def term_and_termref_parse(node, dt)
+        pref = node.at(ns("./preferred"))
+        source = node.xpath(ns("./termsource"))
+        pref.children.each { |n| parse(n, dt) }
+        return if source.empty?
+        dt << "<br/>"
+        source.each_with_index do |s, i|
+          i > 0 and dt << "; "
+          s.elements.each { |n| parse(n, dt) }
+        end
       end
 
-      def foreword(isoxml, out)
-        f = isoxml.at(ns("//foreword")) || return
-        out.div **attr_code(id: f["id"]) do |s|
-          title = f.at(ns("./title"))
-          s.h1(**{ class: "ForewordTitle" }) do |h1|
-            title and title.children.each { |e| parse(e, h1) }
-          end
-          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+      def term_rest_parse(node, dd)
+        set_termdomain("")
+        node.children.each do |n|
+          parse(n, dd) unless %w(preferred termsource).include?(n.name)
         end
       end
+
+      def modification_parse(node, out)
+        out << @modified_lbl
+        node.at(ns("./p[text()[normalize-space() != '']]")) and
+          out << " &mdash; "
+        node.at(ns("./p")).children.each { |n| parse(n, out) }
+      end
     end
   end
 end

data/lib/isodoc/nist/html/nist.scss

@@ -693,7 +693,7 @@ div.Admonition {
         mso-ansi-language:EN-AU;
 }
 
-div Admonotion p {
+div.Admonition p {
   margin-top:6.0pt;margin-right:0cm;
 margin-bottom:6.0pt;margin-left:0cm;text-align:left;mso-pagination:widow-orphan;
 mso-hyphenate:auto;background:#dddddd;mso-layout-grid-align:auto;mso-vertical-align-alt:

data/lib/isodoc/nist/html/nist_cswp.scss

@@ -643,7 +643,7 @@ div.Admonition {
         mso-ansi-language:EN-AU;
 }
 
-div Admonotion p {
+div.Admonition p {
   margin-top:6.0pt;margin-right:0cm;
 margin-bottom:6.0pt;margin-left:0cm;text-align:left;mso-pagination:widow-orphan;
 mso-hyphenate:auto;background:#dddddd;mso-layout-grid-align:auto;mso-vertical-align-alt:

data/lib/isodoc/nist/html_convert.rb

@@ -20,9 +20,11 @@ module IsoDoc
 
       def default_fonts(options)
         {
-          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Libre Baskerville",serif'),
-          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Libre Baskerville",serif'),
-          monospacefont: '"Space Mono",monospace'
+          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' :
+                     '"Libre Baskerville",serif'),
+                     headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' :
+                                  '"Libre Baskerville",serif'),
+                                  monospacefont: '"Space Mono",monospace'
         }
       end
 
@@ -48,28 +50,34 @@ module IsoDoc
       end
 
       def toclevel
-        ret = toclevel_classes.map { |l| "#{l}:not(:empty):not(.TermNum):not(.noTOC):not(.AbstractTitle):not(.IntroTitle):not(.ForewordTitle)" }
-      <<~HEAD.freeze
+        ret = toclevel_classes.map do |l|
+          "#{l}:not(:empty):not(.TermNum):not(.noTOC):not(.AbstractTitle):"\
+            "not(.IntroTitle):not(.ForewordTitle)" 
+        end
+        <<~HEAD.freeze
     function toclevel() { return "#{ret.join(',')}";}
-      HEAD
-    end
+        HEAD
+      end
 
       def html_toc(docxml)
-      idx = docxml.at("//div[@id = 'toc']") or return docxml
-      toc = "<ul>"
-      path = toclevel_classes.map do |l|
-        "//main//#{l}[not(@class = 'TermNum')][not(@class = 'noTOC')][not(text())][not(@class = 'AbstractTitle')][not(@class = 'IntroTitle')][not(@class = 'ForewordTitle')]"
-      end
-      docxml.xpath(path.join(" | ")).each_with_index do |h, tocidx|
-        h["id"] ||= "toc#{tocidx}"
-        toc += html_toc_entry(h.name, h)
+        idx = docxml.at("//div[@id = 'toc']") or return docxml
+        toc = "<ul>"
+        path = toclevel_classes.map do |l|
+          "//main//#{l}[not(@class = 'TermNum')][not(@class = 'noTOC')]"\
+            "[not(text())][not(@class = 'AbstractTitle')]"\
+            "[not(@class = 'IntroTitle')][not(@class = 'ForewordTitle')]"
+        end
+        docxml.xpath(path.join(" | ")).each_with_index do |h, tocidx|
+          h["id"] ||= "toc#{tocidx}"
+          toc += html_toc_entry(h.name, h)
+        end
+        idx.children = "#{toc}</ul>"
+        docxml
       end
-      idx.children = "#{toc}</ul>"
-      docxml
-    end
 
       def make_body(xml, docxml)
-        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72", "xml:lang": "EN-US", class: "container" }
+        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72",
+                      "xml:lang": "EN-US", class: "container" }
         xml.body **body_attr do |body|
           make_body1(body, docxml)
           make_body2(body, docxml)
@@ -117,56 +125,17 @@ module IsoDoc
         end
       end
 
-      def bibliography(isoxml, out)
-        f = isoxml.at(ns("//bibliography/clause | //bibliography/references")) || return
-        page_break(out)
-        isoxml.xpath(ns("//bibliography/clause | //bibliography/references")).each do |f|
-          out.div do |div|
-            div.h1 **{ class: "Section3" } do |h1|
-              if @bibliographycount == 1 then h1 << "References"
-              else
-                f&.at(ns("./title"))&.children.each { |n| parse(n, h1) }
-              end
-            end
-            biblio_list(f, div, false)
-          end
-        end
-      end
-
-      def keywords(_docxml, out)
-        kw = @meta.get[:keywords]
-        kw.empty? and return
-        out.div **{ class: "Section3" } do |div|
-          out.div do |div|
-            clause_name(nil, "Keywords", div,  class: "IntroTitle")
-            div.p kw.sort.join("; ")
-          end
-        end
-      end
-
       def termdef_parse(node, out)
-        pref = node.at(ns("./preferred"))
         out.dl **{ class: "terms_dl" } do |dl|
           dl.dt do |dt|
-            pref.children.each { |n| parse(n, dt) }
+            term_and_termref_parse(node, dt)
           end
-          set_termdomain("")
           dl.dd do |dd|
-            node.children.each { |n| parse(n, dd) unless n.name == "preferred" }
+            term_rest_parse(node, dd)
           end
         end
       end
 
-      def term_cleanup(docxml)
-        docxml.xpath("//table[@class = 'terms_dl']").each do |d|
-          prev = d.previous_element
-          next unless prev and prev.name == "table" and prev["class"] == "terms_dl"
-          d.children.each { |n| prev.add_child(n.remove) }
-          d.remove
-        end
-        docxml
-      end
-
       include BaseConvert
     end
   end