metanorma-rsd 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d60eb313f103724a556fa4331f0db19cb618c9c40082061719250d56c8d2d71d
-  data.tar.gz: 118f978072f0d8b5fbee281e7196c7ce4a2b18f32e506c16d054a1d500cf4ebc
+  metadata.gz: 1d283e879af320fbad1196dcbeb2e0ae38e43e8bfeda40e717ee706e299c70b6
+  data.tar.gz: 5e9262876f2f6cff2d7073328ff53963a15aa1f302968e3084af87d7a0d7ec9a
 SHA512:
-  metadata.gz: 8c6099b91c7360b4b59e9bd7524b1161d1e28b61310671c33dba4d51539e3ceaad9baf66e923ca5cc8aa4c47e1ea1cc1f2afa07e20cc5a037246263d5d3697e4
-  data.tar.gz: fb055fc5fd50e48c6091bcf3cd0166f2a3cd55d2527db880a8660b239dbbf5ff487760ad891170aac12d5eeaccc9a3f37cf718fc0f0cf893b880dbb2e21448e1
+  metadata.gz: d94b8321b4574dde4deab096345db7b665504ddaa3ed583331510f58f6e9a70067aa97e9ba4f3ca6b05315563cceb91ef5a4b57b20c43684394509761cec4625
+  data.tar.gz: 257bccd37f3322c2115bb4cef92e1e1e40c74b8255c18ae12ad07fd6cbcab84c734ea6c9cc734dee345153ef0190578ea23479ad213fb1c089c985d1d9961cea

data/README.adoc

@@ -70,6 +70,7 @@ scripts such as this one. You need only run the following in a Terminal console:
 ----
 $ bash <(curl -s https://raw.githubusercontent.com/riboseinc/metanorma-macos-setup/master/metanorma-setup)
 $ gem install metanorma-rsd
+$ gem install metanorma-cli
 ----
 
 
@@ -77,17 +78,12 @@ $ gem install metanorma-rsd
 
 === Document model
 
-The Ribose Standard Document model is an instance of the
+The Ribose Standard Document model used in this gem is an instance of the
 https://github.com/riboseinc/isodoc-models[StandardDocument model].
 
-The RSD format ("RSD XML") intends to introduce rigor into the RSD
+The Metanorma XML format intends to introduce rigor into the RSD
 standards authoring process, and is prescribed in a separate document.
 
-RSD XML is still under development, but it already contains all the markup
-needed to render a RSD document into HTML.
-
-WARNING: The current RNG model of RSD XML is out of sync with the UML.
-
 === Asciidoctor
 
 Asciidoctor has been selected as the authoring tool to generate the document
@@ -99,19 +95,17 @@ DocBook document authoring tool). Asciidoctor has built-in capability to output
 Text, DocBook and HTML; so it can be used to preview the file as it is being
 authored.
 
-Note that in order to generate HTML preview output close to what is intended
-in the RSD standard, the Asciidoc
-document includes a fair amount of formatting instructions (e.g. disabling
-section numbering where appropriate, the titling of Appendixes as Annexes), as
-well as RSD boilerplate text, and predefined section headers (sections are
-recognised by fixed titles such as `Normative References`). Authoring RSD
-standards in this fashion assumes that users will be populating an Asciidoc
-template, and not removing needed formatting instructions.
+Generating documents via a document model substantially automated formatting
+associated with the document, including automating numbering of headings, figures,
+tables etc, and automatically generating references and citations.
 
 == Document Attributes
 
+=== Common attributes
+
 The gem relies on Asciidoctor document attributes to provide necessary
-metadata about the document. These include:
+metadata about the document. The https://github.com/riboseinc/metanorma-standoc[metanorma-standoc]
+gem documents the Asciidoctor document attributes common to all metanorma gems. These include:
 
 `:edition:`:: The document edition
 
@@ -148,12 +142,18 @@ or `provisional`.
 
 `:language:` :: The language of the document (only `en` for now)  (mandatory)
 
-`:security:` :: Security level classification, e.g., "confidential", "client confidential"
-
 The attribute `:draft:`, if present, includes review notes in the XML output;
 these are otherwise suppressed.
 
-== AsciiRSD features not also present in AsciiISO
+=== Attributes specific to RSD:
+
+`:security:` :: Security level classification, e.g., "confidential", "client confidential"
+
+== Asciidoctor features specific to CSAND
+
+The https://github.com/riboseinc/metanorma-standoc[metanorma-standoc]
+gem documents the customisations of Asciidoctor markup common to all metanorma gems.
+The following markup is specific to this gem:
 
 * `+[keyword]#...#+`: encodes keywords, such as "MUST", "MUST NOT". (Encoded as
 `<span class="keyword">...</span>`.

data/lib/asciidoctor/rsd/isostandard.rng

@@ -744,6 +744,9 @@
     </define>
     <define name="preface">
       <element name="preface">
+        <optional>
+          <ref name="preface_abstract"/>
+        </optional>
         <ref name="foreword"/>
         <optional>
           <ref name="introduction"/>
@@ -811,6 +814,11 @@
       </optional>
     </element>
   </define>
+  <define name="preface_abstract">
+    <element name="abstract">
+      <ref name="Basic-Section"/>
+    </element>
+  </define>
   <define name="foreword">
     <element name="foreword">
       <ref name="Basic-Section"/>

data/lib/isodoc/rsd/html/html_rsd_titlepage.html

@@ -45,7 +45,7 @@
   </div>
 
   <div class="coverpage-stage-block" >
-    <p><span class="coverpage-maturity" id="{{ status | replace: ' ', '-' | downcase }}">{{ status }}</span></p>
+    <p><span class="coverpage-maturity" id="{{ status | replace: ' ', '-' | downcase }}">{% if unpublished %}{{ status }}{% endif %}</span></p>
 {% if security %}
 <p><span class="coverpage-maturity">Classification: {{ security }}</span></p>
 {% endif %}
@@ -55,7 +55,7 @@
 <div  class="coverpage-stage-block" >{{ revdate }}</div>
 {% endif %}
 
-{% if status != "Published" and status != "Withdrawn" %}
+{% if unpublished %}
   <div class="coverpage-warning">
     <span class="title">Warning for Drafts</span>
 

data/lib/isodoc/rsd/html/word_rsd_titlepage.html

@@ -18,7 +18,8 @@ margin-left:4.25pt;margin-right:4.25pt'>
 
 <p class="MsoNormal" align="center" style='text-align:center;border:none;
 mso-border-alt:solid windowtext .5pt;padding:0cm;mso-padding-alt:1.0pt 4.0pt 1.0pt 4.0pt'><span
-                     lang="EN-GB" style='font-size:16.0pt'>{{ status }} {{ doctype }}</span></p>
+                     lang="EN-GB" style='font-size:16.0pt'>{% if unpublished %}{{ status }} {% endif %}{{ doctype }}</span></p>
+
 
 {% if security %}
 <p class="MsoNormal" align="center" style='text-align:center;border:none;
@@ -39,7 +40,7 @@ mso-border-alt:solid windowtext .5pt;padding:0cm;mso-padding-alt:1.0pt 4.0pt 1.0
 mso-border-alt:solid windowtext .5pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
 margin-left:4.25pt;margin-right:4.25pt'>
 
-{% if status != "Published" and status != "Withdrawn" %}
+{% if unpublished %}
 <p class="MsoNormal" align="center" style='margin-bottom:6.0pt;text-align:center;
 border:none;mso-border-alt:solid windowtext .5pt;padding:0cm;mso-padding-alt:
 1.0pt 4.0pt 1.0pt 4.0pt'><b style='mso-bidi-font-weight:normal'><span

data/lib/isodoc/rsd/metadata.rb

@@ -38,6 +38,10 @@ module IsoDoc
         end
       end
 
+      def unpublished(status)
+        %w(published withdrawn).include? status.downcase
+      end
+
       def version(isoxml, _out)
         super
         revdate = get[:revdate]

data/lib/metanorma/rsd/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Rsd
-    VERSION = "1.0.9"
+    VERSION = "1.0.10"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-rsd
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-19 00:00:00.000000000 Z
+date: 2018-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor