isodoc 2.12.6 → 2.12.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48457f7d76baef2d4d349f569e3ee43049253bc9955d50f5c6584d9e8fa2367b
-  data.tar.gz: d87899d14231920e9f2709f2ed5101049e3f0132e2f43f76a67e704c82b91309
+  metadata.gz: 5f9a52529adbedd3c9bfc375db556ea9402a7fcd7e384ccff66c70a2aeb2c964
+  data.tar.gz: 11533489300d99ed35875d79d7327e9acf918ffb4b7bd48552e870b303ce9be5
 SHA512:
-  metadata.gz: c9f54cf72607cca29215845a2f36ca6de3a74d91a97f002157cf8c09a5baeaf37b2b71dddf2eb91eef3b1ea1c4677ebfc3f3cbfc4fee7bc97cc5d1537b43f925
-  data.tar.gz: f0923719cd684e18c2879de8d1477c17b05fb5b3c5e2597a8189371db49aa59c531a863f96808dcc546b5bd709f3799b3dedac6dc3cf9b96ce5aeef25dda4c19
+  metadata.gz: 1fce7b6367b473390f95f062965d6c456c684e5eb5b3ad65622e3cb880e7aa3230f33ea11f7dd4d471c6125843747831e03742b2e17abc220ea9ed0995ee5c14
+  data.tar.gz: a3d34d1c3e98b88451073fe6cd585bbcec1e7c40964bd31cba17494934c864460269ca2c77db9803461448405019800ce731fbff7fef8c560bdb05196c35cc97

data/isodoc.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mn2pdf", ">= 2.08"
   spec.add_dependency "mn-requirements", "~> 0.4.0"
 
-  spec.add_dependency "relaton-render", "~> 0.8.0"
+  spec.add_dependency "relaton-render", "~> 0.9.0"
   spec.add_dependency "roman-numerals"
   spec.add_dependency "rouge", "~> 4.0"
   spec.add_dependency "thread_safe"

data/lib/isodoc/presentation_function/docid.rb

@@ -9,7 +9,7 @@ module IsoDoc
     def pref_ref_code(bib)
       bib["suppress_identifier"] == "true" and return nil
       ret = bib.xpath(ns("./docidentifier[@scope = 'biblio-tag']"))
-      ret.empty? or return ret.map(&:text)
+      ret.empty? or return ret.map { |x| to_xml(x.children) }
       ret = pref_ref_code_parse(bib) or return nil
       ins = bib.at(ns("./docidentifier[last()]"))
       ret.reverse_each do |r|
@@ -50,14 +50,14 @@ module IsoDoc
 
     def bracket_if_num(num)
       num.nil? and return nil
-      num = num.text.sub(/^\[/, "").sub(/\]$/, "")
+      num = to_xml(num.children).sub(/^\[/, "").sub(/\]$/, "")
       /^\d+$/.match?(num) and return "[#{num}]"
       num
     end
 
     def unbracket1(ident)
       ident.nil? and return nil
-      ident.is_a?(String) or ident = ident.text
+      ident.is_a?(String) or ident = to_xml(ident.children)
       ident.sub(/^\[/, "").sub(/\]$/, "")
     end
 

data/lib/isodoc/presentation_function/erefs.rb

@@ -3,11 +3,23 @@ require "metanorma-utils"
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def citeas(xmldoc)
-      xmldoc.xpath(ns("//eref | //origin | //quote//source")).each do |e|
+      xmldoc.xpath(ns("//eref | //origin | //quote//source | //link"))
+        .each do |e|
         e["bibitemid"] && e["citeas"] or next
-        a = @xrefs.anchor(e["bibitemid"], :xref, false) and
-          e["citeas"] = a.gsub(%r{</?[^>]+>}, "")
+        a = @xrefs.anchor(e["bibitemid"], :xref, false) or next
+        e["citeas"] = citeas_cleanup(a)
+        # link generated in collection postprocessing from eref
+        e.name == "link" && e.text.empty? and e.children = e["citeas"]
+      end
+    end
+
+    def citeas_cleanup(ref)
+      if /</.match?(ref)
+        xml = Nokogiri::XML("<root>#{ref}</root>")
+        xml.xpath("//semx").each { |x| x.replace(x.children) }
+        ref = to_xml(xml.at("//root").children)
       end
+      ref
     end
 
     def expand_citeas(text)

data/lib/isodoc/presentation_function/index.rb

@@ -0,0 +1,180 @@
+module IsoDoc
+  class PresentationXMLConvert < ::IsoDoc::Convert
+    def enable_indexsect
+      false
+    end
+
+    def add_id
+      %(id="_#{UUIDTools::UUID.random_create}")
+    end
+
+    def strip_index(docxml)
+      docxml.xpath(ns("//index | //index-xref | //indexsect")).each(&:remove)
+    end
+
+    def index(xml)
+      if enable_indexsect && xml.at(ns("//index"))
+        i = xml.at(ns("//indexsect")) ||
+          xml.root.add_child("<indexsect #{add_id}><title>#{@i18n.index}" \
+                             "</title></indexsect>").first
+        index = sort_indexterms(xml.xpath(ns("//index")),
+                                xml.xpath(ns("//index-xref[@also = 'false']")),
+                                xml.xpath(ns("//index-xref[@also = 'true']")))
+        index1(xml, i, index)
+      else strip_index(xml)
+      end
+    end
+
+    def index1(docxml, indexsect, index)
+      c = indexsect.add_child("<ul></ul>").first
+      index.keys.sort.each do |k|
+        words = index[k].keys.each_with_object({}) do |w, v|
+          v[sortable(w).downcase] = w
+        end
+        words.keys.localize(@lang.to_sym).sort.to_a.each do |w|
+          c.add_child index_entries(words, index[k], w)
+        end
+      end
+      index1_cleanup(docxml)
+    end
+
+    def index1_cleanup(docxml)
+      docxml.xpath(ns("//indexsect//xref")).each do |x|
+        x.children.remove
+      end
+      @xrefs.bookmark_anchor_names(docxml)
+    end
+
+    def sortable(str)
+      str or return " "
+      HTMLEntities.new.decode(Nokogiri::XML.fragment(str).text)
+    end
+
+    def index_entries_opt
+      { xref_lbl: ", ", see_lbl: ", #{see_lbl}", also_lbl: ", #{also_lbl}" }
+    end
+
+    def index_entries(words, index, primary)
+      ret = index_entries_head(words[primary],
+                               index.dig(words[primary], nil, nil),
+                               index_entries_opt)
+      words2 = index[words[primary]]&.keys&.compact
+        &.each_with_object({}) { |w, v| v[w.downcase] = w }
+      unless words2.empty?
+        ret += "<ul>"
+        words2.keys.localize(@lang.to_sym).sort.to_a.each do |w|
+          ret += index_entries2(words2, index[words[primary]], w)
+        end
+        ret += "</ul>"
+      end
+      "#{ret}</li>"
+    end
+
+    def index_entries2(words, index, secondary)
+      ret = index_entries_head(words[secondary],
+                               index.dig(words[secondary], nil),
+                               index_entries_opt)
+      words3 = index[words[secondary]]&.keys&.compact
+        &.each_with_object({}) { |w, v| v[w.downcase] = w }
+      unless words3.empty?
+        ret += "<ul>"
+        words3.keys.localize(@lang.to_sym).sort.to_a.each do |w|
+          ret += (index_entries_head(words3[w],
+                                     index[words[secondary]][words3[w]],
+                                     index_entries_opt) + "</li>")
+        end
+        ret += "</ul>"
+      end
+      "#{ret}</li>"
+    end
+
+    def index_entries_head(head, entries, opt)
+      ret = "<li>#{head}"
+      xref = entries&.dig(:xref)&.join(", ")
+      see = index_entries_see(entries, :see)
+      also = index_entries_see(entries, :also)
+      ret += "#{opt[:xref_lbl]} #{xref}" if xref
+      ret += "#{opt[:see_lbl]} #{see}" if see
+      ret += "#{opt[:also_lbl]} #{also}" if also
+      ret
+    end
+
+    def index_entries_see(entries, label)
+      see_sort = entries&.dig(label) or return nil
+      x = see_sort.each_with_object({}) do |w, v|
+        v[sortable(w).downcase] = w
+      end
+      x.keys.localize(@lang.to_sym).sort.to_a.map do |k|
+        # see_sort[k]
+        x[k]
+      end.join(", ")
+    end
+
+    def see_lbl
+      @lang == "en" ? @i18n.see : "<em>#{@i18n.see}</em>"
+    end
+
+    def also_lbl
+      @lang == "en" ? @i18n.see_also : "<em>#{@i18n.see_also}</em>"
+    end
+
+    def sort_indexterms(terms, see, also)
+      index = extract_indexterms(terms)
+      index = extract_indexsee(index, see, :see)
+      index = extract_indexsee(index, also, :also)
+      index.keys.sort.each_with_object({}) do |k, v|
+        v[sortable(k)[0].upcase.transliterate] ||= {}
+        v[sortable(k)[0].upcase.transliterate][k] = index[k]
+      end
+    end
+
+    def extract_indexsee(val, terms, label)
+      terms.each_with_object(val) do |t, v|
+        term, term2, term3 = extract_indexterms_init(t)
+        term_hash_init(v, term, term2, term3, label)
+        v[term][term2][term3][label] << to_xml(t.at(ns("./target"))&.children)
+        t.remove
+      end
+    end
+
+    def xml_encode_attr(str)
+      HTMLEntities.new.encode(str, :basic, :hexadecimal)
+        .gsub(/&#x([^;]+);/) do |_x|
+        "&#x#{$1.upcase};"
+      end
+    end
+
+    # attributes are decoded into UTF-8,
+    # elements in extract_indexsee are still in entities
+    def extract_indexterms(terms)
+      terms.each_with_object({}) do |t, v|
+        term, term2, term3 = extract_indexterms_init(t)
+        to = t["to"] ? "to='#{t['to']}' " : ""
+        index2bookmark(t)
+        term_hash_init(v, term, term2, term3, :xref)
+        v[term][term2][term3][:xref] << "<xref target='#{t['id']}' " \
+                                        "#{to}pagenumber='true'/>"
+      end
+    end
+
+    def extract_indexterms_init(term)
+      %w(primary secondary tertiary).each_with_object([]) do |x, m|
+        m << to_xml(term.at(ns("./#{x}"))&.children)
+      end
+    end
+
+    def term_hash_init(hash, term, term2, term3, label)
+      hash[term] ||= {}
+      hash[term][term2] ||= {}
+      hash[term][term2][term3] ||= {}
+      hash[term][term2][term3][label] ||= []
+    end
+
+    def index2bookmark(node)
+      node.name = "bookmark"
+      node.children.each(&:remove)
+      node["id"] = "_#{UUIDTools::UUID.random_create}"
+      node.delete("to")
+    end
+  end
+end

data/lib/isodoc/presentation_function/refs.rb

@@ -100,24 +100,27 @@ module IsoDoc
       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
       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>"
@@ -126,10 +129,10 @@ module IsoDoc
     end
 
     def bibliography_bibitem_number_insert_pt(bibitem)
+      bibitem.children.empty? and bibitem.add_child(" ")
       unless d = bibitem.at(ns(".//docidentifier"))
         d = bibitem.children.first
-        d.previous = " "
-        return d.previous
+        d.previous = " " and return d.previous
       end
       unless ins = d.previous_element
         d.previous = " "
@@ -150,6 +153,7 @@ module IsoDoc
     def bibliography_bibitem_tag1(ref, idx, norm)
       ref.xpath(ns("./bibitem")).each do |b|
         implicit_reference(b) and next
+        b["suppress_identifier"] == "true" and next
         idx += 1 unless b["hidden"]
         insert_biblio_tag(b, idx, !norm, standard?(b))
       end

data/lib/isodoc/presentation_function/section.rb

@@ -29,7 +29,7 @@ module IsoDoc
     def clause1(elem)
       level = @xrefs.anchor(elem["id"], :level, false) ||
         (elem.ancestors("clause, annex").size + 1)
-      lbl = @xrefs.anchor(elem["id"], :label, elem.parent.name != "sections")
+      lbl = @xrefs.anchor(elem["id"], :label, !unnumbered_clause?(elem))
       if unnumbered_clause?(elem) || !lbl
         prefix_name(elem, {}, nil, "title")
       else
@@ -49,7 +49,7 @@ module IsoDoc
     end
 
     def annex1(elem)
-      lbl = @xrefs.anchor(elem["id"], :label)
+      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>"
@@ -81,10 +81,6 @@ module IsoDoc
         end
     end
 
-    def index(docxml)
-      docxml.xpath(ns("//index | //index-xref | //indexsect")).each(&:remove)
-    end
-
     def skip_display_order?(node)
       node.name == "floating-title"
     end

data/lib/isodoc/presentation_function/xrefs.rb

@@ -21,7 +21,7 @@ module IsoDoc
       node["style"] == "id" and
         return anchor_id_postproc(node)
       node["citeas"].nil? && node["bibitemid"] and
-        return @xrefs.anchor(node["bibitemid"], :xref) || "???"
+        return citeas_cleanup(@xrefs.anchor(node["bibitemid"], :xref)) || "???"
       node.at(ns("./location")) and
         return combine_xref_locations(node) || "???"
       node["target"] && node["droploc"] and

data/lib/isodoc/presentation_xml_convert.rb

@@ -7,6 +7,7 @@ require_relative "presentation_function/erefs"
 require_relative "presentation_function/inline"
 require_relative "presentation_function/math"
 require_relative "presentation_function/section"
+require_relative "presentation_function/index"
 require_relative "presentation_function/bibdata"
 require_relative "presentation_function/metadata"
 

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "2.12.6".freeze
+  VERSION = "2.12.7".freeze
 end

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

@@ -15,6 +15,9 @@ termsdefsymbols: المصطلحات والتعريفات والرموز
 termsdefabbrev: المصطلحات والتعريفات والاختصارات
 normref: المراجع المعيارية
 bibliography: بيبليوغرافيا
+index: الفهرس
+see: انظر
+see_also: انظر أيضًا
 clause: فقرة
 annex: ملحق
 appendix: تذييل

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

@@ -15,6 +15,9 @@ termsdefsymbols: Begriffe, Definitionen und Symbole
 termsdefabbrev: Begriffe, Definitionen und abgekürzte Begriffe
 normref: Normative Verweise
 bibliography: Bibliographie
+index: Index
+see: schau
+see_also: siehe auch
 clause: Klausel
 annex: Anhang
 appendix: Appendix

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

@@ -14,6 +14,9 @@ termsdefsymbols: Terms, definitions and symbols
 termsdefabbrev: Terms, definitions and abbreviated terms
 normref: Normative references
 bibliography: Bibliography
+index: Index
+see: see
+see_also: see also
 preface: Preface
 section: Section
 clause: Clause

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

@@ -14,6 +14,9 @@ termsdefsymbols: Términos, definiciones y símbolos
 termsdefabbrev: Términos, definiciones y términos abreviados
 normref: Referencias normativas
 bibliography: Bibliografía
+index: Índice
+see: ver
+see_also: ver también
 section: Sección
 clause: Cláusula
 annex: Anexo

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

@@ -14,6 +14,9 @@ termsdefsymbols: Termes, définitions et symboles
 termsdefabbrev: Termes, définitions et termes abrégés
 normref: Références normatives
 bibliography: Bibliographie
+index: Index
+see: voir
+see_also: voir aussi
 preface: Préface
 section: Section
 clause: Article

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

@@ -14,6 +14,9 @@ termsdefsymbols: 用語及び定義並びに記号
 termsdefabbrev: 用語及び定義並びに略語
 normref: 引用規格
 bibliography: 参考文献
+index: 索引
+see: 参照
+see_also: 追加参照
 preface: 序文
 section: セクション
 clause: 箇条

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

@@ -14,6 +14,9 @@ termsdefsymbols: Термины, определения и символы
 termsdefabbrev: Термины, определения и сокращенные термины
 normref: Нормативные ссылки
 bibliography: Библиография
+index: Алфавитный указатель
+see: см.
+see_also: см. также
 section: Раздел
 clause: Пункт
 annex: Дополнение

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

@@ -14,6 +14,9 @@ termsdefsymbols: 术语、定义、符号和代号
 termsdefabbrev: 术语、定义、符号和缩略语
 normref: 规范性引用文件
 bibliography: 参考文献
+index: 索引
+see: 见
+see_also: 另见
 preface: 序言
 section: 条
 clause: 条

data/lib/relaton/render-isodoc/config.yml

@@ -1,4 +1,4 @@
 template:
   # skip authoritative identifier, it is inserted in front of formattedref within metanorma
-  standard: "{% if creatornames %}{{ creatornames }} ({{ role}}){%else%}{{publisher}}{%endif%} . <em>{{ title }}</em> . {{ labels['in'] | capitalize }}:_{{ series_title }}. {{ medium | capitalize }}. {{ edition | capitalize_first }}. {{date}}. {{place}}: {%if  creatornames %}{{publisher}}{% endif %} . {{size}}. {{ extent }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]."
+  standard: "{% if creatornames %}{{ creatornames }} ({{ role}}){%else%}{{publisher}}{%endif%} . <em>{{ title }}</em> . {{ medium | capitalize }}. {{ edition | capitalize_first }}. {{date}}. {{place}}: {%if  creatornames %}{{publisher}}{% endif %} . {{size}}. {{ extent }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]."
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 2.12.6
+  version: 2.12.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-11 00:00:00.000000000 Z
+date: 2024-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: roman-numerals
   requirement: !ruby/object:Gem::Requirement
@@ -439,6 +439,7 @@ files:
 - lib/isodoc/presentation_function/docid.rb
 - lib/isodoc/presentation_function/erefs.rb
 - lib/isodoc/presentation_function/image.rb
+- lib/isodoc/presentation_function/index.rb
 - lib/isodoc/presentation_function/inline.rb
 - lib/isodoc/presentation_function/math.rb
 - lib/isodoc/presentation_function/metadata.rb