metanorma-ietf 3.2.7 → 3.3.1

data/lib/metanorma/ietf/basicdoc.rng

@@ -95,8 +95,89 @@
       <ref name="pagebreak"/>
       <ref name="hr"/>
       <ref name="bookmark"/>
+      <ref name="amend"/>
     </choice>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <ref name="AmendType"/>
+    </element>
+  </define>
+  <define name="AmendType">
+    <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>
+          <choice>
+            <ref name="locality"/>
+            <ref name="localityStack"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <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>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="contributor"/>
+    </zeroOrMore>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
   <define name="paragraph">
     <element name="p">
       <ref name="ParagraphType"/>
@@ -163,6 +244,9 @@
         <data type="ID"/>
       </attribute>
       <attribute name="reviewer"/>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="date">
           <data type="dateTime"/>
@@ -939,18 +1023,12 @@
     </optional>
     <optional>
       <attribute name="width">
-        <choice>
-          <data type="int"/>
-          <value>auto</value>
-        </choice>
+        <ref name="ImageSize"/>
       </attribute>
     </optional>
     <optional>
       <attribute name="height">
-        <choice>
-          <data type="int"/>
-          <value>auto</value>
-        </choice>
+        <ref name="ImageSize"/>
       </attribute>
     </optional>
     <optional>
@@ -965,6 +1043,14 @@
       </attribute>
     </optional>
   </define>
+  <define name="ImageSize">
+    <choice>
+      <data type="string">
+        <param name="pattern">\d+([.]\d+)?(%?)</param>
+      </data>
+      <value>auto</value>
+    </choice>
+  </define>
   <define name="video">
     <element name="video">
       <attribute name="id">

data/lib/metanorma/ietf/biblio-standoc.rng

@@ -9,11 +9,42 @@
   -->
   <include href="biblio.rng">
     <define name="BibData">
-      <ref name="BibliographicItem"/>
+      <ref name="StandardBibliographicItem"/>
       <optional>
         <ref name="ext"/>
       </optional>
     </define>
+    <define name="docrelation">
+      <element name="relation">
+        <attribute name="type">
+          <ref name="DocRelationType"/>
+        </attribute>
+        <optional>
+          <element name="description">
+            <ref name="FormattedString"/>
+          </element>
+        </optional>
+        <element name="bibitem">
+          <ref name="StandardReducedBibliographicItem"/>
+        </element>
+        <choice>
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="localityStack"/>
+          </zeroOrMore>
+        </choice>
+        <choice>
+          <zeroOrMore>
+            <ref name="sourceLocality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="sourceLocalityStack"/>
+          </zeroOrMore>
+        </choice>
+      </element>
+    </define>
   </include>
   <define name="ext">
     <element name="ext">
@@ -161,4 +192,16 @@
       </optional>
     </element>
   </define>
+  <define name="StandardBibliographicItem">
+    <ref name="BibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
+  <define name="StandardReducedBibliographicItem">
+    <ref name="ReducedBibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
 </grammar>

data/lib/metanorma/ietf/biblio.rng

@@ -241,6 +241,9 @@
     </element>
   </define>
   <define name="FullNameType">
+    <optional>
+      <ref name="name_abbreviation"/>
+    </optional>
     <choice>
       <group>
         <zeroOrMore>
@@ -266,6 +269,11 @@
       <ref name="variantname"/>
     </zeroOrMore>
   </define>
+  <define name="name_abbreviation">
+    <element name="abbreviation">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
   <define name="prefix">
     <element name="prefix">
       <ref name="LocalizedString"/>
@@ -870,6 +878,9 @@
     <optional>
       <ref name="validity"/>
     </optional>
+    <optional>
+      <ref name="depiction"/>
+    </optional>
   </define>
   <define name="btitle">
     <element name="title">

data/lib/metanorma/ietf/blocks.rb

@@ -6,12 +6,15 @@ module Metanorma
                   node.attr("keep-with-next"),
                   "keep-with-previous": node.attr("keepWithPrevious") ||
                  node.attr("keep-with-previous"),
+                  indent: node.attr("indent"),
                   id: ::Metanorma::Utils::anchor_or_uuid(node))
       end
 
       def ul_attrs(node)
         attr_code(id: ::Metanorma::Utils::anchor_or_uuid(node),
-                  nobullet: node.attr("nobullet"),
+                  nobullet: node.attr("nobullet") || node.attr("empty"),
+                  indent: node.attr("indent"),
+                  bare: node.attr("bare"),
                   spacing: node.attr("spacing"))
       end
 
@@ -20,6 +23,7 @@ module Metanorma
                   type: node.attr("format") || olist_style(node.style),
                   group: node.attr("group"),
                   spacing: node.attr("spacing"),
+                  indent: node.attr("indent"),
                   start: node.attr("start"))
       end
 

data/lib/metanorma/ietf/front.rb

@@ -9,33 +9,9 @@ module Metanorma
         personal_author(node, xml)
       end
 
-=begin
-      def metadata_publisher(node, xml)
-        publishers = node.attr("publisher") || "IETF"
-        csv_split(publishers)&.each do |p|
-          xml.contributor do |c|
-            c.role **{ type: "publisher" }
-            c.organization { |a| organization(a, p, true) }
-          end
-        end
-      end
-
-      def metadata_copyright(node, xml)
-        publishers = node.attr("copyright-holder") || node.attr("publisher") || "IETF"
-        csv_split(publishers)&.each do |p|
-          xml.copyright do |c|
-            c.from (node.attr("copyright-year") || Date.today.year)
-            c.owner do |owner|
-              owner.organization { |o| organization(o, p, true) }
-            end
-          end
-        end
+      def default_publisher
+        "IETF"
       end
-=end
-
-def default_publisher
-  "IETF"
-end
 
       def org_abbrev
         { "Internet Engineering Task Force" => "IETF" }
@@ -47,10 +23,10 @@ end
         end
         a = node.attr("intended-series") and
           xml.series **{ type: "intended" } do |s|
-          parts = a.split(/ /)
-          s.title parts[0]
-          s.number parts[1..-1].join(" ") if parts.size > 1
-        end
+            parts = a.split(/ /)
+            s.title parts[0]
+            s.number parts[1..-1].join(" ") if parts.size > 1
+          end
       end
 
       def title(node, xml)
@@ -69,7 +45,7 @@ end
       end
 
       def metadata_committee(node, xml)
-        return unless node.attr("workgroup")
+        node.attr("workgroup") or return
         xml.editorialgroup do |a|
           committee_component("workgroup", node, a)
         end
@@ -81,14 +57,14 @@ end
           xml.area a
         end
         xml.ipr (node.attr("ipr") || "trust200902")
-        x = node.attr("consensus") and xml.consensus x
-        x = node.attr("index-include") and xml.indexInclude x
+        x = node.attr("consensus") and xml.consensus (x != "false")
+        x = node.attr("index-include") and xml.indexInclude (x != "false")
         x = node.attr("ipr-extract") and xml.iprExtract x
-        x = node.attr("sort-refs") and xml.sortRefs x
-        x = node.attr("sym-refs") and xml.symRefs x
-        x = node.attr("toc-include") and xml.tocInclude x
+        x = node.attr("sort-refs") and xml.sortRefs (x != "false")
+        x = node.attr("sym-refs") and xml.symRefs (x != "false")
+        x = node.attr("toc-include") and xml.tocInclude (x != "false")
         x = node.attr("toc-depth") and xml.tocDepth x
-        x = node.attr("show-on-front-page") and xml.showOnFrontPage x
+        x = node.attr("show-on-front-page") and xml.showOnFrontPage (x != "false")
         xml.pi { |pi| set_pi(node, pi) }
       end
 
@@ -135,7 +111,7 @@ end
 
       def pi_code(rfc_pis, pi)
         rfc_pis.each_pair do |k, v|
-          next if v.nil?
+          v.nil? and next
           pi.send k.to_s, v
         end
       end

data/lib/metanorma/ietf/ietf.rng

@@ -30,6 +30,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="indent"/>
+      </optional>
       <zeroOrMore>
         <ref name="TextElement"/>
       </zeroOrMore>
@@ -47,6 +50,9 @@
             <ref name="Alignments"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="indent"/>
+        </optional>
         <zeroOrMore>
           <choice>
             <ref name="TextElement"/>
@@ -64,11 +70,21 @@
           <data type="ID"/>
         </attribute>
         <optional>
-          <attribute name="nobullet"/>
+          <attribute name="nobullet">
+            <data type="boolean"/>
+          </attribute>
         </optional>
         <optional>
           <attribute name="spacing"/>
         </optional>
+        <optional>
+          <attribute name="indent"/>
+        </optional>
+        <optional>
+          <attribute name="bare">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="li"/>
         </oneOrMore>
@@ -101,6 +117,9 @@
         <optional>
           <attribute name="start"/>
         </optional>
+        <optional>
+          <attribute name="indent"/>
+        </optional>
         <oneOrMore>
           <ref name="li"/>
         </oneOrMore>

data/lib/metanorma/ietf/isodoc.rng

@@ -17,10 +17,19 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v1.2.9 -->
+<!-- VERSION v1.3.0 -->
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
+    <define name="amend">
+      <element name="amend">
+        <ref name="BlockAttributes"/>
+        <ref name="AmendType"/>
+        <zeroOrMore>
+          <ref name="autonumber"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="admonition">
       <element name="admonition">
         <attribute name="type">
@@ -137,6 +146,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="style"/>
+        </optional>
         <oneOrMore>
           <ref name="PureTextElement"/>
         </oneOrMore>
@@ -2319,69 +2331,6 @@
       <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>
-      <ref name="BlockAttributes"/>
-      <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">

data/lib/metanorma/ietf/reqt.rng

@@ -207,20 +207,4 @@
       <value>permission</value>
     </choice>
   </define>
-  <define name="classification">
-    <element name="classification">
-      <ref name="classification_tag"/>
-      <ref name="classification_value"/>
-    </element>
-  </define>
-  <define name="classification_tag">
-    <element name="tag">
-      <text/>
-    </element>
-  </define>
-  <define name="classification_value">
-    <element name="value">
-      <text/>
-    </element>
-  </define>
 </grammar>

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.2.7".freeze
+    VERSION = "3.3.1".freeze
   end
 end

data/lib/metanorma-ietf.rb

@@ -1,5 +1,6 @@
 require "asciidoctor" unless defined? Asciidoctor::Converter
 require "metanorma"
+require "vectory"
 
 require_relative "metanorma/ietf"
 require_relative "metanorma/ietf/converter"

data/lib/relaton/render/config.yml

@@ -19,7 +19,8 @@ journaltemplate: "{% if series_title and series_num %}<seriesInfo_name='{{ serie
 template:
   # skip standardidentifier, it is inserted in front of formattedref within metanorma
   # date is cleaned up into RFC XML formatting afterwards
-  standard: "<front><title>{{ title }}</title> {{ creatornames }} <date_cleanme='true'>{{date}}</date> {% for k in keywords %}<keyword>{{k}}</keyword>{%endfor%} <abstract_cleanme='true'>{{abstract}}</abstract> </front> {% for u in uris %}<format_target='{{u.content}}'_type='{%if u.type%}{{u.type}}{%else%}HTML{%endif%}'/>{% endfor %} {{ series }} {%for d in doi %}<seriesInfo_value='{{ d | replace: ' ', ' ' | remove_first: 'DOI' | strip }}'_name='DOI'/>{% endfor %}  {% if home_standard %}{% for i in authoritative_identifier %} <seriesInfo_value='{{ i | replace: ' ', ' ' | strip | split: ' ' | last | remove_first: 'I-D.'}}'_name='{%if i contains 'I-D.'%}Internet-Draft{% else %}{{ i | replace: ' ', ' ' | strip | split: ' ' | slice: -2 }}{%endif%}'/> {% endfor %} {% else %} <refcontent>{{authoritative_identifier | join: ', '}}</refcontent> {% endif %}"
+  # ref-included is cleaned up as referencegroup/reference in RFC XML afterwards
+  standard: "{% if stream %}<stream>{{stream}}</stream>{% endif %} <front> <title>{{ title }}</title> {{ creatornames }} <date_cleanme='true'>{{date}}</date> {% for k in keywords %}<keyword>{{k}}</keyword>{%endfor%} <abstract_cleanme='true'>{{abstract}}</abstract> </front> {% for u in uris %}<format_target='{{u.content}}'_type='{%if u.type%}{{u.type}}{%else%}HTML{%endif%}'/>{% endfor %} {{ series }} {%for d in doi %}<seriesInfo_value='{{ d | replace: ' ', ' ' | remove_first: 'DOI' | strip }}'_name='DOI'/>{% endfor %}  {% if home_standard %}{% for j in authoritative_identifier %} <seriesInfo_value='{{ j | replace: ' ', ' ' | strip | split: ' ' | last | remove_first: 'I-D.'}}'_name='{%if j contains 'I-D.'%}Internet-Draft{% else %}{{ j | replace: ' ', ' ' | strip | split: ' ' | slice: -2 }}{%endif%}'/> {% endfor %} {% else %} <refcontent>{{authoritative_identifier | join: ', '}}</refcontent> {% endif %} {% for i in included %}<ref-included> {% if i.stream %}<stream>{{i.stream}}</stream>{% endif %} <front> <title>{% if i.title %}{{ i.title}}{%else%}[TITLE]{%endif%}</title> {% if i.creatornames %}{{ i.creatornames }}{%else%}<author></author>{%endif%} <date_cleanme='true'>{{i.date}}</date> {% for k in i.keywords %}<keyword>{{k}}</keyword>{%endfor%} <abstract_cleanme='true'>{{i.abstract}}</abstract> </front> {% for u in i.uris %}<format_target='{{u.content}}'_type='{%if u.type%}{{u.type}}{%else%}HTML{%endif%}'/>{% endfor %} {{ series }} {%for d in i.doi %}<seriesInfo_value='{{ d | replace: ' ', ' ' | remove_first: 'DOI' | strip }}'_name='DOI'/>{% endfor %}  {% if home_standard %}{% for j in i.authoritative_identifier %} <seriesInfo_value='{{ j | replace: ' ', ' ' | strip | split: ' ' | last | remove_first: 'I-D.'}}'_name='{%if j contains 'I-D.'%}Internet-Draft{% else %}{{ j | replace: ' ', ' ' | strip | split: ' ' | slice: -2 }}{%endif%}'/> {% endfor %} {% else %} <refcontent>{{i.authoritative_identifier | join: ', '}}</refcontent> {% endif %}</ref-included>{% endfor %}"
   website: standard
   book: standard
   booklet: standard

data/lib/relaton/render/parse.rb

@@ -24,7 +24,8 @@ module Relaton
 
         def series_xml2hash1(series, doc)
           ret = super
-          %w(BCP RFC I-D. Internet-Draft).include?(ret[:series_title]) and return {}
+          %w(BCP RFC I-D. Internet-Draft).include?(ret[:series_title]) and
+            return {}
           ret
         end
 
@@ -87,14 +88,48 @@ module Relaton
           super
         end
 
-        # add BCP number
+        # do not add BCP number, it is not included in IETF practice
         def authoritative_identifier(doc)
           ret = super
-          if bcp = doc.series.detect { |s| s.title.title.content == "BCP" }
-            ret.unshift("BCP #{bcp.number}")
-          end
+          #if bcp = doc.series.detect { |s| s.title.title.content == "BCP" }
+            #ret.unshift("BCP #{bcp.number}")
+         #end
           ret.reject { |x| /^(rfc-anchor|Internet-Draft)/.match? (x) }
         end
+
+        def simple_xml2hash(doc)
+          super.merge(stream: stream(doc))
+        end
+
+        def series(doc)
+          a = doc.series.reject { |s| s.type == "stream" }
+          a.empty? and return nil
+          a.detect { |s| s.type == "main" } ||
+            a.detect { |s| s.type.nil? } || a.first
+        end
+
+        def stream(doc)
+          a = doc.series.detect { |s| s.type == "stream" } or return nil
+          series_title(a, doc)
+        end
+
+        def extract(doc)
+          super.merge(included_xml2hash(doc))
+        end
+
+        def included_xml2hash(doc)
+          r = doc.relation.select { |x| x.type == "includes" }
+            .map { |x| parse_single_bibitem(x.bibitem) }
+          r.empty? and return {}
+          { included: r }
+        end
+
+        def parse_single_bibitem(doc)
+        data = extract(doc)
+        #enhance_data(data, r.template_raw)
+        #data_liquid = @fieldsklass.new(renderer: self)
+        #  .compound_fields_format(data)
+        end
       end
     end
   end

data/metanorma-ietf.gemspec

@@ -37,8 +37,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "metanorma-ietf-data"
-  spec.add_dependency "metanorma-standoc", "~> 2.7.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.8.0"
   spec.add_dependency "relaton-render"
+  spec.add_dependency "vectory", "~> 0.6"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"