isodoc 3.1.0 → 3.1.2

data/lib/isodoc/presentation_function/block.rb

@@ -8,7 +8,8 @@ module IsoDoc
     def lower2cap(text)
       text.nil? and return text
       x = Nokogiri::XML("<a>#{text}</a>")
-      firsttext = x.at(".//text()[string-length(normalize-space(.))>0]") or return text
+      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)
@@ -80,7 +81,6 @@ module IsoDoc
     end
 
     def admonition_numbered1(elem)
-      # elem["unnumbered"] && !elem.at(ns("./name")) and return
       label = admonition_label(elem, @xrefs.anchor(elem["id"], :label, false))
       prefix_name(elem, { caption: block_delim }, label, "name")
     end
@@ -88,8 +88,6 @@ module IsoDoc
     def admonition_label(elem, num)
       lbl = if elem["type"] == "box" then @i18n.box
             else @i18n.admonition[elem["type"]]&.upcase end
-      #lbl &&= "<span class='fmt-element-name'>#{lbl}</span>"
-      #num and lbl = l10n("#{lbl} #{autonum(elem['id'], num)}")
       labelled_autonum(lbl, elem["id"], num)
     end
 
@@ -107,8 +105,6 @@ module IsoDoc
       labelled_ancestor(elem) and return
       elem["unnumbered"] && !elem.at(ns("./name")) and return
       n = @xrefs.anchor(elem["id"], :label, false)
-      #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
@@ -128,15 +124,6 @@ module IsoDoc
       end
     end
 
-    def table_fn(elem)
-      (elem.xpath(ns(".//fn")) - elem.xpath(ns("./name//fn")))
-        .each_with_index do |f, i|
-          table_fn1(elem, f, i)
-        end
-    end
-
-    def table_fn1(table, fnote, idx); end
-
     def amend(docxml)
       docxml.xpath(ns("//amend")).each { |f| amend1(f) }
     end
@@ -233,19 +220,28 @@ module IsoDoc
       author = elem.at(ns("./author"))
       source = elem.at(ns("./source"))
       author.nil? && source.nil? and return
+      p = quote_attribution(author, source, elem)
+      elem << "<attribution><p>#{l10n p}</p></attribution>"
+    end
+
+    # e["deleteme"]: duplicate of source, will be duplicated in fmt-eref,
+    # need to delete after
+    def quote_attribution(author, source, elem)
       p = "&#x2014; "
       p += to_xml(semx_fmt_dup(author)) if author
       p += ", " if author && source
-      if source
-        s = semx_fmt_dup(source)
-e = Nokogiri::XML::Node.new("eref", elem.document)
-e << s.children
-s << e
-source.attributes.each_key { |k| e[k] = source[k] }
-e["deleteme"] = "true" # duplicate of source, will be duplicated in fmt-eref, need to delete after
-        p += to_xml(s)
-      end
-      elem << "<attribution><p>#{l10n p}</p></attribution>"
+      source or return p
+      p + to_xml(quote_source(source, elem))
+    end
+
+    def quote_source(source, elem)
+      s = semx_fmt_dup(source)
+      e = Nokogiri::XML::Node.new("eref", elem.document)
+      e << s.children
+      s << e
+      source.attributes.each_key { |k| e[k] = source[k] }
+      e["deleteme"] = "true"
+      s
     end
   end
 end

data/lib/isodoc/presentation_function/concepts.rb

@@ -20,7 +20,6 @@ module IsoDoc
     end
 
     def concept_render(node, defaults)
-      #require "debug"; binding.b
       opts, render, ref, ret = concept_render_init(node, defaults)
       ret&.at(ns("./refterm"))&.remove
       ref && opts[:ref] != "false" and render&.next = " "
@@ -31,7 +30,8 @@ module IsoDoc
     end
 
     def concept_dup(node, ret)
-      node.xpath(".//xmlns:semx[xmlns:fmt-xref | xmlns:fmt-eref | xmlns:fmt-origin | xmlns:fmt-link]").each(&:remove)
+      node.xpath(".//xmlns:semx[xmlns:fmt-xref | xmlns:fmt-eref | " \
+        "xmlns:fmt-origin | xmlns:fmt-link]").each(&:remove)
       ret.xpath(ns(".//xref | .//eref | .//origin | .//link")).each(&:remove)
       ret.xpath(ns(".//semx")).each do |s|
         s.children.empty? and s.remove
@@ -66,10 +66,11 @@ module IsoDoc
       (opts[:linkmention] == "true" && !renderterm.nil? && !ref.nil?) or return
       ref2 = ref.clone
       r2 = renderterm.clone
-      #renderterm.replace(ref2).children = r2
       ref2.children = r2
       if ref.parent.name == "semx"
-        renderterm.replace("<semx element='#{ref.parent['element']}' source='#{ref.parent['source']}'>#{to_xml(ref2)}</semx>")
+        renderterm.replace(<<~SEMX)
+          <semx element='#{ref.parent['element']}' source='#{ref.parent['source']}'>#{to_xml(ref2)}</semx>
+        SEMX
       else
         renderterm.replace(ref2)
       end
@@ -103,7 +104,7 @@ module IsoDoc
       p, ref, orig = related1_prep(node)
       label = @i18n.relatedterms[orig["type"]].upcase
       if p && ref
-        node.children =(l10n("<p><strong>#{label}:</strong> " \
+        node.children = (l10n("<p><strong>#{label}:</strong> " \
                           "<em>#{to_xml(p)}</em> (#{Common::to_xml(ref)})</p>"))
       else
         node.children = (l10n("<p><strong>#{label}:</strong> " \
@@ -198,8 +199,6 @@ module IsoDoc
     def designation_annotate(desgn, name, orig)
       designation_boldface(desgn)
       designation_field(desgn, name, orig)
-      #g = desgn.at(ns("./expression/grammar")) and
-        #name << ", #{designation_grammar(g).join(', ')}"
       designation_grammar(desgn, name)
       designation_localization(desgn, name, orig)
       designation_pronunciation(desgn, name)
@@ -213,7 +212,7 @@ module IsoDoc
       name.children = "<strong>#{name.children}</strong>"
     end
 
-    def designation_field(desgn, name, orig)
+    def designation_field(_desgn, name, orig)
       f = orig.xpath(ns("./field-of-application | ./usage-info"))
         &.map { |u| to_xml(semx_fmt_dup(u)) }&.join(", ")
       f&.empty? and return nil

data/lib/isodoc/presentation_function/erefs.rb

@@ -5,7 +5,7 @@ module IsoDoc
     def citeas(xmldoc)
       xmldoc.xpath(ns("//fmt-eref | //fmt-origin | //fmt-link"))
         .each do |e|
-          sem_xml_descendant?(e) and next
+        sem_xml_descendant?(e) and next
         e["bibitemid"] && e["citeas"] or next
         a = @xrefs.anchor(e["bibitemid"], :xref, false) or next
         e["citeas"] = citeas_cleanup(a)
@@ -35,7 +35,6 @@ module IsoDoc
       ret = resolve_eref_connectives(locs)
       elem["id"] ||= "_#{UUIDTools::UUID.random_create}"
       elem.next = "<semx element='erefstack' source='#{elem['id']}'>#{ret[1]}</semx>"
-      #elem.replace(ret[1])
     end
 
     def eref_localities(refs, target, node)
@@ -198,7 +197,7 @@ module IsoDoc
       docxml.xpath(ns("//display-text")).each { |f| f.replace(f.children) }
       docxml.xpath(ns("//fmt-eref | //fmt-origin[not(.//termref)]"))
         .each do |e|
-          sem_xml_descendant?(e) and next
+        sem_xml_descendant?(e) and next
         href = eref_target(e) or next
         e.xpath(ns("./locality | ./localityStack")).each(&:remove)
         if href[:type] == :anchor then eref2xref(e)

data/lib/isodoc/presentation_function/footnotes.rb

@@ -0,0 +1,140 @@
+module IsoDoc
+  class PresentationXMLConvert < ::IsoDoc::Convert
+    def footnote_collect(fnotes)
+      seen = {}
+      fnotes.each_with_object([]) do |x, m|
+        x["id"] ||= "_#{UUIDTools::UUID.random_create}"
+        seen[x["reference"]] or m << fnbody(x, seen)
+        x["target"] = seen[x["reference"]]
+        ref = x["hiddenref"] == "true" ? "" : fn_ref_label(x)
+        x << "<fmt-fn-label>#{ref}</fmt-fn-label>"
+      end
+    end
+
+    def footnote_container(fnotes, fnbodies)
+      fnbodies.empty? and return
+      ctr = Nokogiri::XML::Node.new("fmt-footnote-container",
+                                    fnotes.first.document)
+      fnbodies.each { |x| ctr << x }
+      ctr
+    end
+
+    def fnbody(fnote, seen)
+      body = Nokogiri::XML::Node.new("fmt-fn-body", fnote.document)
+      body["id"] = "_#{UUIDTools::UUID.random_create}"
+      body["target"] = fnote["id"]
+      body["reference"] = fnote["reference"]
+      body << semx_fmt_dup(fnote)
+      insert_fn_body_ref(fnote, body)
+      seen[fnote["reference"]] = body["id"]
+      body
+    end
+
+    def insert_fn_body_ref(fnote, body)
+      ins = body.at(ns(".//p")) ||
+        body.at(ns("./semx")).children.first.before("<p> </p>").previous
+      lbl = fn_body_label(fnote)
+      ins.children.first.previous = <<~FNOTE.strip
+        <fmt-fn-label>#{lbl}<span class="fmt-caption-delim"><tab/></fmt-fn-label>
+      FNOTE
+    end
+
+    def fn_ref_label(fnote)
+      "<sup>#{fn_label(fnote)}</sup>"
+    end
+
+    def fn_body_label(fnote)
+      "<sup>#{fn_label(fnote)}</sup>"
+    end
+
+    def fn_label(fnote)
+      <<~FNOTE.strip
+        <semx element="autonum" source="#{fnote['id']}">#{fnote['reference']}</semx>
+      FNOTE
+    end
+
+    def table_fn(elem)
+      fnotes = elem.xpath(ns(".//fn")) - elem.xpath(ns("./name//fn"))
+      ret = footnote_collect(fnotes)
+      f = footnote_container(fnotes, ret) and elem << f
+    end
+
+    def document_footnotes(docxml)
+      sects = sort_footnote_sections(docxml)
+      excl = non_document_footnotes(docxml)
+      fns = filter_document_footnotes(sects, excl)
+      fns = renumber_document_footnotes(fns, 1)
+      ret = footnote_collect(fns)
+      f = footnote_container(fns, ret) and docxml.root << f
+    end
+
+    # bibdata, boilerplate, @displayorder sections
+    def sort_footnote_sections(docxml)
+      sects = docxml.xpath(".//*[@displayorder]")
+        .sort_by { |c| c["displayorder"].to_i }
+      b = docxml.at(ns("//boilerplate")) and sects.unshift b
+      b = docxml.at(ns("//bibdata")) and sects.unshift b
+      sects
+    end
+
+    def non_document_footnotes(docxml)
+      table_fns = docxml.xpath(ns("//table//fn")) -
+        docxml.xpath(ns("//table/name//fn"))
+      fig_fns = docxml.xpath(ns("//figure//fn")) -
+        docxml.xpath(ns("//figure/name//fn"))
+      table_fns + fig_fns
+    end
+
+    def filter_document_footnotes(sects, excl)
+      sects.each_with_object([]) do |s, m|
+        docfns = s.xpath(ns(".//fn")) - excl
+        m << docfns
+      end
+    end
+
+    # can instead restart at i=1 each section
+    def renumber_document_footnotes(fns_by_section, idx)
+      fns_by_section.reject(&:empty?).each_with_object({}) do |s, seen|
+        s.each do |f|
+          idx = renumber_document_footnote(f, idx, seen)
+        end
+      end
+      fns_by_section.flatten
+    end
+
+    def renumber_document_footnote(fnote, idx, seen)
+      fnote["original-reference"] = fnote["reference"]
+      if seen[fnote["reference"]]
+        fnote["reference"] = seen[fnote["reference"]]
+      else
+        seen[fnote["reference"]] = idx
+        fnote["reference"] = idx
+        idx += 1
+      end
+      idx
+    end
+
+    # move footnotes into key
+    def figure_fn(elem)
+      fn = elem.xpath(ns(".//fn")) - elem.xpath(ns("./name//fn"))
+      fn.empty? and return
+      dl = figure_key_insert_pt(elem)
+      footnote_collect(fn).each do |f|
+        label, fbody = figure_fn_to_dt_dd(f)
+        dl.previous = "<dt><p>#{to_xml(label)}</p></dt><dd>#{to_xml(fbody)}</dd>"
+      end
+    end
+
+    def figure_fn_to_dt_dd(f)
+      label = f.at(ns(".//fmt-fn-label")).remove
+      label.at(ns(".//span[@class = 'fmt-caption-delim']"))&.remove
+      [label, f]
+    end
+
+    def figure_key_insert_pt(elem)
+      elem.at(ns(".//dl/name"))&.next ||
+        elem.at(ns(".//dl"))&.children&.first ||
+        elem.add_child("<dl> </dl>").first.children.first
+    end
+  end
+end

data/lib/isodoc/presentation_function/image.rb

@@ -73,24 +73,6 @@ module IsoDoc
       prefix_name(elem, { caption: figure_delim(elem) }, l10n(s&.strip), "name")
     end
 
-    # move footnotes into key, and get rid of footnote reference
-    # since it is in diagram
-    def figure_fn(elem)
-      fn = elem.xpath(ns(".//fn")) - elem.xpath(ns("./name//fn"))
-      fn.empty? and return
-      dl = figure_key_insert_pt(elem)
-      fn.each do |f|
-        dl.previous = "<dt><p><sup>#{f['reference']}</sup></p></dt>" \
-          "<dd>#{f.remove.children.to_xml}</dd>"
-      end
-    end
-
-    def figure_key_insert_pt(elem)
-      elem.at(ns("//dl/name"))&.next ||
-        elem.at(ns("//dl"))&.children&.first ||
-        elem.add_child("<dl> </dl>").first.children.first
-    end
-
     def figure_label?(elem)
       elem.at(ns("./figure")) && !elem.at(ns("./name")) and return false
       true

data/lib/isodoc/presentation_function/inline.rb

@@ -39,16 +39,19 @@ module IsoDoc
     def anchor_id_postprocess(node); end
 
     def xref(docxml)
-      #docxml.xpath(ns("//display-text")).each { |f| f.replace(f.children) }
       docxml.xpath(ns("//fmt-xref")).each { |f| xref1(f) }
-      docxml.xpath(ns("//fmt-xref//fmt-xref")).each { |f| f.replace(f.children) }
+      docxml.xpath(ns("//fmt-xref//fmt-xref")).each do |f|
+        f.replace(f.children)
+      end
       docxml.xpath(ns("//fmt-xref//xref")).each { |f| f.replace(f.children) }
     end
 
     def eref(docxml)
       docxml.xpath(ns("//eref[@deleteme]")).each { |f| redundant_eref(f) }
       docxml.xpath(ns("//fmt-eref")).each { |f| xref1(f) }
-      docxml.xpath(ns("//fmt-eref//fmt-xref")).each { |f| f.replace(f.children) }
+      docxml.xpath(ns("//fmt-eref//fmt-xref")).each do |f|
+        f.replace(f.children)
+      end
       docxml.xpath(ns("//erefstack")).each { |f| erefstack1(f) }
     end
 
@@ -65,19 +68,14 @@ module IsoDoc
       docxml.xpath(ns("//fmt-origin[not(.//termref)]")).each { |f| xref1(f) }
     end
 
-    # KILL
-    def quotesourcex(docxml)
-      docxml.xpath(ns("//quote//source")).each { |f| xref1(f) }
-      docxml.xpath(ns("//quote//source//xref")).each do |f|
-        f.replace(f.children)
-      end
-    end
-
     # do not change to Presentation XML rendering
     def sem_xml_descendant?(node)
       !node.ancestors("preferred, admitted, deprecated, related, " \
         "definition, termsource").empty? and return true
       !node.ancestors("xref, eref, origin, link").empty? and return true
+      !node.ancestors("name, title").empty? and return true
+      node.ancestors("bibitem") &&
+        !node.ancestors("formattedref, biblio-tag") and return true
       !node.ancestors("requirement, recommendation, permission").empty? &&
         node.ancestors("fmt-provision").empty? and return true
       false
@@ -112,8 +110,8 @@ module IsoDoc
       docxml.xpath(ns("//identifier")).each do |n|
         %w(bibdata bibitem requirement recommendation permission)
           .include?(n.parent.name) and next
-          s = semx_fmt_dup(n)
-          n.next = "<fmt-identifier><tt>#{to_xml(s)}</tt></fmt-identifier>"
+        s = semx_fmt_dup(n)
+        n.next = "<fmt-identifier><tt>#{to_xml(s)}</tt></fmt-identifier>"
       end
     end
 

data/lib/isodoc/presentation_function/refs.rb

@@ -86,10 +86,15 @@ module IsoDoc
     def bibrender_formattedref(formattedref, xml); end
 
     def bibrender_relaton(xml, renderings)
-      f = renderings[xml["id"]][:formattedref]
+      f = renderings[xml["id"]][:formattedref] or return
       f &&= "<formattedref>#{f}</formattedref>"
-      x = xml.xpath(ns("./docidentifier | ./uri | ./note | ./biblio-tag"))
-      xml.children = "#{f}#{x.to_xml}"
+      if x = xml.at(ns("./formattedref"))
+        x.replace(f)
+      elsif xml.children.empty?
+        xml << f
+      else
+        xml.children.first.previous = f
+      end
     end
 
     def citestyle
@@ -205,7 +210,7 @@ module IsoDoc
       ret = ident_fn(bib)
       date_note = bib.at(ns("./note[@type = 'Unpublished-Status']"))
       date_note.nil? and return ret
-      id = UUIDTools::UUID.random_create.to_s
+      id = "_#{UUIDTools::UUID.random_create}"
       "#{ret}<fn reference='#{id}'><p>#{date_note.content}</p></fn>"
     end
 

data/lib/isodoc/presentation_function/sourcecode.rb

@@ -42,7 +42,7 @@ module IsoDoc
       sourcehighlighter_css(docxml)
       @highlighter = sourcehighlighter
       @callouts = {}
-      (docxml.xpath(ns("//sourcecode")) - 
+      (docxml.xpath(ns("//sourcecode")) -
        docxml.xpath(ns("//metanorma-extension//sourcecode")))
         .each do |f|
         sourcecode1(f)
@@ -52,7 +52,6 @@ module IsoDoc
     def sourcecode1(elem)
       ret1 = semx_fmt_dup(elem)
       b = ret1.at(ns(".//body")) and b.replace(b.children)
-      #sourcecode_annot_id(elem)
       source_label(elem)
       source_highlight(ret1, elem["linenums"] == "true", elem["lang"])
       callouts(elem)
@@ -68,25 +67,11 @@ module IsoDoc
       elem << ret
     end
 
-    # KILL
-    def sourcecode_annot_id(elem)
-      elem.xpath(ns("./annotation")).each do |a|
-        if a["original-id"]
-          a["id"] = a["original-id"]
-          a.delete("original-id")
-        end
-          a.xpath(".//*[@original-id]").each do |n|
-            n["id"] = n["original-id"]
-          n.delete("original-id")
-          end
-        end
-    end
-
     def annotations(elem, fmt_elem)
       elem.at(ns("./annotation")) or return
       ret = ""
       elem.xpath(ns("./annotation")).each do |a|
-        id = a['original-id']
+        id = a["original-id"]
         dd = semx_fmt_dup(a)
         dd["source"] = a["id"]
         ret += <<~OUT
@@ -183,8 +168,6 @@ module IsoDoc
     def source_label(elem)
       if !labelled_ancestor(elem) && # do not number if labelled_ancestor
           lbl = @xrefs.anchor(elem["id"], :label, false)
-        #a = autonum(elem["id"], lbl)
-        #s = "<span class='fmt-element-name'>#{lower2cap @i18n.figure}</span> #{a}"
         s = labelled_autonum(lower2cap(@i18n.figure), elem["id"], lbl)&.strip
       end
       prefix_name(elem, { caption: block_delim }, s, "name")

data/lib/isodoc/presentation_xml_convert.rb

@@ -10,6 +10,7 @@ require_relative "presentation_function/section"
 require_relative "presentation_function/index"
 require_relative "presentation_function/bibdata"
 require_relative "presentation_function/metadata"
+require_relative "presentation_function/footnotes"
 
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
@@ -85,7 +86,8 @@ module IsoDoc
       floattitle docxml # feeds rearrange_clauses
       index docxml # fed by strip_duplicate_ids
       toc docxml
-      display_order docxml
+      display_order docxml # feeds document_footnotes
+      document_footnotes docxml
     end
 
     def block(docxml)

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "3.1.0".freeze
+  VERSION = "3.1.2".freeze
 end

data/lib/isodoc/word_function/body.rb

@@ -51,7 +51,7 @@ module IsoDoc
       def make_body3(body, docxml)
         body.div class: "WordSection3" do |div3|
           content(div3, docxml, ns(self.class::MAIN_ELEMENTS))
-          footnotes div3
+          footnotes docxml, div3
           comments div3
         end
       end
@@ -79,7 +79,8 @@ module IsoDoc
         node.xpath(ns("./note")).each { |n| parse(n, out) }
       end
 
-      def figure_get_or_make_dl(node)
+      # KILL
+      def figure_get_or_make_dlx(node)
         dl = node.at(".//table[@class = 'dl']")
         if dl.nil?
           node.add_child("<p><b>#{@i18n.key}</b></p><table class='dl'></table>")
@@ -89,7 +90,8 @@ module IsoDoc
       end
 
       # get rid of footnote link, it is in diagram
-      def figure_aside_process(fig, aside, key)
+      # KILL
+      def figure_aside_processx(fig, aside, key)
         fig.at("./a[@class='TableFootnoteRef']")&.remove
         fnref = fig.at(".//span[@class='TableFootnoteRef']/..")
         tr = key.add_child("<tr></tr>").first