review 5.0.0 → 5.3.0

data/lib/review/htmlbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
 #                         KADO Masanori
 #               2002-2007 Minero Aoki
 #
@@ -42,17 +42,20 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @noindent = nil
       @ol_num = nil
-      @warns = []
-      @errors = []
       @chapter.book.image_types = %w[.png .jpg .jpeg .gif .svg]
       @column = 0
-      @sec_counter = SecCounter.new(5, @chapter)
       @nonum_counter = 0
       @first_line_num = nil
       @body_ext = nil
       @toc = nil
+      @javascripts = []
+      @section_stack = []
+
+      maker = @book.config.maker || 'epubmaker' # for review-compile
+      @use_section = @book.config[maker] && @book.config[maker]['use_section']
     end
     private :builder_init_file
 
@@ -74,9 +77,10 @@ module ReVIEW
       if !File.exist?(layout_file) && File.exist?(File.join(@book.basedir, 'layouts', 'layout.erb'))
         raise ReVIEW::ConfigError, 'layout.erb is obsoleted. Please use layout.html.erb.'
       end
+
       if File.exist?(layout_file)
         if ENV['REVIEW_SAFE_MODE'].to_i & 4 > 0
-          warn %Q(user's layout is prohibited in safe mode. ignored.)
+          warn %Q(user's layout is prohibited in safe mode. ignored.), location: location
           layout_file = File.expand_path(htmlfilename, ReVIEW::Template::TEMPLATE_DIR)
         end
       else
@@ -85,7 +89,35 @@ module ReVIEW
       layout_file
     end
 
+    def use_section?
+      @use_section
+    end
+
+    def open_section(level)
+      result = []
+
+      while @section_stack.size > 0 && level <= @section_stack[-1]
+        result << '</section>'
+        @section_stack.pop
+      end
+      @section_stack.push(level)
+      result << %Q(<section class="level#{level}">)
+
+      return result.join("\n")
+    end
+
+    def close_sections
+      "</section>\n" * @section_stack.size
+    end
+
     def result
+      check_printendnotes
+
+      # flush all `</section>`
+      if use_section?
+        print close_sections
+      end
+
       # default XHTML header/footer
       @title = strip_html(compile_inline(@chapter.title))
       @body = solve_nest(@output.string)
@@ -100,6 +132,11 @@ module ReVIEW
         @toc = ReVIEW::WEBTOCPrinter.book_to_string(@book)
       end
 
+      if @book.config['math_format'] == 'mathjax'
+        @javascripts.push(%Q(<script>MathJax = { tex: { inlineMath: [['\\\\(', '\\\\)']] }, svg: { fontCache: 'global' } };</script>))
+        @javascripts.push(%Q(<script type="text/javascript" id="MathJax-script" async="true" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>))
+      end
+
       ReVIEW::Template.load(layoutfile).result(binding)
     end
 
@@ -126,6 +163,9 @@ module ReVIEW
     end
 
     def headline(level, label, caption)
+      if use_section?
+        print open_section(level)
+      end
       prefix, anchor = headline_prefix(level)
       if prefix
         prefix = %Q(<span class="secno">#{prefix}</span>)
@@ -149,6 +189,7 @@ module ReVIEW
       @nonum_counter += 1
       puts if level > 1
       return unless caption.present?
+
       if label
         puts %Q(<h#{level} id="#{normalize_id(label)}">#{compile_inline(caption)}</h#{level}>)
       else
@@ -164,6 +205,7 @@ module ReVIEW
       @nonum_counter += 1
       puts if level > 1
       return unless caption.present?
+
       if label
         puts %Q(<h#{level} id="#{normalize_id(label)}" notoc="true">#{compile_inline(caption)}</h#{level}>)
       else
@@ -179,6 +221,7 @@ module ReVIEW
       @nonum_counter += 1
       puts '' if level > 1
       return unless caption.present?
+
       if label
         puts %Q(<a id="#{normalize_id(label)}" /><h#{level} id="#{normalize_id(label)}" hidden="true">#{compile_inline(caption)}</h#{level}>)
       else
@@ -603,24 +646,27 @@ module ReVIEW
 
     def texequation_body(lines)
       puts %Q(<div class="equation">)
-      if @book.config['mathml']
-        require 'math_ml'
-        require 'math_ml/symbol/character_reference'
+      if @book.config['math_format'] == 'mathml'
+        begin
+          require 'math_ml'
+          require 'math_ml/symbol/character_reference'
+        rescue LoadError
+          app_error 'not found math_ml'
+        end
         p = MathML::LaTeX::Parser.new(symbol: MathML::Symbol::CharacterReference)
         print p.parse(lines.join("\n") + "\n", true)
-      elsif @book.config['imgmath']
+      elsif @book.config['math_format'] == 'mathjax'
+        puts "$$#{lines.join("\n")}$$"
+      elsif @book.config['math_format'] == 'imgmath'
         fontsize = @book.config['imgmath_options']['fontsize'].to_f
         lineheight = @book.config['imgmath_options']['lineheight'].to_f
         math_str = "\\begin{equation*}\n\\fontsize{#{fontsize}}{#{lineheight}}\\selectfont\n#{lines.join("\n")}\n\\end{equation*}\n"
         key = Digest::SHA256.hexdigest(math_str)
-        math_dir = File.join(@book.config['imagedir'], '_review_math')
-        Dir.mkdir(math_dir) unless Dir.exist?(math_dir)
-        img_path = File.join(math_dir, "_gen_#{key}.#{@book.config['imgmath_options']['format']}")
         if @book.config.check_version('2', exception: false)
-          make_math_image(math_str, img_path)
+          img_path = @img_math.make_math_image(math_str, key)
           puts %Q(<img src="#{img_path}" />)
         else
-          defer_math_image(math_str, img_path, key)
+          img_path = @img_math.defer_math_image(math_str, key)
           puts %Q(<img src="#{img_path}" class="math_gen_#{key}" alt="#{escape(lines.join(' '))}" />)
         end
       else
@@ -663,7 +709,7 @@ module ReVIEW
     end
 
     def image_dummy(id, caption, lines)
-      warn "image not bound: #{id}"
+      warn "image not bound: #{id}", location: location
       puts %Q(<div id="#{normalize_id(id)}" class="image">)
       image_header(id, caption) if caption_top?('image')
       puts %Q(<pre class="dummyimage">)
@@ -727,7 +773,7 @@ module ReVIEW
 
     def imgtable(lines, id, caption = nil, metric = nil)
       unless @chapter.image_bound?(id)
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         image_dummy(id, caption, lines)
         return
       end
@@ -744,7 +790,7 @@ module ReVIEW
           table_header(id, caption)
         end
       rescue KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
 
       puts '</div>'
@@ -761,6 +807,7 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
+
       lines ||= []
       lines.unshift(escape(comment)) unless comment.blank?
       str = lines.join('<br />')
@@ -780,6 +827,22 @@ module ReVIEW
       end
     end
 
+    def endnote_begin
+      puts %Q(<div class="endnotes">)
+    end
+
+    def endnote_end
+      puts %Q(</div>)
+    end
+
+    def endnote_item(id)
+      back = ''
+      if @book.config['epubmaker'] && @book.config['epubmaker']['back_footnote']
+        back = %Q(<a href="#endnoteb-#{normalize_id(id)}">#{I18n.t('html_footnote_backmark')}</a>)
+      end
+      puts %Q(<div class="endnote" id="endnote-#{normalize_id(id)}"><p class="endnote">#{back}#{I18n.t('html_endnote_textmark', @chapter.endnote(id).number)}#{compile_inline(@chapter.endnote(id).content)}</p></div>)
+    end
+
     def indepimage(lines, id, caption = '', metric = nil)
       metrics = parse_metric('html', metric)
       caption = '' unless caption.present?
@@ -799,7 +862,7 @@ EOS
       begin
         puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape(compile_inline(caption))}"#{metrics} />)
       rescue
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         if lines
           puts %Q(<pre class="dummyimage">)
           lines.each do |line|
@@ -852,7 +915,7 @@ EOS
     alias_method :inline_ref, :inline_labelref
 
     def inline_pageref(id)
-      error "pageref op is unsupported on this builder: #{id}"
+      app_error "pageref op is unsupported on this builder: #{id}"
     end
 
     def inline_chapref(id)
@@ -863,7 +926,7 @@ EOS
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_chap(id)
@@ -873,7 +936,7 @@ EOS
         @book.chapter_index.number(id)
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_title(id)
@@ -884,7 +947,7 @@ EOS
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_fn(id)
@@ -894,7 +957,13 @@ EOS
         %Q(<a id="fnb-#{normalize_id(id)}" href="#fn-#{normalize_id(id)}" class="noteref">*#{@chapter.footnote(id).number}</a>)
       end
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
+    end
+
+    def inline_endnote(id)
+      %Q(<a id="endnoteb-#{normalize_id(id)}" href="#endnote-#{normalize_id(id)}" class="noteref" epub:type="noteref">#{I18n.t('html_endnote_refmark', @chapter.endnote(id).number)}</a>)
+    rescue KeyError
+      app_error "unknown endnote: #{id}"
     end
 
     def compile_ruby(base, ruby)
@@ -971,22 +1040,25 @@ EOS
     end
 
     def inline_m(str)
-      if @book.config['mathml']
-        require 'math_ml'
-        require 'math_ml/symbol/character_reference'
+      if @book.config['math_format'] == 'mathml'
+        begin
+          require 'math_ml'
+          require 'math_ml/symbol/character_reference'
+        rescue LoadError
+          app_error 'not found math_ml'
+        end
         parser = MathML::LaTeX::Parser.new(symbol: MathML::Symbol::CharacterReference)
         %Q(<span class="equation">#{parser.parse(str, nil)}</span>)
-      elsif @book.config['imgmath']
+      elsif @book.config['math_format'] == 'mathjax'
+        %Q(<span class="equation">\\( #{str} \\)</span>)
+      elsif @book.config['math_format'] == 'imgmath'
         math_str = '$' + str + '$'
         key = Digest::SHA256.hexdigest(str)
-        math_dir = File.join(@book.config['imagedir'], '_review_math')
-        Dir.mkdir(math_dir) unless Dir.exist?(math_dir)
-        img_path = File.join(math_dir, "_gen_#{key}.#{@book.config['imgmath_options']['format']}")
         if @book.config.check_version('2', exception: false)
-          make_math_image(math_str, img_path)
+          img_path = @img_math.make_math_image(math_str, key)
           %Q(<span class="equation"><img src="#{img_path}" /></span>)
         else
-          defer_math_image(math_str, img_path, key)
+          img_path = @img_math.defer_math_image(math_str, key)
           %Q(<span class="equation"><img src="#{img_path}" class="math_gen_#{key}" alt="#{escape(str)}" /></span>)
         end
       else
@@ -1019,7 +1091,7 @@ EOS
     def inline_bib(id)
       %Q(<a href="#{@book.bib_file.gsub(/\.re\Z/, ".#{@book.config['htmlext']}")}#bib-#{normalize_id(id)}">[#{@chapter.bibpaper(id).number}]</a>)
     rescue KeyError
-      error "unknown bib: #{id}"
+      app_error "unknown bib: #{id}"
     end
 
     def inline_hd_chap(chap, id)
@@ -1030,13 +1102,13 @@ EOS
         str = I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
       end
       if @book.config['chapterlink']
-        anchor = 'h' + n.gsub('.', '-')
+        anchor = 'h' + n.tr('.', '-')
         %Q(<a href="#{chap.id}#{extname}##{anchor}">#{str}</a>)
       else
         str
       end
     rescue KeyError
-      error "unknown headline: #{id}"
+      app_error "unknown headline: #{id}"
     end
 
     def column_label(id, chapter = @chapter)
@@ -1052,7 +1124,7 @@ EOS
         I18n.t('column', compile_inline(chapter.column(id).caption))
       end
     rescue KeyError
-      error "unknown column: #{id}"
+      app_error "unknown column: #{id}"
     end
 
     def inline_list(id)
@@ -1179,7 +1251,7 @@ EOS
       begin
         %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="[#{id}]" />)
       rescue
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         %Q(<pre>missing image: #{id}</pre>)
       end
     end
@@ -1240,35 +1312,5 @@ EOS
     def olnum(num)
       @ol_num = num.to_i
     end
-
-    def make_math_image(str, path, fontsize = 12)
-      # Re:VIEW 2 compatibility
-      fontsize2 = (fontsize * 1.2).round.to_i
-      texsrc = <<-EOB
-\\documentclass[12pt]{article}
-\\usepackage[utf8]{inputenc}
-\\usepackage{amsmath}
-\\usepackage{amsthm}
-\\usepackage{amssymb}
-\\usepackage{amsfonts}
-\\usepackage{anyfontsize}
-\\usepackage{bm}
-\\pagestyle{empty}
-
-\\begin{document}
-\\fontsize{#{fontsize}}{#{fontsize2}}\\selectfont #{str}
-\\end{document}
-      EOB
-      Dir.mktmpdir do |tmpdir|
-        tex_path = File.join(tmpdir, 'tmpmath.tex')
-        dvi_path = File.join(tmpdir, 'tmpmath.dvi')
-        File.write(tex_path, texsrc)
-        cmd = "latex --interaction=nonstopmode --output-directory=#{tmpdir} #{tex_path} && dvipng -T tight -z9 -o #{path} #{dvi_path}"
-        out, status = Open3.capture2e(cmd)
-        unless status.success?
-          error "latex compile error\n\nError log:\n" + out
-        end
-      end
-    end
   end
 end # module ReVIEW

data/lib/review/htmlutils.rb

@@ -134,7 +134,7 @@ module ReVIEW
       elsif id =~ /\A[0-9_.-][a-z0-9_.-]*\Z/i
         "id_#{id}" # dummy prefix
       else
-        "id_#{CGI.escape(id.gsub('_', '__')).gsub('%', '_').gsub('+', '-')}" # escape all
+        "id_#{CGI.escape(id.gsub('_', '__')).tr('%', '_').tr('+', '-')}" # escape all
       end
     end
   end

data/lib/review/i18n.rb

@@ -91,6 +91,7 @@ module ReVIEW
       else
         user_i18n.each do |key, values|
           raise KeyError, "Invalid locale file: #{path}" unless values.is_a?(Hash)
+
           @store[key].merge!(values)
         end
       end

data/lib/review/i18n.yml

@@ -32,6 +32,8 @@ ja:
   html_footnote_refmark: "*%s"
   html_footnote_textmark: "[*%s] "
   html_footnote_backmark: "⏎"
+  html_endnote_refmark: "(%s)"
+  html_endnote_textmark: "(%s) "
   aut: "著　者"
   csl: "監　修"
   dsr: "デザイン"
@@ -120,6 +122,8 @@ en:
   html_footnote_refmark: "*%s"
   html_footnote_textmark: "[*%s] "
   html_footnote_backmark: "⏎"
+  html_endnote_refmark: "(%s)"
+  html_endnote_textmark: "(%s) "
   aut: "Author"
   csl: "Consultant"
   dsr: "Design"
@@ -188,6 +192,8 @@ zh-TW:
   html_footnote_refmark: "*%s"
   html_footnote_textmark: "[*%s] "
   html_footnote_backmark: "⏎"
+  html_endnote_refmark: "(%s)"
+  html_endnote_textmark: "(%s) "
   aut: "著作人"
   csl: "監　修"
   dsr: "美術編輯"