metanorma-ietf 2.2.2 → 2.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 632a1a83824ce8f51934be44526afeea1ce136b240834729432c140c6d8ca4e6
-  data.tar.gz: da8544516988c9d44389aea405a0473fbe146ff230183a6f163d9218c9c4950b
+  metadata.gz: cf74564b365111cd476e2a8beb46d61ab8c7d78bc2ca920f0ef8a1e79c417f8a
+  data.tar.gz: 0dc7800dc710e5ee211481335b86d23c444e3633a35ed7c5beae318c5c70665d
 SHA512:
-  metadata.gz: 15757ce0afc5e69a804c80a8658e8c8b348ab3fc51da79ff9cf057955611736338e23516a51d4fa7c751b630e621378032ffb130d121b5c0b20c0bdc1ac5b86a
-  data.tar.gz: b17b4e657f8a69d1a97e25828b7fb0c7f501479cbb332d11b450a5be1f005ca398dd0664d91607c639c52748519f82d3f9d2e36fc05863ba79b223df90b00589
+  metadata.gz: f35911333abe66b3f27bb3b27fe6190a64f68504e04be8df120a0f9a4bb44dabb478b156161e5b636c3d2cca7efd5c8503dab393dc2f08265cef7ece8a74b2ad
+  data.tar.gz: 7a2a46fcfdf29645223e3d5df4e703f40d942811a48be24fa094fd13cb63f7c78aec2282e97a5b597676b93d241882f5cfc9184281f65a338dc88d43cad62efb

data/.github/workflows/rake.yml

@@ -0,0 +1,108 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '2.7'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'macos-latest'
+            experimental: true
+
+    steps:
+      - uses: actions/checkout@master
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - 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
+
+      - uses: actions/setup-python@v1
+        with:
+          python-version: '3.6'
+          architecture: 'x64'
+
+      - name: set PIP_DOWNLOAD_CACHE
+        shell: python
+        run: |
+          import os
+          import platform
+          from os.path import expanduser
+
+          home = expanduser("~")
+          cache_path = {
+            "Linux": f"{home}/.cache/pip",
+            "Darwin": f"{home}Library/Caches/pip",
+            "Windows": f"{home}\\AppData\\Local\\pip\\Cache"
+          }[platform.system()]
+
+          os.system(f"echo PIP_DOWNLOAD_CACHE={cache_path} >> {os.environ['GITHUB_ENV']}")
+
+      - uses: actions/cache@v2
+        with:
+          path: ${{ env.PIP_DOWNLOAD_CACHE }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: ${{ runner.os }}-pip-
+
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/xml2rfc
+          key: xml2rfc
+          restore-key: xml2rfc
+
+      - if: matrix.os == 'macos-latest'
+        run: brew install libmagic
+
+      - if: matrix.os == 'windows-latest'
+        run: pip install python-magic-bin
+
+      - run: pip install xml2rfc
+
+      - 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

@@ -402,6 +402,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -429,6 +439,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -576,6 +596,7 @@
       <ref name="bookmark"/>
       <ref name="image"/>
       <ref name="index"/>
+      <ref name="index-xref"/>
     </choice>
   </define>
   <define name="PureTextElement">
@@ -708,15 +729,61 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
+      <attribute name="to">
+        <data type="IDREF"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
       <optional>
-        <attribute name="secondary"/>
+        <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>
   </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>
+        <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 -->
   <define name="bookmark">
     <element name="bookmark">
@@ -998,6 +1065,9 @@
           <value>alphabet_upper</value>
         </choice>
       </attribute>
+      <optional>
+        <attribute name="start"/>
+      </optional>
       <oneOrMore>
         <ref name="li"/>
       </oneOrMore>

data/lib/asciidoctor/ietf/converter.rb

@@ -114,9 +114,9 @@ module Asciidoctor
 
       def cleanup(xmldoc)
         bcp14_cleanup(xmldoc)
-        rfc_anchor_cleanup(xmldoc)
         abstract_cleanup(xmldoc)
         super
+        rfc_anchor_cleanup(xmldoc)
       end
 
       BCP_KEYWORDS = ["MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
@@ -211,6 +211,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

@@ -31,14 +31,8 @@ module Asciidoctor
         end
       end
 
-      def organization(org, orgname)
-        if ["IETF",
-            "Internet Engineering Task Force"].include? orgname
-          org.name "Internet Engineering Task Force"
-          org.abbreviation "IETF"
-        else
-          org.name orgname
-        end
+      def org_abbrev
+        { "Internet Engineering Task Force" => "IETF" }
       end
 
       def metadata_series(node, xml)

data/lib/asciidoctor/ietf/ietf.rng

@@ -868,6 +868,13 @@
   </define>
   <define name="ietf-standard">
     <element name="ietf-standard">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <zeroOrMore>
         <ref name="termdocsource"/>

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">
@@ -42,12 +50,18 @@
     </define>
     <define name="xref">
       <element name="xref">
-        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
           <data type="string">
             <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"/>
@@ -64,6 +78,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -137,6 +156,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -229,6 +253,12 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="width"/>
+        </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -581,6 +611,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -664,6 +696,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -700,6 +742,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -725,6 +777,18 @@
     </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="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -775,6 +839,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -830,13 +897,22 @@
       <element name="code">
         <text/>
       </element>
-      <element name="text">
-        <text/>
-      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
     </element>
   </define>
   <define name="standard-document">
     <element name="standard-document">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <optional>
         <ref name="boilerplate"/>
@@ -858,7 +934,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -995,6 +1071,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="type"/>
     </optional>
@@ -1048,18 +1127,24 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1128,49 +1213,7 @@
   </define>
   <define name="annex">
     <element name="annex">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="language"/>
-      </optional>
-      <optional>
-        <attribute name="script"/>
-      </optional>
-      <optional>
-        <attribute name="inline-header">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <attribute name="obligation">
-        <choice>
-          <value>normative</value>
-          <value>informative</value>
-        </choice>
-      </attribute>
-      <optional>
-        <ref name="section-title"/>
-      </optional>
-      <group>
-        <group>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
-        <zeroOrMore>
-          <choice>
-            <ref name="annex-subsection"/>
-            <ref name="terms"/>
-            <ref name="definitions"/>
-            <ref name="references"/>
-          </choice>
-        </zeroOrMore>
-      </group>
+      <ref name="Annex-Section"/>
     </element>
   </define>
   <define name="terms">
@@ -1189,6 +1232,9 @@
       <optional>
         <attribute name="type"/>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1456,11 +1502,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>
@@ -1510,4 +1551,85 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+          <value>replace</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <optional>
+            <attribute name="id">
+              <data type="ID"/>
+            </attribute>
+          </optional>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </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,
+                                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
@@ -81,5 +82,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/isodoc/ietf/validation.rb

@@ -90,6 +90,8 @@ module IsoDoc::Ietf
           xml.at(".//*[@pn = '#{x['target']}']") or
           ret << "#{x.name} target #{x['target']} does not exist in the document"
         next unless t
+        x.delete("relative") if x["relative"]&.empty?
+        x.delete("section") if x["section"]&.empty?
         if x["format"] == "title" && t.name == "reference"
           t.at("./front/title") or
             ret << "reference #{t['anchor']} has been referenced by #{x.name} "\
@@ -133,7 +135,7 @@ module IsoDoc::Ietf
               "since it does not point to a RFC or Internet-Draft reference"
           end
         end
-        if x["relative"]
+        if x["relative"] 
           unless t.at(".//seriesInfo[@name = 'RFC' or @name = "\
               "'Internet-Draft']") || t["target"]
             ret << "need an explicit target= URL attribute in the reference "\

data/lib/metanorma/ietf/processor.rb

@@ -58,42 +58,31 @@ module Metanorma
           IsoDoc::Ietf::RfcConvert.new(options).convert(inname, isodoc_node, nil, outname)
           @done_rfc = true
 
-        when :txt
+        when :txt, :pdf, :html
           unless xml2rfc_present?
             warn "[metanorma-ietf] Error: unable to generate #{format}, the command `xml2rfc` is not found in path."
             return
           end
 
           rfcname = inname.sub(/\.xml$/, ".rfc.xml")
-          output(isodoc_node, inname, rfcname, :rfc, options) unless @done_rfc
-
-          outname ||= inname.sub(/\.xml$/, ".txt")
-          system("xml2rfc --text #{rfcname} -o #{outname}")
-
-        when :pdf
-          unless xml2rfc_present?
-            warn "[metanorma-ietf] Error: unable to generate #{format}, the command `xml2rfc` is not found in path."
-            return
+          unless @done_rfc && File.exist?(rfcname)
+            output(isodoc_node, inname, rfcname, :rfc, options)
           end
 
-          rfcname = inname.sub(/\.xml$/, ".rfc.xml")
-          output(isodoc_node, inname, rfcname, :rfc, options) unless @done_rfc
-
-          outname ||= inname.sub(/\.xml$/, ".pdf")
-          system("xml2rfc --pdf #{rfcname} -o #{outname}")
-
-        when :html
-          unless xml2rfc_present?
-            warn "[metanorma-ietf] Error: unable to generate #{format}, the command `xml2rfc` is not found in path."
-            return
+          outext = case format
+            when :txt then ".txt"
+            when :pdf then ".pdf"
+            when :html then ".html"
           end
 
-          rfcname = inname.sub(/\.xml$/, ".rfc.xml")
-          output(isodoc_node, inname, rfcname, :rfc, options) unless @done_rfc
-
-          outname ||= inname.sub(/\.xml$/, ".html")
-          system("xml2rfc --html #{rfcname} -o #{outname}")
+          outflag = case format
+            when :txt then "--text"
+            when :pdf then "--pdf"
+            when :html then "--html"
+          end
 
+          outname ||= inname.sub(/\.xml$/, outext)
+          system("xml2rfc #{outflag} #{rfcname} -o #{outname}")
         else
           super
         end

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-   VERSION = "2.2.2".freeze
+   VERSION = "2.2.7".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -35,8 +35,8 @@ 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.5.0"
-  spec.add_dependency "isodoc", "~> 1.2.0"
+  spec.add_dependency "metanorma-standoc", "~> 1.7.0"
+  spec.add_dependency "isodoc", "~> 1.4.2"
   spec.add_dependency "mathml2asciimath"
 
   spec.add_development_dependency "byebug"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2021-01-11 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.5.0
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: isodoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: mathml2asciimath
   requirement: !ruby/object:Gem::Requirement
@@ -223,9 +223,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/macos.yml"
-- ".github/workflows/ubuntu.yml"
-- ".github/workflows/windows.yml"
+- ".github/workflows/rake.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".oss-guides.rubocop.yml"
@@ -262,6 +260,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

data/.github/workflows/macos.yml

@@ -1,54 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: macos
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    paths-ignore:
-      - .github/workflows/ubuntu.yml
-      - .github/workflows/windows.yml
-
-jobs:
-  test-macos:
-    name: Test on Ruby ${{ matrix.ruby }} macOS
-    runs-on: macos-latest
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
-        experimental: [false]
-        include:
-          - ruby: '2.7'
-            experimental: true
-    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: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Update gems
-        run: |
-          sudo gem install bundler --force
-          bundle install --jobs 4 --retry 3
-      - name: Use Python
-        uses: actions/setup-python@v1
-        with:
-          python-version: '3.6'
-          architecture: 'x64'
-      - name: Install xml2rfc
-        run: |
-          pip install xml2rfc
-      - name: Run specs
-        run: |
-          bundle exec rake
-

data/.github/workflows/ubuntu.yml

@@ -1,52 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: ubuntu
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    paths-ignore:
-      - .github/workflows/macos.yml
-      - .github/workflows/windows.yml
-jobs:
-  test-linux:
-    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
-    runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
-        experimental: [false]
-        include:
-          - ruby: '2.7'
-            experimental: true
-    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: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Update gems
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-      - name: Use Python
-        uses: actions/setup-python@v1
-        with:
-          python-version: '3.6'
-          architecture: 'x64'
-      - name: Install xml2rfc
-        run: |
-          pip install xml2rfc
-      - name: Run specs
-        run: |
-          bundle exec rake

data/.github/workflows/windows.yml

@@ -1,54 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: windows
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    paths-ignore:
-      - .github/workflows/macos.yml
-      - .github/workflows/ubuntu.yml
-
-jobs:
-  test-windows:
-    name: Test on Ruby ${{ matrix.ruby }} Windows
-    runs-on: windows-latest
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
-        experimental: [false]
-        include:
-          - ruby: '2.7'
-            experimental: true
-    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: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Update gems
-        shell: pwsh
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-      - name: Use Python
-        uses: actions/setup-python@v1
-        with:
-          ruby-version: '3.6'
-          architecture: 'x64'
-      - name: Install xml2rfc
-        run: |
-          pip install xml2rfc
-      - name: Run specs
-        run: |
-          bundle exec rake