review 5.10.0 → 5.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/rubocop.yml +2 -2
  3. data/.github/workflows/ruby-win.yml +1 -1
  4. data/.github/workflows/ruby.yml +3 -4
  5. data/.rubocop.yml +19 -1
  6. data/Gemfile +2 -0
  7. data/NEWS.ja.md +54 -3
  8. data/NEWS.md +68 -17
  9. data/Rakefile +2 -0
  10. data/bin/review +2 -0
  11. data/bin/review-catalog-converter +2 -0
  12. data/bin/review-check +2 -0
  13. data/bin/review-checkdep +3 -1
  14. data/bin/review-compile +3 -1
  15. data/bin/review-epub2html +2 -0
  16. data/bin/review-epubmaker +2 -0
  17. data/bin/review-idgxmlmaker +2 -0
  18. data/bin/review-index +2 -0
  19. data/bin/review-init +2 -0
  20. data/bin/review-pdfmaker +2 -0
  21. data/bin/review-preproc +2 -0
  22. data/bin/review-textmaker +2 -0
  23. data/bin/review-update +2 -0
  24. data/bin/review-validate +2 -0
  25. data/bin/review-vol +2 -0
  26. data/bin/review-webmaker +2 -0
  27. data/doc/config.yml.sample +1 -1
  28. data/doc/config.yml.sample-simple +2 -2
  29. data/doc/format.ja.md +1 -0
  30. data/doc/format.md +11 -10
  31. data/doc/makeindex.md +1 -1
  32. data/doc/pdfmaker.md +1 -1
  33. data/doc/preproc.md +1 -1
  34. data/doc/quickstart.md +2 -2
  35. data/doc/writing_vertical.md +1 -1
  36. data/lib/review/book/base.rb +3 -2
  37. data/lib/review/book/bib.rb +2 -0
  38. data/lib/review/book/book_unit.rb +3 -0
  39. data/lib/review/book/cache.rb +2 -0
  40. data/lib/review/book/chapter.rb +3 -1
  41. data/lib/review/book/image_finder.rb +2 -0
  42. data/lib/review/book/index/item.rb +2 -0
  43. data/lib/review/book/index.rb +2 -0
  44. data/lib/review/book/page_metric.rb +2 -0
  45. data/lib/review/book/part.rb +2 -0
  46. data/lib/review/book/volume.rb +2 -0
  47. data/lib/review/book.rb +2 -0
  48. data/lib/review/builder.rb +3 -1
  49. data/lib/review/call_hook.rb +2 -0
  50. data/lib/review/catalog.rb +2 -0
  51. data/lib/review/compiler.rb +8 -4
  52. data/lib/review/configure.rb +2 -0
  53. data/lib/review/converter.rb +2 -0
  54. data/lib/review/epub2html.rb +2 -0
  55. data/lib/review/epubbuilder.rb +2 -0
  56. data/lib/review/epubmaker/content.rb +2 -0
  57. data/lib/review/epubmaker/epubcommon.rb +2 -0
  58. data/lib/review/epubmaker/epubv2.rb +2 -0
  59. data/lib/review/epubmaker/epubv3.rb +3 -1
  60. data/lib/review/epubmaker/producer.rb +2 -0
  61. data/lib/review/epubmaker/reviewheaderlistener.rb +5 -2
  62. data/lib/review/epubmaker/zip_exporter.rb +3 -0
  63. data/lib/review/epubmaker.rb +3 -1
  64. data/lib/review/exception.rb +2 -0
  65. data/lib/review/extentions/hash.rb +2 -0
  66. data/lib/review/extentions/object.rb +2 -0
  67. data/lib/review/extentions/string.rb +2 -0
  68. data/lib/review/extentions.rb +2 -0
  69. data/lib/review/highlighter.rb +147 -0
  70. data/lib/review/htmlbuilder.rb +2 -0
  71. data/lib/review/htmltoc.rb +2 -0
  72. data/lib/review/htmlutils.rb +15 -78
  73. data/lib/review/i18n.rb +2 -0
  74. data/lib/review/idgxmlbuilder.rb +3 -1
  75. data/lib/review/idgxmlmaker.rb +3 -1
  76. data/lib/review/img_graph.rb +2 -0
  77. data/lib/review/img_math.rb +10 -6
  78. data/lib/review/index_builder.rb +10 -0
  79. data/lib/review/init.rb +2 -0
  80. data/lib/review/latexbox.rb +3 -1
  81. data/lib/review/latexbuilder.rb +20 -11
  82. data/lib/review/latexindex.rb +2 -0
  83. data/lib/review/latexutils.rb +2 -0
  84. data/lib/review/lineinput.rb +8 -0
  85. data/lib/review/location.rb +10 -6
  86. data/lib/review/loggable.rb +2 -0
  87. data/lib/review/logger.rb +2 -0
  88. data/lib/review/makerhelper.rb +2 -0
  89. data/lib/review/markdownbuilder.rb +2 -0
  90. data/lib/review/md2inaobuilder.rb +2 -0
  91. data/lib/review/pdfmaker.rb +4 -2
  92. data/lib/review/plaintextbuilder.rb +8 -3
  93. data/lib/review/preprocessor/directive.rb +2 -0
  94. data/lib/review/preprocessor/line.rb +2 -0
  95. data/lib/review/preprocessor/repository.rb +2 -0
  96. data/lib/review/preprocessor.rb +2 -0
  97. data/lib/review/rstbuilder.rb +3 -1
  98. data/lib/review/sec_counter.rb +11 -8
  99. data/lib/review/snapshot_location.rb +30 -0
  100. data/lib/review/template.rb +2 -0
  101. data/lib/review/textbuilder.rb +2 -0
  102. data/lib/review/textmaker.rb +2 -0
  103. data/lib/review/textutils.rb +2 -0
  104. data/lib/review/tocprinter.rb +2 -0
  105. data/lib/review/topbuilder.rb +7 -2
  106. data/lib/review/update.rb +2 -0
  107. data/lib/review/version.rb +3 -1
  108. data/lib/review/volumeprinter.rb +2 -0
  109. data/lib/review/webmaker.rb +2 -0
  110. data/lib/review/webtocprinter.rb +3 -1
  111. data/lib/review/yamlloader.rb +2 -0
  112. data/lib/review.rb +2 -0
  113. data/review.gemspec +7 -2
  114. data/samples/debug-book/.gitignore +154 -0
  115. data/samples/debug-book/Gemfile +4 -0
  116. data/samples/debug-book/Rakefile +3 -0
  117. data/samples/debug-book/advanced_features.re +209 -0
  118. data/samples/debug-book/catalog.yml +12 -0
  119. data/samples/debug-book/comprehensive.re +73 -0
  120. data/samples/debug-book/config.yml +461 -0
  121. data/samples/debug-book/edge_cases_test.re +290 -0
  122. data/samples/debug-book/extreme_features.re +305 -0
  123. data/samples/debug-book/images/cover-a5.pdf +0 -0
  124. data/samples/debug-book/images/cover.jpg +0 -0
  125. data/samples/debug-book/lib/tasks/review.rake +146 -0
  126. data/samples/debug-book/multicontent_test.re +286 -0
  127. data/samples/debug-book/review-jlreq.cls +393 -0
  128. data/samples/debug-book/sty/README.md +118 -0
  129. data/samples/debug-book/sty/gentombow.sty +769 -0
  130. data/samples/debug-book/sty/jsbook.cls +2072 -0
  131. data/samples/debug-book/sty/jumoline.sty +310 -0
  132. data/samples/debug-book/sty/plistings.sty +326 -0
  133. data/samples/debug-book/sty/review-base.sty +444 -0
  134. data/samples/debug-book/sty/review-custom.sty +1 -0
  135. data/samples/debug-book/sty/review-jlreq.cls +393 -0
  136. data/samples/debug-book/sty/review-jsbook.cls +545 -0
  137. data/samples/debug-book/sty/review-style.sty +43 -0
  138. data/samples/debug-book/sty/review-tcbox.sty +348 -0
  139. data/samples/debug-book/sty/reviewmacro.sty +20 -0
  140. data/samples/debug-book/style.css +494 -0
  141. data/samples/sample-book/src/config.yml +1 -1
  142. data/templates/latex/review-jlreq/review-jlreq.cls +1 -0
  143. data/templates/latex/review-jsbook/review-jsbook.cls +1 -0
  144. metadata +81 -14
  145. data/.travis.yml +0 -37
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c2a456720c918f2f50342dfbd711d1d1b5dbc78d73ff311f28ac1614797f358a
4
- data.tar.gz: a674bd3277e09fc000f390036824472f2fdf1a51468efe513fe23f21c44246bd
3
+ metadata.gz: 347c89666bba57322ff0454dee7ce71a24011a05ca1c187dfcedd5a59b7328b6
4
+ data.tar.gz: 7619ad20160f938022b52b7d3d88d48e73f37953b2beaa80a1fac78c0ab7a335
5
5
  SHA512:
6
- metadata.gz: f0e3c8e8fdc5ea94c7931ddc1292e8a6a59717cbf6bb82e4c56233ef054fb3756dfb961f937252328951e66be184b4f924a8c8ca9bcb820bcb3d3567f98e4672
7
- data.tar.gz: 7eff5222bde84c529d9688dd1f64c92c414cea0f20191f45ecf25c972f7a79bc3cb01c6381595063110c0f5abe816b01b9ee3fdffea29d0b671dcdf94959dfb7
6
+ metadata.gz: 4f58a638fea1e725b9d839dfdb95b4624be72bdad1c6bc1a76bb74c315f0b80c8907641b235550eb7acdd62d0909f164f232f3ca49a9d2977008b9da40af117d
7
+ data.tar.gz: 75876750417454fda383c8a4ade030fb2efe60156bd1b127baaaff9b03d26f05aba77fb1519318835eeac17de09e019f6b725e0896e3f00d0d2f198cd65d4ab2
@@ -13,10 +13,10 @@ jobs:
13
13
  strategy:
14
14
  fail-fast: false
15
15
  matrix:
16
- ruby: ['3.0', '3.1', '3.2', '3.3']
16
+ ruby: ['3.0', '3.1', '3.2', '3.3', '3.4']
17
17
  os: [ubuntu-latest]
18
18
  steps:
19
- - uses: actions/checkout@v2
19
+ - uses: actions/checkout@v4
20
20
  - name: Set up Ruby
21
21
  uses: ruby/setup-ruby@v1
22
22
  with:
@@ -13,7 +13,7 @@ jobs:
13
13
  strategy:
14
14
  fail-fast: false
15
15
  matrix:
16
- ruby: [ '3.3', '3.2', '3.1', '3.0' ]
16
+ ruby: [ '4.0', '3.4', '3.3', '3.2', '3.1', '3.0' ]
17
17
 
18
18
  steps:
19
19
  - uses: actions/checkout@v2
@@ -13,19 +13,18 @@ jobs:
13
13
  strategy:
14
14
  fail-fast: false
15
15
  matrix:
16
- ruby: ['3.0', '3.1', '3.2', '3.3']
16
+ ruby: ['3.0', '3.1', '3.2', '3.3', '3.4', '4.0']
17
17
  os: [ubuntu-latest, macOS-latest]
18
18
  steps:
19
- - uses: actions/checkout@v2
19
+ - uses: actions/checkout@v4
20
20
  - name: Set up Ruby
21
21
  uses: ruby/setup-ruby@v1
22
22
  with:
23
23
  ruby-version: ${{ matrix.ruby }}
24
+ bundler-cache: true
24
25
  - name: fix ImageMagick policy.xml on Linux
25
26
  if: runner.os == 'Linux'
26
27
  run: sudo sed -i 's/none/read|write/g' /etc/ImageMagick-6/policy.xml
27
28
  - name: Build and test with Rake
28
29
  run: |
29
- gem install bundler --no-document
30
- bundle install --retry 3
31
30
  bundle exec rake test
data/.rubocop.yml CHANGED
@@ -67,6 +67,10 @@ Style/DocumentDynamicEvalDefinition:
67
67
  Style/Documentation:
68
68
  Enabled: false
69
69
 
70
+ Style/DoubleNegation:
71
+ Exclude:
72
+ - 'test/**/*'
73
+
70
74
  Style/FormatString:
71
75
  EnforcedStyle: sprintf
72
76
  Enabled: true
@@ -94,8 +98,9 @@ Style/TernaryParentheses:
94
98
  Enabled: false
95
99
 
96
100
  Style/FrozenStringLiteralComment:
97
- EnforcedStyle: never
98
101
  Enabled: true
102
+ Exclude:
103
+ - 'samples/**/*'
99
104
 
100
105
  Style/SafeNavigation:
101
106
  Enabled: false
@@ -203,6 +208,12 @@ Style/CombinableLoops:
203
208
  Style/FetchEnvVar:
204
209
  Enabled: false
205
210
 
211
+ Style/MultipleComparison:
212
+ Enabled: false
213
+
214
+ Style/EmptyStringInsideInterpolation:
215
+ Enabled: false
216
+
206
217
  ### Layout
207
218
 
208
219
  Layout/BlockAlignment:
@@ -290,6 +301,9 @@ Naming/FileName:
290
301
  Naming/HeredocDelimiterNaming:
291
302
  Enabled: false
292
303
 
304
+ Naming/MethodName:
305
+ Enabled: false
306
+
293
307
  Naming/MethodParameterName:
294
308
  Enabled: false
295
309
 
@@ -299,6 +313,9 @@ Naming/VariableNumber:
299
313
  Exclude:
300
314
  - test/*
301
315
 
316
+ Naming/PredicateMethod:
317
+ Enabled: false
318
+
302
319
  #### Security
303
320
 
304
321
  #### Gemspec
@@ -310,3 +327,4 @@ Gemspec/DevelopmentDependencies:
310
327
  EnforcedStyle: gemspec
311
328
  Exclude:
312
329
  - samples/syntax-book/Gemfile
330
+ - samples/debug-book/Gemfile
data/Gemfile CHANGED
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  source 'https://rubygems.org'
2
4
 
3
5
  # Specify your gem's dependencies in review.gemspec
data/NEWS.ja.md CHANGED
@@ -1,3 +1,54 @@
1
+ # Version 5.11.0
2
+ ## バグ修正
3
+ * ruby-zip v3 系でのエラーに対処しました ([#1941], [#1942])
4
+ * LATEXBuilder: `@<href>` インライン命令で `#...` の内部アンカーリンクが壊れるのを修正しました ([#1955])
5
+ * review-jsbook と新しい TeXLive 2026 以降の組み合わせにおいて、ビルドエラーが発生する問題を修正しました ([#1960], [#1961])
6
+
7
+ ## 機能強化
8
+ * Ruby 3.4 に対応しました ([#1933], [#1939])
9
+ * PLAINTEXTBuilder および TOPBuilder において `//firstlinenum` を利用できるようになりました ([#1931])
10
+
11
+ ## ドキュメント
12
+ * 各ドキュメントのタイプミスを修正しました ([#1928])
13
+ * `format.md` を更新しました ([#1948])
14
+
15
+ ## その他
16
+ * Travis CI の設定を削除しました([#1943])
17
+ * テストの手法およびそれに関連する実装を改善しました ([#1945], [#1953], [#1954], [#1957], [#1958])
18
+ * RuboCop 1.80.1 の指摘を反映しました ([#1946])
19
+ * イミュータブルな位置情報を取得するための `ReVIEW::SnapshotLocation` を追加しました ([#1949])
20
+ * 文字列から `ReVIEW::LineInput` オブジェクトを作成できる `ReVIEW::LineInput.from_string` メソッドを追加しました ([#1950])
21
+ * ハイライト関連の処理を行うクラス `ReVIEW::Highlighter` を追加しました ([#1951])
22
+ * IndexBuilder において `@<ref>` および `@<labelref>` を処理対象にしました ([#1952])
23
+
24
+ ## コントリビューターのみなさん
25
+ * [@kachick](https://github.com/kachick)
26
+ * [@kurank](https://github.com/kurank)
27
+ * [@y-yagi](https://github.com/y-yagi)
28
+ * [@munepi](https://github.com/munepi)
29
+
30
+ [#1928]: https://github.com/kmuto/review/pull/1928
31
+ [#1931]: https://github.com/kmuto/review/pull/1931
32
+ [#1933]: https://github.com/kmuto/review/issues/1933
33
+ [#1939]: https://github.com/kmuto/review/pull/1939
34
+ [#1941]: https://github.com/kmuto/review/pull/1941
35
+ [#1942]: https://github.com/kmuto/review/pull/1942
36
+ [#1943]: https://github.com/kmuto/review/pull/1943
37
+ [#1945]: https://github.com/kmuto/review/pull/1945
38
+ [#1946]: https://github.com/kmuto/review/pull/1946
39
+ [#1948]: https://github.com/kmuto/review/pull/1948
40
+ [#1949]: https://github.com/kmuto/review/pull/1949
41
+ [#1950]: https://github.com/kmuto/review/pull/1950
42
+ [#1951]: https://github.com/kmuto/review/pull/1951
43
+ [#1952]: https://github.com/kmuto/review/pull/1952
44
+ [#1953]: https://github.com/kmuto/review/pull/1953
45
+ [#1954]: https://github.com/kmuto/review/pull/1954
46
+ [#1955]: https://github.com/kmuto/review/pull/1955
47
+ [#1957]: https://github.com/kmuto/review/pull/1957
48
+ [#1958]: https://github.com/kmuto/review/pull/1958
49
+ [#1960]: https://github.com/kmuto/review/issues/1960
50
+ [#1961]: https://github.com/kmuto/review/pull/1961
51
+
1
52
  # Version 5.10.0
2
53
  ## バグ修正
3
54
  * サブディレクトリとカスタムページを両方指定するとエラーが発生するバグを修正しました([#1913],[#1914])
@@ -972,7 +1023,7 @@
972
1023
  * CSS 組版向けに EPUB ファイルを単一 HTML ファイルに変換する `review-epub2html` コマンドを追加しました ([#1098])
973
1024
 
974
1025
  ## 非互換の変更
975
- * PDFMaker: `texcommand`、`dvicommmand`、`makeindex_command` に空白文字入りのパスを指定できるようにしました。これに伴い、これらのパラメータはコマンドオプションを取ることはできなくなりました。コマンドオプションは本来の `texoptions`、`dvioptions`、`makeindex_options` のパラメータに指定してください ([#1091])
1026
+ * PDFMaker: `texcommand`、`dvicommand`、`makeindex_command` に空白文字入りのパスを指定できるようにしました。これに伴い、これらのパラメータはコマンドオプションを取ることはできなくなりました。コマンドオプションは本来の `texoptions`、`dvioptions`、`makeindex_options` のパラメータに指定してください ([#1091])
976
1027
  * PDFMaker: book.re というファイルで生じるビルドの失敗を修正しました。これまではベースファイルとして `book.tex` という名前のファイルを内部で作成していましたが、`__REVIEW_BOOK__.tex` という名前に変更しました ([#1081])
977
1028
  * PDFMaker: jsbook ベーススタイルにおいて、geometry を読み込まないようにしました ([#912])
978
1029
  * PDFMaker: jsbook ベーススタイルにおいて、ページ番号を見開きの左右に振るようにしました ([#1032])
@@ -1117,7 +1168,7 @@
1117
1168
 
1118
1169
  ## 新機能
1119
1170
  * プレインテキストを出力する review-textmaker コマンドを用意しました ([#926])
1120
- * LaTeX 向けに、図版の BoudingBox の採取手段を変更する `pdfmaker/bbox` パラメータを追加しました ([#947])
1171
+ * LaTeX 向けに、図版の BoundingBox の採取手段を変更する `pdfmaker/bbox` パラメータを追加しました ([#947])
1121
1172
  * 新機能:空行を入れる命令 `//blankline` を追加しました ([#942])
1122
1173
 
1123
1174
  ## 非互換の変更
@@ -1994,7 +2045,7 @@
1994
2045
 
1995
2046
  ### HTMLBuilder
1996
2047
 
1997
- * pygmentsによるhiglightingをconfig.ymlで"pygments: true"と指定した場合のみ有効になるようにしました。
2048
+ * pygmentsによるhighlightingをconfig.ymlで"pygments: true"と指定した場合のみ有効になるようにしました。
1998
2049
  * EPUB3での脚注について、epub:type="noteref"とepub:type="footnote"が指定されるようになりました。
1999
2050
 
2000
2051
  ### LATEXBuilder
data/NEWS.md CHANGED
@@ -1,3 +1,54 @@
1
+ # Version 5.11.0
2
+ ## Bug fixes
3
+ * Fixed errors occurring with ruby-zip v3.x ([#1941], [#1942]).
4
+ * LATEXBuilder: Fixed an issue where internal anchor links starting with `#...` in `@<href>` op would break ([#1955]).
5
+ * Fixed a build error when using review-jsbook in combination with TeXLive 2026 or later ([#1960], [#1961]).
6
+
7
+ ## Enhancements
8
+ * Added support for Ruby 3.4 ([#1933], [#1939]).
9
+ * Enabled support for `//firstlinenum` in PLAINTEXTBuilder and TOPBuilder ([#1931]).
10
+
11
+ ## Docs
12
+ * Fixed typos across various documents ([#1928]).
13
+ * Updated `format.md` ([#1948]).
14
+
15
+ ## Others
16
+ * Removed Travis CI configuration ([#1943]).
17
+ * Improved testing methods and related implementations ([#1945], [#1953], [#1954], [#1957], [#1958]).
18
+ * Applied suggestions from RuboCop 1.80.1 ([#1946]).
19
+ * Added `ReVIEW::SnapshotLocation` for retrieving immutable location information ([#1949]).
20
+ * Added `ReVIEW::LineInput.from_string` method to create `ReVIEW::LineInput` objects from strings ([#1950]).
21
+ * Added `ReVIEW::Highlighter` class to handle syntax highlighting processes ([#1951]).
22
+ * IndexBuilder: Added support for processing `@<ref>` and `@<labelref>` ([#1952]).
23
+
24
+ ## Contributors
25
+ * [@kachick](https://github.com/kachick)
26
+ * [@kurank](https://github.com/kurank)
27
+ * [@y-yagi](https://github.com/y-yagi)
28
+ * [@munepi](https://github.com/munepi)
29
+
30
+ [#1928]: https://github.com/kmuto/review/pull/1928
31
+ [#1931]: https://github.com/kmuto/review/pull/1931
32
+ [#1933]: https://github.com/kmuto/review/issues/1933
33
+ [#1939]: https://github.com/kmuto/review/pull/1939
34
+ [#1941]: https://github.com/kmuto/review/pull/1941
35
+ [#1942]: https://github.com/kmuto/review/pull/1942
36
+ [#1943]: https://github.com/kmuto/review/pull/1943
37
+ [#1945]: https://github.com/kmuto/review/pull/1945
38
+ [#1946]: https://github.com/kmuto/review/pull/1946
39
+ [#1948]: https://github.com/kmuto/review/pull/1948
40
+ [#1949]: https://github.com/kmuto/review/pull/1949
41
+ [#1950]: https://github.com/kmuto/review/pull/1950
42
+ [#1951]: https://github.com/kmuto/review/pull/1951
43
+ [#1952]: https://github.com/kmuto/review/pull/1952
44
+ [#1953]: https://github.com/kmuto/review/pull/1953
45
+ [#1954]: https://github.com/kmuto/review/pull/1954
46
+ [#1955]: https://github.com/kmuto/review/pull/1955
47
+ [#1957]: https://github.com/kmuto/review/pull/1957
48
+ [#1958]: https://github.com/kmuto/review/pull/1958
49
+ [#1960]: https://github.com/kmuto/review/issues/1960
50
+ [#1961]: https://github.com/kmuto/review/pull/1961
51
+
1
52
  # Version 5.10.0
2
53
  ## Bug Fixes
3
54
  * Fixed an issue where specifying both a subdirectory and a custom page would cause an error ([#1913], [#1914]).
@@ -279,7 +330,7 @@
279
330
 
280
331
  ## Bug Fixes
281
332
  * fixed WebMaker, review-vol and review-index errors when `contentdir` is defined ([#1633])
282
- * WebMaker: fixed `images/html` foder not being found ([#1623])
333
+ * WebMaker: fixed `images/html` folder not being found ([#1623])
283
334
  * PDFMaker: fixed chapterlink in term list ([#1619])
284
335
  * PDFMaker: fixed errors when index contains `{`, `}`, or `|` ([#1611])
285
336
  * review-vol: valid error messages will be displayed when invalid headings are found ([#1604])
@@ -309,7 +360,7 @@
309
360
  * added a test of TeX compilation to GitHub Actions ([#1643])
310
361
  * refactored codes according to Rubocop 1.10 ([#1593], [#1598], [#1613], [#1636], [#1647], [#1669])
311
362
  * fixed duplicate IDs of syntax-book sample ([#1646])
312
- * refactored the way to reference relative pathes ([#1639])
363
+ * refactored the way to reference relative paths ([#1639])
313
364
  * refactored `ReVIEW::LineInput` class ([#1638])
314
365
  * update Copyright to 2021 ([#1632])
315
366
  * added Ruby 3.0 to the test platform ([#1622])
@@ -386,7 +437,7 @@
386
437
 
387
438
  ## Bug Fixes
388
439
  * PDFMaker: fixed a problem with multiple same-named image files with different extensions that would cause them to be misaligned ([#1483])
389
- * PDFMaker: fixed a problem that cuased an error when the author name (`aut`) was empty ([#1517])
440
+ * PDFMaker: fixed a problem that caused an error when the author name (`aut`) was empty ([#1517])
390
441
  * 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])
391
442
  * PDFMaker: fixed a problem with characters to be TeX-escaped in the `bookttilename` and `aut` parameters causing incorrect PDF metainformation ([#1533])
392
443
  * WebMaker: fixed to avoid nil in HTML template ([#1545])
@@ -396,7 +447,7 @@
396
447
  ## Enhancements
397
448
  * fix warning message to output more detailed information of item ([#1523])
398
449
  * PDFMaker: make `@<hd>` op a hyperlink (when `media=ebook`) ([#1530])
399
- * use `cgi/escape` first and `cgi/util` as fallback. remove orignal implementation in `ReVIEW::HTMLUtils.escape()` ([#1536])
450
+ * use `cgi/escape` first and `cgi/util` as fallback. remove original implementation in `ReVIEW::HTMLUtils.escape()` ([#1536])
400
451
  * suppress warning with same `@<icon>` ([#1541])
401
452
  * fix an error handling when a badly encoded file is received ([#1544])
402
453
  * introduce IndexBuilder. IndexBuilder first scans the entire project files and provides indexes for each builder ([#1384], [#1552])
@@ -499,7 +550,7 @@
499
550
 
500
551
  # Version 4.1.0
501
552
  ## New Features
502
- * 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])
553
+ * add `table_row_separator` to specify a separator that separates table rows. Acceptable value: tabs (means `\t+`, default), `singletab` (means `\t`), spaces (means `\s+`), verticalbar (means `\s*\|\s*`) ([#1420])
503
554
  * PDFMaker, EPUBMaker, WEBMaker, TEXTMaker, IDGXMLMaker: add `-y` (`--only`) option to specify the files to convert instead of all files ([#1428])
504
555
  * add `--without-config-comment` option to review-init command to exclude comments from config.yml ([#1453])
505
556
  * 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])
@@ -646,7 +697,7 @@
646
697
  * refactor mkdchap* and mkpart* ([#1383])
647
698
  * don't update rubygems in Travis CI ([#1389])
648
699
  * refactor around Index ([#1390])
649
- * add configration for review-jlreq to sample documents ([#1391])
700
+ * add configuration for review-jlreq to sample documents ([#1391])
650
701
  * definition list should start with spaces ([#1398])
651
702
 
652
703
  ## Contributors
@@ -971,7 +1022,7 @@
971
1022
  * add `review-epub2html` to produce single HTML file from EPUB file for CSS typesetting ([#1098])
972
1023
 
973
1024
  ## Breaking Changes
974
- * PDFMaker: allow a path with space character on `texcommand`, `dvicommmand`, and `makeindex_command`. Due to this change, these parameters no longer take command options. use `texoptions`, `dvioptions`, and `makeindex_options` to specify options ([#1091])
1025
+ * PDFMaker: allow a path with space character on `texcommand`, `dvicommand`, and `makeindex_command`. Due to this change, these parameters no longer take command options. use `texoptions`, `dvioptions`, and `makeindex_options` to specify options ([#1091])
975
1026
  * PDFMaker: the file used internally has been changed from `book.tex` to `__REVIEW_BOOK__.tex` ([#1081])
976
1027
  * PDFMaker: dropped geometry.sty from jsbook style ([#912])
977
1028
  * PDFMaker: use twocolumn option for jsbook style ([#1032])
@@ -991,7 +1042,7 @@
991
1042
 
992
1043
  ## Docs
993
1044
  * Move sample documents to /samples folder ([#1073])
994
- * Add descriptions abount hooks and parameters of indexing into `config.yml.sample` ([#1097])
1045
+ * Add descriptions about hooks and parameters of indexing into `config.yml.sample` ([#1097])
995
1046
  * Fix typo in quickstart.md ([#1079])
996
1047
 
997
1048
  ## Contributors
@@ -1035,7 +1086,7 @@
1035
1086
  * When the value of review_version is 3 or more, `@<m>` no longer add a space before and after formula ([#943])
1036
1087
  * the function of automatic detection of highlight target language by identifier in `//list`, `//listnum` is removed from HTMLBuilder ([#1016])
1037
1088
  * LATEXBuilder: restructured `layout.tex.erb` ([#950])
1038
- * LATEXBuilder: add a new envirionment `reviewlistblock` in LaTeX ([#916])
1089
+ * LATEXBuilder: add a new environment `reviewlistblock` in LaTeX ([#916])
1039
1090
  * LATEXBuilder: attach `plistings` package and suport it instead of jlisting for `listings` ([#635])
1040
1091
  * LATEXBuilder: remove underline in anchor for printing use ([#808])
1041
1092
  * LATEXBuilder: use more abstract name like `\reviewbold` instead of `\textbf` ([#792])
@@ -1116,7 +1167,7 @@
1116
1167
  ## New Features
1117
1168
 
1118
1169
  * add a new maker command `review-textmaker` to output plain text files ([#926])
1119
- * LATEXBuilder: add a new parameter `pdfmaker/bbox` for settings of BoudingBox ([#947])
1170
+ * LATEXBuilder: add a new parameter `pdfmaker/bbox` for settings of BoundingBox ([#947])
1120
1171
  * add a new command `//blankline` ([#942])
1121
1172
 
1122
1173
  ## Breaking Changes
@@ -1131,7 +1182,7 @@
1131
1182
  * fix column closing ([#894])
1132
1183
  * fix internal errors in `@<hd>` ([#896])
1133
1184
  * LATEXBuilder: fix to ignore empty caption ([#922])
1134
- * fix invalid commmand errors in `//graph` when using gnuplot ([#931])
1185
+ * fix invalid command errors in `//graph` when using gnuplot ([#931])
1135
1186
  * fix errors of `review` command in Windows ([#940])
1136
1187
  * EPUBMaker: fix error of removing temporary files in Windows ([#946])
1137
1188
 
@@ -1196,7 +1247,7 @@
1196
1247
  * use built-in Logger class for warns and errors ([#705])
1197
1248
  * EPUBMaker: warn of large images because of rejecting ebook stores ([#819])
1198
1249
  * LATEXBuilder: add new inline command `@<pageref>` ([#836])
1199
- * support inline notaion `| |` and `$ $` instead of `{}` to surpress escaping `}` ([#876])
1250
+ * support inline notation `| |` and `$ $` instead of `{}` to suppress escaping `}` ([#876])
1200
1251
 
1201
1252
  ## Breaking Changes
1202
1253
 
@@ -1211,7 +1262,7 @@
1211
1262
 
1212
1263
  * fix misrecognition of HeadlineIndex ([#121])
1213
1264
  * TOPBuilder: fix metric parameter in `//image` and `//indepimage` ([#805])
1214
- * fix refering columns in other chapters ([#817])
1265
+ * fix referring columns in other chapters ([#817])
1215
1266
  * use execution date when `date` in config.yml is empty ([#824])
1216
1267
  * fix I18N messages of `listref`, `imgref`, and `tableref` in frontmatters and backmatters ([#830])
1217
1268
  * WebMaker: fix booktitle using Hash ([#831])
@@ -1235,7 +1286,7 @@
1235
1286
 
1236
1287
  ## Others
1237
1288
 
1238
- * fix coding rules to surpress rubocop v0.50.0 ([#823])
1289
+ * fix coding rules to suppress rubocop v0.50.0 ([#823])
1239
1290
 
1240
1291
  ## Contributors
1241
1292
 
@@ -1340,7 +1391,7 @@
1340
1391
  * PDFMaker: support index `@<idx>`, `@<hidx>` ([#261],[#660],[#669],[#740])
1341
1392
  * add RSTBuilder ([#733],[#738])
1342
1393
  * add `//embed{...//}` and `@<embed>{...}` ([#730],[#751],[#757],[#758])
1343
- * HTMLBuilder, IDGXMLBuilder, LATEXBuilder: suppot `//firstlinenum` for `//listnum` and `//emlistnum` ([#685],[#688])
1394
+ * HTMLBuilder, IDGXMLBuilder, LATEXBuilder: support `//firstlinenum` for `//listnum` and `//emlistnum` ([#685],[#688])
1344
1395
  * review-compile: `--nolfinxml` is deprecated ([#683],[#708])
1345
1396
  * HTMLBuilder: Enclose references (`@<img>`, `@<table>`, and `@<list>`) with `<span>`. Class names are 'imgref', 'tableref', and 'listref'. ([#696],[#697])
1346
1397
  * HTMLBuilder: support Rouge ([#684],[#710],[#711])
@@ -1549,7 +1600,7 @@
1549
1600
  * PDFMaker: Migrate platex to uplatex ([#541])
1550
1601
  * EPUBMaker: Support ebpaj format. ([#251], [#429])
1551
1602
  * EPUBMaker: Add `direction` in default setting ([#508])
1552
- * EPUBMaker: Allow `pronounciation` of booktitle and author ([#507])
1603
+ * EPUBMaker: Allow `pronunciation` of booktitle and author ([#507])
1553
1604
  * review-preproc: allow monkeypatch in review-preproc ([#494])
1554
1605
  * HTMLBuilder: Disable hyperlink with `@<href>` with epubmaker/externallink: false in config.yml ([#509], [#544])
1555
1606
  * EPUBMaker: Add custom prefix and `<meta>` element in OPF ([#513])
@@ -2001,7 +2052,7 @@ To support language parameter for syntax highlighting, if you use review-ext.rb
2001
2052
 
2002
2053
  ### HTMLBuilder
2003
2054
 
2004
- * Use pygments higlighting only if "pygments: true" is defined.
2055
+ * Use pygments highlighting only if "pygments: true" is defined.
2005
2056
  * Support epub:type="noteref" and epub:type="footnote" in EPUB3
2006
2057
 
2007
2058
  ### LATEXBuilder
data/Rakefile CHANGED
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  begin
2
4
  require 'bundler'
3
5
  Bundler::GemHelper.install_tasks
data/bin/review CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # review: Wrapper command to call subcommand
4
6
  #
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # Copyright (c) 2014-2019 Masanori Kado, Kenshi Muto
4
6
  #
data/bin/review-check CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # Copyright (c) 2010-2019 Kenshi Muto, Minero Aoki
4
6
  # 1999-2007 Minero Aoki
data/bin/review-checkdep CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # Copyright (c) 2007-2017 Minero Aoki, Kenshi Muto
4
6
  # 1999-2007 Minero Aoki
@@ -11,7 +13,7 @@
11
13
 
12
14
  $LOAD_PATH.unshift(File.realpath('../lib', __dir__))
13
15
 
14
- PREDEF_FILE = 'PREDEF'.freeze
16
+ PREDEF_FILE = 'PREDEF'
15
17
 
16
18
  def main
17
19
  @provided = parse_predefined
data/bin/review-compile CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # Copyright (c) 2008-2019 Kenshi Muto, Masayoshi Takahashi, KADO Masanori, Minero Aoki
4
6
  # Copyright (c) 1999-2007 Minero Aoki
@@ -18,7 +20,7 @@ require 'yaml'
18
20
 
19
21
  include ReVIEW::Loggable
20
22
 
21
- DEFAULT_CONFIG_FILENAME = 'config.yml'.freeze
23
+ DEFAULT_CONFIG_FILENAME = 'config.yml'
22
24
 
23
25
  def main
24
26
  Signal.trap(:INT) { exit 1 }
data/bin/review-epub2html CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # Copyright (c) 2018 Kenshi Muto
4
6
  #
data/bin/review-epubmaker CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  # Copyright (c) 2010-2019 Kenshi Muto and Masayoshi Takahashi
3
5
  #
4
6
  # This program is free software.
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  # Copyright (c) 2019 Kenshi Muto
3
5
  #
4
6
  # This program is free software.
data/bin/review-index CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
4
6
  # 1999-2007 Minero Aoki
data/bin/review-init CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # Copyright (c) 2013-2017 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
4
6
  #
data/bin/review-pdfmaker CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  # Copyright (c) 2010-2017 Kenshi Muto and Masayoshi Takahashi
3
5
  #
4
6
  # This program is free software.
data/bin/review-preproc CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # Copyright (c) 2010-2019 Minero Aoki, Kenshi Muto
4
6
  # 1999-2007 Minero Aoki
data/bin/review-textmaker CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  # Copyright (c) 2018 Kenshi Muto
3
5
  #
4
6
  # This program is free software.
data/bin/review-update CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # Copyright (c) 2018 Kenshi Muto
4
6
  #
data/bin/review-validate CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  # Copyright (c) 2010-2019 Kenshi Muto
3
5
  #
4
6
  # This program is free software
data/bin/review-vol CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # Copyright (c) 2014-2020 Minero Aoki, Kenshi Muto
4
6
  # 2003-2014 Minero Aoki
data/bin/review-webmaker CHANGED
@@ -1,4 +1,6 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  #
3
5
  # This program is free software.
4
6
  # You can distribute or modify this program under the terms of
@@ -416,7 +416,7 @@ pdfmaker:
416
416
  # 画像のデフォルトのサイズを、版面横幅合わせではなく、原寸をそのまま利用する
417
417
  # use_original_image_size: null
418
418
  #
419
- # PDFやIllustratorファイル(.ai)の画像のBoudingBoxの抽出に指定のボックスを採用する
419
+ # PDFやIllustratorファイル(.ai)の画像のBoundingBoxの抽出に指定のボックスを採用する
420
420
  # cropbox(デフォルト), mediabox, artbox, trimbox, bleedboxから選択する。
421
421
  # Illustrator CC以降のIllustratorファイルに対してはmediaboxを指定する必要がある
422
422
  # bbox: mediabox
@@ -3,7 +3,7 @@ review_version: 5.0
3
3
 
4
4
  # debug: true
5
5
 
6
- ## inherited configuratons
6
+ ## inherited configurations
7
7
 
8
8
  # inherit: ["config-default.yml"]
9
9
 
@@ -23,7 +23,7 @@ prt: "Re:VIEW Printing inc."
23
23
  contact: "https://reviewml.org/"
24
24
  date: 2018-11-11
25
25
  history: [["2012-01-30"],["2016-04-20","2016-05-03"],["2018-11-11"]]
26
- rights: (C) 2016-2020 Re:VIEW Commiters, some rights reserved.
26
+ rights: (C) 2016-2020 Re:VIEW Committers, some rights reserved.
27
27
  description: sample config.yml file for Re:VIEW book
28
28
  # urnid: urn:uuid:ffffffff-ffff-ffff-ffff-ffffffffffff
29
29
  # isbn: null
data/doc/format.ja.md CHANGED
@@ -1150,6 +1150,7 @@ UL1-OL1-PARAGRAPH
1150
1150
  * `@<eq>{識別子}` : 式を参照します。
1151
1151
  * `@<hd>{ラベルまたは見出し}` : 節や項を参照します。
1152
1152
  * `@<column>{ラベルまたは見出し}` : コラムを参照します。
1153
+ * `@<ref>{ラベルID}` : `@<labelref>`のエイリアス。ラベルを参照します。
1153
1154
 
1154
1155
  ### その他
1155
1156
  * `@<ruby>{親文字,ルビ}` : ルビを振ります。たとえば `@<ruby>{愕然,がくぜん}` のように表記します。