metanorma-ietf 3.5.2 → 3.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66afc05315cc687095d79073250a66456063aba630e6e3ebbb054d87d1de2a43
-  data.tar.gz: 89ed799dad00eb2ac6e89acd47dab3c0acc63cf1d17adbea9d9fb24f353a8784
+  metadata.gz: 30d6ea179af9c4c095b3e4cb4481ee8cfe136d370e10df652b025c99dd61018f
+  data.tar.gz: 980f41496222a49f993ad5c12aa83fab68e192787ee93b1995631be4f5af29f0
 SHA512:
-  metadata.gz: '0594ed5016ddef64067a6fac2cd2ed8c1adc56d9bd1d60f5747ec30c24e8f8c7882a5361b0706bd4bdaf30df025458faaaa4814dd6a07669e3870a478896a370'
-  data.tar.gz: f116e02cc2c7de0f6533fc98ad4b422d778566a5059d07fddd4df4e49638bf2d92e4b3dc473384f63ebd93150afd715351334a92902f6ce0d4b246de5d2fc69f
+  metadata.gz: 69381efde5d13a2b9453e94ab74d7557fc938295d88cde9b8db80e5229ce306f1c61b90f23887c985dc28e0f61ee2556b96353b6f475a1941a11366800e667d3
+  data.tar.gz: b03c83fe7b56285eb7ce5884861837274824d3a7bf9d1d5dfb474e1cf8e39a355c3059b293ee311f8c4571f0a53e64f8074e91bae901d87853f8efe4819f2094

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_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/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">
@@ -1694,16 +1701,22 @@ which can be bookmarks as well as block or section references</a:documentation>
     <a:documentation>Inline reference to a paragraph or paragraphs, appearing as a footnote.
 The target of a footnote is the location it is embedded in within the text</a:documentation>
     <element name="fn">
-      <attribute name="reference">
-        <a:documentation>The number of the footnote, used to identify it visually</a:documentation>
-      </attribute>
-      <oneOrMore>
-        <ref name="paragraph">
-          <a:documentation>The content of the footnote</a:documentation>
-        </ref>
-      </oneOrMore>
+      <ref name="FnAttributes"/>
+      <ref name="FnBody"/>
     </element>
   </define>
+  <define name="FnBody">
+    <oneOrMore>
+      <ref name="paragraph">
+        <a:documentation>The content of the footnote</a:documentation>
+      </ref>
+    </oneOrMore>
+  </define>
+  <define name="FnAttributes">
+    <attribute name="reference">
+      <a:documentation>The number of the footnote, used to identify it visually</a:documentation>
+    </attribute>
+  </define>
   <define name="callout">
     <a:documentation>Inline reference to a paragraph or paragraphs, appearing as annotation of source code</a:documentation>
     <element name="callout">

data/lib/metanorma/ietf/biblio-standoc.rng

@@ -1,13 +1,14 @@
 <?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">
-  <!--
-    Add-ons to biblio.rnc for standoc model: defines the extension point BibDataExtensionType
-    of relaton
-    
-    Specialisations as for biblio.rnc. Extension point can be redefined completely for a flavour of standoc
-    (SDO); but other elements in Bibdata can only be extended (more specialised vocabularies for Bibdata)
-  -->
   <include href="biblio.rng">
+    <!-- ALERT: we cannot have comments on root element, as they intervene with https://github.com/metanorma/metanorma/issues/437 fix -->
+    <!--
+      Add-ons to biblio.rnc for standoc model: defines the extension point BibDataExtensionType
+      of relaton
+      
+      Specialisations as for biblio.rnc. Extension point can be redefined completely for a flavour of standoc
+      (SDO); but other elements in Bibdata can only be extended (more specialised vocabularies for Bibdata)
+    -->
     <define name="BibData">
       <a:documentation>The bibliographic description of a standardisation document</a:documentation>
       <ref name="StandardBibliographicItem"/>
@@ -91,6 +92,9 @@ a standards definition organization</a:documentation>
         <a:documentation>Representation of the identifier for the standardisation document, giving its individual semantic components</a:documentation>
       </ref>
     </zeroOrMore>
+    <ref name="DocumentImages">
+      <a:documentation>Coverpage and other images to be rendered with document</a:documentation>
+    </ref>
   </define>
   <define name="doctype">
     <a:documentation>Classification of the standardisation document</a:documentation>
@@ -268,6 +272,32 @@ and not those document components</a:documentation>
       </optional>
     </element>
   </define>
+  <define name="DocumentImages">
+    <zeroOrMore>
+      <element name="coverpage-image">
+        <a:documentation>Images to be displayed on the coverpage of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+    <zeroOrMore>
+      <element name="innercoverpage-image">
+        <a:documentation>Images to be displayed on the inner coverpage of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+    <zeroOrMore>
+      <element name="tocside-image">
+        <a:documentation>Images to be displayed on the Table of Contents page of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+    <zeroOrMore>
+      <element name="backpage-image">
+        <a:documentation>Images to be displayed on the backpage of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+  </define>
   <define name="StandardBibliographicItem">
     <ref name="BibliographicItem"/>
     <zeroOrMore>

data/lib/metanorma/ietf/biblio.rng

@@ -1,23 +1,25 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
-  instantiations of this grammar may replace leaf strings
-  with more elaborated types; e.g. title (text) replaced with
-  title-main, title-intro, title-part; type replaced with
-  enum.
-  
-  some renaming at leaf nodes is permissible
-  
-  obligations can change both from optional to mandatory,
-  and from mandatory to optional; optional elements may
-  be omitted; freely positioned alternatives may be replaced
-  with strict ordering
-  
-  DO NOT introduce a namespace here. We do not want a distinct namespace
-  for these elements, and a distinct namespace for any grammar inheriting
-  these elements; we just want one namespace for any child grammars
-  of this.
--->
 <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">
+  <!--
+    ALERT: we cannot have comments on root element, as they intervene with https://github.com/metanorma/metanorma/issues/437 fix
+    
+    Instantiations of this grammar may replace leaf strings
+    with more elaborated types; e.g. title (text) replaced with
+    title-main, title-intro, title-part; type replaced with
+    enum.
+    
+    Some renaming at leaf nodes is permissible
+    
+    Obligations can change both from optional to mandatory,
+    and from mandatory to optional; optional elements may
+    be omitted; freely positioned alternatives may be replaced
+    with strict ordering
+    
+    DO NOT introduce a namespace here. We do not want a distinct namespace
+    for these elements, and a distinct namespace for any grammar inheriting
+    these elements; we just want one namespace for any child grammars
+    of this.
+  -->
   <!--
     https://www.myintervals.com/blog/2009/05/20/iso-8601-date-validation-that-doesnt-suck/
     iso8601date = xsd:string { pattern = "([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?" }
@@ -1241,6 +1243,11 @@ Refer to `BibliographicItem` for definitions</a:documentation>
   </define>
   <define name="formattedref">
     <element name="formattedref">
+      <optional>
+        <attribute name="format">
+          <a:documentation>format of formatted reference; Metanorma assumes references are formatted as Metanorma XML</a:documentation>
+        </attribute>
+      </optional>
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>
@@ -1812,6 +1819,11 @@ May be used to differentiate rendering of notes in bibliographies</a:documentati
     <a:documentation>Abstract of bibliographic item</a:documentation>
     <element name="abstract">
       <ref name="LocalizedStringAttributes"/>
+      <optional>
+        <attribute name="format">
+          <a:documentation>What format the formatted abstract is in. In Metanorma, assumed to be Metanorma XML</a:documentation>
+        </attribute>
+      </optional>
       <choice>
         <oneOrMore>
           <ref name="BasicBlockNoId">

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/ietf.rng

@@ -1,14 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar ns='https://www.metanorma.org/ns/standoc' xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-  <!--
-    VERSION v1.2.1
-    Currently we inherit from a namespaced grammar, isostandard. Until we inherit from isodoc,
-    we cannot have a new default namespace: we will end up with a grammar with two different
-    namespaces, one for isostandard and one for ietf additions. And we do not want that.
-  -->
   <include href="relaton-ietf.rng"/>
   <include href="isodoc.rng">
-    <define name="ParagraphAttrs">
+    <define name="ParagraphAttributes">
       <optional>
         <attribute name="align">
           <ref name="Alignments"/>
@@ -28,7 +22,7 @@
         <attribute name="indent"/>
       </optional>
     </define>
-    <define name="UlAttr">
+    <define name="UlAttributes">
       <optional>
         <attribute name="nobullet">
           <data type="boolean"/>
@@ -54,7 +48,7 @@
         <ref name="note"/>
       </zeroOrMore>
     </define>
-    <define name="OlAttr">
+    <define name="OlAttributes">
       <attribute name="type">
         <choice>
           <value>roman</value>
@@ -86,7 +80,7 @@
         <ref name="note"/>
       </zeroOrMore>
     </define>
-    <define name="DlAttr">
+    <define name="DlAttributes">
       <optional>
         <attribute name="newline"/>
       </optional>
@@ -106,34 +100,12 @@
         <ref name="note"/>
       </zeroOrMore>
     </define>
-    <define name="review">
-      <element name="review">
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-        <attribute name="reviewer"/>
-        <optional>
-          <attribute name="date">
-            <data type="dateTime"/>
-          </attribute>
-        </optional>
-        <attribute name="from">
-          <data type="IDREF"/>
-        </attribute>
-        <optional>
-          <attribute name="to">
-            <data type="IDREF"/>
-          </attribute>
-        </optional>
-        <optional>
-          <attribute name="display"/>
-        </optional>
-        <oneOrMore>
-          <ref name="paragraph"/>
-        </oneOrMore>
-      </element>
+    <define name="ReviewAttributes" combine="interleave">
+      <optional>
+        <attribute name="display"/>
+      </optional>
     </define>
-    <define name="NoteAttr">
+    <define name="NoteAttributes">
       <optional>
         <attribute name="removeInRFC"/>
       </optional>
@@ -146,7 +118,7 @@
         <ref name="paragraph"/>
       </oneOrMore>
     </define>
-    <define name="PreAttr">
+    <define name="PreAttributes">
       <optional>
         <attribute name="alt"/>
       </optional>
@@ -154,12 +126,12 @@
         <attribute name="align"/>
       </optional>
     </define>
-    <define name="ImageAttr" combine="interleave">
+    <define name="ImageAttributes" combine="interleave">
       <optional>
         <attribute name="align"/>
       </optional>
     </define>
-    <define name="SourceAttr" combine="interleave">
+    <define name="SourceAttributes" combine="interleave">
       <optional>
         <attribute name="number"/>
       </optional>
@@ -213,7 +185,7 @@
         <ref name="erefTypeURI"/>
       </element>
     </define>
-    <define name="TableAttr" combine="interleave">
+    <define name="TableAttributes" combine="interleave">
       <optional>
         <attribute name="number"/>
       </optional>
@@ -225,17 +197,7 @@
       </optional>
     </define>
     <define name="Clause-Section">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="language"/>
-      </optional>
-      <optional>
-        <attribute name="script"/>
-      </optional>
+      <ref name="Section-Attributes"/>
       <optional>
         <attribute name="numbered"/>
       </optional>
@@ -245,17 +207,6 @@
       <optional>
         <attribute name="toc"/>
       </optional>
-      <optional>
-        <attribute name="inline-header">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <attribute name="obligation">
-        <choice>
-          <value>normative</value>
-          <value>informative</value>
-        </choice>
-      </attribute>
       <optional>
         <ref name="section-title"/>
       </optional>
@@ -274,23 +225,7 @@
     </define>
     <define name="annex">
       <element name="annex">
-        <optional>
-          <attribute name="id">
-            <data type="ID"/>
-          </attribute>
-        </optional>
-        <optional>
-          <attribute name="language"/>
-        </optional>
-        <optional>
-          <attribute name="script"/>
-        </optional>
-        <attribute name="obligation">
-          <choice>
-            <value>normative</value>
-            <value>informative</value>
-          </choice>
-        </attribute>
+        <ref name="Annex-Section-Attributes"/>
         <optional>
           <attribute name="numbered"/>
         </optional>
@@ -314,17 +249,7 @@
       </element>
     </define>
     <define name="Content-Section">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="language"/>
-      </optional>
-      <optional>
-        <attribute name="script"/>
-      </optional>
+      <ref name="Section-Attributes"/>
       <optional>
         <attribute name="numbered"/>
       </optional>
@@ -358,51 +283,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
-        <element name="primary">
-          <oneOrMore>
-            <ref name="PureTextElement"/>
-          </oneOrMore>
-        </element>
-        <optional>
-          <element name="secondary">
-            <oneOrMore>
-              <ref name="PureTextElement"/>
-            </oneOrMore>
-          </element>
-        </optional>
-        <optional>
-          <element name="tertiary">
-            <oneOrMore>
-              <ref name="PureTextElement"/>
-            </oneOrMore>
-          </element>
-        </optional>
-      </element>
-    </define>
-    <define name="standard-document">
-      <element name="metanorma">
-        <ref name="Root-Attributes"/>
-        <ref name="bibdata"/>
-        <zeroOrMore>
-          <ref name="termdocsource"/>
-        </zeroOrMore>
-        <optional>
-          <ref name="misccontainer"/>
-        </optional>
-        <optional>
-          <ref name="boilerplate"/>
-        </optional>
-        <ref name="preface"/>
-        <oneOrMore>
-          <ref name="sections"/>
-        </oneOrMore>
-        <zeroOrMore>
-          <ref name="annex"/>
-        </zeroOrMore>
-        <ref name="bibliography"/>
-        <zeroOrMore>
-          <ref name="indexsect"/>
-        </zeroOrMore>
+        <ref name="index-primary"/>
+        <ref name="index-secondary"/>
+        <ref name="index-tertiary"/>
       </element>
     </define>
   </include>
@@ -418,11 +301,6 @@
       <text/>
     </element>
   </define>
-  <define name="comment">
-    <element name="comment">
-      <text/>
-    </element>
-  </define>
   <define name="erefTypeURI">
     <optional>
       <attribute name="normative">

data/lib/metanorma/ietf/isodoc.rng

@@ -1,24 +1,27 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
-  instantiations of this grammar may replace leaf strings
-  with more elaborated types; e.g. title (text) replaced with
-  title-main, title-intro, title-part; type replaced with
-  enum.
-  
-  some renaming at leaf nodes is permissible
-  
-  obligations can change both from optional to mandatory,
-  and from mandatory to optional; optional elements may
-  be omitted; freely positioned alternatives may be replaced
-  with strict ordering
-  
-  DO NOT introduce a namespace here. We do not want a distinct namespace
-  for these elements, and a distinct namespace for any grammar inheriting
-  these elements; we just want one namespace for any child grammars
-  of this.
--->
-<!-- VERSION v2.0.0 -->
 <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.3 -->
+
+  <!--
+    ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
+    
+    instantiations of this grammar may replace leaf strings
+    with more elaborated types; e.g. title (text) replaced with
+    title-main, title-intro, title-part; type replaced with
+    enum.
+    
+    some renaming at leaf nodes is permissible
+    
+    obligations can change both from optional to mandatory,
+    and from mandatory to optional; optional elements may
+    be omitted; freely positioned alternatives may be replaced
+    with strict ordering
+    
+    DO NOT introduce a namespace here. We do not want a distinct namespace
+    for these elements, and a distinct namespace for any grammar inheriting
+    these elements; we just want one namespace for any child grammars
+    of this.
+  -->
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
     <define name="amend">
@@ -33,15 +36,6 @@
         </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>
@@ -423,6 +417,13 @@ normative or informative references, some split references into sections organiz
         </oneOrMore>
       </choice>
     </define>
+    <define name="TrAttributes">
+      <optional>
+        <attribute name="style">
+          <a:documentation>CSS style: only background-color supported</a:documentation>
+        </attribute>
+      </optional>
+    </define>
     <define name="table-note">
       <element name="note">
         <ref name="OptionalId"/>
@@ -485,6 +486,22 @@ gives an explicit page orientation</a:documentation>
     </define>
   </include>
   <!-- end overrides -->
+  <define name="FnAttributes" 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="TdAttributes" combine="interleave">
+    <optional>
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </optional>
+  </define>
   <define name="NumberingAttributes" combine="interleave">
     <optional>
       <attribute name="number">
@@ -663,6 +680,13 @@ titlecase, or lowercase</a:documentation>
       </attribute>
     </optional>
   </define>
+  <define name="Basic-Section-Attributes" combine="interleave">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+  </define>
   <define name="ObligationType">
     <a:documentation>The force of a clause in a standard document: whether it has normative or informative effect</a:documentation>
     <choice>
@@ -1177,13 +1201,6 @@ numbers</a:documentation>
       </attribute>
     </optional>
   </define>
-  <define name="Basic-Section-Attributes" combine="interleave">
-    <optional>
-      <attribute name="obligation">
-        <ref name="ObligationType"/>
-      </attribute>
-    </optional>
-  </define>
   <define name="reference-clause">
     <a:documentation>References clause with recursive nesting</a:documentation>
     <element name="clause">
@@ -1224,7 +1241,7 @@ numbers</a:documentation>
       </choice>
     </attribute>
     <attribute name="flavor">
-      <a:documentation>Metanorma flavor, indicating SDO whose requiremnts the realisation aligns to</a:documentation>
+      <a:documentation>Metanorma flavor, indicating SDO whose requirements the realisation aligns to</a:documentation>
     </attribute>
   </define>
   <define name="standard-document">
@@ -1234,6 +1251,11 @@ numbers</a:documentation>
       <ref name="bibdata">
         <a:documentation>Bibliographic description of the document itself, expressed in the Relaton model</a:documentation>
       </ref>
+      <zeroOrMore>
+        <ref name="termdocsource">
+          <a:documentation>Source for term definitions in the document</a:documentation>
+        </ref>
+      </zeroOrMore>
       <optional>
         <ref name="misccontainer">
           <a:documentation>Extension point for extraneous elements that need to be added to standards document as data</a:documentation>
@@ -1244,36 +1266,44 @@ numbers</a:documentation>
           <a:documentation>Front matter that is repeated at the start of documents issued from an SDO, with content not specific to the document</a:documentation>
         </ref>
       </optional>
+      <ref name="DocumentBody"/>
       <optional>
-        <ref name="preface">
-          <a:documentation>Prefatory sections</a:documentation>
-        </ref>
-      </optional>
-      <ref name="sections">
-        <a:documentation>Main body of document</a:documentation>
-      </ref>
-      <zeroOrMore>
-        <ref name="annex">
-          <a:documentation>Annex sections</a:documentation>
-        </ref>
-      </zeroOrMore>
-      <optional>
-        <ref name="bibliography">
-          <a:documentation>Bibliographic sections</a:documentation>
-        </ref>
-      </optional>
-      <zeroOrMore>
-        <ref name="indexsect">
-          <a:documentation>Index of the document</a:documentation>
-        </ref>
-      </zeroOrMore>
-      <optional>
-        <ref name="colophon">
-          <a:documentation>Colophon or postface material</a:documentation>
+        <ref name="review-container">
+          <a:documentation>Annotations to the document</a:documentation>
         </ref>
       </optional>
     </element>
   </define>
+  <define name="DocumentBody">
+    <optional>
+      <ref name="preface">
+        <a:documentation>Prefatory sections</a:documentation>
+      </ref>
+    </optional>
+    <ref name="sections">
+      <a:documentation>Main body of document</a:documentation>
+    </ref>
+    <zeroOrMore>
+      <ref name="annex">
+        <a:documentation>Annex sections</a:documentation>
+      </ref>
+    </zeroOrMore>
+    <optional>
+      <ref name="bibliography">
+        <a:documentation>Bibliographic sections</a:documentation>
+      </ref>
+    </optional>
+    <zeroOrMore>
+      <ref name="indexsect">
+        <a:documentation>Index of the document</a:documentation>
+      </ref>
+    </zeroOrMore>
+    <optional>
+      <ref name="colophon">
+        <a:documentation>Colophon or postface material</a:documentation>
+      </ref>
+    </optional>
+  </define>
   <define name="misccontainer">
     <a:documentation>Elements added to metanorma-extension are open-ended, and constitute source data</a:documentation>
     <element name="metanorma-extension">
@@ -1282,6 +1312,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>
@@ -1581,9 +1618,7 @@ used in document amendments</a:documentation>
   <define name="term">
     <a:documentation>Terminology entry with its definition</a:documentation>
     <element name="term">
-      <ref name="OptionalId"/>
-      <ref name="LocalizedStringAttributes"/>
-      <ref name="BlockAttributes"/>
+      <ref name="TermAttributes"/>
       <oneOrMore>
         <ref name="preferred">
           <a:documentation>One or more names under which the term being defined is canonically known</a:documentation>
@@ -1635,6 +1670,11 @@ used in document amendments</a:documentation>
       </ref>
     </element>
   </define>
+  <define name="TermAttributes">
+    <ref name="OptionalId"/>
+    <ref name="LocalizedStringAttributes"/>
+    <ref name="BlockAttributes"/>
+  </define>
   <define name="preferred">
     <element name="preferred">
       <ref name="Designation"/>
@@ -2296,26 +2336,32 @@ links within an SVG file, so that the SVG file can hyperlink to anchors within t
     </element>
   </define>
   <define name="ul_li">
-    <a:documentation>Unorderd list item for standards documents</a:documentation>
+    <a:documentation>Unordered list item for standards documents</a:documentation>
     <element name="li">
       <ref name="OptionalId"/>
-      <optional>
-        <attribute name="uncheckedcheckbox">
-          <a:documentation>Include a checkbox for the list item</a:documentation>
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="checkedcheckbox">
-          <a:documentation>Check the checkbox for the list item</a:documentation>
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <oneOrMore>
-        <ref name="BasicBlock"/>
-      </oneOrMore>
+      <ref name="UlLiAttributes"/>
+      <ref name="UlLiBody"/>
     </element>
   </define>
+  <define name="UlLiBody">
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="UlLiAttributes">
+    <optional>
+      <attribute name="uncheckedcheckbox">
+        <a:documentation>Include a checkbox for the list item</a:documentation>
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="checkedcheckbox">
+        <a:documentation>Check the checkbox for the list item</a:documentation>
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+  </define>
   <define name="floating-title">
     <a:documentation>A floating title, outside of the clause hierarchy of the document</a:documentation>
     <element name="floating-title">

data/lib/metanorma/ietf/relaton-ietf.rng

@@ -1,66 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar xmlns="http://relaxng.org/ns/structure/1.0">
+<grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0">
   <include href="biblio-standoc.rng">
-    <define name="DocumentType">
-      <choice>
-        <value>rfc</value>
-        <value>internet-draft</value>
-      </choice>
-    </define>
-    <define name="BibDataExtensionType">
-      <optional>
-        <attribute name="schema-version"/>
-      </optional>
-      <optional>
-        <ref name="doctype"/>
-      </optional>
-      <optional>
-        <ref name="docsubtype"/>
-      </optional>
-      <ref name="flavor"/>
-      <zeroOrMore>
-        <ref name="editorialgroup"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="ics"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="area"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="stream"/>
-      </optional>
-      <optional>
-        <ref name="ipr"/>
-      </optional>
-      <optional>
-        <ref name="consensus"/>
-      </optional>
-      <optional>
-        <ref name="index-include"/>
-      </optional>
-      <optional>
-        <ref name="ipr-extract"/>
-      </optional>
-      <optional>
-        <ref name="sort-refs"/>
-      </optional>
-      <optional>
-        <ref name="sym-refs"/>
-      </optional>
-      <optional>
-        <ref name="toc-include"/>
-      </optional>
-      <optional>
-        <ref name="toc-depth"/>
-      </optional>
-      <optional>
-        <ref name="show-on-front-page"/>
-      </optional>
-      <optional>
-        <ref name="processing-instructions"/>
-      </optional>
-    </define>
     <define name="editorialgroup">
       <element name="editorialgroup">
         <zeroOrMore>
@@ -68,7 +8,76 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="DocumentType">
+      <choice>
+        <value>rfc</value>
+        <value>internet-draft</value>
+      </choice>
+    </define>
   </include>
+  <define name="BibDataExtensionType" combine="interleave">
+    <zeroOrMore>
+      <ref name="area">
+        <a:documentation>which IETF area this document relates to. Value should be either the full name or the abbreviation of one of the IETF areas as
+listed on &lt;http://www.ietf.org/iesg/area.html</a:documentation>
+      </ref>
+    </zeroOrMore>
+    <optional>
+      <ref name="stream">
+        <a:documentation>Document stream of document described in https://tools.ietf.org/html/rfc7841</a:documentation>
+      </ref>
+    </optional>
+    <optional>
+      <ref name="ipr">
+        <a:documentation>IP status of document. See https://tools.ietf.org/html/rfc7991#section-2.45.5</a:documentation>
+      </ref>
+    </optional>
+    <optional>
+      <ref name="processing-instructions">
+        <a:documentation>Processing instructions which will be added to generated RFC XML in the form `&lt;?rfc keyword='value'?&gt;</a:documentation>
+      </ref>
+    </optional>
+    <optional>
+      <ref name="consensus">
+        <a:documentation>Document consensus for this document       </a:documentation>
+      </ref>
+    </optional>
+    <optional>
+      <ref name="index-include">
+        <a:documentation>Specifies whether formatter should include an index in generated files. If the source file has no `&lt;iref&gt;` elements, an index is never generated</a:documentation>
+      </ref>
+    </optional>
+    <optional>
+      <ref name="ipr-extract">
+        <a:documentation>Identifies a section that can be extracted from text. See https://tools.ietf.org/html/rfc7991#section-2.45.6</a:documentation>
+      </ref>
+    </optional>
+    <optional>
+      <ref name="sort-refs">
+        <a:documentation>Specifies whether the prep tool for RFC XML should sort references</a:documentation>
+      </ref>
+    </optional>
+    <optional>
+      <ref name="sym-refs">
+        <a:documentation>Specifies whether the RFC XML formatter should use symbolic references (such as "`[RFC2119]`") or not (such as "`[3]`")</a:documentation>
+      </ref>
+    </optional>
+    <optional>
+      <ref name="toc-include">
+        <a:documentation>Specifies whether the RFC XML formatter should contain a table of contents</a:documentation>
+      </ref>
+    </optional>
+    <optional>
+      <ref name="toc-depth">
+        <a:documentation>Determines the depth of the table-of-contents; e.g. a value of `3` means three levels of heading are included</a:documentation>
+      </ref>
+    </optional>
+    <optional>
+      <ref name="show-on-front-page">
+        <a:documentation>Display organization of author on front page of IAB documents. Applied to all organizations named in the document front matter</a:documentation>
+      </ref>
+    </optional>
+  </define>
   <define name="committee">
     <element name="committee">
       <ref name="IsoWorkgroup"/>

data/lib/metanorma/ietf/reqt.rng

@@ -1,5 +1,11 @@
 <?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">
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <!-- ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437 -->
   <!--
     Presupposes isodoc.rnc, is included in it
     include "isodoc.rnc" { }
@@ -7,14 +13,9 @@
     This is the Metanorma default provisions model; it is overridden by other provisions models,
     such as Modspec
   -->
-  <define name="requirement">
+  <define name="recommendation">
     <a:documentation>Specification of an attribute of a subject that is required.
 NOTE: A requirement can contain other requirements</a:documentation>
-    <element name="requirement">
-      <ref name="RequirementType"/>
-    </element>
-  </define>
-  <define name="recommendation">
     <a:documentation>Specification of an attribute of a subject that is recommended</a:documentation>
     <element name="recommendation">
       <ref name="RequirementType"/>

data/lib/metanorma/ietf/validate.rb

@@ -16,8 +16,8 @@ module Metanorma
       end
 
       def submission_validate(doc)
-        stream = doc.at(("//bibdata/series[@type = 'stream']/title"))&.text
-        status = doc.at(("//bibdata/status/stage"))&.text
+        stream = doc.at("//bibdata/series[@type = 'stream']/title")&.text
+        status = doc.at("//bibdata/status/stage")&.text
         stream == "editorial" && status != "informational" and
           @log.add("Document Attributes", nil,
                    "Editorial stream must have Informational status")
@@ -32,8 +32,7 @@ module Metanorma
       end
 
       def workgroup_validate(doc)
-        return if @workgroups.empty?
-
+        @workgroups.empty? and return
         doc.xpath("//bibdata/ext/editorialgroup/workgroup").each do |wg|
           wg_norm = wg.text.sub(/ (Working|Research) Group$/, "")
           @workgroups.include?(wg_norm) and next
@@ -43,10 +42,8 @@ module Metanorma
         end
       end
 
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "ietf.rng"))
+      def schema_file
+        "ietf.rng"
       end
 
       def cache_workgroup(_node)

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.5.2".freeze
+    VERSION = "3.5.4".freeze
   end
 end

metadata

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