metanorma-ogc 1.0.2 → 1.0.7

data/lib/isodoc/ogc/pdf_convert.rb

@@ -1,96 +1,37 @@
 require_relative "base_convert"
-require "fileutils"
 require "isodoc"
-require_relative "metadata"
 
 module IsoDoc
   module Ogc
     # A {Converter} implementation that generates PDF HTML output, and a
     # document schema encapsulation of the document for validation
-    class PdfConvert < IsoDoc::PdfConvert
+    class PdfConvert < IsoDoc::XslfoPdfConvert
       def initialize(options)
         @libdir = File.dirname(__FILE__)
         super
-        #FileUtils.cp html_doc_path('logo.jpg'), "logo.jpg"
-        #@files_to_delete << "logo.jpg"
       end
 
-      def default_fonts(options)
-        {
-          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Overpass",sans-serif'),
-          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Overpass",sans-serif'),
-          monospacefont: '"Space Mono",monospace'
-        }
+      def pdf_stylesheet(docxml)
+        doctype = docxml&.at(ns("//bibdata/ext/doctype"))&.text
+        doctype = "other" unless %w(abstract-specification-topic best-practice
+        change-request-supporting-document community-practice community-standard 
+        discussion-paper engineering-report policy reference-model release-notes 
+        standard user-guide test-suite white-paper).include? doctype
+        "ogc.#{doctype}.xsl"
       end
 
-      def default_file_locations(_options)
-        {
-          htmlstylesheet: html_doc_path("htmlstyle.scss"),
-          htmlcoverpage: html_doc_path("html_ogc_titlepage.html"),
-          htmlintropage: html_doc_path("html_ogc_intro.html"),
-          scripts_pdf: html_doc_path("scripts.pdf.html"),
-        }
-      end
-
-      def metadata_init(lang, script, labels)
-        @meta = Metadata.new(lang, script, labels)
-      end
-
-      def googlefonts
-        <<~HEAD.freeze
-    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i|Space+Mono:400,700" rel="stylesheet" />
-    <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet" />
-    <link href="https://fonts.googleapis.com/css?family=Teko:300,400,500" rel="stylesheet">
-        HEAD
-      end
-
-      def admonition_class(node)
-        case node["type"]
-        when "important" then "Admonition.Important"
-        when "warning" then "Admonition.Warning"
-        else
-          "Admonition"
+      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
-
-      def make_body(xml, docxml)
-        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72", "xml:lang": "EN-US", class: "container" }
-        xml.body **body_attr do |body|
-          make_body1(body, docxml)
-          make_body2(body, docxml)
-          make_body3(body, docxml)
-        end
-      end
-
-      def html_toc(docxml)
-        docxml
-      end
-
-      def make_body3(body, docxml)
-        body.div **{ class: "main-section" } do |div3|
-          @prefacenum = 0
-          boilerplate docxml, div3
-          abstract docxml, div3
-          keywords docxml, div3
-          foreword docxml, div3
-          introduction docxml, div3
-          submittingorgs docxml, div3
-          submitters docxml, div3
-          preface docxml, div3
-          acknowledgements docxml, div3
-          middle docxml, div3
-          footnotes div3
-          comments div3
-        end
-      end
-
-       def authority_cleanup(docxml)
-        authority_cleanup1(docxml, "contact")
-        super
-      end
-
-      include BaseConvert
     end
   end
 end
-

data/lib/isodoc/ogc/reqt.rb

@@ -7,7 +7,9 @@ module IsoDoc
     module BaseConvert
       def recommend_class(node)
         return "recommendtest" if node["type"] == "verification"
+        return "recommendtest" if node["type"] == "abstracttest"
         return "recommendclass" if node["type"] == "class"
+        return "recommendclass" if node["type"] == "conformanceclass"
         "recommend"
       end
 
@@ -22,7 +24,7 @@ module IsoDoc
 
       def recommendation_name(node, out, type)
         label, title, lbl = recommendation_labels(node)
-        out.p **{ class: node["type"] == "verification" ?
+        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}:"))
@@ -47,25 +49,45 @@ module IsoDoc
       def recommendation_attributes1(node)
         out = []
         oblig = node["obligation"] and out << ["Obligation", oblig]
-        subj = node&.at(ns("./subject"))&.text and
-          out << [node["type"] == "class" ? "Target Type" : "Subject", subj]
-        node.xpath(ns("./inherit")).each { |i| out << ["Dependency", i.text] }
+        subj = node&.at(ns("./subject"))&.text and out << [rec_subj(node), subj]
+        node.xpath(ns("./inherit")).each do |i|
+          out << recommendation_attr_parse(i, "Dependency")
+        end
         node.xpath(ns("./classification")).each do |c|
-          tag = c.at(ns("./tag")) or next
-          value = c.at(ns("./value")) or next
-          out << [tag.text.capitalize, value.text]
+          line = recommendation_attr_keyvalue(c, "tag", "value") and out << line
         end
         out
       end
 
+      def rec_subj(node)
+        %w(class conformanceclass).include?(node["type"]) ?
+                  "Target Type" : "Subject"
+      end
+
+      def recommendation_attr_parse(node, label)
+        text = noko do |xml|
+          node.children.each { |n| parse(n, xml) }
+        end.join
+        [label, text]
+      end
+
+      def recommendation_attr_keyvalue(node, key, value)
+        tag = node.at(ns("./#{key}")) or return nil
+        value = node.at(ns("./#{value}")) or return nil
+        [tag.text.capitalize, value.text]
+      end
 
       def recommendation_attributes(node, out)
         ret = recommendation_attributes1(node)
         return if ret.empty?
         ret.each do |i|
           out.tr do |tr|
-            tr.td i[0], **REQ_TBL_ATTR
-            tr.td i[1], **REQ_TBL_ATTR
+            tr.td **REQ_TBL_ATTR do |td|
+              td << i[0]
+            end
+            tr.td **REQ_TBL_ATTR do |td|
+              td << i[1] 
+            end
           end
         end
       end
@@ -122,6 +144,8 @@ module IsoDoc
         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
@@ -132,6 +156,8 @@ module IsoDoc
         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
@@ -142,6 +168,8 @@ module IsoDoc
         label = case node["type"]
                 when "verification" then @labels["permissiontest"]
                 when "class" then @labels["permissionclass"]
+                when "abstracttest" then @labels["abstracttest"]
+                when "conformanceclass" then @labels["conformanceclass"]
                 else
                   @permission_lbl
                 end
@@ -160,16 +188,30 @@ module IsoDoc
         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)
-        sequential_permission_names1(t, id, "permission[not(@type = 'verification' or @type = 'class')]", @permission_lbl)
-        sequential_permission_names1(t, id, "requirement[not(@type = 'verification' or @type = 'class')]", @requirement_lbl)
-        sequential_permission_names1(t, id, "recommendation[not(@type = 'verification' or @type = 'class')]", @recommendation_lbl)
-        sequential_permission_names1(t, id, "permission[@type = 'verification']", @labels["permissiontest"])
-        sequential_permission_names1(t, id, "requirement[@type = 'verification']", @labels["requirementtest"])
-        sequential_permission_names1(t, id, "recommendation[@type = 'verification']", @labels["recommendationtest"])
-        sequential_permission_names1(t, id, "permission[@type = 'class']", @labels["permissionclass"])
-        sequential_permission_names1(t, id, "requirement[@type = 'class']", @labels["requirementclass"])
-        sequential_permission_names1(t, id, "recommendation[@type = 'class']", @labels["recommendationclass"])
+        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)
@@ -186,30 +228,28 @@ module IsoDoc
         sequential_table_names(clause)
         sequential_figure_names(clause)
         sequential_formula_names(clause)
-        sequential_permission_names(clause, "permission[not(@type = 'verification' or @type = 'class')]", @permission_lbl)
-        sequential_permission_names(clause, "requirement[not(@type = 'verification' or @type = 'class')]", @requirement_lbl)
-        sequential_permission_names(clause, "recommendation[not(@type = 'verification' or @type = 'class')]", @recommendation_lbl)
-        sequential_permission_names(clause, "permission[@type = 'verification']", @labels["permissiontest"])
-        sequential_permission_names(clause, "requirement[@type = 'verification']", @labels["requirementtest"])
-        sequential_permission_names(clause, "recommendation[@type = 'verification']", @labels["recommendationtest"])
-        sequential_permission_names(clause, "permission[@type = 'class']", @labels["permissionclass"])
-        sequential_permission_names(clause, "requirement[@type = 'class']", @labels["requirementclass"])
-        sequential_permission_names(clause, "recommendation[@type = 'class']", @labels["recommendationclass"])
+        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)
-        hierarchical_permission_names(clause, num, "permission[not(@type = 'verification' or @type = 'class')]", @permission_lbl)
-        hierarchical_permission_names(clause, num, "requirement[not(@type = 'verification' or @type = 'class')]", @requirement_lbl)
-        hierarchical_permission_names(clause, num, "recommendation[not(@type = 'verification' or @type = 'class')]", @recommendation_lbl)
-        hierarchical_permission_names(clause, num, "permission[@type = 'verification']", @labels["permissiontest"])
-        hierarchical_permission_names(clause, num, "requirement[@type = 'verification']", @labels["requirementtest"])
-        hierarchical_permission_names(clause, num, "recommendation[@type = 'verification']", @labels["recommendationtest"])
-        hierarchical_permission_names(clause, num, "permission[@type = 'class']", @labels["permissionclass"])
-        hierarchical_permission_names(clause, num, "requirement[@type = 'class']", @labels["requirementclass"])
-        hierarchical_permission_names(clause, num, "recommendation[@type = 'class']", @labels["recommendationclass"])
+        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
       end
 
       def hierarchical_permission_names(clause, num, klass, label)

data/lib/isodoc/ogc/sections.rb

@@ -0,0 +1,111 @@
+module IsoDoc
+  module Ogc
+    module BaseConvert
+      def annex_name(annex, name, div)
+        div.h1 **{ class: "Annex" } do |t|
+          t << "#{anchor(annex['id'], :label)} "
+          t.br
+          t.b do |b|
+            name&.children&.each { |c2| parse(c2, b) }
+          end
+        end
+      end
+
+      def keywords(_docxml, out)
+        kw = @meta.get[:keywords]
+        kw.empty? and return
+        @prefacenum += 1
+        out.div **{ class: "Section3" } do |div|
+          clause_name(RomanNumerals.to_roman(@prefacenum).downcase,
+                      "Keywords", div,  class: "IntroTitle")
+          div.p "The following are keywords to be used by search engines and "\
+            "document catalogues."
+          div.p kw.join(", ")
+        end
+      end
+
+      SUBMITTINGORGS =
+        "//bibdata/contributor[role/@type = 'author']/organization/name".freeze
+
+      def submittingorgs(docxml, out)
+        orgs = []
+        docxml.xpath(ns(SUBMITTINGORGS)).each { |org| orgs << org.text }
+        return if orgs.empty?
+        @prefacenum += 1
+        out.div **{ class: "Section3" } do |div|
+          clause_name(RomanNumerals.to_roman(@prefacenum).downcase,
+                      "Submitting Organizations", div,  class: "IntroTitle")
+          div.p "The following organizations submitted this Document to the "\
+            "Open Geospatial Consortium (OGC):"
+          div.ul do |ul|
+            orgs.each { |org| ul.li org }
+          end
+        end
+      end
+
+      def submitters(docxml, out)
+        f = docxml.at(ns("//submitters")) || return
+        @prefacenum += 1
+        out.div **{ class: "Section3" } do |div|
+          clause_name(anchor(f['id'], :label), "Submitters", div,
+                      class: "IntroTitle")
+          f.elements.each { |e| parse(e, div) unless e.name == "title" }
+        end
+      end
+
+      def preface(isoxml, out)
+        title_attr = { class: "IntroTitle" }
+        isoxml.xpath(ns("//preface/clause")).each do |f|
+          @prefacenum += 1
+          out.div **{ class: "Section3", id: f["id"] } do |div|
+            clause_name(RomanNumerals.to_roman(@prefacenum).downcase,
+                        f&.at(ns("./title")), div, title_attr)
+            f.elements.each { |e| parse(e, div) unless e.name == "title" }
+          end
+        end
+      end
+
+      def abstract(isoxml, out)
+        f = isoxml.at(ns("//preface/abstract")) || return
+        @prefacenum += 1
+        page_break(out)
+        out.div **attr_code(id: f["id"]) do |s|
+          clause_name(anchor(f["id"], :label), @abstract_lbl, s,
+                      class: "AbstractTitle")
+          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        end
+      end
+
+      def foreword(isoxml, out)
+        f = isoxml.at(ns("//foreword")) || return
+        @prefacenum += 1
+        page_break(out)
+        out.div **attr_code(id: f["id"]) do |s|
+          clause_name(anchor(f["id"], :label), @foreword_lbl, s,
+                      class: "ForewordTitle")
+          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        end
+      end
+
+      def acknowledgements(isoxml, out)
+        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,
+                      class: "IntroTitle")
+          f.elements.each { |e| parse(e, div) unless e.name == "title" }
+        end
+      end
+
+      def conformance(isoxml, out, num)
+        f = isoxml.at(ns("//clause[title = 'Conformance']")) or return num
+        out.div **attr_code(id: f["id"]) do |div|
+          num = num + 1
+          clause_name(num, "Conformance", div, nil)
+          f.elements.each { |e| parse(e, div) unless e.name == "title" }
+        end
+        num
+      end
+    end
+  end
+end

data/lib/isodoc/ogc/word_convert.rb

@@ -12,13 +12,14 @@ module IsoDoc
       def initialize(options)
         @libdir = File.dirname(__FILE__)
         super
-        #FileUtils.cp html_doc_path('logo.jpg'), "logo.jpg"
       end
 
       def default_fonts(options)
         {
-          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Times New Roman",serif'),
-          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Times New Roman",serif'),
+          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'
         }
       end
@@ -35,7 +36,6 @@ module IsoDoc
         }
       end
 
-
       def metadata_init(lang, script, labels)
         @meta = Metadata.new(lang, script, labels)
       end
@@ -142,19 +142,29 @@ module IsoDoc
       end
 
       def word_cleanup(docxml)
-        word_recommend_cleanup(docxml)
         super
+        word_recommend_cleanup(docxml)
+        word_copyright_cleanup(docxml)
         word_license_cleanup(docxml)
         word_term_cleanup(docxml)
         docxml
       end
 
       def word_license_cleanup(docxml)
-        docxml.xpath("//div[@class = 'boilerplate-license']//p[not(@class)]").each do |p|
+        x = "//div[@class = 'boilerplate-license']//p[not(@class)]"
+        docxml.xpath(x).each do |p|
           p["class"] = "license"
         end
       end
 
+      # center only the Copyright notice
+      def word_copyright_cleanup(docxml)
+        x = "//div[@class = 'boilerplate-copyright']/div[1]/p[not(@class)]"
+        docxml.xpath(x).each do |p|
+          p["align"] = "center"
+        end
+      end
+
       def word_term_cleanup(docxml)
         docxml.xpath("//p[@class = 'TermNum']//p[@class = 'Terms']").each do |p|
           p.replace(p.children)
@@ -168,9 +178,10 @@ module IsoDoc
         docxml.xpath("//table[@class = 'recommend']/thead/tr").each do |tr|
           style_update(tr, "background:#A5A5A5;")
         end
-        docxml.xpath("//table[@class = 'recommend']/tbody/tr").
-          each_slice(2) do |tr1, tr2|
-          tr2 && style_update(tr2, "background:#C9C9C9;")
+        docxml.xpath("//table[@class = 'recommend']/tbody").each do |tr|
+          tr.xpath("./tr").each_slice(2) do |tr1, tr2|
+            tr2 && style_update(tr2, "background:#C9C9C9;")
+          end
         end
       end