metanorma-ietf 3.1.8 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f8cb9a6cb2e25458bb5cb6ccf210d7633c2b204695b25f4ee8d6293153f8edd
-  data.tar.gz: 214f0679505abceb77c0930949be92983c4388af7ecc03884818370c5e2e5c55
+  metadata.gz: 0caa70c59e0b00b7eaf785a68d24b0ec9368c4c0c45c1dee96ef973b0d8c0150
+  data.tar.gz: fcc948fcdb7b9e4b05596b741659052789c595deaf65798a517929bc30173faf
 SHA512:
-  metadata.gz: a394ac99adbe0430c8577256b11da8ef3fc786aece5535b00d9c87cc40abd55743a9d3caa2577edd609aadb699eb8ca895bd08b6495f82b6451d33a918eb32d8
-  data.tar.gz: a0c155b799fae53a21b451085b903bf1c7c5de400ecfc5130418dde096d47e3104ef5a412a755ecfe8d635ca42c10aa67f3dabd2d347246a0b63ed6c053cc25e
+  metadata.gz: 4699fae2fcb874453ca24a16295b72efe450f03dbb16f002884002b7b324f0f5bf03c843f0424a1a8395914d3db9d031f37b2ffb221d0fa2317e0a63c487b0cc
+  data.tar.gz: ba585e9aa3859230b9bf0ff1f574a33ded9268620e40c4438495c8b5a1731b0f8a89e2628b9e1d8a942b9a6d25bcecaba8e0557fc0ea943bebd5eed2c6265280

data/README.adoc

@@ -23,12 +23,8 @@ gem, and aligns closely to it.
 
 The following outputs are generated:
 
-* RFC XML v2
-** Metanorma `doctype`: `rfc2`
-** Metanorma file extension: `xmlrfc` (not `xml`!)
-
 * RFC XML v3
-** Metanorma `doctype`: `rfc3`
+** Metanorma `doctype`: `ietf`
 ** Metanorma file extension: `xmlrfc` (not `xml`!)
 
 The "`xml2rfc`" Vocabulary (hereinafter "`RFC XML`") is an XML-based language
@@ -37,18 +33,16 @@ https://www.ietf.org/id-info/guidelines.html[Internet-Drafts]
 and https://tools.ietf.org/html/rfc7322[RFCs (RFC7322)].
 
 This gem allows you to author these types of documents in AsciiDoc, and outputs
-RFC XML output in both v3 and v2 formats:
+RFC XML output in v3 format:
 
 * v3 RFC XML (https://tools.ietf.org/html/rfc7991[RFC 7991])
-* v2 RFC XML (https://tools.ietf.org/html/rfc7749[RFC 7749])
 
 Its syntax is designed to be "`native-asciidoctor`" as much as possible, with
 some templated use of attributes to convey added information for RFC XML
 output.
 
-This README documents the AsciiRFC markup in full detail. For further
-information about AsciiRFC, please refer to the
-https://datatracker.ietf.org/doc/draft-ribose-asciirfc/[AsciiRFC IETF Internet-Draft].
+For further information about the markup used, please refer to the
+https://www.metanorma.org/author/ietf/[Writing IETF I-Ds and RFCs using AsciiDoc & Metanorma].
 
 
 
@@ -58,13 +52,12 @@ The preferred way to invoke this gem is via the `metanorma` command:
 
 [source,console]
 ----
-$ metanorma --type rfc3 a.adoc                     # output RFC XML v3
-$ metanorma --type rfc3 --extensions xmlrfc a.adoc # output RFC XML v3
+$ metanorma --type ietf a.adoc                     # output RFC XML v3, text, HTML
+$ metanorma --type ietf --extensions xmlrfc a.adoc # output RFC XML v3
 ----
 
-The gem translates the document into IETF XML RFC format.
-
-Text and HTML versions should be generated using the `xml2rfc` tool.
+The gem translates the document into IETF XML RFC format. By default, the gem
+then runs the `xml2rfc` tool to generate text and HTML versions as well.
 
 
 == Installation
@@ -141,18 +134,6 @@ include::spec/examples/example-v3.adoc[]
 ----
 endif::[]
 
-=== RFC XML v2 Example
-
-ifdef::env-github[]
-include::spec/examples/example-v2.adoc[]
-endif::[]
-ifndef::env-github[]
-[source,asciidoc]
-----
-include::spec/examples/example-v2.adoc[]
-----
-endif::[]
-
 
 == Development
 
@@ -210,9 +191,7 @@ This gem is developed, maintained and funded by https://www.ribose.com[Ribose In
 
 == Examples
 
-////
 * Example documents are avalable at the https://github.com/metanorma/mn-samples-ietf[mn-samples-ietf] repository.
-////
 
 * Document templates are available at the https://github.com/metanorma/mn-templates-ietf[mn-templates-ietf] repository.
 

data/lib/isodoc/ietf/inline.rb

@@ -1,5 +1,3 @@
-require "mathml2asciimath"
-
 module IsoDoc
   module Ietf
     class RfcConvert < ::IsoDoc::Convert
@@ -60,7 +58,8 @@ module IsoDoc
 
       def stem_parse(node, out)
         stem = case node["type"]
-               when "MathML" then MathML2AsciiMath.m2a(node.children.to_xml)
+               when "MathML" then Plurimath::Math
+                 .parse(node.children.to_xml, "mathml").to_asciimath
                else HTMLEntities.new.encode(node.text)
                end
         out << "#{@openmathdelim} #{stem} #{@closemathdelim}"
@@ -82,12 +81,15 @@ module IsoDoc
         end
       end
 
+      def image_parse_attrs(node)
+        { src: node["src"], title: node["title"],
+          align: node["align"], name: node["filename"],
+          anchor: node["id"], type: "svg",
+          alt: node["alt"] }
+      end
+
       def image_parse(node, out, caption)
-        attrs = { src: node["src"], title: node["title"],
-                  align: node["align"], name: node["filename"],
-                  anchor: node["id"], type: "svg",
-                  alt: node["alt"] }
-        out.artwork **attr_code(attrs)
+        out.artwork **attr_code(image_parse_attrs(node))
         image_title_parse(out, caption)
       end
 
@@ -102,14 +104,10 @@ module IsoDoc
       def svg_parse(node, out)
         if node.parent.name == "image" then super
         else
-          attrs = { src: node["src"], title: node["title"],
-                  align: node["align"], name: node["filename"],
-                  anchor: node["id"], type: "svg",
-                  alt: node["alt"] }
-        out.artwork **attr_code(attrs) do |x|
-          out = x
-          super
-        end
+          out.artwork **attr_code(image_parse_attrs(node)) do |x|
+            out = x
+            super
+          end
         end
       end
 

data/lib/metanorma/ietf/converter.rb

@@ -53,8 +53,8 @@ module Metanorma
           when :single then xml << "'#{node.text}'"
           when :superscript then xml.sup { |s| s << node.text }
           when :subscript then xml.sub { |s| s << node.text }
-          when :asciimath then stem_parse(node.text, xml, :asciimath)
-          when :latexmath then stem_parse(node.text, xml, :latexmath)
+          when :asciimath then stem_parse(node.text, xml, :asciimath, false)
+          when :latexmath then stem_parse(node.text, xml, :latexmath, false)
           else
             case node.role
             when "bcp14" then xml.bcp14 { |s| s << node.text.upcase }

data/lib/metanorma/ietf/isodoc.rng

@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v1.2.2 -->
+<!-- VERSION v1.2.4 -->
 <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">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
@@ -192,9 +192,11 @@
         </attribute>
       </optional>
       <attribute name="citeas"/>
-      <attribute name="type">
-        <ref name="ReferenceFormat"/>
-      </attribute>
+      <optional>
+        <attribute name="type">
+          <ref name="ReferenceFormat"/>
+        </attribute>
+      </optional>
       <optional>
         <attribute name="alt"/>
       </optional>
@@ -836,6 +838,26 @@
         <ref name="paragraph"/>
       </element>
     </define>
+    <define name="stem">
+      <element name="stem">
+        <attribute name="type">
+          <choice>
+            <value>MathML</value>
+            <value>AsciiMath</value>
+            <value>LatexMath</value>
+          </choice>
+        </attribute>
+        <attribute name="block">
+          <data type="boolean"/>
+        </attribute>
+        <oneOrMore>
+          <choice>
+            <text/>
+            <ref name="AnyElement"/>
+          </choice>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="em">
       <element name="em">
         <zeroOrMore>
@@ -2046,6 +2068,9 @@
   </define>
   <define name="termdefinition">
     <element name="definition">
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <choice>
         <ref name="verbaldefinition"/>
         <ref name="nonverbalrep"/>

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

@@ -26,6 +26,9 @@
       <zeroOrMore>
         <ref name="area"/>
       </zeroOrMore>
+      <optional>
+        <ref name="stream"/>
+      </optional>
       <optional>
         <ref name="ipr"/>
       </optional>
@@ -315,4 +318,16 @@
       </optional>
     </element>
   </define>
+  <define name="stream">
+    <element name="stream">
+      <choice>
+        <value>IAB</value>
+        <value>IETF</value>
+        <value>Independent</value>
+        <value>IRTF</value>
+        <value>Legacy</value>
+        <value>Editorial</value>
+      </choice>
+    </element>
+  </define>
 </grammar>

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.1.8".freeze
+    VERSION = "3.2.1".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -36,9 +36,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  spec.add_dependency "mathml2asciimath"
   spec.add_dependency "metanorma-ietf-data"
-  spec.add_dependency "metanorma-standoc", "~> 2.4.2"
+  spec.add_dependency "metanorma-standoc", "~> 2.5.4"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 3.1.8
+  version: 3.2.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: mathml2asciimath
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: metanorma-ietf-data
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.2
+        version: 2.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.2
+        version: 2.5.4
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement