metanorma-ogc 2.7.3 → 2.7.5

data/lib/metanorma/ogc/isodoc.rng

@@ -1,24 +1,27 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
-  instantiations of this grammar may replace leaf strings
-  with more elaborated types; e.g. title (text) replaced with
-  title-main, title-intro, title-part; type replaced with
-  enum.
-  
-  some renaming at leaf nodes is permissible
-  
-  obligations can change both from optional to mandatory,
-  and from mandatory to optional; optional elements may
-  be omitted; freely positioned alternatives may be replaced
-  with strict ordering
-  
-  DO NOT introduce a namespace here. We do not want a distinct namespace
-  for these elements, and a distinct namespace for any grammar inheriting
-  these elements; we just want one namespace for any child grammars
-  of this.
--->
-<!-- VERSION v2.0.2 -->
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+<!-- VERSION v2.0.4 -->
+
+  <!--
+    ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
+    
+    instantiations of this grammar may replace leaf strings
+    with more elaborated types; e.g. title (text) replaced with
+    title-main, title-intro, title-part; type replaced with
+    enum.
+    
+    some renaming at leaf nodes is permissible
+    
+    obligations can change both from optional to mandatory,
+    and from mandatory to optional; optional elements may
+    be omitted; freely positioned alternatives may be replaced
+    with strict ordering
+    
+    DO NOT introduce a namespace here. We do not want a distinct namespace
+    for these elements, and a distinct namespace for any grammar inheriting
+    these elements; we just want one namespace for any child grammars
+    of this.
+  -->
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
     <define name="amend">
@@ -33,15 +36,6 @@
         </zeroOrMore>
       </element>
     </define>
-    <define name="fn" combine="interleave">
-      <optional>
-        <attribute name="hiddenref">
-          <a:documentation>If true, number the footnote as normal, but suppress display of the footnote reference in the document body.
-This is done if the footnote reference is already presented in some other form, e.g. within a figure image.</a:documentation>
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-    </define>
     <define name="index-primary">
       <element name="primary">
         <oneOrMore>
@@ -423,20 +417,12 @@ normative or informative references, some split references into sections organiz
         </oneOrMore>
       </choice>
     </define>
-    <define name="TdAttributes" combine="interleave">
-      <attribute name="style">
-        <a:documentation>CSS style: only background-color supported</a:documentation>
-      </attribute>
-    </define>
-    <define name="ThAttributes" combine="interleave">
-      <attribute name="style">
-        <a:documentation>CSS style: only background-color supported</a:documentation>
-      </attribute>
-    </define>
     <define name="TrAttributes">
-      <attribute name="style">
-        <a:documentation>CSS style: only background-color supported</a:documentation>
-      </attribute>
+      <optional>
+        <attribute name="style">
+          <a:documentation>CSS style: only background-color supported</a:documentation>
+        </attribute>
+      </optional>
     </define>
     <define name="table-note">
       <element name="note">
@@ -500,6 +486,22 @@ gives an explicit page orientation</a:documentation>
     </define>
   </include>
   <!-- end overrides -->
+  <define name="FnAttributes" combine="interleave">
+    <optional>
+      <attribute name="hiddenref">
+        <a:documentation>If true, number the footnote as normal, but suppress display of the footnote reference in the document body.
+This is done if the footnote reference is already presented in some other form, e.g. within a figure image.</a:documentation>
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+  </define>
+  <define name="TdAttributes" combine="interleave">
+    <optional>
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </optional>
+  </define>
   <define name="NumberingAttributes" combine="interleave">
     <optional>
       <attribute name="number">
@@ -678,6 +680,13 @@ titlecase, or lowercase</a:documentation>
       </attribute>
     </optional>
   </define>
+  <define name="Basic-Section-Attributes" combine="interleave">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+  </define>
   <define name="ObligationType">
     <a:documentation>The force of a clause in a standard document: whether it has normative or informative effect</a:documentation>
     <choice>
@@ -1192,13 +1201,6 @@ numbers</a:documentation>
       </attribute>
     </optional>
   </define>
-  <define name="Basic-Section-Attributes" combine="interleave">
-    <optional>
-      <attribute name="obligation">
-        <ref name="ObligationType"/>
-      </attribute>
-    </optional>
-  </define>
   <define name="reference-clause">
     <a:documentation>References clause with recursive nesting</a:documentation>
     <element name="clause">
@@ -1239,7 +1241,7 @@ numbers</a:documentation>
       </choice>
     </attribute>
     <attribute name="flavor">
-      <a:documentation>Metanorma flavor, indicating SDO whose requiremnts the realisation aligns to</a:documentation>
+      <a:documentation>Metanorma flavor, indicating SDO whose requirements the realisation aligns to</a:documentation>
     </attribute>
   </define>
   <define name="standard-document">
@@ -1249,6 +1251,11 @@ numbers</a:documentation>
       <ref name="bibdata">
         <a:documentation>Bibliographic description of the document itself, expressed in the Relaton model</a:documentation>
       </ref>
+      <zeroOrMore>
+        <ref name="termdocsource">
+          <a:documentation>Source for term definitions in the document</a:documentation>
+        </ref>
+      </zeroOrMore>
       <optional>
         <ref name="misccontainer">
           <a:documentation>Extension point for extraneous elements that need to be added to standards document as data</a:documentation>
@@ -1259,34 +1266,7 @@ numbers</a:documentation>
           <a:documentation>Front matter that is repeated at the start of documents issued from an SDO, with content not specific to the document</a:documentation>
         </ref>
       </optional>
-      <optional>
-        <ref name="preface">
-          <a:documentation>Prefatory sections</a:documentation>
-        </ref>
-      </optional>
-      <ref name="sections">
-        <a:documentation>Main body of document</a:documentation>
-      </ref>
-      <zeroOrMore>
-        <ref name="annex">
-          <a:documentation>Annex sections</a:documentation>
-        </ref>
-      </zeroOrMore>
-      <optional>
-        <ref name="bibliography">
-          <a:documentation>Bibliographic sections</a:documentation>
-        </ref>
-      </optional>
-      <zeroOrMore>
-        <ref name="indexsect">
-          <a:documentation>Index of the document</a:documentation>
-        </ref>
-      </zeroOrMore>
-      <optional>
-        <ref name="colophon">
-          <a:documentation>Colophon or postface material</a:documentation>
-        </ref>
-      </optional>
+      <ref name="DocumentBody"/>
       <optional>
         <ref name="review-container">
           <a:documentation>Annotations to the document</a:documentation>
@@ -1294,6 +1274,36 @@ numbers</a:documentation>
       </optional>
     </element>
   </define>
+  <define name="DocumentBody">
+    <optional>
+      <ref name="preface">
+        <a:documentation>Prefatory sections</a:documentation>
+      </ref>
+    </optional>
+    <ref name="sections">
+      <a:documentation>Main body of document</a:documentation>
+    </ref>
+    <zeroOrMore>
+      <ref name="annex">
+        <a:documentation>Annex sections</a:documentation>
+      </ref>
+    </zeroOrMore>
+    <optional>
+      <ref name="bibliography">
+        <a:documentation>Bibliographic sections</a:documentation>
+      </ref>
+    </optional>
+    <zeroOrMore>
+      <ref name="indexsect">
+        <a:documentation>Index of the document</a:documentation>
+      </ref>
+    </zeroOrMore>
+    <optional>
+      <ref name="colophon">
+        <a:documentation>Colophon or postface material</a:documentation>
+      </ref>
+    </optional>
+  </define>
   <define name="misccontainer">
     <a:documentation>Elements added to metanorma-extension are open-ended, and constitute source data</a:documentation>
     <element name="metanorma-extension">
@@ -1318,6 +1328,7 @@ numbers</a:documentation>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
+          <ref name="executivesummary"/>
         </choice>
       </oneOrMore>
     </element>
@@ -1341,6 +1352,11 @@ numbers</a:documentation>
       <ref name="Content-Section"/>
     </element>
   </define>
+  <define name="executivesummary">
+    <element name="executivesummary">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
   <define name="indexsect">
     <element name="indexsect">
       <ref name="Content-Section"/>
@@ -1566,6 +1582,15 @@ used in document amendments</a:documentation>
   <define name="annex">
     <element name="annex">
       <ref name="Annex-Section"/>
+      <zeroOrMore>
+        <ref name="annex-appendix"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="annex-appendix">
+    <a:documentation>Appendix, distinct subclause type for annexes (annex to annex, rather than subclause to annex)</a:documentation>
+    <element name="appendix">
+      <ref name="Clause-Section"/>
     </element>
   </define>
   <define name="terms">
@@ -1608,9 +1633,7 @@ used in document amendments</a:documentation>
   <define name="term">
     <a:documentation>Terminology entry with its definition</a:documentation>
     <element name="term">
-      <ref name="OptionalId"/>
-      <ref name="LocalizedStringAttributes"/>
-      <ref name="BlockAttributes"/>
+      <ref name="TermAttributes"/>
       <oneOrMore>
         <ref name="preferred">
           <a:documentation>One or more names under which the term being defined is canonically known</a:documentation>
@@ -1662,6 +1685,11 @@ used in document amendments</a:documentation>
       </ref>
     </element>
   </define>
+  <define name="TermAttributes">
+    <ref name="OptionalId"/>
+    <ref name="LocalizedStringAttributes"/>
+    <ref name="BlockAttributes"/>
+  </define>
   <define name="preferred">
     <element name="preferred">
       <ref name="Designation"/>
@@ -2323,26 +2351,32 @@ links within an SVG file, so that the SVG file can hyperlink to anchors within t
     </element>
   </define>
   <define name="ul_li">
-    <a:documentation>Unorderd list item for standards documents</a:documentation>
+    <a:documentation>Unordered list item for standards documents</a:documentation>
     <element name="li">
       <ref name="OptionalId"/>
-      <optional>
-        <attribute name="uncheckedcheckbox">
-          <a:documentation>Include a checkbox for the list item</a:documentation>
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="checkedcheckbox">
-          <a:documentation>Check the checkbox for the list item</a:documentation>
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <oneOrMore>
-        <ref name="BasicBlock"/>
-      </oneOrMore>
+      <ref name="UlLiAttributes"/>
+      <ref name="UlLiBody"/>
     </element>
   </define>
+  <define name="UlLiBody">
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="UlLiAttributes">
+    <optional>
+      <attribute name="uncheckedcheckbox">
+        <a:documentation>Include a checkbox for the list item</a:documentation>
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="checkedcheckbox">
+        <a:documentation>Check the checkbox for the list item</a:documentation>
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+  </define>
   <define name="floating-title">
     <a:documentation>A floating title, outside of the clause hierarchy of the document</a:documentation>
     <element name="floating-title">

data/lib/metanorma/ogc/ogc.rng

@@ -1,71 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar ns='https://www.metanorma.org/ns/standoc' xmlns="http://relaxng.org/ns/structure/1.0">
-  <!--
-    VERSION v1.2.1
-    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="relaton-ogc.rng"/>
-  <include href="isodoc.rng">
-    <define name="preface">
-      <element name="preface">
-        <optional>
-          <ref name="abstract"/>
-        </optional>
-        <ref name="foreword"/>
-        <optional>
-          <ref name="submitters"/>
-        </optional>
-      </element>
-    </define>
-    <define name="standard-document">
-      <element name="metanorma">
-        <ref name="Root-Attributes"/>
-        <ref name="bibdata"/>
-        <zeroOrMore>
-          <ref name="termdocsource"/>
-        </zeroOrMore>
-        <optional>
-          <ref name="misccontainer"/>
-        </optional>
-        <optional>
-          <ref name="boilerplate"/>
-        </optional>
-        <ref name="preface"/>
-        <oneOrMore>
-          <ref name="sections"/>
-        </oneOrMore>
-        <zeroOrMore>
-          <ref name="annex"/>
-        </zeroOrMore>
-        <ref name="bibliography"/>
-        <zeroOrMore>
-          <ref name="indexsect"/>
-        </zeroOrMore>
-      </element>
-    </define>
-  </include>
-  <!-- end overrides -->
-  <define name="TextElement" combine="choice">
-    <ref name="hi"/>
-  </define>
-  <define name="PureTextElement" combine="choice">
-    <ref name="hi"/>
-  </define>
-  <define name="hi">
-    <element name="hi">
-      <zeroOrMore>
-        <choice>
-          <ref name="PureTextElement"/>
-          <ref name="stem"/>
-        </choice>
-      </zeroOrMore>
-    </element>
-  </define>
-  <define name="submitters">
-    <element name="submitters">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
+  <include href="isodoc.rng"/>
 </grammar>
+<!-- end overrides -->

data/lib/metanorma/ogc/relaton-ogc.rng

@@ -45,22 +45,6 @@
         </optional>
       </element>
     </define>
-    <define name="BibDataExtensionType">
-      <optional>
-        <attribute name="schema-version"/>
-      </optional>
-      <optional>
-        <ref name="doctype"/>
-      </optional>
-      <optional>
-        <ref name="docsubtype"/>
-      </optional>
-      <ref name="flavor"/>
-      <ref name="editorialgroup"/>
-      <zeroOrMore>
-        <ref name="ics"/>
-      </zeroOrMore>
-    </define>
     <define name="stage">
       <element name="stage">
         <ref name="StageType"/>

data/lib/metanorma/ogc/reqt.rng

@@ -1,5 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <!-- ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437 -->
   <!--
     Presupposes isodoc.rnc, is included in it
     include "isodoc.rnc" { }
@@ -7,14 +13,9 @@
     This is the Metanorma default provisions model; it is overridden by other provisions models,
     such as Modspec
   -->
-  <define name="requirement">
+  <define name="recommendation">
     <a:documentation>Specification of an attribute of a subject that is required.
 NOTE: A requirement can contain other requirements</a:documentation>
-    <element name="requirement">
-      <ref name="RequirementType"/>
-    </element>
-  </define>
-  <define name="recommendation">
     <a:documentation>Specification of an attribute of a subject that is recommended</a:documentation>
     <element name="recommendation">
       <ref name="RequirementType"/>

data/lib/metanorma/ogc/validate.rb

@@ -1,10 +1,8 @@
 module Metanorma
   module Ogc
     class Converter < Standoc::Converter
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "ogc.rng"))
+      def schema_file
+        "ogc.rng"
       end
 
       def title_validate(_root)
@@ -32,18 +30,18 @@ module Metanorma
       end
 
       def stage_type_validate(stage, doctype)
-        err = case doctype
-              when "standard", "abstract-specification-topic", "draft-standard"
-                %w(draft work-item-draft).include?(stage)
-              when "community-standard"
-                %w(draft swg-draft).include?(stage)
-              when "best-practice", "community-practice"
-                %w(draft swg-draft work-item-draft).include?(stage)
-              else %w(swg-draft oab-review public-rfc tc-vote
-                      work-item-draft deprecated rescinded legacy).include?(stage)
-              end
-        err and @log.add("Document Attributes", nil,
-                         "#{stage} is not an allowed status for #{doctype}")
+        case doctype
+        when "standard", "abstract-specification-topic", "draft-standard"
+          %w(draft work-item-draft).include?(stage)
+        when "community-standard"
+          %w(draft swg-draft).include?(stage)
+        when "best-practice", "community-practice"
+          %w(draft swg-draft work-item-draft).include?(stage)
+        else %w(swg-draft oab-review public-rfc tc-vote work-item-draft
+                deprecated rescinded legacy).include?(stage)
+        end and
+          @log.add("Document Attributes", nil,
+                   "#{stage} is not an allowed status for #{doctype}")
       end
 
       def version_validate(xmldoc)
@@ -58,7 +56,7 @@ module Metanorma
       end
 
       def execsummary_validate(xmldoc)
-        sect = xmldoc.at("//clause[@type = 'executivesummary']")
+        sect = xmldoc.at("//executivesummary")
         @doctype == "engineering-report" && sect.nil? and
           @log.add("Style", nil,
                    "Executive Summary required for Engineering Reports!")
@@ -108,8 +106,7 @@ module Metanorma
       end
 
       def sections_sequence_validate(root)
-        return unless STANDARDTYPE.include?(@doctype)
-
+        STANDARDTYPE.include?(@doctype) or return
         names = root.xpath("//sections/* | //bibliography/*")
         names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val])
         names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val])
@@ -139,8 +136,8 @@ module Metanorma
         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!")
+        root.at("//clause[@type = 'submitters' or @type = 'contributors']") or
+          @log.add("Style", nil, "Submitters is missing!")
       end
 
       def norm_ref_validate(doc)

data/lib/metanorma/ogc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ogc
-    VERSION = "2.7.3".freeze
+    VERSION = "2.7.5".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ogc
 version: !ruby/object:Gem::Version
-  version: 2.7.3
+  version: 2.7.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iso-639