リリースノート 3.1.0

NEWS.ja.md

@@ -1,3 +1,61 @@
+# 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
 
 ## バグ修正

NEWS.md

@@ -1,3 +1,60 @@
+# 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.
+* remove `--strip` option which is undocumented and doesn't work correctly from `review-preproc command` ([#1257])
+
+## Bug Fixes
+* PDFMaker: fix a problem that the section number of the part continues the section number in the previous chapter ([#1225],[#1226])
+* fix copying of gentombow.sty in samples folder ([#1229])
+* PDFMaker: fix that the number of lines specified by `number_of_lines` document option decrease by 1 line than originally on review-jsbook ([#1235])
+* PDFMaker: fix review-jlreq to work with LuaLaTeX ([#1243])
+* EPUBMaker: fix a problem that the hierachy of the table of contents become strange when there is a part ([#1262])
+* fix escaping of `//comment` ([#1264])
+* PDFMaker: fix overflowing when the left column of colophon is long ([#1252])
+* fix an error when CHAPS: is empty ([#1273])
+
+## Enhancements
+* PDFMaker: load amssymb, amsthm, and bm packages which are often used as extension of mathematical expression ([#1224])
+* HTMLBuilder: `emlist` and `listnum` now always pass `highlight` method as well as others ([#1231])
+* EPUBMaker: implement a back-link to the text from the footnote ([#1233])
+* PDFMaker: add `\makelines` macro to create a dummy line ([#1240])
+* implement `#@warn` correctly ([#1258])
+* `#@mapfile` now imports as is (keep tabs etc.) when imported file has `.re` extension ([#1247])
+* add Ruby 2.6 for the test coverage ([#1242])
+* PDFMaker: replace `zw` with `\zw` in review-jlreq. add a indent to paragraphs in the column ([#1250])
+* PDFMaker: when `\reviewimagecaption` is undefined (implemented in [#1254]), define it ([#1267])
+
+## Docs
+* README.md: fix the filename of jsbook.cls ([#1239])
+* add the note about `back_footnote` into config.yml.sample and update documents a little ([#1268])
+
+## Contributors
+* [@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
 
 ## Bug Fixes