metanorma-ogc 2.8.7 → 2.8.9

data/lib/isodoc/ogc/presentation_sections.rb

@@ -94,10 +94,10 @@ module IsoDoc
       end
 
       def format_personalname(contrib)
-        Relaton::Render::Ogc::General
+        ret = Relaton::Render::Ogc::General
           .new(template: { book: "{{ creatornames }}" })
-          .render("<bibitem type='book'>#{contrib.to_xml}</bibitem>",
-                  embedded: true)
+          .render_all("<references><bibitem type='book'>#{contrib.to_xml}</bibitem></references>")
+ret[nil][:citation][:author]
       end
 
       def dochistory_description(item)

data/lib/metanorma/ogc/biblio.rng

@@ -690,7 +690,7 @@ Examples include GRID, LEI, CrossRef, and Ringgold</a:documentation>
   <define name="CitationType">
     <attribute name="bibitemid">
       <a:documentation>Bibliographic item that the citation applies to, referenced as the anchor of a bibliographic description</a:documentation>
-      <data type="IDREF"/>
+      <ref name="IdRefType"/>
     </attribute>
     <choice>
       <zeroOrMore>
@@ -1296,17 +1296,17 @@ for which this claim of validity is made, if applicable</a:documentation>
   </define>
   <define name="validityBegins">
     <element name="validityBegins">
-      <ref name="ISO8601Date"/>
+      <ref name="ISO8601DateTime"/>
     </element>
   </define>
   <define name="validityEnds">
     <element name="validityEnds">
-      <ref name="ISO8601Date"/>
+      <ref name="ISO8601DateTime"/>
     </element>
   </define>
   <define name="validityRevision">
     <element name="revision">
-      <ref name="ISO8601Date"/>
+      <ref name="ISO8601DateTime"/>
     </element>
   </define>
   <define name="TypedTitleString">

data/lib/metanorma/ogc/cleanup.rb

@@ -72,30 +72,6 @@ module Metanorma
         end
       end
 
-      # KILL
-      def section_names_terms_cleanupx(xml)
-        @i18n or return
-        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#{SYM_NO_ABBR} | " \
-                           "//sections//clause[.//terms]#{SYM_NO_ABBR}",
-                      @i18n.termsdefsymbols, true)
-        replace_title(xml, "//sections//terms#{ABBR_NO_SYM} | " \
-                           "//sections//clause[.//terms]#{ABBR_NO_SYM}",
-                      @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
-
       # as in standoc, but do not rename annex terms
        def section_names_terms1_cleanup(xml)
         auto_name_terms(xml) or return

data/lib/metanorma/ogc/converter.rb

@@ -36,8 +36,7 @@ module Metanorma
                   reference-model release-notes standard user-guide white-paper
                   technical-paper test-suite draft-standard}.include? d
           @warned_doctype or
-            @log.add("Document Attributes", nil,
-                     "'#{d}' is not a legal document type: reverting to 'standard'")
+            @log.add("OGC_16", nil, params: [d])
           @warned_doctype = true
           d = @default_doctype
         end
@@ -177,3 +176,5 @@ module Metanorma
     end
   end
 end
+
+require_relative "log"

data/lib/metanorma/ogc/front.rb

@@ -5,12 +5,6 @@ require "fileutils"
 module Metanorma
   module Ogc
     class Converter < Standoc::Converter
-      def safe_xml_string(node, key, value)
-        node.send key do |n|
-          n << value
-        end
-      end
-
       def org_author(node, xml)
         node.attr("submitting-organizations") or return
         csv_split(@c.decode(node.attr("submitting-organizations")),
@@ -18,7 +12,7 @@ module Metanorma
           xml.contributor do |c|
             c.role type: "author"
             c.organization do |a|
-              safe_xml_string(a, "name", org)
+              add_noko_elem(a, "name", org)
             end
           end
         end
@@ -40,7 +34,7 @@ module Metanorma
         type = node.attr("role#{suffix}")&.downcase || "editor"
         if type == "contributor"
           contrib.role type: "author" do |r|
-            safe_xml_string(r, "description", type)
+            add_noko_elem(r, "description", type)
           end
         else contrib.role type: type
         end
@@ -52,7 +46,7 @@ module Metanorma
           c.role type: "editor"
           c.person do |p|
             p.name do |n|
-              n.completename node.attr("editor")
+              add_noko_elem(n, "completename", node.attr("editor"))
             end
           end
         end
@@ -71,10 +65,10 @@ module Metanorma
 
       def personal_author_name(node, xml, suffix)
         if node.attr("fullname#{suffix}")
-          safe_xml_string(xml, "completename", node.attr("fullname#{suffix}"))
+          add_noko_elem(xml, "completename", node.attr("fullname#{suffix}"))
         else
-          safe_xml_string(xml, "forename", node.attr("givenname#{suffix}"))
-          safe_xml_string(xml, "surname", node.attr("surname#{suffix}"))
+          add_noko_elem(xml, "forename", node.attr("givenname#{suffix}"))
+          add_noko_elem(xml, "surname", node.attr("surname#{suffix}"))
         end
       end
 
@@ -108,12 +102,15 @@ module Metanorma
       end
 
       def metadata_id(node, xml)
-        e = externalid(node) and xml.docidentifier e, type: "ogc-external"
+        add_noko_elem(xml, "docidentifier", externalid(node),
+                      type: "ogc-external")
         node.attr("referenceurlid") and
-          xml.docidentifier externalurl(node), type: "ogc-external"
-        docnumber = node.attr("docnumber") || node.attr("docreference")
-        id = node.attr("docidentifier") || docnumber
-        xml.docidentifier id, type: "ogc-internal", primary: "true"
+          add_noko_elem(xml, "docidentifier", externalurl(node),
+                        type: "ogc-external")
+        id = node.attr("docidentifier") || node.attr("docnumber") ||
+          node.attr("docreference")
+        add_noko_elem(xml, "docidentifier", id, type: "ogc-internal",
+                                                primary: "true")
       end
 
       def externalurl(node)
@@ -126,8 +123,7 @@ module Metanorma
 
       def metadata_source(node, xml)
         super
-        node.attr("previous-uri") && xml.uri(node.attr("previous-uri"),
-                                             type: "previous")
+        add_noko_elem(xml, "uri", node.attr("previous-uri"), type: "previous")
       end
 
       def metadata_copyright(node, xml)
@@ -146,7 +142,7 @@ module Metanorma
       def ogc_date(node, xml, ogcname, metanormaname)
         if node.attr(ogcname)
           xml.date type: metanormaname do |d|
-            d.on node.attr(ogcname)
+            add_noko_elem(d, "on", node.attr(ogcname))
           end
         end
       end
@@ -165,17 +161,13 @@ module Metanorma
           unless %w{conceptual-model conceptual-model-and-encoding
                     conceptual-model-and-implementation encoding extension
                     implementation profile profile-with-extension}.include? s
-            @log.add("Document Attributes", nil,
-                     "'#{s}' is not a permitted subtype of Standard: " \
-                     "reverting to 'implementation'")
+            @log.add("OGC_17", nil, params: [s])
             s = "implementation"
           end
         when "best-practice"
           unless %w{general encoding extension profile
                     profile-with-extension}.include? s
-            @log.add("Document Attributes", nil,
-                     "'#{s}' is not a permitted subtype of best-practice: " \
-                     "reverting to 'general'")
+            @log.add("OGC_18", nil, params: [s])
             s = "general"
           end
         end

data/lib/metanorma/ogc/isodoc.rng

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <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">
-<!-- VERSION v2.1.3 -->
+<!-- VERSION v2.1.4 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -905,15 +905,32 @@ titlecase, or lowercase</a:documentation>
     </element>
   </define>
   <define name="image" combine="choice">
-    <element name="svg">
-      <a:documentation>Add svg mark up to image</a:documentation>
-      <oneOrMore>
-        <choice>
-          <text/>
-          <ref name="AnyElement"/>
-        </choice>
-      </oneOrMore>
-    </element>
+    <choice>
+      <element name="image">
+        <ref name="RequiredId"/>
+        <ref name="ImageAttributes"/>
+        <optional>
+          <element name="svg">
+            <a:documentation>Allow svg in image/svg, for consistency</a:documentation>
+            <oneOrMore>
+              <choice>
+                <text/>
+                <ref name="AnyElement"/>
+              </choice>
+            </oneOrMore>
+          </element>
+        </optional>
+      </element>
+      <element name="svg">
+        <a:documentation>Add svg mark up to image</a:documentation>
+        <oneOrMore>
+          <choice>
+            <text/>
+            <ref name="AnyElement"/>
+          </choice>
+        </oneOrMore>
+      </element>
+    </choice>
   </define>
   <define name="ParagraphFnBody" combine="interleave">
     <ref name="BlockSource">

data/lib/metanorma/ogc/log.rb

@@ -0,0 +1,68 @@
+module Metanorma
+  module Ogc
+    class Converter
+      OGC_LOG_MESSAGES = {
+        # rubocop:disable Naming/VariableNumber
+        "OGC_1": { category: "Document Attributes",
+                   error: "%s is not a recognised status",
+                   severity: 2 },
+        "OGC_2": { category: "Document Attributes",
+                   error: "%s is not an allowed status for %s",
+                   severity: 2 },
+        "OGC_3": { category: "Document Attributes",
+                   error: "Version not permitted for %s",
+                   severity: 2 },
+        "OGC_4": { category: "Document Attributes",
+                   error: "Version required for %s",
+                   severity: 2 },
+        "OGC_5": { category: "Style",
+                   error: "Executive Summary required for Engineering Reports!",
+                   severity: 2 },
+        "OGC_6": { category: "Style",
+                   error: "Executive Summary only allowed for Engineering Reports!",
+                   severity: 2 },
+        "OGC_7": { category: "Style",
+                   error: "(section sequencing) %s",
+                   severity: 2 },
+        "OGC_8": { category: "Style",
+                   error: "Document must contain at least one clause",
+                   severity: 2 },
+        "OGC_9": { category: "Style",
+                   error: "Normative References are mandatory",
+                   severity: 2 },
+        "OGC_10": { category: "Style",
+                    error: "Abstract is missing!",
+                    severity: 2 },
+        "OGC_11": { category: "Style",
+                    error: "Keywords are missing!",
+                    severity: 2 },
+        "OGC_12": { category: "Style",
+                    error: "Preface is missing!",
+                    severity: 2 },
+        "OGC_13": { category: "Style",
+                    error: "Submitting Organizations is missing!",
+                    severity: 2 },
+        "OGC_14": { category: "Style",
+                    error: "Submitters is missing!",
+                    severity: 2 },
+        "OGC_15": { category: "Bibliography",
+                    error: "Engineering report should not contain normative references",
+                    severity: 2 },
+        "OGC_16": { category: "Document Attributes",
+                    error: "'%s' is not a legal document type: reverting to 'standard'",
+                    severity: 2 },
+        "OGC_17": { category: "Document Attributes",
+                    error: "'%s' is not a permitted subtype of Standard: reverting to 'implementation'",
+                    severity: 2 },
+        "OGC_18": { category: "Document Attributes",
+                    error: "'%s' is not a permitted subtype of best-practice: reverting to 'general'",
+                    severity: 2 },
+      }.freeze
+      # rubocop:enable Naming/VariableNumber
+
+      def log_messages
+        super.merge(OGC_LOG_MESSAGES)
+      end
+    end
+  end
+end

data/lib/metanorma/ogc/validate.rb

@@ -24,8 +24,7 @@ module Metanorma
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(draft swg-draft oab-review public-rfc tc-vote work-item-draft
            approved deprecated retired rescinded legacy).include? stage or
-          @log.add("Document Attributes", nil,
-                   "#{stage} is not a recognised status")
+          @log.add("OGC_1", nil, params: [stage])
         stage_type_validate(stage, @doctype)
       end
 
@@ -40,29 +39,24 @@ module Metanorma
         else %w(swg-draft oab-review public-rfc tc-vote work-item-draft
                 deprecated rescinded legacy).include?(stage)
         end and
-          @log.add("Document Attributes", nil,
-                   "#{stage} is not an allowed status for #{doctype}")
+          @log.add("OGC_2", nil, params: [stage, doctype])
       end
 
       def version_validate(xmldoc)
         version = xmldoc.at("//bibdata/edition")&.text
         if %w(engineering-report discussion-paper).include? @doctype
-          version.nil? or @log.add("Document Attributes", nil,
-                                   "Version not permitted for #{@doctype}")
+          version.nil? or @log.add("OGC_3", nil, params: [@doctype])
         else
-          version.nil? and @log.add("Document Attributes", nil,
-                                    "Version required for #{@doctype}")
+          version.nil? and @log.add("OGC_4", nil, params: [@doctype])
         end
       end
 
       def execsummary_validate(xmldoc)
         sect = xmldoc.at("//executivesummary")
         @doctype == "engineering-report" && sect.nil? and
-          @log.add("Style", nil,
-                   "Executive Summary required for Engineering Reports!")
+          @log.add("OGC_5", nil)
         @doctype != "engineering-report" && !sect.nil? and
-          @log.add("Style", nil,
-                   "Executive Summary only allowed for Engineering Reports!")
+          @log.add("OGC_6", nil)
       end
 
       def section_validate(doc)
@@ -100,7 +94,7 @@ module Metanorma
 
         test = accepted.map { |a| n.at(a) }
         if test.all?(&:nil?)
-          @log.add("Style", nil, msg)
+          @log.add("OGC_7", nil, params: [msg])
         end
         names
       end
@@ -116,35 +110,31 @@ module Metanorma
           n = names.shift
         end
         if n.nil? || n.name != "clause"
-          @log.add("Style", nil,
-                   "Document must contain at least one clause")
+          @log.add("OGC_8", nil)
           return
         end
         root.at("//references | //clause[descendant::references]" \
                 "[not(parent::clause)]") or
-          @log.add("Style", nil, "Normative References are mandatory")
+          @log.add("OGC_9", nil)
       end
 
       def preface_sequence_validate(root)
         @doctype == "engineering-report" and return
-        root.at("//preface/abstract") or @log.add("Style", nil,
-                                                  "Abstract is missing!")
+        root.at("//preface/abstract") or @log.add("OGC_10", nil)
         root.at("//bibdata/keyword | //bibdata/ext/keyword") or
-          @log.add("Style", nil, "Keywords are missing!")
-        root.at("//foreword") or @log.add("Style", nil,
-                                          "Preface is missing!")
+          @log.add("OGC_11", nil)
+        root.at("//foreword") or @log.add("OGC_12", nil)
         root.at("//bibdata/contributor[role/@type = 'author']/organization/" \
                 "name") or
-          @log.add("Style", nil, "Submitting Organizations is missing!")
+          @log.add("OGC_13", nil)
         root.at("//clause[@type = 'submitters' or @type = 'contributors']") or
-          @log.add("Style", nil, "Submitters is missing!")
+          @log.add("OGC_14", nil)
       end
 
       def norm_ref_validate(doc)
         @doctype == "engineering-report" or return super
         doc.xpath("//references[@normative = 'true']").each do |b|
-          @log.add("Bibliography", b,
-                   "Engineering report should not contain normative references")
+          @log.add("OGC_15", b)
         end
       end
     end

data/lib/metanorma/ogc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ogc
-    VERSION = "2.8.7".freeze
+    VERSION = "2.8.9".freeze
   end
 end

data/lib/relaton/render/config.yml

@@ -1,8 +1,8 @@
 template:
-  standard: "{% if creatornames %}{{ creatornames }} ({{role}}){%else%}{{ publisher_abbrev}}{%endif%} : {{authoritative_identifier|first}} {{draft}} , <em>{{ title }}</em>. {{ publisher }}{%if place%},{%endif%} {{ place }} ({{date}}). {{uri}}."
+  standard: "{% if creatornames %}{{ creatornames }} ({{role}}){%else%}{{ publisher_abbrev}}{%endif%} : {{authoritative_identifier|first}} {{draft}} , <em>{{ title }}</em>$$$ {{ publisher }}{%if place%},{%endif%} {{ place }} ({{date}})$$$ {{uri}}$$$"
   misc: standard
   techreport: standard
-  book: "{{ creatornames }} ({{role}}) : <em>{{ title }}</em> . {{ publisher }}, {% if place %}{{place}}{%else%}{{ labels['no_place']}}{%endif%} ({{date}})."
+  book: "{{ creatornames }} ({{role}}) : <em>{{ title }}</em> $$$ {{ publisher }}, {% if place %}{{place}}{%else%}{{ labels['no_place']}}{%endif%} ({{date}})$$$"
   booklet: book
   manual: book
   proceedings: book
@@ -12,11 +12,11 @@ template:
   webresource: book
   unpublished: book
   presentation: book
-  inbook: "{{ creatornames }} ({{role}}) : {{ title }} . {{ labels['in'] | capitalize }}: {{ host_creatornames}} ({{ host_role}}) : <em>{{host_title}}</em>. {{ extent}}. {{ publisher }}{%if place%},{%endif%} {{ place }} . ({{date}})." 
+  inbook: "{{ creatornames }} ({{role}}) : {{ title }} $$$ {{ labels['in'] | capitalize }}: {{ host_creatornames}} ({{ host_role}}) : <em>{{host_title}}</em>$$$ {{ extent}}$$$ {{ publisher }}{%if place%},{%endif%} {{ place }} $$$ ({{date}})$$$" 
   inproceedings: inbook
   incollection: inbook
-  journal: "<em>{{ title}}</em> . {{ publisher }}{%if place%},{%endif%} {{ place }} . ({{date}})."
-  article: "{{ creatornames }} ({{role}}) : {{ title }}. {{ series }} {{ extent }} ({{date}})."
+  journal: "<em>{{ title}}</em> $$$ {{ publisher }}{%if place%},{%endif%} {{ place }} $$$ ({{date}})$$$"
+  article: "{{ creatornames }} ({{role}}) : {{ title }}$$$ {{ series }} {{ extent }} ({{date}})$$$"
 nametemplate:
   one: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} {{initials[0] | join: '' | remove: '.' | remove: '_' }}{% endif %}"
   two: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} {{initials[0] | join: '' | remove: '.' | remove: '_' }}{% endif %} , {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{surname[1]}} {{ initials[1] | join: '' | remove: '.' | remove: '_' }}{% endif %}"

data/metanorma-ogc.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
 
   spec.add_dependency "iso-639"
-  spec.add_dependency "metanorma-standoc", "~> 3.1.0"
+  spec.add_dependency "metanorma-standoc", "~> 3.2.0"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ogc
 version: !ruby/object:Gem::Version
-  version: 2.8.7
+  version: 2.8.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-13 00:00:00.000000000 Z
+date: 2025-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iso-639
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -299,6 +299,7 @@ files:
 - lib/metanorma/ogc/converter.rb
 - lib/metanorma/ogc/front.rb
 - lib/metanorma/ogc/isodoc.rng
+- lib/metanorma/ogc/log.rb
 - lib/metanorma/ogc/ogc.rng
 - lib/metanorma/ogc/processor.rb
 - lib/metanorma/ogc/relaton-ogc.rng