isodoc 0.5.8 → 0.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57ca9a13e94e7c5861ee7694b1c543a304d35e2c
-  data.tar.gz: 4d1ca9fe799cc66bb3d6e1422585168e09da7c4a
+  metadata.gz: 90089f0b90f1392ef99b4d676db3215397bb70fc
+  data.tar.gz: 5d82f8fb83a29877f878716df97dc6499a998834
 SHA512:
-  metadata.gz: a382164e2ff256407dc864caa9638235970b84bff249291d690588ac880cd832cefd089505336603f4e920dd89053096fc96c5b9d2233fb4f023ac6bf9465d63
-  data.tar.gz: 54d6a2064d4b1fe1a72a8997ca842b1f9a45094a7f3778a9858af9c560757f72d078d38045cee41782d79043a743ecd6be8dbc2d31b657ab07292d2ac6efa090
+  metadata.gz: eb49c04b480775ba01401325d448b9d03181c93f6f456525755ac7a704b8eae5b19a88afd3ac736ff234bb5fc4e7e3a2c0affa0555128efc1e89071eec14f10b
+  data.tar.gz: 382f620801c7e6a447f00de270f2d372a81abbc6f7bb878760e7a000527e2c085389ae694483a426f76d3b75fdb48d93d1d40abcd0601d9db68dee5bc6fd3e95

data/.rubocop.tb.yml

@@ -352,8 +352,18 @@ Style/TrailingCommaInArguments:
     - no_comma
   Enabled: true
 
-Style/TrailingCommaInLiteral:
-  Description: 'Checks for trailing comma in array and hash literals.'
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
   EnforcedStyleForMultiline: comma
   SupportedStylesForMultiline:
@@ -398,6 +408,13 @@ Layout/AlignParameters:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-double-indent'
   Enabled: false
 
+Layout/ConditionPosition:
+  Description: >-
+                 Checks for condition placed in a confusing position relative to
+                 the keyword.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition'
+  Enabled: false
+
 Layout/DotPosition:
   Description: 'Checks the position of the dot in multi-line method calls.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains'
@@ -450,13 +467,6 @@ Lint/CircularArgumentReference:
   Description: "Don't refer to the keyword argument in the default value."
   Enabled: false
 
-Lint/ConditionPosition:
-  Description: >-
-                 Checks for condition placed in a confusing position relative to
-                 the keyword.
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition'
-  Enabled: false
-
 Lint/DeprecatedClassMethods:
   Description: 'Check for deprecated class method calls.'
   Enabled: false
@@ -523,7 +533,7 @@ Lint/UnderscorePrefixedVariableName:
   Description: 'Do not use prefix `_` for a variable that is used.'
   Enabled: false
 
-Lint/UnneededDisable:
+Lint/UnneededCopDisableDirective:
   Description: >-
                  Checks for rubocop:disable comments that can be removed.
                  Note: this cop is not disabled when disabling all cops.

data/lib/isodoc/blocks.rb

@@ -10,7 +10,9 @@ module IsoDoc
 
     def note_p_parse(node, div)
       div.p **{ class: "Note" } do |p|
-        p << note_label(node)
+        p.span **{ class: "note_label" } do |s|
+          s << note_label(node)
+        end
         insert_tab(p, 1)
         node.first_element_child.children.each { |n| parse(n, p) }
       end
@@ -19,7 +21,9 @@ module IsoDoc
 
     def note_parse1(node, div)
       div.p **{ class: "Note" } do |p|
-        p << note_label(node)
+        p.span **{ class: "note_label" } do |s|
+          s << note_label(node)
+        end
         insert_tab(p, 1)
       end
       node.children.each { |n| parse(n, div) }
@@ -39,10 +43,8 @@ module IsoDoc
 
     def figure_name_parse(node, div, name)
       div.p **{ class: "FigureTitle", align: "center" } do |p|
-        p.b do |b|
-          b << l10n("#{@figure_lbl} #{get_anchors[node['id']][:label]}")
-          b << "&nbsp;&mdash; #{name.text}" if name
-        end
+        p << l10n("#{@figure_lbl} #{get_anchors[node['id']][:label]}")
+        p << "&nbsp;&mdash; #{name.text}" if name
       end
     end
 
@@ -72,7 +74,7 @@ module IsoDoc
     end
 
     EXAMPLE_TBL_ATTR =
-      { width: "110pt", valign: "top",
+      { width: "110pt", valign: "top", class: "example_label",
         style: "width:82.8pt;padding:.75pt .75pt .75pt .75pt" }.freeze
 
     # used if we are boxing examples
@@ -91,7 +93,7 @@ module IsoDoc
           tr.td **EXAMPLE_TBL_ATTR do |td|
             td << example_label(node)
           end
-          tr.td **{ valign: "top" } do |td|
+          tr.td **{ valign: "top", class: "example" } do |td|
             node.children.each { |n| parse(n, td) }
           end
         end
@@ -100,9 +102,7 @@ module IsoDoc
 
     def sourcecode_name_parse(_node, div, name)
       div.p **{ class: "FigureTitle", align: "center" } do |p|
-        p.b do |b|
-          b << name.text
-        end
+        p << name.text
       end
     end
 
@@ -124,14 +124,14 @@ module IsoDoc
       out.span **{ class: "zzMoveToFollowing" } do |s|
         s  << "&lt;#{node.at(ns("//callout[@target='#{node['id']}']")).text}&gt; "
       end
-        node.children.each { |n| parse(n, out) }
+      node.children.each { |n| parse(n, out) }
       @annotation = false
     end
 
     def admonition_parse(node, out)
       name = node["type"]
       out.div **{ class: "Admonition" } do |t|
-        t.title { |b| b << name.upcase } if name
+        t.title { |b| b << @admonition[name].upcase } if name
         node.children.each do |n|
           parse(n, t)
         end

data/lib/isodoc/cleanup.rb

@@ -12,6 +12,7 @@ module IsoDoc
       figure_cleanup(docxml)
       table_cleanup(docxml)
       symbols_cleanup(docxml)
+      example_cleanup(docxml)
       admonition_cleanup(docxml)
     end
 
@@ -24,6 +25,13 @@ module IsoDoc
       docxml
     end
 
+    def example_cleanup(docxml)
+      docxml.xpath("//table[@class = 'example']//p[not(@class)]").each do |p|
+        p["class"] = "example"
+      end
+      docxml
+    end
+
     def figure_get_or_make_dl(t)
       dl = t.at(".//dl")
       if dl.nil?
@@ -93,10 +101,15 @@ module IsoDoc
         t.xpath(".//aside").each do |a|
           merge_fnref_into_fn_text(a)
           a.name = "div"
-          a["class"] = "Note"
+          a["class"] = "TableFootnote"
           t << a.remove
         end
       end
+      # preempt html2doc putting MsoNormal there
+      docxml.xpath("//p[not(self::*[@class])]"\
+                   "[ancestor::*[@class = 'TableFootnote']]").each do |p|
+        p["class"] = "TableFootnote"
+      end
     end
 
     def remove_bottom_border(td)
@@ -127,10 +140,13 @@ module IsoDoc
     end
 
     def table_note_cleanup(docxml)
-      docxml.xpath("//table[div[@class = 'Note']]").each do |t|
+      docxml.xpath("//table[div[@class = 'Note' or "\
+                   "@class = 'TableFootnote']]").each do |t|
         tfoot = table_get_or_make_tfoot(t)
         insert_here = new_fullcolspan_row(t, tfoot)
-        t.xpath("div[@class = 'Note']").each { |d| d.parent = insert_here }
+        t.xpath("div[@class = 'Note' or @class = 'TableFootnote']").each do |d|
+          d.parent = insert_here
+        end
       end
       # preempt html2doc putting MsoNormal there
       docxml.xpath("//p[not(self::*[@class])]"\

data/lib/isodoc/comments.rb

@@ -32,7 +32,7 @@ module IsoDoc
       out.span(**comment_link_attrs(fn, node)) do |s1|
         s1.span **{ lang: "EN-GB", style: "font-size:9.0pt" } do |s2|
           s2.a **{ style: "mso-comment-reference:SMC_#{fn};"\
-                   "mso-comment-date:#{node['date']}" }
+                   "mso-comment-date:#{node['date'].gsub(/[-:Z]/, '')}" }
           s2.span **{ style: "mso-special-character:comment",
                       target: fn } # do |s|
         end

data/lib/isodoc/convert.rb

@@ -39,6 +39,7 @@ module IsoDoc
       @wordcoverpage = options[:wordcoverpage]
       @htmlintropage = options[:htmlintropage]
       @wordintropage = options[:wordintropage]
+      @scripts = options[:scripts]
       @i18nyaml = options[:i18nyaml]
       @ulstyle = options[:ulstyle]
       @olstyle = options[:olstyle]
@@ -61,6 +62,7 @@ module IsoDoc
       @closemathdelim = "`"
       @lang = "en"
       @script = "Latn"
+      @files_to_delete = []
     end
 
     def convert1(docxml, filename, dir)

data/lib/isodoc/footnotes.rb

@@ -34,7 +34,7 @@ module IsoDoc
 
     def make_generic_footnote_text(node, fnid)
       noko do |xml|
-        xml.aside **{ id: "ftn#{fnid}" } do |div|
+        xml.aside **{ id: "ftn#{fnid}", class: "footnote" } do |div|
           node.children.each { |n| parse(n, div) }
         end
       end.join("\n")
@@ -53,7 +53,9 @@ module IsoDoc
       # 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) }
+      out.aside **{ class: "footnote" } do |a|
+        a << make_table_footnote_text(node, tid + fn, fn)
+      end
       @in_footnote = false
       @seen_footnote << (tid + fn)
     end

data/lib/isodoc/html.rb

@@ -3,10 +3,13 @@ module IsoDoc
     def postprocess(result, filename, dir)
       result = from_xhtml(cleanup(to_xhtml(result)))
       toHTML(result, filename)
+      @files_to_delete.each { |f| system "rm #{f}" }
     end
 
     def toHTML(result, filename)
-      result = from_xhtml(html_cleanup(to_xhtml(result)))
+      result = from_xhtml(html_cleanup(to_xhtml(result))).
+        gsub(%r{<script><!\[CDATA\[}, "<script>").
+        gsub(%r{\]\]></script>}, "</script>")
       result = populate_template(result, :html)
       File.open("#{filename}.html", "w") do |f|
         f.write(result)
@@ -14,8 +17,8 @@ module IsoDoc
     end
 
     def html_cleanup(x)
-      footnote_backlinks(
-        html_toc(move_images(html_footnote_filter(html_preface(htmlstyle(x)))))
+      footnote_backlinks(html_toc(
+        term_header(move_images(html_footnote_filter(html_preface(htmlstyle(x))))))
       )
     end
 
@@ -36,24 +39,38 @@ module IsoDoc
       MATHJAX.gsub("OPEN", open).gsub("CLOSE", close)
     end
 
+    def term_header(docxml)
+      %w(h1 h2 h3 h4 h5 h6 h7 h8).each do |h|
+        docxml.xpath("//p[@class = 'TermNum'][../#{h}]").each do |p|
+          p.name = "h#{h[1].to_i + 1}"
+        end
+      end
+      docxml
+    end
+
     def html_preface(docxml)
       html_cover(docxml) if @htmlcoverpage
       html_intro(docxml) if @htmlintropage
-      docxml.at("//*[local-name() = 'body']") << mathjax(@openmathdelim,
-                                                         @closemathdelim)
+      docxml.at("//body") << mathjax(@openmathdelim, @closemathdelim)
+      if @scripts
+        scripts = File.read(@scripts, encoding: "UTF-8")
+        docxml.at("//body").add_child scripts #scripts.to_xml(encoding: "US-ASCII")
+      end
       docxml
     end
 
     def html_cover(docxml)
-      cover = Nokogiri::HTML(File.read(@htmlcoverpage, encoding: "UTF-8"))
+      cover = File.read(@htmlcoverpage, encoding: "UTF-8")
+      coverxml = to_xhtml_fragment(cover)
       d = docxml.at('//div[@class="WordSection1"]')
-      d.children.first.add_previous_sibling cover.to_xml(encoding: "US-ASCII")
+      d.children.first.add_previous_sibling coverxml.to_xml(encoding: "US-ASCII")
     end
 
     def html_intro(docxml)
-      cover = Nokogiri::HTML(File.read(@htmlintropage, encoding: "UTF-8"))
+      intro = File.read(@htmlintropage, encoding: "UTF-8")
+      introxml = to_xhtml_fragment(intro)
       d = docxml.at('//div[@class="WordSection2"]')
-      d.children.first.add_previous_sibling cover.to_xml(encoding: "US-ASCII")
+      d.children.first.add_previous_sibling introxml.to_xml(encoding: "US-ASCII")
     end
 
     def htmlstylesheet
@@ -140,7 +157,8 @@ module IsoDoc
       ret = ""
       prevname = ""
       docxml.xpath("//h1 | //h2").each do |h|
-        ret = html_toc1(h, ret, prevname) unless h["class"] == "toc-contents"
+        next if ["toc-contents", "TermNum"].include? h["class"]
+        ret = html_toc1(h, ret, prevname)
         prevname = h.name
       end
       ret += "<ul>" if prevname == "h2"

data/lib/isodoc/i18n-en.yaml

@@ -10,6 +10,7 @@ term_def_boilerplate: |
       </p> </li> </ul>
 scope: Scope
 symbols: Symbols and Abbreviated Terms
+table_of_contents: Table of Contents
 introduction: Introduction
 foreword: Foreword
 termsdef: Terms and Definitions
@@ -18,6 +19,7 @@ normref: Normative References
 bibliography: Bibliography
 clause: Clause
 annex: Annex
+appendix: Appendix
 no_terms_boilerplate: |
           <p>No terms and definitions are listed in this document.</p>
 internal_terms_boilerplate: |
@@ -57,6 +59,13 @@ deprecated: DEPRECATED
 source: SOURCE
 and: and
 all_parts: All Parts
+admonition: {
+  danger: Danger,
+  warning: Warning,
+  caution: Caution,
+  important: Important,
+  safety precautions: Safety Precautions,
+}
 locality: {
                       section: Section,
                       clause: Clause,

data/lib/isodoc/i18n-fr.yaml

@@ -10,14 +10,16 @@ term_def_boilerplate: |
       </p> </li> </ul>
 scope: Domaine d'application
 symbols: Symboles et termes abrégés
+table_of_contents: Sommaire
 introduction: Introduction
 foreword: Avant-propos
 termsdef: Terms et définitions
 termsdefsymbols: Terms, définitions, symboles et termes abrégés
 normref: Références normatives
-bibliography: then Bibliographie
-clause: then Article
+bibliography: Bibliographie
+clause: Article
 annex: Annexe
+appendix: Appendice
 no_terms_boilerplate: |
           <p>Aucun terme n'est defini dans le présent document.</p>
 internal_terms_boilerplate: |
@@ -50,6 +52,13 @@ deprecated: DÉCONSEILLÉ
 source: SOURCE
 and: et
 all_parts: toutes les parties
+admonition: {
+  danger: Danger,
+  warning: Avertissement,
+  caution: Attention,
+  important: Important,
+  safety precautions: Précautions de Sécurité,
+}
 locality: {
                       section: Section,
                       clause: Article,
@@ -63,4 +72,4 @@ locality: {
                       example: Exemple,
                       note: Note,
                       formula: Formule
-                    }
+                    }

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

@@ -8,6 +8,7 @@ term_def_boilerplate: |
       </p> </li> </ul>
 scope: 范围
 symbols: 符号、代号和缩略语
+table_of_contents: 目次
 introduction: 引言
 foreword: 前言
 termsdef: 术语和定义
@@ -15,7 +16,8 @@ termsdefsymbols_lbl: 术语、定义、符号、代号和缩略语
 normref: 规范性引用文件
 bibliography: 参考文献
 clause: 条
-annex: 附录
+annex: 附件
+appendix: 附录
 no_terms_boilerplate: |
           <p>本文件不提供术语和定义。</p>
 internal_terms_boilerplate: |
@@ -50,6 +52,13 @@ deprecated: 被取代
 source: 定义
 and: 和
 all_parts: 所有部分
+admonition: {
+  danger: 危险,
+  warning: 警告,
+  caution: 注意,
+  important: 重要,
+  safety precautions: 安全须知,
+}
 locality: {
   section: 条,
   clause: 条,

data/lib/isodoc/i18n.rb

@@ -20,6 +20,7 @@ module IsoDoc
       @term_def_boilerplate = y["term_def_boilerplate"]
       @scope_lbl = y["scope"]
       @symbols_lbl = y["symbols"]
+      @table_of_contents_lbl = y["table_of_contents"]
       @introduction_lbl = y["introduction"]
       @foreword_lbl = y["foreword"]
       @termsdef_lbl = y["termsdef"]
@@ -28,6 +29,7 @@ module IsoDoc
       @bibliography_lbl = y["bibliography"]
       @clause_lbl = y["clause"]
       @annex_lbl = y["annex"]
+      @appendix_lbl = y["appendix"]
       @no_terms_boilerplate = y["no_terms_boilerplate"]
       @internal_terms_boilerplate = y["internal_terms_boilerplate"]
       @norm_with_refs_pref = y["norm_with_refs_pref"]
@@ -56,12 +58,16 @@ module IsoDoc
       @and_lbl = y["and"]
       @all_parts_lbl = y["all_parts"]
       @locality = y["locality"]
+      @admonition = y["admonition"]
+      @labels = y
+      @labels["language"] = @lang
+      @labels["script"] = @script
     end
 
     def eref_localities1_zh(type, from, to)
       ret = ", 第#{from.text}" if from
       ret += "–#{to}" if to
-      ret += @locality[type]
+      ret += (@locality[type] || type.sub(/^locality:/, "").capitalize )
       ret
     end
 
@@ -69,7 +75,8 @@ module IsoDoc
       subsection = from&.text&.match?(/\./)
       return l10n(eref_localities1_zh(type, from, to)) if lang == "zh"
       ret = ","
-      ret += " #{@locality[type]}" unless subsection && type == "clause"
+      loc = @locality[type] || type.sub(/^locality:/, "").capitalize
+      ret += " #{loc}" unless subsection && type == "clause"
       ret += " #{from.text}" if from
       ret += "–#{to.text}" if to
       l10n(ret)