isodoc 2.12.0 → 2.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7b57ce9e119a72a5611931503d20a6a6eb525b9f07cbc06b0e8794a80db8da2
-  data.tar.gz: 51a4d399f9ab8b7730a08d15deaa52b0526efbbe27cea41e355fca92ce0768ba
+  metadata.gz: 4eb3b494f63d18c01a41db1113867423729b62912dc89c002bccf7bd5b5e10e9
+  data.tar.gz: 665fa84ece67866381fa3c71c41a04e57f231de95143fee235f157ffbe61daf8
 SHA512:
-  metadata.gz: 280cf748d5411c671d3e9f7d6e4b949611f1567766bddcdea160b5eff1bf49d6b61df5b706092f0775812515fb78ccf4812edfb79a98f47d0bcfef9e6215fe70
-  data.tar.gz: 3af9ba5dec2db7b37542f8dab65bc90cdf19f1298110fc230aac03187814c88bffeed194d3d9de7a2e1892f82767d24cab970f780a3655985dfa7f0482d851d1
+  metadata.gz: f1837352724ea2d81646db5a1f499f19ec1f6c84eace5906cd7ae795e6be9fa156e6de43bfa7ecef4ecc4149e7ec4c30c052e64687b1d5f3d8b2ef1b0dfa292e
+  data.tar.gz: 5996acc46b47b24285d1d696d203a16255a69e67a8c25690213afa41d7fe65b02464e26e4db6516b5b3edf020a5222fc342691f0c13b1861d4a436390ea93655

data/isodoc.gemspec

@@ -34,10 +34,10 @@ Gem::Specification.new do |spec|
   # spec.add_dependency "isodoc-i18n", "~> 1.1.0" # already in relaton-render and mn-requirements
   # spec.add_dependency "relaton-cli"
   # spec.add_dependency "metanorma-utils", "~> 1.5.0" # already in isodoc-i18n
-  spec.add_dependency "mn2pdf"
+  spec.add_dependency "mn2pdf", ">= 2.08"
   spec.add_dependency "mn-requirements", "~> 0.4.0"
 
-  spec.add_dependency "relaton-render", "~> 0.7.1"
+  spec.add_dependency "relaton-render", "~> 0.8.0"
   spec.add_dependency "roman-numerals"
   spec.add_dependency "rouge", "~> 4.0"
   spec.add_dependency "thread_safe"

data/lib/isodoc/convert.rb

@@ -115,31 +115,10 @@ module IsoDoc
       metadata_init(@lang, @script, @locale, @i18n)
       xref_init(@lang, @script, self, @i18n,
                 { locale: @locale, bibrender: @bibrender })
-      docxml = preprocess_xslt(docxml)
       toc_init(docxml)
       [docxml, filename, dir]
     end
 
-    def preprocess_xslt(docxml)
-      sheets = extract_preprocess_xslt(docxml)
-      sheets.each do |x|
-        docxml = Nokogiri::XSLT(x).transform(docxml)
-      end
-      docxml
-    rescue ::Error => e
-      require "debug"
-      binding.b
-    end
-
-    def extract_preprocess_xslt(docxml)
-      docxml.xpath(ns("//metanorma-extension/render/preprocess-xslt"))
-        .each_with_object([]) do |x, m|
-          formats = x["format"]&.split(",") || []
-          !formats.empty? && !formats.include?(@format.to_s) and next
-          m << x.children.to_xml
-        end
-    end
-
     def convert_i18n_init(docxml)
       convert_i18n_init1(docxml)
       i18n_init(@lang, @script, @locale)

data/lib/isodoc/function/blocks.rb

@@ -3,8 +3,6 @@ require_relative "blocks_example_note"
 module IsoDoc
   module Function
     module Blocks
-      @annotation = false
-
       def figure_name_parse(_node, div, name)
         name.nil? and return
         div.p class: "FigureTitle", style: "text-align:center;" do |p|
@@ -12,20 +10,13 @@ module IsoDoc
         end
       end
 
-      def figure_key(out)
-        out.p style: "page-break-after:avoid;" do |p|
-          p.b { |b| b << @i18n.key }
-        end
-      end
-
       def figure_attrs(node)
         attr_code(id: node["id"], class: "figure", style: keep_style(node))
       end
 
       def figure_parse(node, out)
-        return pseudocode_parse(node, out) if node["class"] == "pseudocode" ||
-          node["type"] == "pseudocode"
-
+        node["class"] == "pseudocode" || node["type"] == "pseudocode" and
+          return pseudocode_parse(node, out)
         @in_figure = true
         figure_parse1(node, out)
         @in_figure = false
@@ -34,10 +25,9 @@ module IsoDoc
       def figure_parse1(node, out)
         out.div **figure_attrs(node) do |div|
           node.children.each do |n|
-            figure_key(out) if n.name == "dl"
-            parse(n, div) unless n.name == "name"
+            parse(n, div) unless n.name == "fmt-name"
           end
-          figure_name_parse(node, div, node.at(ns("./name")))
+          figure_name_parse(node, div, node.at(ns("./fmt-name")))
         end
       end
 
@@ -47,17 +37,16 @@ module IsoDoc
 
       def pseudocode_parse(node, out)
         @in_figure = true
-        name = node.at(ns("./name"))
+        name = node.at(ns("./fmt-name"))
         out.div **pseudocode_attrs(node) do |div|
-          node.children.each { |n| parse(n, div) unless n.name == "name" }
+          node.children.each { |n| parse(n, div) unless n.name == "fmt-name" }
           sourcecode_name_parse(node, div, name)
         end
         @in_figure = false
       end
 
       def sourcecode_name_parse(_node, div, name)
-        return if name.nil?
-
+        name.nil? and return
         div.p class: "SourceTitle", style: "text-align:center;" do |p|
           name.children.each { |n| parse(n, p) }
         end
@@ -68,7 +57,7 @@ module IsoDoc
       end
 
       def sourcecode_parse(node, out)
-        name = node.at(ns("./name"))
+        name = node.at(ns("./fmt-name"))
         out.p **sourcecode_attrs(node) do |div|
           sourcecode_parse1(node, div)
         end
@@ -82,7 +71,7 @@ module IsoDoc
           node.at("./ancestor::xmlns:table[@class = 'rouge-line-table']") and
           @sourcecode = "table"
         node.children.each do |n|
-          %w(name dl).include?(n.name) and next
+          %w(fmt-name dl).include?(n.name) and next
           parse(n, div)
         end
         @sourcecode = false
@@ -95,10 +84,8 @@ module IsoDoc
       def annotation_parse(node, out)
         dl = node.at(ns("./dl")) or return
         @sourcecode = false
-        # @annotation = true
         out.div class: "annotation" do |div|
           parse(dl, div)
-          # @annotation = false
         end
       end
 
@@ -106,9 +93,9 @@ module IsoDoc
         out.div **attr_code(class: "formula") do |div|
           div.p do |_p|
             parse(node.at(ns("./stem")), div)
-            if lbl = node&.at(ns("./name"))&.text
+            if lbl = node&.at(ns("./fmt-name"))&.text
               insert_tab(div, 1)
-              div << "(#{lbl})"
+              div << lbl
             end
           end
         end
@@ -122,8 +109,7 @@ module IsoDoc
         out.div **formula_attrs(node) do |div|
           formula_parse1(node, div)
           node.children.each do |n|
-            next if %w(stem name).include? n.name
-
+            %w(stem fmt-name).include? n.name and next
             parse(n, div)
           end
         end
@@ -132,10 +118,8 @@ module IsoDoc
       def para_class(node)
         classtype = nil
         classtype = "MsoCommentText" if in_comment
-        classtype = "Sourcecode" if @annotation
-        if node["type"] == "floating-title"
+        node["type"] == "floating-title" and
           classtype = "h#{node['depth']}"
-        end
         classtype ||= node["class"]
         classtype
       end
@@ -150,22 +134,13 @@ module IsoDoc
 
       def para_parse(node, out)
         out.p **attr_code(para_attrs(node)) do |p|
-          unless @termdomain.empty?
-            p << "&lt;#{@termdomain}&gt; "
-            @termdomain = ""
-          end
           node.children.each { |n| parse(n, p) }
         end
       end
 
-      def quote_attribution(node, out)
-        author = node.at(ns("./author"))
-        source = node.at(ns("./source"))
-        author.nil? && source.nil? and return
-        out.p class: "QuoteAttribution" do |p|
-          p << "&#x2014; #{author.text}" if author
-          p << ", " if author && source
-          eref_parse(source, p) if source
+      def attribution_parse(node, out)
+        out.div class: "QuoteAttribution" do |d|
+          node.children.each { |n| parse(n, d) }
         end
       end
 
@@ -173,17 +148,13 @@ module IsoDoc
         attrs = para_attrs(node)
         attrs[:class] = "Quote"
         out.div **attr_code(attrs) do |p|
-          node.children.each do |n|
-            parse(n, p) unless %w(author source).include? n.name
-          end
-          quote_attribution(node, out)
+          node.children.each { |n| parse(n, p) }
         end
       end
 
       def passthrough_parse(node, out)
-        return if node["format"] &&
-          !(node["format"].split(",").include? @format.to_s)
-
+        node["formats"] &&
+          !(node["formats"].split(" ").include? @format.to_s) and return
         out.passthrough node.text
       end
 

data/lib/isodoc/function/blocks_example_note.rb

@@ -2,8 +2,7 @@ module IsoDoc
   module Function
     module Blocks
       def example_label(_node, div, name)
-        return if name.nil?
-
+        name.nil? and return
         div.p class: "example-title" do |_p|
           name.children.each { |n| parse(n, div) }
         end
@@ -20,9 +19,9 @@ module IsoDoc
       # used if we are boxing examples
       def example_div_parse(node, out)
         out.div **example_div_attr(node) do |div|
-          example_label(node, div, node.at(ns("./name")))
+          example_label(node, div, node.at(ns("./fmt-name")))
           node.children.each do |n|
-            parse(n, div) unless n.name == "name"
+            parse(n, div) unless n.name == "fmt-name"
           end
         end
       end
@@ -40,10 +39,12 @@ module IsoDoc
         out.table **example_table_attr(node) do |t|
           t.tr do |tr|
             tr.td **EXAMPLE_TBL_ATTR do |td|
-              example_label(node, td, node.at(ns("./name")))
+              example_label(node, td, node.at(ns("./fmt-name")))
             end
             tr.td **EXAMPLE_TD_ATTR do |td|
-              node.children.each { |n| parse(n, td) unless n.name == "name" }
+              node.children.each do |n|
+                parse(n, td) unless n.name == "fmt-name"
+              end
             end
           end
         end
@@ -53,32 +54,45 @@ module IsoDoc
         example_div_parse(node, out)
       end
 
-      def note_delim
-        ""
+      def block_body_first_elem(node)
+        node.elements.each do |n|
+          %w(title fmt-title fmt-xref-label fmt-name name)
+            .include?(n.name) and next
+          return n
+        end
+        nil
+      end
+
+      def starts_with_para?(node)
+        block_body_first_elem(node)&.name == "p"
+      end
+
+      def note_p_class
+        nil
       end
 
       def note_p_parse(node, div)
-        name = node.at(ns("./name"))&.remove
-        div.p do |p|
+        name = node.at(ns("./fmt-name"))
+        para = node.at(ns("./p"))
+        div.p **attr_code(class: note_p_class) do |p|
           name and p.span class: "note_label" do |s|
             name.children.each { |n| parse(n, s) }
-            s << note_delim
           end
-          insert_tab(p, 1)
-          node.first_element_child.children.each { |n| parse(n, p) }
+          #insert_tab(p, 1) # TODO to Presentation XML
+          children_parse(para, p)
         end
-        node.element_children[1..-1].each { |n| parse(n, div) }
+        para.xpath("./following-sibling::*").each { |n| parse(n, div) }
       end
 
       def note_parse1(node, div)
-        name = node.at(ns("./name")) and div.p do |p|
-          p.span class: "note_label" do |s|
-            name.remove.children.each { |n| parse(n, s) }
-            s << note_delim
+        name = node.at(ns("./fmt-name")) and
+          div.p **attr_code(class: note_p_class) do |p|
+            p.span class: "note_label" do |s|
+              name.remove.children.each { |n| parse(n, s) }
+            end
+            #insert_tab(p, 1) # TODO to Presentation XML
           end
-          insert_tab(p, 1)
-        end
-        node.children.each { |n| parse(n, div) }
+        children_parse(node, div)
       end
 
       def keep_style(node)
@@ -101,7 +115,7 @@ module IsoDoc
       def note_parse(node, out)
         @note = true
         out.div **note_attrs(node) do |div|
-          if node&.at(ns("./*[local-name() != 'name'][1]"))&.name == "p"
+          if starts_with_para?(node)
             note_p_parse(node, div)
           else
             note_parse1(node, div)
@@ -112,7 +126,7 @@ module IsoDoc
 
       def admonition_name_parse(_node, div, name)
         div.p class: "AdmonitionTitle", style: "text-align:center;" do |p|
-          name.children.each { |n| parse(n, p) }
+          children_parse(name, p)
         end
       end
 
@@ -121,7 +135,7 @@ module IsoDoc
       end
 
       def admonition_name(node, _type)
-        node&.at(ns("./name"))
+        node&.at(ns("./fmt-name"))
       end
 
       def admonition_attrs(node)
@@ -130,12 +144,44 @@ module IsoDoc
       end
 
       def admonition_parse(node, out)
-        type = node["type"]
-        name = admonition_name(node, type)
-        out.div **admonition_attrs(node) do |t|
-          admonition_name_parse(node, t, name) if name
-          node.children.each { |n| parse(n, t) unless n.name == "name" }
+        out.div **admonition_attrs(node) do |div|
+          if starts_with_para?(node)
+            admonition_p_parse(node, div)
+          else
+            admonition_parse1(node, div)
+          end
+        end
+      end
+
+      # code to allow name and first paragraph to be rendered in same block
+      def admonition_p_parse(node, div)
+        admonition_parse1(node, div)
+      end
+
+      # code to allow name and first paragraph to be rendered in same block
+      def admonition_name_in_first_para(node, div)
+        name = node.at(ns("./fmt-name"))
+        para = node.at(ns("./p"))
+        div.p do |p|
+          if name = admonition_name(node, node["type"])&.remove
+            name.children.each { |n| parse(n, p) }
+            admonition_name_para_delim(p) # TODO to Presentation XML
+          end
+          para.children.each { |n| parse(n, p) }
+        end
+        para.xpath("./following-sibling::*").each { |n| parse(n, div) }
+      end
+
+      def admonition_name_para_delim(para)
+        insert_tab(para, 1)
+      end
+
+      def admonition_parse1(node, div)
+        name = admonition_name(node, node["type"])
+        if name
+          admonition_name_parse(node, div, name)
         end
+        node.children.each { |n| parse(n, div) unless n.name == "fmt-name" }
       end
     end
   end

data/lib/isodoc/function/cleanup.rb

@@ -25,6 +25,7 @@ module IsoDoc
         admonition_cleanup(docxml)
       end
 
+      # todo PRESENTATION XML
       def admonition_cleanup(docxml)
         docxml.xpath("//div[@class = 'Admonition'][title]").each do |d|
           title = d.at("./title")
@@ -42,45 +43,7 @@ module IsoDoc
         docxml
       end
 
-      def figure_get_or_make_dl(elem)
-        dl = elem.at(".//dl")
-        if dl.nil?
-          elem.add_child("<p><b>#{@i18n.key}</b></p><dl></dl>")
-          dl = elem.at(".//dl")
-        end
-        dl
-      end
-
-      FIGURE_WITH_FOOTNOTES =
-        "//div[@class = 'figure'][descendant::aside]" \
-        "[not(descendant::div[@class = 'figure'])]".freeze
-
-      def figure_aside_process(elem, aside, key)
-        # get rid of footnote link, it is in diagram
-        elem&.at("./a[@class='TableFootnoteRef']")&.remove
-        fnref = elem.at(".//span[@class='TableFootnoteRef']/..")
-        dt = key.add_child("<dt></dt>").first
-        dd = key.add_child("<dd></dd>").first
-        fnref.parent = dt
-        aside.xpath(".//p").each do |a|
-          a.delete("class")
-          a.parent = dd
-        end
-      end
-
-      # move footnotes into key, and get rid of footnote reference
-      # since it is in diagram
-      def figure_cleanup(docxml)
-        docxml.xpath(FIGURE_WITH_FOOTNOTES).each do |f|
-          next unless f.at(".//aside[not(ancestor::p[@class = 'FigureTitle'])]")
-
-          key = figure_get_or_make_dl(f)
-          f.xpath(".//aside").each do |aside|
-            figure_aside_process(f, aside, key)
-          end
-        end
-        docxml
-      end
+      def figure_cleanup(docxml); end
 
       def inline_header_cleanup(docxml)
         docxml.xpath('//span[@class="zzMoveToFollowing"]').each do |x|
@@ -89,13 +52,13 @@ module IsoDoc
           if n.nil?
             x.name = "p"
           else
-            #n.children.first.previous = x.remove
             n.add_first_child(x.remove)
           end
         end
         docxml
       end
 
+      # todo PRESENTATION XML
       def footnote_cleanup(docxml)
         docxml.xpath('//a[@class = "FootnoteRef"]/sup')
           .each_with_index do |x, i|

data/lib/isodoc/function/inline.rb

@@ -8,7 +8,8 @@ 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 << @c.encode(node["target"].sub(/^mailto:/, ""), :basic, :hexadecimal)
+            l << @c.encode(node["target"].sub(/^mailto:/, ""), :basic,
+                           :hexadecimal)
           else node.children.each { |n| parse(n, l) }
           end
         end
@@ -16,16 +17,24 @@ module IsoDoc
 
       def location_parse(node, out); end
 
+      # Presentation XML classes which we need not pass on to HTML or DOC
+      SPAN_UNWRAP_CLASSES =
+        %w[fmt-caption-label fmt-label-delim fmt-caption-delim fmt-autonum-delim
+           fmt-element-name fmt-conn fmt-comma fmt-enum-comma fmt-obligation
+           fmt-xref-container].freeze
+
       def span_parse(node, out)
-        if node["style"] || node["class"]
+        klass = node["style"] || node["class"]
+        if klass && !SPAN_UNWRAP_CLASSES.include?(klass)
           out.span **attr_code(style: node["style"],
                                class: node["class"]) do |s|
-            node.children.each { |n| parse(n, s) }
+            children_parse(node, s)
           end
-        else node.children.each { |n| parse(n, out) }
+        else children_parse(node, out)
         end
       end
 
+      # todo PRESENTATION XML
       def callout_parse(node, out)
         out << " &lt;#{node.text}&gt;"
       end
@@ -46,9 +55,8 @@ module IsoDoc
       end
 
       def suffix_url(url)
-        return url if url.nil? || %r{^https?://|^#}.match?(url)
-        return url unless File.extname(url).empty?
-
+        url.nil? || %r{^https?://|^#}.match?(url) and return url
+        File.extname(url).empty? or return url
         url.sub(/#{File.extname(url)}$/, ".html")
       end
 
@@ -64,6 +72,7 @@ module IsoDoc
         end
       end
 
+      # todo PRESENTATION XML
       def termrefelem_parse(node, out)
         if node.text.strip.empty?
           out << "Termbase #{node['base']}, term ID #{node['target']}"
@@ -133,8 +142,7 @@ module IsoDoc
       end
 
       def text_parse(node, out)
-        return if node.nil? || node.text.nil?
-
+        node.nil? || node.text.nil? and return
         text = node.to_s
         @sourcecode == "pre" and
           text = text.gsub("\n", "<br/>").gsub("<br/> ", "<br/>&#xa0;")
@@ -179,6 +187,28 @@ module IsoDoc
           node.children.each { |n| parse(n, e) }
         end
       end
+
+      def author_parse(node, out)
+        children_parse(node, out)
+      end
+
+      def semx_parse(node, out)
+        children_parse(node, out)
+      end
+
+      def children_parse(node, out)
+        node.children.each { |n| parse(n, out) }
+      end
+
+      def xref_label_parse(node, out); end
+
+      def name_parse(node, out); end
+
+      def floating_title_parse(node, out); end
+
+      def fmt_name_parse(node, out)
+        children_parse(node, out)
+      end
     end
   end
 end

data/lib/isodoc/function/lists.rb

@@ -2,9 +2,9 @@ module IsoDoc
   module Function
     module Lists
       def list_title_parse(node, out)
-        name = node.at(ns("./name")) or return
+        name = node.at(ns("./fmt-name")) or return
         out.p class: "ListTitle" do |p|
-          name&.children&.each { |n| parse(n, p) }
+          name.children&.each { |n| parse(n, p) }
         end
       end
 
@@ -16,7 +16,7 @@ module IsoDoc
         out.div **attr_code(class: "ul_wrap") do |div|
           list_title_parse(node, div)
           div.ul **attr_code(ul_attrs(node)) do |ul|
-            node.children.each { |n| n.name == "name" or parse(n, ul) }
+            node.children.each { |n| n.name == "fmt-name" or parse(n, ul) }
           end
         end
       end
@@ -57,7 +57,7 @@ module IsoDoc
         out.div **attr_code(class: "ol_wrap") do |div|
           list_title_parse(node, div)
           div.ol **attr_code(ol_attrs(node)) do |ol|
-            node.children.each { |n| n.name == "name" or parse(n, ol) }
+            node.children.each { |n| n.name == "fmt-name" or parse(n, ol) }
           end
         end
       end
@@ -106,7 +106,7 @@ module IsoDoc
       end
 
       def dl_parse_notes(node, out)
-        node.elements.reject { |n| dt_dd?(n) || n.name == "name" }
+        node.elements.reject { |n| dt_dd?(n) || n.name == "fmt-name" }
           .each { |n| parse(n, out) }
       end