isodoc 1.6.0 → 1.6.5

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)
@@ -163,9 +169,9 @@ module IsoDoc
       FileUtils.rm_rf dir
     end
 
-    def middle_clause(docxml = nil)
+    def middle_clause(_docxml = nil)
       "//clause[parent::sections][not(@type = 'scope')]"\
-        '[not(descendant::terms)]'
+        "[not(descendant::terms)]"
     end
 
     def target_pdf(node)

data/lib/isodoc/css.rb

@@ -6,17 +6,20 @@ module IsoDoc
     def precompiled_style_or_original(stylesheet_path)
       # Already have compiled stylesheet, use it
       return stylesheet_path if stylesheet_path.nil? ||
-        File.extname(stylesheet_path) == '.css'
-      basename = File.basename(stylesheet_path, '.*')
+        File.extname(stylesheet_path) == ".css"
+
+      basename = File.basename(stylesheet_path, ".*")
       compiled_path = File.join(File.dirname(stylesheet_path),
                                 "#{basename}.css")
       return stylesheet_path unless File.file?(compiled_path)
+
       compiled_path
     end
 
     def localpath(path)
-      return path if %r{^[A-Z]:|^/|^file:/}.match(path)
+      return path if %r{^[A-Z]:|^/|^file:/}.match?(path)
       return path unless (@sourcedir || @localdir) && path
+
       File.expand_path(File.join((@sourcedir || @localdir), path))
     end
 
@@ -34,9 +37,9 @@ module IsoDoc
 
     def default_fonts(_options)
       {
-        bodyfont: 'Arial',
-        headerfont: 'Arial',
-        monospacefont: 'Courier',
+        bodyfont: "Arial",
+        headerfont: "Arial",
+        monospacefont: "Courier",
       }
     end
 
@@ -48,35 +51,35 @@ module IsoDoc
 
     def fonts_options
       {
-        'bodyfont' => options[:bodyfont] || 'Arial',
-        'headerfont' => options[:headerfont] || 'Arial',
-        'monospacefont' => options[:monospacefont] || 'Courier',
+        "bodyfont" => options[:bodyfont] || "Arial",
+        "headerfont" => options[:headerfont] || "Arial",
+        "monospacefont" => options[:monospacefont] || "Courier",
         "normalfontsize" => options[:normalfontsize],
         "monospacefontsize" => options[:monospacefontsize],
         "smallerfontsize" => options[:smallerfontsize],
-        "footnotefontsize" => options[:footnotefontsize] 
+        "footnotefontsize" => options[:footnotefontsize],
       }
     end
 
     def scss_fontheader(is_html_css)
-      b = options[:bodyfont] || 'Arial'
-      h = options[:headerfont] || 'Arial'
-      m = options[:monospacefont] || 'Courier'
-      ns = options[:normalfontsize] || (is_html_css ? "1.0em" : '12.0pt')
-      ms = options[:monospacefontsize] || (is_html_css ? "0.8em" : '11.0pt')
-      ss = options[:smallerfontsize] || (is_html_css ? "0.9em" : '10.0pt')
-      fs = options[:footnotefontsize] || (is_html_css ? "0.9em" : '9.0pt')
+      b = options[:bodyfont] || "Arial"
+      h = options[:headerfont] || "Arial"
+      m = options[:monospacefont] || "Courier"
+      ns = options[:normalfontsize] || (is_html_css ? "1.0em" : "12.0pt")
+      ms = options[:monospacefontsize] || (is_html_css ? "0.8em" : "11.0pt")
+      ss = options[:smallerfontsize] || (is_html_css ? "0.9em" : "10.0pt")
+      fs = options[:footnotefontsize] || (is_html_css ? "0.9em" : "9.0pt")
       "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"\
         "$normalfontsize: #{ns};\n$monospacefontsize: #{ms};\n"\
         "$smallerfontsize: #{ss};\n$footnotefontsize: #{fs};\n"
     end
 
     def convert_scss(filename, stylesheet, stripwordcss)
-      require 'sassc'
-      require 'isodoc/sassc_importer'
+      require "sassc"
+      require "isodoc/sassc_importer"
 
-      [File.join(Gem.loaded_specs['isodoc'].full_gem_path,
-                 'lib', 'isodoc'),
+      [File.join(Gem.loaded_specs["isodoc"].full_gem_path,
+                 "lib", "isodoc"),
                  File.dirname(filename)].each do |name|
                    SassC.load_paths << name
                  end
@@ -88,15 +91,16 @@ module IsoDoc
     # stripwordcss if HTML stylesheet, !stripwordcss if DOC stylesheet
     def generate_css(filename, stripwordcss)
       return nil if filename.nil?
+
       filename = precompiled_style_or_original(filename)
-      stylesheet = File.read(filename, encoding: 'UTF-8')
+      stylesheet = File.read(filename, encoding: "UTF-8")
       stylesheet = populate_template(stylesheet, :word)
-      stylesheet.gsub!(/(\s|\{)mso-[^:]+:[^;]+;/m, '\\1') if stripwordcss
-      if File.extname(filename) == '.scss'
+      stylesheet.gsub!(/(\s|\{)mso-[^:]+:[^;]+;/m, "\\1") if stripwordcss
+      if File.extname(filename) == ".scss"
         stylesheet = convert_scss(filename, stylesheet, stripwordcss)
       end
-      Tempfile.open([File.basename(filename, '.*'), 'css'],
-                    encoding: 'utf-8') do |f|
+      Tempfile.open([File.basename(filename, ".*"), "css"],
+                    encoding: "utf-8") do |f|
         f.write(stylesheet)
         f
       end

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
 
@@ -24,6 +35,7 @@ module IsoDoc::Function
     def figure_parse(node, out)
       return pseudocode_parse(node, out) if node["class"] == "pseudocode" ||
         node["type"] == "pseudocode"
+
       @in_figure = true
       out.div **figure_attrs(node) do |div|
         node.children.each do |n|
@@ -50,7 +62,8 @@ 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) }
       end
@@ -91,14 +104,15 @@ module IsoDoc::Function
       @annotation = false
     end
 
-    def admonition_class(node)
+    def admonition_class(_node)
       "Admonition"
     end
 
     def admonition_name(node, type)
       name = node&.at(ns("./name")) and return name
-      name = Nokogiri::XML::Node.new('name', node.document)
+      name = Nokogiri::XML::Node.new("name", node.document)
       return unless type && @i18n.admonition[type]
+
       name << @i18n.admonition[type]&.upcase
       name
     end
@@ -119,7 +133,8 @@ module IsoDoc::Function
 
     def formula_where(dl, out)
       return unless dl
-      out.p **{ style: "page-break-after:avoid;"} do |p|
+
+      out.p **{ style: "page-break-after:avoid;" } do |p|
         p << @i18n.where
       end
       parse(dl, out)
@@ -148,6 +163,7 @@ module IsoDoc::Function
         formula_where(node.at(ns("./dl")), div)
         node.children.each do |n|
           next if %w(stem dl name).include? n.name
+
           parse(n, div)
         end
       end
@@ -182,6 +198,7 @@ module IsoDoc::Function
       author = node.at(ns("./author"))
       source = node.at(ns("./source"))
       return if author.nil? && source.nil?
+
       out.p **{ class: "QuoteAttribution" } do |p|
         p << "&mdash; #{author.text}" if author
         p << ", " if author && source
@@ -201,8 +218,9 @@ module IsoDoc::Function
     end
 
     def passthrough_parse(node, out)
-      return if node["format"] and
+      return if node["format"] &&
         !(node["format"].split(/,/).include? @format.to_s)
+
       out.passthrough node.text
     end