metanorma-ietf 3.6.3 → 3.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f6e4443d3285113f0feed7ef1361e5d4b66658596fedf93dac1202fbb726c7e
-  data.tar.gz: 3c789caaf85f315377767b52a2f473dc91869f6b180b5dd72d0924bbed7fd777
+  metadata.gz: cb5758828f2f98a205b8195c990f58e1bf21bd90f8031df7d71a3757588952cc
+  data.tar.gz: f8dec2d352999ed8a0524c61a1850385987a03c7addd5648d1ff8886e4aae4c9
 SHA512:
-  metadata.gz: 327449e74a50a023b69472a9e25bd8dd9b6b796ea13b8f97f555bee6d88c4f28a937600bdd7f3628acbff6ae8a56bb8dc17638ec6699dcf20f219da7a142d9f9
-  data.tar.gz: c1edfb038d079c034ce052f0b747dd3182c5361c5718904ad3083074016ae4c0eef3df2d9d9a56fe0d08a125448e090f540703a2ae830b3b9d2ceaad459f71e5
+  metadata.gz: ef4ca63eaaee7f005f29a8e318ed527a71fca533e6f8ede4da6ff4e1bb66331ded6bc90640ea133e061093ef7440f915753173563f9d7e606df85d7d6c37c1a6
+  data.tar.gz: 59e80f4b00c89ceb6b70364abea4e0b26d1f40a59bf0d222f283667da93674ce6bbd8f6b127e0e9b0852656809464ac2cd9b53065438a677f5045fb291ac6e57

data/lib/isodoc/ietf/cleanup.rb

@@ -99,7 +99,12 @@ module IsoDoc
       end
 
       def front_cleanup(xmldoc)
-        xmldoc.xpath("//title").each { |s| s.children = s.text }
+        xmldoc.xpath("//title").each do |s|
+          s.xpath(".//eref[normalize-space(.)='']").each do |e|
+            e.replace(e["target"])
+          end
+          s.children = s.text
+        end
         xmldoc.xpath("//reference/front[not(author)]").each do |f|
           insert = f.at("./seriesInfo[last()]") || f.at("./title")
           insert.next = "<author surname='Unknown'/>"

data/lib/isodoc/ietf/front.rb

@@ -72,7 +72,8 @@ module IsoDoc
         isoxml.xpath("//xmlns:bibdata/xmlns:contributor[xmlns:role/@type = " \
           "'author' or xmlns:role/@type = 'editor']").each do |c|
           role = c.at(ns("./role/@type")).text == "editor" ? "editor" : nil
-          (c.at("./organization") and org_author(c, role, front)) or
+                c.at(ns("./organization/subdivision[@type = 'Workgroup']")) and next
+          (c.at(ns("./organization")) and org_author(c, role, front)) or
             person_author(c, role, front)
         end
       end
@@ -104,7 +105,7 @@ module IsoDoc
         front.author **attrs do |a|
           org = contrib.at(ns("./person/affiliation/organization")) and
             organization(org, a, contrib.document.at(ns("//showOnFrontPage")))
-          address(contrib.xpath(ns(".//address")),
+          address(contrib.at(ns(".//address")),
                   contrib.at(ns(".//phone[not(@type = 'fax')]")),
                   contrib.at(ns(".//phone[@type = 'fax']")),
                   contrib.xpath(ns(".//email")), contrib.at(ns(".//uri")), a)
@@ -126,13 +127,13 @@ module IsoDoc
         name = org.at(ns("./name"))&.text
         out.organization name, **attr_code(
           showOnFrontPage: show&.text, ascii: output_if_translit(name),
-          asciiAbbrev: output_if_translit(org.at(ns("./abbreviation"))),
+          asciiAbbrev: output_if_translit(org.at(ns("./abbreviation"))&.text),
           abbrev: org.at(ns("./abbreviation"))
         )
       end
 
       def address(addr, phone, fax, email, uri, out)
-        return unless addr || phone || fax || email || uri
+        return unless addr || phone || fax || !email.empty? || uri
 
         out.address do |a|
           addr and postal(addr, a)

data/lib/isodoc/ietf/inline.rb

@@ -162,6 +162,7 @@ module IsoDoc
         ) or return ""
         ret.gsub(%r{</?span[^>]*>}, "").sub(/^,/, "")
           .sub(/^\s*(Sections?|Clauses?)/, "").strip.sub(/,$/, "")
+          .gsub(/\s+/, " ")
       end
 
       def semx_origin_parse(node, out)

data/lib/isodoc/ietf/metadata.rb

@@ -29,7 +29,8 @@ module IsoDoc
 
       def docid(isoxml, _out)
         dn = isoxml.at(ns("//bibdata/docnumber"))
-        set(:docnumber, dn&.text&.sub(/^rfc-/, "")&.sub(/\.[a-z0-9]+$/i, ""))
+        set(:docnumber, dn&.text&.strip&.sub(/^rfc-/, "")
+          &.sub(/\.[a-z0-9]+$/i, ""))
       end
 
       def author(xml, _out)
@@ -39,7 +40,8 @@ module IsoDoc
 
       def wg(xml)
         workgroups = []
-        xml.xpath(ns("//bibdata/ext/editorialgroup/workgroup")).each do |wg|
+        xml.xpath(ns("//bibdata/contributor[role/description = 'committee']/" \
+          "organization/subdivision[@type = 'Workgroup']/name")).each do |wg|
           workgroups << wg.text
         end
         set(:wg, workgroups)

data/lib/isodoc/ietf/references.rb

@@ -29,9 +29,7 @@ module IsoDoc
 
       def bibliography1(node, out)
         out.references **attr_code(anchor: node["id"]) do |div|
-          title = node.at(ns("./title")) and div.name do |name|
-            title.children.each { |n| parse(n, name) }
-          end
+          bibliography1_title(node, div)
           node.elements.select do |e|
             %w(references clause).include? e.name
           end.each { |e| bibliography1(e, out) }
@@ -42,6 +40,12 @@ module IsoDoc
         end
       end
 
+      def bibliography1_title(node, div)
+        title = node.at(ns("./title")) and div.name do |name|
+          title.children.each { |n| parse(n, name) }
+        end
+      end
+
       def biblio_list(node, div, _biblio)
         i = 0
         node.xpath(ns("./bibitem | ./note")).each do |b|
@@ -66,15 +70,23 @@ module IsoDoc
       end
 
       def bibitem_render(ref, bib)
+        bib1 = bibitem_render_prep(bib)
+        if (f = bib1.at(ns("./formattedref"))) && !bib1.at(ns("./title"))
+          ref.front do |front|
+            front.title do |t|
+              children_parse(f, t)
+            end
+          end
+        else
+          ref << @bibrenderer.render(bib1.to_xml, embedded: true)
+        end
+      end
+
+      def bibitem_render_prep(bib)
         bib1 = bib.clone
         @isodoc.prep_for_rendering(bib1)
         bib1.namespace = nil
-        ret = @bibrenderer.render(bib1.to_xml, embedded: true)
-        ref << if bib1.at(ns("./formattedref")) && !bib1.at(ns("./title"))
-                 "<front><title>#{ret}</title></front>"
-               else
-                 ret
-               end
+        bib1
       end
     end
   end

data/lib/isodoc/ietf/rfc_convert.rb

@@ -127,6 +127,9 @@ module IsoDoc
         @isodoc.i18n_init("en", "Latn", nil, nil)
       end
 
+      def bibdata(docxml)
+      end
+
       include ::IsoDoc::Ietf::Init
     end
   end

data/lib/metanorma/ietf/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/ietf/cleanup.rb

@@ -10,7 +10,6 @@ module Metanorma
         xmldoc
       end
 
-        # simplified
       def boilerplate_isodoc(xmldoc)
         x = xmldoc.dup
         x.root.add_namespace(nil, xml_namespace)

data/lib/metanorma/ietf/converter.rb

@@ -121,7 +121,7 @@ module Metanorma
         [t, rel]
       end
 
-      def norm_ref_preface(sect); end
+      def norm_ref_preface(sect, isodoc); end
 
       def clause_attrs_preprocess(attrs, node)
         attrs[:numbered] = node.attr("numbered")

data/lib/metanorma/ietf/front.rb

@@ -36,19 +36,11 @@ module Metanorma
           end
       end
 
-      def title(node, xml)
-        ["en"].each do |lang|
-          at = { language: lang, format: "text/plain" }
-          xml.title **attr_code(at.merge(type: "main")) do |t|
-            t << (::Metanorma::Utils::asciidoc_sub(node.attr("title")) ||
-              ::Metanorma::Utils::asciidoc_sub(node.attr("title-en")) ||
-              ::Metanorma::Utils::asciidoc_sub(node.attr("doctitle")))
-          end
-          a = node.attr("abbrev") and
-            xml.title a, **attr_code(at.merge(type: "abbrev"))
-          a = node.attr("asciititle") and
-            xml.title a, **attr_code(at.merge(type: "ascii"))
-        end
+      def title_other(node, xml)
+        a = node.attr("abbrev") and
+          add_title_xml(xml, a, "en", "abbrev")
+        a = node.attr("asciititle") and
+          add_title_xml(xml, a, "en", "ascii")
       end
 
       def metadata_committee(node, xml)

data/lib/metanorma/ietf/ietf.rng

@@ -259,11 +259,11 @@
         <ref name="index-tertiary"/>
       </element>
     </define>
-    <define name="TextElement" combine="choice">
-      <ref name="review"/>
-    </define>
   </include>
   <!-- end overrides -->
+  <define name="TextElement" combine="choice">
+    <ref name="review"/>
+  </define>
   <define name="ReviewAttributes" combine="interleave">
     <optional>
       <attribute name="display"/>

data/lib/metanorma/ietf/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.2 -->
+<!-- VERSION v2.1.3 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -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">
@@ -455,14 +477,7 @@ normative or informative references, some split references into sections organiz
           </ref>
         </zeroOrMore>
         <zeroOrMore>
-          <ref name="doc_bibitem">
-            <a:documentation>Bibliographic item cited in the document</a:documentation>
-          </ref>
-          <zeroOrMore>
-            <ref name="note">
-              <a:documentation>Annotation of the bibliographic item</a:documentation>
-            </ref>
-          </zeroOrMore>
+          <ref name="ReferenceEntry"/>
         </zeroOrMore>
         <zeroOrMore>
           <ref name="references">
@@ -604,18 +619,21 @@ gives an explicit page orientation</a:documentation>
         </element>
       </optional>
     </define>
-  </include>
-  <!-- end overrides -->
-  <define name="FnAttributes" combine="interleave">
-    <ref name="RequiredId"/>
-    <optional>
-      <attribute name="hiddenref">
-        <a:documentation>If true, number the footnote as normal, but suppress display of the footnote reference in the document body.
+    <define name="FnAttributes">
+      <ref name="RequiredId"/>
+      <optional>
+        <attribute name="hiddenref">
+          <a:documentation>If true, number the footnote as normal, but suppress display of the footnote reference in the document body.
 This is done if the footnote reference is already presented in some other form, e.g. within a figure image.</a:documentation>
-        <data type="boolean"/>
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <attribute name="reference">
+        <a:documentation>The number of the footnote, used to identify it visually</a:documentation>
       </attribute>
-    </optional>
-  </define>
+    </define>
+  </include>
+  <!-- end overrides -->
   <define name="TdAttributes" combine="interleave">
     <ref name="RequiredId"/>
     <optional>
@@ -853,6 +871,17 @@ titlecase, or lowercase</a:documentation>
       <value>informative</value>
     </choice>
   </define>
+  <define name="ReferenceEntry">
+    <a:documentation>Entry in bibliography</a:documentation>
+    <ref name="doc_bibitem">
+      <a:documentation>Bibliographic item cited in the document</a:documentation>
+    </ref>
+    <zeroOrMore>
+      <ref name="note">
+        <a:documentation>Annotation of the bibliographic item</a:documentation>
+      </ref>
+    </zeroOrMore>
+  </define>
   <define name="doc_bibitem">
     <a:documentation>Standardisation document representation of bibliographic entry</a:documentation>
     <element name="bibitem">
@@ -869,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/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.6.3".freeze
+    VERSION = "3.6.5".freeze
   end
 end

data/lib/relaton/render/config.yml

@@ -20,7 +20,7 @@ template:
   # skip standardidentifier, it is inserted in front of formattedref within metanorma
   # date is cleaned up into RFC XML formatting afterwards
   # ref-included is cleaned up as referencegroup/reference in RFC XML afterwards
-  standard: "{% if stream %}<stream>{{stream}}</stream>{% endif %} <front> <title>{{ title }}</title> {{ creatornames }} <date_cleanme='true'>{{date}}</date> {% for k in keywords %}<keyword>{{k}}</keyword>{%endfor%} <abstract_cleanme='true'>{{abstract}}</abstract> </front> {{ series }} {%for d in doi %}<seriesInfo_value='{{ d | replace: ' ', ' ' | remove_first: 'DOI' | strip }}'_name='DOI'/>{% endfor %}  {% if home_standard %}{% for j in authoritative_identifier %} <seriesInfo_value='{{ j | replace: ' ', ' ' | strip | split: ' ' | last | remove_first: 'I-D.'}}'_name='{%if j contains 'I-D.'%}Internet-Draft{% else %}{{ j | replace: ' ', ' ' | strip | split: ' ' | slice: -2 }}{%endif%}'/> {% endfor %} {% else %} <refcontent>{{authoritative_identifier | join: ', '}}</refcontent> {% endif %} {% for i in included %}<ref-included target='{{ i.uris[0].content }}'> {% if i.stream %}<stream>{{i.stream}}</stream>{% endif %} <front> <title>{% if i.title %}{{ i.title}}{%else%}[TITLE]{%endif%}</title> {% if i.creatornames %}{{ i.creatornames }}{%else%}<author></author>{%endif%} <date_cleanme='true'>{{i.date}}</date> {% for k in i.keywords %}<keyword>{{k}}</keyword>{%endfor%} <abstract_cleanme='true'>{{i.abstract}}</abstract> </front> {{ series }} {%for d in i.doi %}<seriesInfo_value='{{ d | replace: ' ', ' ' | remove_first: 'DOI' | strip }}'_name='DOI'/>{% endfor %}  {% if home_standard %}{% for j in i.authoritative_identifier %} <seriesInfo_value='{{ j | replace: ' ', ' ' | strip | split: ' ' | last | remove_first: 'I-D.'}}'_name='{%if j contains 'I-D.'%}Internet-Draft{% else %}{{ j | replace: ' ', ' ' | strip | split: ' ' | slice: -2 }}{%endif%}'/> {% endfor %} {% else %} <refcontent>{{i.authoritative_identifier | join: ', '}}</refcontent> {% endif %}</ref-included>{% endfor %}"
+  standard: "{% if stream %}<stream>{{stream}}</stream>{% endif %} <front> <title>{{ title }}</title> {{ creatornames }} <date_cleanme='true'>{{date}}</date> {% for k in keywords %}<keyword>{{k}}</keyword>{%endfor%} <abstract_cleanme='true'>{{abstract}}</abstract> </front> {{ series }} {%for d in doi %}<seriesInfo_value='{{ d | replace: ' ', ' ' | remove_first: 'DOI' | replace: '<esc> ': '<esc>' | replace: ' </esc>' : '</esc>' }}'_name='DOI'/>{% endfor %}  {% if home_standard %}{% for j in authoritative_identifier %} <seriesInfo_value='{{ j | replace: ' ', ' '  | replace: '<esc> ': '<esc>' | replace: ' </esc>' : '</esc>' | split: ' ' | last | remove_first: 'I-D.'}}'_name='{%if j contains 'I-D.'%}Internet-Draft{% else %}{{ j | replace: ' ', ' '  | replace: '<esc> ': '<esc>' | replace: ' </esc>' : '</esc>' | split: ' ' | slice: -2 }}{%endif%}'/> {% endfor %} {% else %} <refcontent>{{authoritative_identifier | join: ', '}}</refcontent> {% endif %} {% for i in included %}<ref-included target='{{ i.uris[0].content }}'> {% if i.stream %}<stream>{{i.stream}}</stream>{% endif %} <front> <title>{% if i.title %}{{ i.title}}{%else%}[TITLE]{%endif%}</title> {% if i.creatornames %}{{ i.creatornames }}{%else%}<author></author>{%endif%} <date_cleanme='true'>{{i.date}}</date> {% for k in i.keywords %}<keyword>{{k}}</keyword>{%endfor%} <abstract_cleanme='true'>{{i.abstract}}</abstract> </front> {{ series }} {%for d in i.doi %}<seriesInfo_value='{{ d | replace: ' ', ' ' | remove_first: 'DOI'  | replace: '<esc> ': '<esc>' | replace: ' </esc>' : '</esc>' }}'_name='DOI'/>{% endfor %}  {% if home_standard %}{% for j in i.authoritative_identifier %} <seriesInfo_value='{{ j | replace: ' ', ' ' |  replace: '<esc> ': '<esc>' | replace: ' </esc>' : '</esc>' | split: ' ' | last | remove_first: 'I-D.'}}'_name='{%if j contains 'I-D.'%}Internet-Draft{% else %}{{ j | replace: ' ', ' ' |  replace: '<esc> ': '<esc>' | replace: ' </esc>' : '</esc>' | split: ' ' | slice: -2 }}{%endif%}'/> {% endfor %} {% else %} <refcontent>{{i.authoritative_identifier | join: ', '}}</refcontent> {% endif %}</ref-included>{% endfor %}"
   website: standard
   book: standard
   booklet: standard

data/lib/relaton/render/parse.rb

@@ -99,7 +99,7 @@ module Relaton
             %w(BCP STD).include?(s.title.title.content)
           end
           bcp and ret.unshift("BCP #{bcp.number}")
-          ret.reject { |x| /^(rfc-anchor|Internet-Draft)/.match? (x) }
+          ret.reject { |x| /(rfc-anchor|Internet-Draft)/.match? (x) }
         end
 
         def simple_xml2hash(doc)

data/metanorma-ietf.gemspec

@@ -51,5 +51,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-ietf
 version: !ruby/object:Gem::Version
-  version: 3.6.3
+  version: 3.6.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-01 00:00:00.000000000 Z
+date: 2025-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-ietf-data
@@ -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-ietf lets you write IETF documents, such as Internet-Drafts and RFCs,
   in native AsciiDoc syntax. This is part of the Metanorma publishing framework.