metanorma-ietf 2.2.4 → 2.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f06324c3b9c916155d7de089ca675e524498efdcd6c07ff824f94b57ab6964c6
-  data.tar.gz: 51bfdd81d038f103e94bc9d5be4f6954d6bc6fbc691972f4b7f3001cd7ca9a2d
+  metadata.gz: ef8df6cb58dabbcabed03ba7d877da277111d4899c18d37ab8cc4dc4946cfffa
+  data.tar.gz: 6b7ad838b66278077b12c5665989f29d928dcbe5a3db01744b6382cbfc33cb0f
 SHA512:
-  metadata.gz: 45fc197eeaeb201677a069bd7ce3037a8d0bb28aacb49678a723bf7628cde25792aca668ddcff291f5932194f906e4bcbe12af342891da9ec5e36963c0cde2e6
-  data.tar.gz: a1752e87e7185ef20c56f58b1d1f568617bfecab5c7295a48e67b22d27afd5eb9b9de470edb0b712423991803887a714a834111af0ba03f1fabc62a6219e8c7c
+  metadata.gz: 2753190188ffb6db38d5c9b82f005288306b2ec8e9b2fc3c913b59f6e233387997b8d2669ea3e30caf6f2c1c17705a47ce77b5fac74bcff404c040a169040e1c
+  data.tar.gz: 2e8bb3135c7b65585822c02c3c0fd57ba26630ded8d73b0af1c9b43f620214a457061eb5769e269a0cf791fea1e5788c0e6ed63669addfaf5e5fbe65d43ed806

data/.github/workflows/rake.yml

@@ -4,7 +4,8 @@ name: rake
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main ]
+    tags: [ v* ]
   pull_request:
 
 jobs:
@@ -31,26 +32,25 @@ jobs:
 
     steps:
       - uses: actions/checkout@master
-      - name: Cache xml2rfc
-        id: cache-xml2rfc
-        uses: actions/cache@v1
-        with:
-          path: ~/.cache/xml2rfc
-          key: xml2rfc
-          restore-key: xml2rfc
 
-      - name: Use Ruby
-        uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
 
-      - name: Update gems
-        run: |
-          bundle install --jobs 4 --retry 3
+      - if: matrix.os == 'macos-latest'
+        run: brew install autoconf automake libtool
+
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
 
-      - name: Use Python
-        uses: actions/setup-python@v1
+      - uses: actions/setup-python@v1
         with:
           python-version: '3.6'
           architecture: 'x64'
@@ -58,6 +58,7 @@ jobs:
       - name: set PIP_DOWNLOAD_CACHE
         shell: python
         run: |
+          import os
           import platform
           from os.path import expanduser
 
@@ -65,10 +66,10 @@ jobs:
           cache_path = {
             "Linux": f"{home}/.cache/pip",
             "Darwin": f"{home}Library/Caches/pip",
-            "Windows": f"{home}/AppData/Local/pip/Cache"
-          }
+            "Windows": f"{home}\\AppData\\Local\\pip\\Cache"
+          }[platform.system()]
 
-          print(f"::set-env name=PIP_DOWNLOAD_CACHE::{cache_path[platform.system()]}")
+          os.system(f"echo PIP_DOWNLOAD_CACHE={cache_path} >> {os.environ['GITHUB_ENV']}")
 
       - uses: actions/cache@v2
         with:
@@ -76,17 +77,32 @@ jobs:
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: ${{ runner.os }}-pip-
 
-      - name: Install xml2rfc's deps macOS
-        if: matrix.os == 'macos-latest'
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/xml2rfc
+          key: xml2rfc
+          restore-key: xml2rfc
+
+      - if: matrix.os == 'macos-latest'
         run: brew install libmagic
 
-      - name: Install xml2rfc's deps Windows
-        if: matrix.os == 'windows-latest'
+      - if: matrix.os == 'windows-latest'
         run: pip install python-magic-bin
 
-      - name: Install xml2rfc
-        run: pip install xml2rfc
+      - run: pip install xml2rfc
 
-      - name: Run specs
-        run: |
-          bundle exec rake
+      - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - name: Trigger tests passed event
+        uses: Sibz/github-status-action@v1
+        with:
+          authToken: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          context: 'tests-passed-successfully'
+          description: 'Tests passed successfully'
+          state: 'success'
+          sha: ${{ github.event.pull_request.head.sha || github.sha }}

data/README.adoc

@@ -2,26 +2,21 @@
 :source-highlighter: coderay
 :icons: font
 
-`metanorma-ietf` lets you write Internet-Drafts and RFCs in AsciiDoc, the
-"`http://asciidoctor.org/[asciidoctor]-way`".
+`metanorma-ietf` lets you write IETF Internet-Drafts and RFCs via Metanorma.
 
 image:https://img.shields.io/gem/v/metanorma-ietf.svg["Gem Version", link="https://rubygems.org/gems/metanorma-ietf"]
-image:https://github.com/metanorma/metanorma-ietf/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-ietf/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-ietf/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-ietf/actions?workflow=ubuntu"]
-image:https://github.com/metanorma/metanorma-ietf/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-ietf/actions?workflow=windows"]
+image:https://github.com/metanorma/metanorma-ietf/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-ietf/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma-ietf/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-ietf"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-ietf.svg["Pull Requests", link="https://github.com/metanorma/metanorma-ietf/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-ietf/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-ietf/releases"]
 
-_Formerly known as_ `asciidoctor-rfc`.
-
-
 == Functionality
 
-This gem processes http://asciidoctor.org/[Asciidoctor] documents following
-a template for generating IETF International Standards.
+This gem processes https://www.metanorma.com[Metanorma documents] following
+a template for generating IETF deliverables.
 
-This AsciiDoc syntax for writing IETF standards is called "`AsciiRFC`".
+Metanorma-IETF adheres to AsciiRFC syntax, an AsciiDoc syntax for writing IETF documents
+developed by the Metanorma team.
 
 The gem currently inherits from the https://github.com/metanorma/metanorma-standoc
 gem, and aligns closely to it.
@@ -221,3 +216,6 @@ This gem is developed, maintained and funded by https://www.ribose.com[Ribose In
 
 * Document templates are available at the https://github.com/metanorma/mn-templates-ietf[mn-templates-ietf] repository.
 
+== Notes
+
+Metanorma-IETF was formerly published as the `asciidoctor-rfc` gem.

data/lib/asciidoctor/ietf/basicdoc.rng

@@ -596,6 +596,7 @@
       <ref name="bookmark"/>
       <ref name="image"/>
       <ref name="index"/>
+      <ref name="index-xref"/>
     </choice>
   </define>
   <define name="PureTextElement">
@@ -728,13 +729,61 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
       <optional>
-        <attribute name="secondary"/>
+        <attribute name="to">
+          <data type="IDREF"/>
+        </attribute>
+      </optional>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="index-xref">
+    <element name="index-xref">
+      <attribute name="also">
+        <data type="boolean"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
       <optional>
-        <attribute name="tertiary"/>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
+      <element name="target">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
     </element>
   </define>
   <!-- bare ID element, used for referencing arbitrary spans of text -->

data/lib/asciidoctor/ietf/blocks.rb

@@ -6,17 +6,17 @@ module Asciidoctor
                   node.attr("keep-with-next"),
                   "keep-with-previous": node.attr("keepWithPrevious") ||
                   node.attr("keep-with-previous"),
-                  id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(node))
+                  id: ::Metanorma::Utils::anchor_or_uuid(node))
       end
 
       def ul_attrs(node)
-        attr_code(id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(node),
+        attr_code(id: ::Metanorma::Utils::anchor_or_uuid(node),
                   nobullet: node.attr("nobullet"),
                   spacing: node.attr("spacing"))
       end
 
       def ol_attrs(node)
-        attr_code(id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(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"),
@@ -24,7 +24,7 @@ module Asciidoctor
       end
 
       def dl_attrs(node)
-        attr_code(id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(node),
+        attr_code(id: ::Metanorma::Utils::anchor_or_uuid(node),
                   newline: node.attr("newline"),
                   indent: node.attr("indent"),
                   spacing: node.attr("spacing"))
@@ -46,7 +46,7 @@ module Asciidoctor
 
       def note(n)
         noko do |xml|
-          xml.note **attr_code(id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(n),
+          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)
@@ -60,7 +60,7 @@ module Asciidoctor
             figure_title(node, f)
             f.pre node.lines.join("\n"),
               **attr_code(align: node.attr("align"),
-                          id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(nil),
+                          id: ::Metanorma::Utils::anchor_or_uuid(nil),
                           alt: node.attr("alt"))
           end
         end

data/lib/asciidoctor/ietf/converter.rb

@@ -204,6 +204,22 @@ module Asciidoctor
         end
       end
 
+      def inline_indexterm(node)
+        noko do |xml|
+          node.type == :visible and xml << node.text.sub(/^primary:(?=\S)/, "")
+          terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
+          if /^primary:\S/.match(terms[0])
+            terms[0].sub!(/^primary:/, "")
+            has_primary = true
+          end
+          xml.index **attr_code(primary: has_primary) do |i|
+            i.primary { |x| x << terms[0] }
+            a = terms.dig(1) and i.secondary { |x| x << a }
+            a = terms.dig(2) and i.tertiary { |x| x << a }
+          end
+        end.join
+      end
+
       def html_extract_attributes(node)
         super.merge(use_xinclude: node.attr("use-xinclude"))
       end
@@ -211,6 +227,13 @@ module Asciidoctor
       def rfc_converter(node)
         IsoDoc::Ietf::RfcConvert.new(html_extract_attributes(node))
       end
+
+      def isodoc(lang, script, i18nyaml = nil)
+        conv = rfc_converter(EmptyAttr.new)
+        i18n = conv.i18n_init(lang, script, i18nyaml)
+        conv.metadata_init(lang, script, i18n)
+        conv
+      end
     end
   end
 end

data/lib/asciidoctor/ietf/front.rb

@@ -51,8 +51,8 @@ module Asciidoctor
         ["en"].each do |lang|
           at = { language: lang, format: "text/plain" }
           xml.title **attr_code(at.merge(type: "main")) do |t|
-            t << (::Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title")) ||
-              ::Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-en")) ||
+            t << (::Metanorma::Utils::asciidoc_sub(node.attr("title")) ||
+              ::Metanorma::Utils::asciidoc_sub(node.attr("title-en")) ||
               node.title)
           end
           a = node.attr("abbrev") and

data/lib/asciidoctor/ietf/ietf.rng

@@ -564,6 +564,39 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="index">
+      <element name="index">
+        <optional>
+          <attribute name="to">
+            <data type="IDREF"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="primary">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <element name="primary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+        <optional>
+          <element name="secondary">
+            <oneOrMore>
+              <ref name="PureTextElement"/>
+            </oneOrMore>
+          </element>
+        </optional>
+        <optional>
+          <element name="tertiary">
+            <oneOrMore>
+              <ref name="PureTextElement"/>
+            </oneOrMore>
+          </element>
+        </optional>
+      </element>
+    </define>
   </include>
   <define name="TextElement" combine="choice">
     <ref name="bcp14"/>
@@ -879,6 +912,9 @@
       <zeroOrMore>
         <ref name="termdocsource"/>
       </zeroOrMore>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -890,6 +926,9 @@
         <ref name="annex"/>
       </zeroOrMore>
       <ref name="bibliography"/>
+      <zeroOrMore>
+        <ref name="indexsect"/>
+      </zeroOrMore>
     </element>
   </define>
 </grammar>

data/lib/asciidoctor/ietf/isodoc.rng

@@ -24,6 +24,14 @@
     <start>
       <ref name="standard-document"/>
     </start>
+    <define name="doctype">
+      <element name="doctype">
+        <optional>
+          <attribute name="abbreviation"/>
+        </optional>
+        <ref name="DocumentType"/>
+      </element>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -47,6 +55,13 @@
             <param name="pattern">\i\c*|\c+#\c+</param>
           </data>
         </attribute>
+        <optional>
+          <attribute name="to">
+            <data type="string">
+              <param name="pattern">\i\c*|\c+#\c+</param>
+            </data>
+          </attribute>
+        </optional>
         <optional>
           <attribute name="type">
             <ref name="ReferenceFormat"/>
@@ -141,6 +156,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -233,6 +253,12 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="width"/>
+        </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -751,6 +777,21 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="colgroup">
+    <element name="colgroup">
+      <oneOrMore>
+        <ref name="col"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="col">
+    <element name="col">
+      <attribute name="width"/>
+    </element>
+  </define>
+  <define name="BibItemType" combine="choice">
+    <value>internal</value>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -771,6 +812,8 @@
       <ref name="requirement"/>
       <ref name="recommendation"/>
       <ref name="permission"/>
+      <ref name="imagemap"/>
+      <ref name="svgmap"/>
     </choice>
   </define>
   <define name="bibliography">
@@ -801,6 +844,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -856,9 +902,11 @@
       <element name="code">
         <text/>
       </element>
-      <element name="text">
-        <text/>
-      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
     </element>
   </define>
   <define name="standard-document">
@@ -871,6 +919,9 @@
         </choice>
       </attribute>
       <ref name="bibdata"/>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -881,11 +932,21 @@
       <zeroOrMore>
         <ref name="annex"/>
       </zeroOrMore>
+      <optional>
+        <ref name="bibliography"/>
+      </optional>
       <zeroOrMore>
-        <ref name="references"/>
+        <ref name="indexsect"/>
       </zeroOrMore>
     </element>
   </define>
+  <define name="misccontainer">
+    <element name="misc-container">
+      <oneOrMore>
+        <ref name="AnyElement"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="preface">
     <element name="preface">
       <oneOrMore>
@@ -909,6 +970,11 @@
       <ref name="Content-Section"/>
     </element>
   </define>
+  <define name="indexsect">
+    <element name="indexsect">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
   <define name="boilerplate">
     <element name="boilerplate">
       <optional>
@@ -1028,6 +1094,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="type"/>
     </optional>
@@ -1081,6 +1150,9 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1183,6 +1255,9 @@
       <optional>
         <attribute name="type"/>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1511,6 +1586,7 @@
           <value>add</value>
           <value>modify</value>
           <value>delete</value>
+          <value>replace</value>
         </choice>
       </attribute>
       <optional>
@@ -1541,6 +1617,11 @@
       </optional>
       <optional>
         <element name="newcontent">
+          <optional>
+            <attribute name="id">
+              <data type="ID"/>
+            </attribute>
+          </optional>
           <zeroOrMore>
             <ref name="BasicBlock"/>
           </zeroOrMore>
@@ -1574,4 +1655,65 @@
       <text/>
     </element>
   </define>
+  <define name="imagemap">
+    <element name="imagemap">
+      <ref name="figure"/>
+      <zeroOrMore>
+        <element name="area">
+          <attribute name="type">
+            <choice>
+              <value>rect</value>
+              <value>circle</value>
+              <value>ellipse</value>
+              <value>poly</value>
+            </choice>
+          </attribute>
+          <choice>
+            <ref name="xref"/>
+            <ref name="hyperlink"/>
+            <ref name="eref"/>
+          </choice>
+          <oneOrMore>
+            <element name="coords">
+              <attribute name="x">
+                <data type="float"/>
+              </attribute>
+              <attribute name="y">
+                <data type="float"/>
+              </attribute>
+            </element>
+          </oneOrMore>
+          <optional>
+            <element name="radius">
+              <attribute name="x">
+                <data type="float"/>
+              </attribute>
+              <optional>
+                <attribute name="y">
+                  <data type="float"/>
+                </attribute>
+              </optional>
+            </element>
+          </optional>
+        </element>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="svgmap">
+    <element name="svgmap">
+      <ref name="figure"/>
+      <zeroOrMore>
+        <element name="target">
+          <attribute name="href">
+            <data type="anyURI"/>
+          </attribute>
+          <choice>
+            <ref name="xref"/>
+            <ref name="hyperlink"/>
+            <ref name="eref"/>
+          </choice>
+        </element>
+      </zeroOrMore>
+    </element>
+  </define>
 </grammar>

data/lib/isodoc/ietf/front.rb

@@ -135,12 +135,12 @@ module IsoDoc::Ietf
     end
 
     def postal(addr, out)
-      if line = addr.at(ns("./formattedAddress"))
-        line.text.split(/\n/).each do |l|
-          out.postalLine l, **attr_code(ascii: l.transliterate)
-        end
-      else
-        out.postal do |p|
+      out.postal do |p|
+        if line = addr.at(ns("./formattedAddress"))
+          line.text.split(/\n/).each do |l|
+            p.postalLine l, **attr_code(ascii: l.transliterate)
+          end
+        else
           postal_detailed(addr, p)
         end
       end

data/lib/isodoc/ietf/i18n-en.yaml

@@ -0,0 +1,5 @@
+term_def_boilerplate:
+no_terms_boilerplate:
+internal_terms_boilerplate:
+external_terms_boilerplate:
+internal_external_terms_boilerplate:

data/lib/isodoc/ietf/i18n.rb

@@ -0,0 +1,14 @@
+module IsoDoc
+  module Ietf
+    class I18n < IsoDoc::I18n
+       def load_yaml1(lang, script)
+        y = if lang == "en"
+              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
+            else
+              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
+            end
+        super.merge(y)
+      end
+    end
+  end
+end

data/lib/isodoc/ietf/init.rb

@@ -0,0 +1,16 @@
+require "isodoc"
+require_relative "i18n"
+
+module IsoDoc
+  module Ietf
+    module Init
+      def i18n_init(lang, script, i18nyaml = nil)
+        @i18n = I18n.new(lang, script, i18nyaml || @i18nyaml)
+      end
+
+      def fileloc(loc)
+        File.join(File.dirname(__FILE__), loc)
+      end
+    end
+  end
+end

data/lib/isodoc/ietf/inline.rb

@@ -156,8 +156,8 @@ module IsoDoc::Ietf
     end
 
     def index_parse(node, out)
-      out.iref nil, **attr_code(item: node["primary"],
-                                subitem: node["secondary"])
+      out.iref nil, **attr_code(item: node.at(ns("./primary")).text, primary: node["primary"],
+                                subitem: node&.at(ns("./secondary"))&.text)
     end
 
     def bookmark_parse(node, out)

data/lib/isodoc/ietf/references.rb

@@ -3,16 +3,27 @@ module IsoDoc::Ietf
     # TODO displayreference will be implemented as combination of autofetch and user-provided citations
 
     def bibliography(isoxml, out)
-      isoxml.xpath(ns("//references")).each do |f|
-        out.references **attr_code(anchor: f["id"]) do |div|
-          title = f.at(ns("./title")) and div.name do |name|
-            title.children.each { |n| parse(n, name) }
-          end
-          f.elements.reject do |e|
-            %w(reference title bibitem note).include? e.name
-          end.each { |e| parse(e, div) }
-          biblio_list(f, div, true)
+      isoxml.xpath(ns("//bibliography/references | "\
+                      "//bibliography/clause[.//references] | "\
+                      "//annex/clause[.//references] | "\
+                      "//annex/references | "\
+                      "//sections/clause[.//references]")).each do |f|
+        bibliography1(f, out)
+      end
+    end
+
+    def bibliography1(f, out)
+      out.references **attr_code(anchor: f["id"]) do |div|
+        title = f.at(ns("./title")) and div.name do |name|
+          title.children.each { |n| parse(n, name) }
         end
+        f.elements.select do |e|
+          %w(references clause).include? e.name
+        end.each { |e| bibliography1(e, out) }
+        f.elements.reject do |e|
+          %w(references title bibitem note).include? e.name
+        end.each { |e| parse(e, div) }
+        biblio_list(f, div, true)
       end
     end
 

data/lib/isodoc/ietf/rfc_convert.rb

@@ -11,6 +11,7 @@ require_relative "./references"
 require_relative "./section"
 require_relative "./validation"
 require_relative "./xref"
+require_relative "./init"
 
 module IsoDoc::Ietf
   class RfcConvert < ::IsoDoc::Convert
@@ -25,7 +26,7 @@ module IsoDoc::Ietf
           make_back(html, docxml)
         end
       end.join("\n").sub(/<!DOCTYPE[^>]+>\n/, "")
-          set_pis(docxml, Nokogiri::XML(xml))
+      set_pis(docxml, Nokogiri::XML(xml))
     end
 
     def metadata_init(lang, script, i18n)
@@ -33,8 +34,8 @@ module IsoDoc::Ietf
     end
 
     def xref_init(lang, script, klass, i18n, options)
-        @xrefs = Xref.new(lang, script, klass, i18n, options)
-      end
+      @xrefs = Xref.new(lang, script, klass, i18n, options)
+    end
 
     def extract_delims(text)
       @openmathdelim = "$$"
@@ -56,9 +57,14 @@ module IsoDoc::Ietf
       end
     end
 
-     def textcleanup(docxml)
+    def omit_docid_prefix(prefix)
+      return true if prefix == "IETF"
+      super
+    end
+
+    def textcleanup(docxml)
       passthrough_cleanup(docxml)
-     end
+    end
 
     def postprocess(result, filename, _dir)
       result = from_xhtml(cleanup(to_xhtml(textcleanup(result)))).
@@ -81,5 +87,7 @@ module IsoDoc::Ietf
       @format = :rfc
       @suffix = "rfc.xml"
     end
+
+    include ::IsoDoc::Ietf::Init
   end
 end

data/lib/isodoc/ietf/section.rb

@@ -141,6 +141,7 @@ module IsoDoc::Ietf
     end
 
     def clause_parse(node, out)
+      return if node.at(ns(".//references"))
       out.section **attr_code( anchor: node["id"], numbered: node["numbered"],
                               removeInRFC: node["removeInRFC"], toc: node["toc"]) do |div|
         clause_parse_title(node, div, node.at(ns("./title")), out)
@@ -153,23 +154,16 @@ module IsoDoc::Ietf
     def clause(isoxml, out)
       isoxml.xpath("//xmlns:preface/child::*[not(name() = 'abstract' or name() = 'foreword')] "\
                    "| //xmlns:sections/child::*").each do |c|
-        clause1(c, out)
-      end
-    end
-
-    def clause1(c, out)
-      out.section **attr_code( anchor: c["id"], numbered: c["numbered"],
-                              removeInRFC: c["removeInRFC"], toc: c["toc"]) do |div|
-        clause_parse_title(c, div, c.at(ns("./title")), out)
-        c.elements.reject { |c1| c1.name == "title" }.each do |c1|
-          parse(c1, div)
-        end
+        #cdup = c.dup
+        #cdup.xpath(ns(".//references")).each { |r| r.remove }
+        #cdup.at("./*[local-name() != 'title'][normalize-space(text()) != '']") or next
+        clause_parse(c, out)
       end
     end
 
     def annex(isoxml, out)
       isoxml.xpath(ns("//annex")).each do |c|
-        clause1(c, out)
+        clause_parse(c, out)
       end
     end
   end

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-   VERSION = "2.2.4".freeze
+   VERSION = "2.2.9".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -35,9 +35,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 1.6.0"
-  spec.add_dependency "isodoc", "~> 1.2.0"
+  spec.add_dependency "metanorma-standoc", "~> 1.8.0"
+  spec.add_dependency "isodoc", "~> 1.5.0"
   spec.add_dependency "mathml2asciimath"
+  spec.add_dependency "nokogiri", "~> 1.10.4"
 
   spec.add_development_dependency "byebug"
   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: 2.2.4
+  version: 2.2.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-25 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: isodoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: mathml2asciimath
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.4
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -260,6 +274,9 @@ files:
 - lib/isodoc/ietf/cleanup.rb
 - lib/isodoc/ietf/footnotes.rb
 - lib/isodoc/ietf/front.rb
+- lib/isodoc/ietf/i18n-en.yaml
+- lib/isodoc/ietf/i18n.rb
+- lib/isodoc/ietf/init.rb
 - lib/isodoc/ietf/inline.rb
 - lib/isodoc/ietf/metadata.rb
 - lib/isodoc/ietf/references.rb
@@ -298,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: metanorma-ietf lets you write IETF documents, such as Internet-Drafts and