Merge pull request #948 from kmuto/v250

add release note of 2.5.0

NEWS.ja.md

@@ -1,3 +1,96 @@
+# Version 3.x (未リリース)
+
+TODO:lib/review/version.rbとreview.gemspecの更新をすること
+
+以下は未マージ・開発中。なるべく入れたいが…
+
+* 非互換の変更：LaTeX の `@<m>` によるインラインの数式の前後にスペースを入れるのを止めました ([#943])
+* 機能追加：LaTeX から生成する PDF の圧縮レベルオプション指定 (`-z 9`、最大圧縮) を config.yml のサンプルに記載しました ([#935])
+* 非互換の変更：`@<chapref>`、`@<column>` の展開文字列を locale.yml で変更しやすいようにしました ([#886])
+* 非互換の変更：LaTeX の表紙 (`cover` パラメータ) と大扉 (`titlepage` パラメータ) は独立した設定となりました ([#848])
+* 非互換の変更：インライン文字装飾の LaTeX への変換結果を `\textbf` ではなく `\reviewbold` のように抽象化した名前にしました ([#792])
+* 非互換の変更：LaTeX でルビを表現できるよう pxrubrica パッケージを読み込むようにしました ([#655])
+* 非互換の変更：LaTeX のコードリスト環境を jlisting から plistings パッケージに変更しました ([#635])
+* 非互換の変更：LaTeX のハイパーリンクの枠線のデフォルトをなしにしました ([#808])
+* 非互換の変更：LaTeX のコードリストを reviewlistblock 環境で囲むようにしました ([#916])
+* 非互換の変更：LaTeX で geometry.sty を使うのを止めました ([#912])
+* 非互換の変更・新機能：
+* 機能追加：表のセル内で `@<br>{}` による改行ができるようにしました ([#668])
+* 非互換の変更・新機能：複数の LaTeX レイアウトファイルから選択できるようにしました ([#812])
+
+非互換になるところはもう少し詳しく説明が必要そう
+
+# Version 2.5.0
+
+## 新機能
+* プレインテキストを出力する review-textmaker コマンドを用意しました ([#926])
+* LaTeX 向けに、図版の BoudingBox の採取手段を変更する `pdfmaker/bbox` パラメータを追加しました ([#947])
+* 新機能：空行を入れる命令 `//blankline` を追加しました ([#942])
+
+## 非互換の変更
+* `//include` 命令は不完全でユーザーの混乱を招くため、削除しました ([#887])
+* LaTeX において、見出しや図表キャプション内にある脚注は `\footnotemark` を暗黙に使うようにしました ([#841])
+* EPUB および WebMaker の大扉では、印刷所 (prt) の代わりに出版社 (pbl) を記載するようにしました ([#927])
+
+## バグ修正
+* column の終了が正しく動作しないのを修正しました ([#894])
+* `@<hd>` 命令の使用時に内部エラーが出ることがあるのを修正しました ([#896])
+* LaTeX において、キャプションが空のときに空行が入ってしまうのを修正しました ([#922])
+* `//graph` 命令内で gnuplot を使用したときにエラーが発生するのを修正しました ([#931])
+* Windows で review コマンドがエラーになるのを修正しました ([#940])
+* Windows で EPUB 生成時に一時作業ファイルの削除エラーが発生するのを修正しました ([#946])
+
+## 機能強化
+* `//note` などの囲み要素内で末尾に空行があるときに不要な空の段落が作成されるのを修正しました ([#882])
+* `@<chap>` などで catalog.yml に存在しない ID を指定したときのエラーメッセージをわかりやすいものにしました ([#891])
+* catalog.yml に UTF-8 BOM ヘッダがあっても正常に動作するようにしました ([#899])
+* LaTeX の奥付の罫線の長さを固定幅ではなく紙面幅にしました ([#907])
+* texstyle パラメータで配列による複数の TeX スタイルファイルの読み込みを許可するようにしました ([#908])
+* 独自の Rakefile を利用するための `lib/tasks` フォルダを `review-init` コマンドで作成するようにしました ([#921])
+* `review-init` コマンド実行時に、`doc` フォルダにドキュメントをコピーするようにしました ([#918])
+* `review` コマンドのヘルプメッセージを追加しました ([#933])
+* 存在しないあるいは壊れている YAML ファイルを読み込もうとしたときに妥当なエラーメッセージを出すようにしました ([#958])
+* `@<img>` や `@<table>` などのインライン命令で存在しない ID を指定したときのエラーメッセージをわかりやすいものに統一しました ([#954])
+* catalog.yml に存在しないファイルをコンパイルしようとしたときのエラーメッセージをわかりやすいものにしました ([#953])
+* LaTeX において、table, imgtable, image, indepimage から変換した TeX ソースコードにコメントで ID を記述するようにしました（`\begin{reviewimage}%%sampleimg` など）。フック処理での書き換えを簡易化するための修正であり、通常のLaTeX(PDF)の出力には影響ありませんが、独自のフック処理を使用していたプロジェクトでは修正が必要になるかもしれません ([#937])
+
+## ドキュメント
+* 画像ファイルの拡張子の探索順序を文書化しました ([#939])
+* review-textmaker の説明を追加しました ([#944])
+
+## コントリビューターのみなさん
+* [@kauplan](https://github.com/kauplan)
+* [@krororo](https://github.com/krororo)
+* [@mhidaka](https://github.com/mhidaka)
+* [@Pegasus204](https://github.com/Pegasus204)
+
+[#841]: https://github.com/kmuto/review/issues/841
+[#882]: https://github.com/kmuto/review/issues/882
+[#887]: https://github.com/kmuto/review/issues/887
+[#891]: https://github.com/kmuto/review/issues/891
+[#894]: https://github.com/kmuto/review/pull/894
+[#896]: https://github.com/kmuto/review/issues/896
+[#899]: https://github.com/kmuto/review/issues/899
+[#907]: https://github.com/kmuto/review/pull/907
+[#908]: https://github.com/kmuto/review/pull/908
+[#918]: https://github.com/kmuto/review/issues/918
+[#921]: https://github.com/kmuto/review/issues/921
+[#922]: https://github.com/kmuto/review/pull/922
+[#926]: https://github.com/kmuto/review/issues/926
+[#927]: https://github.com/kmuto/review/pull/927
+[#931]: https://github.com/kmuto/review/pull/931
+[#933]: https://github.com/kmuto/review/issues/933
+[#937]: https://github.com/kmuto/review/pull/937
+[#939]: https://github.com/kmuto/review/pull/939
+[#940]: https://github.com/kmuto/review/issues/940
+[#942]: https://github.com/kmuto/review/issues/942
+[#944]: https://github.com/kmuto/review/pull/944
+[#946]: https://github.com/kmuto/review/issues/946
+[#947]: https://github.com/kmuto/review/pull/947
+[#953]: https://github.com/kmuto/review/issues/953
+[#954]: https://github.com/kmuto/review/issues/954
+[#958]: https://github.com/kmuto/review/issues/958
+
 # Version 2.4.0
 
 ## 新機能

NEWS.md

@@ -1,3 +1,80 @@
+# Version 2.5.0
+
+## New Features
+
+* add a new maker command `review-textmaker` to output plain text files ([#926])
+* LATEXBuilder: add a new parameter `pdfmaker/bbox` for settings of BoudingBox ([#947])
+* add a new command `//blankline` ([#942])
+
+## Breaking Changes
+
+* remove (incomplete) command `//include` ([#887])
+* LATEXBuilder: use `\footnotemark` implicitly for captions and headings ([#841])
+* EPUBMaker, WEBMaker: use `pbl` (publisher) instead of `prt` (printer) in titlepage ([#927])
+
+## Bug Fixes
+
+* fix column closing ([#894])
+* fix internal errors in `@<hd>` ([#896])
+* LATEXBuilder: fix to ignore empty caption ([#922])
+* fix invalid commmand errors in `//graph` when using gnuplot ([#931])
+* fix errors of `review` command in Windows ([#940])
+* EPUBMaker: fix error of removing temporary files in Windows ([#946])
+
+## Enhancements
+
+* remove tailing empty lines in block (captionblocks) such as `//note`. ([#882])
+* fix error messages when using non-existent ID of catalog.yml in inline commands such as `@<chap>` ([#891])
+* ignore UTF-8 BOM in catalog.yml ([#899])
+* LATEXBuilder: fix a length of horizontal line in colophon ([#907])
+* allow to use multiple parameters of `texstyle` in config.yml ([#908])
+* review-init: create `lib/tasks` folder to use original Rake commands ([#921])
+* review-init: copy `doc` folder into the target project ([#918])
+* add a help message of `review` ([#933])
+* show appropriate error messages when using invalid or non-existent YAML files ([#958])
+* show better error messages when using unknown ID in inline commands such as `@<img>` and `@<table>` ([#954])
+* show better error messages when compiling a file not included in catalog.yml ([#953])
+* LATEXBuilder: add IDs of `table`, `imgtable`, `image` and `indepimage` as comments (ex. `\begin{reviewimage}%%sampleimg`) ([#937])
+
+## Docs
+
+* add the rule of searching image files with extension ([#939])
+* add description of `review-textmaker` ([#944])
+
+## Contributors
+
+* [@kauplan](https://github.com/kauplan)
+* [@krororo](https://github.com/krororo)
+* [@mhidaka](https://github.com/mhidaka)
+* [@Pegasus204](https://github.com/Pegasus204)
+
+[#841]: https://github.com/kmuto/review/issues/841
+[#882]: https://github.com/kmuto/review/issues/882
+[#887]: https://github.com/kmuto/review/issues/887
+[#891]: https://github.com/kmuto/review/issues/891
+[#894]: https://github.com/kmuto/review/pull/894
+[#896]: https://github.com/kmuto/review/issues/896
+[#899]: https://github.com/kmuto/review/issues/899
+[#907]: https://github.com/kmuto/review/pull/907
+[#908]: https://github.com/kmuto/review/pull/908
+[#918]: https://github.com/kmuto/review/issues/918
+[#921]: https://github.com/kmuto/review/issues/921
+[#922]: https://github.com/kmuto/review/pull/922
+[#926]: https://github.com/kmuto/review/issues/926
+[#927]: https://github.com/kmuto/review/pull/927
+[#931]: https://github.com/kmuto/review/pull/931
+[#933]: https://github.com/kmuto/review/issues/933
+[#937]: https://github.com/kmuto/review/pull/937
+[#939]: https://github.com/kmuto/review/pull/939
+[#940]: https://github.com/kmuto/review/issues/940
+[#942]: https://github.com/kmuto/review/issues/942
+[#944]: https://github.com/kmuto/review/pull/944
+[#946]: https://github.com/kmuto/review/issues/946
+[#947]: https://github.com/kmuto/review/pull/947
+[#953]: https://github.com/kmuto/review/issues/953
+[#954]: https://github.com/kmuto/review/issues/954
+[#958]: https://github.com/kmuto/review/issues/958
+
 # Version 2.4.0
 
 ## New Features