metanorma-nist 1.1.2 → 1.2.3

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>

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/_coverpage.css

@@ -0,0 +1,243 @@
+.coverpage-maturity, .coverpage-stage {
+  font-family: 'Source Sans Pro', sans-serif;
+  font-weight: 400;
+  font-size: 1em;
+  margin: 0 0 2em 0;
+  text-transform: uppercase; }
+
+.coverpage-maturity {
+  font-family: {{bodyfont}};
+  font-weight: 400;
+  font-size: 1em;
+  margin: 0 0 2em 0;
+  text-transform: uppercase; }
+
+.coverpage-warning {
+  border: #f36f36 solid 2px;
+  color: #f36f36 !important;
+  margin: 50px 100px;
+  color: #2e81c2;
+  padding: 10px;
+  border-radius: 25px;
+  text-align: center;
+  font-size: 14px; }
+  .coverpage-warning p {
+    margin: 0;
+    line-height: 1.6; }
+  .coverpage-warning .title, .coverpage-warning .authority6 h1, .coverpage-warning .authority6 h2 {
+    margin-top: 0em;
+    font-family: 'Source Sans Pro', sans-serif;
+    font-weight: 300;
+    text-transform: uppercase;
+    font-size: 1.2em; }
+
+.logo-wrapper {
+  margin-left: 3em;
+  margin-top: 100px;
+  margin-bottom: 100px;
+  float: right; }
+
+img#NIST-logo {
+  width: 300px;
+  height: auto;
+  padding-top: 3m;
+  margin-right: 50px; }
+
+.logo-info {
+  margin-left: 3em;
+  margin-bottom: 1.5em; }
+
+.logo-info p {
+  margin: 0; }
+
+#commerce-logo {
+  width: 150px;
+  height: auto; }
+
+.authors-container, .currency {
+  margin-top: 2em; }
+
+.affiliation {
+  font-style: italic;
+  margin-bottom: 1em; }
+
+.main-section {
+  word-wrap: break-word; }
+
+.coverpage-title {
+  font-family: {{headerfont}}; }
+  .coverpage-title span {
+    font-family: {{headerfont}};
+    font-size: 1.1em;
+    line-height: 1; }
+
+.wrapper-top {
+  background: #fff;
+  color: #141115;
+  padding: 7em 0;
+  margin-left: 3em; }
+
+.doc-number {
+  font-size: 20px;
+  font-family: {{bodyfont}};
+  line-height: 1.6;
+  margin: 1.5em 0; }
+
+.title-second {
+  font-style: italic;
+  font-size: 15px;
+  line-height: 1.6;
+  margin-bottom: 1.5em; }
+
+.download-info {
+  margin-top: 2em; }
+
+.category {
+  color: #2677ea;
+  margin-top: 4em;
+  margin-right: 2em;
+  padding: 0.7em 1em;
+  text-align: center;
+  border-top: solid 1px #2677ea;
+  border-bottom: solid 1px #2677ea;
+  text-transform: uppercase; }
+
+.banner {
+  border-top: 1px solid #2677ea;
+  border-bottom: 1px solid #2677ea;
+  margin-right: 50px;
+  margin-top: 100px; }
+  #inactive-draft.banner {
+    display: none; }
+  .banner p {
+    text-transform: uppercase;
+    font-weight: 300;
+    font-size: 16px;
+    letter-spacing: 5px;
+    text-align: center;
+    color: #2677ea;
+    font-family: {{monospacefont}}; }
+
+.WordSection11 {
+  padding: 0 2em 0 3em; }
+
+.info-section {
+  padding: 0; }
+
+.prefatory-section {
+  padding: 0 3em 0 6em; }
+
+.zzSTDTitle1, .MsoCommentText {
+  display: none; }
+
+.coverpage {
+  text-align: left;
+  padding-left: 1.5em; }
+
+.coverpage-logo span, .coverpage-tc-name span {
+  font-family: {{bodyfont}};
+  text-transform: none;
+  font-weight: 300; }
+
+.coverpage-logo span {
+  display: block;
+  float: left; }
+
+.coverpage-tc-name {
+  font-size: 1.2em;
+  line-height: 1.2em;
+  margin: 0.25em 0; }
+
+.coverpage-doc-identity {
+  font-size: 2em;
+  line-height: 1.5em;
+  margin-bottom: 150px; }
+
+.coverpage-stage-block {
+  font-family: 'Source Sans Pro', sans-serif;
+  font-weight: 600;
+  font-size: 1.25em;
+  margin: 2em 0em 2em 0em;
+  text-transform: uppercase; }
+
+.copyright {
+  padding: 1em;
+  font-size: 0.9em;
+  text-align: left; }
+
+table.coverpage-table {
+  max-width: 500px;
+  font-size: 14px; }
+
+.more-info {
+  margin-right: 50px; }
+  .more-info h2 {
+    text-align: center;
+    color: #2e81c2;
+    font-size: 20px;
+    font-family: 'Source Sans Pro', sans-serif;
+    font-weight: 300;
+    text-transform: uppercase; }
+  .more-info p {
+    font-size: 14px; }
+
+.contact-info, .authority5 {
+  padding: 2em;
+  margin-top: 5em;
+  text-align: left;
+  color: #2677ea !important;
+  background-color: #f1f8ff;
+  border-radius: 25px; }
+  .contact-info a, .contact-info a:hover, .authority5 a, .authority5 a:hover {
+    color: #2677ea; }
+
+.authority5 h2 {
+  text-align: center; }
+
+.authority3 {
+  border: solid;
+  padding: 1em; }
+
+.contact-info {
+  width: 280px; }
+  .contact-info a:hover {
+    text-decoration: underline;
+    background: none;
+    box-shadow: 0 0 0 0; }
+  .contact-info p, .contact-info a {
+    font-family: {{monospacefont}};
+    font-variant-ligatures: none;
+    font-weight: 400; }
+  .contact-info .name {
+    font-weight: 700;
+    font-size: 14px;
+    margin-bottom: 5px; }
+  .contact-info .address {
+    font-size: 12px;
+    line-height: 1.3em;
+    margin-top: 0; }
+
+.draft-state-container {
+  margin-bottom: 30px;
+  margin-top: -30px; }
+
+.draft-state {
+  font-size: 20px;
+  color: #f36f36; }
+  #inactive-draft.draft-state {
+    color: #7e0d13; }
+  #inactive-final.draft-state {
+    color: #750697; }
+
+.draft-description {
+  font-size: 14px; }
+  .draft-description p {
+    margin-top: 10px;
+    margin-bottom: 0; }
+
+#retired-draft {
+  color: #7e0d13; }
+
+@media print {
+  .coverpage {
+    height: 23cm; } }