isodoc 1.6.1 → 1.6.6

data/lib/isodoc-yaml/i18n-fr.yaml

@@ -14,6 +14,7 @@ termsdefsymbols: Terms, définitions et symboles
 termsdefabbrev: Terms, définitions et termes abrégés
 normref: Références normatives
 bibliography: Bibliographie
+preface: Préface
 clause: Article
 annex: Annexe
 appendix: Appendice

data/lib/isodoc-yaml/i18n-ru.yaml

@@ -0,0 +1,154 @@
+term_def_boilerplate: 
+scope: Сфера применения
+symbolsabbrev: Символы и сокращенные термины
+abbrev: Сокращенные термины
+symbols: Символы
+table_of_contents: Содержание
+introduction: Введение
+foreword: Предисловие
+abstract: Реферат
+acknowledgements: Подтверждения
+termsdef: Термины и определения
+termsdefsymbolsabbrev: Термины, определения, символы и сокращенные термины
+termsdefsymbols: Термины, определения и символы
+termsdefabbrev: Термины, определения и сокращенные термины
+normref: Нормативные ссылки
+bibliography: Библиография
+clause: Пункт
+annex: Дополнение
+appendix: Приложение
+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>
+term_defined_in: "[термин, определенный в %]"
+note: ПРИМЕЧАНИЕ
+note_xref: Примечание
+termnote: Примечание % к определению
+list: Список
+figure: Рисунок
+formula: Формула
+inequality: Формула
+table: Таблица
+requirement: Требование
+recommendation: Рекомендация
+permission: Разрешение
+key: Условные обозначения
+example: ПРИМЕР
+example_xref: Пример
+where: где
+wholeoftext: Текст полностью
+draft_label: проект
+inform_annex: информативное
+norm_annex: нормативное
+modified: изменен
+deprecated: НЕ РЕКОМЕНДУЕТСЯ
+source: ИСТОЧНИК
+and: и
+all_parts: Все части
+month_january: Январь
+month_february: Февраль
+month_march: Март
+month_april: Апрель
+month_may: Май
+month_june: Июнь
+month_july: Июль
+month_august: Август
+month_september: Сентябрь
+month_october: Октябрь
+month_november: Ноябрь
+month_december: Декабрь
+obligation: Обязательство
+subject: Тема
+inherits: Наследует
+admonition: {
+  danger: Опасность,
+  warning: Предупреждение,
+  caution: Предостережение,
+  important: Важно,
+  safety precautions: Меры безопасности
+}
+locality: {
+                      section: Раздел,
+                      clause: Пункт,
+                      part: Часть,
+                      paragraph: Абзац,
+                      chapter: Глава,
+                      page: Стр.,
+                      table: Таблица,
+                      annex: Дополнение,
+                      figure: Рисунок,
+                      example: Пример,
+                      note: Примечание,
+                      formula: Формула
+                    }
+inflection:
+  Пункт:
+    sg: Пункт
+    pl: Пункты
+  Дополнение:
+    sg: Дополнение
+    pl: Дополнения
+  Приложение:
+    sg: Приложение
+    pl: Приложения
+  Примечание:
+    sg: Примечание
+    pl: Примечания
+  "Примечание % к записи":
+    sg: Примечание % к записи
+    pl: Примечания % к записи
+  Список:
+    sg: Список
+    pl: Списки
+  Рисунок:
+    sg: Рисунок
+    pl: Рисунки
+  Формула:
+    sg: Формула
+    pl: Формулы
+  Таблица:
+    sg: Таблица
+    pl: Таблицы
+  Требование:
+    sg: Требование
+    pl: Требования
+  Рекомендация:
+    sg: Рекомендация
+    pl: Рекомендации
+  Разрешение:
+    sg: Разрешение
+    pl: Разрешения
+  Пример:
+    sg: Пример
+    pl: Примеры
+  Часть:
+    sg: Часть
+    pl: Части
+  Раздел:
+    sg: Раздел
+    pl: Разделы
+  Абзац:
+    sg: Абзац
+    pl: Абзацы
+  Глава:
+    sg: Глава
+    pl: Главы
+  "Стр.":
+    sg: Стр.
+    pl: Стр.

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

@@ -14,6 +14,7 @@ termsdefsymbols: 术语、定义、符号和代号
 termsdefabbrev: 术语、定义、符号和缩略语
 normref: 规范性引用文件
 bibliography: 参考文献
+preface: 序言
 clause: 条
 annex: 附件
 appendix: 附录

data/lib/isodoc.rb

@@ -8,7 +8,6 @@ require "mime/types"
 require "image_size"
 require "set"
 require "pp"
-require "uuidtools"
 require "html2doc"
 require "liquid"
 require "htmlentities"
@@ -26,5 +25,4 @@ require "isodoc/xref"
 require "isodoc/i18n"
 
 module IsoDoc
-
 end

data/lib/isodoc/common.rb

@@ -1,5 +1,6 @@
 require_relative "./function/blocks"
 require_relative "./function/cleanup"
+require_relative "./function/form"
 require_relative "./function/inline"
 require_relative "./function/lists"
 require_relative "./function/references"
@@ -15,6 +16,7 @@ module IsoDoc
   class Common
     include Function::Blocks
     include Function::Cleanup
+    include Function::Form
     include Function::Inline
     include Function::Lists
     include Function::References

data/lib/isodoc/convert.rb

@@ -8,7 +8,7 @@ require_relative "css"
 
 module IsoDoc
   class Convert < ::IsoDoc::Common
-    attr_accessor :options, :i18n, :meta
+    attr_accessor :options, :i18n, :meta, :xrefs
 
     # htmlstylesheet: Generic stylesheet for HTML
     # htmlstylesheet_override: Override stylesheet for HTML
@@ -32,10 +32,13 @@ module IsoDoc
     # monospace: font to use for monospace text
     # suppressheadingnumbers: suppress heading numbers for clauses
     # scripts: Scripts file for HTML
+    # scripts_override: Override scripts file for HTML
     # scripts_pdf: Scripts file for PDF (not used in XSLT PDF)
     # datauriimage: Encode images in HTML output as data URIs
     # break_up_urls_in_tables: whether to insert spaces in URLs in tables
     #   every 40-odd chars
+    # sectionsplit: split up HTML output on sections
+    # bare: do not insert any prefatory material (coverpage, boilerplate)
     def initialize(options)
       @libdir ||= File.dirname(__FILE__) # rubocop:disable Lint/DisjunctiveAssignmentInConstructor
       options.merge!(default_fonts(options)) do |_, old, new|
@@ -64,12 +67,15 @@ module IsoDoc
       @scripts = options[:scripts] ||
         File.join(File.dirname(__FILE__), "base_style", "scripts.html")
       @scripts_pdf = options[:scripts_pdf]
+      @scripts_override = options[:scripts_override]
       @i18nyaml = options[:i18nyaml]
       @ulstyle = options[:ulstyle]
       @olstyle = options[:olstyle]
       @datauriimage = options[:datauriimage]
       @suppressheadingnumbers = options[:suppressheadingnumbers]
       @break_up_urls_in_tables = options[:break_up_urls_in_tables] == "true"
+      @sectionsplit = options[:sectionsplit] == "true"
+      @bare = options[:bare]
       @termdomain = ""
       @termexample = false
       @note = false
@@ -150,7 +156,7 @@ module IsoDoc
       [docxml, filename, dir]
     end
 
-    def convert(input_filename, file = nil, debug = false, 
+    def convert(input_filename, file = nil, debug = false,
                 output_filename = nil)
       file = File.read(input_filename, encoding: "utf-8") if file.nil?
       @openmathdelim, @closemathdelim = extract_delims(file)

data/lib/isodoc/function/blocks.rb

@@ -4,10 +4,21 @@ module IsoDoc::Function
   module Blocks
     @annotation = false
 
-    def figure_name_parse(node, div, name)
-      return if name.nil? 
+    def middle_title(_isoxml, out)
+      out.p(**{ class: "zzSTDTitle1" }) { |p| p << @meta.get[:doctitle] }
+    end
+
+    def middle_admonitions(isoxml, out)
+      isoxml.xpath(ns("//sections/note | //sections/admonition")).each do |x|
+        parse(x, out)
+      end
+    end
+
+    def figure_name_parse(_node, div, name)
+      return if name.nil?
+
       div.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
-        name.children.each { |n| parse(n, div) }
+        name.children.each { |n| parse(n, p) }
       end
     end
 
@@ -51,7 +62,7 @@ module IsoDoc::Function
     end
 
     def sourcecode_name_parse(node, div, name)
-      return if name.nil? 
+      return if name.nil?
 
       div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
         name.children.each { |n| parse(n, p) }

data/lib/isodoc/function/cleanup.rb

@@ -1,16 +1,17 @@
 module IsoDoc::Function
   module Cleanup
     def textcleanup(docxml)
-      docxml = termref_cleanup(passthrough_cleanup(docxml))
+      termref_cleanup(passthrough_cleanup(docxml))
     end
 
     def termref_cleanup(docxml)
-      docxml.
-        gsub(/\s*\[MODIFICATION\]\s*\[\/TERMREF\]/, l10n(", #{@i18n.modified} [/TERMREF]")).
-        gsub(%r{\s*\[/TERMREF\]\s*</p>\s*<p>\s*\[TERMREF\]}, "; ").
-        gsub(/\[TERMREF\]\s*/, l10n("[#{@i18n.source}: ")).
-        gsub(%r{\s*\[\/TERMREF\]\s*}, l10n("]")).
-        gsub(/\s*\[MODIFICATION\]/, l10n(", #{@i18n.modified} &mdash; "))
+      docxml
+        .gsub(/\s*\[MODIFICATION\]\s*\[\/TERMREF\]/,
+              l10n(", #{@i18n.modified} [/TERMREF]"))
+        .gsub(%r{\s*\[/TERMREF\]\s*</p>\s*<p>\s*\[TERMREF\]}, "; ")
+        .gsub(/\[TERMREF\]\s*/, l10n("[#{@i18n.source}: "))
+        .gsub(%r{\s*\[/TERMREF\]\s*}, l10n("]"))
+        .gsub(/\s*\[MODIFICATION\]/, l10n(", #{@i18n.modified} &mdash; "))
     end
 
     def passthrough_cleanup(docxml)
@@ -21,7 +22,7 @@ module IsoDoc::Function
     end
 
     def cleanup(docxml)
-      @i18n ||= i18n_init(@lang, @script) 
+      @i18n ||= i18n_init(@lang, @script)
       comment_cleanup(docxml)
       footnote_cleanup(docxml)
       inline_header_cleanup(docxml)
@@ -34,30 +35,36 @@ module IsoDoc::Function
 
     def table_long_strings_cleanup(docxml)
       return unless @break_up_urls_in_tables == true
+
       docxml.xpath("//td | //th").each do |d|
         d.traverse do |n|
           next unless n.text?
+
           n.replace(HTMLEntities.new.encode(
-            break_up_long_strings(n.text)))
+                      break_up_long_strings(n.text),
+                    ))
         end
       end
     end
 
-    def break_up_long_strings(t)
-      return t if t.match(/^\s*$/)
-      t.split(/(?=\s)/).map do |w|
-        (/^\s*$/.match(t) or w.size < 30) ? w :
+    def break_up_long_strings(text)
+      return text if /^\s*$/.match?(text)
+
+      text.split(/(?=\s)/).map do |w|
+        if /^\s*$/.match(text) || (w.size < 30) then w
+        else
           w.scan(/.{,30}/).map do |w1|
-          (w1.size < 30) ? w1 : break_up_long_strings1(w1)
-        end.join
+            w1.size < 30 ? w1 : break_up_long_strings1(w1)
+          end.join
+        end
       end.join
     end
 
-    def break_up_long_strings1(w1)
-      s = w1.split(%r{(?<=[,.?+;/=])})
-      if s.size == 1 then w1 + " "
+    def break_up_long_strings1(text)
+      s = text.split(%r{(?<=[,.?+;/=])})
+      if s.size == 1 then "#{text} "
       else
-        s[-1] = " " + s[-1]
+        s[-1] = " #{s[-1]}"
         s.join
       end
     end
@@ -78,11 +85,11 @@ module IsoDoc::Function
       docxml
     end
 
-    def figure_get_or_make_dl(t)
-      dl = t.at(".//dl")
+    def figure_get_or_make_dl(elem)
+      dl = elem.at(".//dl")
       if dl.nil?
-        t.add_child("<p><b>#{@i18n.key}</b></p><dl></dl>")
-        dl = t.at(".//dl")
+        elem.add_child("<p><b>#{@i18n.key}</b></p><dl></dl>")
+        dl = elem.at(".//dl")
       end
       dl
     end
@@ -91,10 +98,10 @@ module IsoDoc::Function
       "//div[@class = 'figure'][descendant::aside]"\
       "[not(descendant::div[@class = 'figure'])]".freeze
 
-    def figure_aside_process(f, aside, key)
+    def figure_aside_process(elem, aside, key)
       # get rid of footnote link, it is in diagram
-      f&.at("./a[@class='TableFootnoteRef']")&.remove
-      fnref = f.at(".//span[@class='TableFootnoteRef']/..")
+      elem&.at("./a[@class='TableFootnoteRef']")&.remove
+      fnref = elem.at(".//span[@class='TableFootnoteRef']/..")
       dt = key.add_child("<dt></dt>").first
       dd = key.add_child("<dd></dd>").first
       fnref.parent = dt
@@ -109,6 +116,7 @@ module IsoDoc::Function
     def figure_cleanup(docxml)
       docxml.xpath(FIGURE_WITH_FOOTNOTES).each do |f|
         next unless f.at(".//aside[not(ancestor::p[@class = 'FigureTitle'])]")
+
         key = figure_get_or_make_dl(f)
         f.xpath(".//aside").each do |aside|
           figure_aside_process(f, aside, key)
@@ -137,12 +145,13 @@ module IsoDoc::Function
       docxml
     end
 
-    def merge_fnref_into_fn_text(a)
-      fn = a.at('.//span[@class="TableFootnoteRef"]/..')
+    def merge_fnref_into_fn_text(elem)
+      fn = elem.at('.//span[@class="TableFootnoteRef"]/..')
       n = fn.next_element
       n&.children&.first&.add_previous_sibling(fn.remove)
     end
 
+    # preempt html2doc putting MsoNormal under TableFootnote class
     def table_footnote_cleanup(docxml)
       docxml.xpath("//table[descendant::aside]").each do |t|
         t.xpath(".//aside").each do |a|
@@ -152,36 +161,36 @@ module IsoDoc::Function
           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)
-      td["style"] =
-        td["style"].gsub(/border-bottom:[^;]+;/, "border-bottom:0pt;")
+    def remove_bottom_border(cell)
+      cell["style"] =
+        cell["style"].gsub(/border-bottom:[^;]+;/, "border-bottom:0pt;")
     end
 
-    def table_get_or_make_tfoot(t)
-      tfoot = t.at(".//tfoot")
+    def table_get_or_make_tfoot(table)
+      tfoot = table.at(".//tfoot")
       if tfoot.nil?
-        t.add_child("<tfoot></tfoot>")
-        tfoot = t.at(".//tfoot")
+        table.add_child("<tfoot></tfoot>")
+        tfoot = table.at(".//tfoot")
       else
         tfoot.xpath(".//td | .//th").each { |td| remove_bottom_border(td) }
       end
       tfoot
     end
 
-    def new_fullcolspan_row(t, tfoot)
+    def new_fullcolspan_row(table, tfoot)
       # how many columns in the table?
       cols = 0
-      t.at(".//tr").xpath("./td | ./th").each do |td|
+      table.at(".//tr").xpath("./td | ./th").each do |td|
         cols += (td["colspan"] ? td["colspan"].to_i : 1)
       end
-      style = %{border-top:0pt;border-bottom:#{IsoDoc::Function::Table::SW} 1.5pt;}
+      style =
+        %{border-top:0pt;border-bottom:#{IsoDoc::Function::Table::SW} 1.5pt;}
       tfoot.add_child("<tr><td colspan='#{cols}' style='#{style}'/></tr>")
       tfoot.xpath(".//td").last
     end
@@ -206,12 +215,12 @@ module IsoDoc::Function
 
     def symbols_cleanup(docxml); end
 
-    def table_footnote_reference_format(a)
-      a
+    def table_footnote_reference_format(link)
+      link
     end
 
-    def footnote_reference_format(a)
-      a
+    def footnote_reference_format(link)
+      link
     end
   end
 end