metanorma-ietf 3.7.10 → 3.7.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3f2780e0bd1a5494c182ce6ebdb999c221dcf82cf0910a1ac1d9041e6f8f9ee
-  data.tar.gz: 01bfe0de3efa1fac045a49cc82292efba2d4147bf60215c720e92245179f48dd
+  metadata.gz: 16abd3bccb54974e0c04c25e04bb71e79887b728395927a119922170ad13f3d6
+  data.tar.gz: 79aee453b25eb14b62fc2f7b9842830a07d93f50c8a9b46e731679a1eeaa91f8
 SHA512:
-  metadata.gz: 5329e8796d5243f6433649f3aca56f2c48422be90f4798002170a17f9d1a6495bb4881ca1c02645319277cb3f5162e49ada023efc77115308b4902053a65090e
-  data.tar.gz: 1f821a8e5e81cd25f9342f5d1f6f5dd0a583fb14969eef2b13632252b06e0f004d3ce9858449848ab3baa0b6ef31547338f1a009d6a99b434067afa0ba25fde8
+  metadata.gz: f054786c9b9b730213d6fd582ed2bed04591d7e78ae60c54214d6f40636cf2c88b9dcf3539d3583667d04d407bad13e3a5e94cc6c1e5e871072d0e367e979d63
+  data.tar.gz: c43c6050cd0de928a77cd0b3ad41f1e9de94d97f31b38c53159011580d92ad52a0fba70dedd4d36573984835e7c3563d4662c2cbdfa9bad7f9550111d2e7a8c6

data/lib/isodoc/ietf/blocks.rb

@@ -90,7 +90,10 @@ module IsoDoc
       def pre_parse(node, out)
         out.artwork **attr_code(anchor: node["id"], align: node["align"],
                                 alt: node["alt"], type: "ascii-art") do |s|
-          s.cdata node.text.sub(/^\n/, "").gsub(/\t/, "    ")
+          # \A, not ^: ^ anchors at every line start, so /^\n/ deleted
+          # the first BLANK LINE inside the artwork instead of a
+          # leading newline (#286)
+          s.cdata node.text.sub(/\A\n/, "").gsub(/\t/, "    ")
         end
       end
 

data/lib/isodoc/ietf/cleanup_blocks.rb

@@ -146,6 +146,11 @@ module IsoDoc
 
       def sourcecode_xref(node)
         ret = @xrefs.anchor(node["target"], :xref, false)&.gsub(%r{<[^>]+>}, "")
+        # an unresolved target yields nil: degrade to the raw target
+        # text instead of crashing Node#replace (#278; trigger: xref
+        # inside a literal block in an abstract, whose anchors the
+        # xref table does not know)
+        ret ||= node["target"].to_s
         s = node["section"] and ret += ", Section #{s}"
         node.replace(ret)
       end

data/lib/isodoc/ietf/front.rb

@@ -228,16 +228,19 @@ module IsoDoc
       end
 
       def note(isoxml, front)
-        a = isoxml.at(ns("//preface/abstract/note | //preface/foreword/note")) or
-          return
-        front.note **attr_code(removeInRFC: a["removeInRFC"]) do |n|
-          title = a.at(ns("./name")) and n.name do |t|
-            title.children.each { |tt| parse(tt, t) }
-          end
-          a.children.reject { |c1| c1.name == "name" }.each do |c1|
-            parse(c1, n)
+        # every abstract note, not just the first: the .at singleton
+        # silently deleted any further notes (#285)
+        isoxml.xpath(ns("//preface/abstract/note | //preface/foreword/note"))
+          .each do |a|
+          front.note **attr_code(removeInRFC: a["removeInRFC"]) do |n|
+            title = a.at(ns("./name")) and n.name do |t|
+              title.children.each { |tt| parse(tt, t) }
+            end
+            a.children.reject { |c1| c1.name == "name" }.each do |c1|
+              parse(c1, n)
+            end
+            a.remove
           end
-          a.remove
         end
       end
 

data/lib/isodoc/ietf/lists.rb

@@ -54,7 +54,10 @@ module IsoDoc
       end
 
       def dt_parse(dterm, term)
-        if dterm.elements.empty? then term << dterm.text
+        # text, not <<: the raw-fragment insert parses the string as
+        # markup, so a bare "&" (or "<") in the term is invalid there
+        # and libxml2 drops it silently (#287; same class as #267)
+        if dterm.elements.empty? then term.text dterm.text
         else dterm.children.each { |n| parse(n, term) }
         end
       end

data/lib/isodoc/ietf/references.rb

@@ -85,11 +85,18 @@ module IsoDoc
         # unify with the shared bibrender path when refactoring the reference
         # pipeline.
         did = bib1.at(ns("./docidentifier"))
-        if !bib1.at(ns("./title")) && (f || did)
+        # A formattedref takes this path even when a title is also
+        # present: relaton-render honours the formattedref by returning
+        # it as BARE TEXT, which then lands as loose text inside
+        # <reference> -- invalid RFC XML (#279; trigger: relaton BCP
+        # collection items, e.g. citing "BCP 14").
+        if f || (!bib1.at(ns("./title")) && did)
           ref.front do |front|
             front.title do |t|
               if f then children_parse(f, t)
-              else t << did.text
+              # text, not <<: raw-fragment insert silently drops a
+              # bare "&" in the identifier (#287 sibling)
+              else t.text did.text
               end
             end
           end

data/lib/isodoc/ietf/terms.rb

@@ -86,6 +86,10 @@ module IsoDoc
       def termdocsource_parse(_node, _out); end
 
       def concept_parse(node, out)
+        # generator-emitted term-resolution failure reports
+        # (metanorma-model-iso#144) render in boldface
+        err = node.at(ns("./errormsg")) and
+          return out.strong { |s| err.children.each { |n| parse(n, s) } }
         ref = node.at(ns("./xref | ./eref | ./termref"))
         render = node.at(ns("./renderterm"))
         !ref && !render and return node.children.each { |n| parse(n, out) }

data/lib/isodoc/ietf/validation.rb

@@ -188,11 +188,21 @@ module IsoDoc
         ret
       end
 
+      # RFC 7991 s2.45.5: the legal ipr values. The old
+      # /trust200902$/ test matched only the bare lowercase value --
+      # every capital-T variant (pre5378Trust200902,
+      # noModificationTrust200902, ...) and the 200811 family were
+      # rejected as unknown (#280).
+      IPR_VALUES = %w(trust200902 noModificationTrust200902
+                      noDerivativesTrust200902 pre5378Trust200902
+                      trust200811 noModificationTrust200811
+                      noDerivativesTrust200811 none).freeze
+
       # 5.4.2.3.  "Copyright Notice" Insertion
       def ipr_check(xml)
         xml.root["ipr"] or
           return ["Missing ipr attribute on <rfc> element (:ipr:)"]
-        /trust200902$/.match(xml.root["ipr"]) or
+        IPR_VALUES.include?(xml.root["ipr"]) or
           return ["Unknown ipr attribute on <rfc> element (:ipr:): " \
                   "#{xml.root['ipr']}"]
         []

data/lib/metanorma/ietf/basicdoc.rng

@@ -954,30 +954,36 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
   <define name="TdBody">
     <choice>
       <zeroOrMore>
-        <group>
-          <a:documentation>Table cell is a block</a:documentation>
+        <choice>
+          <a:documentation>Table cell is a block; footnotes admitted inline (metanorma-model-iso#154)</a:documentation>
           <ref name="TextElement"/>
-        </group>
+          <ref name="fn"/>
+        </choice>
       </zeroOrMore>
       <oneOrMore>
-        <ref name="paragraph-with-footnote">
-          <a:documentation>Table cell contains a block</a:documentation>
-        </ref>
+        <choice>
+          <a:documentation>Table cell contains a block; notes admitted alongside paragraphs (metanorma-model-iso#157)</a:documentation>
+          <ref name="paragraph-with-footnote"/>
+          <ref name="note"/>
+        </choice>
       </oneOrMore>
     </choice>
   </define>
   <define name="TdNoIdBody">
     <choice>
       <zeroOrMore>
-        <group>
-          <a:documentation>Table cell is a block</a:documentation>
+        <choice>
+          <a:documentation>Table cell is a block; footnotes admitted inline (metanorma-model-iso#154)</a:documentation>
           <ref name="TextElement"/>
-        </group>
+          <ref name="fn"/>
+        </choice>
       </zeroOrMore>
       <oneOrMore>
-        <ref name="paragraph-with-footnote-no-id">
-          <a:documentation>Table cell contains a block</a:documentation>
-        </ref>
+        <choice>
+          <a:documentation>Table cell contains a block; notes admitted alongside paragraphs (metanorma-model-iso#157)</a:documentation>
+          <ref name="paragraph-with-footnote-no-id"/>
+          <ref name="note-no-id"/>
+        </choice>
       </oneOrMore>
     </choice>
   </define>
@@ -1030,16 +1036,9 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
       </ref>
     </optional>
     <oneOrMore>
-      <choice>
+      <ref name="ExampleBodyContent">
         <a:documentation>Content of the example</a:documentation>
-        <ref name="formula"/>
-        <ref name="ul"/>
-        <ref name="ol"/>
-        <ref name="dl"/>
-        <ref name="quote"/>
-        <ref name="sourcecode"/>
-        <ref name="paragraph-with-footnote"/>
-      </choice>
+      </ref>
     </oneOrMore>
     <zeroOrMore>
       <ref name="note">
@@ -1047,6 +1046,23 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
       </ref>
     </zeroOrMore>
   </define>
+  <define name="ExampleBodyContent">
+    <a:documentation>Content alternatives of an example. Named as an extension hook: higher
+layers may admit further alternatives additively (|=) without copying the
+example model (metanorma-model-iso#160). note is admitted interleaved as
+attested authoring practice (metanorma-model-iso#157, maintainer hierarchy
+reservation recorded there)</a:documentation>
+    <choice>
+      <ref name="formula"/>
+      <ref name="ul"/>
+      <ref name="ol"/>
+      <ref name="dl"/>
+      <ref name="quote"/>
+      <ref name="sourcecode"/>
+      <ref name="paragraph-with-footnote"/>
+      <ref name="note"/>
+    </choice>
+  </define>
   <define name="ExampleNoIdBody">
     <optional>
       <ref name="tname">
@@ -1054,16 +1070,9 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
       </ref>
     </optional>
     <oneOrMore>
-      <choice>
+      <ref name="ExampleNoIdBodyContent">
         <a:documentation>Content of the example</a:documentation>
-        <ref name="formula-no-id"/>
-        <ref name="ul-no-id"/>
-        <ref name="ol-no-id"/>
-        <ref name="dl-no-id"/>
-        <ref name="quote-no-id"/>
-        <ref name="sourcecode-no-id"/>
-        <ref name="paragraph-with-footnote-no-id"/>
-      </choice>
+      </ref>
     </oneOrMore>
     <zeroOrMore>
       <ref name="note-no-id">
@@ -1071,6 +1080,20 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
       </ref>
     </zeroOrMore>
   </define>
+  <define name="ExampleNoIdBodyContent">
+    <a:documentation>Content alternatives of the no-id example variant; extension hook as
+ExampleBodyContent (metanorma-model-iso#160)</a:documentation>
+    <choice>
+      <ref name="formula-no-id"/>
+      <ref name="ul-no-id"/>
+      <ref name="ol-no-id"/>
+      <ref name="dl-no-id"/>
+      <ref name="quote-no-id"/>
+      <ref name="sourcecode-no-id"/>
+      <ref name="paragraph-with-footnote-no-id"/>
+      <ref name="note-no-id"/>
+    </choice>
+  </define>
   <define name="admonition">
     <a:documentation>A sidebar block outside of the main flow of text, conveying particular warnings or supplementary text to the reader</a:documentation>
     <element name="admonition">

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

@@ -50,6 +50,24 @@
         </choice>
       </element>
     </define>
+    <define name="formattedref">
+      <a:documentation>Footnotes are admitted in formatted references in the standoc context:
+free-form bibliography entries may carry authored footnotes
+(metanorma-model-iso#154)</a:documentation>
+      <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>
+          <choice>
+            <ref name="TextElement"/>
+            <ref name="fn"/>
+          </choice>
+        </oneOrMore>
+      </element>
+    </define>
   </include>
   <define name="ext">
     <a:documentation>The extension point of the bibliographic description of a standardisation document</a:documentation>

data/lib/metanorma/ietf/blocks.rb

@@ -68,8 +68,9 @@ module Metanorma
         noko do |xml|
           xml.figure **literal_attrs(node) do |f|
             block_title(node, f)
-            f.pre node.lines.join("\n"),
-                  **attr_code(align: node.attr("align"), alt: node.attr("alt"))
+            pre_attrs = id_attr(node).tap { |h| h.delete(:anchor) }
+              .merge(align: node.attr("align"), alt: node.attr("alt"))
+            f.pre node.lines.join("\n"), **attr_code(pre_attrs)
           end
         end
       end

data/lib/metanorma/ietf/front.rb

@@ -65,6 +65,7 @@ module Metanorma
         end
         add_noko_elem(xml, "ipr", node.attr("ipr") || "trust200902")
         # xml.ipr (node.attr("ipr") || "trust200902")
+        xml.pi { |pi| set_pi(node, pi) }
         x = node.attr("consensus") and xml.consensus (x != "false")
         x = node.attr("index-include") and xml.indexInclude (x != "false")
         add_noko_elem(xml, "iprExtract", node.attr("ipr-extract"))
@@ -75,7 +76,6 @@ module Metanorma
         add_noko_elem(xml, "tocDepth", node.attr("toc-depth"))
         # x = node.attr("toc-depth") and xml.tocDepth x
         x = node.attr("show-on-front-page") and xml.showOnFrontPage (x != "false")
-        xml.pi { |pi| set_pi(node, pi) }
       end
 
       def set_pi(node, pi)

data/lib/metanorma/ietf/ietf.rng

@@ -1,5 +1,5 @@
 <?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">
+<grammar ns='https://www.metanorma.org/ns/standoc' 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="relaton-ietf.rng"/>
   <include href="isodoc.rng">
     <define name="ParagraphAttributes">
@@ -50,13 +50,16 @@
     </define>
     <define name="OlAttributes">
       <attribute name="type">
+        <a:documentation>One of the named numbering styles, or a renderer-native numbering
+format string passed through for xml2rfc to expand, e.g. "R%d"
+(metanorma-model-iso#159; subsumes the former "text" named value)</a:documentation>
         <choice>
           <value>roman</value>
           <value>alphabet</value>
           <value>arabic</value>
           <value>roman_upper</value>
           <value>alphabet_upper</value>
-          <value>text</value>
+          <text/>
         </choice>
       </attribute>
       <optional>
@@ -140,28 +143,6 @@
         <ref name="XrefBody"/>
       </element>
     </define>
-    <define name="erefType">
-      <optional>
-        <attribute name="normative">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <attribute name="citeas"/>
-      <attribute name="type">
-        <ref name="ReferenceFormat"/>
-      </attribute>
-      <optional>
-        <attribute name="alt"/>
-      </optional>
-      <optional>
-        <attribute name="displayFormat"/>
-      </optional>
-      <optional>
-        <attribute name="relative"/>
-      </optional>
-      <ref name="CitationType"/>
-      <text/>
-    </define>
     <define name="quote-source">
       <element name="source">
         <ref name="erefTypeURI"/>
@@ -261,6 +242,25 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="erefType" combine="interleave">
+    <a:documentation>RFC XML idiosyncratic attributes on cross-references to bibliographic
+entities. Additive augmentation of the base erefType: the former wholesale
+redefinition in the override block had rotted against the base grammar
+(bare mixed text predating ErefBody/display-text), and is retired per the
+flavor-override-elimination direction (metanorma-model-iso#158). NB @type
+thereby reverts to optional (base): requiredness cannot be tightened
+through &amp;=; the generator always emits it</a:documentation>
+    <optional>
+      <attribute name="displayFormat">
+        <a:documentation>Rendering format for the reference in RFC XML (xml2rfc displayFormat)</a:documentation>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="relative">
+        <a:documentation>Reference target expressed relative to the containing document (xml2rfc relative)</a:documentation>
+      </attribute>
+    </optional>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="review"/>
   </define>

data/lib/metanorma/ietf/isodoc.rng

@@ -27,11 +27,89 @@
     <define name="amend">
       <a:documentation>Block expressing a machine-readable change in a document</a:documentation>
       <element name="amend">
+        <ref name="OptionalId"/>
         <ref name="BlockAttributes"/>
-        <ref name="AmendType"/>
+        <attribute name="change">
+          <a:documentation>The type of change described in this block</a:documentation>
+          <choice>
+            <value>add</value>
+            <value>modify</value>
+            <value>delete</value>
+            <value>replace</value>
+          </choice>
+        </attribute>
+        <optional>
+          <attribute name="path"/>
+        </optional>
+        <optional>
+          <attribute name="path_end"/>
+        </optional>
+        <optional>
+          <attribute name="title"/>
+        </optional>
+        <optional>
+          <attribute name="position">
+            <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>
+            <zeroOrMore>
+              <choice>
+                <ref name="locality"/>
+                <ref name="localityStack"/>
+              </choice>
+            </zeroOrMore>
+          </element>
+        </optional>
         <zeroOrMore>
           <ref name="autonumber">
-            <a:documentation>Specification of how blocks of a given class should be autonumbered within an AmendBlock newContent element</a:documentation>
+            <a:documentation>Specification of how blocks of a given class should be autonumbered within the newcontent element.
+Precedes the content it numbers</a:documentation>
+          </ref>
+        </zeroOrMore>
+        <zeroOrMore>
+          <element name="description">
+            <a:documentation>Description(s) of the change described in this block</a:documentation>
+            <oneOrMore>
+              <ref name="BasicBlock"/>
+            </oneOrMore>
+          </element>
+        </zeroOrMore>
+        <optional>
+          <element name="newcontent">
+            <a:documentation>New content to be added to the document; applicable to add and modify.
+Can be blocks and/or clauses</a:documentation>
+            <ref name="OptionalId"/>
+            <zeroOrMore>
+              <choice>
+                <ref name="BasicBlock"/>
+                <ref name="clause"/>
+              </choice>
+            </zeroOrMore>
+          </element>
+        </optional>
+        <zeroOrMore>
+          <element name="description">
+            <a:documentation>Further description(s) of the change, following the new content
+(e.g. consequential renumbering instructions)</a:documentation>
+            <oneOrMore>
+              <ref name="BasicBlock"/>
+            </oneOrMore>
+          </element>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="classification">
+            <a:documentation>Classification of the change</a:documentation>
+          </ref>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="contributor">
+            <a:documentation>Contributor responsible for the change</a:documentation>
           </ref>
         </zeroOrMore>
       </element>
@@ -42,6 +120,27 @@ All IdRefType instances point not to `@id` in Semantic XML, which is the Content
 but to `@anchor`, the user-supplied cross-reference</a:documentation>
       <text/>
     </define>
+    <define name="image-no-id">
+      <a:documentation>Container for image content: optional ID attributes recursively (for use in Relaton, metadata).
+The embedded SVG content is admitted here as in ImageBody, and is NOT subject to the no-id
+convention of this model family: SVGs carry ids pervasively, and those ids cannot be stripped,
+because they are load-bearing for image-map functionality (svgmap hyperlink targets)</a:documentation>
+      <element name="image">
+        <ref name="OptionalId"/>
+        <ref name="ImageAttributes"/>
+        <optional>
+          <element name="svg">
+            <a:documentation>image can contain SVG XML, which is used to access its identifiers within the Metanorma XML</a:documentation>
+            <oneOrMore>
+              <choice>
+                <text/>
+                <ref name="AnyElement"/>
+              </choice>
+            </oneOrMore>
+          </element>
+        </optional>
+      </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>
@@ -49,7 +148,7 @@ the type attribute defaults to `review` for reviews</a:documentation>
         <ref name="RequiredId"/>
         <ref name="ReviewAttributes"/>
         <oneOrMore>
-          <ref name="paragraph">
+          <ref name="BasicBlock">
             <a:documentation>Reviewer comments content</a:documentation>
           </ref>
         </oneOrMore>
@@ -85,10 +184,14 @@ the type attribute defaults to `review` for reviews</a:documentation>
     <define name="section-title">
       <a:documentation>Title(s) of a clause</a:documentation>
       <element name="title">
-        <a:documentation>Title proper for a clause</a:documentation>
+        <a:documentation>Title proper for a clause. Footnotes on section headings are admitted
+(metanorma-model-iso#154)</a:documentation>
         <ref name="RequiredId"/>
         <zeroOrMore>
-          <ref name="TextElement"/>
+          <choice>
+            <ref name="TextElement"/>
+            <ref name="fn"/>
+          </choice>
         </zeroOrMore>
       </element>
       <zeroOrMore>
@@ -154,13 +257,17 @@ Sources are currently only rendered in metanorma-plateau</a:documentation>
       <ref name="BlockAttributes"/>
       <optional>
         <attribute name="type">
-          <a:documentation>Type of numbering to be applied to the list items</a:documentation>
+          <a:documentation>Type of numbering to be applied to the list items: one of the five named
+numbering styles, or a renderer-native numbering format string passed
+through for the target rendering language to expand (e.g. xml2rfc v2
+format strings such as "R%d", carried through by metanorma-ietf)</a:documentation>
           <choice>
             <value>roman</value>
             <value>alphabet</value>
             <value>arabic</value>
             <value>roman_upper</value>
             <value>alphabet_upper</value>
+            <text/>
           </choice>
         </attribute>
       </optional>
@@ -220,30 +327,23 @@ Sources are currently only rendered in metanorma-plateau</a:documentation>
         </attribute>
       </optional>
     </define>
-    <define name="ExampleBody">
-      <optional>
-        <ref name="tname">
-          <a:documentation>The caption of the example</a:documentation>
-        </ref>
-      </optional>
-      <oneOrMore>
-        <choice>
-          <a:documentation>Content of the example</a:documentation>
-          <ref name="formula"/>
-          <ref name="ul"/>
-          <ref name="ol"/>
-          <ref name="dl"/>
-          <ref name="quote"/>
-          <ref name="sourcecode"/>
-          <ref name="paragraph-with-footnote"/>
-          <ref name="figure"/>
-        </choice>
-      </oneOrMore>
-      <zeroOrMore>
-        <ref name="note">
-          <a:documentation>Notes whose scope is the current block</a:documentation>
-        </ref>
-      </zeroOrMore>
+    <define name="ExampleBodyContent">
+      <a:documentation>Content alternatives of an example in the isodoc context: as basicdoc,
+with figure admitted, and note admitted only trailing the example body
+rather than interleaved. The content hook is overridden rather than
+ExampleBody itself, so that the extension seam survives: additive
+admissions (|=) from higher layers, such as illustrative provisions in
+reqt, attach to the definition that governs (metanorma-model-iso#160)</a:documentation>
+      <choice>
+        <ref name="formula"/>
+        <ref name="ul"/>
+        <ref name="ol"/>
+        <ref name="dl"/>
+        <ref name="quote"/>
+        <ref name="sourcecode"/>
+        <ref name="paragraph-with-footnote"/>
+        <ref name="figure"/>
+      </choice>
     </define>
     <define name="TableBody">
       <optional>
@@ -413,20 +513,22 @@ and is intended to be referenced by a callout within the source code</a:document
     <define name="source">
       <element name="source">
         <attribute name="status">
-          <a:documentation>The status of the term as it is used in this document, relative to its definition in the original document</a:documentation>
+          <a:documentation>The status of the block content, relative to the source it has been taken from</a:documentation>
           <ref name="SourceStatusType"/>
         </attribute>
-        <attribute name="type">
-          <a:documentation>The type of the managed term in the present context</a:documentation>
-          <ref name="SourceTypeType"/>
-        </attribute>
+        <optional>
+          <attribute name="type">
+            <a:documentation>The type of the source relation. Term-management vocabulary (authoritative/lineage);
+not normally applicable to block attribution, and omitted by the generator for blocks</a:documentation>
+            <ref name="SourceTypeType"/>
+          </attribute>
+        </optional>
         <ref name="origin">
-          <a:documentation>The original document and location where the term definition has been obtained from</a:documentation>
+          <a:documentation>The original document and location the block content has been obtained from</a:documentation>
         </ref>
         <optional>
           <ref name="modification">
-            <a:documentation>Any changes that the definition of the term has undergone relative to the original document,
-in order to be applicable in this standardisation document</a:documentation>
+            <a:documentation>Any changes that the block content has undergone relative to the original document</a:documentation>
           </ref>
         </optional>
       </element>
@@ -852,6 +954,11 @@ titlecase, or lowercase</a:documentation>
         <a:documentation>Width of the figure block in rendering</a:documentation>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="height">
+        <a:documentation>Height of the figure block in rendering</a:documentation>
+      </attribute>
+    </optional>
     <ref name="BlockAttributesCore"/>
   </define>
   <define name="SourceAttributes" combine="interleave">
@@ -1066,6 +1173,9 @@ parargaph sources are currently only rendered in metanorma-plateau</a:documentat
     <a:documentation>Internal reference (for Metanorma document collections)</a:documentation>
   </define>
   <define name="TextElement" combine="choice">
+    <a:documentation>Form input elements are admitted as inline content generally, mirroring
+HTML phrasing content: inputs sit inside paragraphs and table cells
+within forms (metanorma-model-iso#145)</a:documentation>
     <choice>
       <ref name="concept"/>
       <ref name="add"/>
@@ -1073,13 +1183,18 @@ parargaph sources are currently only rendered in metanorma-plateau</a:documentat
       <ref name="span"/>
       <ref name="erefstack"/>
       <ref name="date_inline"/>
+      <ref name="FormInput"/>
+      <ref name="formlabel"/>
     </choice>
   </define>
   <define name="PureTextElement" combine="choice">
     <ref name="passthrough_inline"/>
   </define>
   <define name="NestedTextElement" combine="choice">
-    <ref name="erefstack"/>
+    <choice>
+      <ref name="erefstack"/>
+      <ref name="concept"/>
+    </choice>
   </define>
   <define name="passthrough_inline">
     <a:documentation>Inline text not to be processed semantically, and left in the markup of a target rendering language (e.g. raw HTML)</a:documentation>
@@ -1227,9 +1342,26 @@ That concept may be defined as a term within the current document, or it may be
         <ref name="termref">
           <a:documentation>Link to a definition of the term in a termbase</a:documentation>
         </ref>
+        <ref name="errormsg">
+          <a:documentation>Error message inserted by the Metanorma generator, replacing a concept reference
+that could not be resolved. Only ever emitted by Metanorma itself, never authored;
+its presence marks the document as not ready for publication</a:documentation>
+        </ref>
       </choice>
     </element>
   </define>
+  <define name="errormsg">
+    <a:documentation>Error message inserted by the Metanorma generator, replacing markup it could not process</a:documentation>
+    <element name="errormsg">
+      <zeroOrMore>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
   <define name="BasicBlock" combine="choice">
     <choice>
       <ref name="requirement"/>
@@ -1272,12 +1404,16 @@ That concept may be defined as a term within the current document, or it may be
     <a:documentation>Input form, for use under HTML</a:documentation>
     <element name="form">
       <ref name="RequiredId"/>
-      <attribute name="name">
-        <a:documentation>Name of the input form block</a:documentation>
-      </attribute>
-      <attribute name="action">
-        <a:documentation>Action to be taken on submission of the input form</a:documentation>
-      </attribute>
+      <optional>
+        <attribute name="name">
+          <a:documentation>Name of the input form block</a:documentation>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="action">
+          <a:documentation>Action to be taken on submission of the input form</a:documentation>
+        </attribute>
+      </optional>
       <optional>
         <attribute name="class">
           <a:documentation>Class of input form</a:documentation>
@@ -1289,8 +1425,13 @@ avoid duplicating the custom-class slot in BlockAttributes. Treated like
 figure. See metanorma/metanorma-standoc#1197</a:documentation>
       </ref>
       <zeroOrMore>
-        <!-- Input form contents -->
+        <!--
+          Input form contents: as in HTML, a form contains block-level content,
+          with form input elements appearing inline within it
+        -->
         <choice>
+          <ref name="paragraph-with-footnote"/>
+          <ref name="table"/>
           <ref name="TextElement"/>
           <ref name="FormInput"/>
           <ref name="formlabel"/>
@@ -1734,14 +1875,18 @@ terms sections</a:documentation>
         </ref>
       </optional>
       <oneOrMore>
-        <zeroOrMore>
+        <choice>
           <ref name="BasicBlock">
-            <a:documentation>Prefatory material, may be specific to each definition list</a:documentation>
+            <a:documentation>Prefatory or discursive material; a symbols section may consist of prose only,
+e.g. deferring to symbols defined in another standard</a:documentation>
           </ref>
-        </zeroOrMore>
-        <ref name="dl">
-          <a:documentation>Definition list containing symbols and abbreviations</a:documentation>
-        </ref>
+          <ref name="dl">
+            <a:documentation>Definition list(s) containing symbols and abbreviations</a:documentation>
+          </ref>
+          <ref name="definitions">
+            <a:documentation>Subsections of the symbols section</a:documentation>
+          </ref>
+        </choice>
       </oneOrMore>
     </element>
   </define>
@@ -2011,22 +2156,31 @@ used in document amendments</a:documentation>
         <a:documentation>Type of relation of term applicable</a:documentation>
         <ref name="RelatedTermType"/>
       </attribute>
-      <element name="preferred">
-        <a:documentation>Preferred designation of the term related to the current term</a:documentation>
-        <ref name="Designation"/>
-      </element>
       <choice>
-        <ref name="eref">
-          <a:documentation>Link to a definition of the term in a bibliographic entry</a:documentation>
-        </ref>
-        <ref name="erefstack">
-          <a:documentation>Stack of links to a definition of the term in a bibliographic entry</a:documentation>
-        </ref>
-        <ref name="xref">
-          <a:documentation>Link to a definition of the term in an element of the current document</a:documentation>
-        </ref>
-        <ref name="termref">
-          <a:documentation>Link to a definition of the term in a termbase</a:documentation>
+        <group>
+          <element name="preferred">
+            <a:documentation>Preferred designation of the term related to the current term</a:documentation>
+            <ref name="Designation"/>
+          </element>
+          <choice>
+            <ref name="eref">
+              <a:documentation>Link to a definition of the term in a bibliographic entry</a:documentation>
+            </ref>
+            <ref name="erefstack">
+              <a:documentation>Stack of links to a definition of the term in a bibliographic entry</a:documentation>
+            </ref>
+            <ref name="xref">
+              <a:documentation>Link to a definition of the term in an element of the current document</a:documentation>
+            </ref>
+            <ref name="termref">
+              <a:documentation>Link to a definition of the term in a termbase</a:documentation>
+            </ref>
+          </choice>
+        </group>
+        <ref name="errormsg">
+          <a:documentation>Error message inserted by the Metanorma generator, replacing a related-term
+reference that could not be resolved. Only ever emitted by Metanorma itself,
+never authored; its presence marks the document as not ready for publication</a:documentation>
         </ref>
       </choice>
     </element>
@@ -2177,16 +2331,21 @@ used in document amendments</a:documentation>
           <data type="boolean"/>
         </attribute>
       </optional>
-      <element name="name">
-        <a:documentation>The textual form of the designation</a:documentation>
-        <zeroOrMore>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="index"/>
-            <ref name="index-xref"/>
-          </choice>
-        </zeroOrMore>
-      </element>
+      <oneOrMore>
+        <element name="name">
+          <a:documentation>The textual form of the designation. Repeated for language variants of the
+same designation: repetition of name with language attributes replaces the
+retired variant element (metanorma-standoc#940, metanorma-model-iso#155)</a:documentation>
+          <ref name="LocalizedStringAttributes"/>
+          <zeroOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="index"/>
+              <ref name="index-xref"/>
+            </choice>
+          </zeroOrMore>
+        </element>
+      </oneOrMore>
       <optional>
         <element name="abbreviation-type">
           <a:documentation>Type of abbreviation that constitutes the designation, according to how it is formed</a:documentation>
@@ -2556,6 +2715,7 @@ to better fit some local requirement, though still with the intent of retaining
           <value>sourcecode</value>
           <value>example</value>
           <value>note</value>
+          <value>clause</value>
         </choice>
       </attribute>
       <text>

data/lib/metanorma/ietf/reqt.rng

@@ -35,9 +35,12 @@ the tag name of the top level containers</a:documentation>
         <ref name="ReqtObligationType"/>
       </attribute>
     </optional>
-    <attribute name="id">
-      <data type="ID"/>
-    </attribute>
+    <ref name="RequiredId">
+      <a:documentation>Identification of provisions routed through the shared ID patterns,
+like every other identified block: content GUID in `id`, with the
+isodoc context adding the user-supplied `anchor` (e.g. Modspec
+identifiers) and `source` (metanorma-model-iso#149)</a:documentation>
+    </ref>
     <ref name="NumberingAttributes"/>
     <ref name="BlockAttributesCore">
       <a:documentation>requirement carries its own semantic `class` (provision class, below), so
@@ -126,6 +129,15 @@ interruption by other sub-containers</a:documentation>
           <a:documentation>Provisions nested within this provision, which cannot be referenced autonomously and have
 subclasses specific to the parent provision. Not expressed with provision metadata</a:documentation>
         </ref>
+        <ref name="requirement">
+          <a:documentation>Provisions nested within this provision, which are self-standing and do not have
+subclasses specific to the parent provision. Interleaved with the other
+sub-containers: a requirements class alternates descriptions with its member
+provisions, and descriptions resume after interruption
+(metanorma-model-iso#160)</a:documentation>
+        </ref>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
       </choice>
     </zeroOrMore>
     <optional>
@@ -133,15 +145,17 @@ subclasses specific to the parent provision. Not expressed with provision metada
         <a:documentation>A list of references for the requirement, following the Relaton model</a:documentation>
       </ref>
     </optional>
-    <zeroOrMore>
-      <choice>
-        <a:documentation>Provisions nested within this provision, which are self-standing and do not have
-subclasses specific to the parent provision</a:documentation>
-        <ref name="requirement"/>
-        <ref name="recommendation"/>
-        <ref name="permission"/>
-      </choice>
-    </zeroOrMore>
+  </define>
+  <define name="ExampleBodyContent" combine="choice">
+    <a:documentation>Provisions presented illustratively inside examples. This shape is
+expected only in documents defining schemas and standards (e.g. the
+Modspec specification exhibiting requirement boxes), not in
+standards proper (metanorma-model-iso#160)</a:documentation>
+    <choice>
+      <ref name="requirement"/>
+      <ref name="recommendation"/>
+      <ref name="permission"/>
+    </choice>
   </define>
   <define name="reqtitle">
     <element name="title">
@@ -214,6 +228,12 @@ subclasses specific to the parent provision</a:documentation>
 mixture of the two.
 A machine-readable component can be included as source code with
 nomination of the language</a:documentation>
+    <ref name="OptionalId">
+      <a:documentation>Identification of subparts routed through the shared ID patterns
+(metanorma-model-iso#149). Optional, not required: only some generator
+pipelines (Modspec) stamp subparts with content GUIDs; others emit
+description/specification/component without ids</a:documentation>
+    </ref>
     <optional>
       <attribute name="type">
         <a:documentation>Type of sub-container.

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.7.10".freeze
+    VERSION = "3.7.11".freeze
   end
 end

data/lib/relaton/render/parse.rb

@@ -14,11 +14,18 @@ module Relaton
                     abstract: abstract(doc))
         end
 
-        def home_standard(_doc, pubs)
+        def home_standard(doc, pubs)
           pubs&.any? do |r|
             ["Internet Engineering Task Force", "IETF", "RFC Publisher"]
               .include?(r[:nonpersonal])
-          end
+          end ||
+            # an Internet-Draft is an IETF-stream document even though
+            # its relaton record carries no publisher contributor;
+            # without this, draft references fell to the refcontent
+            # branch and never got the seriesInfo that makes xml2rfc
+            # render "Work in Progress, Internet-Draft, ..." (#283)
+            Array(doc.docidentifier)
+              .any? { |i| i.type == "Internet-Draft" }
         end
 
         # allow publisher for standards
@@ -103,13 +110,17 @@ module Relaton
           datepick(ret)
         end
 
-        # return authors and editors together
+        # return authors and editors together, in DOCUMENT order:
+        # concatenating all authors then all editors re-ordered mixed
+        # lists — RFC 5234 (data order Crocker (ed.), Overell)
+        # rendered as "Overell, P. and D. Crocker", and organisational
+        # authors were hoisted over persons (#284)
         def creatornames1(doc)
           return [] if doc.nil?
 
-          add1 = pick_contributor(doc, "author") || []
-          add2 = pick_contributor(doc, "editor") || []
-          cr = add1 + add2
+          cr = Array(doc.contributor).select do |c|
+            Array(c.role).any? { |r| %w(author editor).include?(r.type) }
+          end
           cr.empty? or return cr
           super
         end
@@ -119,8 +130,26 @@ module Relaton
           bcp = Array(doc.series).detect do |s|
             %w(BCP STD).include?(Array(s.title).first&.content)
           end
-          bcp and ret.unshift("BCP\u00A0#{bcp.number}")
-          ret.reject { |x| /(rfc-anchor|Internet-Draft)/.match?(x) }
+          # label the sub-series by its own title: the unconditional
+          # "BCP" prefix rendered every STD-series RFC as BCP
+          # (STD 63 -> "BCP 63", #282)
+          bcp and ret.unshift(
+            "#{Array(bcp.title).first&.content}\u00A0#{bcp.number}",
+          )
+          # Internet-Draft identifiers stay: rejecting them (as the
+          # rfc-anchor internals rightly are) left draft references
+          # with NO seriesInfo, so xml2rfc never rendered "Work in
+          # Progress, Internet-Draft, draft-name" (#283). Only the
+          # unversioned duplicate of the primary id is dropped.
+          primary = ret.grep(/Internet-Draft/).max_by(&:length)
+          ret.reject do |x|
+            /rfc-anchor/.match?(x) ||
+              (/Internet-Draft/.match?(x) && x != primary) ||
+              # the I-D. anchor form duplicates the real draft name
+              # with an unprefixed, unversioned value — drop it when
+              # a proper Internet-Draft identifier is present
+              (primary && /I-D\./.match?(x))
+          end
             .map { |x| x.gsub(/<\/?esc>/, "").tr(" ", "\u00A0") }
         end
 

data/metanorma-ietf.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
 
   spec.add_dependency "metanorma-ietf-data"
-  spec.add_dependency "metanorma-standoc", "~> 3.4.2"
+  spec.add_dependency "metanorma-standoc", "~> 3.5.0"
   spec.add_dependency "relaton-render"
 
   spec.add_development_dependency "canon" #, "= 0.2.3"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 3.7.10
+  version: 3.7.11
 platform: ruby
 authors:
 - Ribose Inc.
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: 3.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: relaton-render
   requirement: !ruby/object:Gem::Requirement
@@ -334,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: metanorma-ietf lets you write IETF documents, such as Internet-Drafts and
   RFCs, in AsciiDoc.