isodoc 1.7.3 → 1.7.6

data/lib/isodoc/html_function/comments.rb

@@ -1,146 +1,142 @@
-module IsoDoc::HtmlFunction
-  module Comments
-
-    def in_comment
-      @in_comment
-    end
+module IsoDoc
+  module HtmlFunction
+    module Comments
+      def in_comment
+        @in_comment
+      end
 
-    def comments(div)
-=begin
-      return if @comments.empty?
-      div.div **{ style: "mso-element:comment-list" } do |div1|
-        @comments.each { |fn| div1.parent << fn }
+      def comments(div)
+        #       return if @comments.empty?
+        #       div.div **{ style: "mso-element:comment-list" } do |div1|
+        #         @comments.each { |fn| div1.parent << fn }
+        #       end
       end
-=end
-    end
 
-    def review_note_parse(node, out)
-=begin
-      fn = @comments.length + 1
-      make_comment_link(out, fn, node)
-      @in_comment = true
-      @comments << make_comment_text(node, fn)
-      @in_comment = false
-=end
-    end
+      def review_note_parse(node, out)
+        #       fn = @comments.length + 1
+        #       make_comment_link(out, fn, node)
+        #       @in_comment = true
+        #       @comments << make_comment_text(node, fn)
+        #       @in_comment = false
+      end
 
-    def comment_link_attrs(fnote, node)
-      { style: "MsoCommentReference", target: fnote,
-        class: "commentLink", from: node["from"],
-        to: node["to"] }
-    end
+      def comment_link_attrs(fnote, node)
+        { style: "MsoCommentReference", target: fnote,
+          class: "commentLink", from: node["from"],
+          to: node["to"] }
+      end
 
-    # add in from and to links to move the comment into place
-    def make_comment_link(out, fnote, node)
-      out.span(**comment_link_attrs(fnote, node)) do |s1|
+      # add in from and to links to move the comment into place
+      def make_comment_link(out, fnote, node)
+        out.span(**comment_link_attrs(fnote, node)) do |s1|
           s1.a **{ style: "mso-comment-reference:SMC_#{fnote};"\
-                   "mso-comment-date:#{node['date'].gsub(/[-:Z]/, '')}" }
+                          "mso-comment-date:#{node['date'].gsub(/[-:Z]/,
+                                                                '')}" }
         end
-    end
+      end
 
-    def make_comment_target(out)
-      out.span **{ style: "MsoCommentReference" } do |s1|
+      def make_comment_target(out)
+        out.span **{ style: "MsoCommentReference" } do |s1|
           s1.span **{ style: "mso-special-character:comment" }
         end
-    end
+      end
 
-    def make_comment_text(node, fnote)
-      noko do |xml|
-        xml.div **{ style: "mso-element:comment", id: fnote } do |div|
-          div.span **{ style: %{mso-comment-author:"#{node['reviewer']}"} }
-          make_comment_target(div)
-          node.children.each { |n| parse(n, div) }
-        end
-      end.join("\n")
-    end
+      def make_comment_text(node, fnote)
+        noko do |xml|
+          xml.div **{ style: "mso-element:comment", id: fnote } do |div|
+            div.span **{ style: %{mso-comment-author:"#{node['reviewer']}"} }
+            make_comment_target(div)
+            node.children.each { |n| parse(n, div) }
+          end
+        end.join("\n")
+      end
 
-    def comment_cleanup(docxml)
-=begin
-      move_comment_link_to_from(docxml)
-      reorder_comments_by_comment_link(docxml)
-      embed_comment_in_comment_list(docxml)
-=end
-    end
+      def comment_cleanup(docxml)
+        #       move_comment_link_to_from(docxml)
+        #       reorder_comments_by_comment_link(docxml)
+        #       embed_comment_in_comment_list(docxml)
+      end
 
-    COMMENT_IN_COMMENT_LIST =
-      '//div[@style="mso-element:comment-list"]//'\
-      'span[@style="MsoCommentReference"]'.freeze
+      COMMENT_IN_COMMENT_LIST =
+        '//div[@style="mso-element:comment-list"]//'\
+        'span[@style="MsoCommentReference"]'.freeze
 
-    def embed_comment_in_comment_list(docxml)
-      docxml.xpath(COMMENT_IN_COMMENT_LIST).each do |x|
-        n = x.next_element
-        n&.children&.first&.add_previous_sibling(x.remove)
+      def embed_comment_in_comment_list(docxml)
+        docxml.xpath(COMMENT_IN_COMMENT_LIST).each do |x|
+          n = x.next_element
+          n&.children&.first&.add_previous_sibling(x.remove)
+        end
+        docxml
       end
-      docxml
-    end
 
-    def move_comment_link_to_from1(x, fromlink)
-      x.remove
-      link = x.at(".//a")
-      fromlink.replace(x)
-      link.children = fromlink
-    end
+      def move_comment_link_to_from1(x, fromlink)
+        x.remove
+        link = x.at(".//a")
+        fromlink.replace(x)
+        link.children = fromlink
+      end
 
-    def comment_attributes(docxml, x)
-      fromlink = docxml.at("//*[@id='#{x['from']}']")
-      return(nil) if fromlink.nil?
+      def comment_attributes(docxml, x)
+        fromlink = docxml.at("//*[@id='#{x['from']}']")
+        return(nil) if fromlink.nil?
 
-      tolink = docxml.at("//*[@id='#{x['to']}']") || fromlink
-      target = docxml.at("//*[@id='#{x['target']}']")
-      { from: fromlink, to: tolink, target: target }
-    end
+        tolink = docxml.at("//*[@id='#{x['to']}']") || fromlink
+        target = docxml.at("//*[@id='#{x['target']}']")
+        { from: fromlink, to: tolink, target: target }
+      end
 
-    def wrap_comment_cont(from, target)
-      s = from.replace("<span style='mso-comment-continuation:#{target}'>")
-      s.first.children = from
-    end
+      def wrap_comment_cont(from, target)
+        s = from.replace("<span style='mso-comment-continuation:#{target}'>")
+        s.first.children = from
+      end
 
-    def skip_comment_wrap(from)
-      from["style"] != "mso-special-character:comment"
-    end
+      def skip_comment_wrap(from)
+        from["style"] != "mso-special-character:comment"
+      end
 
-    def insert_comment_cont(from, upto, target)
-      # includes_to = from.at(".//*[@id='#{upto}']")
-      while !from.nil? && from["id"] != upto
-        following = from.xpath("./following::*")
-        (from = following.shift) && incl_to = from.at(".//*[@id='#{upto}']")
-        while !incl_to.nil? && !from.nil? && skip_comment_wrap(from)
+      def insert_comment_cont(from, upto, target)
+        # includes_to = from.at(".//*[@id='#{upto}']")
+        while !from.nil? && from["id"] != upto
+          following = from.xpath("./following::*")
           (from = following.shift) && incl_to = from.at(".//*[@id='#{upto}']")
+          while !incl_to.nil? && !from.nil? && skip_comment_wrap(from)
+            (from = following.shift) && incl_to = from.at(".//*[@id='#{upto}']")
+          end
+          wrap_comment_cont(from, target) if !from.nil?
         end
-        wrap_comment_cont(from, target) if !from.nil?
       end
-    end
 
-    def move_comment_link_to_from(docxml)
-      docxml.xpath('//span[@style="MsoCommentReference"][@from]').each do |x|
-        attrs = comment_attributes(docxml, x) || next
-        move_comment_link_to_from1(x, attrs[:from])
-        insert_comment_cont(attrs[:from], x["to"], x["target"])
+      def move_comment_link_to_from(docxml)
+        docxml.xpath('//span[@style="MsoCommentReference"][@from]').each do |x|
+          attrs = comment_attributes(docxml, x) || next
+          move_comment_link_to_from1(x, attrs[:from])
+          insert_comment_cont(attrs[:from], x["to"], x["target"])
+        end
       end
-    end
 
-    def get_comments_from_text(docxml, link_order)
-      comments = []
-      docxml.xpath("//div[@style='mso-element:comment']").each do |c|
-        next unless c["id"] && !link_order[c["id"]].nil?
+      def get_comments_from_text(docxml, link_order)
+        comments = []
+        docxml.xpath("//div[@style='mso-element:comment']").each do |c|
+          next unless c["id"] && !link_order[c["id"]].nil?
 
-        comments << { text: c.remove.to_s, id: c["id"] }
+          comments << { text: c.remove.to_s, id: c["id"] }
+        end
+        comments.sort! { |a, b| link_order[a[:id]] <=> link_order[b[:id]] }
+        # comments
       end
-      comments.sort! { |a, b| link_order[a[:id]] <=> link_order[b[:id]] }
-      # comments
-    end
 
-    COMMENT_TARGET_XREFS =
-      "//span[@style='mso-special-character:comment']/@target".freeze
+      COMMENT_TARGET_XREFS =
+        "//span[@style='mso-special-character:comment']/@target".freeze
 
-    def reorder_comments_by_comment_link(docxml)
-      link_order = {}
-      docxml.xpath(COMMENT_TARGET_XREFS).each_with_index do |target, i|
-        link_order[target.value] = i
+      def reorder_comments_by_comment_link(docxml)
+        link_order = {}
+        docxml.xpath(COMMENT_TARGET_XREFS).each_with_index do |target, i|
+          link_order[target.value] = i
+        end
+        comments = get_comments_from_text(docxml, link_order)
+        list = docxml.at("//*[@style='mso-element:comment-list']") || return
+        list.children = comments.map { |c| c[:text] }.join("\n")
       end
-      comments = get_comments_from_text(docxml, link_order)
-      list = docxml.at("//*[@style='mso-element:comment-list']") || return
-      list.children = comments.map { |c| c[:text] }.join("\n")
     end
   end
 end

data/lib/isodoc/html_function/footnotes.rb

@@ -1,90 +1,91 @@
-module IsoDoc::HtmlFunction
-  module Footnotes
+module IsoDoc
+  module HtmlFunction
+    module Footnotes
+      def footnotes(div)
+        return if @footnotes.empty?
 
-    def footnotes(div)
-      return if @footnotes.empty?
-
-      @footnotes.each { |fn| div.parent << fn }
-    end
-
-    def make_table_footnote_link(out, fnid, fnref)
-      attrs = { href: "##{fnid}", class: "TableFootnoteRef" }
-      out.a **attrs do |a|
-        a << fnref
+        @footnotes.each { |fn| div.parent << fn }
       end
-    end
 
-    def make_table_footnote_target(out, fnid, fnref)
-      attrs = { id: fnid, class: "TableFootnoteRef" }
-      out.span do |s|
-        out.span **attrs do |a|
+      def make_table_footnote_link(out, fnid, fnref)
+        attrs = { href: "##{fnid}", class: "TableFootnoteRef" }
+        out.a **attrs do |a|
           a << fnref
         end
-        insert_tab(s, 1)
       end
-    end
 
-    def make_table_footnote_text(node, fnid, fnref)
-      attrs = { id: "fn:#{fnid}" }
-      noko do |xml|
-        xml.div **attr_code(attrs) do |div|
-          make_table_footnote_target(div, fnid, fnref)
-          node.children.each { |n| parse(n, div) }
+      def make_table_footnote_target(out, fnid, fnref)
+        attrs = { id: fnid, class: "TableFootnoteRef" }
+        out.span do |s|
+          out.span **attrs do |a|
+            a << fnref
+          end
+          insert_tab(s, 1)
         end
-      end.join("\n")
-    end
+      end
 
-    def make_generic_footnote_text(node, fnid)
-      noko do |xml|
-        xml.aside **{ id: "fn:#{fnid}", class: "footnote" } do |div|
-          node.children.each { |n| parse(n, div) }
-        end
-      end.join("\n")
-    end
+      def make_table_footnote_text(node, fnid, fnref)
+        attrs = { id: "fn:#{fnid}" }
+        noko do |xml|
+          xml.div **attr_code(attrs) do |div|
+            make_table_footnote_target(div, fnid, fnref)
+            node.children.each { |n| parse(n, div) }
+          end
+        end.join("\n")
+      end
 
-    def get_table_ancestor_id(node)
-      table = node.ancestors("table") || node.ancestors("figure")
-      return UUIDTools::UUID.random_create.to_s if table.empty?
+      def make_generic_footnote_text(node, fnid)
+        noko do |xml|
+          xml.aside **{ id: "fn:#{fnid}", class: "footnote" } do |div|
+            node.children.each { |n| parse(n, div) }
+          end
+        end.join("\n")
+      end
 
-      table.last["id"]
-    end
+      def get_table_ancestor_id(node)
+        table = node.ancestors("table") || node.ancestors("figure")
+        return UUIDTools::UUID.random_create.to_s if table.empty?
 
-    # @seen_footnote:
-    # do not output footnote text if we have already seen it for this table
+        table.last["id"]
+      end
 
-    def table_footnote_parse(node, out)
-      fn = node["reference"] || UUIDTools::UUID.random_create.to_s
-      tid = get_table_ancestor_id(node)
-      make_table_footnote_link(out, tid + fn, fn)
-      return if @seen_footnote.include?(tid + fn)
+      # @seen_footnote:
+      # do not output footnote text if we have already seen it for this table
 
-      @in_footnote = true
-      out.aside **{ class: "footnote" } do |a|
-        a << make_table_footnote_text(node, tid + fn, fn)
+      def table_footnote_parse(node, out)
+        fn = node["reference"] || UUIDTools::UUID.random_create.to_s
+        tid = get_table_ancestor_id(node)
+        make_table_footnote_link(out, tid + fn, fn)
+        return if @seen_footnote.include?(tid + fn)
+
+        @in_footnote = true
+        out.aside **{ class: "footnote" } do |a|
+          a << make_table_footnote_text(node, tid + fn, fn)
+        end
+        @in_footnote = false
+        @seen_footnote << (tid + fn)
       end
-      @in_footnote = false
-      @seen_footnote << (tid + fn)
-    end
 
-    def footnote_parse(node, out)
-      return table_footnote_parse(node, out) if (@in_table || @in_figure) &&
-        !node.ancestors.map(&:name).include?("name")
+      def footnote_parse(node, out)
+        return table_footnote_parse(node, out) if (@in_table || @in_figure) &&
+          !node.ancestors.map(&:name).include?("name")
 
-      fn = node["reference"] || UUIDTools::UUID.random_create.to_s
-      attrs = { class: "FootnoteRef", href: "#fn:#{fn}" }
-      out.a **attrs do |a|
-        a.sup { |sup| sup << fn }
+        fn = node["reference"] || UUIDTools::UUID.random_create.to_s
+        attrs = { class: "FootnoteRef", href: "#fn:#{fn}" }
+        out.a **attrs do |a|
+          a.sup { |sup| sup << fn }
+        end
+        make_footnote(node, fn)
       end
-      make_footnote(node, fn)
-    end
 
-    def make_footnote(node, fnote)
-      return if @seen_footnote.include?(fnote)
+      def make_footnote(node, fnote)
+        return if @seen_footnote.include?(fnote)
 
-      @in_footnote = true
-      @footnotes << make_generic_footnote_text(node, fnote)
-      @in_footnote = false
-      @seen_footnote << fnote
+        @in_footnote = true
+        @footnotes << make_generic_footnote_text(node, fnote)
+        @in_footnote = false
+        @seen_footnote << fnote
+      end
     end
   end
 end

data/lib/isodoc/html_function/html.rb

@@ -1,129 +1,139 @@
 require "fileutils"
 require "base64"
 
-module IsoDoc::HtmlFunction
-  module Html
-    def convert1(docxml, filename, dir)
-      noko do |xml|
-        xml.html **{ lang: @lang.to_s } do |html|
-          info docxml, nil
-          populate_css
-          html.head { |head| define_head head, filename, dir }
-          make_body(html, docxml)
-        end
-      end.join("\n")
-    end
+module IsoDoc
+  module HtmlFunction
+    module Html
+      def convert1(docxml, filename, dir)
+        noko do |xml|
+          xml.html **{ lang: @lang.to_s } do |html|
+            info docxml, nil
+            populate_css
+            html.head { |head| define_head head, filename, dir }
+            make_body(html, docxml)
+          end
+        end.join("\n")
+      end
 
-    def make_body1(body, _docxml)
-      return if @bare
+      def make_body1(body, _docxml)
+        return if @bare
 
-      body.div **{ class: "title-section" } do |div1|
-        div1.p { |p| p << "&nbsp;" } # placeholder
+        body.div **{ class: "title-section" } do |div1|
+          div1.p { |p| p << "&nbsp;" } # placeholder
+        end
+        section_break(body)
       end
-      section_break(body)
-    end
 
-    def make_body2(body, _docxml)
-      return if @bare
+      def make_body2(body, _docxml)
+        return if @bare
 
-      body.div **{ class: "prefatory-section" } do |div2|
-        div2.p { |p| p << "&nbsp;" } # placeholder
+        body.div **{ class: "prefatory-section" } do |div2|
+          div2.p { |p| p << "&nbsp;" } # placeholder
+        end
+        section_break(body)
       end
-      section_break(body)
-    end
 
-    def make_body3(body, docxml)
-      body.div **{ class: "main-section" } do |div3|
-        boilerplate docxml, div3
-        preface_block docxml, div3
-        abstract docxml, div3
-        foreword docxml, div3
-        introduction docxml, div3
-        preface docxml, div3
-        acknowledgements docxml, div3
-        middle docxml, div3
-        footnotes div3
-        comments div3
+      def make_body3(body, docxml)
+        body.div **{ class: "main-section" } do |div3|
+          boilerplate docxml, div3
+          preface_block docxml, div3
+          abstract docxml, div3
+          foreword docxml, div3
+          introduction docxml, div3
+          preface docxml, div3
+          acknowledgements docxml, div3
+          middle docxml, div3
+          footnotes div3
+          comments div3
+        end
       end
-    end
 
-    def googlefonts
-      <<~HEAD.freeze
-        <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet">
-        <link href="https://fonts.googleapis.com/css?family=Lato:400,400i,700,900" rel="stylesheet">
-      HEAD
-    end
+      def googlefonts
+        <<~HEAD.freeze
+          <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet">
+          <link href="https://fonts.googleapis.com/css?family=Lato:400,400i,700,900" rel="stylesheet">
+        HEAD
+      end
 
-    def html_head
-      <<~HEAD.freeze
-        <title>#{@meta&.get&.dig(: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>
-        <script type="text/javascript">#{toclevel}</script>
-
-        <!--Google fonts-->
-        <link rel="preconnect" href="https://fonts.gstatic.com">#{' '}
-        #{googlefonts}
-        <!--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 html_head
+        <<~HEAD.freeze
+          <title>#{@meta&.get&.dig(: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>
+          <script type="text/javascript">#{toclevel}</script>
+
+          <!--Google fonts-->
+          <link rel="preconnect" href="https://fonts.gstatic.com">#{' '}
+          #{googlefonts}
+          <!--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 html_button
-      return "" if @bare
+      def html_button
+        return "" if @bare
 
-      '<button onclick="topFunction()" id="myBtn" '\
+        '<button onclick="topFunction()" id="myBtn" '\
         'title="Go to top">Top</button>'.freeze
-    end
+      end
 
-    def html_main(docxml)
-      docxml.at("//head").add_child(html_head)
-      d = docxml.at('//div[@class="main-section"]')
-      d.name = "main"
-      d.children.empty? or d.children.first.previous = html_button
-    end
+      def html_main(docxml)
+        docxml.at("//head").add_child(html_head)
+        d = docxml.at('//div[@class="main-section"]')
+        d.name = "main"
+        d.children.empty? or d.children.first.previous = html_button
+      end
 
-    def sourcecodelang(lang)
-      return unless lang
-
-      case lang.downcase
-      when "javascript" then "lang-js"
-      when "c" then "lang-c"
-      when "c+" then "lang-cpp"
-      when "console" then "lang-bsh"
-      when "ruby" then "lang-rb"
-      when "html" then "lang-html"
-      when "java" then "lang-java"
-      when "xml" then "lang-xml"
-      when "perl" then "lang-perl"
-      when "python" then "lang-py"
-      when "xsl" then "lang-xsl"
-      else
-        ""
+      def sourcecodelang(lang)
+        return unless lang
+
+        case lang.downcase
+        when "javascript" then "lang-js"
+        when "c" then "lang-c"
+        when "c+" then "lang-cpp"
+        when "console" then "lang-bsh"
+        when "ruby" then "lang-rb"
+        when "html" then "lang-html"
+        when "java" then "lang-java"
+        when "xml" then "lang-xml"
+        when "perl" then "lang-perl"
+        when "python" then "lang-py"
+        when "xsl" then "lang-xsl"
+        else
+          ""
+        end
       end
-    end
 
-    def sourcecode_parse(node, out)
-      name = node.at(ns("./name"))
-      class1 = "prettyprint #{sourcecodelang(node&.at(ns('./@lang'))&.value)}"
-      out.pre **sourcecode_attrs(node).merge(class: class1) do |div|
-        @sourcecode = true
-        node.children.each { |n| parse(n, div) unless n.name == "name" }
-        @sourcecode = false
+      def sourcecode_parse(node, out)
+        name = node.at(ns("./name"))
+        class1 = "prettyprint #{sourcecodelang(node&.at(ns('./@lang'))&.value)}"
+        out.pre **sourcecode_attrs(node).merge(class: class1) do |div|
+          @sourcecode = true
+          node.children.each { |n| parse(n, div) unless n.name == "name" }
+          @sourcecode = false
+        end
+        sourcecode_name_parse(node, out, name)
       end
-      sourcecode_name_parse(node, out, name)
-    end
 
-    def underline_parse(node, out)
-      out.span **{ style: "text-decoration: underline;" } do |e|
-        node.children.each { |n| parse(n, e) }
+      def underline_parse(node, out)
+        out.span **{ style: "text-decoration: underline;" } do |e|
+          node.children.each { |n| parse(n, e) }
+        end
       end
-    end
 
-    def table_long_strings_cleanup(docxml); end
+      def table_long_strings_cleanup(docxml); end
+
+      def image_parse(node, out, caption)
+        if svg = node.at("./m:svg", "m" => "http://www.w3.org/2000/svg")
+          svg_parse(svg, out)
+          return
+        end
+        super
+      end
+    end
   end
 end