metanorma-ogc 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eea51c0d090677e7d33baba438144ba8124e0013784531aad6157444eb64fe78
-  data.tar.gz: 7fda2b26713c8075c24307ec3db64547de91920540c88b64d029fbf40e59fb56
+  metadata.gz: c479fe29661043d57d71fe5685ac2896c5ecc2ec2813a6ba0a7447001e267c0f
+  data.tar.gz: 6566850cc12d813e37b340a257be263e0da139684242e4afff42610a146e8317
 SHA512:
-  metadata.gz: 9c2e579039e84e10a4f3d91ee1da183e220c1d4d337b6a3bdfb7032d2f706603fba5618b94f854ca6fbb076de01b014496f7f8e3500cbc7b9307542753b35867
-  data.tar.gz: 9e4d01426f51cbe26229d864578c1a2e24c6cdd3a04b3f6346abb6a5e90895d7698701f7cc4716b044d2b0ba96a55c0a65b8a552e77f6626eb88652da4d595cf
+  metadata.gz: 203e38a7f20a0cccb389c3298dfdd6bb455c0c9f09bb54531c14d3cf77b478e8a86e0e1737e6d9ff7c208256fb935ba4cce83d7046a2e8a61361e9a953be7d11
+  data.tar.gz: 4e5cc582d36eb993928dec698abdafeb4fed9ee1aee7124f1459ca4a10c5988017060f2cd1cf95e233f467c4c9077384f2b0061eb2b8581d4a0a679bffad3bdd

data/.travis.yml

@@ -1,15 +1,18 @@
-dist: trusty
-sudo: false
 language: ruby
+cache: bundler
+os:
+- linux
+- osx
 rvm:
-  - 2.5
-  - 2.4
-  - 2.3
-  - ruby-head
+- 2.5
+- 2.4
+- 2.3
+- ruby-head
 before_install:
-  - gem install bundler -v 2.0.1
-  - travis_retry sudo apt-get update
-  - sudo bash -c "curl -L https://raw.githubusercontent.com/metanorma/metanorma-linux-setup/master/ubuntu-install-puppeteer.sh | bash"
+- nvm install 8
+- npm install -g puppeteer
+- gem install bundler -v 2.0.1
+- bundle update
 matrix:
   allow_failures:
     - rvm: ruby-head

data/lib/asciidoctor/ogc/biblio.rng

@@ -636,22 +636,27 @@
       <ref name="ISO8601Date"/>
     </optional>
   </define>
+  <define name="BibliographicDateType">
+    <choice>
+      <value>published</value>
+      <value>accessed</value>
+      <value>created</value>
+      <value>implemented</value>
+      <value>obsoleted</value>
+      <value>confirmed</value>
+      <value>updated</value>
+      <value>issued</value>
+      <value>transmitted</value>
+      <value>copied</value>
+      <value>unchanged</value>
+      <value>circulated</value>
+    </choice>
+  </define>
   <define name="bdate">
     <element name="date">
       <attribute name="type">
         <choice>
-          <value>published</value>
-          <value>accessed</value>
-          <value>created</value>
-          <value>implemented</value>
-          <value>obsoleted</value>
-          <value>confirmed</value>
-          <value>updated</value>
-          <value>issued</value>
-          <value>transmitted</value>
-          <value>copied</value>
-          <value>unchanged</value>
-          <value>circulated</value>
+          <ref name="BibliographicDateType"/>
           <text/>
         </choice>
       </attribute>

data/lib/asciidoctor/ogc/converter.rb

@@ -174,6 +174,9 @@ module Asciidoctor
 
       def example(node)
         return term_example(node) if in_terms?
+        return requirement(node, "recommendation") if node.attr("style") == "recommendation"
+        return requirement(node, "requirement") if node.attr("style") == "requirement"
+        return requirement(node, "permission") if node.attr("style") == "permission"
         noko do |xml|
           xml.example **id_attr(node) do |ex|
             figure_title(node, ex)

data/lib/isodoc/ogc/base_convert.rb

@@ -0,0 +1,338 @@
+require "isodoc"
+require_relative "metadata"
+require "fileutils"
+
+module IsoDoc
+  module Ogc
+    module BaseConvert
+      def annex_name(annex, name, div)
+        div.h1 **{ class: "Annex" } do |t|
+          t << "#{get_anchors[annex['id']][:label]} "
+          t.br
+          t.b do |b|
+            name&.children&.each { |c2| parse(c2, b) }
+          end
+        end
+      end
+
+      def term_defs_boilerplate(div, source, term, preface)
+        if source.empty? && term.nil?
+          div << @no_terms_boilerplate
+        else
+          div << term_defs_boilerplate_cont(source, term)
+        end
+      end
+
+      def fileloc(loc)
+        File.join(File.dirname(__FILE__), loc)
+      end
+
+      def cleanup(docxml)
+        super
+        term_cleanup(docxml)
+      end
+
+      def term_cleanup(docxml)
+        docxml.xpath("//p[@class = 'Terms']").each do |d|
+          h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
+          h2.add_child("&nbsp;")
+          h2.add_child(d.remove)
+        end
+        docxml
+      end
+
+      def info(isoxml, out)
+        @meta.keywords isoxml, out
+        super
+      end
+
+      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 do |org|
+              ul.li org
+            end
+          end
+        end
+      end
+
+      def submitters(docxml, out)
+        f = docxml.at(ns("//submitters")) || return
+        out.div **{ class: "Section3" } do |div|
+          clause_name(get_anchors[f['id']][:label], "Submitters", div,  class: "IntroTitle")
+          f.elements.each { |e| parse(e, div) unless e.name == "title" }
+        end
+      end
+
+      def preface_names(clause)
+        return if clause.nil?
+        @prefacenum += 1
+        @anchors[clause["id"]] =
+          { label: RomanNumerals.to_roman(@prefacenum).downcase,
+            level: 1, xref: preface_clause_name(clause), type: "clause" }
+        clause.xpath(ns("./clause | ./terms | ./term | ./definitions")).each_with_index do |c, i|
+          section_names1(c, "#{@prefacenum}.#{i + 1}", 2)
+        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(get_anchors[f["id"]][:label], @abstract_lbl, s, class: "AbstractTitle")
+          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        end
+      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(get_anchors[f["id"]][:label], @foreword_lbl, s, class: "ForewordTitle")
+          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        end
+      end
+
+      def example_parse(node, out)
+        name = node.at(ns("./name"))
+        sourcecode_name_parse(node, out, name) if name
+        super
+      end
+
+      def error_parse(node, out)
+        case node.name
+        when "recommendation" then recommendation_parse(node, out)
+        when "requirement" then requirement_parse(node, out)
+        when "permission" then permission_parse(node, out)
+        else
+          super
+        end
+      end
+
+      def anchor_names(docxml)
+        super
+        recommendation_anchor_names(docxml)
+        requirement_anchor_names(docxml)
+        permission_anchor_names(docxml)
+      end
+
+      def recommendation_anchor_names(docxml)
+        docxml.xpath(ns("//recommendation")).each_with_index do |x, i|
+          @anchors[x["id"]] = anchor_struct(i+1, nil, "Recommendation", "recommendation")
+        end
+      end
+
+      def requirement_anchor_names(docxml)
+        docxml.xpath(ns("//requirement")).each_with_index do |x, i|
+          @anchors[x["id"]] = anchor_struct(i+1, nil, "Requirement", "requirement")
+        end
+      end
+
+      def permission_anchor_names(docxml)
+        docxml.xpath(ns("//permission")).each_with_index do |x, i|
+          @anchors[x["id"]] = anchor_struct(i+1, nil, "Permission", "permission")
+        end
+      end
+
+      def recommend_table_attr(node)
+        attr_code(id: node["id"], class: "recommend",
+                  cellspacing: 0, cellpadding: 0,
+                  style: "border-collapse:collapse" )
+      end
+
+      REQ_TBL_ATTR =
+        { valign: "top", class: "example_label",
+          style: "width:100.0pt;padding:0 0 0 1em;margin-left:0pt" }.freeze
+
+      def recommend_name_parse(node, div)
+        name = node&.at(ns("./name"))&.text or return
+        div.p do |p|
+          p.b name
+        end
+      end
+
+      def recommendation_parse(node, out)
+        out.table **recommend_table_attr(node) do |t|
+          t.tr do |tr|
+            tr.td **REQ_TBL_ATTR do |td|
+              recommendation_label(node, td)
+            end
+            tr.td **{ valign: "top", class: "recommend" } do |td|
+              recommend_name_parse(node, td)
+              node.children.each { |n| parse(n, td) unless n.name == "name" }
+            end
+          end
+        end
+      end
+
+      def recommendation_label(node, out)
+        n = get_anchors[node["id"]]
+        label = (n.nil? || n[:label].empty?) ?
+          "Recommendation" : l10n("#{"Recommendation"} #{n[:label]}")
+        out.p **{class: "RecommendationTitle" } do |p|
+          p << label
+        end
+      end
+
+      def requirement_parse(node, out)
+        out.table **recommend_table_attr(node) do |t|
+          t.tr do |tr|
+            tr.td **REQ_TBL_ATTR do |td|
+              requirement_label(node, td)
+            end
+            tr.td **{ valign: "top", class: "recommend" } do |td|
+              recommend_name_parse(node, td)
+              node.children.each { |n| parse(n, td) unless n.name == "name" }
+            end
+          end
+        end
+      end
+
+      def requirement_label(node, out)
+        n = get_anchors[node["id"]]
+        label = (n.nil? || n[:label].empty?) ?
+          "Requirement" : l10n("#{"Requirement"} #{n[:label]}")
+        out.p **{class: "RecommendationTitle" } do |p|
+          p << label
+        end
+      end
+
+      def permission_parse(node, out)
+        out.table **recommend_table_attr(node) do |t|
+          t.tr do |tr|
+            tr.td **REQ_TBL_ATTR do |td|
+              permission_label(node, td)
+            end
+            tr.td **{ valign: "top", class: "recommend" } do |td|
+              recommend_name_parse(node, td)
+              node.children.each { |n| parse(n, td) unless n.name == "name" }
+            end
+          end
+        end
+      end
+
+      def permission_label(node, out)
+        n = get_anchors[node["id"]]
+        label = (n.nil? || n[:label].empty?) ?
+          "Permission" : l10n("#{"Permission"} #{n[:label]}")
+        out.p **{class: "RecommendationTitle" } do |p|
+          p << label
+        end
+      end
+
+      def initial_anchor_names(d)
+        @prefacenum = 0
+        preface_names(d.at(ns("//preface/abstract")))
+        @prefacenum += 1 if d.at(ns("//keyword"))
+        preface_names(d.at(ns("//foreword")))
+        #preface_names(d.at(ns("//introduction")))
+        @prefacenum += 1 if d.at(ns(SUBMITTINGORGS))
+        preface_names(d.at(ns("//submitters")))
+        sequential_asset_names(d.xpath(ns("//preface/abstract | //foreword | //introduction | //submitters")))
+        n = section_names(d.at(ns("//clause[title = 'Scope']")), 0, 1)
+        n = section_names(d.at(ns("//clause[title = 'Conformance']")), n, 1)
+        n = section_names(d.at(ns(
+          "//references[title = 'Normative References' or title = 'Normative references']")), n, 1)
+        n = section_names(d.at(ns("//sections/terms | "\
+                                  "//sections/clause[descendant::terms]")), n, 1)
+        n = section_names(d.at(ns("//sections/definitions")), n, 1)
+        middle_section_asset_names(d)
+        clause_names(d, n)
+        termnote_anchor_names(d)
+        termexample_anchor_names(d)
+      end
+
+      MIDDLE_CLAUSE =
+        "//clause[parent::sections][not(xmlns:title = 'Scope' or xmlns:title = 'Conformance')]"\
+        "[not(descendant::terms)]".freeze
+
+      def middle_section_asset_names(d)
+        middle_sections = "//clause[title = 'Scope' or title = 'Conformance'] | "\
+          "//foreword | //introduction | "\
+          "//references[title = 'Normative References' or title = 'Normative references'] | "\
+          "//sections/terms | "\
+          "//sections/definitions | //clause[parent::sections]"
+        sequential_asset_names(d.xpath(ns(middle_sections)))
+      end
+
+=begin
+      def clause_names(docxml, sect_num)
+        docxml.xpath(ns(self.class::MIDDLE_CLAUSE)).each_with_index do |c, i|
+          section_names(c, (i + sect_num), 1)
+        end
+      end
+=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 do |e|
+            parse(e, div) unless e.name == "title"
+          end
+        end
+        num
+      end
+
+=begin
+      def clause(isoxml, out, num)
+        isoxml.xpath(ns(self.class::MIDDLE_CLAUSE)).each do |c|
+          out.div **attr_code(id: c["id"]) do |div|
+            num = num + 1
+            clause_name(num,
+                        c&.at(ns("./title"))&.content, div, nil)
+            c.elements.each do |e|
+              parse(e, div) unless e.name == "title"
+            end
+          end
+        end
+      end
+=end
+
+      def middle(isoxml, out)
+        middle_title(out)
+        i = scope isoxml, out, 0
+        i = conformance isoxml, out, i
+        i = norm_ref isoxml, out, i
+        i = terms_defs isoxml, out, i
+        i = symbols_abbrevs isoxml, out, i
+        clause isoxml, out
+        annex isoxml, out
+        bibliography isoxml, out
+      end
+    end
+  end
+end

data/lib/isodoc/ogc/html/html_ogc_titlepage.html

@@ -84,6 +84,7 @@
   </div>
 </div>
 
+{% if status == "Published" or status == "Withdrawn" %}
 {% if doctype == "Standard" or doctype == "Standard With Suite" %}
   <div class="coverpage-warning">
     <span class="title">Warning</span>
@@ -126,18 +127,36 @@
  </div>
 {% endif %}
 
-{% if status != "Published" and status != "Withdrawn" %}
+{% else %}
   <div class="coverpage-warning">
     <span class="title">Warning for Drafts</span>
 
-    <p class="content">
-    This document is not a OGC Standard. It is distributed for review and
-    comment, and is subject to change without notice and may not be referred to as
-    a Standard.</p>
-    <p class="content">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 Inc. shall not be held responsible for identifying any or all such patent rights.
-    </p>
-    <p class="content">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>
+    {% if doctype == "Standard" or doctype == "Standard With Suite" %}
+    <p class="content">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 class="content">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 %}
+
+    {% if doctype == "Best Practice" %}
+    <p class="content">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 class="content">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 %}
+
+    {% if doctype == "Discussion Paper" %}
+    <p class="content">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>
+    {% endif %}
+
+    {% if doctype == "White Paper" %}
+    <p class="content">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>
+    {% endif %}
+
+    {% if doctype == "Release Notes" %}
+    <p class="content">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 class="content">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 %}
+
   </div>
 {% endif %}