metanorma-nist 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 553e8bf36b10720beecc7e76b0bf8cc2141ea7dfa18b9389adb2355521df72cb
-  data.tar.gz: 4d050660b0d6954dd58bbee575fd62374bcdb2c931b9cce5f4271f30a79a6ecb
+  metadata.gz: 7e2116c19f5daea959497e608d2a19599645a3b827aa4d50f218e8bcc873ff6a
+  data.tar.gz: 47edb544f7e6379637bc9165c5c9b920cb3221c4f16407161edc531661bb8867
 SHA512:
-  metadata.gz: 84ae66bfe9a43d1e79f65c9532116c73eec1a562020e206ce05883391e049dc46fe44a73f60d1ab66396eac6406065d5c36cc84a51b0c927f30b885c33aeee24
-  data.tar.gz: e7bf0c5bc1e70fab341d8c98f0cef3194e3795bae8c705b38bec555822a670b6a4c5682e4663dfbcc8663969b7bc7fe307856f97ba5e9274e261e2893464ce2c
+  metadata.gz: e607121469a2d8d3c96579459a4ab6266a0a2f53dfcbe0bf0c2c35dfe53edf62501d44ba9b124e4c757dfbf940fdfba03cbc91b8ef2dec28509530f524bc2d34
+  data.tar.gz: 885616b6cc0281fa7f06c97c70e7859631ee5857a7543f0c8fa4d9142d3a0406eea165a461e44b6ebf6a06f21b4056652f9f5802ff61c03970ed6d00f745709e

data/.travis.yml

@@ -1,3 +1,5 @@
+# Auto-generated !!! Do not edit it manually
+# use ci-master https://github.com/metanorma/metanorma-build-scripts
 language: ruby
 cache: bundler
 os:
@@ -6,11 +8,11 @@ os:
 rvm:
 - 2.5
 - 2.4
-- 2.3
 - ruby-head
-before_install:
+before_install: 
 - nvm install 8
 - npm install -g puppeteer
+- npm install
 - gem install bundler -v 2.0.1
 - bundle update
 matrix:

data/README.adoc

@@ -150,9 +150,6 @@ as the document identifier is composed from the document series, document number
 and edition/revision (e.g. _NIST SP 800 Revision 1_).
 If the `:docidentifier:` value is provided, it will override this composed value.
 
-`:edition:`:: Edition (revision) of the document. The value of
-this attribute will be displayed as part of the heading, prefixed with "Revision".
-
 `:status:`:: Document status/stage. The permitted types are:
 +
 --
@@ -160,6 +157,7 @@ this attribute will be displayed as part of the heading, prefixed with "Revision
 * `draft-wip`
 * `draft-prelim`
 * `draft-public`
+* `draft-approval`
 * `final` (default: document is published)
 * `final-review`
 --
@@ -233,7 +231,8 @@ Added to authority statement as document contact. Use line breaks (in Asciidocto
 ` + \`) if necessary. Default value is
 "100 Bureau Drive (Mail Stop 8930) Gaithersburg, MD 20899-8930"
 
-`:revision:`:: The document revision; e.g. `1` (Revision 1).
+`:revision:`:: The document revision; e.g. `1` (Revision 1). Will be stored in Metanorma XML
+under the `<edition>` tag, with the prefix `Revision `.
 
 `:volume:`::
 The number of the volume of a standard. Is ignored if a precomposed
@@ -626,10 +625,10 @@ using `:status:`, `:substage:`, `:iteration:`, and `:confirmed-date`.
 | ISO stage | NIST | 93 Repeat current phase | 98 Abandon | 99 Proceed
 
 | 00 Preliminary | `:status: draft-internal` | | (stop work) | `:status: draft-wip`, `:status: draft-public`, or `:status: final` (amend)
-| 10 Proposal | `:status: draft-wip` | | `:status: draft-wip`, `:substage: retired` | `:status: draft-wip`, `:substage: withdrawn`
-| 20 Preparatory | `status: draft-prelim` | | `status: draft-prelim`, `substage: retired` | `status: draft-prelim`, `substage: withdrawn`
-| 40 Enquiry | `status: draft-public` | `status: draft-public`, `:iteration: 2`, `:iteration: 3` ... `:iteration: final` | `:status: draft-public`, `:substage: retired` | `:status: draft-public`, `:substage: withdrawn`
-| 50 Approval | (NIST ERB review) | | `:status: draft-public`, `:substage: retired` | `:status: final`
+| 10 Proposal | `:status: draft-wip` | | `:status: draft-wip`, `:substage: retired` | `:status: draft-wip`, `:substage: withdrawn` or `status: draft-prelim`
+| 20 Preparatory | `status: draft-prelim` | | `status: draft-prelim`, `substage: retired` | `status: draft-prelim`, `substage: withdrawn` or `status: draft-public`
+| 40 Enquiry | `status: draft-public` | `status: draft-public`, `:iteration: 2`, `:iteration: 3` ... `:iteration: final` | `:status: draft-public`, `:substage: retired` | `:status: draft-public`, `:substage: withdrawn`  or `draft-approval`
+| 50 Approval | `status: draft-approval` | | `:status: draft-approval`, `:substage: retired` | `:status: final`
 | 60 Publication | `:status: final`
 | 90 Review | `:status: final-review` | `:status: final`, `:confirmed-date: XXXX-XX-XX` | `:status: final`, `:substage: withdrawn` | `:status: draft-internal` (revise or amend)
 | 95 Withdrawal | `:status: final`, `:substage: withdrawn` | | |

data/appveyor.yml

@@ -1,10 +1,14 @@
+# Auto-generated !!! Do not edit it manually
+# use ci-master https://github.com/metanorma/metanorma-build-scripts
 version: '{build}'
 
+cache:
+  - vendor/bundle
+
 environment:
   matrix:
     - RUBY_VERSION: 25
     - RUBY_VERSION: 24
-    - RUBY_VERSION: 23
     - RUBY_VERSION: _trunk
 
 matrix:
@@ -17,6 +21,8 @@ install:
 
 build_script:
   - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - set GIT_TERMINAL_PROMPT=0
+  - bundle config --local path vendor/bundle
   - bundle update
   - bundle install
 
@@ -27,4 +33,3 @@ before_test:
 
 test_script:
   - bundle exec rake
-

data/lib/asciidoctor/nist/biblio.rng

@@ -544,9 +544,9 @@
     <zeroOrMore>
       <ref name="script"/>
     </zeroOrMore>
-    <optional>
+    <zeroOrMore>
       <ref name="abstract"/>
-    </optional>
+    </zeroOrMore>
     <optional>
       <ref name="status"/>
     </optional>

data/lib/asciidoctor/nist/cleanup.rb

@@ -33,6 +33,11 @@ module Asciidoctor
       end
 
       def move_clauses_into_preface(x, preface)
+        move_clauses_into_preface1(x, preface)
+        move_execsummary_into_preface(x, preface)
+      end
+
+       def move_clauses_into_preface1(x, preface)
         x.xpath("//clause[@preface]").each do |c|
           c.delete("preface")
           title = c&.at("./title")&.text.downcase
@@ -40,6 +45,9 @@ module Asciidoctor
           c.name = "executivesummary" if title == "executive summary"
           preface.add_child c.remove
         end
+       end
+
+       def move_execsummary_into_preface(x, preface)
         x.xpath("//clause[@executivesummary]").each do |c|
           c.delete("executivesummary")
           title = c&.at("./title")&.text.downcase

data/lib/asciidoctor/nist/front.rb

@@ -16,7 +16,7 @@ module Asciidoctor
 
       def metadata_version(node, xml)
         xml.edition node.attr("edition") if node.attr("edition")
-        xml.revision node.attr("revision") if node.attr("revision")
+        xml.edition "Revision #{node.attr("revision")}" if node.attr("revision")
         xml.version do |v|
           v.revision_date node.attr("revdate") if node.attr("revdate")
           v.draft node.attr("draft") if node.attr("draft")
@@ -64,7 +64,7 @@ module Asciidoctor
         did = node.attr("docidentifier")
         dn = node.attr("docnumber")
         if did
-          xml.docidentifier did, **attr_code(type: "nist")
+          xml.docidentifier did, **attr_code(type: "NIST")
           xml.docidentifier unabbreviate(did), **attr_code(type: "nist-long")
         else
           metadata_id_compose(node, xml, dn)
@@ -95,7 +95,7 @@ module Asciidoctor
       def metadata_id_compose(node, xml, dn0)
         return unless dn0
         args = id_args(node, dn0)
-        xml.docidentifier add_id_parts(args, false), **attr_code(type: "nist")
+        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_mr(args), **attr_code(type: "nist-mr")
@@ -236,12 +236,7 @@ module Asciidoctor
               b.uri doi, **{ type: "doi" }
             url = node.attr("superseding-url") and
               b.uri url, **{ type: "uri" }
-            did = xml&.parent&.at("./ancestor::bibdata/docidentifier"\
-                                  "[@type = 'nist']")&.text
-            didl = xml&.parent&.at("./ancestor::bibdata/docidentifier"\
-                                   "[@type = 'nist-long']")&.text
-            b.docidentifier did, **{ type: "nist" }
-            b.docidentifier didl, **{ type: "nist-long" }
+            metadata_superseding_ids(b, xml)
             metadata_superseding_authors(b, node)
             metadata_superseding_dates(b, node)
             b.status do |s|
@@ -253,6 +248,15 @@ module Asciidoctor
         end
       end
 
+      def metadata_superseding_ids(b, xml)
+        did = xml&.parent&.at("./ancestor::bibdata/docidentifier"\
+                              "[@type = 'NIST']")&.text
+        didl = xml&.parent&.at("./ancestor::bibdata/docidentifier"\
+                               "[@type = 'nist-long']")&.text
+        b.docidentifier did, **{ type: "NIST" }
+        b.docidentifier didl, **{ type: "nist-long" }
+      end
+
       def metadata_superseding_dates(b, node)
         cdate = node.attr("superseding-circulated-date") and
           b.date **{ type: "circulated" } do |d|
@@ -302,9 +306,9 @@ module Asciidoctor
           xml.note note, **{ type: "withdrawal-announcement-link" }
       end
 
-      def metadata(node, xml)
-        super
-        metadata_series(node, xml)
+      def metadata_ext(node, xml)
+        metadata_doctype(node, xml)
+        metadata_committee(node, xml)
         metadata_keywords(node, xml)
         metadata_commentperiod(node, xml)
       end

data/lib/asciidoctor/nist/isodoc.rng

@@ -471,6 +471,11 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
+      <optional>
+        <attribute name="unnumbered">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <ref name="stem"/>
       <optional>
         <ref name="dl"/>
@@ -519,6 +524,11 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
+      <optional>
+        <attribute name="unnumbered">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <attribute name="lang"/>
       </optional>
@@ -558,6 +568,11 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
+      <optional>
+        <attribute name="unnumbered">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <attribute name="alt"/>
       </optional>
@@ -675,6 +690,11 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
+      <optional>
+        <attribute name="unnumbered">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <oneOrMore>
         <choice>
           <ref name="formula"/>
@@ -718,6 +738,11 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
+      <optional>
+        <attribute name="unnumbered">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <ref name="source"/>
       </optional>
@@ -1080,57 +1105,28 @@
       </zeroOrMore>
     </element>
   </define>
-  <define name="BibData">
-    <optional>
-      <attribute name="type">
-        <ref name="BibItemType"/>
-      </attribute>
-    </optional>
-    <oneOrMore>
-      <ref name="btitle"/>
-    </oneOrMore>
-    <optional>
-      <ref name="formattedref"/>
-    </optional>
-    <zeroOrMore>
-      <ref name="bsource"/>
-    </zeroOrMore>
-    <zeroOrMore>
-      <ref name="docidentifier"/>
-    </zeroOrMore>
-    <optional>
-      <ref name="docnumber"/>
-    </optional>
-    <zeroOrMore>
-      <ref name="bdate"/>
-    </zeroOrMore>
-    <zeroOrMore>
-      <ref name="contributor"/>
-    </zeroOrMore>
-    <optional>
-      <ref name="edition"/>
-    </optional>
-    <optional>
-      <ref name="version"/>
-    </optional>
-    <zeroOrMore>
-      <ref name="biblionote"/>
-    </zeroOrMore>
-    <zeroOrMore>
-      <ref name="language"/>
-    </zeroOrMore>
-    <zeroOrMore>
-      <ref name="script"/>
-    </zeroOrMore>
+  <define name="ext">
+    <element name="ext">
+      <ref name="BibDataExtensionType"/>
+    </element>
+  </define>
+  <define name="BibDataExtensionType">
     <optional>
-      <ref name="abstract"/>
+      <ref name="doctype"/>
     </optional>
+  </define>
+  <define name="doctype">
+    <element name="doctype">
+      <ref name="DocumentType"/>
+    </element>
+  </define>
+  <define name="DocumentType">
+    <value>document</value>
+  </define>
+  <define name="BibData">
+    <ref name="BibliographicItem"/>
     <optional>
-      <ref name="status"/>
+      <ref name="ext"/>
     </optional>
-    <ref name="copyright"/>
-    <zeroOrMore>
-      <ref name="docrelation"/>
-    </zeroOrMore>
   </define>
 </grammar>

data/lib/asciidoctor/nist/isostandard.rng

@@ -4,28 +4,6 @@
     <start>
       <ref name="iso-standard"/>
     </start>
-    <define name="script">
-      <element name="script">
-        <value>Latn</value>
-      </element>
-    </define>
-    <!-- add type to docidentifier in isodoc? -->
-    <define name="docidentifier">
-      <element name="docidentifier">
-        <optional>
-          <attribute name="type"/>
-        </optional>
-        <choice>
-          <text/>
-          <group>
-            <ref name="documentnumber"/>
-            <optional>
-              <ref name="tc-documentnumber"/>
-            </optional>
-          </group>
-        </choice>
-      </element>
-    </define>
     <define name="organization">
       <element name="organization">
         <ref name="orgname"/>
@@ -55,190 +33,24 @@
         </optional>
       </element>
     </define>
-    <define name="BibliographicItem">
-      <optional>
-        <attribute name="type">
-          <ref name="BibItemType"/>
-        </attribute>
-      </optional>
-      <optional>
-        <ref name="fetched"/>
-      </optional>
-      <choice>
-        <oneOrMore>
-          <ref name="btitle"/>
-        </oneOrMore>
-        <ref name="formattedref"/>
-      </choice>
-      <zeroOrMore>
-        <ref name="bsource"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="docidentifier"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="docnumber"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="bdate"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="contributor"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="edition"/>
-      </optional>
-      <optional>
-        <ref name="version"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="biblionote"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="language"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="script"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="abstract"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="status"/>
-      </optional>
-      <optional>
-        <ref name="copyright"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="docrelation"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="series"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="medium"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="bplace"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="extent"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="accesslocation"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="bclassification"/>
-      </optional>
-      <optional>
-        <ref name="validity"/>
-      </optional>
-      <optional>
-        <ref name="editorialgroup"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="ics"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="allParts"/>
-      </optional>
-    </define>
-    <define name="BibData">
-      <optional>
-        <attribute name="type">
-          <ref name="BibItemType"/>
-        </attribute>
-      </optional>
-      <oneOrMore>
-        <ref name="btitle"/>
-      </oneOrMore>
+    <define name="BibDataExtensionType">
       <optional>
-        <ref name="formattedref"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="bsource"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="docidentifier"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="docnumber"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="bdate"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="contributor"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="edition"/>
-      </optional>
-      <optional>
-        <ref name="version"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="biblionote"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="language"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="script"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="abstract"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="status"/>
-      </optional>
-      <ref name="copyright"/>
-      <zeroOrMore>
-        <ref name="docrelation"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="series"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="medium"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="bplace"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="extent"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="accesslocation"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="bclassification"/>
-      </optional>
-      <optional>
-        <ref name="validity"/>
+        <ref name="doctype"/>
       </optional>
       <ref name="editorialgroup"/>
       <zeroOrMore>
         <ref name="ics"/>
       </zeroOrMore>
-      <optional>
-        <ref name="allParts"/>
-      </optional>
+      <ref name="structuredidentifier"/>
     </define>
     <define name="bdate">
       <element name="date">
         <attribute name="type">
           <choice>
-            <value>published</value>
-            <value>accessed</value>
-            <value>created</value>
-            <value>implemented</value>
-            <value>obsoleted</value>
-            <value>confirmed</value>
-            <value>updated</value>
-            <value>issued</value>
+            <ref name="BibliographicDateType"/>
+            <text/>
           </choice>
         </attribute>
-        <!-- ( ( bfrom, bto? ) | date_on ) -->
         <choice>
           <group>
             <element name="from">
@@ -259,31 +71,6 @@
         </choice>
       </element>
     </define>
-    <define name="biblionote">
-      <element name="note">
-        <optional>
-          <!-- Biblio date notes can be footnoted -->
-          <attribute name="reference"/>
-        </optional>
-        <ref name="FormattedString"/>
-      </element>
-    </define>
-    <define name="btitle">
-      <element name="title">
-        <choice>
-          <ref name="FormattedString"/>
-          <group>
-            <optional>
-              <ref name="title-intro"/>
-            </optional>
-            <ref name="title-main"/>
-            <optional>
-              <ref name="title-part"/>
-            </optional>
-          </group>
-        </choice>
-      </element>
-    </define>
     <define name="sections">
       <element name="sections">
         <ref name="clause"/>
@@ -728,6 +515,16 @@
         </optional>
       </element>
     </define>
+    <define name="DocumentType">
+      <choice>
+        <value>international-standard</value>
+        <value>technical-specification</value>
+        <value>technical-report</value>
+        <value>publicly-available-specification</value>
+        <value>international-workshop-agreement</value>
+        <value>guide</value>
+      </choice>
+    </define>
   </include>
   <!-- end overrides -->
   <!--
@@ -763,16 +560,6 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="BibItemType" combine="choice">
-    <choice>
-      <value>international-standard</value>
-      <value>technical-specification</value>
-      <value>technical-report</value>
-      <value>publicly-available-specification</value>
-      <value>international-workshop-agreement</value>
-      <value>guide</value>
-    </choice>
-  </define>
   <define name="editorialgroup">
     <element name="editorialgroup">
       <oneOrMore>
@@ -804,6 +591,19 @@
       <ref name="Content-Section"/>
     </element>
   </define>
+  <define name="structuredidentifier">
+    <element name="structuredidentifier">
+      <optional>
+        <attribute name="type"/>
+      </optional>
+      <group>
+        <ref name="documentnumber"/>
+        <optional>
+          <ref name="tc-documentnumber"/>
+        </optional>
+      </group>
+    </element>
+  </define>
   <define name="documentnumber">
     <element name="project-number">
       <optional>
@@ -855,26 +655,6 @@
       <text/>
     </element>
   </define>
-  <define name="title-intro">
-    <element name="title-intro">
-      <ref name="FormattedString"/>
-    </element>
-  </define>
-  <define name="title-main">
-    <element name="title-main">
-      <ref name="FormattedString"/>
-    </element>
-  </define>
-  <define name="title-part">
-    <element name="title-part">
-      <ref name="FormattedString"/>
-    </element>
-  </define>
-  <define name="allParts">
-    <element name="allparts">
-      <data type="boolean"/>
-    </element>
-  </define>
   <define name="clause-hanging-paragraph-with-footnote">
     <element name="clause">
       <optional>