isodoc 3.1.4 → 3.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f7b717e7e536647796abc2df27f9a3b00730a7b14790b1724defd797f19ed13
-  data.tar.gz: f12c2f1b8e16e8cbb5543940b828308c4aa7a7b5719a0f37e7fa3677f1c4e8cd
+  metadata.gz: aab1e285713806592294433b8009ca144fe193d9a0f43019448580c8fbe1dd9d
+  data.tar.gz: 58fc680a7a698f4f714a1c9577e7d0f48c382ccadc720b2c588fe870dc643273
 SHA512:
-  metadata.gz: 860033b6e8cd5abf55cd4d4ab172706ac001696758216aff66bc47a53ce3e22a867664ed3325a3c41f7471b9d6afbf65b44df3376b6b8cafbadd845ecda711ea
-  data.tar.gz: e8430c322a91a674085aa9acfeb71a41bf8dc0f32e7d481c81208b36f6afa207f3943cad61580a391df54ecfc345d288f73bbd07993474e15debbc7e2af9cca7
+  metadata.gz: 0fb892bcc672a38de31ab3d6fc9a3e3088d8c4ebba8c46010167a0646284747fca650de1c48c39b07b7177e7674494a05273d63204f4c0702b15a9dc09fe8c2b
+  data.tar.gz: ad8a5996bef31064b9b2fda5245f32caa2c16378468ba36bdf96933fe84c67ec6f0220907a1cde46e571d240dfc866d4363f9712b83c6544c923bea5087ae1a7

data/isodoc.gemspec

@@ -57,5 +57,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "xml-c14n"
+  # html2doc locks lutaml-model to ~ 0.7.0, but until testing of lutaml-model
+  # releases against dowmstream gems (notably Plurimath) is in place, locking at
+  # patch level
+  #spec.add_dependency "lutaml-model", "0.7.1"
   # spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/isodoc/function/cleanup.rb

@@ -16,7 +16,6 @@ module IsoDoc
       def cleanup(docxml)
         @i18n ||= i18n_init(@lang, @script, @locale)
         comment_cleanup(docxml)
-        #footnote_cleanup(docxml)
         inline_header_cleanup(docxml)
         figure_cleanup(docxml)
         table_cleanup(docxml)
@@ -58,15 +57,6 @@ module IsoDoc
         docxml
       end
 
-      # KILL
-      def footnote_cleanup(docxml)
-        docxml.xpath('//a[@class = "FootnoteRef"]/sup')
-          .each_with_index do |x, i|
-          x.content = (i + 1).to_s
-        end
-        docxml
-      end
-
       def merge_fnref_into_fn_text(elem)
         fn = elem.at('.//span[@class="TableFootnoteRef"]/..') or return
         n = fn.next_element

data/lib/isodoc/function/inline.rb

@@ -81,35 +81,41 @@ module IsoDoc
 
       def stem_parse(node, out)
         ret = node.at(ns("./semx[@element = 'stem']")) || node
-        ooml = case node["type"]
-               when "AsciiMath" then asciimath_parse(ret)
-               when "MathML" then mathml_parse(ret)
-               when "LaTeX" then latexmath_parse(ret)
-               else HTMLEntities.new.encode(ret.text)
-               end
-        out.span class: "stem" do |span|
+        ooml, text_only = stem_parse1(ret, node["type"])
+        klass = text_only ? {} : { class: "stem" }
+        out.span **klass do |span|
           span.parent.add_child ooml
         end
       end
 
+      def stem_parse1(ret, type)
+        case type
+        when "AsciiMath" then asciimath_parse(ret)
+        when "MathML" then mathml_parse(ret)
+        when "LaTeX" then latexmath_parse(ret)
+        else [HTMLEntities.new.encode(ret.text),
+              /^[[0-9,.+-]]*$/.match?(ret.text)]
+        end
+      end
+
       MATHML = { "m" => "http://www.w3.org/1998/Math/MathML" }.freeze
 
       def mathml_parse(node)
         # node.xpath("./m:math", MATHML).map(&:to_xml).join
         node.xpath(ns("./asciimath | ./latexmath")).each(&:remove)
         node.xpath(ns("./br")).each { |e| e.namespace = nil }
-        node.elements
+        [node.children, node.elements.empty?]
       end
 
       def asciimath_parse(node)
         a = node.at(ns("./asciimath"))&.text || node.text
-        "#{@openmathdelim}#{HTMLEntities.new.encode(a)}" \
-          "#{@closemathdelim}"
+        ["#{@openmathdelim}#{HTMLEntities.new.encode(a)}" \
+          "#{@closemathdelim}", /^[[0-9,.+-]]*$/.match?(a)]
       end
 
       def latexmath_parse(node)
         a = node.at(ns("./latexmath"))&.text || node.text
-        HTMLEntities.new.encode(a)
+        [HTMLEntities.new.encode(a), /^[[0-9,.+-]]*$/.match?(a)]
       end
 
       def image_title_parse(out, caption)

data/lib/isodoc/function/lists.rb

@@ -37,8 +37,9 @@ module IsoDoc
       # We don't really want users to specify type of ordered list;
       # we will use a fixed hierarchy as practiced by ISO (though not
       # fully spelled out): a) 1) i) A) I)
-
-      def ol_depth(node)
+      # Fallback, this is now being done in Presentation XML
+      # KILL
+      def ol_depthx(node)
         depth = node.ancestors("ul, ol").size + 1
         type = :alphabet
         type = :arabic if [2, 7].include? depth
@@ -49,7 +50,8 @@ module IsoDoc
       end
 
       def ol_attrs(node)
-        { type: node["type"] ? ol_style(node["type"].to_sym) : ol_depth(node),
+        { # type: node["type"] ? ol_style(node["type"].to_sym) : ol_depth(node),
+          type: ol_style(node["type"]&.to_sym),
           id: node["id"], style: keep_style(node) }
       end
 
@@ -62,16 +64,24 @@ module IsoDoc
         end
       end
 
+      def li_checkbox(node)
+        if node["uncheckedcheckbox"] == "true"
+          '<span class="zzMoveToFollowing">' \
+                '<input type="checkbox" checked="checked"/></span>'
+        elsif node["checkedcheckbox"] == "true"
+          '<span class="zzMoveToFollowing">' \
+                '<input type="checkbox"/></span>'
+        else ""
+        end
+      end
+
       def li_parse(node, out)
         out.li **attr_code(id: node["id"]) do |li|
-          if node["uncheckedcheckbox"] == "true"
-            li << '<span class="zzMoveToFollowing">' \
-                  '<input type="checkbox" checked="checked"/></span>'
-          elsif node["checkedcheckbox"] == "true"
-            li << '<span class="zzMoveToFollowing">' \
-                  '<input type="checkbox"/></span>'
+          li << li_checkbox(node)
+          node.children.each do |n|
+            n.name == "fmt-name" and next
+            parse(n, li)
           end
-          node.children.each { |n| parse(n, li) }
         end
       end
 

data/lib/isodoc/html_function/postprocess_footnotes.rb

@@ -28,11 +28,8 @@ module IsoDoc
         xdup = xref.dup
         xdup.remove["id"]
         if footnote.elements.empty?
-          #footnote.children.empty? and footnote << " "
-          #footnote.children.first.previous = xdup
           footnote.add_first_child xdup
         else
-          #footnote.elements.first.children.first.previous = xdup
           footnote.elements.first.add_first_child xdup
         end
       end
@@ -48,18 +45,6 @@ module IsoDoc
         end
         docxml
       end
-
-      # KILL
-      def footnote_formatx(docxml)
-        docxml.xpath("//a[@class = 'FootnoteRef']/sup").each do |x|
-          footnote_reference_format(x)
-        end
-        docxml.xpath("//a[@class = 'TableFootnoteRef'] | "\
-                     "//span[@class = 'TableFootnoteRef']").each do |x|
-          table_footnote_reference_format(x)
-        end
-        docxml
-      end
     end
   end
 end

data/lib/isodoc/init.rb

@@ -20,6 +20,7 @@ module IsoDoc
 
     def toc_init(docxml)
       @doctype = docxml.at(ns("//bibdata/ext/doctype"))&.text
+      @subdoctype = docxml.at(ns("//bibdata/ext/subdoctype"))&.text
       @xrefs.klass.doctype = @doctype
       x = "//metanorma-extension/presentation-metadata" \
           "[name[text() = 'TOC Heading Levels']]/value"

data/lib/isodoc/presentation_function/block.rb

@@ -138,53 +138,6 @@ module IsoDoc
       elem.next = ret
     end
 
-    def dl(docxml)
-      docxml.xpath(ns("//dl")).each { |f| dl1(f) }
-    end
-
-    def dl1(elem)
-      elem.at(ns("./name")) and
-        prefix_name(elem, {}, "", "name") # copy name to fmt-name
-    end
-
-    def ul(docxml)
-      docxml.xpath(ns("//ul")).each { |f| ul1(f) }
-    end
-
-    def ul1(elem)
-      elem.at(ns("./name")) and
-        prefix_name(elem, {}, "", "name") # copy name to fmt-name
-    end
-
-    def ol(docxml)
-      docxml.xpath(ns("//ol")).each { |f| ol1(f) }
-      @xrefs.list_anchor_names(docxml.xpath(ns(@xrefs.sections_xpath)))
-      docxml.xpath(ns("//ol/li")).each { |f| ol_label(f) }
-    end
-
-    # We don't really want users to specify type of ordered list;
-    # we will use by default a fixed hierarchy as practiced by ISO (though not
-    # fully spelled out): a) 1) i) A) I)
-    def ol_depth(node)
-      depth = node.ancestors("ul, ol").size + 1
-      type = :alphabet
-      type = :arabic if [2, 7].include? depth
-      type = :roman if [3, 8].include? depth
-      type = :alphabet_upper if [4, 9].include? depth
-      type = :roman_upper if [5, 10].include? depth
-      type
-    end
-
-    def ol1(elem)
-      elem["type"] ||= ol_depth(elem).to_s
-      elem.at(ns("./name")) and
-        prefix_name(elem, {}, "", "name") # copy name to fmt-name
-    end
-
-    def ol_label(elem)
-      elem["label"] = @xrefs.anchor(elem["id"], :label, false)
-    end
-
     def source(docxml)
       docxml.xpath(ns("//source/modification")).each do |f|
         source_modification(f)

data/lib/isodoc/presentation_function/list.rb

@@ -0,0 +1,78 @@
+module IsoDoc
+  class PresentationXMLConvert < ::IsoDoc::Convert
+    def dl(docxml)
+      docxml.xpath(ns("//dl")).each { |f| dl1(f) }
+    end
+
+    def dl1(elem)
+      elem.at(ns("./name")) and
+        prefix_name(elem, {}, "", "name") # copy name to fmt-name
+    end
+
+    def ul(docxml)
+      docxml.xpath(ns("//ul")).each { |f| ul1(f) }
+      docxml.xpath(ns("//ul/li")).each { |f| ul_label(f) }
+    end
+
+    def ul1(elem)
+      elem.at(ns("./name")) and
+        prefix_name(elem, {}, "", "name") # copy name to fmt-name
+    end
+
+    def ol(docxml)
+      docxml.xpath(ns("//ol")).each { |f| ol1(f) }
+      @xrefs.list_anchor_names(docxml.xpath(ns(@xrefs.sections_xpath)))
+      docxml.xpath(ns("//ol/li")).each { |f| ol_label(f) }
+    end
+
+    def ol_depth(node)
+      depth = node.ancestors("ul, ol").size + 1
+      @counter.ol_type(node, depth) # defined in Xref::Counter
+    end
+
+    def ol1(elem)
+      elem["type"] ||= ol_depth(elem).to_s # feeds ol_label_format
+      elem.at(ns("./name")) and
+        prefix_name(elem, {}, "", "name") # copy name to fmt-name
+    end
+
+    def ol_label(elem)
+      val = @xrefs.anchor(elem["id"], :label, false)
+      semx = "<semx element='autonum' source='#{elem['id']}'>#{val}</semx>"
+      lbl = "<fmt-name>#{ol_label_format(semx, elem)}</fmt-name>"
+      elem.add_first_child(lbl)
+    end
+
+    def ol_label_template(_elem)
+      {
+        alphabet: %{%<span class="fmt-label-delim">)</span>},
+        alphabet_upper: %{%<span class="fmt-label-delim">.</span>},
+        roman: %{%<span class="fmt-label-delim">)</span>},
+        roman_upper: %{%<span class="fmt-label-delim">.</span>},
+        arabic: %{%<span class="fmt-label-delim">)</span>},
+      }
+    end
+
+    def ol_label_format(semx, elem)
+      template = ol_label_template(elem)[elem.parent["type"].to_sym]
+      template.sub("%", semx)
+    end
+
+    def ul_label_list(_elem)
+      %w(&#x2014;)
+    end
+
+    def ul_label(elem)
+      val = ul_label_value(elem)
+      semx = "<semx element='autonum' source='#{elem['id']}'>#{val}</semx>"
+      lbl = "<fmt-name>#{semx}</fmt-name>"
+      elem.add_first_child(lbl)
+    end
+
+    def ul_label_value(elem)
+      depth = elem.ancestors("ul, ol").size
+      val = ul_label_list(elem)
+      val[(depth - 1) % val.size]
+    end
+  end
+end

data/lib/isodoc/presentation_function/math.rb

@@ -149,11 +149,7 @@ module IsoDoc
     def maths_just_numeral(node)
       mn = node.at(".//m:mn", MATHML).children.text
         .sub(/\^([0-9+-]+)$/, "<sup>\\1</sup>")
-      #if node.parent.parent.name == "stem"
-        #node.replace(mn)
-      #else
-        node.replace(mn)
-      #end
+      node.replace(mn)
     end
 
     def mathml1(node, locale)
@@ -209,11 +205,7 @@ module IsoDoc
     def mathml_number_to_number(node)
       (node.elements.size == 1 && node.elements.first.name == "mn") or return
       repl = node.at("./m:mn", MATHML).children
-      #if node.parent.name == "stem"
-        #node.parent.replace(repl)
-      #else
-        node.replace(repl)
-      #end
+      node.replace(repl)
     end
   end
 end

data/lib/isodoc/presentation_function/xrefs.rb

@@ -5,7 +5,7 @@ module IsoDoc
         sem_xml_descendant?(x) and next
         tag = x.name
         y = Nokogiri::XML::Node.new("fmt-#{tag}", x.document)
-        x.attributes.each_key { |a| y[a] = x[a] }
+        x.attributes.keys.reject { |a| a == "id" }.each { |a| y[a] = x[a] }
         n = semx_fmt_dup(x) # semx/fmt-xref for ease of processing
         n.children.each { |c| y << c }
         n << y

data/lib/isodoc/presentation_xml_convert.rb

@@ -1,4 +1,5 @@
 require_relative "presentation_function/block"
+require_relative "presentation_function/list"
 require_relative "presentation_function/reqt"
 require_relative "presentation_function/concepts"
 require_relative "presentation_function/terms"
@@ -21,16 +22,26 @@ module IsoDoc
     end
 
     def convert1(docxml, filename, dir)
+      presxml_convert_init(docxml, filename, dir)
+      conversions(docxml)
+      docxml.root["type"] = "presentation"
+      repeat_id_validate(docxml.root)
+      idref_validate(docxml.root)
+      docxml.to_xml.gsub("<", "<").gsub(">", ">")
+    end
+
+    def counter_init
+      @counter = IsoDoc::XrefGen::Counter.new(0, {})
+    end
+
+    def presxml_convert_init(docxml, filename, dir)
       @outputdir = dir
       @outputfile = Pathname.new(filename).basename.to_s
       docid_prefixes(docxml) # feeds @xrefs.parse citation processing
       @xrefs.parse docxml
       @xrefs.klass.meta = @meta
       @xrefs.klass.info docxml, nil
-      conversions(docxml)
-      docxml.root["type"] = "presentation"
-      repeat_id_validate(docxml.root)
-      docxml.to_xml.gsub("<", "<").gsub(">", ">")
+      counter_init
     end
 
     def repeat_id_validate1(elem)
@@ -50,6 +61,33 @@ module IsoDoc
       end
     end
 
+    IDREF =
+      [%w(review from), %w(review to), %w(index to), %w(xref target),
+       %w(callout target), %w(eref bibitemid), %w(citation bibitemid),
+       %w(admonition target), %w(label for), %w(semx source),
+       %w(fmt-title source), %w(fmt-xref-label container), %w(fn target),
+       %w(fmt-fn-body target), %w(fmt-review-start source),
+       %w(fmt-review-start end), %w(fmt-review-start target),
+       %w(fmt-review-end source), %w(fmt-review-end start),
+       %w(fmt-review-end target)].freeze
+
+    def idref_validate(doc)
+      @log or return
+      IDREF.each do |e|
+        doc.xpath("//xmlns:#{e[0]}[@#{e[1]}]").each do |x|
+          idref_validate1(x, e[1])
+        end
+      end
+    end
+
+    def idref_validate1(node, attr)
+      node[attr].strip.empty? and return
+      @doc_ids[node[attr]] and return
+      @log.add("Anchors", node,
+               "Anchor #{node[attr]} pointed to by #{node.name} " \
+               "is not defined in the document", severity: 1)
+    end
+
     def bibitem_lookup(docxml)
       @bibitem_lookup ||= docxml.xpath(ns("//references/bibitem"))
         .each_with_object({}) do |b, m|
@@ -58,7 +96,6 @@ module IsoDoc
     end
 
     def conversions(docxml)
-      # semantic_xml_insert(docxml)
       metadata docxml
       bibdata docxml
       @xrefs.parse docxml

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "3.1.4".freeze
+  VERSION = "3.1.5".freeze
 end

data/lib/isodoc/word_function/comments.rb

@@ -11,15 +11,6 @@ module IsoDoc
         end
       end
 
-      # KILL
-      def review_note_parsex(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["source"],
@@ -51,17 +42,6 @@ module IsoDoc
         end
       end
 
-      # KILL
-      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 fmt_review_body_parse(node, out)
         out.div style: "mso-element:comment", id: node["id"] do |div|
           div.span style: %{mso-comment-author:"#{node['reviewer']}"}

data/lib/isodoc/word_function/lists.rb

@@ -96,14 +96,12 @@ module IsoDoc
         end
       end
 
-      def li_parse(node, out)
-        out.li **attr_code(id: node["id"]) do |li|
-          if node["uncheckedcheckbox"] == "true"
-            li << '<span class="zzMoveToFollowing">&#x2610; </span>'
-          elsif node["checkedcheckbox"] == "true"
-            li << '<span class="zzMoveToFollowing">&#x2611; </span>'
-          end
-          node.children.each { |n| parse(n, li) }
+      def li_checkbox(node)
+        if node["uncheckedcheckbox"] == "true"
+          '<span class="zzMoveToFollowing">&#x2610; </span>'
+        elsif node["checkedcheckbox"] == "true"
+          '<span class="zzMoveToFollowing">&#x2611; </span>'
+        else ""
         end
       end
     end

data/lib/isodoc/word_function/postprocess.rb

@@ -172,23 +172,6 @@ module IsoDoc
         end
       end
 
-      # KILL
-      def word_footnote_formatx(docxml)
-        # the content is in a[@epub:type = 'footnote']//sup, but in Word,
-        # we need to inject content around the autonumbered footnote reference
-        docxml.xpath("//a[@epub:type = 'footnote']").each do |x|
-          footnote_reference_format(x)
-        end
-        docxml.xpath("//span[@class = 'MsoFootnoteReference']").each do |x|
-          footnote_reference_format(x)
-        end
-        docxml.xpath("//a[@class = 'TableFootnoteRef'] | " \
-                     "//span[@class = 'TableFootnoteRef']").each do |x|
-          table_footnote_reference_format(x)
-        end
-        docxml
-      end
-
       # move p.h1 (floating title) after any page, section breaks
       def word_floating_titles(docxml)
         docxml.xpath("//p[@class = 'section-break' or @class = 'page-break']")

data/lib/isodoc/xref/ol_type_provider.rb

@@ -0,0 +1,16 @@
+module IsoDoc
+  module XrefGen
+    module OlTypeProvider
+      def ol_type(list, depth)
+        return list["type"].to_sym if list["type"]
+        return :arabic if [2, 7].include? depth
+        return :alphabet if [1, 6].include? depth
+        return :alphabet_upper if [4, 9].include? depth
+        return :roman if [3, 8].include? depth
+        return :roman_upper if [5, 10].include? depth
+
+        :arabic
+      end
+    end
+  end
+end

data/lib/isodoc/xref/xref_counter.rb

@@ -1,5 +1,6 @@
 require "roman-numerals"
 require "twitter_cldr"
+require_relative "ol_type_provider"
 
 module IsoDoc
   module XrefGen
@@ -16,6 +17,7 @@ module IsoDoc
     end
 
     class Counter
+      include OlTypeProvider
       attr_accessor :prefix_override
 
       def initialize(num = 0, opts = { numerals: :arabic })
@@ -172,17 +174,6 @@ module IsoDoc
         "#{prefix}#{@base}#{out}#{@letter_override || @letter}"
       end
 
-      def ol_type(list, depth)
-        return list["type"].to_sym if list["type"]
-        return :arabic if [2, 7].include? depth
-        return :alphabet if [1, 6].include? depth
-        return :alphabet_upper if [4, 9].include? depth
-        return :roman if [3, 8].include? depth
-        return :roman_upper if [5, 10].include? depth
-
-        :arabic
-      end
-
       def listlabel(list, depth)
         case ol_type(list, depth)
         when :arabic then @num.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.1.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -443,6 +443,7 @@ files:
 - lib/isodoc/presentation_function/image.rb
 - lib/isodoc/presentation_function/index.rb
 - lib/isodoc/presentation_function/inline.rb
+- lib/isodoc/presentation_function/list.rb
 - lib/isodoc/presentation_function/math.rb
 - lib/isodoc/presentation_function/metadata.rb
 - lib/isodoc/presentation_function/refs.rb
@@ -469,6 +470,7 @@ files:
 - lib/isodoc/word_function/table.rb
 - lib/isodoc/xref.rb
 - lib/isodoc/xref/clause_order.rb
+- lib/isodoc/xref/ol_type_provider.rb
 - lib/isodoc/xref/xref_anchor.rb
 - lib/isodoc/xref/xref_counter.rb
 - lib/isodoc/xref/xref_counter_types.rb