metanorma-nist 1.1.3 → 1.2.4

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/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,37 +6,6 @@ require "fileutils"
 module IsoDoc
   module NIST
     module BaseConvert
-      def metadata_init(lang, script, labels)
-        @meta = Metadata.new(lang, script, labels)
-      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
-        return true if status.nil?
-        /^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|
@@ -54,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
 
@@ -84,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|
@@ -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,28 +170,27 @@ 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
+      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

data/lib/isodoc/nist/html/nist.css

@@ -828,7 +828,7 @@ div.WordSection1 {
           {% endif %}
   mso-even-header: url("file:///C:/Doc/FILENAME_files/header.html") eh2;
   mso-header: url("file:///C:/Doc/FILENAME_files/header.html") h2;
-  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") ef2;
+  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") f2;
   mso-footer: url("file:///C:/Doc/FILENAME_files/header.html") f2;
   mso-paper-source: 0; }
 
@@ -843,7 +843,7 @@ div.WordSection1 {
           {% endif %}
   mso-even-header: url("file:///C:/Doc/FILENAME_files/header.html") eh2l;
   mso-header: url("file:///C:/Doc/FILENAME_files/header.html") h2l;
-  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") ef2l;
+  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") f2l;
   mso-footer: url("file:///C:/Doc/FILENAME_files/header.html") f2l;
   mso-paper-source: 0; }
 
@@ -858,7 +858,7 @@ div.WordSection1 {
           {% endif %}
   mso-even-header: url("file:///C:/Doc/FILENAME_files/header.html") eh2;
   mso-header: url("file:///C:/Doc/FILENAME_files/header.html") h2;
-  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") ef2;
+  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") f2;
   mso-footer: url("file:///C:/Doc/FILENAME_files/header.html") f2;
   mso-paper-source: 0; }
 
@@ -877,7 +877,7 @@ div.WordSection2 {
           {% endif %}
   mso-even-header: url("file:///C:/Doc/FILENAME_files/header.html") eh2;
   mso-header: url("file:///C:/Doc/FILENAME_files/header.html") h2;
-  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") ef3;
+  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") f3;
   mso-footer: url("file:///C:/Doc/FILENAME_files/header.html") f3;
   mso-paper-source: 0; }
 
@@ -892,7 +892,7 @@ div.WordSection2 {
           {% endif %}
   mso-even-header: url("file:///C:/Doc/FILENAME_files/header.html") eh2l;
   mso-header: url("file:///C:/Doc/FILENAME_files/header.html") h2l;
-  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") ef3l;
+  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") f3l;
   mso-footer: url("file:///C:/Doc/FILENAME_files/header.html") f3l;
   mso-paper-source: 0; }
 
@@ -907,14 +907,14 @@ div.WordSection2 {
           {% endif %}
   mso-even-header: url("file:///C:/Doc/FILENAME_files/header.html") eh2;
   mso-header: url("file:///C:/Doc/FILENAME_files/header.html") h2;
-  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") ef3;
+  mso-even-footer: url("file:///C:/Doc/FILENAME_files/header.html") f3;
   mso-footer: url("file:///C:/Doc/FILENAME_files/header.html") f3;
   mso-paper-source: 0; }
 
 div.WordSection3 {
   page: WordSection3; }
 
-table.MsoISOTable {
+table.MsoISOTable, table.MsoISOTableBig {
   mso-style-name: "Table NIST";
   mso-tstyle-rowband-size: 0;
   mso-tstyle-colband-size: 0;
@@ -935,7 +935,7 @@ table.MsoISOTable {
   font-size: 10.0pt;
   font-family: {{bodyfont}}; }
 
-table.MsoISOTable th {
+table.MsoISOTable th, table.MsoISOTableBig th {
   border: solid windowtext 1pt;
   background: black;
   color: white;
@@ -944,12 +944,12 @@ table.MsoISOTable th {
   mso-border-alt: solid windowtext 1pt;
   padding: 0cm 2.85pt 0cm 2.85pt; }
 
-table.MsoISOTable td {
+table.MsoISOTable td, table.MsoISOTableBig td {
   border: solid windowtext 1pt;
   mso-border-alt: solid windowtext 1pt;
   padding: 0cm 2.85pt 0cm 2.85pt; }
 
-table.MsoISOTable p {
+table.MsoISOTable p, table.MsoISOTableBig p {
   font-size: 10.0pt; }
 
 table.MsoTableGrid {
@@ -1039,8 +1039,20 @@ div.example p.MsoListParagraph {
   font-size: 10.0pt; }
 
 div.Note p.MsoListParagraph {
+  font-size: 10.0pt;
+  margin-left: 1.0cm; }
+
+div.Note span.stem {
   font-size: 10.0pt; }
 
+div.Note p.Sourcecode, div.Note pre.Sourcecode {
+  font-size: 8.0pt;
+  margin-left: 1.0cm; }
+
+div.Note table.dl {
+  font-size: 10.0pt;
+  margin-left: 1.0cm; }
+
 span.note_label, span.example_label, td.example_label, td.note_label {
   font-size: 10.0pt;
   font-family: {{bodyfont}}; }

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

@@ -790,7 +790,7 @@ div.WordSection1
         {% endif %}
 	mso-even-header:url("file:///C:/Doc/FILENAME_files/header.html") eh2;
 	mso-header:url("file:///C:/Doc/FILENAME_files/header.html") h2;
-	mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") ef2;
+	mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") f2;
 	mso-footer:url("file:///C:/Doc/FILENAME_files/header.html") f2;
 	mso-paper-source:0;}
 @page WordSection2L {
@@ -804,7 +804,7 @@ div.WordSection1
         {% endif %}
         mso-even-header:url("file:///C:/Doc/FILENAME_files/header.html") eh2l;
         mso-header:url("file:///C:/Doc/FILENAME_files/header.html") h2l;
-        mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") ef2l;
+        mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") f2l;
         mso-footer:url("file:///C:/Doc/FILENAME_files/header.html") f2l;
         mso-paper-source:0;}
 @page WordSection2P {
@@ -818,7 +818,7 @@ div.WordSection1
         {% endif %}
         mso-even-header:url("file:///C:/Doc/FILENAME_files/header.html") eh2;
         mso-header:url("file:///C:/Doc/FILENAME_files/header.html") h2;
-        mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") ef2;
+        mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") f2;
         mso-footer:url("file:///C:/Doc/FILENAME_files/header.html") f2;
         mso-paper-source:0;}
 div.WordSection2
@@ -835,7 +835,7 @@ div.WordSection2
         {% endif %}
 	mso-even-header:url("file:///C:/Doc/FILENAME_files/header.html") eh2;
 	mso-header:url("file:///C:/Doc/FILENAME_files/header.html") h2;
-	mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") ef3;
+	mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") f3;
 	mso-footer:url("file:///C:/Doc/FILENAME_files/header.html") f3;
 	mso-paper-source:0;}
 @page WordSection3L {
@@ -849,7 +849,7 @@ div.WordSection2
         {% endif %}
         mso-even-header:url("file:///C:/Doc/FILENAME_files/header.html") eh2l;
         mso-header:url("file:///C:/Doc/FILENAME_files/header.html") h2l;
-        mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") ef3l;
+        mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") f3l;
         mso-footer:url("file:///C:/Doc/FILENAME_files/header.html") f3l;
         mso-paper-source:0;}
 @page WordSection3P {
@@ -863,12 +863,12 @@ div.WordSection2
         {% endif %}
         mso-even-header:url("file:///C:/Doc/FILENAME_files/header.html") eh2;
         mso-header:url("file:///C:/Doc/FILENAME_files/header.html") h2;
-        mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") ef3;
+        mso-even-footer:url("file:///C:/Doc/FILENAME_files/header.html") f3;
         mso-footer:url("file:///C:/Doc/FILENAME_files/header.html") f3;
         mso-paper-source:0;}
 div.WordSection3
 	{page:WordSection3;}
-table.MsoISOTable
+table.MsoISOTable, table.MsoISOTableBig
 	{mso-style-name:"Table NIST";
 	mso-tstyle-rowband-size:0;
 	mso-tstyle-colband-size:0;
@@ -888,7 +888,7 @@ table.MsoISOTable
 	mso-border-insidev:.75pt solid windowtext;
 	font-size:10.0pt;
 	font-family:$bodyfont;}
-table.MsoISOTable th
+table.MsoISOTable th, table.MsoISOTableBig th
     {border:solid windowtext 1pt;
       background: black;
       color: white;
@@ -896,11 +896,11 @@ table.MsoISOTable th
       font-family:$headerfont;
     mso-border-alt:solid windowtext 1pt;
     padding:0cm 2.85pt 0cm 2.85pt;}
-table.MsoISOTable td
+table.MsoISOTable td, table.MsoISOTableBig td
     {border:solid windowtext 1pt;
     mso-border-alt:solid windowtext 1pt;
     padding:0cm 2.85pt 0cm 2.85pt;}
-table.MsoISOTable p
+table.MsoISOTable p, table.MsoISOTableBig p
 {font-size:10.0pt; }
 table.MsoTableGrid
 	{mso-style-name:"Table Grid";
@@ -990,6 +990,20 @@ div.example p.MsoListParagraph {
 
 div.Note p.MsoListParagraph {
   font-size: 10.0pt;
+  margin-left: 1.0cm;
+}
+
+div.Note span.stem {
+  font-size: 10.0pt; }
+
+div.Note p.Sourcecode, div.Note pre.Sourcecode  {
+  font-size: 8.0pt;
+  margin-left: 1.0cm;
+}
+
+div.Note table.dl  {
+  font-size: 10.0pt;
+  margin-left: 1.0cm;
 }
 
 span.note_label, span.example_label, td.example_label, td.note_label