review 3.0.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c42bf9b1882e845d3b136daa8a10a5b268ec5abc2c60f0e02e2f10bb390350be
-  data.tar.gz: 311a696028fcd8651245648a33d15acb79f79f12986ee2f2ceb67be1329fe2b2
+  metadata.gz: 6045860e33279138a91d9f6fcdecc9dd589c448c9e576858f41969d3fe73fa79
+  data.tar.gz: 70ccce6b312cf4802261417393e724f6cfbc9d97aa7afd7a2d4783af148ba1ea
 SHA512:
-  metadata.gz: dec76569275ed22bc13a978b2181da58f1dec38fe8ddf9a6c5355f0f5fe00385b50307143b938764e5b854471ad80feda576cba5b350ee18e03f6a6b06b1d80b
-  data.tar.gz: aee5b0eff6ec9df9501810c38d0a60c22e5a957e2db2549f1ac63df4ab3e4a575b7ad8f698ab3a54fa10bbdadde5c95685c3f2db51f5c0a097a1b80f3da816b6
+  metadata.gz: 7c0bbe35d45e9b099fcc6f1114b3e0cc8b0c8edc2cb1af04288c71a01e188bc1a4e88c68ccb905c30912d82082a822526f0721034b85c1b530b607341404e2d5
+  data.tar.gz: 7b2010fa445336f13a5067a436957e9899dd17af042ef816c7d742c36c2afd8dbad6c7d0a1a11d572e2f57212e06f100a51403bad0101a5ce9cb8e10505ac531

data/.github/workflows/ruby-win.yml

@@ -0,0 +1,39 @@
+name: TestWin
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6.x', '2.5.x', '2.4.x' ]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build and test with Rake
+      shell: bash
+      run: |
+        gem install bundler --no-document
+        bundle install --retry 3
+        bundle exec ruby test/run_test.rb --max-diff-target-string-size=10000 --verbose=v
+    - name: Test with epubcheck-ruby
+      shell: bash
+      run: |
+        gem install -N epubcheck-ruby
+        ruby bin/review-init hello
+        cd hello
+        ruby ../bin/review-epubmaker config.yml
+        epubcheck book.epub
+        cd ..
+        ruby bin/review-init hello2 --epub-version 2
+        cd hello2
+        ruby ../bin/review-epubmaker config.yml
+        epubcheck book.epub
+        cd ..

data/.github/workflows/ruby.yml

@@ -0,0 +1,27 @@
+name: Test
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7]
+        os: [ubuntu-latest, macOS-latest]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: fix ImageMagick policy.xml on Linux
+      if: runner.os == 'Linux'
+      run: sudo sed -i 's/none/read|write/g' /etc/ImageMagick-6/policy.xml
+    - name: Build and test with Rake
+      run: |
+        gem install bundler --no-document
+        bundle install --retry 3
+        bundle exec rake

data/.rubocop.yml

@@ -5,6 +5,9 @@ AllCops:
     - test/syntax-book/*
   DisplayCopNames: true
 
+require:
+  - rubocop-performance
+
 inherit_from: .rubocop_todo.yml
 
 #### Lint
@@ -37,6 +40,9 @@ Lint/UnusedMethodArgument:
 Lint/UselessAssignment:
   Enabled: true
 
+Lint/ErbNewArguments:
+  Enabled: false
+
 #### Performance
 
 Performance/RegexpMatch:
@@ -52,6 +58,9 @@ Performance/StringReplacement:
 Performance/RangeInclude:
   Enabled: true
 
+Performance/DeletePrefix:
+  Enabled: false
+
 #### Style
 
 Style/AccessModifierDeclarations:
@@ -90,6 +99,9 @@ Style/ClassMethods:
 Style/CommentedKeyword:
   Enabled: false
 
+Style/FloatDivision:
+  Enabled: false
+
 # Do not introduce global variables.
 Style/GlobalVars:
   Enabled: true
@@ -135,7 +147,7 @@ Style/MutableConstant:
 #Style/MultipleComparison:
 #  Enabled: true
 
-Style/UnneededInterpolation:
+Style/RedundantInterpolation:
   Enabled: true
 
 Performance/RedundantMerge:
@@ -187,6 +199,31 @@ Style/LineEndConcatenation:
 Style/MethodCallWithoutArgsParentheses:
   Enabled: true
 
+Style/MethodCallWithArgsParentheses:
+  IgnoredMethods:
+    - 'require'
+    - 'include'
+    - 'file'
+    - 'task'
+    - 'desc'
+    - 'info'
+    - 'gem'
+    - 'exit'
+    - 'print'
+    - 'puts'
+    - 'write'
+    - 'warn'
+    - 'error'
+    - 'raise'
+    - 'yield'
+    - 'source'
+    - 'assert'
+    - 'assert_equal'
+    - 'sh'
+    - 'mv'
+    - 'rm_rf'
+  Enabled: true
+
 Style/MixinUsage:
   Enabled: false
 
@@ -270,7 +307,7 @@ Style/TrailingCommaInHashLiteral:
 Style/WordArray:
   MinSize: 10
 
-Style/UnneededPercentQ:
+Style/RedundantPercentQ:
   Enabled: false
 
 Style/WhileUntilModifier:
@@ -285,7 +322,7 @@ Layout/BlockAlignment:
   Enabled: true
 
 Layout/EndAlignment:
-  Enabled: AlignWith
+  Enabled: true
 
 Layout/MultilineMethodCallBraceLayout:
   Enabled: true
@@ -331,10 +368,10 @@ Layout/IndentationConsistency:
 Layout/IndentationWidth:
   Enabled: true
 
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   Enabled: true
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 
 Layout/LeadingCommentSpace:
@@ -381,16 +418,20 @@ Layout/SpaceInsideStringInterpolation:
   EnforcedStyle: no_space
   Enabled: true
 
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Enabled: true
 
+Layout/TrailingWhitespace:
+  Enabled: true
+  AllowInHeredoc: true
+
 #### Metrics
 
 Metrics/BlockNesting:
   Max: 4
 
 Metrics/ModuleLength:
-  Max: 200
+  Max: 300
 
 Metrics/ParameterLists:
   Max: 8
@@ -457,7 +498,7 @@ Naming/MemoizedInstanceVariableName:
 Naming/MethodName:
   Enabled: true
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   Enabled: false
 
 # Use snake_case for variable names.
@@ -470,8 +511,5 @@ Naming/VariableNumber:
 
 #### Security
 
-# we use Date object in config.yml so should use YAML.load :-/
 Security/YAMLLoad:
-  Exclude:
-    - 'lib/review/catalog.rb'
-    - 'test/test_helper.rb'
+  Enabled: true

data/.travis.yml

@@ -2,6 +2,10 @@ language: ruby
 sudo: false
 dist: trusty
 
+os:
+  - linux
+  - osx
+
 addons:
   apt:
     packages:
@@ -11,16 +15,21 @@ addons:
       - dvipng
 
 before_install:
-  - gem update --system
-  - gem update bundler
+  - |-
+##    gem update --system
+    gem install bundler
+    gem install epubcheck-ruby
+
+script:
+  - bundle exec rake
+  - ruby bin/review-init hello && cd hello && ruby ../bin/review-epubmaker config.yml && epubcheck book.epub
+  - cd ..
+  - ruby bin/review-init hello2 --epub-version 2 && cd hello2 && ruby ../bin/review-epubmaker config.yml && epubcheck book.epub
 
 rvm:
-##  - 2.0
-  - 2.1
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
-  - 2.5.0
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 ##  - ruby-head
 
 branches:

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,361 @@
+# 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
+
+## 非互換の変更
+* PDFMaker: 図版のキャプションとして `\reviewimagecaption` マクロを導入しました ([#1254])。Re:VIEW 3 を使っているプロジェクトでは、`review-update` コマンドを実行して review-base.sty ファイルを更新することを推奨します。
+* `review-preproc` コマンドから、文書化されておらず正しく動作しない `--strip` オプションを除去しました ([#1257])
+
+## バグ修正
+* PDFMaker: 部の中の節番号が前の章の節番号を継続してしまう問題を修正しました ([#1225],[#1226])
+* samples 内で gentombow.sty ファイルのコピーが正しくできていないのを修正しました ([#1229])
+* PDFMaker: review-jsbook 利用時、numer_of_lines ドキュメントオプションで指定した行数より1行減ってしまうのを修正しました ([#1235])
+* PDFMaker: review-jlreq が LuaLaTeX で動作するように修正しました ([#1243])
+* EPUBMaker: 部があるときに目次の階層がおかしくなる問題を修正しました ([#1262])
+* `//comment` の内容が正しくエスケープされないことがある問題を修正しました ([#1264])
+* PDFMaker: 奥付の左列が長いときにあふれるのを修正しました ([#1252])
+* CHAPS: が空のときにエラーになるのを修正しました ([#1273])
+
+## 機能強化
+* PDFMaker: 数式表現の拡張としてよく使われる amssymb, amsthm, bm パッケージを標準で読み込むようにしました ([#1224])
+* HTMLBuilder: emlist, listnum 命令の挙動をほかのコードリスト命令に合わせ、highlight メソッドを必ず経由するようにしました ([#1231])
+* EPUBMaker: 脚注から本文に戻るリンクを表現できるようにしました ([#1233])。`epubmaker` パラメータの `back_footnote` サブパラメータを true にすると利用できます。
+* PDFMaker: ダミーの行を作成する `\makelines` マクロを追加しました ([#1240])
+* `#@warn` 命令を正しく実装しました ([#1258])
+* `#@mapfile` 命令に re 拡張子のファイルが指定されたときにはタブなどを整形せずそのまま取り込むようにしました ([#1247])
+* Ruby 2.6 をテスト対象にしました ([#1242])
+* PDFMaker: review-jlreq で `zw` を使っている箇所を `\zw` に置き換えました。コラム内の段落は字下げするようにしました ([#1250])
+* PDFMaker: [#1254] で導入した `\reviewimagecaption` が定義されていないときにはデフォルトのマクロを提供するようにしました ([#1267])
+
+## ドキュメント
+* README.md: jsbook.cls のファイル名が誤っていたのを修正しました ([#1239])
+* config.yml.sample に back_footnote の説明を追加し、その他いくつかドキュメントに些末な更新を行いました ([#1268])
+
+## コントリビューターのみなさん
+* [@doublemarket](https://github.com/doublemarket)
+* [@munepi](https://github.com/munepi)
+
+[#1224]: https://github.com/kmuto/review/issues/1224
+[#1225]: https://github.com/kmuto/review/pull/1225
+[#1226]: https://github.com/kmuto/review/pull/1226
+[#1229]: https://github.com/kmuto/review/pull/1229
+[#1231]: https://github.com/kmuto/review/issues/1231
+[#1233]: https://github.com/kmuto/review/issues/1233
+[#1235]: https://github.com/kmuto/review/issues/1235
+[#1239]: https://github.com/kmuto/review/pull/1239
+[#1240]: https://github.com/kmuto/review/pull/1240
+[#1242]: https://github.com/kmuto/review/pull/1242
+[#1243]: https://github.com/kmuto/review/issues/1243
+[#1247]: https://github.com/kmuto/review/issues/1247
+[#1250]: https://github.com/kmuto/review/pull/1250
+[#1252]: https://github.com/kmuto/review/issues/1252
+[#1254]: https://github.com/kmuto/review/issues/1254
+[#1257]: https://github.com/kmuto/review/issues/1257
+[#1258]: https://github.com/kmuto/review/issues/1258
+[#1262]: https://github.com/kmuto/review/issues/1262
+[#1264]: https://github.com/kmuto/review/issues/1264
+[#1267]: https://github.com/kmuto/review/issues/1267
+[#1268]: https://github.com/kmuto/review/issues/1268
+[#1273]: https://github.com/kmuto/review/issues/1273
+
 # Version 3.0.0
 
 ## バグ修正