metanorma-ogc 0.2.10 → 0.2.11

data/lib/asciidoctor/ogc/ogc.rng

@@ -1,54 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+<grammar xmlns="http://relaxng.org/ns/structure/1.0">
   <!--
     Currently we inherit from a namespaced grammar, isostandard. Until we inherit from isodoc,
     we cannot have a new default namespace: we will end up with a grammar with two different
     namespaces, one for isostandard and one for csand additions. And we do not want that.
   -->
-  <include href="isostandard.rng">
+  <include href="isodoc.rng">
     <start>
       <ref name="ogc-standard"/>
     </start>
-    <define name="figure">
-      <element name="figure">
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-        <optional>
-          <ref name="tname"/>
-        </optional>
-        <choice>
-          <ref name="image"/>
-          <ref name="pre"/>
-          <oneOrMore>
-            <ref name="subfigure"/>
-          </oneOrMore>
-        </choice>
-        <zeroOrMore>
-          <ref name="fn"/>
-        </zeroOrMore>
-        <optional>
-          <ref name="dl"/>
-        </optional>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </element>
-    </define>
-    <define name="subfigure">
-      <element name="figure">
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-        <optional>
-          <ref name="tname"/>
-        </optional>
-        <choice>
-          <ref name="image"/>
-          <ref name="pre"/>
-        </choice>
-      </element>
-    </define>
     <define name="DocumentType">
       <choice>
         <value>abstract-specification-topic</value>
@@ -65,6 +25,7 @@
         <value>standard</value>
         <value>user-guide</value>
         <value>white-paper</value>
+        <value>test-suite</value>
       </choice>
     </define>
     <define name="editorialgroup">
@@ -135,6 +96,16 @@
       </choice>
     </element>
   </define>
+  <define name="subcommittee">
+    <element name="subcommittee">
+      <ref name="IsoWorkgroup"/>
+    </element>
+  </define>
+  <define name="workgroup">
+    <element name="workgroup">
+      <ref name="IsoWorkgroup"/>
+    </element>
+  </define>
   <define name="ogc-standard">
     <element name="ogc-standard">
       <ref name="bibdata"/>

data/lib/asciidoctor/ogc/reqt.rng

@@ -54,9 +54,9 @@
     <optional>
       <ref name="subject"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="reqinherit"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="classification"/>
     </zeroOrMore>

data/lib/asciidoctor/ogc/validate.rb

@@ -22,6 +22,7 @@ module Asciidoctor
       end
 
       def section_validate(doc)
+        preface_sequence_validate(doc.root)
         sections_sequence_validate(doc.root)
       end
 
@@ -68,7 +69,8 @@ module Asciidoctor
       end
 
       def sections_sequence_validate(root)
-        return unless STANDARDTYPE.include? root&.at("//bibdata/ext/doctype")&.text
+        return unless STANDARDTYPE.include?(
+          root&.at("//bibdata/ext/doctype")&.text)
         f = root.at("//sections").elements
         names = f.map { |s| { tag: s.name, title: s&.at("./title")&.text } }
         names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val]) || return
@@ -82,9 +84,21 @@ module Asciidoctor
           warn "OGC style: Document must contain at least one clause"
           return
         end
-        root.at("//references | //clause[descendant::references][not(parent::clause)]") or
-          seqcheck([{tag: "clause"}],
-                   "Normative References are mandatory", [{tag: "references"}])
+        root.at("//references | //clause[descendant::references]"\
+                "[not(parent::clause)]") or
+        seqcheck([{tag: "clause"}],
+                 "Normative References are mandatory", [{tag: "references"}])
+      end
+
+      def preface_sequence_validate(root)
+        root.at("//preface/abstract") or warn "OGC style: Abstract is missing!"
+        root.at("//bibdata/keyword | //bibdata/ext/keyword") or
+          warn "OGC style: Keywords are missing!"
+        root.at("//foreword") or warn "OGC style: Preface is missing!"
+        root.at("//bibdata/contributor[role/@type = 'author']/organization/"\
+                "name") or
+               warn "OGC style: Submitting Organizations is missing!"
+        root.at("//submitters") or warn "OGC style: Submitters is missing!"
       end
     end
   end

data/lib/isodoc/ogc/base_convert.rb

@@ -22,10 +22,29 @@ module IsoDoc
       end
 
       def cleanup(docxml)
+        requirement_table_cleanup(docxml)
         super
         term_cleanup(docxml)
       end
 
+      # table nested in table: merge label and caption into a single row
+      def requirement_table_cleanup(docxml)
+        docxml.xpath("//table[@class = 'recommendclass']//table").each do |t|
+          x = t.at("./thead") and x.replace(x.children)
+          x = t.at("./tbody") and x.replace(x.children)
+          x = t.at("./tfoot") and x.replace(x.children)
+          if x = t.at("./tr/th[@colspan = '2']") and y = t.at("./tr/td[@colspan = '2']")
+            x["colspan"] = "1"
+            y["colspan"] = "1"
+            x.name = "td"
+            p = x.at("./p[@class = 'RecommendationTitle']") and p.delete("class")
+            x << y.dup
+            y.parent.remove
+          end
+          t.replace(t.children)
+        end
+      end
+
       def term_cleanup(docxml)
         docxml.xpath("//p[@class = 'Terms']").each do |d|
           h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")

data/lib/isodoc/ogc/html/_coverpage.scss

@@ -91,6 +91,39 @@
   }
 }
 
+.docstage-box {
+table {
+  width: auto;
+}
+th {
+  background-color: #93c0d6;
+}
+td {
+vertical-align: top;
+background-color: #daeef3;
+padding: 0.5em;
+border: 0;
+}
+th:first-child {
+border-radius: 1em 0 0 0;
+}
+th:last-child {
+border-radius: 0 1em 0 0;
+}
+tr:first-child {
+border-radius: 0 0 0 1em;
+}
+tr:last-child {
+border-radius: 0 1em 0 0;
+}
+tr:last-child > td:first-child {
+border-radius: 0 0 0 1em;
+}
+tr:last-child > td:last-child {
+border-radius: 0 0 1em 0;
+}
+}
+
 
 .WordSection11 {
   padding: 0 2em 0 3em;

data/lib/isodoc/ogc/html/html_ogc_titlepage.html

@@ -165,6 +165,15 @@
   </div>
 {% endif %}
 
+<div class="docstage-box">
+  <table>
+    <tr><th>Document type:</th><th>OGC {{doctype}}</th></tr>
+    <tr><td align="right">Document subtype:</td><td align="right">{{docsubtype}}</td></tr>
+    <tr><td align="right">Document stage:</td><td align="right">{{stage}}</td></tr>
+    <tr><td align="right">Document language:</td><td align="right">{{doclanguage}}</td></tr>
+  </table>
+</div>
+
 <div class="info-section">
 <div class="copyright">
   <p><b>Copyright notice</b></p>

data/lib/isodoc/ogc/html/htmlstyle.scss

@@ -484,6 +484,11 @@ p.Biblio, p.NormRef {
   @include recommendationBlock();
 }
 
+tbody td.recommend p.RecommendationTitle, tbody td.recommend p.RecommendationTitle, tbody td.recommend p.RecommendationTitle {
+  font-weight: normal;
+  text-align: left;
+}
+
 #myBtn {
   @include toTopBtn(white, #00335b);
 }

data/lib/isodoc/ogc/html_convert.rb

@@ -20,7 +20,7 @@ module IsoDoc
       def default_fonts(options)
         {
           bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Overpass",sans-serif'),
-          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Teko",sans-serif'),
+          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Overpass",sans-serif'),
           monospacefont: '"Space Mono",monospace'
         }
       end

data/lib/isodoc/ogc/i18n-en.yaml

@@ -2,3 +2,6 @@ foreword: Preface
 recommendationtest: Recommendation Test
 requirementtest: Requirement Test
 permissiontest: Permission Test
+recommendationclass: Recommendation Class
+requirementclass: Requirement Class
+permissionclass: Permission Class

data/lib/isodoc/ogc/metadata.rb

@@ -37,7 +37,7 @@ module IsoDoc
 
       def keywords(isoxml, _out)
         keywords = []
-        isoxml.xpath(ns("//bibdata/ext/keyword")).each do |kw|
+        isoxml.xpath(ns("//bibdata/keyword | //bibdata/ext/keyword")).each do |kw|
           keywords << kw.text
         end
         set(:keywords, keywords)
@@ -52,7 +52,8 @@ module IsoDoc
         revdate = get[:revdate]
         set(:revdate_monthyear, monthyr(revdate))
         set(:edition, isoxml&.at(ns("//bibdata/edition"))&.text)
-        set(:language, ISO_639.find_by_code(isoxml&.at(ns("//bibdata/language"))&.text))
+        lg = ISO_639.find_by_code(isoxml&.at(ns("//bibdata/language"))&.text)
+        set(:doclanguage, lg ? lg[3] : "English")
       end
 
       MONTHS = {
@@ -83,7 +84,7 @@ module IsoDoc
 
       def type_capitalise(b)
         b.split(/[- ]/).map do |w|
-          w.capitalize unless %w(SWG).include? w
+          %w(SWG).include?(w) ? w : w.capitalize
         end.join(" ")
       end
 
@@ -93,6 +94,10 @@ module IsoDoc
         b = isoxml&.at(ns("//bibdata/ext/docsubtype"))&.text and
         set(:docsubtype, type_capitalise(b))
       end
+
+      def status_print(status)
+        type_capitalise(status)
+      end
     end
   end
 end

data/lib/isodoc/ogc/pdf_convert.rb

@@ -18,7 +18,7 @@ module IsoDoc
       def default_fonts(options)
         {
           bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Overpass",sans-serif'),
-          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Teko",sans-serif'),
+          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Overpass",sans-serif'),
           monospacefont: '"Space Mono",monospace'
         }
       end

data/lib/isodoc/ogc/reqt.rb

@@ -5,10 +5,15 @@ require "fileutils"
 module IsoDoc
   module Ogc
     module BaseConvert
+      def recommend_class(node)
+        return "recommendtest" if node["type"] == "verification"
+        return "recommendclass" if node["type"] == "class"
+        "recommend"
+      end
+
       def recommend_table_attr(node)
         attr_code(id: node["id"], 
-                  class: node["type"] == "verification" ?
-                  "recommendtest" : "recommend",
+                  class: recommend_class(node),
                   style: "border-collapse:collapse;border-spacing:0;")
       end
 
@@ -42,11 +47,12 @@ module IsoDoc
       def recommendation_attributes1(node)
         out = []
         oblig = node["obligation"] and out << ["Obligation", oblig]
-        subj = node&.at(ns("./subject"))&.text and out << ["Subject", subj]
+        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] }
         node.xpath(ns("./classification")).each do |c|
-          tag = c.at(ns("./tag"))
-          value = c.at(ns("./value"))
-          tag && value or next
+          tag = c.at(ns("./tag")) or next
+          value = c.at(ns("./value")) or next
           out << [tag.text.capitalize, value.text]
         end
         out
@@ -113,19 +119,33 @@ module IsoDoc
       end
 
       def recommendation_parse(node, out)
-        recommendation_parse1(node, out, node["type"] == "verification" ?
-                              @labels["recommendationtest"] :
-                              @recommendation_lbl)
+        label = case node["type"]
+                when "verification" then @labels["recommendationtest"]
+                when "class" then @labels["recommendationclass"]
+                else
+                  @recommendation_lbl
+                end
+        recommendation_parse1(node, out, label)
       end
 
       def requirement_parse(node, out)
-        recommendation_parse1(node, out, node["type"] == "verification" ?
-                              @labels["requirementtest"] : @requirement_lbl)
+        label = case node["type"]
+                when "verification" then @labels["requirementtest"]
+                when "class" then @labels["requirementclass"]
+                else
+                  @requirement_lbl
+                end
+        recommendation_parse1(node, out, label)
       end
 
       def permission_parse(node, out)
-        recommendation_parse1(node, out, node["type"] == "verification" ?
-                              @labels["permissiontest"] : @permission_lbl)
+        label = case node["type"]
+                when "verification" then @labels["permissiontest"]
+                when "class" then @labels["permissionclass"]
+                else
+                  @permission_lbl
+                end
+        recommendation_parse1(node, out, label)
       end
 
       FIRST_LVL_REQ = IsoDoc::Function::XrefGen::FIRST_LVL_REQ
@@ -136,27 +156,29 @@ module IsoDoc
           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_names1(t, id, "permission[not(@type = 'verification')]", @permission_lbl)
-          sequential_permission_names1(t, id, "requirement[not(@type = 'verification')]", @requirement_lbl)
-          sequential_permission_names1(t, id, "recommendation[not(@type = 'verification')]", @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_children(t, id)
         end
       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"])
+      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_names1(t, id, "permission[not(@type = 'verification')]", @permission_lbl)
-          sequential_permission_names1(t, id, "requirement[not(@type = 'verification')]", @requirement_lbl)
-          sequential_permission_names1(t, id, "recommendation[not(@type = 'verification')]", @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_children(t, id)
         end
       end
 
@@ -164,24 +186,30 @@ module IsoDoc
         sequential_table_names(clause)
         sequential_figure_names(clause)
         sequential_formula_names(clause)
-        sequential_permission_names(clause, "permission[not(@type = 'verification')]", @permission_lbl)
-        sequential_permission_names(clause, "requirement[not(@type = 'verification')]", @requirement_lbl)
-        sequential_permission_names(clause, "recommendation[not(@type = 'verification')]", @recommendation_lbl)
+        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"])
       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')]", @permission_lbl)
-        hierarchical_permission_names(clause, num, "requirement[not(@type = 'verification')]", @requirement_lbl)
-        hierarchical_permission_names(clause, num, "recommendation[not(@type = 'verification')]", @recommendation_lbl)
+        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"])
       end
 
       def hierarchical_permission_names(clause, num, klass, label)
@@ -190,12 +218,7 @@ module IsoDoc
           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_names1(t, lbl, "permission[not(@type = 'verification')]", @permission_lbl)
-          sequential_permission_names1(t, lbl, "requirement[not(@type = 'verification')]", @requirement_lbl)
-          sequential_permission_names1(t, lbl, "recommendation[not(@type = 'verification')]", @recommendation_lbl)
-          sequential_permission_names1(t, lbl, "permission[@type = 'verification']", @labels["permissiontest"])
-          sequential_permission_names1(t, lbl, "requirement[@type = 'verification']", @labels["requirementtest"])
-          sequential_permission_names1(t, lbl, "recommendation[@type = 'verification']", @labels["recommendationtest"])
+          sequential_permission_children(t, lbl)
         end
       end
     end