metanorma-ietf 3.5.8 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe59c2573e7cb80e26151e058ec1ddaec137ae0627f53aca32cea593f2a88a6e
-  data.tar.gz: 98f4553275189beb41e4d0f71daf1070163ec210f7050bdf4c8fda7b0f5a9bbf
+  metadata.gz: 89f6ac422dac62904d909f6993446eb129be1d8c7e4de293efff0a00d7a214f6
+  data.tar.gz: 2e143432805fa1d7cd1cb206b7c7145b957771819ad222674583380923576104
 SHA512:
-  metadata.gz: c56521d03c6c45c07e7cbfa977e7d87252825ccee610a7c4525398abe2f73ec3d64e4b3c28bf750c5058b0b4a6ae894a1c24238aad5328821265d4ebf0e1182b
-  data.tar.gz: 7d290b56d4ab6214181ff5c718e0eaafe8a199b9d5871a49cb17b260dd6ca02a7ed3b09d1aa110b8eba23154dfe6c9b4f1c237f81b75da3280c5367eb4a114db
+  metadata.gz: 990260a7fbc5f14ee4df3d5b354fc2f4e5cf7f5e2ab5192350cf2fec94da5bef65a506726eda678faf76f54381e0344d9f9d4ebdafe9557379193c15c23caa2d
+  data.tar.gz: f95f99fc706252db1900bd701a13d6f95903db3340b764e67728a88e4549efd4b80222769ea88c04852b8eda19732a306f76591bd6bb308c71f5550545b78949

data/lib/isodoc/ietf/blocks.rb

@@ -83,10 +83,10 @@ module IsoDoc
 
       def annotation_parse(node, out)
         @sourcecode = false
-        node.at(ns("./annotation")) or return
+        node.at(ns("./callout-annotation")) or return
         out.t { |p| p << @i18n.key }
         out.dl do |dl|
-          node.xpath(ns("./annotation")).each do |a|
+          node.xpath(ns("./callout-annotation")).each do |a|
             annotation_parse1(a, dl)
           end
         end
@@ -162,7 +162,14 @@ module IsoDoc
         end
       end
 
+      def render_annotations?(node)
+        node.at(ns("//presentation-metadata/render-document-annotations"))
+          &.text == "true" ||
+          node.at(ns("//bibdata/ext/notedraftinprogress"))
+      end
+
       def review_note_parse(node, out)
+        render_annotations?(node) or return
         out.cref **attr_code(anchor: node["id"], display: node["display"],
                              source: node["reviewer"], from: node["from"]) do |c|
           if name = node.at(ns("./name"))

data/lib/isodoc/ietf/cleanup_blocks.rb

@@ -109,7 +109,7 @@ module IsoDoc
       def sourcecode_remove_markup(node)
         node.traverse do |n|
           n.text? and next
-          %w(name callout annotation note sourcecode).include? n.name and next
+          %w(name callout callout-annotation note sourcecode).include? n.name and next
           sourcecode_remove_markup_elem(n)
         end
       end

data/lib/isodoc/ietf/reqt.rb

@@ -3,7 +3,7 @@ module IsoDoc
     class RfcConvert < ::IsoDoc::Convert
       def recommendation_name(node, out)
         out.t **{ keepWithNext: "true" } do |p|
-          node.children.each { |n| parse(n, p) }
+          node.children&.each { |n| parse(n, p) }
         end
       end
 

data/lib/isodoc/ietf/section.rb

@@ -173,7 +173,7 @@ module IsoDoc
       end
 
       def comments(isoxml, out)
-        isoxml.xpath(ns("//review")).each do |c|
+        isoxml.xpath(ns("//annotation")).each do |c|
           review_note_parse(c, out)
         end
       end

data/lib/metanorma/ietf/blocks.rb

@@ -38,14 +38,13 @@ module Metanorma
                   ))
       end
 
-      def todo_attrs(node)
+      def sidebar_attrs(node)
         super.merge(attr_code(display: node.attr("display")))
       end
 
       def sidebar(node)
-        draft? or return
         noko do |xml|
-          xml.review **sidebar_attrs(node) do |r|
+          xml.annotation **sidebar_attrs(node) do |r|
             block_title(node, r)
             wrap_in_para(node, r)
           end

data/lib/metanorma/ietf/cleanup.rb

@@ -36,14 +36,14 @@ module Metanorma
 
       def cref_cleanup(xmldoc)
         xmldoc.xpath("//crefref").each do |r|
-          if c = xmldoc.at("//review[@anchor = '#{r.text}']")
+          if c = xmldoc.at("//annotation[@anchor = '#{r.text}']")
             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)
+                     "No matching annotation for cref:[#{r.text}]", severity: 1)
           end
         end
       end

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.0.7 -->
+<!-- VERSION v2.0.8 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -72,6 +72,46 @@ but to `@anchor`, the user-supplied cross-reference</a:documentation>
         </oneOrMore>
       </element>
     </define>
+    <define name="review">
+      <a:documentation>Generalise BasicDoc element from just review comments, to general annotations;
+the type attribute defaults to `review` for reviews</a:documentation>
+      <element name="annotation">
+        <ref name="RequiredId"/>
+        <ref name="ReviewAttributes"/>
+        <oneOrMore>
+          <ref name="paragraph">
+            <a:documentation>Reviewer comments content</a:documentation>
+          </ref>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="ruby_pronunciation">
+      <a:documentation>Ruby annotation giving pronunciation of text: change tag from BasicDoc for disambiguation</a:documentation>
+      <element name="ruby-pronunciation">
+        <attribute name="value">
+          <a:documentation>Ruby annotation value</a:documentation>
+        </attribute>
+        <ref name="LocalizedStringAttributes"/>
+      </element>
+    </define>
+    <define name="ruby_annotation">
+      <a:documentation>Ruby annotation giving information other than pronunciation of text: change tag from BasicDoc for disambiguation</a:documentation>
+      <element name="ruby-annotation">
+        <attribute name="value">
+          <a:documentation>Ruby annotation value</a:documentation>
+        </attribute>
+        <ref name="LocalizedStringAttributes"/>
+      </element>
+    </define>
+    <define name="annotation">
+      <a:documentation>Source code annotation, corresponding to a callout</a:documentation>
+      <element name="callout-annotation">
+        <ref name="RequiredId"/>
+        <oneOrMore>
+          <ref name="paragraph"/>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="section-title">
       <a:documentation>Title(s) of a clause</a:documentation>
       <element name="title">
@@ -540,7 +580,7 @@ normative or informative references, some split references into sections organiz
       <ref name="OptionalId"/>
       <optional>
         <attribute name="style">
-          <a:documentation>CSS style: only background-color supported</a:documentation>
+          <a:documentation>CSS style: only background-color, color, border supported</a:documentation>
         </attribute>
       </optional>
     </define>
@@ -620,7 +660,7 @@ This is done if the footnote reference is already presented in some other form,
     <ref name="RequiredId"/>
     <optional>
       <attribute name="style">
-        <a:documentation>CSS style: only background-color supported</a:documentation>
+        <a:documentation>CSS style: only background-color, color, border supported</a:documentation>
       </attribute>
     </optional>
   </define>
@@ -700,6 +740,11 @@ titlecase, or lowercase</a:documentation>
         <a:documentation>Width of the table block in rendering</a:documentation>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color, color, border supported</a:documentation>
+      </attribute>
+    </optional>
     <ref name="BlockAttributes"/>
   </define>
   <define name="FigureAttributes" combine="interleave">
@@ -1417,7 +1462,7 @@ numbers</a:documentation>
       </optional>
       <ref name="DocumentBody"/>
       <optional>
-        <ref name="review-container">
+        <ref name="annotation-container">
           <a:documentation>Annotations to the document</a:documentation>
         </ref>
       </optional>
@@ -1461,8 +1506,8 @@ numbers</a:documentation>
       </oneOrMore>
     </element>
   </define>
-  <define name="review-container">
-    <element name="review-container">
+  <define name="annotation-container">
+    <element name="annotation-container">
       <oneOrMore>
         <ref name="review"/>
       </oneOrMore>

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.5.8".freeze
+    VERSION = "3.6.0".freeze
   end
 end

data/lib/relaton/render/template.rb

@@ -17,10 +17,10 @@ module Relaton
     module Ietf
       module Template
         class Name < ::Relaton::Render::Template::Name
-          def customise_liquid
-            super
-            ::Liquid::Template
-              .register_filter(::Relaton::Render::Template::Ascii)
+          def create_liquid_environment
+            env = super
+            env.register_filter(::Relaton::Render::Template::Ascii)
+            env
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 3.5.8
+  version: 3.6.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-23 00:00:00.000000000 Z
+date: 2025-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-ietf-data