metanorma-ogc 1.0.6 → 1.1.1

data/lib/isodoc/ogc/pdf_convert.rb

@@ -19,19 +19,6 @@ module IsoDoc
         standard user-guide test-suite white-paper).include? doctype
         "ogc.#{doctype}.xsl"
       end
-
-      def convert(filename, file = nil, debug = false)
-        file = File.read(filename, encoding: "utf-8") if file.nil?
-        docxml, outname_html, dir = convert_init(file, filename, debug)
-        /\.xml$/.match(filename) or
-          filename = Tempfile.open([outname_html, ".xml"], encoding: "utf-8") do |f|
-          f.write file
-          f.path
-        end
-        FileUtils.rm_rf dir
-        ::Metanorma::Output::XslfoPdf.new.convert(
-          filename, outname_html + ".pdf", File.join(@libdir, pdf_stylesheet(docxml)))
-      end
     end
   end
 end

data/lib/isodoc/ogc/presentation_xml_convert.rb

@@ -0,0 +1,10 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module Ogc
+    class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+    end
+  end
+end
+

data/lib/isodoc/ogc/reqt.rb

@@ -1,6 +1,4 @@
 require "isodoc"
-require_relative "metadata"
-require "fileutils"
 
 module IsoDoc
   module Ogc
@@ -14,27 +12,38 @@ module IsoDoc
       end
 
       def recommend_table_attr(node)
-        attr_code(id: node["id"], 
-                  class: recommend_class(node),
-                  style: "border-collapse:collapse;border-spacing:0;")
+        attr_code(id: node["id"], class: recommend_class(node),
+                  style: "border-collapse:collapse;border-spacing:0;"\
+                 "#{keep_style(node)}")
       end
 
       REQ_TBL_ATTR =
         { style: "vertical-align:top;", class: "recommend" }.freeze
 
+      def recommendation_class(node)
+        %w(verification abstracttest).include?(node["type"]) ?
+                  "RecommendationTestTitle" : "RecommendationTitle"
+      end
+
       def recommendation_name(node, out, type)
         label, title, lbl = recommendation_labels(node)
-        out.p **{ class: %w(verification abstracttest).include?(node["type"]) ?
-                  "RecommendationTestTitle" : "RecommendationTitle" }  do |b|
-          lbl = anchor(node['id'], :label, false)
-          b << (lbl.nil? ? l10n("#{type}:") : l10n("#{type} #{lbl}:"))
-          if title
-            b << " "
-            title.children.each { |n| parse(n,b) }
+        out.p **{ class: recommendation_class(node) } do |b|
+          if inject_crossreference_reqt?(node, label)
+            lbl = @xrefs.anchor(@xrefs.reqtlabels[label.text], :xref, false)
+            b << (lbl.nil? ? l10n("#{type}:") : l10n("#{lbl}:"))
+          else
+            b << (lbl.nil? ? l10n("#{type}:") : l10n("#{type} #{lbl}:"))
           end
+          recommendation_name1(title, node, label, b)
         end
       end
 
+      def recommendation_name1(title, node, label, b)
+        return unless  title && !inject_crossreference_reqt?(node, label)
+        b << " "
+        title.children.each { |n| parse(n,b) }
+      end
+
       def recommend_title(node, out)
         label = node.at(ns("./label")) or return
         out.tr do |tr|
@@ -46,6 +55,12 @@ module IsoDoc
         end
       end
 
+      # embedded reqts xref to top level reqts via label lookup
+      def inject_crossreference_reqt?(node, label)
+        !node.ancestors("requirement, recommendation, permission").empty? &&
+          @xrefs.reqtlabels[label&.text]
+      end
+
       def recommendation_attributes1(node)
         out = []
         oblig = node["obligation"] and out << ["Obligation", oblig]
@@ -61,7 +76,7 @@ module IsoDoc
 
       def rec_subj(node)
         %w(class conformanceclass).include?(node["type"]) ?
-                  "Target Type" : "Subject"
+          "Target Type" : "Subject"
       end
 
       def recommendation_attr_parse(node, label)
@@ -78,9 +93,7 @@ module IsoDoc
       end
 
       def recommendation_attributes(node, out)
-        ret = recommendation_attributes1(node)
-        return if ret.empty?
-        ret.each do |i|
+        recommendation_attributes1(node).each do |i|
           out.tr do |tr|
             tr.td **REQ_TBL_ATTR do |td|
               td << i[0]
@@ -92,12 +105,17 @@ module IsoDoc
         end
       end
 
+      def reqt_component_attrs(node)
+        attr_code(style: keep_style(node))
+      end
+
       def requirement_component_parse(node, out)
         return if node["exclude"] == "true"
         node.elements.size == 1 && node.first_element_child.name == "dl" and
           return reqt_dl(node.first_element_child, out)
         out.tr do |tr|
-          tr.td **REQ_TBL_ATTR.merge(colspan: 2) do |td|
+          tr.td **REQ_TBL_ATTR.merge(colspan: 2).
+            merge(reqt_component_attrs(node)) do |td|
             node.children.each { |n| parse(n, td) }
           end
         end
@@ -141,125 +159,31 @@ module IsoDoc
       end
 
       def recommendation_parse(node, out)
-        label = case node["type"]
-                when "verification" then @labels["recommendationtest"]
-                when "class" then @labels["recommendationclass"]
-                when "abstracttest" then @labels["abstracttest"]
-                when "conformanceclass" then @labels["conformanceclass"]
-                else
-                  @recommendation_lbl
-                end
-        recommendation_parse1(node, out, label)
-      end
-
-      def requirement_parse(node, out)
-        label = case node["type"]
-                when "verification" then @labels["requirementtest"]
-                when "class" then @labels["requirementclass"]
-                when "abstracttest" then @labels["abstracttest"]
-                when "conformanceclass" then @labels["conformanceclass"]
-                else
-                  @requirement_lbl
-                end
-        recommendation_parse1(node, out, label)
+        recommendation_parse0(node, out, "recommendation")
       end
 
-      def permission_parse(node, out)
+      def recommendation_parse0(node, out, r)
         label = case node["type"]
-                when "verification" then @labels["permissiontest"]
-                when "class" then @labels["permissionclass"]
+                when "verification" then @labels["#{r}test"]
+                when "class" then @labels["#{r}class"]
                 when "abstracttest" then @labels["abstracttest"]
                 when "conformanceclass" then @labels["conformanceclass"]
-                else
-                  @permission_lbl
+                else 
+                  case r
+                  when "recommendation" then @recommendation_lbl
+                  when "requirement" then @requirement_lbl
+                  when "permission" then @permission_lbl
+                  end
                 end
         recommendation_parse1(node, out, label)
       end
 
-      FIRST_LVL_REQ = IsoDoc::Function::XrefGen::FIRST_LVL_REQ
-
-      def sequential_permission_names(clause, klass, label)
-        c = ::IsoDoc::Function::XrefGen::Counter.new
-        clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
-          next if t["id"].nil? || t["id"].empty?
-          id = c.increment(t).print
-          @anchors[t["id"]] = anchor_struct(id, t, label, klass, t["unnumbered"])
-          sequential_permission_children(t, id)
-        end
-      end
-
-      def req_class_paths
-        {  
-          "class" => "@type = 'class'", 
-          "test" => "@type = 'verification'", 
-          "" => "not(@type = 'verification' or @type = 'class' or @type = 'abstracttest' or @type = 'conformanceclass')",
-        }
-      end
-
-      def req_class_paths2
-        {
-          "abstracttest" => "@type = 'abstracttest'",
-          "conformanceclass" => "@type = 'conformanceclass'",
-        }
-      end
-
-      def sequential_permission_children(t, id)
-        req_class_paths.each do |k, v|
-          sequential_permission_names1(t, id, "permission[#{v}]", @labels["permission#{k}"])
-          sequential_permission_names1(t, id, "requirement[#{v}]", @labels["requirement#{k}"])
-          sequential_permission_names1(t, id, "recommendation[#{v}]",  @labels["recommendation#{k}"])
-        end
-        req_class_paths2.each do |k, v|
-          sequential_permission_names1(t, id, "*[#{v}]", @labels[k])
-        end
-      end
-
-      def sequential_permission_names1(block, lbl, klass, label)
-        c = ::IsoDoc::Function::XrefGen::Counter.new
-        block.xpath(ns("./#{klass}")).each do |t|
-          next if t["id"].nil? || t["id"].empty?
-          id = "#{lbl}#{hierfigsep}#{c.increment(t).print}"
-          @anchors[t["id"]] = anchor_struct(id, t, label, klass, t["unnumbered"])
-          sequential_permission_children(t, id)
-        end
-      end
-
-      def sequential_asset_names(clause)
-        sequential_table_names(clause)
-        sequential_figure_names(clause)
-        sequential_formula_names(clause)
-        req_class_paths.each do |k, v|
-          sequential_permission_names(clause, "permission[#{v}]", @labels["permission#{k}"])
-          sequential_permission_names(clause, "requirement[#{v}]", @labels["requirement#{k}"])
-          sequential_permission_names(clause, "recommendation[#{v}]",  @labels["recommendation#{k}"])
-        end
-        req_class_paths2.each do |k, v|
-          sequential_permission_names(clause, "*[#{v}]", @labels[k])
-        end
-      end
-
-      def hierarchical_asset_names(clause, num)
-        hierarchical_table_names(clause, num)
-        hierarchical_figure_names(clause, num)
-        hierarchical_formula_names(clause, num)
-        req_class_paths.each do |k, v|
-          hierarchical_permission_names(clause, num, "permission[#{v}]", @labels["permission#{k}"])
-          hierarchical_permission_names(clause, num, "requirement[#{v}]", @labels["requirement#{k}"])
-          hierarchical_permission_names(clause, num, "recommendation[#{v}]",  @labels["recommendation#{k}"])
-        end
-        req_class_paths2.each do |k, v|
-          hierarchical_permission_names(clause, num, "*[#{v}]", @labels[k])
-        end
+      def requirement_parse(node, out)
+        recommendation_parse0(node, out, "requirement")
       end
 
-      def hierarchical_permission_names(clause, num, klass, label)
-        c = ::IsoDoc::Function::XrefGen::Counter.new
-        clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
-          next if t["id"].nil? || t["id"].empty?
-          lbl = "#{num}#{hiersep}#{c.increment(t).print}"
-          @anchors[t["id"]] = anchor_struct(lbl, t, label, klass, t["unnumbered"])
-          sequential_permission_children(t, lbl)
-        end
+      def permission_parse(node, out)
+        recommendation_parse0(node, out, "permission")
       end
     end
   end

data/lib/isodoc/ogc/sections.rb

@@ -3,7 +3,7 @@ module IsoDoc
     module BaseConvert
       def annex_name(annex, name, div)
         div.h1 **{ class: "Annex" } do |t|
-          t << "#{anchor(annex['id'], :label)} "
+          t << "#{@xrefs.anchor(annex['id'], :label)} "
           t.br
           t.b do |b|
             name&.children&.each { |c2| parse(c2, b) }
@@ -24,12 +24,13 @@ module IsoDoc
         end
       end
 
-      SUBMITTINGORGS =
-        "//bibdata/contributor[role/@type = 'author']/organization/name".freeze
+      def submittingorgs_path
+        "//bibdata/contributor[role/@type = 'author']/organization/name"
+      end
 
       def submittingorgs(docxml, out)
         orgs = []
-        docxml.xpath(ns(SUBMITTINGORGS)).each { |org| orgs << org.text }
+        docxml.xpath(ns(submittingorgs_path)).each { |org| orgs << org.text }
         return if orgs.empty?
         @prefacenum += 1
         out.div **{ class: "Section3" } do |div|
@@ -47,7 +48,7 @@ module IsoDoc
         f = docxml.at(ns("//submitters")) || return
         @prefacenum += 1
         out.div **{ class: "Section3" } do |div|
-          clause_name(anchor(f['id'], :label), "Submitters", div,
+          clause_name(@xrefs.anchor(f['id'], :label), "Submitters", div,
                       class: "IntroTitle")
           f.elements.each { |e| parse(e, div) unless e.name == "title" }
         end
@@ -70,7 +71,7 @@ module IsoDoc
         @prefacenum += 1
         page_break(out)
         out.div **attr_code(id: f["id"]) do |s|
-          clause_name(anchor(f["id"], :label), @abstract_lbl, s,
+          clause_name(@xrefs.anchor(f["id"], :label), @abstract_lbl, s,
                       class: "AbstractTitle")
           f.elements.each { |e| parse(e, s) unless e.name == "title" }
         end
@@ -81,7 +82,7 @@ module IsoDoc
         @prefacenum += 1
         page_break(out)
         out.div **attr_code(id: f["id"]) do |s|
-          clause_name(anchor(f["id"], :label), @foreword_lbl, s,
+          clause_name(@xrefs.anchor(f["id"], :label), @foreword_lbl, s,
                       class: "ForewordTitle")
           f.elements.each { |e| parse(e, s) unless e.name == "title" }
         end
@@ -91,7 +92,7 @@ module IsoDoc
         f = isoxml.at(ns("//acknowledgements")) || return
         @prefacenum += 1
         out.div **{ class: "Section3", id: f["id"] } do |div|
-          clause_name(anchor(f["id"], :label), f&.at(ns("./title")), div,
+          clause_name(@xrefs.anchor(f["id"], :label), f&.at(ns("./title")), div,
                       class: "IntroTitle")
           f.elements.each { |e| parse(e, div) unless e.name == "title" }
         end

data/lib/isodoc/ogc/word_convert.rb

@@ -18,9 +18,9 @@ module IsoDoc
         {
           bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' :
                      '"Times New Roman",serif'),
-          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' :
-                       '"Times New Roman",serif'),
-          monospacefont: '"Courier New",monospace'
+                     headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' :
+                                  '"Times New Roman",serif'),
+                                  monospacefont: '"Courier New",monospace'
         }
       end
 
@@ -36,10 +36,6 @@ module IsoDoc
         }
       end
 
-      def metadata_init(lang, script, labels)
-        @meta = Metadata.new(lang, script, labels)
-      end
-
       def make_body(xml, docxml)
         body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72" }
         xml.body **body_attr do |body|
@@ -71,15 +67,15 @@ module IsoDoc
                           <span lang="EN-GB"><span
         style='mso-element:field-begin'></span><span
         style='mso-spacerun:yes'>&#xA0;</span>TOC
-        \\h \\z \\t &quot;RecommendationTitle,1&quot; <span
-        style='mso-element:field-separator'></span></span>
+        \\h \\z \\t &quot;RecommendationTitle,recommendationtitle&quot; 
+        <span style='mso-element:field-separator'></span></span>
       TOC
 
       WORD_TOC_TABLE_PREFACE1 = <<~TOC.freeze
                           <span lang="EN-GB"><span
         style='mso-element:field-begin'></span><span
         style='mso-spacerun:yes'>&#xA0;</span>TOC
-        \\h \\z \\t &quot;TableTitle,1&quot; <span
+        \\h \\z \\t &quot;TableTitle,tabletitle&quot; <span
         style='mso-element:field-separator'></span></span>
       TOC
 
@@ -87,7 +83,7 @@ module IsoDoc
                                       <span lang="EN-GB"><span
         style='mso-element:field-begin'></span><span
         style='mso-spacerun:yes'>&#xA0;</span>TOC
-        \\h \\z \\t &quot;FigureTitle,1&quot; <span
+        \\h \\z \\t &quot;FigureTitle,figuretitle&quot; <span
         style='mso-element:field-separator'></span></span>
       TOC
 
@@ -185,11 +181,6 @@ module IsoDoc
         end
       end
 
-      def authority_cleanup(docxml)
-        docxml&.at("//div[@id = 'boilerplate-contact']")&.remove
-        super
-      end
-
       include BaseConvert
     end
   end

data/lib/isodoc/ogc/xref.rb

@@ -0,0 +1,158 @@
+module IsoDoc
+  module Ogc
+    class Xref < IsoDoc::Xref
+      def initialize(lang, script, klass, labels, options)
+        @reqtlabels = {}
+        super
+      end
+
+      def reqtlabels
+        @reqtlabels
+      end
+
+      FIRST_LVL_REQ = IsoDoc::XrefGen::Blocks::FIRST_LVL_REQ
+
+      def sequential_permission_names(clause, klass, label)
+        c = ::IsoDoc::XrefGen::Counter.new
+        clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
+          next if t["id"].nil? || t["id"].empty?
+          id = c.increment(t).print
+          @anchors[t["id"]] = anchor_struct(id, t, label, klass, t["unnumbered"])
+          l = t.at(ns("./label"))&.text and @reqtlabels[l] = t["id"]
+          sequential_permission_children(t, id)
+        end
+      end
+
+      def req_class_paths
+        { "class" => "@type = 'class'", 
+          "test" => "@type = 'verification'", 
+          "" => "not(@type = 'verification' or @type = 'class' or "\
+          "@type = 'abstracttest' or @type = 'conformanceclass')", }
+      end
+
+      def req_class_paths2
+        { "abstracttest" => "@type = 'abstracttest'",
+          "conformanceclass" => "@type = 'conformanceclass'", }
+      end
+
+      def sequential_permission_children(t, id)
+        req_class_paths.each do |k, v|
+          %w(permission requirement recommendation).each do |r|
+            sequential_permission_names1(t, id, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            sequential_permission_names1(t, id, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            sequential_permission_names1(t, id, "#{r}[#{v}]", @labels["#{r}#{k}"])
+          end
+        end
+        req_class_paths2.each do |k, v|
+          sequential_permission_names1(t, id, "*[#{v}]", @labels[k])
+        end
+      end
+
+      def sequential_permission_names1(block, lbl, klass, label)
+        c = ::IsoDoc::XrefGen::Counter.new
+        block.xpath(ns("./#{klass}")).each do |t|
+          next if t["id"].nil? || t["id"].empty?
+          id = "#{lbl}#{hierfigsep}#{c.increment(t).print}"
+          @anchors[t["id"]] = anchor_struct(id, t, label, klass, t["unnumbered"])
+          sequential_permission_children(t, id)
+        end
+      end
+
+      def sequential_asset_names(clause)
+        sequential_table_names(clause)
+        sequential_figure_names(clause)
+        sequential_formula_names(clause)
+        req_class_paths.each do |k, v|
+          %w(permission requirement recommendation).each do |r|
+            sequential_permission_names(clause, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            sequential_permission_names(clause, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            sequential_permission_names(clause, "#{r}[#{v}]", @labels["#{r}#{k}"])
+          end
+        end
+        req_class_paths2.each do |k, v|
+          sequential_permission_names(clause, "*[#{v}]", @labels[k])
+        end
+      end
+
+      def hierarchical_asset_names(clause, num)
+        hierarchical_table_names(clause, num)
+        hierarchical_figure_names(clause, num)
+        hierarchical_formula_names(clause, num)
+        req_class_paths.each do |k, v|
+          %w(permission requirement recommendation).each do |r|
+            hierarchical_permission_names(clause, num, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            hierarchical_permission_names(clause, num, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            hierarchical_permission_names(clause, num, "#{r}[#{v}]",  @labels["#{r}#{k}"])
+          end
+        end
+        req_class_paths2.each do |k, v|
+          hierarchical_permission_names(clause, num, "*[#{v}]", @labels[k])
+        end
+      end
+
+      def hierarchical_permission_names(clause, num, klass, label)
+        c = ::IsoDoc::XrefGen::Counter.new
+        clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
+          next if t["id"].nil? || t["id"].empty?
+          lbl = "#{num}#{hiersep}#{c.increment(t).print}"
+          @anchors[t["id"]] = anchor_struct(lbl, t, label, klass, t["unnumbered"])
+          l = t.at(ns("./label"))&.text and @reqtlabels[l] = t["id"]
+          sequential_permission_children(t, lbl)
+        end
+      end
+
+      def initial_anchor_names(d)
+        @prefacenum = 0
+        preface_names_numbered(d.at(ns("//preface/abstract")))
+        @prefacenum += 1 if d.at(ns("//keyword"))
+        preface_names_numbered(d.at(ns("//foreword")))
+        preface_names_numbered(d.at(ns("//introduction")))
+        @prefacenum += 1 if d.at(ns(@klass.submittingorgs_path))
+        preface_names_numbered(d.at(ns("//submitters")))
+        d.xpath(ns("//preface/clause")).each do |c|
+          preface_names_numbered(c)
+        end
+        preface_names_numbered(d.at(ns("//acknowledgements")))
+        sequential_asset_names(d.xpath(ns(
+          "//preface/abstract | //foreword | //introduction | "\
+          "//submitters | //acknowledgements | //preface/clause")))
+        n = section_names(d.at(ns("//clause[title = 'Scope']")), 0, 1)
+        n = section_names(d.at(ns("//clause[title = 'Conformance']")), n, 1)
+        n = section_names(d.at(ns(
+          "//references[title = 'Normative References' or "\
+          "title = 'Normative references']")), n, 1)
+        n = section_names(
+          d.at(ns("//sections/terms | //sections/clause[descendant::terms]")),
+          n, 1)
+        n = section_names(d.at(ns("//sections/definitions")), n, 1)
+        middle_section_asset_names(d)
+        clause_names(d, n)
+        termnote_anchor_names(d)
+        termexample_anchor_names(d)
+      end
+
+      def middle_section_asset_names(d)
+        middle_sections = "//clause[title = 'Scope' or title = 'Conformance'] "\
+          "| //foreword | //introduction | //preface/abstract | "\
+          "//submitters | //acknowledgements | //preface/clause | "\
+          "//references[title = 'Normative References' or title = "\
+          "'Normative references'] | //sections/terms | "\
+          "//sections/definitions | //clause[parent::sections]"
+        sequential_asset_names(d.xpath(ns(middle_sections)))
+      end
+
+      def preface_names_numbered(clause)
+        return if clause.nil?
+        @prefacenum += 1
+        pref = RomanNumerals.to_roman(@prefacenum).downcase
+        @anchors[clause["id"]] =
+          { label: pref,
+            level: 1, xref: preface_clause_name(clause), type: "clause" }
+        clause.xpath(ns("./clause | ./terms | ./term | ./definitions | "\
+                        "./references")).each_with_index do |c, i|
+          section_names1(c, "#{pref}.#{i + 1}", 2)
+        end
+      end
+    end
+  end
+end