isodoc 2.12.0 → 2.12.2

data/lib/isodoc/presentation_function/metadata.rb

@@ -4,7 +4,6 @@ module IsoDoc
       toc_metadata(docxml)
       fonts_metadata(docxml)
       attachments_extract(docxml)
-      preprocess_xslt_insert(docxml)
       localized_strings(docxml)
       a = docxml.at(ns("//metanorma-extension")) or return
       a.elements.empty? and a.remove
@@ -83,67 +82,6 @@ module IsoDoc
         "</presentation-metadata>"
     end
 
-    def preprocess_xslt_insert(docxml)
-      content = ""
-      p = passthrough_xslt and content += p
-      p = preprocess_xslt_read and content += File.read(p)
-      content.empty? and return
-      ins = extension_insert(docxml, %w(render))
-      ins << content
-    end
-
-    COPY_XSLT =
-      '<xsl:copy><xsl:apply-templates select="@* | node()"/></xsl:copy>'.freeze
-    COPY_CHILDREN_XSLT =
-      '<xsl:apply-templates select="node()"/>'.freeze
-
-    def xslt_template(content)
-      <<~XSLT
-        <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" version="1.0">
-          <xsl:output method="xml" version="1.0" encoding="UTF-8" indent="no"/>
-          <xsl:template match="@* | node()">#{COPY_XSLT}</xsl:template>
-        #{content}
-        </xsl:stylesheet>
-      XSLT
-    end
-
-    def passthrough_xslt
-      @output_formats.nil? and return nil
-      @output_formats.empty? and return nil
-      @output_formats.each_key.with_object([]) do |k, m|
-        m << <<~XSLT
-          <preprocess-xslt format="#{k}">
-            #{xslt_template(<<~XSLT1)
-              <xsl:template match="*[local-name() = 'passthrough']">
-                <xsl:if test="contains(@formats,',#{k},')"> <!-- delimited -->
-                #{COPY_XSLT}
-                </xsl:if>
-              </xsl:template>
-            XSLT1
-            }
-          </preprocess-xslt>
-        XSLT
-        m << <<~XSLT
-          <preprocess-xslt format="#{k}">
-            #{xslt_template(<<~XSLT1)
-              <xsl:template match="*[local-name() = 'math-with-linebreak']">
-              #{k == 'pdf' ? COPY_CHILDREN_XSLT : ''}
-              </xsl:template>
-              <xsl:template match="*[local-name() = 'math-no-linebreak']">
-              #{k == 'pdf' ? '' : COPY_CHILDREN_XSLT}
-              </xsl:template>
-            XSLT1
-            }
-          </preprocess-xslt>
-        XSLT
-      end.join("\n")
-    end
-
-    # read in from file, but with `<preprocess-xslt @format="">` wrapper
-    def preprocess_xslt_read
-      html_doc_path("preprocess.xslt")
-    end
-
     def i18n_tag(key, value)
       "<localized-string key='#{key}' language='#{@lang}'>#{value}" \
         "</localized-string>"

data/lib/isodoc/presentation_function/refs.rb

@@ -1,3 +1,5 @@
+require_relative "docid"
+
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def references(docxml)
@@ -5,10 +7,24 @@ module IsoDoc
       renderings = references_render(docxml)
       docxml.xpath(ns("//references/bibitem")).each do |x|
         bibitem(x, renderings)
+        reference_name(x)
       end
       hidden_items(docxml)
       move_norm_ref_to_sections(docxml)
-      @xrefs.parse_inclusions(refs: true).parse(docxml)
+    end
+
+    def reference_names(docxml)
+      docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |ref|
+        reference_name(ref)
+      end
+    end
+
+    def reference_name(ref)
+      ids = bibitem_ref_code(ref)
+      identifiers = render_identifier(ids)
+      reference = docid_l10n(identifiers[:metanorma] || identifiers[:sdo] ||
+                    identifiers[:ordinal] || identifiers[:doi])
+      @xrefs.get[ref["id"]] = { xref: reference }
     end
 
     def move_norm_ref_to_sections(docxml)
@@ -56,7 +72,7 @@ module IsoDoc
     end
 
     def bibitem(xml, renderings)
-      @xrefs.klass.implicit_reference(xml) and xml["hidden"] = "true"
+      implicit_reference(xml) and xml["hidden"] = "true"
       bibrender_item(xml, renderings)
     end
 
@@ -81,7 +97,7 @@ module IsoDoc
     end
 
     def bibliography_bibitem_number_skip(bibitem)
-      @xrefs.klass.implicit_reference(bibitem) ||
+      implicit_reference(bibitem) ||
         bibitem.at(ns(".//docidentifier[@type = 'metanorma']")) ||
         bibitem.at(ns(".//docidentifier[@type = 'metanorma-ordinal']")) ||
         bibitem["hidden"] == "true" || bibitem.parent["hidden"] == "true"
@@ -92,7 +108,7 @@ module IsoDoc
       docxml.xpath(ns("//references[@normative = 'false']/bibitem")).each do |b|
         i = bibliography_bibitem_number1(b, i)
       end
-      @xrefs.references docxml
+      reference_names docxml
       bibliography_bibitem_tag(docxml)
     end
 
@@ -122,12 +138,6 @@ module IsoDoc
       ins
     end
 
-    def docid_prefixes(docxml)
-      docxml.xpath(ns("//references/bibitem/docidentifier")).each do |i|
-        i.children = @xrefs.klass.docid_prefix(i["type"], to_xml(i.children))
-      end
-    end
-
     def bibliography_bibitem_tag(docxml)
       [true, false].each do |norm|
         i = 0
@@ -139,17 +149,17 @@ module IsoDoc
 
     def bibliography_bibitem_tag1(ref, idx, norm)
       ref.xpath(ns("./bibitem")).each do |b|
-        @xrefs.klass.implicit_reference(b) and next
+        implicit_reference(b) and next
         idx += 1 unless b["hidden"]
-        insert_biblio_tag(b, idx, !norm, @xrefs.klass.standard?(b))
+        insert_biblio_tag(b, idx, !norm, standard?(b))
       end
       idx
     end
 
     def insert_biblio_tag(bib, ordinal, biblio, standard)
       datefn = date_note_process(bib)
-      ids = @xrefs.klass.bibitem_ref_code(bib)
-      idents = @xrefs.klass.render_identifier(ids)
+      ids = bibitem_ref_code(bib)
+      idents = render_identifier(ids)
       ret = if biblio then biblio_ref_entry_code(ordinal, idents, ids,
                                                  standard, datefn, bib)
             else norm_ref_entry_code(ordinal, idents, ids, standard, datefn,
@@ -199,5 +209,25 @@ module IsoDoc
       ret = bib.at(ns("./docidentifier//fn")) or return ""
       to_xml(ret.remove)
     end
+
+    # reference not to be rendered because it is deemed implicit
+    # in the standards environment
+    def implicit_reference(bib)
+      bib["hidden"] == "true"
+    end
+
+    SKIP_DOCID = <<~XPATH.strip.freeze
+      @type = 'DOI' or @type = 'doi' or @type = 'ISSN' or @type = 'issn' or @type = 'ISBN' or @type = 'isbn' or starts-with(@type, 'ISSN.') or starts-with(@type, 'ISBN.') or starts-with(@type, 'issn.') or starts-with(@type, 'isbn.')
+    XPATH
+
+    def standard?(bib)
+      ret = false
+      bib.xpath(ns("./docidentifier")).each do |id|
+        id["type"].nil? ||
+          id.at(".//self::*[#{SKIP_DOCID} or @type = 'metanorma']") and next
+        ret = true
+      end
+      ret
+    end
   end
 end

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

data/lib/isodoc/presentation_function/section.rb

@@ -1,17 +1,12 @@
 require_relative "refs"
+require_relative "title"
 
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
-    def middle_title(docxml)
-      s = docxml.at(ns("//sections")) or return
-      t = @meta.get[:doctitle]
-      t.nil? || t.empty? and return
-      s.add_first_child "<p class='zzSTDTitle1'>#{t}</p>"
-    end
-
     def clause(docxml)
-      docxml.xpath(ns("//clause | " \
-                      "//terms | //definitions | //references"))
+      docxml.xpath(ns("//clause | //terms | //definitions | //references | " \
+                      "//introduction | //foreword | //preface/abstract | " \
+                      "//acknowledgements | //colophon | //indexsect "))
         .each do |f|
         f.parent.name == "annex" &&
           @xrefs.klass.single_term_clause?(f.parent) and next
@@ -25,32 +20,23 @@ module IsoDoc
         elem.at("./ancestor::*[@unnumbered = 'true']")
     end
 
+    def clausedelim
+      ret = super
+      ret && !ret.empty? or return ret
+      "<span class='fmt-autonum-delim'>#{ret}</span>"
+    end
+
     def clause1(elem)
       level = @xrefs.anchor(elem["id"], :level, false) ||
         (elem.ancestors("clause, annex").size + 1)
-      t = elem.at(ns("./title")) and t["depth"] = level
-      unnumbered_clause?(elem) and return
-      lbl = @xrefs.anchor(elem["id"], :label,
-                          elem.parent.name != "sections") or return
-      prefix_name(elem, "<tab/>", "#{lbl}#{clausedelim}", "title")
-    end
-
-    def floattitle(docxml)
-      p = "//clause | //annex | //appendix | //introduction | //foreword | " \
-          "//preface/abstract | //acknowledgements | //terms | " \
-          "//definitions | //references | //colophon | //indexsect"
-      docxml.xpath(ns(p)).each { |f| floattitle1(f) }
-      # top-level
-      docxml.xpath(ns("//sections | //preface | //colophon"))
-        .each { |f| floattitle1(f) }
-    end
-
-    # TODO not currently doing anything with the @depth attribute of floating-title
-    def floattitle1(elem)
-      elem.xpath(ns(".//floating-title")).each do |p|
-        p.name = "p"
-        p["type"] = "floating-title"
+      lbl = @xrefs.anchor(elem["id"], :label, elem.parent.name != "sections")
+      if unnumbered_clause?(elem) || !lbl
+        prefix_name(elem, {}, nil, "title")
+      else
+        prefix_name(elem, { caption: "<tab/>" }, "#{lbl}#{clausedelim}",
+                    "title")
       end
+      t = elem.at(ns("./fmt-title")) and t["depth"] = level
     end
 
     def annex(docxml)
@@ -64,10 +50,18 @@ module IsoDoc
 
     def annex1(elem)
       lbl = @xrefs.anchor(elem["id"], :label)
+      # TODO: do not alter title, alter semx/@element = title
       t = elem.at(ns("./title")) and
         t.children = "<strong>#{to_xml(t.children)}</strong>"
-      unnumbered_clause?(elem) and return
-      prefix_name(elem, "<br/><br/>", lbl, "title")
+      if unnumbered_clause?(elem)
+        prefix_name(elem, {}, nil, "title")
+      else
+        prefix_name(elem, { caption: annex_delim(elem) }, lbl, "title")
+      end
+    end
+
+    def annex_delim(_elem)
+      "<br/><br/>"
     end
 
     def single_term_clause_retitle(elem)
@@ -82,28 +76,22 @@ module IsoDoc
       t = elem.at(ns("./terms | ./definitions | ./references"))
       t.xpath(ns(".//clause | .//terms | .//definitions | .//references"))
         .each do |c|
-          tit = c.at(ns("./title")) or return
+          tit = c.at(ns("./fmt-title")) or next
           tit["depth"] = tit["depth"].to_i - 1 unless tit["depth"] == "1"
         end
     end
 
-    def term(docxml)
-      docxml.xpath(ns("//term")).each do |f|
-        term1(f)
-      end
-    end
-
-    def term1(elem)
-      lbl = @xrefs.anchor(elem["id"], :label) or return
-      prefix_name(elem, "", "#{lbl}#{clausedelim}", "name")
-    end
-
     def index(docxml)
       docxml.xpath(ns("//index | //index-xref | //indexsect")).each(&:remove)
     end
 
+    def skip_display_order?(node)
+      node.name == "floating-title"
+    end
+
     def display_order_at(docxml, xpath, idx)
       c = docxml.at(ns(xpath)) or return idx
+      skip_display_order?(c) and return idx
       idx += 1
       idx = preceding_floating_titles(c, idx)
       c["displayorder"] = idx
@@ -112,6 +100,7 @@ module IsoDoc
 
     def display_order_xpath(docxml, xpath, idx)
       docxml.xpath(ns(xpath)).each do |c|
+        skip_display_order?(c) and next
         idx += 1
         idx = preceding_floating_titles(c, idx)
         c["displayorder"] = idx
@@ -119,19 +108,6 @@ module IsoDoc
       idx
     end
 
-    def preceding_floating_titles(node, idx)
-      out = node.xpath("./preceding-sibling::*")
-        .reverse.each_with_object([]) do |p, m|
-        %w(note admonition p).include?(p.name) or break m
-        m << p
-      end
-      out.reject { |c| c["displayorder"] }.reverse_each do |c|
-        c["displayorder"] = idx
-        idx += 1
-      end
-      idx
-    end
-
     def display_order(docxml)
       i = 0
       d = @xrefs.clause_order(docxml)
@@ -145,46 +121,26 @@ module IsoDoc
       end
     end
 
-    def clausetitle(docxml)
-      cjk_extended_title(docxml)
-    end
-
-    def cjk_search
-      lang = %w(zh ja ko).map { |x| "@language = '#{x}'" }.join(" or ")
-      %(Hans Hant Jpan Hang Kore).include?(@script) and
-        lang += " or not(@language)"
-      lang
-    end
-
-    def cjk_extended_title(docxml)
-      l = cjk_search
-      docxml.xpath(ns("//bibdata/title[#{l}] | //floating-title[#{l}] | " \
-                      "//title[@depth = '1' or not(@depth)][#{l}]")).each do |t|
-        t.text.size < 4 or next
-        t.elements.empty? or next # can't be bothered
-        t.children = @i18n.cjk_extend(t.text)
-      end
-    end
-
     def preface_rearrange(doc)
-      preface_move(doc.at(ns("//preface/abstract")),
+      preface_move(doc.xpath(ns("//preface/abstract")),
                    %w(foreword introduction clause acknowledgements), doc)
-      preface_move(doc.at(ns("//preface/foreword")),
+      preface_move(doc.xpath(ns("//preface/foreword")),
                    %w(introduction clause acknowledgements), doc)
-      preface_move(doc.at(ns("//preface/introduction")),
+      preface_move(doc.xpath(ns("//preface/introduction")),
                    %w(clause acknowledgements), doc)
-      preface_move(doc.at(ns("//preface/acknowledgements")),
+      preface_move(doc.xpath(ns("//preface/acknowledgements")),
                    %w(), doc)
     end
 
-    def preface_move(clause, after, _doc)
-      clause or return
-      preface = clause.parent
+    def preface_move(clauses, after, _doc)
+      clauses.empty? and return
+      preface = clauses.first.parent
+      clauses.each do |clause|
       float = preceding_floats(clause)
-      prev = nil
       xpath = after.map { |n| "./self::xmlns:#{n}" }.join(" | ")
       xpath.empty? and xpath = "./self::*[not(following-sibling::*)]"
-      preface_move1(clause, preface, float, prev, xpath)
+      preface_move1(clause, preface, float, nil, xpath)
+      end
     end
 
     def preface_move1(clause, preface, float, prev, xpath)
@@ -194,48 +150,17 @@ module IsoDoc
         x.at(xpath) or next
         clause == prev and break
         prev ||= preface.children.first
-        float << clause
+        prev.next = clause
         float.each { |n| prev.next = n }
         break
       end
     end
 
-    def preceding_floats(clause)
-      ret = []
-      p = clause
-      while prev = p.previous_element
-        if prev.name == "floating-title"
-          ret << prev
-          p = prev
-        else break
-        end
-      end
-      ret
-    end
-
     def rearrange_clauses(docxml)
       preface_rearrange(docxml) # feeds toc_title
       toc_title(docxml)
     end
 
-    def toc_title(docxml)
-      docxml.at(ns("//preface/clause[@type = 'toc']")) and return
-      ins = toc_title_insert_pt(docxml) or return
-      id = UUIDTools::UUID.random_create.to_s
-      ins.previous = <<~CLAUSE
-        <clause type = 'toc' id='_#{id}'><title depth='1'>#{@i18n.table_of_contents}</title></clause>
-      CLAUSE
-    end
-
-    def toc_title_insert_pt(docxml)
-      ins = docxml.at(ns("//preface")) ||
-        docxml.at(ns("//sections | //annex | //bibliography"))
-          &.before("<preface> </preface>")
-          &.previous_element or return nil
-      ins.children.empty? and ins << " "
-      ins.children.first
-    end
-
     def toc(docxml)
       toc_refs(docxml)
     end
@@ -243,7 +168,7 @@ module IsoDoc
     def toc_refs(docxml)
       docxml.xpath(ns("//toc//xref[text()]")).each do |x|
         lbl = @xrefs.anchor(x["target"], :label) or next
-        x.add_first_child "#{lbl}<tab/>"
+        x.add_first_child "#{lbl}<span class='fmt-caption-delim'><tab/></span>"
       end
     end
   end

data/lib/isodoc/presentation_function/sourcecode.rb

@@ -150,10 +150,13 @@ module IsoDoc
     end
 
     def source_label(elem)
-      labelled_ancestor(elem) and return
-      lbl = @xrefs.anchor(elem["id"], :label, false) or return
-      prefix_name(elem, block_delim,
-                  l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
+      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")
     end
   end
 end

data/lib/isodoc/presentation_function/terms.rb

@@ -109,9 +109,17 @@ module IsoDoc
       docxml.xpath(ns("//termnote")).each { |f| termnote1(f) }
     end
 
+    def termnote_delim(_elem)
+      l10n(": ")
+    end
+
     def termnote1(elem)
-      lbl = l10n(@xrefs.anchor(elem["id"], :label) || "???")
-      prefix_name(elem, "", lower2cap(lbl), "name")
+      lbl = termnote_label(elem)
+      prefix_name(elem, { label: termnote_delim(elem) }, lower2cap(lbl), "name")
+    end
+
+    def termnote_label(elem)
+      @xrefs.anchor(elem["id"], :label) || "???"
     end
 
     def termdefinition(docxml)
@@ -123,6 +131,7 @@ module IsoDoc
     def termdefinition1(elem)
       unwrap_definition(elem)
       multidef(elem) if elem.xpath(ns("./definition")).size > 1
+      termdomain(elem)
     end
 
     def multidef(elem)
@@ -144,6 +153,13 @@ module IsoDoc
       end
     end
 
+    def termdomain(elem)
+      d = elem.at(ns(".//domain")) or return
+      p = elem.at(ns(".//definition//p")) or return
+      p.add_first_child "<#{d.to_xml}>  "
+      d["hidden"] = true
+    end
+
     def termsource(docxml)
       docxml.xpath(ns("//termsource")).each { |f| termsource_modification(f) }
       docxml.xpath(ns("//termsource")).each { |f| termsource1(f) }
@@ -176,5 +192,14 @@ module IsoDoc
       when "adapted" then @i18n.adapted
       end
     end
+
+    def term(docxml)
+      docxml.xpath(ns("//term")).each { |f| term1(f) }
+    end
+
+    def term1(elem)
+      lbl = @xrefs.anchor(elem["id"], :label) or return
+      prefix_name(elem, {}, "#{lbl}#{clausedelim}", "name")
+    end
   end
 end

data/lib/isodoc/presentation_function/title.rb

@@ -0,0 +1,107 @@
+require_relative "refs"
+
+module IsoDoc
+  class PresentationXMLConvert < ::IsoDoc::Convert
+    def middle_title(docxml)
+      s = docxml.at(ns("//sections")) or return
+      t = @meta.get[:doctitle]
+      t.nil? || t.empty? and return
+      s.add_first_child "<p class='zzSTDTitle1'>#{t}</p>"
+    end
+
+    def missing_title(docxml)
+      docxml.xpath(ns("//definitions[not(./title)]")).each do |d|
+        # should only be happening for subclauses
+        d.add_first_child "<title>#{@i18n.symbols}</title>"
+      end
+      docxml.xpath(ns("//foreword[not(./title)]")).each do |d|
+        d.add_first_child "<title>#{@i18n.foreword}</title>"
+      end
+    end
+
+    def floattitle(docxml)
+      docxml.xpath(ns(".//floating-title")).each { |f| floattitle1(f) }
+    end
+
+    # TODO not currently doing anything with the @depth attribute of floating-title
+    def floattitle1(elem)
+      elem["id"] ||= "_#{UUIDTools::UUID.random_create}"
+      p = elem.dup
+      p.children = "<semx element='floating-title' source='#{elem['id']}'>" \
+        "#{to_xml(p.children)}</semx>"
+      elem.next = p
+      p.name = "p"
+      p["type"] = "floating-title"
+      transfer_id(elem, p)
+    end
+
+    def preceding_floating_titles(node, idx)
+      out = node.xpath("./preceding-sibling::*")
+        .reverse.each_with_object([]) do |p, m|
+        %w(note admonition p floating-title).include?(p.name) or break m
+        m << p
+      end
+      #require 'debug'; out.empty? or binding.b
+      out.reject { |c| c["displayorder"] }.reverse_each do |c|
+          skip_display_order?(c) and next
+        c["displayorder"] = idx
+        idx += 1
+      end
+      idx
+    end
+
+    def clausetitle(docxml)
+      cjk_extended_title(docxml)
+    end
+
+    def cjk_search
+      lang = %w(zh ja ko).map { |x| "@language = '#{x}'" }.join(" or ")
+      %(Hans Hant Jpan Hang Kore).include?(@script) and
+        lang += " or not(@language)"
+      lang
+    end
+
+    def cjk_extended_title(doc)
+      l = cjk_search
+      doc.xpath(ns("//bibdata/title[#{l}] | //floating-title[#{l}] | " \
+                   "//fmt-title[@depth = '1' or not(@depth)][#{l}]"))
+        .each do |t|
+        t.text.size < 4 or next
+        t.traverse do |n|
+          n.text? or next
+          n.replace(@i18n.cjk_extend(n.text))
+        end
+      end
+    end
+
+    def preceding_floats(clause)
+      ret = []
+      p = clause
+      while prev = p.previous_element
+        if prev.name == "floating-title"
+          ret << prev
+          p = prev
+        else break end
+      end
+      ret
+    end
+
+    def toc_title(docxml)
+      docxml.at(ns("//preface/clause[@type = 'toc']")) and return
+      ins = toc_title_insert_pt(docxml) or return
+      id = UUIDTools::UUID.random_create.to_s
+      ins.previous = <<~CLAUSE
+        <clause type = 'toc' id='_#{id}'><fmt-title depth='1'>#{@i18n.table_of_contents}</fmt-title></clause>
+      CLAUSE
+    end
+
+    def toc_title_insert_pt(docxml)
+      ins = docxml.at(ns("//preface")) ||
+        docxml.at(ns("//sections | //annex | //bibliography"))
+          &.before("<preface> </preface>")
+          &.previous_element or return nil
+      ins.children.empty? and ins << " "
+      ins.children.first
+    end
+  end
+end