metanorma-standoc 1.10.6 → 1.10.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5982aeb8f67b56ccf4da3cf8589b3855fda38e646650074f8804d8e94de9a791
-  data.tar.gz: 6efa1a3eb9fce06dfcce893c835152a2ee642418cd35f06981d4a3d7e4408832
+  metadata.gz: 90fb9b89f2c7070b763519843f307f4d3ecebb8ee462d7017afb886a397de8a8
+  data.tar.gz: b6f2e8253577f05a76e833d3a1e5d9f64fd47a7de48d8ec6703056b04965096a
 SHA512:
-  metadata.gz: 4d4cd2f1c480899fe9221482e53bff2702d96cc1688937b15b993eddcddbca80cb7c5d931913ceaa5e06f9c0b6a70723fc3a84c275a259c5a9bb21fb8b3d42fe
-  data.tar.gz: 61cf1ff021b2f6365ad83311478732ed431dc2f3328e11ec1a96ebfa264c463ded7198779a86928bb3a82ce4153f4934b96aeccccff5d136d3018cd9b6025173
+  metadata.gz: 17eb330f74f079b78db600f8030c15e497b6e0b1251157b9499cf532974280e6d4bb61ebe7d4c52cc443ca4d407371b575f6425783aa384e4c977733de528c5e
+  data.tar.gz: f3063d8116e77c1e00cf6f9ba12668e5bfbb581d41e02e9d4c4fee2dc21884754f8102a718d7318d3b0619abaf1715528162e9aebcb97895a7ab85bbeb6fccd4

data/lib/asciidoctor/standoc/base.rb

@@ -23,17 +23,6 @@ module Asciidoctor
         self.class::XML_NAMESPACE
       end
 
-      def content(node)
-        node.content
-      end
-
-      def skip(node, name = nil)
-        name = name || node.node_name
-        w = "converter missing for #{name} node in Metanorma backend"
-        @log.add("AsciiDoc Input", node, w)
-        nil
-      end
-
       def html_extract_attributes(node)
         {
           script: node.attr("script"),
@@ -56,6 +45,7 @@ module Asciidoctor
           suppressasciimathdup: node.attr("suppress-asciimath-dup"),
           bare: node.attr("bare"),
           sectionsplit: node.attr("sectionsplit"),
+          baseassetpath: node.attr("base-asset-path"),
         }
       end
 
@@ -90,6 +80,7 @@ module Asciidoctor
           break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
           suppressasciimathdup: node.attr("suppress-asciimath-dup"),
           bare: node.attr("bare"),
+          baseassetpath: node.attr("base-asset-path"),
         }
 
         if font_manifest_file = node.attr("mn2pdf-font-manifest-file")
@@ -124,8 +115,7 @@ module Asciidoctor
         @files_to_delete = []
         @filename = if node.attr("docfile")
                       File.basename(node.attr("docfile"))&.gsub(/\.adoc$/, "")
-                    else
-                      ""
+                    else ""
                     end
         @localdir = Metanorma::Utils::localdir(node)
         @output_dir = outputdir node

data/lib/asciidoctor/standoc/cleanup.rb

@@ -2,12 +2,14 @@ require "nokogiri"
 require "pathname"
 require "html2doc"
 require_relative "./cleanup_block"
+require_relative "./cleanup_table"
 require_relative "./cleanup_footnotes"
 require_relative "./cleanup_ref"
 require_relative "./cleanup_ref_dl"
 require_relative "./cleanup_boilerplate"
 require_relative "./cleanup_section"
 require_relative "./cleanup_terms"
+require_relative "./cleanup_xref"
 require_relative "./cleanup_inline"
 require_relative "./cleanup_amend"
 require_relative "./cleanup_maths"
@@ -129,13 +131,18 @@ module Asciidoctor
       end
 
       def toc_cleanup(xmldoc)
+        toc_cleanup_para(xmldoc)
+        xmldoc.xpath("//toc").each { |t| toc_cleanup1(t, xmldoc) }
+        toc_cleanup_clause(xmldoc)
+      end
+
+      def toc_cleanup_para(xmldoc)
         xmldoc.xpath("//p[toc]").each do |x|
           x.xpath("./toc").reverse.each do |t|
             x.next = t
           end
           x.remove if x.text.strip.empty?
         end
-        xmldoc.xpath("//toc").each { |t| toc_cleanup1(t, xmldoc) }
       end
 
       def toc_index(toc, xmldoc)
@@ -169,6 +176,24 @@ module Asciidoctor
         end
         toc.children = "<ul>#{ret}</ul>"
       end
+
+      def toc_cleanup_clause(xmldoc)
+        xmldoc
+          .xpath("//clause[@type = 'toc'] | //annex[@type = 'toc']").each do |c|
+          c.xpath(".//ul[not(ancestor::ul)]").each do |ul|
+            toc_cleanup_clause_entry(xmldoc, ul)
+            ul.replace("<toc>#{ul.to_xml}</toc>")
+          end
+        end
+      end
+
+      def toc_cleanup_clause_entry(xmldoc, list)
+        list.xpath(".//xref[not(text())]").each do |x|
+          c1 = xmldoc.at("//*[@id = '#{x['target']}']")
+          t = c1.at("./variant-title[@type = 'toc']") || c1.at("./title")
+          x << t.dup.children
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -9,9 +9,7 @@ module Asciidoctor
          "//ul[not(ancestor::bibdata)]", "//quote[not(ancestor::bibdata)]",
          "//note[not(ancestor::bibitem or "\
          "ancestor::table or ancestor::bibdata)]"].each do |w|
-          inject_id(
-            xmldoc, w
-          )
+          inject_id(xmldoc, w)
         end
       end
 
@@ -21,70 +19,6 @@ module Asciidoctor
         end
       end
 
-      def dl1_table_cleanup(xmldoc)
-        q = "//table/following-sibling::*[1][self::dl]"
-        xmldoc.xpath(q).each do |s|
-          s["key"] == "true" and s.previous_element << s.remove
-        end
-      end
-
-      # move Key dl after table footer
-      def dl2_table_cleanup(xmldoc)
-        q = "//table/following-sibling::*[1][self::p]"
-        xmldoc.xpath(q).each do |s|
-          if s.text =~ /^\s*key[^a-z]*$/i && s&.next_element&.name == "dl"
-            s.next_element["key"] = "true"
-            s.previous_element << s.next_element.remove
-            s.remove
-          end
-        end
-      end
-
-      def insert_thead(table)
-        thead = table.at("./thead")
-        return thead unless thead.nil?
-
-        if tname = table.at("./name")
-          thead = tname.add_next_sibling("<thead/>").first
-          return thead
-        end
-        table.children.first.add_previous_sibling("<thead/>").first
-      end
-
-      def header_rows_cleanup(xmldoc)
-        xmldoc.xpath("//table[@headerrows]").each do |s|
-          thead = insert_thead(s)
-          (thead.xpath("./tr").size...s["headerrows"].to_i).each do
-            row = s.at("./tbody/tr")
-            row.parent = thead
-          end
-          thead.xpath(".//td").each { |n| n.name = "th" }
-          s.delete("headerrows")
-        end
-      end
-
-      def table_cleanup(xmldoc)
-        dl1_table_cleanup(xmldoc)
-        dl2_table_cleanup(xmldoc)
-        notes_table_cleanup(xmldoc)
-        header_rows_cleanup(xmldoc)
-      end
-
-      # move notes into table
-      def notes_table_cleanup(xmldoc)
-        nomatches = false
-        until nomatches
-          q = "//table/following-sibling::*[1]"\
-              "[self::note[not(@keep-separate = 'true')]]"
-          nomatches = true
-          xmldoc.xpath(q).each do |n|
-            n.delete("keep-separate")
-            n.previous_element << n.remove
-            nomatches = false
-          end
-        end
-      end
-
       # include where definition list inside stem block
       def formula_cleanup(formula)
         formula_cleanup_where1(formula)
@@ -216,18 +150,16 @@ module Asciidoctor
       end
 
       def sourcecode_markup(node)
-        acc = []
         node.text.split(/(#{Regexp.escape(@sourcecode_markup_start)}|
                           #{Regexp.escape(@sourcecode_markup_end)})/x)
-          .each_slice(4).map do |a|
+          .each_slice(4).map.with_object([]) do |a, acc|
           acc << safe_noko(a[0], node.document)
           next unless a.size == 4
 
           acc << Asciidoctor.convert(
             a[2], doctype: :inline, backend: (self&.backend&.to_sym || :standoc)
           )
-        end
-        acc.join
+        end.join
       end
 
       def form_cleanup(xmldoc)

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -55,108 +55,6 @@ module Asciidoctor
         end
       end
 
-      # extending localities to cover ISO referencing
-      LOCALITY_REGEX_STR = <<~REGEXP.freeze
-        ^((?<locality>section|clause|part|paragraph|chapter|page|
-                      table|annex|figure|example|note|formula|list|time|anchor|
-                      locality:[^ \\t\\n\\r:,;=]+)(\\s+|=)
-               (?<ref>[^"][^ \\t\\n,:-]*|"[^"]+")
-                 (-(?<to>[^"][^ \\t\\n,:-]*|"[^"]"))?|
-          (?<locality2>whole|locality:[^ \\t\\n\\r:,;=]+))(?<punct>[,:;]?)\\s*
-         (?<text>.*)$
-      REGEXP
-      LOCALITY_RE = Regexp.new(LOCALITY_REGEX_STR.gsub(/\s/, ""),
-                               Regexp::IGNORECASE | Regexp::MULTILINE)
-
-      def tq(text)
-        text.sub(/^"/, "").sub(/"$/, "")
-      end
-
-      def extract_localities(elem)
-        f = elem&.children&.first or return
-        f.text? or return
-        head = f.remove.text
-        tail = elem&.children&.remove
-        extract_localities1(elem, head)
-        tail and elem << tail
-      end
-
-      def extract_localities1(elem, text)
-        b = elem.add_child("<localityStack/>").first if LOCALITY_RE.match text
-        while (m = LOCALITY_RE.match text)
-          ref = m[:ref] ? "<referenceFrom>#{tq m[:ref]}</referenceFrom>" : ""
-          refto = m[:to] ? "<referenceTo>#{tq m[:to]}</referenceTo>" : ""
-          b.add_child("<locality type='#{locality_label(m)}'>#{ref}#{refto}"\
-                      "</locality>")
-          text = m[:text]
-          b = elem.add_child("<localityStack/>").first if m[:punct] == ";"
-        end
-        elem.add_child(text) if text
-      end
-
-      def locality_label(match)
-        loc = match[:locality] || match[:locality2]
-        /^locality:/.match?(loc) ? loc : loc&.downcase
-      end
-
-      def xref_to_eref(elem)
-        elem["bibitemid"] = elem["target"]
-        unless elem["citeas"] = @anchors&.dig(elem["target"], :xref)
-          @internal_eref_namespaces.include?(elem["type"]) or
-            @log.add("Crossreferences", elem,
-                     "#{elem['target']} does not have a corresponding "\
-                     "anchor ID in the bibliography!")
-        end
-        elem.delete("target")
-        extract_localities(elem) unless elem.children.empty?
-      end
-
-      def xref_cleanup(xmldoc)
-        xmldoc.xpath("//xref").each do |x|
-          /:/.match(x["target"]) and xref_to_internal_eref(x)
-          next unless x.name == "xref"
-
-          if refid? x["target"]
-            x.name = "eref"
-            xref_to_eref(x)
-          else x.delete("type")
-          end
-        end
-      end
-
-      def xref_to_internal_eref(elem)
-        a = elem["target"].split(":", 3)
-        unless a.size < 2 || a[0].empty? || a[1].empty?
-          elem["target"] = "#{a[0]}_#{a[1]}"
-          a.size > 2 and
-            elem.children = %{anchor="#{a[2..-1].join}",#{elem&.children&.text}}
-          elem["type"] = a[0]
-          @internal_eref_namespaces << a[0]
-          elem.name = "eref"
-          xref_to_eref(elem)
-        end
-      end
-
-      def quotesource_cleanup(xmldoc)
-        xmldoc.xpath("//quote/source | //terms/source").each do |x|
-          xref_to_eref(x)
-        end
-      end
-
-      def origin_cleanup(xmldoc)
-        xmldoc.xpath("//origin/concept[termref]").each do |x|
-          t = x.at("./termref")
-          x.replace(t)
-        end
-        xmldoc.xpath("//origin").each do |x|
-          x["citeas"] = @anchors&.dig(x["bibitemid"], :xref) or
-            @log.add("Crossreferences", x,
-                     "#{x['bibitemid']} does not have a corresponding anchor "\
-                     "ID in the bibliography!")
-          extract_localities(x) unless x.children.empty?
-        end
-      end
-
       def concept_cleanup(xmldoc)
         xmldoc.xpath("//concept[not(termxref)]").each do |x|
           term = x.at("./refterm")

data/lib/asciidoctor/standoc/cleanup_reqt.rb

@@ -72,7 +72,7 @@ module Asciidoctor
       def requirement_metadata(xmldoc)
         xmldoc.xpath(REQRECPER).each do |r|
           dl = r&.at("./dl[@metadata = 'true']")&.remove or next
-          requirement_metadata1(r, dl)
+          requirement_metadata1(r, dl, r.at("./title"))
         end
       end
 
@@ -80,8 +80,8 @@ module Asciidoctor
         %w(label subject inherit)
       end
 
-      def requirement_metadata1(reqt, dlist)
-        unless ins = reqt.at("./title")
+      def requirement_metadata1(reqt, dlist, ins)
+        unless ins
           reqt.children.first.previous = " "
           ins = reqt.children.first
         end

data/lib/asciidoctor/standoc/cleanup_section_names.rb

@@ -78,12 +78,12 @@ module Asciidoctor
       def sections_variant_title_cleanup(xml)
         path = SECTION_CONTAINERS.map { |x| "./ancestor::#{x}" }.join(" | ")
         xml.xpath("//p[@variant_title]").each do |p|
+          p.name = "variant-title"
+          p.delete("id")
+          p.delete("variant_title")
           p.xpath("(#{path})[last()]").each do |sect|
-            p.name = "variant-title"
-            p.delete("id")
-            if ins = sect.at("./title") then ins.next = p
-            else sect.children.first.previous = p
-            end
+            ins = sect.at("./title") and ins.next = p or
+              sect.children.first.previous = p
           end
         end
       end

data/lib/asciidoctor/standoc/cleanup_table.rb

@@ -0,0 +1,68 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      def dl1_table_cleanup(xmldoc)
+        q = "//table/following-sibling::*[1][self::dl]"
+        xmldoc.xpath(q).each do |s|
+          s["key"] == "true" and s.previous_element << s.remove
+        end
+      end
+
+      # move Key dl after table footer
+      def dl2_table_cleanup(xmldoc)
+        q = "//table/following-sibling::*[1][self::p]"
+        xmldoc.xpath(q).each do |s|
+          if s.text =~ /^\s*key[^a-z]*$/i && s&.next_element&.name == "dl"
+            s.next_element["key"] = "true"
+            s.previous_element << s.next_element.remove
+            s.remove
+          end
+        end
+      end
+
+      def insert_thead(table)
+        thead = table.at("./thead")
+        return thead unless thead.nil?
+
+        if tname = table.at("./name")
+          thead = tname.add_next_sibling("<thead/>").first
+          return thead
+        end
+        table.children.first.add_previous_sibling("<thead/>").first
+      end
+
+      def header_rows_cleanup(xmldoc)
+        xmldoc.xpath("//table[@headerrows]").each do |s|
+          thead = insert_thead(s)
+          (thead.xpath("./tr").size...s["headerrows"].to_i).each do
+            row = s.at("./tbody/tr")
+            row.parent = thead
+          end
+          thead.xpath(".//td").each { |n| n.name = "th" }
+          s.delete("headerrows")
+        end
+      end
+
+      def table_cleanup(xmldoc)
+        dl1_table_cleanup(xmldoc)
+        dl2_table_cleanup(xmldoc)
+        notes_table_cleanup(xmldoc)
+        header_rows_cleanup(xmldoc)
+      end
+
+      # move notes into table
+      def notes_table_cleanup(xmldoc)
+        nomatches = false
+        until nomatches
+          nomatches = true
+          xmldoc.xpath("//table/following-sibling::*[1]"\
+                       "[self::note[not(@keep-separate = 'true')]]").each do |n|
+            n.delete("keep-separate")
+            n.previous_element << n.remove
+            nomatches = false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/cleanup_text.rb

@@ -9,7 +9,8 @@ module Asciidoctor
                   </passthrough>}mx) { HTMLEntities.new.decode($1) }
       end
 
-            IGNORE_DUMBQUOTES = "//pre | //pre//* | //tt | //tt//* | "\
+      IGNORE_DUMBQUOTES =
+        "//pre | //pre//* | //tt | //tt//* | "\
         "//sourcecode | //sourcecode//* | //bibdata//* | //stem | "\
         "//stem//* | //figure[@class = 'pseudocode'] | "\
         "//figure[@class = 'pseudocode']//*".freeze
@@ -32,6 +33,7 @@ module Asciidoctor
                      "[starts-with(., '\"') or starts-with(., \"'\")]]")
           .each do |x|
           next if !x.ancestors("pre, tt, sourcecode, stem, figure").empty?
+
           uninterrupt_quotes_around_xml1(x)
         end
       end
@@ -40,7 +42,8 @@ module Asciidoctor
         prev = elem.at(".//preceding::text()[1]") or return
         /\S$/.match?(prev.text) or return
         foll = elem.at(".//following::text()[1]")
-        m = /^(["'][[:punct:]]*)(\s|$)/.match(HTMLEntities.new.decode(foll&.text)) or return
+        m = /^(["'][[:punct:]]*)(\s|$)/
+          .match(HTMLEntities.new.decode(foll&.text)) or return
         foll.content = foll.text.sub(/^(["'][[:punct:]]*)/, "")
         prev.content = "#{prev.text}#{m[1]}"
       end

data/lib/asciidoctor/standoc/cleanup_xref.rb

@@ -0,0 +1,107 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      # extending localities to cover ISO referencing
+      LOCALITY_REGEX_STR = <<~REGEXP.freeze
+        ^((?<locality>section|clause|part|paragraph|chapter|page|
+                      table|annex|figure|example|note|formula|list|time|anchor|
+                      locality:[^ \\t\\n\\r:,;=]+)(\\s+|=)
+               (?<ref>[^"][^ \\t\\n,:-]*|"[^"]+")
+                 (-(?<to>[^"][^ \\t\\n,:-]*|"[^"]"))?|
+          (?<locality2>whole|locality:[^ \\t\\n\\r:,;=]+))(?<punct>[,:;]?)\\s*
+         (?<text>.*)$
+      REGEXP
+      LOCALITY_RE = Regexp.new(LOCALITY_REGEX_STR.gsub(/\s/, ""),
+                               Regexp::IGNORECASE | Regexp::MULTILINE)
+
+      def tq(text)
+        text.sub(/^"/, "").sub(/"$/, "")
+      end
+
+      def extract_localities(elem)
+        f = elem&.children&.first or return
+        f.text? or return
+        head = f.remove.text
+        tail = elem&.children&.remove
+        extract_localities1(elem, head)
+        tail and elem << tail
+      end
+
+      def extract_localities1(elem, text)
+        b = elem.add_child("<localityStack/>").first if LOCALITY_RE.match text
+        while (m = LOCALITY_RE.match text)
+          ref = m[:ref] ? "<referenceFrom>#{tq m[:ref]}</referenceFrom>" : ""
+          refto = m[:to] ? "<referenceTo>#{tq m[:to]}</referenceTo>" : ""
+          b.add_child("<locality type='#{locality_label(m)}'>#{ref}#{refto}"\
+                      "</locality>")
+          text = m[:text]
+          b = elem.add_child("<localityStack/>").first if m[:punct] == ";"
+        end
+        elem.add_child(text) if text
+      end
+
+      def locality_label(match)
+        loc = match[:locality] || match[:locality2]
+        /^locality:/.match?(loc) ? loc : loc&.downcase
+      end
+
+      def xref_to_eref(elem)
+        elem["bibitemid"] = elem["target"]
+        unless elem["citeas"] = @anchors&.dig(elem["target"], :xref)
+          @internal_eref_namespaces.include?(elem["type"]) or
+            @log.add("Crossreferences", elem,
+                     "#{elem['target']} does not have a corresponding "\
+                     "anchor ID in the bibliography!")
+        end
+        elem.delete("target")
+        extract_localities(elem) unless elem.children.empty?
+      end
+
+      def xref_cleanup(xmldoc)
+        xmldoc.xpath("//xref").each do |x|
+          /:/.match(x["target"]) and xref_to_internal_eref(x)
+          next unless x.name == "xref"
+
+          if refid? x["target"]
+            x.name = "eref"
+            xref_to_eref(x)
+          else x.delete("type")
+          end
+        end
+      end
+
+      def xref_to_internal_eref(elem)
+        a = elem["target"].split(":", 3)
+        unless a.size < 2 || a[0].empty? || a[1].empty?
+          elem["target"] = "#{a[0]}_#{a[1]}"
+          a.size > 2 and
+            elem.children = %{anchor="#{a[2..-1].join}",#{elem&.children&.text}}
+          elem["type"] = a[0]
+          @internal_eref_namespaces << a[0]
+          elem.name = "eref"
+          xref_to_eref(elem)
+        end
+      end
+
+      def quotesource_cleanup(xmldoc)
+        xmldoc.xpath("//quote/source | //terms/source").each do |x|
+          xref_to_eref(x)
+        end
+      end
+
+      def origin_cleanup(xmldoc)
+        xmldoc.xpath("//origin/concept[termref]").each do |x|
+          t = x.at("./termref")
+          x.replace(t)
+        end
+        xmldoc.xpath("//origin").each do |x|
+          x["citeas"] = @anchors&.dig(x["bibitemid"], :xref) or
+            @log.add("Crossreferences", x,
+                     "#{x['bibitemid']} does not have a corresponding anchor "\
+                     "ID in the bibliography!")
+          extract_localities(x) unless x.children.empty?
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/converter.rb

@@ -49,6 +49,7 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::FormSelectMacro
         inline_macro Asciidoctor::Standoc::FormOptionMacro
         inline_macro Asciidoctor::Standoc::ToCInlineMacro
+        inline_macro Asciidoctor::Standoc::PassInlineMacro
         inline_macro Metanorma::Plugin::Lutaml::LutamlFigureInlineMacro
         inline_macro Metanorma::Plugin::Lutaml::LutamlTableInlineMacro
         block_macro Metanorma::Plugin::Lutaml::LutamlDiagramBlockMacro
@@ -98,6 +99,17 @@ module Asciidoctor
         File.join(@libdir, "../../isodoc/html", file)
       end
 
+      def content(node)
+        node.content
+      end
+
+      def skip(node, name = nil)
+        name = name || node.node_name
+        w = "converter missing for #{name} node in Metanorma backend"
+        @log.add("AsciiDoc Input", node, w)
+        nil
+      end
+
       alias_method :embedded, :content
       alias_method :verse, :quote
       alias_method :audio, :skip

data/lib/asciidoctor/standoc/isodoc.rng

@@ -1036,6 +1036,7 @@
       <ref name="svgmap"/>
       <ref name="inputform"/>
       <ref name="toc"/>
+      <ref name="passthrough"/>
     </choice>
   </define>
   <define name="toc">
@@ -1043,6 +1044,14 @@
       <ref name="ul"/>
     </element>
   </define>
+  <define name="passthrough">
+    <element name="passthrough">
+      <optional>
+        <attribute name="formats"/>
+      </optional>
+      <text/>
+    </element>
+  </define>
   <define name="inputform">
     <element name="form">
       <attribute name="id">