metanorma-nist 1.2.5 → 1.2.10

data/lib/asciidoctor/nist/front_id.rb

@@ -24,6 +24,9 @@ module Asciidoctor
         {
           id: dn0,
           series: node.attr("series"),
+          subseries: node.attr("series-title") || node.attr("series-abbrev"),
+          subseries_abbr: node.attr("series-abbrev"),
+          subseries_mr: node.attr("series-mrprefix") || node.attr("series-abbrev"),
           edition: node.attr("edition"),
           version: node.attr("version"),
           revision: node.attr("revision"),
@@ -52,8 +55,7 @@ module Asciidoctor
         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(args, true), **attr_code(type: "nist-long")
           xml.docidentifier add_id_parts_mr(args), **attr_code(type: "nist-mr")
         end
       end
@@ -67,10 +69,20 @@ module Asciidoctor
         IsoDoc::NIST::Metadata.new(nil, nil, @i18n).status_abbr(stage, iter)
       end
 
+      def id_series_name(args, type)
+        if args[:series] == "nist-csts"
+          return ret = case type
+                       when :long then args[:subseries] 
+                       when :short then args[:subseries_abbr]
+                       when :mr then args[:subseries_mr]
+                       end
+        end
+        type == :long ?
+          SERIES.dig(args[:series].to_sym) : SERIES_ABBR.dig(args[:series].to_sym)
+      end
+
       def add_id_parts(args, long)
-        args[:series] and series_name = long ?
-          SERIES.dig(args[:series].to_sym) :
-          SERIES_ABBR.dig(args[:series].to_sym)
+        args[:series] and series_name = id_series_name(args, (long ? :long : :short))
         dn = (series_name || "NIST #{args[:series]}")  + " " + args[:id]
         dn += " Volume #{args[:vol]}" if args[:vol]
         dn += "," if args[:vol] && args[:revision]
@@ -107,8 +119,7 @@ module Asciidoctor
 
       def add_id_parts_mr(args)
         ret = ["NIST"]
-        args[:series] and
-          ret << SERIES_ABBR&.dig(args[:series].to_sym)&.sub(/^NIST /, "")
+        args[:series] and ret << id_series_name(args, :mr)&.sub(/^NIST /, "")
         stage = status_abbr(args[:stage], nil) || ""
         stage += "[-#{args[:iter]}]" if args[:iter]
         ret << stage unless stage.empty?

data/lib/asciidoctor/nist/isodoc.rng

@@ -24,6 +24,14 @@
     <start>
       <ref name="standard-document"/>
     </start>
+    <define name="doctype">
+      <element name="doctype">
+        <optional>
+          <attribute name="abbreviation"/>
+        </optional>
+        <ref name="DocumentType"/>
+      </element>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -47,6 +55,13 @@
             <param name="pattern">\i\c*|\c+#\c+</param>
           </data>
         </attribute>
+        <optional>
+          <attribute name="to">
+            <data type="string">
+              <param name="pattern">\i\c*|\c+#\c+</param>
+            </data>
+          </attribute>
+        </optional>
         <optional>
           <attribute name="type">
             <ref name="ReferenceFormat"/>
@@ -141,6 +156,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -233,6 +253,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -751,6 +774,18 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="colgroup">
+    <element name="colgroup">
+      <oneOrMore>
+        <ref name="col"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="col">
+    <element name="col">
+      <attribute name="width"/>
+    </element>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -1164,49 +1199,7 @@
   </define>
   <define name="annex">
     <element name="annex">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="language"/>
-      </optional>
-      <optional>
-        <attribute name="script"/>
-      </optional>
-      <optional>
-        <attribute name="inline-header">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <attribute name="obligation">
-        <choice>
-          <value>normative</value>
-          <value>informative</value>
-        </choice>
-      </attribute>
-      <optional>
-        <ref name="section-title"/>
-      </optional>
-      <group>
-        <group>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
-        <zeroOrMore>
-          <choice>
-            <ref name="annex-subsection"/>
-            <ref name="terms"/>
-            <ref name="definitions"/>
-            <ref name="references"/>
-          </choice>
-        </zeroOrMore>
-      </group>
+      <ref name="Annex-Section"/>
     </element>
   </define>
   <define name="terms">

data/lib/asciidoctor/nist/nist.rng

@@ -43,6 +43,7 @@
           <choice>
             <ref name="clause"/>
             <ref name="errata_clause"/>
+            <ref name="acknowledgements"/>
           </choice>
         </zeroOrMore>
         <optional>

data/lib/asciidoctor/nist/validate.rb

@@ -48,18 +48,29 @@ module Asciidoctor
       end
 
       def series_validate(xmldoc)
-        series = xmldoc&.at("//bibdata/series/title")&.text or return
+        series = xmldoc&.at("//bibdata/series[@type = 'main']/title")&.text or return
+        recognised_series_validate(series)
+        subseries_validate(series, xmldoc)
+      end
+
+      def recognised_series_validate(series)
         found = false
         SERIES.each { |_, v| found = true if v == series }
-        found or
-          @log.add("Document Attributes", nil, 
-                   "#{series} is not a recognised series")
+        found or @log.add("Document Attributes", nil, "#{series} is not a recognised series")
+      end
+
+      def subseries_validate(series, xmldoc)
+        subseries = xmldoc&.at("//bibdata/series[@type = 'secondary']")
+        csts = series == "NIST Cybersecurity Technical Specification"
+        subseries && !csts and
+          @log.add("Document Attributes", nil, "Subseries are not permitted on the series #{series}")
+        !subseries && csts and
+          @log.add("Document Attributes", nil, "Subseries are required on the series #{series}")
       end
 
       def validate(doc)
         content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "nist.rng"))
+        schema_validate(formattedstr_strip(doc.dup), File.join(File.dirname(__FILE__), "nist.rng"))
       end
 
       def introduction_validate(doc)

data/lib/isodoc/nist/base_convert.rb

@@ -113,7 +113,7 @@ module IsoDoc
         end
       end
 
-      def middle_clause
+      def middle_clause(_docxml)
         "//clause[parent::sections] | //terms[parent::sections]"
       end
 
@@ -175,8 +175,7 @@ module IsoDoc
 
       def modification_parse(node, out)
         out << @i18n.modified
-        node.at(ns("./p[text()[normalize-space() != '']]")) and
-          out << " &mdash; "
+        node.at(ns("./p[text()[normalize-space() != '']]")) and out << " &mdash; "
         node.at(ns("./p")).children.each { |n| parse(n, out) }
       end
 

data/lib/isodoc/nist/fonts_manifest.yaml

@@ -0,0 +1,4 @@
+---
+Times New Roman:
+Arial:
+Courier New:

data/lib/isodoc/nist/html/header_cswp.html

@@ -65,8 +65,7 @@ href="../{{ filename }}.html">
 
 <p class=MsoHeaderCxSpFirst style='tab-stops:center 234.0pt right 468.0pt'><span
 lang=EN-US style='font-size:10.0pt;font-family:"Arial",sans-serif;font-variant:
-small-caps;color:#244061;mso-themecolor:accent1;mso-themeshade:128'>NIST
-Cybersecurity White Paper<span style='mso-tab-count:2'>                                                                           </span></span><!--[if supportFields]><span
+small-caps;color:#244061;mso-themecolor:accent1;mso-themeshade:128'>{{ series }}<span style='mso-tab-count:2'>                                                                           </span></span><!--[if supportFields]><span
 lang=EN-US style='font-size:10.0pt;font-family:"Arial",sans-serif;font-variant:
 small-caps;color:#244061;mso-themecolor:accent1;mso-themeshade:128'><span
 style='mso-element:field-begin'></span> DOCPROPERTY<span
@@ -199,7 +198,7 @@ _Hlk10701209'></span></a><w:Sdt SdtDocPart="t" DocPartType="Watermarks"
 style='mso-bookmark:_Hlk10701209'><span lang=EN-US style='font-size:10.0pt;
 font-family:"Arial",sans-serif;font-variant:small-caps;color:white;mso-themecolor:
 background1;background:#244061;mso-shading-themecolor:accent1;mso-shading-themeshade:
-128'>NIST Cybersecurity White Paper {% if draft_prefix %}(DRAFT){% endif %}</span></span></span><span
+128'>{{ series }} {% if draft_prefix %}(DRAFT){% endif %}</span></span></span><span
 style='mso-bookmark:_Hlk10701208'><span style='mso-bookmark:_Hlk10701209'><span
 class=MsoCommentReference><span lang=EN-US style='font-size:10.0pt;font-family:
 "Arial",sans-serif;font-variant:small-caps;color:white;mso-color-alt:windowtext'><span

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

@@ -104,6 +104,10 @@ b, strong {
 div.document-stage-band, div.document-type-band {
   background-color: #333333; }
 
+a.FootnoteRef + a.FootnoteRef:before {
+  content: ", ";
+  vertical-align: super; }
+
 #nist-sp-band {
   background-color: #d8eca8; }
 
@@ -176,223 +180,6 @@ div.document-stage-band, div.document-type-band {
 #withdrawn {
   border-bottom: solid 3px #7e0d13; }
 
-dl {
-  grid-template-columns: 25% 75%; }
-  dl.glossary dt {
-    font-weight: bold; }
-
-body {
-  margin-left: auto;
-  margin-right: auto;
-  max-width: 100%;
-  font-size: 14px;
-  font-weight: 400;
-  line-height: 1.6em;
-  color: #141115;
-  background-color: #fff; }
-  body main {
-    margin: 0 3em 0 6em; }
-
-.rule {
-  width: 100%;
-  height: 1px;
-  background-color: #2677ea;
-  margin: 2em 0; }
-
-.rule-2 {
-  width: 100%;
-  height: 1px;
-  background-color: #2677ea; }
-
-.rule-thick {
-  width: 100%;
-  height: 3px;
-  background-color: #2677ea;
-  margin: 3em 0 0 0; }
-
-#toc {
-  font-family: 'Source Sans Pro', sans-serif; }
-  #toc ul {
-    margin: 0;
-    padding: 0;
-    list-style: none; }
-    #toc ul li a {
-      padding: 5px 10px; }
-    #toc ul a {
-      color: #141115;
-      text-decoration: none;
-      display: block; }
-      #toc ul a:hover {
-        box-shadow: none;
-        color: white; }
-  #toc .h2 {
-    padding-left: 30px; }
-  #toc .h3 {
-    padding-left: 50px; }
-  #toc .toc-active, #toc li:hover {
-    background: #006494;
-    box-shadow: inset -5px 0px 10px -5px #006494 !important; }
-    #toc .toc-active a, #toc li:hover a {
-      color: white; }
-  @media print {
-    #toc .toc-active, #toc li:hover {
-      background: white;
-      box-shadow: none !important; }
-    #toc .toc-active a {
-      color: #141115; }
-    #toc li:hover a {
-      color: black; } }
-  #toc li a {
-    font-size: 14px; }
-  #toc li:before {
-    content: " ";
-    display: none; }
-
-@media screen and (min-width: 768px) {
-  nav {
-    position: fixed;
-    top: 0;
-    bottom: 0;
-    left: 0;
-    width: 323px;
-    font-size: 0.9em;
-    overflow: auto;
-    padding: 0 0 0 45px;
-    background-color: white; } }
-
-@media print {
-  nav {
-    position: relative;
-    width: auto;
-    font-size: 0.9em;
-    overflow: auto;
-    padding: 0;
-    margin-right: 0;
-    background-color: white; } }
-
-nav #toc {
-  font-family: {{bodyfont}};
-  font-weight: 400; }
-  @media screen and (max-width: 768px) {
-    nav #toc {
-      padding: 0 1.5em;
-      overflow: visible; } }
-@media screen and (min-width: 768px) {
-  #toggle {
-    position: fixed;
-    height: 100%;
-    width: 30px;
-    background-color: #006494;
-    color: white !important;
-    cursor: pointer;
-    z-index: 100; }
-    #toggle span {
-      text-align: center;
-      width: 100%;
-      position: absolute;
-      top: 50%;
-      transform: translate(0, -50%); } }
-
-@media screen and (max-width: 768px) {
-  #toggle {
-    display: none; } }
-
-@media print {
-  #toggle {
-    display: none; } }
-
-@media screen and (min-width: 768px) {
-  .container {
-    padding-left: 360px; } }
-
-@media print {
-  .container {
-    padding-left: 0; } }
-
-@media screen and (min-width: 768px) {
-  .rule.toc {
-    display: none; } }
-
-span.nistvariable {
-  font-family: {{bodyfont}};
-  font-style: italic; }
-
-/* Document bands */
-.document-stage-band {
-  left: 0;
-  top: 0;
-  height: 100%;
-  position: fixed;
-  display: block;
-  z-index: 101;
-  box-shadow: -5px 0px 10px #1d1d1d; }
-  .document-stage-band > :first-child {
-    position: relative;
-    width: 25px;
-    font-family: 'Source Sans Pro', sans-serif;
-    font-weight: 300;
-    height: 160px;
-    color: #7ba812;
-    text-transform: uppercase;
-    font-size: 0.9em;
-    font-weight: 400;
-    letter-spacing: 0.05em;
-    margin: 0;
-    margin-left: 6px;
-    writing-mode: tb-rl;
-    -webkit-transform: rotate(180deg);
-    -moz-transform: rotate(180deg);
-    -o-transform: rotate(180deg);
-    white-space: nowrap;
-    display: block;
-    bottom: 0; }
-  @media print {
-    .document-stage-band {
-      display: none; } }
-.document-type-band {
-  left: 0;
-  top: 180px;
-  height: 100%;
-  position: fixed;
-  display: block;
-  z-index: 102; }
-  .document-type-band > :first-child {
-    position: relative;
-    width: 25px;
-    font-family: 'Source Sans Pro', sans-serif;
-    font-weight: 400;
-    color: #7ba812;
-    text-transform: uppercase;
-    font-size: 0.9em;
-    font-weight: 400;
-    letter-spacing: 0.05em;
-    margin: 0;
-    margin-left: 6px;
-    writing-mode: tb-rl;
-    -webkit-transform: rotate(180deg);
-    -moz-transform: rotate(180deg);
-    -o-transform: rotate(180deg);
-    white-space: nowrap;
-    display: block;
-    bottom: 0; }
-  @media print {
-    .document-type-band {
-      display: none; } }
-  .document-type-band .document-type {
-    top: 20px; }
-
-#governance-band p.document-type {
-  height: 230px !important; }
-
-#standard-band p {
-  height: 270px !important; }
-
-#proposal-band p {
-  height: 150px !important; }
-
-#standard, #final {
-  color: #9ABD48; }
-
 .coverpage-maturity, .coverpage-stage {
   font-family: 'Source Sans Pro', sans-serif;
   font-weight: 400;
@@ -637,6 +424,223 @@ table.coverpage-table {
   .coverpage {
     height: 23cm; } }
 
+dl {
+  grid-template-columns: 25% 75%; }
+  dl.glossary dt {
+    font-weight: bold; }
+
+body {
+  margin-left: auto;
+  margin-right: auto;
+  max-width: 100%;
+  font-size: {{normalfontsize}};
+  font-weight: 400;
+  line-height: 1.6em;
+  color: #141115;
+  background-color: #fff; }
+  body main {
+    margin: 0 3em 0 6em; }
+
+.rule {
+  width: 100%;
+  height: 1px;
+  background-color: #2677ea;
+  margin: 2em 0; }
+
+.rule-2 {
+  width: 100%;
+  height: 1px;
+  background-color: #2677ea; }
+
+.rule-thick {
+  width: 100%;
+  height: 3px;
+  background-color: #2677ea;
+  margin: 3em 0 0 0; }
+
+#toc {
+  font-family: 'Source Sans Pro', sans-serif; }
+  #toc ul {
+    margin: 0;
+    padding: 0;
+    list-style: none; }
+    #toc ul li a {
+      padding: 5px 10px; }
+    #toc ul a {
+      color: #141115;
+      text-decoration: none;
+      display: block; }
+      #toc ul a:hover {
+        box-shadow: none;
+        color: white; }
+  #toc .h2 {
+    padding-left: 30px; }
+  #toc .h3 {
+    padding-left: 50px; }
+  #toc .toc-active, #toc li:hover {
+    background: #006494;
+    box-shadow: inset -5px 0px 10px -5px #006494 !important; }
+    #toc .toc-active a, #toc li:hover a {
+      color: white; }
+  @media print {
+    #toc .toc-active, #toc li:hover {
+      background: white;
+      box-shadow: none !important; }
+    #toc .toc-active a {
+      color: #141115; }
+    #toc li:hover a {
+      color: black; } }
+  #toc li a {
+    font-size: {{normalfontsize}}; }
+  #toc li:before {
+    content: " ";
+    display: none; }
+
+@media screen and (min-width: 768px) {
+  nav {
+    position: fixed;
+    top: 0;
+    bottom: 0;
+    left: 0;
+    width: 323px;
+    font-size: 0.9em;
+    overflow: auto;
+    padding: 0 0 0 45px;
+    background-color: white; } }
+
+@media print {
+  nav {
+    position: relative;
+    width: auto;
+    font-size: 0.9em;
+    overflow: auto;
+    padding: 0;
+    margin-right: 0;
+    background-color: white; } }
+
+nav #toc {
+  font-family: {{bodyfont}};
+  font-weight: 400; }
+  @media screen and (max-width: 768px) {
+    nav #toc {
+      padding: 0 1.5em;
+      overflow: visible; } }
+@media screen and (min-width: 768px) {
+  #toggle {
+    position: fixed;
+    height: 100%;
+    width: 30px;
+    background-color: #006494;
+    color: white !important;
+    cursor: pointer;
+    z-index: 100; }
+    #toggle span {
+      text-align: center;
+      width: 100%;
+      position: absolute;
+      top: 50%;
+      transform: translate(0, -50%); } }
+
+@media screen and (max-width: 768px) {
+  #toggle {
+    display: none; } }
+
+@media print {
+  #toggle {
+    display: none; } }
+
+@media screen and (min-width: 768px) {
+  .container {
+    padding-left: 360px; } }
+
+@media print {
+  .container {
+    padding-left: 0; } }
+
+@media screen and (min-width: 768px) {
+  .rule.toc {
+    display: none; } }
+
+span.nistvariable {
+  font-family: {{bodyfont}};
+  font-style: italic; }
+
+/* Document bands */
+.document-stage-band {
+  left: 0;
+  top: 0;
+  height: 100%;
+  position: fixed;
+  display: block;
+  z-index: 101;
+  box-shadow: -5px 0px 10px #1d1d1d; }
+  .document-stage-band > :first-child {
+    position: relative;
+    width: 25px;
+    font-family: 'Source Sans Pro', sans-serif;
+    font-weight: 300;
+    height: 160px;
+    color: #7ba812;
+    text-transform: uppercase;
+    font-size: 0.9em;
+    font-weight: 400;
+    letter-spacing: 0.05em;
+    margin: 0;
+    margin-left: 6px;
+    writing-mode: tb-rl;
+    -webkit-transform: rotate(180deg);
+    -moz-transform: rotate(180deg);
+    -o-transform: rotate(180deg);
+    white-space: nowrap;
+    display: block;
+    bottom: 0; }
+  @media print {
+    .document-stage-band {
+      display: none; } }
+.document-type-band {
+  left: 0;
+  top: 180px;
+  height: 100%;
+  position: fixed;
+  display: block;
+  z-index: 102; }
+  .document-type-band > :first-child {
+    position: relative;
+    width: 25px;
+    font-family: 'Source Sans Pro', sans-serif;
+    font-weight: 400;
+    color: #7ba812;
+    text-transform: uppercase;
+    font-size: 0.9em;
+    font-weight: 400;
+    letter-spacing: 0.05em;
+    margin: 0;
+    margin-left: 6px;
+    writing-mode: tb-rl;
+    -webkit-transform: rotate(180deg);
+    -moz-transform: rotate(180deg);
+    -o-transform: rotate(180deg);
+    white-space: nowrap;
+    display: block;
+    bottom: 0; }
+  @media print {
+    .document-type-band {
+      display: none; } }
+  .document-type-band .document-type {
+    top: 20px; }
+
+#governance-band p.document-type {
+  height: 230px !important; }
+
+#standard-band p {
+  height: 270px !important; }
+
+#proposal-band p {
+  height: 150px !important; }
+
+#standard, #final {
+  color: #9ABD48; }
+
 .recommend {
   background-color: #ccffcc;
   padding: 1.2em;
@@ -735,7 +739,7 @@ p.Biblio, p.NormRef {
   overflow: auto;
   font-family: {{monospacefont}};
   font-variant-ligatures: none;
-  font-size: 0.8em;
+  font-size: {{monospacefontsize}};
   background-color: #f6f6f6; }
   .figure .FigureTitle, .figure .figure-title {
     font-weight: 700;
@@ -757,7 +761,7 @@ pre {
   font-family: {{monospacefont}};
   font-variant-ligatures: none;
   background-color: #f6f6f6;
-  font-size: 0.8em;
+  font-size: {{monospacefontsize}};
   line-height: 1.6em;
   padding: 1.5em;
   margin: 2em 0 1em 0;
@@ -766,7 +770,7 @@ pre {
 
 .pseudocode {
   background-color: #f6f6f6;
-  font-size: 0.8em;
+  font-size: {{monospacefontsize}};
   line-height: 1.6em;
   padding: 1.5em;
   margin: 2em 0 1em 0;
@@ -875,7 +879,7 @@ a.footnote-number {
   font-size: 0.8em; }
 
 .footnote {
-  font-size: 0.9em; }
+  font-size: {{footnotefontsize}}; }
 
 /* Keywords */
 span.keyword {