isodoc 1.0.25 → 1.1.0

data/lib/isodoc/{function → xref}/xref_gen.rb

@@ -1,11 +1,9 @@
-require_relative "xref_counter"
-require_relative "xref_anchor"
-require_relative "xref_gen_seq"
+require_relative "xref_gen_seq.rb"
 
-module IsoDoc::Function
-  module XrefGen
+module IsoDoc::XrefGen
+  module Blocks
     def termnote_label(n)
-      @termnote_lbl.gsub(/%/, n.to_s)
+      @labels["termnote"].gsub(/%/, n.to_s)
     end
 
     def termnote_anchor_names(docxml)
@@ -17,7 +15,7 @@ module IsoDoc::Function
           @anchors[n["id"]] =
             { label: termnote_label(c.print), type: "termnote",
               xref: l10n("#{anchor(t['id'], :xref)}, "\
-                         "#{@note_xref_lbl} #{c.print}") }
+                         "#{@labels["note_xref"]} #{c.print}") }
         end
       end
     end
@@ -33,13 +31,14 @@ module IsoDoc::Function
           @anchors[n["id"]] = {
             type: "termexample", label: idx, 
             xref: l10n("#{anchor(t['id'], :xref)}, "\
-                       "#{@example_xref_lbl} #{c.print}") }
+                       "#{@labels["example_xref"]} #{c.print}") }
         end
       end
     end
 
     SECTIONS_XPATH =
       "//foreword | //introduction | //acknowledgements | //preface/clause | "\
+      "//preface/terms | preface/definitions | preface/references | "\
       "//sections/terms | //annex | "\
       "//sections/clause | //sections/definitions | "\
       "//bibliography/references | //bibliography/clause".freeze
@@ -56,7 +55,7 @@ module IsoDoc::Function
         notes.each do |n|
           next if @anchors[n["id"]] || n["id"].nil? || n["id"].empty?
           idx = notes.size == 1 ? "" : " #{c.increment(n).print}"
-          @anchors[n["id"]] = anchor_struct(idx, n, @note_xref_lbl, 
+          @anchors[n["id"]] = anchor_struct(idx, n, @labels["note_xref"], 
                                             "note", false)
         end
         note_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
@@ -68,7 +67,7 @@ module IsoDoc::Function
       "not(self::xmlns:terms) and not(self::xmlns:definitions)]//"\
       "xmlns:example | ./xmlns:example".freeze
 
-    CHILD_SECTIONS = "./clause | ./appendix | ./terms | ./definitions"
+    CHILD_SECTIONS = "./clause | ./appendix | ./terms | ./definitions | ./references"
 
     def example_anchor_names(sections)
       sections.each do |s|
@@ -78,7 +77,7 @@ module IsoDoc::Function
           next if @anchors[n["id"]]
           next if n["id"].nil? || n["id"].empty?
           idx = notes.size == 1 ? "" : " #{c.increment(n).print}"
-          @anchors[n["id"]] = anchor_struct(idx, n, @example_xref_lbl,
+          @anchors[n["id"]] = anchor_struct(idx, n, @labels["example_xref"],
                                             "example", n["unnumbered"])
         end
         example_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
@@ -93,7 +92,7 @@ module IsoDoc::Function
         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, @list_lbl, "list", false)
+          @anchors[n["id"]] = anchor_struct(idx, n, @labels["list"], "list", false)
           list_item_anchor_names(n, @anchors[n["id"]], 1, "", notes.size != 1)
         end
         list_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
@@ -114,16 +113,5 @@ module IsoDoc::Function
         end
       end
     end
-
-    # extract names for all anchors, xref and label
-    def anchor_names(docxml)
-      initial_anchor_names(docxml)
-      back_anchor_names(docxml)
-      # preempt clause notes with all other types of note (ISO default)
-      note_anchor_names(docxml.xpath(ns("//table | //figure")))
-      note_anchor_names(docxml.xpath(ns(SECTIONS_XPATH)))
-      example_anchor_names(docxml.xpath(ns(SECTIONS_XPATH)))
-      list_anchor_names(docxml.xpath(ns(SECTIONS_XPATH)))
-    end
   end
 end

data/lib/isodoc/{function → xref}/xref_gen_seq.rb

@@ -1,19 +1,32 @@
-module IsoDoc::Function
-  module XrefGen
+module IsoDoc::XrefGen
+  module Blocks
+    def hiersep
+      "."
+    end
+
+    def hierfigsep
+      "-"
+    end
+
+    def subfigure_increment(j, c, t)
+      if t.parent.name == "figure" then j += 1
+      else
+        j = 0
+        c.increment(t)
+      end
+      j
+    end
+
     def sequential_figure_names(clause)
       c = Counter.new
       j = 0
       clause.xpath(ns(".//figure | .//sourcecode[not(ancestor::example)]")).
         each do |t|
-        if t.parent.name == "figure" then j += 1
-        else
-          j = 0
-          c.increment(t)
-        end
+        j = subfigure_increment(j, c, t)
         label = c.print + (j.zero? ? "" : "-#{j}")
         next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] =
-          anchor_struct(label, nil, @figure_lbl, "figure", t["unnumbered"])
+          anchor_struct(label, nil, @labels["figure"], "figure", t["unnumbered"])
       end
     end
 
@@ -22,7 +35,7 @@ module IsoDoc::Function
       clause.xpath(ns(".//table")).each do |t|
         next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] = anchor_struct(c.increment(t).print, nil, 
-                                          @table_lbl, "table", t["unnumbered"])
+                                          @labels["table"], "table", t["unnumbered"])
       end
     end
 
@@ -32,7 +45,7 @@ module IsoDoc::Function
         next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] =
           anchor_struct(c.increment(t).print, t, 
-                        t["inequality"] ? @inequality_lbl : @formula_lbl,
+                        t["inequality"] ? @labels["inequality"] : @labels["formula"],
                         "formula", t["unnumbered"])
       end
     end
@@ -51,9 +64,9 @@ module IsoDoc::Function
     end
 
     def sequential_permission_names2(t, id)
-      sequential_permission_names1(t, id, "permission", @permission_lbl)
-      sequential_permission_names1(t, id, "requirement", @requirement_lbl)
-      sequential_permission_names1(t, id, "recommendation", @recommendation_lbl)
+      sequential_permission_names1(t, id, "permission", @labels["permission"])
+      sequential_permission_names1(t, id, "requirement", @labels["requirement"])
+      sequential_permission_names1(t, id, "recommendation", @labels["recommendation"])
     end
 
     def sequential_permission_names1(block, lbl, klass, label)
@@ -70,9 +83,9 @@ module IsoDoc::Function
       sequential_table_names(clause)
       sequential_figure_names(clause)
       sequential_formula_names(clause)
-      sequential_permission_names(clause, "permission", @permission_lbl)
-      sequential_permission_names(clause, "requirement", @requirement_lbl)
-      sequential_permission_names(clause, "recommendation", @recommendation_lbl)
+      sequential_permission_names(clause, "permission", @labels["permission"])
+      sequential_permission_names(clause, "requirement", @labels["requirement"])
+      sequential_permission_names(clause, "recommendation", @labels["recommendation"])
     end
 
     def hierarchical_figure_names(clause, num)
@@ -80,15 +93,11 @@ module IsoDoc::Function
       j = 0
       clause.xpath(ns(".//figure |  .//sourcecode[not(ancestor::example)]")).
         each do |t|
-        if t.parent.name == "figure" then j += 1
-        else
-          j = 0
-          c.increment(t)
-        end
+        j = subfigure_increment(j, c, t)
         label = "#{num}#{hiersep}#{c.print}" +
           (j.zero? ? "" : "#{hierfigsep}#{j}")
         next if t["id"].nil? || t["id"].empty?
-        @anchors[t["id"]] = anchor_struct(label, nil, @figure_lbl, "figure",
+        @anchors[t["id"]] = anchor_struct(label, nil, @labels["figure"], "figure",
                                           t["unnumbered"])
       end
     end
@@ -99,7 +108,7 @@ module IsoDoc::Function
         next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] =
           anchor_struct("#{num}#{hiersep}#{c.increment(t).print}",
-                        nil, @table_lbl, "table", t["unnumbered"])
+                        nil, @labels["table"], "table", t["unnumbered"])
       end
     end
 
@@ -107,11 +116,11 @@ module IsoDoc::Function
       hierarchical_table_names(clause, num)
       hierarchical_figure_names(clause, num)
       hierarchical_formula_names(clause, num)
-      hierarchical_permission_names(clause, num, "permission", @permission_lbl)
+      hierarchical_permission_names(clause, num, "permission", @labels["permission"])
       hierarchical_permission_names(clause, num, "requirement",
-                                    @requirement_lbl)
+                                    @labels["requirement"])
       hierarchical_permission_names(clause, num, "recommendation",
-                                    @recommendation_lbl)
+                                    @labels["recommendation"])
     end
 
     def hierarchical_formula_names(clause, num)
@@ -120,7 +129,7 @@ module IsoDoc::Function
         next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] =
           anchor_struct("#{num}#{hiersep}#{c.increment(t).print}", nil,
-                        t["inequality"] ? @inequality_lbl : @formula_lbl,
+                        t["inequality"] ? @labels["inequality"] : @labels["formula"],
                         "formula", t["unnumbered"])
       end
     end
@@ -135,13 +144,13 @@ module IsoDoc::Function
       end
     end
 
-     def hierarchical_permission_names2(t, id)
-      hierarchical_permission_names1(t, id, "permission", @permission_lbl)
-      hierarchical_permission_names1(t, id, "requirement", @requirement_lbl)
-      hierarchical_permission_names1(t, id, "recommendation", @recommendation_lbl)
+    def hierarchical_permission_names2(t, id)
+      hierarchical_permission_names1(t, id, "permission", @labels["permission"])
+      hierarchical_permission_names1(t, id, "requirement", @labels["requirement"])
+      hierarchical_permission_names1(t, id, "recommendation", @labels["recommendation"])
     end
 
-     def hierarchical_permission_names1(block, lbl, klass, label)
+    def hierarchical_permission_names1(block, lbl, klass, label)
       c = Counter.new
       block.xpath(ns("./#{klass}")).each do |t|
         next if t["id"].nil? || t["id"].empty?

data/lib/isodoc/{function → xref}/xref_sect_gen.rb

@@ -1,39 +1,28 @@
-module IsoDoc::Function
-  module XrefSectGen
+module IsoDoc::XrefGen
+  module Sections
     def back_anchor_names(docxml)
       docxml.xpath(ns("//annex")).each_with_index do |c, i|
         annex_names(c, (65 + i).chr.to_s)
       end
       docxml.xpath(
-        ns("//bibliography/clause[not(xmlns:title = 'Normative References' or "\
-           "xmlns:title = 'Normative references')] |"\
-           "//bibliography/references[not(xmlns:title = 'Normative References'"\
-           " or xmlns:title = 'Normative references')]")).each do |b|
-        preface_names(b)
-      end
-      docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |ref|
-        reference_names(ref)
-      end
+        ns("//bibliography/clause[.//references[@normative = 'false']] | "\
+           "//bibliography/references[@normative = 'false']"
+          )).each do |b|
+            preface_names(b)
+          end
+          docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |ref|
+            reference_names(ref)
+          end
     end
 
     def initial_anchor_names(d)
-      preface_names(d.at(ns("//preface/abstract")))
-      preface_names(d.at(ns("//foreword")))
-      preface_names(d.at(ns("//introduction")))
-      d.xpath(ns("//preface/clause")).each do |c|
-      preface_names(c)
-      end
-      preface_names(d.at(ns("//acknowledgements")))
+      d.xpath(ns("//preface/*")).each { |c| c.element? and preface_names(c) }
       # potentially overridden in middle_section_asset_names()
-      sequential_asset_names(
-        d.xpath(ns("//preface/abstract | //foreword | //introduction | "\
-                   "//preface/clause | //acknowledgements")))
+      sequential_asset_names(d.xpath(ns("//preface/*")))
       n = section_names(d.at(ns("//clause[title = 'Scope']")), 0, 1)
       n = section_names(d.at(ns(
-        "//bibliography/clause[title = 'Normative References' or "\
-        "title = 'Normative references'] |"\
-        "//bibliography/references[title = 'Normative References' or "\
-        "title = 'Normative references']")), n, 1)
+        "//bibliography/clause[.//references[@normative = 'true']] | "\
+        "//bibliography/references[@normative = 'true']")), n, 1)
       n = section_names(d.at(ns("//sections/terms | "\
                                 "//sections/clause[descendant::terms]")), n, 1)
       n = section_names(d.at(ns("//sections/definitions")), n, 1)
@@ -76,17 +65,14 @@ module IsoDoc::Function
 
     def middle_section_asset_names(d)
       middle_sections = "//clause[title = 'Scope'] | "\
-        "//references[title = 'Normative References' or title = "\
-        "'Normative references'] | "\
-        "//sections/terms | //preface/abstract | //foreword | "\
-        "//introduction | //preface/clause | //acknowledgements | "\
+        "//references[@normative = 'true'] | "\
+        "//sections/terms | //preface/* | "\
         "//sections/definitions | //clause[parent::sections]"
       sequential_asset_names(d.xpath(ns(middle_sections)))
     end
 
     def clause_names(docxml, sect_num)
-      q = self.class::MIDDLE_CLAUSE
-      docxml.xpath(ns(q)).each_with_index do |c, i|
+      docxml.xpath(ns(@klass.middle_clause)).each_with_index do |c, i|
         section_names(c, (i + sect_num), 1)
       end
     end
@@ -95,7 +81,7 @@ module IsoDoc::Function
       return num if clause.nil?
       num = num + 1
       @anchors[clause["id"]] =
-        { label: num.to_s, xref: l10n("#{@clause_lbl} #{num}"), level: lvl,
+        { label: num.to_s, xref: l10n("#{@labels["clause"]} #{num}"), level: lvl,
           type: "clause" }
       clause.xpath(ns(SUBCLAUSES)).
         each_with_index do |c, i|
@@ -106,7 +92,7 @@ module IsoDoc::Function
 
     def section_names1(clause, num, level)
       @anchors[clause["id"]] =
-        { label: num, level: level, xref: l10n("#{@clause_lbl} #{num}"),
+        { label: num, level: level, xref: l10n("#{@labels["clause"]} #{num}"),
           type: "clause" }
       clause.xpath(ns(SUBCLAUSES)).
         each_with_index do |c, i|
@@ -115,27 +101,55 @@ module IsoDoc::Function
     end
 
     def annex_name_lbl(clause, num)
-      obl = l10n("(#{@inform_annex_lbl})")
-      obl = l10n("(#{@norm_annex_lbl})") if clause["obligation"] == "normative"
-      l10n("<b>#{@annex_lbl} #{num}</b><br/>#{obl}")
+      obl = l10n("(#{@labels["inform_annex"]})")
+      obl = l10n("(#{@labels["norm_annex"]})") if clause["obligation"] == "normative"
+      l10n("<b>#{@labels["annex"]} #{num}</b><br/>#{obl}")
+    end
+
+    def single_annex_special_section(clause)
+      a = clause.xpath(ns("./references | ./terms | ./definitions"))
+      a.size == 1 or return nil
+      clause.xpath(ns("./clause | ./p | ./table | ./ol | ./ul | ./dl | "\
+                      "./note | ./admonition | ./figure")).size == 0 or
+                     return nil
+      a[0]
     end
 
     def annex_names(clause, num)
       @anchors[clause["id"]] = { label: annex_name_lbl(clause, num),
                                  type: "clause",
-                                 xref: "#{@annex_lbl} #{num}", level: 1 }
-      clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
-        annex_names1(c, "#{num}.#{i + 1}", 2)
+                                 xref: "#{@labels["annex"]} #{num}", level: 1 }
+      if a = single_annex_special_section(clause)
+        annex_names1(a, "#{num}", 1)
+      else
+        clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
+          annex_names1(c, "#{num}.#{i + 1}", 2)
+        end
       end
       hierarchical_asset_names(clause, num)
     end
 
     def annex_names1(clause, num, level)
-      @anchors[clause["id"]] = { label: num, xref: "#{@annex_lbl} #{num}",
+      @anchors[clause["id"]] = { label: num, xref: "#{@labels["annex"]} #{num}",
                                  level: level, type: "clause" }
       clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
         annex_names1(c, "#{num}.#{i + 1}", level + 1)
       end
     end
+
+    ISO_PUBLISHER_XPATH =
+      "./contributor[xmlns:role/@type = 'publisher']/"\
+      "organization[abbreviation = 'ISO' or xmlns:abbreviation = 'IEC' or "\
+      "xmlns:name = 'International Organization for Standardization' or "\
+      "xmlns:name = 'International Electrotechnical Commission']".freeze
+
+    def reference_names(ref)
+      isopub = ref.at(ns(ISO_PUBLISHER_XPATH))
+      ids = @klass.bibitem_ref_code(ref)
+      identifiers = @klass.render_identifier(ids)
+      date = ref.at(ns("./date[@type = 'published']"))
+      reference = @klass.docid_l10n(identifiers[0] || identifiers[1])
+      @anchors[ref["id"]] = { xref: reference }
+    end
   end
 end

data/lib/isodoc/xslfo_convert.rb

@@ -13,11 +13,28 @@ module IsoDoc
       "_pdfimages"
     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)
+    def initialize(options)
+      @format = :pdf
+      @suffix = "pdf"
+      super
+    end
+
+    def pdf_stylesheet(docxml)
+      nil
+    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
-      ::Metanorma::Output::XslfoPdf.new.convert(filename, outname_html + ".pdf", nil)
+      ::Metanorma::Output::XslfoPdf.new.convert(input_filename,
+                                                output_filename || "#{filename}.#{@suffix}", 
+                                               File.join(@libdir, pdf_stylesheet(docxml)))
     end
 
     def xref_parse(node, out)

data/spec/assets/i18n.yaml

@@ -1,2 +1,5 @@
 foreword: Enkonduko
-
+clause: klaŭzo
+table: Tabelo
+source: SOURCE
+modified: modified

data/spec/assets/odf.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+  <circle fill="#009" r="45" cx="50" cy="50"/>
+  <path d="M33,26H78A37,37,0,0,1,33,83V57H59V43H33Z" fill="#FFF"/>
+</svg>

data/spec/assets/odf1.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+  <circle fill="#009" r="45" cx="50" cy="50"/>
+  <path d="M33,26H78A37,37,0,0,1,33,83V57H59V43H33Z" fill="#FFF"/>
+</svg>