review 1.7.2 → 2.0.0.beta1

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 (101) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +1 -43
  3. data/.travis.yml +0 -9
  4. data/ChangeLog +0 -16
  5. data/Gemfile +1 -0
  6. data/README.rdoc +1 -1
  7. data/Rakefile +12 -1
  8. data/bin/review-check +21 -8
  9. data/bin/review-compile +15 -9
  10. data/bin/review-epubmaker-legacy +6 -6
  11. data/bin/review-index +13 -2
  12. data/bin/review-init +18 -12
  13. data/bin/review-preproc +14 -1
  14. data/bin/review-validate +1 -1
  15. data/bin/review-vol +13 -1
  16. data/doc/quickstart.ja.md +1 -1
  17. data/doc/quickstart.md +1 -1
  18. data/lib/epubmaker/content.rb +3 -3
  19. data/lib/epubmaker/epubcommon.rb +108 -91
  20. data/lib/epubmaker/epubv2.rb +67 -14
  21. data/lib/epubmaker/epubv3.rb +59 -25
  22. data/lib/epubmaker/producer.rb +1 -13
  23. data/lib/lineinput.rb +0 -48
  24. data/lib/review/book/base.rb +4 -12
  25. data/lib/review/book/compilable.rb +3 -1
  26. data/lib/review/book/index.rb +4 -4
  27. data/lib/review/builder.rb +54 -47
  28. data/lib/review/compiler.rb +4662 -326
  29. data/lib/review/compiler/literals_1_8.kpeg +19 -0
  30. data/lib/review/compiler/literals_1_8.rb +432 -0
  31. data/lib/review/compiler/literals_1_9.kpeg +22 -0
  32. data/lib/review/compiler/literals_1_9.rb +435 -0
  33. data/lib/review/configure.rb +8 -20
  34. data/lib/review/epubbuilder.rb +1 -1
  35. data/lib/review/epubmaker.rb +122 -52
  36. data/lib/review/ewbbuilder.rb +4 -4
  37. data/lib/review/exception.rb +1 -1
  38. data/lib/review/extentions.rb +1 -0
  39. data/lib/review/extentions/array.rb +25 -0
  40. data/lib/review/htmlbuilder.rb +286 -275
  41. data/lib/review/htmllayout.rb +0 -2
  42. data/lib/review/htmlutils.rb +4 -4
  43. data/lib/review/i18n.rb +2 -6
  44. data/lib/review/i18n.yml +1 -1
  45. data/lib/review/idgxmlbuilder.rb +239 -204
  46. data/lib/review/inaobuilder.rb +75 -73
  47. data/lib/review/latexbuilder.rb +265 -219
  48. data/lib/review/latexutils.rb +6 -6
  49. data/lib/review/layout.tex.erb +1 -1
  50. data/lib/review/location.rb +24 -0
  51. data/lib/review/markdownbuilder.rb +124 -79
  52. data/lib/review/node.rb +267 -0
  53. data/lib/review/pdfmaker.rb +92 -92
  54. data/lib/review/preprocessor.rb +51 -14
  55. data/lib/review/review.kpeg +724 -0
  56. data/lib/review/textbuilder.rb +1 -1
  57. data/lib/review/textutils.rb +24 -18
  58. data/lib/review/tocparser.rb +3 -3
  59. data/lib/review/tocprinter.rb +31 -8
  60. data/lib/review/topbuilder.rb +119 -111
  61. data/lib/review/unfold.rb +2 -2
  62. data/lib/review/version.rb +1 -1
  63. data/review.gemspec +2 -2
  64. data/rubocop-todo.yml +456 -0
  65. data/test/assets/test_template.tex +1 -1
  66. data/test/sample-book/src/config.yml +0 -1
  67. data/test/test.re +1 -1
  68. data/test/test_book.rb +4 -4
  69. data/test/test_book_chapter.rb +70 -0
  70. data/test/test_book_part.rb +1 -1
  71. data/test/test_builder.rb +6 -28
  72. data/test/test_compiler.rb +59 -14
  73. data/test/test_helper.rb +47 -4
  74. data/test/test_htmlbuilder.rb +104 -73
  75. data/test/test_i18n.rb +5 -3
  76. data/test/test_idgxmlbuilder.rb +5 -2
  77. data/test/test_inaobuilder.rb +4 -2
  78. data/test/test_latexbuilder.rb +18 -37
  79. data/test/test_lineinput.rb +25 -4
  80. data/test/test_markdownbuilder.rb +4 -22
  81. data/test/test_pdfmaker.rb +12 -11
  82. data/test/test_textutils.rb +0 -36
  83. data/test/test_topbuilder.rb +2 -0
  84. metadata +14 -28
  85. data/.rubocop_todo.yml +0 -605
  86. data/Dockerfile +0 -22
  87. data/doc/NEWS.ja.md +0 -362
  88. data/doc/NEWS.md +0 -366
  89. data/lib/review/htmltoc.rb +0 -45
  90. data/lib/review/template.rb +0 -21
  91. data/templates/html/layout-html5.html.erb +0 -17
  92. data/templates/html/layout-xhtml1.html.erb +0 -20
  93. data/templates/ncx/epubv2.ncx.erb +0 -11
  94. data/templates/opf/epubv2.opf.erb +0 -21
  95. data/templates/opf/epubv3.opf.erb +0 -18
  96. data/templates/xml/container.xml.erb +0 -6
  97. data/test/assets/test.xml.erb +0 -3
  98. data/test/sample-book/src/config-epub2.yml +0 -186
  99. data/test/test_configure.rb +0 -50
  100. data/test/test_htmltoc.rb +0 -32
  101. data/test/test_template.rb +0 -26
data/Dockerfile DELETED
@@ -1,22 +0,0 @@
1
- # This file is a sample Dockerfile to build Re:VIEW documents.
2
- #
3
- # Build:
4
- # $ docker build -t review .
5
- #
6
- # Usage:
7
- # $ cd path/to/review/project
8
- # $ docker run -it --rm -v `pwd`:/work review rake pdf
9
- #
10
- # cf. https://github.com/vvakame/docker-review/blob/master/Dockerfile
11
-
12
- FROM debian:sid
13
- MAINTAINER takahashim
14
-
15
- RUN apt-get update \
16
- && apt-get install -y --no-install-recommends git-core ruby locales zip \
17
- && apt-get install -y --no-install-recommends texlive-lang-cjk texlive-lang-japanese texlive-fonts-recommended texlive-latex-extra ghostscript \
18
- && rm -rf /var/lib/apt/lists/*
19
- RUN gem install review rake bundler --no-rdoc --no-ri
20
-
21
- VOLUME ["/work"]
22
- WORKDIR /work
data/doc/NEWS.ja.md DELETED
@@ -1,362 +0,0 @@
1
- # Version 1.7.2の主な変更点
2
-
3
- ## バグ修正
4
- * latexbuilderで`//list`がhighlitingなしのときにキャプションが表示されなくなっていたのを修正しました ([#465])
5
- * markdownbuilderでdefinition listを使うとエラーになるのを修正しました ([#473])
6
-
7
- # Version 1.7.1の主な変更点
8
-
9
- ## バグ修正
10
- * latexbuilderで`//listnum`のキャプションが2重に出力されるバグを修正しました ([#465])
11
- * review-initで生成される雛形を元にEPUB3のファイルを作成するとepubcheck 4.0.1でエラーになるバグを修正しました ([#456])
12
-
13
- # Version 1.7.0の主な変更点
14
-
15
- ## 全般
16
- * Rubocopの設定の追加とそれに伴うリファクタリングを実施しました
17
- * 内部の文字コードをUTF-8に統一しました ([#399])
18
- * Dockerfileを追加しました
19
-
20
- ## バグ修正
21
- * コードハイライト無効時に、htmlbuilderでlistnumおよびemlistnumにおいて行番号が表示されないバグを修正しました ([#449])
22
-
23
- ## ビルダーとメーカー
24
-
25
- ### epubmaker
26
- * 綴じ方向を設定する``direction``パラメータをサポートしました ([#435])
27
-
28
- ## コードコントリビュータ
29
- * [@snoozer05](https://github.com/snoozer05)
30
-
31
- [#399]: https://github.com/kmuto/review/pull/399
32
- [#435]: https://github.com/kmuto/review/pull/435
33
- [#449]: https://github.com/kmuto/review/issues/449
34
-
35
- # Version 1.6.0の主な変更点
36
-
37
- ## 全般
38
- * Ruby 1.8.7のサポートを終了しました
39
- * コードハイライトのデフォルト言語を設定できるようにしました ([#403])
40
- * 見出し参照の際のクォートもI18nを使うようにしました ([#420])
41
- * ``//source`` 記法でハイライトの設定と使用言語のオプションをサポートしました
42
- * 設定ファイルに ``toc`` を追加しました
43
-
44
- ## バグ修正
45
- * ``@<hd>`` で子要素を指定できないバグを修正しました ([#400])
46
- * プロジェクトのパスに空白スペースが含まれているときにEPUBが正しく生成されないバグを修正しました ([#398])
47
- * ``@<img>``などを付録で使ったときに``appendix_format:alpha``にしておいても``図1.1``のようになってしまうバグを修正しました ([#405])
48
- * ハイライト時にリスト名が表示されないバグを修正しました ([#418])
49
- * i18nの設定がうまくマージされないバグを修正しました ([#423])
50
- * EPUBの表紙画像が厳密にマッチされないバグを修正しました ([#417])
51
- * EPUBのバージョンが3のときに ``htmlversion`` が正しく設定されないバグを修正しました ([#433])
52
-
53
- ## コマンド
54
-
55
- ### review-init
56
- * locale.ymlを生成するオプションを追加しました ([#425])
57
-
58
- ## ビルダーとメーカー
59
-
60
- ### htmlbuilder
61
- * 章番号を ``span`` タグでマークアップしました ([#415])
62
-
63
- ### latexbuilder
64
- * ``config["conver"]`` をサポートしました
65
-
66
- ### pdfmaker
67
- * EPUBMakerと同様のファイルの挿入機能をサポートしました
68
-
69
- ### epubmaker
70
- * ``toc`` プロパティをconfig.ymlに追加しました ([#413])
71
-
72
- ## コードコントリビュータ
73
- * [@keiji](https://github.com/keiji)
74
- * [@orangain](https://github.com/orangain)
75
- * [@akinomurasame](https://github.com/akinomurasame)
76
- * [@krororo](https://github.com/krororo)
77
- * [@masarakki](https://github.com/masarakki)
78
-
79
- [#398]: https://github.com/kmuto/review/issues/398
80
- [#400]: https://github.com/kmuto/review/issues/400
81
- [#405]: https://github.com/kmuto/review/issues/405
82
- [#403]: https://github.com/kmuto/review/issues/403
83
- [#413]: https://github.com/kmuto/review/issues/413
84
- [#415]: https://github.com/kmuto/review/issues/415
85
- [#417]: https://github.com/kmuto/review/issues/417
86
- [#418]: https://github.com/kmuto/review/issues/418
87
- [#420]: https://github.com/kmuto/review/issues/420
88
- [#423]: https://github.com/kmuto/review/issues/423
89
- [#425]: https://github.com/kmuto/review/issues/425
90
- [#433]: https://github.com/kmuto/review/issues/433
91
-
92
- # Version 1.5.0の主な変更点
93
-
94
- ## 注意
95
- * 後述するリストハイライト時の言語指定のため、``//list``、``//emlist``等のリストブロック記法をreview-ext.rbで拡張している場合、既存のコードにエラーが出ることがあります。その場合、review-ext.rbを修正する必要があります(review-ext.rbを使っていない場合は影響はありません)。
96
-
97
- ## 全般
98
- * config.ymlに設定項目を追加しました。
99
- * ``@<hd>``で付録の表記を正しく参照できるようにしました。
100
- * 浅いレベルのコラムを参照できない問題を修正しました。
101
- * i18n.ymlの項目を追加しました。
102
- * ``ReVIEW::Book::Base.load_default``を廃止しました。
103
- * ``@<imgref>``記法を追加しました。
104
- * サンプルのRakefileにpdf/epub/cleanタスクを追加しました。
105
- * ドキュメントのフォーマットをRDocからMarkdownに変更しました。
106
- * 「Re:VIEW Quick Start Guide」を追加しました。
107
- * ``@<hd>``でidが一意なターゲットを指定するときに``|``を省略できるようにしました。
108
- * リストのハイライト表示のときに言語を指定できるようにしました。
109
- * 「Re:VIEW Format Guide」を追加しました。
110
- * ハイライトを使うときのconfig.ymlの設定名として``highlight``を追加しました。
111
-
112
- ## コマンド
113
- ### review-epubmaker
114
- * config.ymlの``toc``をサポートしました。
115
-
116
- ### review-init
117
- * ディレクトリが存在しているときでも実行できる``--force``オプションを追加しました。
118
-
119
- ### review-vol
120
- * ``--yaml``オプションを追加しました。
121
-
122
- ## Builders and Makers
123
- ### markdownbuilder
124
- * ``list_header()``と``list_body()``を追加しました。
125
-
126
- ### htmlbuilder
127
- * ``HTMLBuilder#texequation``のMathMLのエラーを修正しました。
128
-
129
- ### idgxmlbuilder
130
- * ``@<ttb>``の``index``タグを廃止しました。
131
-
132
- ### latexbuilder
133
- * ``@<table>``で他の章のテーブルを参照できるようにしました。
134
- * listings packageによるハイライトをサポートしました。
135
-
136
- ### pdfmaker
137
- * LaTeXツールがないときにエラーを出すようにしました。
138
- * config.ymlの``toctitle``をサポートしました。
139
- * すでにPDFファイルが存在しているときに削除するようにしました。
140
- * config.ymlの``dvicommand``と``dvioptions``をサポートしました。
141
- * config.ymlの``texoptions``をサポートしました。
142
- * ``sty/*.fd``や``sty/*.cls``を読み込むようにしました。
143
- * TeXの処理フックを追加しました。
144
- * LaTeXコマンドの失敗時に例外を上げて処理が止まるようにしました
145
- * 一部sedコマンドを利用していた部分を修正し依存しないようにしました。
146
-
147
- ### epubmaker
148
- * MathMLのサポートを改善しました。
149
- * ダミーの``<li>``要素を見せないようにしました。
150
- * config.ymlにツリー構造を導入しました。
151
- * 国際化のリソースとしてEPUBMaker::Resourceの代わりにReVIEW::I18nが使われるようになりました。
152
-
153
- ## コードコントリビュータ
154
- * akinomurasameさん
155
- * gfxさん
156
- * krororoさん
157
- * orangainさん
158
-
159
-
160
- # Version 1.4.0の主な変更点
161
- ## 全般
162
- * bib記法のIDを正規化しました。
163
- * POSTDEFファイルとcatalog.ymlのPOSTDEFセクションの挙動を合わせました。
164
- * catalog.ymlにAPPENDIXセクションを追加しました。
165
- * 暗黙的なprefaces, appendix, postscriptsの指定を削除しました。
166
- * コードとテストケースをリファクタリングしました。
167
- * README.rdocにInstallation, Resources, Linksの情報を追加しました。
168
-
169
- ## コマンド
170
- ### review-epubmaker
171
- * debugがtrueのときに、第一階層の一時ディレクトリを保持するようにしました。
172
- * cover_linearオプションをサポートしました。
173
-
174
- ### review-catalog-converter
175
- * 従来のカタログファイルをcatalog.ymlに変換するコマンドを追加しました。
176
-
177
- ## Builders and Makers
178
- ### markdownbuilder
179
- * GitHub Flavored Markdownとの互換性を向上させました。
180
- * Headlineの前後にブランクを挿入しました。
181
- * tt記法を追加しました。
182
- * footnote記法を追加しました。
183
- * indepimage記法を追加しました。
184
- * 表示されていなかった画像のキャプションを表示するようにしました。
185
-
186
- ### htmlbuilder
187
- * 画像ファイルが見つからないときに警告を出すようにしました。
188
- * レイアウトファイル名を'layout.erb'から'layout.html.erb'に変更しました。
189
- * emlist/emlistnum/cmdのキャプションをコンパイルするようにしました。
190
- * title記法をコンパイルするようにしました。
191
-
192
- ### idgxmlbuilder
193
- * 画像ファイルが見つからないときに警告を出すようにしました。
194
-
195
- ### latexbuilder
196
- * レイアウトファイル名を'review.tex.erb'から'layout.tex.erb'に変更しました。
197
- * 奥付用の項目として'contact'(連絡先)を追加しました。また、発行所と印刷所を両方併記するため、pblを「発行所」として追加し、prtを「印刷所」として両方を記述できるようにしました。
198
- ただし、互換性のためにデフォルトではprtは「発行所」になっているため、i18n.ymlで設定を行う必要があります。
199
-
200
-
201
- ### pdfmaker
202
- * ロケールファイルを使用できるようにしました。
203
- * colophon_orderオプションを追加しました。
204
-
205
- ### epubmaker
206
- * EPUB3のときのカバーファイルにepub:type='cover'属性を追加しました。
207
- * 見出し含まれるHTMLの特殊文字をエスケープしました。
208
-
209
- ## コードコントリビュータ
210
- * suzuki さん
211
- * vvakame さん
212
- * eiel さん
213
-
214
-
215
-
216
- # Version 1.3.0の主な変更点
217
-
218
- ## 全般
219
- * 従来のカタログファイルの代わりにcatalog.ymlを使用できるようにしました。
220
- * コラムを参照する`@<column>{}`を追加しました。
221
- * `@<chapref>{}`で部を参照できるようにしました。
222
- * セーフモード(環境変数`REVIEW_SAFE_MODE`の設定)を追加しました。
223
- * *.reのファイルは必ずカタログファイルと同じ階層に置くことにしました。
224
- * config.rbを使った設定を廃止しました。
225
- * 文書ディレクトリ内にあるlib/review/以下のファイルの読み込み機能を廃止しました。
226
- * 付録の見出し表記を指定する設定`appendix_format`(arabic, roman, alphaのいずれかを指定)を追加しました。
227
-
228
- ## コマンド
229
- * 同じバージョンのreview-compileを使用するようにしました。
230
- * バージョン情報を表示する`--version`オプションを追加しました。
231
-
232
- ### review-compile
233
- * カタログファイルを指定する`--catalogfile`オプションを追加しました。
234
-
235
- ### review-pdfmaker
236
- * ビルド用の一時ディレクトリを削除するようにしました。
237
- * 途中でエラーが発生した場合に動作を停止するようにしました。
238
- * 途中でエラーが発生しても停止せずに実行し続ける`--ignore-errors`オプションを追加しました。
239
- * ディレクトリの深い場所にある画像ファイルのebb/bbファイルを作成するようにしました。
240
- * `debug`オプションを上書きする`--[no-]debug`オプションを追加しました。
241
-
242
- ### review-init
243
- * 出力されるCSSのファイル名を統一しました。
244
-
245
- ### review-epubmaker
246
- * review-empumaker-ngから名称を変更しました。旧review-epubmakerはreview-epubmaker-legacyに名称を変更しました。
247
- * EPUBに同梱する画像の指定に関する`verify_target_images`と`force_include_images`オプションを追加しました。
248
-
249
- ## Builders
250
-
251
- ### htmlbuilder
252
- * 脚注から参照元の本文に戻れるようにしました。
253
- * HTMLコメント内でハイフンのエスケープをするようにしました。
254
- * id属性をHTML規格に合わせて正規化するようにしました。
255
- * layoutファイルからセクションタイトル一覧(`toc`)を参照できるようにしました。
256
- * layoutファイルから前後の章のリンク(`prev_chapter`, `next_chapter`)を参照できるようにしました。
257
-
258
- ### latexbuilder
259
- * コラムを目次に含めるようにしました。
260
- * graph記法で使用する画像の形式をPDFに変更しました。
261
-
262
- ## コードコントリビュータ
263
- * kazutomi さん
264
- * dmiyakawa さん
265
- * zunda さん
266
-
267
- # Version 1.2.0の主な変更点
268
-
269
- ## 全般
270
-
271
- * 名称が'ReVIEW'から'Re:VIEW'に変更になりました。
272
- * 画像ファイルが設定ではなくビルダ名などを元にディレクトリ内を探索するようになりました。
273
-
274
- ## コマンド
275
- ### review-epubmaker-ng / review-epubmaker
276
-
277
- * フォント埋め込みに対応しました。
278
- * EPUB3のMathMLに対応しました。
279
- * OPFファイル内のIDとして'rv-'というプレフィックスをつけるようになりました。
280
- * config.ymlでpht(Photographer / 撮影者) と csl(Consultant / 監修者)を指定できるようになりました。
281
- * 目次の各章・節見出し等について、元々の見出しにHTMLの装飾要素がついていた場合、目次ではそれらの要素を落とすようにしました(review-epubmaker)
282
-
283
- ### review-pdfmaker
284
-
285
- * config.ymlで"texcommand"を指定できるようになりました。これにより、platexではなくLuaLaTeX等も指定できるようになりました。
286
-
287
- ### review-init
288
-
289
- * gemでインストールした場合に動作しないバグを修正しました。
290
-
291
- ## Builders
292
-
293
- ### HTMLBuilder
294
-
295
- * pygmentsによるhiglightingをconfig.ymlで"pygments: true"と指定した場合のみ有効になるようにしました。
296
- * EPUB3での脚注について、epub:type="noteref"とepub:type="footnote"が指定されるようになりました。
297
-
298
- ### LATEXBuilder
299
-
300
- * //bibpaper の直後で改行するようにしました。
301
-
302
- ### MARKDOWNBuilder
303
-
304
- * ``@<em>{}`` (``@<i>``と同様)と``@<strong>{}``(``@<b>``と同様)をサポートしました。
305
-
306
-
307
-
308
- # Version 1.1の変更点
309
-
310
- ## 全般
311
-
312
- * markdownbuilder追加
313
- * inaobuilder追加
314
- * jewelerからbundlerに変更
315
- * review-initコマンドを追加
316
- * プリプロセスでMIMEと半角カナを保持するよう修正
317
- * エスケープされるべきところでされないバグを修正(``[...]``内で「``]``」がエスケープできない等)
318
- * その他多数のバグ修正
319
-
320
- ## review-compile
321
-
322
- * --structuredxmlオプション追加(idgxml)
323
- * --toclevelオプション追加
324
- * --tabwidthオプション追加
325
- * --output-fileオプション追加
326
-
327
- ## review-epubmakerとreview-pdfmaker共通
328
-
329
- * PARTファイルの中に``foo.re``といったファイル名を書けるよう修正
330
- * 一時ファイルのファイル名を変更(文書名+"-pdf" or 文書名+"-epub")
331
-
332
- ## review-epubmaker
333
- * epubversion、htmlversion追加(EPUB3は実験的サポート)
334
- * YAMLファイルにcover_linearオプション追加
335
-
336
- ## review-pdfmaker
337
- * review.tex.erbファイル追加
338
- * HTMLbuilderのようにlayoutsファイルをサポート
339
-
340
- ## review-compile
341
-
342
- * ``//centering``記法追加
343
- * ``//olnum``記法追加
344
- * ``//comment``の引数を0..1に変更
345
- * ``//source``の引数を0..1に変更
346
-
347
- ## htmlbuilder
348
-
349
- * HTML5には``<tt>``がないので``<code>``に変更
350
- * ``@<bou>``を追加
351
- * pygmentsによるhighlightをサポート
352
- * ``<title>``内ではReVIEWのタグを無視するよう修正
353
-
354
- ## latexbuilder
355
- * ReVIEW専用マクロを追加(``\reviewindepimagecaption``, ``\reviewth``, ``\reviewem`` and ``\reviewstrong``)
356
- * ``\reviewbibref``、``\\reviewtableref``、``\reviewimageref``マクロに引数を追加してリンクになるよう修正
357
- * デフォルトのテンプレートに``\usepackage{amsmath}``を追加
358
- * ``//box``記法をサポート
359
- * ``@<ami>``記法をサポート
360
- * 見出しレベル5と6を追加(paragraph, subparagraph)
361
- * ダッシュのエスケープを追加
362
- * ``begin{alltt}..\end{alltt}``は``\reviewemlist``、``\reviewlist``、``\reviewcmd``の各専用マクロ内で指定するよう(自分で再定義できるよう)修正
data/doc/NEWS.md DELETED
@@ -1,366 +0,0 @@
1
- # Version 1.7.2
2
-
3
- ## Bug Fix
4
- * Fix latexbuilder to show caption in `//list` without highliting ([#465])
5
- * Fix markdownbuilder to use definition list ([#473])
6
-
7
- # Version 1.7.1
8
-
9
- ## Bug Fix
10
- * Fix latexbuilder to display caption twice in `//listnum` ([#465])
11
- * Fix review-init to generate non-valid EPUB3 file with epubcheck 4.0.1 ([#456])
12
-
13
- # Version 1.7.0
14
-
15
- ## In general
16
- * Set up Rubocop settings and refactor code with the settings
17
- * Change the internal encoding to UTF-8 altogether ([#399])
18
- * Add a Dockerfile
19
-
20
- ## Bug Fix
21
- * Fix htmlbuilder to display line numbers with listnum/emlistnum under a syntax highlighting environment ([#449])
22
-
23
- ## Builders and Makers
24
-
25
- ### epubmaker
26
- * Support ``direction`` parameter to set binding direction ([#435])
27
-
28
- ## Code contributors
29
- * [@snoozer05](https://github.com/snoozer05)
30
-
31
- [#399]: https://github.com/kmuto/review/pull/399
32
- [#435]: https://github.com/kmuto/review/pull/435
33
- [#449]: https://github.com/kmuto/review/issues/449
34
-
35
- # Version 1.6.0
36
-
37
- ## In general
38
- * Stop supporting Ruby 1.8.7
39
- * Enable to set default language for code highlighting ([#403])
40
- * Use I18n in inline ``@<hd>`` chap ([#420])
41
- * Support highlighting and lang option in ``//source``
42
-
43
- ## Bug Fix
44
- * Fix ``@<hd>`` to detect the target header-index in the middle of indexes ([#400])
45
- * Fix epubmaker to escape pathname includes whitespace ([#398])
46
- * Fix ``Builder#get_chap`` to return formatted appendix name correctly ([#405])
47
- * Fix missing listing name when using syntax highlighting ([#418])
48
- * Fix i18n to merge settings correctly ([#423])
49
- * Fix epubmaker to match coverimage strictly ([#417])
50
- * Fix htmlversion when epubversion == 3 ([#433])
51
-
52
- ## Commands
53
-
54
- ### review-init
55
- * Add option to create locale.yml ([#425])
56
-
57
- ## Builders and Makers
58
-
59
- ### htmlbuilder
60
- * Markup section number by span ([#415])
61
-
62
- ### latexbuilder
63
- * Support ``config["conver"]``
64
-
65
- ### pdfmaker
66
- * Support file insertion (same as EPUBMaker)
67
-
68
- ### epubmaker
69
- * Add ``toc`` property to config.yml ([#413])
70
-
71
- ## Code contributors
72
- * [@keiji](https://github.com/keiji)
73
- * [@orangain](https://github.com/orangain)
74
- * [@akinomurasame](https://github.com/akinomurasame)
75
- * [@krororo](https://github.com/krororo)
76
- * [@masarakki](https://github.com/masarakki)
77
-
78
- [#398]: https://github.com/kmuto/review/issues/398
79
- [#400]: https://github.com/kmuto/review/issues/400
80
- [#405]: https://github.com/kmuto/review/issues/405
81
- [#403]: https://github.com/kmuto/review/issues/403
82
- [#413]: https://github.com/kmuto/review/issues/413
83
- [#415]: https://github.com/kmuto/review/issues/415
84
- [#417]: https://github.com/kmuto/review/issues/417
85
- [#418]: https://github.com/kmuto/review/issues/418
86
- [#420]: https://github.com/kmuto/review/issues/420
87
- [#423]: https://github.com/kmuto/review/issues/423
88
- [#425]: https://github.com/kmuto/review/issues/425
89
- [#433]: https://github.com/kmuto/review/issues/433
90
-
91
-
92
- # version 1.5.0
93
- ## Notice
94
- To support language parameter for syntax highlighting, if you use review-ext.rb to extend code block markup such as ``//list`` and ``//emlist``, you should fix it (if you don't use review-ext.rb, you don't have to do anything).
95
-
96
- ## In general
97
- * Add default properties in config.yml
98
- * Fix appendix format with ``@<hd>``.
99
- * Fix index error in shallow column.
100
- * Add more items in i18n.yml.
101
- * Obsolete ``ReVIEW::Book::Base.load_default``.
102
- * Add ``@<imgref>`` notation.
103
- * Add pdf, epub and cleanup tasks to sample Rakefile.
104
- * Change all formats of documents from RDoc to Markdown.
105
- * Add "Re:VIEW Quick Start Guide (EN)".
106
- * Enable ``@<hd>`` to identify the target, has unique id, without ``|``.
107
- * Add an argument lang to list related notations when highlighting.
108
- * Add "Re:VIEW Format Guide (EN)".
109
- * Add ``highlight`` property in config.yml as setting of highlight.
110
-
111
- ## Commands
112
- ### review-epubmaker
113
- * Support ``toc`` in config.yml
114
-
115
- ### review-init
116
- * Add ``--force`` option to generate files even if directory is existed.
117
-
118
- ### review-vol
119
- * Add ``--yaml`` option.
120
-
121
- ## Builders and Makers
122
- ### markdownbuilder
123
- * Implement ``list_header()`` and ``list_body()``.
124
-
125
- ### htmlbuilder
126
- * Fix MathML error in ``HTMLBuilder#texequation``.
127
-
128
- ### idgxmlbuilder
129
- * Stop providing a index for ``@<ttb>``.
130
-
131
- ### latexbuilder
132
- * Fix ``@<table>`` to refer the table on another chapter.
133
- * Support syntax highlighting with listings.
134
-
135
- ### pdfmaker
136
- * Raise errors if no LaTeX tools are installed.
137
- * Support ``toctitle`` in config.yml.
138
- * Remove a PDF file if already exists.
139
- * Add parameters ``dvicommand`` and ``dvioptions`` in config.yml.
140
- * Add parameters ``texoptions`` in config.yml.
141
- * Load ``sty/*.fd`` and ``sty/*.cls``
142
- * Provide hooks before/after TeX compiling.
143
- * remove dependency on sed command
144
- * raise errors and stop building when LaTeX command failed
145
-
146
- ### epubmaker
147
- * Improve to support of MathML.
148
- * Make dummy ``<li>`` item hidden in nav file.
149
- * Introduce structured YAML tree for config.yml.
150
- * Use ``ReVIEW::I18n`` instead of ``EPUBMaker::Resource``
151
-
152
- ## Code contributors
153
- * akinomurasame
154
- * gfx
155
- * krororo
156
- * orangain
157
-
158
- # version 1.4.0
159
-
160
- ## In general
161
- * Normalize ID in bib notation.
162
- * Fix compatibility between POSTDEF file and POSTDEF section in catalog.yml.
163
- * Add APPENDIX section into catalog.yml.
164
- * Remove implicit settings of prefaces, appendix and postscripts.
165
- * Refactor code and test cases.
166
- * Add Installation, Resources and Links on README.rdoc
167
-
168
- ## Commands
169
-
170
- ### review-epubmaker
171
- * Keep 1st stage temporary directory when debug is true.
172
- * Support cover_linear option.
173
-
174
- ### review-catalog-converter
175
- * Add new command which converts traditional catalog files into catalog.yml.
176
-
177
- ## Builders and Makers
178
-
179
- ### markdownbuilder
180
- * Improve compatibility with GitHub Flavored Markdown.
181
- * Add blank line before/after headline.
182
- * Support tt notation.
183
- * Support footnote notation.
184
- * Add indepimate notation.
185
- * Display nondisplayed image caption.
186
-
187
- ### htmlbuilder
188
- * Provide warning message if image couldn't be found.
189
- * Change layout file name from 'layout.erb' to 'layout.html.erb'.
190
- * Compile caption of emlist/emlistnum/cmd notation.
191
- * Compile title notation.
192
-
193
- ### idgxmlbuilder
194
- * Provide warning message if image couldn't be found.
195
-
196
- ### latexbuilder
197
- * Change layout file name from 'review.tex.erb' to 'layout.tex.erb'.
198
- * add 'contact' for colophon in config.yml.
199
- * add 'pbl'(publisher) for colohpon in config.yml. You can use both 'prt' and 'pbl'.
200
-
201
- ### pdfmaker
202
- * Support locale file.
203
- * Add colophon_order option.
204
-
205
- ### epubmaker
206
- * Add epub:type='cover' attribute in cover file when it is EPUB3.
207
- * Escape special HTML characters to entities in toc view.
208
-
209
- ## Code contributors
210
- * suzuki
211
- * vvakame
212
- * eiel
213
-
214
-
215
-
216
- # version 1.3.0
217
-
218
- ## In general
219
- * Introduce a new catalog file `catalog.yml`.
220
- * Support `@<column>{}` to refer to the column.
221
- * Enable `@<chapref>{}` to refert to the part.
222
- * Add safe mode as an environment variable 'REVIEW_SAFE_MODE'.
223
- * Force *.re files to put on the same directory of the catalog files.
224
- * Discontinue feature of setting with config.rb.
225
- * Discontinue feature of loading lib/review/* files in the document directory.
226
- * Introduce config `appendix_format` (arabic, roman, or alpha) to set an appendix heading style.
227
-
228
- ## Commands
229
- * Force to use review-compile with the same version.
230
- * Add `--version` to display the version.
231
-
232
- ### review-compile
233
- * Add `--catalogfile` to set a catalog file.
234
-
235
- ### review-pdfmaker
236
- * Remove tmpdir for build.
237
- * Exit when any errors occur.
238
- * Add `--ignore-errors` to proceed even when any errors occur.
239
- * Generate ebb/bb files of image files in the image directory.
240
- * Add `--[no-]debug` to override `debug` in the config.yml.
241
-
242
- ### review-init
243
- * Generate consistent CSS filenames.
244
-
245
- ### review-epubmaker
246
- * Rename review-empumaker to review-empumaker-legacy, then rename review-empumaker-ng to review-empumaker.
247
- * Add `verify_target_images` and `force_include_images` configs which are related to including images in the EPUB file.
248
-
249
- ## Builders
250
- ### htmlbuilder
251
- * Add a reverse link from the footnote to the body.
252
- * Escape hyphens in the HTML comment tags.
253
- * Normalize 'id' attributes.
254
- * Enable to refer to the section titles from a layout file (`toc`).
255
- * Enable to refer to the prev/next section from a layout file (`prev_chapter`, `next_chapter`).
256
-
257
- ### latexbuilder
258
- * Add columns in the TOC.
259
- * Change a image file extension as PDF in the graph notation.
260
-
261
- ## Code contributors
262
- * kazutomi
263
- * dmiyakawa
264
- * zunda
265
-
266
-
267
-
268
- # version 1.2.0
269
-
270
- ## In general
271
-
272
- * 'ReVIEW' has been renamed to 'Re:VIEW'
273
- * Improve the image file finder.
274
-
275
- ## Commands
276
-
277
- ### review-epubmaker-ng / review-epubmaker
278
-
279
- * Support font embedding
280
- * Support MathML in EPUB3
281
- * Add prefix 'rv-' to ID
282
- * Add pht(Photographer / 撮影者) and csl(Consultant / 監修者)
283
- * Strip HTML element in chapter items of TOC (review-epubmaker)
284
-
285
- ### review-pdfmaker
286
-
287
- * Add "texcommand" in config.yml to support LuaLaTeX or other latex command
288
-
289
- ### review-init
290
-
291
- * Fix error installed by gem
292
-
293
- ## Builders
294
-
295
- ### HTMLBuilder
296
-
297
- * Use pygments higlighting only if "pygments: true" is defined.
298
- * Support epub:type="noteref" and epub:type="footnote" in EPUB3
299
-
300
- ### LATEXBuilder
301
-
302
- * Add newline after //bibpaper
303
-
304
- ### MARKDOWNBuilder
305
-
306
- * Support ``@<em>{}`` (same as ``@<i>``) and ``@<strong>{}`` (same as ``@<b>``)
307
-
308
-
309
-
310
- # version 1.1
311
-
312
- ## in general
313
-
314
- * add markdownbuilder
315
- * add inaobuilder
316
- * use bundler instead of jeweler
317
- * add review-init command
318
- * preserve MIME and JIS X 0201 kana during a preprocess
319
- * fix many escape bugs (enable escape ``\[`` in ``[...]``, etc.)
320
- * many other bugfixs
321
-
322
- ## review-compile
323
-
324
- * add --structuredxml option(idgxml)
325
- * add --toclevel option
326
- * add --tabwidth option
327
- * add --output-file option
328
-
329
- ## review-epubmaker and review-pdfmaker
330
-
331
- * support ``foo.re`` filename in PART file
332
- * rename tempolary dir name (bookname + "-pdf" and bookname + "-epub")
333
-
334
- ## review-epubmaker
335
-
336
- * support epubversion and htmlversion option in YAML configuration file (EPUB3 support is experimental)
337
- * support cover_linear option in YAML file
338
-
339
- ## review-pdfmaker
340
-
341
- * separate tex template file from source code (see review.tex.erb)
342
- * support layouts like HTMLbuilder
343
-
344
- ## review-compile
345
-
346
- * add command ``//centering``
347
- * add command ``//olnum``
348
- * change # of arguments of ``//comment`` (1 -> 0..1)
349
- * change # of arguments of ``//source`` (1 -> 0..1)
350
-
351
- ## htmlbuilder
352
- * use ``<code>`` instead of ``<tt>`` in HTML5
353
- * support ``@<bou>`` (you should use CSS3)
354
- * support highlight with pygments
355
- * strip ReVIEW tag in ``<title>``
356
-
357
- ## latexbuilder
358
- * add some macro for ReVIEW(``\reviewindepimagecaption``, ``\reviewth``, ``\reviewem`` and ``\reviewstrong``).
359
- * add argument of macro ``\reviewbibref``, ``\\reviewtableref`` and ``\reviewimageref`` to make link
360
- * add ``\usepackage{amsmath}`` in default template.
361
- * support ``//box``
362
- * support ``@<ami>``
363
- * add headline level 5 and 6 (paragraph, subparagraph)
364
- * escape all dash
365
- * add ``begin{alltt}..\end{alltt}`` into ``\reviewemlist``, ``\reviewlist`` and ``\reviewcmd``
366
-