isodoc 0.5.5 → 0.5.7

data/lib/isodoc/footnotes.rb

@@ -0,0 +1,74 @@
+require "uuidtools"
+
+module IsoDoc
+  class Convert
+    def footnotes(div)
+      return if @footnotes.empty?
+      @footnotes.each { |fn| div.parent << fn }
+    end
+
+    def make_table_footnote_link(out, fnid, fnref)
+      attrs = { href: "##{fnid}", class: "TableFootnoteRef" }
+      out.a **attrs do |a|
+        a << fnref
+      end
+    end
+
+    def make_table_footnote_target(out, fnid, fnref)
+      attrs = { id: fnid, class: "TableFootnoteRef" }
+      out.a **attrs do |a|
+        a << fnref
+        insert_tab(a, 1)
+      end
+    end
+
+    def make_table_footnote_text(node, fnid, fnref)
+      attrs = { id: "ftn#{fnid}" }
+      noko do |xml|
+        xml.div **attr_code(attrs) do |div|
+          make_table_footnote_target(div, fnid, fnref)
+          node.children.each { |n| parse(n, div) }
+        end
+      end.join("\n")
+    end
+
+    def make_generic_footnote_text(node, fnid)
+      noko do |xml|
+        xml.aside **{ id: "ftn#{fnid}" } do |div|
+          node.children.each { |n| parse(n, div) }
+        end
+      end.join("\n")
+    end
+
+    def get_table_ancestor_id(node)
+      table = node.ancestors("table") || node.ancestors("figure")
+      return UUIDTools::UUID.random_create.to_s if table.empty?
+      table.last["id"]
+    end
+
+    def table_footnote_parse(node, out)
+      fn = node["reference"]
+      tid = get_table_ancestor_id(node)
+      make_table_footnote_link(out, tid + fn, fn)
+      # do not output footnote text if we have already seen it for this table
+      return if @seen_footnote.include?(tid + fn)
+      @in_footnote = true
+      out.aside { |a| a << make_table_footnote_text(node, tid + fn, fn) }
+      @in_footnote = false
+      @seen_footnote << (tid + fn)
+    end
+
+    def footnote_parse(node, out)
+      return table_footnote_parse(node, out) if @in_table || @in_figure
+      fn = node["reference"]
+      out.a **{ "epub:type": "footnote", href: "#ftn#{fn}" } do |a|
+        a.sup { |sup| sup << fn }
+      end
+      return if @seen_footnote.include?(fn)
+      @in_footnote = true
+      @footnotes << make_generic_footnote_text(node, fn)
+      @in_footnote = false
+      @seen_footnote << fn
+    end
+  end
+end

data/lib/isodoc/html.rb

@@ -1,5 +1,10 @@
 module IsoDoc
   class Convert
+    def postprocess(result, filename, dir)
+      result = from_xhtml(cleanup(to_xhtml(result)))
+      toHTML(result, filename)
+    end
+
     def toHTML(result, filename)
       result = from_xhtml(html_cleanup(to_xhtml(result)))
       result = populate_template(result, :html)
@@ -10,7 +15,7 @@ module IsoDoc
 
     def html_cleanup(x)
       footnote_backlinks(
-        move_images(html_footnote_filter(html_preface(htmlstyle(x))))
+        html_toc(move_images(html_footnote_filter(html_preface(htmlstyle(x)))))
       )
     end
 
@@ -32,15 +37,23 @@ module IsoDoc
     end
 
     def html_preface(docxml)
+      html_cover(docxml) if @htmlcoverpage
+      html_intro(docxml) if @htmlintropage
+      docxml.at("//*[local-name() = 'body']") << mathjax(@openmathdelim,
+                                                         @closemathdelim)
+      docxml
+    end
+
+    def html_cover(docxml)
       cover = Nokogiri::HTML(File.read(@htmlcoverpage, encoding: "UTF-8"))
       d = docxml.at('//div[@class="WordSection1"]')
       d.children.first.add_previous_sibling cover.to_xml(encoding: "US-ASCII")
+    end
+
+    def html_intro(docxml)
       cover = Nokogiri::HTML(File.read(@htmlintropage, encoding: "UTF-8"))
       d = docxml.at('//div[@class="WordSection2"]')
       d.children.first.add_previous_sibling cover.to_xml(encoding: "US-ASCII")
-      docxml.at("//*[local-name() = 'body']") << mathjax(@openmathdelim,
-                                                         @closemathdelim)
-      docxml
     end
 
     def htmlstylesheet
@@ -110,5 +123,29 @@ module IsoDoc
       end
       docxml
     end
+
+    def html_toc1(h, ret, prevname)
+      h["id"] = UUIDTools::UUID.random_create.to_s unless h["id"]
+      li = "<li><a href='##{h["id"]}'>#{header_strip(h)}</a></li>"
+      if h.name == "h1"
+        ret += "</ul>" if prevname == "h2"
+      else
+        ret += "<ul>" if prevname == "h1"
+      end
+      ret + li
+    end
+
+    def html_toc(docxml)
+      return docxml unless @htmlintropage
+      ret = ""
+      prevname = ""
+      docxml.xpath("//h1 | //h2").each do |h|
+        ret = html_toc1(h, ret, prevname) unless h["class"] == "toc-contents"
+        prevname = h.name
+      end
+      ret += "<ul>" if prevname == "h2"
+      docxml.at("//*[@id='toc-list']").replace("<ul>#{ret}</ret>")
+      docxml
+    end
   end
 end

data/lib/isodoc/i18n-en.yaml

@@ -40,6 +40,7 @@ internal_external_terms_boilerplate: |
 note: NOTE
 note_xref: Note
 termnote: Note % to entry
+list: List
 figure: Figure
 formula: Formula
 table: Table

data/lib/isodoc/i18n-fr.yaml

@@ -35,6 +35,7 @@ note_xref: Note
 termnote: Note % à l'article
 figure: Figure
 formula: Formule
+list: Liste
 table: Tableau
 key: Légende
 example: EXEMPLE

data/lib/isodoc/i18n-zh-Hans.yaml

@@ -35,6 +35,7 @@ note_xref: 注
 termnote: 注%
 figure: 图
 formula: 公式
+list: 列项
 table: 表
 key: 说明
 example: 示例

data/lib/isodoc/i18n.rb

@@ -39,6 +39,7 @@ module IsoDoc
       @note_xref_lbl = y["note_xref"]
       @termnote_lbl = y["termnote"]
       @figure_lbl = y["figure"]
+      @list_lbl = y["list"]
       @formula_lbl = y["formula"]
       @table_lbl = y["table"]
       @key_lbl = y["key"]

data/lib/isodoc/inline.rb

@@ -3,14 +3,11 @@ require "uuidtools"
 module IsoDoc
   class Convert
     def section_break(body)
-      body.br **{ clear: "all", class: "section" }
+      body.br
     end
 
-    def page_break(body)
-      body.br **{
-        clear: "all",
-        style: "mso-special-character:line-break;page-break-before:always",
-      }
+    def page_break(out)
+      out.br
     end
 
     def link_parse(node, out)
@@ -57,7 +54,7 @@ module IsoDoc
                  l10n(", #{@whole_of_text}")
                else
                  eref_localities1(r["type"], r.at(ns("./referenceFrom")),
-                                  r.at(ns("./referenceTo")))
+                                  r.at(ns("./referenceTo")), @lang)
                end
       end
       ret
@@ -86,11 +83,6 @@ module IsoDoc
       end
     end
 
-    def pagebreak_parse(_node, out)
-      attrs = { clear: all, class: "pagebreak" }
-      out.br **attrs
-    end
-
     def error_parse(node, out)
       text = node.to_xml.gsub(/</, "&lt;").gsub(/>/, "&gt;")
       out.para do |p|

data/lib/isodoc/iso2wordhtml.rb

@@ -6,14 +6,6 @@ module IsoDoc
       @termdomain = termdomain
     end
 
-    def get_termexample
-      @termexample
-    end
-
-    def set_termexample(value)
-      @termexample = value
-    end
-
     def in_sourcecode
       @sourcecode
     end
@@ -32,6 +24,27 @@ module IsoDoc
       [filename, dir]
     end
 
+    # these are in fact preprocess,
+    # but they are extraneous to main HTML file
+    def html_header(html, docxml, filename, dir)
+      anchor_names docxml
+      define_head html, filename, dir
+    end
+
+    # isodoc.css overrides any CSS injected by Html2Doc, which
+    # is inserted before this CSS.
+    def define_head(html, filename, _dir)
+      html.head do |head|
+        head.title { |t| t << filename }
+        return unless @standardstylesheet
+        head.style do |style|
+          stylesheet = File.read(@standardstylesheet).
+            gsub("FILENAME", filename)
+          style.comment "\n#{stylesheet}\n"
+        end
+      end
+    end
+
     def make_body(xml, docxml)
       body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72" }
       xml.body **body_attr do |body|
@@ -51,6 +64,8 @@ module IsoDoc
     def make_body2(body, docxml)
       body.div **{ class: "WordSection2" } do |div2|
         info docxml, div2
+        foreword docxml, div2
+        introduction docxml, div2
         div2.p { |p| p << "&nbsp;" } # placeholder
       end
       section_break(body)
@@ -65,7 +80,6 @@ module IsoDoc
     end
 
     def info(isoxml, out)
-      # intropage(out)
       title isoxml, out
       subtitle isoxml, out
       id isoxml, out
@@ -73,8 +87,7 @@ module IsoDoc
       bibdate isoxml, out
       relations isoxml, out
       version isoxml, out
-      foreword isoxml, out
-      introduction isoxml, out
+      get_metadata
     end
 
     def middle_title(out)
@@ -125,7 +138,7 @@ module IsoDoc
         when "br" then out.br
         when "hr" then out.hr
         when "bookmark" then bookmark_parse(node, out)
-        when "pagebreak" then pagebreak_parse(node, out)
+        when "pagebreak" then page_break(out)
         when "callout" then callout_parse(node, out)
         when "stem" then stem_parse(node, out)
         when "clause" then clause_parse(node, out)
@@ -161,7 +174,7 @@ module IsoDoc
         when "termsource" then termref_parse(node, out)
         when "modification" then modification_parse(node, out)
         when "termnote" then termnote_parse(node, out)
-        when "termexample" then termexample_parse(node, out)
+        when "termexample" then example_parse(node, out)
         when "terms" then terms_parse(node, out)
         when "symbols-abbrevs" then symbols_parse(node, out)
         when "references" then bibliography_parse(node, out)

data/lib/isodoc/metadata.rb

@@ -65,17 +65,35 @@ module IsoDoc
       set_metadata(:secretariat, sec.text) if sec
     end
 
+    def date_range(date)
+      from = date.at(ns("./from"))
+      to = date.at(ns("./to"))
+      ret = from.text
+      ret += "–#{to.text}" if to
+      ret
+    end
+
     def bibdate(isoxml, _out)
       isoxml.xpath(ns("//bibdata/date")).each do |d|
-        set_metadata("#{d['type']}date".to_sym, d.text)
+        set_metadata("#{d['type']}date".to_sym, date_range(d))
       end
     end
 
+    def iso?(org)
+      name = org&.at(ns("./name"))&.text
+      abbrev = org&.at(ns("./abbreviation"))&.text
+      (abbrev == "ISO" || 
+       name == "International Organization for Standardization" )
+    end
+
     def agency(xml)
       agency = ""
       xml.xpath(ns("//bibdata/contributor[xmlns:role/@type = 'publisher']/"\
-                   "organization/name")).each do |org|
-        agency = org.text == "ISO" ? "ISO/#{agency}" : "#{agency}#{org.text}/"
+                   "organization")).each do |org|
+        name = org&.at(ns("./name"))&.text
+        abbrev = org&.at(ns("./abbreviation"))&.text
+        agency1 = abbrev || name
+        agency = iso?(org) ?  "ISO/#{agency}" : "#{agency}#{agency1}/"
       end
       set_metadata(:agency, agency.sub(%r{/$}, ""))
     end
@@ -105,8 +123,8 @@ module IsoDoc
     def draftinfo(draft, revdate)
       draftinfo = ""
       if draft
-        draftinfo = " (#{@draft_lbl} #{draft.text}"
-        draftinfo += ", #{revdate.text}" if revdate
+        draftinfo = " (#{@draft_lbl} #{draft}"
+        draftinfo += ", #{revdate}" if revdate
         draftinfo += ")"
       end
       l10n(draftinfo)
@@ -114,13 +132,8 @@ module IsoDoc
 
     def version(isoxml, _out)
       set_metadata(:docyear, isoxml&.at(ns("//copyright/from"))&.text)
-      # draft = isoxml.at(ns("//version/draft"))
-      # set_metadata(:draft, draft.nil? ? nil : draft.text)
       set_metadata(:draft, isoxml&.at(ns("//version/draft"))&.text)
-      # revdate = isoxml.at(ns("//version/revision-date"))
-      #set_metadata(:revdate, revdate.nil? ? nil : revdate.text)
       set_metadata(:revdate, isoxml&.at(ns("//version/revision-date"))&.text)
-      #set_metadata(:draftinfo, draftinfo(draft, revdate))
       set_metadata(:draftinfo,
                    draftinfo(get_metadata[:draft], get_metadata[:revdate]))
     end

data/lib/isodoc/references.rb

@@ -8,7 +8,7 @@ module IsoDoc
       isocode = b.at(ns("./docidentifier")).text
       isodate = b.at(ns("./date[@type = 'published']"))
       reference = docid_l10n(isocode)
-      reference += ": #{isodate.text}" if isodate
+      reference += ": #{date_range(isodate)}" if isodate
       reference
     end
 
@@ -48,15 +48,6 @@ module IsoDoc
       end
     end
 
-    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|
-        ref_entry_code(r, ordinal, ref.text.gsub(/[\[\]]/, ""))
-        para.children.each { |n| parse(n, r) }
-      end
-    end
-
     # TODO generate formatted ref if not present
     def noniso_bibitem(list, b, ordinal, bibliography)
       list.p **attr_code("id": b["id"], class: "Biblio") do |r|
@@ -66,13 +57,15 @@ module IsoDoc
         else
           r << "#{iso_bibitem_ref_code(b)}, "
         end
-        b.at(ns("./formattedref")).children.each { |n| parse(n, r) }
+        b.at(ns("./formattedref"))&.children&.each { |n| parse(n, r) }
       end
     end
 
     ISO_PUBLISHER_XPATH =
       "./contributor[xmlns:role/@type = 'publisher']/"\
-      "organization[name = 'ISO' or xmlns:name = 'IEC']".freeze
+      "organization[abbreviation = 'ISO' or xmlns:abbreviation = 'IEC' or "\
+      "xmlns:name = 'International Organization for Standardization' or "\
+      "xmlns:name = 'International Electrotechnical Commission']".freeze
 
     def split_bibitems(f)
       iso_bibitem = []
@@ -142,8 +135,13 @@ module IsoDoc
       end
     end
 
-    def format_ref(ref, isopub)
-      return "ISO #{ref}" if isopub
+    def format_ref(ref, isopub, date)
+      if isopub
+        return ref unless date
+        from = date.at(ns("./from"))
+        return ref if from&.text == "--"
+        return ref + ": #{date_range(date)}"
+      end
       return "[#{ref}]" if /^\d+$/.match?(ref) && !/^\[.*\]$/.match?(ref)
       ref
     end
@@ -151,17 +149,17 @@ module IsoDoc
     def reference_names(ref)
       isopub = ref.at(ns(ISO_PUBLISHER_XPATH))
       docid = ref.at(ns("./docidentifier"))
-      return ref_names(ref) unless docid
+      # 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 != "--"
+      reference = format_ref(docid_l10n(docid.text), isopub, date)
+      # reference += ": #{date_range(date)}" if date && isopub && from.text != "--"
       @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
+    # def ref_names(ref)
+    #  linkend = ref.text
+    # linkend.gsub!(/[\[\]]/, "") unless /^\[\d+\]$/.match? linkend
+    # @anchors[ref["id"]] = { xref: linkend }
+    # end
   end
 end