isodoc 1.2.7 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1a16a6af5cb8621eb1dd8e14a2680e7858476d5ffc1007e45566928e9ebaef7
-  data.tar.gz: ef5696d693f602b825457939bfab6f1ccfd827a9f24cbfa975ee6120c603b264
+  metadata.gz: 81eb17e1804dbdda88651d40a5263f265a39f3c5c3eee536ddbb409ee1c206f5
+  data.tar.gz: 62551af56891b80367034f70fd90b909f13b58717999dd0109e67f6974aa9adb
 SHA512:
-  metadata.gz: f3f8718e404915ce3d9d7ad8de1b4f6c0eb6442c930ced3e05c6f1db25ee23324de1783c3fe96e41e86d765a705b7b41df78bd159ff1333f3809ed2682188cc6
-  data.tar.gz: 0ba52d047fb5b1119d1cf485eea60511066f5fec0152222123cedea05f346a7f2276a9ac90aede713d6ae14b3a2be4c5e41267ffdb4ccdff285b5d13350cd26c
+  metadata.gz: 3a933d2ec1665a9853a8ad29a340d718726b9f37c1b8f843feca20bd4ced4f38b89a7b862912e7154e63acd126b58b930b35c57f3ddea9896c52d8517139928d
+  data.tar.gz: 611451fcf174a2594cf3ae73518b33ae2d251b783a8c633c6d571e977731ea1b4113b11492df99cfc879c9c26363fd4b8a8a4decc28f7ecddcd50a3d9d3428a2

data/.github/workflows/rake.yml

@@ -4,7 +4,8 @@ name: rake
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main ]
+    tags: [ v* ]
   pull_request:
 
 jobs:
@@ -31,11 +32,19 @@ jobs:
     steps:
       - uses: actions/checkout@master
 
-      - name: Use Ruby
-        uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
+
+      - uses: actions/cache@v2
+        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'
@@ -57,8 +66,4 @@ jobs:
           choco install --no-progress -y inkscape
           inkscape --version
 
-      - name: Update gems
-        run: bundle install --jobs 4 --retry 3
-
-      - name: Run specs
-        run: bundle exec rake
+      - 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,10 +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.2.0"
   spec.add_dependency "relaton-cli"
-  spec.add_dependency "gyoku", "~> 1.3"
 
   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
@@ -96,3 +97,58 @@ locality: {
                       note: Note,
                       formula: Formula
                     }
+inflection:
+  Clause:
+    sg: Clause
+    pl: Clauses
+  Annex:
+    sg: Annex
+    pl: Annexes
+  Appendix:
+    sg: Appendix
+    pl: Appendixes
+  Note:
+    sg: Note
+    pl: Notes
+  "Note % to entry":
+    sg: Note % to entry
+    pl: Notes % to entry
+  List:
+    sg: List
+    pl: Lists
+  Figure:
+    sg: Figure
+    pl: Figures
+  Formula:
+    sg: Formula
+    pl: Formulas
+  Table:
+    sg: Table
+    pl: Tables
+  Requirement:
+    sg: Requirement
+    pl: Requirements
+  Recommendation:
+    sg: Recommendation
+    pl: Recommendations
+  Permission:
+    sg: Permission
+    pl: Permissions
+  Example:
+    sg: Example
+    pl: Examples
+  Part:
+    sg: Part
+    pl: Parts
+  Section:
+    sg: Section
+    pl: Sections
+  Paragraph:
+    sg: Paragraph
+    pl: Paragraphs
+  Chapter:
+    sg: Chapter
+    pl: Chapters
+  Page:
+    sg: Page
+    pl: Pages

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

@@ -1,5 +1,5 @@
 term_def_boilerplate: 
-scope: Domaine d'application
+scope: Domaine d’application
 symbolsabbrev: Symboles et termes abrégés
 abbrev: Termes abrégés
 symbols: Symboles
@@ -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
@@ -89,3 +90,59 @@ locality: {
                       note: Note,
                       formula: Formule
                     }
+inflection:
+  Clause:
+    sg: Article
+    pl: Articles
+  Annex:
+    sg: Annexe
+    pl: Annexes
+  Appendix:
+    sg: Appendice
+    pl: Appendices
+  Note:
+    sg: Note
+    pl: Notes
+  "Note % à l’article":
+    sg: Note % à l’article
+    pl: Notes % à l’article
+  List:
+    sg: Liste
+    pl: Listes
+  Figure:
+    sg: Figure
+    pl: Figures
+  Formula:
+    sg: Formule
+    pl: Formules
+  Table:
+    sg: Tableau
+    pl: Tableaux
+  Requirement:
+    sg: Exigence
+    pl: Exigences
+  Recommendation:
+    sg: Recommandation
+    pl: Recommandations
+  Permission:
+    sg: Autorisation
+    pl: Autorisations
+  Example:
+    sg: Exemple
+    pl: Exemples
+  Part:
+    sg: Partie
+    pl: Parties
+  Section:
+    sg: Section
+    pl: Sections
+  Paragraph:
+    sg: Alinéa
+    pl: Alinéas
+  Chapter:
+    sg: Chapitre
+    pl: Chapitres
+  Page:
+    sg: Page
+    pl: Pages
+

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/blocks.scss

@@ -50,7 +50,7 @@
   }
 
   background-color: $colorBg;
-  font-size: 0.8em;
+  font-size: $monospacefontsize;
   line-height: 1.6em;
   padding: 1.5em;
   margin: 2em 0 1em 0;
@@ -68,7 +68,7 @@
   }
 
   background-color: $colorBg;
-  font-size: 0.8em;
+  font-size: $monospacefontsize;
   line-height: 1.6em;
   padding: 1.5em;
   margin: 2em 0 1em 0;

data/lib/isodoc/base_style/typography.scss

@@ -56,7 +56,7 @@
 
   &, th, td {
     border: $border;
-    font-size: 0.95em;
+    font-size: 0.95em; // NN 20201115: ??? normalfontsize - 0.05?
   }
   th, td {
     padding: 1em;

data/lib/isodoc/convert.rb

@@ -3,6 +3,7 @@ require "isodoc/common"
 require "fileutils"
 require "tempfile"
 require_relative "i18n"
+require_relative "css"
 
 module IsoDoc
   class Convert < ::IsoDoc::Common
@@ -17,6 +18,10 @@ module IsoDoc
     # wordcoverpage: Cover page for Word
     # htmlintropage: Introductory page for HTML
     # wordintropage: Introductory page for Word
+    # normalfontsize: Font size for body text
+    # smallerfontsize: Font size for smaller than body text
+    # monospacefontsize: Font size for monospace font
+    # footnotefontsize: Font size for footnotes
     # i18nyaml: YAML file for internationalisation of text
     # ulstyle: list style in Word CSS for unordered lists
     # olstyle: list style in Word CSS for ordered lists
@@ -25,8 +30,10 @@ module IsoDoc
     # monospace: font to use for monospace text
     # suppressheadingnumbers: suppress heading numbers for clauses
     # scripts: Scripts file for HTML
-    # scripts_pdf: Scripts file for PDF
+    # 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
     def initialize(options)
       @libdir ||= File.dirname(__FILE__)
       options.merge!(default_fonts(options)) do |_, old, new|
@@ -46,6 +53,10 @@ module IsoDoc
       @wordcoverpage = options[:wordcoverpage]
       @htmlintropage = options[:htmlintropage]
       @wordintropage = options[:wordintropage]
+      @normalfontsize = options[:normalfontsize]
+      @smallerfontsize = options[:smallerfontsize]
+      @monospacefontsize = options[:monospacefontsize]
+      @footnotefontsize = options[:footnotefontsize]
       @scripts = options[:scripts]
       @scripts_pdf = options[:scripts_pdf]
       @i18nyaml = options[:i18nyaml]
@@ -80,62 +91,10 @@ module IsoDoc
       @fn_bookmarks = {}
     end
 
-    # Check if already compiled version(.css) exists,
-    #   if not, return original scss file. During release
-    #   we compile scss into css files in order to not depend on scss
-    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, '.*')
-      compiled_path = File.join(File.dirname(stylesheet_path),
-                                "#{basename}.css")
-      return stylesheet_path unless File.file?(compiled_path)
-
-      compiled_path
-    end
-
-    # run this after @meta is populated
-    def populate_css
-      @htmlstylesheet = generate_css(@htmlstylesheet_name, true)
-      @wordstylesheet = generate_css(@wordstylesheet_name, false)
-      @standardstylesheet = generate_css(@standardstylesheet_name, false)
-    end
-
     def tmpimagedir_suffix
       '_images'
     end
 
-    def default_fonts(_options)
-      {
-        bodyfont: 'Arial',
-        headerfont: 'Arial',
-        monospacefont: 'Courier'
-      }
-    end
-
-    # none for this parent gem, but will be populated in child gems 
-    # which have access to stylesheets &c
-    def default_file_locations(_options)
-      {}
-    end
-
-    def fonts_options
-      {
-        'bodyfont' => options[:bodyfont] || 'Arial',
-        'headerfont' => options[:headerfont] || 'Arial',
-        'monospacefont' => options[:monospacefont] || 'Courier'
-      }
-    end
-
-    def scss_fontheader
-      b = options[:bodyfont] || 'Arial'
-      h = options[:headerfont] || 'Arial'
-      m = options[:monospacefont] || 'Courier'
-      "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
-    end
-
     def html_doc_path(*file)
       file.each do |f|
         ret = File.join(@libdir, File.join('html', f))
@@ -144,37 +103,6 @@ module IsoDoc
       nil
     end
 
-    def convert_scss(filename, stylesheet)
-      require 'sassc'
-      require 'isodoc/sassc_importer'
-
-      [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)
-                   .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
-      if File.extname(filename) == '.scss'
-        stylesheet = convert_scss(filename, stylesheet)
-      end
-      Tempfile.open([File.basename(filename, '.*'), 'css'],
-                    encoding: 'utf-8') do |f|
-        f.write(stylesheet)
-        f
-      end
-    end
-
     def convert1(docxml, filename, dir)
       @xrefs.parse docxml
       noko do |xml|
@@ -229,7 +157,7 @@ module IsoDoc
       FileUtils.rm_rf dir
     end
 
-    def middle_clause
+    def middle_clause(docxml = nil)
       "//clause[parent::sections][not(@type = 'scope')]"\
         '[not(descendant::terms)]'
     end

data/lib/isodoc/css.rb

@@ -0,0 +1,95 @@
+module IsoDoc
+  class Convert < ::IsoDoc::Common
+    # Check if already compiled version(.css) exists,
+    #   if not, return original scss file. During release
+    #   we compile scss into css files in order to not depend on scss
+    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, '.*')
+      compiled_path = File.join(File.dirname(stylesheet_path),
+                                "#{basename}.css")
+      return stylesheet_path unless File.file?(compiled_path)
+      compiled_path
+    end
+
+    # run this after @meta is populated
+    def populate_css
+      @htmlstylesheet = generate_css(@htmlstylesheet_name, true)
+      @wordstylesheet = generate_css(@wordstylesheet_name, false)
+      @standardstylesheet = generate_css(@standardstylesheet_name, false)
+    end
+
+    def default_fonts(_options)
+      {
+        bodyfont: 'Arial',
+        headerfont: 'Arial',
+        monospacefont: 'Courier',
+      }
+    end
+
+    # none for this parent gem, but will be populated in child gems
+    # which have access to stylesheets &c
+    def default_file_locations(_options)
+      {}
+    end
+
+    def fonts_options
+      {
+        'bodyfont' => options[:bodyfont] || 'Arial',
+        'headerfont' => options[:headerfont] || 'Arial',
+        'monospacefont' => options[:monospacefont] || 'Courier',
+        "normalfontsize" => options[:normalfontsize],
+        "monospacefontsize" => options[:monospacefontsize],
+        "smallerfontsize" => options[:smallerfontsize],
+        "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')
+      "$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'
+
+      [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(stripwordcss) + stylesheet,
+                                   syntax: :scss, importer: SasscImporter)
+                   .render
+    end
+
+    # 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 = populate_template(stylesheet, :word)
+      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|
+        f.write(stylesheet)
+        f
+      end
+    end
+  end
+end