isodoc 1.2.8 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 491a322b0df2e6b1c8b4f12e520ca349657a009058b416067acdd5437a16085c
-  data.tar.gz: 1f52844ffdc37875d2b40f8d46f52263abcbe5101c99adaf88d839a28a18ed49
+  metadata.gz: f3c777ea5977413526f9c0178d0460978e495a4292335201d871c1150b0f48ac
+  data.tar.gz: d5a5cbf4385dbdaa4ab65be04bc902853a236d470247d093f35eb3c12fe3cbc4
 SHA512:
-  metadata.gz: ce472eadec9ab44d5739f0e506813cb89cf7de6def2909e8ffd0788cf4fe246bf3433b75c22490528b0287bbfad1e2cc5ca50eeaacdd4156fe9bb32a36e912df
-  data.tar.gz: efb30d195c6a15f97133b76d1d4cac762800fe7620d11a58a2655e7ccd3bc972827d419337cbff13fb7d1c4b96004da7b9d95323ae7d8f6c1eaa07d784f67834
+  metadata.gz: 554df5885f22823b5aaec3453da4695fce9c0c32ee90de6830a4159f8029b070385f2124c9fae5a7082b63688df596f8ea2b39d58297e64f20304b0e40e030cb
+  data.tar.gz: f8adad1944d3062b2ce674c7fb0201f81e6ad4ff43bdd4f43f08429b6cc808f5ab40aa1905473365e3b59d66a6a413a064fdbc20f755c986ed3a763b017fe5b3

data/.github/workflows/rake.yml

@@ -36,7 +36,7 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
 
-      - uses: actions/cache@v1
+      - uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
@@ -67,3 +67,17 @@ jobs:
           inkscape --version
 
       - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - name: Trigger tests passed event
+        uses: Sibz/github-status-action@v1
+        with:
+          authToken: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          context: 'tests-passed-successfully'
+          description: 'Tests passed successfully'
+          state: 'success'
+          sha: ${{ github.event.pull_request.head.sha || github.sha }}

data/isodoc.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciimath"
   spec.add_dependency "htmlentities", "~> 4.3.4"
-  spec.add_dependency "nokogiri", ">= 1.10.4"
+  spec.add_dependency "nokogiri", "~> 1.10.4"
   spec.add_dependency "thread_safe"
   spec.add_dependency "uuidtools"
   spec.add_dependency "html2doc", "~> 1.0.0"

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

@@ -97,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

@@ -90,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/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

data/lib/isodoc/function/inline_simple.rb

@@ -23,7 +23,10 @@ module IsoDoc::Function
     def index_parse(node, out)
     end
 
-        def bookmark_parse(node, out)
+    def index_xref_parse(node, out)
+    end
+
+    def bookmark_parse(node, out)
       out.a **attr_code(id: node["id"])
     end
 
@@ -68,5 +71,11 @@ module IsoDoc::Function
         node.children.each { |n| parse(n, e) }
       end
     end
+
+    def underline_parse(node, out)
+      out.u do |e|
+        node.children.each { |n| parse(n, e) }
+      end
+    end
   end
 end