review-peg 0.1.0

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