review 4.1.0 → 5.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (259) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ruby-tex.yml +35 -0
  3. data/.github/workflows/ruby-win.yml +19 -9
  4. data/.github/workflows/ruby.yml +7 -3
  5. data/.rubocop.yml +138 -34
  6. data/NEWS.ja.md +285 -0
  7. data/NEWS.md +285 -1
  8. data/README.md +7 -6
  9. data/Rakefile +7 -2
  10. data/bin/review +2 -4
  11. data/bin/review-catalog-converter +4 -4
  12. data/bin/review-check +8 -12
  13. data/bin/review-checkdep +2 -5
  14. data/bin/review-compile +18 -34
  15. data/bin/review-epub2html +1 -4
  16. data/bin/review-epubmaker +3 -4
  17. data/bin/review-idgxmlmaker +1 -3
  18. data/bin/review-index +5 -86
  19. data/bin/review-init +1 -4
  20. data/bin/review-pdfmaker +1 -3
  21. data/bin/review-preproc +30 -38
  22. data/bin/review-textmaker +1 -3
  23. data/bin/review-update +1 -4
  24. data/bin/review-validate +4 -4
  25. data/bin/review-vol +5 -82
  26. data/bin/review-webmaker +1 -3
  27. data/doc/config.yml.sample +45 -11
  28. data/doc/config.yml.sample-simple +3 -3
  29. data/doc/format.ja.md +103 -13
  30. data/doc/format.md +104 -16
  31. data/doc/makeindex.ja.md +2 -2
  32. data/doc/pdfmaker.ja.md +42 -0
  33. data/doc/pdfmaker.md +41 -0
  34. data/doc/quickstart.ja.md +19 -6
  35. data/doc/quickstart.md +18 -6
  36. data/doc/writing_vertical.ja.md +6 -0
  37. data/lib/review.rb +1 -1
  38. data/lib/review/book.rb +2 -2
  39. data/lib/review/book/base.rb +67 -29
  40. data/lib/review/book/bib.rb +21 -0
  41. data/lib/review/book/book_unit.rb +158 -0
  42. data/lib/review/book/chapter.rb +33 -26
  43. data/lib/review/book/index.rb +24 -185
  44. data/lib/review/book/index/item.rb +7 -1
  45. data/lib/review/book/page_metric.rb +7 -7
  46. data/lib/review/book/part.rb +26 -11
  47. data/lib/review/book/volume.rb +5 -5
  48. data/lib/review/builder.rb +121 -52
  49. data/lib/review/call_hook.rb +20 -0
  50. data/lib/review/catalog.rb +3 -2
  51. data/lib/review/compiler.rb +230 -111
  52. data/lib/review/configure.rb +91 -7
  53. data/lib/review/converter.rb +1 -1
  54. data/lib/review/epub2html.rb +6 -1
  55. data/lib/review/epubmaker.rb +124 -152
  56. data/lib/review/epubmaker/content.rb +113 -0
  57. data/lib/review/epubmaker/epubcommon.rb +372 -0
  58. data/lib/review/epubmaker/epubv2.rb +178 -0
  59. data/lib/review/epubmaker/epubv3.rb +231 -0
  60. data/lib/review/epubmaker/producer.rb +167 -0
  61. data/lib/review/epubmaker/reviewheaderlistener.rb +12 -2
  62. data/lib/review/epubmaker/zip_exporter.rb +84 -0
  63. data/lib/review/exception.rb +13 -0
  64. data/lib/review/htmlbuilder.rb +176 -89
  65. data/lib/review/htmlutils.rb +8 -11
  66. data/lib/review/i18n.rb +2 -1
  67. data/lib/review/idgxmlbuilder.rb +165 -75
  68. data/lib/review/idgxmlmaker.rb +24 -28
  69. data/lib/review/img_math.rb +238 -0
  70. data/lib/review/index_builder.rb +645 -0
  71. data/lib/review/init.rb +9 -17
  72. data/lib/review/latexbox.rb +58 -0
  73. data/lib/review/latexbuilder.rb +193 -75
  74. data/lib/review/latexutils.rb +9 -1
  75. data/lib/review/lineinput.rb +112 -2
  76. data/lib/review/loggable.rb +27 -0
  77. data/lib/review/logger.rb +90 -3
  78. data/lib/review/makerhelper.rb +17 -188
  79. data/lib/review/markdownbuilder.rb +54 -4
  80. data/lib/review/pdfmaker.rb +76 -84
  81. data/lib/review/plaintextbuilder.rb +106 -22
  82. data/lib/review/preprocessor.rb +107 -303
  83. data/lib/review/preprocessor/directive.rb +35 -0
  84. data/lib/review/preprocessor/line.rb +34 -0
  85. data/lib/review/preprocessor/repository.rb +177 -0
  86. data/lib/review/rstbuilder.rb +27 -8
  87. data/lib/review/sec_counter.rb +14 -0
  88. data/lib/review/template.rb +11 -1
  89. data/lib/review/textmaker.rb +27 -32
  90. data/lib/review/textutils.rb +3 -12
  91. data/lib/review/tocprinter.rb +242 -97
  92. data/lib/review/topbuilder.rb +98 -31
  93. data/lib/review/update.rb +12 -13
  94. data/lib/review/version.rb +1 -1
  95. data/lib/review/volumeprinter.rb +97 -0
  96. data/lib/review/webmaker.rb +40 -47
  97. data/lib/review/webtocprinter.rb +39 -35
  98. data/lib/review/yamlloader.rb +2 -1
  99. data/review.gemspec +5 -3
  100. data/samples/sample-book/src/config-epub2.yml +1 -1
  101. data/samples/sample-book/src/config.yml +3 -3
  102. data/samples/sample-book/src/lib/tasks/review.rake +19 -1
  103. data/samples/sample-book/src/lib/tasks/z01_copy_sty.rake +2 -1
  104. data/samples/syntax-book/Gemfile +1 -1
  105. data/samples/syntax-book/ch01.re +1 -1
  106. data/samples/syntax-book/ch02.re +21 -6
  107. data/samples/syntax-book/ch03.re +1 -1
  108. data/samples/syntax-book/config.yml +1 -1
  109. data/samples/syntax-book/images/img3-2.png +0 -0
  110. data/samples/syntax-book/lib/tasks/z01_copy_sty.rake +2 -1
  111. data/templates/html/_colophon.html.erb +23 -0
  112. data/templates/html/_colophon_history.html.erb +9 -0
  113. data/templates/html/_cover.html.erb +10 -0
  114. data/templates/html/_part_body.html.erb +6 -0
  115. data/templates/html/_titlepage.html.erb +20 -0
  116. data/templates/html/layout-html5.html.erb +6 -0
  117. data/templates/html/layout-xhtml1.html.erb +6 -0
  118. data/templates/latex/config.erb +35 -23
  119. data/templates/latex/review-jlreq/README.md +3 -1
  120. data/templates/latex/review-jlreq/review-base.sty +36 -23
  121. data/templates/latex/review-jlreq/review-jlreq.cls +18 -25
  122. data/templates/latex/review-jlreq/review-style.sty +6 -1
  123. data/templates/latex/review-jlreq/review-tcbox.sty +348 -0
  124. data/templates/latex/review-jlreq/reviewmacro.sty +5 -0
  125. data/templates/latex/review-jsbook/README.md +7 -5
  126. data/templates/latex/review-jsbook/review-base.sty +40 -24
  127. data/templates/latex/review-jsbook/review-jsbook.cls +13 -3
  128. data/templates/latex/review-jsbook/review-style.sty +6 -1
  129. data/templates/latex/review-jsbook/review-tcbox.sty +348 -0
  130. data/templates/latex/review-jsbook/reviewmacro.sty +5 -0
  131. data/templates/opf/epubv2.opf.erb +7 -7
  132. data/templates/opf/epubv3.opf.erb +7 -7
  133. data/templates/opf/opf_manifest_epubv2.opf.erb +10 -0
  134. data/templates/opf/opf_manifest_epubv3.opf.erb +10 -0
  135. data/templates/opf/opf_metainfo_epubv2.opf.erb +17 -0
  136. data/templates/opf/opf_metainfo_epubv3.opf.erb +49 -0
  137. data/templates/opf/opf_tocx_epubv2.opf.erb +9 -0
  138. data/templates/opf/opf_tocx_epubv3.opf.erb +17 -0
  139. data/templates/web/html/layout-html5.html.erb +9 -8
  140. data/templates/web/html/layout-xhtml1.html.erb +6 -0
  141. data/test/assets/header_listener.html +35 -0
  142. data/test/assets/img_math/img1.png +0 -0
  143. data/test/assets/img_math/img2.png +0 -0
  144. data/test/assets/img_math/img3.png +0 -0
  145. data/test/assets/syntax_book_index_detail.txt +58 -0
  146. data/test/assets/test_template.tex +6 -3
  147. data/test/assets/test_template_backmatter.tex +6 -3
  148. data/test/book_test_helper.rb +11 -5
  149. data/test/run_test.rb +1 -1
  150. data/test/test_book.rb +54 -63
  151. data/test/test_book_chapter.rb +95 -54
  152. data/test/test_book_part.rb +3 -3
  153. data/test/test_builder.rb +29 -20
  154. data/test/test_catalog_converter_cmd.rb +1 -1
  155. data/test/test_converter.rb +1 -0
  156. data/test/test_epub3maker.rb +170 -126
  157. data/test/test_epubmaker.rb +254 -129
  158. data/test/test_epubmaker_cmd.rb +15 -4
  159. data/test/test_helper.rb +12 -5
  160. data/test/test_htmlbuilder.rb +926 -76
  161. data/test/test_htmlutils.rb +0 -12
  162. data/test/test_i18n.rb +33 -33
  163. data/test/test_idgxmlbuilder.rb +531 -20
  164. data/test/test_idgxmlmaker_cmd.rb +7 -3
  165. data/test/test_img_math.rb +111 -0
  166. data/test/test_index.rb +62 -52
  167. data/test/test_indexbuilder.rb +52 -0
  168. data/test/test_latexbuilder.rb +891 -20
  169. data/test/test_latexbuilder_v2.rb +56 -10
  170. data/test/test_lineinput.rb +20 -93
  171. data/test/test_logger.rb +7 -7
  172. data/test/test_makerhelper.rb +0 -12
  173. data/test/test_markdownbuilder.rb +32 -0
  174. data/test/test_pdfmaker.rb +100 -11
  175. data/test/test_pdfmaker_cmd.rb +3 -3
  176. data/test/test_plaintextbuilder.rb +546 -32
  177. data/test/test_preprocessor.rb +188 -1
  178. data/test/test_review_ext.rb +2 -1
  179. data/test/test_reviewheaderlistener.rb +49 -0
  180. data/test/test_rstbuilder.rb +25 -1
  181. data/test/test_sec_counter.rb +156 -0
  182. data/test/test_template.rb +12 -2
  183. data/test/test_textmaker_cmd.rb +5 -1
  184. data/test/test_tocprinter.rb +46 -0
  185. data/test/test_topbuilder.rb +324 -20
  186. data/test/test_update.rb +44 -44
  187. data/test/test_webtocprinter.rb +75 -43
  188. data/test/test_zip_exporter.rb +5 -6
  189. data/vendor/gentombow/LICENSE +1 -1
  190. data/vendor/gentombow/Makefile +0 -1
  191. data/vendor/gentombow/bounddvi-en.pdf +0 -0
  192. data/vendor/gentombow/bounddvi-en.tex +1 -0
  193. data/vendor/gentombow/bounddvi.pdf +0 -0
  194. data/vendor/gentombow/bounddvi.sty +30 -7
  195. data/vendor/gentombow/bounddvi.tex +1 -0
  196. data/vendor/gentombow/create_archive.sh +1 -0
  197. data/vendor/gentombow/gentombow-ja.pdf +0 -0
  198. data/vendor/gentombow/gentombow-ja.tex +9 -0
  199. data/vendor/gentombow/gentombow.pdf +0 -0
  200. data/vendor/gentombow/gentombow.sty +32 -10
  201. data/vendor/gentombow/gentombow.tex +8 -0
  202. data/vendor/gentombow/tests/gentombow-01-pdfx.tex +8 -0
  203. data/vendor/gentombow/tests/gentombow-02-pdfx.tex +8 -0
  204. data/vendor/jsclasses/Makefile +3 -2
  205. data/vendor/jsclasses/create_archive.sh +5 -5
  206. data/vendor/jsclasses/jis/Makefile +3 -2
  207. data/vendor/jsclasses/jis/jsarticle.cls +22 -18
  208. data/vendor/jsclasses/jis/jsbook.cls +22 -18
  209. data/vendor/jsclasses/jis/jsclasses.dtx +94 -13
  210. data/vendor/jsclasses/jis/jsclasses.ins +15 -5
  211. data/vendor/jsclasses/jis/jslogo.ins +9 -0
  212. data/vendor/jsclasses/jis/jslogo.sty +1 -13
  213. data/vendor/jsclasses/jis/jspf.cls +22 -18
  214. data/vendor/jsclasses/jis/jsreport.cls +22 -18
  215. data/vendor/jsclasses/jis/jsverb.ins +9 -0
  216. data/vendor/jsclasses/jis/jsverb.sty +1 -13
  217. data/vendor/jsclasses/jis/kiyou.cls +22 -18
  218. data/vendor/jsclasses/jis/minijs.sty +65 -22
  219. data/vendor/jsclasses/jis/okumacro.ins +9 -0
  220. data/vendor/jsclasses/jis/okumacro.sty +1 -13
  221. data/vendor/jsclasses/jis/okuverb.ins +9 -0
  222. data/vendor/jsclasses/jis/okuverb.sty +1 -13
  223. data/vendor/jsclasses/jis/winjis.sty +23 -19
  224. data/vendor/jsclasses/jsarticle.cls +22 -18
  225. data/vendor/jsclasses/jsbook.cls +22 -18
  226. data/vendor/jsclasses/jsclasses.dtx +94 -13
  227. data/vendor/jsclasses/jsclasses.ins +15 -5
  228. data/vendor/jsclasses/jsclasses.pdf +0 -0
  229. data/vendor/jsclasses/jslogo.ins +9 -0
  230. data/vendor/jsclasses/jslogo.pdf +0 -0
  231. data/vendor/jsclasses/jslogo.sty +1 -13
  232. data/vendor/jsclasses/jspf.cls +22 -18
  233. data/vendor/jsclasses/jsreport.cls +22 -18
  234. data/vendor/jsclasses/jsverb.ins +9 -0
  235. data/vendor/jsclasses/jsverb.pdf +0 -0
  236. data/vendor/jsclasses/jsverb.sty +1 -13
  237. data/vendor/jsclasses/kiyou.cls +22 -18
  238. data/vendor/jsclasses/minijs.sty +68 -22
  239. data/vendor/jsclasses/okumacro.ins +9 -0
  240. data/vendor/jsclasses/okumacro.pdf +0 -0
  241. data/vendor/jsclasses/okumacro.sty +1 -13
  242. data/vendor/jsclasses/okuverb.ins +9 -0
  243. data/vendor/jsclasses/okuverb.pdf +0 -0
  244. data/vendor/jsclasses/okuverb.sty +1 -13
  245. data/vendor/jsclasses/tests/relfont.tex +10 -0
  246. data/vendor/jsclasses/winjis.sty +23 -19
  247. metadata +106 -22
  248. data/.rubocop_todo.yml +0 -7
  249. data/lib/epubmaker.rb +0 -23
  250. data/lib/epubmaker/content.rb +0 -110
  251. data/lib/epubmaker/epubcommon.rb +0 -441
  252. data/lib/epubmaker/epubv2.rb +0 -143
  253. data/lib/epubmaker/epubv3.rb +0 -233
  254. data/lib/epubmaker/producer.rb +0 -375
  255. data/lib/epubmaker/zip_exporter.rb +0 -81
  256. data/lib/lineinput.rb +0 -155
  257. data/lib/review/book/compilable.rb +0 -178
  258. data/lib/review/tocparser.rb +0 -275
  259. data/test/test_tocparser.rb +0 -25
data/NEWS.ja.md CHANGED
@@ -1,3 +1,288 @@
1
+ # Version 5.2.0
2
+ ## 新機能
3
+ * EPUBMaker: CSS 組版向けに、見出しの存在に応じて `<section>` で階層化する機能を追加しました。config.yml で `epubmaker` セクションの `use_section` パラメータを `true` にすると有効化されます ([#1685])
4
+
5
+ ## バグ修正
6
+ * PDFMaker: Ruby 2.6 以上でテンプレートの引数についての警告が出る問題を修正しました ([#1683])
7
+ * EPUBMaker: Docker 環境においてファイルがコピーされず空になる問題を修正しました ([#1686])
8
+ * 縦中横を正しく表示する CSS 設定を追加しました ([#1688])
9
+ * PDFMaker: 新しい TeXLive との組み合わせで pxjahyper のオプション競合エラーが発生するのを修正しました ([#1690])
10
+ * PDFMaker: 画像が見つからないときにコンパイルエラーになるのを修正しました ([#1706])
11
+
12
+ ## 機能強化
13
+ * 警告とエラーを出力する際の処理を改善しました。`error!` (すぐに終了) および `app_error` (`ApplicationError` 例外を上げる) メソッドを導入しました ([#1674])
14
+ * PDFMaker: ビルドのために画像ファイルをコピーする際、実コピーではなくシンボリックリンクを利用して処理を高速化するオプションを追加しました。`pdfmaker` セクションの `use_symlink` パラメータを `true` にすると、デフォルト挙動の実コピーの代わりにシンボリックリンクが使われます。Windows など一部の OS ではこれは動作しない可能性があります ([#1696])
15
+ * PDFMaker: review-jlreq で `serial_pagination=true, openany` を指定したときには前付の後の空ページが入らないようにしました ([#1711])
16
+
17
+ ## その他
18
+ * GitHub Actions まわりを修正しました ([#1684], [#1691])
19
+ * review-preproc: リファクタリングを行いました ([#1697])
20
+ * 入れ子の箇条書きの処理をリファクタリングしました ([#1698])
21
+ * Rubocop 1.12 に対応しました ([#1689], [#1692], [#1699], [#1700])
22
+ * 各ビルダの `builder_init_file` メソッドで最初に `super` で基底 builder の `builder_init_file` を実行するようにしました ([#1702])
23
+ * PDFMaker: FileUtils ライブラリを内部で使う際に、明示記法の `FIleUtils.foobar` を使うようにしました ([#1704])
24
+
25
+ ## コントリビューターのみなさん
26
+ * [@odaki](https://github.com/odaki)
27
+ * [@imamurayusuke](https://github.com/imamurayusuke)
28
+
29
+ [#1674]: https://github.com/kmuto/review/issues/1674
30
+ [#1683]: https://github.com/kmuto/review/pulls/1683
31
+ [#1684]: https://github.com/kmuto/review/pulls/1684
32
+ [#1685]: https://github.com/kmuto/review/pulls/1685
33
+ [#1686]: https://github.com/kmuto/review/issues/1686
34
+ [#1688]: https://github.com/kmuto/review/pulls/1688
35
+ [#1689]: https://github.com/kmuto/review/pulls/1689
36
+ [#1690]: https://github.com/kmuto/review/pulls/1690
37
+ [#1691]: https://github.com/kmuto/review/pulls/1691
38
+ [#1692]: https://github.com/kmuto/review/pulls/1692
39
+ [#1696]: https://github.com/kmuto/review/issues/1696
40
+ [#1697]: https://github.com/kmuto/review/pulls/1697
41
+ [#1698]: https://github.com/kmuto/review/pulls/1698
42
+ [#1699]: https://github.com/kmuto/review/pulls/1699
43
+ [#1700]: https://github.com/kmuto/review/pulls/1700
44
+ [#1702]: https://github.com/kmuto/review/pulls/1702
45
+ [#1704]: https://github.com/kmuto/review/pulls/1704
46
+ [#1706]: https://github.com/kmuto/review/issues/1706
47
+ [#1711]: https://github.com/kmuto/review/issues/1711
48
+
49
+ # Version 5.1.1
50
+ ## バグ修正
51
+ * `review-preproc` がエラーになるのを修正しました ([#1679])
52
+
53
+ [#1679]: https://github.com/kmuto/review/issues/1679
54
+
55
+ # Version 5.1.0
56
+ ## 新機能
57
+ * CSS 組版ソフトウェア [Vivliostyle-CLI](https://github.com/vivliostyle/vivliostyle-cli) を呼び出す Rake ルールを追加しました。Vivliostyle-CLI をインストールした環境において、`rake vivliostyle:build` または `rake vivliostyle` で PDF を作成、`rake vivliostyle:preview` でブラウザのプレビューが開きます ([#1663])
58
+ * PDFMaker: `config.yml` に `boxsetting` パラメータを新設し、column・note・memo・tip・info・warning・important・caution・notice の囲み飾りを事前定義のものや独自に作成したものから選択およびカスタマイズできるようにしました ([#1637])
59
+ * 挿入箇所を示す `@<ins>`、削除箇所を示す `@<del>` の2つのインライン命令を追加しました ([#1630])
60
+ * EPUBMaker, WebMaker: 数式表現手法として MathJax をサポートし、数式表現手法を `math_format` パラメータで選択するようにしました ([#1587], [#1614])
61
+
62
+ ## 非互換の変更
63
+ * EPUBMaker: `urnid` パラメータのデフォルト値のプレフィクスを、`urn:uid` から `urn:uuid` に変更しました ([#1658])
64
+ * PDFMaker: 長い脚注がページ分断されないようにしました ([#1607])
65
+
66
+ ## バグ修正
67
+ * `contentdir` を設定しているときに WebMaker, review-vol, review-index がエラーになるのを修正しました ([#1633])
68
+ * WebMaker: `images/html` 図版フォルダが見つけられないのを修正しました ([#1623])
69
+ * PDFMaker: 用語リストの見出しで chapterlink がおかしな結果になるのを修正しました ([#1619])
70
+ * PDFMaker: 索引に `{`, `}`, `|` が含まれているときにエラーや奇妙な文字に変換されるのを修正しました ([#1611])
71
+ * review-vol: 不正な見出しがあったときに妥当なエラーメッセージを出力するようにしました ([#1604])
72
+ * PDFMaker: `after_makeindex` フックを LaTeX コンパイル後ではなく `mendex` 実行後に実行するように修正しました ([#1605])
73
+ * PDFMaker: `//image` のキャプションが空だったときに内部エラーではなく図番号が出力されるように修正しました ([#1666])
74
+ * review-vol, review-index が不正なファイルを受け取ったときのエラー処理を修正しました ([#1671])
75
+ * EPUBMaker: author などの静的ファイルを指示したときに、ファイルが存在しないと内部エラーを起こしていたのを修正しました ([#1670])
76
+
77
+ ## 機能強化
78
+ * tty-loger gem パッケージがインストールされている場合、Re:VIEW の各 Maker コマンドの進行状態をアイコンおよびカラーで示すようにしました ([#1660])
79
+ * PDFMaker: クラスファイルで `\RequirePackage{plautopatch}` を最初に評価するようにしました ([#1644])
80
+ * MARKDOWNBuilder: `@<hd>` をサポートしました ([#1629])
81
+ * Re:VIEW ドキュメントファイルに不正なエスケープシーケンス文字が含まれているときにエラーを出すようにしました ([#1596], [#1602])
82
+ * `=` の数が6を超える見出し扱いの行があるときにエラーを出すようにしました ([#1591])
83
+
84
+ ## ドキュメント
85
+ * 画像探索の際に各 Maker が参照するサブフォルダ名について記載しました ([#1626])
86
+
87
+ ## その他
88
+ * EPUBMaker: EPUB ライブラリ一式を `lib/epubmaker` から `lib/review/epubmaker` に移動し、リファクタリングしました ([#1575], [#1617], [#1635], [#1640], [#1641], [#1650], [#1653], [#1655])
89
+ * EPUBMaker: テストを追加しました ([#1656])
90
+ * PDFMaker: いくつかの処理をリファクタリングしました ([#1664])
91
+ * 数式画像生成処理を `ReVIEW::ImgMath` クラスにまとめました ([#1642], [#1649], [#1659], [#1662])
92
+ * IDGXMLMaker: いくつかの処理をリファクタリングしました ([#1654])
93
+ * MakerHelper: いくつかの処理をリファクタリングしました ([#1652])
94
+ * テンプレート処理を `ReVIEW::Template.generate` メソッドに統一しました ([#1648])
95
+ * GitHub Actions で TeX コンパイルのテストも行うようにしました ([#1643])
96
+ * Rubocop 1.10 に対応しました ([#1593], [#1598], [#1613], [#1636], [#1647], [#1669])
97
+ * サンプル syntax-book の重複 ID を修正しました ([#1646])
98
+ * ライブラリの相対パスの参照方法をリファクタリングしました ([#1639])
99
+ * `ReVIEW::LineInput` クラスをリファタクタリングしました ([#1638])
100
+ * Copyright を2021年に更新しました ([#1632])
101
+ * Ruby 3.0 でのテストを実行するようにしました ([#1622])
102
+ * 不安定な Pygments のテストを抑制しました ([#1610], [#1618])
103
+ * WebTocPrinter: テストのエラーを修正しました ([#1606])
104
+ * テストのターゲットを指定しやすいようにしました ([#1594])
105
+
106
+ [#1671]: https://github.com/kmuto/review/issues/1671
107
+ [#1670]: https://github.com/kmuto/review/pull/1670
108
+ [#1669]: https://github.com/kmuto/review/pull/1669
109
+ [#1666]: https://github.com/kmuto/review/issues/1666
110
+ [#1664]: https://github.com/kmuto/review/pull/1664
111
+ [#1663]: https://github.com/kmuto/review/pull/1663
112
+ [#1662]: https://github.com/kmuto/review/issues/1662
113
+ [#1660]: https://github.com/kmuto/review/issues/1660
114
+ [#1659]: https://github.com/kmuto/review/pull/1659
115
+ [#1658]: https://github.com/kmuto/review/pull/1658
116
+ [#1656]: https://github.com/kmuto/review/pull/1656
117
+ [#1655]: https://github.com/kmuto/review/pull/1655
118
+ [#1654]: https://github.com/kmuto/review/pull/1654
119
+ [#1653]: https://github.com/kmuto/review/pull/1653
120
+ [#1652]: https://github.com/kmuto/review/pull/1652
121
+ [#1650]: https://github.com/kmuto/review/pull/1650
122
+ [#1649]: https://github.com/kmuto/review/pull/1649
123
+ [#1648]: https://github.com/kmuto/review/pull/1648
124
+ [#1647]: https://github.com/kmuto/review/pull/1647
125
+ [#1646]: https://github.com/kmuto/review/pull/1646
126
+ [#1644]: https://github.com/kmuto/review/issues/1644
127
+ [#1643]: https://github.com/kmuto/review/pull/1643
128
+ [#1642]: https://github.com/kmuto/review/pull/1642
129
+ [#1641]: https://github.com/kmuto/review/pull/1641
130
+ [#1640]: https://github.com/kmuto/review/pull/1640
131
+ [#1639]: https://github.com/kmuto/review/pull/1639
132
+ [#1638]: https://github.com/kmuto/review/pull/1638
133
+ [#1637]: https://github.com/kmuto/review/pull/1637
134
+ [#1636]: https://github.com/kmuto/review/pull/1636
135
+ [#1635]: https://github.com/kmuto/review/pull/1635
136
+ [#1633]: https://github.com/kmuto/review/issues/1633
137
+ [#1632]: https://github.com/kmuto/review/issues/1632
138
+ [#1630]: https://github.com/kmuto/review/issues/1630
139
+ [#1629]: https://github.com/kmuto/review/pull/1629
140
+ [#1626]: https://github.com/kmuto/review/pull/1626
141
+ [#1623]: https://github.com/kmuto/review/issues/1623
142
+ [#1622]: https://github.com/kmuto/review/pull/1622
143
+ [#1619]: https://github.com/kmuto/review/issues/1619
144
+ [#1618]: https://github.com/kmuto/review/pull/1618
145
+ [#1617]: https://github.com/kmuto/review/pull/1617
146
+ [#1614]: https://github.com/kmuto/review/pull/1614
147
+ [#1613]: https://github.com/kmuto/review/pull/1613
148
+ [#1611]: https://github.com/kmuto/review/issues/1611
149
+ [#1610]: https://github.com/kmuto/review/pull/1610
150
+ [#1607]: https://github.com/kmuto/review/issues/1607
151
+ [#1606]: https://github.com/kmuto/review/issues/1606
152
+ [#1605]: https://github.com/kmuto/review/issues/1605
153
+ [#1604]: https://github.com/kmuto/review/issues/1604
154
+ [#1602]: https://github.com/kmuto/review/pull/1602
155
+ [#1598]: https://github.com/kmuto/review/pull/1598
156
+ [#1596]: https://github.com/kmuto/review/issues/1596
157
+ [#1594]: https://github.com/kmuto/review/pull/1594
158
+ [#1593]: https://github.com/kmuto/review/pull/1593
159
+ [#1591]: https://github.com/kmuto/review/issues/1591
160
+ [#1587]: https://github.com/kmuto/review/issues/1587
161
+ [#1575]: https://github.com/kmuto/review/issues/1575
162
+
163
+ # Version 5.0.0
164
+ ## 新機能
165
+ * review-jsbook / review-jlreq クラスに、`cover_fit_page` オプションを追加しました。`texdocumentclass` パラメータに `cover_fit_page=true` を付けると、画像サイズがどのようなものであっても仕上がりサイズに拡縮して表紙に貼り込みます。なお、制作において図版は実寸で作成することを推奨します ([#1534])
166
+ * 小さな囲み要素 (`//note`, `//memo`, `//tip`, `//info`, `//warning`, `//important`, `//caution`, `//notice`) の中で、`//image` などのブロック命令を含めたり、および箇条書きを入れたりできるようになりました。拡張で類似のことを利用したいときには、defminicolumn で定義します ([#1558], [#1562])
167
+ * 箇条書きの入れ子を指示する命令として `//beginchild`, `//endchild` という1行命令を追加しました。箇条書きの子にしたいものを `//beginchild` と `//endchild` で囲むと、前に位置する箇条書きの子要素になります。**この機能は実験的です。今後のバージョンで挙動を変えたり廃止したりする可能性があります** ([#1497])
168
+
169
+ ## 非互換の変更
170
+ * review-jlreq.cls における hiddenfolio の配置を、jlreqtrimmarkssetup を使って実装するように変更しました。以前のバージョンとは位置や表示に若干の違いがあります ([#1397])
171
+ * `chapterlink` パラメータのデフォルト値を true (有効) にしました。これが有効になっているときには、Web、EPUB での章・項の参照や、図表・リスト・式・参考文献の参照などがハイパーリンク化されます。TeX PDF においては `media=ebook` のときのみ、章・項・参考文献の参照がハイパーリンク化されます ([#1529])
172
+
173
+ ## バグ修正
174
+ * PDFMaker: 同名で拡張子違いの図版ファイルがあるときに、位置がずれる問題を修正しました。extractbb コマンドは明示的に呼び出されなくなります ([#1483])
175
+ * PDFMaker: 著者名 (`aut`) パラメータが空のときにエラーになる問題を修正しました ([#1517])
176
+ * PDFMaker: `//indepimage` 命令で画像が存在せず、かつ ID に TeX のエスケープ対象となる文字を含んでいるとエラーが起きる問題を修正しました ([#1527])
177
+ * PDFMaker: `bookttilename` や `aut` パラメータに TeX のエスケープ対象となる文字を入れると PDF メタ情報がおかしくなる問題を修正しました (`media=ebook` のときのみ) ([#1533])
178
+ * WebMaker: HTML テンプレートで nil が入ってしまうのを修正しました ([#1545])
179
+ * PDFMaker: 章番号を非表示にするとエラーで失敗するのを修正しました ([#1559])
180
+ * MarkdownBuilder: note 等の中の段落を改行区切りではなく空行区切りにしました ([#1572])
181
+
182
+ ## 機能強化
183
+ * 図表などのアイテムでエラーが発生したときの表示を詳細にしました ([#1523])
184
+ * PDFMaker: `@<hd>` 命令で展開した項・段について、`media=ebook` のときにはハイパーリンクになるようにしました ([#1530])
185
+ * HTMLBuilder および IDGXMLBuilder において、文字列のエスケープを従来の `cgi/util` の代わりにより高速な `cgi/escape` が利用できるときにはそれを利用するようにしました。また、`ReVIEW::HTMLUtils.escape` も書き換えられました ([#1536])
186
+ * `@<icon>` 命令の利用時に ID の重複の警告が出るのを抑制しました ([#1541])
187
+ * 不正なエンコーディングのファイルを受け取ったときに妥当なエラー表示をするようにしました ([#1544])
188
+ * IndexBuilder を導入しました。これまで図表等の番号の管理および参照はその都度対象ファイルを解析する方法でしたが、IndexBuilder はプロジェクト全体を走査し、以降の各ビルダのために番号を提供します。review-ext.rb でブロック命令やインライン命令を追加していた場合、IndexBuilder クラス (またはその基底クラスである Builder クラス) にも追加が必要です ([#1384], [#1552])
189
+ * ID やラベルに以下の文字または空白文字が含まれていると、TeX のコンパイルあるいは生成される EPUB においてエラーが発生するため、これらの文字が含まれているときには警告を出すようにしました ([#1393], [#1574])
190
+ ```
191
+ #%\{}[]~/$'"|*?&<>`
192
+ ```
193
+
194
+ ## ドキュメント
195
+ * format.ja.md と format.md のタイプミスを修正しました ([#1528])
196
+ * makeindex.ja.md のサンプル結果の誤りを修正しました ([#1584])
197
+
198
+ ## その他
199
+ * Rubocop 0.92.0 に対応しました ([#1511], [#1569], [#1573])
200
+ * `Re:VIEW::Compiler` 内の `@strategy` は実際はビルダなので、`@builder` という名前に変更しました ([#1520])
201
+ * Rubocop-performance 1.7.1 に対応しました ([#1521])
202
+ * syntax-book サンプルドキュメントの Gemfile を更新しました ([#1522])
203
+ * ImageMagick における GhostScript の呼び出しが非推奨となったため、テストを除去しました ([#1526])
204
+ * 一部のテストユニットの不要な標準エラー出力を抑制しました ([#1538])
205
+ * `Compilable` モジュールの代わりに、`Chapter` および `Part` のスーパークラスとなる `BookUnit` 抽象クラスを導入しました ([#1543])
206
+ * `ReVIEW::Book::Base.load` をやめ、`ReVIEW::Book::Base.load` または `ReVIEW::Book::Base.new` を使うようにしました。`ReVIEW::Book::Base.load` に `:config` オプションを加えました ([#1548], [#1563])
207
+ * 内部のパラメータの汎用構成のために `ReVIEW::Configure.create` コンストラクタを導入しました ([#1549])
208
+ * WebMaker: 使われていない `clean_mathdir` メソッドを削除しました ([#1550])
209
+ * catalog.yml の解析を `ReVIEW::Book::Base.new` の中で最初に実行するようにしました ([#1551])
210
+ * ファイルの書き出しで可能なところは `File.write` を使うようにしました ([#1560])
211
+ * Builder クラスの `builder_init` メソッドを削除し、`initialize` を使うようにしました ([#1564])
212
+
213
+ ## コントリビューターのみなさん
214
+ * [@snoozer05](https://github.com/snoozer05)
215
+
216
+ [#1384]: https://github.com/kmuto/review/pull/1384
217
+ [#1393]: https://github.com/kmuto/review/issues/1393
218
+ [#1397]: https://github.com/kmuto/review/issues/1397
219
+ [#1483]: https://github.com/kmuto/review/issues/1483
220
+ [#1497]: https://github.com/kmuto/review/pull/1497
221
+ [#1511]: https://github.com/kmuto/review/pull/1511
222
+ [#1517]: https://github.com/kmuto/review/issues/1517
223
+ [#1520]: https://github.com/kmuto/review/pull/1520
224
+ [#1521]: https://github.com/kmuto/review/pull/1521
225
+ [#1522]: https://github.com/kmuto/review/pull/1522
226
+ [#1523]: https://github.com/kmuto/review/pull/1523
227
+ [#1526]: https://github.com/kmuto/review/pull/1526
228
+ [#1527]: https://github.com/kmuto/review/pull/1527
229
+ [#1528]: https://github.com/kmuto/review/pull/1528
230
+ [#1529]: https://github.com/kmuto/review/issues/1529
231
+ [#1530]: https://github.com/kmuto/review/issues/1530
232
+ [#1533]: https://github.com/kmuto/review/issues/1533
233
+ [#1534]: https://github.com/kmuto/review/issues/1534
234
+ [#1536]: https://github.com/kmuto/review/pull/1536
235
+ [#1538]: https://github.com/kmuto/review/pull/1538
236
+ [#1541]: https://github.com/kmuto/review/pull/1541
237
+ [#1543]: https://github.com/kmuto/review/pull/1543
238
+ [#1544]: https://github.com/kmuto/review/issues/1544
239
+ [#1545]: https://github.com/kmuto/review/issues/1545
240
+ [#1548]: https://github.com/kmuto/review/pull/1548
241
+ [#1549]: https://github.com/kmuto/review/pull/1549
242
+ [#1550]: https://github.com/kmuto/review/pull/1550
243
+ [#1551]: https://github.com/kmuto/review/pull/1551
244
+ [#1552]: https://github.com/kmuto/review/pull/1552
245
+ [#1558]: https://github.com/kmuto/review/pull/1558
246
+ [#1559]: https://github.com/kmuto/review/issues/1559
247
+ [#1560]: https://github.com/kmuto/review/pull/1560
248
+ [#1562]: https://github.com/kmuto/review/pull/1562
249
+ [#1563]: https://github.com/kmuto/review/pull/1563
250
+ [#1564]: https://github.com/kmuto/review/pull/1564
251
+ [#1569]: https://github.com/kmuto/review/pull/1569
252
+ [#1572]: https://github.com/kmuto/review/pull/1572
253
+ [#1573]: https://github.com/kmuto/review/pull/1573
254
+ [#1574]: https://github.com/kmuto/review/issues/1574
255
+ [#1584]: https://github.com/kmuto/review/pull/1584
256
+
257
+ # Version 4.2.0
258
+ ## 新機能
259
+ * 図・表・リスト・式のキャプションの位置を内容の上側・下側どちらにするかを指定する `caption_position` パラメータを追加しました。`caption_position` の下位パラメータとして `image`・`table`・`list`・`equation` のパラメータがあり、値として `top` (上側) または `bottom` (下側) を指定します。デフォルトは `image` のみ `bottom`、ほかは `top` です ([#1320])
260
+
261
+ ## 非互換の変更
262
+ * review-vol を再構成しました。部の処理や見出し内のインライン命令の処理を正しました。表示形式をわかりやすい形に変更しました。部を指定したときに部のボリュームではなく、部ファイル単体のボリュームを返すようにしました。`-P`, `--directory` オプションは廃止しました ([#1485])
263
+ * review-index を再構成しました。オプション名を大幅に変更しています。行数・文字数は `-d` オプションを指定したときのみ表示するようにしました。また、ファイルの行数・文字数ではなく、PLAINTEXTBuilder を利用して、変換結果に近い行数・文字数を返すようにしました (review-vol よりも正確です)。特定の章は `-y` オプションで複数指定できるようにしました ([#1485])
264
+
265
+ ## バグ修正
266
+ * 重複する `@non_parsed_commands` 宣言を削除しました ([#1499])
267
+ * WebMaker、TextMaker で数式画像が作成されない問題を修正しました ([#1501])
268
+
269
+ ## 機能強化
270
+ * imgmath での数式画像の作成処理を最適化し、高速化しました ([#1488])
271
+ * デフォルト以外の固有の YAML 設定を PDFMaker に引き渡したいときのために、`layouts/config-local.tex.erb` ファイルが存在すればそれを評価・読み込みするようにしました ([#1505])
272
+
273
+ ## その他
274
+ * GitHub Actions を eregon/use-ruby-action から ruby/setup-ruby に切り替えました ([#1490])
275
+ * テストの際、samples フォルダ内にあるビルド成果物を無視するようにしました ([#1504])
276
+
277
+ [#1320]: https://github.com/kmuto/review/issues/1320
278
+ [#1485]: https://github.com/kmuto/review/issues/1485
279
+ [#1488]: https://github.com/kmuto/review/issues/1488
280
+ [#1490]: https://github.com/kmuto/review/pull/1490
281
+ [#1499]: https://github.com/kmuto/review/issues/1499
282
+ [#1501]: https://github.com/kmuto/review/pull/1501
283
+ [#1504]: https://github.com/kmuto/review/pull/1504
284
+ [#1505]: https://github.com/kmuto/review/issues/1505
285
+
1
286
  # Version 4.1.0
2
287
  ## 新機能
3
288
  * 表のセル区切りの文字を `table_row_separator` パラメータで変更できるようにしました。指定可能な値は tabs (1個以上のタブ、デフォルト)、singletab (1文字のタブ文字区切り)、spaces (1文字以上のスペースまたはタブ文字の区切り)、 verticalbar ("0個以上の空白 | 0個以上の空白" の区切り) です ([#1420])
data/NEWS.md CHANGED
@@ -1,3 +1,288 @@
1
+ # Version 5.2.0
2
+ ## New Features
3
+ * EPUBMaker: added `<section>` based on heading level for CSS formatting, when the `epubmaker/use_section` parameter is set to `true` ([#1685])
4
+
5
+ ## Bug Fixes
6
+ * PDFMaker: fixed a problem that caused a warning in templates for Ruby 2.6 and above ([#1683])
7
+ * EPUBMaker: fixed an issue that caused copied files to be empty in Docker environments ([#1686])
8
+ * added CSS style for correct displaying horizontal characters in vertical typesetting ([#1688])
9
+ * PDFMaker: fixed the pxjahyper option conflict error on latest TeXLive ([#1690])
10
+ * PDFMaker: fixed compile error when image is not found ([#1706])
11
+
12
+ ## Enhancements
13
+ * improve around warn and error handling ([#1674])
14
+ * PDFMaker: introduced `pdfmaker/use_symlink` parameter to speed up the process by using symbolic links instead of actual copies. This may not work on some operating systems such as Windows ([#1696])
15
+ * PDFMaker: don't insert empty page after frontmatter when using review-jlreq with `serial_pagination=true, openany` ([#1711])
16
+
17
+ ## Others
18
+ * fixed related to GitHub Actions ([#1684], [#1691])
19
+ * review-preproc: refactored ([#1697])
20
+ * refactored nested lists handling ([#1698])
21
+ * refactor code with Rubocop 1.12 ([#1689], [#1692], [#1699], [#1700])
22
+ * The `builder_init_file` method of each builder now executes `super` first to use base builder's `builder_init_file` ([#1702])
23
+ * PDFMaker: Stopped implicitly including FileUtils library ([#1704])
24
+
25
+ ## Contributors
26
+ * [@odaki](https://github.com/odaki)
27
+ * [@imamurayusuke](https://github.com/imamurayusuke)
28
+
29
+ [#1674]: https://github.com/kmuto/review/issues/1674
30
+ [#1683]: https://github.com/kmuto/review/pulls/1683
31
+ [#1684]: https://github.com/kmuto/review/pulls/1684
32
+ [#1685]: https://github.com/kmuto/review/pulls/1685
33
+ [#1686]: https://github.com/kmuto/review/issues/1686
34
+ [#1688]: https://github.com/kmuto/review/pulls/1688
35
+ [#1689]: https://github.com/kmuto/review/pulls/1689
36
+ [#1690]: https://github.com/kmuto/review/pulls/1690
37
+ [#1691]: https://github.com/kmuto/review/pulls/1691
38
+ [#1692]: https://github.com/kmuto/review/pulls/1692
39
+ [#1696]: https://github.com/kmuto/review/issues/1696
40
+ [#1697]: https://github.com/kmuto/review/pulls/1697
41
+ [#1698]: https://github.com/kmuto/review/pulls/1698
42
+ [#1699]: https://github.com/kmuto/review/pulls/1699
43
+ [#1700]: https://github.com/kmuto/review/pulls/1700
44
+ [#1702]: https://github.com/kmuto/review/pulls/1702
45
+ [#1704]: https://github.com/kmuto/review/pulls/1704
46
+ [#1706]: https://github.com/kmuto/review/issues/1706
47
+ [#1711]: https://github.com/kmuto/review/issues/1711
48
+
49
+ # Version 5.1.1
50
+ ## Bug Fixes
51
+ * Fix the runtime error of `review-preproc` ([#1679])
52
+
53
+ [#1679]: https://github.com/kmuto/review/issues/1679
54
+
55
+ # Version 5.1.0
56
+ ## New Features
57
+ * added Rake rule to call [Vivliostyle-CLI](https://github.com/vivliostyle/vivliostyle-cli), CSS typesetting formatter. Create a PDF with `rake vivliostyle:build` or `rake vivliostyle`, and open a preview with `rake vivliostyle:preview` ([#1663])
58
+ * PDFMaker: introduced `boxsetting` parameter to choose and customize the decorations for column, note, memo, tip, info, warning, important, caution and notice ([#1637])
59
+ * added inline op, `@<ins>` (indicates an insertion) and `@<del>` (indicates a deletion) ([#1630])
60
+ * EPUBMaker, WebMaker: MathJax is now supported. Added `math_format` parameter to choose the mathematical expression method ([#1587], [#1614])
61
+
62
+ ## Breaking Changes
63
+ * EPUBMaker: changed the default value of the `urnid` parameter from `urn:uid` to `urn:uuid` ([#1658])
64
+ * PDFMaker: footnotes are no longer broken up by a page ([#1607])
65
+
66
+ ## Bug Fixes
67
+ * fixed WebMaker, review-vol and review-index errors when `contentdir` is defined ([#1633])
68
+ * WebMaker: fixed `images/html` foder not being found ([#1623])
69
+ * PDFMaker: fixed chapterlink in term list ([#1619])
70
+ * PDFMaker: fixed errors when index contains `{`, `}`, or `|` ([#1611])
71
+ * review-vol: valid error messages will be displayed when invalid headings are found ([#1604])
72
+ * PDFMaker: `after_makeindex` hook to be executed after `mendex` execution, not after LaTeX compilation ([#1605])
73
+ * PDFMaker: if the caption of `//image` is empty, the figure number will be printed instead of an internal error ([#1666])
74
+ * fixed review-vol and review-index errors when a file is invalid ([#1671])
75
+ * EPUBMaker: fixed an error when static file is missing ([#1670])
76
+
77
+ ## Enhancements
78
+ * Maker commands now display with nice colors and icons for their progress status when tty-logger gem is installed ([#1660])
79
+ * PDFMaker: added `\RequirePackage{plautopatch}` definition to class files ([#1644])
80
+ * MARKDOWNBuilder: supported `@<hd>` ([#1629])
81
+ * Re:VIEW now reports an error when a document file contains invalid escape sequence characters ([#1596], [#1602])
82
+ * an error is raised when there are more than 6 `=` in a heading ([#1591])
83
+
84
+ ## Docs
85
+ * documented the name of the image folder referenced by Makers ([#1626])
86
+
87
+ ## Others
88
+ * EPUBMaker: moved EPUB library from `lib/epubmaker` to `lib/review/epubmaker` and refactored it ([#1575], [#1617], [#1635], [#1640], [#1641], [#1650], [#1653], [#1655])
89
+ * EPUBMaker: added tests ([#1656])
90
+ * PDFMaker: refactored some ([#1664])
91
+ * introduced `ReVIEW::ImgMath` class to handle mathematic images ([#1642], [#1649], [#1659], [#1662])
92
+ * IDGXMLMaker: refactored some ([#1654])
93
+ * MakerHelper: refactored some ([#1652])
94
+ * introduced `ReVIEW::Template.generate` class to handle the templates ([#1648])
95
+ * added a test of TeX compilation to GitHub Actions ([#1643])
96
+ * refactored codes according to Rubocop 1.10 ([#1593], [#1598], [#1613], [#1636], [#1647], [#1669])
97
+ * fixed duplicate IDs of syntax-book sample ([#1646])
98
+ * refactored the way to reference relative pathes ([#1639])
99
+ * refactored `ReVIEW::LineInput` class ([#1638])
100
+ * update Copyright to 2021 ([#1632])
101
+ * added Ruby 3.0 to the test platform ([#1622])
102
+ * suppressed tests for Pygments ([#1610], [#1618])
103
+ * WebTocPrinter: fixed an error of test ([#1606])
104
+ * improved to make it easier to specify the target of the test ([#1594])
105
+
106
+ [#1671]: https://github.com/kmuto/review/issues/1671
107
+ [#1670]: https://github.com/kmuto/review/pull/1670
108
+ [#1669]: https://github.com/kmuto/review/pull/1669
109
+ [#1666]: https://github.com/kmuto/review/issues/1666
110
+ [#1664]: https://github.com/kmuto/review/pull/1664
111
+ [#1663]: https://github.com/kmuto/review/pull/1663
112
+ [#1662]: https://github.com/kmuto/review/issues/1662
113
+ [#1660]: https://github.com/kmuto/review/issues/1660
114
+ [#1659]: https://github.com/kmuto/review/pull/1659
115
+ [#1658]: https://github.com/kmuto/review/pull/1658
116
+ [#1656]: https://github.com/kmuto/review/pull/1656
117
+ [#1655]: https://github.com/kmuto/review/pull/1655
118
+ [#1654]: https://github.com/kmuto/review/pull/1654
119
+ [#1653]: https://github.com/kmuto/review/pull/1653
120
+ [#1652]: https://github.com/kmuto/review/pull/1652
121
+ [#1650]: https://github.com/kmuto/review/pull/1650
122
+ [#1649]: https://github.com/kmuto/review/pull/1649
123
+ [#1648]: https://github.com/kmuto/review/pull/1648
124
+ [#1647]: https://github.com/kmuto/review/pull/1647
125
+ [#1646]: https://github.com/kmuto/review/pull/1646
126
+ [#1644]: https://github.com/kmuto/review/issues/1644
127
+ [#1643]: https://github.com/kmuto/review/pull/1643
128
+ [#1642]: https://github.com/kmuto/review/pull/1642
129
+ [#1641]: https://github.com/kmuto/review/pull/1641
130
+ [#1640]: https://github.com/kmuto/review/pull/1640
131
+ [#1639]: https://github.com/kmuto/review/pull/1639
132
+ [#1638]: https://github.com/kmuto/review/pull/1638
133
+ [#1637]: https://github.com/kmuto/review/pull/1637
134
+ [#1636]: https://github.com/kmuto/review/pull/1636
135
+ [#1635]: https://github.com/kmuto/review/pull/1635
136
+ [#1633]: https://github.com/kmuto/review/issues/1633
137
+ [#1632]: https://github.com/kmuto/review/issues/1632
138
+ [#1630]: https://github.com/kmuto/review/issues/1630
139
+ [#1629]: https://github.com/kmuto/review/pull/1629
140
+ [#1626]: https://github.com/kmuto/review/pull/1626
141
+ [#1623]: https://github.com/kmuto/review/issues/1623
142
+ [#1622]: https://github.com/kmuto/review/pull/1622
143
+ [#1619]: https://github.com/kmuto/review/issues/1619
144
+ [#1618]: https://github.com/kmuto/review/pull/1618
145
+ [#1617]: https://github.com/kmuto/review/pull/1617
146
+ [#1614]: https://github.com/kmuto/review/pull/1614
147
+ [#1613]: https://github.com/kmuto/review/pull/1613
148
+ [#1611]: https://github.com/kmuto/review/issues/1611
149
+ [#1610]: https://github.com/kmuto/review/pull/1610
150
+ [#1607]: https://github.com/kmuto/review/issues/1607
151
+ [#1606]: https://github.com/kmuto/review/issues/1606
152
+ [#1605]: https://github.com/kmuto/review/issues/1605
153
+ [#1604]: https://github.com/kmuto/review/issues/1604
154
+ [#1602]: https://github.com/kmuto/review/pull/1602
155
+ [#1598]: https://github.com/kmuto/review/pull/1598
156
+ [#1596]: https://github.com/kmuto/review/issues/1596
157
+ [#1594]: https://github.com/kmuto/review/pull/1594
158
+ [#1593]: https://github.com/kmuto/review/pull/1593
159
+ [#1591]: https://github.com/kmuto/review/issues/1591
160
+ [#1587]: https://github.com/kmuto/review/issues/1587
161
+ [#1575]: https://github.com/kmuto/review/issues/1575
162
+
163
+ # Version 5.0.0
164
+ ## New Features
165
+ * 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])
166
+ * 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])
167
+ * added single commands `//beginchild` and `//endchild` for nesting itemized/enumerate/description list. **EXPERIMENTAL FEATURE** ([#1497])
168
+
169
+ ## Breaking Changes
170
+ * In review-jlreq.cls, hiddenfolio is now implemented by jlreqtrimmarkssetup. It is slightly different from the previous version in position and display ([#1397])
171
+ * 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])
172
+
173
+ ## Bug Fixes
174
+ * PDFMaker: fixed a problem with multiple same-named image files with different extensions that would cause them to be misaligned ([#1483])
175
+ * PDFMaker: fixed a problem that cuased an error when the author name (`aut`) was empty ([#1517])
176
+ * 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])
177
+ * PDFMaker: fixed a problem with characters to be TeX-escaped in the `bookttilename` and `aut` parameters causing incorrect PDF metainformation ([#1533])
178
+ * WebMaker: fixed to avoid nil in HTML template ([#1545])
179
+ * PDFMaker: fixed a problem when hiding chapter numbers ([#1559])
180
+ * MarkdownBuilder: paragraphs in minicolumn should be separated with a blank line instead of a newline ([#1572])
181
+
182
+ ## Enhancements
183
+ * fix warning message to output more detailed information of item ([#1523])
184
+ * PDFMaker: make `@<hd>` op a hyperlink (when `media=ebook`) ([#1530])
185
+ * use `cgi/escape` first and `cgi/util` as fallback. remove orignal implementation in `ReVIEW::HTMLUtils.escape()` ([#1536])
186
+ * suppress warning with same `@<icon>` ([#1541])
187
+ * fix an error handling when a badly encoded file is received ([#1544])
188
+ * introduce IndexBuilder. IndexBuilder first scans the entire project files and provides indexes for each builder ([#1384], [#1552])
189
+ * IDs and labels containing below characters or space characters are now warned ([#1393], [#1574])
190
+ ```
191
+ #%\{}[]~/$'"|*?&<>`
192
+ ```
193
+
194
+ ## Docs
195
+ * fix a typo in format.ja.md and format.md ([#1528])
196
+ * fix incorrect example in makeindex.ja.md ([#1584])
197
+
198
+ ## Others
199
+ * refactor code with Rubocop 0.92.0 ([#1511], [#1569], [#1573])
200
+ * rename `@strategy` to `@builder` in `Re:VIEW::Compiler` ([#1520])
201
+ * refactor code with Rubocop-performance 1.7.1 ([#1521])
202
+ * update Gemfile in syntax-book ([#1522])
203
+ * calling GhostScript in ImageMagick has been deprecated, so the test has been removed ([#1526])
204
+ * unnecessary stderr output on some test units has been suppressed ([#1538])
205
+ * add `BookUnit` class instead of `Compilable` module, the super class of `Chapter` and `Part` ([#1543])
206
+ * `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])
207
+ * added `ReVIEW::Configure.create` ([#1549])
208
+ * WebMaker: removed unused `clean_mathdir` ([#1550])
209
+ * add `Base#parse_catalog_file()` and use it in `ReVIEW::Book::Base.new()`. `Base#catalog` is just getter now ([#1551])
210
+ * use `File.write` when it can be used ([#1560])
211
+ * remove `Builder#builder_init()` ([#1564])
212
+
213
+ ## Contributors
214
+ * [@snoozer05](https://github.com/snoozer05)
215
+
216
+ [#1384]: https://github.com/kmuto/review/pull/1384
217
+ [#1393]: https://github.com/kmuto/review/issues/1393
218
+ [#1397]: https://github.com/kmuto/review/issues/1397
219
+ [#1483]: https://github.com/kmuto/review/issues/1483
220
+ [#1497]: https://github.com/kmuto/review/pull/1497
221
+ [#1511]: https://github.com/kmuto/review/pull/1511
222
+ [#1517]: https://github.com/kmuto/review/issues/1517
223
+ [#1520]: https://github.com/kmuto/review/pull/1520
224
+ [#1521]: https://github.com/kmuto/review/pull/1521
225
+ [#1522]: https://github.com/kmuto/review/pull/1522
226
+ [#1523]: https://github.com/kmuto/review/pull/1523
227
+ [#1526]: https://github.com/kmuto/review/pull/1526
228
+ [#1527]: https://github.com/kmuto/review/pull/1527
229
+ [#1528]: https://github.com/kmuto/review/pull/1528
230
+ [#1529]: https://github.com/kmuto/review/issues/1529
231
+ [#1530]: https://github.com/kmuto/review/issues/1530
232
+ [#1533]: https://github.com/kmuto/review/issues/1533
233
+ [#1534]: https://github.com/kmuto/review/issues/1534
234
+ [#1536]: https://github.com/kmuto/review/pull/1536
235
+ [#1538]: https://github.com/kmuto/review/pull/1538
236
+ [#1541]: https://github.com/kmuto/review/pull/1541
237
+ [#1543]: https://github.com/kmuto/review/pull/1543
238
+ [#1544]: https://github.com/kmuto/review/issues/1544
239
+ [#1545]: https://github.com/kmuto/review/issues/1545
240
+ [#1548]: https://github.com/kmuto/review/pull/1548
241
+ [#1549]: https://github.com/kmuto/review/pull/1549
242
+ [#1550]: https://github.com/kmuto/review/pull/1550
243
+ [#1551]: https://github.com/kmuto/review/pull/1551
244
+ [#1552]: https://github.com/kmuto/review/pull/1552
245
+ [#1558]: https://github.com/kmuto/review/pull/1558
246
+ [#1559]: https://github.com/kmuto/review/issues/1559
247
+ [#1560]: https://github.com/kmuto/review/pull/1560
248
+ [#1562]: https://github.com/kmuto/review/pull/1562
249
+ [#1563]: https://github.com/kmuto/review/pull/1563
250
+ [#1564]: https://github.com/kmuto/review/pull/1564
251
+ [#1569]: https://github.com/kmuto/review/pull/1569
252
+ [#1572]: https://github.com/kmuto/review/pull/1572
253
+ [#1573]: https://github.com/kmuto/review/pull/1573
254
+ [#1574]: https://github.com/kmuto/review/issues/1574
255
+ [#1584]: https://github.com/kmuto/review/pull/1584
256
+
257
+ # Version 4.2.0
258
+ ## New Features
259
+ * 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])
260
+
261
+ ## Breaking Changes
262
+ * 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])
263
+ * 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])
264
+
265
+ ## Bug Fixes
266
+ * remove duplicated `@non_parsed_commands` declaration ([#1499])
267
+ * mathematical images not being created in WebMaker and TextMaker has been fixed ([#1501])
268
+
269
+ ## Enhancements
270
+ * improve a performance of building math figures on imgmath ([#1488])
271
+ * 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])
272
+
273
+ ## Others
274
+ * GitHub Actions: use `ruby/setup-ruby` instead of `eregon/use-ruby-action` ([#1490])
275
+ * skip artifacts in the sample folder during testing ([#1504])
276
+
277
+ [#1320]: https://github.com/kmuto/review/issues/1320
278
+ [#1485]: https://github.com/kmuto/review/issues/1485
279
+ [#1488]: https://github.com/kmuto/review/issues/1488
280
+ [#1490]: https://github.com/kmuto/review/pull/1490
281
+ [#1499]: https://github.com/kmuto/review/issues/1499
282
+ [#1501]: https://github.com/kmuto/review/pull/1501
283
+ [#1504]: https://github.com/kmuto/review/pull/1504
284
+ [#1505]: https://github.com/kmuto/review/issues/1505
285
+
1
286
  # Version 4.1.0
2
287
  ## New Features
3
288
  * 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])
@@ -1571,4 +1856,3 @@ To support language parameter for syntax highlighting, if you use review-ext.rb
1571
1856
  * add headline level 5 and 6 (paragraph, subparagraph)
1572
1857
  * escape all dash
1573
1858
  * add ``begin{alltt}..\end{alltt}`` into ``\reviewemlist``, ``\reviewlist`` and ``\reviewcmd``
1574
-