isodoc 2.12.1 → 2.12.2

data/lib/isodoc/function/terms.rb

@@ -28,24 +28,27 @@ module IsoDoc
         end
       end
 
-      def para_then_remainder(first, node, para, div)
-        if first.name == "p"
-          first.children.each { |n| parse(n, para) }
-          node.elements.drop(1).each { |n| parse(n, div) }
-        else
-          node.elements.each { |n| parse(n, div) }
-        end
+      def termnote_p_class
+        nil
       end
 
       def termnote_parse(node, out)
-        name = node&.at(ns("./name"))&.remove
+        para = block_body_first_elem(node)
         out.div **note_attrs(node) do |div|
-          div.p do |p|
-            name&.children&.each { |n| parse(n, p) }
-            p << " "
-            para_then_remainder(node.first_element_child, node, p, div)
-          end
+          termnote_parse1(node, para, div)
+          para&.xpath("./following-sibling::*")&.each { |n| parse(n, div) }
+        end
+      end
+
+      def termnote_parse1(node, para, div)
+        div.p **attr_code(class: termnote_p_class) do |p|
+          name = node.at(ns("./fmt-name")) and
+            p.span class: "termnote_label" do |s|
+              children_parse(name, s)
+            end
+          para&.name == "p" and children_parse(para, p)
         end
+        para&.name != "p" and parse(para, div)
       end
 
       def termref_parse(node, out)
@@ -60,7 +63,7 @@ module IsoDoc
       end
 
       def termdef_parse(node, out)
-        name = node.at(ns("./name"))&.remove
+        name = node.at(ns("./fmt-name"))&.remove
         out.p class: "TermNum", id: node["id"] do |p|
           name&.children&.each { |n| parse(n, p) }
         end

data/lib/isodoc/function/to_word_html.rb

@@ -262,6 +262,11 @@ module IsoDoc
           when "ruby" then ruby_parse(node, out)
           when "rt" then rt_parse(node, out)
           when "rb" then rb_parse(node, out)
+          when "semx" then semx_parse(node, out)
+          when "name" then name_parse(node, out)
+          when "fmt-xref-label" then xref_label_parse(node, out)
+          when "fmt-name" then fmt_name_parse(node, out)
+          when "floating-title" then floating_title_parse(node, out)
           else error_parse(node, out)
           end
         end

data/lib/isodoc/html_function/footnotes.rb

@@ -24,6 +24,7 @@ module IsoDoc
         end
       end
 
+      # Move to Presentation XML, as <fmt-footnote>: it's a footnote body
       def make_table_footnote_text(node, fnid, fnref)
         attrs = { id: "fn:#{fnid}" }
         noko do |xml|
@@ -68,7 +69,7 @@ module IsoDoc
 
       def footnote_parse(node, out)
         return table_footnote_parse(node, out) if (@in_table || @in_figure) &&
-          !node.ancestors.map(&:name).include?("name")
+          !node.ancestors.map(&:name).include?("fmt-name")
 
         fn = node["reference"] || UUIDTools::UUID.random_create.to_s
         attrs = { class: "FootnoteRef", href: "#fn:#{fn}" }

data/lib/isodoc/html_function/html.rb

@@ -15,10 +15,6 @@ module IsoDoc
         end.join("\n")
       end
 
-      def preprocess_xslt(docxml)
-        super
-      end
-
       def make_body1(body, _docxml)
         return if @bare
 
@@ -78,7 +74,7 @@ module IsoDoc
       end
 
       def sourcecode_parse(node, out)
-        name = node.at(ns("./name"))
+        name = node.at(ns("./fmt-name"))
         tag = node.at(ns(".//sourcecode | .//table")) ? "div" : "pre"
         attr = sourcecode_attrs(node).merge(class: "sourcecode")
         out.send tag, **attr do |div|

data/lib/isodoc/init.rb

@@ -141,13 +141,14 @@ module IsoDoc
       self.class::AGENCIES.include?(text)
     end
 
-    # This is highly specific to ISO, but it's not a bad precedent for
-    # references anyway; keeping here instead of in IsoDoc::Iso for now
     def docid_l10n(text)
       text.nil? and return text
       @i18n.all_parts and text.gsub!(/All Parts/i, @i18n.all_parts.downcase)
-      text.size < 20 and text.gsub!(/ /, "&#xa0;")
-      text
+      x = Nokogiri::XML::DocumentFragment.parse(text)
+      (x.xpath(".//text()") - x.xpath(".//fn//text()")).each do |n|
+        n.replace(n.text.gsub(/ /, "&#xa0;"))
+      end
+      to_xml(x)
     end
 
     def docid_prefix(prefix, docid)
@@ -161,5 +162,14 @@ module IsoDoc
       %w(ISO IEC IEV ITU W3C BIPM csd metanorma repository metanorma-ordinal)
         .include? prefix
     end
+
+    def connectives_spans(text)
+      text.gsub("<conn>", "<span class='fmt-conn'>")
+        .gsub("</conn>", "</span>")
+        .gsub("<enum-comma>", "<span class='fmt-enum-comma'>")
+        .gsub("</enum-comma>", "</span>")
+        .gsub("<comma>", "<span class='fmt-comma'>")
+        .gsub("</comma>", "</span>")
+    end
   end
 end

data/lib/isodoc/metadata.rb

@@ -13,6 +13,15 @@ module IsoDoc
       @i18n.l10n(expr, lang, script, locale)
     end
 
+    def connectives_strip(text)
+      text.gsub("<conn>", "")
+        .gsub("</conn>", "")
+        .gsub("<enum-comma>", "")
+        .gsub("</enum-comma>", "")
+        .gsub("<comma>", "")
+        .gsub("</comma>", "")
+    end
+
     def initialize(lang, script, locale, i18n, fonts_options = {})
       @metadata = { lang:, script: }
       DATETYPES.each { |w| @metadata["#{w.tr('-', '_')}date".to_sym] = "XXX" }

data/lib/isodoc/metadata_contributor.rb

@@ -79,7 +79,7 @@ module IsoDoc
     def agency(xml)
       agency, publisher = agency1(xml)
       set(:agency, agency.sub(%r{/$}, ""))
-      set(:publisher, @i18n.boolean_conj(publisher, "and"))
+      set(:publisher, connectives_strip(@i18n.boolean_conj(publisher, "and")))
       agency_addr(xml)
     end
 

data/lib/isodoc/metadata_date.rb

@@ -42,7 +42,7 @@ module IsoDoc
 
     def bibdate(isoxml, _out)
       isoxml.xpath(ns("//bibdata/date")).each do |d|
-        set("#{d['type'].gsub(/-/, '_')}date".to_sym, Common::date_range(d))
+        set("#{d['type'].tr('-', '_')}date".to_sym, Common::date_range(d))
       end
     end
   end

data/lib/isodoc/presentation_function/autonum.rb

@@ -0,0 +1,139 @@
+module IsoDoc
+  class PresentationXMLConvert < ::IsoDoc::Convert
+    def prefix_name(node, delims, label, elem)
+      label, delims = prefix_name_defaults(node, delims, label)
+      name, ins, ids, number = prefix_name_prep(node, elem)
+      ins.next = fmt_xref_label(label, number, ids)
+      # autonum can be empty, e.g single note in clause: "NOTE []"
+      number and node["autonum"] = number.gsub(/<[^>]+>/, "")
+      !node.at(ns("./fmt-#{elem}")) &&
+        (c = fmt_caption(label, elem, name, ids, delims)) and ins.next = c
+      prefix_name_postprocess(node, elem)
+    end
+
+    def prefix_name_defaults(node, delims, label)
+      label&.empty? and label = nil
+      delims.nil? and delims = {}
+      [label, delims]
+    end
+
+    def prefix_name_prep(node, elem)
+      lbls = prefix_name_labels(node)
+      name = node.at(ns("./#{elem}")) and name["id"] = lbls[:name]
+      ins = name || node.add_first_child("<sentinel/>").elements.first
+      node["unnumbered"] or
+        number = @xrefs.anchor(node["id"], :value, false)&.strip
+      [name, ins, lbls, number]
+    end
+
+    def prefix_name_labels(node)
+      { elem: node["id"],
+        name: "_#{UUIDTools::UUID.random_create}" }
+    end
+
+    def prefix_name_postprocess(node, elem)
+      node.at(ns("./sentinel"))&.remove
+      strip_duplicate_ids(node, node.at(ns("./#{elem}")),
+                          node.at(ns("./fmt-#{elem}")))
+    end
+
+    def transfer_id(old, new)
+      old["id"] or return
+      new["id"] = old["id"]
+      old["original-id"] = old["id"]
+      old.delete("id")
+    end
+
+    def gather_all_ids(elem)
+      elem.xpath(".//*[@id]").each_with_object([]) do |i, m|
+        m << i["id"]
+      end
+    end
+
+    # remove ids duplicated between title and fmt-title
+    # index terms are assumed transferred to fmt-title from title
+    def strip_duplicate_ids(_node, sem_title, pres_title)
+      sem_title && pres_title or return
+      ids = gather_all_ids(pres_title)
+      sem_title.xpath(".//*[@id]").each do |x|
+        ids.include?(x["id"]) or next
+        x["original-id"] = x["id"]
+        x.delete("id")
+      end
+      sem_title.xpath(ns(".//index")).each(&:remove)
+    end
+
+    def semx(node, label, element = "autonum")
+      id = node["id"] || node[:id]
+      /<semx element='[^']+' source='#{id}'/.match?(label) and return label
+      l = stripsemx(label)
+      %(<semx element='#{element}' source='#{id}'>#{l}</semx>)
+    end
+
+    def autonum(id, num)
+      /<semx/.match?(num) and return num # already contains markup
+      "<semx element='autonum' source='#{id}'>#{num}</semx>"
+    end
+
+    def labelled_autonum(label, id, num)
+      elem = "<span class='fmt-element-name'>#{label}</span>"
+      num.blank? and return elem
+      l10n("#{elem} #{autonum(id, num)}")
+    end
+
+    def fmt_xref_label(label, _number, ids)
+      label or return ""
+      x = @xrefs.anchor(ids[:elem], :xref, false) or return ""
+      ret = "<fmt-xref-label>#{x}</fmt-xref-label>"
+      container = @xrefs.anchor(ids[:elem], :container, false)
+      y = prefix_container_fmt_xref_label(container, x)
+      y != x and
+        ret += "<fmt-xref-label container='#{container}'>#{y}</fmt-xref-label>"
+      ret
+    end
+
+    def prefix_container_fmt_xref_label(container, xref)
+      container or return xref
+      container_container = @xrefs.anchor(container, :container, false)
+      container_label =
+        prefix_container_fmt_xref_label(container_container,
+                                        @xrefs.anchor(container, :xref, false))
+      l10n(connectives_spans(@i18n.nested_xref
+        .sub("%1", "<span class='fmt-xref-container'>#{container_label}</span>")
+        .sub("%2", xref)))
+    end
+
+    # detect whether string which may contain XML markup is empty
+    def empty_xml?(str)
+      str.blank? and return true
+      x = Nokogiri::XML::DocumentFragment.parse(str)
+      x.to_str.strip.empty?
+    end
+
+    # Remove ".blank?" tests if want empty delim placeholders for manipulation
+    def fmt_caption(label, elem, name, ids, delims)
+      label = fmt_caption_label_wrap(label)
+      c = fmt_caption2(label, elem, name, ids, delims)
+      empty_xml?(c) and return
+      !delims[:label].blank? and
+        f = "<span class='fmt-label-delim'>#{delims[:label]}</span>"
+      "<fmt-#{elem}>#{c}#{f}</fmt-#{elem}>"
+    end
+
+    def fmt_caption_label_wrap(label)
+      empty_xml?(label) || %r{<span class=['"]fmt-caption-label['"]}.match?(label) or
+        label = "<span class='fmt-caption-label'>#{label}</span>"
+      label
+    end
+
+    def fmt_caption2(label, elem, name, ids, delims)
+      if name && !name.children.empty?
+        empty_xml?(label) or
+          d = "<span class='fmt-caption-delim'>#{delims[:caption]}</span>"
+        attr = " element='#{elem}' source='#{ids[:name]}'"
+        "#{label}#{d}<semx #{attr}>#{to_xml(name.children)}</semx>"
+      elsif label then label
+      end
+    end
+  end
+end

data/lib/isodoc/presentation_function/block.rb

@@ -1,29 +1,23 @@
 require_relative "image"
 require_relative "sourcecode"
+require_relative "autonum"
 require "rouge"
 
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def lower2cap(text)
-      /^[[:upper:]][[:upper:]]/.match?(text) and return text
-      text&.capitalize
+      text.nil? and return text
+      x = Nokogiri::XML("<a>#{text}</a>")
+      firsttext = x.at(".//text()[string-length(normalize-space(.))>0]") or return text
+      /^[[:upper:]][[:upper:]]/.match?(firsttext.text) and return text
+      firsttext.replace(firsttext.text.capitalize)
+      to_xml(x.root.children)
     end
 
     def block_delim
       "&#xa0;&#x2014; "
     end
 
-    def prefix_name(node, delim, number, elem)
-      number.nil? || number.empty? and return
-      unless name = node.at(ns("./#{elem}"))
-        node.add_first_child "<#{elem}></#{elem}>"
-        name = node.children.first
-      end
-      if name.children.empty? then name.add_child(cleanup_entities(number.strip))
-      else (name.children.first.previous = "#{number.strip}#{delim}")
-      end
-    end
-
     def formula(docxml)
       docxml.xpath(ns("//formula")).each { |f| formula1(f) }
     end
@@ -31,7 +25,7 @@ module IsoDoc
     def formula1(elem)
       formula_where(elem.at(ns("./dl")))
       lbl = @xrefs.anchor(elem["id"], :label, false)
-      lbl.nil? || lbl.empty? or prefix_name(elem, "", "(#{lbl})", "name")
+      lbl.nil? || lbl.empty? or prefix_name(elem, {}, lbl, "name")
     end
 
     def formula_where(dlist)
@@ -47,11 +41,8 @@ module IsoDoc
 
     def example1(elem)
       n = @xrefs.get[elem["id"]]
-      lbl = if n.nil? || n[:label].nil? || n[:label].empty?
-              @i18n.example
-            else l10n("#{@i18n.example} #{n[:label]}")
-            end
-      prefix_name(elem, block_delim, lbl, "name")
+      lbl = labelled_autonum(@i18n.example, elem["id"], n&.dig(:label))
+      prefix_name(elem, { caption: block_delim }, lbl, "name")
     end
 
     def note(docxml)
@@ -59,22 +50,18 @@ module IsoDoc
     end
 
     def note_delim(_elem)
-      ""
+      "<tab/>"
     end
 
     def note1(elem)
       %w(bibdata bibitem).include?(elem.parent.name) ||
-        elem["notag"] == "true" and return
-      lbl = note_label(elem)
-      prefix_name(elem, "", lbl, "name")
+        elem["notag"] == "true" or lbl = note_label(elem)
+      prefix_name(elem, { label: note_delim(elem) }, lbl, "name")
     end
 
     def note_label(elem)
       n = @xrefs.get[elem["id"]]
-      lbl = @i18n.note
-      (n.nil? || n[:label].nil? || n[:label].empty?) or
-        lbl = l10n("#{lbl} #{n[:label]}")
-      "#{lbl}#{note_delim(elem)}"
+      labelled_autonum(@i18n.note, elem["id"], n&.dig(:label))
     end
 
     def admonition(docxml)
@@ -85,24 +72,25 @@ module IsoDoc
       if elem["type"] == "box"
         admonition_numbered1(elem)
       elsif elem["notag"] == "true" || elem.at(ns("./name"))
+        prefix_name(elem, { label: admonition_delim(elem) }, nil, "name")
       else
         label = admonition_label(elem, nil)
-        prefix_name(elem, "", label, "name")
+        prefix_name(elem, { label: admonition_delim(elem) }, label, "name")
       end
-      n = elem.at(ns("./name")) and n << admonition_delim(elem)
     end
 
     def admonition_numbered1(elem)
-      elem["unnumbered"] && !elem.at(ns("./name")) and return
+      # elem["unnumbered"] && !elem.at(ns("./name")) and return
       label = admonition_label(elem, @xrefs.anchor(elem["id"], :label, false))
-      prefix_name(elem, block_delim, label, "name")
+      prefix_name(elem, { caption: block_delim }, label, "name")
     end
 
     def admonition_label(elem, num)
       lbl = if elem["type"] == "box" then @i18n.box
             else @i18n.admonition[elem["type"]]&.upcase end
-      num and lbl = l10n("#{lbl} #{num}")
-      lbl
+      #lbl &&= "<span class='fmt-element-name'>#{lbl}</span>"
+      #num and lbl = l10n("#{lbl} #{autonum(elem['id'], num)}")
+      labelled_autonum(lbl, elem["id"], num)
     end
 
     def admonition_delim(_elem)
@@ -119,8 +107,14 @@ module IsoDoc
       labelled_ancestor(elem) and return
       elem["unnumbered"] && !elem.at(ns("./name")) and return
       n = @xrefs.anchor(elem["id"], :label, false)
-      prefix_name(elem, block_delim, l10n("#{lower2cap @i18n.table} #{n}"),
-                  "name")
+      #lbl = "<span class='fmt-element-name'>#{lower2cap @i18n.table}</span> "\
+        #"#{autonum(elem['id'], n)}"
+      lbl = labelled_autonum(lower2cap(@i18n.table), elem["id"], n)
+      prefix_name(elem, { caption: table_delim }, l10n(lbl), "name")
+    end
+
+    def table_delim
+      block_delim
     end
 
     def table_long_strings_cleanup(docxml)
@@ -156,7 +150,23 @@ module IsoDoc
       elem.replace(elem.children)
     end
 
-    def dl(docxml); end
+    def dl(docxml)
+      docxml.xpath(ns("//dl")).each { |f| dl1(f) }
+    end
+
+    def dl1(elem)
+      elem.at(ns("./name")) and
+        prefix_name(elem, {}, "", "name") # copy name to fmt-name
+    end
+
+    def ul(docxml)
+      docxml.xpath(ns("//ul")).each { |f| ul1(f) }
+    end
+
+    def ul1(elem)
+      elem.at(ns("./name")) and
+        prefix_name(elem, {}, "", "name") # copy name to fmt-name
+    end
 
     def ol(docxml)
       docxml.xpath(ns("//ol")).each { |f| ol1(f) }
@@ -179,9 +189,8 @@ module IsoDoc
 
     def ol1(elem)
       elem["type"] ||= ol_depth(elem).to_s
-      elem.xpath(ns("./li")).each do |li|
-        li["id"] ||= "_#{UUIDTools::UUID.random_create}"
-      end
+      elem.at(ns("./name")) and
+        prefix_name(elem, {}, "", "name") # copy name to fmt-name
     end
 
     def ol_label(elem)

data/lib/isodoc/presentation_function/docid.rb

@@ -6,29 +6,6 @@ module IsoDoc
       end
     end
 
-=begin
-    # This is highly specific to ISO, but it's not a bad precedent for
-    # references anyway; keeping here instead of in IsoDoc::Iso for now
-    def docid_l10n(text)
-      text.nil? and return text
-      @i18n.all_parts and text.gsub!(/All Parts/i, @i18n.all_parts.downcase)
-      text.size < 20 and text.gsub!(/ /, "&#xa0;")
-      text
-    end
-
-    def docid_prefix(prefix, docid)
-      docid = "#{prefix} #{docid}" if prefix && !omit_docid_prefix(prefix) &&
-        !/^#{prefix}\b/.match(docid)
-      docid_l10n(docid)
-    end
-
-    def omit_docid_prefix(prefix)
-      prefix.nil? || prefix.empty? and return true
-      %w(ISO IEC IEV ITU W3C BIPM csd metanorma repository metanorma-ordinal)
-        .include? prefix
-    end
-=end
-
     def pref_ref_code(bib)
       bib["suppress_identifier"] == "true" and return nil
       ret = bib.xpath(ns("./docidentifier[@scope = 'biblio-tag']"))

data/lib/isodoc/presentation_function/erefs.rb

@@ -5,7 +5,8 @@ module IsoDoc
     def citeas(xmldoc)
       xmldoc.xpath(ns("//eref | //origin | //quote//source")).each do |e|
         e["bibitemid"] && e["citeas"] or next
-        a = @xrefs.anchor(e["bibitemid"], :xref, false) and e["citeas"] = a
+        a = @xrefs.anchor(e["bibitemid"], :xref, false) and
+          e["citeas"] = a.gsub(%r{</?[^>]+>}, "")
       end
     end
 
@@ -87,7 +88,8 @@ module IsoDoc
       locs1 = []
       until locs.empty?
         if locs[1] == "to"
-          locs1 << @i18n.chain_to.sub("%1", locs[0]).sub("%2", locs[2])
+          locs1 << connectives_spans(@i18n.chain_to.sub("%1", locs[0])
+            .sub("%2", locs[2]))
           locs.shift(3)
         else locs1 << locs.shift
         end

data/lib/isodoc/presentation_function/image.rb

@@ -43,16 +43,32 @@ module IsoDoc
       elem.children = x
     end
 
+    def subfigure_delim
+      ""
+      # "<span class='fmt-label-delim'>)</span>"
+    end
+
+    def figure_delim(_elem)
+      block_delim
+    end
+
+    def figure_name(elem)
+      "<span class='fmt-element-name'>#{figure_label(elem)}</span> "
+    end
+
     def figure1(elem)
       elem["class"] == "pseudocode" || elem["type"] == "pseudocode" and
         return sourcecode1(elem)
       figure_fn(elem)
       figure_key(elem.at(ns("./dl")))
-      figure_label?(elem) or return nil
-      lbl = @xrefs.anchor(elem["id"], :label, false) or return
-      # no xref, no label: this can be set in xref
-      prefix_name(elem, block_delim,
-                  l10n("#{figure_label(elem)} #{lbl}"), "name")
+      lbl = @xrefs.anchor(elem["id"], :label, false)
+      lbl and a = autonum(elem["id"], lbl)
+      figname = figure_name(elem)
+      if elem.parent.name == "figure"
+        a += subfigure_delim
+      end
+      lbl && figure_label?(elem) and s = "#{figname}#{a}"
+      prefix_name(elem, { caption: figure_delim(elem) }, l10n(s&.strip), "name")
     end
 
     # move footnotes into key, and get rid of footnote reference

data/lib/isodoc/presentation_function/inline.rb

@@ -13,7 +13,7 @@ module IsoDoc
       node["style"] == "id" and anchor_id_postprocess(node)
       xref_empty?(node) or return
       target = docid_l10n(node["target"]) ||
-        expand_citeas(docid_l10n(node["citeas"]))
+        docid_l10n(expand_citeas(node["citeas"]))
       link = anchor_linkend(node, target)
       link += eref_localities(node.xpath(ns("./locality | ./localityStack")),
                               link, node)

data/lib/isodoc/presentation_function/reqt.rb

@@ -24,7 +24,7 @@ module IsoDoc
     def recommendation1(elem, type)
       lbl = @reqt_models.model(elem["model"])
         .recommendation_label(elem, type, xrefs)
-      prefix_name(elem, "", l10n(lbl), "name")
+      prefix_name(elem, {}, l10n(lbl), "name")
     end
 
     def requirement_render_preprocessing(docxml); end