isodoc 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1edc88536663d06a4d23249a6ec1909148185456f84a427fe2299da8e138ab4
-  data.tar.gz: fd6099657296706882b03eb557f59b242c733415b9d49fe8bf4e3aa73bd67eb8
+  metadata.gz: 46206b47756f66c1927ca1810020fbe63141a27f6ad000e95b7938f5b2f8cdcc
+  data.tar.gz: bbce350ccfa6c97bff0c45cccdc15febde0a2c17b1e415fb8132f205ba202d85
 SHA512:
-  metadata.gz: 4112c5b84d25a09e9d701b9735d80e01e9f4bf294288c097524c83e31689dc90c1dd9168e9f70061868d41c032d2b864a96b76b19f0926584a2549a1f5309a63
-  data.tar.gz: b002124056e50a37732ad78fa9e959658b0f07c9f5af9d248f69c0d282cc74804471124fc4b7f150ba19935e3aa904df0d54222fb201e279d6325ebfffe9def8
+  metadata.gz: 7679fe14d35c348ffc9fcda332f27bf39e898337ae5c0cd7a8638e74f1d26a77ca528cad7d210b82f546336b80e0115c4131c49d9cec1ae82a8174d34002ead3
+  data.tar.gz: 20ca1c4d733511fa7f5dc5fe28295c754803b20167e3ae8d39209b1c2d3f63fc064308668a7c23cf834a6a1d93e46ec486931d2c189c0e47210507b32c0291a2

data/.github/workflows/rake.yml

@@ -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,11 +30,11 @@ 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"
-  spec.add_dependency "liquid"
+  spec.add_dependency "liquid", "~> 4"
   spec.add_dependency "twitter_cldr"
   spec.add_dependency "roman-numerals"
   spec.add_dependency "metanorma", "~> 1.2.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/convert.rb

@@ -9,6 +9,7 @@ module IsoDoc
   class Convert < ::IsoDoc::Common
     attr_accessor :options
     attr_accessor :i18n
+    attr_accessor :meta
 
     # htmlstylesheet: Generic stylesheet for HTML
     # wordstylesheet: Generic stylesheet for Word
@@ -157,7 +158,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/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

data/lib/isodoc/function/section.rb

@@ -56,7 +56,7 @@ module IsoDoc::Function
     end
 
     def clause(isoxml, out)
-      isoxml.xpath(ns(middle_clause)).each do |c|
+      isoxml.xpath(ns(middle_clause(isoxml))).each do |c|
         out.div **attr_code(clause_attrs(c)) do |s|
           clause_name(nil, c&.at(ns("./title")), s, nil)
           c.elements.reject { |c1| c1.name == "title" }.each do |c1|

data/lib/isodoc/function/table.rb

@@ -58,11 +58,21 @@ module IsoDoc::Function
       end
     end
 
+    def colgroup(node, t)
+      colgroup = node.at(ns("./colgroup")) or return
+      t.colgroup do |cg|
+        colgroup.xpath(ns("./col")).each do |c|
+          cg.col **{ style: "width: #{c['width']};" }
+        end
+      end
+    end
+
     def table_parse(node, out)
       @in_table = true
       table_title_parse(node, out)
       out.table **table_attrs(node) do |t|
         tcaption(node, t)
+        colgroup(node, t)
         thead_parse(node, t)
         tbody_parse(node, t)
         tfoot_parse(node, t)

data/lib/isodoc/function/to_word_html.rb

@@ -109,7 +109,7 @@ module IsoDoc::Function
       @meta.get
     end
 
-    def middle_title(out)
+    def middle_title(_isoxml, out)
       out.p(**{ class: "zzSTDTitle1" }) { |p| p << @meta.get[:doctitle] }
     end
 
@@ -120,7 +120,7 @@ module IsoDoc::Function
     end
 
     def middle(isoxml, out)
-      middle_title(out)
+      middle_title(isoxml, out)
       middle_admonitions(isoxml, out)
       i = scope isoxml, out, 0
       i = norm_ref isoxml, out, i
@@ -157,6 +157,7 @@ module IsoDoc::Function
         when "sub" then sub_parse(node, out)
         when "tt" then tt_parse(node, out)
         when "strike" then strike_parse(node, out)
+        when "underline" then underline_parse(node, out)
         when "keyword" then keyword_parse(node, out)
         when "smallcap" then smallcap_parse(node, out)
         when "br" then br_parse(node, out)
@@ -215,6 +216,7 @@ 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 "index-xref" then index_xref_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)

data/lib/isodoc/function/utils.rb

@@ -152,8 +152,8 @@ module IsoDoc::Function
     def populate_template(docxml, _format = nil)
       meta = @meta
              .get
-             .merge(@labels || {})
-             .merge(@meta.labels || {})
+             .merge(@labels ? {labels: @labels} : {})
+             .merge(@meta.labels ? {labels: @meta.labels} : {})
              .merge(fonts_options || {})
       template = liquid(docxml)
       template.render(meta.map { |k, v| [k.to_s, empty2nil(v)] }.to_h)
@@ -161,7 +161,7 @@ module IsoDoc::Function
     end
 
     def save_dataimage(uri, _relative_dir = true)
-      %r{^data:image/(?<imgtype>[^;]+);base64,(?<imgdata>.+)$} =~ uri
+      %r{^data:(image|application)/(?<imgtype>[^;]+);base64,(?<imgdata>.+)$} =~ uri
       imgtype.sub!(/\+[a-z0-9]+$/, '') # svg+xml
       imgtype = 'png' unless /^[a-z0-9]+$/.match imgtype
       Tempfile.open(['image', ".#{imgtype}"]) do |f|
@@ -173,7 +173,7 @@ module IsoDoc::Function
     end
 
     def image_localfile(i)
-      if /^data:image/.match? i['src']
+      if /^data:/.match? i['src']
         save_dataimage(i['src'], false)
       elsif %r{^([A-Z]:)?/}.match? i['src']
         i['src']

data/lib/isodoc/gem_tasks.rb

@@ -97,6 +97,10 @@ module IsoDoc
         $bodyfont: '{{bodyfont}}';
         $headerfont: '{{headerfont}}';
         $monospacefont: '{{monospacefont}}';
+        $normalfontsize: '{{normalfontsize}}';
+        $smallerfontsize: '{{smallerfontsize}}';
+        $footnotefontsize: '{{footnotefontsize}}';
+        $monospacefontsize: '{{monospacefontsize}}';
       TEXT
     end
 

data/lib/isodoc/html_function/html.rb

@@ -60,6 +60,7 @@ module IsoDoc::HtmlFunction
     <script type="text/javascript">#{toclevel}</script>
 
     <!--Google fonts-->
+      <link rel="preconnect" href="https://fonts.gstatic.com"> 
       #{googlefonts}
     <!--Font awesome import for the link icon-->
     <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/solid.css" integrity="sha384-v2Tw72dyUXeU3y4aM2Y0tBJQkGfplr39mxZqlTBDUZAb9BGoC40+rdFCG0m10lXk" crossorigin="anonymous">
@@ -110,6 +111,12 @@ module IsoDoc::HtmlFunction
       sourcecode_name_parse(node, out, name)
     end
 
+    def underline_parse(node, out)
+      out.span **{ style: "text-decoration: underline;" } do |e|
+        node.children.each { |n| parse(n, e) }
+      end
+    end
+
     def table_long_strings_cleanup(docxml)
     end
   end

data/lib/isodoc/html_function/mathvariant_to_plain.rb

@@ -0,0 +1,82 @@
+module IsoDoc
+  module HtmlFunction
+    # Class for recursively converting mathvariant text into plain text symbols
+    class MathvariantToPlain
+      MATHML = { "m" => "http://www.w3.org/1998/Math/MathML" }.freeze
+      MATHVARIANT_SPECIAL_CASE_MAPPINGS_1 = %w[bold italic sans-serif]
+        .permutation
+        .each_with_object(:sansbolditalic)
+        .map { |n, y| [n, y] }
+        .to_h
+        .freeze
+      MATHVARIANT_SPECIAL_CASE_MAPPINGS_2 = {
+        %w[bold fraktur] => :frakturbold,
+        %w[bold script] => :scriptbold,
+        %w[sans-serif bold] => :sansbold,
+        %w[sans-serif italic] => :sansitalic,
+        %w[sans-serif bold-italic] => :sansbolditalic,
+        %w[bold-sans-serif italic] => :sansbolditalic,
+        %w[sans-serif-italic bold] => :sansbolditalic,
+      }.freeze
+      MATHVARIANT_TO_PLANE_MAPPINGS = {
+        %w[double-struck] => :doublestruck,
+        %w[bold-fraktur] => :frakturbold,
+        %w[script] => :script,
+        %w[bold-script] => :scriptbold,
+        %w[fraktur] => :fraktur,
+        %w[sans-serif] => :sans,
+        %w[bold-sans-serif] => :sansbold,
+        %w[sans-serif-italic] => :sansitalic,
+        %w[sans-serif-bold-italic] => :sansbolditalic,
+        %w[monospace] => :monospace,
+      }.freeze
+
+      attr_reader :docxml
+
+      # @param [Nokogiri::Document] docxml
+      def initialize(docxml)
+        @docxml = docxml
+      end
+
+      def convert
+        docxml.xpath("//m:math", MATHML).each do |elem|
+          next if nothing_to_style(elem)
+          mathml1(elem)
+        end
+        docxml
+      end
+
+      private
+
+      def nothing_to_style(elem)
+        !elem.at("./*[@mathvariant][not(@mathvariant = 'normal')][not(@mathvariant = 'italic')]")
+      end
+
+      def mathml1(base_elem)
+        MATHVARIANT_SPECIAL_CASE_MAPPINGS_1
+          .merge(MATHVARIANT_SPECIAL_CASE_MAPPINGS_2)
+          .merge(MATHVARIANT_TO_PLANE_MAPPINGS)
+          .each_pair do |mathvariant_list, plain_font|
+            base_elem.xpath(mathvariant_xpath(mathvariant_list)).each do |elem|
+              toPlane(elem, plain_font)
+            end
+          end
+      end
+
+      def mathvariant_xpath(list)
+        list
+          .map { |variant| "//*[@mathvariant = '#{variant}']" }
+          .join
+      end
+
+      def toPlane(elem, font)
+        elem.traverse do |n|
+          next unless n.text?
+
+          n.replace(Plane1Converter.conv(HTMLEntities.new.decode(n.text), font))
+        end
+        elem
+      end
+    end
+  end
+end

data/lib/isodoc/html_function/postprocess.rb

@@ -1,35 +1,47 @@
+require "isodoc/html_function/mathvariant_to_plain"
+
 module IsoDoc::HtmlFunction
   module Html
-    def postprocess(result, filename, dir)
+    def postprocess(result, filename, _dir)
       result = from_xhtml(cleanup(to_xhtml(textcleanup(result))))
       toHTML(result, filename)
       @files_to_delete.each { |f| FileUtils.rm_rf f }
     end
 
     def script_cdata(result)
-      result.gsub(%r{<script([^>]*)>\s*<!\[CDATA\[}m, "<script\\1>").
-        gsub(%r{\]\]>\s*</script>}, "</script>").
-        gsub(%r{<!\[CDATA\[\s*<script([^>]*)>}m, "<script\\1>").
-        gsub(%r{</script>\s*\]\]>}, "</script>")
+      result.gsub(%r{<script([^>]*)>\s*<!\[CDATA\[}m, "<script\\1>")
+        .gsub(%r{\]\]>\s*</script>}, "</script>")
+        .gsub(%r{<!\[CDATA\[\s*<script([^>]*)>}m, "<script\\1>")
+        .gsub(%r{</script>\s*\]\]>}, "</script>")
     end
 
     def toHTML(result, filename)
-      result = (from_xhtml(html_cleanup(to_xhtml(result))))
-      #result = populate_template(result, :html)
+      result = from_xhtml(html_cleanup(to_xhtml(result)))
+      # result = populate_template(result, :html)
       result = from_xhtml(move_images(to_xhtml(result)))
       result = html5(script_cdata(inject_script(result)))
       File.open(filename, "w:UTF-8") { |f| f.write(result) }
     end
 
     def html5(doc)
-      doc.sub(%r{<!DOCTYPE html [^>]+>}, "<!DOCTYPE html>").
-        sub(%r{<\?xml[^>]+>}, "")
+      doc.sub(%r{<!DOCTYPE html [^>]+>}, "<!DOCTYPE html>")
+        .sub(%r{<\?xml[^>]+>}, "")
     end
 
     def html_cleanup(x)
-      footnote_format(footnote_backlinks(html_toc(
-        term_header((html_footnote_filter(html_preface(htmlstyle(x))))))
-                        ))
+      mathml(
+        footnote_format(
+          footnote_backlinks(
+            html_toc(
+              term_header(html_footnote_filter(html_preface(htmlstyle(x))))
+            )
+          )
+        )
+      )
+    end
+
+    def mathml(docxml)
+      IsoDoc::HtmlFunction::MathvariantToPlain.new(docxml).convert
     end
 
     def htmlstylesheet
@@ -76,14 +88,14 @@ module IsoDoc::HtmlFunction
     def html_cover(docxml)
       doc = to_xhtml_fragment(File.read(@htmlcoverpage, encoding: "UTF-8"))
       d = docxml.at('//div[@class="title-section"]')
-      #d.children.first.add_previous_sibling doc.to_xml(encoding: "US-ASCII")
+      # d.children.first.add_previous_sibling doc.to_xml(encoding: "US-ASCII")
       d.children.first.add_previous_sibling populate_template(doc.to_xml(encoding: "US-ASCII"), :html)
     end
 
     def html_intro(docxml)
       doc = to_xhtml_fragment(File.read(@htmlintropage, encoding: "UTF-8"))
       d = docxml.at('//div[@class="prefatory-section"]')
-      #d.children.first.add_previous_sibling doc.to_xml(encoding: "US-ASCII")
+      # d.children.first.add_previous_sibling doc.to_xml(encoding: "US-ASCII")
       d.children.first.add_previous_sibling populate_template(doc.to_xml(encoding: "US-ASCII"), :html)
     end
 
@@ -93,19 +105,19 @@ module IsoDoc::HtmlFunction
     end
 
     def toclevel_classes
-      (1..@htmlToClevels).inject([]) { |m, i| m << "h#{i}" }
+      (1..@htmlToClevels).reduce([]) { |m, i| m << "h#{i}" }
     end
 
     def toclevel
       ret = toclevel_classes.map { |l| "#{l}:not(:empty):not(.TermNum):not(.noTOC)" }
       <<~HEAD.freeze
-    function toclevel() { return "#{ret.join(',')}";}
+        function toclevel() { return "#{ret.join(',')}";}
       HEAD
     end
 
     # needs to be same output as toclevel
     def html_toc(docxml)
-      idx = docxml.at("//div[@id = 'toc']") or return docxml
+      (idx = docxml.at("//div[@id = 'toc']")) or (return docxml)
       toc = "<ul>"
       path = toclevel_classes.map do |l|
         "//main//#{l}[not(@class = 'TermNum')][not(@class = 'noTOC')][text()]"
@@ -125,7 +137,7 @@ module IsoDoc::HtmlFunction
       docxml.xpath("//*[local-name() = 'img']").each do |i|
         i["width"], i["height"] = Html2Doc.image_resize(i, image_localfile(i),
                                                         @maxheight, @maxwidth)
-        next if /^data:image/.match i["src"]
+        next if /^data:/.match i["src"]
         @datauriimage ? datauri(i) : move_image1(i)
       end
       docxml
@@ -133,9 +145,10 @@ module IsoDoc::HtmlFunction
 
     def datauri(i)
       type = i["src"].split(".")[-1]
+      supertype = type == "xml" ? "application" : "image"
       bin = IO.binread(image_localfile(i))
       data = Base64.strict_encode64(bin)
-      i["src"] = "data:image/#{type};base64,#{data}"
+      i["src"] = "data:#{supertype}/#{type};base64,#{data}"
     end
 
     def image_suffix(i)