Caption refactor Presentation XML: https://github.com/metanorma/isodo…

lib/isodoc/function/blocks.rb

@@ -25,9 +25,9 @@ def figure_parse(node, out)
       def figure_parse1(node, out)
         out.div **figure_attrs(node) do |div|
           node.children.each do |n|
-            parse(n, div) unless n.name == "name"
+            parse(n, div) unless n.name == "fmt-name"
           end
-          figure_name_parse(node, div, node.at(ns("./name")))
+          figure_name_parse(node, div, node.at(ns("./fmt-name")))
         end
       end
 
@@ -37,9 +37,9 @@ def pseudocode_attrs(node)
 
       def pseudocode_parse(node, out)
         @in_figure = true
-        name = node.at(ns("./name"))
+        name = node.at(ns("./fmt-name"))
         out.div **pseudocode_attrs(node) do |div|
-          node.children.each { |n| parse(n, div) unless n.name == "name" }
+          node.children.each { |n| parse(n, div) unless n.name == "fmt-name" }
           sourcecode_name_parse(node, div, name)
         end
         @in_figure = false
@@ -57,7 +57,7 @@ def sourcecode_attrs(node)
       end
 
       def sourcecode_parse(node, out)
-        name = node.at(ns("./name"))
+        name = node.at(ns("./fmt-name"))
         out.p **sourcecode_attrs(node) do |div|
           sourcecode_parse1(node, div)
         end
@@ -71,7 +71,7 @@ def sourcecode_parse1(node, div)
           node.at("./ancestor::xmlns:table[@class = 'rouge-line-table']") and
           @sourcecode = "table"
         node.children.each do |n|
-          %w(name dl).include?(n.name) and next
+          %w(fmt-name dl).include?(n.name) and next
           parse(n, div)
         end
         @sourcecode = false
@@ -93,7 +93,7 @@ def formula_parse1(node, out)
         out.div **attr_code(class: "formula") do |div|
           div.p do |_p|
             parse(node.at(ns("./stem")), div)
-            if lbl = node&.at(ns("./name"))&.text
+            if lbl = node&.at(ns("./fmt-name"))&.text
               insert_tab(div, 1)
               div << lbl
             end
@@ -109,7 +109,7 @@ def formula_parse(node, out)
         out.div **formula_attrs(node) do |div|
           formula_parse1(node, div)
           node.children.each do |n|
-            %w(stem name).include? n.name and next
+            %w(stem fmt-name).include? n.name and next
             parse(n, div)
           end
         end

lib/isodoc/function/blocks_example_note.rb

@@ -19,9 +19,9 @@ def example_div_attr(node)
       # used if we are boxing examples
       def example_div_parse(node, out)
         out.div **example_div_attr(node) do |div|
-          example_label(node, div, node.at(ns("./name")))
+          example_label(node, div, node.at(ns("./fmt-name")))
           node.children.each do |n|
-            parse(n, div) unless n.name == "name"
+            parse(n, div) unless n.name == "fmt-name"
           end
         end
       end
@@ -39,10 +39,12 @@ def example_table_parse(node, out)
         out.table **example_table_attr(node) do |t|
           t.tr do |tr|
             tr.td **EXAMPLE_TBL_ATTR do |td|
-              example_label(node, td, node.at(ns("./name")))
+              example_label(node, td, node.at(ns("./fmt-name")))
             end
             tr.td **EXAMPLE_TD_ATTR do |td|
-              node.children.each { |n| parse(n, td) unless n.name == "name" }
+              node.children.each do |n|
+                parse(n, td) unless n.name == "fmt-name"
+              end
             end
           end
         end
@@ -52,26 +54,40 @@ def example_parse(node, out)
         example_div_parse(node, out)
       end
 
+      def starts_with_para?(node)
+        node.elements.each do |n|
+          %w(title fmt-title fmt-xref-label fmt-name name).include?(n) and next
+          n.name == "p" and return true
+        end
+        false
+      end
+
+      def note_p_class
+        nil
+      end
+
       def note_p_parse(node, div)
-        name = node.at(ns("./name"))&.remove
-        div.p do |p|
+        name = node.at(ns("./fmt-name"))
+        para = node.at(ns("./p"))
+        div.p **attr_code(class: note_p_class) do |p|
           name and p.span class: "note_label" do |s|
             name.children.each { |n| parse(n, s) }
           end
-          insert_tab(p, 1)
-          node.first_element_child.children.each { |n| parse(n, p) }
+          insert_tab(p, 1) # TODO to Presentation XML
+          children_parse(para, p)
         end
-        node.element_children[1..].each { |n| parse(n, div) }
+        para.xpath("./following-sibling::*").each { |n| parse(n, div) }
       end
 
       def note_parse1(node, div)
-        name = node.at(ns("./name")) and div.p do |p|
-          p.span class: "note_label" do |s|
-            name.remove.children.each { |n| parse(n, s) }
+        name = node.at(ns("./fmt-name")) and
+          div.p **attr_code(class: note_p_class) do |p|
+            p.span class: "note_label" do |s|
+              name.remove.children.each { |n| parse(n, s) }
+            end
+            insert_tab(p, 1) # TODO to Presentation XML
           end
-          insert_tab(p, 1)
-        end
-        node.children.each { |n| parse(n, div) }
+        children_parse(node, div)
       end
 
       def keep_style(node)
@@ -94,7 +110,7 @@ def note_attrs(node)
       def note_parse(node, out)
         @note = true
         out.div **note_attrs(node) do |div|
-          if node&.at(ns("./*[local-name() != 'name'][1]"))&.name == "p"
+          if starts_with_para?(node)
             note_p_parse(node, div)
           else
             note_parse1(node, div)
@@ -105,7 +121,7 @@ def note_parse(node, out)
 
       def admonition_name_parse(_node, div, name)
         div.p class: "AdmonitionTitle", style: "text-align:center;" do |p|
-          name.children.each { |n| parse(n, p) }
+          children_parse(name, p)
         end
       end
 
@@ -114,7 +130,7 @@ def admonition_class(_node)
       end
 
       def admonition_name(node, _type)
-        node&.at(ns("./name"))
+        node&.at(ns("./fmt-name"))
       end
 
       def admonition_attrs(node)
@@ -124,7 +140,7 @@ def admonition_attrs(node)
 
       def admonition_parse(node, out)
         out.div **admonition_attrs(node) do |div|
-          if node&.at(ns("./*[local-name() != 'name'][1]"))&.name == "p"
+          if starts_with_para?(node)
             admonition_p_parse(node, div)
           else
             admonition_parse1(node, div)
@@ -139,14 +155,16 @@ def admonition_p_parse(node, div)
 
       # code to allow name and first paragraph to be rendered in same block
       def admonition_name_in_first_para(node, div)
+        name = node.at(ns("./fmt-name"))
+        para = node.at(ns("./p"))
         div.p do |p|
           if name = admonition_name(node, node["type"])&.remove
             name.children.each { |n| parse(n, p) }
-            admonition_name_para_delim(p)
+            admonition_name_para_delim(p) # TODO to Presentation XML
           end
-          node.first_element_child.children.each { |n| parse(n, p) }
+          para.children.each { |n| parse(n, p) }
         end
-        node.element_children[1..].each { |n| parse(n, div) }
+        para.xpath("./following-sibling::*").each { |n| parse(n, div) }
       end
 
       def admonition_name_para_delim(para)
@@ -158,7 +176,7 @@ def admonition_parse1(node, div)
         if name
           admonition_name_parse(node, div, name)
         end
-        node.children.each { |n| parse(n, div) unless n.name == "name" }
+        node.children.each { |n| parse(n, div) unless n.name == "fmt-name" }
       end
     end
   end

lib/isodoc/function/inline.rb

@@ -17,13 +17,19 @@ def link_parse(node, out)
 
       def location_parse(node, out); end
 
+      # Presentation XML classes which we need not pass on to HTML or DOC
+      SPAN_UNWRAP_CLASSES =
+        %w[fmt-caption-label fmt-label-delim fmt-caption-delim fmt-autonum-delim
+           fmt-element-name].freeze
+
       def span_parse(node, out)
-        if node["style"] || node["class"]
+        klass = node["style"] || node["class"]
+        if klass && !SPAN_UNWRAP_CLASSES.include?(klass)
           out.span **attr_code(style: node["style"],
                                class: node["class"]) do |s|
-            node.children.each { |n| parse(n, s) }
+            children_parse(node, s)
           end
-        else node.children.each { |n| parse(n, out) }
+        else children_parse(node, out)
         end
       end
 
@@ -48,9 +54,8 @@ def xref_parse(node, out)
       end
 
       def suffix_url(url)
-        return url if url.nil? || %r{^https?://|^#}.match?(url)
-        return url unless File.extname(url).empty?
-
+        url.nil? || %r{^https?://|^#}.match?(url) and return url
+        File.extname(url).empty? or return url
         url.sub(/#{File.extname(url)}$/, ".html")
       end
 
@@ -136,8 +141,7 @@ def smallcap_parse(node, xml)
       end
 
       def text_parse(node, out)
-        return if node.nil? || node.text.nil?
-
+        node.nil? || node.text.nil? and return
         text = node.to_s
         @sourcecode == "pre" and
           text = text.gsub("\n", "<br/>").gsub("<br/> ", "<br/>&#xa0;")
@@ -184,8 +188,20 @@ def rb_parse(node, out)
       end
 
       def author_parse(node, out)
+        children_parse(node, out)
+      end
+
+      def semx_parse(node, out)
+        children_parse(node, out)
+      end
+
+      def children_parse(node, out)
         node.children.each { |n| parse(n, out) }
       end
+
+      def xref_label_parse(node, out); end
+
+      def name_parse(node, out); end
     end
   end
 end

lib/isodoc/function/lists.rb

@@ -2,7 +2,7 @@ module IsoDoc
   module Function
     module Lists
       def list_title_parse(node, out)
-        name = node.at(ns("./name")) or return
+        name = node.at(ns("./fmt-name")) or return
         out.p class: "ListTitle" do |p|
           name.children&.each { |n| parse(n, p) }
         end
@@ -16,7 +16,7 @@ def ul_parse(node, out)
         out.div **attr_code(class: "ul_wrap") do |div|
           list_title_parse(node, div)
           div.ul **attr_code(ul_attrs(node)) do |ul|
-            node.children.each { |n| n.name == "name" or parse(n, ul) }
+            node.children.each { |n| n.name == "fmt-name" or parse(n, ul) }
           end
         end
       end
@@ -57,7 +57,7 @@ def ol_parse(node, out)
         out.div **attr_code(class: "ol_wrap") do |div|
           list_title_parse(node, div)
           div.ol **attr_code(ol_attrs(node)) do |ol|
-            node.children.each { |n| n.name == "name" or parse(n, ol) }
+            node.children.each { |n| n.name == "fmt-name" or parse(n, ol) }
           end
         end
       end
@@ -106,7 +106,7 @@ def dl_parse(node, out)
       end
 
       def dl_parse_notes(node, out)
-        node.elements.reject { |n| dt_dd?(n) || n.name == "name" }
+        node.elements.reject { |n| dt_dd?(n) || n.name == "fmt-name" }
           .each { |n| parse(n, out) }
       end
 

lib/isodoc/function/references.rb

@@ -41,9 +41,9 @@ def norm_ref_xpath
       def norm_ref(node, out)
         node["hidden"] != "true" or return
         out.div do |div|
-          clause_name(node, node.at(ns("./title")), div, nil)
+          clause_name(node, node.at(ns("./fmt-title")), div, nil)
           if node.name == "clause"
-            node.elements.each { |e| parse(e, div) unless e.name == "title" }
+            node.elements.each { |e| parse(e, div) unless e.name == "fmt-title" }
           else biblio_list(node, div, false)
           end
         end
@@ -60,7 +60,7 @@ def bibliography(node, out)
         page_break(out)
         out.div do |div|
           div.h1 class: "Section3" do |h1|
-            node.at(ns("./title"))&.children&.each { |c2| parse(c2, h1) }
+            node.at(ns("./fmt-title"))&.children&.each { |c2| parse(c2, h1) }
           end
           biblio_list(node, div, true)
         end
@@ -69,7 +69,7 @@ def bibliography(node, out)
       def bibliography_parse(node, out)
         node["hidden"] != true or return
         out.div do |div|
-          clause_parse_title(node, div, node.at(ns("./title")), out,
+          clause_parse_title(node, div, node.at(ns("./fmt-title")), out,
                              { class: "Section3" })
           biblio_list(node, div, true)
         end

lib/isodoc/function/reqt.rb

@@ -20,9 +20,9 @@ def recommendation_parse(node, out)
       end
 
       def recommendation_parse1(node, out)
-        recommendation_name(node.at(ns("./name")), out)
+        recommendation_name(node.at(ns("./fmt-name")), out)
         node.children.each do |n|
-          parse(n, out) unless n.name == "name"
+          parse(n, out) unless n.name == "fmt-name"
         end
       end