isodoc 2.4.3 → 2.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0720c3026536785125b4c6c495e4f2573dfa7b2186094c0f36efa9c20a1fbd3
-  data.tar.gz: 9ea3325d067e417956b865edd0baf70dff9a5cb80008e6dfe5fbfbdaaaf16ff4
+  metadata.gz: 9a2cc598b5e8c9690a42329b2af309d75d281db2767adc8fc00eb21a498f69cf
+  data.tar.gz: 1026ad146597f3e93b46f035506f648e7775bb0cf3e846d6f578d2af029dfb1a
 SHA512:
-  metadata.gz: 2e97827c7adacaa26ef823222897672413056219fba5a3e0a6dee92079ac680cd50a9f1dde9cb7c40fddf23ef000fcb0478709a95916a4e6b222bf3d4e94ca54
-  data.tar.gz: 888734821add95629f8709aac1e5ac8b95b372b6a33d43e366e78e0c4ec6a3957dc9264a86015501458ca2752b881f44053e1f7a3997c5d0fb1b43ec816abc74
+  metadata.gz: 5923a84bcb2fa4ba407eae39adf36202ebd07902ec425274641717d38b00daea3e035c9c8f12a936f1c6f4126e3d38db68a5184dfe63718adbe08b8c6ed4046d
+  data.tar.gz: 36a2d61a352858557db3c8f8f097b590842bf148b0ffaf48fcf3a5dd45f0781dcfe929000de3704427d9bde7c1a2c74458f931c0976356e4594bb510631c66c7

data/lib/isodoc/class_utils.rb

@@ -76,8 +76,11 @@ module IsoDoc
 
     # node is at the start of sentence in a Metanorma XML context
     def start_of_sentence(node)
-      prec = nearest_block_parent(node).xpath("./descendant-or-self::text()") &
-        node.xpath("./preceding::text()")
+      prec = [] # all text nodes before node
+      nearest_block_parent(node).traverse do |x|
+        x == node and break
+        x.text? and prec << x
+      end
       prec.empty? || /(?!<[^.].)\.\s+$/.match(prec.map(&:text).join)
     end
   end

data/lib/isodoc/function/section.rb

@@ -58,7 +58,7 @@ module IsoDoc
         num
       end
 
-      TERM_CLAUSE = "//sections/terms | "\
+      TERM_CLAUSE = "//sections/terms | " \
                     "//sections/clause[descendant::terms]".freeze
 
       def terms_defs(isoxml, out, num)
@@ -100,7 +100,7 @@ module IsoDoc
       def introduction(isoxml, out)
         f = isoxml.at(ns("//introduction")) || return
         page_break(out)
-        out.div **{ class: "Section3", id: f["id"] } do |div|
+        out.div class: "Section3", id: f["id"] do |div|
           clause_name(nil, f.at(ns("./title")), div, { class: "IntroTitle" })
           f.elements.each do |e|
             parse(e, div) unless e.name == "title"
@@ -122,7 +122,7 @@ module IsoDoc
         f = isoxml.at(ns("//acknowledgements")) || return
         title_attr = { class: "IntroTitle" }
         page_break(out)
-        out.div **{ class: "Section3", id: f["id"] } do |div|
+        out.div class: "Section3", id: f["id"] do |div|
           clause_name(nil, f&.at(ns("./title")), div, title_attr)
           f.elements.each do |e|
             parse(e, div) unless e.name == "title"
@@ -140,10 +140,10 @@ module IsoDoc
       end
 
       def preface(isoxml, out)
-        isoxml.xpath(ns("//preface/clause | //preface/references | "\
+        isoxml.xpath(ns("//preface/clause | //preface/references | " \
                         "//preface/definitions | //preface/terms")).each do |f|
           page_break(out)
-          out.div **{ class: "Section3", id: f["id"] } do |div|
+          out.div class: "Section3", id: f["id"] do |div|
             clause_name(nil, f&.at(ns("./title")), div, { class: "IntroTitle" })
             f.elements.each do |e|
               parse(e, div) unless e.name == "title"
@@ -174,7 +174,7 @@ module IsoDoc
       def copyright_parse(node, out)
         return if @bare
 
-        out.div **{ class: "boilerplate-copyright" } do |div|
+        out.div class: "boilerplate-copyright" do |div|
           node.children.each { |n| parse(n, div) }
         end
       end
@@ -182,7 +182,7 @@ module IsoDoc
       def license_parse(node, out)
         return if @bare
 
-        out.div **{ class: "boilerplate-license" } do |div|
+        out.div class: "boilerplate-license" do |div|
           node.children.each { |n| parse(n, div) }
         end
       end
@@ -190,7 +190,7 @@ module IsoDoc
       def legal_parse(node, out)
         return if @bare
 
-        out.div **{ class: "boilerplate-legal" } do |div|
+        out.div class: "boilerplate-legal" do |div|
           node.children.each { |n| parse(n, div) }
         end
       end
@@ -198,7 +198,7 @@ module IsoDoc
       def feedback_parse(node, out)
         return if @bare
 
-        out.div **{ class: "boilerplate-feedback" } do |div|
+        out.div class: "boilerplate-feedback" do |div|
           node.children.each { |n| parse(n, div) }
         end
       end

data/lib/isodoc/presentation_function/block.rb

@@ -15,8 +15,7 @@ module IsoDoc
     end
 
     def prefix_name(node, delim, number, elem)
-      return if number.nil? || number.empty?
-
+      number.nil? || number.empty? and return
       unless name = node.at(ns("./#{elem}"))
         (node.children.empty? and node.add_child("<#{elem}></#{elem}>")) or
           node.children.first.previous = "<#{elem}></#{elem}>"
@@ -54,12 +53,12 @@ module IsoDoc
     end
 
     def note1(elem)
-      elem.parent.name == "bibitem" || elem["notag"] == "true" and return
+      %w(bibdata bibitem).include?(elem.parent.name) ||
+        elem["notag"] == "true" and return
       n = @xrefs.get[elem["id"]]
-      lbl = if n.nil? || n[:label].nil? || n[:label].empty?
-              @i18n.note
-            else l10n("#{@i18n.note} #{n[:label]}")
-            end
+      lbl = @i18n.note
+      (n.nil? || n[:label].nil? || n[:label].empty?) or
+        lbl = l10n("#{lbl} #{n[:label]}")
       prefix_name(elem, "", lbl, "name")
     end
 
@@ -68,8 +67,18 @@ module IsoDoc
     end
 
     def admonition1(elem)
-      elem.at(ns("./name")) || elem["notag"] == "true" and return
-      prefix_name(elem, "", @i18n.admonition[elem["type"]]&.upcase, "name")
+      if elem["type"] == "box"
+        admonition_numbered1(elem)
+      else
+        elem["notag"] == "true" || elem.at(ns("./name")) and return
+        prefix_name(elem, "", @i18n.admonition[elem["type"]]&.upcase, "name")
+      end
+    end
+
+    def admonition_numbered1(elem)
+      elem["unnumbered"] && !elem.at(ns("./name")) and return
+      n = @xrefs.anchor(elem["id"], :label, false)
+      prefix_name(elem, block_delim, l10n("#{@i18n.box} #{n}"), "name")
     end
 
     def recommendation(docxml)

data/lib/isodoc/presentation_function/math.rb

@@ -106,7 +106,7 @@ module IsoDoc
     def mathml_style_inherit(node)
       node.at("./ancestor::xmlns:strong") or return
       node.children =
-        "<mstyle fontweight='bold'>#{node.children.to_xml}</mstyle>"
+        "<mstyle mathvariant='bold'>#{node.children.to_xml}</mstyle>"
     end
 
     def mathml_number_to_number(node)

data/lib/isodoc/presentation_function/refs.rb

@@ -1,5 +1,3 @@
-require_relative "../../relaton/render/general"
-
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def references(docxml)

data/lib/isodoc/presentation_function/section.rb

@@ -17,7 +17,7 @@ module IsoDoc
       level = @xrefs.anchor(elem["id"], :level, false) ||
         (elem.ancestors("clause, annex").size + 1)
       t = elem.at(ns("./title")) and t["depth"] = level
-      return if !elem.ancestors("boilerplate").empty? ||
+      return if !elem.ancestors("boilerplate, metanorma-extension").empty? ||
         @suppressheadingnumbers || elem["unnumbered"]
 
       lbl = @xrefs.anchor(elem["id"], :label,

data/lib/isodoc/presentation_function/sourcecode.rb

@@ -1,16 +1,23 @@
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def sourcehighlighter_css(docxml)
-      @sourcehighlighter or return
+      ret = custom_css(docxml)
+      ret.empty? and return
       ins = docxml.at(ns("//metanorma-extension")) ||
         docxml.at(ns("//bibdata")).after("<metanorma-extension/>").next_element
-      ins << "<source-highlighter-css>#{sourcehighlighter_css_file}" \
+      ins << "<source-highlighter-css>#{ret}" \
              "</source-highlighter-css>"
     end
 
-    def sourcehighlighter_css_file
-      File.read(File.join(File.dirname(__FILE__), "..", "base_style",
-                          "rouge.css"))
+    def custom_css(docxml)
+      ret = ""
+      @sourcehighlighter and
+        ret += File.read(File.join(File.dirname(__FILE__), "..", "base_style",
+                                   "rouge.css"))
+      a = docxml.at(ns("//metanorma-extension/" \
+                       "clause[title = 'user-css']/sourcecode")) and
+        ret += "\n#{to_xml(a.children)}"
+      ret
     end
 
     def sourcehighlighter
@@ -109,6 +116,7 @@ module IsoDoc
        Rouge::Lexer.find("plaintext"))
       l = Rouge::Lexers::Escape.new(start: "{^^{", end: "}^^}", lang: lexer)
       source = to_xml(elem.children).gsub(/</, "{^^{<").gsub(/>/, ">}^^}")
+      l.lang.reset!
       l.lex(@c.decode(source))
     end
 

data/lib/isodoc/presentation_function/terms.rb

@@ -56,23 +56,22 @@ module IsoDoc
     def concept1_ref(_node, ref, opts)
       ref.nil? and return
       opts[:ref] == "false" and return ref.remove
-      r = concept1_ref_content(ref)
-      ref = r.at("./descendant-or-self::xmlns:xref | " \
-                 "./descendant-or-self::xmlns:eref | " \
-                 "./descendant-or-self::xmlns:termref")
-      %w(xref eref).include? ref&.name and get_linkend(ref)
-      opts[:linkref] == "false" && %w(xref eref).include?(ref&.name) and
+      concept1_ref_content(ref)
+      %w(xref eref).include? ref.name and get_linkend(ref)
+      opts[:linkref] == "false" && %w(xref eref).include?(ref.name) and
         ref.replace(ref.children)
     end
 
     def concept1_ref_content(ref)
+      prev = "["
+      foll = "]"
       if non_locality_elems(ref).select do |c|
            !c.text? || /\S/.match(c)
          end.empty?
-        ref.replace(@i18n.term_defined_in.sub(/%/,
-                                              to_xml(ref)))
-      else ref.replace("[#{to_xml(ref)}]")
+        prev, foll = @i18n.term_defined_in.split("%")
       end
+      ref.previous = prev
+      ref.next = foll
     end
 
     def related(docxml)

data/lib/isodoc/presentation_xml_convert.rb

@@ -87,10 +87,11 @@ module IsoDoc
 
     def semantic_xml_insert(xml)
       @semantic_xml_insert or return
-      embed = to_xml(embedable_semantic_xml(xml))
+      embed = embedable_semantic_xml(xml)
       ins = metanorma_extension_insert_pt(xml)
       ins = ins.at(ns("./metanorma")) || ins.add_child("<metanorma/>").first
-      ins << "<source>#{embed}</source>"
+      ins = ins.add_child("<source/>").first
+      ins << embed
     end
 
     def metanorma_extension_insert_pt(xml)
@@ -107,14 +108,15 @@ module IsoDoc
     end
 
     def embedable_semantic_xml_tags(xml)
-      Nokogiri::XML(to_xml(xml).gsub(%r{(</?)([[:alpha:]])},
-                                     "\\1semantic__\\2")).root
+      Nokogiri::XML(to_xml(xml)
+        .sub(/ xmlns=['"][^"']+['"]/, "")
+        .gsub(%r{(</?)([[:alpha:]])}, "\\1semantic__\\2")).root
     end
 
     def embedable_semantic_xml_attributes(xml)
       Metanorma::Utils::anchor_attributes.each do |(tag_name, attr_name)|
         tag_name == "*" or tag_name = "semantic__#{tag_name}"
-        xml.xpath(ns("//#{tag_name}[@#{attr_name}]")).each do |elem|
+        xml.xpath("//#{tag_name}[@#{attr_name}]").each do |elem|
           elem.attributes[attr_name].value =
             "semantic__#{elem.attributes[attr_name].value}"
         end

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "2.4.3".freeze
+  VERSION = "2.4.4".freeze
 end

data/lib/isodoc/xref/xref_anchor.rb

@@ -4,10 +4,12 @@ module IsoDoc
   module XrefGen
     module Anchor
       class SeenAnchor
-        include Singleton
-
-        def initialize
+        def initialize(xmldoc)
           @seen = {}
+          # ignore all metanorma-extension ids
+          xmldoc.xpath("//xmlns:metanorma-extension//*[@id]").each do |x|
+            add(x["id"])
+          end
         end
 
         def seen(elem)

data/lib/isodoc/xref/xref_gen.rb

@@ -92,14 +92,15 @@ module IsoDoc
         SECTIONS_XPATH
       end
 
-      CHILD_NOTES_XPATH =
+      def child_asset_path(asset)
         "./*[not(self::xmlns:clause) and not(self::xmlns:appendix) and " \
-        "not(self::xmlns:terms) and not(self::xmlns:definitions)]//xmlns:note | " \
-        "./xmlns:note".freeze
+        "not(self::xmlns:terms) and not(self::xmlns:definitions)]//xmlns:X | " \
+        "./xmlns:X".gsub("X", asset)
+      end
 
       def note_anchor_names(sections)
         sections.each do |s|
-          notes = s.xpath(CHILD_NOTES_XPATH) -
+          notes = s.xpath(child_asset_path("note")) -
             s.xpath(ns(".//figure//note | .//table//note"))
           note_anchor_names1(notes, Counter.new)
           note_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
@@ -116,17 +117,28 @@ module IsoDoc
         end
       end
 
-      CHILD_EXAMPLES_XPATH =
-        "./*[not(self::xmlns:clause) and not(self::xmlns:appendix) and " \
-        "not(self::xmlns:terms) and not(self::xmlns:definitions)]//" \
-        "xmlns:example | ./xmlns:example".freeze
-
       CHILD_SECTIONS = "./clause | ./appendix | ./terms | ./definitions | " \
                        "./references".freeze
 
+      def admonition_anchor_names(sections)
+        sections.each do |s|
+          notes = s.xpath(child_asset_path("admonition[@type = 'box']"))
+          admonition_anchor_names1(notes, Counter.new)
+          admonition_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
+        end
+      end
+
+      def admonition_anchor_names1(notes, counter)
+        notes.noblank.each do |n|
+          @anchors[n["id"]] ||=
+            anchor_struct(increment_label(notes, n, counter), n,
+                          @labels["box"], "admonition", n["unnumbered"])
+        end
+      end
+
       def example_anchor_names(sections)
         sections.each do |s|
-          notes = s.xpath(CHILD_EXAMPLES_XPATH)
+          notes = s.xpath(child_asset_path("example"))
           example_anchor_names1(notes, Counter.new)
           example_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
         end
@@ -154,7 +166,8 @@ module IsoDoc
         end
       end
 
-      def list_item_anchor_names(list, list_anchor, depth, prev_label, refer_list)
+      def list_item_anchor_names(list, list_anchor, depth, prev_label,
+refer_list)
         c = Counter.new(list["start"] ? list["start"].to_i - 1 : 0)
         list.xpath(ns("./li")).each do |li|
           label = c.increment(li).listlabel(list, depth)

data/lib/isodoc/xref/xref_sect_gen.rb

@@ -45,6 +45,7 @@ module IsoDoc
         termexample_anchor_names(doc)
         note_anchor_names(doc.xpath(ns("//table | //figure")))
         note_anchor_names(doc.xpath(ns(sections_xpath)))
+        admonition_anchor_names(doc.xpath(ns(sections_xpath)))
         example_anchor_names(doc.xpath(ns(sections_xpath)))
         list_anchor_names(doc.xpath(ns(sections_xpath)))
         deflist_anchor_names(doc.xpath(ns(sections_xpath)))

data/lib/isodoc/xref.rb

@@ -49,7 +49,6 @@ module IsoDoc
       return nil if ident.nil? || ident.empty?
 
       if warning && !@anchors[ident]
-        @seen ||= SeenAnchor.instance
         @seen.seen(ident) or warn "No label has been processed for ID #{ident}"
         @seen.add(ident)
         return "[#{ident}]"
@@ -59,6 +58,7 @@ module IsoDoc
 
     # extract names for all anchors, xref and label
     def parse(docxml)
+      @seen = SeenAnchor.new(docxml)
       amend_preprocess(docxml) if @parse_settings.empty?
       initial_anchor_names(docxml)
       back_anchor_names(docxml)

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

@@ -55,6 +55,7 @@ table: جدول
 requirement: مطلب
 recommendation: توصية
 permission: إذن
+box: الإطار
 key: مفتاح
 example: مثال
 example_xref: مثال

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

@@ -61,6 +61,7 @@ table: Tabelle
 requirement: Anforderung
 recommendation: Empfehlung
 permission: Erlaubnis
+box: Kasten
 key: Taste
 example: BEISPIEL
 example_xref: Beispiel

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

@@ -61,6 +61,7 @@ table: Table
 requirement: Requirement
 recommendation: Recommendation
 permission: Permission
+box: Box
 # Modspec
 recommendationtest: Recommendation test
 requirementtest: Requirement test

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

@@ -61,6 +61,7 @@ table: Tabla
 requirement: Requerimiento
 recommendation: Recomendación
 permission: Permiso
+box: Recuadro
 key: Clave
 example: EJEMPLO
 example_xref: Ejemplo

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

@@ -58,6 +58,7 @@ table: Tableau
 requirement: Exigence
 recommendation: Recommandation
 permission: Autorisation
+box: Encadré
 key: Légende
 example: EXEMPLE
 example_xref: Exemple

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

@@ -66,6 +66,7 @@ table: Таблица
 requirement: Требование
 recommendation: Рекомендация
 permission: Разрешение
+box: Вставка
 key: Условные обозначения
 example: ПРИМЕР
 example_xref: Пример

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

@@ -56,6 +56,7 @@ table: 表
 requirement: 要求
 recommendation: 建议
 permission: 容許
+box: 专栏
 key: 说明
 example: 示例
 example_xref: 示例

data/lib/isodoc.rb

@@ -7,10 +7,10 @@ require "base64"
 require "mime/types"
 require "image_size"
 require "set"
-require "pp"
 require "html2doc"
 require "liquid"
 require "htmlentities"
+require "relaton-render"
 
 require "isodoc/common"
 require "isodoc/convert"
@@ -24,6 +24,7 @@ require "isodoc/presentation_xml_convert"
 require "isodoc/xref"
 require "isodoc/i18n"
 require "metanorma/output"
+require "relaton/render-isodoc/general"
 
 module IsoDoc
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 2.4.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciimath
@@ -494,8 +494,8 @@ files:
 - lib/metanorma/output/base.rb
 - lib/metanorma/output/utils.rb
 - lib/metanorma/output/xslfo.rb
-- lib/relaton/render/config.yml
-- lib/relaton/render/general.rb
+- lib/relaton/render-isodoc/config.yml
+- lib/relaton/render-isodoc/general.rb
 homepage: https://github.com/metanorma/isodoc
 licenses:
 - BSD-2-Clause