isodoc 3.1.0 → 3.1.2

data/lib/isodoc/word_function/footnotes.rb

@@ -10,75 +10,67 @@ module IsoDoc
         sprintf "%09d", ret
       end
 
-      def footnotes(div)
-        return if @footnotes.empty?
-
-        @footnotes.each { |fn| div.parent << fn }
-      end
-
-      def make_table_footnote_link(out, fnid, fnref)
+      def make_table_footnote_link(out, fnid, node)
         attrs = { href: "##{fnid}", class: "TableFootnoteRef" }
+        sup = node.at(ns("./sup")) and sup.replace(sup.children)
         out.a **attrs do |a|
-          a << fnref
+          children_parse(node, a)
         end
       end
 
-      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)
+      def fmt_fn_body_parse(node, out)
+        node.at(ns(".//fmt-fn-label"))&.remove
+        aside = node.parent.name == "fmt-footnote-container"
+        tag = aside ? "aside" : "div"
+        out.send tag, id: "ftn#{node['reference']}" do |div|
+          node.children.each { |n| parse(n, div) }
         end
       end
 
-      def make_table_footnote_text(node, fnid, fnref)
-        attrs = { id: "ftn#{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 make_generic_footnote_text(node, fnid)
-        noko do |xml|
-          xml.aside id: "ftn#{fnid}" do |div|
-            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?
-
-        table.last["id"]
+      # dupe to HTML
+ def get_table_ancestor_id(node)
+    table = node.ancestors("table")
+        table.empty? and table = node.ancestors("figure")
+        table.empty? and return [nil, UUIDTools::UUID.random_create.to_s]
+        [table.last, table.last["id"]]
       end
 
+      # dupe to HTML
       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)
+        table, tid = get_table_ancestor_id(node)
+        make_table_footnote_link(out, tid + fn, node.at(ns("./fmt-fn-label")))
         # 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 { |a| a << make_table_footnote_text(node, tid + fn, fn) }
-        @in_footnote = false
+        update_table_fn_body_ref(node, table, tid + fn)
         @seen_footnote << (tid + fn)
       end
 
-      def seen_footnote_parse(_node, out, footnote)
-        out.span style: "mso-element:field-begin"
-        out << " NOTEREF _Ref#{@fn_bookmarks[footnote]} \\f \\h"
-        out.span style: "mso-element:field-separator"
-        out.span class: "MsoFootnoteReference" do |s|
-          s << footnote
+      # TODO merge with HTML
+      def update_table_fn_body_ref(fnote, table, reference)
+        fnbody = table.at(ns(".//fmt-fn-body[@id = '#{fnote['target']}']")) or return
+        fnbody["reference"] = reference
+        sup = fnbody.at(ns(".//fmt-fn-label/sup")) and sup.replace(sup.children)
+        fnbody.xpath(ns(".//fmt-fn-label")).each do |s|
+          s["class"] = "TableFootnoteRef"
+          s.name = "span"
+          d = s.at(ns("./span[@class = 'fmt-caption-delim']")) and
+            s.next = d
+        end
+      end
+
+      def seen_footnote_parse(node, out, footnote)
+        f = node.at(ns("./fmt-fn-label"))
+        sup = f.at(ns(".//sup")) and sup.replace(sup.children)
+        s = f.at(ns(".//semx[@source = '#{node['id']}']"))
+
+        semx = <<~SPAN.strip
+<span style="mso-element:field-begin"/> NOTEREF _Ref#{@fn_bookmarks[footnote]} \\f \\h<span style="mso-element:field-separator"/>#{footnote}<span style="mso-element:field-end"/>
+        SPAN
+        s.replace(semx)
+        out.span class: "MsoFootnoteReference" do |fn|
+          children_parse(f, fn)
         end
-        out.span style: "mso-element:field-end"
       end
 
       def footnote_parse(node, out)
@@ -89,26 +81,23 @@ module IsoDoc
         return seen_footnote_parse(node, out, fn) if @seen_footnote.include?(fn)
 
         @fn_bookmarks[fn] = bookmarkid
-        out.span style: "mso-bookmark:_Ref#{@fn_bookmarks[fn]}" do |s|
-          s.a class: "FootnoteRef", "epub:type": "footnote",
-              href: "#ftn#{fn}" do |a|
-            a.sup { |sup| sup << fn }
-          end
+        f = node.at(ns("./fmt-fn-label"))
+        sup = f.at(ns(".//sup")) and sup.replace(sup.children)
+        if semx = f.at(ns(".//semx[@element = 'autonum']"))
+          semx.name = "span"
+          semx["class"] = "FMT-PLACEHOLDER"
+        end
+        out.span style: "mso-bookmark:_Ref#{@fn_bookmarks[fn]}", class: "MsoFootnoteReference" do |s|
+              children_parse(f, out)
+        end
+        if semx = out.parent.at(".//span[@class = 'FMT-PLACEHOLDER']")
+          semx.name = "a"
+          semx["class"] = "FootnoteRef"
+          semx["epub:type"] = "footnote"
+          semx["href"] = "#ftn#{fn}"
         end
-        @in_footnote = true
-        @footnotes << make_generic_footnote_text(node, fn)
-        @in_footnote = false
         @seen_footnote << fn
       end
-
-      def make_footnote(node, footnote)
-        return if @seen_footnote.include?(footnote)
-
-        @in_footnote = true
-        @footnotes << make_generic_footnote_text(node, footnote)
-        @in_footnote = false
-        @seen_footnote << footnote
-      end
     end
   end
 end

data/lib/isodoc/word_function/postprocess.rb

@@ -63,7 +63,7 @@ module IsoDoc
         word_section_breaks(docxml)
         word_tab_clean(docxml)
         authority_cleanup(docxml)
-        word_footnote_format(docxml)
+        #word_footnote_format(docxml)
         word_remove_empty_toc(docxml)
         word_remove_empty_sections(docxml)
         docxml
@@ -172,12 +172,16 @@ module IsoDoc
         end
       end
 
-      def word_footnote_format(docxml)
+      # 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)

data/lib/isodoc/xref/xref_gen.rb

@@ -36,12 +36,6 @@ module IsoDoc
         end
       end
 
-      def increment_label(elems, node, counter, increment: true)
-        elems.size == 1 && !node["number"] and return ""
-        counter.increment(node) if increment
-        counter.print
-      end
-
       def termnote_anchor_names(docxml)
         docxml.xpath(ns("//*[termnote]")).each do |t|
           c = Counter.new
@@ -240,8 +234,7 @@ refer_list)
       def bookmark_container(parent)
         if parent
           clause = parent.xpath(CLAUSE_ANCESTOR)&.last
-          if clause["id"] == id
-            nil
+          if clause["id"] == id then nil
           else
             @anchors.dig(clause["id"], :xref)
           end
@@ -251,7 +244,6 @@ refer_list)
       def bookmark_anchor_names(xml)
         xml.xpath(ns(".//bookmark")).noblank.each do |n|
           _parent, id = id_ancestor(n)
-          # container = bookmark_container(parent)
           @anchors[n["id"]] = { type: "bookmark", label: nil, value: nil,
                                 xref: @anchors.dig(id, :xref) || "???",
                                 container: @anchors.dig(id, :container) }

data/lib/isodoc/xref/xref_gen_seq.rb

@@ -1,20 +1,9 @@
 require_relative "../function/utils"
+require_relative "xref_util"
 
 module IsoDoc
   module XrefGen
     module Blocks
-      def hiersep
-        "."
-      end
-
-      def hierfigsep
-        "-"
-      end
-
-      def hierreqtsep
-        "-"
-      end
-
       def subfigure_increment(idx, counter, elem)
         if elem.parent.name == "figure" then idx += 1
         else
@@ -54,33 +43,11 @@ module IsoDoc
         end
       end
 
-      def hier_separator(markup: false)
-        h = hiersep
-        h.blank? || !markup or h = delim_wrap(h)
-        h
-      end
-
       def subfigure_label(subfignum)
         subfignum.zero? and return
         subfignum.to_s
       end
 
-      def subfigure_separator(markup: false)
-        h = hierfigsep
-        h.blank? || !markup or h = delim_wrap(h)
-        h
-      end
-
-      def subreqt_separator(markup: false)
-        h = hierreqtsep
-        h.blank? || !markup or h = delim_wrap(h)
-        h
-      end
-
-      def subfigure_delim
-        ""
-      end
-
       def figure_anchor(elem, sublabel, label, klass, container: false)
         if sublabel
           /<semx/.match?(label) or label = semx(elem.parent, label)
@@ -106,11 +73,11 @@ module IsoDoc
         )
         if elem["unnumbered"] != "true"
           x = "#{subfigure_separator(markup: true)}#{semx(elem, sublabel)}"
-          @anchors[elem["id"]][:label] = "#{label}#{x}" # "#{semx(elem.parent, label)}#{x}"
+          @anchors[elem["id"]][:label] = "#{label}#{x}"
           @anchors[elem["id"]][:xref] = @anchors[elem.parent["id"]][:xref] + x +
             delim_wrap(subfigure_delim)
           x = @anchors[elem.parent["id"]][:container] and
-          @anchors[elem["id"]][:container] = x
+            @anchors[elem["id"]][:container] = x
         end
       end
 
@@ -119,8 +86,8 @@ module IsoDoc
         clause.xpath(ns(".//table")).noblank.each do |t|
           # labelled_ancestor(t) and next
           @anchors[t["id"]] = anchor_struct(
-            c.increment(t).print, t,
-            @labels["table"], "table", { unnumb: t["unnumbered"], container: container }
+            c.increment(t).print, t, @labels["table"], "table",
+            { unnumb: t["unnumbered"], container: container }
           )
         end
       end
@@ -183,8 +150,9 @@ container: false)
           x = "#{subreqt_separator(markup: true)}#{semx(elem, id)}"
           @anchors[elem["id"]][:semx] = @anchors[elem.parent["id"]][:semx] + x
           @anchors[elem["id"]][:label] =
-            "<span class='fmt-element-name'>#{label}</span> #{@anchors[elem["id"]][:semx]}"
-          @anchors[elem["id"]][:xref] = "<span class='fmt-element-name'>#{label}</span> #{@anchors[elem["id"]][:semx]}"
+            "<span class='fmt-element-name'>#{label}</span> #{@anchors[elem['id']][:semx]}"
+          @anchors[elem["id"]][:xref] =
+            "<span class='fmt-element-name'>#{label}</span> #{@anchors[elem['id']][:semx]}"
         end
         model.permission_parts(elem, id, label, klass).each do |n|
           @anchors[n[:id]] = anchor_struct(n[:number], n[:elem], n[:label],
@@ -217,31 +185,19 @@ container: false)
         sequential_permission_names(clause, container:)
       end
 
-      def nodeSet(clauses)
-        case clauses
-        when Nokogiri::XML::Node
-          [clauses]
-        when Nokogiri::XML::NodeSet
-          clauses
-        end
-      end
-
       # these can take a NodeSet as argument; semx will point to members of the NodeSet,
       # but numbering will be consecutive
       def hierarchical_figure_names(clauses, num)
         c = Counter.new
         j = 0
         nodeSet(clauses).each do |clause|
-        clause.xpath(ns(self.class::FIGURE_NO_CLASS)).noblank.each do |t|
-          # labelled_ancestor(t, %w(figure)) and next
-          j = subfigure_increment(j, c, t)
-          sublabel = subfigure_label(j)
-          # hierarchical_figure_body(num, j, c, t, "figure")
-          #figure_anchor(t, sublabel, "#{num}#{hier_separator}#{c.print}", "figure")
-          #require "debug"; binding.b
-          figure_anchor(t, sublabel, hiersemx(clause, num, c, t), "figure")
-        end
-        hierarchical_figure_class_names(clause, num)
+          clause.xpath(ns(self.class::FIGURE_NO_CLASS)).noblank.each do |t|
+            # labelled_ancestor(t, %w(figure)) and next
+            j = subfigure_increment(j, c, t)
+            sublabel = subfigure_label(j)
+            figure_anchor(t, sublabel, hiersemx(clause, num, c, t), "figure")
+          end
+          hierarchical_figure_class_names(clause, num)
         end
       end
 
@@ -249,29 +205,27 @@ container: false)
         c = {}
         j = 0
         nodeSet(clauses).each do |clause|
-        clause.xpath(ns(".//figure[@class][not(@class = 'pseudocode')]"))
-          .noblank.each do |t|
-          # labelled_ancestor(t, %w(figure)) and next
-          c[t["class"]] ||= Counter.new
-          j = subfigure_increment(j, c[t["class"]], t)
-          sublabel = subfigure_label(j)
-          # hierarchical_figure_body(num, j, c[t["class"]], t, t["class"])
-          #figure_anchor(t, sublabel, "#{num}#{hier_separator}#{c[t['class']].print}", t["class"])
-          figure_anchor(t, sublabel, hiersemx(clause, num, c[t["class"]], t), t["class"])
-        end
+          clause.xpath(ns(".//figure[@class][not(@class = 'pseudocode')]"))
+            .noblank.each do |t|
+            # labelled_ancestor(t, %w(figure)) and next
+            c[t["class"]] ||= Counter.new
+            j = subfigure_increment(j, c[t["class"]], t)
+            sublabel = subfigure_label(j)
+            figure_anchor(t, sublabel, hiersemx(clause, num, c[t["class"]], t),
+                          t["class"])
+          end
         end
       end
 
       def hierarchical_table_names(clauses, num)
         c = Counter.new
         nodeSet(clauses).each do |clause|
-        clause.xpath(ns(".//table")).noblank.each do |t|
-          # labelled_ancestor(t) and next
-          @anchors[t["id"]] =
-            #anchor_struct("#{num}#{hier_separator}#{c.increment(t).print}",
-            anchor_struct(hiersemx(clause, num, c.increment(t), t),
-                          t, @labels["table"], "table", { unnumb: t["unnumbered"], container: false })
-        end
+          clause.xpath(ns(".//table")).noblank.each do |t|
+            # labelled_ancestor(t) and next
+            @anchors[t["id"]] =
+              anchor_struct(hiersemx(clause, num, c.increment(t), t),
+                            t, @labels["table"], "table", { unnumb: t["unnumbered"], container: false })
+          end
         end
       end
 
@@ -285,29 +239,30 @@ container: false)
       def hierarchical_formula_names(clauses, num)
         c = Counter.new
         nodeSet(clauses).each do |clause|
-        clause.xpath(ns(".//formula")).noblank.each do |t|
-          @anchors[t["id"]] = anchor_struct(
-            #"#{num}#{hier_separator}#{c.increment(t).print}", t,
-                     hiersemx(clause, num, c.increment(t), t), t,
-            t["inequality"] ? @labels["inequality"] : @labels["formula"],
-            "formula", { unnumb: t["unnumbered"], container: false }
-          )
-        end
+          clause.xpath(ns(".//formula")).noblank.each do |t|
+            @anchors[t["id"]] = anchor_struct(
+              # "#{num}#{hier_separator}#{c.increment(t).print}", t,
+              hiersemx(clause, num, c.increment(t), t), t,
+              t["inequality"] ? @labels["inequality"] : @labels["formula"],
+              "formula", { unnumb: t["unnumbered"], container: false }
+            )
+          end
         end
       end
 
       def hierarchical_permission_names(clauses, num)
         c = ReqCounter.new
         nodeSet(clauses).each do |clause|
-        clause.xpath(ns(FIRST_LVL_REQ)).noblank.each do |t|
-          m = @reqt_models.model(t["model"])
-          klass, label = reqt2class_label(t, m)
-          #id = "#{num}#{hier_separator}#{c.increment(label, t).print}"
-          id = hiersemx(clause, num, c.increment(label, t), t)
-          sequential_permission_body(id, nil, t, label, klass, m, container: false)
-          sequential_permission_children(t, id, klass, container: false)
+          clause.xpath(ns(FIRST_LVL_REQ)).noblank.each do |t|
+            m = @reqt_models.model(t["model"])
+            klass, label = reqt2class_label(t, m)
+            # id = "#{num}#{hier_separator}#{c.increment(label, t).print}"
+            id = hiersemx(clause, num, c.increment(label, t), t)
+            sequential_permission_body(id, nil, t, label, klass, m,
+                                       container: false)
+            sequential_permission_children(t, id, klass, container: false)
+          end
         end
-       end
       end
     end
   end

data/lib/isodoc/xref/xref_util.rb

@@ -23,6 +23,49 @@ module IsoDoc
         xpath.reject { |n| blank?(n["id"]) }
       end
 
+      def hiersep
+        "."
+      end
+
+      def hierfigsep
+        "-"
+      end
+
+      def hierreqtsep
+        "-"
+      end
+
+      def hier_separator(markup: false)
+        h = hiersep
+        h.blank? || !markup or h = delim_wrap(h)
+        h
+      end
+
+      def subfigure_separator(markup: false)
+        h = hierfigsep
+        h.blank? || !markup or h = delim_wrap(h)
+        h
+      end
+
+      def subreqt_separator(markup: false)
+        h = hierreqtsep
+        h.blank? || !markup or h = delim_wrap(h)
+        h
+      end
+
+      def subfigure_delim
+        ""
+      end
+
+      def nodeSet(clauses)
+        case clauses
+        when Nokogiri::XML::Node
+          [clauses]
+        when Nokogiri::XML::NodeSet
+          clauses
+        end
+      end
+
       SECTIONS_XPATH =
         "//foreword | //introduction | //acknowledgements | " \
         "//preface/abstract | " \
@@ -85,6 +128,12 @@ module IsoDoc
         label.blank? and return autonum
         l10n("<span class='fmt-element-name'>#{label}</span> #{autonum}")
       end
+
+      def increment_label(elems, node, counter, increment: true)
+        elems.size == 1 && !node["number"] and return ""
+        counter.increment(node) if increment
+        counter.print
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
@@ -282,14 +296,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sassc-embedded
   requirement: !ruby/object:Gem::Requirement
@@ -403,6 +431,7 @@ files:
 - lib/isodoc/function/blocks.rb
 - lib/isodoc/function/blocks_example_note.rb
 - lib/isodoc/function/cleanup.rb
+- lib/isodoc/function/footnotes.rb
 - lib/isodoc/function/form.rb
 - lib/isodoc/function/inline.rb
 - lib/isodoc/function/inline_simple.rb
@@ -411,6 +440,7 @@ files:
 - lib/isodoc/function/reqt.rb
 - lib/isodoc/function/section.rb
 - lib/isodoc/function/section_titles.rb
+- lib/isodoc/function/setup.rb
 - lib/isodoc/function/table.rb
 - lib/isodoc/function/terms.rb
 - lib/isodoc/function/to_word_html.rb
@@ -420,7 +450,6 @@ files:
 - lib/isodoc/html_convert.rb
 - lib/isodoc/html_function.rb
 - lib/isodoc/html_function/comments.rb
-- lib/isodoc/html_function/footnotes.rb
 - lib/isodoc/html_function/form.rb
 - lib/isodoc/html_function/html.rb
 - lib/isodoc/html_function/mathvariant_to_plain.rb
@@ -439,6 +468,7 @@ files:
 - lib/isodoc/presentation_function/concepts.rb
 - lib/isodoc/presentation_function/docid.rb
 - lib/isodoc/presentation_function/erefs.rb
+- lib/isodoc/presentation_function/footnotes.rb
 - lib/isodoc/presentation_function/image.rb
 - lib/isodoc/presentation_function/index.rb
 - lib/isodoc/presentation_function/inline.rb
@@ -502,7 +532,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Convert documents in IsoDoc into Word and HTML in AsciiDoc.