isodoc 2.10.0 → 3.0.0

data/lib/isodoc/presentation_function/refs.rb

@@ -1,3 +1,5 @@
+require_relative "docid"
+
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def references(docxml)
@@ -5,27 +7,49 @@ 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)
       docxml.at(ns(@xrefs.klass.norm_ref_xpath)) or return
-      s = docxml.at(ns("//sections")) ||
-        docxml.at(ns("//preface"))&.after("<sections/>")&.next_element ||
-        docxml.at(ns("//annex | //bibliography"))&.before("<sections/>")
-          &.previous_element or return
+      s = move_norm_ref_to_sections_insert_pt(docxml) or return
       docxml.xpath(ns(@xrefs.klass.norm_ref_xpath)).each do |r|
+        r.at("./ancestor::xmlns:bibliography") or next
         s << r.remove
       end
     end
 
+    def move_norm_ref_to_sections_insert_pt(docxml)
+      s = docxml.at(ns("//sections")) and return s
+      s = docxml.at(ns("//preface")) and
+        return s.after("<sections/>").next_element
+      docxml.at(ns("//annex | //bibliography"))&.before("<sections/>")
+        &.previous_element
+    end
+
     def hidden_items(docxml)
       docxml.xpath(ns("//references[bibitem/@hidden = 'true']")).each do |x|
         x.at(ns("./bibitem[not(@hidden = 'true')]")) and next
-        x.elements.map(&:name).any? { |n| n != "bibitem" } and next
+        x.elements.map(&:name).any? do |n|
+          !%w(title bibitem).include?(n)
+        end and next
         x["hidden"] = "true"
       end
     end
@@ -48,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
 
@@ -73,27 +97,30 @@ 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["suppress_identifier"] == "true" ||
         bibitem["hidden"] == "true" || bibitem.parent["hidden"] == "true"
     end
 
     def bibliography_bibitem_number(docxml)
       i = 0
-      docxml.xpath(ns("//references[@normative = 'false']/bibitem")).each do |b|
-        i = bibliography_bibitem_number1(b, i)
+      docxml.xpath(ns("//references")).each do |r|
+        r.xpath(ns("./bibitem")).each do |b|
+          i = bibliography_bibitem_number1(b, i, r["normative"] == "true")
+        end
       end
-      @xrefs.references docxml
+      reference_names docxml
       bibliography_bibitem_tag(docxml)
     end
 
-    def bibliography_bibitem_number1(bibitem, idx)
+    def bibliography_bibitem_number1(bibitem, idx, normative)
       ins = bibliography_bibitem_number_insert_pt(bibitem)
       mn = bibitem.at(ns(".//docidentifier[@type = 'metanorma']")) and
-        /^\[?\d+\]?$/.match?(mn.text) and
-        mn.remove # ignore numbers already inserted
-      unless bibliography_bibitem_number_skip(bibitem)
+        /^\[?\d+\]?$/.match?(mn.text) and mn.remove # ignore numbers already inserted
+      if !bibliography_bibitem_number_skip(bibitem) && (!normative || mn)
+        # respect numeric ids in normative only if already inserted
         idx += 1
         ins.next =
           "<docidentifier type='metanorma-ordinal'>[#{idx}]</docidentifier>"
@@ -102,17 +129,16 @@ module IsoDoc
     end
 
     def bibliography_bibitem_number_insert_pt(bibitem)
-      unless ins = bibitem.at(ns(".//docidentifier")).previous_element
-        bibitem.at(ns(".//docidentifier")).previous = " "
-        ins = bibitem.at(ns(".//docidentifier")).previous
+      bibitem.children.empty? and bibitem.add_child(" ")
+      unless d = bibitem.at(ns(".//docidentifier"))
+        d = bibitem.children.first
+        d.previous = " " and return d.previous
       end
-      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))
+      unless ins = d.previous_element
+        d.previous = " "
+        ins = d.previous
       end
+      ins
     end
 
     def bibliography_bibitem_tag(docxml)
@@ -126,17 +152,18 @@ 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
+        b["suppress_identifier"] == "true" 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,
@@ -186,5 +213,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

@@ -2,26 +2,29 @@ module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def recommendation(docxml)
       docxml.xpath(ns("//recommendation")).each do |f|
-        recommendation1(f, lower2cap(@i18n.recommendation))
+        recommendation1(f, lower2cap(f["class"]) ||
+                        lower2cap(@i18n.recommendation))
       end
     end
 
     def requirement(docxml)
       docxml.xpath(ns("//requirement")).each do |f|
-        recommendation1(f, lower2cap(@i18n.requirement))
+        recommendation1(f, lower2cap(f["class"]) ||
+                        lower2cap(@i18n.requirement))
       end
     end
 
     def permission(docxml)
       docxml.xpath(ns("//permission")).each do |f|
-        recommendation1(f, lower2cap(@i18n.permission))
+        recommendation1(f, lower2cap(f["class"]) ||
+                        lower2cap(@i18n.permission))
       end
     end
 
     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,54 +1,42 @@
 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.children.first.previous =
-        "<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
-
         clause1(f)
       end
     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
+    def unnumbered_clause?(elem)
       !elem.ancestors("boilerplate, metanorma-extension").empty? ||
-        @suppressheadingnumbers || elem["unnumbered"] 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 do |f|
-        floattitle1(f)
-      end
-      # top-level
-      docxml.xpath(ns("//sections | //preface | //colophon"))
-        .each { |f| floattitle1(f) }
+        @suppressheadingnumbers || elem["unnumbered"] ||
+        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 floattitle1(elem)
-      elem.xpath(ns(".//floating-title")).each do |p|
-        p.name = "p"
-        p["type"] = "floating-title"
+    def clause1(elem)
+      level = @xrefs.anchor(elem["id"], :level, false) ||
+        (elem.ancestors("clause, annex").size + 1)
+      lbl = @xrefs.anchor(elem["id"], :label, !unnumbered_clause?(elem))
+      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)
@@ -61,11 +49,19 @@ module IsoDoc
     end
 
     def annex1(elem)
-      lbl = @xrefs.anchor(elem["id"], :label)
-      if t = elem.at(ns("./title"))
+      lbl = @xrefs.anchor(elem["id"], :label, false)
+      # TODO: do not alter title, alter semx/@element = title
+      t = elem.at(ns("./title")) and
         t.children = "<strong>#{to_xml(t.children)}</strong>"
+      if unnumbered_clause?(elem)
+        prefix_name(elem, {}, nil, "title")
+      else
+        prefix_name(elem, { caption: annex_delim(elem) }, lbl, "title")
       end
-      prefix_name(elem, "<br/><br/>", lbl, "title")
+    end
+
+    def annex_delim(_elem)
+      "<br/><br/>"
     end
 
     def single_term_clause_retitle(elem)
@@ -80,28 +76,18 @@ 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)
+    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
@@ -110,6 +96,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
@@ -117,19 +104,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)
@@ -143,98 +117,46 @@ 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)
       preface.elements.each do |x|
         ((x.name == "floating-title" || x.at(xpath)) &&
         xpath != "./self::*[not(following-sibling::*)]") or prev = x
-        # after.include?(x.name) or next
         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
@@ -242,7 +164,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.children.first.previous = "#{lbl}<tab/>"
+        x.add_first_child "#{lbl}<span class='fmt-caption-delim'><tab/></span>"
       end
     end
   end

data/lib/isodoc/presentation_function/sourcecode.rb

@@ -34,7 +34,7 @@ module IsoDoc
 
     def callouts(elem)
       elem.xpath(ns(".//callout")).each do |c|
-        @callouts[c["target"]] = c.children.to_xml
+        @callouts[c["target"]] = to_xml(c.children)
       end
     end
 
@@ -42,36 +42,66 @@ module IsoDoc
       sourcehighlighter_css(docxml)
       @highlighter = sourcehighlighter
       @callouts = {}
-      docxml.xpath(ns("//sourcecode")).each do |f|
+      (docxml.xpath(ns("//sourcecode")) - 
+       docxml.xpath(ns("//metanorma-extension//sourcecode")))
+        .each do |f|
         sourcecode1(f)
       end
     end
 
     def sourcecode1(elem)
-      source_highlight(elem)
+      ret1 = semx_fmt_dup(elem)
+      #sourcecode_annot_id(elem)
       source_label(elem)
+      source_highlight(ret1, elem["linenums"] == "true", elem["lang"])
       callouts(elem)
-      annotations(elem)
+      annotations(elem, ret1)
+      fmt_sourcecode(elem, ret1)
     end
 
-    def annotations(elem)
+    def fmt_sourcecode(elem, ret1)
+      ret = Nokogiri::XML::Node.new("fmt-#{elem.name}", elem.document)
+      elem.attributes.each_key { |x| x != "id" and ret[x] = elem[x] }
+      ret1.xpath(ns("./name")).each(&:remove)
+      ret << ret1.children
+      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|
-        a.remove
+        id = a['original-id']
+        dd = semx_fmt_dup(a)
+        dd["source"] = a["id"]
         ret += <<~OUT
-          <dt id='#{a['id']}'><span class='c'>#{@callouts[a['id']]}</span></dt>
-          <dd>#{a.children.to_xml}</dd>
+          <dt id='#{id}'><span class='c'>#{@callouts[id]}</span></dt>
+          <dd>#{to_xml dd}</dd>
         OUT
       end
-      elem << "<dl><name>#{@i18n.key}</name>#{ret}</dl>"
+      fmt_elem.xpath(ns("./annotation")).each(&:remove)
+      fmt_elem << "<dl><name>#{@i18n.key}</name>#{ret}</dl>"
     end
 
-    def source_highlight(elem)
+    def source_highlight(elem, linenums, lang)
       @highlighter or return
       markup = source_remove_markup(elem)
-      p = source_lex(elem)
-      elem.children = if elem["linenums"] == "true"
+      p = source_lex(elem, lang)
+      elem.children = if linenums
                         r = sourcecode_table_to_elem(elem, p)
                         source_restore_markup_table(r, markup)
                       else
@@ -140,9 +170,9 @@ module IsoDoc
       r
     end
 
-    def source_lex(elem)
-      lexer = (Rouge::Lexer.find(elem["lang"] || "plaintext") ||
-       Rouge::Lexer.find("plaintext"))
+    def source_lex(elem, lang)
+      lexer = Rouge::Lexer.find(lang || "plaintext") ||
+        Rouge::Lexer.find("plaintext")
       l = Rouge::Lexers::Escape.new(start: "{^^{", end: "}^^}", lang: lexer)
       source = to_xml(elem.children).gsub(/</, "{^^{<").gsub(/>/, ">}^^}")
       l.lang.reset!
@@ -150,10 +180,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