review 3.2.0 → 4.0.0

data/bin/review-validate

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2010-2017 Kenshi Muto
+# Copyright (c) 2010-2019 Kenshi Muto
 #
 # This program is free software
 # You can distribute or modify this program under the terms of
@@ -48,7 +48,7 @@ ARGF.each do |line|
       @logger.warn "#{ln}: found '*' without the head space. Is it correct?"
     end
   elsif line =~ /\A\s+(\d+\.)\s+/ && line =~ /\A\s+\*\s+/
-    unless Tw[list emlist listnum emlistnum cmd image table].include?(block)
+    unless %w[list emlist listnum emlistnum cmd image table].include?(block)
       @logger.warn "#{ln}: found itemized list or numbered list in #{block}. Is it correct?"
     end
   elsif block == 'table'

data/bin/review-vol

@@ -69,23 +69,23 @@ def main
     end
   end
   puts '============================='
-  print_volume book.volume # puts "Total #{book.volume}"
+  print_volume(book.volume) # puts "Total #{book.volume}"
 rescue ReVIEW::ApplicationError, Errno::ENOENT => e
   raise if $DEBUG
-  @logger.error "#{File.basename($PROGRAM_NAME)}: #{e.message}"
+  @logger.error e.message
   exit 1
 end
 
 def print_chapter_volume(chap)
   vol = chap.volume
   title = chap.title
-  printf "%s %3dKB %6dC %5dL %3dP %s %-s\n",
+  printf("%s %3dKB %6dC %5dL %3dP %s %-s\n",
          chapnumstr(chap.number), vol.kbytes, vol.chars, vol.lines, vol.page,
-         "#{chap.name} ".ljust(25, '.'), title
+         "#{chap.name} ".ljust(25, '.'), title)
 end
 
 def print_volume(vol)
-  printf "    %3dKB %6dC %5dL %3dP\n", vol.kbytes, vol.chars, vol.lines, vol.page
+  printf("    %3dKB %6dC %5dL %3dP\n", vol.kbytes, vol.chars, vol.lines, vol.page)
 end
 
 def chapnumstr(n)

data/doc/config.yml.sample

@@ -5,7 +5,7 @@
 # このファイルはUTF-8エンコーディングで記述してください。
 
 # この設定ファイルでサポートするRe:VIEWのバージョン番号。
-review_version: 3.0
+review_version: 4.0
 
 # ほかの設定ファイルの継承を指定できる。同じパラメータに異なる値がある場合は、
 # 呼び出し元の値が優先される。
@@ -111,7 +111,7 @@ toclevel: 3
 secnolevel: 2
 
 # 本文中に目次ページを作成するか。省略した場合はnull (作成しない)
-# toc: true
+toc: true
 
 # EPUB2標準の目次(NCX)以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
 # ePUB3においてはこの設定によらず必ず作成される
@@ -184,7 +184,7 @@ secnolevel: 2
 # 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数、1kバイトごとのページ数
 # page_metric: [40,80,40,80,2]
 
-# EPUBおよびWeb生成における数式の画像化指定
+# EPUB・Web、およびテキスト生成時における数式の画像化指定
 # TeXの数式を画像化するか。省略した場合はnull (作成しない)
 # imgmath: true
 
@@ -211,14 +211,20 @@ secnolevel: 2
   # pdfcrop_cmd: "pdfcrop --hires %i %o"
   # PDFから画像化するコマンドのコマンドライン。プレースホルダは
   # %i: 入力ファイル、%o: 出力ファイル、%O: 出力ファイルから拡張子を除いたもの
-  # %p: 対象ページ番号
-  # pdfcrop_pixelize_cmd: "pdftocairo -png -r 90 -f %p -l %p -singlefile %i %O"
+  # %p: 対象ページ番号、%t: フォーマット
+  # pdfcrop_pixelize_cmd: "pdftocairo -%t -r 90 -f %p -l %p -singlefile %i %O"
   # pdfcrop_pixelize_cmdが複数ページの処理に対応していない場合に単ページ化するか
   # extract_singlepage: null
   # extract_singlepageがtrueの場合に単ページ化するコマンドのコマンドライン
   # pdfextract_cmd: "pdfjam -q --outfile %o %i %p"
   # converterにdvipngを指定したときのdvipngコマンドのコマンドライン
   # dvipng_cmd: "dvipng -T tight -z 9 -p %p -l %p -o %o %i"
+  #
+  # PDFで保存したいときにはたとえば以下のようにする
+  # format: pdf
+  # extract_singlepage: true
+  # pdfextract_cmd: "pdftk A=%i cat A%p output %o"
+  # pdfcrop_pixelize_cmd: "mv %i %o"
 
 # EPUBにおけるページ送りの送り方向、page-progression-directionの値("ltr"|"rtl"|"default")
 # direction: "ltr"
@@ -322,7 +328,7 @@ epubmaker:
 # texcommand: "uplatex"
 #
 # LaTeXのコマンドに渡すオプションを指定する
-# texoptions: "-interaction=nonstopmode -file-line-error"
+# texoptions: "-interaction=nonstopmode -file-line-error -halt-on-error"
 #
 # LaTeX用のdvi変換コマンドを指定する(dvipdfmx)
 # dvicommand: "dvipdfmx"
@@ -388,4 +394,6 @@ pdfmaker:
   # makeindex_mecab_opts: "-Oyomi"
   # 奥付を作成するか。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
   colophon: true
+  # 表紙挿入時に表紙のページ番号名を「cover」とし、偶数ページ扱いにして大扉前に白ページが入るのを防ぐ。デフォルトはtrue
+  # use_cover_nombre: true
   # pdfmaker:階層を使うものはここまで

data/doc/config.yml.sample-simple

@@ -1,5 +1,5 @@
 # simple sample of config.yml
-review_version: 3.0
+review_version: 4.0
 
 # debug: true
 

data/doc/format.ja.md

@@ -505,14 +505,13 @@ complexmatrixという識別子に基づく画像ファイルが貼り込まれ
 
 本文中のインライン命令「`@<fn>{site}`」は脚注番号に置換され、「本書のサポートサイト……」という文は実際の脚注に変換されます。
 
-注意: TeX PDF において、コラムや表など平文でないところで「`@<fn>{～}`」を使うには、`footnotetext` オプションを使う必要があります。
+注意: TeX PDF において、コラムの中で脚注を利用する場合、`//footnote` 行はコラムの終わり（`==[/column]` など）の後ろに記述することをお勧めします。Re:VIEW の標準提供のコラム表現では問題ありませんが、サードパーティのコラムの実装によってはおかしな採番表現になることがあります。
 
 ### footnotetext オプション
+TeX PDF において、コラム以外の `//note` などの囲み記事の中で「`@<fn>{～}`」を使うには、`footnotetext` オプションを使う必要があります。
 
 `footnotetext` オプションを使うには、`config.yml` ファイルに`footnotetext: true` を追加します。
 
-これで PDF のコラムや表のなかでも脚注が使えるようになります。
-
 ただし、通常の脚注（footnote）ではなく、footnotemark と footnotetext を使うため、本文と脚注が別ページに分かれる可能性があるなど、いろいろな制約があります。また、採番が別々になるため、footnote と footnotemark/footnotetext を両立させることはできません。
 
 ## 参考文献の定義
@@ -638,8 +637,8 @@ imgmath_options:
   pdfcrop_cmd: "pdfcrop --hires %i %o"
   # PDFから画像化するコマンドのコマンドライン。プレースホルダは
   # %i: 入力ファイル、%o: 出力ファイル、%O: 出力ファイルから拡張子を除いたもの
-  # %p: 対象ページ番号
-  pdfcrop_pixelize_cmd: "pdftocairo -png -r 90 -f %p -l %p -singlefile %i %O"
+  # %p: 対象ページ番号、%t: フォーマット
+  pdfcrop_pixelize_cmd: "pdftocairo -%t -r 90 -f %p -l %p -singlefile %i %O"
   # pdfcrop_pixelize_cmdが複数ページの処理に対応していない場合に単ページ化するか
   extract_singlepage: null
   # 単ページ化するコマンドのコマンドライン
@@ -673,6 +672,17 @@ imgmath_options:
   pdfcrop_pixelize_cmd: "sips -s format png --out %o %i"
 ```
 
+textmaker 向けに PDF 形式の数式ファイルを作成したいときには、たとえば以下のように設定します（ページの抽出には pdftk を利用）。
+
+```
+imgmath: true
+imgmath_options:
+  format: pdf
+  extract_singlepage: true
+  pdfextract_cmd: "pdftk A=%i cat A%p output %o"
+  pdfcrop_pixelize_cmd: "mv %i %o"
+```
+
 Re:VIEW 2 以前の dvipng の設定に合わせるには、次のようにします。
 
 ```

data/doc/format.md

@@ -98,11 +98,11 @@ Nested itemize is like ` **`, ` ***`.
 Usage:
 
 ```
-* 1st item
-** nested 1st item
-* 2nd item
-** nested 2nd item
-* 3rd item
+ * 1st item
+ ** nested 1st item
+ * 2nd item
+ ** nested 2nd item
+ * 3rd item
 ```
 
 In itemize, you must write one more space character at line head.
@@ -118,34 +118,34 @@ They aren't nested.
 Usage:
 
 ```
-1. 1st condition
-2. 2nd condition
-3. 3rd condition
+ 1. 1st condition
+ 2. 2nd condition
+ 3. 3rd condition
 ```
 
 The value of Number is ignored.
 
 ```
-1. 1st condition
-1. 2nd condition
-1. 3rd condition
+ 1. 1st condition
+ 1. 2nd condition
+ 1. 3rd condition
 ```
 
 You must write one more space character at line head like itemize.
 
 ## Definition List
 
-Definition list (dl in HTML) use `:` and indented lines.
+Definition list (dl in HTML) uses ` : ` and indented lines.
 
 Usage:
 
 ```review
-: Alpha
+ : Alpha
     RISC CPU made by DEC.
-: POWER
+ : POWER
     RSIC CPU made by IBM and Motolora.
     POWER PC is delivered from this.
-: SPARC
+ : SPARC
     RISC CPU made by SUN.
 ```
 
@@ -546,9 +546,10 @@ You should get and install it before reading the book.
 `@<fn>{site}` in source are replaced by footnote marks, and the phrase "support site of .."
 is in footnotes.
 
-Note that In LATEXBuilder, you should use `footnotetext` option to use `@<fn>{...}` in columns and tables.
+Note that in LATEXBuilder, it is highly recommended to place `//footnote` after the end line of column (`==[/column]`) to avoid problems when using third party's style file.
 
 ### `footnotetext` option
+Note that in LATEXBuilder, you should use `footnotetext` option to use `@<fn>{...}` in `//note` or other short column blocks.
 
 By adding `footnotetext:true` in config.yml, you can use footnote in tables and short notes.
 
@@ -682,8 +683,8 @@ imgmath_options:
   pdfcrop_cmd: "pdfcrop --hires %i %o"
   # imaging command.
   # %i: filename for input %o: filename for output %O: filename for output without the extension
-  # %p: page number
-  pdfcrop_pixelize_cmd: "pdftocairo -png -r 90 -f %p -l %p -singlefile %i %O"
+  # %p: page number, %t: format
+  pdfcrop_pixelize_cmd: "pdftocairo -%t -r 90 -f %p -l %p -singlefile %i %O"
   # whether to generate a single PDF page for pdfcrop_pixelize_cmd.
   extract_singlepage: null
   # command line to generate a single PDF page file.
@@ -717,6 +718,17 @@ imgmath_options:
   pdfcrop_pixelize_cmd: "sips -s format png --out %o %i"
 ```
 
+To create PDF math images:
+
+```
+imgmath: true
+imgmath_options:
+  format: pdf
+  extract_singlepage: true
+  pdfextract_cmd: "pdftk A=%i cat A%p output %o"
+  pdfcrop_pixelize_cmd: "mv %i %o"
+```
+
 To set the same setting as Re:VIEW 2:
 
 ```

data/doc/pdfmaker.ja.md

@@ -121,7 +121,7 @@ LaTeX コンパイラコマンドおよびオプションについて、Re:VIEW
 
 ```yaml
 texcommand: uplatex
-texoptions: "-interaction=nonstopmode -file-line-error"
+texoptions: "-interaction=nonstopmode -file-line-error -halt-on-error"
 texdocumentclass: ["jsbook", "uplatex,oneside"]
 dvicommand: dvipdfmx
 dvioptions: "-d 5"

data/doc/pdfmaker.md

@@ -100,7 +100,7 @@ Default settings of Re:VIEW is below:
 
 ```yaml
 texcommand: uplatex
-texoptions: "-interaction=nonstopmode -file-line-error"
+texoptions: "-interaction=nonstopmode -file-line-error -halt-on-error"
 texdocumentclass: ["review-jsbook", "uplatex,twoside"]
 dvicommand: dvipdfmx
 dvioptions: "-d 5"

data/lib/review/book.rb

@@ -19,7 +19,7 @@ require 'review/book/index'
 module ReVIEW
   module Book
     def self.load(dir)
-      Base.load dir
+      Base.load(dir)
     end
   end
 end

data/lib/review/book/base.rb

@@ -29,7 +29,6 @@ module ReVIEW
         @chapter_index = nil
         @config = ReVIEW::Configure.values
         @catalog = nil
-        @read_part = nil
         @warn_old_files = {} # XXX for checking CHAPS, PREDEF, POSTDEF
         @basedir_seen = {}
         update_rubyenv
@@ -189,8 +188,8 @@ module ReVIEW
         return @catalog if @catalog.present?
 
         catalogfile_path = filename_join(@basedir, config['catalogfile'])
-        if File.file? catalogfile_path
-          @catalog = File.open(catalogfile_path, 'r:BOM|utf-8') { |f| Catalog.new(f) }
+        if File.file?(catalogfile_path)
+          @catalog = File.open(catalogfile_path, 'rt:BOM|utf-8') { |f| Catalog.new(f) }
         end
         if @catalog
           @catalog.validate!(@config, basedir)
@@ -202,7 +201,7 @@ module ReVIEW
         if catalog
           catalog.chaps
         else
-          read_file(config['chapter_file'])
+          read_file(config['chapter_file']).split("\n")
         end
       end
 
@@ -210,7 +209,7 @@ module ReVIEW
         if catalog
           catalog.predef
         else
-          read_file(config['predef_file'])
+          read_file(config['predef_file']).split("\n")
         end
       end
 
@@ -218,7 +217,7 @@ module ReVIEW
         if catalog
           catalog.appendix
         else
-          read_file(config['postdef_file']) # for backward compatibility
+          read_file(config['postdef_file']).split("\n") # for backward compatibility
         end
       end
 
@@ -226,17 +225,15 @@ module ReVIEW
         if catalog
           catalog.postdef
         else
-          ''
+          []
         end
       end
 
       def read_part
-        return @read_part if @read_part
-
         if catalog
-          @read_part = catalog.parts
+          catalog.parts
         else
-          @read_part = File.read(File.join(@basedir, config['part_file']))
+          File.read(File.join(@basedir, config['part_file'])).split("\n")
         end
       end
 
@@ -258,13 +255,13 @@ module ReVIEW
 
       def prefaces
         if catalog
-          return mkpart_from_namelist(catalog.predef.split("\n"))
+          return Part.mkpart_from_namelist(self, catalog.predef)
         end
 
         begin
           predef_file = filename_join(@basedir, config['predef_file'])
           if File.file?(predef_file)
-            mkpart_from_namelistfile(predef_file)
+            Part.mkpart_from_namelistfile(self, predef_file)
           end
         rescue FileNotFound => e
           raise FileNotFound, "preface #{e.message}"
@@ -273,15 +270,15 @@ module ReVIEW
 
       def appendix
         if catalog
-          names = catalog.appendix.split("\n")
-          chaps = names.each_with_index.map { |n, idx| mkchap_ifexist(n, idx) }.compact
-          return mkpart(chaps)
+          names = catalog.appendix
+          chaps = names.each_with_index.map { |name, number| Chapter.mkchap_ifexist(self, name, number + 1) }.compact
+          return Part.mkpart(chaps)
         end
 
         begin
           postdef_file = filename_join(@basedir, config['postdef_file'])
           if File.file?(postdef_file)
-            mkpart_from_namelistfile(postdef_file)
+            Part.mkpart_from_namelistfile(self, postdef_file)
           end
         rescue FileNotFound => e
           raise FileNotFound, "postscript #{e.message}"
@@ -290,7 +287,7 @@ module ReVIEW
 
       def postscripts
         if catalog
-          mkpart_from_namelist(catalog.postdef.split("\n"))
+          Part.mkpart_from_namelist(self, catalog.postdef)
         end
       end
 
@@ -300,13 +297,13 @@ module ReVIEW
         list = parse_chapters
         # NOTE: keep this = style to work this logic.
         if pre = prefaces
-          list.unshift pre
+          list.unshift(pre)
         end
         if app = appendix
-          list.push app
+          list.push(app)
         end
         if post = postscripts
-          list.push post
+          list.push(post)
         end
         list
       end
@@ -324,7 +321,7 @@ module ReVIEW
                 chap = Chapter.new(self, num += 1, chap, File.join(contentdir, chap))
                 chap
               end
-              Part.new(self, part += 1, chaps, read_part.split("\n")[part - 1])
+              Part.new(self, part += 1, chaps, read_part[part - 1])
             else
               chap = Chapter.new(self, num += 1, entry, File.join(contentdir, entry))
               if chap.number
@@ -337,12 +334,11 @@ module ReVIEW
           end
         end
 
-        chap = read_chaps.
-               strip.lines.map(&:strip).join("\n").split(/\n{2,}/).
+        chap = read_chaps.map(&:strip).join("\n").split(/\n{2,}/).
                map do |part_chunk|
           chaps = part_chunk.split.map { |chapid| Chapter.new(self, num += 1, chapid, File.join(contentdir, chapid)) }
-          if part_exist? && read_part.split("\n").size > part
-            Part.new(self, part += 1, chaps, read_part.split("\n")[part - 1])
+          if part_exist? && read_part.size > part
+            Part.new(self, part += 1, chaps, read_part[part - 1])
           else
             Part.new(self, nil, chaps)
           end
@@ -350,42 +346,6 @@ module ReVIEW
         chap
       end
 
-      def mkpart_from_namelistfile(path)
-        chaps = []
-        File.read(path, mode: 'r:BOM|utf-8').split.each_with_index do |name, idx|
-          if path =~ /PREDEF/
-            chaps << mkchap(name)
-          else
-            chaps << mkchap(name, idx + 1)
-          end
-        end
-        mkpart(chaps)
-      end
-
-      def mkpart_from_namelist(names)
-        mkpart(names.map { |n| mkchap_ifexist(n) }.compact)
-      end
-
-      def mkpart(chaps)
-        chaps.empty? ? nil : Part.new(self, nil, chaps)
-      end
-
-      def mkchap(name, number = nil)
-        name += ext if File.extname(name).empty?
-        path = File.join(contentdir, name)
-        raise FileNotFound, "file not exist: #{path}" unless File.file?(path)
-        Chapter.new(self, number, name, path)
-      end
-
-      def mkchap_ifexist(name, idx = nil)
-        name += ext if File.extname(name).empty?
-        path = File.join(contentdir, name)
-        if File.file?(path)
-          idx += 1 if idx
-          Chapter.new(self, idx, name, path)
-        end
-      end
-
       def read_file(filename)
         unless @warn_old_files[filename]
           @warn_old_files[filename] = true
@@ -394,7 +354,7 @@ module ReVIEW
           end
         end
         res = ''
-        File.open(filename_join(@basedir, filename), 'r:BOM|utf-8') do |f|
+        File.open(filename_join(@basedir, filename), 'rt:BOM|utf-8') do |f|
           f.each_line do |line|
             next if /\A#/ =~ line
             line.gsub!(/#.*\Z/, '')