isodoc 1.1.3.pre.alpha2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 595f696067ee780226eb9e657df1786a99e805f58516f43c9c0fcfd0feed5579
-  data.tar.gz: be599ec59b45ffabff696d03eb331613bd08e759ae645d9734af7bae7691095c
+  metadata.gz: 41a0527fbc7f1b53775ff475d0306709ad4ffb42d5aa17ab1907124684d6a891
+  data.tar.gz: ea38f9755d51aef103ca9d63f496a5a12d89211be9e3bd0c48bb5a21409318ca
 SHA512:
-  metadata.gz: 319902ca73d2ad35626d5cad95dee5504e0cd4eeedd759fcf1c64e4739ab749597e7397712e868b262628c902a683d060454fe22e0944c46f9e36497643dbf15
-  data.tar.gz: f14346e3eb2d380e4228ea1beed7e3e08767abf715e08e14165559c84254376446897c91e8d203bd3a1e7422a548575f2e5f16ed604617581b78fd493c9cf640
+  metadata.gz: c54dd45f7dac502a8cb36dcf5cd6c6ec19b7accf8a03d12b7e393d5d284cbc6ed055c4f024a8b643b56fc3fe9c0344b007a491de98dfdc93eb28cc74f7079f35
+  data.tar.gz: c626b8d0a3f08e48d62a082d0f0a33037b06918d3b1d767a8777ec2da04c507a9e16d1ee79827c9911eb8d4242c449fa46cbe1c4fc4ac387fefa1f5a363303fd

data/isodoc.gemspec

@@ -37,8 +37,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "liquid"
   spec.add_dependency "roman-numerals"
   spec.add_dependency "metanorma", "~> 1.1.0"
-  spec.add_dependency "rake", "~> 12.0"
 
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "byebug", "~> 9.1"
   spec.add_development_dependency "sassc", "~> 2.4.0"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

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

@@ -1,10 +1,13 @@
 term_def_boilerplate: 
 scope: Scope
-symbols: Symbols and abbreviated terms
+symbolsabbrev: Symbols and abbreviated terms
+abbrev: Abbreviated terms
+symbols: Symbols
 table_of_contents: Table of contents
 introduction: Introduction
 foreword: Foreword
 abstract: Abstract
+acknowledgements: Acknowledgements
 termsdef: Terms and definitions
 termsdefsymbolsabbrev: Terms, definitions, symbols and abbreviated terms
 termsdefsymbols: Terms, definitions and symbols

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

@@ -1,10 +1,13 @@
 term_def_boilerplate: 
 scope: Domaine d'application
-symbols: Symboles et termes abrégés
+symbolabbrev: Symboles et termes abrégés
+abbrev: Termes abrégés
+symbols: Symboles
 table_of_contents: Sommaire
 introduction: Introduction
 foreword: Avant-propos
 abstract: Résumé
+acknowledgements: Remerciements
 termsdef: Terms et définitions
 termsdefsymbolsabbrev: Terms, définitions, symboles et termes abrégés
 termsdefsymbols: Terms, définitions et symboles

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

@@ -1,10 +1,13 @@
 term_def_boilerplate: 
 scope: 范围
-symbols: 符号、代号和缩略语
+symbolsabbrev: 符号、代号和缩略语
+abbrev: 代号和缩略语
+symbols: 符号
 table_of_contents: 目次
 introduction: 引言
 foreword: 前言
 abstract: 摘要
+acknowledgements: 致謝
 termsdef: 术语和定义
 termsdefsymbolsabbrev: 术语、定义、符号、代号和缩略语
 termsdefsymbols: 术语、定义、符号和代号

data/lib/isodoc.rb

@@ -23,6 +23,7 @@ require "isodoc/xslfo_convert"
 require "isodoc/headlesshtml_convert"
 require "isodoc/presentation_xml_convert"
 require "isodoc/xref"
+require "isodoc/i18n"
 
 module IsoDoc
 

data/lib/isodoc/common.rb

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

data/lib/isodoc/convert.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
-
-require 'isodoc/common'
-require 'fileutils'
-require 'tempfile'
+require "isodoc/common"
+require "fileutils"
+require "tempfile"
+require_relative "i18n"
 
 module IsoDoc
   class Convert < ::IsoDoc::Common
     attr_reader :options
-    attr_accessor :labels
+    attr_accessor :i18n
 
     # htmlstylesheet: Generic stylesheet for HTML
     # wordstylesheet: Generic stylesheet for Word
@@ -38,15 +38,9 @@ module IsoDoc
       @options = options
       @files_to_delete = []
       @tempfile_cache = []
-      @htmlstylesheet_name = precompiled_style_or_original(
-        options[:htmlstylesheet]
-      )
-      @wordstylesheet_name = precompiled_style_or_original(
-        options[:wordstylesheet]
-      )
-      @standardstylesheet_name = precompiled_style_or_original(
-        options[:standardstylesheet]
-      )
+      @htmlstylesheet_name = options[:htmlstylesheet]
+      @wordstylesheet_name = options[:wordstylesheet]
+      @standardstylesheet_name = options[:standardstylesheet]
       @header = options[:header]
       @htmlcoverpage = options[:htmlcoverpage]
       @wordcoverpage = options[:wordcoverpage]
@@ -72,10 +66,10 @@ module IsoDoc
       @in_figure = false
       @seen_footnote = Set.new
       @c = HTMLEntities.new
-      @openmathdelim = '`'
-      @closemathdelim = '`'
-      @lang = 'en'
-      @script = 'Latn'
+      @openmathdelim = "`"
+      @closemathdelim = "`"
+      @lang = options[:language] || "en"
+      @script = options[:script] || "Latn"
       @maxwidth = 1200
       @maxheight = 800
       @wordToClevels = options[:doctoclevels].to_i
@@ -121,8 +115,8 @@ module IsoDoc
       }
     end
 
-    # none for this parent gem, but will be populated in child
-    #   gems which have access to stylesheets &c; e.g.
+    # none for this parent gem, but will be populated in child gems 
+    # which have access to stylesheets &c; e.g.
     # {
     #      htmlstylesheet: html_doc_path("htmlstyle.scss"),
     #      htmlcoverpage: html_doc_path("html_rsd_titlepage.html"),
@@ -155,8 +149,12 @@ module IsoDoc
       "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
     end
 
-    def html_doc_path(file)
-      File.join(@libdir, File.join('html', file))
+    def html_doc_path(*file)
+      file.each do |f|
+        ret = File.join(@libdir, File.join('html', f))
+        File.exist?(ret) and return ret
+      end
+      nil
     end
 
     def convert_scss(filename, stylesheet)
@@ -165,17 +163,18 @@ module IsoDoc
 
       [File.join(Gem.loaded_specs['isodoc'].full_gem_path,
                  'lib', 'isodoc'),
-       File.dirname(filename)].each do |name|
-        SassC.load_paths << name
-      end
-      SassC::Engine.new(scss_fontheader + stylesheet, syntax: :scss,
-                                                      importer: SasscImporter)
+                 File.dirname(filename)].each do |name|
+                   SassC.load_paths << name
+                 end
+                 SassC::Engine.new(scss_fontheader + stylesheet, syntax: :scss,
+                                   importer: SasscImporter)
                    .render
     end
 
     def generate_css(filename, stripwordcss)
       return nil if filename.nil?
 
+      filename = precompiled_style_or_original(filename)
       stylesheet = File.read(filename, encoding: 'UTF-8')
       stylesheet = populate_template(stylesheet, :word)
       stylesheet.gsub!(/(\s|\{)mso-[^:]+:[^;]+;/m, '\\1') if stripwordcss
@@ -202,32 +201,38 @@ module IsoDoc
       end.join("\n")
     end
 
-    def metadata_init(lang, script, labels)
-      @meta = Metadata.new(lang, script, labels)
+    def metadata_init(lang, script, i18n)
+      @meta = Metadata.new(lang, script, i18n)
+    end
+
+    def xref_init(lang, script, _klass, i18n, options)
+      html = HtmlConvert.new(language: @lang, script: @script)
+      @xrefs = Xref.new(lang, script, html, i18n, options)
+    end
+
+    def i18n_init(lang, script, i18nyaml = nil)
+      @i18n = I18n.new(lang, script, i18nyaml || @i18nyaml)
     end
 
-    def xref_init(lang, script, klass, labels, options)
-      @xrefs = Xref.new(lang, script, klass, labels, options)
+    def l10n(x, lang = @lang, script = @script)
+      @i18n.l10n(x, lang, script)
     end
 
     def convert_init(file, input_filename, debug)
       docxml = Nokogiri::XML(file)
       filename, dir = init_file(input_filename, debug)
-      docxml.root.default_namespace = ''
-      lang = docxml&.at(ns('//bibdata/language'))&.text || @lang
-      script = docxml&.at(ns('//bibdata/script'))&.text || @script
-      i18n_init(lang, script)
-      metadata_init(lang, script, @labels)
-      @meta.fonts_options = fonts_options
-      xref_init(lang, script, self, @labels, {})
+      docxml.root.default_namespace = ""
+      lang = docxml&.at(ns("//bibdata/language"))&.text and @lang = lang
+      script = docxml&.at(ns("//bibdata/script"))&.text and @script = script
+      i18n_init(@lang, @script)
+      metadata_init(@lang, @script, @i18n)
+      xref_init(@lang, @script, self, @i18n, {})
       [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?
+      file = File.read(input_filename, encoding: "utf-8") if file.nil?
       @openmathdelim, @closemathdelim = extract_delims(file)
       docxml, filename, dir = convert_init(file, input_filename, debug)
       result = convert1(docxml, filename, dir)
@@ -238,8 +243,8 @@ module IsoDoc
     end
 
     def middle_clause
-      "//clause[parent::sections][not(xmlns:title = 'Scope')]"\
-      '[not(descendant::terms)]'
+      "//clause[parent::sections][not(@type = 'scope')]"\
+        '[not(descendant::terms)]'
     end
   end
 end

data/lib/isodoc/function/blocks.rb

@@ -5,20 +5,15 @@ module IsoDoc::Function
     @annotation = false
 
     def figure_name_parse(node, div, name)
-      return if name.nil? && node.at(ns("./figure"))
-      lbl = @xrefs.anchor(node['id'], :label, false)
-      lbl = nil if labelled_ancestor(node) && node.ancestors("figure").empty?
-      return if lbl.nil? && name.nil?
+      return if name.nil? 
       div.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
-        lbl.nil? or p << l10n("#{@figure_lbl} #{lbl}")
-        name and !lbl.nil? and p << "&nbsp;&mdash; "
-        name and name.children.each { |n| parse(n, div) }
+        name.children.each { |n| parse(n, div) }
       end
     end
 
     def figure_key(out)
       out.p **{ style: "page-break-after:avoid;"} do |p|
-        p.b { |b| b << @key_lbl }
+        p.b { |b| b << @i18n.key }
       end
     end
 
@@ -55,15 +50,9 @@ module IsoDoc::Function
     end
 
     def sourcecode_name_parse(node, div, name)
-      lbl = @xrefs.anchor(node['id'], :label, false)
-      lbl = nil if labelled_ancestor(node)
-      return if lbl.nil? && name.nil?
+      return if name.nil? 
       div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
-        if node.ancestors("example").empty?
-          lbl.nil? or p << l10n("#{@figure_lbl} #{lbl}")
-          name and !lbl.nil? and p << "&nbsp;&mdash; "
-        end
-        name&.children&.each { |n| parse(n, p) }
+        name.children.each { |n| parse(n, p) }
       end
     end
 
@@ -109,8 +98,8 @@ module IsoDoc::Function
     def admonition_name(node, type)
       name = node&.at(ns("./name")) and return name
       name = Nokogiri::XML::Node.new('name', node.document)
-      return unless type && @admonition[type]
-      name << @admonition[type]&.upcase
+      return unless type && @i18n.admonition[type]
+      name << @i18n.admonition[type]&.upcase
       name
     end
 
@@ -131,7 +120,7 @@ module IsoDoc::Function
     def formula_where(dl, out)
       return unless dl
       out.p **{ style: "page-break-after:avoid;"} do |p|
-        p << @where_lbl
+        p << @i18n.where
       end
       parse(dl, out)
       out.parent.at("./dl")["class"] = "formula_dl"
@@ -141,8 +130,7 @@ module IsoDoc::Function
       out.div **attr_code(class: "formula") do |div|
         div.p do |p|
           parse(node.at(ns("./stem")), div)
-          lbl = @xrefs.anchor(node['id'], :label, false)
-          unless lbl.nil?
+          if lbl = node&.at(ns("./name"))&.text
             insert_tab(div, 1)
             div << "(#{lbl})"
           end
@@ -159,7 +147,7 @@ module IsoDoc::Function
         formula_parse1(node, div)
         formula_where(node.at(ns("./dl")), div)
         node.children.each do |n|
-          next if %w(stem dl).include? n.name
+          next if %w(stem dl name).include? n.name
           parse(n, div)
         end
       end

data/lib/isodoc/function/blocks_example_note.rb

@@ -1,13 +1,9 @@
 module IsoDoc::Function
   module Blocks
     def example_label(node, div, name)
-      n = @xrefs.get[node["id"]]
+      return if name.nil?
       div.p **{ class: "example-title" } do |p|
-        lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @example_lbl :
-          l10n("#{@example_lbl} #{n[:label]}")
-        p << lbl
-        name and !lbl.nil? and p << "&nbsp;&mdash; "
-        name and name.children.each { |n| parse(n, div) }
+        name.children.each { |n| parse(n, div) }
       end
     end
 
@@ -55,16 +51,16 @@ module IsoDoc::Function
       example_div_parse(node, out)
     end
 
-    def note_label(node)
-      n = @xrefs.get[node["id"]]
-      return @note_lbl if n.nil? || n[:label].nil? || n[:label].empty?
-      l10n("#{@note_lbl} #{n[:label]}")
+    def note_delim
+      ""
     end
 
     def note_p_parse(node, div)
+      name = node&.at(ns("./name"))&.remove
       div.p do |p|
-        p.span **{ class: "note_label" } do |s|
-          s << note_label(node)
+        name and p.span **{ class: "note_label" } do |s|
+          name and name.children.each { |n| parse(n, s) }
+          s << note_delim
         end
         insert_tab(p, 1)
         node.first_element_child.children.each { |n| parse(n, p) }
@@ -73,9 +69,11 @@ module IsoDoc::Function
     end
 
     def note_parse1(node, div)
-      div.p do |p|
+      name = node&.at(ns("./name"))&.remove
+      name and div.p do |p|
         p.span **{ class: "note_label" } do |s|
-          s << note_label(node)
+          name.children.each { |n| parse(n, s) }
+          s << note_delim
         end
         insert_tab(p, 1)
       end
@@ -99,7 +97,8 @@ module IsoDoc::Function
     def note_parse(node, out)
       @note = true
       out.div **note_attrs(node) do |div|
-        node.first_element_child.name == "p" ?
+        node&.at(ns("./*[local-name() != 'name'][1]"))&.name == "p" ?
+        #node.first_element_child.name == "p" ?
           note_p_parse(node, div) : note_parse1(node, div)
       end
       @note = false

data/lib/isodoc/function/cleanup.rb

@@ -7,10 +7,10 @@ module IsoDoc::Function
     def termref_cleanup(docxml)
       docxml.
         gsub(%r{\s*\[/TERMREF\]\s*</p>\s*<p>\s*\[TERMREF\]}, "; ").
-        gsub(/\[TERMREF\]\s*/, l10n("[#{@source_lbl}: ")).
-        gsub(/\s*\[MODIFICATION\]\s*\[\/TERMREF\]/, l10n(", #{@modified_lbl} [/TERMREF]")).
+        gsub(/\[TERMREF\]\s*/, l10n("[#{@i18n.source}: ")).
+        gsub(/\s*\[MODIFICATION\]\s*\[\/TERMREF\]/, l10n(", #{@i18n.modified} [/TERMREF]")).
         gsub(%r{\s*\[\/TERMREF\]\s*}, l10n("]")).
-        gsub(/\s*\[MODIFICATION\]/, l10n(", #{@modified_lbl} &mdash; "))
+        gsub(/\s*\[MODIFICATION\]/, l10n(", #{@i18n.modified} &mdash; "))
     end
 
     def passthrough_cleanup(docxml)
@@ -21,6 +21,7 @@ module IsoDoc::Function
     end
 
     def cleanup(docxml)
+      @i18n ||= i18n_init(@lang, @script) 
       comment_cleanup(docxml)
       footnote_cleanup(docxml)
       inline_header_cleanup(docxml)
@@ -80,7 +81,7 @@ module IsoDoc::Function
     def figure_get_or_make_dl(t)
       dl = t.at(".//dl")
       if dl.nil?
-        t.add_child("<p><b>#{@key_lbl}</b></p><dl></dl>")
+        t.add_child("<p><b>#{@i18n.key}</b></p><dl></dl>")
         dl = t.at(".//dl")
       end
       dl

data/lib/isodoc/function/inline.rb

@@ -16,85 +16,16 @@ module IsoDoc::Function
       out << " &lt;#{node.text}&gt;"
     end
 
-    def prefix_container(container, linkend, _target)
-      l10n(@xrefs.anchor(container, :xref) + ", " + linkend)
-    end
-
-    def anchor_linkend(node, linkend)
-      if node["citeas"].nil? && node["bibitemid"] 
-        return @xrefs.anchor(node["bibitemid"] ,:xref) || "???"
-      elsif node["target"] && !/.#./.match(node["target"])
-        linkend = @xrefs.anchor(node["target"], :xref)
-        container = @xrefs.anchor(node["target"], :container, false)
-        (container && get_note_container_id(node) != container &&
-         @xrefs.get[node["target"]]) &&
-        linkend = prefix_container(container, linkend, node["target"])
-        linkend = capitalise_xref(node, linkend)
+    def no_locality_parse(node, out)
+      node.children.each do |n|
+        parse(n, out) unless %w{locality localityStack}.include? n.name
       end
-      linkend || "???"
-    end
-
-    def capitalise_xref(node, linkend)
-      return linkend unless %w(Latn Cyrl Grek).include? @script
-      return linkend&.capitalize if node["case"] == "capital"
-      return linkend&.downcase if node["case"] == "lowercase"
-      return linkend if linkend[0,1].match(/\p{Upper}/)
-      prec = nearest_block_parent(node).xpath("./descendant-or-self::text()") &
-        node.xpath("./preceding::text()")
-      (prec.empty? || /(?!<[^.].)\.\s+$/.match(prec.map { |p| p.text }.join)) ?
-        linkend&.capitalize : linkend
-    end
-
-    def nearest_block_parent(node)
-      until %w(p title td th name formula 
-        li dt dd sourcecode pre).include?(node.name)
-        node = node.parent
-      end
-      node
-    end
-
-    def get_linkend(node)
-      contents = node.children.select do |c|
-        !%w{locality localityStack}.include? c.name 
-      end.select { |c| !c.text? || /\S/.match(c) }
-      !contents.empty? and
-        return Nokogiri::XML::NodeSet.new(node.document, contents).to_xml
-      link = anchor_linkend(node, docid_l10n(node["target"] || node["citeas"]))
-      link + eref_localities(node.xpath(ns("./locality | ./localityStack")),
-                             link)
-      # so not <origin bibitemid="ISO7301" citeas="ISO 7301">
-      # <locality type="section"><reference>3.1</reference></locality></origin>
     end
 
     def xref_parse(node, out)
       target = /#/.match(node["target"]) ? node["target"].sub(/#/, ".html#") :
         "##{node["target"]}"
-        out.a(**{ "href": target }) { |l| l << get_linkend(node) }
-    end
-
-    def eref_localities(refs, target)
-      ret = ""
-      refs.each_with_index do |r, i|
-        delim = ","
-        delim = ";" if r.name == "localityStack" && i>0
-        if r.name == "localityStack"
-          r.elements.each_with_index do |rr, j|
-            ret += eref_localities0(rr, j, target, delim)
-            delim = ","
-          end
-        else
-          ret += eref_localities0(r, i, target, delim)
-        end
-      end
-      ret
-    end
-
-    def eref_localities0(r, i, target, delim)
-      if r["type"] == "whole" then l10n("#{delim} #{@wholeoftext_lbl}")
-      else
-        eref_localities1(target, r["type"], r.at(ns("./referenceFrom")),
-                         r.at(ns("./referenceTo")), delim, @lang)
-      end
+        out.a(**{ "href": target }) { |l| no_locality_parse(node, l) }
     end
 
     def suffix_url(url)
@@ -114,14 +45,13 @@ module IsoDoc::Function
     end
 
     def eref_parse(node, out)
-      linkend = get_linkend(node)
       href = eref_target(node)
       if node["type"] == "footnote"
         out.sup do |s|
-          s.a(**{ "href": href }) { |l| l << linkend }
+          s.a(**{ "href": href }) { |l| no_locality_parse(node, l) }
         end
       else
-        out.a(**{ "href": href }) { |l| l << linkend }
+        out.a(**{ "href": href }) { |l| no_locality_parse(node, l) }
       end
     end