metanorma-ogc 1.0.2 → 1.0.7

data/lib/asciidoctor/ogc/boilerplate.xml

@@ -3,11 +3,17 @@
     <clause>
       <title>Copyright notice</title>
 
-      <p align="center">Copyright
+      <p>Copyright
         © {{ docyear }} Open Geospatial Consortium<br/>
         To obtain additional rights of use, visit 
         <link target="http://www.opengeospatial.org/legal/">http://www.opengeospatial.org/legal/</link></p>
     </clause>
+    <clause>
+      <title>Note</title>
+      <p>Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. The Open Geospatial Consortium shall not be held responsible for identifying any or all such patent rights.</p>
+
+      <p>Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the standard set forth in this document, and to provide supporting documentation.</p>
+    </clause>
   </copyright-statement>
   <license-statement>
     <clause>
@@ -71,7 +77,9 @@
         authorization of LICENSOR or such copyright holder. LICENSOR is and shall at
         all times be the sole entity that may authorize you or any third party to use
         certification marks, trademarks or other special designations to indicate
-        compliance with any LICENSOR standards or specifications. This Agreement is
+        compliance with any LICENSOR standards or specifications.</p>
+     
+      <p> This Agreement is
         governed by the laws of the Commonwealth of Massachusetts. The application to
         this Agreement of the United Nations Convention on Contracts for the
         International Sale of Goods is hereby expressly excluded. In the event any
@@ -80,88 +88,63 @@
         modified the entire Agreement shall remain in full force and effect. No
         decision, action or inaction by LICENSOR shall be construed to be a waiver of
         any rights or remedies available to it.</p>
+
+      <p>None of the Intellectual Property or underlying information or technology may be downloaded or otherwise exported or reexported in violation of U.S. export laws and regulations. In addition, you are responsible for complying with any local laws in your jurisdiction which may impact your right to import, export or use the Intellectual Property, and you represent that you have complied with any regulations or registration procedures required by applicable law to make this license enforceable.</p>
     </clause>
   </license-statement>
 
   <legal-statement>
-    {% if stage == "Published" or stage == "Withdrawn" %}
     {% if doctype == "Standard" or doctype == "Community Standard" %}
+    {% if stage == "Published" or stage == "Withdrawn" %}
     <clause>
       <title>Warning</title>
       <p>This document is an OGC Member approved international standard. This document is available on a royalty free, non-discriminatory basis. Recipients of this document are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.
       </p>
     </clause>
-
-    {% elsif doctype == "Discussion Paper" %}
+    {% else %}
     <clause>
-      <title>Warning</title>
-      <p>This document is not an OGC Standard. This document is an OGC Discussion Paper and is therefore <em>not an official position</em> of the OGC membership. It is distributed for review and comment. It is subject to change without notice and may not be referred to as an OGC Standard. Further, an OGC Discussion Paper should not be referenced as required or mandatory technology in procurements.
-      </p>
+      <title>Warning for Drafts</title>
+      <p>This document is not an OGC Standard. This document is distributed for review and comment. This document is subject to change without notice and may not be referred to as an OGC Standard.</p>
+
+      <p>Recipients of this document are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.</p>
     </clause>
+    {% endif %}
 
 
     {% elsif doctype == "Engineering Report" %}
     <clause>
       <title>Warning</title>
-      <p>This document is not an OGC Standard. This document is an OGC Public Engineering Report created as a deliverable in an OGC Interoperability Initiative and is <em>not an official position</em> of the OGC membership. It is distributed for review and comment. It is subject to change without notice and may not be referred to as an OGC Standard. Further, any OGC Engineering Report should not be referenced as required or mandatory technology in procurements.
-      </p>
+      <p>This document is not an OGC Standard. This document is an OGC Public Engineering Report created as a deliverable in an OGC Interoperability Initiative and is <em>not an official position</em> of the OGC membership. It is distributed for review and comment. It is subject to change without notice and may not be referred to as an OGC Standard.</p>
+     
+      <p>Further, any OGC Engineering Report should not be referenced as required or mandatory technology in procurements. However, the discussions in this document could very well lead to the definition of an OGC Standard.</p>
     </clause>
 
 
     {% elsif doctype == "Best Practice" %}
     <clause>
       <title>Warning</title>
-      <p>This document defines an OGC Best Practices on a particular technology or approach related to an OGC standard. This document is <em>not</em> an OGC Standard and may not be referred to as an OGC Standard. It is subject to change without notice. However, this document is an <em>official</em> position of the OGC membership on this particular technology topic.
-      </p>
-    </clause>
+      <p>This document defines an OGC Best Practice on a particular technology or approach related to an OGC standard. This document is <em>not</em> an OGC Standard and may not be referred to as an OGC Standard. It is subject to change without notice. However, this document is an <em>official</em> position of the OGC membership on this particular technology topic.</p>
 
-    {% elsif doctype == "Policy" %}
-    <clause>
-      <title>Warning</title>
-      <p>This document is an OGC Policies and Procedures Document. The document is subject to change based on membership requirements and motions. Please note that the OGC <link target="http://www.opengeospatial.org/ogc/policies/directives">Policies Related to OGC Standards</link> should be also be read.
-      </p>
-    </clause>
-    {% else %}
-    <clause>
-      <title>Warning</title>
-      <p>This document is published by OGC. 
-      </p>
+      <p>Recipients of this document are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.</p>
     </clause>
-    {% endif %}
 
-    {% else %}
+    {% elsif doctype == "Release Notes" %}
     <clause>
-      <title>Warning for Drafts</title>
-
-      {% if doctype == "Standard" or doctype == "Standard With Suite" %}
-      <p>This document is not an OGC Standard. This document is distributed for review and comment. This document is subject to change without notice and may not be referred to as an OGC Standard.</p>
-
-      <p>Recipients of this document are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.</p>
-
-      {% elsif doctype == "Best Practice" %}
-      <p>This document defines an OGC Best Practice on a particular technology or approach related to an OGC standard. This document is not an OGC Standard and may not be referred to as an OGC Standard. It is subject to change without notice. However, this document is an official position of the OGC membership on this particular technology topic.</p>
-
-      <p>Recipients of this document are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.</p>
-
-      {% elsif doctype == "Discussion Paper" %}
-      <p>This document is not an OGC Standard. This document is an OGC Discussion Paper and is therefore not an official position of the OGC membership. It is distributed for review and comment. It is subject to change without notice and may not be referred to as an OGC Standard. Further, an OGC Discussion Paper should not be referenced as required or mandatory technology in procurements.</p>
-
-      {% elsif doctype == "White Paper" %}
-      <p>This document is not an OGC Standard. This document is an OGC White Paper and is therefore not an official position of the OGC membership. It is distributed for review and comment. It is subject to change without notice and may not be referred to as an OGC Standard. Further, an OGC White Paper should not be referenced as required or mandatory technology in procurements.</p>
-
-      {% elsif doctype == "Release Notes" %}
+      <title>Warning</title>
       <p>This document is not an OGC standard. This document provides release notes for an OGC standard. This document is subject to change without notice and may not be referred to as an OGC Standard.</p>
 
       <p>Recipients of this document are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.</p>
 
-      {% else %}
-       <p>This document is not an OGC Standard. This document is distributed for review and comment. This document is subject to change without notice and may not be referred to as an OGC Standard.</p>
-
-      <p>Recipients of this document are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.</p>
-      {% endif %}
+    </clause>
 
+    {% else %}
+    <clause>
+      <title>Warning</title>
+      <p>This document is not an OGC Standard. This document is an OGC {{ doctype }} and is therefore not an official position of the OGC membership. It is distributed for review and comment. It is subject to change without notice and may not be referred to as an OGC Standard.</p>
+      <p>Further, an OGC {{ doctype }} should not be referenced as required or mandatory technology in procurements.</p>
     </clause>
     {% endif %}
+
   </legal-statement>
 
 

data/lib/asciidoctor/ogc/converter.rb

@@ -33,7 +33,8 @@ module Asciidoctor
           reference-model release-notes standard user-guide white-paper 
           test-suite}.include? d
           @warned_doctype or
-            warn "'#{d}' is not a legal document type: reverting to 'standard'"
+            @log.add("Document Attributes", nil,
+                     "'#{d}' is not a legal document type: reverting to 'standard'")
           @warned_doctype = true
           d = "standard"
         end
@@ -45,6 +46,7 @@ module Asciidoctor
         when "preface" then "foreword"
         when "foreword" then "donotrecognise-foreword"
         when "introduction" then "donotrecognise-foreword"
+        when "references" then "normative references"
         else
           super
         end
@@ -60,8 +62,9 @@ module Asciidoctor
           File.open(filename, "w") { |f| f.write(ret) }
           html_converter(node).convert filename unless node.attr("nodoc")
           word_converter(node).convert filename unless node.attr("nodoc")
-          pdf_converter(node).convert filename unless node.attr("nodoc")
+          pdf_converter(node)&.convert filename unless node.attr("nodoc")
         end
+        @log.write(@localdir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
         ret
       end
@@ -97,14 +100,6 @@ module Asciidoctor
         end
       end
 
-      def bibliography_parse(attrs, xml, node)
-        clausetype = node&.attr("heading")&.downcase || node.title.downcase
-        if clausetype == "references" then norm_ref_parse(attrs, xml, node) 
-        else
-          super
-        end
-      end
-
       def submitters_parse(attrs, xml, node)
         xml.submitters **attr_code(attrs) do |xml_section|
           xml_section << node.content
@@ -128,6 +123,7 @@ module Asciidoctor
       end
 
       def pdf_converter(node)
+        return nil if node.attr("no-pdf")
         IsoDoc::Ogc::PdfConvert.new(html_extract_attributes(node))
       end
 

data/lib/asciidoctor/ogc/front.rb

@@ -93,7 +93,7 @@ module Asciidoctor
         a = node.attr("abbrev")
         return unless d and a
         url = "http://www.opengis.net/doc/#{IsoDoc::Ogc::DOCTYPE_ABBR[d]}/#{a}"
-        v = node.attr("edition") and url += "/#{v}"
+        v = (node.attr("edition") || node.attr("version")) and url += "/#{v}"
         url
       end
 
@@ -150,6 +150,11 @@ module Asciidoctor
         end
       end
 
+      def metadata_version(node, xml)
+        node.set_attr("edition", node.attr("version"), false) if node.attr("version")
+        super
+      end
+
       def metadata_subdoctype(node, xml)
         s = node.attr("docsubtype") 
         s1 = ::IsoDoc::Ogc::DOCSUBTYPE_ABBR.invert[s] and s = s1
@@ -158,15 +163,15 @@ module Asciidoctor
           unless %w{conceptual-model conceptual-model-and-encoding
                     conceptual-model-and-implementation encoding extension
                     implementation profile profile-with-extension}.include? s
-            warn "'#{s}' is not a permitted subtype of Standard: "\
-              "reverting to 'implementation'"
+            @log.add("Document Attributes", nil, "'#{s}' is not a permitted subtype of Standard: "\
+              "reverting to 'implementation'")
             s = "implementation"
           end
         when "best-practice"
           unless %w{general encoding extension profile
                     profile-with-extension}.include? s
-            warn "'#{s}' is not a permitted subtype of Standard: "\
-              "reverting to 'implementation'"
+            @log.add("Document Attributes", nil, "'#{s}' is not a permitted subtype of Standard: "\
+              "reverting to 'implementation'")
             s = "general"
           end
         end

data/lib/asciidoctor/ogc/isodoc.rng

@@ -101,9 +101,7 @@
         <ref name="structuredidentifier"/>
       </zeroOrMore>
     </define>
-    <define name="TitleType">
-      <text/>
-    </define>
+    <!-- TitleType = text -->
     <define name="sections">
       <element name="sections">
         <oneOrMore>
@@ -131,6 +129,9 @@
             </choice>
           </attribute>
         </optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
         <optional>
           <ref name="section-title"/>
         </optional>
@@ -307,6 +308,21 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="TextElement" combine="choice">
+    <ref name="concept"/>
+  </define>
+  <define name="concept">
+    <element name="concept">
+      <optional>
+        <attribute name="term"/>
+      </optional>
+      <choice>
+        <ref name="eref"/>
+        <ref name="xref"/>
+        <ref name="termref"/>
+      </choice>
+    </element>
+  </define>
   <define name="BasicBlock" combine="choice">
     <choice>
       <ref name="requirement"/>
@@ -645,6 +661,11 @@
     <optional>
       <attribute name="script"/>
     </optional>
+    <optional>
+      <attribute name="inline-header">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <optional>
       <attribute name="obligation">
         <choice>
@@ -908,7 +929,10 @@
   </define>
   <define name="origin">
     <element name="origin">
-      <ref name="erefType"/>
+      <choice>
+        <ref name="erefType"/>
+        <ref name="termref"/>
+      </choice>
     </element>
   </define>
   <define name="modification">
@@ -916,6 +940,15 @@
       <ref name="paragraph"/>
     </element>
   </define>
+  <define name="termref">
+    <element name="termref">
+      <attribute name="base"/>
+      <attribute name="target"/>
+      <optional>
+        <text/>
+      </optional>
+    </element>
+  </define>
   <define name="structuredidentifier">
     <element name="structuredidentifier">
       <optional>

data/lib/asciidoctor/ogc/ogc.rng

@@ -75,10 +75,6 @@
         <value>profile</value>
         <value>profile-with-extension</value>
         <value>general</value>
-        <value>encoding</value>
-        <value>extension</value>
-        <value>profile</value>
-        <value>profile-with-extension</value>
       </choice>
     </element>
   </define>

data/lib/asciidoctor/ogc/validate.rb

@@ -19,16 +19,18 @@ module Asciidoctor
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(swg-draft oab-review public-rfc tc-vote
         published deprecated retired).include? stage or
-        warn "Document Attributes: #{stage} is not a recognised status"
+        @log.add("Document Attributes", nil, "#{stage} is not a recognised status")
       end
 
       def version_validate(xmldoc)
         version = xmldoc&.at("//bibdata/edition")&.text
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
         if %w(engineering-report discussion-paper).include? doctype
-          warn "Version not permitted for #{doctype}" unless version.nil?
+          version.nil? or
+          @log.add("Document Attributes", nil, "Version not permitted for #{doctype}") 
         else
-          warn "Version required for #{doctype}" if version.nil?
+          version.nil? and
+          @log.add("Document Attributes", nil,  "Version required for #{doctype}") 
         end
       end
 
@@ -74,7 +76,7 @@ module Asciidoctor
       def seqcheck(names, msg, accepted)
         n = names.shift
         unless accepted.include? n
-          warn "OGC style: #{msg}"
+          @log.add("Style", nil, msg)
           names = []
         end
         names
@@ -93,7 +95,7 @@ module Asciidoctor
           n = names.shift
         end
         unless n
-          warn "OGC style: 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]"\
@@ -103,14 +105,14 @@ module Asciidoctor
       end
 
       def preface_sequence_validate(root)
-        root.at("//preface/abstract") or warn "OGC style: Abstract is missing!"
+        root.at("//preface/abstract") or @log.add("Style", nil, "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!"
+          @log.add("Style", nil, "Keywords are missing!")
+        root.at("//foreword") or @log.add("Style", nil,  "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!"
+               @log.add("Style", nil, "Submitting Organizations is missing!")
+        root.at("//submitters") or @log.add("Style", nil, "Submitters is missing!")
       end
     end
   end

data/lib/isodoc/ogc/base_convert.rb

@@ -2,21 +2,12 @@ require "isodoc"
 require_relative "metadata"
 require_relative "reqt"
 require_relative "biblio"
+require_relative "sections"
 require "fileutils"
 
 module IsoDoc
   module Ogc
     module BaseConvert
-      def annex_name(annex, name, div)
-        div.h1 **{ class: "Annex" } do |t|
-          t << "#{anchor(annex['id'], :label)} "
-          t.br
-          t.b do |b|
-            name&.children&.each { |c2| parse(c2, b) }
-          end
-        end
-      end
-
       def fileloc(loc)
         File.join(File.dirname(__FILE__), loc)
       end
@@ -63,68 +54,12 @@ module IsoDoc
 
       def load_yaml(lang, script)
         y = if @i18nyaml then YAML.load_file(@i18nyaml)
-            elsif lang == "en"
-              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
             else
               YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
             end
         super.merge(y)
       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(", ")
-        end
-      end
-
-      SUBMITTINGORGS =
-        "//bibdata/contributor[role/@type = 'author']/organization/name".freeze
-
-      def submittingorgs(docxml, out)
-        orgs = []
-        docxml.xpath(ns(SUBMITTINGORGS)).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
-      end
-
-      def submitters(docxml, out)
-        f = docxml.at(ns("//submitters")) || return
-        @prefacenum += 1
-        out.div **{ class: "Section3" } do |div|
-          clause_name(anchor(f['id'], :label), "Submitters", div,
-                      class: "IntroTitle")
-          f.elements.each { |e| parse(e, div) unless e.name == "title" }
-        end
-      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
-        end
-      end
-
       def preface_names_numbered(clause)
         return if clause.nil?
         @prefacenum += 1
@@ -138,44 +73,24 @@ module IsoDoc
         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(anchor(f["id"], :label), @abstract_lbl, s,
-                      class: "AbstractTitle")
-          f.elements.each { |e| parse(e, s) unless e.name == "title" }
-        end
+      def example_parse(node, out)
+        name = node.at(ns("./name"))
+        example_name_parse(node, out, name) #if name
+        super
       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(anchor(f["id"], :label), @foreword_lbl, s,
-                      class: "ForewordTitle")
-          f.elements.each { |e| parse(e, s) unless e.name == "title" }
-        end
+      def example_label(node, div, name)
       end
 
-      def acknowledgements(isoxml, out)
-        f = isoxml.at(ns("//acknowledgements")) || return
-        @prefacenum += 1
-        out.div **{ class: "Section3", id: f["id"] } do |div|
-          clause_name(anchor(f["id"], :label), f&.at(ns("./title")), div,
-                      class: "IntroTitle")
-          f.elements.each { |e| parse(e, div) unless e.name == "title" }
+      def example_name_parse(node, div, name)
+        lbl = anchor(node['id'], :label, false)
+        div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
+          lbl.nil? or p << l10n("#{@example_lbl} #{lbl}")
+          name and !lbl.nil? and p << "&nbsp;&mdash; "
+          name&.children&.each { |n| parse(n, p) }
         end
       end
 
-      def example_parse(node, out)
-        name = node.at(ns("./name"))
-        sourcecode_name_parse(node, out, name) if name
-        super
-      end
-
       def initial_anchor_names(d)
         @prefacenum = 0
         preface_names_numbered(d.at(ns("//preface/abstract")))
@@ -220,16 +135,6 @@ module IsoDoc
         sequential_asset_names(d.xpath(ns(middle_sections)))
       end
 
-      def conformance(isoxml, out, num)
-        f = isoxml.at(ns("//clause[title = 'Conformance']")) or return num
-        out.div **attr_code(id: f["id"]) do |div|
-          num = num + 1
-          clause_name(num, "Conformance", div, nil)
-          f.elements.each { |e| parse(e, div) unless e.name == "title" }
-        end
-        num
-      end
-
       def middle(isoxml, out)
         middle_title(out)
         i = scope isoxml, out, 0