metanorma-nist 1.0.4 → 1.0.9

data/lib/asciidoctor/nist/converter.rb

@@ -107,7 +107,7 @@ module Asciidoctor
           File.open(filename, "w:UTF-8") { |f| f.write(ret) }
           html_converter(node).convert filename unless node.attr("nodoc")
           word_converter(node).convert filename unless node.attr("nodoc")
-          pdf_converter(node).convert filename unless node.attr("nodoc")
+          pdf_converter(node)&.convert filename unless node.attr("nodoc")
         end
         @log.write(@localdir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
@@ -151,36 +151,12 @@ module Asciidoctor
         end
       end
 
-      def section(node)
-        a = section_attributes(node)
-        noko do |xml|
-          case sectiontype(node)
-            #when "normative references" then norm_ref_parse(a, xml, node)
-          when "terms and definitions"
-            if node.attr("style") == "appendix" && node.level == 1
-              @term_def = true
-              terms_annex_parse(a, xml, node)
-              @term_def = false
-            else
-              clause_parse(a, xml, node)
-            end
-          when "acknowledgements"
-            acknowledgements_parse(a, xml, node)
-          else
-            if @term_def 
-              term_def_subclause_parse(a, xml, node)
-            elsif @biblio then bibliography_parse(a, xml, node)
-            elsif node.attr("style") == "bibliography"
-              bibliography_parse(a, xml, node)
-            elsif node.attr("style") == "abstract"
-              abstract_parse(a, xml, node)
-            elsif node.attr("style") == "appendix" && node.level == 1
-              annex_parse(a, xml, node)
-            else
-              clause_parse(a, xml, node)
-            end
-          end
-        end.join("\n")
+      def term_def_parse(attrs, xml, node, toplevel)
+        if node.attr("style") == "appendix" && node.level == 1
+          terms_annex_parse(attrs, xml, node)
+        else
+          clause_parse(attrs, xml, node)
+        end
       end
 
       def bibliography_parse(a, xml, node)
@@ -236,6 +212,7 @@ module Asciidoctor
       end
 
       def pdf_converter(node)
+        return nil if node.attr("no-pdf")
         IsoDoc::NIST::PdfConvert.new(html_extract_attributes(node))
       end
     end

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")
@@ -46,7 +47,7 @@ module Asciidoctor
 
       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 << (Asciidoctor::Standoc::Utils::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|
@@ -144,20 +145,26 @@ module Asciidoctor
       end
 
       def relaton_relations
-        super + %w(obsoletes obsoleted-by supersedes superseded-by)
+        super + %w(obsoletes obsoleted-by)
       end
 
-      def metadata_getrelation(node, xml, type)
-        if type == "obsoleted-by" and node.attr("superseding-status")
+      def relaton_relation_descriptions
+        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")
           metadata_superseding_doc(node, xml)
-        else
-          super
         end
+        super
       end
 
       def metadata_superseding_doc(node, xml)
         xml.relation **{ type: "obsoletedBy" } do |r|
-          r.bibitem do |b|
+          r.bibitem **{ type: "standard" } do |b|
             metadata_superseding_titles(b, node)
             doi = node.attr("superseding-doi") and
               b.uri doi, **{ type: "doi" }
@@ -197,16 +204,21 @@ module Asciidoctor
 
       def metadata_superseding_titles(b, node)
         if node.attr("superseding-title")
-          b.title Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("superseding-title")),
-            **{ type: "main" }
+          b.title **{ type: "main" } do |t|
+            t << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("superseding-title"))
+          end
           node.attr("superseding-subtitle") and
-            b.title Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("superseding-subtitle")),
-            **{ type: "subtitle" }
+            b.title **{ type: "subtitle" } do |t|
+            t << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("superseding-subtitle"))
+          end
         else
-          b.title Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-main") || node.title),
-            **{ type: "main" }
+          b.title **{ type: "main" } do |t|
+            t << (Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-main")) || node.title)
+          end
           node.attr("title-sub") and
-            b.title Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-sub")), **{ type: "subtitle" }
+            b.title **{ type: "subtitle" } do |t|
+            t << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-sub"))
+          end
         end
       end
 

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>
@@ -129,6 +137,9 @@
             </choice>
           </attribute>
         </optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
         <optional>
           <ref name="section-title"/>
         </optional>
@@ -305,6 +316,21 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="TextElement" combine="choice">
+    <ref name="concept"/>
+  </define>
+  <define name="concept">
+    <element name="concept">
+      <optional>
+        <attribute name="term"/>
+      </optional>
+      <choice>
+        <ref name="eref"/>
+        <ref name="xref"/>
+        <ref name="termref"/>
+      </choice>
+    </element>
+  </define>
   <define name="BasicBlock" combine="choice">
     <choice>
       <ref name="requirement"/>
@@ -884,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">
@@ -911,7 +945,10 @@
   </define>
   <define name="origin">
     <element name="origin">
-      <ref name="erefType"/>
+      <choice>
+        <ref name="erefType"/>
+        <ref name="termref"/>
+      </choice>
     </element>
   </define>
   <define name="modification">
@@ -919,6 +956,15 @@
       <ref name="paragraph"/>
     </element>
   </define>
+  <define name="termref">
+    <element name="termref">
+      <attribute name="base"/>
+      <attribute name="target"/>
+      <optional>
+        <text/>
+      </optional>
+    </element>
+  </define>
   <define name="structuredidentifier">
     <element name="structuredidentifier">
       <optional>

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")), link)
-        contents = node.children.select { |c| c.name != "locality" }
+        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