metanorma-ietf 2.0.10 → 2.1.1

data/lib/asciidoctor/ietf/reqt.rng

@@ -30,9 +30,22 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="subsequence"/>
     </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <attribute name="id">
       <data type="ID"/>
     </attribute>
@@ -141,6 +154,16 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <oneOrMore>
       <ref name="BasicBlock"/>
     </oneOrMore>

data/lib/isodoc/ietf/blocks.rb

@@ -1,8 +1,8 @@
 module IsoDoc::Ietf
   class RfcConvert < ::IsoDoc::Convert
     def para_attrs(node)
-      { keepWithNext: node["keepWithNext"],
-        keepWithPrevious: node["keepWithPrevious"],
+      { keepWithNext: node["keep-with-next"],
+        keepWithPrevious: node["keep-with-previous"],
         anchor: node["id"] }
     end
 
@@ -56,23 +56,25 @@ module IsoDoc::Ietf
       end
     end
 
-    def dl_attr(node)
+    def dl_attrs(node)
       attr_code(anchor: node["id"],
                 newline: node["newline"],
                 indent: node["indent"],
                 spacing: node["spacing"])
     end
 
-     def dt_parse(dt, term)
+    def dt_parse(dt, term)
       if dt.elements.empty?
-          term << dt.text
+        term << dt.text
       else
         dt.children.each { |n| parse(n, term) }
       end
     end
 
     def note_label(node)
-      l10n("#{super}: ")
+      n = @xrefs.get[node["id"]]
+      return l10n("#{@note_lbl}: ") if n.nil? || n[:label].nil? || n[:label].empty?
+      l10n("#{@note_lbl} #{n[:label]}: ")
     end
 
     def note_parse(node, out)
@@ -94,7 +96,7 @@ module IsoDoc::Ietf
     end
 
     def example_label(node, div, name)
-      n = get_anchors[node["id"]]
+      n = @xrefs.get[node["id"]]
       div.t **attr_code(anchor: node["id"], keepWithNext: "true") do |p|
         lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @example_lbl :
           l10n("#{@example_lbl} #{n[:label]}")
@@ -112,8 +114,8 @@ module IsoDoc::Ietf
         div.sourcecode **attr_code(type: node["lang"], name: node["filename"],
                                    markers: node["markers"],
                                    src: node["src"]) do |s|
-          node.children.each { |x| parse(x, s) unless x.name == "name" }
-        end
+                                     node.children.each { |x| parse(x, s) unless x.name == "name" }
+                                   end
       end
     end
 
@@ -144,12 +146,21 @@ module IsoDoc::Ietf
     def formula_parse1(node, out)
       out.t **attr_code(anchor: node["id"]) do |p|
         parse(node.at(ns("./stem")), p)
-        lbl = anchor(node['id'], :label, false)
+        lbl = @xrefs.anchor(node['id'], :label, false)
         lbl.nil? or
           p << "    (#{lbl})"
       end
     end
 
+    def formula_parse(node, out)
+      formula_parse1(node, out)
+      formula_where(node.at(ns("./dl")), out)
+      node.children.each do |n|
+        next if %w(stem dl).include? n.name
+        parse(n, out)
+      end
+    end
+
     def quote_attribution(node)
       author = node&.at(ns("./author"))&.text
       source = node&.at(ns("./source/@uri"))&.text

data/lib/isodoc/ietf/front.rb

@@ -19,16 +19,20 @@ module IsoDoc::Ietf
     end
 
     def info(isoxml, out)
-      @meta.keywords isoxml, out
       @meta.areas isoxml, out
       super
     end
 
+    def output_if_translit(text)
+      return nil if text.nil?
+      text.transliterate != text ? text.transliterate : nil
+    end
+
     def title(isoxml, front)
       title = @meta.get[:doctitle] or return
       front.title title, **attr_code(abbrev: @meta.get[:docabbrev],
-                                     ascii: @meta.get[:docascii] ||
-                                     title.transliterate)
+                                     ascii: (@meta.get[:docascii] ||
+                                     output_if_translit(title)))
     end
 
     def seriesinfo(isoxml, front)
@@ -38,7 +42,7 @@ module IsoDoc::Ietf
 
     def seriesinfo_attr(isoxml)
       attr_code(value: @meta.get[:docnumber] || "",
-                asciiValue: @meta.get[:docnumber]&.transliterate,
+                asciiValue: output_if_translit(@meta.get[:docnumber]),
                 status: @meta.get[:stage],
                 stream: isoxml&.at(ns("//bibdata/series[@type = 'stream']/"\
                                       "title"))&.text)
@@ -83,9 +87,9 @@ module IsoDoc::Ietf
 
     def pers_author_attrs1(ret, full, init, c)
       full and ret.merge!(attr_code(
-        asciiFullname: full&.transliterate,
-        asciiInitials: init&.transliterate,
-        asciiSurname: c&.at(ns("./surname"))&.text&.transliterate))
+        asciiFullname: output_if_translit(full),
+        asciiInitials: output_if_translit(init),
+        asciiSurname: output_if_translit(c&.at(ns("./surname")))))
       ret
     end
 
@@ -114,8 +118,8 @@ module IsoDoc::Ietf
     def organization(org, out, show)
       name = org.at(ns("./name"))&.text
       out.organization name, **attr_code(
-        showOnFrontPage: show&.text, ascii: name&.transliterate,
-        asciiAbbrev: org&.at(ns("./abbreviation"))&.transliterate,
+        showOnFrontPage: show&.text, ascii: output_if_translit(name),
+        asciiAbbrev: output_if_translit(org.at(ns("./abbreviation"))),
         abbrev: org.at(ns("./abbreviation")))
     end
 

data/lib/isodoc/ietf/inline.rb

@@ -120,11 +120,15 @@ module IsoDoc::Ietf
 
     def eref_parse(node, out)
       linkend = node.children.reject { |c| %w{locality localityStack}.include? c.name }
+      relative = node["relative"] ||
+        node.at(ns(".//locality[@type = 'anchor']/referenceFrom"))&.text || ""
       section = eref_clause(node.xpath(ns("./locality | ./localityStack")), nil) || ""
+      section = "" if relative.empty?
       out.relref **attr_code(target: node["bibitemid"], section: section,
+                             relative: relative,
                              displayFormat: node["displayFormat"]) do |l|
-        linkend.each { |n| parse(n, l) }
-      end
+                               linkend.each { |n| parse(n, l) }
+                             end
     end
 
     def eref_clause(refs, target)

data/lib/isodoc/ietf/metadata.rb

@@ -19,14 +19,6 @@ module IsoDoc
         # = item describedby convertedfrom alternate
       end
 
-      def keywords(isoxml, _out)
-        ret = []
-        isoxml.xpath(ns("//bibdata/keyword")).each do |kw|
-          ret << kw.text
-        end
-        set(:keywords, ret)
-      end
-
       def areas(isoxml, _out)
         ret = []
         isoxml.xpath(ns("//bibdata/ext/area")).each do |kw|
@@ -45,18 +37,18 @@ module IsoDoc
         wg(xml)
       end
 
-       def wg(xml)
-         workgroups = []
-         xml.xpath(ns("//bibdata/ext/editorialgroup/workgroup")).each do |wg|
-           workgroups << wg.text
+      def wg(xml)
+        workgroups = []
+        xml.xpath(ns("//bibdata/ext/editorialgroup/workgroup")).each do |wg|
+          workgroups << wg.text
         end
-         set(:wg, workgroups)
+        set(:wg, workgroups)
       end
 
-       def doctype(isoxml, _out)
-         super
-         set(:doctype, "Rfc") if get[:doctype].nil?
-       end
+      def doctype(isoxml, _out)
+        super
+        set(:doctype, "Rfc") if get[:doctype].nil?
+      end
     end
   end
 end

data/lib/isodoc/ietf/references.rb

@@ -50,8 +50,9 @@ module IsoDoc::Ietf
           r.format nil, **attr_code(target: u.text, type: u["type"])
         end
         docidentifiers = b.xpath(ns("./docidentifier"))
-        id = bibitem_ref_code(b) and id.text != "(NO ID)" and
-          r.refcontent render_identifier(id)
+        id = render_identifier(bibitem_ref_code(b))
+        !id[1].nil? and id[1] != "(NO ID)" and
+          r.refcontent id[1]
         docidentifiers&.each do |u|
           if %w(DOI IETF).include? u["type"]
             r.seriesInfo nil, **attr_code(value: u.text, name: u["type"])
@@ -67,15 +68,6 @@ module IsoDoc::Ietf
       end
     end
 
-    def bibitem_ref_code(b)
-      id =  b.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'metanorma' "\
-                    "or @type = 'ISSN' or @type = 'ISBN' or @type = 'IETF')]"))
-      return id if id
-      id = Nokogiri::XML::Node.new("docidentifier", b.document)
-      id << "(NO ID)"
-      id
-    end
-
     def relaton_to_author(b, f)
       auths = b.xpath(ns("./contributor[xmlns:role/@type = 'author' or "\
                          "xmlns:role/@type = 'editor']"))

data/lib/isodoc/ietf/reqt.rb

@@ -1,5 +1,10 @@
 module IsoDoc::Ietf
   class RfcConvert < ::IsoDoc::Convert
+    def recommendation_labels(node)
+      [node.at(ns("./label")), node.at(ns("./title")), 
+       @xrefs.anchor(node['id'], :label, false)]
+    end
+
     def recommendation_name(node, out, type)
       label, title, lbl = recommendation_labels(node)
       out.t **{ keepWithNext: "true" }  do |b|

data/lib/isodoc/ietf/rfc_convert.rb

@@ -9,11 +9,12 @@ require_relative "./cleanup"
 require_relative "./footnotes"
 require_relative "./references"
 require_relative "./section"
+require_relative "./xref"
 
 module IsoDoc::Ietf
   class RfcConvert < ::IsoDoc::Convert
     def convert1(docxml, filename, dir)
-      anchor_names docxml
+      @xrefs.parse docxml
       info docxml, nil
       xml = noko do |xml|
         xml.rfc **attr_code(rfc_attributes(docxml)) do |html|
@@ -30,6 +31,10 @@ module IsoDoc::Ietf
       @meta = Metadata.new(lang, script, labels)
     end
 
+    def xref_init(lang, script, klass, labels, options)
+        @xrefs = Xref.new(lang, script, klass, labels, options)
+      end
+
     def extract_delims(text)
       @openmathdelim = "$$"
       @closemathdelim = "$$"
@@ -50,10 +55,15 @@ module IsoDoc::Ietf
       end
     end
 
+     def textcleanup(docxml)
+      passthrough_cleanup(docxml)
+     end
+
     def postprocess(result, filename, dir)
-      result = from_xhtml(cleanup(to_xhtml(result))).sub(/<!DOCTYPE[^>]+>\n/, "").
+      result = from_xhtml(cleanup(to_xhtml(textcleanup(result)))).
+        sub(/<!DOCTYPE[^>]+>\n/, "").
         sub(/(<rfc[^<]+? )lang="[^"]+"/, "\\1")
-      File.open("#{filename}.rfc.xml", "w:UTF-8") { |f| f.write(result) }
+      File.open(filename, "w:UTF-8") { |f| f.write(result) }
       @files_to_delete.each { |f| FileUtils.rm_rf f }
     end
 
@@ -66,6 +76,7 @@ module IsoDoc::Ietf
       super
       @xinclude = options[:use_xinclude] == "true"
       @format = :rfc
+      @suffix = "rfc.xml"
     end
   end
 end

data/lib/isodoc/ietf/section.rb

@@ -60,7 +60,8 @@ module IsoDoc::Ietf
       {
         docName:        @meta.get[:doctype] == "Internet Draft" ? @meta.get[:docnumber] : nil,
         number:         @meta.get[:doctype].casecmp?("rfc") ? @meta.get[:docnumber] : nil,
-        category:       docxml&.at(ns("//bibdata/series[@type = 'intended']/title"))&.text || "std",
+        category:       series2category(
+          docxml&.at(ns("//bibdata/series[@type = 'intended']/title"))&.text),
         ipr:            docxml&.at(ns("//bibdata/ext/ipr"))&.text,
         obsoletes:      obs,
         updates:        upd,
@@ -78,6 +79,20 @@ module IsoDoc::Ietf
       }
     end
 
+    def series2category(series)
+      case series&.downcase
+      when "standard", "std" then "std"
+      when "informational", "info" then "info"
+      when "experimental", "exp" then "exp"
+      when "bcp" then "bcp"
+      when "fyi", "info" then "info"
+      when "full-standard" then "std"
+      when "historic" then "historic"
+      else
+        "std"
+      end
+    end
+
     def xpath_comma(xpath)
       return nil if xpath.empty?
       xpath.map { |x| x.text }.join(", ")

data/lib/isodoc/ietf/table.rb

@@ -1,12 +1,12 @@
 module IsoDoc::Ietf
   class RfcConvert < ::IsoDoc::Convert
-    def make_table_attr(node)
+    def table_attrs(node)
       attr_code(anchor: node["id"], align: node["align"])
     end
 
     def table_parse(node, out)
       @in_table = true
-      out.table **make_table_attr(node) do |t|
+      out.table **table_attrs(node) do |t|
         table_title_parse(node, out)
         thead_parse(node, t)
         tbody_parse(node, t)

data/lib/isodoc/ietf/terms.rb

@@ -48,18 +48,5 @@ module IsoDoc::Ietf
 
     def termdocsource_parse(_node, _out)
     end
-
-    def termnote_anchor_names(docxml)
-      docxml.xpath(ns("//term[descendant::termnote]")).each do |t|
-        c = Counter.new
-        notes = t.xpath(ns(".//termnote"))
-        notes.each do |n|
-          next if n["id"].nil? || n["id"].empty?
-          idx = notes.size == 1 ? "" : " #{c.increment(n).print}"
-          @anchors[n["id"]] =
-            anchor_struct(idx, n, @note_xref_lbl, "note", false)
-        end
-      end
-    end
   end
 end

data/lib/isodoc/ietf/xref.rb

@@ -0,0 +1,20 @@
+require "isodoc"
+
+module IsoDoc
+  module Ietf
+    class Xref < IsoDoc::Xref
+      def termnote_anchor_names(docxml)
+        docxml.xpath(ns("//term[descendant::termnote]")).each do |t|
+          c = IsoDoc::XrefGen::Counter.new
+          notes = t.xpath(ns(".//termnote"))
+          notes.each do |n|
+            next if n["id"].nil? || n["id"].empty?
+            idx = notes.size == 1 ? "" : " #{c.increment(n).print}"
+            @anchors[n["id"]] =
+              anchor_struct(idx, n, @labels["note_xref"], "note", false)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/ietf/processor.rb

@@ -48,14 +48,19 @@ module Metanorma
         nil
       end
 
+      def use_presentation_xml(ext)
+        false
+      end
+
       def xml2rfc_present?
         !which("xml2rfc").nil?
       end
 
-      def output(isodoc_node, outname, format, options={})
+      def output(isodoc_node, inname, outname, format, options={})
         case format
         when :rfc
-          IsoDoc::Ietf::RfcConvert.new(options).convert(outname, isodoc_node)
+          outname ||= inname.sub(/\.xml$/, ".rfc.xml")
+          IsoDoc::Ietf::RfcConvert.new(options).convert(inname, isodoc_node, nil, outname)
           @done_rfc = true
 
         when :txt
@@ -64,9 +69,10 @@ module Metanorma
             return
           end
 
-          rfcname = outname.sub(/\.txt$/, ".rfc.xml")
-          output(isodoc_node, outname, :rfc, options) unless @done_rfc
+          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
@@ -75,9 +81,10 @@ module Metanorma
             return
           end
 
-          rfcname = outname.sub(/\.pdf$/, ".rfc.xml")
-          output(isodoc_node, outname, :rfc, options) unless @done_rfc
+          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
@@ -86,9 +93,10 @@ module Metanorma
             return
           end
 
-          rfcname = outname.sub(/\.html$/, ".rfc.xml")
-          output(isodoc_node, outname, :rfc, options) unless @done_rfc
+          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}")
 
         else