metanorma-nist 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79b2cd1ac9a7ff463c23371e7bfa9e29ec244601341ed33e603f7e0354f4d9e6
-  data.tar.gz: 5aca2aca01a5ff7066b71df1f73c1e3e2c83c3ee786170e7a50fa107f3e6a9f2
+  metadata.gz: 0def1e8573338383bf4e456fc4fc092a232c08ef46b676facc570908ad9fd9aa
+  data.tar.gz: 820cf042c13235a0519ee6818573d9fb445bb6e0d368265a7e72753ea7e40c94
 SHA512:
-  metadata.gz: d0dd3462d1f337597610e80f572727ce6a49097fa9501cbd1eaa47d3b22fc67d1cea85c7012d23b51dac3718e3f8caf28c25ac0a4bb2bef439cbb638555c46d1
-  data.tar.gz: f8cdb2613aee57ba726feedd3b4c48dab082f1ab69363056dd3d80432db3a2398a95e96a378aeefd724914f975a80884d095c464e129828d7a9a10509f3432bb
+  metadata.gz: 0c5a2abc6a91c220a19917f5b314a18fa06067263c391fbe4d97897d16461b11af49c61feaf8a737264c355627aa42a202981a1b8c40ed7fb37bb8c39791b2e0
+  data.tar.gz: 0fc41aabba065a26cef8e432bf32b2c5c2927e9a3826cf89c578905e9154b51085ca447463e8feddff9ed7f21ae32ed5f79b65981dee54921f86d976c0b4b40d

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

@@ -100,9 +100,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)
@@ -159,7 +162,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

@@ -27,31 +27,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
 
@@ -72,7 +76,8 @@ module Asciidoctor
         xml.contributor do |c|
           c.role **{ type: "publisher" }
           c.organization do |a|
-            a.name "NIST"
+            a.name "National Institute of Standards and Technology"
+            a.abbreviation "NIST"
             d = node.attr("nist-division") and a.subdivision d
           end
         end
@@ -86,9 +91,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"),
@@ -112,7 +118,8 @@ module Asciidoctor
           c.from from
           c.owner do |owner|
             owner.organization do |o|
-              o.name "NIST"
+              o.name "National Institute of Standards and Technology"
+              o.abbreviation "NIST"
             end
           end
         end
@@ -149,14 +156,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 +172,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 +209,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

@@ -922,6 +922,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +964,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +992,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1014,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,6 +1042,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1180,6 +1183,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>

data/lib/asciidoctor/nist/validate.rb

@@ -21,26 +21,30 @@ module Asciidoctor
       def doctype_validate(xmldoc)
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
         %w(standard).include? doctype or
-          @log.add("Document Attributes", nil, "#{doctype} is not a recognised document type")
+          @log.add("Document Attributes", nil, 
+                   "#{doctype} is not a recognised document type")
       end
 
       def stage_validate(xmldoc)
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(draft-internal draft-wip draft-prelim draft-public draft-approval
         final final-review).include? stage or
-        @log.add("Document Attributes", nil, "#{stage} is not a recognised stage")
+        @log.add("Document Attributes", nil, 
+                 "#{stage} is not a recognised stage")
       end
 
       def substage_validate(xmldoc)
         substage = xmldoc&.at("//bibdata/status/substage")&.text or return
         %w(active retired withdrawn).include? substage or
-          @log.add("Document Attributes", nil, "#{substage} is not a recognised substage")
+          @log.add("Document Attributes", nil, 
+                   "#{substage} is not a recognised substage")
       end
 
       def iteration_validate(xmldoc)
         iteration = xmldoc&.at("//bibdata/status/iteration")&.text or return
         %w(final).include? iteration.downcase or /^\d+$/.match(iteration) or
-          @log.add("Document Attributes", nil, "#{iteration} is not a recognised iteration")
+          @log.add("Document Attributes", nil, 
+                   "#{iteration} is not a recognised iteration")
       end
 
       def series_validate(xmldoc)
@@ -48,7 +52,8 @@ module Asciidoctor
         found = false
         SERIES.each { |_, v| found = true if v == series }
         found or
-          @log.add("Document Attributes", nil, "#{series} is not a recognised series")
+          @log.add("Document Attributes", nil, 
+                   "#{series} is not a recognised series")
       end
 
       def validate(doc)
@@ -60,8 +65,9 @@ module Asciidoctor
       def introduction_validate(doc)
         intro = doc.at("//sections/clause/title")
         intro&.text == "Introduction" or
-          @log.add("Style", intro, "First section of document body should be Introduction, "\
-          "not #{intro&.text}")
+          @log.add("Style", intro, 
+                   "First section of document body should be Introduction, "\
+                   "not #{intro&.text}")
       end
 
       REF_SECTIONS_TO_VALIDATE = "//references[not(parent::clause)]/title | "\
@@ -80,8 +86,9 @@ module Asciidoctor
         return if names == ["References"]
         return if names == ["Bibliography"]
         return if names == ["References", "Bibliography"]
-        @log.add("Style", nil, "Reference clauses #{names.join(', ')} do not follow expected "\
-          "pattern in NIST")
+        @log.add("Style", nil, 
+                 "Reference clauses #{names.join(', ')} do not follow "\
+                 "expected pattern in NIST")
       end
     end
   end

data/lib/isodoc/nist/base_convert.rb

@@ -1,6 +1,4 @@
 require "isodoc"
-require_relative "metadata"
-require_relative "xref"
 require_relative "refs"
 require_relative "section"
 require "fileutils"
@@ -8,26 +6,11 @@ require "fileutils"
 module IsoDoc
   module NIST
     module BaseConvert
-      def metadata_init(lang, script, labels)
-        @meta = Metadata.new(lang, script, labels)
+      def keywords(docxml, out)
+        f = docxml.at(ns("//preface/clause[@type = 'keywords']")) || return
+        intro_clause(f, out)
       end
 
-      def xref_init(lang, script, klass, labels, options)
-        @xrefs = Xref.new(lang, script, klass, labels, options)
-      end
-
-      def keywords(_docxml, out)
-        kw = @meta.get[:keywords]
-        kw.empty? and return
-        out.div **{ class: "Section3" } do |div|
-          clause_name(nil, "Keywords", div,  class: "IntroTitle")
-          div.p kw.sort.join("; ")
-        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"
         status = isoxml&.at(ns("//bibdata/status/stage"))&.text
@@ -35,10 +18,6 @@ module IsoDoc
         /^final/.match status
       end
 
-      def fileloc(loc)
-        File.join(File.dirname(__FILE__), loc)
-      end
-
       def requirement_cleanup(docxml)
         docxml.xpath("//div[@class = 'recommend' or @class = 'require' "\
                      "or @class = 'permission']").each do |d|
@@ -152,33 +131,6 @@ module IsoDoc
         super
       end
 
-      def wrap_brackets(txt)
-        return txt if /^\[.*\]$/.match txt
-        "[#{txt}]"
-      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 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
-      end
-
-      def load_yaml(lang, script)
-        y = if @i18nyaml then YAML.load_file(@i18nyaml)
-            elsif lang == "en"
-              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
-            else
-              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
-            end
-        super.merge(y)
-      end
-
       def terms_parse(node, out)
         out.div **attr_code(id: node["id"]) do |div|
           node.at(ns("./title")) and
@@ -218,29 +170,16 @@ module IsoDoc
       def term_rest_parse(node, dd)
         set_termdomain("")
         node.children.each do |n|
-          parse(n, dd) unless %w(preferred termsource).include?(n.name)
+          parse(n, dd) unless %w(preferred termsource name).include?(n.name)
         end
       end
 
       def modification_parse(node, out)
-        out << @modified_lbl
+        out << @i18n.modified
         node.at(ns("./p[text()[normalize-space() != '']]")) and
           out << " &mdash; "
         node.at(ns("./p")).children.each { |n| parse(n, out) }
       end
-
-      def annex_name(annex, name, div)
-        div.h1 **{ class: "Annex" } do |t|
-          t << "#{@xrefs.anchor(annex['id'], :label)} &mdash; "
-          t.b do |b|
-            if @bibliographycount == 1 && annex.at(ns("./references"))
-              b << "References"
-            else
-              name&.children&.each { |c2| parse(c2, b) }
-            end
-          end
-        end
-      end
     end
   end
 end