review 5.0.0 → 5.3.0

data/bin/review-preproc

@@ -9,19 +9,20 @@
 # 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'
 require 'review/extentions'
 require 'review/logger'
-require 'lineinput'
+require 'review/lineinput'
+require 'review/loggable'
 require 'stringio'
 require 'fileutils'
 require 'optparse'
+require 'tempfile'
+
+include ReVIEW::Loggable
 
 def sigmain
   Signal.trap(:INT) { exit 1 }
@@ -33,16 +34,7 @@ rescue Errno::EPIPE
   exit 0
 end
 
-def main
-  @logger = ReVIEW.logger
-  if File.file?('review-preproc-ext.rb')
-    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'))
-    end
-  end
-
+def parse_options
   param = {}
 
   mode = :output
@@ -60,32 +52,42 @@ def main
   begin
     opts.parse!
   rescue OptionParser::ParseError => e
-    @logger.error e.message
+    error e.message
     $stderr.puts opts.help
     exit 1
   end
 
-  pp = ReVIEW::Preprocessor.new(ReVIEW::Repository.new(param), param)
-  current_file = nil
+  [param, mode]
+end
+
+def main
+  @logger = ReVIEW.logger
+  if File.file?('review-preproc-ext.rb')
+    if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0
+      warn 'review-preproc-ext.rb is prohibited in safe mode. ignored.'
+    else
+      Kernel.load(File.expand_path('review-preproc-ext.rb'))
+    end
+  end
+
+  param, mode = parse_options
+  pp = ReVIEW::Preprocessor.new(param)
   ARGV.each do |path|
-    current_file = path
     case mode
     when :output
-      File.open(path) { |f| pp.process(f, $stdout) }
+      $stdout.write(pp.process(path))
     when :replace
-      File.write("#{path}.pptmp", preproc(pp, path))
-      File.rename("#{path}.pptmp", path)
+      output = pp.process(path)
+      File.write(path, output)
     when :diff, :check
-      tmp = '/tmp/review.pptmp'
-      begin
-        File.write(tmp, preproc(pp, path))
+      Tempfile.create('review.pptmp') do |tmp_io|
+        tmp = tmp_io.path
+        tmp_io.write(pp.process(path))
         if mode == :check
           system("diff -qu #{path} #{tmp} >/dev/null || echo #{path}")
         else
           system("diff -u #{path} #{tmp}")
         end
-      ensure
-        FileUtils.rm_f(tmp)
       end
     else
       raise "must not happen: #{mode}"
@@ -93,18 +95,8 @@ 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) }
-  buf.string
-end
 
-def File.write(path, str)
-  File.open(path, 'w') { |f| f.write str }
+  error! e.message
 end
 
 sigmain

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:
 #    パラメータ: 値
@@ -338,6 +341,8 @@ epubmaker:
   #
   # 脚注に「戻る」リンクを追加する(trueで追加)。脚注の記号および戻るリンクの記号はlocale.ymlで変更可能
   # back_footnote: null
+  # 見出しに応じて<section>で囲むようにする(trueで<section>を利用)
+  # use_section: null
   # epubmaker:階層を使うものはここまで
 
 # LaTeX用のスタイルファイル(styディレクトリ以下に置くこと)
@@ -423,4 +428,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.3 に基づいています。
 
 ## 段落
 
@@ -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
 
 ### インラインの画像挿入
 
@@ -396,7 +396,7 @@ plot sin(x)
 * Gnuplot ( http://www.gnuplot.info/ ) : `gnuplot` コマンドへのパスを OS に設定すること
 * Blockdiag ( http://blockdiag.com/ ) : `blockdiag` コマンドへのパスを OS に設定すること。PDF を生成する場合は ReportLab もインストールすること
 * aafigure ( https://launchpad.net/aafigure ) : `aafigure` コマンドへのパスを OS に設定すること
-* PlantUML ( http://plantuml.com/ ) : `java` コマンドへのパスを OS に設定し、`plantuml.jar` が作業フォルダにあること
+* PlantUML ( http://plantuml.com/ ) : `java` コマンドへのパスを OS に設定し、`plantuml.jar` が作業フォルダ、または `/usr/share/plantuml` あるいは `/usr/share/java` フォルダにあること
 
 ## 表
 
@@ -524,6 +524,7 @@ Re:VIEW 5.0 以降では、囲み記事に箇条書きや図表・リストを
 ```
 パッケージは本書のサポートサイトから入手できます@<fn>{site}。
 各自ダウンロードしてインストールしておいてください。
+
 //footnote[site][本書のサポートサイト： http://i.loveruby.net/ja/stdcompiler ]
 ```
 
@@ -538,6 +539,31 @@ TeX PDF において、コラム以外の `//note` などの囲み記事の中
 
 ただし、通常の脚注（footnote）ではなく、footnotemark と footnotetext を使うため、本文と脚注が別ページに分かれる可能性があるなど、いろいろな制約があります。また、採番が別々になるため、footnote と footnotemark/footnotetext を両立させることはできません。
 
+## 後注
+
+後注（最後にまとめて出力される注釈）は、「`//endnote`」を使って記述します。
+
+```
+パッケージは本書のサポートサイトから入手できます@<endnote>{site}。
+各自ダウンロードしてインストールしておいてください。
+
+//endnote[site][本書のサポートサイト： http://i.loveruby.net/ja/stdcompiler ]
+```
+
+本文中のインライン命令「`@<endnote>{site}`」は後注番号に置換され、「本書のサポートサイト……」という文は後注として内部に保存されます。
+
+保存されている後注を書き出すには、書き出したい箇所（通常は章の末尾）に「`//printendnotes`」を置きます。
+
+```
+ …
+
+==== 注釈
+
+//printendnotes
+```
+
+後注の管理は章 (re ファイル) 単位であり、複数の章にまたがった後注を作ることはできません。
+
 ## 参考文献の定義
 
 参考文献は同一ディレクトリ内の `bib.re` ファイルに定義します。
@@ -612,7 +638,7 @@ LaTeX の式を挿入するには、`//texequation{ 〜 //}` を使います。
 
 LaTeX の数式が正常に整形されるかどうかは処理系に依存します。LaTeX を利用する PDFMaker では問題なく利用できます。
 
-EPUBMaker および WEBMaker では、MathML に変換する方法と、画像化する方法のどちらかを選べます。
+EPUBMaker および WEBMaker では、MathML に変換する方法、MathJax に変換する方法、画像化する方法から選べます。
 
 ### MathML の場合
 MathML ライブラリをインストールしておきます（`gem install math_ml`）。
@@ -620,11 +646,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 +674,7 @@ TeXLive などの LaTeX 環境が必要です。必要に応じて config.yml
 config.yml で以下のように設定すると、
 
 ```
-imgmath: true
+math_format: imgmath
 ```
 
 デフォルト値として以下が使われます。
@@ -674,10 +709,10 @@ 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"
+  pdfcrop_pixelize_cmd: "pdftocairo -%t -r 90 -f %p -l %p %i %o"
 ```
 
 デフォルトでは、pdfcrop_pixelize_cmd に指定するコマンドは、1ページあたり1数式からなる複数ページの PDF のファイル名を `%i` プレースホルダで受け取り、`%p` プレースホルダのページ数に基づいて `%o`（拡張子あり）または `%O`（拡張子なし）の画像ファイルに書き出す、という仕組みになっています。
@@ -685,7 +720,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 +734,7 @@ imgmath_options:
 textmaker 向けに PDF 形式の数式ファイルを作成したいときには、たとえば以下のように設定します（ページの抽出には pdftk を利用）。
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   format: pdf
   extract_singlepage: true
@@ -710,7 +745,7 @@ imgmath_options:
 Re:VIEW 2 以前の dvipng の設定に合わせるには、次のようにします。
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   converter: dvipng
   fontsize: 12
@@ -1013,6 +1048,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.3.
 
 ## 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
 
@@ -423,7 +423,7 @@ Before using these tools, you should installed them and configured path appropri
 * Gnuplot ( http://www.gnuplot.info/ ) : set path to `gnuplot` command
 * Blockdiag ( http://blockdiag.com/ ) : set path to `blockdiag` command. Install ReportLab also to make a PDF
 * aafigure ( https://launchpad.net/aafigure ) : set path to `aafigure` command
-* PlantUML ( http://plantuml.com/ ) : set path to `java` command. place `plantuml.jar` on working folder
+* PlantUML ( http://plantuml.com/ ) : set path to `java` command. place `plantuml.jar` on working folder, `/usr/share/plantuml` or `/usr/share/java`.
 
 ## Tables
 
@@ -551,6 +551,7 @@ Usage:
 ```
 You can get the packages from support site for the book.@<fn>{site}
 You should get and install it before reading the book.
+
 //footnote[site][support site of the book: http://i.loveruby.net/ja/stdcompiler ]
 ```
 
@@ -572,6 +573,34 @@ Note that with this option, Re:VIEW use footnotemark and footnotetext instead of
 There are some constraints to use this option.
 You cannot use footnote and footnotemark/footnotetext at the same time.
 
+## Endnotes
+
+You can use `//endnote` to write endnotes.
+
+Usage:
+
+```
+You can get the packages from support site for the book.@<endnote>{site}
+You should get and install it before reading the book.
+
+//endnote[site][support site of the book: http://i.loveruby.net/ja/stdcompiler ]
+```
+
+`@<endnote>{site}` in source are replaced by endnote marks, and the phrase "support site of .."
+is stored for printing later.
+
+To print stored endnotes, place "`//printendnotes`" where you want to write down them (usually at the end of the chapter).
+
+```
+ ...
+
+==== Endnote
+
+//printendnotes
+```
+
+It is not possible to create an endnote that spans multiple chapters.
+
 ## Bibliography
 
 When you want to use a bibliography, you should write them in the file `bib.re`.
@@ -645,7 +674,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 +682,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 +710,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,10 +745,10 @@ 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"
+  pdfcrop_pixelize_cmd: "pdftocairo -%t -r 90 -f %p -l %p %i %o"
 ```
 
 By default, the command specified in `pdfcrop_pixelize_cmd` takes the filename of multi-page PDF consisting of one formula per page.
@@ -718,7 +756,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 +770,7 @@ imgmath_options:
 To create PDF math images:
 
 ```
-imgmath: true
+math_format: imgmath
 imgmath_options:
   format: pdf
   extract_singlepage: true
@@ -743,7 +781,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 +1092,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

data/doc/quickstart.ja.md

@@ -8,7 +8,7 @@ Re:VIEW は GNU Lesser General Public License Version 2.1 に基づいて配布
 
 このドキュメントでは、Re:VIEW のセットアップから変換の例までを簡単に説明します。
 
-このドキュメントは、Re:VIEW 4.2 に基づいています。
+このドキュメントは、Re:VIEW 5.1 に基づいています。
 
 ## セットアップ
 
@@ -160,6 +160,16 @@ config.yml のサンプルについては以下を参照してください。
 
 * [config.yml.sample](https://github.com/kmuto/review/blob/master/doc/config.yml.sample)
 
+#### Vivliostyle CLI を使った PDF 化
+
+TeX (`review-pdfmaker`、`rake pdf`) を利用する代わりに、[Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli) を使って PDF を作成することもできます。Re:VIEW が EPUB を作成したあと、VivliostyleCLI がそれを PDF に変換します。
+
+```bash
+$ rake vivliostyle:build    ← Vivliostyle を使って PDF を作成
+$ rake vivliostyle:preview  ← Chrome/Chromium ブラウザでプレビュー
+$ rake vivliostyle          ← vivliostyle:buildのショートカット
+```
+
 ### 章を増やす、カスタマイズする
 作成した PDF あるいは EPUB を見ると、先に作成した RE:VIEW フォーマットテキストファイルが「第1章」となっていることがわかります。
 

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.2.
+The supported version of the article is Re:VIEW 5.1.
 
 ## Set up Re:VIEW
 
@@ -161,6 +161,16 @@ $ rake idgxml    ## generate InDesign XML
 
 There is a sample YAML file [config.yml.sample](https://github.com/kmuto/review/blob/master/doc/config.yml.sample) in the same directory of this document.
 
+#### generate PDF using Vivliostyle CLI
+
+Instead of using TeX (`review-pdfmaker` or `rake pdf`), you can also create a PDF use [Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli). Re:VIEW creates EPUB first and then converts it to PDF with Vivliostyle CLI.
+
+```bash
+$ rake vivliostyle:build    ## build PDF using Viliostyle
+$ rake vivliostyle:preview  ## preview pages in Chrome/Chromium browser
+$ rake vivliostyle          ## shortcut of vivliostyle:build
+```
+
 ### add chapters and modify them
 
 `catalog.yml` file is a catalog of Re:VIEW format files.
@@ -182,7 +192,6 @@ POSTDEF:
 
 The first item in CHAPS is the first chapter, and the second item (if you add) is the second chapter. PREDEF is for front matter, APPENDIX is for appendix, and POSTDEF is for back matter.  You can see in detail with [catalog.md](https://github.com/kmuto/review/blob/master/doc/catalog.ja.md).
 
-
 ### more information
 
 For more information about Re:VIEW format, see [format.md](https://github.com/kmuto/review/blob/master/doc/format.md).

data/doc/writing_vertical.ja.md

@@ -35,6 +35,12 @@ body {
     -epub-writing-mode:   vertical-rl;
     writing-mode: tb-rl;
 }
+
+span.tcy {
+    -webkit-text-combine: horizontal;
+    -ms-text-combine-horizontal: all;
+    text-combine-upright: all;
+}
 ```
 
 また、縦書きの書籍は通常、「左開き」（右ページから左ページへ進む）となるので、config.yml の direction パラメータを設定します。