isodoc 2.1.1 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aff7d421567c13d1c20aa58af56f75a5ef83d78c5268580cef8236b951e41f4d
-  data.tar.gz: 3f81f0d40caa3e069cc814195e565e824c5fd072a8ca408aa70ce2d7026862eb
+  metadata.gz: 3bf48bda8bc7d17d20a766f93c30bcf9f6e7e597497f8663f2c96ff292ada4f5
+  data.tar.gz: 7efd7f5c3aff9ee37fc631eecd1a564213ab56f92780807d1dff2b17e05c402b
 SHA512:
-  metadata.gz: 722f301c40200078c8753612504b5311bd5f1f87041143c9172b70a9b121066579ffb7fd9ce13ebce46a052360e105590fce318324a25175878685ca65958210
-  data.tar.gz: 1f78ddc58e32b347464eb1f73245fc85b4ddb3cb6ac5d27aa9bdaf6f0cc47dfd1db74e648e26ee8ad2860d28eef7530d503471a8ade31f572d9d495299ee033b
+  metadata.gz: 449d645dc7a4caaf2cd778dedfa4bb995344c3c83b076abbe4ea971b32d6fc9515ee7ae1140d76dfbc5f2c01220513979ea239c095fc2037b84263996a728e4f
+  data.tar.gz: 2031af0175ba1ba995fe3cca887180fa0e0d097dcfd6e2afb51eb7dc60ad8934bfbf4fc17dd9f91f1f2fba8e63e46efd8cee7a2fb2e9693d3f3f804ef432f662

data/isodoc.gemspec

@@ -24,7 +24,10 @@ Gem::Specification.new do |spec|
 
   spec.bindir        = "bin"
   spec.require_paths = ["lib"]
-  spec.files         = `git ls-files`.split("\n")
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|.github)/}) \
+    || f.match(%r{\.[a-zA-Z0-9_-]+\.yml|Rakefile|bin/rspec})
+  end
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 

data/lib/isodoc/base_style/blocks.scss

@@ -23,6 +23,13 @@
   }
 }
 
+@mixin listBlock() {
+  .ListTitle {
+    @include blockTitle();
+    text-align: left;
+  }
+}
+
 @mixin figureBlock() {
   .FigureTitle, .figure-title {
     @include blockTitle();

data/lib/isodoc/class_utils.rb

@@ -62,5 +62,21 @@ module IsoDoc
       end
       xml.root.children.to_xml
     end
+
+    def nearest_block_parent(node)
+      until %w(p title td th name formula li dt dd sourcecode pre quote
+               note example)
+          .include?(node.name)
+        node = node.parent
+      end
+      node
+    end
+
+    # node is at the start of sentence in a Metanorma XML context
+    def start_of_sentence(node)
+      prec = nearest_block_parent(node).xpath("./descendant-or-self::text()") &
+        node.xpath("./preceding::text()")
+      prec.empty? || /(?!<[^.].)\.\s+$/.match(prec.map(&:text).join)
+    end
   end
 end

data/lib/isodoc/function/inline.rb

@@ -14,6 +14,8 @@ module IsoDoc
         end
       end
 
+      def location_parse(node, out); end
+
       def span_parse(node, out)
         node.children.each { |n| parse(n, out) }
       end

data/lib/isodoc/function/lists.rb

@@ -1,13 +1,21 @@
 module IsoDoc
   module Function
     module Lists
+      def list_title_parse(node, out)
+        name = node.at(ns("./name")) or return
+        out.p **{ class: "ListTitle" } do |p|
+          name&.children&.each { |n| parse(n, p) }
+        end
+      end
+
       def ul_attrs(node)
         { id: node["id"], style: keep_style(node) }
       end
 
       def ul_parse(node, out)
+        list_title_parse(node, out)
         out.ul **attr_code(ul_attrs(node)) do |ul|
-          node.children.each { |n| parse(n, ul) }
+          node.children.each { |n| n.name == "name" or parse(n, ul) }
         end
       end
 
@@ -44,8 +52,9 @@ module IsoDoc
       end
 
       def ol_parse(node, out)
+        list_title_parse(node, out)
         out.ol **attr_code(ol_attrs(node)) do |ol|
-          node.children.each { |n| parse(n, ol) }
+          node.children.each { |n| n.name == "name" or parse(n, ol) }
         end
       end
 
@@ -82,17 +91,23 @@ module IsoDoc
       end
 
       def dl_parse(node, out)
+        list_title_parse(node, out)
         out.dl **dl_attrs(node) do |v|
           node.elements.select { |n| dt_dd? n }.each_slice(2) do |dt, dd|
-            v.dt **attr_code(id: dt["id"]) do |term|
-              dt_parse(dt, term)
-            end
-            v.dd **attr_code(id: dd["id"]) do |listitem|
-              dd.children.each { |n| parse(n, listitem) }
-            end
+            dl_parse1(v, dt, dd)
           end
         end
-        node.elements.reject { |n| dt_dd? n }.each { |n| parse(n, out) }
+        node.elements.reject { |n| dt_dd?(n) || n.name == "name" }
+          .each { |n| parse(n, out) }
+      end
+
+      def dl_parse1(dlist, dterm, ddef)
+        dlist.dt **attr_code(id: dterm["id"]) do |term|
+          dt_parse(dterm, term)
+        end
+        dlist.dd **attr_code(id: ddef["id"]) do |listitem|
+          ddef.children.each { |n| parse(n, listitem) }
+        end
       end
     end
   end

data/lib/isodoc/function/to_word_html.rb

@@ -231,6 +231,7 @@ module IsoDoc
           when "toc" then toc_parse(node, out)
           when "variant-title" then variant_title(node, out)
           when "span" then span_parse(node, out)
+          when "location" then location_parse(node, out)
           else error_parse(node, out)
           end
         end

data/lib/isodoc/function/utils.rb

@@ -11,6 +11,10 @@ module IsoDoc
         self.class.ns(xpath)
       end
 
+      def start_of_sentence(node)
+        self.class.start_of_sentence(node)
+      end
+
       def insert_tab(out, count)
         tab = %w(Hans Hant).include?(@script) ? "　" : "  "
         [1..count].each { out << tab }
@@ -58,24 +62,30 @@ module IsoDoc
         end
       end
 
-      def to_xhtml_prep(xml)
-        xml.gsub!(/<\?xml[^>]*>/, "")
-        /<!DOCTYPE /.match(xml) || (xml = DOCTYPE_HDR + xml)
+      def numeric_escapes(xml)
+        c = HTMLEntities.new
         xml.split(/(&[^ \r\n\t#;]+;)/).map do |t|
           if /^(&[^ \t\r\n#;]+;)/.match?(t)
-            HTMLEntities.new.encode(HTMLEntities.new.decode(t), :hexadecimal)
+            c.encode(c.decode(t), :hexadecimal)
           else t
           end
         end.join
       end
 
+      def to_xhtml_prep(xml)
+        xml.gsub!(/<\?xml[^>]*>/, "")
+        /<!DOCTYPE /.match(xml) || (xml = DOCTYPE_HDR + xml)
+        numeric_escapes(xml)
+      end
+
       def to_xhtml_fragment(xml)
         doc = ::Nokogiri::XML.parse(NOKOHEAD)
         doc.fragment(xml)
       end
 
       def from_xhtml(xml)
-        xml.to_xml.sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, "")
+        numeric_escapes(xml.to_xml
+          .sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, ""))
       end
 
       CLAUSE_ANCESTOR =
@@ -100,8 +110,12 @@ module IsoDoc
         "local-name() = 'figure' or local-name() = 'formula' or "\
         "local-name() = 'table' or local-name() = 'example']/@id"
 
-      def get_note_container_id(node)
-        container = node.xpath(NOTE_CONTAINER_ANCESTOR)
+      # no recursion on references
+      def get_note_container_id(node, type)
+        xpath = NOTE_CONTAINER_ANCESTOR.dup
+        %w(figure table example).include?(type) and
+          xpath.sub!(%r[ or local-name\(\) = '#{type}'], "")
+        container = node.xpath(xpath)
         container&.last&.text || nil
       end
 

data/lib/isodoc/gem_tasks.rb

@@ -8,14 +8,20 @@ module IsoDoc
   module GemTasks
     extend Rake::DSL if defined? Rake::DSL
 
+    @@css_list = []
+
     module_function
 
+    def self.css_list
+      @@css_list
+    end
+
     def install
       rule ".css" => [proc { |tn| tn.sub(/\.css$/, ".scss") }] do |current_task|
         puts(current_task)
         compile_scss_task(current_task)
       rescue StandardError => e
-        notify_borken_compilation(e, current_task)
+        notify_broken_compilation(e, current_task)
       end
 
       scss_files = Rake::FileList["lib/**/*.scss"]
@@ -40,25 +46,27 @@ module IsoDoc
       end
     end
 
-    def notify_borken_compilation(error, current_task)
+    def interactive?
+      ENV["CI"] == nil
+    end
+
+    def notify_broken_compilation(error, current_task)
       puts("Cannot compile #{current_task} because of #{error.message}")
+      return unless interactive?
+
       puts("continue anyway[y|n]?")
-      answer = STDIN.gets.strip
-      if %w[y yes].include?(answer.strip.downcase)
-        puts("Cannot compile #{current_task} because of #{error.message}")
-      else
-        exit(0)
-      end
+      answer = $stdin.gets.strip
+      exit(0) unless %w[y yes].include?(answer.strip.downcase)
     end
 
     def git_cache_compiled_files
-      CLEAN.each do |css_file|
+      @@css_list.each do |css_file|
         sh "git add #{css_file}"
       end
     end
 
     def git_rm_compiled_files
-      CLEAN.each do |css_file|
+      @@css_list.each do |css_file|
         sh "git rm --cached #{css_file}"
       end
     end
@@ -129,6 +137,7 @@ module IsoDoc
       File.open(compiled_path, "w:UTF-8") do |f|
         f.write(content)
       end
+      @@css_list << compiled_path
       CLEAN << compiled_path
     end
   end

data/lib/isodoc/i18n.rb

@@ -23,3 +23,22 @@ module IsoDoc
     end
   end
 end
+
+class ::Hash
+  def deep_merge(second)
+    merger = proc { |_, v1, v2|
+      if Hash === v1 && Hash === v2
+        v1.merge(v2, &merger)
+      elsif Array === v1 && Array === v2
+        v1 | v2
+      elsif [:undefined, nil,
+             :nil].include?(v2)
+        v1
+      else
+        v2
+      end
+    }
+    merge(second.to_h, &merger)
+  end
+end
+

data/lib/isodoc/metadata.rb

@@ -11,8 +11,8 @@ module IsoDoc
       Common::ns(xpath)
     end
 
-    def l10n(a, b, c)
-      @i18n.l10n(a, b, c)
+    def l10n(expr, lang, script)
+      @i18n.l10n(expr, lang, script)
     end
 
     def initialize(lang, script, i18n, fonts_options = {})

data/lib/isodoc/presentation_function/block.rb

@@ -8,6 +8,10 @@ module IsoDoc
       text.capitalize
     end
 
+    def block_delim
+      " — "
+    end
+
     def prefix_name(node, delim, number, elem)
       return if number.nil? || number.empty?
 
@@ -31,7 +35,7 @@ module IsoDoc
       return if labelled_ancestor(elem)
 
       lbl = @xrefs.anchor(elem["id"], :label, false) or return
-      prefix_name(elem, " — ",
+      prefix_name(elem, block_delim,
                   l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
     end
 
@@ -60,7 +64,7 @@ module IsoDoc
             else
               l10n("#{@i18n.example} #{n[:label]}")
             end
-      prefix_name(elem, " — ", lbl, "name")
+      prefix_name(elem, block_delim, lbl, "name")
     end
 
     def note(docxml)
@@ -130,7 +134,7 @@ module IsoDoc
       return if elem["unnumbered"] && !elem.at(ns("./name"))
 
       n = @xrefs.anchor(elem["id"], :label, false)
-      prefix_name(elem, " — ", l10n("#{lower2cap @i18n.table} #{n}"),
+      prefix_name(elem, block_delim, l10n("#{lower2cap @i18n.table} #{n}"),
                   "name")
     end
 

data/lib/isodoc/presentation_function/image.rb

@@ -32,7 +32,7 @@ module IsoDoc
       return if elem.at(ns("./figure")) && !elem.at(ns("./name"))
 
       lbl = @xrefs.anchor(elem["id"], :label, false) or return
-      prefix_name(elem, " — ",
+      prefix_name(elem, block_delim,
                   l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
     end
 

data/lib/isodoc/presentation_function/inline.rb

@@ -3,14 +3,6 @@ require_relative "xrefs"
 
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
-    def nearest_block_parent(node)
-      until %w(p title td th name formula li dt dd sourcecode pre)
-          .include?(node.name)
-        node = node.parent
-      end
-      node
-    end
-
     def non_locality_elems(node)
       node.children.reject do |c|
         %w{locality localityStack location}.include? c.name
@@ -179,12 +171,13 @@ module IsoDoc
     def eref_locality_populate(type, node)
       return "" if node["droploc"] == "true"
 
-      loc = @i18n.locality[type] || type.sub(/^locality:/, "")
-      loc = case node["case"]
+      loc = type.sub(/^locality:/, "")
+      ret = @i18n.locality[loc] || loc
+      ret = case node["case"]
             when "lowercase" then loc.downcase
-            else Metanorma::Utils.strict_capitalize_first(loc)
+            else Metanorma::Utils.strict_capitalize_first(ret)
             end
-      " #{loc}"
+      " #{ret}"
     end
 
     def xref(docxml)
@@ -226,6 +219,12 @@ module IsoDoc
       end
     end
 
+    def identifier(docxml)
+      docxml.xpath(ns("//identifier")).each do |n|
+        n.name = "tt"
+      end
+    end
+
     private
 
     def found_matching_variant_sibling(node)

data/lib/isodoc/presentation_function/section.rb

@@ -177,7 +177,7 @@ module IsoDoc
 
     def toc(docxml)
       docxml.xpath(ns("//toc//xref[text()]")).each do |x|
-        lbl = @xrefs.get[x["target"]][:label] or next
+        lbl = @xrefs.anchor(x["target"], :label) or next
         x.children.first.previous = "#{lbl}<tab/>"
       end
     end

data/lib/isodoc/presentation_function/xrefs.rb

@@ -26,24 +26,39 @@ module IsoDoc
     def anchor_linkend1(node)
       linkend = @xrefs.anchor(node["target"], :xref)
       container = @xrefs.anchor(node["target"], :container, false)
-      (container && get_note_container_id(node) != container &&
-       @xrefs.get[node["target"]]) and
+      prefix_container?(container, node) and
         linkend = prefix_container(container, linkend, node["target"])
       capitalise_xref(node, linkend, anchor_value(node["target"]))
     end
 
+    def prefix_container?(container, node)
+      type = @xrefs.anchor(node["target"], :type)
+      container &&
+        get_note_container_id(node, type) != container &&
+        @xrefs.get[node["target"]]
+    end
+
     def combine_xref_locations(node)
       locs = gather_xref_locations(node)
       linkend = if can_conflate_xref_rendering?(locs)
-                  out = locs.each { |l| l[:target] = anchor_value(l[:target]) }
-                  l10n("#{locs.first[:elem]} #{combine_conn(out)}")
+                  combine_conflated_xref_locations(locs)
                 else
-                  out = locs.each { |l| l[:target] = anchor_linked1(l[:node]) }
+                  out = locs.each { |l| l[:target] = anchor_linkend1(l[:node]) }
                   l10n(combine_conn(out))
                 end
       capitalise_xref(node, linkend, anchor_value(node["target"]))
     end
 
+    def combine_conflated_xref_locations(locs)
+      out = locs.each { |l| l[:target] = anchor_value(l[:target]) }
+      ret = l10n("#{locs.first[:elem]} #{combine_conn(out)}")
+      container = @xrefs.anchor(locs.first[:node]["target"], :container,
+                                false)
+      prefix_container?(container, locs.first[:node]) and
+        ret = prefix_container(container, ret, locs.first[:node]["target"])
+      ret
+    end
+
     def gather_xref_locations(node)
       node.xpath(ns("./location")).each_with_object([]) do |l, m|
         type = @xrefs.anchor(l["target"], :type)
@@ -74,7 +89,8 @@ module IsoDoc
     end
 
     def can_conflate_xref_rendering?(locs)
-      !locs.all? { |l| l[:container].nil? } &&
+      (locs.all? { |l| l[:container].nil? } ||
+       locs.all? { |l| l[:container] == locs.first[:container] }) &&
         locs.all? { |l| l[:type] == locs[0][:type] }
     end
 
@@ -89,9 +105,7 @@ module IsoDoc
     end
 
     def capitalise_xref1(node, linkend)
-      prec = nearest_block_parent(node).xpath("./descendant-or-self::text()") &
-        node.xpath("./preceding::text()")
-      if prec.empty? || /(?!<[^.].)\.\s+$/.match(prec.map(&:text).join)
+      if start_of_sentence(node)
         Common::case_with_markup(linkend, "capital", @script)
       else linkend
       end

data/lib/isodoc/presentation_xml_convert.rb

@@ -68,6 +68,7 @@ module IsoDoc
       quotesource docxml
       mathml docxml
       variant docxml
+      identifier docxml
     end
 
     def terms(docxml)

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "2.1.1".freeze
+  VERSION = "2.1.3".freeze
 end

data/lib/isodoc/word_function/body.rb

@@ -92,8 +92,10 @@ module IsoDoc
       end
 
       def dl_parse_table(node, out)
+        list_title_parse(node, out)
         out.table **{ class: "dl" } do |v|
-          node.elements.select { |n| dt_dd? n }.each_slice(2) do |dt, dd|
+          node.elements.select { |n| dt_dd?(n) }
+            .each_slice(2) do |dt, dd|
             dl_parse_table1(v, dt, dd)
           end
           dl_parse_notes(node, v)
@@ -112,11 +114,12 @@ module IsoDoc
       end
 
       def dl_parse_notes(node, out)
-        return if node.elements.reject { |n| dt_dd? n }.empty?
+        remainder = node.elements.reject { |n| dt_dd?(n) || n.name == "name" }
+        return if remainder.empty?
 
         out.tr do |tr|
           tr.td **{ colspan: 2 } do |td|
-            node.elements.reject { |n| dt_dd? n }.each { |n| parse(n, td) }
+            remainder.each { |n| parse(n, td) }
           end
         end
       end

data/lib/isodoc/word_function/inline.rb

@@ -1,9 +1,14 @@
 module IsoDoc
   module WordFunction
     module Body
-      def section_break(body)
+      def section_break(body, continuous: false)
         body.p do |p|
-          p.br **{ clear: "all", class: "section" }
+          if continuous
+            p.br **{ clear: "all", style: "page-break-before:auto;"\
+                                          "mso-break-type:section-break" }
+          else
+            p.br **{ clear: "all", class: "section" }
+          end
         end
       end
 

data/lib/isodoc/xref/xref_gen.rb

@@ -43,7 +43,7 @@ module IsoDoc
       end
 
       def termnote_anchor_names(docxml)
-        docxml.xpath(ns("//term[termnote]")).each do |t|
+        docxml.xpath(ns("//*[termnote]")).each do |t|
           c = Counter.new
           t.xpath(ns("./termnote")).reject { |n| blank?(n["id"]) }.each do |n|
             c.increment(n)
@@ -57,7 +57,7 @@ module IsoDoc
       end
 
       def termexample_anchor_names(docxml)
-        docxml.xpath(ns("//term[termexample]")).each do |t|
+        docxml.xpath(ns("//*[termexample]")).each do |t|
           examples = t.xpath(ns("./termexample"))
           c = Counter.new
           examples.reject { |n| blank?(n["id"]) }.each do |n|
@@ -148,12 +148,12 @@ module IsoDoc
         c = Counter.new(list["start"] ? list["start"].to_i - 1 : 0)
         list.xpath(ns("./li")).each do |li|
           label = c.increment(li).listlabel(list, depth)
-          label = "#{prev_label}.#{label}" unless prev_label.empty?
+          label = "#{prev_label}) #{label}" unless prev_label.empty?
           label = "#{list_anchor[:xref]} #{label}" if refer_list
           li["id"] and @anchors[li["id"]] =
-                         { xref: "#{label})", type: "listitem",
-                           container: list_anchor[:container] }
-          li.xpath(ns("./ol")).each do |ol|
+                         { 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)
           end
         end

data/lib/isodoc/xref.rb

@@ -52,7 +52,7 @@ module IsoDoc
 
     # extract names for all anchors, xref and label
     def parse(docxml)
-      amend_preprocess(docxml) if  @parse_settings.empty?
+      amend_preprocess(docxml) if @parse_settings.empty?
       initial_anchor_names(docxml)
       back_anchor_names(docxml)
       # preempt clause notes with all other types of note (ISO default)

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

@@ -132,6 +132,7 @@ relatedterms:
   contrast: مضاد
   # تباين
   see: انظر
+  seealso: انظر أيضا
 inflection:
   فقرة:
     sg: فقرة

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

@@ -138,6 +138,7 @@ relatedterms:
   compare: vergleiche
   contrast: dagegen
   see: siehe
+  seealso: siehe auch
 inflection:
   Klausel:
     sg: Klausel

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

@@ -138,6 +138,7 @@ relatedterms:
   compare: compare
   contrast: contrast
   see: see
+  seealso: see also
 inflection:
   Clause:
     sg: Clause

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

@@ -138,6 +138,7 @@ relatedterms:
   compare: relacionado
   contrast: difiere
   see: véase
+  seealso: véase tambien
 inflection:
   Cláusula:
     sg: Cláusula

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

@@ -136,6 +136,7 @@ relatedterms:
   compare: comparez
   contrast: contrastez
   see: voir
+  seealso: voir aussi
 inflection:
   Clause:
     sg: Article

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

@@ -143,6 +143,7 @@ relatedterms:
   compare: наравне
   contrast: противоположный
   see: см.
+  seealso: см. также
 inflection:
   Пункт:
     sg: Пункт

data/lib/isodoc-yaml/i18n-zh-Hans.yaml

@@ -132,4 +132,5 @@ relatedterms:
   compare: 比较
   contrast: 对比
   see: 见
+  seealso: 参见