isodoc 2.4.5 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cbb9d45ce42c28917d84ebd31912cd4218cd47f633d27cf58f1060396c14d67
-  data.tar.gz: 25872abe5383206f171fadb766688bd46e751cb83852fa0c09848cdb8a4a45a6
+  metadata.gz: 15d6f1ca680a6bb801c444655ba27e347ca04a671c207b9a74ad4c6388596394
+  data.tar.gz: 02e6caa0ae2463bd2966ee14a9837c0d1b1b4cfac77596380bbb3856979ee142
 SHA512:
-  metadata.gz: 8734f21809f2c71d90bbb291c2da8e703cf25e06bebeb83cf3db464d2b97179dd2744be793e11b2657435309c2faf8a08d4d8d48a16c2fad34bdc8fe628a3b1d
-  data.tar.gz: ebbcfc1ca95fe1b7d3c8ec89a73823176ae72ad0cd3b43cdc9061a9eafc6dce8612832c0a6dc1fc3f3be4948367567e74fc8c78eb90d5e234a8bd6fbd9cd467a
+  metadata.gz: 857b7630d0a1146e5070b3ced33eb99b40089cf114181b6519cd1e26a5c17fc8b1e36dfe59ea115055fb2f8cbf901c57b7ad730fe39878e0cf589201eb06222a
+  data.tar.gz: 4ca7278d7571fc4aa64fa6443a373d77d352ffe64b79086ef142aad1260a25e57589023707a153bb54cae60bd4e441d2ed116a33f18db2905907b61b5c14875f

data/lib/isodoc/base_style/all.css

@@ -117,6 +117,10 @@ a.FootnoteRef + a.FootnoteRef:before {
   content: ", ";
   vertical-align: super; }
 
+a.TableFootnoteRef + a.TableFootnoteRef:before {
+  content: ", ";
+  vertical-align: super; }
+
 .addition {
   color: blue; }
 

data/lib/isodoc/base_style/reset.css

@@ -117,6 +117,10 @@ a.FootnoteRef + a.FootnoteRef:before {
   content: ", ";
   vertical-align: super; }
 
+a.TableFootnoteRef + a.TableFootnoteRef:before {
+  content: ", ";
+  vertical-align: super; }
+
 .addition {
   color: blue; }
 

data/lib/isodoc/base_style/reset.scss

@@ -144,6 +144,12 @@ a.FootnoteRef + a.FootnoteRef:before {
     vertical-align: super;
   }
 
+a.TableFootnoteRef + a.TableFootnoteRef:before { 
+    content: ", ";
+    vertical-align: super; 
+  }
+
+
 .addition {
   color: blue;
 }

data/lib/isodoc/function/blocks.rb

@@ -10,8 +10,7 @@ module IsoDoc
       end
 
       def figure_name_parse(_node, div, name)
-        return if name.nil?
-
+        name.nil? and return
         div.p class: "FigureTitle", style: "text-align:center;" do |p|
           name.children.each { |n| parse(n, p) }
         end
@@ -110,16 +109,6 @@ module IsoDoc
         end
       end
 
-      def formula_where(dlist, out)
-        return unless dlist
-
-        out.p style: "page-break-after:avoid;" do |p|
-          p << @i18n.where
-        end
-        parse(dlist, out)
-        out.parent.at("./dl")["class"] = "formula_dl"
-      end
-
       def formula_parse1(node, out)
         out.div **attr_code(class: "formula") do |div|
           div.p do |_p|
@@ -139,9 +128,8 @@ module IsoDoc
       def formula_parse(node, out)
         out.div **formula_attrs(node) do |div|
           formula_parse1(node, div)
-          formula_where(node.at(ns("./dl")), div)
           node.children.each do |n|
-            next if %w(stem dl name).include? n.name
+            next if %w(stem name).include? n.name
 
             parse(n, div)
           end

data/lib/isodoc/function/cleanup.rb

@@ -88,7 +88,7 @@ module IsoDoc
       end
 
       FIGURE_WITH_FOOTNOTES =
-        "//div[@class = 'figure'][descendant::aside]"\
+        "//div[@class = 'figure'][descendant::aside]" \
         "[not(descendant::div[@class = 'figure'])]".freeze
 
       def figure_aside_process(elem, aside, key)
@@ -159,7 +159,7 @@ module IsoDoc
       end
 
       def table_footnote_cleanup_propagate(docxml)
-        docxml.xpath("//p[not(self::*[@class])]"\
+        docxml.xpath("//p[not(self::*[@class])]" \
                      "[ancestor::*[@class = 'TableFootnote']]").each do |p|
           p["class"] = "TableFootnote"
         end
@@ -194,7 +194,7 @@ module IsoDoc
       end
 
       def table_note_cleanup(docxml)
-        docxml.xpath("//table[div[@class = 'Note' or "\
+        docxml.xpath("//table[div[@class = 'Note' or " \
                      "@class = 'TableFootnote']]").each do |t|
           tfoot = table_get_or_make_tfoot(t)
           insert_here = new_fullcolspan_row(t, tfoot)

data/lib/isodoc/function/lists.rb

@@ -87,7 +87,7 @@ module IsoDoc
       end
 
       def dl_attrs(node)
-        attr_code(id: node["id"], style: keep_style(node))
+        attr_code(id: node["id"], style: keep_style(node), class: node["class"])
       end
 
       def dl_parse(node, out)

data/lib/isodoc/function/references.rb

@@ -153,7 +153,7 @@ module IsoDoc
           return num
         out.div do |div|
           num += 1
-          clause_name(num, f.at(ns("./title")), div, nil)
+          clause_name(f, f.at(ns("./title")), div, nil)
           if f.name == "clause"
             f.elements.each { |e| parse(e, div) unless e.name == "title" }
           else biblio_list(f, div, false)

data/lib/isodoc/function/section.rb

@@ -20,7 +20,7 @@ module IsoDoc
       def clause(isoxml, out)
         isoxml.xpath(ns(middle_clause(isoxml))).each do |c|
           out.div **attr_code(clause_attrs(c)) do |s|
-            clause_name(nil, c&.at(ns("./title")), s, nil)
+            clause_name(c, c&.at(ns("./title")), s, nil)
             c.elements.reject { |c1| c1.name == "title" }.each do |c1|
               parse(c1, s)
             end
@@ -50,7 +50,7 @@ module IsoDoc
         f = isoxml.at(ns("//clause[@type = 'scope']")) or return num
         out.div **attr_code(id: f["id"]) do |div|
           num = num + 1
-          clause_name(num, f&.at(ns("./title")), div, nil)
+          clause_name(f, f&.at(ns("./title")), div, nil)
           f.elements.each do |e|
             parse(e, div) unless e.name == "title"
           end
@@ -65,7 +65,7 @@ module IsoDoc
         f = isoxml.at(ns(TERM_CLAUSE)) or return num
         out.div **attr_code(id: f["id"]) do |div|
           num = num + 1
-          clause_name(num, f&.at(ns("./title")), div, nil)
+          clause_name(f, f&.at(ns("./title")), div, nil)
           f.elements.each do |e|
             parse(e, div) unless %w{title source}.include? e.name
           end
@@ -82,7 +82,7 @@ module IsoDoc
         f = isoxml.at(ns("//sections/definitions")) or return num
         out.div **attr_code(id: f["id"], class: "Symbols") do |div|
           num = num + 1
-          clause_name(num, f.at(ns("./title")), div, nil)
+          clause_name(f, f.at(ns("./title")), div, nil)
           f.elements.each do |e|
             parse(e, div) unless e.name == "title"
           end
@@ -101,7 +101,7 @@ module IsoDoc
         f = isoxml.at(ns("//introduction")) || return
         page_break(out)
         out.div class: "Section3", id: f["id"] do |div|
-          clause_name(nil, f.at(ns("./title")), div, { class: "IntroTitle" })
+          clause_name(f, f.at(ns("./title")), div, { class: "IntroTitle" })
           f.elements.each do |e|
             parse(e, div) unless e.name == "title"
           end
@@ -112,7 +112,7 @@ module IsoDoc
         f = isoxml.at(ns("//foreword")) || return
         page_break(out)
         out.div **attr_code(id: f["id"]) do |s|
-          clause_name(nil, f.at(ns("./title")) || @i18n.foreword, s,
+          clause_name(f, f.at(ns("./title")) || @i18n.foreword, s,
                       { class: "ForewordTitle" })
           f.elements.each { |e| parse(e, s) unless e.name == "title" }
         end
@@ -123,7 +123,7 @@ module IsoDoc
         title_attr = { class: "IntroTitle" }
         page_break(out)
         out.div class: "Section3", id: f["id"] do |div|
-          clause_name(nil, f&.at(ns("./title")), div, title_attr)
+          clause_name(f, f&.at(ns("./title")), div, title_attr)
           f.elements.each do |e|
             parse(e, div) unless e.name == "title"
           end
@@ -134,7 +134,7 @@ module IsoDoc
         f = isoxml.at(ns("//preface/abstract")) || return
         page_break(out)
         out.div **attr_code(id: f["id"]) do |s|
-          clause_name(nil, f.at(ns("./title")), s, { class: "AbstractTitle" })
+          clause_name(f, f.at(ns("./title")), s, { class: "AbstractTitle" })
           f.elements.each { |e| parse(e, s) unless e.name == "title" }
         end
       end
@@ -144,7 +144,7 @@ module IsoDoc
                         "//preface/definitions | //preface/terms")).each do |f|
           page_break(out)
           out.div class: "Section3", id: f["id"] do |div|
-            clause_name(nil, f&.at(ns("./title")), div, { class: "IntroTitle" })
+            clause_name(f, f&.at(ns("./title")), div, { class: "IntroTitle" })
             f.elements.each do |e|
               parse(e, div) unless e.name == "title"
             end
@@ -157,7 +157,7 @@ module IsoDoc
         page_break(out)
         isoxml.xpath(ns("//colophon/clause")).each do |f|
           out.div class: "Section3", id: f["id"] do |div|
-            clause_name(nil, f&.at(ns("./title")), div, { class: "IntroTitle" })
+            clause_name(f, f&.at(ns("./title")), div, { class: "IntroTitle" })
             f.elements.each do |e|
               parse(e, div) unless e.name == "title"
             end

data/lib/isodoc/function/section_titles.rb

@@ -10,7 +10,7 @@ module IsoDoc
       end
 
       def inline_header_title(out, node, title)
-        out.span **{ class: "zzMoveToFollowing" } do |s|
+        out.span class: "zzMoveToFollowing" do |s|
           s.b do |b|
             title&.children&.each { |c2| parse(c2, b) }
             clausedelimspace(node, out) if /\S/.match?(title&.text)
@@ -38,15 +38,15 @@ module IsoDoc
       end
 
       def clause_title_depth(node, title)
-        depth = node.ancestors("clause, annex, terms, references, "\
-                               "definitions, acknowledgements, introduction, "\
+        depth = node.ancestors("clause, annex, terms, references, " \
+                               "definitions, acknowledgements, introduction, " \
                                "foreword").size + 1
         depth = title["depth"] if title && title["depth"]
         depth
       end
 
       def clause_parse_subtitle(title, heading)
-        if var = title&.at("./following-sibling::xmlns:variant-title"\
+        if var = title&.at("./following-sibling::xmlns:variant-title" \
                            "[@type = 'sub']")&.remove
           heading.br nil
           heading.br nil
@@ -55,8 +55,8 @@ module IsoDoc
       end
 
       # top level clause names
-      def clause_name(_num, title, div, header_class)
-        preceding_floating_titles(title, div)
+      def clause_name(node, title, div, header_class)
+        preceding_floating_titles(node, div)
         header_class = {} if header_class.nil?
         div.h1 **attr_code(header_class) do |h1|
           if title.is_a?(String) then h1 << title
@@ -72,7 +72,7 @@ module IsoDoc
         preceding_floating_titles(name, div)
         return if name.nil?
 
-        div.h1 **{ class: "Annex" } do |t|
+        div.h1 class: "Annex" do |t|
           name.children.each { |c2| parse(c2, t) }
           clause_parse_subtitle(name, t)
         end
@@ -85,10 +85,10 @@ module IsoDoc
         end
       end
 
-      def preceding_floating_titles(name, div)
-        return if name.nil? || name.is_a?(String)
+      def preceding_floating_titles(node, div)
+        return if node.nil?
 
-        out = name.parent.xpath("./preceding-sibling::*")
+        out = node.xpath("./preceding-sibling::*")
           .reverse.each_with_object([]) do |p, m|
           break m unless p.name == "p"
 

data/lib/isodoc/function/to_word_html.rb

@@ -112,16 +112,17 @@ module IsoDoc
         @meta.url isoxml, out
         @meta.keywords isoxml, out
         @meta.note isoxml, out
+        @meta.presentation isoxml, out
         @meta.get
       end
 
       def middle(isoxml, out)
         middle_title(isoxml, out)
         middle_admonitions(isoxml, out)
-        i = scope isoxml, out, 0
-        i = norm_ref isoxml, out, i
-        i = terms_defs isoxml, out, i
-        symbols_abbrevs isoxml, out, i
+        scope isoxml, out, 0
+        norm_ref isoxml, out, 0
+        terms_defs isoxml, out, 0
+        symbols_abbrevs isoxml, out, 0
         clause isoxml, out
         annex isoxml, out
         bibliography isoxml, out

data/lib/isodoc/html_function/postprocess_cover.rb

@@ -100,12 +100,14 @@ module IsoDoc
       #{header_strip(content)}</a></li>)
       end
 
+      # array of arrays, one per level, containing XPath fragments for the elems
+      # matching that ToC level
       def toclevel_classes
-        (1..@htmlToClevels).reduce([]) { |m, i| m << "h#{i}" }
+        (1..@htmlToClevels).reduce([]) { |m, i| m << ["h#{i}"] }
       end
 
       def toclevel
-        ret = toclevel_classes.map do |l|
+        ret = toclevel_classes.flatten.map do |l|
           "#{l}:not(:empty):not(.TermNum):not(.noTOC)"
         end
         <<~HEAD.freeze
@@ -116,18 +118,25 @@ module IsoDoc
       # needs to be same output as toclevel
       def html_toc(docxml)
         idx = docxml.at("//div[@id = 'toc']") or return docxml
-        toc = "<ul>"
-        path = toclevel_classes.map do |l|
-          "//main//#{l}#{toc_exclude_class}"
+        path = toclevel_classes.map do |x|
+          x.map { |l| "//main//#{l}#{toc_exclude_class}" }
         end
-        docxml.xpath(path.join(" | ")).each_with_index do |h, tocidx|
-          h["id"] ||= "toc#{tocidx}"
-          toc += html_toc_entry(h.name, h)
-        end
-        idx.children = "#{toc}</ul>"
+        toc = html_toc_entries(docxml, path)
+          .map { |k| k[:entry] }.join("\n")
+        idx.children = "<ul>#{toc}</ul>"
         docxml
       end
 
+      def html_toc_entries(docxml, path)
+        path.each_with_index.with_object([]) do |(p, i), m|
+          docxml.xpath(p.join(" | ")).each do |h|
+            h["id"] ||= "_#{UUIDTools::UUID.random_create}"
+            m << { entry: html_toc_entry("h#{i + 1}", h),
+                   line: h.line }
+          end
+        end.sort_by { |k| k[:line] }
+      end
+
       def toc_exclude_class
         "[not(@class = 'TermNum')][not(@class = 'noTOC')]" \
           "[string-length(normalize-space(.))>0]"

data/lib/isodoc/metadata.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require_relative "./metadata_date"
 require_relative "./metadata_contributor"
 
@@ -39,7 +37,7 @@ module IsoDoc
       @metadata[key] = value
     end
 
-    NOLANG = "[not(@language) or @language = '']"
+    NOLANG = "[not(@language) or @language = '']".freeze
 
     def currlang
       "[@language = '#{@lang}']"
@@ -109,7 +107,8 @@ module IsoDoc
 
     def version(isoxml, _out)
       set(:edition, isoxml&.at(ns("//bibdata/edition#{NOLANG}"))&.text)
-      set(:edition_display, isoxml&.at(ns("//bibdata/edition#{currlang}"))&.text)
+      set(:edition_display,
+          isoxml&.at(ns("//bibdata/edition#{currlang}"))&.text)
       set(:docyear, isoxml&.at(ns("//bibdata/copyright/from"))&.text)
       set(:draft, isoxml&.at(ns("//bibdata/version/draft"))&.text)
       revdate = isoxml&.at(ns("//bibdata/version/revision-date"))&.text
@@ -173,5 +172,14 @@ module IsoDoc
       c = isoxml.at(ns("//metanorma-extension/source-highlighter-css")) or return
       set(:code_css, c.text)
     end
+
+    def presentation(xml, _out)
+      xml.xpath(ns("//metanorma-extension/presentation-metadata")).each do |p|
+        ((n = p.at(ns("./name"))) && (v = p.at(ns("./value")))) or next
+        lbl = "presentation_metadata_#{n.text}".to_sym
+        m = get[lbl] || []
+        set(lbl, m << v.text)
+      end
+    end
   end
 end

data/lib/isodoc/presentation_function/block.rb

@@ -31,10 +31,18 @@ module IsoDoc
     end
 
     def formula1(elem)
+      formula_where(elem.at(ns("./dl")))
       lbl = @xrefs.anchor(elem["id"], :label, false)
       prefix_name(elem, "", lbl, "name")
     end
 
+    def formula_where(dlist)
+      dlist or return
+      dlist["class"] = "formula_dl"
+      where = dlist.xpath(ns("./dt")).size > 1 ? @i18n.where : @i18n.where_one
+      dlist.previous = "<p keep-with-next='true'>#{where}</p>"
+    end
+
     def example(docxml)
       docxml.xpath(ns("//example")).each { |f| example1(f) }
     end

data/lib/isodoc/presentation_function/erefs.rb

@@ -17,10 +17,11 @@ module IsoDoc
 
     def eref_localities(refs, target, node)
       if can_conflate_eref_rendering?(refs)
-        l10n(", #{eref_localities_conflated(refs, target, node)}")
+        l10n(", #{eref_localities_conflated(refs, target, node)}"
+          .gsub(/\s+/, " "))
       else
         ret = resolve_eref_connectives(eref_locality_stacks(refs, target, node))
-        l10n(ret.join)
+        l10n(ret.join.gsub(/\s+/, " "))
       end
     end
 
@@ -68,7 +69,7 @@ module IsoDoc
     end
 
     def resolve_comma_connectives1(locs, locs1, add)
-      if [", ", " "].include?(locs[1])
+      if [", ", " ", ""].include?(locs[1])
         add += locs[0..2].join
         locs.shift(3)
       else

data/lib/isodoc/presentation_function/xrefs.rb

@@ -75,7 +75,7 @@ module IsoDoc
     def combine_conflated_xref_locations(locs)
       out = locs.each { |l| l[:label] = anchor_value(l[:target]) }
       label = @i18n.inflect(locs.first[:elem], number: "pl")
-      out[0][:label] = l10n("#{label} #{out[0][:label]}")
+      out[0][:label] = l10n("#{label} #{out[0][:label]}").strip
       combine_conflated_xref_locations_container(locs, l10n(combine_conn(out)))
     end
 

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "2.4.5".freeze
+  VERSION = "2.5.0".freeze
 end

data/lib/isodoc/word_function/body.rb

@@ -93,7 +93,7 @@ module IsoDoc
 
       def dl_parse_table(node, out)
         list_title_parse(node, out)
-        out.table class: "dl" do |v|
+        out.table class: (node["class"] || "dl") do |v|
           node.elements.select { |n| dt_dd?(n) }
             .each_slice(2) do |dt, dd|
             dl_parse_table1(v, dt, dd)
@@ -204,14 +204,6 @@ module IsoDoc
         )
       end
 
-      def formula_where(deflist, out)
-        return unless deflist
-
-        out.p { |p| p << @i18n.where }
-        parse(deflist, out)
-        t = out.parent.at("./table") and t["class"] = "formula_dl"
-      end
-
       def formula_parse1(node, out)
         out.div **attr_code(class: "formula") do |div|
           div.p do |_p|
@@ -244,11 +236,11 @@ module IsoDoc
 
       def info(isoxml, out)
         @tocfigurestitle =
-          isoxml&.at(ns("//metanorma-extension/toc[@type = 'figure']/title"))&.text
+          isoxml.at(ns("//metanorma-extension/toc[@type = 'figure']/title"))&.text
         @toctablestitle =
-          isoxml&.at(ns("//metanorma-extension/toc[@type = 'table']/title"))&.text
+          isoxml.at(ns("//metanorma-extension/toc[@type = 'table']/title"))&.text
         @tocrecommendationstitle = isoxml
-          &.at(ns("//metanorma-extension/toc[@type = 'recommendation']/title"))&.text
+          .at(ns("//metanorma-extension/toc[@type = 'recommendation']/title"))&.text
         super
       end
     end

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

@@ -60,6 +60,7 @@ key: مفتاح
 example: مثال
 example_xref: مثال
 where: حيث
+where_one: حيث
 wholeoftext: كامل النص
 draft_label: مسودة
 inform_annex: إخباري

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

@@ -66,6 +66,7 @@ key: Taste
 example: BEISPIEL
 example_xref: Beispiel
 where: wobei
+where_one: wobei
 wholeoftext: Ganzer Text
 draft_label: Entwurf
 inform_annex: informativ

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

@@ -75,6 +75,7 @@ key: Key
 example: EXAMPLE
 example_xref: Example
 where: where
+where_one: where
 wholeoftext: Whole of text
 draft_label: draft
 inform_annex: informative

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

@@ -66,6 +66,7 @@ key: Clave
 example: EJEMPLO
 example_xref: Ejemplo
 where: donde
+where_one: donde
 wholeoftext: Todo el texto
 draft_label: borrador
 inform_annex: informativo

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

@@ -63,6 +63,7 @@ key: Légende
 example: EXEMPLE
 example_xref: Exemple
 where: où
+where_one: où
 wholeoftext: Ensemble du texte
 draft_label: brouillon
 inform_annex: informative

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

@@ -71,6 +71,7 @@ key: Условные обозначения
 example: ПРИМЕР
 example_xref: Пример
 where: где
+where_one: где
 wholeoftext: Текст полностью
 draft_label: проект
 inform_annex: информативное

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

@@ -61,6 +61,7 @@ key: 说明
 example: 示例
 example_xref: 示例
 where: 式中
+where_one: 式中
 wholeoftext: 全部
 draft_label: 稿
 inform_annex: 资料性附录

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 2.4.5
+  version: 2.5.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-27 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciimath