metanorma-ietf 3.5.5 → 3.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2bbef6e584be1dd783e7737b1e05b43a6ed524acc3cd3affb2edbe407d3417b
-  data.tar.gz: '097b2d98f09a4ff356b7000ba0ccb683194c36a8edfbb9c39895a314f663da68'
+  metadata.gz: 5a7a8acefbf989aea665a8fbbb0e60447c921ee34527b9b1ba07526d281c35db
+  data.tar.gz: 5fdd90c1ad276336baf77616781b92bde24fa381752f6e8fc523f8d3a79d9c08
 SHA512:
-  metadata.gz: aab2b309ce5d38c345ffd952fdcbcc07f723b35b2d3d31a2be9301ed0a390d31a8991c83aa6500ec47cfd1b11004f3ef99961ab89f7509168547b281685dc578
-  data.tar.gz: 55d97a53151343f37471913d54ee369f847bce6eff6fceb160980e5025a257714a992790562eab342d9be92c071fcbe9ee42309b1185514c14b79bf5698762b7
+  metadata.gz: 6e431686a4ed4fae904657b67f891c8dd1dc7f5ef1c33a1dbb04bc9d07b993801ab1b7d0423ff298d73ff4c2319393b9a0890d3d167177a70fcdee0289c80488
+  data.tar.gz: e9d77d069d55d1e36b98fa249e0e4ac8e0183a71c6fb53014626ccaa5a2a344d4b1952ef95c3f3bc4bad0160e6fe6bb10c602ef7f33b030e4b4701c11db8bcdf

data/lib/isodoc/ietf/blocks.rb

@@ -57,7 +57,7 @@ module IsoDoc
         end
       end
 
-      def source_parse(node, out)
+      def semx_source_parse(node, out)
         termref_parse(node, out)
       end
 

data/lib/isodoc/ietf/terms.rb

@@ -127,7 +127,7 @@ module IsoDoc
         origin = elem.at(ns("./origin"))
         s = termsource_status(elem["status"]) and origin.next = l10n(", #{s}")
         termsource_add_modification_text(elem.at(ns("./modification")))
-        while elem&.next_element&.name == "termsource"
+        while elem&.next_element&.name == "source"
           elem << "; #{to_xml(elem.next_element.remove.children)}"
         end
       end

data/lib/metanorma/ietf/basicdoc.rng

@@ -267,6 +267,10 @@ in a document (e.g. sourcecode annotations)</a:documentation>
       <value>justified</value>
     </choice>
   </define>
+  <define name="IdRefType">
+    <a:documentation>Type of cross-references to elements. In BasicDoc, these always point to id { xsd:ID } </a:documentation>
+    <data type="IDREF"/>
+  </define>
   <define name="RequiredId">
     <a:documentation>Mandatory anchor of element, to be used for cross-references within the document</a:documentation>
     <attribute name="id">
@@ -409,13 +413,13 @@ in a document (e.g. sourcecode annotations)</a:documentation>
       <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"/>
+        <ref name="IdRefType"/>
       </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"/>
+        <ref name="IdRefType"/>
       </attribute>
     </optional>
   </define>
@@ -1504,7 +1508,7 @@ Restricted recursively to contain only other such inline elements with no identi
         <attribute name="to">
           <a:documentation>A reference to an anchor element (typically a bookmark), 
 to indicate that the index range covers a range of locations between the current index element and the `to` anchor</a:documentation>
-          <data type="IDREF"/>
+          <ref name="IdRefType"/>
         </attribute>
       </optional>
       <ref name="index-primary">
@@ -1662,7 +1666,7 @@ which can be bookmarks as well as block or section references</a:documentation>
   <define name="XrefAttributes">
     <attribute name="target">
       <a:documentation>The identifier of a section, block or inlined element being referenced</a:documentation>
-      <data type="IDREF"/>
+      <ref name="IdRefType"/>
     </attribute>
     <optional>
       <attribute name="type">
@@ -1723,7 +1727,7 @@ The target of a footnote is the location it is embedded in within the text</a:do
       <attribute name="target">
         <a:documentation>The target of the callout is understood to be the location of the callout within the source code; 
 the extent of the target is not expressed overtly</a:documentation>
-        <data type="IDREF"/>
+        <ref name="IdRefType"/>
       </attribute>
       <text>
         <a:documentation>The label of the callout, used to identify its target within the source code</a:documentation>

data/lib/metanorma/ietf/blocks.rb

@@ -2,36 +2,40 @@ module Metanorma
   module Ietf
     class Converter < ::Metanorma::Standoc::Converter
       def para_attrs(node)
-        attr_code("keep-with-next": node.attr("keepWithNext") ||
-                  node.attr("keep-with-next"),
-                  "keep-with-previous": node.attr("keepWithPrevious") ||
-                 node.attr("keep-with-previous"),
-                  indent: node.attr("indent"),
-                  id: ::Metanorma::Utils::anchor_or_uuid(node))
+        attr_code(id_attr(node).merge(
+                    "keep-with-next": node.attr("keepWithNext") ||
+                            node.attr("keep-with-next"),
+                    "keep-with-previous": node.attr("keepWithPrevious") ||
+                           node.attr("keep-with-previous"),
+                    indent: node.attr("indent"),
+                  ))
       end
 
       def ul_attrs(node)
-        attr_code(id: ::Metanorma::Utils::anchor_or_uuid(node),
-                  nobullet: node.attr("nobullet") || node.attr("empty"),
-                  indent: node.attr("indent"),
-                  bare: node.attr("bare"),
-                  spacing: node.attr("spacing"))
+        attr_code(id_attr(node).merge(
+                    nobullet: node.attr("nobullet") || node.attr("empty"),
+                    indent: node.attr("indent"),
+                    bare: node.attr("bare"),
+                    spacing: node.attr("spacing"),
+                  ))
       end
 
       def ol_attrs(node)
-        attr_code(id: ::Metanorma::Utils::anchor_or_uuid(node),
-                  type: node.attr("format") || olist_style(node.style),
-                  group: node.attr("group"),
-                  spacing: node.attr("spacing"),
-                  indent: node.attr("indent"),
-                  start: node.attr("start"))
+        attr_code(id_attr(node).merge(
+                    type: node.attr("format") || olist_style(node.style),
+                    group: node.attr("group"),
+                    spacing: node.attr("spacing"),
+                    indent: node.attr("indent"),
+                    start: node.attr("start"),
+                  ))
       end
 
       def dl_attrs(node)
-        attr_code(id: ::Metanorma::Utils::anchor_or_uuid(node),
-                  newline: node.attr("newline"),
-                  indent: node.attr("indent"),
-                  spacing: node.attr("spacing"))
+        attr_code(id_attr(node).merge(
+                    newline: node.attr("newline"),
+                    indent: node.attr("indent"),
+                    spacing: node.attr("spacing"),
+                  ))
       end
 
       def todo_attrs(node)
@@ -39,11 +43,10 @@ module Metanorma
       end
 
       def sidebar(node)
-        return unless draft?
-
+        draft? or return
         noko do |xml|
           xml.review **sidebar_attrs(node) do |r|
-            node.title.nil? or r.name { |name| name << node.title }
+            block_title(node, r)
             wrap_in_para(node, r)
           end
         end
@@ -51,9 +54,10 @@ module Metanorma
 
       def note(node)
         noko do |xml|
-          xml.note **attr_code(id: ::Metanorma::Utils::anchor_or_uuid(nil),
-                               removeInRFC: node.attr("remove-in-rfc")) do |c|
-            node.title.nil? or c.name { |name| name << node.title }
+          xml.note **attr_code(id_attr(node).merge(
+                                 removeInRFC: node.attr("remove-in-rfc"),
+                               )) do |c|
+            block_title(node, c)
             wrap_in_para(node, c)
           end
         end
@@ -62,11 +66,9 @@ module Metanorma
       def literal(node)
         noko do |xml|
           xml.figure **literal_attrs(node) do |f|
-            figure_title(node, f)
+            block_title(node, f)
             f.pre node.lines.join("\n"),
-                  **attr_code(align: node.attr("align"),
-                              id: ::Metanorma::Utils::anchor_or_uuid(nil),
-                              alt: node.attr("alt"))
+                  **attr_code(align: node.attr("align"), alt: node.attr("alt"))
           end
         end
       end

data/lib/metanorma/ietf/cleanup.rb

@@ -26,7 +26,7 @@ module Metanorma
 
       def cref_cleanup(xmldoc)
         xmldoc.xpath("//crefref").each do |r|
-          if c = xmldoc.at("//review[@id = '#{r.text}']")
+          if c = xmldoc.at("//review[@anchor = '#{r.text}']")
             id = "_#{UUIDTools::UUID.random_create}"
             c["from"] = id
             c["to"] = id

data/lib/metanorma/ietf/isodoc.rng

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-<!-- VERSION v2.0.4 -->
+<!-- VERSION v2.0.7 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -36,6 +36,12 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="IdRefType">
+      <a:documentation>Cross-references are not normalised to xsd:IDREF in Semantic XML: that is deferred to Presentation XML.
+All IdRefType instances point not to `@id` in Semantic XML, which is the Content GUID for an element,
+but to `@anchor`, the user-supplied cross-reference</a:documentation>
+      <text/>
+    </define>
     <define name="index-primary">
       <element name="primary">
         <oneOrMore>
@@ -70,6 +76,7 @@
       <a:documentation>Title(s) of a clause</a:documentation>
       <element name="title">
         <a:documentation>Title proper for a clause</a:documentation>
+        <ref name="RequiredId"/>
         <zeroOrMore>
           <ref name="TextElement"/>
         </zeroOrMore>
@@ -77,10 +84,19 @@
       <zeroOrMore>
         <element name="variant-title">
           <a:documentation>Alternate title for a clause</a:documentation>
+          <ref name="RequiredId"/>
           <ref name="TypedTitleString"/>
         </element>
       </zeroOrMore>
     </define>
+    <define name="tname">
+      <element name="name">
+        <ref name="RequiredId"/>
+        <oneOrMore>
+          <ref name="NestedTextElement"/>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="UlBody">
       <optional>
         <ref name="tname">
@@ -238,7 +254,7 @@
           <a:documentation>Notes specific to this block</a:documentation>
         </ref>
       </zeroOrMore>
-      <ref name="TermSource">
+      <ref name="BlockSource">
         <a:documentation>A source for the table</a:documentation>
       </ref>
     </define>
@@ -262,10 +278,112 @@ and is intended to be referenced by a callout within the source code</a:document
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
-      <ref name="TermSource">
+      <ref name="BlockSource">
+        <a:documentation>A source for the block</a:documentation>
+      </ref>
+    </define>
+    <define name="FigureBody">
+      <optional>
+        <ref name="tname">
+          <a:documentation>The caption of the block</a:documentation>
+        </ref>
+      </optional>
+      <choice>
+        <a:documentation>Content of the figure</a:documentation>
+        <ref name="image"/>
+        <ref name="video"/>
+        <ref name="audio"/>
+        <ref name="pre"/>
+        <oneOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="figure"/>
+        </zeroOrMore>
+      </choice>
+      <zeroOrMore>
+        <ref name="fn">
+          <a:documentation>Footnotes specific to the figure</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <optional>
+        <ref name="dl">
+          <a:documentation>An optional definitions list defining any symbols used in the figure</a:documentation>
+        </ref>
+      </optional>
+      <zeroOrMore>
+        <ref name="note">
+          <a:documentation>Notes whose scope is the current block</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>A source for the block</a:documentation>
+      </ref>
+    </define>
+    <define name="FigureNoIdBody">
+      <optional>
+        <ref name="source">
+          <a:documentation>A URI or other reference intended to link to an externally hosted image (or equivalent)</a:documentation>
+        </ref>
+      </optional>
+      <optional>
+        <ref name="tname">
+          <a:documentation>The caption of the block</a:documentation>
+        </ref>
+      </optional>
+      <choice>
+        <a:documentation>Content of the figure</a:documentation>
+        <ref name="image-no-id"/>
+        <ref name="video-no-id"/>
+        <ref name="audio-no-id"/>
+        <ref name="pre-no-id"/>
+        <oneOrMore>
+          <ref name="paragraph-with-footnote-no-id"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="figure-no-id"/>
+        </zeroOrMore>
+      </choice>
+      <zeroOrMore>
+        <ref name="fn">
+          <a:documentation>Footnotes specific to the figure</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <optional>
+        <ref name="dl-no-id">
+          <a:documentation>An optional definitions list defining any symbols used in the figure</a:documentation>
+        </ref>
+      </optional>
+      <zeroOrMore>
+        <ref name="note-no-id">
+          <a:documentation>Notes whose scope is the current block</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <ref name="BlockSource">
         <a:documentation>A source for the block</a:documentation>
       </ref>
     </define>
+    <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>
+          <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>
+        <ref name="origin">
+          <a:documentation>The original document and location where the term definition 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>
+          </ref>
+        </optional>
+      </element>
+    </define>
     <define name="sourcecodebody">
       <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
 (The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
@@ -367,6 +485,7 @@ normative or informative references, some split references into sections organiz
     <!-- exclude figures? -->
     <define name="dd">
       <element name="dd">
+        <ref name="OptionalId"/>
         <zeroOrMore>
           <!-- exclude figures? -->
           <ref name="BasicBlock"/>
@@ -418,6 +537,7 @@ normative or informative references, some split references into sections organiz
       </choice>
     </define>
     <define name="TrAttributes">
+      <ref name="OptionalId"/>
       <optional>
         <attribute name="style">
           <a:documentation>CSS style: only background-color supported</a:documentation>
@@ -487,6 +607,7 @@ gives an explicit page orientation</a:documentation>
   </include>
   <!-- end overrides -->
   <define name="FnAttributes" combine="interleave">
+    <ref name="RequiredId"/>
     <optional>
       <attribute name="hiddenref">
         <a:documentation>If true, number the footnote as normal, but suppress display of the footnote reference in the document body.
@@ -496,6 +617,7 @@ This is done if the footnote reference is already presented in some other form,
     </optional>
   </define>
   <define name="TdAttributes" combine="interleave">
+    <ref name="RequiredId"/>
     <optional>
       <attribute name="style">
         <a:documentation>CSS style: only background-color supported</a:documentation>
@@ -687,6 +809,32 @@ titlecase, or lowercase</a:documentation>
       </attribute>
     </optional>
   </define>
+  <define name="RequiredId" combine="interleave">
+    <optional>
+      <attribute name="anchor">
+        <a:documentation>User-supplied anchor of element; replaced by content-based id, with all references to the anchor updated accordingly</a:documentation>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="source">
+        <a:documentation>Sourcing of the current element in an external data model</a:documentation>
+        <ref name="IdRefType"/>
+      </attribute>
+    </optional>
+  </define>
+  <define name="OptionalId" combine="interleave">
+    <optional>
+      <attribute name="anchor">
+        <a:documentation> User-supplied anchor of element; replaced by content-based id, with all references to the anchor updated accordingly</a:documentation>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="source">
+        <a:documentation>Sourcing of the current element in an external data model</a:documentation>
+        <ref name="IdRefType"/>
+      </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>
@@ -832,6 +980,7 @@ titlecase, or lowercase</a:documentation>
 is used in particular to capture mutually agreed definitions of codepoints in Unicode Private Use Area</a:documentation>
         </attribute>
       </optional>
+      <ref name="OptionalId"/>
       <oneOrMore>
         <ref name="TextElement">
           <a:documentation>Textual content of span</a:documentation>
@@ -1081,7 +1230,7 @@ That concept may be defined as a term within the current document, or it may be
     <element name="label">
       <!-- Identifier of form input element that this element is a label of -->
       <attribute name="for">
-        <data type="IDREF"/>
+        <ref name="IdRefType"/>
       </attribute>
       <zeroOrMore>
         <ref name="PureTextElement"/>
@@ -1686,7 +1835,7 @@ used in document amendments</a:documentation>
     </element>
   </define>
   <define name="TermAttributes">
-    <ref name="OptionalId"/>
+    <ref name="RequiredId"/>
     <ref name="LocalizedStringAttributes"/>
     <ref name="BlockAttributes"/>
   </define>
@@ -2029,6 +2178,7 @@ used in document amendments</a:documentation>
   <define name="termdefinition">
     <a:documentation>The definition of a term applied in the current document</a:documentation>
     <element name="definition">
+      <ref name="RequiredId"/>
       <optional>
         <attribute name="type">
           <a:documentation>Type of definition, used to differentiate it from other definitions of the same term if present</a:documentation>
@@ -2050,6 +2200,7 @@ used in document amendments</a:documentation>
   </define>
   <define name="verbaldefinition">
     <element name="verbal-definition">
+      <ref name="RequiredId"/>
       <oneOrMore>
         <choice>
           <a:documentation>Content of the verbal representation of the term</a:documentation>
@@ -2070,6 +2221,7 @@ used in document amendments</a:documentation>
   <define name="nonverbalrep">
     <a:documentation>Non-verbal representation of the term</a:documentation>
     <element name="non-verbal-representation">
+      <ref name="RequiredId"/>
       <oneOrMore>
         <choice>
           <a:documentation>Content of the non-verbal representation of the term</a:documentation>
@@ -2121,7 +2273,7 @@ used in document amendments</a:documentation>
   </define>
   <define name="termsource">
     <a:documentation>The bibliographic source where a term is defined in the sense applicable in this standardisation document</a:documentation>
-    <element name="termsource">
+    <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>
         <ref name="SourceStatusType"/>
@@ -2503,6 +2655,11 @@ Normative References contents contain normative references, but as a clause in t
       <ref name="termsource"/>
     </zeroOrMore>
   </define>
+  <define name="BlockSource">
+    <zeroOrMore>
+      <ref name="source"/>
+    </zeroOrMore>
+  </define>
   <start>
     <ref name="standard-document"/>
   </start>

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.5.5".freeze
+    VERSION = "3.5.7".freeze
   end
 end

metadata

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