review 5.0.0 → 5.1.0

data/bin/review-check

@@ -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'
 require 'optparse'
@@ -86,6 +83,7 @@ def check_text(files)
         m = re.match(s)
         next if m.nil? || m[0] == @review_utils_word_ok
         next if neg && neg =~ s
+
         str, offset = find_line(para, re)
         out = sprintf("%s:%d: %s\n", path, lineno + offset, str)
         print out
@@ -107,6 +105,7 @@ def find_line(lines, re)
   while i < lines.size - 1
     str = lines[i] + lines[i + 1]
     return str.gsub(re, '<<<\&>>>'), i if re =~ str
+
     i += 1
   end
 
@@ -118,6 +117,7 @@ def words_re(rc)
   nega = []
   File.foreach(rc) do |line|
     next if line[0, 1] == '#'
+
     if / !/ =~ line
       line, n = *line.split('!', 2)
       nega.push(n.strip)
@@ -134,7 +134,7 @@ def each_paragraph(f)
     case line
     when /\A\#@ok\((.*)\)/
       @review_utils_word_ok = $1
-    when /\A\#@/
+    when /\A\#@/, /\A\s*\z/
       # do nothing
       next
     when %r{\A//caption\{(.*?)//\}}
@@ -145,9 +145,6 @@ def each_paragraph(f)
       end
     when /\A=/
       yield [line.slice(/\A=+(?:\[.*?\])?\s+(.*)/, 1).strip], f.lineno
-    when /\A\s*\z/
-      # skip
-      next
     else
       buf = [line.strip]
       lineno = f.lineno
@@ -155,6 +152,7 @@ def each_paragraph(f)
         break if line.strip.empty?
         break if %r{\A(?:=|//[\w\}])} =~ line
         next if /\A\#@/ =~ line
+
         buf.push(line.strip)
       end
       yield buf, lineno

data/bin/review-checkdep

@@ -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__))
 
 PREDEF_FILE = 'PREDEF'.freeze
 

data/bin/review-compile

@@ -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'
 require 'fileutils'
@@ -126,7 +123,7 @@ def parse_opts
   opts.on('--chapref="before,middle,after"', 'Chapref decoration. (idgxml)') { |cdec| @config['chapref'] = cdec }
   opts.on('--chapterlink', 'make chapref hyperlink') { @config['chapterlink'] = true }
   opts.on('--stylesheet=file', 'Stylesheet file for HTML (comma separated)') { |files| @config['stylesheet'] = files.split(/\s*,\s*/) }
-  opts.on('--mathml', 'Use MathML for TeX equation in HTML') { @config['mathml'] = true }
+  opts.on('--mathml', 'Use MathML for TeX equation in HTML') { @config['math_format'] = 'mathml' }
   opts.on('--htmlversion=VERSION', 'HTML version.') do |v|
     v = v.to_i
     @config['htmlversion'] = v if [4, 5].include?(v)

data/bin/review-epub2html

@@ -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/epub2html'
 

data/bin/review-epubmaker

@@ -6,11 +6,10 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 # For details of the GNU LGPL, see the file "COPYING".
 #
-require 'pathname'
-require 'optparse'
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
 
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
+
+require 'optparse'
 require 'review/epubmaker'
 
 ReVIEW::EPUBMaker.execute(*ARGV)

data/bin/review-idgxmlmaker

@@ -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/idgxmlmaker'
 

data/bin/review-index

@@ -9,11 +9,17 @@
 # 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/tocprinter'
 
-ReVIEW::TOCPrinter.execute(*ARGV)
+begin
+  Signal.trap(:INT) { exit 1 }
+  if RUBY_PLATFORM !~ /mswin(?!ce)|mingw|cygwin|bccwin/
+    Signal.trap(:PIPE, 'IGNORE')
+  end
+
+  ReVIEW::TOCPrinter.execute(*ARGV)
+rescue Errno::EPIPE
+  exit 0
+end

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'
@@ -93,6 +90,7 @@ def main
   end
 rescue ReVIEW::Error => e
   raise if $DEBUG
+
   @logger.error e.message
   exit 1
 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

@@ -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
@@ -53,6 +52,7 @@ ARGF.each do |line|
     end
   elsif block == 'table'
     next if line.start_with?('#@')
+
     if line !~ /\A-----/
       # table
       colcount = line.split("\t").size

data/bin/review-vol

@@ -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/volumeprinter'
 

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

@@ -87,7 +87,7 @@ 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
@@ -208,11 +208,14 @@ toc: true
 # 各数字の意味は、順にリストの行数、リストの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:
 #    パラメータ: 値
@@ -423,4 +426,17 @@ pdfmaker:
   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

@@ -25,7 +25,7 @@ date: 2018-11-11
 history: [["2012-01-30"],["2016-04-20","2016-05-03"],["2018-11-11"]]
 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

data/doc/format.ja.md

@@ -2,7 +2,7 @@
 
 Re:VIEW フォーマットの文法について解説します。Re:VIEW フォーマットはアスキー社（現カドカワ）の EWB を基本としながら、一部に RD や各種 Wiki の文法を取り入れて簡素化しています。
 
-このドキュメントは、Re:VIEW 5.0 に基づいています。
+このドキュメントは、Re:VIEW 5.1 に基づいています。
 
 ## 段落
 
@@ -345,7 +345,7 @@ V1 --> V6 --|
 ```
 
 * `<imgdir>` はデフォルトでは images ディレクトリです。
-* `<builder>` は利用しているビルダ名（ターゲット名）で、たとえば `--target=html` としているのであれば、images/html ディレクトリとなります。
+* `<builder>` は利用しているビルダ名（ターゲット名）で、たとえば `--target=html` としているのであれば、images/html ディレクトリとなります。各 Maker におけるビルダ名は epubmaker および webmaker の場合は `html`、pdfmaker の場合は `latex`、textmaker の場合は `top` です。
 * `<chapid>` は章 ID です。たとえば ch01.re という名前であれば「ch01」です。
 * `<id>` は //image[〜] の最初に入れた「〜」のことです（つまり、ID に日本語や空白交じりの文字を使ってしまうと、後で画像ファイル名の名前付けに苦労することになります！）。
 * `<ext>` は Re:VIEW が自動で判別する拡張子です。ビルダによってサポートおよび優先する拡張子は異なります。
@@ -354,7 +354,7 @@ V1 --> V6 --|
 
 * HTMLBuilder (EPUBMaker、WEBMaker)、MARKDOWNBuilder: .png、.jpg、.jpeg、.gif、.svg
 * LATEXBuilder (PDFMaker): .ai、.eps、.pdf、.tif、.tiff、.png、.bmp、.jpg、.jpeg、.gif
-* それ以外のビルダ: .ai、.psd、.eps、.pdf、.tif、.tiff、.png、.bmp、.jpg、.jpeg、.gif、.svg
+* それ以外のビルダ・Maker: .ai、.psd、.eps、.pdf、.tif、.tiff、.png、.bmp、.jpg、.jpeg、.gif、.svg
 
 ### インラインの画像挿入
 
@@ -612,7 +612,7 @@ LaTeX の式を挿入するには、`//texequation{ 〜 //}` を使います。
 
 LaTeX の数式が正常に整形されるかどうかは処理系に依存します。LaTeX を利用する PDFMaker では問題なく利用できます。
 
-EPUBMaker および WEBMaker では、MathML に変換する方法と、画像化する方法のどちらかを選べます。
+EPUBMaker および WEBMaker では、MathML に変換する方法、MathJax に変換する方法、画像化する方法から選べます。
 
 ### MathML の場合
 MathML ライブラリをインストールしておきます（`gem install math_ml`）。
@@ -620,11 +620,20 @@ MathML ライブラリをインストールしておきます（`gem install mat
 さらに config.yml に以下のように指定します。
 
 ```
-mathml: true
+math_format: mathml
 ```
 
 なお、MathML で正常に表現されるかどうかは、ビューアやブラウザに依存します。
 
+### MathJax の場合
+config.yml に以下のように指定します。
+
+```
+math_format: mathjax
+```
+
+MathJax の JavaScript モジュールはインターネットから読み込まれます。現時点で EPUB の仕様では外部からの読み込みを禁止しているため、MathJax を有効にすると EPUB ファイルの検証を通りません。また、ほぼすべての EPUB リーダーで MathJax は動作しません。CSS 組版との組み合わせでは利用できる可能性があります。
+
 ### 画像化の場合
 
 LaTeX を内部で呼び出し、外部ツールを使って画像化する方法です。画像化された数式は、`images/_review_math` フォルダに配置されます。
@@ -639,7 +648,7 @@ TeXLive などの LaTeX 環境が必要です。必要に応じて config.yml
 config.yml で以下のように設定すると、
 
 ```
-imgmath: true
+math_format: imgmath
 ```
 
 デフォルト値として以下が使われます。
@@ -674,7 +683,7 @@ imgmath_options:
 たとえば SVG を利用するには、次のようにします。
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   format: svg
   pdfcrop_pixelize_cmd: "pdftocairo -svg -r 90 -f %p -l %p -singlefile %i %o"
@@ -685,7 +694,7 @@ imgmath_options:
 単一のページの処理を前提とする `sips` コマンドや `magick` コマンドを使う場合、入力 PDF から指定のページを抽出するように `extract_singlepage: true` として挙動を変更します。単一ページの抽出はデフォルトで TeXLive の `pdfjam` コマンドが使われます。
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   extract_singlepage: true
   # pdfjamの代わりに外部ツールのpdftkを使う場合（Windowsなど）
@@ -699,7 +708,7 @@ imgmath_options:
 textmaker 向けに PDF 形式の数式ファイルを作成したいときには、たとえば以下のように設定します（ページの抽出には pdftk を利用）。
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   format: pdf
   extract_singlepage: true
@@ -710,7 +719,7 @@ imgmath_options:
 Re:VIEW 2 以前の dvipng の設定に合わせるには、次のようにします。
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   converter: dvipng
   fontsize: 12
@@ -1013,6 +1022,8 @@ UL1-OL1-PARAGRAPH
 * `@<ttb>{〜}` : 等幅＋太字にします。
 * `@<code>{〜}` : 等幅にします（コードの引用という性質）。
 * `@<tcy>{〜}` : 縦書きの文書において文字を縦中横にします。
+* `@<ins>{〜}` : 挿入箇所を明示します（デフォルトでは下線が引かれます）。
+* `@<del>{〜}` : 削除箇所を明示します（デフォルトでは打ち消し線が引かれます）。
 
 ### 参照
 * `@<chap>{章ファイル名}` : 「第17章」のような、章番号を含むテキストに置換されます。

data/doc/format.md

@@ -4,7 +4,7 @@ The document is a brief guide for Re:VIEW markup syntax.
 
 Re:VIEW is based on EWB of ASCII (now KADOKAWA), influenced RD and other Wiki system's syntax.
 
-This document explains about the format of Re:VIEW 5.0.
+This document explains about the format of Re:VIEW 5.1.
 
 ## Paragraph
 
@@ -375,7 +375,7 @@ The order of finding image is as follows.  The first matched one is used.
 ```
 
 * ``<imgdir>`` is `images` as default.
-* ``<builder>`` is a builder (target) name to use.  When you use review-comile commmand with ``--target=html``, `<imagedir>/<builder>` is `images/html`.
+* ``<builder>`` is a builder (target) name to use.  When you use review-comile commmand with ``--target=html``, `<imagedir>/<builder>` is `images/html`. The builder name for epubmaker and webmaker is `html`, for pdfmaker it is `latex`, and for textmaker it is `top`.
 * ``<chapid>`` is basename of *.re file.  If the filename is `ch01.re`, chapid is `ch01`.
 * ``<id>`` is the ID of the first argument of `//image`.  You should use only printable ASCII characters as ID.
 * ``<ext>`` is file extensions of Re:VIEW.  They are different by the builder you use.
@@ -384,7 +384,7 @@ For each builder, image files are searched in order of the following extensions,
 
 * HTMLBuilder (EPUBMaker, WEBMaker), MARKDOWNBuilder: .png, .jpg, .jpeg, .gif, .svg
 * LATEXBuilder (PDFMaker): .ai, .eps, .pdf, .tif, .tiff, .png, .bmp, .jpg, .jpeg, .gif
-* Other builders: .ai, .psd, .eps, .pdf, .tif, .tiff, .png, .bmp, .jpg, .jpeg, .gif, .svg
+* Other builders/makers: .ai, .psd, .eps, .pdf, .tif, .tiff, .png, .bmp, .jpg, .jpeg, .gif, .svg
 
 ### Inline Images
 
@@ -645,7 +645,7 @@ There is `@<m>{ ... }` for inline (see "Fence notation for inline commands" sect
 
 Whether LaTeX formula is correctly displayed or not depends on the processing system. PDFMaker uses LaTeX internally, so there is no problem.
 
-EPUBMaker and WEBMaker use either MathML transformation or imaging.
+In EPUBMaker and WEBMaker, you can choose between MathML conversion, MathJax conversion, and imaging.
 
 ### MathML case
 Install MathML library (`gem install math_ml`).
@@ -653,11 +653,20 @@ Install MathML library (`gem install math_ml`).
 Specify in config.yml as follows:
 
 ```
-mathml: true
+math_format: mathml
 ```
 
 Whether it is displayed properly in MathML depends on your viewer or browser.
 
+### MathJax case
+Specify in config.yml as follows:
+
+```
+math_format: mathjax
+```
+
+MathJax JavaScript module is loaded from the Internet. Because the EPUB specification prohibits loading files from external, enabling this feature will cause the EPUB file to fail validation. Also MathJax will not work in almost all EPUB readers, but may be available with CSS formatting processor.
+
 ### imaging case
 
 This way calls LaTeX internally and images it with an external tool. Image files will be placed in `images/_review_math` folder.
@@ -672,7 +681,7 @@ In addition, external tools for image conversion are also needed. Currently, it
 By setting in config.yml,
 
 ```
-imgmath: true
+math_format: imgmath
 ```
 
 it is set as follows:
@@ -707,7 +716,7 @@ imgmath_options:
 For example, to make SVG:
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   format: svg
   pdfcrop_pixelize_cmd: "pdftocairo -svg -r 90 -f %p -l %p -singlefile %i %o"
@@ -718,7 +727,7 @@ By default, the command specified in `pdfcrop_pixelize_cmd` takes the filename o
 If you want to use the `sips` command or the` magick` command, they can only process a single page, so you need to set `extract_singlepage: true` to extract the specified page from the input PDF. `pdfjam` command (in TeXLive) is used to extract pages.
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   extract_singlepage: true
   # use pdftk instead of default pdfjam (for Windows)
@@ -732,7 +741,7 @@ imgmath_options:
 To create PDF math images:
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   format: pdf
   extract_singlepage: true
@@ -743,7 +752,7 @@ imgmath_options:
 To set the same setting as Re:VIEW 2:
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   converter: dvipng
   fontsize: 12
@@ -1054,6 +1063,8 @@ Output:
 @<ttb>{BarClass}:: teletype (monospaced font) and bold
 @<code>{a.foo(bar)}:: teletype (monospaced font) for fragments of code
 @<tcy>{}:: short horizontal text in vertical text
+@<ins>{sentence}:: inserted part (underline)
+@<del>{sentence}:: deleted part (strike through)
 ```
 
 ### References