metanorma-ietf 3.7.4 → 3.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9018d538b7886bc97f2c3731b238f8b4a88dd0646c08e1739258d32186105b82
-  data.tar.gz: fb88d10ea69d84882a7b140f542ae32db359fff6e47e5e62783f00d01a1d1910
+  metadata.gz: 917f45dcbf37bfa5362c83d3688f63f8bbf907a9452ba3167690f0a0be23e0fd
+  data.tar.gz: d38e9efce5c27e09faf6121a67eae5f563e9379fad2eaf99b2162698b1bfd8ba
 SHA512:
-  metadata.gz: a832ec2d1cca05799e44d8ea28398796eff7e27b2a8b0245f9f1a12b08d82091ba215b4562efdfa8b47ba1db8c840485569407f7622d313a450a9f725dbf11b2
-  data.tar.gz: 3ef307ca1189c5ae89be6adbbc2cd040e142220e773d112b81d8bb16411cbf33b0778364d1a17b483c618001373f0338bb80c018aee6594bfc44ae45e349130f
+  metadata.gz: 18d1ef2932fb94013492fff0ee29c3247ec1467b1cfc093eb8a40b428ec2d29958a21da6c2a34cbab738d42ff1406da0be758d6eea04cb1ff77f88b7f8cacaee
+  data.tar.gz: ae477686b0e71cb42b6eed87a91c3cb1205562cfcd477d7d5ec132f4380bdc6ddbadb5d501d6fe98606c172199eb916ea47addd8ed8695aabb0d76140be7bf5e

data/.rubocop.yml

@@ -1,10 +1,22 @@
 # Auto-generated by Cimas: Do not edit it manually!
 # See https://github.com/metanorma/cimas
 inherit_from:
-  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+
+# Rubocop plugins enabled centrally so every metanorma-org gem picks them up
+# on cimas sync — best practice belongs at the shared-template layer, not
+# per-repo. Per ronaldtse feedback on metanorma/ci#332.
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
 
 # local repo-specific modifications
 # ...
 
 AllCops:
-  TargetRubyVersion: 2.5
+  # 3.3 matches the org-wide minimum being pushed via #274 (Raise minimum
+  # Ruby version to 3.3 due to EOL of 3.2 on 2026-03-31). Was 3.4 before
+  # this commit — 3.4 was above the org's stated minimum and would have
+  # applied Rubocop rules that fail-close on gems still targeting 3.3.
+  TargetRubyVersion: 3.3

data/lib/isodoc/ietf/init.rb

@@ -12,6 +12,10 @@ module IsoDoc
       def fileloc(loc)
         File.join(File.dirname(__FILE__), loc)
       end
+
+      def presentation_xml_converter
+        ::IsoDoc::PresentationXMLConvert.new(language: @lang, script: @script)
+      end
     end
   end
 end

data/lib/isodoc/ietf/rfc_convert.rb

@@ -1,18 +1,18 @@
-require_relative "./terms"
-require_relative "./blocks"
-require_relative "./lists"
-require_relative "./metadata"
-require_relative "./front"
-require_relative "./table"
-require_relative "./inline"
-require_relative "./reqt"
-require_relative "./cleanup"
-require_relative "./footnotes"
-require_relative "./references"
-require_relative "./section"
-require_relative "./validation"
-require_relative "./xref"
-require_relative "./init"
+require_relative "terms"
+require_relative "blocks"
+require_relative "lists"
+require_relative "metadata"
+require_relative "front"
+require_relative "table"
+require_relative "inline"
+require_relative "reqt"
+require_relative "cleanup"
+require_relative "footnotes"
+require_relative "references"
+require_relative "section"
+require_relative "validation"
+require_relative "xref"
+require_relative "init"
 
 module IsoDoc
   module Ietf
@@ -32,10 +32,11 @@ module IsoDoc
 
       def document_preprocess(docxml)
         @isodoc.reqt_models = Metanorma::Requirements
-          .new({ default: "default", lang: @lang, script: @script,
-                 locale: @locale, labels: @i18n.get })
+          .new({ conv: @isodoc, default: "default", lang: @lang,
+                 script: @script, locale: @locale, labels: @i18n.get })
         populate_id(docxml)
         info docxml, nil
+        @xrefs.reqt_models = @isodoc.reqt_models
         @xrefs.parse docxml
         @isodoc.xrefs = @xrefs
         @isodoc.bibrender = @isodoc.bibrenderer
@@ -88,7 +89,7 @@ module IsoDoc
           "fmt-provision"
           node.elements.each { |n| parse(n, out) }
         else
-          text = node.to_xml.gsub(/</, "&lt;").gsub(/>/, "&gt;")
+          text = node.to_xml.gsub("<", "&lt;").gsub(">", "&gt;")
           out.t { |p| p << text }
         end
       end
@@ -127,8 +128,7 @@ module IsoDoc
         @isodoc.i18n_init("en", "Latn", nil, nil)
       end
 
-      def bibdata(docxml)
-      end
+      def bibdata(docxml); end
 
       include ::IsoDoc::Ietf::Init
     end

data/lib/isodoc/ietf/table.rb

@@ -18,9 +18,13 @@ module IsoDoc
       end
 
       def table_parse_tail(node, out)
-        (key = node.at(ns("./key"))) && parse(key, out)
-        node.xpath(ns("./source")).each { |n| parse(n, out) }
-        node.xpath(ns("./note")).each { |n| parse(n, out) }
+        table_parse_tail_elems.each do |k|
+          node.xpath(ns(k)).each { |n| parse(n, out) }
+        end
+      end
+
+      def table_parse_tail_elems
+        ["./key", "./source", "./note"]
       end
 
       def table_title_parse(node, out)

data/lib/metanorma/ietf/basicdoc.rng

@@ -187,6 +187,15 @@ Applicable to modify and delete</a:documentation>
         <a:documentation>Optional caption of this block</a:documentation>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="position">
+        <a:documentation>For an "add" change, whether the change is added before or after the location</a:documentation>
+        <choice>
+          <value>before</value>
+          <value>after</value>
+        </choice>
+      </attribute>
+    </optional>
     <optional>
       <element name="location">
         <a:documentation>The location(s) in the original document which have undergone the change described in this block</a:documentation>
@@ -1893,15 +1902,40 @@ or as the string "auto"</a:documentation>
     <a:documentation>Mathematically formatted text</a:documentation>
     <element name="stem">
       <ref name="StemAttributes"/>
-      <oneOrMore>
-        <choice>
+      <optional>
+        <text>
           <a:documentation>The content of the mathematically formatted text</a:documentation>
-          <text/>
-          <ref name="AnyElement"/>
-        </choice>
-      </oneOrMore>
+        </text>
+      </optional>
+      <optional>
+        <ref name="mathml"/>
+      </optional>
+      <optional>
+        <ref name="asciimath"/>
+      </optional>
+      <optional>
+        <ref name="latexmath"/>
+      </optional>
     </element>
   </define>
+  <define name="latexmath">
+    <a:documentation>Encoding of LatexMath</a:documentation>
+    <element name="latexmath">
+      <text/>
+    </element>
+  </define>
+  <define name="asciimath">
+    <a:documentation>Encoding of AsciiMath</a:documentation>
+    <element name="asciimath">
+      <text/>
+    </element>
+  </define>
+  <define name="mathml">
+    <a:documentation>Encoding of MathML: the official W3C MathML 3.0 grammar (namespace
+http://www.w3.org/1998/Math/MathML), via the metanorma wrapper in
+grammars/mathml/. See grammars/mathml/README.adoc and basicdoc-models#35.</a:documentation>
+    <externalRef href="metanorma-mathml.rng"/>
+  </define>
   <define name="StemAttributes">
     <attribute name="type">
       <a:documentation>The notation used to mathematically format the text</a:documentation>

data/lib/metanorma/ietf/biblio.rng

@@ -1142,11 +1142,11 @@ NOTE: This should preferably be encoded as  a URI or short identifier, rather th
         <a:documentation>Information about how long the current description of the bibliographic item is valid for</a:documentation>
       </ref>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="depiction">
         <a:documentation>Depiction of the bibliographic item, typically an image</a:documentation>
       </ref>
-    </optional>
+    </zeroOrMore>
   </define>
   <define name="ReducedBibliographicItem">
     <a:documentation>Reduced description of a bibliographic resource, without mandatory title and docidentifier, used for document relations
@@ -2015,15 +2015,11 @@ provided that it is not the entire bibliographic item that is so related</a:docu
     <a:documentation>A version of the bibliographic item (within an edition). Can be used for drafts</a:documentation>
     <element name="version">
       <optional>
-        <ref name="revision-date">
-          <a:documentation>The date at which the current version of the bibliographic item was produced</a:documentation>
-        </ref>
-      </optional>
-      <optional>
-        <ref name="draft">
-          <a:documentation>The identifier for the current draft of the bibliographic item</a:documentation>
-        </ref>
+        <attribute name="type">
+          <a:documentation>Versioning scheme, in case of multiple versioning schemes</a:documentation>
+        </attribute>
       </optional>
+      <text/>
     </element>
   </define>
   <define name="vedition">
@@ -2063,13 +2059,13 @@ provided that it is not the entire bibliographic item that is so related</a:docu
           <ref name="LocalizedString"/>
         </element>
       </optional>
-      <oneOrMore>
+      <zeroOrMore>
         <element name="taxon">
           <a:documentation>The keywords as a hierarchical taxonomy. For example, the sequence of `taxon` elements
 `pump`, `centrifugal pump`, `line shaft pump` represents a taxonomic classification</a:documentation>
           <ref name="LocalizedString"/>
         </element>
-      </oneOrMore>
+      </zeroOrMore>
       <zeroOrMore>
         <ref name="vocabid">
           <a:documentation>Identifiers for the keyword as a controlled vocabulary</a:documentation>

data/lib/metanorma/ietf/converter.rb

@@ -178,7 +178,7 @@ module Metanorma
       end
 
       def isodoc(lang, script, locale, i18nyaml = nil)
-        conv = rfc_converter(EmptyAttr.new)
+        conv = rfc_converter(::Metanorma::Standoc::EmptyAttr.new)
         conv.init_i18n({ i18nyaml:, language: lang, script:, locale: })
         i18n = conv.i18n_init(lang, script, locale, i18nyaml)
         conv.metadata_init(lang, script, locale, i18n)

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.5 -->
+<!-- VERSION v2.1.6 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -164,6 +164,9 @@ Sources are currently only rendered in metanorma-plateau</a:documentation>
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <ref name="DisplayDirective"/>
+      </optional>
     </define>
     <define name="DlAttributes">
       <ref name="BlockAttributes"/>
@@ -210,6 +213,12 @@ Sources are currently only rendered in metanorma-plateau</a:documentation>
     <define name="ExampleAttributes">
       <ref name="NumberingAttributes"/>
       <ref name="BlockAttributes"/>
+      <optional>
+        <attribute name="collapsible">
+          <a:documentation>Render the example as collapsible (HTML5 details/summary)</a:documentation>
+          <data type="boolean"/>
+        </attribute>
+      </optional>
     </define>
     <define name="ExampleBody">
       <optional>
@@ -814,6 +823,9 @@ titlecase, or lowercase</a:documentation>
   </define>
   <define name="UlAttributes" combine="interleave">
     <ref name="BlockAttributes"/>
+    <optional>
+      <ref name="DisplayDirective"/>
+    </optional>
   </define>
   <define name="TableAttributes" combine="interleave">
     <optional>
@@ -840,7 +852,7 @@ titlecase, or lowercase</a:documentation>
         <a:documentation>Width of the figure block in rendering</a:documentation>
       </attribute>
     </optional>
-    <ref name="BlockAttributes"/>
+    <ref name="BlockAttributesCore"/>
   </define>
   <define name="SourceAttributes" combine="interleave">
     <ref name="BlockAttributes"/>
@@ -1271,7 +1283,11 @@ That concept may be defined as a term within the current document, or it may be
           <a:documentation>Class of input form</a:documentation>
         </attribute>
       </optional>
-      <ref name="BlockAttributes"/>
+      <ref name="BlockAttributesCore">
+        <a:documentation>form declares its own class above, so it uses BlockAttributesCore to
+avoid duplicating the custom-class slot in BlockAttributes. Treated like
+figure. See metanorma/metanorma-standoc#1197</a:documentation>
+      </ref>
       <zeroOrMore>
         <!-- Input form contents -->
         <choice>
@@ -1968,7 +1984,7 @@ used in document amendments</a:documentation>
           <a:documentation>Zero or more examples of how the term is to be used</a:documentation>
         </ref>
       </zeroOrMore>
-      <ref name="TermSource">
+      <ref name="TermSources">
         <a:documentation>Bibliographic references for the managed term</a:documentation>
       </ref>
     </element>
@@ -2077,7 +2093,7 @@ used in document amendments</a:documentation>
         <a:documentation>Information about how the designation is to be used</a:documentation>
       </ref>
     </optional>
-    <ref name="TermSource">
+    <ref name="TermSources">
       <a:documentation>Bibliographic references for this designation of the managed term</a:documentation>
     </ref>
   </define>
@@ -2348,7 +2364,7 @@ used in document amendments</a:documentation>
           <ref name="formula"/>
         </choice>
       </oneOrMore>
-      <ref name="TermSource">
+      <ref name="TermSources">
         <a:documentation>Bibliographic references for this designation of the managed term</a:documentation>
       </ref>
     </element>
@@ -2365,7 +2381,7 @@ used in document amendments</a:documentation>
           <ref name="formula"/>
         </choice>
       </oneOrMore>
-      <ref name="TermSource">
+      <ref name="TermSources">
         <a:documentation>Bibliographic references for this designation of the managed term</a:documentation>
       </ref>
     </element>
@@ -2756,7 +2772,11 @@ links within an SVG file, so that the SVG file can hyperlink to anchors within t
       </oneOrMore>
     </element>
   </define>
-  <define name="BlockAttributes">
+  <define name="BlockAttributesCore">
+    <a:documentation>Block attributes excluding the custom CSS class. Blocks that already carry
+their own `class` attribute (e.g. figure, via basicdoc FigureAttributes)
+include this directly, to avoid a duplicate-attribute collision with the
+`class` added in BlockAttributes. See metanorma/metanorma-standoc#1197</a:documentation>
     <optional>
       <attribute name="keep-with-next">
         <a:documentation>Keep this block on the same page as the following block in paged media</a:documentation>
@@ -2788,6 +2808,37 @@ to span across both columns</a:documentation>
       </attribute>
     </optional>
   </define>
+  <define name="BlockAttributes">
+    <a:documentation>Universal block attributes, including a custom CSS class (space-separated,
+appended additively to the block's built-in HTML class, HTML output only).
+See metanorma/metanorma-standoc#1197</a:documentation>
+    <ref name="BlockAttributesCore"/>
+    <optional>
+      <attribute name="class">
+        <a:documentation>Custom CSS class(es) for the block in HTML output</a:documentation>
+      </attribute>
+    </optional>
+  </define>
+  <define name="DisplayDirective">
+    <a:documentation>Directive on how to render a block in Presentation XML </a:documentation>
+    <optional>
+      <attribute name="display">
+        <a:documentation>Display style for block.
+If the block is `ol` or `ul` and dispay is `table`, 
+the list is to be rendered as a table, with a column for each nested level, and a row for each terminal sublist</a:documentation>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="display-directives">
+        <a:documentation>display-directives is a key-value set of attributes, guiding how the rendering of the block should happen. 
+The key-value set is comma-delimited, and encoded as `key1='value1',key2='value'`, 
+as with stem//mn/@data-metanorma-numberformat
+*  If the block is `ol` or `ul` and dispay is `table`,  display-directives can have the value `colgroup='col1,col2,...coln'`, 
+where each col value is a percentage width of the column in the output table (with no % suffix). 
+e.g. `colgroup='50,33.3,16.7'`  </a:documentation>
+      </attribute>
+    </optional>
+  </define>
   <define name="ReferencesAttributes">
     <optional>
       <attribute name="obligation">
@@ -2800,7 +2851,7 @@ Normative References contents contain normative references, but as a clause in t
       <data type="boolean"/>
     </attribute>
   </define>
-  <define name="TermSource">
+  <define name="TermSources">
     <zeroOrMore>
       <ref name="termsource"/>
     </zeroOrMore>

data/lib/metanorma/ietf/mathml3-common.rng

@@ -0,0 +1,257 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+      This is the Mathematical Markup Language (MathML) 3.0, an XML
+      application for describing mathematical notation and capturing
+      both its structure and content.
+  
+      Copyright 1998-2014 W3C (MIT, ERCIM, Keio, Beihang)
+  
+      Use and distribution of this code are permitted under the terms
+      W3C Software Notice and License
+      http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
+-->
+<grammar ns="http://www.w3.org/1998/Math/MathML" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <start>
+    <ref name="math"/>
+  </start>
+  <define name="math">
+    <element name="math">
+      <ref name="math.attributes"/>
+      <zeroOrMore>
+        <ref name="MathExpression"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="MathExpression">
+    <ref name="semantics"/>
+  </define>
+  <define name="NonMathMLAtt">
+    <attribute>
+      <anyName>
+        <except>
+          <nsName ns=""/>
+          <nsName/>
+        </except>
+      </anyName>
+      <data type="string"/>
+    </attribute>
+  </define>
+  <define name="CommonDeprecatedAtt">
+    <optional>
+      <attribute name="other"/>
+    </optional>
+  </define>
+  <define name="CommonAtt">
+    <optional>
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="xref"/>
+    </optional>
+    <optional>
+      <attribute name="class">
+        <data type="NMTOKENS"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="style">
+        <data type="string"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="href">
+        <data type="anyURI"/>
+      </attribute>
+    </optional>
+    <ref name="CommonDeprecatedAtt"/>
+    <zeroOrMore>
+      <ref name="NonMathMLAtt"/>
+    </zeroOrMore>
+  </define>
+  <define name="math.attributes">
+    <ref name="CommonAtt"/>
+    <optional>
+      <attribute name="display">
+        <choice>
+          <value>block</value>
+          <value>inline</value>
+        </choice>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="maxwidth">
+        <ref name="length"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="overflow">
+        <choice>
+          <value>linebreak</value>
+          <value>scroll</value>
+          <value>elide</value>
+          <value>truncate</value>
+          <value>scale</value>
+        </choice>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="altimg">
+        <data type="anyURI"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="altimg-width">
+        <ref name="length"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="altimg-height">
+        <ref name="length"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="altimg-valign">
+        <choice>
+          <ref name="length"/>
+          <value>top</value>
+          <value>middle</value>
+          <value>bottom</value>
+        </choice>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="alttext"/>
+    </optional>
+    <optional>
+      <attribute name="cdgroup">
+        <data type="anyURI"/>
+      </attribute>
+    </optional>
+    <ref name="math.deprecatedattributes"/>
+  </define>
+  <!--
+    the mathml3-presentation schema  adds additional attributes
+    to the math element, all those valid on mstyle
+  -->
+  <define name="math.deprecatedattributes">
+    <optional>
+      <attribute name="mode">
+        <data type="string"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="macros">
+        <data type="string"/>
+      </attribute>
+    </optional>
+  </define>
+  <define name="name">
+    <attribute name="name">
+      <data type="NCName"/>
+    </attribute>
+  </define>
+  <define name="cd">
+    <attribute name="cd">
+      <data type="NCName"/>
+    </attribute>
+  </define>
+  <define name="src">
+    <optional>
+      <attribute name="src">
+        <data type="anyURI"/>
+      </attribute>
+    </optional>
+  </define>
+  <define name="annotation">
+    <element name="annotation">
+      <ref name="annotation.attributes"/>
+      <text/>
+    </element>
+  </define>
+  <define name="annotation-xml.model">
+    <zeroOrMore>
+      <choice>
+        <ref name="MathExpression"/>
+        <ref name="anyElement"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="anyElement">
+    <element>
+      <anyName>
+        <except>
+          <nsName/>
+        </except>
+      </anyName>
+      <zeroOrMore>
+        <choice>
+          <attribute>
+            <anyName/>
+          </attribute>
+          <text/>
+          <ref name="anyElement"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="annotation-xml">
+    <element name="annotation-xml">
+      <ref name="annotation.attributes"/>
+      <ref name="annotation-xml.model"/>
+    </element>
+  </define>
+  <define name="annotation.attributes">
+    <ref name="CommonAtt"/>
+    <optional>
+      <ref name="cd"/>
+    </optional>
+    <optional>
+      <ref name="name"/>
+    </optional>
+    <ref name="DefEncAtt"/>
+    <optional>
+      <ref name="src"/>
+    </optional>
+  </define>
+  <define name="DefEncAtt">
+    <optional>
+      <attribute name="encoding">
+        <data type="string"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="definitionURL">
+        <data type="anyURI"/>
+      </attribute>
+    </optional>
+  </define>
+  <define name="semantics">
+    <element name="semantics">
+      <ref name="semantics.attributes"/>
+      <ref name="MathExpression"/>
+      <zeroOrMore>
+        <choice>
+          <ref name="annotation"/>
+          <ref name="annotation-xml"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="semantics.attributes">
+    <ref name="CommonAtt"/>
+    <ref name="DefEncAtt"/>
+    <optional>
+      <ref name="cd"/>
+    </optional>
+    <optional>
+      <ref name="name"/>
+    </optional>
+  </define>
+  <define name="length">
+    <data type="string">
+      <param name="pattern">\s*((-?[0-9]*([0-9]\.?|\.[0-9])[0-9]*(e[mx]|in|cm|mm|p[xtc]|%)?)|(negative)?((very){0,2}thi(n|ck)|medium)mathspace)\s*</param>
+    </data>
+  </define>
+</grammar>