review 4.1.0 → 4.2.0

data/doc/quickstart.ja.md

@@ -8,7 +8,7 @@ Re:VIEW は GNU Lesser General Public License Version 2.1 に基づいて配布
 
 このドキュメントでは、Re:VIEW のセットアップから変換の例までを簡単に説明します。
 
-このドキュメントは、Re:VIEW 4.0 に基づいています。
+このドキュメントは、Re:VIEW 4.2 に基づいています。
 
 ## セットアップ
 
@@ -217,19 +217,22 @@ $ review-preproc --replace ファイル ←ファイルを更新したもので
 $ review-vol
 ```
 
-より細かな見出し一覧などを出したいときには、review-index コマンドを使うのもよいでしょう。
+より細かな見出し一覧などを出したいときには、review-index コマンドを使うとよいでしょう。
 
 ```bash
-$ review-index --level 掘り下げる見出しレベル数 -a
+$ review-index -l 掘り下げる見出しレベル数
+$ review-index -l 掘り下げる見出しレベル数 -d ←分量の詳細を表示
 ```
 
+review-vol と review-index では、文字数や行数、見込みページなど各値に大きな差が出ることがあります。これは、review-vol がごく簡単にファイルから概算しているのに対し、review-index は実際に内部でコンパイルして比較的精密に計量しているからです。
+
 ## プロジェクトフォルダを新しい Re:VIEW バージョンに追従する方法
 
 Re:VIEW は定期的に更新されています。おおむね後方互換性を保持していますが、新しいバージョン固有の機能を利用したいときには、プロジェクトフォルダを新しいバージョンに更新する review-update コマンドを利用します。
 
 ```bash
 $ review-update
-** review-update はプロジェクトを 4.0.0 に更新します **
+** review-update はプロジェクトを 4.1.0 に更新します **
 config.yml: 'review_version' を '4.0' に更新しますか? [y]/n ←Enterで実行
 Rakefile は Re:VIEW バージョンのもの (/.../review/samples/sample-book/src/Rakefile) で置き換えられます。本当に進めますか? [y]/n
 lib/tasks/review.rake は Re:VIEW バージョンのもの (/.../review/samples/sample-book/src/lib/tasks/review.rake) で置き換えられます。本当に進めますか? [y]/n
@@ -246,7 +249,7 @@ INFO: 新しいファイル /.../sty/gentombow.sty が作成されました。
 
 ## クレジット
 
-Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2019年12月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
+Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2020年3月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
 
 バグ・パッチの報告、その他の情報は、
 

data/doc/quickstart.md

@@ -9,7 +9,7 @@ Re:VIEW is free software under the terms of the GNU Lesser General Public Licens
 
 This article describes how to setup Re:VIEW and use it.
 
-The supported version of the article is Re:VIEW 4.0.
+The supported version of the article is Re:VIEW 4.2.
 
 ## Set up Re:VIEW
 
@@ -223,16 +223,19 @@ $ review-vol
 You can also use `review-index` command to generate header list.
 
 ```bash
-$ review-index --level <heading level> -a
+$ review-index --level <heading level>
+$ review-index --level <heading level> -d  ## show volumes also
 ```
 
+review-vol and review-index can have large differences in the number of characters, lines, and pages. While review-vol only estimates from the file, review-index actually compiles and calculates.
+
 ## how to update the document folder to the new Re:VIEW version
 
 Re:VIEW is updated regularly. We Re:VIEW team watch the backward compatibility carefully, but if you want to use the features in the new version, you can use review-update command to update the project folder.
 
 ```bash
 $ review-update
-** review-update updates your project to 4.0.0 **
+** review-update updates your project to 4.1.0 **
 config.yml: Update 'review_version' to '4.0'? [y]/n
 Rakefile will be overridden with Re:VIEW version (/.../review/samples/sample-book/src/Rakefile). Do you really proceed? [y]/n
 lib/tasks/review.rake will be overridden with Re:VIEW version (/.../review/samples/sample-book/src/lib/tasks/review.rake). Do you really proceed? [y]/n
@@ -249,7 +252,7 @@ Finished.
 
 ## Copyright
 
-The original author of Re:VIEW is Minero Aoki. The current maintainer is Kenshi Muto(@kmuto), and committers are Masayoshi Takahashi and Masanori Kado (December 2019).
+The original author of Re:VIEW is Minero Aoki. The current maintainer is Kenshi Muto(@kmuto), and committers are Masayoshi Takahashi and Masanori Kado (March 2020).
 
 If you want to report bugs and patches, or to get more information, see:
 

data/lib/review/book/base.rb

@@ -79,7 +79,7 @@ module ReVIEW
       def page_metric
         if config['page_metric'].respond_to?(:downcase) && config['page_metric'].upcase =~ /\A[A-Z0-9_]+\Z/
           ReVIEW::Book::PageMetric.const_get(config['page_metric'].upcase)
-        elsif config['page_metric'].is_a?(Array) && config['page_metric'].size == 5
+        elsif config['page_metric'].is_a?(Array) && (config['page_metric'].size == 5 || config['page_metric'].size == 4)
           ReVIEW::Book::PageMetric.new(*config['page_metric'])
         else
           config['page_metric']
@@ -175,9 +175,7 @@ module ReVIEW
       end
 
       def volume
-        vol = Volume.sum(chapters.map(&:volume))
-        vol.page_per_kbyte = page_metric.page_per_kbyte
-        vol
+        Volume.sum(parts.map(&:volume) + chapters.map(&:volume))
       end
 
       def load_config(filename)

data/lib/review/book/compilable.rb

@@ -52,11 +52,7 @@ module ReVIEW
       end
 
       def volume
-        unless @volume
-          @volume = Volume.count_file(path)
-          @volume.page_per_kbyte = @book.page_metric.page_per_kbyte
-        end
-        @volume
+        @volume ||= Volume.count_file(path)
       end
 
       def lines

data/lib/review/book/page_metric.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2020 Minero Aoki, Kenshi Muto
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -11,21 +11,21 @@ module ReVIEW
     class PageMetric
       MetricData = Struct.new(:n_lines, :n_columns)
 
-      def initialize(list_lines, list_columns, text_lines, text_columns, page_per_kbyte)
+      def initialize(list_lines, list_columns, text_lines, text_columns, _page_per_kbyte = 1)
+        # page_per_kbyte is obsolete. Just for backward compatibility
         @list = MetricData.new(list_lines, list_columns)
         @text = MetricData.new(text_lines, text_columns)
-        @page_per_kbyte = page_per_kbyte
       end
 
-      A5 = PageMetric.new(46, 80, 30, 74, 1)
-      B5 = PageMetric.new(46, 80, 30, 74, 2)
+      # based on review-jsbook's default
+      A5 = PageMetric.new(40, 34, 29, 34)
+      B5 = PageMetric.new(50, 40, 36, 40)
 
       attr_reader :list
       attr_reader :text
-      attr_reader :page_per_kbyte
 
       def ==(other)
-        self.list == other.list && self.text == other.text && self.page_per_kbyte == other.page_per_kbyte
+        self.list == other.list && self.text == other.text
       end
     end
   end

data/lib/review/book/part.rb

@@ -41,7 +41,7 @@ module ReVIEW
         @chapters = chapters
         @name = name
         @path = name
-        @content = nil
+        @content = ''
         if io
           @content = io.read
         elsif @path.present? && File.exist?(File.join(@book.config['contentdir'], @path))
@@ -65,8 +65,11 @@ module ReVIEW
       end
 
       def volume
-        vol = Volume.sum(@chapters.map(&:volume))
-        vol.page_per_kbyte = @book.page_metric.page_per_kbyte
+        if @number && file?
+          vol = Volume.count_file(File.join(@book.config['contentdir'], @path))
+        else
+          vol = Volume.new(0, 0, 0)
+        end
         vol
       end
 

data/lib/review/book/volume.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2007-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2007-2020 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -33,20 +33,19 @@ module ReVIEW
         @bytes = bytes
         @chars = chars
         @lines = lines
-        @page_per_kbyte = nil
       end
 
       attr_reader :bytes
       attr_reader :chars
       attr_accessor :lines
-      attr_accessor :page_per_kbyte
 
       def kbytes
         (@bytes.to_f / 1024).ceil
       end
 
       def page
-        (kbytes.to_f / @page_per_kbyte).ceil
+        # XXX:unrelibable
+        kbytes.to_f.ceil
       end
 
       def to_s

data/lib/review/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2002-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2002-2020 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -142,25 +142,28 @@ module ReVIEW
 
     def list(lines, id, caption, lang = nil)
       begin
-        list_header(id, caption, lang)
+        list_header(id, caption, lang) if caption_top?('list')
+        list_body(id, lines, lang)
+        list_header(id, caption, lang) unless caption_top?('list')
       rescue KeyError
         error "no such list: #{id}"
       end
-      list_body(id, lines, lang)
     end
 
     def listnum(lines, id, caption, lang = nil)
       begin
-        list_header(id, caption, lang)
+        list_header(id, caption, lang) if caption_top?('list')
+        listnum_body(lines, lang)
+        list_header(id, caption, lang) unless caption_top?('list')
       rescue KeyError
         error "no such list: #{id}"
       end
-      listnum_body(lines, lang)
     end
 
     def source(lines, caption = nil, lang = nil)
-      source_header(caption)
+      source_header(caption) if caption_top?('list')
       source_body(lines, lang)
+      source_header(caption) unless caption_top?('list')
     end
 
     def image(lines, id, caption, metric = nil)
@@ -175,15 +178,18 @@ module ReVIEW
     def table(lines, id = nil, caption = nil)
       sepidx, rows = parse_table_rows(lines)
       begin
-        if caption.present?
+        if caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
+        table_begin(rows.first.size)
+        table_rows(sepidx, rows)
+        table_end
+        if !caption_top?('table') && caption.present?
           table_header(id, caption)
         end
       rescue KeyError
         error "no such table: #{id}"
       end
-      table_begin(rows.first.size)
-      table_rows(sepidx, rows)
-      table_end
     end
 
     def table_row_separator_regexp
@@ -680,5 +686,12 @@ EOTGNUPLOT
     def escape(str)
       str
     end
+
+    def caption_top?(type)
+      unless %w[top bottom].include?(@book.config['caption_position'][type])
+        warn("invalid caption_position/#{type} parameter. 'top' is assumed")
+      end
+      @book.config['caption_position'][type] != 'bottom'
+    end
   end
 end # module ReVIEW

data/lib/review/compiler.rb

@@ -26,6 +26,14 @@ module ReVIEW
 
     attr_reader :strategy
 
+    def non_escaped_commands
+      if @strategy.highlight?
+        %i[list emlist listnum emlistnum cmd]
+      else
+        []
+      end
+    end
+
     def compile(chap)
       @chapter = chap
       do_compile
@@ -225,14 +233,6 @@ module ReVIEW
       f = LineInput.new(StringIO.new(@chapter.content))
       @strategy.bind(self, @chapter, Location.new(@chapter.basename, f))
 
-      @non_parsed_commands = %i[embed texequation graph]
-      if @strategy.highlight?
-        @non_escaped_commands = %i[list emlist listnum emlistnum cmd]
-      else
-        @non_escaped_commands = []
-      end
-      @command_name_stack = []
-
       tagged_section_init
       while f.next?
         case f.peek
@@ -554,7 +554,7 @@ module ReVIEW
 
     def in_non_escaped_command?
       current_command = @command_name_stack.last
-      current_command && @non_escaped_commands.include?(current_command)
+      current_command && non_escaped_commands.include?(current_command)
     end
 
     def text(str, block_mode = false)

data/lib/review/configure.rb

@@ -106,6 +106,12 @@ module ReVIEW
           'lineheight' => 10 * 1.2,
           'pdfcrop_pixelize_cmd' => 'pdftocairo -%t -r 90 -f %p -l %p -singlefile %i %O',
           'dvipng_cmd' => 'dvipng -T tight -z 9 -p %p -l %p -o %o %i'
+        },
+        'caption_position' => {
+          'list' => 'top',
+          'image' => 'bottom',
+          'table' => 'top',
+          'equation' => 'top'
         }
       ]
       conf.maker = nil

data/lib/review/epubmaker.rb

@@ -166,7 +166,7 @@ module ReVIEW
         copy_backmatter(basetmpdir)
 
         math_dir = "./#{@config['imagedir']}/_review_math"
-        if @config['imgmath'] && File.exist?(File.join(math_dir, '__IMGMATH_BODY__.tex'))
+        if @config['imgmath'] && File.exist?(File.join(math_dir, '__IMGMATH_BODY__.map'))
           make_math_images(math_dir)
         end
         call_hook('hook_afterbackmatter', basetmpdir)

data/lib/review/htmlbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
 #                         KADO Masanori
 #               2002-2007 Minero Aoki
 #
@@ -286,15 +286,25 @@ module ReVIEW
     end
 
     def box(lines, caption = nil)
-      puts %Q(<div class="syntax">)
+      captionstr = nil
       if caption.present?
-        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+        captionstr = %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
+      puts %Q(<div class="syntax">)
+
+      if caption_top?('list') && caption.present?
+        puts captionstr
       end
+
       print %Q(<pre class="syntax">)
       lines.each do |line|
         puts detab(line)
       end
       puts '</pre>'
+
+      if !caption_top?('list') && caption.present?
+        puts captionstr
+      end
       puts '</div>'
     end
 
@@ -444,7 +454,7 @@ module ReVIEW
 
     def emlist(lines, caption = nil, lang = nil)
       puts %Q(<div class="emlist-code">)
-      if caption.present?
+      if caption_top?('list') && caption.present?
         puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
       end
       class_names = ['emlist']
@@ -455,12 +465,15 @@ module ReVIEW
       lexer = lang
       puts highlight(body: body, lexer: lexer, format: 'html')
       puts '</pre>'
+      if !caption_top?('list') && caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
       puts '</div>'
     end
 
     def emlistnum(lines, caption = nil, lang = nil)
       puts %Q(<div class="emlistnum-code">)
-      if caption.present?
+      if caption_top?('list') && caption.present?
         puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
       end
 
@@ -482,19 +495,29 @@ module ReVIEW
         puts '</pre>'
       end
 
+      if !caption_top?('list') && caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
+
       puts '</div>'
     end
 
     def cmd(lines, caption = nil)
       puts %Q(<div class="cmd-code">)
-      if caption.present?
+      if caption_top?('list') && caption.present?
         puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
       end
+
       print %Q(<pre class="cmd">)
       body = lines.inject('') { |i, j| i + detab(j) + "\n" }
       lexer = 'shell-session'
       puts highlight(body: body, lexer: lexer, format: 'html')
       puts '</pre>'
+
+      if !caption_top?('list') && caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
+
       puts '</div>'
     end
 
@@ -530,12 +553,13 @@ module ReVIEW
     def texequation(lines, id = nil, caption = '')
       if id
         puts %Q(<div id="#{normalize_id(id)}" class="caption-equation">)
-        texequation_header(id, caption)
+        texequation_header(id, caption) if caption_top?('equation')
       end
 
       texequation_body(lines)
 
       if id
+        texequation_header(id, caption) unless caption_top?('equation')
         puts '</div>'
       end
     end
@@ -603,20 +627,22 @@ module ReVIEW
     def image_image(id, caption, metric)
       metrics = parse_metric('html', metric)
       puts %Q(<div id="#{normalize_id(id)}" class="image">)
+      image_header(id, caption) if caption_top?('image')
       puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape(compile_inline(caption))}"#{metrics} />)
-      image_header(id, caption)
+      image_header(id, caption) unless caption_top?('image')
       puts '</div>'
     end
 
     def image_dummy(id, caption, lines)
       warn "image not bound: #{id}"
       puts %Q(<div id="#{normalize_id(id)}" class="image">)
+      image_header(id, caption) if caption_top?('image')
       puts %Q(<pre class="dummyimage">)
       lines.each do |line|
         puts detab(line)
       end
       puts '</pre>'
-      image_header(id, caption)
+      image_header(id, caption) unless caption_top?('image')
       puts '</div>'
     end
 
@@ -679,15 +705,19 @@ module ReVIEW
 
       puts %Q(<div id="#{normalize_id(id)}" class="imgtable image">)
       begin
-        if caption.present?
+        if caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
+
+        imgtable_image(id, caption, metric)
+
+        if !caption_top?('table') && caption.present?
           table_header(id, caption)
         end
       rescue KeyError
         error "no such table: #{id}"
       end
 
-      imgtable_image(id, caption, metric)
-
       puts '</div>'
     end
 
@@ -724,7 +754,19 @@ module ReVIEW
     def indepimage(lines, id, caption = '', metric = nil)
       metrics = parse_metric('html', metric)
       caption = '' unless caption.present?
+      caption_str = nil
+      if caption.present?
+        caption_str = <<-EOS
+<p class="caption">
+#{I18n.t('numberless_image')}#{I18n.t('caption_prefix')}#{compile_inline(caption)}
+</p>
+EOS
+      end
+
       puts %Q(<div id="#{normalize_id(id)}" class="image">)
+      if caption_top?('image') && caption.present?
+        puts caption_str
+      end
       begin
         puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape(compile_inline(caption))}"#{metrics} />)
       rescue
@@ -738,10 +780,8 @@ module ReVIEW
         end
       end
 
-      if caption.present?
-        puts %Q(<p class="caption">)
-        puts %Q(#{I18n.t('numberless_image')}#{I18n.t('caption_prefix')}#{compile_inline(caption)})
-        puts '</p>'
+      if !caption_top?('image') && caption.present?
+        puts caption_str
       end
       puts '</div>'
     end