metanorma-ietf 3.0.6 → 3.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b48379093e4f20d35fddb174f623ff1e926c2ae65b6e473df2476d7cfd203b0b
-  data.tar.gz: 640976bed48e7c8b9c4ac56533059a240a93c8bc814473456b8034dc1ffdb777
+  metadata.gz: bdae18146fd717cdc3e4edbc6aee7c51e286e93f4f04b08f247d0110c29644d5
+  data.tar.gz: 5990873706f6bab2c18005eba348edc987b54a7600c62889def4579c5f82b622
 SHA512:
-  metadata.gz: e27578363727679af9e4c75865bf7a82caa39050fbd0e6f76c15e38ca6a24af2c492d8e127b376048d6ae2e65d3924ff6e583fcc0fe2eed9a41b2ae0b82d5fc3
-  data.tar.gz: 74c40963d020da82e6e9c7c05b8d723f3724d4dd69c293bfd1d0a5251733f077a975f10cbe440561cfb6d9443fb2c78ce92a8792d67835c8c182168d098bca13
+  metadata.gz: 8aed3ba6d2fe6b46f5907b71feefc20fe49bcc73c6a68244855eb730dae27c552347e4a3c3ec8f77d190f04f7e8f25560c5cd4d0b4ce00572dead34bdd7674c0
+  data.tar.gz: 854ab1d486f0689509468ec3f3342b38894e27b146abe258bb09d544e2dc8f9df65b1828b64d44589cab485ad09ad71b51859b164e0051599e0be6c6fea84b8c

data/lib/isodoc/ietf/i18n.rb

@@ -7,7 +7,7 @@ module IsoDoc
             else
               YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
             end
-        super.merge(y)
+        super.deep_merge(y)
       end
     end
   end

data/lib/isodoc/ietf/references.rb

@@ -38,7 +38,6 @@ module IsoDoc
 
           i += 1 if b.name == "bibitem"
           if b.name == "note" then note_parse(b, div)
-          elsif ietf?(b) then ietf_bibitem_entry(div, b, i)
           else
             nonstd_bibitem(div, b, i, biblio)
           end
@@ -171,18 +170,6 @@ module IsoDoc
           end
         end
       end
-
-      def ietf_bibitem_entry(div, bib, _idx)
-        url = bib&.at(ns("./uri[@type = 'xml']"))&.text
-        div << "<xi:include href='#{url}'/>"
-      end
-
-      def ietf?(bib)
-        return false if !@xinclude
-
-        url = bib.at(ns("./uri[@type = 'xml']")) or return false
-        /xml2rfc\.tools\.ietf\.org/.match(url)
-      end
     end
   end
 end

data/lib/isodoc/ietf/reqt.rb

@@ -2,7 +2,7 @@ module IsoDoc
   module Ietf
     class RfcConvert < ::IsoDoc::Convert
       def recommendation_labels(node)
-        [node.at(ns("./label")), node.at(ns("./title")),
+        [node.at(ns("./identifier")), node.at(ns("./title")),
          @xrefs.anchor(node["id"], :label, false)]
       end
 
@@ -37,7 +37,7 @@ module IsoDoc
         recommendation_name(node, out, @i18n.recommendation)
         recommendation_attributes(node, out)
         node.children.each do |n|
-          parse(n, out) unless %w(label title).include? n.name
+          parse(n, out) unless %w(identifier title).include? n.name
         end
       end
 
@@ -45,7 +45,7 @@ module IsoDoc
         recommendation_name(node, out, @i18n.requirement)
         recommendation_attributes(node, out)
         node.children.each do |n|
-          parse(n, out) unless %w(label title).include? n.name
+          parse(n, out) unless %w(identifier title).include? n.name
         end
       end
 
@@ -53,7 +53,7 @@ module IsoDoc
         recommendation_name(node, out, @i18n.permission)
         recommendation_attributes(node, out)
         node.children.each do |n|
-          parse(n, out) unless %w(label title).include? n.name
+          parse(n, out) unless %w(identifier title).include? n.name
         end
       end
 

data/lib/metanorma/ietf/biblio.rng

@@ -614,12 +614,103 @@
     <optional>
       <ref name="fetched"/>
     </optional>
-    <choice>
-      <oneOrMore>
-        <ref name="btitle"/>
-      </oneOrMore>
+    <optional>
       <ref name="formattedref"/>
-    </choice>
+    </optional>
+    <oneOrMore>
+      <ref name="btitle"/>
+    </oneOrMore>
+    <zeroOrMore>
+      <ref name="bsource"/>
+    </zeroOrMore>
+    <oneOrMore>
+      <ref name="docidentifier"/>
+    </oneOrMore>
+    <optional>
+      <ref name="docnumber"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="bdate"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="contributor"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="edition"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="version"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="biblionote"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="language"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="script"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bibabstract"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="status"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="copyright"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="docrelation"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="series"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="medium"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="bplace"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bprice"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="extent"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="bibliographic_size"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="accesslocation"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="license"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bclassification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bkeyword"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="validity"/>
+    </optional>
+  </define>
+  <define name="ReducedBibliographicItem">
+    <optional>
+      <attribute name="type">
+        <ref name="BibItemType"/>
+      </attribute>
+    </optional>
+    <optional>
+      <ref name="fetched"/>
+    </optional>
+    <optional>
+      <ref name="formattedref"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="btitle"/>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="bsource"/>
     </zeroOrMore>
@@ -638,9 +729,9 @@
     <optional>
       <ref name="edition"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="version"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="biblionote"/>
     </zeroOrMore>
@@ -833,6 +924,12 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="language"/>
+      </optional>
+      <optional>
+        <attribute name="script"/>
+      </optional>
       <text/>
     </element>
   </define>
@@ -986,36 +1083,34 @@
           <ref name="SeriesType"/>
         </attribute>
       </optional>
-      <choice>
+      <optional>
         <ref name="formattedref"/>
-        <group>
-          <ref name="btitle"/>
-          <optional>
-            <ref name="bplace"/>
-          </optional>
-          <optional>
-            <ref name="seriesorganization"/>
-          </optional>
-          <optional>
-            <ref name="abbreviation"/>
-          </optional>
-          <optional>
-            <ref name="seriesfrom"/>
-          </optional>
-          <optional>
-            <ref name="seriesto"/>
-          </optional>
-          <optional>
-            <ref name="seriesnumber"/>
-          </optional>
-          <optional>
-            <ref name="seriespartnumber"/>
-          </optional>
-          <optional>
-            <ref name="seriesrun"/>
-          </optional>
-        </group>
-      </choice>
+      </optional>
+      <ref name="btitle"/>
+      <optional>
+        <ref name="bplace"/>
+      </optional>
+      <optional>
+        <ref name="seriesorganization"/>
+      </optional>
+      <optional>
+        <ref name="abbreviation"/>
+      </optional>
+      <optional>
+        <ref name="seriesfrom"/>
+      </optional>
+      <optional>
+        <ref name="seriesto"/>
+      </optional>
+      <optional>
+        <ref name="seriesnumber"/>
+      </optional>
+      <optional>
+        <ref name="seriespartnumber"/>
+      </optional>
+      <optional>
+        <ref name="seriesrun"/>
+      </optional>
     </element>
   </define>
   <define name="SeriesType">
@@ -1174,7 +1269,7 @@
         </element>
       </optional>
       <element name="bibitem">
-        <ref name="BibliographicItem"/>
+        <ref name="ReducedBibliographicItem"/>
       </element>
       <choice>
         <zeroOrMore>
@@ -1199,9 +1294,9 @@
       <optional>
         <ref name="revision-date"/>
       </optional>
-      <zeroOrMore>
+      <optional>
         <ref name="draft"/>
-      </zeroOrMore>
+      </optional>
     </element>
   </define>
   <define name="vedition">

data/lib/metanorma/ietf/blocks.rb

@@ -2,10 +2,10 @@ module Metanorma
   module Ietf
     class Converter < ::Metanorma::Standoc::Converter
       def para_attrs(node)
-        attr_code( "keep-with-next": node.attr("keepWithNext") ||
+        attr_code("keep-with-next": node.attr("keepWithNext") ||
                   node.attr("keep-with-next"),
                   "keep-with-previous": node.attr("keepWithPrevious") ||
-                  node.attr("keep-with-previous"),
+                 node.attr("keep-with-previous"),
                   id: ::Metanorma::Utils::anchor_or_uuid(node))
       end
 
@@ -36,20 +36,21 @@ module Metanorma
 
       def sidebar(node)
         return unless draft?
+
         noko do |xml|
-          xml.review **(sidebar_attrs(node)) do |r|
+          xml.review **sidebar_attrs(node) do |r|
             node.title.nil? or r.name { |name| name << node.title }
             wrap_in_para(node, r)
           end
         end
       end
 
-      def note(n)
+      def note(node)
         noko do |xml|
-          xml.note **attr_code(id: ::Metanorma::Utils::anchor_or_uuid(n),
-                               removeInRFC: n.attr("remove-in-rfc")) do |c|
-            n.title.nil? or c.name { |name| name << n.title }
-            wrap_in_para(n, c)
+          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 }
+            wrap_in_para(node, c)
           end
         end.join("\n")
       end
@@ -59,9 +60,9 @@ module Metanorma
           xml.figure **literal_attrs(node) do |f|
             figure_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"),
+                              id: ::Metanorma::Utils::anchor_or_uuid(nil),
+                              alt: node.attr("alt"))
           end
         end
       end
@@ -70,9 +71,10 @@ module Metanorma
         super.merge(attr_code(align: node.attr("align")))
       end
 
-       def listing_attrs(node)
-         super.merge(attr_code(markers: node.attr("markers"), src: node.attr("src")))
-       end
+      def listing_attrs(node)
+        super.merge(attr_code(markers: node.attr("markers"),
+                              src: node.attr("src")))
+      end
     end
   end
 end

data/lib/metanorma/ietf/cleanup.rb

@@ -5,7 +5,6 @@ module Metanorma
         bcp14_cleanup(xmldoc)
         abstract_cleanup(xmldoc)
         super
-        rfc_anchor_cleanup(xmldoc)
         cref_cleanup(xmldoc)
         xmldoc
       end
@@ -42,21 +41,6 @@ module Metanorma
         end
       end
 
-      def rfc_anchor_cleanup(xml)
-        map = xml.xpath("//bibitem[docidentifier[@type = 'IETF' or @type = 'RFC']"\
-                        "[@scope = 'anchor']]").each_with_object({}) do |b, m|
-          next if b.at("./ancestor::bibdata | ./ancestor::bibitem")
-
-          id = b.at("./docidentifier[@type = 'IETF' or @type = 'RFC'][@scope = 'anchor']").text
-          m[b["id"]] = id
-          b["id"] = id
-        end
-        xml.xpath("//eref | //origin").each do |x|
-          map[x["bibitemid"]] and x["bibitemid"] = map[x["bibitemid"]]
-        end
-        xml
-      end
-
       def smartquotes_cleanup(xmldoc)
         xmldoc.traverse do |n|
           next unless n.text?

data/lib/metanorma/ietf/converter.rb

@@ -38,7 +38,7 @@ module Metanorma
       end
 
       def doctype(node)
-        ret = super
+        ret = node.attr("doctype")&.gsub(/\s+/, "-")&.downcase || "internet-draft"
         ret = "internet-draft" if ret == "article"
         ret
       end

data/lib/metanorma/ietf/isodoc.rng

@@ -69,6 +69,17 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="AdmonitionType">
+      <choice>
+        <value>warning</value>
+        <value>note</value>
+        <value>tip</value>
+        <value>important</value>
+        <value>caution</value>
+        <value>statement</value>
+        <value>editorial</value>
+      </choice>
+    </define>
     <define name="index">
       <element name="index">
         <optional>
@@ -116,6 +127,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="suppress_identifier">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <ref name="BibliographicItem"/>
       </element>
     </define>
@@ -282,6 +298,9 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="ul_li"/>
         </oneOrMore>
@@ -324,6 +343,9 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="li"/>
         </oneOrMore>
@@ -360,6 +382,9 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -694,6 +719,9 @@
       <optional>
         <attribute name="tag"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="multilingual-rendering">
           <ref name="MultilingualRenderingType"/>
@@ -729,6 +757,9 @@
         <optional>
           <attribute name="tag"/>
         </optional>
+        <optional>
+          <attribute name="type"/>
+        </optional>
         <optional>
           <attribute name="multilingual-rendering">
             <ref name="MultilingualRenderingType"/>
@@ -1254,7 +1285,12 @@
   </define>
   <define name="span">
     <element name="span">
-      <attribute name="class"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
+      <optional>
+        <attribute name="style"/>
+      </optional>
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>
@@ -2050,6 +2086,7 @@
       <value>compare</value>
       <value>contrast</value>
       <value>see</value>
+      <value>seealso</value>
     </choice>
   </define>
   <define name="deprecates">
@@ -2472,6 +2509,16 @@
           <text/>
         </element>
       </optional>
+      <optional>
+        <element name="amendment">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="corrigendum">
+          <text/>
+        </element>
+      </optional>
       <optional>
         <element name="language">
           <text/>

data/lib/metanorma/ietf/reqt.rng

@@ -108,7 +108,7 @@
     </element>
   </define>
   <define name="label">
-    <element name="label">
+    <element name="identifier">
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.0.6".freeze
+    VERSION = "3.0.9".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "mathml2asciimath"
   spec.add_dependency "metanorma-ietf-data"
-  spec.add_dependency "metanorma-standoc", "~> 2.1.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.2.0"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.0.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mathml2asciimath
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -235,9 +235,6 @@ files:
 - LICENSE
 - README.adoc
 - Rakefile
-- docs/installation.md
-- docs/navigation.md
-- docs/overview.md
 - lib/isodoc/ietf/SVG-1.2-RFC.rng
 - lib/isodoc/ietf/blocks.rb
 - lib/isodoc/ietf/cleanup.rb
@@ -296,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
+rubygems_version: 3.3.16
 signing_key:
 specification_version: 4
 summary: metanorma-ietf lets you write IETF documents, such as Internet-Drafts and

data/docs/installation.md

@@ -1,21 +0,0 @@
----
-title: Installation
----
-
-Add this line to your application’s Gemfile:
-
-```
-gem "metanorma-ietf"
-```
-
-And then execute:
-
-```
-$ bundle
-```
-
-Or install it yourself as:
-
-```
-$ gem install metanorma-cli
-```

data/docs/navigation.md

@@ -1,7 +0,0 @@
----
-items:
-- title: Introduction
-  items:
-    - { title: Overview, path: overview/ }
-    - { title: Installation, path: installation/ }
----

data/docs/overview.md

@@ -1,5 +0,0 @@
----
-title: Overview
----
-
-metanorma-ietf lets you write Internet-Drafts and RFCs using the Metanorma publishing toolchain.