metanorma-ogc 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28745dd5a01a192127b2f83263b77bef14f84b34a29250917c52ef19b299abbf
-  data.tar.gz: d4b8436c3181ddb7ec37a138ba92de16e8ca52b598aa7bb776fe6a96e857f558
+  metadata.gz: b06257175ed17babd9928b2e5fecaf8aef1ab4e70ba53d494244813e28180d5b
+  data.tar.gz: 7f6d69a86ba6427adeed77e5b47565a4a286278f6931cbf451ee8606fdc0cf5e
 SHA512:
-  metadata.gz: 3eef074b538b1ebd105b1cdf5964738635da7995356276e1eb137199a812d7ca47116d29eca8074fbd5f031b40aa511c8d3e1895b97399f733e9a0e795932815
-  data.tar.gz: a7ff610163cc1661bcf9fc85a7e112e01b974d1a324a6f6347c6c53b78a9153b6a6f29e90f8ecebaa3c97de1955f26051e6981882467fd3f9af997979f5ab83a
+  metadata.gz: 3396cd1cb78a0d014003913d57a4460b38b377b980441a98a1e453f125ea9b10636782ab6eff031e425518863cdcf5ef4c3228561cda5d4d6b0d720310b93fb4
+  data.tar.gz: 85705853508542c024f56181bd1ba871b8c869aa4e5b2f3df4689864fa0d7876193f08bb43638260ae5eff5d0eb4d9631892a13bf0a9a934b33af3e94793f1ae

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/converter.rb

@@ -16,8 +16,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 +26,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'")
@@ -44,69 +43,80 @@ module Asciidoctor
       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")
+        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"))
+        schema_validate(formattedstr_strip(doc.dup),
+                        File.join(File.dirname(__FILE__), "ogc.rng"))
       end
 
-      def sections_cleanup(x)
+      def sections_cleanup(xml)
         super
-        x.xpath("//*[@inline-header]").each do |h|
+        xml.xpath("//*[@inline-header]").each do |h|
           h.delete("inline-header")
         end
       end
 
-      def make_preface(x, s)
+      def make_preface(xml, sect)
         super
-        insert_security(x, s)
-        insert_submitters(x, s)
+        insert_security(xml, sect)
+        insert_submitters(xml, sect)
       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 ||
+      def insert_security(xml, sect)
+        doctype = sect&.at("//bibdata/ext/doctype")&.text
+        description = if %w(standard
+                            community-standard).include?(doctype)
+                        "standard"
+                      else
+                        "document"
+                      end
+        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 s
+        preface.add_child sect
       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
+      def insert_submitters(xml, sect)
+        if xml.at("//submitters")
+          preface = sect.at("//preface") ||
+            sect.add_previous_sibling("<preface/>").first
+          submitters = xml.at("//submitters").remove
           preface.add_child submitters.remove
         end
       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,11 +128,36 @@ module Asciidoctor
         end
       end
 
-      def style(n, t)
-        return
+      def style(_node, _text)
+        nil
+      end
+
+      def termdef_boilerplate_cleanup(xmldoc); end
+
+      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 table_cell(node, xml_tr, tblsec)
+        node.set_attr("valign", "middle")
+        super
       end
 
-      def termdef_boilerplate_cleanup(xmldoc)
+      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 bibdata_cleanup(xmldoc)
@@ -131,6 +166,25 @@ module Asciidoctor
         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 highlight_parse(text, xml)
         xml.hi { |s| s << text }
       end
@@ -145,6 +199,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>

data/lib/isodoc/ogc/biblio.rb

@@ -1,31 +1,31 @@
 module IsoDoc
   module Ogc
     module BaseConvert
-      def std_bibitem_entry(list, b, ordinal, biblio)
-        list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
+      def std_bibitem_entry(list, bib, ordinal, biblio)
+        list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
           prefix_bracketed_ref(ref, "[#{ordinal}]") if biblio
-          standard_citation(ref, b)
+          standard_citation(ref, bib)
         end
       end
 
-      def nonstd_bibitem(list, b, ordinal, bibliography)
-        list.p **attr_code(iso_bibitem_entry_attrs(b, bibliography)) do |r|
-          id = bibitem_ref_code(b)
+      def nonstd_bibitem(list, bib, ordinal, bibliography)
+        list.p **attr_code(iso_bibitem_entry_attrs(bib, bibliography)) do |r|
+          id = bibitem_ref_code(bib)
           identifier = render_identifier(id)
           identifier[1] = nil
           if bibliography
             ref_entry_code(r, ordinal, identifier, id)
           end
-          reference_format(b, r)
+          reference_format(bib, r)
         end
       end
 
-      def reference_format(b, r)
-        if ftitle = b.at(ns("./formattedref"))
-          ftitle&.children&.each { |n| parse(n, r) }
+      def reference_format(bib, ref)
+        if ftitle = bib.at(ns("./formattedref"))
+          ftitle&.children&.each { |n| parse(n, ref) }
         else
           # eventually will be full LNCS reference
-          standard_citation(r, b)
+          standard_citation(ref, bib)
         end
       end
 
@@ -34,97 +34,101 @@ module IsoDoc
       end
 
       def multiplenames_and(names)
-        return "" if names.length == 0
+        return "" if names.empty?
         return names[0] if names.length == 1
         return "#{names[0]} and #{names[1]}" if names.length == 2
+
         names[0..-2].join(", ") + " and #{names[-1]}"
       end
 
-      def nodes_to_span(n)
+      def nodes_to_span(node)
         noko do |xml|
           xml.span do |s|
-            n&.children&.each { |x| parse(x, s) }
+            node&.children&.each { |x| parse(x, s) }
           end
-        end.join("")
+        end.join
       end
 
-      def extract_publisher(b)
-        c = b.xpath(ns("./contributor[role/@type = 'publisher'][organization]"))
+      def extract_publisher(bib)
         abbrs = []
         names = []
-        c&.each do |c1|
+        bib.xpath(ns("./contributor[role/@type = 'publisher']"\
+                     "[organization]"))&.each do |c1|
           n = c1.at(ns("./organization/name")) or next
           abbrs << (c1.at(ns("./organization/abbreviation")) || n)
           names << nodes_to_span(n)
         end
         return [nil, nil] if names.empty?
-        return [multiplenames_and(names), (abbrs.map { |x| x.text }).join("/")]
+
+        [multiplenames_and(names), abbrs.map(&:text).join("/")]
       end
 
-      def extract_author(b)
-        c = b.xpath(ns("./contributor[role/@type = 'author']"))
-        c = b.xpath(ns("./contributor[role/@type = 'editor']")) if c.empty?
+      def extract_author(bib)
+        c = bib.xpath(ns("./contributor[role/@type = 'author']"))
+        c = bib.xpath(ns("./contributor[role/@type = 'editor']")) if c.empty?
         return nil if c.empty?
+
         c.map do |c1|
           c1&.at(ns("./organization/name"))&.text || extract_person_name(c1)
         end.reject { |e| e.nil? || e.empty? }.join(", ")
       end
 
-      def extract_person_name(b)
-        p = b.at(ns("./person/name")) or return
+      def extract_person_name(bib)
+        p = bib.at(ns("./person/name")) or return
         c = p.at(ns("./completename")) and return c.text
         s = p&.at(ns("./surname"))&.text or return
         i = p.xpath(ns("./initial")) and
-          front = i.map { |e| e.text.gsub(/[^[:upper:]]/, "") }.join("")
+          front = i.map { |e| e.text.gsub(/[^[:upper:]]/, "") }.join
         i.empty? and f = p.xpath(ns("./forename")) and
-          front = f.map { |e| e.text[0].upcase }.join("")
+          front = f.map { |e| e.text[0].upcase }.join
         front ? "#{s} #{front}" : s
       end
 
-
       def date_render(date)
         return nil if date.nil?
+
         on = date&.at(ns("./on"))&.text
         from = date&.at(ns("./from"))&.text
         to = date&.at(ns("./to"))&.text
         return on if on && !on.empty?
         return "#{from}&ndash;#{to}" if from && !from.empty?
+
         nil
       end
 
-      def extract_year(b)
-        d = b.at(ns("./date[@type = 'published']")) ||
-          b.at(ns("./date[@type = 'issued']")) ||
-          b.at(ns("./date[@type = 'circulated']")) ||
-          b.at(ns("./date"))
+      def extract_year(bib)
+        d = bib.at(ns("./date[@type = 'published']")) ||
+          bib.at(ns("./date[@type = 'issued']")) ||
+          bib.at(ns("./date[@type = 'circulated']")) ||
+          bib.at(ns("./date"))
         date_render(d)
       end
 
-      def extract_city(b)
-        b.at(ns("./place"))
+      def extract_city(bib)
+        bib.at(ns("./place"))
       end
 
-      def extract_uri(b)
-        b.at(ns("./uri"))
+      def extract_uri(bib)
+        bib.at(ns("./uri"))
       end
 
       # {author}: {document identifier}, {title}. {publisher}, {city} ({year})
-      def standard_citation(out, b)
-        if ftitle = b.at(ns("./formattedref"))
+      def standard_citation(out, bib)
+        if ftitle = bib.at(ns("./formattedref"))
           ftitle&.children&.each { |n| parse(n, out) }
         else
-          pub, pub_abbrev = extract_publisher(b)
-          author = extract_author(b)
-          c = extract_city(b)
-          y = extract_year(b)
-          u = extract_uri(b)
+          pub, pub_abbrev = extract_publisher(bib)
+          author = extract_author(bib)
+          c = extract_city(bib)
+          y = extract_year(bib)
+          u = extract_uri(bib)
           out << "#{author || pub_abbrev}: " if author || pub_abbrev
-          id = render_identifier(inline_bibitem_ref_code(b))
+          id = render_identifier(inline_bibitem_ref_code(bib))
           out << id[1] if id[1]
-          out << " (Draft)" if ogc_draft_ref?(b)
+          out << " (Draft)" if ogc_draft_ref?(bib)
           out << ", "
           out.i do |i|
-            iso_title(b)&.children&.each { |n| parse(n, i) }
+            iso_title(bib)&.children&.each { |n| parse(n, i) }
           end
           out << ". "
           out << pub if pub
@@ -136,12 +140,14 @@ module IsoDoc
         end
       end
 
-      def inline_bibitem_ref_code(b)
-        id = b.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'metanorma' "\
-                     "or @type = 'ISSN' or @type = 'ISBN' or @type = 'rfc-anchor')]"))
-        id ||= b.at(ns("./docidentifier[not(@type = 'metanorma')]"))
+      def inline_bibitem_ref_code(bib)
+        id = bib.at(ns("./docidentifier[not(@type = 'DOI' "\
+                       "or @type = 'metanorma' or @type = 'ISSN' "\
+                       "or @type = 'ISBN' or @type = 'rfc-anchor')]"))
+        id ||= bib.at(ns("./docidentifier[not(@type = 'metanorma')]"))
         return [nil, id, nil] if id
-        id = Nokogiri::XML::Node.new("docidentifier", b.document)
+
+        id = Nokogiri::XML::Node.new("docidentifier", bib.document)
         id << "(NO ID)"
         [nil, id, nil]
       end