metanorma-csd 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc93b5ef9c1b130f88bc1df2a147df5e5e61f05d45b2f93d2758627a0eae0269
-  data.tar.gz: d4014ba691ed9d6ad473b590e659883ff2c0fa3fe668d22bde6181e1b417688f
+  metadata.gz: f636a1b9e0dd059719304718108e989bc5b2674bf424489ab1d8c708c5a42fab
+  data.tar.gz: 144e027a106e43e82aaccbb32b6823dff56ed9b1d3cb309044c60bc9113f87b3
 SHA512:
-  metadata.gz: 2ddf5db4d14bf62b74bec8712c37bd7e60e64128a29f6b33015cf87722d56a1d6dafdc4246dc2ff2f537b8e8847f43e2b9c8e2a8cf523b99cb8182bdfb638207
-  data.tar.gz: a15c74e3fd3ab404b3512623d39e0b1fdab76f9b23a9ec9331dab7de2a4b01b2d87cc201e2b38e0893ed94a462d841ae6cb43d474be5bfb3325f7b559e219ef2
+  metadata.gz: 282fa313ca0659704839dcd19ea60e7f376e5d5094816e320db9c7f85b5778de7c08256cabf1c4645a4a1f959d9f3eaa59d1e543707791b8966ec573b9bc9dfa
+  data.tar.gz: 05f8626d4f0c79caad7fa6de6dc122226c8b9f26c08aad38f0edd711b87b9602a2e1da215aedbfd829183f7ec5cfa094bc4f0da52dec66ef3352dc90c8c9d7cf

data/README.adoc

@@ -20,14 +20,14 @@ for guidance, including https://github.com/riboseinc/metanorma-iso/wiki/Guidance
 The following outputs are generated.
 
 * (Optional) An HTML preview generated directly from the Asciidoctor document,
-using native Asciidoc formatting. 
+using native Asciidoc formatting.
 ** http://asciimath.org[AsciiMathML] is to be used for mathematical formatting.
 The gem uses the https://github.com/asciidoctor/asciimath[Ruby AsciiMath parser],
 which is syntactically stricter than the common MathJax processor;
 if you do not get expected results, try bracketting terms your in AsciiMathML
 expressions.
 * an XML representation of the document, intended as a document model for CSD
-International Standards. 
+International Standards.
 * The XML representation is processed in turn to generate the following outputs
 as end deliverable CSD standard drafts.
 ** HTML
@@ -55,12 +55,14 @@ document.
 
 The gem then converts the XML into HTML and PDF.
 
+////
 The gem can also be invoked directly within asciidoctor, though this is deprecated:
 
 [source,console]
 ----
-$ asciidoctor -b csd -r 'metanorma-csd' a.adoc  
+$ asciidoctor -b csd -r 'metanorma-csd' a.adoc
 ----
+////
 
 === Installation
 
@@ -77,7 +79,7 @@ $ gem install metanorma-csd
 === PDF output
 
 PDF output is generated by printing the HTML output as PDF. This is done
-within the gem, using 
+within the gem, using
 https://developers.google.com/web/updates/2017/04/headless-chrome[Headless Chrome],
 via the https://github.com/GoogleChrome/puppeteer[Puppeteer] Node library.
 
@@ -145,6 +147,7 @@ report:: Report (suffix `R`)
 administrative:: Administrative (suffix `A`)
 amendment:: Amendment (suffix `Amd`)
 technical corrigendum:: Technical Corrigendum (suffix `Cor`)
+advisory:: Advisory (suffix `Adv`)
 --
 
 `:status:``:: The document status. The permitted types are: `proposal`,

data/lib/asciidoctor/csd/converter.rb

@@ -1,6 +1,7 @@
 require "asciidoctor"
 require "isodoc/csd/html_convert"
 require "isodoc/csd/word_convert"
+require "metanorma/csd"
 require "asciidoctor/standoc/converter"
 require "fileutils"
 
@@ -57,20 +58,10 @@ module Asciidoctor
         end
       end
 
-      DOCSUFFIX = {
-        "standard": "",
-        "directive": "DIR",
-        "guide": "Guide",
-        "specification": "S",
-        "report": "R",
-        "amendment": "Amd",
-        "technical corrigendum": "Cor",
-        "administrative": "A",
-      }
 
       def metadata_status(node, xml)
         status = node.attr("status")
-        unless status && %w(FDS DS CD WD published).include?(status)
+        unless status && ::Metanorma::Csd::DOCSTATUS.keys.include?(status)
           warn "#{status} is not a legal status"
         end
         xml.status(**{ format: "plain" }) { |s| s << status }
@@ -78,18 +69,36 @@ module Asciidoctor
 
       def metadata_id(node, xml)
         id = node.attr("docnumber") || "???"
-        typesuffix = DOCSUFFIX[doctype(node)]
-        prefix = "CC"
-        prefix += "/#{typesuffix}" if typesuffix
-        status = node.attr("status")
-        status = nil if status == "published"
-        prefix += "/#{status}" if status
-        year = node.attr("copyright-year")
-        id = prefix + " " + id
-        id += ":#{year}" if year
+        # prefix = "CC"
+        doctype(node)
+        # unless typesuffix.empty?
+        #   prefix += "/#{typesuffix}"
+        # end
+        #
+        # status = DOCSTATUS[node.attr("status")] || ""
+        # unless status.empty?
+        #   prefix += "/#{status}"
+        # end
+        #
+        # id = "#{prefix} #{id}"
+        #
+        # year = node.attr("copyright-year")
+        # if year
+        #   id += ":#{year}"
+        # end
+
         xml.docidentifier { |i| i << id }
       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|
@@ -119,16 +128,6 @@ module Asciidoctor
         ret1
       end
 
-      def doctype(node)
-        d = node.attr("doctype")
-        unless ["standard", "directive", "guide", "specification", "report",
-            "amendment", "technical corrigendum" ].include?(d)
-          warn "#{d} is not a legal document type: reverting to 'standard'"
-          d = "standard"
-        end
-        d
-      end
-
       def document(node)
         init(node)
         ret1 = makexml(node)

data/lib/asciidoctor/csd/csd.rng

@@ -106,6 +106,7 @@
         <value>administrative</value>
         <value>amendment</value>
         <value>technical corrigendum</value>
+        <value>advisory</value>
       </choice>
     </define>
     <define name="BibliographicItem">

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

@@ -1,9 +1,9 @@
-<div class="document-stage-band" id="{{ doctype | replace: ' ', '-' | downcase }}-band">
+<div class="document-stage-band" id="{{ status | replace: ' ', '-' | downcase }}-band">
     <p class="document-stage">{{ status }}</p>
 </div>
 
 <div class="document-type-band" id="{{ doctype | replace: ' ', '-' | downcase }}-band">
-    <p class="document-type">Calconnect {{ doctype }}</p>
+    <p class="document-type">CalConnect {{ doctype }}</p>
 </div>
 
 
@@ -19,8 +19,8 @@
   <div class="coverpage-doc-identity">
     <div class="doc-number">
       <span class="docnumber">{{ docnumber }}</span>
-      <span class="docnumber-separator">:</span>
-      <span class="docyear">{{ docyear }}</span>
+      <!-- <span class="docnumber-separator">:</span>
+      <span class="docyear">{{ docyear }}</span> -->
     </div>
 
     <div class="coverpage-title">
@@ -40,7 +40,7 @@
 
   <div class="title-section1">
   <div class="coverpage-stage-block" >
-    <span class="coverpage-stage" id="{{ doctype | replace: ' ', '-' | downcase }}">Calconnect {{ doctype }}</span>
+    <span class="coverpage-stage" id="{{ doctype | replace: ' ', '-' | downcase }}">CalConnect {{ doctype }}</span>
   </div>
 
   <div class="coverpage-stage-block" >

data/lib/isodoc/csd/html/htmlstyle.scss

@@ -2,7 +2,7 @@
     0 CSS RESET
 */
 
-/* http://meyerweb.com/eric/tools/css/reset/ 
+/* http://meyerweb.com/eric/tools/css/reset/
    v2.0 | 20110126
    License: none (public domain)
 */
@@ -59,9 +59,9 @@ time, mark, audio, video {
 
 
 html, body, div, span, applet, object, iframe,
-p, blockquote, 
-a, abbr, acronym, address, big, cite, 
-del, dfn, em, img, ins, q, s, 
+p, blockquote,
+a, abbr, acronym, address, big, cite,
+del, dfn, em, img, ins, q, s,
 small, strike, strong, sub, sup, var,
 b, u, i, center,
 dl, dt, dd, ol, ul, li,
@@ -101,7 +101,7 @@ dd p, dt p {
 
 
 /* HTML5 display-role reset for older browsers */
-article, aside, details, figcaption, figure, 
+article, aside, details, figcaption, figure,
 footer, header, hgroup, menu, nav, section {
 	display: block;
 }
@@ -121,12 +121,12 @@ table {
 	border-spacing: 0;
 }
 
- 
+
 /*
     1. HTML & Body
 */
 
-  body { 
+  body {
     margin: 0;
     margin-left: auto;
     margin-right: auto;
@@ -161,7 +161,7 @@ table {
         overflow: auto;
         padding: 0 0 0 45px;
         margin-right: 30px;
-        background-color:#f7f7f7; 
+        background-color:#f7f7f7;
     }
 
     #toggle {
@@ -177,10 +177,10 @@ table {
     #toggle span {
         text-align: center;
         width: 100%;
-        position: absolute;             
+        position: absolute;
         top: 50%;
         transform: translate(0, -50%);
-        
+
     }
 
 
@@ -208,14 +208,14 @@ table {
         overflow: visible;
     }
 }
-  
+
 @media screen {
-  img { 
-      width: 100%;   
+  img {
+      width: 100%;
       height: auto;
   }
 }
-    
+
 
 #toc ul {
     margin: 0;
@@ -295,20 +295,18 @@ table {
 }
 
 p.document-type, p.document-stage {
-    color: white;
-    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);
+  color: white;
+  text-transform: uppercase;
+  font-size: 0.9em;
+  font-weight: 400;
+  letter-spacing: 0.05em;
+  margin:0;
+  margin-left: 6px;
+  writing-mode:tb-rl;
+  transform:rotate(180deg);
 	white-space:nowrap;
 	display:block;
-    bottom:0;
+  bottom:0;
 }
 
 p.document-type {
@@ -326,93 +324,56 @@ p.document-stage {
     height:160px;
 }
 
-#standard-band {
-    background-color: #0ac442;
-}
-
-#standard {
-    border-bottom: solid 3px #0ac442;
-}
 
-#governance {
-    border-bottom: solid 3px #750697;
-}
-
-#governance-band {
-    background-color: #750697;
-}
+$doctype-colors-list:(
+  standard: #0AC442,
+  governance: #540D6E,
+  guide: #D183C9,
+  specification: #65AFFF,
+  report: #3A405A,
+  amendment: #F26430,
+  corrigendum: #C84630,
+  administrative: #BFAE48,
+  advisory: #BD9391
+);
 
-#guide {
-    border-bottom: solid 3px #48a0e7;
+@each $key,$val in $doctype-colors-list{
+  ##{$key}-band {
+    background-color: #{$val};
+  }
+  ##{$key} {
+    border-bottom: solid 3px #{$val};
+  }
 }
 
-#guide-band {
-    background-color: #48a0e7;
+$docstage-colors-list:(
+  proposal: #39A0ED,
+  working-draft: #2D7393,
+  committee-draft: #2A6B7C,
+  draft-standard: #1C7F7A,
+  final-draft: #53C170,
+  published: #069E2D,
+  withdrawn: #004E64,
+  cancelled: #2E382E,
+);
+
+@each $key,$val in $docstage-colors-list{
+  ##{$key}-band {
+    background-color: #{$val};
+  }
+  ##{$key} {
+    border-bottom: solid 3px #{$val};
+  }
 }
 
 .coverpage-maturity {
-    font-family: $bodyfont;
-    font-weight: 400;
-    font-size: 1em;
-    margin: 0 0 2em 0;
-    text-transform: uppercase;
-    }
-
-#proposal {
-    border-bottom: solid 3px #00BFFF;
-}
-
-#proposal-band {
-    background-color: #00BFFF;
-}
-
-#working-draft {
-    border-bottom: solid 3px #fda706;
-}
-
-#working-draft-band {
-    background-color: #fda706;
-}
-
-#committee-draft {
-    border-bottom: solid 3px #fd06fd;
-}
-
-#committee-draft-band {
-    background-color: #fd06fd;
-}
-
-#draft-standard {
-    border-bottom: solid 3px #fdf906;
-}
-
-#draft-standard-band {
-    background-color: #fdf906;
-}
-
-#final-draft {
-    border-bottom: solid 3px #7e0d13;
-}
-
-#final-draft-band {
-    background-color: #7e0d13;
-}
-
-#published {
-    border-bottom: solid 3px #0ac442;
-}
-
-#published-band {
-    background-color: #0ac442;
-}
-
-#withdrawn {
-    border-bottom: solid 3px #a0a0a0;
+  font-family: $bodyfont;
+  font-weight: 400;
+  font-size: 1em;
+  margin: 0 0 2em 0;
+  text-transform: uppercase;
 }
 
-#withdrawn-band {
-    background-color: #a0a0a0;
-}
 
 /*
     3. TYPOGRAPHY
@@ -421,7 +382,7 @@ p.document-stage {
 /*
     3.1 Titles
 */
-  
+
   h1,h2,h3,h4,h5,h6 {
     font-family: $headerfont;
     color: #0e1a85;
@@ -431,7 +392,7 @@ p.document-stage {
   }
 
   h1 {
-    font-size: 1.4em; 
+    font-size: 1.4em;
     text-transform: uppercase;
     margin-top: 2em;
   }
@@ -439,15 +400,15 @@ p.document-stage {
   h1#content {
       margin-top: 2em;
   }
-  
+
   h2 {
-    font-size: 1.3em; 
+    font-size: 1.3em;
     font-weight: 400;
   }
-  
+
   h3 {
     font-size: 1.1em;
-    font-weight: 400;   
+    font-weight: 400;
   }
 
   /*
@@ -455,8 +416,8 @@ p.document-stage {
     float: left;
     padding-right: 4px;
     margin-left: -20px;
-    font-family: "Font Awesome 5 Free"; 
-    font-weight: 900; 
+    font-family: "Font Awesome 5 Free";
+    font-weight: 900;
     font-size: 0.8em;
     color: #cfcfcf;
     content: "\f0c1";
@@ -480,7 +441,7 @@ p.document-stage {
     line-height: 1.7em;
     margin: 0;
   }
-  
+
   /*
   p.AltTerms {
     font-style: italic;
@@ -496,12 +457,12 @@ span.obligation {
 /*
     3.2 Links
 */
-  
+
     a, a:visited{
         text-decoration: none;
         color: #485094;
     }
-      
+
     a:hover {
         color: white;
         background: #1d1d1d;
@@ -526,15 +487,15 @@ span.obligation {
       }
 
 
-      
+
 /*
     3.3 Lists
 */
-        
+
     ul {
     margin-left: 1.2em;
   }
-      
+
 ol {
   margin-left: 1.2em; }
 
@@ -810,11 +771,11 @@ p {
       font-family: $headerfont;
       font-size: 1.2em;
 	line-height: 1.2em;
-	font-weight: 900; 
+	font-weight: 900;
 	padding-left: 1em;
 	padding-right: 1em;
   }
-  
+
   .title-section1 {
     padding: 0 2em 0 3em;
   }
@@ -822,8 +783,8 @@ p {
   .prefatory-section {
     padding: 0 3em 0 6em;
   }
-  
-  
+
+
   .zzSTDTitle1, .MsoCommentText {
     display: none;
   }
@@ -839,13 +800,13 @@ p {
       text-transform: uppercase;
       font-weight: 600;
   }
-  
+
   .coverpage-tc-name {
     font-size: 1.2em;
     line-height: 1.2em;
     margin: 0.25em 0;
   }
-  
+
 /*
     4.2 Document Identity
 */
@@ -854,8 +815,8 @@ p {
     font-size: 2em;
     line-height: 2em;
   }
-  
-  
+
+
   .coverpage-title .title-second {
     display: none;
   }
@@ -869,13 +830,13 @@ p {
   }
 
 
-  
-  
+
+
 /*
     4.3 Draft Warning
 */
 
-  
+
   .coverpage-warning {
     border-top: solid 1px #f36f36;
     border-bottom: solid 1px #f36f36;
@@ -883,7 +844,7 @@ p {
     color: #485094;
     padding: 1em;
   }
-  
+
   .coverpage-warning .title {
     color: #f36f36;
     font-family: $headerfont;
@@ -892,21 +853,21 @@ p {
     font-size: 1.2em;
   }
 
-  
-  
+
+
 /*
     4.4 Copyright
-*/  
+*/
 
   .copyright {
     padding: 1em;
     font-size: 0.8em;
     text-align: left;
   }
-  
-  
+
+
   .copyright .name, .copyright .address {color: #485094;}
-  
+
 
 
 /*
@@ -936,7 +897,7 @@ To top button
     padding: 10px 15px 10px 15px;
     border-radius: 4px;
   }
-  
+
   #myBtn:hover {
     opacity: 1;
   }

data/lib/isodoc/csd/metadata.rb

@@ -1,10 +1,12 @@
 require "isodoc"
+require "metanorma/csd"
 
 module IsoDoc
   module Csd
     # A {Converter} implementation that generates CSD output, and a document
     # schema encapsulation of the document for validation
     class Metadata < IsoDoc::Metadata
+
       def initialize(lang, script, labels)
         super
         set(:status, "XXX")
@@ -27,14 +29,39 @@ module IsoDoc
 
       def docid(isoxml, _out)
         docnumber = isoxml.at(ns("//bibdata/docidentifier"))
-        docstatus = isoxml.at(ns("//bibdata/status"))
-        dn = docnumber&.text || "???"
-        if docstatus
-          set(:status, status_print(docstatus.text))
-          abbr = status_abbr(docstatus.text)
-          dn += "/#{abbr}" unless abbr.empty?
+
+        prefix = "CC"
+
+        if docnumber.nil?
+          set(:docnumber, prefix)
         end
-        set(:docnumber, dn)
+
+        dn = docnumber&.text
+
+        doctype = isoxml&.at(ns("//bibdata"))&.attr("type")
+        typesuffix = ::Metanorma::Csd::DOCSUFFIX[doctype] || ""
+        unless typesuffix.empty?
+          prefix += "/#{typesuffix}"
+        end
+
+        docstatus = isoxml&.at(ns("//bibdata/status"))
+        unless docstatus.nil?
+          status_text = docstatus.text
+          status = ::Metanorma::Csd::DOCSTATUS[status_text] || ""
+          unless status.empty?
+            set(:status, status_print(status_text))
+            prefix += "/#{status}"
+          end
+        end
+
+        docid = "#{prefix} #{dn}"
+
+        year = isoxml&.at(ns("//bibdata/copyright/from"))&.text
+        if year
+          docid += ":#{year}"
+        end
+
+        set(:docnumber, docid)
       end
 
       def status_print(status)
@@ -42,15 +69,7 @@ module IsoDoc
       end
 
       def status_abbr(status)
-        case status
-        when "working-draft" then "WD"
-        when "committee-draft" then "CD"
-        when "draft-standard" then "DS"
-        when "final-draft" then "FDS"
-        # when "published" then ""
-        else
-          ""
-        end
+        ::Metanorma::Csd::DOCSTATUS[status] || ""
       end
     end
   end

data/lib/metanorma/csd.rb

@@ -3,5 +3,27 @@ require_relative "./csd/processor"
 module Metanorma
   module Csd
 
+    DOCSUFFIX = {
+      "standard" => "",
+      "directive" => "DIR",
+      "guide" => "Guide",
+      "specification" => "S",
+      "report" => "R",
+      "amendment" => "Amd",
+      "technical-corrigendum" => "Cor",
+      "administrative" => "A",
+      "advisory" => "Adv",
+    }
+
+    DOCSTATUS = {
+      "working-draft" => "WD",
+      "committee-draft" => "CD",
+      "draft-standard" => "DS",
+      "final-draft" => "FDS",
+      "published" => "",
+      "cancelled" => "",
+      "withdrawn" => "",
+    }
+
   end
 end

data/lib/metanorma/csd/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Csd
-    VERSION = "1.0.7"
+    VERSION = "1.0.8"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-csd
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-27 00:00:00.000000000 Z
+date: 2018-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc