review 3.1.0 → 5.0.0

data/Dockerfile

@@ -9,13 +9,29 @@
 #
 # cf. https://github.com/vvakame/docker-review/blob/master/Dockerfile
 
-FROM debian:sid
+FROM debian:buster
 MAINTAINER takahashim
 
-RUN apt-get update \
-	&& apt-get install -y --no-install-recommends git-core ruby locales zip \
-    && apt-get install -y --no-install-recommends texlive-lang-cjk texlive-lang-japanese texlive-fonts-recommended texlive-latex-extra ghostscript \
-	&& rm -rf /var/lib/apt/lists/*
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+      locales git-core curl ca-certificates && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+RUN echo "en_US.UTF-8 UTF-8" >> /etc/locale.gen
+RUN locale-gen en_US.UTF-8 && update-locale en_US.UTF-8
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+      texlive-lang-japanese texlive-fonts-recommended texlive-latex-extra lmodern fonts-lmodern cm-super tex-gyre fonts-texgyre texlive-pictures texlive-plain-generic \
+      ghostscript gsfonts \
+      zip ruby-zip \
+      ruby-nokogiri mecab ruby-mecab mecab-ipadic-utf8 poppler-data \
+      mecab-jumandic- mecab-jumandic-utf8- \
+      texlive-extra-utils poppler-utils && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+RUN kanji-config-updmap-sys ipaex
+
 RUN gem install review rake bundler --no-rdoc --no-ri
 
 VOLUME ["/work"]

data/NEWS.ja.md

@@ -1,3 +1,397 @@
+# Version 5.0.0
+## 新機能
+* review-jsbook / review-jlreq クラスに、`cover_fit_page` オプションを追加しました。`texdocumentclass` パラメータに `cover_fit_page=true` を付けると、画像サイズがどのようなものであっても仕上がりサイズに拡縮して表紙に貼り込みます。なお、制作において図版は実寸で作成することを推奨します ([#1534])
+* 小さな囲み要素 (`//note`, `//memo`, `//tip`, `//info`, `//warning`, `//important`, `//caution`, `//notice`) の中で、`//image` などのブロック命令を含めたり、および箇条書きを入れたりできるようになりました。拡張で類似のことを利用したいときには、defminicolumn で定義します ([#1558], [#1562])
+* 箇条書きの入れ子を指示する命令として `//beginchild`, `//endchild` という1行命令を追加しました。箇条書きの子にしたいものを `//beginchild` と `//endchild` で囲むと、前に位置する箇条書きの子要素になります。**この機能は実験的です。今後のバージョンで挙動を変えたり廃止したりする可能性があります** ([#1497])
+
+## 非互換の変更
+* review-jlreq.cls における hiddenfolio の配置を、jlreqtrimmarkssetup を使って実装するように変更しました。以前のバージョンとは位置や表示に若干の違いがあります ([#1397])
+* `chapterlink` パラメータのデフォルト値を true (有効) にしました。これが有効になっているときには、Web、EPUB での章・項の参照や、図表・リスト・式・参考文献の参照などがハイパーリンク化されます。TeX PDF においては `media=ebook` のときのみ、章・項・参考文献の参照がハイパーリンク化されます ([#1529])
+
+## バグ修正
+* PDFMaker: 同名で拡張子違いの図版ファイルがあるときに、位置がずれる問題を修正しました。extractbb コマンドは明示的に呼び出されなくなります ([#1483])
+* PDFMaker: 著者名 (`aut`) パラメータが空のときにエラーになる問題を修正しました ([#1517])
+* PDFMaker: `//indepimage` 命令で画像が存在せず、かつ ID に TeX のエスケープ対象となる文字を含んでいるとエラーが起きる問題を修正しました ([#1527])
+* PDFMaker: `bookttilename` や `aut` パラメータに TeX のエスケープ対象となる文字を入れると PDF メタ情報がおかしくなる問題を修正しました (`media=ebook` のときのみ) ([#1533])
+* WebMaker: HTML テンプレートで nil が入ってしまうのを修正しました ([#1545])
+* PDFMaker: 章番号を非表示にするとエラーで失敗するのを修正しました ([#1559])
+* MarkdownBuilder: note 等の中の段落を改行区切りではなく空行区切りにしました ([#1572])
+
+## 機能強化
+* 図表などのアイテムでエラーが発生したときの表示を詳細にしました ([#1523])
+* PDFMaker: `@<hd>` 命令で展開した項・段について、`media=ebook` のときにはハイパーリンクになるようにしました ([#1530])
+* HTMLBuilder および IDGXMLBuilder において、文字列のエスケープを従来の `cgi/util` の代わりにより高速な `cgi/escape` が利用できるときにはそれを利用するようにしました。また、`ReVIEW::HTMLUtils.escape` も書き換えられました ([#1536])
+* `@<icon>` 命令の利用時に ID の重複の警告が出るのを抑制しました ([#1541])
+* 不正なエンコーディングのファイルを受け取ったときに妥当なエラー表示をするようにしました ([#1544])
+* IndexBuilder を導入しました。これまで図表等の番号の管理および参照はその都度対象ファイルを解析する方法でしたが、IndexBuilder はプロジェクト全体を走査し、以降の各ビルダのために番号を提供します。review-ext.rb でブロック命令やインライン命令を追加していた場合、IndexBuilder クラス (またはその基底クラスである Builder クラス) にも追加が必要です ([#1384], [#1552])
+* ID やラベルに以下の文字または空白文字が含まれていると、TeX のコンパイルあるいは生成される EPUB においてエラーが発生するため、これらの文字が含まれているときには警告を出すようにしました ([#1393], [#1574])
+```
+#%\{}[]~/$'"|*?&<>`
+```
+
+## ドキュメント
+* format.ja.md と format.md のタイプミスを修正しました ([#1528])
+* makeindex.ja.md のサンプル結果の誤りを修正しました ([#1584])
+
+## その他
+* Rubocop 0.92.0 に対応しました ([#1511], [#1569], [#1573])
+* `Re:VIEW::Compiler` 内の `@strategy` は実際はビルダなので、`@builder` という名前に変更しました ([#1520])
+* Rubocop-performance 1.7.1 に対応しました ([#1521])
+* syntax-book サンプルドキュメントの Gemfile を更新しました ([#1522])
+* ImageMagick における GhostScript の呼び出しが非推奨となったため、テストを除去しました ([#1526])
+* 一部のテストユニットの不要な標準エラー出力を抑制しました ([#1538])
+* `Compilable` モジュールの代わりに、`Chapter` および `Part` のスーパークラスとなる `BookUnit` 抽象クラスを導入しました ([#1543])
+* `ReVIEW::Book::Base.load` をやめ、`ReVIEW::Book::Base.load` または `ReVIEW::Book::Base.new` を使うようにしました。`ReVIEW::Book::Base.load` に `:config` オプションを加えました ([#1548], [#1563])
+* 内部のパラメータの汎用構成のために `ReVIEW::Configure.create` コンストラクタを導入しました ([#1549])
+* WebMaker: 使われていない `clean_mathdir` メソッドを削除しました ([#1550])
+* catalog.yml の解析を `ReVIEW::Book::Base.new` の中で最初に実行するようにしました ([#1551])
+* ファイルの書き出しで可能なところは `File.write` を使うようにしました ([#1560])
+* Builder クラスの `builder_init` メソッドを削除し、`initialize` を使うようにしました ([#1564])
+
+## コントリビューターのみなさん
+* [@snoozer05](https://github.com/snoozer05)
+
+[#1384]: https://github.com/kmuto/review/pull/1384
+[#1393]: https://github.com/kmuto/review/issues/1393
+[#1397]: https://github.com/kmuto/review/issues/1397
+[#1483]: https://github.com/kmuto/review/issues/1483
+[#1497]: https://github.com/kmuto/review/pull/1497
+[#1511]: https://github.com/kmuto/review/pull/1511
+[#1517]: https://github.com/kmuto/review/issues/1517
+[#1520]: https://github.com/kmuto/review/pull/1520
+[#1521]: https://github.com/kmuto/review/pull/1521
+[#1522]: https://github.com/kmuto/review/pull/1522
+[#1523]: https://github.com/kmuto/review/pull/1523
+[#1526]: https://github.com/kmuto/review/pull/1526
+[#1527]: https://github.com/kmuto/review/pull/1527
+[#1528]: https://github.com/kmuto/review/pull/1528
+[#1529]: https://github.com/kmuto/review/issues/1529
+[#1530]: https://github.com/kmuto/review/issues/1530
+[#1533]: https://github.com/kmuto/review/issues/1533
+[#1534]: https://github.com/kmuto/review/issues/1534
+[#1536]: https://github.com/kmuto/review/pull/1536
+[#1538]: https://github.com/kmuto/review/pull/1538
+[#1541]: https://github.com/kmuto/review/pull/1541
+[#1543]: https://github.com/kmuto/review/pull/1543
+[#1544]: https://github.com/kmuto/review/issues/1544
+[#1545]: https://github.com/kmuto/review/issues/1545
+[#1548]: https://github.com/kmuto/review/pull/1548
+[#1549]: https://github.com/kmuto/review/pull/1549
+[#1550]: https://github.com/kmuto/review/pull/1550
+[#1551]: https://github.com/kmuto/review/pull/1551
+[#1552]: https://github.com/kmuto/review/pull/1552
+[#1558]: https://github.com/kmuto/review/pull/1558
+[#1559]: https://github.com/kmuto/review/issues/1559
+[#1560]: https://github.com/kmuto/review/pull/1560
+[#1562]: https://github.com/kmuto/review/pull/1562
+[#1563]: https://github.com/kmuto/review/pull/1563
+[#1564]: https://github.com/kmuto/review/pull/1564
+[#1569]: https://github.com/kmuto/review/pull/1569
+[#1572]: https://github.com/kmuto/review/pull/1572
+[#1573]: https://github.com/kmuto/review/pull/1573
+[#1574]: https://github.com/kmuto/review/issues/1574
+[#1584]: https://github.com/kmuto/review/pull/1584
+
+# Version 4.2.0
+## 新機能
+* 図・表・リスト・式のキャプションの位置を内容の上側・下側どちらにするかを指定する `caption_position` パラメータを追加しました。`caption_position` の下位パラメータとして `image`・`table`・`list`・`equation` のパラメータがあり、値として `top` (上側) または `bottom` (下側) を指定します。デフォルトは `image` のみ `bottom`、ほかは `top` です ([#1320])
+
+## 非互換の変更
+* review-vol を再構成しました。部の処理や見出し内のインライン命令の処理を正しました。表示形式をわかりやすい形に変更しました。部を指定したときに部のボリュームではなく、部ファイル単体のボリュームを返すようにしました。`-P`, `--directory` オプションは廃止しました ([#1485])
+* review-index を再構成しました。オプション名を大幅に変更しています。行数・文字数は `-d` オプションを指定したときのみ表示するようにしました。また、ファイルの行数・文字数ではなく、PLAINTEXTBuilder を利用して、変換結果に近い行数・文字数を返すようにしました (review-vol よりも正確です)。特定の章は `-y` オプションで複数指定できるようにしました ([#1485])
+
+## バグ修正
+* 重複する `@non_parsed_commands` 宣言を削除しました ([#1499])
+* WebMaker、TextMaker で数式画像が作成されない問題を修正しました ([#1501])
+
+## 機能強化
+* imgmath での数式画像の作成処理を最適化し、高速化しました ([#1488])
+* デフォルト以外の固有の YAML 設定を PDFMaker に引き渡したいときのために、`layouts/config-local.tex.erb` ファイルが存在すればそれを評価・読み込みするようにしました ([#1505])
+
+## その他
+* GitHub Actions を eregon/use-ruby-action から ruby/setup-ruby に切り替えました ([#1490])
+* テストの際、samples フォルダ内にあるビルド成果物を無視するようにしました ([#1504])
+
+[#1320]: https://github.com/kmuto/review/issues/1320
+[#1485]: https://github.com/kmuto/review/issues/1485
+[#1488]: https://github.com/kmuto/review/issues/1488
+[#1490]: https://github.com/kmuto/review/pull/1490
+[#1499]: https://github.com/kmuto/review/issues/1499
+[#1501]: https://github.com/kmuto/review/pull/1501
+[#1504]: https://github.com/kmuto/review/pull/1504
+[#1505]: https://github.com/kmuto/review/issues/1505
+
+# Version 4.1.0
+## 新機能
+* 表のセル区切りの文字を `table_row_separator` パラメータで変更できるようにしました。指定可能な値は tabs (1個以上のタブ、デフォルト)、singletab (1文字のタブ文字区切り)、spaces (1文字以上のスペースまたはタブ文字の区切り)、 verticalbar ("0個以上の空白 | 0個以上の空白" の区切り) です ([#1420])
+* PDFMaker, EPUBMaker, WEBMaker, TEXTMaker, IDGXMLMaker: 全ファイルでなく変換対象ファイルを指定するための `-y`（または`--only`）オプションを追加しました ([#1428], [#1467])
+* config.yml のコメント行を含めないようにする `--without-config-comment` オプションを review-init に追加しました ([#1453])
+* PDFMaker: `pdfmaker` セクションに `use_original_image_size` パラメータを新設しました。デフォルトでは `//image`, `//indepimage`, `//imgtable` で挿入する画像において、metrics の指定がないときには版面の横幅に合うよう拡縮しますが、`use_original_image_size` パラメータを true に設定すると、拡縮なしで原寸のまま配置します ([#1461])
+
+## 非互換の変更
+* PDFMaker: config.yml の `image_scale2width` パラメータを、直下から `pdfmaker` セクションの下に属するように変更しました ([#1462])
+
+## バグ修正
+* PDFMaker: Re:VIEW 3 系のプロジェクトとの後方互換処理の誤りを修正しました ([#1414])
+* PDFMaker: review-jlreq を LuaLaTeX でコンパイルしたときのエラーを修正しました ([#1416])
+* PDFMaker: 索引が目次に含まれない問題を修正しました ([#1418])
+* RSTBuilder: メソッドの引数の誤りで変換に失敗する問題を修正しました ([#1426])
+* IDGXMLBuilder: 表に関する警告を出すときの誤りを修正しました ([#1427])
+* IDGXMLMaker: フィルタプログラムにエラーが発生したときの処理の誤りを修正しました ([#1429])
+* PDFMaker: `media=ebook` のときに、見出し等に `@<code>` や `@<tt>` のようなコード書体の命令を使うとビルドに失敗する問題を修正しました ([#1432], [#1465])
+* PDFMaker: MeCab がインストールされていないときにエラーになるのを警告に変更しました ([#1445])
+* IDGXMLBuilder: `//imgtable` が正しく動作しなかったのを修正しました ([#1448])
+* PDFMaker: 索引が1つも登録されていない状態で makeindex を有効にするとエラーになるのを修正しました ([#1467])
+* PDFMaker: 説明箇条書き (`:`) の見出しに脚注を入れると消えてしまうのを修正しました ([#1476])
+* review-index: `@<w>` が見出しに使われているときにエラーになるのを修正しました ([#1484])
+
+## 機能強化
+* PDFMaker: 問題報告の解析に役立つよう、提供する cls、sty ファイルについてバージョンを付けるようにしました ([#1163])
+* Dockerfile を更新しました ([#1412])
+* IDGXMLMaker: フィルタプログラムの標準エラー出力を警告扱いで出力するようにしました ([#1443])
+* .gitignore ファイルに 〜-idgxml フォルダ を追加しました ([#1448])
+* `//source` 命令は全ビルダでオプションを省略できるようになりました ([#1447])
+* Ruby 2.7 をテスト対象に加えました ([#1468])
+* `word_files` パラメータは配列で複数の単語 CSV ファイルを受け付けるようになりました ([#1469])
+* EPUBMaker: 見出しが1つもない .re ファイルについて警告を出すようにしました。EPUB においてはファイル内に見出しが必ず1つは必要です。見出しを入れたくないときには、`=[notoc]` (目次に入れない) や `=[nodisp]` (目次に入れず表示もしない) を使用してください ([#1474])
+
+## ドキュメント
+* 奥付に関係する `contact` （連絡先）および `colophon_order` （項目の掲載順序）についてのドキュメントを設定ファイルサンプル `config.yml.sample` に追加しました ([#1425])
+* quickstart.ja.md, quickstart.md を Re:VIEW 4 の内容に更新しました ([#1442])
+* サンプル syntax-book を更新しました ([#1448], [#1449])
+* README.md を更新しました ([#1455], [#1458])
+* 図版のビルダ固有オプション `::` の記法を format.ja.md, format.md に記載しました ([#1421])
+
+## その他
+* Rubocop 0.78.0 の指摘に対応しました ([#1424], [#1430])
+* LaTeX の実行環境がある場合、PDF のビルドテストをより厳密に実行するようにしました ([#1433])
+* ビルドテストを Travis CI から GitHub Actions に切り替えました ([#1431], [#1436], [#1437])
+* IDGXMLBuilder のコードリストの処理をリファクタリングしました ([#1438], [#1439])
+* サンプル syntax-book に入っていた review-ext.rb はもう不要なので削除しました ([#1446])
+* IDGXMLMaker, TextMaker のテストを追加しました ([#1448])
+* Index 関連の処理をリファクタリングしました ([#1456], [#1457], [#1459])
+* jsclasses パッケージを 2020/02/02 バージョンに更新しました ([#1478])
+
+## コントリビューターのみなさん
+* [@turky](https://github.com/turky)
+
+[#1163]: https://github.com/kmuto/review/issues/1163
+[#1412]: https://github.com/kmuto/review/pull/1412
+[#1414]: https://github.com/kmuto/review/issues/1414
+[#1416]: https://github.com/kmuto/review/issues/1416
+[#1418]: https://github.com/kmuto/review/issues/1418
+[#1420]: https://github.com/kmuto/review/issues/1420
+[#1421]: https://github.com/kmuto/review/issues/1421
+[#1424]: https://github.com/kmuto/review/pull/1424
+[#1425]: https://github.com/kmuto/review/pull/1425
+[#1426]: https://github.com/kmuto/review/pull/1426
+[#1427]: https://github.com/kmuto/review/pull/1427
+[#1428]: https://github.com/kmuto/review/pull/1428
+[#1429]: https://github.com/kmuto/review/pull/1429
+[#1430]: https://github.com/kmuto/review/pull/1430
+[#1431]: https://github.com/kmuto/review/pull/1431
+[#1432]: https://github.com/kmuto/review/issues/1432
+[#1433]: https://github.com/kmuto/review/pull/1433
+[#1436]: https://github.com/kmuto/review/pull/1436
+[#1437]: https://github.com/kmuto/review/issues/1437
+[#1438]: https://github.com/kmuto/review/pull/1438
+[#1439]: https://github.com/kmuto/review/pull/1439
+[#1442]: https://github.com/kmuto/review/issues/1442
+[#1443]: https://github.com/kmuto/review/pull/1443
+[#1445]: https://github.com/kmuto/review/pull/1445
+[#1446]: https://github.com/kmuto/review/pull/1446
+[#1447]: https://github.com/kmuto/review/issues/1447
+[#1448]: https://github.com/kmuto/review/pull/1448
+[#1449]: https://github.com/kmuto/review/pull/1449
+[#1453]: https://github.com/kmuto/review/pull/1453
+[#1455]: https://github.com/kmuto/review/pull/1455
+[#1456]: https://github.com/kmuto/review/pull/1456
+[#1457]: https://github.com/kmuto/review/pull/1457
+[#1458]: https://github.com/kmuto/review/pull/1458
+[#1459]: https://github.com/kmuto/review/pull/1459
+[#1461]: https://github.com/kmuto/review/issues/1461
+[#1462]: https://github.com/kmuto/review/issues/1462
+[#1465]: https://github.com/kmuto/review/pull/1465
+[#1466]: https://github.com/kmuto/review/pull/1466
+[#1467]: https://github.com/kmuto/review/pull/1467
+[#1468]: https://github.com/kmuto/review/pull/1468
+[#1469]: https://github.com/kmuto/review/issues/1469
+[#1474]: https://github.com/kmuto/review/issues/1474
+[#1476]: https://github.com/kmuto/review/issues/1476
+[#1478]: https://github.com/kmuto/review/issues/1478
+[#1484]: https://github.com/kmuto/review/pull/1484
+
+# Version 4.0.0
+## 新機能
+* IDGXML ファイルをまとめて生成する、review-idgxmlmaker を導入しました ([#1337])
+* review-textmaker は、imgmath パラメータが有効になっている場合に、数式を画像化するようになりました ([#1338])
+* review-init に `-w` オプションを指定することで、Web ブラウザ上で TeX のレイアウトができるウィザードモードを用意しました。なお、この機能は実験的であり、将来別のものに置き換える可能性もあります ([#1403])
+* 実験的実装として、複数行から段落を結合する際に、前後の文字の種類に基づいて空白文字の挿入を行う機能を追加しました。この機能を利用するには、unicode-eaw gem をインストールした上で、config.yml に `join_lines_by_lang: true` を追加してください ([#1362])
+
+## 非互換の変更
+* 通常の利用では使われることがないので、review-init の実行時に空の layouts フォルダを作成するのをやめました ([#1340])
+* PDFMaker: `@<code>`、`@<tt>`、`@<tti>`、`@<ttb>` で空白文字が消えてしまう問題を修正しました。および利便性のために、文字列が版面からあふれるときに途中で改行するようにもしました ([#1348])
+* `//texequation`、`//embed`、`//graph` はもともとインライン命令を許容しないので、内容のエスケープもしないようにしました。また、末尾に余計な空行が加わるのも防ぐようにしました ([#1371], [#1374])
+* PDFMaker: コラム内での使用を考えて、表の配置のデフォルトを htp (指定位置→ページ上→独立ページの順に試行) から H (絶対に指定位置) にしました (review-style.sty の `\floatplacement{table}` の値) [#1385]
+* PDFMaker: コードリスト内では和文欧文間の空きを 1/4 文字ではなく 0 にするようにしました ([#1401])
+* config.yml の目次を制御する toc パラメータの値は、これまで null (false、目次は作らない) でしたが、一般的な利用方法を鑑みて、デフォルトを true (目次を作る) に切り替えました ([#1405])
+
+## バグ修正
+* review-jlreq がタイプミスのために一部の jlreq.cls バージョンで正しく動作しないのを修正しました ([#1350])
+* re ファイルが改行コード CR で記述されたときに不正な結果になるのを修正しました ([#1341])
+* PDFMaker: review-jlreq において `//cmd` のブロックがページをまたいだときに文字色が黒になって見えなくなってしまうのを修正しました ([#1363])
+* PDFMaker: `@<column>` で「コラム」ラベルが重複して出力されるのを修正しました ([#1367])
+* PDFMaker: gentombow.sty と jsbook.cls は review-jsbook の場合のみコピーするようにしました ([#1381])
+* PDFMaker: LuaLaTeX で review-jlreq を使ったときに壊れた PDFDocumentInformation ができる問題を修正しました ([#1392])
+* PDFMaker: review-jlreq で偶数ページに隠しノンブルが入らなかったのを修正しました ([#1395])
+
+## 機能強化
+* IDGXML ビルダで `@<em>` および `@<strong>` をサポートしました ([#1353])
+* PDFMaker: コードブロックの各行の処理を `code_line`, `code_line_num` のメソッドに切り出しました ([#1368])
+* PDFMaker: デフォルトのコンパイルオプションに `-halt-on-error` を追加しました。TeX のコンパイルエラーが発生したときに即終了することで問題が把握しやすくなります ([#1378])
+* PDFMaker: コラム内に脚注 (`@<fn>`) があるときの挙動がコラムの実装手段によって異なり、番号がずれるなどの問題を起こすことがあるため、脚注の文章 (`//footnote`) はコラムの後に置くことを推奨します。コラム内に脚注文章が存在する場合は警告するようにしました ([#1379])
+* YAML ファイルのエラーチェックを強化しました ([#1386])
+* Logger での表示時に標準の progname を使うようにしました ([#1388])
+* PDFMaker: 電子版の作成時に、表紙のページ番号を偶数とし、名前を「cover」にするようにしました ([#1402])
+* PDFMaker: `generate_pdf` メソッドのリファクタリングを行いました ([#1404])
+* プロジェクトの新規作成時に登録除外ファイル一覧の .gitignore ファイルを置くようにしました ([#1407])
+
+## ドキュメント
+* sample-book の README.md を更新しました ([#1354])
+* review-jsbook の README.md に jsbook.cls のオプションの説明を追加しました ([#1365])
+
+## その他
+* メソッド引数のコーディングルールを統一しました ([#1360])
+* `Catalog#{chaps,parts,predef,postdef,appendix}` は String ではなく Array を返すようにしました ([#1372])
+* YAML ファイルの読み込みに `safe_load` を使うようにしました ([#1375])
+* `table` メソッドをリファクタリングし、ビルダ個々の処理を簡略化しました ([#1356])
+* `XXX_header` と `XXX_body` まわりをリファクタリングしました ([#1359])
+* `Builder#highlight?` メソッドを HTMLBuilder 以外でも利用できるようにしました ([#1373])
+* mkchap* と mkpart* まわりをリファクタリングしました ([#1383])
+* Travis CI で rubygems を更新しないようにしました ([#1389])
+* Index まわりをリファクタリングしました ([#1390])
+* samples フォルダのサンプルドキュメントに review-jlreq のための設定を追加しました ([#1391])
+* 用語リストは `:` の前にスペースを入れることを強く推奨するようにしました。スペースがない場合、警告されます ([#1398])
+
+## コントリビューターのみなさん
+* [@m-shibata](https://github.com/m-shibata)
+* [@masarakki](https://github.com/masarakki)
+
+[#1337]: https://github.com/kmuto/review/issues/1337
+[#1338]: https://github.com/kmuto/review/issues/1338
+[#1340]: https://github.com/kmuto/review/issues/1340
+[#1341]: https://github.com/kmuto/review/issues/1341
+[#1348]: https://github.com/kmuto/review/issues/1348
+[#1350]: https://github.com/kmuto/review/issues/1350
+[#1353]: https://github.com/kmuto/review/pull/1353
+[#1354]: https://github.com/kmuto/review/pull/1354
+[#1356]: https://github.com/kmuto/review/pull/1356
+[#1359]: https://github.com/kmuto/review/pull/1359
+[#1360]: https://github.com/kmuto/review/pull/1360
+[#1362]: https://github.com/kmuto/review/pull/1362
+[#1363]: https://github.com/kmuto/review/issues/1363
+[#1365]: https://github.com/kmuto/review/pull/1365
+[#1367]: https://github.com/kmuto/review/issues/1367
+[#1368]: https://github.com/kmuto/review/issues/1368
+[#1371]: https://github.com/kmuto/review/pull/1371
+[#1372]: https://github.com/kmuto/review/pull/1372
+[#1373]: https://github.com/kmuto/review/pull/1373
+[#1374]: https://github.com/kmuto/review/pull/1374
+[#1375]: https://github.com/kmuto/review/pull/1375
+[#1378]: https://github.com/kmuto/review/pull/1378
+[#1379]: https://github.com/kmuto/review/issues/1379
+[#1381]: https://github.com/kmuto/review/issues/1381
+[#1383]: https://github.com/kmuto/review/issues/1383
+[#1385]: https://github.com/kmuto/review/issues/1385
+[#1386]: https://github.com/kmuto/review/pull/1386
+[#1388]: https://github.com/kmuto/review/pull/1388
+[#1389]: https://github.com/kmuto/review/pull/1389
+[#1390]: https://github.com/kmuto/review/pull/1390
+[#1391]: https://github.com/kmuto/review/pull/1391
+[#1392]: https://github.com/kmuto/review/issues/1392
+[#1395]: https://github.com/kmuto/review/issues/1395
+[#1398]: https://github.com/kmuto/review/issues/1398
+[#1401]: https://github.com/kmuto/review/pull/1401
+[#1402]: https://github.com/kmuto/review/pull/1402
+[#1403]: https://github.com/kmuto/review/pull/1403
+[#1404]: https://github.com/kmuto/review/pull/1404
+[#1405]: https://github.com/kmuto/review/pull/1405
+[#1407]: https://github.com/kmuto/review/pull/1407
+
+# Version 3.2.0
+
+## 非互換の変更
+* PDFMaker: `//image` 命令などで画像を配置するときに `\includegraphics` ではなく、それを抽象化した `\reviewincludegraphics` を使うようにしました ([#1318])
+
+## バグ修正
+* 別の章の図表やリストを参照する際に章が存在しないとき、内部エラーではなく標準のキーエラーを返すようにしました ([#1284])
+* review-compile のエラーメッセージで提示する値の誤りを修正しました ([#1286])
+* PDFMaker: review-jsbook において、serial_pagination=true を設定しているとき、PDF のページ番号のメタ情報がおかしくなるのを修正しました ([#1288])
+* notoc, nodisp, nonum を含む見出しを `@<hd>` で参照したときに番号が付いてしまうこと、およびその後の見出しの番号がおかしくなることを修正しました ([#1294])
+* PDFMaker: jlreq.cls 0401 版利用時に review-jlreq.cls でエラーが出るのを修正しました ([#1298])
+* EPUBMaker: EPUB2 の生成に失敗するのを修正しました ([#1301])
+* EPUBMaker: Windows で一時フォルダの削除にときどき失敗する現象に対処しました ([#1011])
+* PDFMaker: `@<bou>` をサポートしました ([#1220])
+* PDFMaker: jlreq.cls の古いバージョンでも動くように対処しました ([#1317])
+
+## 機能強化
+* `CHAPS:` が空のときのテストを追加しました ([#1275])
+* PDFMaker: 安全のため、reviewtt などのインライン書体命令を RobustCommand マクロで定義するようにしました ([#1280])
+* EPUBMaker: デバッグモードで実行する `--debug` オプションを追加しました ([#1281])
+* review-epub2html: 脚注をインラインで表現する `--inline-footnote` オプションを追加しました ([#1283])
+* EPUBMaker: iBooks 向けに、EPUB3 においても表紙画像のメタデータを入れるようにしました ([#1293])
+* PDFMaker: review-jsbook および review-jlreq において、コードリストや数式のキャプションの直後に改ページされる現象を程度抑制するようにしました ([#1299])
+* rubocop 0.67.2 に基づいてコードを整形しました ([#1297])
+* EPUB 作成のテストを追加しました ([#1300])
+* テスト対象の Ruby バージョンを 2.4.6, 2.5.5, 2.6.3 としました ([#1303])
+* YAMLLoader のコードを改良しました ([#1304])
+* `*` の箇条書きで、`**` から始めたり、`*` のあとに `***` を使ったりといった不正なレベル指定をエラーにしました ([#1313])
+* ReVIEW::Location クラスを分離しました ([#1308])
+* 箇条書きや文献リストで複数行の英単語が連結されてしまうのを回避しました (ただし PDFMaker のみ) ([#1312])
+* 空の表があったときにエラーを出すようにしました ([#1325])
+* いくつかのテスト対象を追加しました ([#1327], [#1328])
+* MARKDOWNBuilder: ``//listnum``に対応しました ([#1336])
+
+## ドキュメント
+* 見出しのレベルの説明の誤りを修正しました ([#1309])
+
+## その他
+* もう使われていない ReVIEW::Preprocessor::Strip を削除しました ([#1305])
+
+## コントリビューターのみなさん
+* [@uetchy](https://github.com/uetchy)
+* [@mitsuo0114](https://github.com/mitsuo0114)
+
+[#1011]: https://github.com/kmuto/review/issues/1011
+[#1220]: https://github.com/kmuto/review/issues/1220
+[#1275]: https://github.com/kmuto/review/pull/1275
+[#1280]: https://github.com/kmuto/review/pull/1280
+[#1281]: https://github.com/kmuto/review/issues/1281
+[#1283]: https://github.com/kmuto/review/pull/1283
+[#1284]: https://github.com/kmuto/review/issues/1284
+[#1286]: https://github.com/kmuto/review/pull/1286
+[#1288]: https://github.com/kmuto/review/issues/1288
+[#1293]: https://github.com/kmuto/review/pull/1293
+[#1294]: https://github.com/kmuto/review/issues/1294
+[#1297]: https://github.com/kmuto/review/pull/1297
+[#1298]: https://github.com/kmuto/review/pull/1298
+[#1299]: https://github.com/kmuto/review/pull/1299
+[#1300]: https://github.com/kmuto/review/pull/1300
+[#1301]: https://github.com/kmuto/review/pull/1301
+[#1303]: https://github.com/kmuto/review/pull/1303
+[#1304]: https://github.com/kmuto/review/pull/1304
+[#1305]: https://github.com/kmuto/review/pull/1305
+[#1308]: https://github.com/kmuto/review/pull/1308
+[#1309]: https://github.com/kmuto/review/issues/1309
+[#1312]: https://github.com/kmuto/review/issues/1312
+[#1313]: https://github.com/kmuto/review/issues/1313
+[#1317]: https://github.com/kmuto/review/pull/1317
+[#1318]: https://github.com/kmuto/review/issues/1318
+[#1325]: https://github.com/kmuto/review/issues/1325
+[#1327]: https://github.com/kmuto/review/issues/1327
+[#1328]: https://github.com/kmuto/review/pull/1328
+[#1336]: https://github.com/kmuto/review/pull/1336
+
 # Version 3.1.0
 
 ## 非互換の変更

data/NEWS.md

@@ -1,3 +1,397 @@
+# Version 5.0.0
+## New Features
+* added `cover_fit_page` option to review-jsbook / review-jlreq classes. When `cover_fit_page=true` is specified in the `texdocumentclass` parameter, the cover image is scaled to paper size. Note: it is recommended that the images should be created at actual size ([#1534])
+* allow minicolumn nesting. Now you can put a block instruction such as `//image` or itemized list in minicolumn (`//note`, `//memo`, `//tip`, `//info`, `//warning`, `//important`, `//caution`, `//notice`) ([#1558], [#1562])
+* added single commands `//beginchild` and `//endchild` for nesting itemized/enumerate/description list. **EXPERIMENTAL FEATURE** ([#1497])
+
+## Breaking Changes
+* In review-jlreq.cls, hiddenfolio is now implemented by jlreqtrimmarkssetup. It is slightly different from the previous version in position and display ([#1397])
+* The default value of the `chapterlink` parameter is now true. Most links (chapter, section, image, table, list, equation, bibliography) in Web and EPUB are now hyperlinked. In TeX PDF, some links (chapter, section, biliography) are hyperlinked only when `media=ebook` ([#1529])
+
+## Bug Fixes
+* PDFMaker: fixed a problem with multiple same-named image files with different extensions that would cause them to be misaligned ([#1483])
+* PDFMaker: fixed a problem that cuased an error when the author name (`aut`) was empty ([#1517])
+* PDFMaker: fixed a problem that caused an error if `//indepimage`'s image file didn't exist and ID contained characters to be TeX-escaped ([#1527])
+* PDFMaker: fixed a problem with characters to be TeX-escaped in the `bookttilename` and `aut` parameters causing incorrect PDF metainformation ([#1533])
+* WebMaker: fixed to avoid nil in HTML template ([#1545])
+* PDFMaker: fixed a problem when hiding chapter numbers ([#1559])
+* MarkdownBuilder: paragraphs in minicolumn should be separated with a blank line instead of a newline ([#1572])
+
+## Enhancements
+* fix warning message to output more detailed information of item ([#1523])
+* PDFMaker: make `@<hd>` op a hyperlink (when `media=ebook`) ([#1530])
+* use `cgi/escape` first and `cgi/util` as fallback. remove orignal implementation in `ReVIEW::HTMLUtils.escape()` ([#1536])
+* suppress warning with same `@<icon>` ([#1541])
+* fix an error handling when a badly encoded file is received ([#1544])
+* introduce IndexBuilder. IndexBuilder first scans the entire project files and provides indexes for each builder ([#1384], [#1552])
+* IDs and labels containing below characters or space characters are now warned ([#1393], [#1574])
+```
+#%\{}[]~/$'"|*?&<>`
+```
+
+## Docs
+* fix a typo in format.ja.md and format.md ([#1528])
+* fix incorrect example in makeindex.ja.md ([#1584])
+
+## Others
+* refactor code with Rubocop 0.92.0 ([#1511], [#1569], [#1573])
+* rename `@strategy` to `@builder` in `Re:VIEW::Compiler` ([#1520])
+* refactor code with Rubocop-performance 1.7.1 ([#1521])
+* update Gemfile in syntax-book ([#1522])
+* calling GhostScript in ImageMagick has been deprecated, so the test has been removed ([#1526])
+* unnecessary stderr output on some test units has been suppressed ([#1538])
+* add `BookUnit` class instead of `Compilable` module, the super class of `Chapter` and `Part` ([#1543])
+* `ReVIEW::Book.load` is deprecated, use `ReVIEW::Book::Base.load` or `ReVIEW::Book::Base.new` add new option `:config` for `ReVIEW::Book::Base.load` ([#1548], [#1563])
+* added `ReVIEW::Configure.create` ([#1549])
+* WebMaker: removed unused `clean_mathdir` ([#1550])
+* add `Base#parse_catalog_file()` and use it in `ReVIEW::Book::Base.new()`. `Base#catalog` is just getter now  ([#1551])
+* use `File.write` when it can be used ([#1560])
+* remove `Builder#builder_init()` ([#1564])
+
+## Contributors
+* [@snoozer05](https://github.com/snoozer05)
+
+[#1384]: https://github.com/kmuto/review/pull/1384
+[#1393]: https://github.com/kmuto/review/issues/1393
+[#1397]: https://github.com/kmuto/review/issues/1397
+[#1483]: https://github.com/kmuto/review/issues/1483
+[#1497]: https://github.com/kmuto/review/pull/1497
+[#1511]: https://github.com/kmuto/review/pull/1511
+[#1517]: https://github.com/kmuto/review/issues/1517
+[#1520]: https://github.com/kmuto/review/pull/1520
+[#1521]: https://github.com/kmuto/review/pull/1521
+[#1522]: https://github.com/kmuto/review/pull/1522
+[#1523]: https://github.com/kmuto/review/pull/1523
+[#1526]: https://github.com/kmuto/review/pull/1526
+[#1527]: https://github.com/kmuto/review/pull/1527
+[#1528]: https://github.com/kmuto/review/pull/1528
+[#1529]: https://github.com/kmuto/review/issues/1529
+[#1530]: https://github.com/kmuto/review/issues/1530
+[#1533]: https://github.com/kmuto/review/issues/1533
+[#1534]: https://github.com/kmuto/review/issues/1534
+[#1536]: https://github.com/kmuto/review/pull/1536
+[#1538]: https://github.com/kmuto/review/pull/1538
+[#1541]: https://github.com/kmuto/review/pull/1541
+[#1543]: https://github.com/kmuto/review/pull/1543
+[#1544]: https://github.com/kmuto/review/issues/1544
+[#1545]: https://github.com/kmuto/review/issues/1545
+[#1548]: https://github.com/kmuto/review/pull/1548
+[#1549]: https://github.com/kmuto/review/pull/1549
+[#1550]: https://github.com/kmuto/review/pull/1550
+[#1551]: https://github.com/kmuto/review/pull/1551
+[#1552]: https://github.com/kmuto/review/pull/1552
+[#1558]: https://github.com/kmuto/review/pull/1558
+[#1559]: https://github.com/kmuto/review/issues/1559
+[#1560]: https://github.com/kmuto/review/pull/1560
+[#1562]: https://github.com/kmuto/review/pull/1562
+[#1563]: https://github.com/kmuto/review/pull/1563
+[#1564]: https://github.com/kmuto/review/pull/1564
+[#1569]: https://github.com/kmuto/review/pull/1569
+[#1572]: https://github.com/kmuto/review/pull/1572
+[#1573]: https://github.com/kmuto/review/pull/1573
+[#1574]: https://github.com/kmuto/review/issues/1574
+[#1584]: https://github.com/kmuto/review/pull/1584
+
+# Version 4.2.0
+## New Features
+* introduce `caption_position` parameter to specify a caption position of image, table, list, and equation. `caption_position` has child parameters `image`, `table`, `list`, and `equation` and the value is `top` or `bottom` ([#1320])
+
+## Breaking Changes
+* review-vol is rewritten.  Improved processing of parts and inline instructions in headings. Changed display format. When a part is specified, the volume of the part file itself is returned instead of the volume of the part. The `-P` and `--directory` options have been removed ([#1485])
+* review-index is rewritten. Most option names have been changed. The number of lines and characters are now displayed only when `-d` option is specified. review-index uses PLAINTEXTBuilder to return accurate line and character counts. `-y` option is provided to specify a target chapter ([#1485])
+
+## Bug Fixes
+* remove duplicated `@non_parsed_commands` declaration ([#1499])
+* mathematical images not being created in WebMaker and TextMaker has been fixed ([#1501])
+
+## Enhancements
+* improve a performance of building math figures on imgmath ([#1488])
+* for those times when you want to hand over non-default YAML parameters to PDFMaker, you can write your own `layouts/config-local.tex.erb` file ([#1505])
+
+## Others
+* GitHub Actions: use `ruby/setup-ruby` instead of `eregon/use-ruby-action` ([#1490])
+* skip artifacts in the sample folder during testing ([#1504])
+
+[#1320]: https://github.com/kmuto/review/issues/1320
+[#1485]: https://github.com/kmuto/review/issues/1485
+[#1488]: https://github.com/kmuto/review/issues/1488
+[#1490]: https://github.com/kmuto/review/pull/1490
+[#1499]: https://github.com/kmuto/review/issues/1499
+[#1501]: https://github.com/kmuto/review/pull/1501
+[#1504]: https://github.com/kmuto/review/pull/1504
+[#1505]: https://github.com/kmuto/review/issues/1505
+
+# Version 4.1.0
+## New Features
+* add `table_row_separator` to specify a separator that separates table rows. Accceptable value: tabs (means `\t+`, default), `singletab` (means `\t`), spaces (means `\s+`), verticalbar (means `\s*\|\s*`) ([#1420])
+* PDFMaker, EPUBMaker, WEBMaker, TEXTMaker, IDGXMLMaker: add `-y` (`--only`) option to specify the files to convert instead of all files ([#1428])
+* add `--without-config-comment` option to review-init command to exclude comments from config.yml ([#1453])
+* PDFMaker: add `use_original_image_size` in `pdfmaker` section. If this parameter is set to true, images in `//image`, `//indepimage`, and `//imgtable` will be placed in actual size, not textwidth ([#1461])
+
+## Breaking Changes
+* PDFMaker: `image_scale2width` parameter has been moved under `pdfmaker` section ([#1462])
+
+## Bug Fixes
+* PDFMaker: fix backward compatibility error with Re:VIEW 3 ([#1414])
+* PDFMaker: fix an error when compiling review-jlreq with LuaLaTeX ([#1416])
+* PDFMaker: fix index not being included in the table of contents ([#1418])
+* RSTBuilder: fix conversion failure due to incorrect method argument handling ([#1426])
+* IDGXMLBuilder: there was an error in the warning handling for the table ([#1427])
+* IDGXMLMaker: there was an error in the processing when an error occurred in the filter program ([#1429])
+* PDFMaker: fix a build failure when using inline operators such as `@<code>` or `@<tt>` for heading with `media=ebook` mode ([#1432], [#1465])
+* PDFMaker: raise just warning instead of error, when MeCab isn't installed ([#1445])
+* IDGXMLBuilder: fix `//imgtable` to work correctly ([#1448])
+* PDFMaker: fix an error when makeindex is true but no index is registered ([#1467])
+* PDFMaker: fix missing footnotes in a description list ([#1476])
+* review-index: fix an error when `@<w>` exists in headlines ([#1484])
+
+## Enhancements
+* PDFMaker: add version to .cls/.sty files ([#1163])
+* update Dockerfile ([#1412])
+* IDGXMLMaker: show the contents of stderr from the filter program ([#1443])
+* add *-idgxml folder entry to .gitignore ([#1448])
+* `//source` can now omit options in all builders ([#1447])
+* add Ruby 2.7 to the test targets ([#1468])
+* allow a setting of multiple word\_file ([#1469])
+* EPUBMaker: warn when there is no heading in .re file ([#1474])
+
+## Docs
+* add the description about `contact` and `colophon_order` to `config.yml.sample` ([#1425])
+* update quickstart.ja.md and quickstart.md to Re:VIEW 4 ([#1442])
+* update syntax-book sample document ([#1448], [#1449])
+* update README.md ([#1455], [#1458])
+* update format.ja.md and format.md. add the description about `::` notation which sets builder-specific options to images ([#1421])
+
+## Others
+* refactor codes with Rubocop 0.78.0 ([#1424], [#1430])
+* run PDF build test more strictly when there is LaTeX runtime environment ([#1433])
+* switch the build test suite from Travis CI to GitHub Actions ([#1431], [#1436], [#1437])
+* IDGXMLBuilder: refactor code list methods ([#1438], [#1439])
+* remove unnecessary review-ext.rb from syntax-book ([#1446])
+* add tests for IDGXMLMaker and TextMaker ([#1448])
+* refactor around Index ([#1456], [#1457], [#1459])
+* update jsclasses to version 2020/02/02 ([#1478])
+
+## Contributors
+* [@turky](https://github.com/turky)
+
+[#1163]: https://github.com/kmuto/review/issues/1163
+[#1412]: https://github.com/kmuto/review/pull/1412
+[#1414]: https://github.com/kmuto/review/issues/1414
+[#1416]: https://github.com/kmuto/review/issues/1416
+[#1418]: https://github.com/kmuto/review/issues/1418
+[#1420]: https://github.com/kmuto/review/issues/1420
+[#1421]: https://github.com/kmuto/review/issues/1421
+[#1424]: https://github.com/kmuto/review/pull/1424
+[#1425]: https://github.com/kmuto/review/pull/1425
+[#1426]: https://github.com/kmuto/review/pull/1426
+[#1427]: https://github.com/kmuto/review/pull/1427
+[#1428]: https://github.com/kmuto/review/pull/1428
+[#1429]: https://github.com/kmuto/review/pull/1429
+[#1430]: https://github.com/kmuto/review/pull/1430
+[#1431]: https://github.com/kmuto/review/pull/1431
+[#1432]: https://github.com/kmuto/review/issues/1432
+[#1433]: https://github.com/kmuto/review/pull/1433
+[#1436]: https://github.com/kmuto/review/pull/1436
+[#1437]: https://github.com/kmuto/review/issues/1437
+[#1438]: https://github.com/kmuto/review/pull/1438
+[#1439]: https://github.com/kmuto/review/pull/1439
+[#1442]: https://github.com/kmuto/review/issues/1442
+[#1443]: https://github.com/kmuto/review/pull/1443
+[#1445]: https://github.com/kmuto/review/pull/1445
+[#1446]: https://github.com/kmuto/review/pull/1446
+[#1447]: https://github.com/kmuto/review/issues/1447
+[#1448]: https://github.com/kmuto/review/pull/1448
+[#1449]: https://github.com/kmuto/review/pull/1449
+[#1453]: https://github.com/kmuto/review/pull/1453
+[#1455]: https://github.com/kmuto/review/pull/1455
+[#1456]: https://github.com/kmuto/review/pull/1456
+[#1457]: https://github.com/kmuto/review/pull/1457
+[#1458]: https://github.com/kmuto/review/pull/1458
+[#1459]: https://github.com/kmuto/review/pull/1459
+[#1461]: https://github.com/kmuto/review/issues/1461
+[#1462]: https://github.com/kmuto/review/issues/1462
+[#1465]: https://github.com/kmuto/review/pull/1465
+[#1466]: https://github.com/kmuto/review/pull/1466
+[#1467]: https://github.com/kmuto/review/pull/1467
+[#1468]: https://github.com/kmuto/review/pull/1468
+[#1469]: https://github.com/kmuto/review/issues/1469
+[#1474]: https://github.com/kmuto/review/issues/1474
+[#1476]: https://github.com/kmuto/review/issues/1476
+[#1478]: https://github.com/kmuto/review/issues/1478
+[#1484]: https://github.com/kmuto/review/pull/1484
+
+# Version 4.0.0
+## New Features
+* introduce review-idgxmlmaker which generates IDGXML files at once ([#1337])
+* review-textmaker converts the math in the document to image files when `imgmath` parameter has `true` ([#1338])
+* introduce wizard mode to layout of LaTeX on Web browser. Add `-w` option to review-init. This feature is experimental and may be replaced in the future ([#1403])
+* experimental feature: introduce the feature to insert whitespace based on character when combining lines into a paragraph. To enable this, install unicode-eaw gem and add `join_lines_by_lang: true` into config.yml [#1362]
+
+## Breaking Changes
+* review-init no longer creates empty `layouts` folder ([#1340])
+* PDFMaker: fix a problem that white space characters disappeared in `@<code>`, `@<tt>`, `@<tti>`, and `@<ttb>`. Also the string is automatically wrapped ([#1348])
+* `//texequation`, `//embed` and `//graph` that don't allow inline op no longer escape inline op in strings. And don't put extra line break ([#1371], [#1374])
+* PDFMaker: change the default table placement from `htp` to `H` for use in columns (`\floatplacement{table}` value in review-style.sty) [#1385]
+* PDFMaker: the space between Japanese/Western characters in the code lists is changed to 0 from 1/4 character ([#1401])
+* change the default value of `toc` parameter from null (false, don't create a table of contents) to true (create a table of contents) ([#1405])
+
+## Bug Fixes
+* fix a typo in review-jlreq ([#1350])
+* fix incorrect result when `re` file uses CR for line-feed code ([#1341])
+* PDFMaker: fix foreground color of `//cmd` with review-jlreq after page breaking ([#1363])
+* PDFMaker: fix duplicate 'column' label for `@<column>` ([#1367])
+* PDFMaker: copy gentombow.sty and jsbook.cls only for review-jsbook ([#1381])
+* PDFMaker: fix invalid PDFDocumentInformation on review-jlreq with LuaLaTeX ([#1392])
+* PDFMaker: fix missing hiddenfolio information at even pages on review-jlreq ([#1395])
+
+## Enhancements
+* support `@<em>` and `@<strong>` in IDGXMLBuilder ([#1353])
+* PDFMaker: extract `code_line` and `code_line_num` from code blocks for ease handling each line ([#1368])
+* PDFMaker: add new compile option `-halt-on-error` to make it easier to find the problem when an error occurs ([#1378])
+* PDFMaker: when there is a footnote text (`//footnote`) in the column block, it may cuse problems such as numbering. So warn it if there is. ([#1379])
+* Logger: progname should be add in logger, not in message arguments ([#1388])
+* improve error checking for yaml files ([#1386])
+* PDFMaker: the cover page becomes even number (p.0) and is named "cover" ([#1402])
+* PDFMaker: refactor `generate_pdf` method ([#1404])
+* create `.gitignore` for new project ([#1407])
+
+## Docs
+* update sample-book/README.md ([#1354])
+* add descriptions about options of jsbook.cls to review-jsbook/README.md ([#1365])
+
+## Others
+* unify styles of a method with arguments ([#1360])
+* `Catalog#{chaps,parts,predef,postdef,appendix}` should return Array, not String ([#1372])
+* use `safe_load` for loading YAML ([#1375])
+* refactor `table` method to simplify each builder ([#1356])
+* refactor `XXX_header` and `XXX_body` ([#1359])
+* enable `Builder#highlight?` method on each builder ([#1373])
+* refactor mkdchap* and mkpart* ([#1383])
+* don't update rubygems in Travis CI ([#1389])
+* refactor around Index ([#1390])
+* add configration for review-jlreq to sample documents ([#1391])
+* definition list should start with spaces ([#1398])
+
+## Contributors
+* [@m-shibata](https://github.com/m-shibata)
+* [@masarakki](https://github.com/masarakki)
+
+[#1337]: https://github.com/kmuto/review/issues/1337
+[#1338]: https://github.com/kmuto/review/issues/1338
+[#1340]: https://github.com/kmuto/review/issues/1340
+[#1341]: https://github.com/kmuto/review/issues/1341
+[#1348]: https://github.com/kmuto/review/issues/1348
+[#1350]: https://github.com/kmuto/review/issues/1350
+[#1353]: https://github.com/kmuto/review/pull/1353
+[#1354]: https://github.com/kmuto/review/pull/1354
+[#1356]: https://github.com/kmuto/review/pull/1356
+[#1359]: https://github.com/kmuto/review/pull/1359
+[#1360]: https://github.com/kmuto/review/pull/1360
+[#1362]: https://github.com/kmuto/review/pull/1362
+[#1363]: https://github.com/kmuto/review/issues/1363
+[#1365]: https://github.com/kmuto/review/pull/1365
+[#1367]: https://github.com/kmuto/review/issues/1367
+[#1368]: https://github.com/kmuto/review/issues/1368
+[#1371]: https://github.com/kmuto/review/pull/1371
+[#1372]: https://github.com/kmuto/review/pull/1372
+[#1373]: https://github.com/kmuto/review/pull/1373
+[#1374]: https://github.com/kmuto/review/pull/1374
+[#1375]: https://github.com/kmuto/review/pull/1375
+[#1378]: https://github.com/kmuto/review/pull/1378
+[#1379]: https://github.com/kmuto/review/issues/1379
+[#1381]: https://github.com/kmuto/review/issues/1381
+[#1383]: https://github.com/kmuto/review/issues/1383
+[#1385]: https://github.com/kmuto/review/issues/1385
+[#1386]: https://github.com/kmuto/review/pull/1386
+[#1388]: https://github.com/kmuto/review/pull/1388
+[#1389]: https://github.com/kmuto/review/pull/1389
+[#1390]: https://github.com/kmuto/review/pull/1390
+[#1391]: https://github.com/kmuto/review/pull/1391
+[#1392]: https://github.com/kmuto/review/issues/1392
+[#1395]: https://github.com/kmuto/review/issues/1395
+[#1398]: https://github.com/kmuto/review/issues/1398
+[#1401]: https://github.com/kmuto/review/pull/1401
+[#1402]: https://github.com/kmuto/review/pull/1402
+[#1403]: https://github.com/kmuto/review/pull/1403
+[#1404]: https://github.com/kmuto/review/pull/1404
+[#1405]: https://github.com/kmuto/review/pull/1405
+[#1407]: https://github.com/kmuto/review/pull/1407
+
+# Version 3.2.0
+
+## Breaking Changes
+* PDFMaker: changed to use the abstract name `\reviewincludegraphics` instead of `\includegraphics` for image placements (such as `//image`) ([#1318])
+
+## Bug Fixes
+* reference to IDs of non-existent chapter now return standard key error (instead of internal error) ([#1284])
+* fixed the value in the error message of review-compile ([#1286])
+* PDFMaker: fixed the metadata of PDF page number was wrong when using review-jsbook with serial_pagination = true ([#1288])
+* fixed a bug when using `@<hd>` to refer to headings with notoc, nodisp, or nonum ([#1294])
+* PDFMaker: fixed an error in review-jlreq when using jlreq.cls version 0401 ([#1298])
+* EPUBMaker: fixed a error of building EPUB2 ([#1301])
+* EPUBMaker: added a workaround for a temporary folder deletion failure on Windows ([#1011])
+* PDFMaker: support `@<bou>` ([#1220])
+* PDFMaker: support old jlreq.cls ([#1317])
+
+## Enhancements
+* added test when `CHAPS:` is empty ([#1275])
+* PDFMaker: for safety, inline typeface commands such as `\reviewtt` are defined with RobustCommand ([#1280])
+* EPUBMaker: added `--debug` option to execute in debug mode ([#1281])
+* review-epub2html: added `--inline-footnote` option to represent footnotes as inline ([#1283])
+* EPUBMaker: added metadata of the cover image on EPUB3 for iBooks ([#1293])
+* PDFMaker: suppressed the unexptected page break after the caption of code list or equation in review-jsbook and review-jlreq ([#1299])
+* reformatted the codes using rubocop 0.67.2 ([#1297])
+* added a test of building EPUB ([#1300])
+* updated Ruby versions of test target to 2.4.6, 2.5.5, and 2.6.3 ([#1303])
+* improved the code of YAMLLoader ([#1304])
+* raise an error when invalid level is used in bullet ([#1313])
+* extracted ReVIEW::Location class ([#1308])
+* avoid multi-lined English words being combined without a space in bullets and bibliographic list (only in PDFMaker, at this time) ([#1312])
+* raise an error when table is empty ([#1325])
+* add some tests ([#1327], [#1328])
+* MARKDOWNBilder: support `//listnum` ([#1336])
+
+## Docs
+* fixed the description about header levels ([#1309])
+
+## Others
+* removed ReVIEW::Preprocessor::Strip due to it is no longer used ([#1305])
+
+## Contributors
+* [@uetchy](https://github.com/uetchy)
+* [@mitsuo0114](https://github.com/mitsuo0114)
+
+[#1011]: https://github.com/kmuto/review/issues/1011
+[#1220]: https://github.com/kmuto/review/issues/1220
+[#1275]: https://github.com/kmuto/review/pull/1275
+[#1280]: https://github.com/kmuto/review/pull/1280
+[#1281]: https://github.com/kmuto/review/issues/1281
+[#1283]: https://github.com/kmuto/review/pull/1283
+[#1284]: https://github.com/kmuto/review/issues/1284
+[#1286]: https://github.com/kmuto/review/pull/1286
+[#1288]: https://github.com/kmuto/review/issues/1288
+[#1293]: https://github.com/kmuto/review/pull/1293
+[#1294]: https://github.com/kmuto/review/issues/1294
+[#1297]: https://github.com/kmuto/review/pull/1297
+[#1298]: https://github.com/kmuto/review/pull/1298
+[#1299]: https://github.com/kmuto/review/pull/1299
+[#1300]: https://github.com/kmuto/review/pull/1300
+[#1301]: https://github.com/kmuto/review/pull/1301
+[#1303]: https://github.com/kmuto/review/pull/1303
+[#1304]: https://github.com/kmuto/review/pull/1304
+[#1305]: https://github.com/kmuto/review/pull/1305
+[#1308]: https://github.com/kmuto/review/pull/1308
+[#1309]: https://github.com/kmuto/review/issues/1309
+[#1312]: https://github.com/kmuto/review/issues/1312
+[#1313]: https://github.com/kmuto/review/issues/1313
+[#1317]: https://github.com/kmuto/review/pull/1317
+[#1318]: https://github.com/kmuto/review/issues/1318
+[#1325]: https://github.com/kmuto/review/issues/1325
+[#1327]: https://github.com/kmuto/review/issues/1327
+[#1328]: https://github.com/kmuto/review/pull/1328
+[#1336]: https://github.com/kmuto/review/pull/1336
+
 # Version 3.1.0
 ## Breaking Changes
 * PDFMaker: introduce `\reviewimagecaption` macro for the caption of figure ([#1254]). Please update your review-base.sty by `review-update` command on your  Re:VIEW 3 project.
@@ -451,7 +845,7 @@
 
 ## Enhancements
 
-* allow block `{ 〜 //}` in `//indepimage`. ([#802])
+* allow block `{ ... //}` in `//indepimage`. ([#802])
 * warn when images are not found in `//indepimage`([#803])
 * LATEXBuilder: allow caption in `//source` ([#834])