isodoc 1.2.3 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04b4a5b6d5f00722c0939f1b75ffaeaeb4fc4e7a6f36ebec40e19b93df9f38f1
-  data.tar.gz: 41baee0c2174ce3de7c02afdb1179e6445d37e10233f22b396089e1eb60c1a22
+  metadata.gz: 491a322b0df2e6b1c8b4f12e520ca349657a009058b416067acdd5437a16085c
+  data.tar.gz: 1f52844ffdc37875d2b40f8d46f52263abcbe5101c99adaf88d839a28a18ed49
 SHA512:
-  metadata.gz: '0823e689e87baac6d76bd7b7622a34976418e1da41be9bdeb4a308456ba36a4ec009dc72b59e7b1da0c416c0dbb95f1e6425f436f496540803ac3e4e48baa5f1'
-  data.tar.gz: f48233075744aa6ccc52e743870a5cf8952fe248b67527e913ac0c343a868f19eafe0a3dc3aaeb056dc1f58c12c7b849748f91c548755e586e4f55bcdad84bca
+  metadata.gz: ce472eadec9ab44d5739f0e506813cb89cf7de6def2909e8ffd0788cf4fe246bf3433b75c22490528b0287bbfad1e2cc5ca50eeaacdd4156fe9bb32a36e912df
+  data.tar.gz: efb30d195c6a15f97133b76d1d4cac762800fe7620d11a58a2655e7ccd3bc972827d419337cbff13fb7d1c4b96004da7b9d95323ae7d8f6c1eaa07d784f67834

data/.github/workflows/rake.yml

@@ -0,0 +1,69 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '2.7'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'macos-latest'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - name: Install Inkscape macOS
+        if: matrix.os == 'macos-latest'
+        run: |
+          brew cask install inkscape
+          inkscape --version
+
+      - name: Install Inkscape Ubuntu
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          sudo add-apt-repository ppa:inkscape.dev/stable
+          sudo apt update
+          sudo apt install inkscape
+          inkscape --version
+
+      - name: Install Inkscape Windows
+        if: matrix.os == 'windows-latest'
+        run: |
+          choco install --no-progress -y inkscape
+          inkscape --version
+
+      - run: bundle exec rake

data/README.adoc

@@ -1,9 +1,7 @@
 = isodoc: Processor to generate HTML/Word from Metanorma XML
 
 image:https://img.shields.io/gem/v/isodoc.svg["Gem Version", link="https://rubygems.org/gems/isodoc"]
-image:https://github.com/metanorma/isodoc/workflows/ubuntu/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/isodoc/actions?query=workflow%3Aubuntu"]
-image:https://github.com/metanorma/isodoc/workflows/macos/badge.svg["OSX Build Status", link="https://github.com/metanorma/isodoc/actions?query=workflow%3Amacos"]
-image:https://github.com/metanorma/isodoc/workflows/windows/badge.svg["Windows Build Status", link="https://github.com/metanorma/isodoc/actions?query=workflow%3Awindows"]
+image:https://github.com/metanorma/isodoc/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/isodoc/actions?query=workflow%3Arake"]
 image:https://codeclimate.com/github/metanorma/isodoc/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/isodoc"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/isodoc.svg["Pull Requests", link="https://github.com/metanorma/isodoc/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/isodoc/latest.svg["Commits since latest",link="https://github.com/metanorma/isodoc/releases"]

data/isodoc.gemspec

@@ -35,8 +35,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "uuidtools"
   spec.add_dependency "html2doc", "~> 1.0.0"
   spec.add_dependency "liquid"
+  spec.add_dependency "twitter_cldr"
   spec.add_dependency "roman-numerals"
-  spec.add_dependency "metanorma", "~> 1.1.0"
+  spec.add_dependency "metanorma", "~> 1.2.0"
+  spec.add_dependency "relaton-cli"
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "byebug", "~> 9.1"

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

@@ -36,6 +36,7 @@ external_terms_boilerplate: |
 internal_external_terms_boilerplate: |
           <p>For the purposes of this document, the terms and definitions 
             given in % and the following apply.</p>
+term_defined_in: "[term defined in %]"
 note: NOTE
 note_xref: Note
 termnote: Note % to entry

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

@@ -1,6 +1,6 @@
 term_def_boilerplate: 
-scope: Domaine d'application
-symbolabbrev: Symboles et termes abrégés
+scope: Domaine d’application
+symbolsabbrev: Symboles et termes abrégés
 abbrev: Termes abrégés
 symbols: Symboles
 table_of_contents: Sommaire
@@ -18,20 +18,21 @@ clause: Article
 annex: Annexe
 appendix: Appendice
 no_terms_boilerplate: |
-          <p>Aucun terme n'est defini dans le présent document.</p>
+          <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>
+         <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).
+     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>
+          <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>
+          <p>Pour les besoins du présent document, les termes et définitions de % ainsi que les suivants, s’appliquent.</p>
+term_defined_in: "[terme défini dans %]"
 note: NOTE
 note_xref: Note
-termnote: Note % à l'article
+termnote: Note % à l’article
 figure: Figure
 formula: Formule
 inequality: Formule

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

@@ -31,6 +31,7 @@ external_terms_boilerplate: |
           <p>% 界定的术语和定义适用于本文件。</p>
 internal_external_terms_boilerplate: |
           <p>% 界定的以及下列术语和定义适用于本文件。</p>
+term_defined_in: "〖术语于%中定义〗"
 note: 注
 note_xref: 注
 termnote: 注%

data/lib/isodoc/base_style/all.css

@@ -9,7 +9,7 @@ fieldset, form, label, legend,
 table, caption, tbody, tfoot, thead, tr, th, td,
 article, aside, canvas, details, embed,
 figure, figcaption, footer, header, hgroup,
-menu, nav, output, ruby, section, summary,
+menu, output, ruby, section, summary,
 time, mark, audio, video {
   margin: 0;
   padding: 0; }
@@ -104,6 +104,10 @@ b, strong {
 div.document-stage-band, div.document-type-band {
   background-color: #333333; }
 
+a.FootnoteRef + a.FootnoteRef:before {
+  content: ", ";
+  vertical-align: super; }
+
 #standard-band {
   background-color: #0AC442; }
 

data/lib/isodoc/base_style/metanorma_word.css

@@ -16,6 +16,12 @@ td {
 tr {
   page-break-after: avoid; }
 
+table.MsoISOTableBig tr {
+  page-break-inside: auto; }
+
+table.MsoISOTableBig td {
+  page-break-inside: auto; }
+
 span.stem {
   font-family: "Cambria Math",serif;
   mso-ascii-font-family: "Cambria Math";

data/lib/isodoc/base_style/metanorma_word.scss

@@ -13,6 +13,12 @@ table.MsoISOTable tr
 td { page-break-inside:avoid; }
 tr { page-break-after:avoid; }
 
+table.MsoISOTableBig tr
+    {page-break-inside:auto;}
+
+table.MsoISOTableBig td
+    {page-break-inside:auto;}
+
 span.stem
     {font-family:"Cambria Math",serif;
     mso-ascii-font-family:"Cambria Math";

data/lib/isodoc/base_style/reset.css

@@ -9,7 +9,7 @@ fieldset, form, label, legend,
 table, caption, tbody, tfoot, thead, tr, th, td,
 article, aside, canvas, details, embed,
 figure, figcaption, footer, header, hgroup,
-menu, nav, output, ruby, section, summary,
+menu, output, ruby, section, summary,
 time, mark, audio, video {
   margin: 0;
   padding: 0; }
@@ -103,3 +103,7 @@ b, strong {
 
 div.document-stage-band, div.document-type-band {
   background-color: #333333; }
+
+a.FootnoteRef + a.FootnoteRef:before {
+  content: ", ";
+  vertical-align: super; }

data/lib/isodoc/base_style/reset.scss

@@ -9,7 +9,7 @@ fieldset, form, label, legend,
 table, caption, tbody, tfoot, thead, tr, th, td,
 article, aside, canvas, details, embed,
 figure, figcaption, footer, header, hgroup,
-menu, nav, output, ruby, section, summary,
+menu, output, ruby, section, summary,
 time, mark, audio, video {
   margin: 0;
   padding: 0;
@@ -127,3 +127,8 @@ b, strong {
 div.document-stage-band, div.document-type-band {
   background-color: #333333;
 }
+
+a.FootnoteRef + a.FootnoteRef:before {
+    content: ", ";
+    vertical-align: super;
+  }

data/lib/isodoc/convert.rb

@@ -116,20 +116,7 @@ module IsoDoc
     end
 
     # 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"),
-    #      htmlintropage: html_doc_path("html_rsd_intro.html"),
-    #      scripts: html_doc_path("scripts.html"),
-    #      wordstylesheet: html_doc_path("wordstyle.scss"),
-    #      standardstylesheet: html_doc_path("rsd.scss"),
-    #      header: html_doc_path("header.html"),
-    #      wordcoverpage: html_doc_path("word_rsd_titlepage.html"),
-    #      wordintropage: html_doc_path("word_rsd_intro.html"),
-    #      ulstyle: l3
-    #      olstyle: l2
-    # }
+    # which have access to stylesheets &c
     def default_file_locations(_options)
       {}
     end

data/lib/isodoc/function/blocks.rb

@@ -181,6 +181,7 @@ module IsoDoc::Function
     def quote_attribution(node, out)
       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

data/lib/isodoc/function/inline.rb

@@ -67,19 +67,6 @@ module IsoDoc::Function
       out << "Termbase #{node['base']}, term ID #{node['target']}"
     end
 
-    def concept_parse(node, out)
-      content = node.first_element_child.children.select do |c|
-        !%w{locality localityStack}.include? c.name 
-      end.select { |c| !c.text? || /\S/.match(c) }
-      if content.empty?
-        out << "[Term defined in "
-        parse(node.first_element_child, out)
-        out << "]"
-      else
-        content.each { |n| parse(n, out) }
-      end
-    end
-
     def stem_parse(node, out)
       ooml = if node["type"] == "AsciiMath"
                "#{@openmathdelim}#{HTMLEntities.new.encode(node.text)}"\
@@ -131,25 +118,5 @@ module IsoDoc::Function
         p.b(**{ role: "strong" }) { |e| e << text }
       end
     end
-
-    def variant_parse(node, out)
-      if node["lang"] == @lang && node["script"] == @script
-        node.children.each { |n| parse(n, out) }
-      else
-        return if found_matching_variant_sibling(node)
-        return unless !node.at("./preceding-sibling::xmlns:variant")
-        node.children.each { |n| parse(n, out) }
-      end
-    end
-
-    def found_matching_variant_sibling(node)
-      prev = node.xpath("./preceding-sibling::xmlns:variant")
-      foll = node.xpath("./following-sibling::xmlns:variant")
-      found = false
-      (prev + foll).each do |n|
-        found = true if n["lang"] == @lang && n["script"] == @script
-      end
-      found
-    end
   end
 end

data/lib/isodoc/function/references.rb

@@ -54,7 +54,8 @@ module IsoDoc::Function
     def bibitem_ref_code(b)
       id = b.at(ns("./docidentifier[@type = 'metanorma']"))
       id1 = pref_ref_code(b)
-      id2 = b.at(ns("./docidentifier[@type = 'DOI' or @type = 'ISSN' or @type = 'ISBN']")) 
+      id2 = b.at(ns("./docidentifier[@type = 'DOI' or @type = 'ISSN' or "\
+                    "@type = 'ISBN']")) 
       return [id, id1, id2] if id || id1 || id2
       id = Nokogiri::XML::Node.new("docidentifier", b.document)
       id << "(NO ID)"
@@ -89,7 +90,7 @@ module IsoDoc::Function
     end
 
     def date_note_process(b, ref)
-      date_note = b.at(ns("./note[@type = 'ISO DATE']"))
+      date_note = b.at(ns("./note[@type = 'Unpublished-Status']"))
       return if date_note.nil?
       date_note.children.first.replace("<p>#{date_note.content}</p>")
       footnote_parse(date_note, ref)
@@ -193,7 +194,8 @@ module IsoDoc::Function
     def bibliography_parse(node, out)
       title = node&.at(ns("./title"))&.text || ""
       out.div do |div|
-        clause_parse_title(node, div, node.at(ns("./title")), out, { class: "Section3" })
+        clause_parse_title(node, div, node.at(ns("./title")), out,
+                           { class: "Section3" })
         biblio_list(node, div, true)
       end
     end

data/lib/isodoc/function/table.rb

@@ -82,6 +82,7 @@ module IsoDoc::Function
     def make_tr_attr(td, row, totalrows, header)
       style = td.name == "th" ? "font-weight:bold;" : ""
       td["align"] and style += "text-align:#{td['align']};"
+      td["valign"] and style += "vertical-align:#{td['valign']};"
       rowmax = td["rowspan"] ? row + td["rowspan"].to_i - 1 : row
       style += <<~STYLE
         border-top:#{row.zero? ? "#{SW} 1.5pt;" : 'none;'}

data/lib/isodoc/function/to_word_html.rb

@@ -96,6 +96,7 @@ module IsoDoc::Function
       @meta.subtitle isoxml, out
       @meta.docstatus isoxml, out
       @meta.docid isoxml, out
+      @meta.otherid isoxml, out
       @meta.docnumeric isoxml, out
       @meta.doctype isoxml, out
       @meta.author isoxml, out
@@ -104,6 +105,7 @@ module IsoDoc::Function
       @meta.version isoxml, out
       @meta.url isoxml, out
       @meta.keywords isoxml, out
+      @meta.note isoxml, out
       @meta.get
     end
 
@@ -213,14 +215,13 @@ module IsoDoc::Function
         when "verification" then requirement_component_parse(node, out)
         when "import" then requirement_component_parse(node, out)
         when "index" then index_parse(node, out)
-        when "concept" then concept_parse(node, out)
         when "termref" then termrefelem_parse(node, out)
         when "copyright-statement" then copyright_parse(node, out)
         when "license-statement" then license_parse(node, out)
         when "legal-statement" then legal_parse(node, out)
         when "feedback-statement" then feedback_parse(node, out)
         when "passthrough" then passthrough_parse(node, out)
-        when "variant" then variant_parse(node, out)
+        when "amend" then amend_parse(node, out)
         when "tab" then clausedelimspace(out) # in Presentation XML only
         else
           error_parse(node, out)

data/lib/isodoc/function/utils.rb

@@ -184,7 +184,7 @@ module IsoDoc::Function
 
     def labelled_ancestor(node)
       !node.ancestors('example, requirement, recommendation, permission, '\
-                             'table, figure, sourcecode').empty?
+                             'note, table, figure, sourcecode').empty?
     end
   end
 end

data/lib/isodoc/html_function/postprocess.rb

@@ -221,6 +221,7 @@ module IsoDoc::HtmlFunction
     MATHJAX = <<~"MATHJAX".freeze
       <script type="text/x-mathjax-config">
         MathJax.Hub.Config({
+          "HTML-CSS": { preferredFont: "STIX" },
           asciimath2jax: { delimiters: [['OPEN', 'CLOSE']] }
        });
       </script>

data/lib/isodoc/i18n.rb

@@ -1,12 +1,24 @@
 require "yaml"
 
-# TODO: Cleanup and generalize
 module IsoDoc
   class I18n
     def load_yaml(lang, script, i18nyaml = nil)
       ret = load_yaml1(lang, script)
-      return ret.merge(YAML.load_file(i18nyaml)) if i18nyaml
-      ret
+      return normalise_hash(ret.merge(YAML.load_file(i18nyaml))) if i18nyaml
+      normalise_hash(ret)
+    end
+
+    def normalise_hash(ret)
+      if ret.is_a? Hash 
+        ret.each do |k, v|
+          ret[k] = normalise_hash(v)
+        end
+        ret
+      elsif ret.is_a? Array then ret.map { |n| normalise_hash(n) }
+      elsif ret.is_a? String then ret.unicode_normalize(:nfc) 
+      else
+        ret
+      end
     end
 
     def load_yaml1(lang, script)
@@ -43,55 +55,6 @@ module IsoDoc
       @labels.each do |k, v|
         self.class.send(:define_method, k.downcase) { v }
       end
-=begin
-      @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"]
-      @abstract_lbl = y["abstract"]
-      @termsdef_lbl = y["termsdef"]
-      @termsdefsymbols_lbl = y["termsdefsymbols"]
-      @normref_lbl = y["normref"]
-      @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"]
-      @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"]
-      @list_lbl = y["list"]
-      @formula_lbl = y["formula"]
-      @inequality_lbl = y["inequality"]
-      @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_label"]
-      @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"]
-      @permission_lbl = y["permission"]
-      @recommendation_lbl = y["recommendation"]
-      @requirement_lbl = y["requirement"]
-      @locality = y["locality"]
-      @admonition = y["admonition"]
-=end
     end
 
     def self.l10n(x, lang = @lang, script = @script)
@@ -116,6 +79,14 @@ module IsoDoc
       end
     end
 
+    def multiple_and(names, andword)
+      return '' if names.empty?
+      return names[0] if names.length == 1
+      (names.length == 2) &&
+        (return l10n("#{names[0]} #{andword} #{names[1]}", @lang, @script))
+      l10n(names[0..-2].join(', ') + " #{andword} #{names[-1]}", @lang, @script)
+    end
+
     #module_function :l10n
 
   end