isodoc 0.4.5 → 0.5.5

data/lib/isodoc/references.rb

@@ -1,9 +1,13 @@
 module IsoDoc
   class Convert
+    def docid_l10n(x)
+      x.gsub(/All Parts/, @all_parts_lbl)
+    end
+
     def iso_bibitem_ref_code(b)
-      isocode = b.at(ns("./docidentifier"))
+      isocode = b.at(ns("./docidentifier")).text
       isodate = b.at(ns("./date[@type = 'published']"))
-      reference = "ISO #{isocode.text}"
+      reference = docid_l10n(isocode)
       reference += ": #{isodate.text}" if isodate
       reference
     end
@@ -16,16 +20,19 @@ module IsoDoc
       footnote_parse(date_note, ref)
     end
 
+    def iso_bibitem_entry_attrs(b, biblio)
+      { id: b["id"], class: biblio ? "Biblio" : nil }
+    end
+
     def iso_bibitem_entry(list, b, ordinal, biblio)
-      attrs = { id: b["id"], class: biblio ? "Biblio" : nil }
-      list.p **attr_code(attrs) do |ref|
+      list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
         if biblio
           ref << "[#{ordinal}]"
           insert_tab(ref, 1)
         end
         ref << iso_bibitem_ref_code(b)
         date_note_process(b, ref)
-        ref << ", " if biblio
+        ref << ", "
         ref.i { |i| i << " #{b.at(ns('./title')).text}" }
       end
     end
@@ -41,7 +48,7 @@ module IsoDoc
       end
     end
 
-    def ref_entry(list, b, ordinal, bibliography)
+    def ref_entry(list, b, ordinal, _bibliography)
       ref = b.at(ns("./ref"))
       para = b.at(ns("./p"))
       list.p **attr_code("id": ref["id"], class: "Biblio") do |r|
@@ -50,17 +57,22 @@ module IsoDoc
       end
     end
 
+    # TODO generate formatted ref if not present
     def noniso_bibitem(list, b, ordinal, bibliography)
-      ref = b.at(ns("./docidentifier"))
-      para = b.at(ns("./formattedref"))
       list.p **attr_code("id": b["id"], class: "Biblio") do |r|
-        ref_entry_code(r, ordinal, ref.text.gsub(/[\[\]]/, ""))
-        para.children.each { |n| parse(n, r) }
+        if bibliography
+          id = docid_l10n(b.at(ns("./docidentifier")).text.gsub(/[\[\]]/, ""))
+          ref_entry_code(r, ordinal, id)
+        else
+          r << "#{iso_bibitem_ref_code(b)}, "
+        end
+        b.at(ns("./formattedref")).children.each { |n| parse(n, r) }
       end
     end
 
     ISO_PUBLISHER_XPATH =
-      "./contributor[xmlns:role/@type = 'publisher']/organization[name = 'ISO']"
+      "./contributor[xmlns:role/@type = 'publisher']/"\
+      "organization[name = 'ISO' or xmlns:name = 'IEC']".freeze
 
     def split_bibitems(f)
       iso_bibitem = []
@@ -85,33 +97,22 @@ module IsoDoc
       end
     end
 
-    NORM_WITH_REFS_PREF = <<~BOILERPLATE
-          The following documents are referred to in the text in such a way
-          that some or all of their content constitutes requirements of this
-          document. For dated references, only the edition cited applies.
-          For undated references, the latest edition of the referenced
-          document (including any amendments) applies.
-    BOILERPLATE
-
-    NORM_EMPTY_PREF =
-      "There are no normative references in this document."
-
     def norm_ref_preface(f, div)
       refs = f.elements.select do |e|
         ["reference", "bibitem"].include? e.name
       end
-      pref = if refs.empty? then self.class::NORM_EMPTY_PREF 
-             else 
-               self.class::NORM_WITH_REFS_PREF
+      pref = if refs.empty? then @norm_empty_pref
+             else
+               @norm_with_refs_pref
              end
       div.p pref
     end
 
     def norm_ref(isoxml, out)
       q = "./*/references[title = 'Normative References']"
-      f = isoxml.at(ns(q)) or return
+      f = isoxml.at(ns(q)) || return
       out.div do |div|
-        clause_name("2.", "Normative References", div, false)
+        clause_name("2.", @normref_lbl, div, nil)
         norm_ref_preface(f, div)
         biblio_list(f, div, false)
       end
@@ -119,15 +120,48 @@ module IsoDoc
 
     def bibliography(isoxml, out)
       q = "./*/references[title = 'Bibliography']"
-      f = isoxml.at(ns(q)) or return
+      f = isoxml.at(ns(q)) || return
       page_break(out)
       out.div do |div|
-        div.h1 "Bibliography", **{ class: "Section3" }
+        div.h1 @bibliography_lbl, **{ class: "Section3" }
         f.elements.reject do |e|
           ["reference", "title", "bibitem"].include? e.name
         end.each { |e| parse(e, div) }
         biblio_list(f, div, true)
       end
     end
+
+    def bibliography_parse(node, out)
+      title = node&.at(ns("./title"))&.text || ""
+      out.div do |div|
+        div.h2 title, **{ class: "Section3" }
+        node.elements.reject do |e|
+          ["reference", "title", "bibitem"].include? e.name
+        end.each { |e| parse(e, div) }
+        biblio_list(node, div, true)
+      end
+    end
+
+    def format_ref(ref, isopub)
+      return "ISO #{ref}" if isopub
+      return "[#{ref}]" if /^\d+$/.match?(ref) && !/^\[.*\]$/.match?(ref)
+      ref
+    end
+
+    def reference_names(ref)
+      isopub = ref.at(ns(ISO_PUBLISHER_XPATH))
+      docid = ref.at(ns("./docidentifier"))
+      return ref_names(ref) unless docid
+      date = ref.at(ns("./date[@type = 'published']"))
+      reference = format_ref(docid_l10n(docid.text), isopub)
+      reference += ": #{date.text}" if date && isopub && date != "--"
+      @anchors[ref["id"]] = { xref: reference }
+    end
+
+    def ref_names(ref)
+      linkend = ref.text
+      linkend.gsub!(/[\[\]]/, "") unless /^\[\d+\]$/.match? linkend
+      @anchors[ref["id"]] = { xref: linkend }
+    end
   end
 end

data/lib/isodoc/section.rb

@@ -1,42 +1,45 @@
 module IsoDoc
   class Convert
+    def inline_header_title(out, node, c1)
+      out.span **{ class: "zzMoveToFollowing" } do |s|
+        s.b do |b|
+          b << "#{get_anchors[node['id']][:label]}. #{c1.text} "
+        end
+      end
+    end
+
+    def clause_parse_title(node, div, c1, out)
+      if node["inline-header"] == "true"
+        inline_header_title(out, node, c1)
+      else
+        div.send "h#{get_anchors[node['id']][:level]}" do |h|
+          h << "#{get_anchors[node['id']][:label]}. #{c1.text}"
+        end
+      end
+    end
+
     def clause_parse(node, out)
-      out.div **attr_code(id: node["id"]) do |s|
+      out.div **attr_code(id: node["id"]) do |div|
         node.children.each do |c1|
           if c1.name == "title"
-            if node["inline-header"]
-              out.span **{ class: "zzMoveToFollowing" } do |s|
-                s.b do |b|
-                  b << "#{get_anchors()[node['id']][:label]}. #{c1.text} "
-                end
-              end
-            else
-              s.send "h#{get_anchors()[node['id']][:level]}" do |h|
-                h << "#{get_anchors()[node['id']][:label]}. #{c1.text}"
-              end
-            end
+            clause_parse_title(node, div, c1, out)
           else
-            parse(c1, s)
+            parse(c1, div)
           end
         end
       end
     end
 
-    def clause_name(num, title, div, inline_header)
-      if inline_header
-        div.span **{ class: "zzMoveToFollowing" } do |s|
-          s.b do |b|
-            b << num
-            b << title + " "
-          end
-        end
-      else
-        div.h1 do |h1|
+    def clause_name(num, title, div, header_class)
+      header_class = {} if header_class.nil?
+      div.h1 **attr_code(header_class) do |h1|
+        if num
           h1 << num
           insert_tab(h1, 1)
-          h1 << title
         end
+        h1 << title
       end
+      div.parent.at(".//h1")
     end
 
     def clause(isoxml, out)
@@ -45,8 +48,8 @@ module IsoDoc
         out.div **attr_code(id: c["id"]) do |s|
           c.elements.each do |c1|
             if c1.name == "title"
-              clause_name("#{get_anchors()[c['id']][:label]}.", 
-                          c1.text, s, c["inline-header"])
+              clause_name("#{get_anchors[c['id']][:label]}.",
+                          c1.text, s, nil)
             else
               parse(c1, s)
             end
@@ -57,7 +60,7 @@ module IsoDoc
 
     def annex_name(annex, name, div)
       div.h1 **{ class: "Annex" } do |t|
-        t << "#{get_anchors()[annex['id']][:label]}<br/><br/>"
+        t << "#{get_anchors[annex['id']][:label]}<br/><br/>"
         t << "<b>#{name.text}</b>"
       end
     end
@@ -65,15 +68,13 @@ module IsoDoc
     def annex(isoxml, out)
       isoxml.xpath(ns("//annex")).each do |c|
         page_break(out)
-        out.div **attr_code(id: c["id"], class: "Section3" ) do |s|
-          #s1.div **{ class: "annex" } do |s|
-            c.elements.each do |c1|
-              if c1.name == "title" then annex_name(c, c1, s)
-              else
-                parse(c1, s)
-              end
+        out.div **attr_code(id: c["id"], class: "Section3") do |s|
+          c.elements.each do |c1|
+            if c1.name == "title" then annex_name(c, c1, s)
+            else
+              parse(c1, s)
             end
-          # end
+          end
         end
       end
     end
@@ -81,39 +82,88 @@ module IsoDoc
     def scope(isoxml, out)
       f = isoxml.at(ns("//clause[title = 'Scope']")) || return
       out.div **attr_code(id: f["id"]) do |div|
-        clause_name("1.", "Scope", div, false)
+        clause_name("1.", @scope_lbl, div, nil)
         f.elements.each do |e|
           parse(e, div) unless e.name == "title"
         end
       end
     end
 
+    def external_terms_boilerplate(sources)
+      @external_terms_boilerplate.gsub(/%/, sources)
+    end
+
+    def internal_external_terms_boilerplate(sources)
+      @internal_external_terms_boilerplate.gsub(/%/, sources)
+    end
+
+    def term_defs_boilerplate(div, source, term)
+      if source.empty? && term.nil?
+        div << @no_terms_boilerplate
+      else
+        div << term_defs_boilerplate_cont(source, term)
+      end
+      div << @term_def_boilerplate
+    end
+
+    def term_defs_boilerplate_cont(src, term)
+      sources = sentence_join(src.map { |s| s["citeas"] })
+      if src.empty?
+        @internal_terms_boilerplate
+      elsif term.nil?
+        external_terms_boilerplate(sources)
+      else
+        internal_external_terms_boilerplate(sources)
+      end
+    end
+
+    def terms_defs_title(f)
+      symbols = f.at(".//symbols-abbrevs")
+      return @termsdefsymbols_lbl if symbols
+      @termsdef_lbl
+    end
+
     def terms_defs(isoxml, out)
-      f = isoxml.at(ns("//terms")) || return
+      f = isoxml.at(ns("//sections/terms")) || return
       out.div **attr_code(id: f["id"]) do |div|
-        clause_name("3.", "Terms and Definitions", div, false)
+        clause_name("3.", terms_defs_title(f), div, nil)
+        term_defs_boilerplate(div, f.xpath(ns("./source")), f.at(ns(".//term")))
         f.elements.each do |e|
-          parse(e, div) unless e.name == "title"
+          parse(e, div) unless %w{title source}.include? e.name
         end
       end
     end
 
+    # subclause
+    def terms_parse(isoxml, out)
+      clause_parse(isoxml, out)
+    end
+
     def symbols_abbrevs(isoxml, out)
-      f = isoxml.at(ns("//symbols-abbrevs")) || return
-      out.div **attr_code(id: f["id"]) do |div|
-        clause_name("4.", "Symbols and Abbreviations", div, false)
+      f = isoxml.at(ns("//sections/symbols-abbrevs")) || return
+      out.div **attr_code(id: f["id"], class: "Symbols") do |div|
+        clause_name("4.", @symbols_lbl, div, nil)
         f.elements.each do |e|
           parse(e, div) unless e.name == "title"
         end
       end
     end
 
+    # subclause
+    def symbols_parse(isoxml, out)
+      isoxml.children.first.previous =
+        "<title>Symbols and Abbreviated Terms</title>"
+      clause_parse(isoxml, out)
+    end
+
     def introduction(isoxml, out)
       f = isoxml.at(ns("//introduction")) || return
+      num = f.at(ns(".//subsection")) ? "0." : nil
       title_attr = { class: "IntroTitle" }
       page_break(out)
       out.div **{ class: "Section3", id: f["id"] } do |div|
-        div.h1 "Introduction", **attr_code(title_attr)
+        # div.h1 "Introduction", **attr_code(title_attr)
+        clause_name(num, @introduction_lbl, div, title_attr)
         f.elements.each do |e|
           if e.name == "patent-notice"
             e.elements.each { |e1| parse(e1, div) }
@@ -128,7 +178,7 @@ module IsoDoc
       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" }
+        s.h1 **{ class: "ForewordTitle" } { |h1| h1 << @foreword_lbl }
         f.elements.each { |e| parse(e, s) unless e.name == "title" }
       end
     end

data/lib/isodoc/table.rb

@@ -2,12 +2,10 @@ module IsoDoc
   class Convert
     def table_title_parse(node, out)
       name = node.at(ns("./name"))
-      if name
-        out.p **{ class: "TableTitle", align: "center" } do |p|
-          p.b do |b|
-            b << "#{get_anchors()[node['id']][:label]}&nbsp;&mdash; "
-            b << name.text
-          end
+      out.p **{ class: "TableTitle", align: "center" } do |p|
+        p.b do |b|
+          b << l10n("#{@table_lbl} #{get_anchors[node['id']][:label]}")
+          b << l10n("&nbsp;&mdash; #{name.text}") if name
         end
       end
     end
@@ -60,35 +58,37 @@ module IsoDoc
         thead_parse(node, t)
         tbody_parse(node, t)
         tfoot_parse(node, t)
-        dl = node.at(ns("./dl")) and parse(dl, out)
+        (dl = node.at(ns("./dl"))) && parse(dl, out)
         node.xpath(ns("./note")).each { |n| parse(n, out) }
       end
       @in_table = false
       # out.p { |p| p << "&nbsp;" }
     end
 
-    SW = "solid windowtext"
+    SW = "solid windowtext".freeze
+
+    # def make_tr_attr(td, row, totalrows, cols, totalcols, header)
+    # border-left:#{col.zero? ? "#{SW} 1.5pt;" : "none;"}
+    # border-right:#{SW} #{col == totalcols && !header ? "1.5" : "1.0"}pt;
 
-    #border-left:#{col.zero? ? "#{SW} 1.5pt;" : "none;"}
-    #border-right:#{SW} #{col == totalcols && !header ? "1.5" : "1.0"}pt;
-    def make_tr_attr(td, row, totalrows, col, totalcols, header)
+    def make_tr_attr(td, row, totalrows)
       style = td.name == "th" ? "font-weight:bold;" : ""
       rowmax = td["rowspan"] ? row + td["rowspan"].to_i - 1 : row
       style += <<~STYLE
-          border-top:#{row.zero? ? "#{SW} 1.5pt;" : "none;"}
-          mso-border-top-alt:#{row.zero? ? "#{SW} 1.5pt;" : "none;"}
-          border-bottom:#{SW} #{rowmax == totalrows ? "1.5" : "1.0"}pt;
-          mso-border-bottom-alt:#{SW} #{rowmax == totalrows ? "1.5" : "1.0"}pt;
+        border-top:#{row.zero? ? "#{SW} 1.5pt;" : 'none;'}
+        mso-border-top-alt:#{row.zero? ? "#{SW} 1.5pt;" : 'none;'}
+        border-bottom:#{SW} #{rowmax == totalrows ? '1.5' : '1.0'}pt;
+        mso-border-bottom-alt:#{SW} #{rowmax == totalrows ? '1.5' : '1.0'}pt;
       STYLE
       { rowspan: td["rowspan"], colspan: td["colspan"],
         align: td["align"], style: style.gsub(/\n/, "") }
     end
 
-    def tr_parse(node, out, ord, totalrows, header)
+    def tr_parse(node, out, ord, totalrows, _header)
       out.tr do |r|
-        node.elements.each_with_index do |td, i|
-          attrs = make_tr_attr(td, ord, totalrows - 1, 
-                               i, node.elements.size - 1, header)
+        node.elements.each do |td|
+          attrs = make_tr_attr(td, ord, totalrows - 1)
+          # i, node.elements.size - 1, header)
           r.send td.name, **attr_code(attrs) do |entry|
             td.children.each { |n| parse(n, entry) }
           end

data/lib/isodoc/terms.rb

@@ -1,6 +1,5 @@
 module IsoDoc
   class Convert
-
     def definition_parse(node, out)
       node.children.each { |n| parse(n, out) }
     end
@@ -12,8 +11,8 @@ module IsoDoc
     end
 
     def deprecated_term_parse(node, out)
-      out.p **{ class: "AltTerms" } do |p|
-        p << "DEPRECATED: #{node.text}"
+      out.p **{ class: "DeprecatedTerms" } do |p|
+        p << l10n("#{@deprecated_lbl}: #{node.text}")
       end
     end
 
@@ -38,7 +37,7 @@ module IsoDoc
       out.div **{ class: "Note" } do |div|
         first = node.first_element_child
         div.p **{ class: "Note" } do |p|
-          p << "EXAMPLE:"
+          p << l10n("#{@example_lbl}:")
           insert_tab(p, 1)
           para_then_remainder(first, node, p)
         end
@@ -49,7 +48,7 @@ module IsoDoc
       out.div **{ class: "Note" } do |div|
         first = node.first_element_child
         div.p **{ class: "Note" } do |p|
-          p << "#{get_anchors()[node["id"]][:label]}: "
+          p << "#{get_anchors[node['id']][:label]}: "
           para_then_remainder(first, node, p)
         end
       end
@@ -65,7 +64,7 @@ module IsoDoc
 
     def termdef_parse(node, out)
       out.p **{ class: "TermNum", id: node["id"] } do |p|
-        p << get_anchors()[node["id"]][:label]
+        p << get_anchors[node["id"]][:label]
       end
       set_termdomain("")
       node.children.each { |n| parse(n, out) }