isodoc 1.0.25 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0256be2230e0c8757987eb82dee6f8ced68e1cc8794964fabbc446e78d53195
-  data.tar.gz: a8bc10c2952aacf1542b3a4a1edae6c363bee78604dea3c541f9fd769031ea13
+  metadata.gz: 5b5e9597107793ecac111d5706640c399dcdec0411fdf49489c7058cf342bac2
+  data.tar.gz: 0b488bc57ff9c36a418f0012a49d68111a2e5f519a0a5d6191d201db99356526
 SHA512:
-  metadata.gz: b54f7daa32cc4e7e80a560dfd660f76bf4acae581cda2c3b7f89012ab368da2d0951dec308982bea80e07b1e9d59eed1d170aecae686f42b82f31843a9fff4e9
-  data.tar.gz: 75bceea7c655e1bf34de59ed6eb185596966c70b09f4da3c786c80fb57394a8e28c7f87cd47b1a795bee0b5e72d08f372981c587f27e3fb31240a96668cebeaf
+  metadata.gz: 26660b7ac5d08b63f0846c5d8a3caea1f58eed0491c1fcfe83ee3d3b9b3d73da9eaf57636fc48ed84370f12a1dd25e6043b5372750b03d6fc20547be0c6f22f0
+  data.tar.gz: 99fe284cd22c1c19dc3f4528ae057857194b0354f55cf31414b1dbc1d54f9c564b1b45101faaad426c69fb2fb15dd3ae2186d0532a95a1675f5b92f7658d7546

data/.github/workflows/macos.yml

@@ -1,20 +1,26 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
 name: macos
 
 on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-macos:
     name: Test on Ruby ${{ matrix.ruby }} macOS
     runs-on: macos-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -33,6 +39,10 @@ jobs:
       - name: Install Puppeteer
         run: |
           npm install -g puppeteer@3.0.1
+      - name: Install Inkscape
+        run: |
+          brew cask install inkscape
+          inkscape --version
       - name: Run specs
         run: |
           bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -1,20 +1,26 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
 name: ubuntu
 
 on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-linux:
     name: Test on Ruby ${{ matrix.ruby }} Ubuntu
     runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -35,11 +41,17 @@ jobs:
           sudo apt-get update
           sudo apt-get install libgbm1
           npm install -g puppeteer@3.0.1
+      - name: Install Inkscape
+        run: |
+          sudo add-apt-repository ppa:inkscape.dev/stable
+          sudo apt update
+          sudo apt install inkscape
+          inkscape --version
       - name: Run specs
         run: |
           bundle exec rake
       - name: Trigger dependent repositories
-        if: github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/master' && matrix.ruby == '2.6'
         env:
           GH_USERNAME: ${{ secrets.PAT_USERNAME }}
           GH_ACCESS_TOKEN: ${{ secrets.PAT_TOKEN }}

data/.github/workflows/windows.yml

@@ -1,20 +1,26 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
 name: windows
 
 on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
 
 jobs:
   test-windows:
     name: Test on Ruby ${{ matrix.ruby }} Windows
     runs-on: windows-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -35,6 +41,10 @@ jobs:
       - name: Install Puppeteer
         run: |
           npm install -g puppeteer@3.0.1
+      - name: Install Inkscape
+        run: |
+          choco install --no-progress -y inkscape
+          inkscape --version
       - name: Run specs
         run: |
           bundle exec rake

data/isodoc.gemspec

@@ -36,8 +36,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "html2doc", "~> 1.0.0"
   spec.add_dependency "liquid"
   spec.add_dependency "roman-numerals"
-  spec.add_dependency "sassc", "~> 2.2.1"
-  spec.add_dependency "metanorma", "~> 1.0.0"
+  spec.add_dependency "sassc", "~> 2.4.0"
+  spec.add_dependency "metanorma", "~> 1.1.0"
   spec.add_dependency "rake", "~> 12.0"
 
   spec.add_development_dependency "byebug", "~> 9.1"

data/lib/isodoc.rb

@@ -21,6 +21,8 @@ require "isodoc/word_convert"
 require "isodoc/pdf_convert"
 require "isodoc/xslfo_convert"
 require "isodoc/headlesshtml_convert"
+require "isodoc/presentation_xml_convert"
+require "isodoc/xref"
 
 module IsoDoc
 

data/lib/isodoc/common.rb

@@ -9,8 +9,6 @@ require_relative "./function/table"
 require_relative "./function/terms"
 require_relative "./function/to_word_html"
 require_relative "./function/utils"
-require_relative "./function/xref_gen"
-require_relative "./function/xref_sect_gen"
 require_relative "./function/reqt"
 require_relative "./class_utils"
 
@@ -27,8 +25,6 @@ module IsoDoc
     include Function::Terms
     include Function::ToWordHtml
     include Function::Utils
-    include Function::XrefGen
-    include Function::XrefSectGen
 
     extend ::IsoDoc::ClassUtils
   end

data/lib/isodoc/convert.rb

@@ -53,7 +53,6 @@ module IsoDoc
       @termexample = false
       @note = false
       @sourcecode = false
-      @anchors = {}
       @footnotes = []
       @comments = []
       @in_footnote = false
@@ -142,7 +141,7 @@ module IsoDoc
     end
 
     def convert1(docxml, filename, dir)
-      anchor_names docxml
+      @xrefs.parse docxml
       noko do |xml|
         xml.html **{ lang: "#{@lang}" } do |html|
           html.parent.add_namespace("epub", "http://www.idpf.org/2007/ops")
@@ -158,25 +157,36 @@ module IsoDoc
       @meta = Metadata.new(lang, script, labels)
     end
 
-    def convert_init(file, filename, debug)
+    def xref_init(lang, script, klass, labels, options)
+      @xrefs = Xref.new(lang, script, klass, labels, options)
+    end
+
+    def convert_init(file, input_filename, debug)
       docxml = Nokogiri::XML(file)
-      filename, dir = init_file(filename, debug)
+      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)
+      xref_init(lang, script, self, @labels, {})
       [docxml, filename, dir]
     end
 
-    def convert(filename, file = nil, debug = false)
-      file = File.read(filename, encoding: "utf-8") if file.nil?
+    def convert(input_filename, file = nil, debug = false, output_filename = nil)
+      file = File.read(input_filename, encoding: "utf-8") if file.nil?
       @openmathdelim, @closemathdelim = extract_delims(file)
-      docxml, filename, dir = convert_init(file, filename, debug)
+      docxml, filename, dir = convert_init(file, input_filename, debug)
       result = convert1(docxml, filename, dir)
       return result if debug
-      postprocess(result, filename, dir)
+      output_filename ||= "#{filename}.#{@suffix}"
+      postprocess(result, output_filename, dir)
       FileUtils.rm_rf dir
     end
+
+    def middle_clause
+      "//clause[parent::sections][not(xmlns:title = 'Scope')]"\
+      "[not(descendant::terms)]".freeze
+    end
   end
 end

data/lib/isodoc/function/blocks.rb

@@ -1,48 +1,12 @@
-require_relative "blocks_example"
+require_relative "blocks_example_note"
 
 module IsoDoc::Function
   module Blocks
     @annotation = false
 
-    def note_label(node)
-      n = get_anchors[node["id"]]
-      return @note_lbl if n.nil? || n[:label].nil? || n[:label].empty?
-      l10n("#{@note_lbl} #{n[:label]}")
-    end
-
-    def note_p_parse(node, div)
-      div.p do |p|
-        p.span **{ class: "note_label" } do |s|
-          s << note_label(node)
-        end
-        insert_tab(p, 1)
-        node.first_element_child.children.each { |n| parse(n, p) }
-      end
-      node.element_children[1..-1].each { |n| parse(n, div) }
-    end
-
-    def note_parse1(node, div)
-      div.p do |p|
-        p.span **{ class: "note_label" } do |s|
-          s << note_label(node)
-        end
-        insert_tab(p, 1)
-      end
-      node.children.each { |n| parse(n, div) }
-    end
-
-    def note_parse(node, out)
-      @note = true
-      out.div **{ id: node["id"], class: "Note" } do |div|
-        node.first_element_child.name == "p" ?
-          note_p_parse(node, div) : note_parse1(node, div)
-      end
-      @note = false
-    end
-
     def figure_name_parse(node, div, name)
       return if name.nil? && node.at(ns("./figure"))
-      lbl = anchor(node['id'], :label, false)
+      lbl = @xrefs.anchor(node['id'], :label, false)
       lbl = nil if labelled_ancestor(node) && node.ancestors("figure").empty?
       return if lbl.nil? && name.nil?
       div.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
@@ -58,11 +22,15 @@ module IsoDoc::Function
       end
     end
 
+    def figure_attrs(node)
+      attr_code(id: node["id"], class: "figure", style: keep_style(node))
+    end
+
     def figure_parse(node, out)
       return pseudocode_parse(node, out) if node["class"] == "pseudocode" ||
         node["type"] == "pseudocode"
       @in_figure = true
-      out.div **attr_code(id: node["id"], class: "figure") do |div|
+      out.div **figure_attrs(node) do |div|
         node.children.each do |n|
           figure_key(out) if n.name == "dl"
           parse(n, div) unless n.name == "name"
@@ -72,10 +40,14 @@ module IsoDoc::Function
       @in_figure = false
     end
 
+    def pseudocode_attrs(node)
+      attr_code(id: node["id"], class: "pseudocode", style: keep_style(node))
+    end
+
     def pseudocode_parse(node, out)
       @in_figure = true
       name = node.at(ns("./name"))
-      out.div **attr_code(id: node["id"], class: "pseudocode") do |div|
+      out.div **pseudocode_attrs(node) do |div|
         node.children.each { |n| parse(n, div) unless n.name == "name" }
         sourcecode_name_parse(node, div, name)
       end
@@ -83,7 +55,7 @@ module IsoDoc::Function
     end
 
     def sourcecode_name_parse(node, div, name)
-      lbl = anchor(node['id'], :label, false)
+      lbl = @xrefs.anchor(node['id'], :label, false)
       lbl = nil if labelled_ancestor(node)
       return if lbl.nil? && name.nil?
       div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
@@ -101,9 +73,13 @@ module IsoDoc::Function
       end
     end
 
+    def sourcecode_attrs(node)
+      attr_code(id: node["id"], class: "Sourcecode", style: keep_style(node))
+    end
+
     def sourcecode_parse(node, out)
       name = node.at(ns("./name"))
-      out.p **attr_code(id: node["id"], class: "Sourcecode") do |div|
+      out.p **sourcecode_attrs(node) do |div|
         @sourcecode = true
         node.children.each { |n| parse(n, div) unless n.name == "name" }
         @sourcecode = false
@@ -138,10 +114,15 @@ module IsoDoc::Function
       name
     end
 
+    def admonition_attrs(node)
+      attr_code(id: node["id"], class: admonition_class(node),
+                style: keep_style(node))
+    end
+
     def admonition_parse(node, out)
       type = node["type"]
       name = admonition_name(node, type)
-      out.div **{ class: admonition_class(node) } do |t|
+      out.div **admonition_attrs(node) do |t|
         admonition_name_parse(node, t, name) if name
         node.children.each { |n| parse(n, t) unless n.name == "name" }
       end
@@ -157,10 +138,10 @@ module IsoDoc::Function
     end
 
     def formula_parse1(node, out)
-      out.div **attr_code(id: node["id"], class: "formula") do |div|
+      out.div **attr_code(class: "formula") do |div|
         div.p do |p|
           parse(node.at(ns("./stem")), div)
-          lbl = anchor(node['id'], :label, false)
+          lbl = @xrefs.anchor(node['id'], :label, false)
           unless lbl.nil?
             insert_tab(div, 1)
             div << "(#{lbl})"
@@ -169,12 +150,18 @@ module IsoDoc::Function
       end
     end
 
+    def formula_attrs(node)
+      attr_code(id: node["id"], style: keep_style(node))
+    end
+
     def formula_parse(node, out)
-      formula_parse1(node, out)
-      formula_where(node.at(ns("./dl")), out)
-      node.children.each do |n|
-        next if %w(stem dl).include? n.name
-        parse(n, out)
+      out.div **formula_attrs(node) do |div|
+        formula_parse1(node, div)
+        formula_where(node.at(ns("./dl")), div)
+        node.children.each do |n|
+          next if %w(stem dl).include? n.name
+          parse(n, div)
+        end
       end
     end
 
@@ -187,8 +174,9 @@ module IsoDoc::Function
 
     def para_attrs(node)
       attrs = { class: para_class(node), id: node["id"] }
-      node["align"].nil? or
-        attrs[:style] = "text-align:#{node['align']};"
+      s = node["align"].nil? ? "" : "text-align:#{node['align']};"
+      s = "#{s}#{keep_style(node)}"
+      attrs[:style] = s unless s.empty?
       attrs
     end
 
@@ -222,5 +210,11 @@ module IsoDoc::Function
         quote_attribution(node, out)
       end
     end
+
+    def passthrough_parse(node, out)
+      return if node["format"] and
+        !(node["format"].split(/,/).include? @format.to_s)
+      out.passthrough node.text
+    end
   end
 end

data/lib/isodoc/function/blocks_example_note.rb

@@ -0,0 +1,108 @@
+module IsoDoc::Function
+  module Blocks
+    def example_label(node, div, name)
+      n = @xrefs.get[node["id"]]
+      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) }
+      end
+    end
+
+    EXAMPLE_TBL_ATTR =
+      { class: "example_label", style: "width:82.8pt;padding:0 0 0 0;\
+        margin-left:0pt;vertical-align:top;" }.freeze
+
+    def example_div_attr(node)
+      attr_code(id: node["id"], class: "example", style: keep_style(node))
+    end
+
+    # used if we are boxing examples
+    def example_div_parse(node, out)
+      out.div **example_div_attr(node) do |div|
+        example_label(node, div, node.at(ns("./name")))
+        node.children.each do |n|
+          parse(n, div) unless n.name == "name"
+        end
+      end
+    end
+
+    def example_table_attr(node)
+      attr_code(id: node["id"], class: "example",
+                style: "border-collapse:collapse;border-spacing:0;"\
+                "#{keep_style(node)}" )
+    end
+
+    EXAMPLE_TD_ATTR =
+      { style: "vertical-align:top;padding:0;", class: "example" }.freeze
+
+    def example_table_parse(node, out)
+      out.table **example_table_attr(node) do |t|
+        t.tr do |tr|
+          tr.td **EXAMPLE_TBL_ATTR do |td|
+            example_label(node, td, node.at(ns("./name")))
+          end
+          tr.td **EXAMPLE_TD_ATTR do |td|
+            node.children.each { |n| parse(n, td) unless n.name == "name" }
+          end
+        end
+      end
+    end
+
+    def example_parse(node, out)
+      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]}")
+    end
+
+    def note_p_parse(node, div)
+      div.p do |p|
+        p.span **{ class: "note_label" } do |s|
+          s << note_label(node)
+        end
+        insert_tab(p, 1)
+        node.first_element_child.children.each { |n| parse(n, p) }
+      end
+      node.element_children[1..-1].each { |n| parse(n, div) }
+    end
+
+    def note_parse1(node, div)
+      div.p do |p|
+        p.span **{ class: "note_label" } do |s|
+          s << note_label(node)
+        end
+        insert_tab(p, 1)
+      end
+      node.children.each { |n| parse(n, div) }
+    end
+
+    def keep_style(node)
+      ret = ""
+      node["keep-with-next"] == "true" and
+        ret += "page-break-after: avoid;"
+      node["keep-lines-together"] == "true" and
+        ret += "page-break-inside: avoid;"
+      return nil if ret.empty?
+      ret
+    end
+
+    def note_attrs(node)
+      attr_code(id: node["id"], class: "Note", style: keep_style(node))
+    end
+
+    def note_parse(node, out)
+      @note = true
+      out.div **note_attrs(node) do |div|
+        node.first_element_child.name == "p" ?
+          note_p_parse(node, div) : note_parse1(node, div)
+      end
+      @note = false
+    end
+  end
+end