isodoc 2.5.3 → 2.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af49b7f014295d868870736466462acab674753399c173b2fea81b5e93bce2ea
-  data.tar.gz: 50816b1a7bac40a6fa6d54130bfa1c199d17e9013b22fde96e3b93c30f5602cd
+  metadata.gz: 3cbf57138d05cbc6fb861e09c867a3f4f3a58d349be341676e3a4ff2ef3b3477
+  data.tar.gz: e201871207c3d77a4be10a66624cd40859baf0a09bf309382f4fb43b2154e0eb
 SHA512:
-  metadata.gz: 0f6f487050715c2a09af3b0c5a7e5c5b3f81cf58afaa05b451bfcc240a79de055ed78b770ed8ffcc1e8c1804c2cbf6985c64ee18870df95edad4e57261911e73
-  data.tar.gz: 98f4b78b5ab197058fb69131c097f9636e765e1a3d9f5fa05ae39a3a7e1fc777b75d4f6b4ce745249234cd9ba42409476663a9dc1800efabef37e13a0ed70395
+  metadata.gz: 4b543165a879e7e1a4992c6a6bf58baa5b606af5ea83773194666daf4605ac4fb2142a95817b9259c825e9aa1abfcb750e1a0b6d4663ff29225ff6b547958b92
+  data.tar.gz: df54828f56b89b01dea07da527868a7f6fd7cf775b7133d4877856b97d838cbe48d21dbbde53263f61e51d937b6cf278a8e897f00d726ebccf3802e254999e97

data/isodoc.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ribose Inc."]
   spec.email         = ["open.source@ribose.com"]
 
-  spec.summary       = "Convert documents in IsoDoc into Word and HTML "\
+  spec.summary       = "Convert documents in IsoDoc into Word and HTML " \
                        "in AsciiDoc."
   spec.description   = <<~DESCRIPTION
     isodoc converts documents in the IsoDoc document model into
@@ -26,14 +26,13 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features|bin|.github)/}) \
     || f.match(%r{Rakefile|bin/rspec})
   end
-  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "html2doc", "~> 1.5.3"
   spec.add_dependency "htmlentities", "~> 4.3.4"
   # spec.add_dependency "isodoc-i18n", "~> 1.1.0" # already in relaton-render and mn-requirements
-  spec.add_dependency "liquid", "~> 5"
   spec.add_dependency "emf2svg"
+  spec.add_dependency "liquid", "~> 5"
   spec.add_dependency "plurimath"
   spec.add_dependency "relaton-cli"
   # spec.add_dependency "metanorma-utils", "~> 1.5.0" # already in isodoc-i18n

data/lib/isodoc/function/section.rb

@@ -96,57 +96,77 @@ module IsoDoc
         clause_parse(isoxml, out)
       end
 
-      def introduction(isoxml, out)
-        f = isoxml.at(ns("//introduction")) || return
+      def introduction(clause, out)
         page_break(out)
-        out.div class: "Section3", id: f["id"] do |div|
-          clause_name(f, f.at(ns("./title")), div, { class: "IntroTitle" })
-          f.elements.each do |e|
+        out.div class: "Section3", id: clause["id"] do |div|
+          clause_name(clause, clause.at(ns("./title")), div,
+                      { class: "IntroTitle" })
+          clause.elements.each do |e|
             parse(e, div) unless e.name == "title"
           end
         end
       end
 
-      def foreword(isoxml, out)
-        f = isoxml.at(ns("//foreword")) || return
+      def foreword(clause, out)
         page_break(out)
-        out.div **attr_code(id: f["id"]) do |s|
-          clause_name(f, f.at(ns("./title")) || @i18n.foreword, s,
+        out.div **attr_code(id: clause["id"]) do |s|
+          clause_name(clause, clause.at(ns("./title")) || @i18n.foreword, s,
                       { class: "ForewordTitle" })
-          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+          clause.elements.each { |e| parse(e, s) unless e.name == "title" }
         end
       end
 
-      def acknowledgements(isoxml, out)
-        f = isoxml.at(ns("//acknowledgements")) || return
+      def acknowledgements(clause, out)
         title_attr = { class: "IntroTitle" }
         page_break(out)
-        out.div class: "Section3", id: f["id"] do |div|
-          clause_name(f, f&.at(ns("./title")), div, title_attr)
-          f.elements.each do |e|
+        out.div class: "Section3", id: clause["id"] do |div|
+          clause_name(clause, clause.at(ns("./title")), div, title_attr)
+          clause.elements.each do |e|
             parse(e, div) unless e.name == "title"
           end
         end
       end
 
-      def abstract(isoxml, out)
-        f = isoxml.at(ns("//preface/abstract")) || return
+      def abstract(clause, out)
         page_break(out)
-        out.div **attr_code(id: f["id"]) do |s|
-          clause_name(f, f.at(ns("./title")), s, { class: "AbstractTitle" })
-          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        out.div **attr_code(id: clause["id"]) do |s|
+          clause_name(clause, clause.at(ns("./title")), s,
+                      { class: "AbstractTitle" })
+          clause.elements.each { |e| parse(e, s) unless e.name == "title" }
         end
       end
 
-      def preface(isoxml, out)
-        isoxml.xpath(ns("//preface/clause | //preface/references | " \
-                        "//preface/definitions | //preface/terms")).each do |f|
-          page_break(out)
-          out.div class: "Section3", id: f["id"] do |div|
-            clause_name(f, f&.at(ns("./title")), div, { class: "IntroTitle" })
-            f.elements.each do |e|
-              parse(e, div) unless e.name == "title"
-            end
+      def preface_attrs(node)
+        { id: node["id"],
+          class: node["type"] == "toc" ? "TOC" : "Section3" }
+      end
+
+      def preface(clause, out)
+        if clause["type"] == "toc"
+          table_of_contents(clause, out)
+        else
+          preface_normal(clause, out)
+        end
+      end
+
+      def preface_normal(clause, out)
+        page_break(out)
+        out.div **attr_code(preface_attrs(clause)) do |div|
+          clause_name(clause, clause.at(ns("./title")), div,
+                      { class: "IntroTitle" })
+          clause.elements.each do |e|
+            parse(e, div) unless e.name == "title"
+          end
+        end
+      end
+
+      def table_of_contents(clause, out)
+        page_break(out)
+        out.div **attr_code(preface_attrs(clause)) do |div|
+          clause_name(clause, clause.at(ns("./title")), div,
+                      { class: "IntroTitle" })
+          clause.elements.each do |e|
+            parse(e, div) unless e.name == "title"
           end
         end
       end
@@ -174,15 +194,33 @@ module IsoDoc
         t.size == 1 && %w(terms definitions references).include?(t[0].name)
       end
 
-      def preface_block(isoxml, out)
+      def front(isoxml, out)
         p = isoxml.at(ns("//preface")) or return
         p.elements.each do |e|
-          next if is_clause?(e.name)
-
-          parse(e, out)
+          if is_clause?(e.name)
+            case e.name
+            when "abstract" then abstract e, out
+            when "foreword" then foreword e, out
+            when "introduction" then introduction e, out
+            when "executivesummary" then executivesummary e, out
+            when "clause" then preface e, out
+            when "acknowledgements" then acknowledgements e, out
+            end
+          else
+            preface_block(e, out)
+          end
         end
       end
 
+      def executivesummary(clause, out)
+        introduction clause, out
+      end
+
+      # block, e.g. note, admonition
+      def preface_block(block, out)
+        parse(block, out)
+      end
+
       def copyright_parse(node, out)
         return if @bare
 

data/lib/isodoc/html_function/html.rb

@@ -37,12 +37,7 @@ module IsoDoc
       def make_body3(body, docxml)
         body.div class: "main-section" do |div3|
           boilerplate docxml, div3
-          preface_block docxml, div3
-          abstract docxml, div3
-          foreword docxml, div3
-          introduction docxml, div3
-          preface docxml, div3
-          acknowledgements docxml, div3
+          front docxml, div3
           middle docxml, div3
           footnotes div3
           comments div3

data/lib/isodoc/html_function/postprocess_cover.rb

@@ -117,16 +117,24 @@ module IsoDoc
 
       # needs to be same output as toclevel
       def html_toc(docxml)
-        idx = docxml.at("//div[@id = 'toc']") or return docxml
+        idx = html_toc_init(docxml) or return docxml
         path = toclevel_classes.map do |x|
           x.map { |l| "//main//#{l}#{toc_exclude_class}" }
         end
         toc = html_toc_entries(docxml, path)
           .map { |k| k[:entry] }.join("\n")
-        idx.children = "<ul>#{toc}</ul>"
+        idx << "<ul>#{toc}</ul>"
         docxml
       end
 
+      def html_toc_init(docxml)
+        dest = docxml.at("//div[@id = 'toc']") or return
+        if source = docxml.at("//div[@class = 'TOC']")
+          dest << to_xml(source.remove.children)
+        end
+        dest
+      end
+
       def html_toc_entries(docxml, path)
         path.each_with_index.with_object([]) do |(p, i), m|
           docxml.xpath(p.join(" | ")).each do |h|

data/lib/isodoc/presentation_function/section.rb

@@ -124,9 +124,103 @@ module IsoDoc
       display_order_xpath(docxml, "//colophon/*", i)
     end
 
-    def clausetitle(docxml); end
+    def clausetitle(docxml)
+      cjk_extended_title(docxml)
+    end
+
+    def cjk_search
+      lang = %w(zh ja ko).map { |x| "@language = '#{x}'" }.join(" or ")
+      %(Hans Hant Jpan Hang Kore).include?(@script) and
+        lang += " or not(@language)"
+      lang
+    end
+
+    def cjk_extended_title(docxml)
+      l = cjk_search
+      docxml.xpath(ns("//bibdata/title[#{l}] | //floating-title[#{l}] | " \
+                      "//title[@depth = '1' or not(@depth)][#{l}]")).each do |t|
+        t.text.size < 4 or next
+        t.elements.empty? or next # can't be bothered
+        t.children = @i18n.cjk_extend(t.text)
+      end
+    end
+
+    def preface_rearrange(doc)
+      preface_move(doc.at(ns("//preface/abstract")),
+                   %w(foreword introduction clause acknowledgements), doc)
+      preface_move(doc.at(ns("//preface/foreword")),
+                   %w(introduction clause acknowledgements), doc)
+      preface_move(doc.at(ns("//preface/introduction")),
+                   %w(clause acknowledgements), doc)
+      preface_move(doc.at(ns("//preface/acknowledgements")),
+                   %w(), doc)
+    end
+
+    def preface_move(clause, after, _doc)
+      clause or return
+      preface = clause.parent
+      float = preceding_floats(clause)
+      prev = nil
+      xpath = after.map { |n| "./self::xmlns:#{n}" }.join(" | ")
+      xpath.empty? and xpath = "./self::*[not(following-sibling::*)]"
+      preface_move1(clause, preface, float, prev, xpath)
+    end
+
+    def preface_move1(clause, preface, float, prev, xpath)
+      preface.elements.each do |x|
+        ((x.name == "floating-title" || x.at(xpath)) &&
+        xpath != "./self::*[not(following-sibling::*)]") or prev = x
+        # after.include?(x.name) or next
+        x.at(xpath) or next
+        clause == prev and break
+        prev ||= preface.children.first
+        float << clause
+        float.each { |n| prev.next = n }
+        break
+      end
+    end
+
+    def preceding_floats(clause)
+      ret = []
+      p = clause
+      while prev = p.previous_element
+        if prev.name == "floating-title"
+          ret << prev
+          p = prev
+        else break
+        end
+      end
+      ret
+    end
+
+    def rearrange_clauses(docxml)
+      preface_rearrange(docxml) # feeds toc_title
+      toc_title(docxml)
+    end
+
+    def toc_title(docxml)
+      docxml.at(ns("//preface/clause[@type = 'toc']")) and return
+      ins = toc_title_insert_pt(docxml) or return
+      id = UUIDTools::UUID.random_create.to_s
+      ins.previous = <<~CLAUSE
+        <clause type = 'toc' id='_#{id}'><title depth='1'>#{@i18n.table_of_contents}</title></clause>
+      CLAUSE
+    end
+
+    def toc_title_insert_pt(docxml)
+      ins = docxml.at(ns("//preface")) ||
+        docxml.at(ns("//sections | //annex | //bibliography"))
+          &.before("<preface> </preface>")
+          &.previous_element or return nil
+      ins.children.empty? and ins << " "
+      ins.children.first
+    end
 
     def toc(docxml)
+      toc_refs(docxml)
+    end
+
+    def toc_refs(docxml)
       docxml.xpath(ns("//toc//xref[text()]")).each do |x|
         lbl = @xrefs.anchor(x["target"], :label) or next
         x.children.first.previous = "#{lbl}<tab/>"

data/lib/isodoc/presentation_function/xrefs.rb

@@ -76,7 +76,7 @@ module IsoDoc
     # Note % to entry and Note % to entry: cannot conflate as Note % to entry 1 and 2
     # So Notes 1 and 3, but Note 1 to entry and Note 3 to entry
     def combine_conflated_xref_locations(locs)
-      out = if locs.any? { |l| /%/.match?(l[:elem]) }
+      out = if locs.any? { |l| l[:elem]&.include?("%") }
               locs.each { |l| l[:label] = @xrefs.anchor(l[:target], :xref) }
             else
               conflate_xref_locations(locs)
@@ -138,6 +138,7 @@ module IsoDoc
     end
 
     def can_conflate_xref_rendering?(locs)
+      @i18n.get["no_conflate_xref_locations"] == true and return false
       (locs.all? { |l| l[:container].nil? } ||
        locs.all? { |l| l[:container] == locs.first[:container] }) &&
         locs.all? { |l| l[:type] == locs[0][:type] }

data/lib/isodoc/presentation_xml_convert.rb

@@ -39,12 +39,13 @@ module IsoDoc
       references docxml
       # triggers xrefs reparse, so put references before all other sections,
       # which alter titles and thus can alter xrefs
+      rearrange_clauses docxml # feeds toc, display_order, clausetitle, clause
       annex docxml
-      clause docxml
+      clause docxml # feeds clausetitle
       term docxml
       index docxml
-      clausetitle docxml
-      floattitle docxml
+      clausetitle docxml # feeds floattitle
+      floattitle docxml # feeds rearrange_clauses
       toc docxml
       display_order docxml
     end

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "2.5.3".freeze
+  VERSION = "2.5.4".freeze
 end

data/lib/isodoc/word_function/body.rb

@@ -28,12 +28,7 @@ module IsoDoc
       def make_body2(body, docxml)
         body.div class: "WordSection2" do |div2|
           boilerplate docxml, div2
-          preface_block docxml, div2
-          abstract docxml, div2
-          foreword docxml, div2
-          introduction docxml, div2
-          preface docxml, div2
-          acknowledgements docxml, div2
+          front docxml, div2
           div2.p { |p| p << "&#xa0;" } # placeholder
         end
         section_break(body)
@@ -243,6 +238,18 @@ module IsoDoc
           .at(ns("//metanorma-extension/toc[@type = 'recommendation']/title"))&.text
         super
       end
+
+      def table_of_contents(clause, out)
+        page_break(out)
+        out.div **attr_code(preface_attrs(clause)) do |div|
+          div.p class: "zzContents" do |p|
+            clause.at(ns("./title"))&.children&.each { |c| parse(c, p) }
+          end
+          clause.elements.each do |e|
+            parse(e, div) unless e.name == "title"
+          end
+        end
+      end
     end
   end
 end

data/lib/isodoc/word_function/postprocess_toc.rb

@@ -2,12 +2,28 @@ module IsoDoc
   module WordFunction
     module Postprocess
       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
+          intro.sub(/WORDTOC/, toc)
+        else
+          source = docxml.at("//div[@class = 'TOC']") and
+            source.children = toc
+          intro
+        end
+      end
+
+      def assemble_toc(docxml, level)
         toc = ""
         toc += make_WordToC(docxml, level)
         toc += make_table_word_toc(docxml)
         toc += make_figure_word_toc(docxml)
         toc += make_recommendation_word_toc(docxml)
-        intro.sub(/WORDTOC/, toc)
+        toc
       end
 
       def word_toc_entry(toclevel, heading)
@@ -43,6 +59,9 @@ module IsoDoc
 
       def make_WordToC(docxml, level)
         toc = ""
+        if source = docxml.at("//div[@class = 'TOC']")
+          toc = to_xml(source.children)
+        end
         # docxml.xpath("//h1 | //h2[not(ancestor::*[@class = 'Section3'])]").
         xpath = (1..level).each.map { |i| "//h#{i}" }.join (" | ")
         docxml.xpath(xpath).each do |h|

data/lib/isodoc-yaml/i18n-ja.yaml

@@ -38,9 +38,10 @@ multiple_or: "%1, or %2"
 chain_and: "%1 and %2"
 chain_or: "%1 or %2"
 chain_from: "%1 from %2"
-chain_to: "%1 to %2"
+chain_to: "%1～%2"
 nested_xref: "%1の%2"
 list_nested_xref: "%1の%2"
+no_conflate_xref_locations: true
 ordinal_keys: []
 SpelloutRules: spellout-ordinal
 note: 注記

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 2.5.4
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html2doc
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.3.4
 - !ruby/object:Gem::Dependency
-  name: liquid
+  name: emf2svg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: emf2svg
+  name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: plurimath
   requirement: !ruby/object:Gem::Requirement
@@ -473,7 +473,7 @@ homepage: https://github.com/metanorma/isodoc
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -488,8 +488,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.4.12
+signing_key:
 specification_version: 4
 summary: Convert documents in IsoDoc into Word and HTML in AsciiDoc.
 test_files: []