metanorma-ogc 1.3.8 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1cf7a554aa5d0925f31dadc79986085ae51643cdcc2e3367087da1b2dc9e99b
-  data.tar.gz: 95a95b35de2d3f9613779bcef6a32b3a21ecfd7b4df77c3411b9da2755369a35
+  metadata.gz: 6d485aa36153e193dceebf844193f8042fce9db6ce93b00e66ac43e7755a541e
+  data.tar.gz: '0692880332b57c821956e5d9ec5e3dd3ddf94e33f8b6b92f8f16b89f72bae1b9'
 SHA512:
-  metadata.gz: 4b11e5d10627ebd1946e97cdd36ac9c32018033d3044242437149212d9ff6f182ba8c5e1fd9fda1a8fbb66629e36f2de8c40e20ed3022e33aa55a3850dc27141
-  data.tar.gz: b362a4c65d8c69d3ab99251c9067d6c5a3225e1d391c05953eab122ce5b0a154c17c6d4ac25c5933d12f7542a2c57d42120e8e9eb9561f5b959ded3c2128ddb4
+  metadata.gz: f6d4d7d832023e182ef9f0bbe2a4603a5827f7667131f3a27cdc3ebd1a57917483011396f67b160ac91d65576d6d04a73fee200064f2caf0d10736ece807d51c
+  data.tar.gz: 846eb44d909ef21e3a08b3bddcb4171271a92dd65cf4c9d208dac02154228ac1b18699d2a71c0e1e7bc2a7912160dc815429bf5a80873591e0ae3708d5ca1693

data/lib/asciidoctor/ogc/boilerplate.xml

@@ -95,13 +95,13 @@
     {% if doctype == "Standard" or doctype == "Community Standard" or doctype == "Abstract Specification" %}
     {% if stage == "Approved" or stage == "Withdrawn" %}
     <clause>
-      <title>Warning</title>
+      <title>Notice</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>
     {% else %}
     <clause>
-      <title>Warning for Drafts</title>
+      <title>Notice 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>
@@ -111,7 +111,7 @@
 
     {% elsif doctype == "Engineering Report" %}
     <clause>
-      <title>Warning</title>
+      <title>Notice</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.</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>
@@ -120,7 +120,7 @@
 
     {% elsif doctype == "Best Practice" %}
     <clause>
-      <title>Warning</title>
+      <title>Notice</title>
       <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>
 
       <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>
@@ -128,7 +128,7 @@
 
     {% elsif doctype == "Release Notes" %}
     <clause>
-      <title>Warning</title>
+      <title>Notice</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>
@@ -137,7 +137,7 @@
 
     {% else %}
     <clause>
-      <title>Warning</title>
+      <title>Notice</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>

data/lib/asciidoctor/ogc/cleanup.rb

@@ -0,0 +1,173 @@
+module Asciidoctor
+  module Ogc
+    class Converter < Standoc::Converter
+      def sections_cleanup(xml)
+        super
+        xml.xpath("//*[@inline-header]").each do |h|
+          h.delete("inline-header")
+        end
+      end
+
+      def make_preface(xml, sect)
+        super
+        insert_security(xml, sect)
+        insert_submitters(xml, sect)
+      end
+
+      def add_id
+        %(id="_#{UUIDTools::UUID.random_create}")
+      end
+
+      def insert_security(xml, sect)
+        description = "document"
+        description = "standard" if %w(standard community-standard)
+          .include?(sect&.at("//bibdata/ext/doctype")&.text)
+        preface = sect.at("//preface") ||
+          sect.add_previous_sibling("<preface/>").first
+        sect = xml&.at("//clause[@type = 'security']")&.remove ||
+          "<clause type='security' #{add_id}>"\
+          "<title>Security considerations</title>"\
+          "<p>#{@i18n.security_empty.sub(/%/, description)}</p></clause>"
+        preface.add_child sect
+      end
+
+      def insert_submitters(xml, sect)
+        if xml.at("//submitters")
+          preface = sect.at("//preface") ||
+            sect.add_previous_sibling("<preface/>").first
+          submitters = xml.at("//submitters").remove
+          submitters.xpath(".//table").each do |t|
+            t["unnumbered"] = true
+          end
+          preface.add_child submitters.remove
+        end
+      end
+
+      def termdef_boilerplate_cleanup(xmldoc); end
+
+      def bibdata_cleanup(xmldoc)
+        super
+        a = xmldoc.at("//bibdata/status/stage")
+        a.text == "published" and a.children = "approved"
+      end
+
+      def section_names_terms_cleanup(xml)
+        replace_title(xml, "//definitions[@type = 'symbols']", @i18n&.symbols)
+        replace_title(xml, "//definitions[@type = 'abbreviated_terms']",
+                      @i18n&.abbrev)
+        replace_title(xml, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
+        replace_title(xml, "//sections//terms#{SYMnoABBR} | "\
+                           "//sections//clause[.//terms]#{SYMnoABBR}",
+                      @i18n&.termsdefsymbols, true)
+        replace_title(xml, "//sections//terms#{ABBRnoSYM} | "\
+                           "//sections//clause[.//terms]#{ABBRnoSYM}",
+                      @i18n&.termsdefabbrev, true)
+        replace_title(xml, "//sections//terms#{SYMABBR} | "\
+                           "//sections//clause[.//terms]#{SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(xml, "//sections//terms#{NO_SYMABBR} | "\
+                           "//sections//clause[.//terms]#{NO_SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(xml, "//sections//terms[not(.//definitions)] | "\
+                           "//sections//clause[.//terms][not(.//definitions)]",
+                      @i18n&.termsdef, true)
+      end
+
+      def requirement_metadata_component_tags
+        %w(test-purpose test-method test-method-type conditions part description
+           reference step requirement permission recommendation)
+      end
+
+      def requirement_metadata1(reqt, dlist, ins)
+        ins1 = super
+        dlist.xpath("./dt").each do |e|
+          tag = e&.text&.gsub(/ /, "-")&.downcase
+          next unless requirement_metadata_component_tags.include? tag
+
+          ins1.next = requirement_metadata1_component(e, tag)
+          ins1 = ins1.next
+        end
+      end
+
+      def requirement_metadata1_component(term, tag)
+        val = term.at("./following::dd")
+        val.name = tag
+        val.xpath("./dl").each do |d|
+          requirement_metadata1(val, d, d)
+          d.remove
+        end
+        if %w(requirement permission
+              recommendation).include?(term.text) && !val.text.empty?
+          val["label"] = val.text.strip
+          val.children.remove
+        end
+        val
+      end
+
+      def requirement_metadata(xmldoc)
+        super
+        xmldoc.xpath(REQRECPER).each do |r|
+          requirement_metadata_to_component(r)
+          requirement_metadata_to_requirement(r)
+          requirement_subparts_to_blocks(r)
+        end
+      end
+
+      def requirement_metadata_to_component(reqt)
+        reqt.xpath(".//test-method | .//test-purpose | .//conditions | "\
+                   ".//part | .//test-method-type | .//step | .//reference")
+          .each do |c|
+          c["class"] = c.name
+          c.name = "component"
+        end
+      end
+
+      def requirement_metadata_to_requirement(reqt)
+        reqt.xpath("./requirement | ./permission | ./recommendation")
+          .each do |c|
+          c["id"] = Metanorma::Utils::anchor_or_uuid
+        end
+      end
+
+      def requirement_subparts_to_blocks(reqt)
+        reqt.xpath(".//component | .//description").each do |c|
+          next if %w(p ol ul dl table component description)
+            .include?(c&.elements&.first&.name)
+
+          c.children = "<p>#{c.children.to_xml}</p>"
+        end
+      end
+
+      # skip annex/terms/terms, which is empty node
+      def termdef_subclause_cleanup(xmldoc)
+        xmldoc.xpath("//annex//terms[terms]").each do |t|
+          next if t.parent.name == "terms"
+
+          t.children.each { |n| n.parent = t.parent }
+          t.remove
+        end
+      end
+
+      def requirement_cleanup(xmldoc)
+        requirement_type(xmldoc)
+        super
+      end
+
+      def requirement_type(xmldoc)
+        xmldoc.xpath(REQRECPER).each do |r|
+          next unless r["type"]
+
+          r["type"] = case r["type"]
+                      when "requirement", "recommendation", "permission"
+                        "general"
+                      when "requirement_class" then "class"
+                      when "conformance_test" then "verification"
+                      when "conformance_class" then "conformanceclass"
+                      when "abstract_test" then "abstracttest"
+                      else r["type"]
+                      end
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/ogc/converter.rb

@@ -3,6 +3,7 @@ require "asciidoctor/standoc/converter"
 require "fileutils"
 require_relative "front"
 require_relative "validate"
+require_relative "cleanup"
 
 module Asciidoctor
   module Ogc
@@ -16,8 +17,7 @@ module Asciidoctor
       register_for "ogc"
 
       # ignore, we generate ToC outside of asciidoctor
-      def toc(value)
-      end
+      def toc(value); end
 
       def makexml(node)
         @draft = node.attributes.has_key?("draft")
@@ -27,11 +27,11 @@ module Asciidoctor
       def doctype(node)
         d = super
         d1 = ::IsoDoc::Ogc::DOCTYPE_ABBR.invert[d] and d = d1
-        unless %w{abstract-specification-topic best-practice 
-          change-request-supporting-document community-practice 
-          community-standard discussion-paper engineering-report other policy 
-          reference-model release-notes standard user-guide white-paper 
-          test-suite}.include? d
+        unless %w{abstract-specification-topic best-practice other policy
+                  change-request-supporting-document community-practice
+                  community-standard discussion-paper engineering-report
+                  reference-model release-notes standard user-guide white-paper
+                  test-suite}.include? d
           @warned_doctype or
             @log.add("Document Attributes", nil,
                      "'#{d}' is not a legal document type: reverting to 'standard'")
@@ -41,72 +41,42 @@ module Asciidoctor
         d
       end
 
+      def sectiontype(node, level = true)
+        ret = sectiontype_streamline(sectiontype1(node))
+        return ret if ret == "terms and definitions" &&
+          node.attr("style") == "appendix" && node.level == 1
+
+        super
+      end
+
       def sectiontype_streamline(ret)
         case ret
         when "preface" then "foreword"
-        when "foreword" then "donotrecognise-foreword"
-        when "introduction" then "donotrecognise-foreword"
+        when "foreword", "introduction" then "donotrecognise-foreword"
         when "references" then "normative references"
+        when "glossary" then "terms and definitions"
         else
           super
         end
       end
 
       def outputs(node, ret)
-        File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
-        presentation_xml_converter(node).convert(@filename + ".xml")
-        html_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.html")
-        doc_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.doc")
-        pdf_converter(node)&.convert(@filename + ".presentation.xml", nil, false, "#{@filename}.pdf")
-      end
-
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup), File.join(File.dirname(__FILE__), "ogc.rng"))
-      end
-
-      def sections_cleanup(x)
-        super
-        x.xpath("//*[@inline-header]").each do |h|
-          h.delete("inline-header")
-        end
-      end
-
-      def make_preface(x, s)
-        super
-        insert_security(x, s)
-        insert_submitters(x, s)
-      end
-
-      def add_id
-        %(id="_#{UUIDTools::UUID.random_create}")
-      end
-
-      def insert_security(x, s)
-        doctype = s&.at("//bibdata/ext/doctype")&.text
-        description = %w(standard community-standard).include?(doctype) ? "standard" : "document"
-        preface = s.at("//preface") || s.add_previous_sibling("<preface/>").first
-        s = x&.at("//clause[@type = 'security']")&.remove ||
-          "<clause type='security' #{add_id}>"\
-          "<title>Security Considerations</title>"\
-          "<p>#{@i18n.security_empty.sub(/%/, description)}</p></clause>"
-        preface.add_child s
-      end
-
-      def insert_submitters(x, s)
-        if x.at("//submitters")
-          preface = s.at("//preface") || s.add_previous_sibling("<preface/>").first
-          submitters = x.at("//submitters").remove
-          preface.add_child submitters.remove
-        end
+        File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
+        presentation_xml_converter(node).convert("#{@filename}.xml")
+        html_converter(node).convert("#{@filename}.presentation.xml", nil,
+                                     false, "#{@filename}.html")
+        doc_converter(node).convert("#{@filename}.presentation.xml", nil,
+                                    false, "#{@filename}.doc")
+        pdf_converter(node)&.convert("#{@filename}.presentation.xml", nil,
+                                     false, "#{@filename}.pdf")
       end
 
       def clause_parse(attrs, xml, node)
-        case clausetype = node&.attr("heading")&.downcase || node.title.downcase
+        case node&.attr("heading")&.downcase || node.title.downcase
         when "submitters" then return submitters_parse(attrs, xml, node)
         when "conformance" then attrs = attrs.merge(type: "conformance")
-        when "security considerations" then attrs = 
-          attrs.merge(type: "security")
+        when "security considerations" then attrs =
+                                              attrs.merge(type: "security")
         end
         super
       end
@@ -118,23 +88,50 @@ module Asciidoctor
         end
       end
 
-      def style(n, t)
-        return
+      def style(_node, _text)
+        nil
       end
 
-      def termdef_boilerplate_cleanup(xmldoc)
+      def term_def_parse(attrs, xml, node, _toplevel)
+        if node.attr("style") == "appendix" && node.level == 1
+          terms_annex_parse(attrs, xml, node)
+        else
+          super
+        end
       end
 
-      def bibdata_cleanup(xmldoc)
+      def table_cell(node, xml_tr, tblsec)
+        node.set_attr("valign", "middle")
         super
-        a = xmldoc.at("//bibdata/status/stage")
-        a.text == "published" and a.children = "approved"
+      end
+
+      def terms_annex_parse(attrs, xml, node)
+        attrs1 = attrs.merge(id: "_#{UUIDTools::UUID.random_create}")
+        xml.annex **attr_code(attrs1) do |xml_section|
+          xml_section.title { |name| name << node.title }
+          xml_section.terms **attr_code(attrs) do |terms|
+            (s = node.attr("source")) && s.split(",").each do |s1|
+              terms.termdocsource(nil, **attr_code(bibitemid: s1))
+            end
+            terms << node.content
+          end
+        end
       end
 
       def highlight_parse(text, xml)
         xml.hi { |s| s << text }
       end
 
+      def example(node)
+        role = node.role || node.attr("style")
+        if %w(requirement_class conformance_test conformance_class
+              abstract_test).include?(role)
+          node.set_attr("type", role)
+          return requirement(node, "requirement")
+        end
+        super
+      end
+
       def presentation_xml_converter(node)
         IsoDoc::Ogc::PresentationXMLConvert.new(html_extract_attributes(node))
       end
@@ -145,6 +142,7 @@ module Asciidoctor
 
       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

@@ -171,7 +171,7 @@ module Asciidoctor
             s = "general"
           end
         end
-        s and xml.docsubtype s
+        s and xml.subdoctype s
       end
 
       def title(node, xml)

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">
@@ -158,15 +170,17 @@
             <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="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>
@@ -976,6 +990,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 +1036,7 @@
       <ref name="svgmap"/>
       <ref name="inputform"/>
       <ref name="toc"/>
+      <ref name="passthrough"/>
     </choice>
   </define>
   <define name="toc">
@@ -1019,6 +1044,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">
@@ -1686,7 +1719,9 @@
       <zeroOrMore>
         <ref name="termgrammar"/>
       </zeroOrMore>
-      <ref name="definition"/>
+      <oneOrMore>
+        <ref name="termdefinition"/>
+      </oneOrMore>
       <zeroOrMore>
         <ref name="termnote"/>
       </zeroOrMore>
@@ -1749,7 +1784,7 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="definition">
+  <define name="termdefinition">
     <element name="definition">
       <oneOrMore>
         <choice>
@@ -1758,6 +1793,9 @@
           <ref name="formula"/>
         </choice>
       </oneOrMore>
+      <zeroOrMore>
+        <ref name="termsource"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="termnote">

data/lib/asciidoctor/ogc/ogc.rng

@@ -62,6 +62,19 @@
         </optional>
       </element>
     </define>
+    <define name="DocumentSubtype">
+      <choice>
+        <value>conceptual-model</value>
+        <value>conceptual-model-and-encoding</value>
+        <value>conceptual-model-and-implementation</value>
+        <value>encoding</value>
+        <value>extension</value>
+        <value>implementation</value>
+        <value>profile</value>
+        <value>profile-with-extension</value>
+        <value>general</value>
+      </choice>
+    </define>
   </include>
   <define name="TextElement" combine="choice">
     <ref name="hi"/>
@@ -79,19 +92,6 @@
       </zeroOrMore>
     </element>
   </define>
-  <define name="DocumentSubtype">
-    <choice>
-      <value>conceptual-model</value>
-      <value>conceptual-model-and-encoding</value>
-      <value>conceptual-model-and-implementation</value>
-      <value>encoding</value>
-      <value>extension</value>
-      <value>implementation</value>
-      <value>profile</value>
-      <value>profile-with-extension</value>
-      <value>general</value>
-    </choice>
-  </define>
   <define name="submitters">
     <element name="submitters">
       <ref name="Basic-Section"/>

data/lib/asciidoctor/ogc/reqt.rng

@@ -64,9 +64,9 @@
     <optional>
       <ref name="label"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="subject"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="reqinherit"/>
     </zeroOrMore>
@@ -80,6 +80,7 @@
         <ref name="verification"/>
         <ref name="import"/>
         <ref name="description"/>
+        <ref name="component"/>
       </choice>
     </zeroOrMore>
     <optional>
@@ -105,12 +106,16 @@
   </define>
   <define name="subject">
     <element name="subject">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="reqinherit">
     <element name="inherit">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="measurementtarget">
@@ -138,6 +143,12 @@
       <ref name="RequirementSubpart"/>
     </element>
   </define>
+  <define name="component">
+    <element name="component">
+      <attribute name="class"/>
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
   <define name="reqt_references">
     <element name="references">
       <oneOrMore>