metanorma-ogc 1.1.0 → 1.2.1

data/lib/isodoc/ogc/presentation_xml_convert.rb

@@ -1,9 +1,136 @@
-require_relative "base_convert"
+require_relative "init"
 require "isodoc"
+require "uuidtools"
 
 module IsoDoc
   module Ogc
     class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+      def convert1(docxml, filename, dir)
+        info docxml, nil
+        insert_preface_sections(docxml)
+        super
+      end
+
+      def insert_preface_sections(docxml)
+        insert_keywords(docxml)
+        insert_submitting_orgs(docxml)
+      end
+
+      def preface_init_insert_pt(docxml)
+        docxml.at(ns("//preface")) ||
+          docxml.at(ns("//sections")).
+          add_previous_sibling("<preface> </preface>").first
+      end
+
+      def submit_orgs_append_pt(docxml)
+        docxml.at(ns("//introduction")) ||
+        docxml.at(ns("//foreword")) ||
+        docxml.at(ns("//preface/clause[@type = 'keywords']")) ||
+        docxml.at(ns("//preface/abstract"))
+      end
+
+      def insert_submitting_orgs(docxml)
+        orgs = []
+        docxml.xpath(ns(submittingorgs_path)).each { |org| orgs << org.text }
+        return if orgs.empty?
+        if a = submit_orgs_append_pt(docxml)
+          a.next = submitting_orgs_clause(orgs)
+        else
+          preface_init_insert_pt(docxml)&.children&.first&.
+            add_previous_sibling(submitting_orgs_clause(orgs))
+        end
+      end
+
+      def submitting_orgs_clause(orgs)
+        <<~END
+        <clause id="_#{UUIDTools::UUID.random_create}" type="submitting_orgs">
+        <title>Submitting Organizations</title>
+        <p>The following organizations submitted this Document to the
+           Open Geospatial Consortium (OGC):</p>
+         <ul>#{orgs.map { |m| "<li>#{m}</li>" }.join("\n")}</ul>
+         </clause>
+        END
+      end
+
+      def keyword_clause(kw)
+        <<~END
+        <clause id="_#{UUIDTools::UUID.random_create}" type="keywords">
+        <title>Keywords</title>
+        <p>The following are keywords to be used by search engines and
+            document catalogues.</p>
+        <p>#{kw.join(", ")}</p></clause>
+        END
+      end
+
+      def insert_keywords(docxml)
+        kw = @meta.get[:keywords]
+        kw.empty? and return
+        if abstract = docxml.at(ns("//preface/abstract"))
+          abstract.next = keyword_clause(kw)
+        else
+          preface_init_insert_pt(docxml)&.children&.first&.
+            add_previous_sibling(keyword_clause(kw))
+        end
+      end
+
+      def example1(f)
+        lbl = @xrefs.anchor(f['id'], :label, false) or return
+        prefix_name(f, "&nbsp;&mdash; ", l10n("#{@i18n.example} #{lbl}"), "name")
+      end
+
+      def recommendation1(f, type)
+        type = recommendation_class(f)
+        label = f&.at(ns("./label"))&.text
+        if inject_crossreference_reqt?(f, label)
+          n = @xrefs.anchor(@xrefs.reqtlabels[label], :xref, false)
+          lbl = (n.nil? ? type : n)
+          f&.at(ns("./title"))&.remove # suppress from display if embedded
+        else
+          n = @xrefs.anchor(f['id'], :label, false)
+          lbl = (n.nil? ? type : l10n("#{type} #{n}"))
+        end
+        prefix_name(f, "", lbl, "name")
+      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]
+      end
+
+      def recommendation_class(node)
+        case node["type"]
+        when "verification" then @i18n.get["#{node.name}test"]
+        when "class" then @i18n.get["#{node.name}class"]
+        when "abstracttest" then @i18n.get["abstracttest"]
+        when "conformanceclass" then @i18n.get["conformanceclass"]
+        else
+          case node.name
+          when "recommendation" then @i18n.recommendation
+          when "requirement" then @i18n.requirement
+          when "permission" then @i18n.permission
+          end
+        end
+      end
+
+      def annex1(f)
+        lbl = @xrefs.anchor(f['id'], :label)
+        if t = f.at(ns("./title"))
+          t.children = "<strong>#{t.children.to_xml}</strong>"
+        end
+        prefix_name(f, "<br/>", lbl, "title")
+      end
+
+      def clause(docxml)
+        super
+        docxml.xpath(ns("//foreword | //preface/abstract | "\
+                        "//submitters | //introduction | //acknowledgements")).
+                       each do |f|
+          clause1(f)
+        end
+      end
+
+      include Init
     end
   end
 end

data/lib/isodoc/ogc/reqt.rb

@@ -28,18 +28,14 @@ module IsoDoc
       def recommendation_name(node, out, type)
         label, title, lbl = recommendation_labels(node)
         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
+          lbl and lbl.children.each { |n| parse(n, b) }
+          b << l10n(":")
           recommendation_name1(title, node, label, b)
         end
       end
 
       def recommendation_name1(title, node, label, b)
-        return unless  title && !inject_crossreference_reqt?(node, label)
+        return unless title
         b << " "
         title.children.each { |n| parse(n,b) }
       end
@@ -55,12 +51,6 @@ 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]
@@ -163,19 +153,7 @@ module IsoDoc
       end
 
       def recommendation_parse0(node, out, r)
-        label = case node["type"]
-                when "verification" then @labels["#{r}test"]
-                when "class" then @labels["#{r}class"]
-                when "abstracttest" then @labels["abstracttest"]
-                when "conformanceclass" then @labels["conformanceclass"]
-                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)
+        recommendation_parse1(node, out, nil)
       end
 
       def requirement_parse(node, out)

data/lib/isodoc/ogc/sections.rb

@@ -1,108 +1,62 @@
 module IsoDoc
   module Ogc
     module BaseConvert
-      def annex_name(annex, name, div)
-        div.h1 **{ class: "Annex" } do |t|
-          t << "#{@xrefs.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(", ")
+      def intro_clause(f, out)
+        out.div **{ class: "Section3", id: f["id"] } do |div|
+          clause_name(nil, f&.at(ns("./title")), div, class: "IntroTitle")
+          f.elements.each { |e| parse(e, div) unless e.name == "title" }
         end
       end
 
-      def submittingorgs_path
-        "//bibdata/contributor[role/@type = 'author']/organization/name"
+      def keywords(docxml, out)
+        f = docxml.at(ns("//preface/clause[@type = 'keywords']")) || return
+        intro_clause(f, out)
       end
 
       def submittingorgs(docxml, out)
-        orgs = []
-        docxml.xpath(ns(submittingorgs_path)).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
+        f = docxml.at(ns("//preface/clause[@type = 'submitting_orgs']")) || return
+        intro_clause(f, out)
       end
 
       def submitters(docxml, out)
         f = docxml.at(ns("//submitters")) || return
-        @prefacenum += 1
-        out.div **{ class: "Section3" } do |div|
-          clause_name(@xrefs.anchor(f['id'], :label), "Submitters", div,
-                      class: "IntroTitle")
-          f.elements.each { |e| parse(e, div) unless e.name == "title" }
-        end
+        intro_clause(f, out)
       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
+        isoxml.xpath(ns("//preface/clause[not(@type = 'keywords' or "\
+                        "@type = 'submitting_orgs')]")).each do |f|
+          intro_clause(f, out)
         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(@xrefs.anchor(f["id"], :label), @abstract_lbl, s,
-                      class: "AbstractTitle")
+          clause_name(nil, f&.at(ns("./title")), 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(@xrefs.anchor(f["id"], :label), @foreword_lbl, s,
-                      class: "ForewordTitle")
+          clause_name(nil, f&.at(ns("./title")), 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(@xrefs.anchor(f["id"], :label), f&.at(ns("./title")), div,
-                      class: "IntroTitle")
-          f.elements.each { |e| parse(e, div) unless e.name == "title" }
-        end
+        intro_clause(f, out)
       end
 
       def conformance(isoxml, out, num)
-        f = isoxml.at(ns("//clause[title = 'Conformance']")) or return num
+        f = isoxml.at(ns("//clause[@type = 'conformance']")) or return num
         out.div **attr_code(id: f["id"]) do |div|
-          num = num + 1
-          clause_name(num, "Conformance", div, nil)
+          clause_name(nil, f&.at(ns("./title")), div, nil)
           f.elements.each { |e| parse(e, div) unless e.name == "title" }
         end
         num

data/lib/isodoc/ogc/word_convert.rb

@@ -1,4 +1,5 @@
 require_relative "base_convert"
+require_relative "init"
 require "fileutils"
 require "isodoc"
 require_relative "metadata"
@@ -36,6 +37,20 @@ module IsoDoc
         }
       end
 
+      def convert1(docxml, filename, dir)
+        if docxml&.at(ns('//bibdata/ext/doctype'))&.text == "white-paper"
+          @wordstylesheet_name = html_doc_path("wordstyle_wp.scss")
+          @standardstylesheet_name = html_doc_path("ogc_wp.scss")
+          @wordcoverpage = html_doc_path("word_ogc_titlepage_wp.html")
+          @wordintropage = html_doc_path("word_ogc_intro_wp.html")
+          @header = html_doc_path("header_wp.html")
+          @doctype = "white-paper"
+          options[:bodyfont] = '"Arial",sans-serif'
+          options[:headerfont] = '"Lato",sans-serif'
+        end
+        super
+      end
+
       def make_body(xml, docxml)
         body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72" }
         xml.body **body_attr do |body|
@@ -67,15 +82,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
 
@@ -83,7 +98,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
 
@@ -156,9 +171,12 @@ module IsoDoc
       # 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
+        docxml.xpath(x).each { |p| p["align"] = "center" }
+        return unless @doctype == "white-paper"
+        docxml.xpath("//div[@class = 'boilerplate-copyright']//p[not(@class)]").
+          each { |p| p["class"] = "license" }
+        docxml.xpath("//div[@class = 'boilerplate-legal']//p[not(@class)]").
+          each { |p| p["class"] = "license" }
       end
 
       def word_term_cleanup(docxml)
@@ -182,6 +200,7 @@ module IsoDoc
       end
 
       include BaseConvert
+      include Init
     end
   end
 end

data/lib/isodoc/ogc/xref.rb

@@ -17,7 +17,8 @@ module IsoDoc
         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"])
+          @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
@@ -38,9 +39,8 @@ module IsoDoc
       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}"])
+            sequential_permission_names1(t, id, "#{r}[#{v}]",
+                                         @labels["#{r}#{k}"])
           end
         end
         req_class_paths2.each do |k, v|
@@ -53,7 +53,8 @@ module IsoDoc
         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"])
+          @anchors[t["id"]] = anchor_struct(id, t, label, klass,
+                                            t["unnumbered"])
           sequential_permission_children(t, id)
         end
       end
@@ -64,9 +65,8 @@ module IsoDoc
         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}"])
+            sequential_permission_names(clause, "#{r}[#{v}]",
+                                        @labels["#{r}#{k}"])
           end
         end
         req_class_paths2.each do |k, v|
@@ -80,9 +80,8 @@ module IsoDoc
         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}"])
+            hierarchical_permission_names(clause, num, "#{r}[#{v}]",
+                                          @labels["#{r}#{k}"])
           end
         end
         req_class_paths2.each do |k, v|
@@ -95,7 +94,8 @@ module IsoDoc
         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"])
+          @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
@@ -104,23 +104,23 @@ module IsoDoc
       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("//preface/clause[@type = 'keywords']")))
         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("//preface/clause"\
+                                       "[@type = 'submitting_orgs']")))
         preface_names_numbered(d.at(ns("//submitters")))
-        d.xpath(ns("//preface/clause")).each do |c|
+        d.xpath(ns("//preface/clause[not(@type = 'keywords' or "\
+                   "@type = 'submitting_orgs')]")).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("//clause[@type = 'scope']")), 0, 1)
+        n = section_names(d.at(ns("//clause[@type = 'conformance']")), n, 1)
+        n = section_names(d.at(ns(@klass.norm_ref_xpath)), n, 1)
         n = section_names(
           d.at(ns("//sections/terms | //sections/clause[descendant::terms]")),
           n, 1)
@@ -132,11 +132,10 @@ module IsoDoc
       end
 
       def middle_section_asset_names(d)
-        middle_sections = "//clause[title = 'Scope' or title = 'Conformance'] "\
+        middle_sections = "//clause[@type = 'scope' or @type = 'conformance'] "\
           "| //foreword | //introduction | //preface/abstract | "\
           "//submitters | //acknowledgements | //preface/clause | "\
-          "//references[title = 'Normative References' or title = "\
-          "'Normative references'] | //sections/terms | "\
+          " #{@klass.norm_ref_xpath} | //sections/terms | "\
           "//sections/definitions | //clause[parent::sections]"
         sequential_asset_names(d.xpath(ns(middle_sections)))
       end
@@ -153,6 +152,12 @@ module IsoDoc
           section_names1(c, "#{pref}.#{i + 1}", 2)
         end
       end
+
+      def reference_names(ref)
+        super
+        return unless @klass.ogc_draft_ref?(ref)
+        @anchors[ref["id"]] = { xref: @anchors[ref["id"]][:xref] + " (draft)" }
+      end
     end
   end
 end