isodoc 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d32b7fb0ccf46bf00db077c1f952a95a39dc114c10c22ce24962a4dc7e084bec
-  data.tar.gz: 4f6af811725e65d76950fda577e1ef3ff6f2a9e0dd10f970f13799eb2ca21be9
+  metadata.gz: e2307d0897bc261ade077a3550818f09a5d008640f2711809d0daf173f57e40c
+  data.tar.gz: 1a26f9322f6277cbc7534b8161d5798777a2e7683b782c402a5c1c8a4825cd6d
 SHA512:
-  metadata.gz: 294dd638a3e080df5d3b02d78d2d27a635353ddd911422ff7a65b7c6dc461c5c686c0663392807c46081184e7721c00e66b4f9e2cc5a9ada8971394b78b1ef97
-  data.tar.gz: '0428344db3cf6dceae24089c25e91f72e1fc1db90b03bca1e5bd48d927720c6e84379f08acb861621a91bace3af950357821ee396c842f05fa889ab3f51d5b6f'
+  metadata.gz: 322b6d4ea3fbc7aedb90fddbeeae80347058e1a78b55e0b4fb7fea4fbbd4a26251cdd72fb664eb8bd36a082ca70e8bc39ad0e34eaec2143ed6b6ce9b9eed5af9
+  data.tar.gz: cf491aa85b5b08741027d50379be5c1be9a0ad252c20a56380429b828a2a6a6a899747830aaf1cf20bddb6a19ca5fabc7944fde58f11a1c908f9181d2feb095f

data/Gemfile.lock

@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/riboseinc/html2doc.git
-  revision: 6c69bb488b9adc2654276986c657b05bfa82f34d
+  revision: f8bd693d8748c622bbe8f24ab30ac142b2543a0a
   specs:
-    html2doc (0.7.1)
+    html2doc (0.8.0)
       asciimath
       htmlentities (~> 4.3.4)
       image_size
@@ -15,9 +15,9 @@ GIT
 PATH
   remote: .
   specs:
-    isodoc (0.6.2)
+    isodoc (0.7.0)
       asciimath
-      html2doc
+      html2doc (>= 0.7.1)
       htmlentities (~> 4.3.4)
       image_size
       liquid
@@ -40,7 +40,7 @@ GEM
     docile (1.3.1)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    ffi (1.9.23)
+    ffi (1.9.25)
     formatador (0.2.5)
     guard (2.14.2)
       formatador (>= 0.2.4)

data/README.adoc

@@ -1,12 +1,15 @@
-= isodoc
-
+= isodoc: Ruby gem for converting ISODoc documents into HTML/Word
 
 image:https://img.shields.io/gem/v/isodoc.svg["Gem Version", link="https://rubygems.org/gems/isodoc"]
 image:https://img.shields.io/travis/riboseinc/asciidoctor-iso/master.svg["Build Status", link="https://travis-ci.org/riboseinc/isodoc"]
 image:https://codeclimate.com/github/riboseinc/isodoc/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/isodoc"]
 
+== Purpose
+
 This Gem converts documents in the https://github.com/riboseinc/isodoc-models[ISODoc document model] into HTML and Microsoft Word.
 
+== Usage
+
 The Gem contains two classes, `IsoDoc::Convert` (for HTML output) and `IsoDoc::WordConvert` (for Word output). They are initialised with the following rendering parameters:
 
 i18nyaml:: YAML file giving internationalisation equivalents for keywords in rendering output; see https://github.com/riboseinc/asciidoctor-iso#document-attributes for further documentation
@@ -22,38 +25,47 @@ The IsoDoc gem classes themselves are abstract (though their current implementat
 e.g.
 
 [source,ruby]
---
-        IsoDoc::Convert::Iso.new(
-          bodyfont: "Zapf Chancery", 
-          headerfont: "Comic Sans", 
-          monospacefont: "Andale Mono",
-          alt: true,
-          script: "Hans",
-          i18nyaml: "i18n-en.yaml"
-        )
---
+----
+IsoDoc::Convert::Iso.new(
+  bodyfont: "Zapf Chancery",
+  headerfont: "Comic Sans",
+  monospacefont: "Andale Mono",
+  alt: true,
+  script: "Hans",
+  i18nyaml: "i18n-en.yaml"
+)
+----
 
 The conversion takes place with a `convert` method, with three arguments: the filename to be used for the output (once its file type suffix is stripped), the XML document string to be converted (optional), and a "debug" argument (optional), which stops execution before the output file is generated. If the document string is nil, its contents are read in from the filename provided. So:
 
 [source,ruby]
---
-IsoDoc::Iso::Convert.new({}).convert("test.xml") # generates test.html
+----
+# generates test.html
+IsoDoc::Iso::Convert.new({}).convert("test.xml")
 
-IsoDoc::Iso::WordConvert.new({script: "Hans"}).convert("test.xml") # generates test.doc, with Chinese font defaults rather than Roman
+# generates test.doc, with Chinese font defaults rather than Roman
+IsoDoc::Iso::WordConvert.new({script: "Hans"}).convert("test.xml")
 
-IsoDoc::Iso::Convert.new({}).convert("test", File.read("file1.xml")) # generates test.html, based on file1.xml
+# generates test.html, based on file1.xml
+IsoDoc::Iso::Convert.new({}).convert("test", File.read("file1.xml"))
 
+# generates HTML output for the given input string, but does not save it to disk.
 IsoDoc::Iso::Convert.new({}).convert("test", <<~"INPUT", true)
-    <iso-standard xmlns="http://riboseinc.com/isoxml">
+  <iso-standard xmlns="http://riboseinc.com/isoxml">
     <preface><foreword>
     <note>
-    <p id="_f06fd0d1-a203-4f3d-a515-0bdba0f8d83f">These results are based on a 
+      <p id="_f06fd0d1-a203-4f3d-a515-0bdba0f8d83f">These results are based on a
       study carried out on three different types of kernel.</p>
     </note>
     </foreword></preface>
-    </iso-standard>
-    INPUT
-# generates HTML output for the given input string, but does not save it to disk.
---
+  </iso-standard>
+  INPUT
+----
 
 NOTE: In the HTML stylesheets specific to standards, the Cover page and Intro page must be XHTML fragments, not HTML fragments. In particular, unlike Word HTML, all HTML attributes need to be quoted: `<p class="MsoToc2">`, not `<p class=MsoToc2>`.
+
+== Converting Word output into "`Native Word`" (`.docx`)
+
+This gem relies on https://github.com/riboseinc/html2doc[html2doc] to generate Microsoft Word documents.
+
+Please see https://github.com/riboseinc/html2doc#converting-document-output-to-native-word-docx[this post-processing procedure] to convert output into a native-`docx` document.

data/isodoc.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ruby-xslt"
   spec.add_dependency "thread_safe"
   spec.add_dependency "uuidtools"
-  spec.add_dependency "html2doc"
+  spec.add_dependency "html2doc", ">= 0.7.1"
   spec.add_dependency "liquid"
   spec.add_dependency "roman-numerals"
   spec.add_dependency "sass"

data/lib/isodoc.rb

@@ -1,4 +1,4 @@
-module Isodoc
+module IsoDoc
 
 require_relative "isodoc/version"
 
@@ -12,6 +12,8 @@ require "image_size"
 require "set"
 require "pp"
 require "isodoc/convert"
+require "isodoc/metadata"
+require "isodoc/htmlconvert/convert"
 require "isodoc/wordconvert/convert"
 require "isodoc/iso/convert"
 require "isodoc/iso/wordconvert"

data/lib/isodoc/blocks.rb

@@ -1,5 +1,5 @@
 module IsoDoc
-  class Convert
+  class Common
     @annotation = false
 
     def note_label(node)

data/lib/isodoc/cleanup.rb

@@ -4,7 +4,7 @@ require "nokogiri"
 require "pp"
 
 module IsoDoc
-  class Convert
+  class Common
     def cleanup(docxml)
       comment_cleanup(docxml)
       footnote_cleanup(docxml)

data/lib/isodoc/convert.rb

@@ -9,16 +9,13 @@ require "isodoc/blocks"
 require "isodoc/lists"
 require "isodoc/table"
 require "isodoc/inline"
-require "isodoc/footnotes"
-require "isodoc/comments"
 require "isodoc/xref_gen"
 require "isodoc/xref_sect_gen"
-require "isodoc/html"
 require "isodoc/i18n"
 require "sass"
 
 module IsoDoc
-  class Convert
+  class Common
 
     # htmlstylesheet: Generic stylesheet for HTML
     # wordstylesheet: Generic stylesheet for Word
@@ -49,8 +46,6 @@ module IsoDoc
       @note = false
       @sourcecode = false
       @anchors = {}
-      @meta = {}
-      init_metadata
       @footnotes = []
       @comments = []
       @in_footnote = false
@@ -91,12 +86,18 @@ module IsoDoc
       end.join("\n")
     end
 
+    def metadata_init(lang, script, labels)
+            @meta = Metadata.new(lang, script, labels)
+    end
+
     def convert_init(file, filename, debug)
       docxml = Nokogiri::XML(file)
       filename, dir = init_file(filename, debug)
       docxml.root.default_namespace = ""
-      i18n_init(docxml&.at(ns("//bibdata/language"))&.text || "en",
-                docxml&.at(ns("//bibdata/script"))&.text || "Latn")
+      lang = docxml&.at(ns("//bibdata/language"))&.text || "en"
+      script = docxml&.at(ns("//bibdata/script"))&.text || "Latn"
+      i18n_init(lang, script)
+      metadata_init(lang, script, @labels)
       [docxml, filename, dir]
     end
 

data/lib/isodoc/{comments.rb → htmlconvert/comments.rb}

@@ -1,7 +1,7 @@
 require "uuidtools"
 
 module IsoDoc
-  class Convert
+  class Convert < Common
     def in_comment
       @in_comment
     end

data/lib/isodoc/htmlconvert/convert.rb

@@ -0,0 +1,13 @@
+require "uuidtools"
+require "html2doc"
+require "liquid"
+
+require_relative "comments.rb"
+require_relative "footnotes.rb"
+require_relative "html.rb"
+
+module IsoDoc
+
+    class Convert < Common
+    end 
+end

data/lib/isodoc/{footnotes.rb → htmlconvert/footnotes.rb}

@@ -1,7 +1,7 @@
 require "uuidtools"
 
 module IsoDoc
-  class Convert
+  class Convert < Common
     def footnotes(div)
       return if @footnotes.empty?
       @footnotes.each { |fn| div.parent << fn }

data/lib/isodoc/{html.rb → htmlconvert/html.rb}

@@ -1,5 +1,30 @@
 module IsoDoc
-  class Convert
+  class Convert < Common
+        def make_body1(body, _docxml)
+      body.div **{ class: "title-section" } do |div1|
+        div1.p { |p| p << "&nbsp;" } # placeholder
+      end
+      section_break(body)
+    end
+
+    def make_body2(body, docxml)
+      body.div **{ class: "prefatory-section" } do |div2|
+        info docxml, div2
+        div2.p { |p| p << "&nbsp;" } # placeholder
+      end
+      section_break(body)
+    end
+
+    def make_body3(body, docxml)
+      body.div **{ class: "main-section" } do |div3|
+        foreword docxml, div3
+        introduction docxml, div3
+        middle docxml, div3
+        footnotes div3
+        comments div3
+      end
+    end
+
     def postprocess(result, filename, dir)
       result = from_xhtml(cleanup(to_xhtml(result)))
       toHTML(result, filename)
@@ -76,7 +101,7 @@ module IsoDoc
 
     def html_main(docxml)
       docxml.at("//head").add_child(html_head())
-      d = docxml.at('//div[@class="WordSection3"]')
+      d = docxml.at('//div[@class="main-section"]')
       d.name = "main"
       d.children.first.previous = html_button()
     end
@@ -96,14 +121,14 @@ module IsoDoc
     def html_cover(docxml)
       cover = File.read(@htmlcoverpage, encoding: "UTF-8")
       coverxml = to_xhtml_fragment(cover)
-      d = docxml.at('//div[@class="WordSection1"]')
+      d = docxml.at('//div[@class="title-section"]')
       d.children.first.add_previous_sibling coverxml.to_xml(encoding: "US-ASCII")
     end
 
     def html_intro(docxml)
       intro = File.read(@htmlintropage, encoding: "UTF-8")
       introxml = to_xhtml_fragment(intro)
-      d = docxml.at('//div[@class="WordSection2"]')
+      d = docxml.at('//div[@class="prefatory-section"]')
       d.children.first.add_previous_sibling introxml.to_xml(encoding: "US-ASCII")
     end
 

data/lib/isodoc/i18n-en.yaml

@@ -9,13 +9,13 @@ term_def_boilerplate: |
         <a href=http://www.electropedia.org>http://www.electropedia.org</a>
       </p> </li> </ul>
 scope: Scope
-symbols: Symbols and Abbreviated Terms
-table_of_contents: Table of Contents
+symbols: Symbols and abbreviated terms
+table_of_contents: Table of contents
 introduction: Introduction
 foreword: Foreword
-termsdef: Terms and Definitions
-termsdefsymbols: Terms, Definitions, Symbols and Abbreviated Terms
-normref: Normative References
+termsdef: Terms and definitions
+termsdefsymbols: Terms, definitions, symbols and abbreviated terms
+normref: Normative references
 bibliography: Bibliography
 clause: Clause
 annex: Annex

data/lib/isodoc/i18n.rb

@@ -1,7 +1,7 @@
 require "yaml"
 
 module IsoDoc
-  class Convert
+  class Common
     def i18n_init(lang, script)
       @lang = lang
       @script = script
@@ -84,7 +84,7 @@ module IsoDoc
 
     # function localising spaces and punctuation.
     # Not clear if period needs to be localised for zh
-    def l10n(x, lang = @lang, script = @script)
+    def self.l10n(x, lang, script)
       if lang == "zh" && script == "Hans"
         x.gsub(/ /, "").gsub(/:/, "：").gsub(/,/, "、").
           gsub(/\(/, "（").gsub(/\)/, "）").
@@ -94,5 +94,9 @@ module IsoDoc
         x
       end
     end
+
+    def l10n(x, lang = @lang, script = @script)
+      Common::l10n(x, lang, script)
+    end
   end
 end

data/lib/isodoc/inline.rb

@@ -1,7 +1,7 @@
 require "uuidtools"
 
 module IsoDoc
-  class Convert
+  class Common
     def section_break(body)
       body.br
     end
@@ -13,7 +13,7 @@ module IsoDoc
     def link_parse(node, out)
       linktext = node.text
       linktext = node["target"] if linktext.empty?
-      out.a **{ "href": node["target"] } { |l| l << linktext }
+      out.a(**{ "href": node["target"] }) { |l| l << linktext }
     end
 
     def callout_parse(node, out)
@@ -21,9 +21,9 @@ module IsoDoc
     end
 
     def anchor_linkend(node, linkend)
-      if node["citeas"].nil? && get_anchors.has_key?(node["bibitemid"])
+      if node["citeas"].nil? && node["bibitemid"] && get_anchors.has_key?(node["bibitemid"])
         return get_anchors[node["bibitemid"]][:xref]
-      elsif get_anchors.has_key?(node["target"])
+      elsif node["target"] && get_anchors.has_key?(node["target"])
         linkend = get_anchors[node["target"]][:xref]
         container = get_anchors[node["target"]][:container]
         (container && get_note_container_id(node) != container) &&
@@ -44,7 +44,7 @@ module IsoDoc
 
     def xref_parse(node, out)
       linkend = get_linkend(node)
-      out.a **{ "href": "#" + node["target"] } { |l| l << linkend }
+      out.a(**{ "href": "#" + node["target"] }) { |l| l << linkend }
     end
 
     def eref_localities(refs)
@@ -63,10 +63,10 @@ module IsoDoc
       linkend = get_linkend(node)
       if node["type"] == "footnote"
         out.sup do |s|
-          s.a **{ "href": "#" + node["bibitemid"] } { |l| l << linkend }
+          s.a(**{ "href": "#" + node["bibitemid"] }) { |l| l << linkend }
         end
       else
-        out.a **{ "href": "#" + node["bibitemid"] } { |l| l << linkend }
+        out.a(**{ "href": "#" + node["bibitemid"] }) { |l| l << linkend }
       end
     end
 
@@ -85,7 +85,7 @@ module IsoDoc
     def error_parse(node, out)
       text = node.to_xml.gsub(/</, "&lt;").gsub(/>/, "&gt;")
       out.para do |p|
-        p.b **{ role: "strong" } { |e| e << text }
+        p.b(**{ role: "strong" }) { |e| e << text }
       end
     end
   end

data/lib/isodoc/iso/convert.rb

@@ -41,6 +41,10 @@ module IsoDoc
         @scripts = html_doc_path("scripts.html")
       end
 
+      def implicit_reference(b)
+        isocode = b.at(ns("./docidentifier")).text
+        isocode == "IEV"
+      end
     end
   end
 end

data/lib/isodoc/iso/html/style-human.scss

@@ -128,12 +128,12 @@ main {
     padding-right: 2em;
 }
 
-.WordSection1, .WordSection2 {
+.title-section, .prefatory-section {
     padding-left: 4em;
     padding-top: 2em;
 }
 
-.WordSection2 {
+.prefatory-section {
     margin-bottom: 5em;
 }
 
@@ -350,7 +350,7 @@ p.Terms {
         padding: 0;
     }
 
-    .WordSection1, .WordSection2 {
+    .title-section, .prefatory-section {
         padding-left: 0;
         padding-top: 0;
         width: 100%;