isodoc 1.7.3 → 1.7.6

data/lib/isodoc/html_function/mathvariant_to_plain.rb

@@ -41,6 +41,7 @@ module IsoDoc
       def convert
         docxml.xpath("//m:math", MATHML).each do |elem|
           next if nothing_to_style(elem)
+
           mathml1(elem)
         end
         docxml
@@ -49,7 +50,8 @@ module IsoDoc
       private
 
       def nothing_to_style(elem)
-        !elem.at("./*[@mathvariant][not(@mathvariant = 'normal')][not(@mathvariant = 'italic')]")
+        !elem.at("./*[@mathvariant][not(@mathvariant = 'normal')]"\
+                 "[not(@mathvariant = 'italic')]")
       end
 
       def mathml1(base_elem)
@@ -58,7 +60,7 @@ module IsoDoc
           .merge(MATHVARIANT_TO_PLANE_MAPPINGS)
           .each_pair do |mathvariant_list, plain_font|
             base_elem.xpath(mathvariant_xpath(mathvariant_list)).each do |elem|
-              toPlane(elem, plain_font)
+              to_plane(elem, plain_font)
             end
           end
       end
@@ -69,7 +71,7 @@ module IsoDoc
           .join
       end
 
-      def toPlane(elem, font)
+      def to_plane(elem, font)
         elem.traverse do |n|
           next unless n.text?
 

data/lib/isodoc/presentation_function/block.rb

@@ -1,55 +1,24 @@
-require "base64"
+require_relative "./image"
 
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
-    def lower2cap(s)
-      return s if /^[[:upper:]][[:upper:]]/.match?(s)
+    def lower2cap(text)
+      return text if /^[[:upper:]][[:upper:]]/.match?(text)
 
-      s.capitalize
+      text.capitalize
     end
 
-    def figure(docxml)
-      docxml.xpath(ns("//image")).each { |f| svg_extract(f) }
-      docxml.xpath(ns("//figure")).each { |f| figure1(f) }
-      docxml.xpath(ns("//svgmap")).each do |s|
-        if f = s.at(ns("./figure")) then s.replace(f)
-        else
-          s.remove
-        end
-      end
-    end
-
-    def svg_extract(elem)
-      return unless %r{^data:image/svg\+xml;base64,}.match?(elem["src"])
-
-      svg = Base64.strict_decode64(elem["src"]
-        .sub(%r{^data:image/svg\+xml;base64,}, ""))
-      x = Nokogiri::XML.fragment(svg.sub(/<\?xml[^>]*>/, "")) do |config|
-        config.huge
-      end
-      elem.replace(x)
-    end
-
-    def figure1(f)
-      return sourcecode1(f) if f["class"] == "pseudocode" || f["type"] == "pseudocode"
-      return if labelled_ancestor(f) && f.ancestors("figure").empty?
-      return if f.at(ns("./figure")) and !f.at(ns("./name"))
-
-      lbl = @xrefs.anchor(f['id'], :label, false) or return
-      prefix_name(f, "&nbsp;&mdash; ",
-                  l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
-    end
-
-    def prefix_name(f, delim, number, elem)
+    def prefix_name(node, delim, number, elem)
       return if number.nil? || number.empty?
 
-      unless name = f.at(ns("./#{elem}"))
-        f.children.empty? and f.add_child("<#{elem}></#{elem}>") or
-          f.children.first.previous = "<#{elem}></#{elem}>"
-          name = f.children.first
+      unless name = node.at(ns("./#{elem}"))
+        node.children.empty? and node.add_child("<#{elem}></#{elem}>") or
+          node.children.first.previous = "<#{elem}></#{elem}>"
+        name = node.children.first
+      end
+      if name.children.empty? then name.add_child(number)
+      else (name.children.first.previous = "#{number}#{delim}")
       end
-      name.children.empty? ? name.add_child(number) :
-        ( name.children.first.previous = "#{number}#{delim}" )
     end
 
     def sourcecode(docxml)
@@ -58,12 +27,13 @@ module IsoDoc
       end
     end
 
-    def sourcecode1(f)
-      return if labelled_ancestor(f)
-      return unless f.ancestors("example").empty?
+    def sourcecode1(elem)
+      return if labelled_ancestor(elem)
+      return unless elem.ancestors("example").empty?
 
-      lbl = @xrefs.anchor(f['id'], :label, false) or return
-      prefix_name(f, "&nbsp;&mdash; ", l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
+      lbl = @xrefs.anchor(elem["id"], :label, false) or return
+      prefix_name(elem, "&nbsp;&mdash; ",
+                  l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
     end
 
     def formula(docxml)
@@ -73,9 +43,9 @@ module IsoDoc
     end
 
     # introduce name element
-    def formula1(f)
-      lbl = @xrefs.anchor(f['id'], :label, false)
-      prefix_name(f, "", lbl, "name")
+    def formula1(elem)
+      lbl = @xrefs.anchor(elem["id"], :label, false)
+      prefix_name(elem, "", lbl, "name")
     end
 
     def example(docxml)
@@ -90,11 +60,14 @@ module IsoDoc
       end
     end
 
-    def example1(f)
-      n = @xrefs.get[f["id"]]
-      lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @i18n.example:
-        l10n("#{@i18n.example} #{n[:label]}")
-      prefix_name(f, "&nbsp;&mdash; ", lbl, "name")
+    def example1(elem)
+      n = @xrefs.get[elem["id"]]
+      lbl = if n.nil? || n[:label].nil? || n[:label].empty?
+              @i18n.example
+            else
+              l10n("#{@i18n.example} #{n[:label]}")
+            end
+      prefix_name(elem, "&nbsp;&mdash; ", lbl, "name")
     end
 
     def note(docxml)
@@ -104,13 +77,16 @@ module IsoDoc
     end
 
     # introduce name element
-    def note1(f)
-      return if f.parent.name == "bibitem"
+    def note1(elem)
+      return if elem.parent.name == "bibitem"
 
-      n = @xrefs.get[f["id"]]
-      lbl = (@i18n.note if n.nil? || n[:label].nil? || n[:label].empty?) ?
-        @i18n.note: l10n("#{@i18n.note} #{n[:label]}")
-      prefix_name(f, "", lbl, "name")
+      n = @xrefs.get[elem["id"]]
+      lbl = if n.nil? || n[:label].nil? || n[:label].empty?
+              @i18n.note
+            else
+              l10n("#{@i18n.note} #{n[:label]}")
+            end
+      prefix_name(elem, "", lbl, "name")
     end
 
     def termnote(docxml)
@@ -120,9 +96,27 @@ module IsoDoc
     end
 
     # introduce name element
-    def termnote1(f)
-      lbl = l10n(@xrefs.anchor(f["id"], :label) || "???")
-      prefix_name(f, "", lower2cap(lbl), "name")
+    def termnote1(elem)
+      lbl = l10n(@xrefs.anchor(elem["id"], :label) || "???")
+      prefix_name(elem, "", lower2cap(lbl), "name")
+    end
+
+    def termdefinition(docxml)
+      docxml.xpath(ns("//term[definition]")).each do |f|
+        termdefinition1(f)
+      end
+    end
+
+    def termdefinition1(elem)
+      return unless elem.xpath(ns("./definition")).size > 1
+
+      d = elem.at(ns("./definition"))
+      d = d.replace("<ol><li>#{d.children.to_xml}</li></ol>").first
+      elem.xpath(ns("./definition")).each do |f|
+        f = f.replace("<li>#{f.children.to_xml}</li>").first
+        d << f
+      end
+      d.wrap("<definition></definition>")
     end
 
     def recommendation(docxml)
@@ -144,10 +138,10 @@ module IsoDoc
     end
 
     # introduce name element
-    def recommendation1(f, type)
-      n = @xrefs.anchor(f["id"], :label, false)
+    def recommendation1(elem, type)
+      n = @xrefs.anchor(elem["id"], :label, false)
       lbl = (n.nil? ? type : l10n("#{type} #{n}"))
-      prefix_name(f, "", lbl, "name")
+      prefix_name(elem, "", lbl, "name")
     end
 
     def table(docxml)
@@ -156,12 +150,13 @@ module IsoDoc
       end
     end
 
-    def table1(f)
-      return if labelled_ancestor(f)
-      return if f["unnumbered"] && !f.at(ns("./name"))
+    def table1(elem)
+      return if labelled_ancestor(elem)
+      return if elem["unnumbered"] && !elem.at(ns("./name"))
 
-      n = @xrefs.anchor(f["id"], :label, false)
-      prefix_name(f, "&nbsp;&mdash; ", l10n("#{lower2cap @i18n.table} #{n}"), "name")
+      n = @xrefs.anchor(elem["id"], :label, false)
+      prefix_name(elem, "&nbsp;&mdash; ", l10n("#{lower2cap @i18n.table} #{n}"),
+                  "name")
     end
 
     # we use this to eliminate the semantic amend blocks from rendering
@@ -171,11 +166,11 @@ module IsoDoc
       end
     end
 
-    def amend1(f)
-      f.xpath(ns("./autonumber")).each(&:remove)
-      f.xpath(ns("./newcontent")).each { |a| a.name = "quote" }
-      f.xpath(ns("./description")).each { |a| a.replace(a.children) }
-      f.replace(f.children)
+    def amend1(elem)
+      elem.xpath(ns("./autonumber")).each(&:remove)
+      elem.xpath(ns("./newcontent")).each { |a| a.name = "quote" }
+      elem.xpath(ns("./description")).each { |a| a.replace(a.children) }
+      elem.replace(elem.children)
     end
   end
 end

data/lib/isodoc/presentation_function/concept.rb

@@ -0,0 +1,68 @@
+module IsoDoc
+  class PresentationXMLConvert < ::IsoDoc::Convert
+    def concept(docxml)
+      docxml.xpath(ns("//concept")).each { |f| concept1(f) }
+    end
+
+    def concept1(node)
+      xref = node&.at(ns("./xref/@target"))&.text or
+        return concept_render(node, ital: node["ital"] || "true",
+                                    ref: node["ref"] || "true",
+                                    linkref: node["linkref"] || "true",
+                                    linkmention: node["linkmention"] || "false")
+      if node.at(ns("//definitions//dt[@id = '#{xref}']"))
+        concept_render(node, ital: node["ital"] || "false",
+                             ref: node["ref"] || "false",
+                             linkref: node["linkref"] || "true",
+                             linkmention: node["linkmention"] || "false")
+      else concept_render(node, ital: node["ital"] || "true",
+                                ref: node["ref"] || "true",
+                                linkref: node["linkref"] || "true",
+                                linkmention: node["linkmention"] || "false")
+      end
+    end
+
+    def concept_render(node, opts)
+      node&.at(ns("./refterm"))&.remove
+      r = node.at(ns("./renderterm"))
+      ref = node.at(ns("./xref | ./eref | ./termref"))
+      ref && opts[:ref] != "false" and r&.next = " "
+      opts[:ital] == "true" and r&.name = "em"
+      if opts[:linkmention] == "true" && !r.nil? && !ref.nil?
+        ref2 = ref.clone
+        r2 = r.clone
+        r.replace(ref2).children = r2
+      end
+      concept1_ref(node, ref, opts)
+      if opts[:ital] == "false"
+        r = node.at(ns(".//renderterm"))
+        r&.replace(r&.children)
+      end
+      node.replace(node.children)
+    end
+
+    def concept1_ref(_node, ref, opts)
+      ref.nil? and return
+      return ref.remove if opts[:ref] == "false"
+
+      r = concept1_ref_content(ref)
+      ref = r.at("./descendant-or-self::xmlns:xref | "\
+                 "./descendant-or-self::xmlns:eref | "\
+                 "./descendant-or-self::xmlns:termref")
+      %w(xref eref).include? ref&.name and get_linkend(ref)
+      if opts[:linkref] == "false" && %w(xref eref).include?(ref&.name)
+        ref.replace(ref.children)
+      end
+    end
+
+    def concept1_ref_content(ref)
+      if non_locality_elems(ref).select do |c|
+           !c.text? || /\S/.match(c)
+         end.empty?
+        ref.replace(@i18n.term_defined_in.sub(/%/,
+                                              ref.to_xml))
+      else ref.replace("[#{ref.to_xml}]")
+      end
+    end
+  end
+end

data/lib/isodoc/presentation_function/image.rb

@@ -0,0 +1,112 @@
+require "base64"
+require "emf2svg"
+
+module IsoDoc
+  class PresentationXMLConvert < ::IsoDoc::Convert
+    def figure(docxml)
+      docxml.xpath(ns("//image")).each { |f| svg_extract(f) }
+      docxml.xpath(ns("//figure")).each { |f| figure1(f) }
+      docxml.xpath(ns("//svgmap")).each do |s|
+        if f = s.at(ns("./figure")) then s.replace(f)
+        else s.remove
+        end
+      end
+      docxml.xpath(ns("//image")).each { |f| svg_emf_double(f) }
+    end
+
+    def svg_extract(elem)
+      return unless %r{^data:image/svg\+xml;}.match?(elem["src"])
+
+      svg = Base64.strict_decode64(elem["src"]
+        .sub(%r{^data:image/svg\+xml;(charset=[^;]+;)?base64,}, ""))
+      x = Nokogiri::XML.fragment(svg.sub(/<\?xml[^>]*>/, "")) do |config|
+        config.huge
+      end
+      elem["src"] = ""
+      elem.children = x
+    end
+
+    def figure1(elem)
+      return sourcecode1(elem) if elem["class"] == "pseudocode" ||
+        elem["type"] == "pseudocode"
+      return if labelled_ancestor(elem) && elem.ancestors("figure").empty? ||
+        elem.at(ns("./figure")) && !elem.at(ns("./name"))
+
+      lbl = @xrefs.anchor(elem["id"], :label, false) or return
+      prefix_name(elem, "&nbsp;&mdash; ",
+                  l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
+    end
+
+    def svg_emf_double(img)
+      if emf?(img["mimetype"])
+        img = emf_encode(img)
+        img.children.first.previous = emf_to_svg(img)
+      elsif img["mimetype"] == "image/svg+xml"
+        src = svg_to_emf(img) and img << "<emf src='#{src}'/>"
+      end
+    end
+
+    def emf_encode(img)
+      img["mimetype"] = "image/svg+xml"
+      unless %r{^data:image}.match?(img["src"])
+        img["src"] = Metanorma::Utils::datauri(img["src"])
+      end
+      img.children = "<emf src='#{img['src']}'/>"
+      img["src"] = ""
+      img
+    end
+
+    def emf_to_svg(img)
+      emf = Metanorma::Utils::save_dataimage(img.at(ns("./emf/@src")).text)
+      Emf2svg.from_file(emf).sub(/<\?[^>]+>/, "")
+    end
+
+    def svg_to_emf(node)
+      uri = svg_to_emf_uri(node)
+      ret = svg_to_emf_filename(uri)
+      File.exists?(ret) and return ret
+      exe = inkscape_installed? or return nil
+      uri = Metanorma::Utils::external_path uri
+      exe = Metanorma::Utils::external_path exe
+      system(%(#{exe} --export-type="emf" #{uri})) and
+        return Metanorma::Utils::datauri(ret)
+
+      warn %(Fail on #{exe} --export-type="emf" #{uri})
+
+      nil
+    end
+
+    def svg_to_emf_uri(node)
+      uri = if node&.elements&.first&.name == "svg"
+              a = Base64.strict_encode64(node.children.to_xml)
+              "data:image/svg+xml;base64,#{a}"
+            else node["src"]
+            end
+      if %r{^data:}.match?(uri)
+        uri = save_dataimage(uri)
+        @tempfile_cache << uri
+      end
+      uri
+    end
+
+    def svg_to_emf_filename(uri)
+      "#{File.join(File.dirname(uri), File.basename(uri, '.*'))}.emf"
+    end
+
+    def emf_to_svgfilename(uri)
+      "#{File.join(File.dirname(uri), File.basename(uri, '.*'))}.svg"
+    end
+
+    def inkscape_installed?
+      cmd = "inkscape"
+      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+      ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/isodoc/presentation_function/inline.rb

@@ -1,3 +1,6 @@
+require "metanorma-utils"
+require_relative "./concept"
+
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def prefix_container(container, linkend, _target)
@@ -67,7 +70,7 @@ module IsoDoc
       link += eref_localities(node.xpath(ns("./locality | ./localityStack")),
                               link, node)
       non_locality_elems(node).each(&:remove)
-      node.add_child(link)
+      node.add_child(cleanup_entities(link))
     end
     # so not <origin bibitemid="ISO7301" citeas="ISO 7301">
     # <locality type="section"><reference>3.1</reference></locality></origin>
@@ -88,8 +91,7 @@ module IsoDoc
           ret += eref_localities0(rr, j, target, delim, node)
           delim = ","
         end
-      else
-        ret += eref_localities0(ref, idx, target, delim, node)
+      else ret += eref_localities0(ref, idx, target, delim, node)
       end
       ret
     end
@@ -130,7 +132,7 @@ module IsoDoc
       loc = @i18n.locality[type] || type.sub(/^locality:/, "")
       loc = case node["case"]
             when "lowercase" then loc.downcase
-            else loc.capitalize
+            else Metanorma::Utils.strict_capitalize_first(loc)
             end
       " #{loc}"
     end
@@ -155,41 +157,6 @@ module IsoDoc
       get_linkend(node)
     end
 
-    def concept(docxml)
-      docxml.xpath(ns("//concept")).each { |f| concept1(f) }
-    end
-
-    def concept1(node)
-      xref = node&.at(ns("./xref/@target"))&.text or
-        return concept_render(node, node["ital"] || "true",
-                              node["ref"] || "true")
-      if node.at(ns("//definitions//dt[@id = '#{xref}']"))
-        concept_render(node, node["ital"] || "false", node["ref"] || "false")
-      else concept_render(node, node["ital"] || "true", node["ref"] || "true")
-      end
-    end
-
-    def concept_render(node, ital, ref)
-      node&.at(ns("./refterm"))&.remove
-      r = node.at(ns("./renderterm"))
-      r&.next = " " if node.at(ns("./xref | ./eref | ./termref")) && ref != "false"
-      if ital == "true" then r&.name = "em"
-      else r&.replace(r&.children)
-      end
-      concept1_ref(node, ref)
-      node.replace(node.children)
-    end
-
-    def concept1_ref(node, ref)
-      r = node.at(ns("./xref | ./eref | ./termref")) or return
-      return r.remove if ref == "false"
-
-      if non_locality_elems(r).select { |c| !c.text? || /\S/.match(c) }.empty?
-        r.replace(@i18n.term_defined_in.sub(/%/, r.to_xml))
-      else r.replace("[#{r.to_xml}]")
-      end
-    end
-
     def variant(docxml)
       docxml.xpath(ns("//variant")).each { |f| variant1(f) }
       docxml.xpath(ns("//variant[@remove = 'true']")).each(&:remove)

data/lib/isodoc/presentation_function/math.rb

@@ -1,5 +1,6 @@
 require "twitter_cldr"
 require "bigdecimal"
+require "mathml2asciimath"
 
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
@@ -70,7 +71,15 @@ module IsoDoc
       locale
     end
 
+    def asciimath_dup(node)
+      return if @suppressasciimathdup
+
+      a = MathML2AsciiMath.m2a(node.to_xml)
+      node.next = "<!-- #{a} -->"
+    end
+
     def mathml1(node, locale)
+      asciimath_dup(node)
       localize_maths(node, locale)
       return unless node.elements.size == 1 && node.elements.first.name == "mn"
 

data/lib/isodoc/presentation_function/section.rb

@@ -78,12 +78,23 @@ module IsoDoc
       i = display_order_at(docxml, "//clause[@type = 'scope']", i)
       i = display_order_at(docxml, @xrefs.klass.norm_ref_xpath, i)
       i = display_order_at(docxml, "//sections/terms | "\
-                           "//sections/clause[descendant::terms]", i)
+                                   "//sections/clause[descendant::terms]", i)
       i = display_order_at(docxml, "//sections/definitions", i)
       i = display_order_xpath(docxml, @xrefs.klass.middle_clause(docxml), i)
       i = display_order_xpath(docxml, "//annex", i)
       i = display_order_xpath(docxml, @xrefs.klass.bibliography_xpath, i)
       display_order_xpath(docxml, "//indexsect", i)
     end
+
+    def clausetitle(docxml)
+      docxml.xpath(ns("//variant-title[@type = 'toc']")).each(&:remove)
+    end
+
+    def toc(docxml)
+      docxml.xpath(ns("//toc//xref[text()]")).each do |x|
+        lbl = @xrefs.get[x["target"]][:label] or next
+        x.children.first.previous = "#{lbl}<tab/>"
+      end
+    end
   end
 end

data/lib/isodoc/presentation_xml_convert.rb

@@ -34,6 +34,8 @@ module IsoDoc
       term docxml
       references docxml
       index docxml
+      clausetitle docxml
+      toc docxml
       display_order docxml
     end
 
@@ -47,6 +49,7 @@ module IsoDoc
       termexample docxml
       note docxml
       termnote docxml
+      termdefinition docxml
       permission docxml
       requirement docxml
       recommendation docxml

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "1.7.3".freeze
+  VERSION = "1.7.6".freeze
 end