metanorma-ietf 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: def69cf551c6c50fcb28fcdf04ab02e0d3d9cf83ba3dcd81114c41f71860599f
-  data.tar.gz: 5afc33bb93c93fbc86565d984562a3a61ed02b700e0a1e66a70f47289ef230c9
+  metadata.gz: 7a36096d484f0abebdb0aac35196a9f8975f7d5704851d3209d133e9901b1b82
+  data.tar.gz: 1fbef89a62eddc130fdf1c99367fae06c29369206f11bcbef9c24e1c1ab07c3d
 SHA512:
-  metadata.gz: 4a2c6f8d47d875c1fb896d1fffdc5d5f789c05a679ab474ae7dfbc52795b9df47eb4763164f08c2da964c0de53ad51f91233ea230a8bce9553a31986f19bf4cd
-  data.tar.gz: eb7fbd7913907b01e95f07bd2b28058b1d8c953f5f9b8b8a9c81a6c1638319fbb2ce8f593a3d83970b5ea748fbf34b7d0ba60b73ea5fa8f9c1a41e3076aec6ac
+  metadata.gz: 2ecdee7ac6dd34da6fe68e4613233b352b6eb1fa35ddec7a7f427b1dcce3bf09d8d5672f37efef8aac10f8e6cbf81c7d2f6466818db0a2fbae27676202c57dff
+  data.tar.gz: f914bccab27c70cbf81281aa0475896190e578bdd09a00072f8802d03903cca7b814bde12d214bfa01d43a95b218a9c1f13312877f6736dad9bf80f2c171253f

data/lib/asciidoctor/ietf/basicdoc.rng

@@ -624,6 +624,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -634,6 +637,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -641,7 +647,12 @@
   <define name="tt">
     <element name="tt">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -822,7 +833,9 @@
       <attribute name="alt"/>
     </optional>
     <ref name="CitationType"/>
-    <text/>
+    <oneOrMore>
+      <ref name="PureTextElement"/>
+    </oneOrMore>
   </define>
   <define name="hyperlink">
     <element name="link">
@@ -835,7 +848,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="xref">
@@ -849,7 +864,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="fn">

data/lib/asciidoctor/ietf/cleanup.rb

@@ -6,6 +6,8 @@ module Asciidoctor
         abstract_cleanup(xmldoc)
         super
         rfc_anchor_cleanup(xmldoc)
+        cref_cleanup(xmldoc)
+        xmldoc
       end
 
       def abstract_cleanup(xmldoc)
@@ -15,6 +17,21 @@ module Asciidoctor
         end
       end
 
+      def cref_cleanup(xmldoc)
+        xmldoc.xpath("//crefref").each do |r|
+          if c = xmldoc.at("//review[@id = '#{r.text}']")
+            r.replace(c.remove)
+          else
+            @log.add("Crossrefences", r,
+                     "No matching review for cref:[#{r.text}]")
+          end
+        end
+      end
+
+      BCP_KEYWORDS = ["MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+                      "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
+                      "OPTIONAL"].freeze
+
       def bcp14_cleanup(xmldoc)
         return unless @bcp_bold
 
@@ -26,12 +43,13 @@ module Asciidoctor
       end
 
       def rfc_anchor_cleanup(xmldoc)
-        map = {}
-        xmldoc.xpath("//bibitem[docidentifier/@type = 'rfc-anchor']").each do |b|
-          next if b.at("./ancestor::bibdata")
+        map = xmldoc.xpath("//bibitem[docidentifier/@type = 'rfc-anchor']")
+          .each_with_object({}) do |b, m|
+          next if b.at("./ancestor::bibdata | ./ancestor::bibitem")
 
-          map[b["id"]] = b.at("./docidentifier[@type = 'rfc-anchor']").text
-          b["id"] = b.at("./docidentifier[@type = 'rfc-anchor']").text
+          id = b.at("./docidentifier[@type = 'rfc-anchor']").text
+          m[b["id"]] = id
+          b["id"] = id
         end
         xmldoc.xpath("//eref | //origin").each do |x|
           map[x["bibitemid"]] and x["bibitemid"] = map[x["bibitemid"]]
@@ -45,7 +63,12 @@ module Asciidoctor
 
           n.replace(HTMLEntities.new.encode(
                       n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'")
-                      .gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic
+                      .gsub(/\u201c|\u201d|\u201e|\u201f/, '"')
+                      .gsub(/[\u2010-\u2015]/, "-")
+                      .gsub(/\u2026/, "...")
+                      .gsub(/[\u200b-\u200c]/, "")
+                      .gsub(/[\u2000-\u200a]|\u202f|\u205f/, " "),
+                      :basic,
                     ))
         end
         xmldoc

data/lib/asciidoctor/ietf/converter.rb

@@ -5,10 +5,15 @@ require_relative "./front"
 require_relative "./blocks"
 require_relative "./validate"
 require_relative "./cleanup"
+require_relative "./macros"
 
 module Asciidoctor
   module Ietf
     class Converter < ::Asciidoctor::Standoc::Converter
+      Asciidoctor::Extensions.register do
+        inline_macro Asciidoctor::Ietf::InlineCrefMacro
+      end
+
       XML_ROOT_TAG = "ietf-standard".freeze
       XML_NAMESPACE = "https://www.metanorma.org/ns/ietf".freeze
 
@@ -113,70 +118,7 @@ module Asciidoctor
         [t, rel]
       end
 
-      def cleanup(xmldoc)
-        bcp14_cleanup(xmldoc)
-        abstract_cleanup(xmldoc)
-        super
-        rfc_anchor_cleanup(xmldoc)
-      end
-
-      BCP_KEYWORDS = ["MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
-                      "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", "OPTIONAL"].freeze
-
-      def abstract_cleanup(xmldoc)
-        xmldoc.xpath("//abstract[not(text())]").each do |x|
-          x.remove
-          warn "Empty abstract section removed"
-        end
-      end
-
-      def bcp14_cleanup(xmldoc)
-        return unless @bcp_bold
-        xmldoc.xpath("//strong").each do |s|
-          next unless BCP_KEYWORDS.include?(s.text)
-          s.name = "bcp14"
-        end
-      end
-
-      def rfc_anchor_cleanup(xmldoc)
-        map = {}
-        xmldoc.xpath("//bibitem[docidentifier/@type = 'rfc-anchor']").each do |b|
-          next if b.at("./ancestor::bibdata | ./ancestor::bibitem")
-
-          map[b["id"]] = b.at("./docidentifier[@type = 'rfc-anchor']").text
-          b["id"] = b.at("./docidentifier[@type = 'rfc-anchor']").text
-        end
-        xmldoc.xpath("//eref | //origin").each do |x|
-          map[x["bibitemid"]] and x["bibitemid"] = map[x["bibitemid"]]
-        end
-        xmldoc
-      end
-
-      def smartquotes_cleanup(xmldoc)
-        xmldoc.traverse do |n|
-          next unless n.text?
-          n.replace(HTMLEntities.new.encode(
-            n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'").
-            gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic))
-        end
-        xmldoc
-      end
-
-      def xref_to_eref(x)
-        super
-        x.delete("format")
-      end
-
-      def xref_cleanup(xmldoc)
-        super
-        xmldoc.xpath("//xref").each do |x|
-          x.delete("displayFormat")
-          x.delete("relative")
-        end
-      end
-
-      def norm_ref_preface(f)
-      end
+      def norm_ref_preface(sect); end
 
       def clause_parse(attrs, xml, node)
         attrs[:numbered] = node.attr("numbered")

data/lib/asciidoctor/ietf/ietf.rng

@@ -459,14 +459,9 @@
         <ref name="section-title"/>
       </optional>
       <group>
-        <group>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
         <zeroOrMore>
           <choice>
             <ref name="clause-subsection"/>
@@ -508,14 +503,9 @@
           <ref name="section-title"/>
         </optional>
         <group>
-          <group>
-            <zeroOrMore>
-              <ref name="BasicBlock"/>
-            </zeroOrMore>
-            <zeroOrMore>
-              <ref name="note"/>
-            </zeroOrMore>
-          </group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
           <zeroOrMore>
             <ref name="clause-subsection"/>
           </zeroOrMore>
@@ -547,14 +537,9 @@
         <ref name="section-title"/>
       </optional>
       <group>
-        <group>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
         <zeroOrMore>
           <ref name="content-subsection"/>
         </zeroOrMore>
@@ -602,7 +587,10 @@
     </define>
   </include>
   <define name="TextElement" combine="choice">
-    <ref name="bcp14"/>
+    <choice>
+      <ref name="bcp14"/>
+      <ref name="review"/>
+    </choice>
   </define>
   <define name="bcp14">
     <element name="bcp14">