metanorma-ietf 3.5.7 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a7a8acefbf989aea665a8fbbb0e60447c921ee34527b9b1ba07526d281c35db
-  data.tar.gz: 5fdd90c1ad276336baf77616781b92bde24fa381752f6e8fc523f8d3a79d9c08
+  metadata.gz: 89f6ac422dac62904d909f6993446eb129be1d8c7e4de293efff0a00d7a214f6
+  data.tar.gz: 2e143432805fa1d7cd1cb206b7c7145b957771819ad222674583380923576104
 SHA512:
-  metadata.gz: 6e431686a4ed4fae904657b67f891c8dd1dc7f5ef1c33a1dbb04bc9d07b993801ab1b7d0423ff298d73ff4c2319393b9a0890d3d167177a70fcdee0289c80488
-  data.tar.gz: e9d77d069d55d1e36b98fa249e0e4ac8e0183a71c6fb53014626ccaa5a2a344d4b1952ef95c3f3bc4bad0160e6fe6bb10c602ef7f33b030e4b4701c11db8bcdf
+  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/front.rb

@@ -37,7 +37,7 @@ module IsoDoc
       end
 
       def seriesinfo(isoxml, front)
-        rfc_seriesinfo(isoxml, front) if @meta.get[:doctype] == "Rfc"
+        rfc_seriesinfo(isoxml, front) if @meta.get[:doctype] == "RFC"
         id_seriesinfo(isoxml, front) if @meta.get[:doctype] == "Internet Draft"
       end
 
@@ -55,8 +55,8 @@ module IsoDoc
         i = isoxml&.at(ns("//bibdata/series[@type = 'intended']")) and
           front.seriesInfo nil,
                            **attr_code(name: "",
-                                       status: i&.at(ns("./title"))&.text,
-                                       value: i&.at(ns("./number"))&.text || "")
+                                       status: i.at(ns("./title"))&.text,
+                                       value: i.at(ns("./number"))&.text || "")
       end
 
       def id_seriesinfo(isoxml, front)

data/lib/isodoc/ietf/metadata.rb

@@ -2,7 +2,7 @@ require "isodoc"
 
 module IsoDoc
   module Ietf
-    class  Metadata < IsoDoc::Metadata
+    class Metadata < IsoDoc::Metadata
       TITLE_RFC = "//bibdata//title[@type='main' and @language='en']".freeze
 
       def title(isoxml, _out)
@@ -47,7 +47,7 @@ module IsoDoc
 
       def doctype(isoxml, _out)
         super
-        set(:doctype, "Rfc") if get[:doctype].nil?
+        set(:doctype, "RFC") if get[:doctype].nil?
       end
     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/rfc_convert.rb

@@ -34,6 +34,7 @@ module IsoDoc
         @isodoc.reqt_models = Metanorma::Requirements
           .new({ default: "default", lang: @lang, script: @script,
                  locale: @locale, labels: @i18n.get })
+        populate_id(docxml)
         info docxml, nil
         @xrefs.parse docxml
         @isodoc.xrefs = @xrefs
@@ -46,12 +47,25 @@ module IsoDoc
         @xrefs.parse docxml
       end
 
+      def populate_id(docxml)
+        docxml.xpath("//*[@id]").each do |x|
+          x["semx-id"] = x["id"]
+          x["anchor"] and x["id"] = to_ncname(x["anchor"])
+        end
+      end
+
+      # do not sanitise "#"
+      def to_ncname(ident)
+        ret = ident.split("#", 2)
+        ret.map { |x| Metanorma::Utils::to_ncname(x) }.join("#")
+      end
+
       def metadata_init(lang, script, locale, i18n)
         @meta = Metadata.new(lang, script, locale, i18n)
       end
 
-      def xref_init(lang, script, klass, i18n, options)
-        @xrefs = Xref.new(lang, script, klass, i18n, options)
+      def xref_init(lang, script, _klass, i18n, options)
+        @xrefs = Xref.new(lang, script, self, i18n, options)
       end
 
       def extract_delims(text)

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

@@ -10,6 +10,16 @@ module Metanorma
         xmldoc
       end
 
+        # simplified
+      def boilerplate_isodoc(xmldoc)
+        x = xmldoc.dup
+        x.root.add_namespace(nil, xml_namespace)
+        #xml = Nokogiri::XML(x.to_xml)
+        @isodoc ||= isodoc(@lang, @script, @locale)
+        # initialise @isodoc.xrefs, for @isodoc.xrefs.info
+        @isodoc
+      end
+
       def dt_cleanup(xmldoc)
         xmldoc.xpath("//dt").each do |dt|
           /:$/.match?(dt.text.strip) and next
@@ -26,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/converter.rb

@@ -25,7 +25,6 @@ module Metanorma
       end
 
       def makexml(node)
-        @draft = node.attributes.has_key?("draft")
         @workgroups = cache_workgroup(node)
         @bcp_bold = !node.attr?("no-rfc-bold-bcp14")
         @xinclude = node.attr?("use-xinclude")

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.7".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

data/metanorma-ietf.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
 
   spec.add_dependency "metanorma-ietf-data"
-  spec.add_dependency "metanorma-standoc", "~> 3.0.0"
+  spec.add_dependency "metanorma-standoc", "~> 3.1.0"
   spec.add_dependency "relaton-render"
 
   spec.add_development_dependency "debug"
@@ -50,7 +50,6 @@ Gem::Specification.new do |spec|
 spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
-  spec.add_development_dependency "vcr", "~> 6.1.0"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "xml-c14n"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 3.5.7
+  version: 3.6.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-09 00:00:00.000000000 Z
+date: 2025-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-ietf-data
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: relaton-render
   requirement: !ruby/object:Gem::Requirement
@@ -192,20 +192,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement