isodoc 2.9.4 → 2.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa1b06e38f973ba312a0f2d90d306c7ffb34e377f2fcc4a59c42775ba9f2a927
-  data.tar.gz: b74dcbe6b71b90da2ec4f205754bb08028d5bd1d45f085f7e35d6c3c47dc55cc
+  metadata.gz: 6867b3f44bce43fcfbd4c65115b8b71b6eb38cb7b1e39c20215addc7af8ad086
+  data.tar.gz: f335e4aecc20758c7c9810083d7da486ec73e0db4c377b9528841b46166085de
 SHA512:
-  metadata.gz: 9cbe711521cc25e29f1879fa47ca42347a5ecfc0f94526166a4acb73f5787d5a5d577d68e3fe756cedce0c862b4aebfb54022fea51f296cbbeeff173e2ad5521
-  data.tar.gz: a07f6c1bdd5457be3cad8fececa4974de6bc95a952c73e31b718e22606a6d4c6807293729a784d55655a4419e10486c7de171dd1630ceb2f275605b263955e5d
+  metadata.gz: 0bda93db557ef73dc1c5999bbd88d9ba06ac9977f48b93f4adca7aaac7e762d5b4fed0d62d8934151ce3ecf1becea0060d3fab65c92e2150a8a00a0c49895ee6
+  data.tar.gz: 1b0d780a2e450e8a22e8f6d4dcbcaa991e73bdcf1343ca3675c2e81b5f52688be7882f58762c18820fd2e99c4c37ea6043af8efc7f454ec44b553e00c3d356e3

data/lib/isodoc/convert.rb

@@ -10,7 +10,8 @@ require "mn-requirements"
 module IsoDoc
   class Convert < ::IsoDoc::Common
     attr_accessor :options, :i18n, :meta, :xrefs, :reqt_models,
-                  :requirements_processor, :doctype, :bibrender
+                  :requirements_processor, :doctype, :bibrender,
+                  :tempfile_cache, :wordcoverpage, :wordintropage
 
     # htmlstylesheet: Generic stylesheet for HTML
     # htmlstylesheet_override: Override stylesheet for HTML
@@ -89,11 +90,15 @@ module IsoDoc
                                                            i18nhash: @i18n.get))
     end
 
+    def convert1_namespaces(html)
+      html.add_namespace("epub", "http://www.idpf.org/2007/ops")
+    end
+
     def convert1(docxml, filename, dir)
       @xrefs.parse docxml
       noko do |xml|
         xml.html lang: @lang.to_s do |html|
-          html.parent.add_namespace("epub", "http://www.idpf.org/2007/ops")
+          convert1_namespaces(html.parent)
           info docxml, nil
           populate_css
           html.head { |head| define_head head, filename, dir }
@@ -177,5 +182,19 @@ module IsoDoc
       else "##{node['target']}"
       end
     end
+
+    # use a different class than self for rendering, as a result
+    # of document-specific criteria
+    # but pass on any singleton methods defined on top of the self instance
+    def swap_renderer(oldklass, newklass, file, input_filename, debug)
+      ref = oldklass # avoid oldklass == self for indirection of methods
+      oldklass.singleton_methods.each do |x|
+        newklass.define_singleton_method(x) do |*args|
+          ref.public_send(x, *args)
+        end
+      end
+      oldklass.singleton_methods.empty? or
+        newklass.convert_init(file, input_filename, debug)
+    end
   end
 end

data/lib/isodoc/function/inline.rb

@@ -8,7 +8,7 @@ module IsoDoc
         node["update-type"] == "true" and url = suffix_url(url)
         out.a **attr_code(href: url, title: node["alt"]) do |l|
           if node.elements.empty? && node.text.strip.empty?
-            l << node["target"].sub(/^mailto:/, "")
+            l << @c.encode(node["target"].sub(/^mailto:/, ""), :basic, :hexadecimal)
           else node.children.each { |n| parse(n, l) }
           end
         end

data/lib/isodoc/function/section.rb

@@ -152,6 +152,7 @@ module IsoDoc
       end
 
       def table_of_contents(clause, out)
+        @bare and return
         page_break(out)
         out.div **attr_code(preface_attrs(clause)) do |div|
           clause_name(clause, clause.at(ns("./title")), div,
@@ -194,32 +195,28 @@ module IsoDoc
       end
 
       def copyright_parse(node, out)
-        return if @bare
-
+        @bare and return
         out.div class: "boilerplate-copyright" do |div|
           node.children.each { |n| parse(n, div) }
         end
       end
 
       def license_parse(node, out)
-        return if @bare
-
+        @bare and return
         out.div class: "boilerplate-license" do |div|
           node.children.each { |n| parse(n, div) }
         end
       end
 
       def legal_parse(node, out)
-        return if @bare
-
+        @bare and return
         out.div class: "boilerplate-legal" do |div|
           node.children.each { |n| parse(n, div) }
         end
       end
 
       def feedback_parse(node, out)
-        return if @bare
-
+        @bare and return
         out.div class: "boilerplate-feedback" do |div|
           node.children.each { |n| parse(n, div) }
         end

data/lib/isodoc/html_function/postprocess_cover.rb

@@ -40,8 +40,10 @@ module IsoDoc
       end
 
       def html_preface(docxml)
-        html_cover(docxml) if @htmlcoverpage && !@bare
-        html_intro(docxml) if @htmlintropage && !@bare
+        @htmlcoverpage && !@htmlcoverpage.empty? && !@bare and
+          html_cover(docxml)
+        @htmlintropage && !@htmlintropage.empty? && !@bare and
+          html_intro(docxml)
         docxml.at("//body") << mathjax(@openmathdelim, @closemathdelim)
         html_main(docxml)
         authority_cleanup(docxml)

data/lib/isodoc/presentation_function/math.rb

@@ -100,7 +100,7 @@ module IsoDoc
     end
 
     def maths_just_numeral(node)
-      mn = node.at("./m:mn", MATHML).children
+      mn = node.at(".//m:mn", MATHML).children
       if node.parent.name == "stem"
         node.parent.replace(mn)
       else
@@ -127,12 +127,22 @@ module IsoDoc
     end
 
     def mathml_number(node, locale)
-      justnumeral = node.elements.size == 1 && node.elements.first.name == "mn"
+      justnumeral = numeric_mathml?(node)
       justnumeral or asciimath_dup(node)
       localize_maths(node, locale)
       justnumeral and maths_just_numeral(node)
     end
 
+    def numeric_mathml?(node)
+      m = {}
+      node.traverse do |x|
+        %w(mstyle mrow math text).include?(x.name) and next
+        m[x.name] ||= 0
+        m[x.name] += 1
+      end
+      m.keys.size == 1 && m["mn"] == 1
+    end
+
     def mathml_style_inherit(node)
       node.at("./ancestor::xmlns:strong") or return
       node.children =

data/lib/isodoc/presentation_function/refs.rb

@@ -102,9 +102,14 @@ module IsoDoc
     end
 
     def bibliography_bibitem_number_insert_pt(bibitem)
-      unless ins = bibitem.at(ns(".//docidentifier")).previous_element
-        bibitem.at(ns(".//docidentifier")).previous = " "
-        ins = bibitem.at(ns(".//docidentifier")).previous
+      unless d = bibitem.at(ns(".//docidentifier"))
+        d = bibitem.children.first
+        d.previous = " "
+        return d.previous
+      end
+      unless ins = d.previous_element
+        d.previous = " "
+        ins = d.previous
       end
       ins
     end

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "2.9.4".freeze
+  VERSION = "2.10.1".freeze
 end

data/lib/isodoc/word_function/body.rb

@@ -5,6 +5,14 @@ require_relative "lists"
 module IsoDoc
   module WordFunction
     module Body
+      def convert1_namespaces(html)
+        super
+        html.add_namespace("v", "urn:schemas-microsoft-com:vml")
+        html.add_namespace("o", "urn:schemas-microsoft-com:office:office")
+        html.add_namespace("w", "urn:schemas-microsoft-com:office:word")
+        html.add_namespace("m", "http://schemas.microsoft.com/office/2004/12/omml")
+      end
+
       def define_head(head, filename, _dir)
         head.style do |style|
           loc = File.join(File.dirname(__FILE__), "..", "base_style",

data/lib/isodoc/word_function/postprocess.rb

@@ -7,17 +7,21 @@ module IsoDoc
   module WordFunction
     module Postprocess
       def postprocess(result, filename, dir)
+        result = postprocess_cleanup(result)
         filename = filename.sub(/\.doc$/, "")
         header = generate_header(filename, dir)
-        result = from_xhtml(cleanup(to_xhtml(textcleanup(result))))
+        @wordstylesheet = wordstylesheet_update
         toWord(result, filename, dir, header)
         @files_to_delete.each { |f| FileUtils.rm_f f }
       end
 
-      def toWord(result, filename, dir, header)
-        result = from_xhtml(word_cleanup(to_xhtml(result)))
+      def postprocess_cleanup(result)
+        result = cleanup(to_xhtml(textcleanup(result)))
+        from_xhtml(word_cleanup(result))
           .gsub("-DOUBLE_HYPHEN_ESCAPE-", "--")
-        @wordstylesheet = wordstylesheet_update
+      end
+
+      def toWord(result, filename, dir, header)
         Html2Doc.new(
           filename: filename, imagedir: @localdir,
           stylesheet: @wordstylesheet&.path,
@@ -60,9 +64,16 @@ module IsoDoc
         word_tab_clean(docxml)
         authority_cleanup(docxml)
         word_footnote_format(docxml)
+        word_remove_empty_toc(docxml)
+        word_remove_empty_sections(docxml)
         docxml
       end
 
+      def word_remove_empty_toc(docxml)
+        docxml.at("//div[@class = 'TOC']//p[@class = 'MsoToc1']") and return
+        remove_toc_div(docxml)
+      end
+
       def word_sourcecode_annotations(html)
         ann = ".//div[@class = 'annotation']"
         html.xpath("//p[@class = '#{sourcecode_style}'][#{ann}]")

data/lib/isodoc/word_function/postprocess_cover.rb

@@ -2,25 +2,36 @@ module IsoDoc
   module WordFunction
     module Postprocess
       def word_preface(docxml)
-        word_cover(docxml) if @wordcoverpage
-        word_intro(docxml, @wordToClevels) if @wordintropage
+        @wordcoverpage && !@wordcoverpage.empty? and
+          word_cover(docxml)
+        @wordintropage && !@wordintropage.empty? and
+          word_intro(docxml, @wordToClevels)
+      end
+
+      def word_remove_empty_sections(docxml)
+        %w(WordSection1 WordSection2).each do |x|
+          ins = docxml.at("//div[@class='#{x}']") or next
+          @c.decode(ins.text).gsub(/\p{Z}|\p{C}/, "").strip.empty? or next
+          ins.next_element.remove
+          ins.remove
+        end
       end
 
       def word_cover(docxml)
+        ins = docxml.at('//div[@class="WordSection1"]') or return
         cover = File.read(@wordcoverpage, encoding: "UTF-8")
         cover = populate_template(cover, :word)
         coverxml = to_word_xhtml_fragment(cover)
-        docxml.at('//div[@class="WordSection1"]').children.first.previous =
-          coverxml.to_xml(encoding: "US-ASCII")
+        ins.children.first.previous = coverxml.to_xml(encoding: "US-ASCII")
       end
 
       def word_intro(docxml, level)
+        ins = docxml.at('//div[@class="WordSection2"]') or return
         intro = insert_toc(File.read(@wordintropage, encoding: "UTF-8"),
                            docxml, level)
         intro = populate_template(intro, :word)
         introxml = to_word_xhtml_fragment(intro)
-        docxml.at('//div[@class="WordSection2"]').children.first.previous =
-          introxml.to_xml(encoding: "US-ASCII")
+        ins.children.first.previous = introxml.to_xml(encoding: "US-ASCII")
       end
 
       # add namespaces for Word fragments
@@ -90,10 +101,7 @@ module IsoDoc
       def generate_header(filename, _dir)
         @header or return nil
         template = IsoDoc::Common.liquid(File.read(@header, encoding: "UTF-8"))
-        meta = @meta.get.merge(@labels ? { labels: @labels } : {})
-          .merge(@meta.labels ? { labels: @meta.labels } : {})
-        meta[:filename] = filename
-        params = meta.transform_keys(&:to_s)
+        params = header_params(filename)
         Tempfile.open(%w(header html),
                       mode: File::BINARY | File::SHARE_DELETE,
                       encoding: "utf-8") do |f|
@@ -102,6 +110,13 @@ module IsoDoc
         end
       end
 
+      def header_params(filename)
+        meta = @meta.get.merge(@labels ? { labels: @labels } : {})
+          .merge(@meta.labels ? { labels: @meta.labels } : {})
+        meta[:filename] = filename
+        meta.transform_keys(&:to_s)
+      end
+
       def word_section_breaks(docxml)
         @landscapestyle = ""
         word_section_breaks1(docxml, "WordSection2")

data/lib/isodoc/word_function/postprocess_toc.rb

@@ -4,11 +4,7 @@ module IsoDoc
       def insert_toc(intro, docxml, level)
         toc = assemble_toc(docxml, level)
         if intro&.include?("WORDTOC")
-          if s = docxml.at("//div[@class = 'TOC']")
-            s&.previous_element&.elements&.first&.name == "br" and
-              s&.previous_element&.remove # page break
-            s.remove
-          end
+          remove_toc_div(docxml)
           intro.sub("WORDTOC", toc)
         else
           source = docxml.at("//div[@class = 'TOC']") and
@@ -17,6 +13,14 @@ module IsoDoc
         end
       end
 
+      def remove_toc_div(docxml)
+        s = docxml.at("//div[@class = 'TOC']") or return
+        prev = s.previous_element
+        prev&.elements&.first&.name == "br" and
+          prev&.remove # page break
+        s.remove
+      end
+
       def assemble_toc(docxml, level)
         toc = ""
         toc += make_WordToC(docxml, level)

data/lib/isodoc/xref/clause_order.rb

@@ -0,0 +1,41 @@
+module IsoDoc
+  module XrefGen
+    module Sections
+      def clause_order(docxml)
+        { preface: clause_order_preface(docxml),
+          main: clause_order_main(docxml),
+          annex: clause_order_annex(docxml),
+          back: clause_order_back(docxml) }
+      end
+
+      def clause_order_preface(_docxml)
+        [{ path: "//preface/*", multi: true }]
+      end
+
+      def clause_order_main(docxml)
+        [
+          { path: "//sections/clause[@type = 'scope']" },
+          { path: @klass.norm_ref_xpath },
+          { path: "//sections/terms | " \
+            "//sections/clause[descendant::terms]" },
+          { path: "//sections/definitions | " \
+            "//sections/clause[descendant::definitions]" \
+            "[not(descendant::terms)]" },
+          { path: @klass.middle_clause(docxml), multi: true },
+        ]
+      end
+
+      def clause_order_annex(_docxml)
+        [{ path: "//annex", multi: true }]
+      end
+
+      def clause_order_back(_docxml)
+        [
+          { path: @klass.bibliography_xpath },
+          { path: "//indexsect", multi: true },
+          { path: "//colophon/*", multi: true },
+        ]
+      end
+    end
+  end
+end

data/lib/isodoc/xref/xref_counter.rb

@@ -139,7 +139,7 @@ module IsoDoc
       end
 
       def increment(node)
-        @unnumbered = (node["unnumbered"] || node["hidden"]) and return self
+        @unnumbered = node["unnumbered"] == "true" || node["hidden"] == "true" and return self
         reset_overrides
         if node["subsequence"] != @subseq &&
             !(blank?(node["subsequence"]) && blank?(@subseq))

data/lib/isodoc/xref/xref_gen.rb

@@ -88,6 +88,7 @@ module IsoDoc
 
       def admonition_anchor_names(sections)
         sections.each do |s|
+          s.at(ns(".//admonition[@type = 'box']")) or next
           notes = s.xpath(child_asset_path("admonition[@type = 'box']"))
           admonition_anchor_names1(notes, Counter.new)
           admonition_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
@@ -132,20 +133,19 @@ module IsoDoc
         end
       end
 
-      def list_item_anchor_names(list, list_anchor, depth, prev_label,
-refer_list)
+      def list_item_anchor_names(list, list_anchor, depth, prev_label, refer_list)
         c = Counter.new(list["start"] ? list["start"].to_i - 1 : 0)
         list.xpath(ns("./li")).each do |li|
           bare_label, label =
             list_item_value(li, c, depth, { list_anchor: list_anchor, prev_label: prev_label,
-                                            refer_list: refer_list })
+                                            refer_list: depth == 1 ? refer_list : nil })
           li["id"] and @anchors[li["id"]] =
                          { label: bare_label, bare_xref: "#{label})",
                            xref: "#{label})",
                            type: "listitem", refer_list: refer_list,
                            container: list_anchor[:container] }
           (li.xpath(ns(".//ol")) - li.xpath(ns(".//ol//ol"))).each do |ol|
-            list_item_anchor_names(ol, list_anchor, depth + 1, label, false)
+            list_item_anchor_names(ol, list_anchor, depth + 1, label, refer_list)
           end
         end
       end

data/lib/isodoc/xref/xref_sect_gen.rb

@@ -1,42 +1,8 @@
+require_relative "clause_order"
+
 module IsoDoc
   module XrefGen
     module Sections
-      def clause_order(docxml)
-        { preface: clause_order_preface(docxml),
-          main: clause_order_main(docxml),
-          annex: clause_order_annex(docxml),
-          back: clause_order_back(docxml) }
-      end
-
-      def clause_order_preface(_docxml)
-        [{ path: "//preface/*", multi: true }]
-      end
-
-      def clause_order_main(docxml)
-        [
-          { path: "//sections/clause[@type = 'scope']" },
-          { path: @klass.norm_ref_xpath },
-          { path: "//sections/terms | " \
-            "//sections/clause[descendant::terms]" },
-          { path: "//sections/definitions | " \
-            "//sections/clause[descendant::definitions]" \
-            "[not(descendant::terms)]" },
-          { path: @klass.middle_clause(docxml), multi: true },
-        ]
-      end
-
-      def clause_order_annex(_docxml)
-        [{ path: "//annex", multi: true }]
-      end
-
-      def clause_order_back(_docxml)
-        [
-          { path: @klass.bibliography_xpath },
-          { path: "//indexsect", multi: true },
-          { path: "//colophon/*", multi: true },
-        ]
-      end
-
       def back_anchor_names(xml)
         if @parse_settings.empty? || @parse_settings[:clauses]
           annex_anchor_names(xml)
@@ -105,11 +71,12 @@ module IsoDoc
         termnote_anchor_names(doc)
         termexample_anchor_names(doc)
         note_anchor_names(doc.xpath(ns("//table | //figure")))
-        note_anchor_names(doc.xpath(ns(sections_xpath)))
-        admonition_anchor_names(doc.xpath(ns(sections_xpath)))
-        example_anchor_names(doc.xpath(ns(sections_xpath)))
-        list_anchor_names(doc.xpath(ns(sections_xpath)))
-        deflist_anchor_names(doc.xpath(ns(sections_xpath)))
+        sections = doc.xpath(ns(sections_xpath))
+        note_anchor_names(sections)
+        admonition_anchor_names(sections)
+        example_anchor_names(sections)
+        list_anchor_names(sections)
+        deflist_anchor_names(sections)
         bookmark_anchor_names(doc)
       end
 
@@ -172,7 +139,7 @@ module IsoDoc
       end
 
       def section_names(clause, num, lvl)
-        clause.nil? and return num
+        unnumbered_section_name?(clause) and return num
         num.increment(clause)
         section_name_anchors(clause, num.print, lvl)
         clause.xpath(ns(SUBCLAUSES))
@@ -183,6 +150,7 @@ module IsoDoc
       end
 
       def section_names1(clause, num, level)
+        unnumbered_section_name?(clause) and return num
         section_name_anchors(clause, num, level)
         i = Counter.new(0, prefix: "#{num}.")
         clause.xpath(ns(SUBCLAUSES)).each do |c|
@@ -190,6 +158,15 @@ module IsoDoc
         end
       end
 
+      def unnumbered_section_name?(clause)
+        clause.nil? and return true
+        if clause["unnumbered"] == "true"
+          unnumbered_names(clause)
+          return true
+        end
+        false
+      end
+
       def section_name_anchors(clause, num, level)
         @anchors[clause["id"]] =
           { label: num, xref: l10n("#{@labels['clause']} #{num}"),

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 2.9.4
+  version: 2.10.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-25 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html2doc
@@ -392,6 +392,7 @@ files:
 - lib/isodoc/word_function/postprocess_toc.rb
 - lib/isodoc/word_function/table.rb
 - lib/isodoc/xref.rb
+- lib/isodoc/xref/clause_order.rb
 - lib/isodoc/xref/xref_anchor.rb
 - lib/isodoc/xref/xref_counter.rb
 - lib/isodoc/xref/xref_gen.rb