metanorma-csd 1.0.10 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91fc0a9da08260a793f3b925205be38d57708084a0ce67d173df0bba2ec10e0b
-  data.tar.gz: 1606fa2d8f2b3832f9946ccb4d7848e2cf333cf8df82db1e3a554bcf827230ab
+  metadata.gz: cfa77e6bb51c1c9b88c27780e2c2469d07a8a677dce69b429c90bf5a9e8935ad
+  data.tar.gz: ac9a4b4d45310c4dc67d5c9f4cf8f5ab16c400557bcc87181d8d373e07faca7b
 SHA512:
-  metadata.gz: 623ed2ae7a6a907824b5bb3c30ab9ca579a62a3230e0ffb79269754ae145f2fcec879e376895a26538cd96e1ed131fd6b53356d9e8aa647274cf187088f53882
-  data.tar.gz: a922a098a6a216b2b9ba0a6718dea2557c529cc4ef379b264938e88890a163f1d9cac6e0892c07d20c119a28b43e1f98d60ebc8c5cac8e7ed1a6857cd375fc88
+  metadata.gz: 0b53a3f7c310eac3fd0eb622e04f828b54f6be4f92513eb5614eac743007c94479bdfae7fa3d63d62466f56498f3b3c28b2756ab6aebd06542133029d4423635
+  data.tar.gz: 4c0e567f10f0f0e76a75cd4724908d62be56ae7daf9e8ae4c7f681afa475faed3eb09b668db7e260d49c4e8365c2572c5d77678f4e54079a866af44b1bcaf63f

data/README.adoc

@@ -120,8 +120,11 @@ 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
 
@@ -168,7 +171,22 @@ other committees are added as `_3`, `_4`...
 The attribute `:draft:`, if present, includes review notes in the XML output;
 these are otherwise suppressed.
 
-== AsciiCSD features not also present in AsciiISO
+=== Attributs specific to CSD
+
+`:fullname{_i}:`:: The full name of a person who is a contributor to the document.
+A second person is indicated by using a numeric suffix: `:fullname:`, `:fullname_2:`, `fullname_3:`, &c.
+
+`:surname{_i}:`:: The surname of a person who is a contributor to the document.
+`:givenname{_i}:`:: The given name(s) of a person who is a contributor to the document.
+`:role{_i}:`:: The role of a a person who is a contributor to the document. By default,
+they are coded as an `editor`; they can also be represented as an `author`.
+
+
+== 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/csd/converter.rb

@@ -4,6 +4,8 @@ require "isodoc/csd/word_convert"
 require "metanorma/csd"
 require "asciidoctor/standoc/converter"
 require "fileutils"
+require_relative "validate_section"
+require_relative "front"
 
 module Asciidoctor
   module Csd
@@ -19,89 +21,6 @@ module Asciidoctor
         super
       end
 
-      def metadata_author(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "author" }
-          c.organization do |a|
-            a.name "CalConnect"
-          end
-        end
-      end
-
-      def metadata_publisher(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "publisher" }
-          c.organization do |a|
-            a.name "CalConnect"
-          end
-        end
-      end
-
-      def metadata_committee(node, xml)
-        xml.editorialgroup do |a|
-          a.technical_committee node.attr("technical-committee"),
-            **attr_code(type: node.attr("technical-committee-type"))
-          i = 2
-          while node.attr("technical-committee_#{i}") do
-            a.technical_committee node.attr("technical-committee_#{i}"),
-              **attr_code(type: node.attr("technical-committee-type_#{i}"))
-            i += 1
-          end
-        end
-      end
-
-      def metadata_status(node, xml)
-        status = node.attr("status")
-        unless status && ::Metanorma::Csd::DOCSTATUS.keys.include?(status)
-          warn "#{status} is not a legal status"
-        end
-        xml.status(**{ format: "plain" }) { |s| s << status }
-      end
-
-      def prefix_id(node)
-        prefix = "CC"
-        typesuffix = ::Metanorma::Csd::DOCSUFFIX[node.attr("doctype")] || ""
-        prefix += "/#{typesuffix}" unless typesuffix.empty?
-        status = ::Metanorma::Csd::DOCSTATUS[node.attr("status")] || ""
-        prefix += "/#{status}" unless status.empty?
-        prefix
-      end
-
-      def metadata_id(node, xml)
-        id = node.attr("docnumber") || "???"
-        prefix = prefix_id(node)
-        id = "#{prefix} #{id}"
-        year = node.attr("copyright-year")
-        id += ":#{year}" if year
-        xml.docidentifier id, **{type: "csd"}
-        xml.docnumber node.attr("docnumber")
-      end
-
-      def doctype(node)
-        d = node.attr("doctype")
-        unless ::Metanorma::Csd::DOCSUFFIX.keys.include?(d)
-          warn "#{d} is not a legal document type: reverting to 'standard'"
-          d = "standard"
-        end
-        d
-      end
-
-      def metadata_copyright(node, xml)
-        from = node.attr("copyright-year") || Date.today.year
-        xml.copyright do |c|
-          c.from from
-          c.owner do |owner|
-            owner.organization do |o|
-              o.name "CalConnect"
-            end
-          end
-        end
-      end
-
-      def title_validate(root)
-        nil
-      end
-
       def makexml(node)
         result = ["<?xml version='1.0' encoding='UTF-8'?>\n<csd-standard>"]
         @draft = node.attributes.has_key?("draft")

data/lib/asciidoctor/csd/front.rb

@@ -0,0 +1,118 @@
+require "asciidoctor"
+require "asciidoctor/standoc/converter"
+require "fileutils"
+
+module Asciidoctor
+  module Csd
+
+    class Converter < Standoc::Converter
+
+      def metadata_author(node, xml)
+        xml.contributor do |c|
+          c.role **{ type: "author" }
+          c.organization do |a|
+            a.name "CalConnect"
+          end
+        end
+        personal_author(node, xml)
+      end
+
+      def personal_author(node, xml)
+        if node.attr("fullname") || node.attr("surname")
+          personal_author1(node, xml, "")
+        end
+        i = 2
+        while node.attr("fullname_#{i}") || node.attr("surname_#{i}")
+          personal_author1(node, xml, "_#{i}")
+          i += 1
+        end
+      end
+
+      def personal_author1(node, xml, suffix)
+        xml.contributor do |c|
+          c.role **{ type: node.attr("role#{suffix}")&.downcase || "author" }
+          c.person do |p|
+            p.name do |n|
+              if node.attr("fullname#{suffix}")
+                n.completename node.attr("fullname#{suffix}")
+              else
+                n.forename node.attr("givenname#{suffix}")
+                n.surname node.attr("surname#{suffix}")
+              end
+            end
+          end
+        end
+      end
+
+      def metadata_publisher(node, xml)
+        xml.contributor do |c|
+          c.role **{ type: "publisher" }
+          c.organization do |a|
+            a.name "CalConnect"
+          end
+        end
+      end
+
+      def metadata_committee(node, xml)
+        xml.editorialgroup do |a|
+          a.technical_committee node.attr("technical-committee"),
+            **attr_code(type: node.attr("technical-committee-type"))
+          i = 2
+          while node.attr("technical-committee_#{i}") do
+            a.technical_committee node.attr("technical-committee_#{i}"),
+              **attr_code(type: node.attr("technical-committee-type_#{i}"))
+            i += 1
+          end
+        end
+      end
+
+      def metadata_status(node, xml)
+        status = node.attr("status")
+        unless status && ::Metanorma::Csd::DOCSTATUS.keys.include?(status)
+          warn "#{status} is not a legal status"
+        end
+        xml.status(**{ format: "plain" }) { |s| s << status }
+      end
+
+      def prefix_id(node)
+        prefix = "CC"
+        typesuffix = ::Metanorma::Csd::DOCSUFFIX[node.attr("doctype")] || ""
+        prefix += "/#{typesuffix}" unless typesuffix.empty?
+        status = ::Metanorma::Csd::DOCSTATUS[node.attr("status")] || ""
+        prefix += "/#{status}" unless status.empty?
+        prefix
+      end
+
+      def metadata_id(node, xml)
+        id = node.attr("docnumber") || "???"
+        prefix = prefix_id(node)
+        id = "#{prefix} #{id}"
+        year = node.attr("copyright-year")
+        id += ":#{year}" if year
+        xml.docidentifier id, **{type: "csd"}
+        xml.docnumber node.attr("docnumber")
+      end
+
+      def doctype(node)
+        d = node.attr("doctype")
+        unless ::Metanorma::Csd::DOCSUFFIX.keys.include?(d)
+          warn "#{d} is not a legal document type: reverting to 'standard'"
+          d = "standard"
+        end
+        d
+      end
+
+      def metadata_copyright(node, xml)
+        from = node.attr("copyright-year") || Date.today.year
+        xml.copyright do |c|
+          c.from from
+          c.owner do |owner|
+            owner.organization do |o|
+              o.name "CalConnect"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/csd/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/asciidoctor/csd/validate_section.rb

@@ -0,0 +1,138 @@
+require "nokogiri"
+
+module Asciidoctor
+  module Csd
+    class Converter < Standoc::Converter
+      def section_validate(doc)
+        advisory = doc.root.at("//bibdata[@type = 'advisory']")
+        symbols_validate(doc.root) unless advisory
+        sections_sequence_validate(doc.root) unless advisory
+        super
+      end
+
+      ONE_SYMBOLS_WARNING = "ISO style: only one Symbols and Abbreviated "\
+        "Terms section in the standard".freeze
+
+      NON_DL_SYMBOLS_WARNING = "ISO style: Symbols and Abbreviated Terms can "\
+        "only contain a definition list".freeze
+
+      def symbols_validate(root)
+        f = root.xpath("//definitions")
+        f.empty? && return
+        (f.size == 1) || warn(ONE_SYMBOLS_WARNING)
+        f.first.elements.each do |e|
+          unless e.name == "dl"
+            warn(NON_DL_SYMBOLS_WARNING)
+            return
+          end
+        end
+      end
+
+      def seqcheck(names, msg, accepted)
+        n = names.shift
+        unless accepted.include? n
+          warn "ISO style: #{msg}"
+          names = []
+        end
+        names
+      end
+
+      # spec of permissible section sequence
+      # we skip normative references, it goes to end of list
+      SEQ =
+        [
+          {
+            msg: "Initial section must be (content) Foreword",
+            val:  [{ tag: "foreword", title: "Foreword" }],
+          },
+          {
+            msg: "Prefatory material must be followed by (clause) Scope",
+            val:  [{ tag: "introduction", title: "Introduction" },
+                   { tag: "clause", title: "Scope" }],
+          },
+          {
+            msg: "Prefatory material must be followed by (clause) Scope",
+            val: [{ tag: "clause", title: "Scope" }],
+          },
+          {
+            msg: "Normative References must be followed by "\
+            "Terms and Definitions",
+            val: [
+              { tag: "terms", title: "Terms and definitions" },
+              { tag: "clause", title: "Terms and definitions" },
+              {
+                tag: "terms",
+                title: "Terms, definitions, symbols and abbreviated terms",
+              },
+              {
+                tag: "clause",
+                title: "Terms, definitions, symbols and abbreviated terms",
+              },
+            ],
+          },
+      ].freeze
+
+      SECTIONS_XPATH =
+        "//foreword | //introduction | //sections/terms | .//annex | "\
+        "//sections/definitions | //sections/clause | //references[not(parent::clause)] | "\
+        "//clause[descendant::references][not(parent::clause)]".freeze
+
+      def sections_sequence_validate(root)
+        f = root.xpath(SECTIONS_XPATH)
+        names = f.map { |s| { tag: s.name, title: s&.at("./title")&.text } }
+        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val]) || return
+        n = names[0]
+        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val]) || return
+        if n == { tag: "introduction", title: "Introduction" }
+          names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val]) || return
+        end
+        names = seqcheck(names, SEQ[3][:msg], SEQ[3][:val]) || return
+        n = names.shift
+        if n == { tag: "definitions", title: nil }
+          n = names.shift || return
+        end
+        unless n
+          warn "ISO style: Document must contain at least one clause"
+          return
+        end
+        n[:tag] == "clause" ||
+          warn("ISO style: Document must contain clause after "\
+               "Terms and Definitions")
+        n == { tag: "clause", title: "Scope" } &&
+          warn("ISO style: Scope must occur before Terms and Definitions")
+        n = names.shift || return
+        while n[:tag] == "clause"
+          n[:title] == "Scope" &&
+            warn("ISO style: Scope must occur before Terms and Definitions")
+          n = names.shift || return
+        end
+        unless n[:tag] == "annex" || n[:tag] == "references"
+          warn "ISO style: Only annexes and references can follow clauses"
+        end
+        while n[:tag] == "annex"
+          n = names.shift
+          if n.nil?
+            warn("ISO style: Document must include (references) "\
+                 "Normative References")
+            return
+          end
+        end
+        n == { tag: "references", title: "Normative References" } ||
+          warn("ISO style: Document must include (references) "\
+               "Normative References")
+        n = names.shift
+        n == { tag: "references", title: "Bibliography" } ||
+          warn("ISO style: Final section must be (references) Bibliography")
+        names.empty? ||
+          warn("ISO style: There are sections after the final Bibliography")
+      end
+
+      def style_warning(node, msg, text)
+        return if @novalid
+        w = "ISO style: WARNING (#{Standoc::Utils::current_location(node)}): #{msg}"
+        w += ": #{text}" if text
+        warn w
+      end
+    end
+  end
+end

data/lib/isodoc/csd/html/html_csd_titlepage.html

@@ -36,6 +36,17 @@
   <div class="coverpage-tc-name">
     <span>TC {{ tc }}</span>
   </div>
+
+  {% if editors %}
+  <div class="coverpage-tc-name">
+    <span>Editors: {{ editors | join: ", " }}</span>
+  </div>
+  {% endif %}
+  {% if authors %}
+  <div class="coverpage-tc-name">
+    <span>Authors: {{ authors | join: ", " }}</span>
+  </div>
+  {% endif %}
   </div>
 
   <div class="title-section1">
@@ -44,10 +55,10 @@
   </div>
 
   <div class="coverpage-stage-block" >
-    <span class="coverpage-maturity" id="{{ status | replace: ' ', '-' | downcase }}">{{ status }}</span>
+    <span class="coverpage-maturity" id="{{ status | replace: ' ', '-' | downcase }}">{% if unpublished %}{{ status }}{% endif %}</span>
 </div>
 
-{% if status != "Published" and status != "Withdrawn" %}
+{% if unpublished %}
   <div class="coverpage-warning">
     <span class="title">Warning for Drafts</span>
 

data/lib/isodoc/csd/html/word_csd_titlepage.html

@@ -10,6 +10,17 @@ style='mso-no-proof:yes'>{{ tc | join: "/" }}</span></p>
 style='mso-bidi-font-weight:normal'><span lang="EN-GB" style='font-size:24.0pt'>{{ doctitle }}</span>
 </b><br/><span lang="EN-GB" style='font-size:16.0pt'>{{ docsubtitle }}</span></p>
 
+  {% if editors %}
+  <p class="MsoNormal" align="center" style='text-align:center'>
+    <span>Editors: {{ editors | join: ", " }}</span>
+  </p>
+  {% endif %}
+  {% if authors %}
+  <p class="MsoNormal" align="center" style='text-align:center'>
+    <span>Authors: {{ authors | join: ", " }}</span>
+  </p>
+  {% endif %}
+
 <p class="MsoNormal" style='margin-top:100.0pt'><span lang="EN-GB"><o:p>&nbsp;</o:p></span></p>
 
 <div style='mso-element:para-border-div;border:solid windowtext 1.0pt;
@@ -18,7 +29,7 @@ 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 doctype == "Policy And Procedures" or doctype == "Proposal" %}
 <p class="MsoNormal" align="center" style='text-align:center;border:none;
@@ -33,7 +44,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/csd/metadata.rb

@@ -25,6 +25,26 @@ module IsoDoc
         set(:tc, "XXXX")
         tc = isoxml.at(ns("//bibdata/editorialgroup/technical-committee"))
         set(:tc, tc.text) if tc
+        authors = isoxml.xpath(ns("//bibdata/contributor[role/@type = 'author']/person/name"))
+        set(:authors, extract_person_names(authors))
+        editors = isoxml.xpath(ns("//bibdata/contributor[role/@type = 'editor']/person/name"))
+        set(:editors, extract_person_names(editors))
+      end
+
+      def extract_person_names(authors)
+        ret = []
+        authors.each do |a|
+          if a.at(ns("./completename"))
+            ret << a.at(ns("./completename")).text
+          else
+            fn = []
+            forenames = a.xpath(ns("./forename"))
+            forenames.each { |f| fn << f.text }
+            surname = a&.at(ns("./surname"))&.text
+            ret << fn.join(" ") + " " + surname
+          end
+        end
+        ret
       end
 
       def docid(isoxml, _out)
@@ -44,7 +64,10 @@ module IsoDoc
       def status_abbr(status)
         ::Metanorma::Csd::DOCSTATUS[status] || ""
       end
+
+      def unpublished(status)
+        %w(published withdrawn).include? status.downcase
+      end
     end
   end
 end
-

data/lib/metanorma/csd/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Csd
-    VERSION = "1.0.10"
+    VERSION = "1.0.11"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-csd
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.11
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
+date: 2018-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -221,9 +221,11 @@ files:
 - lib/asciidoctor/csd/biblio.rng
 - lib/asciidoctor/csd/converter.rb
 - lib/asciidoctor/csd/csd.rng
+- lib/asciidoctor/csd/front.rb
 - lib/asciidoctor/csd/isodoc.rng
 - lib/asciidoctor/csd/isostandard.rng
 - lib/asciidoctor/csd/pdf.js
+- lib/asciidoctor/csd/validate_section.rb
 - lib/isodoc/csd/html/csd.scss
 - lib/isodoc/csd/html/dots-w@2x.png
 - lib/isodoc/csd/html/dots@2x.png