metanorma-m3d 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33357663540823bfd36ac345d42da5814b1d69f3b7b8652434db43a927b8dd3f
-  data.tar.gz: 15cd653c3ec6952ca03bb33fb989c7eef1670aac3798f322fb8eddbe0b2aca4c
+  metadata.gz: 8391270f98c3dc1df190b52dec7641db3b500296b081a36fbcff596b49b7a335
+  data.tar.gz: 352a3fecc4687580b3f96c6f549d49faec6107a21eee37f45648e7fdd82c9e1f
 SHA512:
-  metadata.gz: 2d21bed6f5986e92fface06808c8096d89bb2d7e363103a282020b65226c2a8ad0680fbcce966b7a39393eb7eb821db3792a1c77406ce2507bb49c0beb534e62
-  data.tar.gz: 293bf2115c741bfca50a427b1138b3cc1516851114e231d7069aba386c9c9268579574ef2d3448e7676bc10fba25d2f6a3f442bdf0197c2951bec65557f1a15b
+  metadata.gz: c6a041e2e7378ba80d6b2fc6b9d76f702a18daab3fc9e980be243cba41e59172e891d979bb5841dc3e40a93b09b12983d432130d5f1483832a6783e27b50ae5a
+  data.tar.gz: edbbfa7950cc912283be30f26b0dc0810c0df83462fd710e64df7487119b9ce22bb10ccdf855aabe1f4af7d3dd2d1d9262d6b581b94ac7d240a2ec1e1fdb264c

data/.travis.yml

@@ -8,6 +8,8 @@ rvm:
   - ruby-head
 before_install:
   - gem install bundler -v 1.16.1
+  - npm install -g puppeteer
+  - npm install
   - unset _JAVA_OPTIONS
 matrix:
   allow_failures:

data/lib/asciidoctor/m3d/converter.rb

@@ -121,6 +121,7 @@ module Asciidoctor
             gsub(%r{^.*/}, "")
           File.open(filename, "w") { |f| f.write(ret) }
           html_converter(node).convert filename unless node.attr("nodoc")
+          pdf_converter(node).convert filename unless node.attr("nodoc")
           word_converter(node).convert filename unless node.attr("nodoc")
         end
         @files_to_delete.each { |f| system "rm #{f}" }
@@ -161,6 +162,10 @@ module Asciidoctor
         IsoDoc::M3d::WordConvert.new(doc_extract_attributes(node))
       end
 
+      def pdf_converter(node)
+        IsoDoc::M3d::PdfConvert.new(html_extract_attributes(node))
+      end
+
       def inline_quoted(node)
         noko do |xml|
           case node.type

data/lib/asciidoctor/m3d/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module M3d
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

data/lib/isodoc/m3d/html/html_m3d_titlepage.html

@@ -33,21 +33,23 @@
   </div>
 
   <div class="docinfo">
-    Updated <span class="date">{{ revdate_monthyear }}</span>,
-    Version <span class="version">{{ draft }}</span> <br/>
+    {% if revdate_monthyear -%}Updated <span class="date">{{ revdate_monthyear }}</span>{%- endif -%}{%- if revdate_monthyear and draft -%},{%- endif -%}{%- if draft -%}Version <span class="version">{{ draft }}</span>{%- endif -%}
+    <br/>
     {% if url %}
     Shortened URL to this document:  <a href="{{ url }}">{{ url }}</a>
     {% endif %}
   </div>
 
+  {% if tc %}
   <div class="coverpage-tc-name">
     <span>TC {{ tc }}</span>
   </div>
+  {% endif %}
   </div>
 
   <div class="title-section1">
   <div class="coverpage-stage-block" >
-    <span class="coverpage-stage" id="{{ doctype | replace: ' ', '-' | downcase }}">Ribose {{ doctype }}</span>
+    <span class="coverpage-stage" id="{{ doctype | replace: ' ', '-' | downcase }}">{{ doctype }}</span>
   </div>
 
   <div class="coverpage-stage-block" >

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

@@ -67,10 +67,10 @@ time, mark, audio, video {
 
 
 html, body, div, span, applet, object, iframe,
-p, blockquote, pre,
-a, abbr, acronym, address, big, cite, code,
-del, dfn, em, img, ins, kbd, q, s, samp,
-small, strike, strong, sub, sup, tt, var,
+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,
 fieldset, form, label, legend,
@@ -82,6 +82,10 @@ time, mark, audio, video {
   font-family: $bodyfont;
 }
 
+code, pre, tt, kbd, samp {
+  font-family: $monospacefont;
+}
+
 h1, h2, h3, h4, h5, h6, .h2Annex {
   font-family: $headerfont;
 }
@@ -154,7 +158,7 @@ table {
 */
 
 
-@media (min-width: 768px) {
+@media screen and (min-width: 768px) {
     nav {
         position: fixed;
         top: 0;
@@ -205,7 +209,7 @@ table {
     }
 }
 
-@media (max-width: 768px) {
+@media screen and (max-width: 768px) {
     #toc {
         padding: 0 1.5em 0 1.5em;
         overflow: visible;
@@ -447,6 +451,7 @@ p.document-stage {
     font-size: 1.1em;
   }
 
+@media screen {
   span[id^="toc"]:after {
     float: left;
     padding-right: 4px;
@@ -457,6 +462,7 @@ p.document-stage {
     color: #cfcfcf;
     content: "\f0c1";
   }
+}
 
   .TermNum, .Terms, .AltTerms {
     color: black;
@@ -816,6 +822,7 @@ p {
 
   .coverpage-logo img {
       width: 400px;
+      height: auto;
   }
 
 
@@ -994,7 +1001,7 @@ a.anchorjs-link:hover {
 
 @media print {
     .section-title {page-break-before: always;}
-    nav, #toc, #toggle, .document-stage-band,
+    #toggle, .document-stage-band,
     .document-type-band {display: none;}
     .container {padding-left: 0;}
 

data/lib/isodoc/m3d/html/m3d.scss

@@ -584,14 +584,6 @@ div.coverpage_warning
   margin: 0.25em 0;
 }
 
-.coverpage-doc-identity {
-  background-color: #485094;
-  color: white;
-  font-size: 2em;
-  line-height: 2em;
-  margin: 0.5em 0;
-}
-
 .coverpage-title {
   font-weight: 400;
 }
@@ -668,17 +660,6 @@ aside {
           font-size:10.0pt;
 }
 
-/*
-div.example {
-	border:solid black .25pt;
-	mso-border-alt:solid black .25pt;
-	padding:10pt;
-	mso-padding-alt:10.0pt 10.0pt 10.0pt 10.0pt;
-	margin:10pt;
-	mso-margin-alt:10.0pt 10.0pt 10.0pt 10.0pt;
-}
-*/
-
 div.example {
   margin-left:70.9pt;
   text-indent:-70.9pt;

data/lib/{asciidoctor/m3d/html/scripts.html → isodoc/m3d/html/scripts.pdf.html}

@@ -1,11 +1,12 @@
-  <script>//TOC generation
+  <script>
+    //TOC generation
       $('#toc').toc({
           'selectors': 'h1,h2:not(.TermNum)', //elements to use as headings
           'container': 'main', //element to find all selectors in
           'smoothScrolling': true, //enable or disable smooth scrolling on click
           'prefix': 'toc', //prefix for anchor tags and class names
           'onHighlight': function(el) {}, //called when a new section is highlighted 
-          'highlightOnScroll': true, //add class to heading that is currently in focus
+          'highlightOnScroll': false, //add class to heading that is currently in focus
           'highlightOffset': 100, //offset to trigger the next headline
           'anchorName': function(i, heading, prefix) { //custom function for anchor name
               return prefix+i;
@@ -56,13 +57,14 @@ $('#toggle').on('click', function(){
     }
     </script>
 
-<script>
+  <script>
   $(document).ready(function() {
-	  $('[id^=toc]').each(function ()
-	  {
-	     var currentToc = $(this);
+          $('[id^=toc]').each(function ()
+          {
+             var currentToc = $(this);
        var url = window.location.href;
-	     currentToc.wrap("<a href='" + url + "#" + currentToc.attr("id") + "' </a>");
-	  });
+             currentToc.wrap("<a href='" + url + "#" + currentToc.attr("id") + "' </a>");
+          });
 });
 </script>
+

data/lib/isodoc/m3d/m3dhtmlconvert.rb

@@ -35,6 +35,7 @@ module IsoDoc
           htmlstylesheet: html_doc_path("htmlstyle.scss"),
           htmlcoverpage: html_doc_path("html_m3d_titlepage.html"),
           htmlintropage: html_doc_path("html_m3d_intro.html"),
+          standardstylesheet: nil,
           scripts: html_doc_path("scripts.html"),
         }
       end
@@ -48,7 +49,7 @@ module IsoDoc
           div << <<~"COLOPHON"
           <p>As with all M3AAWG documents that we publish, please check the M3AAWG website
           (<a href="http://www.m3aawg.org">www.m3aawg.org</a>) for updates to this paper.</p>
-          <p>&copy; 2017 copyright by the Messaging, Malware and Mobile Anti-Abuse Working Group (M3AAWG)</p>
+          <p>&copy; {{ docyear }} copyright by the Messaging, Malware and Mobile Anti-Abuse Working Group (M3AAWG)</p>
           COLOPHON
         end
       end

data/lib/isodoc/m3d/m3dpdfconvert.rb

@@ -0,0 +1,155 @@
+require "isodoc"
+require_relative "metadata"
+require_relative "m3dpdfrender"
+require "fileutils"
+
+module IsoDoc
+  module M3d
+    # A {Converter} implementation that generates CSAND output, and a document
+    # schema encapsulation of the document for validation
+    class PdfConvert < IsoDoc::PdfConvert
+      def add_image(filenames)
+        filenames.each do |filename|
+          FileUtils.cp html_doc_path(filename), filename
+          @files_to_delete << filename
+        end
+      end
+
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        super
+        add_image(%w(logo.jpg m3-logo.png))
+      end
+
+      def default_fonts(options)
+        {
+          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Overpass",sans-serif'),
+          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Overpass",sans-serif'),
+          monospacefont: '"Space Mono",monospace'
+        }
+      end
+
+      def default_file_locations(_options)
+        {
+          htmlstylesheet: html_doc_path("htmlstyle.scss"),
+          htmlcoverpage: html_doc_path("html_m3d_titlepage.html"),
+          htmlintropage: html_doc_path("html_m3d_intro.html"),
+          standardstylesheet: nil,
+          scripts_pdf: html_doc_path("scripts.pdf.html"),
+        }
+      end
+
+      def metadata_init(lang, script, labels)
+        @meta = Metadata.new(lang, script, labels)
+      end
+
+      def colophon(body, docxml)
+        body.div **{ class: "colophon" } do |div|
+          div << <<~"COLOPHON"
+          <p>As with all M3AAWG documents that we publish, please check the M3AAWG website
+          (<a href="http://www.m3aawg.org">www.m3aawg.org</a>) for updates to this paper.</p>
+          <p>&copy; {{ docyear }} copyright by the Messaging, Malware and Mobile Anti-Abuse Working Group (M3AAWG)</p>
+          COLOPHON
+        end
+      end
+
+      def html_head()
+        <<~HEAD.freeze
+        <title>{{ doctitle }}</title>
+    <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+
+    <!--TOC script import-->
+    <script type="text/javascript"  src="https://cdn.rawgit.com/jgallen23/toc/0.3.2/dist/toc.min.js"></script>
+
+    <!--Google fonts-->
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i|Space+Mono:400,700" rel="stylesheet">
+    <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet">
+    <!--Font awesome import for the link icon-->
+    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/solid.css" integrity="sha384-v2Tw72dyUXeU3y4aM2Y0tBJQkGfplr39mxZqlTBDUZAb9BGoC40+rdFCG0m10lXk" crossorigin="anonymous">
+    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/fontawesome.css" integrity="sha384-q3jl8XQu1OpdLgGFvNRnPdj5VIlCvgsDQTQB6owSOHWlAurxul7f+JpUOVdAiJ5P" crossorigin="anonymous">
+<style class="anchorjs"></style>
+        HEAD
+      end
+
+      def make_body(xml, docxml)
+        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72", "xml:lang": "EN-US", class: "container" }
+        xml.body **body_attr do |body|
+          make_body1(body, docxml)
+          make_body2(body, docxml)
+          make_body3(body, docxml)
+          colophon(body, docxml)
+        end
+      end
+
+      def html_toc(docxml)
+        docxml
+      end
+
+      def annex_name(annex, name, div)
+        div.h1 **{ class: "Annex" } do |t|
+          t << "#{get_anchors[annex['id']][:label]} "
+          t << "<b>#{name.text}</b>"
+        end
+      end
+
+      def annex_name_lbl(clause, num)
+        obl = l10n("(#{@inform_annex_lbl})")
+        obl = l10n("(#{@norm_annex_lbl})") if clause["obligation"] == "normative"
+        l10n("<b>#{@annex_lbl} #{num}</b> #{obl}")
+      end
+
+      def pre_parse(node, out)
+        out.pre node.text # content.gsub(/</, "&lt;").gsub(/>/, "&gt;")
+      end
+
+      def term_defs_boilerplate(div, source, term, preface)
+        if source.empty? && term.nil?
+          div << @no_terms_boilerplate
+        else
+          div << term_defs_boilerplate_cont(source, term)
+        end
+      end
+
+      def i18n_init(lang, script)
+        super
+        @annex_lbl = "Appendix"
+      end
+
+      def error_parse(node, out)
+        # catch elements not defined in ISO
+        case node.name
+        when "pre"
+          pre_parse(node, out)
+        when "keyword"
+          out.span node.text, **{ class: "keyword" }
+        else
+          super
+        end
+      end
+
+      def fileloc(loc)
+        File.join(File.dirname(__FILE__), loc)
+      end
+
+      def cleanup(docxml)
+        super
+        term_cleanup(docxml)
+      end
+
+      def term_cleanup(docxml)
+        docxml.xpath("//p[@class = 'Terms']").each do |d|
+          h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
+          h2.add_child("&nbsp;")
+          h2.add_child(d.remove)
+        end
+        docxml
+      end
+
+      def info(isoxml, out)
+        @meta.url isoxml, out
+        super
+      end
+    end
+  end
+end
+

data/lib/isodoc/m3d/m3dpdfrender.rb

@@ -0,0 +1,68 @@
+module IsoDoc
+  module M3d
+    # A {Converter} implementation that generates CSAND output, and a document
+    # schema encapsulation of the document for validation
+    class PdfConvert < IsoDoc::PdfConvert
+      def annex_name(annex, name, div)
+        div.h1 **{ class: "Annex" } do |t|
+          t << "#{get_anchors[annex['id']][:label]} "
+          t << "<b>#{name.text}</b>"
+        end
+      end
+
+      def annex_name_lbl(clause, num)
+        obl = l10n("(#{@inform_annex_lbl})")
+        obl = l10n("(#{@norm_annex_lbl})") if clause["obligation"] == "normative"
+        l10n("<b>#{@annex_lbl} #{num}</b> #{obl}")
+      end
+
+      def pre_parse(node, out)
+        out.pre node.text # content.gsub(/</, "&lt;").gsub(/>/, "&gt;")
+      end
+
+      def term_defs_boilerplate(div, source, term, preface)
+        if source.empty? && term.nil?
+          div << @no_terms_boilerplate
+        else
+          div << term_defs_boilerplate_cont(source, term)
+        end
+      end
+
+      def i18n_init(lang, script)
+        super
+        @annex_lbl = "Appendix"
+      end
+
+      def error_parse(node, out)
+        # catch elements not defined in ISO
+        case node.name
+        when "pre"
+          pre_parse(node, out)
+        when "keyword"
+          out.span node.text, **{ class: "keyword" }
+        else
+          super
+        end
+      end
+
+      def fileloc(loc)
+        File.join(File.dirname(__FILE__), loc)
+      end
+
+      def cleanup(docxml)
+        super
+        term_cleanup(docxml)
+      end
+
+      def term_cleanup(docxml)
+        docxml.xpath("//p[@class = 'Terms']").each do |d|
+          h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
+          h2.add_child("&nbsp;")
+          h2.add_child(d.remove)
+        end
+        docxml
+      end
+    end
+  end
+end
+