metanorma-ogc 2.8.6 → 2.8.8

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

@@ -869,7 +869,7 @@ depending on whether the items exist as independent documents, or are parts of a
       </zeroOrMore>
     </element>
   </define>
-  <define name="BibItemType" combine="choice">
+  <define name="BibItemType">
     <a:documentation>Type of bibliographic item.
 The value list complies with the types provided in ISO 690:2021.
 NOTE: These values represent a strict superset to BibTeX

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

@@ -165,17 +165,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

@@ -311,17 +311,28 @@ and is intended to be referenced by a callout within the source code</a:document
         </ref>
       </optional>
       <choice>
-        <a:documentation>Content of the figure</a:documentation>
-        <ref name="image"/>
+        <a:documentation>Content of the figure     </a:documentation>
+        <ref name="image">
+          <a:documentation>by default the content of a figure is a media file</a:documentation>
+        </ref>
         <ref name="video"/>
         <ref name="audio"/>
-        <ref name="pre"/>
+        <ref name="pre">
+          <a:documentation>figures can contain ASCII art</a:documentation>
+        </ref>
         <oneOrMore>
-          <ref name="paragraph-with-footnote"/>
+          <ref name="paragraph-with-footnote">
+            <a:documentation>figures can contain discursive art</a:documentation>
+          </ref>
         </oneOrMore>
         <zeroOrMore>
-          <ref name="figure"/>
+          <ref name="figure">
+            <a:documentation>subfigures, nested directly within a figure</a:documentation>
+          </ref>
         </zeroOrMore>
+        <ref name="table">
+          <a:documentation>Table is understood in this context to be a tabular arrangement of subfigures</a:documentation>
+        </ref>
       </choice>
       <zeroOrMore>
         <ref name="fn">
@@ -354,17 +365,28 @@ and is intended to be referenced by a callout within the source code</a:document
         </ref>
       </optional>
       <choice>
-        <a:documentation>Content of the figure</a:documentation>
-        <ref name="image-no-id"/>
+        <a:documentation>Content of the figure     </a:documentation>
+        <ref name="image-no-id">
+          <a:documentation>by default the content of a figure is a media file</a:documentation>
+        </ref>
         <ref name="video-no-id"/>
         <ref name="audio-no-id"/>
-        <ref name="pre-no-id"/>
+        <ref name="pre-no-id">
+          <a:documentation>figures can contain ASCII art</a:documentation>
+        </ref>
         <oneOrMore>
-          <ref name="paragraph-with-footnote-no-id"/>
+          <ref name="paragraph-with-footnote-no-id">
+            <a:documentation>figures can contain discursive art</a:documentation>
+          </ref>
         </oneOrMore>
         <zeroOrMore>
-          <ref name="figure-no-id"/>
+          <ref name="figure-no-id">
+            <a:documentation>subfigures, nested directly within a figure</a:documentation>
+          </ref>
         </zeroOrMore>
+        <ref name="table-no-id">
+          <a:documentation>Table is understood in this context to be a tabular arrangement of subfigures</a:documentation>
+        </ref>
       </choice>
       <zeroOrMore>
         <ref name="fn">
@@ -876,6 +898,9 @@ titlecase, or lowercase</a:documentation>
           <data type="boolean"/>
         </attribute>
       </optional>
+      <ref name="LocalizedStringAttributes">
+        <a:documentation>Specify language of bibitem, can be used to render it with language-specific bibliographic style</a:documentation>
+      </ref>
       <ref name="ReducedBibliographicItem"/>
     </element>
   </define>

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.6".freeze
+    VERSION = "2.8.8".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"
@@ -40,5 +40,5 @@ spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "webmock"
-  spec.add_development_dependency "canon"
+  spec.add_development_dependency "canon", "= 0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ogc
 version: !ruby/object:Gem::Version
-  version: 2.8.6
+  version: 2.8.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-30 00:00:00.000000000 Z
+date: 2025-11-03 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
@@ -210,16 +210,16 @@ dependencies:
   name: canon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.3
 description: 'Metanorma for the Open Geospatial Consortium.
 
   '
@@ -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