metanorma-nist 0.0.4 → 0.0.5

data/lib/isodoc/nist/html/header.html

@@ -144,8 +144,7 @@ style='mso-tab-count:1'>
 <div style='mso-element:footer' id=f3>
 
 <p class=MsoFooter style='line-height:12.0pt'><span lang=EN-GB
-style='font-size:10.0pt;mso-bidi-font-size:11.0pt'>© NIST.&nbsp;{{ docyear }}&nbsp;– All
-rights reserved<span style='mso-tab-count:1'>                                                                                                                                                                           </span></span><!--[if supportFields]><b
+style='font-size:10.0pt;mso-bidi-font-size:11.0pt'><span style='mso-tab-count:1'>                                                                                                                                                                           </span></span><!--[if supportFields]><b
 style='mso-bidi-font-weight:normal'><span lang=EN-GB style='font-size:10.0pt;
 mso-bidi-font-size:11.0pt'><span style='mso-element:field-begin'></span>
 PAGE<span style='mso-spacerun:yes'>   </span>\* MERGEFORMAT <span

data/lib/isodoc/nist/html/html_nist_intro.html

@@ -21,6 +21,18 @@ CODEN: NSPUE2</p>
 <p>Organizations are encouraged to review all draft publications during public comment periods and provide feedback to NIST. Many NIST cybersecurity publications, other than the ones noted above, are available at <a href="https://csrc.nist.gov/publications">https://csrc.nist.gov/publications</a>.
 </div>
 
+{% if comment_extended %}
+<p align="center">[{{ comment_extended}}: Comment period extended]</p>
+{% endif %}
+
+{% if comment_from and comment_to %}
+<p align="center"><b>Public comment period: <i>{{ comment_from }}</i> through <i>{{comment_to}}</i></b></p>
+{% else %}
+{% if comment_from %}
+<p align="center"><b>Public comment period: from <i>{{ comment_from }}</i></b></p>
+{% endif %}
+{% endif %}
+
 <h2>Comments on this publication may be submitted to:</h2>
 
 <p align="center">National Institute of Standards and Technology <br/>

data/lib/isodoc/nist/html/html_nist_titlepage.html

@@ -20,7 +20,7 @@
 
       <div class="coverpage-doc-identity">
         <div class="doc-number">
-          <div>{{ docnumber }}</div>
+          <div>{{ docnumber_long }}</div>
           {% if edition %} <div> Revision {{ edition }}</div> {% endif %}
           <div> {{ draftinfo }}</div>
         </div>
@@ -30,6 +30,9 @@
           {% if docsubtitle %}
           <br/><span class="title-second">{{ docsubtitle }}</span>
           {% endif %}
+          {% if docparttitle %}
+          <br/><span class="title-second">{{ docparttitle }}</span>
+          {% endif %}
         </div>
       </div>
 
@@ -38,7 +41,7 @@
       </div>
 
       <div class="coverpage-tc-name">
-        <span>{{ tc }}</span>
+        <span>{{ subseries }}</span>
       </div>
 
       <div class="rule-thick"></div>
@@ -57,7 +60,7 @@
         This publication is available free of charge from: <br>
         <a href="{{url}}">{{ url }}</a>
 
-        <div class="category">{{ tc }}</div>
+        <div class="category">{{ subseries }}</div>
 
       </div>
 
@@ -108,18 +111,6 @@
     <div class="info-section">
       <div class="copyright">
 
-        <p class="year">
-        &copy; {{ docyear }} NIST.
-        </p>
-
-        <p class="message">
-        All rights reserved. Unless otherwise specified, no part of this
-        publication may be reproduced or utilized otherwise in any form or by any
-        means, electronic or mechanical, including photocopying, or posting on the
-        internet or an intranet, without prior written permission. Permission can
-        be requested from the address below.
-        </p>
-
         <div class="contact-info">
           <p class="name">National Institute of Standards and Technology</p>
           <p class="address">

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

@@ -354,11 +354,11 @@ p.document-stage {
 }
 
 
-#standard-band,  #published-band {
+#standard-band,  #final-band {
 color: rgb(123, 168, 18);
   background-color: rgb(216, 236, 168); }
 
-  #standard, #published {
+  #standard, #final {
   color: #9ABD48; }
 
 #governance, #policy-and-procedures {
@@ -380,22 +380,22 @@ color: rgb(123, 168, 18);
   margin: 0 0 2em 0;
   text-transform: uppercase; }
 
-#working-draft, #proposal {
+#internal-draft, #proposal {
   border-bottom: solid 3px #F7803C; }
 
-#working-draft-band, #proposal-band {
+#internal-draft-band, #proposal-band {
   background-color: #F7803C; }
 
-#committee-draft {
+#public-draft, #initial-public-draft, #final-public-draft {
   border-bottom: solid 3px #fd06fd; }
 
-#committee-draft-band {
+#public-draft-band, #initial-public-draft-band, #final-public-draft-band {
   background-color: #fd06fd; }
 
-#draft-standard {
+#retired-draft {
   border-bottom: solid 3px #fdf906; }
 
-#draft-standard-band {
+#retired-draft-band {
   background-color: #fdf906; }
 
 #standard {
@@ -404,10 +404,10 @@ color: rgb(123, 168, 18);
 #standard-band {
   background-color: #9ABD48; }
 
-#obsolete {
+#withdrawn {
   border-bottom: solid 3px #7e0d13; }
 
-#obsolete-band {
+#withdrawn-band {
   background-color: #7e0d13; }
 
 .coverpage-maturity {

data/lib/isodoc/nist/html/word_nist_intro.html

@@ -103,6 +103,19 @@ font-family:"Arial",sans-serif;color:black'><o:p></o:p></span></b></p>
 
 </div>
 
+{% if comment_extended %}
+<p class=MsoNormal align="center">[{{ comment_extended}}: Comment period extended]</p>
+{% endif %}
+
+{% if comment_from and comment_to %}
+<p class=MsoNormal align="center"><b>Public comment period: <i>{{ comment_from }}</i> through <i>{{comment_to}}</i></b></p>
+{% else %}
+{% if comment_from %}
+<p class=MsoNormal align="center"><b>Public comment period: from <i>{{ comment_from }}</i></b></p>
+{% endif %}
+{% endif %}
+
+
 <p class=MsoNormal align=center style='margin-bottom:6.0pt;text-align:center'><b><span
 lang=EN-US style='font-size:11.0pt;font-family:"Arial",sans-serif'>Comments
 on this publication may be submitted to:</span></b><b style='mso-bidi-font-weight:

data/lib/isodoc/nist/html/word_nist_titlepage.html

@@ -14,6 +14,9 @@ mso-border-top-alt:thin-thick-small-gap windowtext 4.5pt;padding:6.0pt 0cm 0cm 0
 {% if docsubtitle %}
   <p class="CoverSubtitle"><span lang="EN-US">{{ docsubtitle }}<o:p></o:p></span></p>
 {% endif %}
+{% if docparttitle %}
+  <p class="CoverSubtitle"><span lang="EN-US">{{ docparttitle }}<o:p></o:p></span></p>
+{% endif %}
 
 <div style='mso-element:para-border-div;border:none;border-top:solid black 1.5pt;
 mso-border-top-themecolor:text1;padding:1.0pt 0cm 0cm 0cm'>
@@ -65,7 +68,7 @@ padding:1.0pt 0cm 1.0pt 0cm'>
 <p class="MsoNormal" align="center" style='text-align:center;border:none;
 mso-border-top-alt:solid windowtext 1.5pt;mso-border-bottom-alt:solid windowtext 1.5pt;
 padding:0cm;mso-padding-alt:1.0pt 0cm 1.0pt 0cm'><span lang="EN-US"
-     style='font-size:16.0pt;font-family:"Arial",sans-serif;mso-ansi-language:EN-US;letter-spacing:10.0pt'>{{ tc }}<o:p></o:p></span></p>
+     style='font-size:16.0pt;font-family:"Arial",sans-serif;mso-ansi-language:EN-US;letter-spacing:10.0pt'>{{ subseries }}<o:p></o:p></span></p>
 
 </div>
 

data/lib/isodoc/nist/html_convert.rb

@@ -13,6 +13,7 @@ module IsoDoc
       end
 
       def convert1(docxml, filename, dir)
+        @bibliographycount = docxml.xpath(ns("//bibliography/references | //annex/references | //bibliography/clause/references")).size
         FileUtils.cp html_doc_path('logo.png'), "#{@localdir}/logo.png"
         FileUtils.cp html_doc_path('commerce-logo-color.png'), "#{@localdir}/commerce-logo-color.png"
         @files_to_delete << "#{@localdir}/logo.png"
@@ -97,7 +98,11 @@ module IsoDoc
         isoxml.xpath(ns("//bibliography/clause | //bibliography/references")).each do |f|
           out.div do |div|
             div.h1 **{ class: "Section3" } do |h1|
-              f&.at(ns("./title"))&.children.each { |n| parse(n, h1) }
+              if @bibliographycount == 1
+                h1 << "References"
+              else
+                f&.at(ns("./title"))&.children.each { |n| parse(n, h1) }
+              end
             end
             f.elements.reject do |e|
               ["reference", "title", "bibitem"].include? e.name
@@ -145,9 +150,9 @@ module IsoDoc
 
       def skip_render(c, isoxml)
         return false unless c.name == "reviewernote"
-        status = isoxml&.at(ns("//bibdata/status"))&.text
+        status = isoxml&.at(ns("//bibdata/status/stage"))&.text
         return true if status.nil?
-        return ["published", "withdrawn"].include? status
+        return ["final", "withdrawn"].include? status
       end
 
       def term_defs_boilerplate(div, source, term, preface)
@@ -166,15 +171,6 @@ module IsoDoc
         File.join(File.dirname(__FILE__), loc)
       end
 
-      def term_cleanup(docxml)
-        docxml.xpath("//p[@class = 'Terms']").each do |d|
-          h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
-          h2.add_child("&nbsp;")
-          h2.add_child(d.remove)
-        end
-        docxml
-      end
-
       def requirement_cleanup(docxml)
         docxml.xpath("//div[@class = 'recommend' or @class = 'require' "\
                      "or @class = 'permission'][title]").each do |d|
@@ -320,6 +316,8 @@ module IsoDoc
 
       def info(isoxml, out)
         @meta.keywords isoxml, out
+        @meta.series isoxml, out
+        @meta.commentperiod isoxml, out
         super
       end
 
@@ -479,7 +477,11 @@ module IsoDoc
         div.h1 **{ class: "Annex" } do |t|
           t << "#{get_anchors[annex['id']][:label]} &mdash; "
           t.b do |b|
-            name&.children&.each { |c2| parse(c2, b) }
+            if @bibliographycount == 1 && annex.at(ns("./references"))
+              b << "References"
+            else
+              name&.children&.each { |c2| parse(c2, b) }
+            end
           end
         end
       end
@@ -488,6 +490,69 @@ module IsoDoc
         "-"
       end
 
+      def annex_names(clause, num)
+        @anchors[clause["id"]] = { label: annex_name_lbl(clause, num), type: "clause",
+                                   xref: "#{@annex_lbl} #{num}", level: 1 }
+        clause.xpath(ns("./clause | ./terms | ./term | ./references")).each_with_index do |c, i|
+          annex_names1(c, "#{num}.#{i + 1}", 2)
+        end
+        hierarchical_asset_names(clause, num)
+      end
+
+      def annex_names1(clause, num, level)
+        @anchors[clause["id"]] = { label: num, xref: "#{@annex_lbl} #{num}",
+                                   level: level, type: "clause" }
+        clause.xpath(ns("./clause | ./terms | ./term | ./references")).each_with_index do |c, i|
+          annex_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
+      end
+
+      def terms_parse(node, out)
+        out.div **attr_code(id: node["id"]) do |div|
+          node.at(ns("./title")) and
+            clause_parse_title(node, div, node.at(ns("./title")), out)
+          term_defs_boilerplate(div, node.xpath(ns(".//termdocsource")),
+                                node.at(ns(".//term")), node.at(ns("./p")))
+          node.elements.each do |e|
+            parse(e, div) unless %w{title source}.include? e.name
+          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) }
+          end
+          set_termdomain("")
+          dl.dd do |dd|
+            node.children.each { |n| parse(n, dd) unless n.name == "preferred" }
+          end
+        end
+      end
+
+      def term_cleanup(docxml)
+        docxml.xpath("//dl[@class = 'terms_dl']").each do |d|
+          prev = d.previous_element
+          next unless prev.name == "dl" and prev["class"] == "terms_dl"
+          d.children.each { |n| prev.add_child(n.remove) }
+          d.remove
+        end
+        docxml
+      end
+
+      def bibliography_parse(node, out)
+        title = node&.at(ns("./title"))&.text || ""
+        out.div do |div|
+          node.parent.name == "annex" or
+            div.h2 title, **{ class: "Section3" }
+          node.elements.reject do |e|
+            ["reference", "title", "bibitem"].include? e.name
+          end.each { |e| parse(e, div) }
+          biblio_list(node, div, true)
+        end
+      end
     end
   end
 end

data/lib/isodoc/nist/metadata.rb

@@ -1,4 +1,5 @@
 require "isodoc"
+require "twitter_cldr"
 
 module IsoDoc
   module NIST
@@ -9,13 +10,13 @@ module IsoDoc
         set(:status, "XXX")
       end
 
-      def title(isoxml, _out)
-        main = isoxml&.at(ns("//bibdata/title[@language='en']"))&.text
+      def title(isoxml, out)
+        main = isoxml&.at(ns("//bibdata/title/title-main"))&.text
         set(:doctitle, main)
       end
 
       def subtitle(isoxml, _out)
-        main = isoxml&.at(ns("//bibdata/subtitle[@language='en']"))&.text
+        main = isoxml&.at(ns("//bibdata/title/title-sub"))&.text or return
         set(:docsubtitle, main)
       end
 
@@ -26,22 +27,25 @@ module IsoDoc
       end
 
       def docid(isoxml, _out)
-        docnumber_node = isoxml.at(ns("//bibdata/docidentifier"))
-        docnumber = docnumber_node&.text
+        docid = isoxml.at(ns("//bibdata/docidentifier[@type = 'nist']"))&.text
+        docid_long = isoxml.at(ns("//bibdata/docidentifier"\
+                                  "[@type = 'nist-long']"))&.text
+        docnumber = isoxml.at(ns("//bibdata/docnumber"))&.text
+        set(:docidentifier, docid)
+        set(:docidentifier_long, draft_prefix(docid_long, isoxml))
         set(:docnumber, docnumber)
-        # TODO: for NIST SPs only!!!
-        docnumber and set(:docnumber_long, 
-                          docnumber.gsub("NIST SP", "NIST Special Publication"))
       end
 
-      def status_abbr(status)
-        case status
-        when "working-draft" then "wd"
-        when "committee-draft" then "cd"
-        when "draft-standard" then "d"
-        else
-          ""
-        end
+      def draft_prefix(docidentifier_long, isoxml)
+        return nil if docidentifier_long.nil?
+        docstatus = isoxml.at(ns("//bibdata/status/stage"))&.text
+        return docidentifier_long unless docstatus && docstatus != "final"
+        iter = isoxml.at(ns("//bibdata/status/iteration"))&.text
+        prefix = "DRAFT "
+        /^\d+$/.match iter and
+          iter = iter.to_i.localize.to_rbnf_s("OrdinalRules", "digits-ordinal")
+        prefix += "(#{iter}) " if iter
+        prefix + docidentifier_long
       end
 
       def draftinfo(draft, revdate)
@@ -53,12 +57,38 @@ module IsoDoc
         IsoDoc::Function::I18n::l10n(draftinfo, @lang, @script)
       end
 
+      def docstatus(isoxml, _out)
+        docstatus = isoxml.at(ns("//bibdata/status/stage"))&.text
+        iter = isoxml.at(ns("//bibdata/status/iteration"))&.text
+        docstatus = adjust_docstatus(docstatus, iter)
+        set(:unpublished, docstatus != "final")
+        set(:iteration, iter) if iter
+        set(:status, status_print(docstatus || "final"))
+      end
+
+      def adjust_docstatus(status, iter)
+        return unless iter and status
+        status = "initial-public-draft" if status == "public-draft" &&
+          (iter == "1" ||  iter == "initial")
+        status = "final-public-draft" if status == "public-draft" &&
+          (iter == "final")
+        status
+      end
+
       def version(isoxml, _out)
         super
         revdate = get[:revdate]
         set(:revdate_monthyear, monthyr(revdate))
       end
 
+      def series(isoxml, _out)
+        series = isoxml.at(ns("//bibdata/series[@type = 'main']/title"))&.text
+        set(:series, series) if series
+        subseries = isoxml.at(ns("//bibdata/series[@type = 'secondary']/"\
+                                 "title"))&.text
+        set(:subseries, subseries) if subseries
+      end
+
       MONTHS = {
         "01": "January",
         "02": "February",
@@ -88,11 +118,22 @@ module IsoDoc
         set(:keywords, keywords)
       end
 
+      def commentperiod(isoxml, _out)
+        from = isoxml.at(ns("//bibdata/commentperiod/from"))&.text
+        to = isoxml.at(ns("//bibdata/commentperiod/to"))&.text
+        extended = isoxml.at(ns("//bibdata/commentperiod/extended"))&.text
+        set(:comment_from, from) if from
+        set(:comment_to, to) if to
+        set(:comment_extended, extended) if extended
+      end
+
       def url(xml, _out)
         super
         a = xml.at(ns("//bibdata/uri[@type = 'email']")) and set(:email, a.text)
+        a = xml.at(ns("//bibdata/uri[@type = 'doi']")) and set(:doi, a.text)
+        a = xml.at(ns("//bibdata/uri[@type = 'uri' or not(@type)]")) and
+          set(:url, a.text)
       end
-
     end
   end
 end

data/lib/isodoc/nist/pdf_convert.rb

@@ -10,8 +10,10 @@ module IsoDoc
       def initialize(options)
         @libdir = File.dirname(__FILE__)
         super
-              end
+      end
+
       def convert1(docxml, filename, dir)
+        @bibliographycount = docxml.xpath(ns("//bibliography/references | //annex/references | //bibliography/clause/references")).size
         FileUtils.cp html_doc_path('logo.png'), File.join(@localdir, "logo.png")
         FileUtils.cp html_doc_path('commerce-logo-color.png'), File.join(@localdir, "commerce-logo-color.png")
         @files_to_delete << File.join(@localdir, "logo.png")
@@ -305,7 +307,11 @@ module IsoDoc
         isoxml.xpath(ns("//bibliography/clause | //bibliography/references")).each do |f|
           out.div do |div|
             div.h1 **{ class: "Section3" } do |h1|
-              f&.at(ns("./title"))&.children.each { |n| parse(n, h1) }
+              if @bibliographycount == 1
+                h1 << "References"
+              else
+                f&.at(ns("./title"))&.children.each { |n| parse(n, h1) }
+              end
             end
             f.elements.reject do |e|
               ["reference", "title", "bibitem"].include? e.name
@@ -317,6 +323,8 @@ module IsoDoc
 
       def info(isoxml, out)
         @meta.keywords isoxml, out
+        @meta.series isoxml, out
+        @meta.commentperiod isoxml, out
         super
       end
 
@@ -349,7 +357,7 @@ module IsoDoc
         end
       end
 
-            def middle_section_asset_names(d)
+      def middle_section_asset_names(d)
         middle_sections =
           "//xmlns:preface/child::* | //xmlns:sections/child::*"
         sequential_asset_names(d.xpath(middle_sections))
@@ -449,7 +457,11 @@ module IsoDoc
         div.h1 **{ class: "Annex" } do |t|
           t << "#{get_anchors[annex['id']][:label]} &mdash; "
           t.b do |b|
-            name&.children&.each { |c2| parse(c2, b) }
+            if @bibliographycount == 1 && annex.at(ns("./references"))
+              b << "References"
+            else
+              name&.children&.each { |c2| parse(c2, b) }
+            end
           end
         end
       end
@@ -458,8 +470,69 @@ module IsoDoc
         "-"
       end
 
+      def annex_names(clause, num)
+        @anchors[clause["id"]] = { label: annex_name_lbl(clause, num), type: "clause",
+                                   xref: "#{@annex_lbl} #{num}", level: 1 }
+        clause.xpath(ns("./clause | ./terms | ./term | ./references")).each_with_index do |c, i|
+          annex_names1(c, "#{num}.#{i + 1}", 2)
+        end
+        hierarchical_asset_names(clause, num)
+      end
+
+      def annex_names1(clause, num, level)
+        @anchors[clause["id"]] = { label: num, xref: "#{@annex_lbl} #{num}",
+                                   level: level, type: "clause" }
+        clause.xpath(ns("./clause | ./terms | ./term | ./references")).each_with_index do |c, i|
+          annex_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
+      end
+
+      def terms_parse(node, out)
+        out.div **attr_code(id: node["id"]) do |div|
+          node.at(ns("./title")) and
+            clause_parse_title(node, div, node.at(ns("./title")), out)
+          term_defs_boilerplate(div, node.xpath(ns(".//termdocsource")),
+                                node.at(ns(".//term")), node.at(ns("./p")))
+          node.elements.each do |e|
+            parse(e, div) unless %w{title source}.include? e.name
+          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) }
+          end
+          set_termdomain("")
+          dl.dd do |dd|
+            node.children.each { |n| parse(n, dd) unless n.name == "preferred" }
+          end
+        end
+      end
 
+      def term_cleanup(docxml)
+        docxml.xpath("//dl[@class = 'terms_dl']").each do |d|
+          prev = d.previous_element
+          next unless prev.name == "dl" and prev["class"] == "terms_dl"
+          d.children.each { |n| prev.add_child(n.remove) }
+          d.remove
+        end
+        docxml
+      end
 
+      def bibliography_parse(node, out)
+        title = node&.at(ns("./title"))&.text || ""
+        out.div do |div|
+          node.parent.name == "annex" or
+            div.h2 title, **{ class: "Section3" }
+          node.elements.reject do |e|
+            ["reference", "title", "bibitem"].include? e.name
+          end.each { |e| parse(e, div) }
+          biblio_list(node, div, true)
+        end
+      end
     end
   end
 end