isodoc 1.6.3 → 1.6.4

data/lib/isodoc/html_function/footnotes.rb

@@ -3,6 +3,7 @@ module IsoDoc::HtmlFunction
 
     def footnotes(div)
       return if @footnotes.empty?
+
       @footnotes.each { |fn| div.parent << fn }
     end
 
@@ -44,15 +45,19 @@ module IsoDoc::HtmlFunction
     def get_table_ancestor_id(node)
       table = node.ancestors("table") || node.ancestors("figure")
       return UUIDTools::UUID.random_create.to_s if table.empty?
+
       table.last["id"]
     end
 
+    # @seen_footnote:
+    # do not output footnote text if we have already seen it for this table
+
     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)
-      # do not output footnote text if we have already seen it for this table
       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)
@@ -62,8 +67,9 @@ module IsoDoc::HtmlFunction
     end
 
     def footnote_parse(node, out)
-       return table_footnote_parse(node, out) if (@in_table || @in_figure) &&
-        !node.ancestors.map {|m| m.name }.include?("name")
+      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|
@@ -72,12 +78,13 @@ module IsoDoc::HtmlFunction
       make_footnote(node, fn)
     end
 
-    def make_footnote(node, fn)
-      return if @seen_footnote.include?(fn)
+    def make_footnote(node, fnote)
+      return if @seen_footnote.include?(fnote)
+
       @in_footnote = true
-      @footnotes << make_generic_footnote_text(node, fn)
+      @footnotes << make_generic_footnote_text(node, fnote)
       @in_footnote = false
-      @seen_footnote << fn
+      @seen_footnote << fnote
     end
   end
 end

data/lib/isodoc/html_function/html.rb

@@ -5,9 +5,9 @@ module IsoDoc::HtmlFunction
   module Html
     def convert1(docxml, filename, dir)
       noko do |xml|
-        xml.html **{ lang: "#{@lang}" } do |html|
+        xml.html **{ lang: @lang.to_s } do |html|
           info docxml, nil
-          populate_css()
+          populate_css
           html.head { |head| define_head head, filename, dir }
           make_body(html, docxml)
         end
@@ -15,13 +15,17 @@ module IsoDoc::HtmlFunction
     end
 
     def make_body1(body, _docxml)
+      return if @bare
+
       body.div **{ class: "title-section" } do |div1|
         div1.p { |p| p << "&nbsp;" } # placeholder
       end
       section_break(body)
     end
 
-    def make_body2(body, docxml)
+    def make_body2(body, _docxml)
+      return if @bare
+
       body.div **{ class: "prefatory-section" } do |div2|
         div2.p { |p| p << "&nbsp;" } # placeholder
       end
@@ -43,46 +47,47 @@ module IsoDoc::HtmlFunction
       end
     end
 
-    def googlefonts()
+    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">
+        <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()
+    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>
+        <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()
+    def html_button
       '<button onclick="topFunction()" id="myBtn" '\
         'title="Go to top">Top</button>'.freeze
     end
 
     def html_main(docxml)
-      docxml.at("//head").add_child(html_head())
+      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()
+      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"
@@ -117,7 +122,6 @@ module IsoDoc::HtmlFunction
       end
     end
 
-    def table_long_strings_cleanup(docxml)
-    end
+    def table_long_strings_cleanup(docxml); end
   end
 end

data/lib/isodoc/html_function/postprocess.rb

@@ -29,15 +29,15 @@ module IsoDoc::HtmlFunction
         .sub(%r{<\?xml[^>]+>}, "")
     end
 
-    def html_cleanup(x)
+    def html_cleanup(html)
       mathml(
         footnote_format(
           footnote_backlinks(
             html_toc(
-              term_header(html_footnote_filter(html_preface(htmlstyle(x))))
-            )
-          )
-        )
+              term_header(html_footnote_filter(html_preface(htmlstyle(html)))),
+            ),
+          ),
+        ),
       )
     end
 
@@ -60,7 +60,6 @@ module IsoDoc::HtmlFunction
     def htmlstyle(docxml)
       return docxml unless @htmlstylesheet
 
-      title = docxml.at("//*[local-name() = 'head']/*[local-name() = 'title']")
       head = docxml.at("//*[local-name() = 'head']")
       head << htmlstylesheet(@htmlstylesheet)
       s = htmlstylesheet(@htmlstylesheet_override) and head << s
@@ -68,8 +67,8 @@ module IsoDoc::HtmlFunction
     end
 
     def html_preface(docxml)
-      html_cover(docxml) if @htmlcoverpage
-      html_intro(docxml) if @htmlintropage
+      html_cover(docxml) if @htmlcoverpage && !@bare
+      html_intro(docxml) if @htmlintropage && !@bare
       docxml.at("//body") << mathjax(@openmathdelim, @closemathdelim)
       docxml.at("//body") << sourcecode_highlighter
       html_main(docxml)
@@ -79,7 +78,8 @@ module IsoDoc::HtmlFunction
 
     def authority_cleanup1(docxml, klass)
       dest = docxml.at("//div[@id = 'boilerplate-#{klass}-destination']")
-      auth = docxml.at("//div[@id = 'boilerplate-#{klass}' or @class = 'boilerplate-#{klass}']")
+      auth = docxml.at("//div[@id = 'boilerplate-#{klass}' or "\
+                       "@class = 'boilerplate-#{klass}']")
       auth&.xpath(".//h1[not(text())] | .//h2[not(text())]")&.each(&:remove)
       auth&.xpath(".//h1 | .//h2")&.each { |h| h["class"] = "IntroTitle" }
       dest and auth and dest.replace(auth.remove)
@@ -96,7 +96,7 @@ module IsoDoc::HtmlFunction
       d = docxml.at('//div[@class="title-section"]')
       # d.children.first.add_previous_sibling doc.to_xml(encoding: "US-ASCII")
       d.children.first.add_previous_sibling(
-        populate_template(doc.to_xml(encoding: "US-ASCII"), :html)
+        populate_template(doc.to_xml(encoding: "US-ASCII"), :html),
       )
     end
 
@@ -105,7 +105,7 @@ module IsoDoc::HtmlFunction
       d = docxml.at('//div[@class="prefatory-section"]')
       # d.children.first.add_previous_sibling doc.to_xml(encoding: "US-ASCII")
       d.children.first.add_previous_sibling(
-        populate_template(doc.to_xml(encoding: "US-ASCII"), :html)
+        populate_template(doc.to_xml(encoding: "US-ASCII"), :html),
       )
     end
 
@@ -149,7 +149,7 @@ module IsoDoc::HtmlFunction
       docxml.xpath("//*[local-name() = 'img']").each do |i|
         i["width"], i["height"] = Html2Doc.image_resize(i, image_localfile(i),
                                                         @maxheight, @maxwidth)
-        next if /^data:/.match i["src"]
+        next if /^data:/.match? i["src"]
 
         @datauriimage ? datauri(i) : move_image1(i)
       end
@@ -187,8 +187,11 @@ module IsoDoc::HtmlFunction
       return doc unless @scripts
 
       scripts = File.read(@scripts, encoding: "UTF-8")
+      scripts_override = ""
+      @scripts_override and
+        scripts_override = File.read(@scripts_override, encoding: "UTF-8")
       a = doc.split(%r{</body>})
-      a[0] + scripts + "</body>" + a[1]
+      "#{a[0]}#{scripts}#{scripts_override}</body>#{a[1]}"
     end
 
     def sourcecode_highlighter

data/lib/isodoc/pdf_convert.rb

@@ -1,11 +1,10 @@
-require_relative "html_function/comments.rb"
-require_relative "html_function/footnotes.rb"
-require_relative "html_function/html.rb"
+require_relative "html_function/comments"
+require_relative "html_function/footnotes"
+require_relative "html_function/html"
 require "metanorma"
 
 module IsoDoc
   class PdfConvert < ::IsoDoc::Convert
-
     include HtmlFunction::Comments
     include HtmlFunction::Footnotes
     include HtmlFunction::Html
@@ -13,6 +12,8 @@ module IsoDoc
     def initialize(options)
       @standardstylesheet = nil
       super
+      @format = :pdf
+      @suffix = "pdf"
       @scripts = @scripts_pdf if @scripts_pdf
       @maxwidth = 500
       @maxheight = 800
@@ -22,22 +23,19 @@ module IsoDoc
       "_pdfimages"
     end
 
-    def initialize(options)
-      @format = :pdf
-      @suffix = "pdf"
-      super
-    end
-
     def convert(input_filename, file = nil, debug = false, output_filename = nil)
       file = File.read(input_filename, encoding: "utf-8") if file.nil?
       @openmathdelim, @closemathdelim = extract_delims(file)
       docxml, filename, dir = convert_init(file, input_filename, debug)
       result = convert1(docxml, filename, dir)
       return result if debug
-      postprocess(result, filename + ".tmp.html", dir)
+
+      postprocess(result, "#{filename}.tmp.html", dir)
       FileUtils.rm_rf dir
-      ::Metanorma::Output::Pdf.new.convert("#{filename}.tmp.html",
-                                           output_filename || "#{filename}.#{@suffix}")
+      ::Metanorma::Output::Pdf.new.convert(
+        "#{filename}.tmp.html",
+        output_filename || "#{filename}.#{@suffix}",
+      )
       FileUtils.rm_rf ["#{filename}.tmp.html", tmpimagedir]
     end
 

data/lib/isodoc/presentation_function/bibdata.rb

@@ -2,12 +2,32 @@ module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def bibdata(docxml)
       a = bibdata_current(docxml) or return
+      address_precompose(a)
       bibdata_i18n(a)
       a.next =
         "<localized-strings>#{i8n_name(trim_hash(@i18n.get), '').join('')}"\
         "</localized-strings>"
     end
 
+    def address_precompose(bib)
+      bib.xpath(ns("//bibdata//address")).each do |b|
+        next if b.at(ns("./formattedAddress"))
+
+        x = address_precompose1(b)
+        b.children = "<formattedAddress>#{x}</formattedAddress>"
+      end
+    end
+
+    def address_precompose1(addr)
+      ret = []
+      addr.xpath(ns("./street")).each { |s| ret << s.children.to_xml }
+      a = addr.at(ns("./city")) and ret << a.children.to_xml
+      addr.xpath(ns("./state")).each { |s| ret << s.children.to_xml }
+      a = addr.at(ns("./country")) and ret << a.children.to_xml
+      a = addr.at(ns("./postcode")) and ret[-1] += " #{a.children.to_xml}"
+      ret.join("<br/>")
+    end
+
     def bibdata_current(docxml)
       a = docxml.at(ns("//bibdata")) or return
       a.xpath(ns("./language")).each do |l|
@@ -35,27 +55,28 @@ module IsoDoc
       x.next.children = hash[x.text]
     end
 
-    def i18n_tag(k, v)
-      "<localized-string key='#{k}' language='#{@lang}'>#{v}</localized-string>"
+    def i18n_tag(key, value)
+      "<localized-string key='#{key}' language='#{@lang}'>#{value}"\
+        "</localized-string>"
     end
 
-    def i18n_safe(k)
-      k.to_s.gsub(/\s|\./, "_")
+    def i18n_safe(key)
+      key.to_s.gsub(/\s|\./, "_")
     end
 
-    def i8n_name(h, pref)
-      if h.is_a? Hash then i8n_name1(h, pref)
-      elsif h.is_a? Array
-        h.reject { |a| blank?(a) }.each_with_object([])
+    def i8n_name(hash, pref)
+      if hash.is_a? Hash then i8n_name1(hash, pref)
+      elsif hash.is_a? Array
+        hash.reject { |a| blank?(a) }.each_with_object([])
           .with_index do |(v1, g), i|
           i8n_name(v1, "#{i18n_safe(k)}.#{i}").each { |x| g << x }
         end
-      else [i18n_tag(pref, h)]
+      else [i18n_tag(pref, hash)]
       end
     end
 
-    def i8n_name1(h, pref)
-      h.reject { |k, v| blank?(v) }.each_with_object([]) do |(k, v), g|
+    def i8n_name1(hash, pref)
+      hash.reject { |_k, v| blank?(v) }.each_with_object([]) do |(k, v), g|
         if v.is_a? Hash then i8n_name(v, i18n_safe(k)).each { |x| g << x }
         elsif v.is_a? Array
           v.reject { |a| blank?(a) }.each_with_index do |v1, i|
@@ -68,28 +89,28 @@ module IsoDoc
     end
 
     # https://stackoverflow.com/a/31822406
-    def blank?(v)
-      v.nil? || v.respond_to?(:empty?) && v.empty?
+    def blank?(elem)
+      elem.nil? || elem.respond_to?(:empty?) && elem.empty?
     end
 
-    def trim_hash(h)
+    def trim_hash(hash)
       loop do
-        h_new = trim_hash1(h)
-        break h if h==h_new
+        h_new = trim_hash1(hash)
+        break hash if hash == h_new
 
-        h = h_new
+        hash = h_new
       end
     end
 
-    def trim_hash1(h)
-      return h unless h.is_a? Hash
+    def trim_hash1(hash)
+      return hash unless hash.is_a? Hash
 
-      h.each_with_object({}) do |(k, v), g|
+      hash.each_with_object({}) do |(k, v), g|
         next if blank?(v)
 
-        g[k] = if v.is_a? Hash then trim_hash1(h[k])
+        g[k] = if v.is_a? Hash then trim_hash1(hash[k])
                elsif v.is_a? Array
-                 h[k].map { |a| trim_hash1(a) }.reject { |a| blank?(a) }
+                 hash[k].map { |a| trim_hash1(a) }.reject { |a| blank?(a) }
                else
                  v
                end

data/lib/isodoc/presentation_function/inline.rb

@@ -9,8 +9,8 @@ module IsoDoc
         return @xrefs.anchor(node["bibitemid"], :xref) || "???"
       elsif node["target"] && node["droploc"]
         return @xrefs.anchor(node["target"], :value) ||
-          @xrefs.anchor(node["target"], :label) ||
-          @xrefs.anchor(node["target"], :xref) || "???"
+            @xrefs.anchor(node["target"], :label) ||
+            @xrefs.anchor(node["target"], :xref) || "???"
       elsif node["target"] && !/.#./.match(node["target"])
         linkend = anchor_linkend1(node)
       end
@@ -33,6 +33,10 @@ module IsoDoc
       return linkend&.downcase if node["case"] == "lowercase"
       return linkend if linkend[0, 1].match?(/\p{Upper}/)
 
+      capitalise_xref1(node, linkend)
+    end
+
+    def capitalise_xref1(node, linkend)
       prec = nearest_block_parent(node).xpath("./descendant-or-self::text()") &
         node.xpath("./preceding::text()")
       if prec.empty? || /(?!<[^.].)\.\s+$/.match(prec.map(&:text).join)
@@ -43,8 +47,8 @@ module IsoDoc
 
     def nearest_block_parent(node)
       until %w(p title td th name formula li dt dd sourcecode pre)
-        .include?(node.name)
-      node = node.parent
+          .include?(node.name)
+        node = node.parent
       end
       node
     end
@@ -90,7 +94,7 @@ module IsoDoc
       ret
     end
 
-    def eref_localities0(ref, _i, target, delim, node)
+    def eref_localities0(ref, _idx, target, delim, node)
       if ref["type"] == "whole" then l10n("#{delim} #{@i18n.wholeoftext}")
       else
         eref_localities1(target, ref["type"], ref.at(ns("./referenceFrom")),
@@ -99,24 +103,24 @@ module IsoDoc
     end
 
     # TODO: move to localization file
-    def eref_localities1_zh(_target, type, from, to, node, delim)
+    def eref_localities1_zh(_target, type, from, upto, node, delim)
       ret = "#{delim} 第#{from.text}" if from
-      ret += "&ndash;#{to.text}" if to
+      ret += "&ndash;#{upto.text}" if upto
       loc = (@i18n.locality[type] || type.sub(/^locality:/, "").capitalize)
       ret += " #{loc}" unless node["droploc"] == "true"
       ret
     end
 
     # TODO: move to localization file
-    def eref_localities1(target, type, from, to, delim, node, lang = "en")
+    def eref_localities1(target, type, from, upto, delim, node, lang = "en")
       return "" if type == "anchor"
 
       lang == "zh" and
-        return l10n(eref_localities1_zh(target, type, from, to, node, delim))
+        return l10n(eref_localities1_zh(target, type, from, upto, node, delim))
       ret = delim
       ret += eref_locality_populate(type, node)
       ret += " #{from.text}" if from
-      ret += "&ndash;#{to.text}" if to
+      ret += "&ndash;#{upto.text}" if upto
       l10n(ret)
     end
 
@@ -161,11 +165,12 @@ module IsoDoc
       content = node.first_element_child.children.reject do |c|
         %w{locality localityStack}.include? c.name
       end.select { |c| !c.text? || /\S/.match(c) }
-      if node.replace content.empty?
-        @i18n.term_defined_in.sub(/%/, node.first_element_child.to_xml)
-      else
-        "<em>#{node.children.to_xml}</em>"
-      end
+      n = if content.empty?
+            @i18n.term_defined_in.sub(/%/, node.first_element_child.to_xml)
+          else
+            "<em>#{node.children.to_xml}</em>"
+          end
+      node.replace(n)
     end
 
     def variant(docxml)