metanorma-ogc 2.4.9 → 2.5.1

data/lib/isodoc/ogc/presentation_xml_convert.rb

@@ -1,6 +1,6 @@
 require_relative "init"
-require "uuidtools"
 require_relative "../../relaton/render/general"
+require_relative "presentation_sections"
 
 module IsoDoc
   module Ogc
@@ -10,8 +10,6 @@ module IsoDoc
         super
       end
 
-      def middle_title(docxml); end
-
       def convert1(docxml, filename, dir)
         info docxml, nil
         super
@@ -21,123 +19,100 @@ module IsoDoc
         File.read(File.join(@libdir, "html", "rouge.css"))
       end
 
-      def preface_rearrange(doc)
-        super
-        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")),
-                       submit_orgs_append_pt(doc), doc)
-        insert_submitting_orgs(doc)
-        preface_insert(doc.at(ns("//preface/clause[@type = 'security']")),
-                       submit_orgs_append_pt(doc), doc)
-        insert_keywords(doc)
-      end
-
-      def preface_init_insert_pt(docxml)
-        docxml.at(ns("//preface")) ||
-          docxml.at(ns("//sections"))
-            .add_previous_sibling("<preface> </preface>").first
-      end
-
-      def preface_insert(clause, after, docxml)
-        clause or return
-        clause.remove
-        if after then after.next = clause
-        else
-          preface_init_insert_pt(docxml)&.children&.first
-            &.add_previous_sibling(clause)
+      def example1(elem)
+        lbl = @xrefs.anchor(elem["id"], :label, false) or return
+        prefix_name(elem, block_delim, l10n("#{@i18n.example} #{lbl}"),
+                    "name")
+      end
+
+      def bibdata(docxml)
+        docxml.xpath(ns("//bibdata/contributor[@type = 'author']")).each do |a|
+          a.at(ns("./description"))&.text == "contributor" and
+            a["type"] = "contributor"
         end
+        super
+        dochistory_insert(docxml)
       end
 
-      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"))
+      UPDATE_RELATIONS = <<~XPATH.freeze
+        //bibdata/relation[@type = 'updatedBy' or @type = 'merges' or @type = 'splits' or @type = 'hasDraft']/bibitem
+      XPATH
+
+      def dochistory_insert(docxml)
+        updates = docxml.xpath(ns(UPDATE_RELATIONS))
+        updates.empty? and return
+        fwd = annex_insert_point(docxml)
+        generate_dochistory(updates, fwd)
       end
 
-      def insert_submitting_orgs(docxml)
-        orgs = docxml.xpath(ns(submittingorgs_path))
-          .each_with_object([]) { |org, m| m << org.text }
-        orgs.empty? and return
-        if a = submit_orgs_append_pt(docxml)
-          a.next = submitting_orgs_clause(orgs)
-        else
-          preface_init_insert_pt(docxml)&.children&.first
-            &.add_previous_sibling(submitting_orgs_clause(orgs))
-        end
+      def annex_insert_point(docxml)
+        docxml.at(ns("//annex[last()]")) || docxml.at(ns("//sections"))
       end
 
-      def submitting_orgs_clause(orgs)
-        <<~SUBMITTING
-          <clause id="_#{UUIDTools::UUID.random_create}" type="submitting_orgs">
-          <title>Submitting Organizations</title>
-          <p>The following organizations submitted this Document to the Open Geospatial Consortium (OGC):</p>
-           <ul>#{orgs.map { |m| "<li>#{m}</li>" }.join("\n")}</ul>
-           </clause>
-        SUBMITTING
-      end
-
-      def keyword_clause(kwords)
-        <<~KEYWORDS
-          <clause id="_#{UUIDTools::UUID.random_create}" type="keywords">
-          <title>Keywords</title>
-          <p>The following are keywords to be used by search engines and document catalogues.</p>
-          <p>#{kwords.join(', ')}</p></clause>
-        KEYWORDS
-      end
-
-      def insert_keywords(docxml)
-        kw = @meta.get[:keywords]
-        kw.empty? and return
-        if abstract =
-             docxml.at(ns("//preface/clause[@type = 'executivesummary']")) ||
-             docxml.at(ns("//preface/abstract"))
-          abstract.next = keyword_clause(kw)
-        else
-          preface_init_insert_pt(docxml)&.children&.first
-            &.add_previous_sibling(keyword_clause(kw))
-        end
+      def generate_dochistory(updates, pref)
+        ret = updates.map { |u| generate_dochistory_row(u) }.flatten.join("\n")
+        pref.next = <<~XML
+          <annex id='_#{UUIDTools::UUID.random_create}' obligation='informative'>
+          <title>#{@i18n.dochistory}</title>
+          <table><thead>
+          <tr><th>Date</th><th>Release</th><th>Author</th><th>Paragraph Modified</th><th>Description</th></tr>
+          </thead><tbody>
+          #{ret}
+          </tbody></table></annex>
+        XML
       end
 
-      def example1(elem)
-        lbl = @xrefs.anchor(elem["id"], :label, false) or return
-        prefix_name(elem, block_delim, l10n("#{@i18n.example} #{lbl}"),
-                    "name")
+      def generate_dochistory_row(item)
+        e = item.at(ns("./edition")) || item.at(ns("./version/draft"))
+        date = dochistory_date(item)
+        c = dochistory_contributors(item)
+        l = dochistory_location(item)
+        desc = dochistory_description(item)
+        "<tr><td>#{date}</td><td>#{e&.text}</td><td>#{c}</td>" \
+          "<td>#{l}</td><td>#{desc}</td></tr>"
       end
 
-      def annex1(elem)
-        lbl = @xrefs.anchor(elem["id"], :label)
-        t = elem.at(ns("./title")) and
-          t.children = "<strong>#{to_xml(t.children)}</strong>"
-        prefix_name(elem, "<br/>", lbl, "title")
+      def dochistory_date(item)
+        d = item.at(ns("./date[@type = 'updated']")) ||
+          item.at(ns("./date[@type = 'published']")) ||
+          item.at(ns("./date[@type = 'issued']")) or return ""
+        d.text.strip
       end
 
-      def clause(docxml)
-        super
-        docxml.xpath(ns("//foreword | //preface/abstract | " \
-                        "//submitters | //introduction | //acknowledgements"))
-          .each { |f| clause1(f) }
+      def dochistory_contributors(item)
+        item.xpath(ns("./contributor")).map do |c|
+          dochistory_contributor(c)
+        end.join(", ")
       end
 
-      def clause1(elem)
-        elem.name == "terms" && elem.parent.name == "annex" &&
-          elem.parent.xpath(ns("./terms")).size == 1 and return
-        elem.name == "clause" && elem["type"] == "toc" and return
-        super
+      def dochistory_contributor(contrib)
+        ret = contrib.at("./organization/subdivision") ||
+          contrib.at("./organization/name") ||
+          contrib.at("./person/name/abbreviation") ||
+          contrib.at("./person/name/completename")
+        ret and return ret.text
+        format_personalname(contrib)
       end
 
-      def bibdata(docxml)
-        docxml.xpath(ns("//bibdata/contributor[@type = 'author']")).each do |a|
-          a.at(ns("./description"))&.text == "contributor" and
-            a["type"] = "contributor"
-        end
-        super
+      def format_personalname(contrib)
+        Relaton::Render::Ogc::General
+          .new(template: { book: "{{ creatornames }}" })
+          .render("<bibitem type='book'>#{contrib.to_xml}</bibitem>",
+                  embedded: true)
+      end
+
+      def dochistory_description(item)
+        d = item.at(ns("./amend/description")) or return ""
+        d.children.to_xml
+      end
+
+      def dochistory_location(item)
+        t = item.at(ns("./amend/location")) or return "All"
+        xpath = "./amend/location/locality | ./amend/location/localityStack"
+        r = eref_localities(item.xpath(ns(xpath)), nil, t)
+        r.sub!(/^, /, "")
+        r == @i18n.wholeoftext and r = "All"
+        r
       end
 
       def bibdata_i18n(bib)
@@ -203,7 +178,7 @@ module IsoDoc
       # else, use both ordinal, as prefix, and ids
       def biblio_ref_entry_code(ordinal, ids, _id, standard, datefn, _bib)
         standard and return "[#{ordinal}]<tab/>"
-        ret = (ids[:ordinal] || ids[:metanorma] || "[#{ordinal}]")
+        ret = ids[:ordinal] || ids[:metanorma] || "[#{ordinal}]"
         prefix_bracketed_ref("#{ret}#{datefn}")
       end
 

data/lib/metanorma/ogc/basicdoc.rng

@@ -95,8 +95,89 @@
       <ref name="pagebreak"/>
       <ref name="hr"/>
       <ref name="bookmark"/>
+      <ref name="amend"/>
     </choice>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <ref name="AmendType"/>
+    </element>
+  </define>
+  <define name="AmendType">
+    <optional>
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+    </optional>
+    <attribute name="change">
+      <choice>
+        <value>add</value>
+        <value>modify</value>
+        <value>delete</value>
+        <value>replace</value>
+      </choice>
+    </attribute>
+    <optional>
+      <attribute name="path"/>
+    </optional>
+    <optional>
+      <attribute name="path_end"/>
+    </optional>
+    <optional>
+      <attribute name="title"/>
+    </optional>
+    <optional>
+      <element name="location">
+        <zeroOrMore>
+          <choice>
+            <ref name="locality"/>
+            <ref name="localityStack"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="description">
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="newcontent">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="contributor"/>
+    </zeroOrMore>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
   <define name="paragraph">
     <element name="p">
       <ref name="ParagraphType"/>
@@ -163,6 +244,9 @@
         <data type="ID"/>
       </attribute>
       <attribute name="reviewer"/>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="date">
           <data type="dateTime"/>
@@ -939,18 +1023,12 @@
     </optional>
     <optional>
       <attribute name="width">
-        <choice>
-          <data type="int"/>
-          <value>auto</value>
-        </choice>
+        <ref name="ImageSize"/>
       </attribute>
     </optional>
     <optional>
       <attribute name="height">
-        <choice>
-          <data type="int"/>
-          <value>auto</value>
-        </choice>
+        <ref name="ImageSize"/>
       </attribute>
     </optional>
     <optional>
@@ -965,6 +1043,14 @@
       </attribute>
     </optional>
   </define>
+  <define name="ImageSize">
+    <choice>
+      <data type="string">
+        <param name="pattern">\d+([.]\d+)?(%?)</param>
+      </data>
+      <value>auto</value>
+    </choice>
+  </define>
   <define name="video">
     <element name="video">
       <attribute name="id">

data/lib/metanorma/ogc/biblio-standoc.rng

@@ -9,11 +9,42 @@
   -->
   <include href="biblio.rng">
     <define name="BibData">
-      <ref name="BibliographicItem"/>
+      <ref name="StandardBibliographicItem"/>
       <optional>
         <ref name="ext"/>
       </optional>
     </define>
+    <define name="docrelation">
+      <element name="relation">
+        <attribute name="type">
+          <ref name="DocRelationType"/>
+        </attribute>
+        <optional>
+          <element name="description">
+            <ref name="FormattedString"/>
+          </element>
+        </optional>
+        <element name="bibitem">
+          <ref name="StandardReducedBibliographicItem"/>
+        </element>
+        <choice>
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="localityStack"/>
+          </zeroOrMore>
+        </choice>
+        <choice>
+          <zeroOrMore>
+            <ref name="sourceLocality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="sourceLocalityStack"/>
+          </zeroOrMore>
+        </choice>
+      </element>
+    </define>
   </include>
   <define name="ext">
     <element name="ext">
@@ -161,4 +192,16 @@
       </optional>
     </element>
   </define>
+  <define name="StandardBibliographicItem">
+    <ref name="BibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
+  <define name="StandardReducedBibliographicItem">
+    <ref name="ReducedBibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
 </grammar>

data/lib/metanorma/ogc/biblio.rng

@@ -241,6 +241,9 @@
     </element>
   </define>
   <define name="FullNameType">
+    <optional>
+      <ref name="name_abbreviation"/>
+    </optional>
     <choice>
       <group>
         <zeroOrMore>
@@ -266,6 +269,11 @@
       <ref name="variantname"/>
     </zeroOrMore>
   </define>
+  <define name="name_abbreviation">
+    <element name="abbreviation">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
   <define name="prefix">
     <element name="prefix">
       <ref name="LocalizedString"/>
@@ -870,6 +878,9 @@
     <optional>
       <ref name="validity"/>
     </optional>
+    <optional>
+      <ref name="depiction"/>
+    </optional>
   </define>
   <define name="btitle">
     <element name="title">

data/lib/metanorma/ogc/boilerplate.adoc

@@ -20,7 +20,35 @@ Use of this document is subject to the license agreement at https://www.ogc.org/
 
 == legal-statement
 {% if doctype == "Standard" or doctype == "Community Standard" or doctype == "Abstract Specification" %}
-{% if stage == "Approved" or stage == "Withdrawn" %}
+{% if stage == "Deprecated" %}
+
+=== Notice
+This Standard has been deprecated by the OGC and is no longer supported. A newer version exists and is recommended for use. 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.
+
+{% elsif stage == "Legacy" %}
+
+=== Notice
+This Standard has been deprecated to Legacy status and is no longer supported. This Standard is still suitable for use, but newer Standards offer the same or improved functions and capabilities. 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.
+
+{% elsif stage == "Rescinded" %}
+
+=== Notice
+This Standard has been rescinded and is no longer an OGC Standard nor is it suitable for use. Rescinded Standards are not published on any public OGC resources.
+
+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.
+
+{% elsif stage == "Retired" %}
+
+=== Notice
+This Standard has been retired by the OGC and is no longer supported nor recommended for use. 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.
+
+{% elsif stage == "Approved" or stage == "Withdrawn" %}
 
 === Notice
 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.

data/lib/metanorma/ogc/cleanup.rb

@@ -64,11 +64,12 @@ module Metanorma
         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
+          xml.xpath("//submitters").each do |s|
+            s.xpath(".//table").each do |t|
+              t["unnumbered"] = true
+            end
+            preface.add_child s.remove
           end
-          preface.add_child submitters.remove
         end
       end
 
@@ -225,15 +226,15 @@ module Metanorma
           type: id ? id["type"] : nil }
       end
 
-       # Numbers sort *before* letters; we leave out using thorn to force that sort order.
-      # case insensitive
-       def symbol_key(sym)
+      # Numbers sort *before* letters; we leave out using thorn to force
+      # that sort order. case insensitive
+      def symbol_key(sym)
         @c.decode(asciimath_key(sym).text)
           .gsub(/[\[\]{}<>()]/, "").gsub(/\s/m, "")
           .gsub(/[[:punct:]]|[_^]/, ":\\0").gsub("`", "")
       end
 
-       def symbols_cleanup(docxml)
+      def symbols_cleanup(docxml)
         docxml.xpath("//definitions/dl").each do |dl|
           dl_out = extract_symbols_list(dl)
           dl_out.sort! do |a, b|

data/lib/metanorma/ogc/converter.rb

@@ -88,8 +88,10 @@ module Metanorma
 
       def clause_parse(attrs, xml, node)
         case node.attr("heading")&.downcase || node.title.downcase
-        when "submitters", "contributors"
+        when "submitters"
           return submitters_parse(attrs, 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")
@@ -101,7 +103,8 @@ module Metanorma
 
       def submitters_parse(attrs, xml, node)
         title = @i18n.submitters
-        doctype(node) == "engineering-report" and
+        doctype(node) == "engineering-report" ||
+          attrs[:type] == "contributors" and
           title = @i18n.contributors_clause
         xml.submitters **attr_code(attrs) do |xml_section|
           xml_section.title title

data/lib/metanorma/ogc/isodoc.rng

@@ -17,10 +17,19 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v1.2.9 -->
+<!-- VERSION v1.3.0 -->
 <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">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
+    <define name="amend">
+      <element name="amend">
+        <ref name="BlockAttributes"/>
+        <ref name="AmendType"/>
+        <zeroOrMore>
+          <ref name="autonumber"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="admonition">
       <element name="admonition">
         <attribute name="type">
@@ -137,6 +146,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="style"/>
+        </optional>
         <oneOrMore>
           <ref name="PureTextElement"/>
         </oneOrMore>
@@ -2319,69 +2331,6 @@
       <ref name="CitationType"/>
     </element>
   </define>
-  <define name="amend">
-    <element name="amend">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <attribute name="change">
-        <choice>
-          <value>add</value>
-          <value>modify</value>
-          <value>delete</value>
-          <value>replace</value>
-        </choice>
-      </attribute>
-      <optional>
-        <attribute name="path"/>
-      </optional>
-      <optional>
-        <attribute name="path_end"/>
-      </optional>
-      <optional>
-        <attribute name="title"/>
-      </optional>
-      <ref name="BlockAttributes"/>
-      <optional>
-        <element name="location">
-          <zeroOrMore>
-            <ref name="locality"/>
-          </zeroOrMore>
-        </element>
-      </optional>
-      <zeroOrMore>
-        <ref name="autonumber"/>
-      </zeroOrMore>
-      <optional>
-        <element name="description">
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-        </element>
-      </optional>
-      <optional>
-        <element name="newcontent">
-          <optional>
-            <attribute name="id">
-              <data type="ID"/>
-            </attribute>
-          </optional>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-        </element>
-      </optional>
-      <optional>
-        <element name="description">
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-        </element>
-      </optional>
-    </element>
-  </define>
   <define name="autonumber">
     <element name="autonumber">
       <attribute name="type">

data/lib/metanorma/ogc/reqt.rng

@@ -207,20 +207,4 @@
       <value>permission</value>
     </choice>
   </define>
-  <define name="classification">
-    <element name="classification">
-      <ref name="classification_tag"/>
-      <ref name="classification_value"/>
-    </element>
-  </define>
-  <define name="classification_tag">
-    <element name="tag">
-      <text/>
-    </element>
-  </define>
-  <define name="classification_value">
-    <element name="value">
-      <text/>
-    </element>
-  </define>
 </grammar>