metanorma-itu 2.7.6 → 2.8.0

data/lib/isodoc/itu/presentation_ref.rb

@@ -84,15 +84,17 @@ module IsoDoc
 
       def norm_ref_entry_code(_ordinal, idents, _ids, _standard, datefn, _bib)
         ret = (idents[:metanorma] || idents[:ordinal] || idents[:sdo]).to_s
-        ret.empty? and return ret
-        /^\[.+\]$/.match?(ret) or ret = "[#{ret}]"
+        ret.empty? and return ""
+        ret = ret.sub(/^\[(.+)\]$/, "\\1")
+        ret = "[#{esc ret}]"
         ret += datefn
         ret.gsub("-", "‑").gsub(/ /, " ")
       end
 
       def biblio_ref_entry_code(_ordinal, idents, _id, _standard, datefn, _bib)
         ret = (idents[:metanorma] || idents[:ordinal] || idents[:sdo]).to_s
-        /^\[.+\]$/.match?(ret) or ret = "[#{ret}]"
+        ret = ret.sub(/^\[(.+)\]$/, "\\1")
+        ret = "[#{esc ret}]"
         ret += datefn
         ret.empty? and return ret
         ret.gsub("-", "‑").gsub(/ /, " ")

data/lib/isodoc/itu/presentation_xml_convert.rb

@@ -52,7 +52,7 @@ module IsoDoc
       end
 
       def termsource_label(elem, sources)
-        elem.replace(sources)
+        elem.replace(@i18n.l10n(sources))
       end
 
       def eref1(elem)

data/lib/isodoc/itu/xref.rb

@@ -96,10 +96,10 @@ module IsoDoc
           { unnumb: elem["unnumbered"] }
         )
         if elem["unnumbered"] != "true"
-          #@anchors[elem["id"]][:label] = sublabel
-          @anchors[elem["id"]][:xref] = @anchors[elem.parent["id"]][:xref] +
+          p = elem.at("./ancestor::xmlns:figure")
+          @anchors[elem["id"]][:xref] = @anchors[p["id"]][:xref] +
             delim_wrap("-") + semx(elem, sublabel)
-          x = @anchors[elem.parent["id"]][:container] and
+          x = @anchors[p["id"]][:container] and
             @anchors[elem["id"]][:container] = x
         end
       end

data/lib/metanorma/itu/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/itu/converter.rb

@@ -152,3 +152,5 @@ module Metanorma
     end
   end
 end
+
+require_relative "log"

data/lib/metanorma/itu/front.rb

@@ -18,8 +18,7 @@ module Metanorma
       end
 
       def title_defaultlang(node, xml)
-        a = node.attr("title") || node.attr("title-#{@lang}") ||
-          node.attr("doctitle")
+        a = node.attr("title") || node.attr("title-#{@lang}") or return
         add_title_xml(xml, a, @lang, "main")
         if a = node.attr("annextitle") || node.attr("annextitle-#{@lang}")
           add_title_xml(xml, a, @lang, "annex")
@@ -38,6 +37,7 @@ module Metanorma
       def title(node, xml)
         title_defaultlang(node, xml)
         title_otherlangs(node, xml)
+        title_fallback(node, xml)
         %w(subtitle amendment-title corrigendum-title collection-title
            slogan-title).each do |t|
           other_title_defaultlang(node, xml, t)

data/lib/metanorma/itu/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/itu/itu.rng

@@ -2,13 +2,6 @@
 <grammar ns='https://www.metanorma.org/ns/standoc' xmlns="http://relaxng.org/ns/structure/1.0">
   <include href="relaton-itu.rng"/>
   <include href="isodoc.rng">
-    <define name="OlAttributes" combine="interleave">
-      <optional>
-        <attribute name="class">
-          <value>steps</value>
-        </attribute>
-      </optional>
-    </define>
     <define name="Clause-Section">
       <ref name="Section-Attributes"/>
       <optional>
@@ -35,4 +28,11 @@
       </group>
     </define>
   </include>
+  <define name="OlAttributes" combine="interleave">
+    <optional>
+      <attribute name="class">
+        <value>steps</value>
+      </attribute>
+    </optional>
+  </define>
 </grammar>

data/lib/metanorma/itu/log.rb

@@ -0,0 +1,47 @@
+module Metanorma
+  module Itu
+    class Converter
+      ITU_LOG_MESSAGES = {
+        # rubocop:disable Naming/VariableNumber
+        "ITU_1": { category: "Document Attributes",
+                   error: "%s is not a recognised document type",
+                   severity: 2 },
+        "ITU_2": { category: "Document Attributes",
+                   error: "%s is not a recognised status",
+                   severity: 2 },
+        "ITU_3": { category: "Document Attributes",
+                   error: "Title includes series name %s",
+                   severity: 2 },
+        "ITU_4": { category: "Style",
+                   error: "Requirement possibly in preface: %s",
+                   severity: 2 },
+        "ITU_6": { category: "Document Attributes",
+                   error: "Recommendation Status %s inconsistent with AAP",
+                   severity: 2 },
+        "ITU_7": { category: "Document Attributes",
+                   error: "Recommendation Status %s inconsistent with TAP",
+                   severity: 2 },
+        "ITU_8": { category: "Style",
+                   error: "%s does not match ITU document identifier conventions",
+                   severity: 2 },
+        "ITU_9": { category: "Style",
+                   error: "Unnumbered clause out of place",
+                   severity: 2 },
+        "ITU_10": { category: "Style",
+                    error: "No Summary has been provided",
+                    severity: 2 },
+        "ITU_11": { category: "Style",
+                    error: "No Keywords have been provided",
+                    severity: 2 },
+        "ITU_12": { category: "Style",
+                    error: "(terms) %s: %s",
+                    severity: 2 },
+      }.freeze
+      # rubocop:enable Naming/VariableNumber
+
+      def log_messages
+        super.merge(ITU_LOG_MESSAGES)
+      end
+    end
+  end
+end

data/lib/metanorma/itu/validate.rb

@@ -12,16 +12,14 @@ module Metanorma
            focus-group implementers-guide technical-paper technical-report
            joint-itu-iso-iec service-publication
            contribution).include? @doctype or
-          @log.add("Document Attributes", nil,
-                   "#{@doctype} is not a recognised document type")
+          @log.add("ITU_1", nil, params: [@doctype])
       end
 
       def stage_validate(xmldoc)
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(in-force superseded in-force-prepublished withdrawn
            draft).include? stage or
-          @log.add("Document Attributes", nil,
-                   "#{stage} is not a recognised status")
+          @log.add("ITU_2", nil, params: [stage])
       end
 
       def content_validate(doc)
@@ -41,8 +39,7 @@ module Metanorma
         xmldoc.xpath("//bibdata/series/title").each do |s|
           series = s.text.sub(/^[A-Z]: /, "")
           t.downcase.include?(series.downcase) and
-            @log.add("Document Attributes", nil,
-                     "Title includes series name #{series}")
+            @log.add("ITU_3", nil, params: [series])
         end
       end
 
@@ -61,8 +58,7 @@ module Metanorma
         xmldoc.xpath("//preface/*").each do |c|
           extract_text(c).split(/\.\s+/).each do |t|
             /\b(shall|must)\b/i.match(t) and
-              @log.add("Style", c,
-                       "Requirement possibly in preface: #{t.strip}")
+              @log.add("ITU_4", c, params: [t.strip])
           end
         end
       end
@@ -71,35 +67,33 @@ module Metanorma
       # Supplanted by rendering
       def numbers_validate(xmldoc); end
 
-      def style_two_regex_not_prev(node, text, regex, regex_prev, warning)
-        text.nil? and return
-        arr = text.split(/\W+/)
-        arr.each_index do |i|
-          m_prev = i.zero? ? nil : regex_prev.match(arr[i - 1])
-          if !regex.match?(arr[i]) && m_prev.nil?
-            @log.add("Style", node, "#{warning}: #{m[:num]}")
-          end
-        end
-      end
+      #       def style_two_regex_not_prev(node, text, regex, regex_prev, warning)
+      #         text.nil? and return
+      #         arr = text.split(/\W+/)
+      #         arr.each_index do |i|
+      #           m_prev = i.zero? ? nil : regex_prev.match(arr[i - 1])
+      #           if !regex.match?(arr[i]) && m_prev.nil?
+      #             @log.add("Style", node, "#{warning}: #{m[:num]}")
+      #             # ID = ITU_5
+      #           end
+      #         end
+      #       end
 
       def approval_validate(xmldoc)
         s = xmldoc.at("//bibdata/ext/recommendationstatus/approvalstage") or
           return
         process = s["process"]
         (process == "aap") && %w(determined in-force).include?(s.text) and
-          @log.add("Document Attributes", nil,
-                   "Recommendation Status #{s.text} inconsistent with AAP")
+          @log.add("ITU_6", nil, params: [s.text])
         (process == "tap") && !%w(determined in-force).include?(s.text) and
-          @log.add("Document Attributes", nil,
-                   "Recommendation Status #{s.text} inconsistent with TAP")
+          @log.add("ITU_7", nil, params: [s.text])
       end
 
       def itu_identifier_validate(xmldoc)
         xmldoc.xpath("//bibdata/docidentifier[@type = 'ITU']").each do |x|
           /^SG \d+/.match?(x.text) ||
             /^ITU-[RTD] [AD-VX-Z]\.\d+(\.\d+)?$/.match?(x.text) or
-            @log.add("Style", nil, "#{x.text} does not match ITU document " \
-                                   "identifier conventions")
+            @log.add("ITU_8", nil, params: [x.text])
         end
       end
 
@@ -114,16 +108,16 @@ module Metanorma
           next if (@doctype == "resolution") && (c.parent.name == "sections") &&
             !c.at("./preceding-sibling::clause")
 
-          @log.add("Style", c, "Unnumbered clause out of place")
+          @log.add("ITU_9", c)
         end
       end
 
       # Editing Guidelines 7.2, 7.3
       def section_check(xmldoc)
         xmldoc.at("//bibdata/abstract") or
-          @log.add("Style", nil, "No Summary has been provided")
+          @log.add("ITU_10", nil)
         xmldoc.at("//bibdata/keyword") or
-          @log.add("Style", nil, "No Keywords have been provided")
+          @log.add("ITU_11", nil)
       end
 
       def termdef_style(xmldoc)
@@ -131,15 +125,15 @@ module Metanorma
           para = t.at("./definition/verbal-definition") || return
           term = t.at("./preferred//name").text
           termdef_warn(term, /^[A-Z][a-z]+/, t, term, "term is not lowercase")
-          termdef_warn(para.text, /^[a-z]/, t, term,
+          termdef_warn(para.text.strip, /^[a-z]/, t, term,
                        "term definition does not start with capital")
-          termdef_warn(para.text, /[^.]$/, t, term,
+          termdef_warn(para.text.strip, /[^.]\z/, t, term,
                        "term definition does not end with period")
         end
       end
 
       def termdef_warn(text, regex, node, term, msg)
-        regex.match(text) && @log.add("Style", node, "#{term}: #{msg}")
+        regex.match(text) && @log.add("ITU_12", node, params: [term, msg])
       end
     end
   end

data/lib/metanorma/itu/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Itu
-    VERSION = "2.7.6".freeze
+    VERSION = "2.8.0".freeze
   end
 end

data/lib/relaton/render/config.yml

@@ -1,3 +1,3 @@
 template:
   # skip authoritative identifier, it is inserted in front of formattedref within metanorma
-  standard: "<em>{{ title }}</em> ,_{{ edition | capitalize_first }} . {{ extent }}." 
+  standard: "<em>{{ title }}</em> ,_{{ edition | capitalize_first }} $$$ {{ extent }}" 

data/metanorma-itu.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 3.1.0"
+  spec.add_dependency "metanorma-standoc", "~> 3.2.0"
   spec.add_dependency "pubid"
   spec.add_dependency "twitter_cldr", ">= 3.0.0"
   spec.add_dependency "tzinfo-data" # we need this for windows only
@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "openssl"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "~> 1"
@@ -42,5 +43,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-itu
 version: !ruby/object:Gem::Version
-  version: 2.7.6
+  version: 2.8.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-29 00:00:00.000000000 Z
+date: 2025-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -16,14 +16,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: pubid
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -238,16 +252,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 ITU.
 
   '
@@ -336,6 +350,7 @@ files:
 - lib/metanorma/itu/front_id.rb
 - lib/metanorma/itu/isodoc.rng
 - lib/metanorma/itu/itu.rng
+- lib/metanorma/itu/log.rb
 - lib/metanorma/itu/processor.rb
 - lib/metanorma/itu/relaton-itu.rng
 - lib/metanorma/itu/reqt.rng