metanorma-iso 1.3.23 → 1.4.0

data/lib/isodoc/iso/metadata.rb

@@ -6,19 +6,25 @@ module IsoDoc
       def initialize(lang, script, labels)
         super
         @metadata = {
-        tc: "XXXX",
-        sc: "XXXX",
-        wg: "XXXX",
-        editorialgroup: [],
-        secretariat: "XXXX",
-        obsoletes: nil,
-        obsoletes_part: nil
-      }
+          tc: "XXXX",
+          sc: "XXXX",
+          wg: "XXXX",
+          editorialgroup: [],
+          secretariat: "XXXX",
+          obsoletes: nil,
+          obsoletes_part: nil
+        }
       end
 
-      def status_abbrev(stage, substage, iter, draft)
+      def status_abbrev(stage, substage, iter, draft, doctype)
         return "" unless stage
-        stage += iter if iter
+        if %w(technical-report technical-specification).include?(doctype)
+          stage = "DTS" if stage == "DIS"
+          stage = "FDTS" if stage == "FDIS"
+        end
+        if %w(PWI NWIP WD CD).include?(stage)
+          stage += iter if iter
+        end
         stage = "Pre" + stage if draft =~ /^0\./
         stage
       end
@@ -33,7 +39,8 @@ module IsoDoc
           set(:statusabbr, status_abbrev(docstatus["abbreviation"] || "??",
                                          isoxml&.at(ns("//bibdata/status/substage"))&.text,
                                          isoxml&.at(ns("//bibdata/status/iteration"))&.text,
-                                         isoxml&.at(ns("//version/draft"))&.text))
+                                         isoxml&.at(ns("//version/draft"))&.text,
+                                         isoxml&.at(ns("//bibdata/ext/doctype"))&.text))
           unpublished(docstatus.text) and
             set(:stageabbr, docstatus["abbreviation"])
         end
@@ -46,12 +53,14 @@ module IsoDoc
       end
 
       def docid(isoxml, _out)
-        dn = isoxml.at(ns("//bibdata/docidentifier[@type = 'iso']"))
+        dn = isoxml.at(ns("//bibdata/docidentifier[@type = 'ISO']"))
         set(:docnumber, dn&.text)
         tcdn = isoxml.xpath(ns("//bibdata/docidentifier[@type = 'iso-tc']"))
         set(:tc_docnumber, tcdn.map { |n| n.text })
         dn = isoxml.at(ns("//bibdata/docidentifier[@type = 'iso-with-lang']"))
         set(:docnumber_lang, dn&.text)
+        dn = isoxml.at(ns("//bibdata/docidentifier[@type = 'iso-reference']"))
+        set(:docnumber_reference, dn&.text)
       end
 
       # we don't leave this to i18n.rb, because we have both English and
@@ -63,6 +72,20 @@ module IsoDoc
         end
       end
 
+      def amd_label(lang)
+        case lang
+        when "en" then "AMENDMENT"
+        when "fr" then "AMENDMENT"
+        end
+      end
+
+      def corr_label(lang)
+        case lang
+        when "en" then "TECHNICAL CORRIGENDUM"
+        when "fr" then "RECTIFICATIF TECHNIQUE"
+        end
+      end
+
       def part_title(part, partnum, subpartnum, lang)
         return "" unless part
         suffix = @c.encode(part.text, :hexadecimal)
@@ -76,6 +99,14 @@ module IsoDoc
         "#{part_label(lang)} #{partnum}"
       end
 
+      def amd_prefix(num, lang)
+        "#{amd_label(lang)} #{num}"
+      end
+
+      def corr_prefix(num, lang)
+        "#{corr_label(lang)} #{num}"
+      end
+
       def compose_title(main, intro, part, partnum, subpartnum, lang)
         main = main.nil? ? "" : @c.encode(main.text, :hexadecimal)
         intro &&
@@ -87,12 +118,23 @@ module IsoDoc
         main
       end
 
+      def title_nums(isoxml)
+        [isoxml.at(ns("//bibdata//project-number/@part")),
+         isoxml.at(ns("//bibdata//project-number/@subpart")),
+         isoxml.at(ns("//bibdata//project-number/@amendment")),
+         isoxml.at(ns("//bibdata//project-number/@corrigendum"))]
+      end
+
+      def title_parts(isoxml, lang)
+        [isoxml.at(ns("//bibdata//title[@type='title-intro' and @language='#{lang}']")),
+         isoxml.at(ns("//bibdata//title[@type='title-main' and @language='#{lang}']")),
+         isoxml.at(ns("//bibdata//title[@type='title-part' and @language='#{lang}']")),
+         isoxml.at(ns("//bibdata//title[@type='title-amd' and @language='#{lang}']"))]
+      end
+
       def title(isoxml, _out)
-        intro = isoxml.at(ns("//bibdata//title[@type='title-intro' and @language='en']"))
-        main = isoxml.at(ns("//bibdata//title[@type='title-main' and @language='en']"))
-        part = isoxml.at(ns("//bibdata//title[@type='title-part' and @language='en']"))
-        partnumber = isoxml.at(ns("//bibdata//project-number/@part"))
-        subpartnumber = isoxml.at(ns("//bibdata//project-number/@subpart"))
+        intro, main, part, amd = title_parts(isoxml, "en")
+        partnumber, subpartnumber, amdnumber, corrnumber = title_nums(isoxml)
 
         set(:doctitlemain, @c.encode(main ? main.text : "", :hexadecimal))
         main = compose_title(main, intro, part, partnumber, subpartnumber, "en")
@@ -100,20 +142,24 @@ module IsoDoc
         set(:doctitleintro, @c.encode(intro ? intro.text : "", :hexadecimal)) if intro
         set(:doctitlepartlabel, part_prefix(partnumber, subpartnumber, "en"))
         set(:doctitlepart, @c.encode(part.text, :hexadecimal)) if part
+        set(:doctitleamdlabel, amd_prefix(amdnumber, "en")) if amdnumber
+        set(:doctitleamd, @c.encode(amd.text, :hexadecimal)) if amd
+        set(:doctitlecorrlabel, corr_prefix(corrnumber, "en")) if corrnumber
       end
 
       def subtitle(isoxml, _out)
-        intro = isoxml.at(ns("//bibdata//title[@type='title-intro' and @language='fr']"))
-        main = isoxml.at(ns("//bibdata//title[@type='title-main' and @language='fr']"))
-        part = isoxml.at(ns("//bibdata//title[@type='title-part' and @language='fr']"))
-        partnumber = isoxml.at(ns("//bibdata//project-number/@part"))
-        subpartnumber = isoxml.at(ns("//bibdata//project-number/@subpart"))
+        intro, main, part, amd = title_parts(isoxml, "fr")
+        partnumber, subpartnumber, amdnumber, corrnumber = title_nums(isoxml)
+
         set(:docsubtitlemain, @c.encode(main ? main.text : "", :hexadecimal))
         main = compose_title(main, intro, part, partnumber, subpartnumber, "fr")
         set(:docsubtitle, main)
         set(:docsubtitleintro, @c.encode(intro ? intro.text : "", :hexadecimal)) if intro
         set(:docsubtitlepartlabel, part_prefix(partnumber, subpartnumber, "fr"))
         set(:docsubtitlepart, @c.encode(part.text, :hexadecimal)) if part
+        set(:docsubtitleamdlabel, amd_prefix(amdnumber, "fr")) if amdnumber
+        set(:docsubtitleamd, @c.encode(amd.text, :hexadecimal)) if amd
+        set(:docsubtitlecorrlabel, corr_prefix(corrnumber, "fr")) if corrnumber
       end
 
       def author(xml, _out)
@@ -164,7 +210,7 @@ module IsoDoc
         super
         ics = []
         isoxml.xpath(ns("//bibdata/ext/ics/code")).each { |i| ics << i.text }
-        set(:ics, ics.empty? ? "XXX" : ics.join(", "))
+        set(:ics, ics.empty? ? nil : ics.join(", "))
       end
     end
   end

data/lib/isodoc/iso/pdf_convert.rb

@@ -13,18 +13,12 @@ module IsoDoc
         super
       end
 
-      def convert(filename, file = nil, debug = false)
-        file = File.read(filename, encoding: "utf-8") if file.nil?
-        docxml, outname_html, dir = convert_init(file, filename, debug)
-        /\.xml$/.match(filename) or
-          filename = Tempfile.open([outname_html, ".xml"], encoding: "utf-8") do |f|
-          f.write file
-          f.path
+      def pdf_stylesheet(docxml)
+        case doctype = docxml&.at(ns("//bibdata/ext/doctype"))&.text
+        when "amendment", "technical-corrigendum" then "itu.recommendation-annex.xsl"
+        else
+          "iso.international-standard.xsl"
         end
-        FileUtils.rm_rf dir
-        ::Metanorma::Output::XslfoPdf.new.convert(
-          filename, outname_html + ".pdf",
-          File.join(@libdir, "iso.international-standard.xsl"))
       end
     end
   end

data/lib/isodoc/iso/presentation_xml_convert.rb

@@ -0,0 +1,13 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module Iso
+
+    # A {Converter} implementation that generates HTML output, and a document
+    # schema encapsulation of the document for validation
+    #
+    class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+    end
+  end
+end

data/lib/isodoc/iso/sections.rb

@@ -0,0 +1,66 @@
+module IsoDoc
+  module Iso
+    module BaseConvert
+      def middle_title(out)
+        middle_title_main(out)
+        middle_title_amd(out)
+      end
+
+      def middle_title_main(out)
+        out.p(**{ class: "zzSTDTitle1" }) do |p|
+          p << @meta.get[:doctitleintro]
+          p << " &mdash; " if @meta.get[:doctitleintro] && @meta.get[:doctitlemain]
+          p << @meta.get[:doctitlemain]
+          p << " &mdash; " if @meta.get[:doctitlemain] && @meta.get[:doctitlepart]
+        end
+        a = @meta.get[:doctitlepart] and out.p(**{ class: "zzSTDTitle2" }) do |p|
+          b = @meta.get[:doctitlepartlabel] and p << "#{b}: "
+          p << "<br/><b>#{a}</b>"
+        end
+      end
+
+      def middle_title_amd(out)
+        a = @meta.get[:doctitleamdlabel] and out.p(**{ class: "zzSTDTitle2" }) do |p|
+          p << a
+          a = @meta.get[:doctitleamd] and p << ": #{a}"
+        end
+        a = @meta.get[:doctitlecorrlabel] and out.p(**{ class: "zzSTDTitle2" }) do |p|
+          p << a
+        end
+      end
+
+      def annex(isoxml, out)
+        amd(isoxml) and @suppressheadingnumbers = @oldsuppressheadingnumbers
+        super
+        amd(isoxml) and @suppressheadingnumbers = true
+      end
+
+      def introduction(isoxml, out)
+        f = isoxml.at(ns("//introduction")) || return
+        num = f.at(ns(".//clause")) ? "0" : nil
+        title_attr = { class: "IntroTitle" }
+        page_break(out)
+        out.div **{ class: "Section3", id: f["id"] } do |div|
+          clause_name(num, @introduction_lbl, div, title_attr)
+          f.elements.each do |e|
+            parse(e, div) unless e.name == "title"
+          end
+        end
+      end
+
+      def foreword(isoxml, out)
+        f = isoxml.at(ns("//foreword")) || return
+        page_break(out)
+        out.div **attr_code(id: f["id"]) do |s|
+          s.h1(**{ class: "ForewordTitle" }) { |h1| h1 << @foreword_lbl }
+          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        end
+      end
+
+      def clause_parse_title(node, div, c1, out)
+        return inline_header_title(out, node, c1) if c1.nil?
+        super
+      end
+    end
+  end
+end

data/lib/isodoc/iso/sts_convert.rb

@@ -0,0 +1,31 @@
+require "isodoc"
+require "mn2sts"
+
+module IsoDoc
+  module Iso
+
+    # A {Converter} implementation that generates HTML output, and a document
+    # schema encapsulation of the document for validation
+    #
+    class StsConvert < IsoDoc::XslfoPdfConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        @format = :sts
+        @suffix = "sts.xml"
+      end
+
+      def convert(input_filename, file = nil, debug = false, output_filename = nil)
+        file = File.read(input_filename, encoding: "utf-8") if file.nil?
+        docxml, filename, dir = convert_init(file, input_filename, debug)
+        /\.xml$/.match(input_filename) or
+          input_filename = Tempfile.open([filename, ".xml"], encoding: "utf-8") do |f|
+          f.write file
+          f.path
+        end
+        FileUtils.rm_rf dir
+        Mn2sts.convert(input_filename, output_filename || "#{filename}.#{@suffix}")
+      end
+    end
+  end
+end
+

data/lib/isodoc/iso/xref.rb

@@ -0,0 +1,111 @@
+module IsoDoc
+  module Iso
+    class Xref < IsoDoc::Xref
+      def parse(docxml)
+        if @klass.amd(docxml)
+          back_anchor_names(docxml)
+          note_anchor_names(docxml.xpath(ns("//annex//table | //annex//figure")))
+          note_anchor_names(docxml.xpath(ns("//annex")))
+          example_anchor_names(docxml.xpath(ns("//annex")))
+          list_anchor_names(docxml.xpath(ns("//annex")))
+        else
+          super
+        end
+      end
+
+      def initial_anchor_names(d)
+        super
+        introduction_names(d.at(ns("//introduction")))
+      end
+
+      # we can reference 0-number clauses in introduction
+      def introduction_names(clause)
+        return if clause.nil?
+        clause.xpath(ns("./clause")).each_with_index do |c, i|
+          section_names1(c, "0.#{i + 1}", 2)
+        end
+      end
+
+      def annex_names(clause, num)
+        appendix_names(clause, num)
+        super
+      end
+
+      def appendix_names(clause, num)
+        clause.xpath(ns("./appendix")).each_with_index do |c, i|
+          @anchors[c["id"]] = anchor_struct(i + 1, nil, @labels["appendix"], "clause")
+          @anchors[c["id"]][:level] = 2
+          @anchors[c["id"]][:container] = clause["id"]
+        end
+      end
+
+      def section_names1(clause, num, level)
+        @anchors[clause["id"]] =
+          { label: num, level: level, xref: num }
+        # subclauses are not prefixed with "Clause"
+        clause.xpath(ns("./clause | ./terms | ./term | ./definitions | "\
+                        "./references")).
+                       each_with_index do |c, i|
+          section_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
+      end
+
+      def annex_names1(clause, num, level)
+        @anchors[clause["id"]] = { label: num, xref: num, level: level }
+        clause.xpath(ns("./clause | ./references")).each_with_index do |c, i|
+          annex_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
+      end
+
+      def hierarchical_formula_names(clause, num)
+        c = IsoDoc::XrefGen::Counter.new
+        clause.xpath(ns(".//formula")).each do |t|
+          next if t["id"].nil? || t["id"].empty?
+          @anchors[t["id"]] =
+            anchor_struct("#{num}#{hiersep}#{c.increment(t).print}", t,
+                          t["inequality"] ? @labels["inequality"] : @labels["formula"],
+                          "formula", t["unnumbered"])
+        end
+      end
+
+      def figure_anchor(t, sublabel, label)
+        @anchors[t["id"]] = anchor_struct(
+          (sublabel ? "#{label} #{sublabel}" : label),
+          nil, @labels["figure"], "figure", t["unnumbered"])
+        sublabel && t["unnumbered"] != "true" and
+          @anchors[t["id"]][:label] = sublabel
+      end
+
+      def sequential_figure_names(clause)
+        c = IsoDoc::XrefGen::Counter.new
+        j = 0
+        clause.xpath(ns(".//figure | .//sourcecode[not(ancestor::example)]")).
+          each do |t|
+          j = subfigure_increment(j, c, t)
+          sublabel = j.zero? ? nil : "#{(j+96).chr})"
+          next if t["id"].nil? || t["id"].empty?
+          figure_anchor(t, sublabel, c.print)
+        end
+      end
+
+      def hierarchical_figure_names(clause, num)
+        c = IsoDoc::XrefGen::Counter.new
+        j = 0
+        clause.xpath(ns(".//figure |  .//sourcecode[not(ancestor::example)]")).
+          each do |t|
+          j = subfigure_increment(j, c, t)
+          label = "#{num}#{hiersep}#{c.print}"
+          sublabel = j.zero? ? nil : "#{(j+96).chr})"
+          next if t["id"].nil? || t["id"].empty?
+          figure_anchor(t, sublabel, label)
+        end
+      end
+
+      def reference_names(ref)
+        super
+        @anchors[ref["id"]] = { xref: @anchors[ref["id"]][:xref].
+                                sub(/ \(All Parts\)/i, "") }
+      end
+    end
+  end
+end

data/lib/metanorma-iso.rb

@@ -4,6 +4,8 @@ require_relative "metanorma/iso/version"
 require_relative "isodoc/iso/html_convert"
 require_relative "isodoc/iso/word_convert"
 require_relative "isodoc/iso/pdf_convert"
+require_relative "isodoc/iso/sts_convert"
+require_relative "isodoc/iso/presentation_xml_convert"
 require "asciidoctor/extensions"
 
 if defined? Metanorma

data/lib/metanorma/iso/processor.rb

@@ -2,8 +2,13 @@ require "metanorma/processor"
 
 module Metanorma
   module Iso
-    def self.pdf_fonts
-      ["Cambria", "Times New Roman", "Cambria Math", "HanSans", "Courier"]
+    def self.fonts_used
+      {
+        html: ["Cambria", "Times New Roman", "Cambria Math", "HanSans", "Courier New"],
+        html_alt: ["Cambria", "Times New Roman", "Cambria Math", "HanSans", "Courier New"],
+        doc: ["Cambria", "Times New Roman", "Cambria Math", "HanSans", "Courier New"],
+        pdf: ["Cambria", "Times New Roman", "Cambria Math", "HanSans", "Courier New"],
+      }
     end
 
     class Processor < Metanorma::Processor
@@ -19,7 +24,8 @@ module Metanorma
           html: "html",
           html_alt: "alt.html",
           doc: "doc",
-          pdf: "pdf"
+          pdf: "pdf",
+          sts: "sts.xml"
         )
       end
 
@@ -31,16 +37,25 @@ module Metanorma
         Metanorma::Input::Asciidoc.new.process(file, filename, @asciidoctor_backend)
       end
 
-      def output(isodoc_node, outname, format, options={})
+      def use_presentation_xml(ext)
+        return true if ext == :html_alt
+        super
+      end
+
+      def output(isodoc_node, inname, outname, format, options={})
         case format
         when :html
-          IsoDoc::Iso::HtmlConvert.new(options).convert(outname, isodoc_node)
+          IsoDoc::Iso::HtmlConvert.new(options).convert(inname, isodoc_node, nil, outname)
         when :html_alt
-          IsoDoc::Iso::HtmlConvert.new(options.merge(alt: true)).convert(outname, isodoc_node)
+          IsoDoc::Iso::HtmlConvert.new(options.merge(alt: true)).convert(inname, isodoc_node, nil, outname)
         when :doc
-          IsoDoc::Iso::WordConvert.new(options).convert(outname, isodoc_node)
+          IsoDoc::Iso::WordConvert.new(options).convert(inname, isodoc_node, nil, outname)
         when :pdf
-          IsoDoc::Iso::PdfConvert.new(options).convert(outname, isodoc_node)
+          IsoDoc::Iso::PdfConvert.new(options).convert(inname, isodoc_node, nil, outname)
+        when :sts
+          IsoDoc::Iso::StsConvert.new(options).convert(inname, isodoc_node, nil, outname)
+        when :presentation
+          IsoDoc::Iso::PresentationXMLConvert.new(options).convert(inname, isodoc_node, nil, outname)
         else
           super
         end