isodoc 0.4.5 → 0.5.5

data/lib/isodoc/i18n-en.yaml

@@ -0,0 +1,72 @@
+term_def_boilerplate: |
+      <p>ISO and IEC maintain terminological databases for use in
+      standardization at the following addresses:</p>
+
+      <ul>
+      <li> <p>ISO Online browsing platform: available at
+        <a href=http://www.iso.org/obp>http://www.iso.org/obp</a></p> </li>
+      <li> <p>IEC Electropedia: available at
+        <a href=http://www.electropedia.org>http://www.electropedia.org</a>
+      </p> </li> </ul>
+scope: Scope
+symbols: Symbols and Abbreviated Terms
+introduction: Introduction
+foreword: Foreword
+termsdef: Terms and Definitions
+termsdefsymbols: Terms, Definitions, Symbols and Abbreviated Terms
+normref: Normative References
+bibliography: Bibliography
+clause: Clause
+annex: Annex
+no_terms_boilerplate: |
+          <p>No terms and definitions are listed in this document.</p>
+internal_terms_boilerplate: |
+        <p>For the purposes of this document, 
+            the following terms and definitions apply.</p>
+norm_with_refs_pref: 
+      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.
+norm_empty_pref: 
+          There are no normative references in this document.
+external_terms_boilerplate: |
+          <p>For the purposes of this document, 
+            the terms and definitions given in % apply.</p>
+internal_external_terms_boilerplate: |
+          <p>For the purposes of this document, the terms and definitions 
+            given in % and the following apply.</p>
+note: NOTE
+note_xref: Note
+termnote: Note % to entry
+figure: Figure
+formula: Formula
+table: Table
+key: Key
+example: EXAMPLE
+example_xref: Example
+where: where
+wholeoftext: Whole of text
+draft: draft
+inform_annex: informative
+norm_annex: normative
+modified: modified
+deprecated: DEPRECATED
+source: SOURCE
+and: and
+all_parts: All Parts
+locality: {
+                      section: Section,
+                      clause: Clause,
+                      part: Part,
+                      paragraph: Paragraph,
+                      chapter: Chapter,
+                      page: Page,
+                      table: Table,
+                      annex: Annex,
+                      figure: Figure,
+                      example: Example,
+                      note: Note,
+                      formula: Formula
+                    }

data/lib/isodoc/i18n-fr.yaml

@@ -0,0 +1,65 @@
+term_def_boilerplate: |
+      <p>L'ISO et l'IEC tiennent à jour des bases de données terminologiques
+      destinées à être utilisées en normalisation, consultables aux adresses
+      suivantes:</p>
+      <ul>
+      <li> <p>ISO Online browsing platform: disponible à l'adresse
+        <a href=http://www.iso.org/obp>http://www.iso.org/obp</a></p> </li>
+      <li> <p>IEC Electropedia: disponible à l'adresse
+        <a href=http://www.electropedia.org>http://www.electropedia.org</a>
+      </p> </li> </ul>
+scope: Domaine d'application
+symbols: Symboles et termes abrégés
+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
+annex: Annexe
+no_terms_boilerplate: |
+          <p>Aucun terme n'est defini dans le présent document.</p>
+internal_terms_boilerplate: |
+         <p>Pour les besoins du présent document, les termes et définitions suivants s'appliquent.</p>
+norm_with_refs_pref: 
+     Les documents suivants cités dans le texte constituent, pour tout ou partie de leur contenu, des exigences du présent document. Pour les références datées, seule l’édition citée s'applique. Pour les références non datées, la dernière édition du document de référence s'applique (y compris les éventuels amendements).
+norm_empty_pref: 
+          Le présent document ne contient aucune référence normative.
+external_terms_boilerplate: |
+          <p>Pour les besoins du présent document, les termes et définitions de % s'appliquent.</p>
+internal_external_terms_boilerplate: |
+          <p>Pour les besoins du présent document, les termes et définitions de % ainsi que les suivants, s'appliquent.</p>
+note: NOTE
+note_xref: Note
+termnote: Note % à l'article
+figure: Figure
+formula: Formule
+table: Tableau
+key: Légende
+example: EXEMPLE
+example_xref: Exemple
+where: où
+wholeoftext: Ensemble du texte
+draft: brouillon
+inform_annex: informative
+norm_annex: normative
+modified: modifié
+deprecated: DÉCONSEILLÉ
+source: SOURCE
+and: et
+all_parts: toutes les parties
+locality: {
+                      section: Section,
+                      clause: Article,
+                      part: Partie,
+                      paragraph: Alinéa,
+                      chapter: Chapitre,
+                      page: Page,
+                      table: Tableau,
+                      annex: Annexe,
+                      figure: Figure,
+                      example: Exemple,
+                      note: Note,
+                      formula: Formule
+                    }

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

@@ -0,0 +1,64 @@
+term_def_boilerplate: |
+      <p>ISO和IEC用于标准化的术语数据库地址如下：</p>
+      <ul>
+      <li> <p>ISO在线浏览平台:
+        位于<a href=http://www.iso.org/obp>http://www.iso.org/obp</a></p> </li>
+      <li> <p>IEC Electropedia:
+        位于<a href=http://www.electropedia.org>http://www.electropedia.org</a>
+      </p> </li> </ul>
+scope: 范围
+symbols: 符号、代号和缩略语
+introduction: 引言
+foreword: 前言
+termsdef: 术语和定义
+termsdefsymbols_lbl: 术语、定义、符号、代号和缩略语
+normref: 规范性引用文件
+bibliography: 参考文献
+clause: 条
+annex: 附录
+no_terms_boilerplate: |
+          <p>本文件不提供术语和定义。</p>
+internal_terms_boilerplate: |
+          <p>下列术语和定义适用于本文件。</p>
+norm_with_refs_pref: 
+          下列文件对于本文件的应用是必不可少的。
+          凡是注日期的引用文件，仅注日期的版本适用于本文件。
+          凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。
+norm_empty_pref: 
+          本文件并没有规范性引用文件。
+external_terms_boilerplate: |
+          <p>% 界定的术语和定义适用于本文件。</p>
+internal_external_terms_boilerplate: |
+          <p>% 界定的以及下列术语和定义适用于本文件。</p>
+note: 注
+note_xref: 注
+termnote: 注%
+figure: 图
+formula: 公式
+table: 表
+key: 说明
+example: 示例
+example_xref: 示例
+where: 式中
+wholeoftext: 全部
+draft: 稿
+inform_annex: 资料性附录
+norm_annex: 规范性附录
+modified: 改写
+deprecated: 被取代
+source: 定义
+and: 和
+all_parts: 所有部分
+locality: {
+  section: 条,
+  clause: 条,
+  part: 部分,
+  paragraph: 段,
+  chapter: 章,
+  page: 页,
+  table: 表,
+  annex: 附录,
+  figure: 图,
+  example: 示例,
+  note: 注
+}

data/lib/isodoc/i18n.rb

@@ -0,0 +1,90 @@
+require "yaml"
+
+module IsoDoc
+  class Convert
+    def i18n_init(lang, script)
+      @lang = lang
+      @script = script
+      y = if @i18nyaml
+            YAML.load_file(@i18nyaml)
+          elsif lang == "en"
+            YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
+          elsif lang == "fr"
+            YAML.load_file(File.join(File.dirname(__FILE__), "i18n-fr.yaml"))
+          elsif lang == "zh" && script == "Hans"
+            YAML.load_file(File.join(File.dirname(__FILE__),
+                                     "i18n-zh-Hans.yaml"))
+          else
+            YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
+          end
+      @term_def_boilerplate = y["term_def_boilerplate"]
+      @scope_lbl = y["scope"]
+      @symbols_lbl = y["symbols"]
+      @introduction_lbl = y["introduction"]
+      @foreword_lbl = y["foreword"]
+      @termsdef_lbl = y["termsdef"]
+      @termsdefsymbols_lbl = y["termsdefsymbols"]
+      @normref_lbl = y["normref"]
+      @bibliography_lbl = y["bibliography"]
+      @clause_lbl = y["clause"]
+      @annex_lbl = y["annex"]
+      @no_terms_boilerplate = y["no_terms_boilerplate"]
+      @internal_terms_boilerplate = y["internal_terms_boilerplate"]
+      @norm_with_refs_pref = y["norm_with_refs_pref"]
+      @norm_empty_pref = y["norm_empty_pref"]
+      @external_terms_boilerplate = y["external_terms_boilerplate"]
+      @internal_external_terms_boilerplate =
+        y["internal_external_terms_boilerplate"]
+      @note_lbl = y["note"]
+      @note_xref_lbl = y["note_xref"]
+      @termnote_lbl = y["termnote"]
+      @figure_lbl = y["figure"]
+      @formula_lbl = y["formula"]
+      @table_lbl = y["table"]
+      @key_lbl = y["key"]
+      @example_lbl = y["example"]
+      @example_xref_lbl = y["example_xref"]
+      @where_lbl = y["where"]
+      @wholeoftext_lbl = y["wholeoftext"]
+      @draft_lbl = y["draft"]
+      @inform_annex_lbl = y["inform_annex"]
+      @norm_annex_lbl = y["norm_annex"]
+      @modified_lbl = y["modified"]
+      @deprecated_lbl = y["deprecated"]
+      @source_lbl = y["source"]
+      @and_lbl = y["and"]
+      @all_parts_lbl = y["all_parts"]
+      @locality = y["locality"]
+    end
+
+    def eref_localities1_zh(type, from, to)
+      ret = ", 第#{from.text}" if from
+      ret += "–#{to}" if to
+      ret += @locality[type]
+      ret
+    end
+
+    def eref_localities1(type, from, to, lang = "en")
+      subsection = from&.text&.match?(/\./)
+      return l10n(eref_localities1_zh(type, from, to)) if lang == "zh"
+      ret = ","
+      ret += " #{@locality[type]}" unless subsection && type == "clause"
+      ret += " #{from.text}" if from
+      ret += "–#{to.text}" if to
+      l10n(ret)
+    end
+
+    # function localising spaces and punctuation.
+    # Not clear if period needs to be localised for zh
+    def l10n(x, lang = @lang, script = @script)
+      if lang == "zh" && script == "Hans"
+        x.gsub(/ /, "").gsub(/:/, "：").gsub(/,/, "、").
+          gsub(/\(/, "（").gsub(/\)/, "）").
+          gsub(/\[/, "【").gsub(/\]/, "】").
+          gsub(/<b>/, "").gsub("</b>", "")
+      else
+        x
+      end
+    end
+  end
+end

data/lib/isodoc/inline.rb

@@ -23,14 +23,21 @@ module IsoDoc
       out << " &lt;#{node.text}&gt;"
     end
 
-    def get_linkend(node)
-      linkend = node["target"] || node["citeas"]
-      get_anchors().has_key?(node["target"]) &&
-        linkend = get_anchors()[node["target"]][:xref]
-      if node["citeas"].nil? && get_anchors().has_key?(node["bibitemid"])
-        linkend = get_anchors()[node["bibitemid"]][:xref]
+    def anchor_linkend(node, linkend)
+      if node["citeas"].nil? && get_anchors.has_key?(node["bibitemid"])
+        return get_anchors[node["bibitemid"]][:xref]
+      elsif get_anchors.has_key?(node["target"])
+        linkend = get_anchors[node["target"]][:xref]
+        container = get_anchors[node["target"]][:container]
+        (container && get_note_container_id(node) != container) &&
+          linkend = l10n(get_anchors[container][:xref] + ", " + linkend)
       end
-      linkend += eref_localities(node.xpath(ns("./locality"))) 
+      linkend
+    end
+
+    def get_linkend(node)
+      linkend = anchor_linkend(node, node["target"] || node["citeas"])
+      linkend += eref_localities(node.xpath(ns("./locality")))
       text = node.children.select { |c| c.text? && !c.text.empty? }
       linkend = text.join(" ") unless text.nil? || text.empty?
       # so not <origin bibitemid="ISO7301" citeas="ISO 7301">
@@ -43,16 +50,15 @@ module IsoDoc
       out.a **{ "href": "#" + node["target"] } { |l| l << linkend }
     end
 
-    def eref_localities(r)
+    def eref_localities(refs)
       ret = ""
-      r.each do |r|
-        if r["type"] == "whole"
-          ret += ", Whole of text"
-        else
-          ret += ", #{r["type"].capitalize}"
-          ref = r.at(ns("./reference"))
-          ret += " #{ref.text}" if ref
-        end
+      refs.each do |r|
+        ret += if r["type"] == "whole"
+                 l10n(", #{@whole_of_text}")
+               else
+                 eref_localities1(r["type"], r.at(ns("./referenceFrom")),
+                                  r.at(ns("./referenceTo")))
+               end
       end
       ret
     end
@@ -69,7 +75,8 @@ module IsoDoc
     end
 
     def stem_parse(node, out)
-      ooml = if node["type"] == "AsciiMath" then "`#{node.text}`"
+      ooml = if node["type"] == "AsciiMath"
+               "#{@openmathdelim}#{node.text}#{@closemathdelim}"
              elsif node["type"] == "MathML" then node.first_element_child.to_s
              else
                node.text
@@ -79,7 +86,7 @@ module IsoDoc
       end
     end
 
-    def pagebreak_parse(node, out)
+    def pagebreak_parse(_node, out)
       attrs = { clear: all, class: "pagebreak" }
       out.br **attrs
     end

data/lib/isodoc/iso2wordhtml.rb

@@ -2,12 +2,33 @@ require "pp"
 
 module IsoDoc
   class Convert
+    def set_termdomain(termdomain)
+      @termdomain = termdomain
+    end
+
+    def get_termexample
+      @termexample
+    end
+
+    def set_termexample(value)
+      @termexample = value
+    end
 
-    def init_file(filename)
+    def in_sourcecode
+      @sourcecode
+    end
+
+    def note?
+      @note
+    end
+
+    def init_file(filename, debug)
       filename = filename.gsub(%r{\.[^/.]+$}, "")
       dir = "#{filename}_files"
-      Dir.mkdir(dir) unless File.exists?(dir)
-      system "rm -r #{dir}/*"
+      unless debug
+        Dir.mkdir(dir) unless File.exists?(dir)
+        system "rm -r #{dir}/*"
+      end
       [filename, dir]
     end
 
@@ -20,7 +41,7 @@ module IsoDoc
       end
     end
 
-    def make_body1(body, docxml)
+    def make_body1(body, _docxml)
       body.div **{ class: "WordSection1" } do |div1|
         div1.p { |p| p << "&nbsp;" } # placeholder
       end
@@ -50,6 +71,7 @@ module IsoDoc
       id isoxml, out
       author isoxml, out
       bibdate isoxml, out
+      relations isoxml, out
       version isoxml, out
       foreword isoxml, out
       introduction isoxml, out
@@ -72,7 +94,7 @@ module IsoDoc
     end
 
     def smallcap_parse(node, xml)
-      xml.span **{style: "font-variant:small-caps;"} do |s|
+      xml.span **{ style: "font-variant:small-caps;" } do |s|
         s << node.text
       end
     end
@@ -137,11 +159,12 @@ module IsoDoc
         when "domain" then set_termdomain(node.text)
         when "definition" then definition_parse(node, out)
         when "termsource" then termref_parse(node, out)
-        when "isosection"
-          out << "[ISOSECTION] #{node.text}"
         when "modification" then modification_parse(node, out)
         when "termnote" then termnote_parse(node, out)
         when "termexample" then termexample_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)
         else
           error_parse(node, out)
         end

data/lib/isodoc/lists.rb

@@ -15,12 +15,28 @@ module IsoDoc
     }.freeze
 
     def ol_style(type)
+      type = :alphabet unless type
       OL_STYLE[type.to_sym]
     end
 
+    # We don't really want users to specify type of ordered list;
+    # we will use a fixed hierarchy as practiced by ISO (though not
+    # fully spelled out): a) 1) i) A) I) 
+    #
+   
+    def ol_depth(node)
+      depth = node.ancestors("ul, ol").size + 1
+      type = :alphabet
+      type = :arabic if [2, 7].include? depth
+      type = :roman if [3, 8].include? depth
+      type = :alphabet_upper if [4, 9].include? depth
+      type = :roman_upper if [5, 10].include? depth
+      ol_style(type)
+    end
+
     def ol_parse(node, out)
-      # attrs = { numeration: node["type"] }
-      style = ol_style(node["type"])
+      # style = ol_style(node["type"])
+      style = ol_depth(node)
       out.ol **attr_code(type: style) do |ol|
         node.children.each { |n| parse(n, ol) }
       end
@@ -32,17 +48,21 @@ module IsoDoc
       end
     end
 
+    def dt_parse(dt, term)
+      if dt.elements.empty?
+        term.p **attr_code(class: note? ? "Note" : nil) do |p|
+          p << dt.text
+        end
+      else
+        dt.children.each { |n| parse(n, term) }
+      end
+    end
+
     def dl_parse(node, out)
       out.dl do |v|
         node.elements.each_slice(2) do |dt, dd|
           v.dt do |term|
-            if dt.elements.empty?
-              term.p **attr_code(class: is_note ? "Note" : nil) do
-                |p| p << dt.text
-              end
-            else
-              dt.children.each { |n| parse(n, term) }
-            end
+            dt_parse(dt, term)
           end
           v.dd do |listitem|
             dd.children.each { |n| parse(n, listitem) }