metanorma-ogc 1.4.0 → 1.4.3.1

data/lib/asciidoctor/ogc/isodoc.rng

@@ -32,6 +32,18 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="section-title">
+      <element name="title">
+        <zeroOrMore>
+          <ref name="TextElement"/>
+        </zeroOrMore>
+      </element>
+      <zeroOrMore>
+        <element name="variant-title">
+          <ref name="TypedTitleString"/>
+        </element>
+      </zeroOrMore>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -135,6 +147,14 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="ul_li"/>
         </oneOrMore>
@@ -158,15 +178,25 @@
             <data type="boolean"/>
           </attribute>
         </optional>
-        <attribute name="type">
-          <choice>
-            <value>roman</value>
-            <value>alphabet</value>
-            <value>arabic</value>
-            <value>roman_upper</value>
-            <value>alphabet_upper</value>
-          </choice>
-        </attribute>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="type">
+            <choice>
+              <value>roman</value>
+              <value>alphabet</value>
+              <value>arabic</value>
+              <value>roman_upper</value>
+              <value>alphabet_upper</value>
+            </choice>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="li"/>
         </oneOrMore>
@@ -195,6 +225,14 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -242,6 +280,14 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -302,6 +348,14 @@
         <optional>
           <attribute name="width"/>
         </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
         <optional>
           <ref name="colgroup"/>
         </optional>
@@ -352,6 +406,14 @@
         <optional>
           <attribute name="class"/>
         </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
         <optional>
           <ref name="source"/>
         </optional>
@@ -410,6 +472,14 @@
         <optional>
           <attribute name="lang"/>
         </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -458,6 +528,14 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
         <ref name="stem"/>
         <optional>
           <ref name="dl"/>
@@ -486,6 +564,14 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="tag"/>
+      </optional>
+      <optional>
+        <attribute name="multilingual-rendering">
+          <ref name="MultilingualRenderingType"/>
+        </attribute>
+      </optional>
       <zeroOrMore>
         <ref name="TextElement"/>
       </zeroOrMore>
@@ -513,6 +599,14 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
         <zeroOrMore>
           <choice>
             <ref name="TextElement"/>
@@ -544,6 +638,14 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
         <optional>
           <ref name="quote-source"/>
         </optional>
@@ -653,6 +755,14 @@
         <optional>
           <attribute name="type"/>
         </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <choice>
             <ref name="paragraph"/>
@@ -910,6 +1020,14 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="MultilingualRenderingType">
+    <choice>
+      <value>common</value>
+      <value>all-columns</value>
+      <value>parallel</value>
+      <value>tag</value>
+    </choice>
+  </define>
   <define name="docsubtype">
     <element name="subdoctype">
       <ref name="DocumentSubtype"/>
@@ -976,6 +1094,16 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="linkmention">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="linkref">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <element name="refterm">
           <zeroOrMore>
@@ -1012,6 +1140,7 @@
       <ref name="svgmap"/>
       <ref name="inputform"/>
       <ref name="toc"/>
+      <ref name="passthrough"/>
     </choice>
   </define>
   <define name="toc">
@@ -1019,6 +1148,14 @@
       <ref name="ul"/>
     </element>
   </define>
+  <define name="passthrough">
+    <element name="passthrough">
+      <optional>
+        <attribute name="formats"/>
+      </optional>
+      <text/>
+    </element>
+  </define>
   <define name="inputform">
     <element name="form">
       <attribute name="id">
@@ -1029,6 +1166,14 @@
       <optional>
         <attribute name="class"/>
       </optional>
+      <optional>
+        <attribute name="tag"/>
+      </optional>
+      <optional>
+        <attribute name="multilingual-rendering">
+          <ref name="MultilingualRenderingType"/>
+        </attribute>
+      </optional>
       <zeroOrMore>
         <choice>
           <ref name="TextElement"/>
@@ -1686,7 +1831,9 @@
       <zeroOrMore>
         <ref name="termgrammar"/>
       </zeroOrMore>
-      <ref name="definition"/>
+      <oneOrMore>
+        <ref name="termdefinition"/>
+      </oneOrMore>
       <zeroOrMore>
         <ref name="termnote"/>
       </zeroOrMore>
@@ -1749,7 +1896,7 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="definition">
+  <define name="termdefinition">
     <element name="definition">
       <oneOrMore>
         <choice>
@@ -1758,6 +1905,9 @@
           <ref name="formula"/>
         </choice>
       </oneOrMore>
+      <zeroOrMore>
+        <ref name="termsource"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="termnote">
@@ -1786,6 +1936,14 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="tag"/>
+      </optional>
+      <optional>
+        <attribute name="multilingual-rendering">
+          <ref name="MultilingualRenderingType"/>
+        </attribute>
+      </optional>
       <oneOrMore>
         <choice>
           <ref name="paragraph"/>
@@ -1802,6 +1960,24 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
+      <optional>
+        <attribute name="keep-with-next">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="keep-lines-together">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="tag"/>
+      </optional>
+      <optional>
+        <attribute name="multilingual-rendering">
+          <ref name="MultilingualRenderingType"/>
+        </attribute>
+      </optional>
       <ref name="paragraph"/>
     </element>
   </define>
@@ -1969,6 +2145,14 @@
       <optional>
         <attribute name="title"/>
       </optional>
+      <optional>
+        <attribute name="tag"/>
+      </optional>
+      <optional>
+        <attribute name="multilingual-rendering">
+          <ref name="MultilingualRenderingType"/>
+        </attribute>
+      </optional>
       <optional>
         <element name="location">
           <zeroOrMore>
@@ -2028,6 +2212,14 @@
   </define>
   <define name="imagemap">
     <element name="imagemap">
+      <optional>
+        <attribute name="tag"/>
+      </optional>
+      <optional>
+        <attribute name="multilingual-rendering">
+          <ref name="MultilingualRenderingType"/>
+        </attribute>
+      </optional>
       <ref name="figure"/>
       <zeroOrMore>
         <element name="area">
@@ -2072,6 +2264,14 @@
   </define>
   <define name="svgmap">
     <element name="svgmap">
+      <optional>
+        <attribute name="tag"/>
+      </optional>
+      <optional>
+        <attribute name="multilingual-rendering">
+          <ref name="MultilingualRenderingType"/>
+        </attribute>
+      </optional>
       <ref name="figure"/>
       <zeroOrMore>
         <element name="target">

data/lib/asciidoctor/ogc/reqt.rng

@@ -58,6 +58,14 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="tag"/>
+    </optional>
+    <optional>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
+    </optional>
     <optional>
       <ref name="reqtitle"/>
     </optional>
@@ -175,6 +183,14 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="tag"/>
+    </optional>
+    <optional>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
+    </optional>
     <oneOrMore>
       <ref name="BasicBlock"/>
     </oneOrMore>

data/lib/asciidoctor/ogc/validate.rb

@@ -1,7 +1,13 @@
 module Asciidoctor
   module Ogc
     class Converter < Standoc::Converter
-      def title_validate(root)
+      def validate(doc)
+        content_validate(doc)
+        schema_validate(formattedstr_strip(doc.dup),
+                        File.join(File.dirname(__FILE__), "ogc.rng"))
+      end
+
+      def title_validate(_root)
         nil
       end
 
@@ -18,8 +24,9 @@ module Asciidoctor
       def stage_validate(xmldoc)
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(swg-draft oab-review public-rfc tc-vote
-        approved deprecated retired).include? stage or
-        @log.add("Document Attributes", nil, "#{stage} is not a recognised status")
+           approved deprecated retired).include? stage or
+          @log.add("Document Attributes", nil,
+                   "#{stage} is not a recognised status")
       end
 
       def version_validate(xmldoc)
@@ -27,10 +34,12 @@ module Asciidoctor
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
         if %w(engineering-report discussion-paper).include? doctype
           version.nil? or
-          @log.add("Document Attributes", nil, "Version not permitted for #{doctype}") 
+            @log.add("Document Attributes", nil,
+                     "Version not permitted for #{doctype}")
         else
           version.nil? and
-          @log.add("Document Attributes", nil,  "Version required for #{doctype}") 
+            @log.add("Document Attributes", nil,
+                     "Version required for #{doctype}")
         end
       end
 
@@ -41,7 +50,7 @@ module Asciidoctor
       end
 
       STANDARDTYPE = %w{standard standard-with-suite abstract-specification
-      community-standard profile}.freeze
+                        community-standard profile}.freeze
 
       # spec of permissible section sequence
       # we skip normative references, it goes to end of list
@@ -49,24 +58,25 @@ module Asciidoctor
         [
           {
             msg: "Prefatory material must be followed by (clause) Scope",
-            val: ["./self::clause[@type = 'scope']" ]
+            val: ["./self::clause[@type = 'scope']"],
           },
           {
             msg: "Scope must be followed by Conformance",
-            val: ["./self::clause[@type = 'conformance']" ]
+            val: ["./self::clause[@type = 'conformance']"],
           },
           {
             msg: "Normative References must be followed by "\
-            "Terms and Definitions",
-            val: ["./self::terms | .//terms"]
+                 "Terms and Definitions",
+            val: ["./self::terms | .//terms"],
           },
-      ].freeze
+        ].freeze
 
       def seqcheck(names, msg, accepted)
         n = names.shift
         return [] if n.nil?
+
         test = accepted.map { |a| n.at(a) }
-        if test.all? { |a| a.nil? }
+        if test.all?(&:nil?)
           @log.add("Style", nil, msg)
         end
         names
@@ -74,7 +84,9 @@ module Asciidoctor
 
       def sections_sequence_validate(root)
         return unless STANDARDTYPE.include?(
-          root&.at("//bibdata/ext/doctype")&.text)
+          root&.at("//bibdata/ext/doctype")&.text,
+        )
+
         names = root.xpath("//sections/* | //bibliography/*")
         names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val])
         names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val])
@@ -84,25 +96,28 @@ module Asciidoctor
           n = names.shift
         end
         if n.nil? || n.name != "clause"
-          @log.add("Style", nil, "Document must contain at least one clause")
+          @log.add("Style", nil,
+                   "Document must contain at least one clause")
           return
         end
         root.at("//references | //clause[descendant::references]"\
                 "[not(parent::clause)]") or
-        @log.add("Style", nil, "Normative References are mandatory")
+          @log.add("Style", nil, "Normative References are mandatory")
       end
 
       def preface_sequence_validate(root)
-        root.at("//preface/abstract") or @log.add("Style", nil, "Abstract is missing!")
+        root.at("//preface/abstract") or @log.add("Style", nil,
+                                                  "Abstract is missing!")
         root.at("//bibdata/keyword | //bibdata/ext/keyword") or
           @log.add("Style", nil, "Keywords are missing!")
-        root.at("//foreword") or @log.add("Style", nil,  "Preface is missing!")
+        root.at("//foreword") or @log.add("Style", nil,
+                                          "Preface is missing!")
         root.at("//bibdata/contributor[role/@type = 'author']/organization/"\
                 "name") or
-               @log.add("Style", nil, "Submitting Organizations is missing!")
-        root.at("//submitters") or @log.add("Style", nil, "Submitters is missing!")
+          @log.add("Style", nil, "Submitting Organizations is missing!")
+        root.at("//submitters") or @log.add("Style", nil,
+                                            "Submitters is missing!")
       end
     end
   end
 end
-

data/lib/isodoc/ogc/base_convert.rb

@@ -15,7 +15,7 @@ module IsoDoc
       end
 
       def hi_parse(node, out)
-        out.span **{class: "hi"} do |e|
+        out.span **{ class: "hi" } do |e|
           node.children.each { |n| parse(n, e) }
         end
       end
@@ -27,23 +27,58 @@ module IsoDoc
 
       def term_cleanup(docxml)
         docxml.xpath("//p[@class = 'Terms']").each do |d|
-          h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
-          h2.add_child(" ")
-          h2.add_child(d.remove)
+          term_cleanup_merge_termnum(d)
+          term_cleanup_merge_admitted(d)
         end
         docxml
       end
 
+      def term_cleanup_merge_termnum(term)
+        h2 = term.at("./preceding-sibling::*[@class = 'TermNum'][1]")
+        term["class"] = h2["class"]
+        term["id"] = h2["id"]
+        term.children.first.previous = " "
+        term.children.first.previous = h2.remove.children
+      end
+
+      def term_cleanup_merge_admitted(term)
+        term.xpath("./following-sibling::p[@class = 'AltTerms' or "\
+                   "@class = 'DeprecatedTerms']").each do |a|
+          term << " "
+          term << a.children
+          a.remove
+        end
+      end
+
+      def deprecated_term_parse(node, out)
+        out.p **{ class: "DeprecatedTerms" } do |p|
+          node.children.each { |c| parse(c, p) }
+          p << "&#xa0;"
+          p.span **{ class: "AdmittedLabel" } do |s|
+            s << l10n(@i18n.deprecated)
+          end
+        end
+      end
+
+      def admitted_term_parse(node, out)
+        out.p **{ class: "AltTerms" } do |p|
+          node.children.each { |c| parse(c, p) }
+          p << "&#xa0;"
+          p.span **{ class: "AdmittedLabel" } do |s|
+            s << l10n(@i18n.admitted)
+          end
+        end
+      end
+
       def example_parse(node, out)
         name = node.at(ns("./name"))
-        example_name_parse(node, out, name) #if name
+        example_name_parse(node, out, name) # if name
         super
       end
 
-      def example_label(node, div, name)
-      end
+      def example_label(node, div, name); end
 
-      def example_name_parse(node, div, name)
+      def example_name_parse(_node, div, name)
         div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
           name&.children&.each { |n| parse(n, p) }
         end
@@ -56,6 +91,7 @@ module IsoDoc
 
       def is_clause?(name)
         return true if name == "submitters"
+
         super
       end
 
@@ -84,8 +120,8 @@ module IsoDoc
       def make_tr_attr(td, row, totalrows, header)
         ret = super
         if td.at("./ancestor::xmlns:table[@class = 'recommendation'] | "\
-            "./ancestor::xmlns:table[@class = 'requirement'] | "\
-            "./ancestor::xmlns:table[@class = 'permission']")
+                 "./ancestor::xmlns:table[@class = 'requirement'] | "\
+                 "./ancestor::xmlns:table[@class = 'permission']")
           ret[:style] = "vertical-align:top;"
           ret[:class] = "recommend"
         end
@@ -94,6 +130,7 @@ module IsoDoc
 
       def para_class(node)
         return node["class"] if node["class"]
+
         super
       end
     end