metanorma-ietf 3.5.1 → 3.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da1665019f44fcc0eb18a283049b279819b7e185818f1f0722c7933c92a226aa
-  data.tar.gz: 4b4defd2a8b051c5174f3f45c93035b7eee50b812448863f42f8eb435f126b0f
+  metadata.gz: 378d773da5d48f1d408bdf1764876cf9000c4fbc7d3c91dbf30df1c5f50ffa06
+  data.tar.gz: 49055c291b27e058204ff5958cc4e31c8f56fecc2503b3417dbd3723869550fc
 SHA512:
-  metadata.gz: f80bd6987bc38d3dedd539c2573bfd458cdbb9911a03370f0e7a5bc40804076c6bb28e15fa970fe90473c7827aa8f29b77aec5d66ee6533da7a1d284cda4987e
-  data.tar.gz: 4caff92a476ea68f7a99112c808c6f09344a3f2f2e38f9dd56dfc462ae23f948cbedce37532f2f82e02b2fbf8c2e950b7bec2882ab5c09b903f4d201fb2a0183
+  metadata.gz: f4aea53f5e58916d5fd7282089d6eb52c16a48f643888d1e0c39a6f8312955cc1ffa0b8de2eff1fd4045ecffcea9bc8f73b98f92d703920473a91ce6485d1969
+  data.tar.gz: 5320a0b3bbfadbc20035596de82b6c9856c165219dc65e3de56709e60fcf510a6a826bdd0b91f5797c6bb23c6c6614c9e3649d3435fb9b2ce1aeceda78f62a0a

data/lib/isodoc/ietf/blocks.rb

@@ -164,7 +164,7 @@ module IsoDoc
 
       def review_note_parse(node, out)
         out.cref **attr_code(anchor: node["id"], display: node["display"],
-                             source: node["reviewer"]) do |c|
+                             source: node["reviewer"], from: node["from"]) do |c|
           if name = node.at(ns("./name"))
             name.children.each { |n| parse(n, c) }
             c << " "

data/lib/isodoc/ietf/cleanup.rb

@@ -12,8 +12,8 @@ module IsoDoc
         sourcecode_cleanup(docxml)
         li_cleanup(docxml)
         deflist_cleanup(docxml)
+        cref_cleanup(docxml) # feeds bookmark
         bookmark_cleanup(docxml)
-        cref_cleanup(docxml)
         front_cleanup(docxml)
         u_cleanup(docxml)
         biblio_cleanup(docxml) # feeds aside

data/lib/isodoc/ietf/cleanup_blocks.rb

@@ -110,14 +110,29 @@ module IsoDoc
         node.traverse do |n|
           n.text? and next
           %w(name callout annotation note sourcecode).include? n.name and next
-          case n.name
-          when "br" then n.replace("\n")
-          when "t" then n.replace("\n\n#{n.children}")
-          else n.replace(n.children)
-          end
+          sourcecode_remove_markup_elem(n)
+        end
+      end
+
+      def sourcecode_remove_markup_elem(node)
+        case node.name
+        when "br" then node.replace("\n")
+        when "t" then node.replace("\n\n#{node.children}")
+        when "eref"
+          node.replace(node.children.empty? ? node["target"] : node.children)
+        when "xref"
+          node.children.empty? ? sourcecode_xref(node) : node.replace(node.children)
+          # when "relref" then n.replace(n.children.empty? ? n["target"] : n.children)
+        else node.replace(node.children)
         end
       end
 
+      def sourcecode_xref(node)
+        ret = @xrefs.anchor(node["target"], :xref, false)&.gsub(%r{<[^>]+>}, "")
+        s = node["section"] and ret += ", Section #{s}"
+        node.replace(ret)
+      end
+
       def annotation_cleanup(docxml)
         docxml.xpath("//reference").each do |r|
           while r.next_element&.name == "aside"

data/lib/isodoc/ietf/cleanup_inline.rb

@@ -62,12 +62,28 @@ module IsoDoc
       end
 
       def cref_cleanup(docxml)
+        cref_move(docxml)
+        cref_unwrap(docxml)
+      end
+
+      # do not remove bookmarks until this is done,
+      # bookmarks can be cref destination
+      def cref_move(docxml)
+        docxml.xpath("//cref[@from]").each do |c|
+          dest = docxml.at("//*[@anchor = '#{c['from']}']")
+          t = dest.at(".//text()[not(ancestor::cref)]") and dest = t
+          c.delete("from")
+          c.delete("to")
+          dest.previous = c
+        end
+      end
+
+      def cref_unwrap(docxml)
         docxml.xpath("//cref").each do |c|
           c.xpath("./t").each do |t|
             t.replace(t.children)
           end
-          next unless %w(section abstract).include? c.parent.name
-
+          %w(section abstract).include? c.parent.name or next
           c.wrap("<t></t>")
         end
       end

data/lib/isodoc/ietf/rfc_convert.rb

@@ -37,6 +37,8 @@ module IsoDoc
         info docxml, nil
         @xrefs.parse docxml
         @isodoc.xrefs = @xrefs
+        @isodoc.bibrender = @isodoc.bibrenderer
+        @isodoc.reference_names(docxml)
         @isodoc.permission(docxml)
         @isodoc.requirement(docxml)
         @isodoc.recommendation(docxml)

data/lib/isodoc/ietf/section.rb

@@ -133,6 +133,7 @@ module IsoDoc
         out.back do |back|
           bibliography isoxml, back
           annex isoxml, back
+          comments isoxml, back
         end
       end
 
@@ -145,8 +146,7 @@ module IsoDoc
       end
 
       def clause_parse(node, out)
-        return if node.at(ns(".//references"))
-
+        node.at(ns(".//references")) and return
         out.section **attr_code(
           anchor: node["id"], numbered: node["numbered"],
           removeInRFC: node["removeInRFC"], toc: node["toc"]
@@ -162,9 +162,6 @@ module IsoDoc
         isoxml.xpath("//xmlns:preface/child::*" \
                      "[not(name() = 'abstract' or name() = 'foreword')] " \
                      "| //xmlns:sections/child::*").each do |c|
-          # cdup = c.dup
-          # cdup.xpath(ns(".//references")).each { |r| r.remove }
-          # cdup.at("./*[local-name() != 'title'][normalize-space(text()) != '']") or next
           clause_parse(c, out)
         end
       end
@@ -174,6 +171,12 @@ module IsoDoc
           clause_parse(c, out)
         end
       end
+
+      def comments(isoxml, out)
+        isoxml.xpath(ns("//review")).each do |c|
+          review_note_parse(c, out)
+        end
+      end
     end
   end
 end

data/lib/metanorma/ietf/basicdoc.rng

@@ -382,33 +382,7 @@ in a document (e.g. sourcecode annotations)</a:documentation>
     <a:documentation>Block intended to capture reviewer comments about some text in the document</a:documentation>
     <element name="review">
       <ref name="RequiredId"/>
-      <attribute name="reviewer">
-        <a:documentation>The party who has offered the comment</a:documentation>
-      </attribute>
-      <optional>
-        <attribute name="type">
-          <a:documentation>The type of reviewer comment</a:documentation>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="date">
-          <a:documentation>The date when the comment was made</a:documentation>
-          <data type="dateTime"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="from">
-          <a:documentation>Identifier for the start of the text or point in the text to which the comment applies.
-If not provided, the comment applies in the vicinity of the place it has been inserted into the text</a:documentation>
-          <data type="IDREF"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="to">
-          <a:documentation>Identifier for the end of the text to which the comment applies</a:documentation>
-          <data type="IDREF"/>
-        </attribute>
-      </optional>
+      <ref name="ReviewAttributes"/>
       <oneOrMore>
         <ref name="paragraph">
           <a:documentation>Reviewer comments content</a:documentation>
@@ -416,6 +390,35 @@ If not provided, the comment applies in the vicinity of the place it has been in
       </oneOrMore>
     </element>
   </define>
+  <define name="ReviewAttributes">
+    <attribute name="reviewer">
+      <a:documentation>The party who has offered the comment</a:documentation>
+    </attribute>
+    <optional>
+      <attribute name="type">
+        <a:documentation>The type of reviewer comment</a:documentation>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="date">
+        <a:documentation>The date when the comment was made</a:documentation>
+        <data type="dateTime"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="from">
+        <a:documentation>Identifier for the start of the text or point in the text to which the comment applies.
+If not provided, the comment applies in the vicinity of the place it has been inserted into the text</a:documentation>
+        <data type="IDREF"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="to">
+        <a:documentation>Identifier for the end of the text to which the comment applies</a:documentation>
+        <data type="IDREF"/>
+      </attribute>
+    </optional>
+  </define>
   <define name="NumberingAttributes">
     <optional>
       <attribute name="unnumbered">
@@ -857,6 +860,7 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
   <define name="tr">
     <a:documentation>Sequence of cells to be displayed as a row in a table</a:documentation>
     <element name="tr">
+      <ref name="TrAttributes"/>
       <oneOrMore>
         <choice>
           <ref name="td">
@@ -869,6 +873,9 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
       </oneOrMore>
     </element>
   </define>
+  <define name="TrAttributes">
+    <empty/>
+  </define>
   <define name="tr-no-id">
     <a:documentation>Sequence of cells to be displayed as a row in a table: optional ID attributes recursively (for use in Relaton, metadata)</a:documentation>
     <element name="tr">

data/lib/metanorma/ietf/cleanup.rb

@@ -6,9 +6,17 @@ module Metanorma
         abstract_cleanup(xmldoc)
         super
         cref_cleanup(xmldoc)
+        dt_cleanup(xmldoc)
         xmldoc
       end
 
+      def dt_cleanup(xmldoc)
+        xmldoc.xpath("//dt").each do |dt|
+          /:$/.match?(dt.text.strip) and next
+          dt << ":"
+        end
+      end
+
       def abstract_cleanup(xmldoc)
         xmldoc.xpath("//abstract[not(text())]").each do |x|
           x.remove
@@ -19,7 +27,10 @@ module Metanorma
       def cref_cleanup(xmldoc)
         xmldoc.xpath("//crefref").each do |r|
           if c = xmldoc.at("//review[@id = '#{r.text}']")
-            r.replace(c.remove)
+            id = "_#{UUIDTools::UUID.random_create}"
+            c["from"] = id
+            c["to"] = id
+            r.replace("<bookmark id='#{id}'/>")
           else
             @log.add("Crossrefences", r,
                      "No matching review for cref:[#{r.text}]", severity: 1)
@@ -43,8 +54,7 @@ module Metanorma
 
       def smartquotes_cleanup(xmldoc)
         xmldoc.traverse do |n|
-          next unless n.text?
-
+          n.text? or next
           n.replace(HTMLEntities.new.encode(
                       n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'")
                       .gsub(/\u201c|\u201d|\u201e|\u201f/, '"')
@@ -85,6 +95,7 @@ module Metanorma
       def section_names_refs_cleanup(xml); end
 
       def note_cleanup(xmldoc); end
+
     end
   end
 end

data/lib/metanorma/ietf/isodoc.rng

@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v2.0.0 -->
+<!-- VERSION v2.0.2 -->
 <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">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
@@ -33,6 +33,15 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="fn" combine="interleave">
+      <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"/>
+        </attribute>
+      </optional>
+    </define>
     <define name="index-primary">
       <element name="primary">
         <oneOrMore>
@@ -414,6 +423,21 @@ normative or informative references, some split references into sections organiz
         </oneOrMore>
       </choice>
     </define>
+    <define name="TdAttributes" combine="interleave">
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </define>
+    <define name="ThAttributes" combine="interleave">
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </define>
+    <define name="TrAttributes">
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </define>
     <define name="table-note">
       <element name="note">
         <ref name="OptionalId"/>
@@ -1263,6 +1287,11 @@ numbers</a:documentation>
           <a:documentation>Colophon or postface material</a:documentation>
         </ref>
       </optional>
+      <optional>
+        <ref name="review-container">
+          <a:documentation>Annotations to the document</a:documentation>
+        </ref>
+      </optional>
     </element>
   </define>
   <define name="misccontainer">
@@ -1273,6 +1302,13 @@ numbers</a:documentation>
       </oneOrMore>
     </element>
   </define>
+  <define name="review-container">
+    <element name="review-container">
+      <oneOrMore>
+        <ref name="review"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="preface">
     <element name="preface">
       <oneOrMore>

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.5.1".freeze
+    VERSION = "3.5.3".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.5.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-ietf-data