review 3.0.0 → 4.2.0

data/lib/review/htmlutils.rb

@@ -82,7 +82,7 @@ module ReVIEW
       begin
         require 'pygments'
         begin
-          Pygments.highlight(unescape(body),
+          Pygments.highlight(body,
                              options: options,
                              formatter: format,
                              lexer: lexer)
@@ -128,8 +128,7 @@ module ReVIEW
         return body
       end
 
-      text = unescape(body)
-      formatter.format(lexer.lex(text))
+      formatter.format(lexer.lex(body))
     end
 
     def normalize_id(id)

data/lib/review/i18n.rb

@@ -90,7 +90,7 @@ module ReVIEW
         end
       else
         user_i18n.each do |key, values|
-          raise KeyError, "Invalid locale file: #{path}" unless values.is_a? Hash
+          raise KeyError, "Invalid locale file: #{path}" unless values.is_a?(Hash)
           @store[key].merge!(values)
         end
       end
@@ -165,7 +165,7 @@ module ReVIEW
         end
       end
       remove_args.reverse_each do |idx|
-        args.delete_at idx
+        args.delete_at(idx)
       end
       args_matched = (frmt.count('%') <= args.size)
       frmt.gsub!('##', '%%')

data/lib/review/i18n.yml

@@ -29,6 +29,9 @@ ja:
   ruby_postfix: "）"
   external_link: "%s（%s）"
   label_marker: "●●　"
+  html_footnote_refmark: "*%s"
+  html_footnote_textmark: "[*%s] "
+  html_footnote_backmark: "⏎"
   aut: "著　者"
   csl: "監　修"
   dsr: "デザイン"
@@ -114,6 +117,9 @@ en:
   ruby_prefix: "("
   ruby_postfix: ")"
   label_marker: "●●　"
+  html_footnote_refmark: "*%s"
+  html_footnote_textmark: "[*%s] "
+  html_footnote_backmark: "⏎"
   aut: "Author"
   csl: "Consultant"
   dsr: "Design"
@@ -179,6 +185,9 @@ zh-TW:
   ruby_postfix: "）"
   external_link: "%s (%s)"
   label_marker: "●●　"
+  html_footnote_refmark: "*%s"
+  html_footnote_textmark: "[*%s] "
+  html_footnote_backmark: "⏎"
   aut: "著作人"
   csl: "監　修"
   dsr: "美術編輯"

data/lib/review/idgxmlbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -16,7 +16,9 @@ module ReVIEW
     include TextUtils
     include HTMLUtils
 
-    %i[ttbold hint maru keytop labelref ref].each { |e| Compiler.definline(e) }
+    %i[ttbold hint maru keytop labelref ref strong em].each do |e|
+      Compiler.definline(e)
+    end
     Compiler.defsingle(:dtp, 1)
 
     Compiler.defblock(:insn, 0..1)
@@ -146,6 +148,7 @@ module ReVIEW
 
         @subsubsubsection += 1
         print %Q(<sect4 id="sect:#{@chapter.number}.#{@section}.#{@subsection}.#{@subsubsection}.#{@subsubsubsection}">) if @secttags
+      when 6 # rubocop:disable Lint/EmptyWhen
       else
         raise "caption level too deep or unsupported: #{level}"
       end
@@ -164,7 +167,7 @@ module ReVIEW
     end
 
     def ul_item_begin(lines)
-      print %Q(<li aid:pstyle="ul-item">#{lines.join.chomp})
+      print %Q(<li aid:pstyle="ul-item">#{join_lines_to_paragraph(lines).chomp})
     end
 
     def ul_item_end
@@ -199,7 +202,7 @@ module ReVIEW
     end
 
     def ol_item(lines, num)
-      puts %Q(<li aid:pstyle="ol-item" olnum="#{@ol_num}" num="#{num}">#{lines.join.chomp}</li>)
+      puts %Q(<li aid:pstyle="ol-item" olnum="#{@ol_num}" num="#{num}">#{join_lines_to_paragraph(lines).chomp}</li>)
       @ol_num += 1
     end
 
@@ -221,7 +224,7 @@ module ReVIEW
     end
 
     def dd(lines)
-      puts "<dd>#{lines.join.chomp}</dd>"
+      puts "<dd>#{join_lines_to_paragraph(lines).chomp}</dd>"
     end
 
     def dl_end
@@ -231,12 +234,12 @@ module ReVIEW
     def paragraph(lines)
       if @noindent.nil?
         if lines[0] =~ /\A(\t+)/
-          puts %Q(<p inlist="#{$1.size}">#{lines.join.sub(/\A\t+/, '')}</p>)
+          puts %Q(<p inlist="#{$1.size}">#{join_lines_to_paragraph(lines).sub(/\A\t+/, '')}</p>)
         else
-          puts "<p>#{lines.join}</p>"
+          puts "<p>#{join_lines_to_paragraph(lines)}</p>"
         end
       else
-        puts %Q(<p aid:pstyle="noindent" noindent='1'>#{lines.join}</p>)
+        puts %Q(<p aid:pstyle="noindent" noindent='1'>#{join_lines_to_paragraph(lines)}</p>)
         @noindent = nil
       end
     end
@@ -268,7 +271,6 @@ module ReVIEW
     end
 
     def list_header(id, caption, _lang)
-      puts '<codelist>'
       return true unless caption.present?
       if get_chap.nil?
         puts %Q(<caption>#{I18n.t('list')}#{I18n.t('format_number_without_chapter', [@chapter.list(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
@@ -293,14 +295,20 @@ module ReVIEW
       end
     end
 
+    def list(lines, id, caption, lang = nil)
+      puts '<codelist>'
+      super(lines, id, caption, lang)
+      puts '</codelist>'
+    end
+
     def list_body(_id, lines, _lang)
       print '<pre>'
       codelines_body(lines)
-      puts '</pre></codelist>'
+      print '</pre>'
     end
 
     def emlist(lines, caption = nil, _lang = nil)
-      quotedlist lines, 'emlist', caption
+      quotedlist(lines, 'emlist', caption)
     end
 
     def emlistnum(lines, caption = nil, _lang = nil)
@@ -309,7 +317,13 @@ module ReVIEW
       lines.each_with_index do |line, i|
         lines2 << detab(%Q(<span type='lineno'>) + (i + first_line_num).to_s.rjust(2) + ': </span>' + line)
       end
-      quotedlist lines2, 'emlistnum', caption
+      quotedlist(lines2, 'emlistnum', caption)
+    end
+
+    def listnum(lines, id, caption, lang = nil)
+      puts '<codelist>'
+      super(lines, id, caption, lang)
+      puts '</codelist>'
     end
 
     def listnum_body(lines, _lang)
@@ -328,16 +342,18 @@ module ReVIEW
         print '</listinfo>' if @book.config['listinfo']
         no += 1
       end
-      puts '</pre></codelist>'
+      print '</pre>'
     end
 
     def cmd(lines, caption = nil)
-      quotedlist lines, 'cmd', caption
+      quotedlist(lines, 'cmd', caption)
     end
 
     def quotedlist(lines, css_class, caption)
       print %Q(<list type='#{css_class}'>)
-      puts "<caption aid:pstyle='#{css_class}-title'>#{compile_inline(caption)}</caption>" if caption.present?
+      if caption_top?('list') && caption.present?
+        puts "<caption aid:pstyle='#{css_class}-title'>#{compile_inline(caption)}</caption>"
+      end
       print '<pre>'
       no = 1
       lines.each do |line|
@@ -352,7 +368,11 @@ module ReVIEW
         print '</listinfo>' if @book.config['listinfo']
         no += 1
       end
-      puts '</pre></list>'
+      puts '</pre>'
+      if !caption_top?('list') && caption.present?
+        puts "<caption aid:pstyle='#{css_class}-title'>#{compile_inline(caption)}</caption>"
+      end
+      puts '</list>'
     end
     private :quotedlist
 
@@ -396,20 +416,22 @@ module ReVIEW
     def image_image(id, caption, metric = nil)
       metrics = parse_metric('idgxml', metric)
       puts '<img>'
+      image_header(id, caption) if caption_top?('image')
       puts %Q(<Image href="file://#{@chapter.image(id).path.sub(%r{\A./}, '')}"#{metrics} />)
-      image_header id, caption
+      image_header(id, caption) unless caption_top?('image')
       puts '</img>'
     end
 
     def image_dummy(id, caption, lines)
       puts '<img>'
+      image_header(id, caption) if caption_top?('image')
       print %Q(<pre aid:pstyle="dummyimage">)
       lines.each do |line|
         print detab(line)
         print "\n"
       end
       print '</pre>'
-      image_header id, caption
+      image_header(id, caption) unless caption_top?('image')
       puts '</img>'
       warn "image not bound: #{id}"
     end
@@ -425,96 +447,118 @@ module ReVIEW
 
     def texequation(lines, id = nil, caption = '')
       @texblockequation += 1
+      caption_str = nil
       if id
         puts '<equationblock>'
         if get_chap.nil?
-          puts %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
+          caption_str = %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
         else
-          puts %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
+          caption_str = %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
         end
+        puts caption_str if caption_top?('equation')
       end
 
       puts %Q(<replace idref="texblock-#{@texblockequation}">)
       puts '<pre>'
-      puts lines.join("\n")
+      print lines.join("\n")
       puts '</pre>'
       puts '</replace>'
 
       if id
+        puts caption_str unless caption_top?('equation')
         puts '</equationblock>'
       end
     end
 
     def table(lines, id = nil, caption = nil)
-      tablewidth = @book.config['tableopt'] ? @book.config['tableopt'].split(',')[0].to_f / @book.config['pt_to_mm_unit'].to_f : nil
-      col = 0
+      @tablewidth = nil
+      if @book.config['tableopt']
+        @tablewidth = @book.config['tableopt'].split(',')[0].to_f / @book.config['pt_to_mm_unit'].to_f
+      end
+      @col = 0
 
+      sepidx, rows = parse_table_rows(lines)
       puts '<table>'
-      rows = []
+
+      begin
+        if caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
+
+        if @tablewidth.nil?
+          print '<tbody>'
+        else
+          print %Q(<tbody xmlns:aid5="http://ns.adobe.com/AdobeInDesign/5.0/" aid:table="table" aid:trows="#{rows.length}" aid:tcols="#{@col}">)
+        end
+        @table_id = id
+        table_rows(sepidx, rows)
+        puts '</tbody>'
+
+        if !caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
+      rescue KeyError
+        error "no such table: #{id}"
+      end
+      puts '</table>'
+      @tsize = nil
+    end
+
+    def parse_table_rows(lines)
       sepidx = nil
+      rows = []
       lines.each_with_index do |line, idx|
         if /\A[\=\-]{12}/ =~ line
           sepidx ||= idx
           next
         end
-        if tablewidth
+        if @tablewidth
           rows.push(line.gsub(/\t\.\t/, "\tDUMMYCELLSPLITTER\t").gsub(/\t\.\.\t/, "\t.\t").gsub(/\t\.\Z/, "\tDUMMYCELLSPLITTER").gsub(/\t\.\.\Z/, "\t.").gsub(/\A\./, ''))
         else
           rows.push(line.gsub(/\t\.\t/, "\t\t").gsub(/\t\.\.\t/, "\t.\t").gsub(/\t\.\Z/, "\t").gsub(/\t\.\.\Z/, "\t.").gsub(/\A\./, ''))
         end
-        col2 = rows[rows.length - 1].split(/\t/).length
-        col = col2 if col2 > col
+        col2 = rows[rows.length - 1].split(table_row_separator_regexp).length
+        @col = col2 if col2 > @col
       end
+      error 'no rows in the table' if rows.empty?
+      [sepidx, rows]
+    end
 
+    def table_rows(sepidx, rows)
       cellwidth = []
-      if tablewidth
+      if @tablewidth
         if @tsize.nil?
-          col.times { |n| cellwidth[n] = tablewidth / col }
+          @col.times { |n| cellwidth[n] = @tablewidth / @col }
         else
           cellwidth = @tsize.split(/\s*,\s*/)
           totallength = 0
           cellwidth.size.times do |n|
             cellwidth[n] = cellwidth[n].to_f / @book.config['pt_to_mm_unit'].to_f
             totallength += cellwidth[n]
-            warn "total length exceeds limit for table: #{id}" if totallength > tablewidth
+            warn "total length exceeds limit for table: #{@table_id}" if totallength > @tablewidth
           end
-          if cellwidth.size < col
-            cw = (tablewidth - totallength) / (col - cellwidth.size)
-            warn "auto cell sizing exceeds limit for table: #{id}" if cw <= 0
-            (cellwidth.size..(col - 1)).each { |i| cellwidth[i] = cw }
+          if cellwidth.size < @col
+            cw = (@tablewidth - totallength) / (@col - cellwidth.size)
+            warn "auto cell sizing exceeds limit for table: #{@table_id}" if cw <= 0
+            (cellwidth.size..(@col - 1)).each { |i| cellwidth[i] = cw }
           end
         end
       end
 
-      begin
-        table_header id, caption if caption.present?
-      rescue KeyError
-        error "no such table: #{id}"
-      end
-      return if rows.empty?
-
-      if tablewidth.nil?
-        print '<tbody>'
-      else
-        print %Q(<tbody xmlns:aid5="http://ns.adobe.com/AdobeInDesign/5.0/" aid:table="table" aid:trows="#{rows.length}" aid:tcols="#{col}">)
-      end
-
       if sepidx
         sepidx.times do |y|
-          if tablewidth.nil?
+          if @tablewidth.nil?
             puts %Q(<tr type="header">#{rows.shift}</tr>)
           else
             i = 0
-            rows.shift.split("\t").each_with_index do |cell, x|
+            rows.shift.split(table_row_separator_regexp).each_with_index do |cell, x|
               print %Q(<td xyh="#{x + 1},#{y + 1},#{sepidx}" aid:table="cell" aid:theader="1" aid:crows="1" aid:ccols="1" aid:ccolwidth="#{sprintf('%.3f', cellwidth[i])}">#{cell.sub('DUMMYCELLSPLITTER', '')}</td>)
               i += 1
             end
           end
         end
       end
-      trputs(tablewidth, rows, cellwidth, sepidx)
-      puts '</tbody></table>'
-      @tsize = nil
+      trputs(@tablewidth, rows, cellwidth, sepidx)
     end
 
     def trputs(tablewidth, rows, cellwidth, sepidx)
@@ -522,7 +566,7 @@ module ReVIEW
       if tablewidth
         rows.each_with_index do |row, y|
           i = 0
-          row.split("\t").each_with_index do |cell, x|
+          row.split(table_row_separator_regexp).each_with_index do |cell, x|
             print %Q(<td xyh="#{x + 1},#{y + 1 + sepidx},#{sepidx}" aid:table="cell" aid:crows="1" aid:ccols="1" aid:ccolwidth="#{sprintf('%.3f', cellwidth[i])}">#{cell.sub('DUMMYCELLSPLITTER', '')}</td>)
             i += 1
           end
@@ -560,7 +604,6 @@ module ReVIEW
     end
 
     def table_end
-      print '<?dtp tablerow last?>'
     end
 
     def emtable(lines, caption = nil)
@@ -568,24 +611,29 @@ module ReVIEW
     end
 
     def imgtable(lines, id, caption = nil, metric = nil)
-      if @chapter.image(id).bound?
+      if @chapter.image_bound?(id)
         metrics = parse_metric('idgxml', metric)
         puts '<table>'
-        table_header id, caption if caption.present?
+        if caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
         puts %Q(<imgtable><Image href="file://#{@chapter.image(id).path.sub(%r{\A./}, '')}"#{metrics} /></imgtable>)
+        if !caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
         puts '</table>'
       else
         warn "image not bound: #{id}" if @strict
-        image_dummy id, caption, lines
+        image_dummy(id, caption, lines)
       end
     end
 
     def comment(lines, comment = nil)
-      return true unless @book.config['draft']
+      return unless @book.config['draft']
       lines ||= []
-      lines.unshift comment unless comment.blank?
+      lines.unshift(escape(comment)) unless comment.blank?
       str = lines.join("\n")
-      print "<msg>#{escape(str)}</msg>"
+      print "<msg>#{str}</msg>"
     end
 
     def inline_comment(str)
@@ -689,6 +737,14 @@ module ReVIEW
       %Q(<b>#{escape(str)}</b>)
     end
 
+    def inline_em(str)
+      %Q(<em>#{escape(str)}</em>)
+    end
+
+    def inline_strong(str)
+      %Q(<strong>#{escape(str)}</strong>)
+    end
+
     def inline_tt(str)
       %Q(<tt>#{escape(str)}</tt>)
     end
@@ -970,6 +1026,7 @@ module ReVIEW
     end
 
     def syntaxblock(type, lines, caption)
+      captionstr = nil
       if caption.present?
         titleopentag = %Q(caption aid:pstyle="#{type}-title")
         titleclosetag = 'caption'
@@ -977,9 +1034,13 @@ module ReVIEW
           titleopentag = %Q(floattitle type="insn")
           titleclosetag = 'floattitle'
         end
-        puts %Q(<#{type}><#{titleopentag}>#{compile_inline(caption)}</#{titleclosetag}>)
+        captionstr = %Q(<#{titleopentag}>#{compile_inline(caption)}</#{titleclosetag}>)
+      end
+      print "<#{type}>"
+      if caption_top?('list')
+        puts captionstr
       else
-        puts "<#{type}>"
+        puts ''
       end
 
       no = 1
@@ -995,6 +1056,9 @@ module ReVIEW
         print '</listinfo>' if @book.config['listinfo']
         no += 1
       end
+      unless caption_top?('list')
+        print captionstr
+      end
       puts "</#{type}>"
     end
 
@@ -1009,12 +1073,17 @@ module ReVIEW
     def indepimage(_lines, id, caption = nil, metric = nil)
       metrics = parse_metric('idgxml', metric)
       puts '<img>'
+      if caption_top?('image')
+        puts %Q(<caption>#{compile_inline(caption)}</caption>) if caption.present?
+      end
       begin
         puts %Q(<Image href="file://#{@chapter.image(id).path.sub(%r{\A\./}, '')}"#{metrics} />)
       rescue
         warn %Q(image not bound: #{id})
       end
-      puts %Q(<caption>#{compile_inline(caption)}</caption>) if caption.present?
+      unless caption_top?('image')
+        puts %Q(<caption>#{compile_inline(caption)}</caption>) if caption.present?
+      end
       puts '</img>'
     end
 
@@ -1113,25 +1182,36 @@ module ReVIEW
       error "unknown chapter: #{id}"
     end
 
-    def source_header(caption)
+    def source(lines, caption = nil, lang = nil)
       puts '<source>'
+      if caption_top?('list')
+        source_header(caption)
+      end
+      source_body(lines, lang)
+      unless caption_top?('list')
+        source_header(caption)
+      end
+      puts '</source>'
+    end
+
+    def source_header(caption)
       puts %Q(<caption>#{compile_inline(caption)}</caption>) if caption.present?
     end
 
     def source_body(lines, _lang)
       puts '<pre>'
       codelines_body(lines)
-      puts '</pre></source>'
+      print '</pre>'
     end
 
     def bibpaper(lines, id, caption)
-      bibpaper_header id, caption
-      bibpaper_bibpaper id, caption, lines unless lines.empty?
+      puts %Q(<bibitem id="bib-#{id}">)
+      bibpaper_header(id, caption)
+      bibpaper_bibpaper(id, caption, lines) unless lines.empty?
       puts '</bibitem>'
     end
 
     def bibpaper_header(id, caption)
-      puts %Q(<bibitem id="bib-#{id}">)
       puts "<caption><span type='bibno'>[#{@chapter.bibpaper(id).number}] </span>#{compile_inline(caption)}</caption>" if caption.present?
     end
 
@@ -1146,13 +1226,12 @@ module ReVIEW
     end
 
     def inline_hd_chap(chap, id)
-      if chap.number
-        n = chap.headline_index.number(id)
-        if @book.config['secnolevel'] >= n.split('.').size
-          return I18n.t('hd_quote', [n, compile_inline(chap.headline(id).caption)])
-        end
+      n = chap.headline_index.number(id)
+      if n.present? && chap.number && over_secnolevel?(n)
+        I18n.t('hd_quote', [n, compile_inline(chap.headline(id).caption)])
+      else
+        I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
       end
-      I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
     rescue KeyError
       error "unknown headline: #{id}"
     end