review 3.2.0 → 5.1.0

data/bin/review-init

@@ -7,10 +7,7 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 # For details of the GNU LGPL, see the file "COPYING".
 
-require 'pathname'
-
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 require 'review/init'
 

data/bin/review-pdfmaker

@@ -7,9 +7,7 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'pathname'
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 require 'review/pdfmaker'
 

data/bin/review-preproc

@@ -9,10 +9,7 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'pathname'
-
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 require 'review/preprocessor'
 require 'review/version'
@@ -39,7 +36,7 @@ def main
     if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0
       @logger.warn 'review-preproc-ext.rb is prohibited in safe mode. ignored.'
     else
-      Kernel.load File.expand_path('review-preproc-ext.rb')
+      Kernel.load(File.expand_path('review-preproc-ext.rb'))
     end
   end
 
@@ -71,21 +68,21 @@ def main
     current_file = path
     case mode
     when :output
-      File.open(path) { |f| pp.process f, $stdout }
+      File.open(path) { |f| pp.process(f, $stdout) }
     when :replace
-      File.write "#{path}.pptmp", preproc(pp, path)
-      File.rename "#{path}.pptmp", path
+      File.write("#{path}.pptmp", preproc(pp, path))
+      File.rename("#{path}.pptmp", path)
     when :diff, :check
       tmp = '/tmp/review.pptmp'
       begin
-        File.write tmp, preproc(pp, path)
+        File.write(tmp, preproc(pp, path))
         if mode == :check
-          system "diff -qu #{path} #{tmp} >/dev/null || echo #{path}"
+          system("diff -qu #{path} #{tmp} >/dev/null || echo #{path}")
         else
-          system "diff -u #{path} #{tmp}"
+          system("diff -u #{path} #{tmp}")
         end
       ensure
-        FileUtils.rm_f tmp
+        FileUtils.rm_f(tmp)
       end
     else
       raise "must not happen: #{mode}"
@@ -93,13 +90,14 @@ def main
   end
 rescue ReVIEW::Error => e
   raise if $DEBUG
+
   @logger.error e.message
   exit 1
 end
 
 def preproc(pp, path)
   buf = StringIO.new
-  File.open(path) { |f| pp.process f, buf }
+  File.open(path) { |f| pp.process(f, buf) }
   buf.string
 end
 

data/bin/review-textmaker

@@ -7,9 +7,7 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'pathname'
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 require 'review/textmaker'
 

data/bin/review-update

@@ -7,10 +7,7 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 # For details of the GNU LGPL, see the file "COPYING".
 
-require 'pathname'
-
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 require 'review/update'
 

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
@@ -8,10 +8,9 @@
 #
 
 # simple validator for Re:VIEW
-require 'pathname'
 
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
+
 require 'review/logger'
 
 block = nil
@@ -30,7 +29,7 @@ ARGF.each do |line|
       @logger.warn "#{ln}: block #{new_block} started, but previous block #{block} didn't close yet."
     end
     block = new_block
-  elsif line =~ %r{\A//\}}
+  elsif line.start_with?('//}')
     if block.nil?
       @logger.warn "#{ln}: block ended, but not opened."
     end
@@ -48,12 +47,13 @@ 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'
     next if line.start_with?('#@')
-    if line !~ /\A\-\-\-\-\-/
+
+    if line !~ /\A-----/
       # table
       colcount = line.split("\t").size
       if maxcolcount == 0

data/bin/review-vol

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2014-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2014-2020 Minero Aoki, Kenshi Muto
 #               2003-2014 Minero Aoki
 #
 # This program is free software.
@@ -9,87 +9,10 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'pathname'
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+require 'review/volumeprinter'
 
-require 'review'
-require 'optparse'
-
-include ReVIEW::TextUtils
-
-def main
-  @logger = ReVIEW.logger
-  @config = ReVIEW::Configure.values
-
-  part_sensitive = false
-  basedir = nil
-  yamlfile = 'config.yml'
-  opts = OptionParser.new
-  opts.version = ReVIEW::VERSION
-  opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| yamlfile = yaml }
-  opts.on('-P', '--part-sensitive', 'Prints volume of each parts.') { part_sensitive = true }
-  opts.on('--directory=DIR', 'Compile all chapters in DIR.') { |path| basedir = path }
-  opts.on('--help', 'Print this message and quit') do
-    puts opts.help
-    exit 0
-  end
-  begin
-    opts.parse!
-  rescue OptionParser::ParseError => e
-    @logger.error e.message
-    $stderr.puts opts.help
-    exit 1
-  end
-
-  book = basedir ? ReVIEW::Book.load(basedir) : ReVIEW::Book::Base.load
-  book.config = @config
-  if yamlfile
-    book.load_config(yamlfile)
-  end
-
-  if part_sensitive
-    sep = ''
-    book.each_part do |part|
-      print sep
-      sep = "\n"
-      if part.number
-        puts "Part #{part.number} #{part.name}"
-      end
-      part.each_chapter do |chap|
-        print_chapter_volume chap
-      end
-      puts '    --------------------'
-      print_volume part.volume
-    end
-  else
-    book.each_chapter do |chap|
-      print_chapter_volume chap
-    end
-  end
-  puts '============================='
-  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}"
-  exit 1
-end
-
-def print_chapter_volume(chap)
-  vol = chap.volume
-  title = chap.title
-  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
-end
-
-def print_volume(vol)
-  printf "    %3dKB %6dC %5dL %3dP\n", vol.kbytes, vol.chars, vol.lines, vol.page
+if File.basename($PROGRAM_NAME) == File.basename(__FILE__)
+  ReVIEW::VolumePrinter.execute(*ARGV)
 end
-
-def chapnumstr(n)
-  n ? sprintf('%2d.', n) : '   '
-end
-
-main

data/bin/review-webmaker

@@ -6,9 +6,7 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'pathname'
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 require 'review/webmaker'
 

data/doc/config.yml.sample

@@ -5,7 +5,7 @@
 # このファイルはUTF-8エンコーディングで記述してください。
 
 # この設定ファイルでサポートするRe:VIEWのバージョン番号。
-review_version: 3.0
+review_version: 5.0
 
 # ほかの設定ファイルの継承を指定できる。同じパラメータに異なる値がある場合は、
 # 呼び出し元の値が優先される。
@@ -64,6 +64,8 @@ aut: ["青木峰郎", "武藤健志", "高橋征義", "角征典"]
 # a-trc, trc: 筆記・タイプ作業者
 # a-trl, trl: 翻訳者
 
+# contact: 連絡先
+
 # 刊行日(省略した場合は実行時の日付)
 # date: 2018-11-11
 # 発行年月。YYYY-MM-DD形式による配列指定。省略した場合はdateを使用する
@@ -72,7 +74,7 @@ aut: ["青木峰郎", "武藤健志", "高橋征義", "角征典"]
 # 日付の後ろを空白文字で区切り、任意の文字列を置くことも可能。
 # history: [["2016-04-20 v1.0.0版発行", "2018-11-11 v3.0.0版発行"]]
 # 権利表記(配列で複数指定可)
-# rights: (C) 2016-2019 Re:VIEW Developers
+# rights: (C) 2016-2020 Re:VIEW Developers
 # description: 説明
 # subject: 短い説明用タグ(配列で複数指定可)
 # type: 書籍のカテゴリーなど(配列で複数指定可)
@@ -85,11 +87,14 @@ aut: ["青木峰郎", "武藤健志", "高橋征義", "角征典"]
 debug: null
 
 # 固有IDに使用するドメイン。指定しない場合には、時刻に基づくランダムUUIDが入る
-# urnid: urn:uid:http://example.com/book-title/
+# urnid: urn:uuid:http://example.com/book-title/
 #
 # ISBN。省略した場合はurnidが入る
 # isbn: null
 #
+# @<chap>, @<chapref>, @<title>, @<hd>命令をハイパーリンクにする(nullでハイパーリンクにしない)
+# chapterlink: true
+
 # HTMLファイルの拡張子(省略した場合はhtml)
 # htmlext: html
 #
@@ -111,7 +116,7 @@ toclevel: 3
 secnolevel: 2
 
 # 本文中に目次ページを作成するか。省略した場合はnull (作成しない)
-# toc: true
+toc: true
 
 # EPUB2標準の目次(NCX)以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
 # ePUB3においてはこの設定によらず必ず作成される
@@ -137,7 +142,10 @@ secnolevel: 2
 # creditfile: null
 
 # 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
+# デフォルトの奥付における各項目の名前（「著　者」など）を変えたいときにはlocale.ymlで文字列を設定する（詳細はdoc/format.ja.mdを参照）
 # colophon: null
+# デフォルトの奥付における、各項目の記載順序
+# colophon_order: ["aut", "csl", "trl", "dsr", "ill", "cov", "edt", "pbl", "contact", "prt"]
 
 # 裏表紙データファイル (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
 # backcover: null
@@ -173,22 +181,41 @@ secnolevel: 2
 # reファイルを格納するディレクトリ。省略した場合は以下 (. はカレントディレクトリを示す)
 # contentdir: .
 
-# @<w>命令で使用する単語ファイルのパス
+# @<w>命令で使用する単語ファイルのパス。["common.csv", "mybook.csv"]のように配列指定も可
 # words_file: words.csv
 
-# review-vol向けのヒント情報
-# 1ページの行数文字数と1kbごとのページ数を用紙サイズで指定する(A5 or B5)
+# //table命令における列の区切り文字。tabs (1文字以上のタブ文字区切り。デフォルト), singletab (1文字のタブ文字区切り), spaces (1文字以上のスペースまたはタブ文字の区切り), verticalbar ("0個以上の空白 | 0個以上の空白"の区切り)
+# table_row_separator: tabs
+
+# 複数行から段落を結合する際、前後のUnicode文字種に基づき必要に応じて空白文字を挿入するか
+# 省略した場合はnull (挿入しない)。別途unicode-eaw gemファイルが必要
+# join_lines_by_lang: null
+
+# 図・表・コードリスト・数式のキャプション位置。
+# 値はtop（上）またはbottom（下）でデフォルトは以下のとおり
+# caption_position:
+#   image: bottom
+#   table: top
+#   list: top
+#   equation: top
+
+# review-toc向けのヒント情報
+# (文字幅を考慮した行数計測には、別途unicode-eaw gemファイルが必要)
+# ページあたりの行数文字数を用紙サイズで指定する(A5 or B5)
 # page_metric: A5
 #
 # あるいは、配列で指定することもできる
-# 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数、1kバイトごとのページ数
-# page_metric: [40,80,40,80,2]
+# 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数
+# page_metric: [40,34,29,34]
 
-# EPUBおよびWeb生成における数式の画像化指定
-# TeXの数式を画像化するか。省略した場合はnull (作成しない)
-# imgmath: true
+# @<m>, //texequation に記述したTeX数式の表現方法 (PDFMaker (LaTeX) 以外)
+#   null: TeX式をそのまま文字列として出力 (デフォルト)
+#   mathml: MathML変換。別途math_ml gemファイルが必要。EPUBMaker/WebMakerのみ効果
+#   imgmath: 画像化。オプションはimgmath_optionsで設定する
+#   mathjax: MathJax変換。EPUBMaker/WebMakerのみ効果。なお、MathJaxに必要なデータはインターネットから取得される。EPUBで利用できるかはEPUBリーダ依存
+# math_format: null
 
-# imgmathがtrueの場合の設定
+# math_formatがimgmathの場合の設定
 # 以下のパラメータを有効にするときには、
 # imgmath_options:
 #    パラメータ: 値
@@ -211,14 +238,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 +355,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"
@@ -367,6 +400,9 @@ pdfmaker:
   # 画像のscale=X.Xという指定を画像拡大縮小率からページ最大幅の相対倍率に変換する
   # image_scale2width: true
   #
+  # 画像のデフォルトのサイズを、版面横幅合わせではなく、原寸をそのまま利用する
+  # use_original_image_size: null
+  #
   # PDFやIllustratorファイル(.ai)の画像のBoudingBoxの抽出に指定のボックスを採用する
   # cropbox(デフォルト), mediabox, artbox, trimbox, bleedboxから選択する。
   # Illustrator CC以降のIllustratorファイルに対してはmediaboxを指定する必要がある
@@ -388,4 +424,19 @@ pdfmaker:
   # makeindex_mecab_opts: "-Oyomi"
   # 奥付を作成するか。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
   colophon: true
+  # 表紙挿入時に表紙のページ番号名を「cover」とし、偶数ページ扱いにして大扉前に白ページが入るのを防ぐ。デフォルトはtrue
+  # use_cover_nombre: true
+  #
+  # 囲み表現の切り替え設定
+  # column, note, memo, tip, info, warning, important, caution, noticeを設定可
+  # styleはreview-tcbox.styまたは独自に作成したスタイルで定義済みの囲みスタイル名
+  # optionsはキャプションなし囲みに対するtcolorboxの追加・上書きオプション
+  # options_with_captionはキャプション付き囲みのtcolorboxの追加・上書きオプション（省略した場合はoptionsと同じ）
+  #
+  # boxsetting:
+  #   note:
+  #     style: squarebox
+  #     options: "colback=black!5!white"
+  #     options_with_caption: "colbacktitle=black!25!white"
+  #
   # pdfmaker:階層を使うものはここまで

data/doc/config.yml.sample-simple

@@ -1,5 +1,5 @@
 # simple sample of config.yml
-review_version: 3.0
+review_version: 5.0
 
 # debug: true
 
@@ -20,11 +20,12 @@ aut: ["Masayoshi Takahashi"]
 # edt: null
 pbl: "Re:VIEW Publishing inc."
 prt: "Re:VIEW Printing inc."
+contact: "https://reviewml.org/"
 date: 2018-11-11
 history: [["2012-01-30"],["2016-04-20","2016-05-03"],["2018-11-11"]]
-rights: (C) 2016-2019 Re:VIEW Commiters, some rights reserved.
+rights: (C) 2016-2020 Re:VIEW Commiters, some rights reserved.
 description: sample config.yml file for Re:VIEW book
-urnid: urn:uid:http://reviewml.org/review-sample-book
+urnid: urn:uuid:http://reviewml.org/review-sample-book
 # isbn: null
 
 ## Book Structure