metanorma-ogc 2.7.4 → 2.7.6

data/lib/isodoc/ogc/presentation_sections.rb

@@ -4,15 +4,24 @@ module IsoDoc
       def middle_title(docxml); end
 
       def preface_rearrange(doc)
-        super
+        [
+          ["//preface/abstract",
+           %w(executivesummary foreword introduction clause acknowledgements)],
+          ["//preface/executivesummary",
+           %w(foreword introduction clause acknowledgements)],
+          ["//preface/foreword",
+           %w(introduction clause acknowledgements)],
+          ["//preface/introduction",
+           %w(clause acknowledgements)],
+          ["//preface/acknowledgements", %w()],
+        ].each do |x|
+          preface_move(doc.xpath(ns(x[0])), x[1], doc)
+        end
         insert_preface_sections(doc)
       end
 
       def insert_preface_sections(doc)
-        preface_insert(doc.at(ns("//preface/clause" \
-                                 "[@type = 'executivesummary']")),
-                       doc.at(ns("//preface/abstract")), doc)
-        preface_insert(doc.at(ns("//preface//submitters")),
+        preface_insert(doc.at(ns("//preface//clause[@type = 'submitters' or @type = 'contributors']")),
                        submit_orgs_append_pt(doc), doc)
         insert_submitting_orgs(doc)
         preface_insert(doc.at(ns("//preface/clause[@type = 'security']")),
@@ -39,8 +48,8 @@ module IsoDoc
       def submit_orgs_append_pt(docxml)
         docxml.at(ns("//foreword")) ||
           docxml.at(ns("//preface/clause[@type = 'keywords']")) ||
-          docxml.at(ns("//preface/clause[@type = 'executivesummary']")) ||
-          docxml.at(ns("//preface/abstract"))
+          docxml.at(ns("//preface/abstract")) ||
+          docxml.at(ns("//preface/executivesummary"))
       end
 
       def insert_submitting_orgs(docxml)
@@ -78,7 +87,7 @@ module IsoDoc
         kw = @meta.get[:keywords]
         kw.empty? and return
         if abstract =
-             docxml.at(ns("//preface/clause[@type = 'executivesummary']")) ||
+             docxml.at(ns("//preface/executivesummary")) ||
              docxml.at(ns("//preface/abstract"))
           abstract.next = keyword_clause(kw)
         else
@@ -88,12 +97,7 @@ module IsoDoc
       end
 
       def annex_delim(_elem)
-      "<br/>"
-    end
-
-      def clause(docxml)
-        super
-        docxml.xpath(ns("//submitters")).each { |f| clause1(f) }
+        "<br/>"
       end
 
       def clause1(elem)

data/lib/isodoc/ogc/sections.rb

@@ -1,13 +1,6 @@
 module IsoDoc
   module Ogc
     module BaseConvert
-      def top_element_render(node, out)
-        case node.name
-        when "submitters" then intro_clause node, out
-        else super
-        end
-      end
-
       def preface(clause, out)
         case clause["type"]
         when "toc"
@@ -17,10 +10,6 @@ module IsoDoc
         end
       end
 
-      def sections_names
-        super + %w[submitters]
-      end
-
       def intro_clause(elem, out)
         out.div class: "Section3", id: elem["id"] do |div|
           clause_name(elem, elem&.at(ns("./fmt-title")), div,

data/lib/isodoc/ogc/xref.rb

@@ -42,7 +42,7 @@ module IsoDoc
       def middle_section_asset_names(doc)
         middle_sections =
           "//clause[@type = 'scope' or @type = 'conformance'] | //foreword | " \
-          "//introduction | //preface/abstract | //submitters | " \
+          "//introduction | //preface/abstract | " \
           "//acknowledgements | //preface/clause | " \
           "#{@klass.norm_ref_xpath} | //sections/terms | " \
           "//sections/definitions | //clause[parent::sections]"
@@ -69,7 +69,7 @@ module IsoDoc
       def preface_names_numbered1(clause, parentnum, num, level)
         lbl = clause_number_semx(parentnum, clause, num)
         @anchors[clause["id"]] =
-          { label: lbl, level: level, 
+          { label: lbl, level: level,
             xref: labelled_autonum(@labels["clause"], lbl),
             type: "clause", elem: @labels["clause"] }
         clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
@@ -110,7 +110,7 @@ module IsoDoc
           @anchors[t["id"]] = anchor_struct(
             c.print, t,
             @labels["sourcecode"], "sourcecode",
-            { unnumb: t["unnumbered"], container: container}
+            { unnumb: t["unnumbered"], container: container }
           )
         end
       end
@@ -123,13 +123,12 @@ module IsoDoc
       def hierarchical_sourcecode_names(clauses, num)
         c = Counter.new
         nodeSet(clauses).each do |clause|
-        clause.xpath(ns(LISTING)).noblank.each do |t|
-          @anchors[t["id"]] =
-            anchor_struct(#"#{num}#{hier_separator}#{c.increment(t).print}", 
-                          hiersemx(clause, num, c.increment(t), t),
-                          t, @labels["sourcecode"],
-                          "sourcecode", { unnumb:t["unnumbered"] })
-        end
+          clause.xpath(ns(LISTING)).noblank.each do |t|
+            @anchors[t["id"]] =
+              anchor_struct(hiersemx(clause, num, c.increment(t), t),
+                            t, @labels["sourcecode"],
+                            "sourcecode", { unnumb: t["unnumbered"] })
+          end
         end
       end
     end

data/lib/metanorma/ogc/basicdoc.rng

@@ -267,6 +267,10 @@ in a document (e.g. sourcecode annotations)</a:documentation>
       <value>justified</value>
     </choice>
   </define>
+  <define name="IdRefType">
+    <a:documentation>Type of cross-references to elements. In BasicDoc, these always point to id { xsd:ID } </a:documentation>
+    <data type="IDREF"/>
+  </define>
   <define name="RequiredId">
     <a:documentation>Mandatory anchor of element, to be used for cross-references within the document</a:documentation>
     <attribute name="id">
@@ -409,13 +413,13 @@ in a document (e.g. sourcecode annotations)</a:documentation>
       <attribute name="from">
         <a:documentation>Identifier for the start of the text or point in the text to which the comment applies.
 If not provided, the comment applies in the vicinity of the place it has been inserted into the text</a:documentation>
-        <data type="IDREF"/>
+        <ref name="IdRefType"/>
       </attribute>
     </optional>
     <optional>
       <attribute name="to">
         <a:documentation>Identifier for the end of the text to which the comment applies</a:documentation>
-        <data type="IDREF"/>
+        <ref name="IdRefType"/>
       </attribute>
     </optional>
   </define>
@@ -1504,7 +1508,7 @@ Restricted recursively to contain only other such inline elements with no identi
         <attribute name="to">
           <a:documentation>A reference to an anchor element (typically a bookmark), 
 to indicate that the index range covers a range of locations between the current index element and the `to` anchor</a:documentation>
-          <data type="IDREF"/>
+          <ref name="IdRefType"/>
         </attribute>
       </optional>
       <ref name="index-primary">
@@ -1662,7 +1666,7 @@ which can be bookmarks as well as block or section references</a:documentation>
   <define name="XrefAttributes">
     <attribute name="target">
       <a:documentation>The identifier of a section, block or inlined element being referenced</a:documentation>
-      <data type="IDREF"/>
+      <ref name="IdRefType"/>
     </attribute>
     <optional>
       <attribute name="type">
@@ -1723,7 +1727,7 @@ The target of a footnote is the location it is embedded in within the text</a:do
       <attribute name="target">
         <a:documentation>The target of the callout is understood to be the location of the callout within the source code; 
 the extent of the target is not expressed overtly</a:documentation>
-        <data type="IDREF"/>
+        <ref name="IdRefType"/>
       </attribute>
       <text>
         <a:documentation>The label of the callout, used to identify its target within the source code</a:documentation>

data/lib/metanorma/ogc/cleanup.rb

@@ -14,26 +14,17 @@ module Metanorma
 
       def make_preface(xml, sect)
         super
-        insert_execsummary(xml, sect)
         insert_security(xml, sect)
         insert_submitters(xml, sect)
       end
 
-      def add_id
+      def add_id_txt
         %(id="_#{UUIDTools::UUID.random_create}")
       end
 
-      def insert_execsummary(xml, sect)
-        summ = xml&.at("//clause[@type = 'executivesummary']")&.remove or
-          return
-        preface = sect.at("//preface") ||
-          sect.add_previous_sibling("<preface/>").first
-        preface.add_child summ
-      end
-
       def insert_security(xml, sect)
-        description = "document"
-        description = "standard" if %w(standard community-standard)
+        "document"
+        "standard" if %w(standard community-standard)
           .include?(@doctype)
         @doctype == "engineering-report" and return remove_security(xml)
         preface = sect.at("//preface") ||
@@ -54,21 +45,20 @@ module Metanorma
         description = "standard" if %w(standard community-standard)
           .include?(doctype)
         <<~CLAUSE
-          <clause type='security' #{add_id}>
+          <clause type='security' #{add_id_txt}>
             <title>Security considerations</title>
             <p>#{@i18n.security_empty.sub('%', description)}</p></clause>
         CLAUSE
       end
 
       def insert_submitters(xml, sect)
-        if xml.at("//submitters")
-          preface = sect.at("//preface") ||
+        if xml.at("//clause[@type = 'submitters' or @type = 'contributors']")
+          p = sect.at("//preface") ||
             sect.add_previous_sibling("<preface/>").first
-          xml.xpath("//submitters").each do |s|
-            s.xpath(".//table").each do |t|
-              t["unnumbered"] = true
-            end
-            preface.add_child s.remove
+          xml.xpath("//clause[@type = 'submitters' or @type = 'contributors']")
+            .each do |s|
+            s.xpath(".//table").each { |t| t["unnumbered"] = true }
+            p.add_child s.remove
           end
         end
       end

data/lib/metanorma/ogc/converter.rb

@@ -7,13 +7,7 @@ require_relative "cleanup"
 
 module Metanorma
   module Ogc
-    # A {Converter} implementation that generates RSD output, and a document
-    # schema encapsulation of the document for validation
-    #
     class Converter < Standoc::Converter
-      #XML_ROOT_TAG = "ogc-standard".freeze
-      #XML_NAMESPACE = "https://www.metanorma.org/ns/ogc".freeze
-
       register_for "ogc"
 
       def init_toc(node)
@@ -71,10 +65,8 @@ module Metanorma
 
       def override_style(node)
         s = node.attr("style")
-        if %w(executive_summary overview future_outlook value_proposition
-              contributors).include?(s)
+        if %w(overview future_outlook value_proposition contributors).include?(s)
           node.set_attr("style", "preface")
-          s == "executive_summary" and s = "executivesummary"
           node.set_attr("type", s)
         end
         if %w(aims objectives topics outlook security).include?(s)
@@ -88,11 +80,16 @@ module Metanorma
         when "foreword", "introduction" then "donotrecognise-foreword"
         when "references" then "normative references"
         when "glossary" then "terms and definitions"
-        else
-          super
+        else super
         end
       end
 
+      # legacy encoding
+      def sectiontype1(node)
+        role_style(node, "executive_summary") and return "executivesummary"
+        super
+      end
+
       def outputs(node, ret)
         File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
         presentation_xml_converter(node).convert("#{@filename}.xml")
@@ -105,20 +102,18 @@ module Metanorma
       end
 
       def clause_parse(attrs, xml, node)
-        %w(executivesummary overview future_outlook value_proposition
+        %w(overview future_outlook value_proposition
            contributors aims objectives topics outlook security)
           .include?(node.attr("type")) and
           attrs = attrs.merge(type: node.attr("type"))
         case node.attr("heading")&.downcase || node.title.downcase
         when "submitters"
-          return submitters_parse(attrs, xml, node)
+          return submitters_parse(attrs.merge(type: "submitters"), xml, node)
         when "contributors"
           return submitters_parse(attrs.merge(type: "contributors"), xml, node)
         when "conformance" then attrs = attrs.merge(type: "conformance")
         when "security considerations"
           attrs = attrs.merge(type: "security")
-        when "executive summary"
-          attrs = attrs.merge(type: "executivesummary")
         end
         super
       end
@@ -128,7 +123,7 @@ module Metanorma
         doctype(node) == "engineering-report" ||
           attrs[:type] == "contributors" and
           title = @i18n.contributors_clause
-        xml.submitters **attr_code(attrs) do |xml_section|
+        xml.clause **attr_code(attrs) do |xml_section|
           xml_section.title title
           xml_section << node.content
         end
@@ -155,6 +150,7 @@ module Metanorma
         attrs1 = attrs.merge(id: "_#{UUIDTools::UUID.random_create}")
         xml.annex **attr_code(attrs1) do |xml_section|
           xml_section.title { |name| name << node.title }
+          attrs.delete(:anchor)
           xml_section.terms **attr_code(attrs) do |terms|
             (s = node.attr("source")) && s.split(",").each do |s1|
               terms.termdocsource(nil, **attr_code(bibitemid: s1))
@@ -164,10 +160,6 @@ module Metanorma
         end
       end
 
-      def highlight_parse(text, xml)
-        xml.hi { |s| s << text }
-      end
-
       def set_obligation(attrs, node)
         if node.attr("style") == "appendix" && node.level == 1
           attrs[:obligation] = if node.attributes.has_key?("obligation")

data/lib/metanorma/ogc/isodoc.rng

@@ -1,6 +1,6 @@
 <?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">
-<!-- VERSION v2.0.3 -->
+<!-- VERSION v2.0.5 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -36,6 +36,12 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="IdRefType">
+      <a:documentation>Cross-references are not normalised to xsd:IDREF in Semantic XML: that is deferred to Presentation XML.
+All IdRefType instances point not to `@id` in Semantic XML, which is the Content GUID for an element,
+but to `@anchor`, the user-supplied cross-reference</a:documentation>
+      <text/>
+    </define>
     <define name="index-primary">
       <element name="primary">
         <oneOrMore>
@@ -238,7 +244,7 @@
           <a:documentation>Notes specific to this block</a:documentation>
         </ref>
       </zeroOrMore>
-      <ref name="TermSource">
+      <ref name="BlockSource">
         <a:documentation>A source for the table</a:documentation>
       </ref>
     </define>
@@ -262,10 +268,112 @@ and is intended to be referenced by a callout within the source code</a:document
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
-      <ref name="TermSource">
+      <ref name="BlockSource">
+        <a:documentation>A source for the block</a:documentation>
+      </ref>
+    </define>
+    <define name="FigureBody">
+      <optional>
+        <ref name="tname">
+          <a:documentation>The caption of the block</a:documentation>
+        </ref>
+      </optional>
+      <choice>
+        <a:documentation>Content of the figure</a:documentation>
+        <ref name="image"/>
+        <ref name="video"/>
+        <ref name="audio"/>
+        <ref name="pre"/>
+        <oneOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="figure"/>
+        </zeroOrMore>
+      </choice>
+      <zeroOrMore>
+        <ref name="fn">
+          <a:documentation>Footnotes specific to the figure</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <optional>
+        <ref name="dl">
+          <a:documentation>An optional definitions list defining any symbols used in the figure</a:documentation>
+        </ref>
+      </optional>
+      <zeroOrMore>
+        <ref name="note">
+          <a:documentation>Notes whose scope is the current block</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <ref name="BlockSource">
         <a:documentation>A source for the block</a:documentation>
       </ref>
     </define>
+    <define name="FigureNoIdBody">
+      <optional>
+        <ref name="source">
+          <a:documentation>A URI or other reference intended to link to an externally hosted image (or equivalent)</a:documentation>
+        </ref>
+      </optional>
+      <optional>
+        <ref name="tname">
+          <a:documentation>The caption of the block</a:documentation>
+        </ref>
+      </optional>
+      <choice>
+        <a:documentation>Content of the figure</a:documentation>
+        <ref name="image-no-id"/>
+        <ref name="video-no-id"/>
+        <ref name="audio-no-id"/>
+        <ref name="pre-no-id"/>
+        <oneOrMore>
+          <ref name="paragraph-with-footnote-no-id"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="figure-no-id"/>
+        </zeroOrMore>
+      </choice>
+      <zeroOrMore>
+        <ref name="fn">
+          <a:documentation>Footnotes specific to the figure</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <optional>
+        <ref name="dl-no-id">
+          <a:documentation>An optional definitions list defining any symbols used in the figure</a:documentation>
+        </ref>
+      </optional>
+      <zeroOrMore>
+        <ref name="note-no-id">
+          <a:documentation>Notes whose scope is the current block</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>A source for the block</a:documentation>
+      </ref>
+    </define>
+    <define name="source">
+      <element name="source">
+        <attribute name="status">
+          <a:documentation>The status of the term as it is used in this document, relative to its definition in the original document</a:documentation>
+          <ref name="SourceStatusType"/>
+        </attribute>
+        <attribute name="type">
+          <a:documentation>The type of the managed term in the present context</a:documentation>
+          <ref name="SourceTypeType"/>
+        </attribute>
+        <ref name="origin">
+          <a:documentation>The original document and location where the term definition has been obtained from</a:documentation>
+        </ref>
+        <optional>
+          <ref name="modification">
+            <a:documentation>Any changes that the definition of the term has undergone relative to the original document,
+in order to be applicable in this standardisation document</a:documentation>
+          </ref>
+        </optional>
+      </element>
+    </define>
     <define name="sourcecodebody">
       <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
 (The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
@@ -687,6 +795,20 @@ titlecase, or lowercase</a:documentation>
       </attribute>
     </optional>
   </define>
+  <define name="RequiredId" combine="interleave">
+    <optional>
+      <attribute name="anchor">
+        <a:documentation>User-supplied anchor of element; replaced by content-based id, with all references to the anchor updated accordingly</a:documentation>
+      </attribute>
+    </optional>
+  </define>
+  <define name="OptionalId" combine="interleave">
+    <optional>
+      <attribute name="anchor">
+        <a:documentation> User-supplied anchor of element; replaced by content-based id, with all references to the anchor updated accordingly</a:documentation>
+      </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>
@@ -1081,7 +1203,7 @@ That concept may be defined as a term within the current document, or it may be
     <element name="label">
       <!-- Identifier of form input element that this element is a label of -->
       <attribute name="for">
-        <data type="IDREF"/>
+        <ref name="IdRefType"/>
       </attribute>
       <zeroOrMore>
         <ref name="PureTextElement"/>
@@ -1328,6 +1450,7 @@ numbers</a:documentation>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
+          <ref name="executivesummary"/>
         </choice>
       </oneOrMore>
     </element>
@@ -1351,6 +1474,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"/>
@@ -1576,6 +1704,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">
@@ -2106,7 +2243,7 @@ used in document amendments</a:documentation>
   </define>
   <define name="termsource">
     <a:documentation>The bibliographic source where a term is defined in the sense applicable in this standardisation document</a:documentation>
-    <element name="termsource">
+    <element name="source">
       <attribute name="status">
         <a:documentation>The status of the term as it is used in this document, relative to its definition in the original document</a:documentation>
         <ref name="SourceStatusType"/>
@@ -2488,6 +2625,11 @@ Normative References contents contain normative references, but as a clause in t
       <ref name="termsource"/>
     </zeroOrMore>
   </define>
+  <define name="BlockSource">
+    <zeroOrMore>
+      <ref name="source"/>
+    </zeroOrMore>
+  </define>
   <start>
     <ref name="standard-document"/>
   </start>

data/lib/metanorma/ogc/ogc.rng

@@ -1,39 +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">
   <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>
-  </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/validate.rb

@@ -56,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!")
@@ -136,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.4".freeze
+    VERSION = "2.7.6".freeze
   end
 end

metadata

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