metanorma-ietf 3.0.4 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a9015764516ae9e7eaac9862c48e49facb45c08e3b68744d11cb0b698a0921
-  data.tar.gz: 5c445117afb3a242d18973a99ec0eabeb4c0cfe582bf19da1e38a35657dfa366
+  metadata.gz: d9f8258cd56113e10722ce8677d62aa22766c25b74676c0cca588bdce4e42974
+  data.tar.gz: 5353aca20fb71c85372b76d1ca7e34d3927944e69baeba30e4964fe2faa73d48
 SHA512:
-  metadata.gz: '0316278f956b44dbe26db8bdb236c5e42b30228c06552de7b78c61530800d46f1d00918d7f4c7bf13b76a518d8960fd204375ec2a5f6aa271f5ea3ce10f06b26'
-  data.tar.gz: bd4b8b4489cac7307aeee01b002a6a6db32f567489da41d6385522ab21ec6081c1c9f29f3110b3f3ed29a03e7c93be5fb603d3bb228d7aef23cfd75447c7a45b
+  metadata.gz: 377cdab4b95054f519d409e5987f33d1d37aae27520f60cdbe59761a3efe6b2d4f7306657eeaba2ff4431ee18f81f7c98215de76b9cb81a87b9984a1b1126d06
+  data.tar.gz: 90704e85d696d404bda87daf06b710f8656d6c3867286f657ddc5b99315a5c9984b262363a19838b0d469f8f47ae3320675c9cd570de8e22d9ff10b94d6f99f6

data/lib/isodoc/ietf/blocks.rb

@@ -179,6 +179,15 @@ module IsoDoc
         end
       end
 
+      def admonition_name(node, type)
+        name = node&.at(ns("./name")) and return name
+        name = Nokogiri::XML::Node.new("name", node.document)
+        return unless type && @i18n.admonition[type]
+
+        name << @i18n.admonition[type]&.upcase
+        name
+      end
+
       def admonition_name_parse(_node, div, name)
         div.t **{ keepWithNext: "true" } do |p|
           name.children.each { |n| parse(n, p) }

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/init.rb

@@ -5,7 +5,7 @@ module IsoDoc
   module Ietf
     module Init
       def i18n_init(lang, script, i18nyaml = nil)
-        @i18n = I18n.new(lang, script, i18nyaml || @i18nyaml)
+        @i18n = I18n.new(lang, script, i18nyaml: i18nyaml || @i18nyaml)
       end
 
       def fileloc(loc)

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/metanorma/ietf/biblio.rng

@@ -527,7 +527,7 @@
   </define>
   <define name="LocalityType">
     <data type="string">
-      <param name="pattern">section|clause|part|paragraph|chapter|page|whole|table|annex|figure|note|list|example|volume|issue|time|anchor|locality:[a-zA-Z0-9_]+</param>
+      <param name="pattern">section|clause|part|paragraph|chapter|page|title|line|whole|table|annex|figure|note|list|example|volume|issue|time|anchor|locality:[a-zA-Z0-9_]+</param>
     </data>
   </define>
   <define name="referenceFrom">
@@ -614,12 +614,12 @@
     <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>
@@ -677,6 +677,9 @@
     <zeroOrMore>
       <ref name="extent"/>
     </zeroOrMore>
+    <optional>
+      <ref name="bibliographic_size"/>
+    </optional>
     <zeroOrMore>
       <ref name="accesslocation"/>
     </zeroOrMore>
@@ -848,17 +851,46 @@
   </define>
   <define name="bplace">
     <element name="place">
-      <optional>
-        <attribute name="uri">
-          <data type="anyURI"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="region"/>
-      </optional>
+      <choice>
+        <text/>
+        <group>
+          <ref name="bibliocity"/>
+          <zeroOrMore>
+            <ref name="biblioregion"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="bibliocountry"/>
+          </zeroOrMore>
+        </group>
+      </choice>
+    </element>
+  </define>
+  <define name="bibliocity">
+    <element name="city">
       <text/>
     </element>
   </define>
+  <define name="biblioregion">
+    <element name="region">
+      <ref name="RegionType"/>
+    </element>
+  </define>
+  <define name="bibliocountry">
+    <element name="country">
+      <ref name="RegionType"/>
+    </element>
+  </define>
+  <define name="RegionType">
+    <optional>
+      <attribute name="iso"/>
+    </optional>
+    <optional>
+      <attribute name="recommended">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <text/>
+  </define>
   <define name="bprice">
     <element name="price">
       <attribute name="currency"/>
@@ -922,9 +954,29 @@
       <text/>
     </element>
   </define>
+  <define name="sizevalue">
+    <element name="value">
+      <attribute name="type"/>
+      <text/>
+    </element>
+  </define>
+  <define name="bibliographic_size">
+    <element name="size">
+      <oneOrMore>
+        <ref name="sizevalue"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="extent">
     <element name="extent">
-      <ref name="BibItemLocality"/>
+      <choice>
+        <zeroOrMore>
+          <ref name="locality"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="localityStack"/>
+        </zeroOrMore>
+      </choice>
     </element>
   </define>
   <define name="series">
@@ -934,36 +986,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">

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

@@ -32,6 +32,43 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="admonition">
+      <element name="admonition">
+        <attribute name="type">
+          <ref name="AdmonitionType"/>
+        </attribute>
+        <optional>
+          <attribute name="class"/>
+        </optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="uri">
+            <data type="anyURI"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="coverpage">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="notag">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="index">
       <element name="index">
         <optional>
@@ -245,6 +282,9 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="ul_li"/>
         </oneOrMore>
@@ -287,6 +327,9 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="li"/>
         </oneOrMore>
@@ -323,6 +366,9 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -851,6 +897,16 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="coverpage">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="notag">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <choice>
             <ref name="paragraph"/>
@@ -1178,6 +1234,7 @@
       <ref name="concept"/>
       <ref name="add"/>
       <ref name="del"/>
+      <ref name="span"/>
     </choice>
   </define>
   <define name="add">
@@ -1204,6 +1261,14 @@
       </choice>
     </element>
   </define>
+  <define name="span">
+    <element name="span">
+      <attribute name="class"/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="concept">
     <element name="concept">
       <optional>

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.0.4".freeze
+    VERSION = "3.0.7".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.0.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.1.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.4
+  version: 3.0.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mathml2asciimath
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.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.7
 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.