review 3.0.0.preview4 → 3.0.0.rc1

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 (91) hide show
  1. checksums.yaml +4 -4
  2. data/NEWS.ja.md +61 -4
  3. data/NEWS.md +61 -4
  4. data/README.md +2 -1
  5. data/doc/config.yml.sample +48 -20
  6. data/doc/config.yml.sample-simple +7 -6
  7. data/doc/format_idg.ja.md +6 -2
  8. data/doc/pdfmaker.ja.md +95 -4
  9. data/doc/pdfmaker.md +79 -0
  10. data/doc/quickstart.ja.md +26 -3
  11. data/doc/quickstart.md +25 -3
  12. data/doc/writing_vertical.ja.md +19 -2
  13. data/lib/review/epubmaker.rb +27 -27
  14. data/lib/review/i18n.yml +1 -0
  15. data/lib/review/init.rb +34 -22
  16. data/lib/review/latexbuilder.rb +95 -18
  17. data/lib/review/pdfmaker.rb +1 -0
  18. data/lib/review/update.rb +60 -25
  19. data/lib/review/version.rb +1 -1
  20. data/review.gemspec +1 -1
  21. data/samples/sample-book/src/config.yml +3 -3
  22. data/samples/syntax-book/config.yml +3 -3
  23. data/templates/latex/config.erb +3 -0
  24. data/templates/latex/review-jlreq/README.md +97 -7
  25. data/templates/latex/review-jlreq/review-base.sty +8 -0
  26. data/templates/latex/review-jlreq/review-jlreq.cls +28 -6
  27. data/templates/latex/review-jsbook/README.md +18 -20
  28. data/templates/latex/review-jsbook/review-base.sty +15 -0
  29. data/templates/latex/review-jsbook/review-jsbook.cls +172 -230
  30. data/test/test_epubmaker_cmd.rb +1 -1
  31. data/test/test_helper.rb +3 -3
  32. data/test/test_image_finder.rb +9 -9
  33. data/test/test_latexbuilder.rb +20 -1
  34. data/test/test_makerhelper.rb +12 -12
  35. data/test/test_pdfmaker_cmd.rb +1 -1
  36. data/test/test_update.rb +18 -4
  37. data/test/test_zip_exporter.rb +7 -7
  38. data/vendor/jsclasses/.gitignore +163 -0
  39. data/vendor/jsclasses/LICENSE +25 -0
  40. data/vendor/jsclasses/Makefile +88 -0
  41. data/vendor/jsclasses/README.md +43 -0
  42. data/vendor/jsclasses/create_archive.sh +59 -0
  43. data/vendor/jsclasses/jis/Makefile +62 -0
  44. data/vendor/jsclasses/jis/jsarticle.cls +1935 -0
  45. data/vendor/jsclasses/jis/jsbook.cls +2026 -0
  46. data/vendor/jsclasses/jis/jsclasses.dtx +5961 -0
  47. data/vendor/jsclasses/jis/jsclasses.ins +8 -0
  48. data/vendor/jsclasses/jis/jslogo.dtx +413 -0
  49. data/vendor/jsclasses/jis/jslogo.ins +4 -0
  50. data/vendor/jsclasses/jis/jslogo.sty +223 -0
  51. data/vendor/jsclasses/jis/jspf.cls +1766 -0
  52. data/vendor/jsclasses/jis/jsreport.cls +2020 -0
  53. data/vendor/jsclasses/jis/jsverb.dtx +322 -0
  54. data/vendor/jsclasses/jis/jsverb.ins +4 -0
  55. data/vendor/jsclasses/jis/jsverb.sty +128 -0
  56. data/vendor/jsclasses/jis/kiyou.cls +1882 -0
  57. data/vendor/jsclasses/jis/minijs.sty +52 -0
  58. data/vendor/jsclasses/jis/okumacro.dtx +1179 -0
  59. data/vendor/jsclasses/jis/okumacro.ins +4 -0
  60. data/vendor/jsclasses/jis/okumacro.sty +455 -0
  61. data/vendor/jsclasses/jis/okuverb.dtx +243 -0
  62. data/vendor/jsclasses/jis/okuverb.ins +4 -0
  63. data/vendor/jsclasses/jis/okuverb.sty +102 -0
  64. data/vendor/jsclasses/jis/winjis.sty +87 -0
  65. data/vendor/jsclasses/jsarticle.cls +1938 -0
  66. data/vendor/jsclasses/jsbook.cls +2029 -0
  67. data/vendor/jsclasses/jsclasses.dtx +5966 -0
  68. data/vendor/jsclasses/jsclasses.ins +8 -0
  69. data/vendor/jsclasses/jsclasses.pdf +0 -0
  70. data/vendor/jsclasses/jslogo.dtx +424 -0
  71. data/vendor/jsclasses/jslogo.ins +4 -0
  72. data/vendor/jsclasses/jslogo.pdf +0 -0
  73. data/vendor/jsclasses/jslogo.sty +223 -0
  74. data/vendor/jsclasses/jspf.cls +1769 -0
  75. data/vendor/jsclasses/jsreport.cls +2023 -0
  76. data/vendor/jsclasses/jsverb.dtx +333 -0
  77. data/vendor/jsclasses/jsverb.ins +4 -0
  78. data/vendor/jsclasses/jsverb.pdf +0 -0
  79. data/vendor/jsclasses/jsverb.sty +128 -0
  80. data/vendor/jsclasses/kiyou.cls +1885 -0
  81. data/vendor/jsclasses/minijs.sty +52 -0
  82. data/vendor/jsclasses/okumacro.dtx +1184 -0
  83. data/vendor/jsclasses/okumacro.ins +4 -0
  84. data/vendor/jsclasses/okumacro.pdf +0 -0
  85. data/vendor/jsclasses/okumacro.sty +458 -0
  86. data/vendor/jsclasses/okuverb.dtx +254 -0
  87. data/vendor/jsclasses/okuverb.ins +4 -0
  88. data/vendor/jsclasses/okuverb.pdf +0 -0
  89. data/vendor/jsclasses/okuverb.sty +102 -0
  90. data/vendor/jsclasses/winjis.sty +87 -0
  91. metadata +55 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a903b095f340bf40a4e98b60b691541b9ce7ba19a178db25b88463d9125144ca
4
- data.tar.gz: 18f15f4b01e4deb47acbc22538e7d894d84338215f207da3efc22f21621d4ca8
3
+ metadata.gz: 792d5855801da09c439c877981ba7105633189c70527b5a2c26709ab6383ea84
4
+ data.tar.gz: e615658f6848efabd7802189744f84888717fc83f5a1113ec38e15e7c075487e
5
5
  SHA512:
6
- metadata.gz: 71f9400d75229765b867201152a2bcb7a48d9ce208da28f83adcac2f5f322a37ee0f3efa338b0a012e377c84d75d5c2afc6e9d25ad04306b0a27da7cbea0d75d
7
- data.tar.gz: e3e8e3ef0d54aadff4c02206791e2f1c2477c05ec857a7b8ef5cac53d5922a9da99786fa5daf1a00ab7afbdb1a0c5d62ccec0622ffab92201655ad8ffd51c650
6
+ metadata.gz: 1136c1217fb03c8dfb42c8320946832ebc4a25c20769b0d46e1d2e32e98144ca702f20785e343a5b20a8572184543438cb348d571e2033eeaf3bbd2635785f9e
7
+ data.tar.gz: a8ac7a9b84bbc9b90f18533351dd71a1a36a24bdcdf5deb78fd38eff9550e99d8284ec33f9c574b1b75f3045089257b010e507bb450205f61f0b5966336411bb
data/NEWS.ja.md CHANGED
@@ -1,3 +1,64 @@
1
+ # Version 3.0.0 release candidate
2
+ ## 非互換の変更
3
+ * PDFMaker: review-jsbook の見出しの文字サイズを、オリジナルの jsbook に準拠しました ([#1152])
4
+ * PDFMaker: review-jsbook において、3.0.0 preview 4 までの Q,W,L,H で指定する方法をやめ、fontsize などの単位付きパラメータを使うようにしました。3.0.0 preview 3 〜 3.0.0 preview 4 で作成したプロジェクトに対しては、review-update コマンドで新しいパラメータに移行できます ([#1151],[#1201])
5
+
6
+ ## バグ修正
7
+ * PDFMaker: review-jsbook クラスファイルで hiddenfolio パラメータと tombopaper パラメータを同時に使用すると hiddenfolio パラメータが無視される問題を修正しました ([#1158])
8
+ * PDFMaker: review-jsbook クラスファイルで paperwidth, paperheight パラメータが効かない問題を修正しました ([#1171])
9
+ * review-update で sty フォルダの更新が無視されることがあるのを修正しました ([#1183])
10
+
11
+ ## 機能強化
12
+ * PDFMaker: review-jsbook において、fontsize パラメータで標準の文字サイズ、baselineskip パラメータで標準の行の高さを pt や Q、mm などの単位付きで指定できるようにしました ([#1151])
13
+ * PDFMaker: 何らかの事情でオリジナルの jsbook.cls クラスファイルを使い続けたいユーザー向けに、review-jsbook セットのスタイルファイルを流用可能にしました ([#1177])
14
+ * PDFMaker: ユーザーが任意のスタイルや `//embed` 命令で利用できるよう、review-jsbook および review-jlreq に空ページを作成する `\oneblankpage`、必要に応じて改ページすることで次のページが必ず偶数ページになるようにする `\clearoddpage` のマクロを追加しました ([#1175],[#1182])
15
+ * PDFMaker: review-jsbook および review-jlreq クラスファイルのドキュメントオプションパラメータに、生成 PDF の種類を指定する `media` を追加しました。3.0.0 preview3 で導入した `cameraready` パラメータと同じ意味です(どちらを使ってもかまいません)([#1181])
16
+ * PDFMaker: 部の中で節などの下位見出しを利用できるようになりました ([#1195])
17
+ * PDFMaker: 部があるときには `\reviewusepart` というマクロを定義するようにしました ([#1199])
18
+ * review-init が生成する config.yml ファイルで、`texdocumentclass` パラメータをコメントアウトされた状態ではなく明示指定するようにしました ([#1202])
19
+ * PDFMaker: `//tsize` 命令で幅が明示指定されている場合には、表中の改行(`@<br>`)を `\newline` マクロで表現するようにしました ([#1206])
20
+ * PDFMaker: TeX における表の列幅の表現として、`L{幅}`(左寄せ・均等配置なし), `C{幅}`(中央寄せ), `R{幅}`(右寄せ) を利用できるようにしました ([#1208])
21
+ * PDFMaker: バージョン間の実装差異を避けるため、スナップショットの jsbook.cls (2018/06/23) および gentombow.sty (2018/08/30 v0.9j) を sty フォルダにコピーしてそれを利用するようにしました ([#1210])
22
+
23
+ ## バグ修正
24
+ * PDFMaker: review-jlreq クラスファイルで serial_pagination および startpage が動作していなかったのを修正しました ([#1204])
25
+
26
+ ## ドキュメント
27
+ * IDGXML のドキュメント format_idg.ja.md を更新しました ([#1188])
28
+ * クイックスタートガイド quickstart.ja.md に review-update について説明を追加しました ([#1189])
29
+ * サンプル設定ファイル config.yml.sample のコメント類を更新しました ([#1190])
30
+ * PDFMaker のドキュメント pdfmaker.ja.md を更新しました ([#1191])
31
+ * 縦書きについてのドキュメント writing_vertical.ja.md を更新しました ([#1198])
32
+ * review-jsbook のドキュメントを更新しました ([#1203])
33
+ * review-jlreq のドキュメントを更新しました ([#1204])
34
+
35
+ ## コントリビューターのみなさん
36
+ * [@munepi](https://github.com/munepi)
37
+
38
+ [#1151]: https://github.com/kmuto/review/issues/1151
39
+ [#1152]: https://github.com/kmuto/review/issues/1152
40
+ [#1158]: https://github.com/kmuto/review/issues/1158
41
+ [#1171]: https://github.com/kmuto/review/issues/1171
42
+ [#1175]: https://github.com/kmuto/review/pull/1175
43
+ [#1177]: https://github.com/kmuto/review/pull/1177
44
+ [#1181]: https://github.com/kmuto/review/issues/1181
45
+ [#1182]: https://github.com/kmuto/review/pull/1182
46
+ [#1183]: https://github.com/kmuto/review/issues/1183
47
+ [#1188]: https://github.com/kmuto/review/pull/1188
48
+ [#1189]: https://github.com/kmuto/review/pull/1189
49
+ [#1190]: https://github.com/kmuto/review/pull/1190
50
+ [#1191]: https://github.com/kmuto/review/pull/1191
51
+ [#1195]: https://github.com/kmuto/review/issues/1195
52
+ [#1198]: https://github.com/kmuto/review/pull/1198
53
+ [#1199]: https://github.com/kmuto/review/pull/1199
54
+ [#1201]: https://github.com/kmuto/review/pull/1201
55
+ [#1202]: https://github.com/kmuto/review/pull/1202
56
+ [#1203]: https://github.com/kmuto/review/pull/1203
57
+ [#1204]: https://github.com/kmuto/review/pull/1204
58
+ [#1206]: https://github.com/kmuto/review/issues/1206
59
+ [#1208]: https://github.com/kmuto/review/pull/1208
60
+ [#1210]: https://github.com/kmuto/review/issues/1210
61
+
1
62
  # Version 3.0.0 preview 4
2
63
  ## 新機能
3
64
  * 旧バージョンのプロジェクトを新しいバージョンに合わせたものに更新する `review-update` コマンドを導入しました ([#1144])
@@ -13,10 +74,6 @@
13
74
  * PDFMaker: review-jlreq.cls クラスファイルでも hiddenfolio パラメータを利用できるようにしました ([#1147])
14
75
  * EPUBMaker/WEBMaker: imgmath 機能を有効にしたときに、各 `//texequation` に対してフォントサイズを明示して渡すようにしました ([#1146])
15
76
 
16
- ## ドキュメント
17
-
18
- ## コントリビューターのみなさん
19
-
20
77
  [#1144]: https://github.com/kmuto/review/issues/1144
21
78
  [#1146]: https://github.com/kmuto/review/issues/1146
22
79
  [#1147]: https://github.com/kmuto/review/issues/1147
data/NEWS.md CHANGED
@@ -1,3 +1,64 @@
1
+ # Version 3.0.0 release candidate
2
+ ## Breaking Changes
3
+ * PDFMaker: heading character size of review-jsbook becomes the same as the original jsbook ([#1152])
4
+ * PDFMaker: Q, W, L, H parameters of review-jsbook are withdrawn. Projects created in the past preview version can be updated with the review-update command ([#1151],[#1201])
5
+
6
+ ## Bug Fixes
7
+ * PDFMaker: fixes an issue that hiddenfolio parameter was ignored when using both hiddenfolio and tombopaper in review-jsbook ([#1158])
8
+ * PDFMaker: fixes a problem that the paperwidth and paperheight parameters of review-jsbook didn't work ([#1171])
9
+ * fixes an issue that review-update ignored update of sty folder ([#1183])
10
+
11
+ ## Enhancements
12
+ * PDFMaker: in review-jsbook, you can specify the font size with `fontsize` parameter and the line height with `baselineskip` parameter with units such as pt and mm ([#1151])
13
+ * PDFMaker: users who want to continue using the original jsbook.cls class file for some reason can use sty files of review-jsbook set ([#1177])
14
+ * PDFMaker: add useful macros to review-jsbook and review-jlreq for users. `\oneblankpage` creates an empty page. `\clearoddpage` breaks page as necessary so that the next page is always an even page ([#1175],[#1182])
15
+ * PDFMaker: add `media` parameter that specifies the type of PDF to review-jsbook and review-jlreq. This has the same meaning as `cameraready` ([#1181])
16
+ * PDFMaker: sections are now allowed in part ([#1195])
17
+ * PDFMaker: `\reviewusepart` macro is defined when theare is a part ([#1199])
18
+ * `texdocumentclass` parameter is explicit (not a comment) when creating config.yml by review-init ([#1202])
19
+ * PDFMaker: line feed (`@<br>`) in the table is now represented by `\newline` macro when the width is explicity specified with `//tsize` ([#1206])
20
+ * PDFMaker: enable to use `L{width}` (left justified), `C{width}` (centering), `R{width}` (right justified) as representation of the table column width ([#1208])
21
+ * PDFMaker: to avoid implementation differences between versions, the snapshots jsbook.cls (2018/06/23) and gentombow.sty (2018/08/30 v0.9j) are copied to the `sty` folder ([#1210])
22
+
23
+ ## Bug Fixes
24
+ * PDFMaker: fix serial_pagination and startpage were not working in review-jlreq class ([#1204])
25
+
26
+ ## Docs
27
+ * update `format_idg.ja.md` ([#1188])
28
+ * add note about review-update command to quickstart guide `quickstart.ja.md` ([#1189])
29
+ * update comments of `config.yml.sample` ([#1190])
30
+ * update `pdfmaker.ja.md` ([#1191])
31
+ * update `writing_vertical.ja.md` ([#1198])
32
+ * update document of review-jsbook ([#1203])
33
+ * update document of review-jlreq ([#1204])
34
+
35
+ ## Contributors
36
+ * [@munepi](https://github.com/munepi)
37
+
38
+ [#1151]: https://github.com/kmuto/review/issues/1151
39
+ [#1152]: https://github.com/kmuto/review/issues/1152
40
+ [#1158]: https://github.com/kmuto/review/issues/1158
41
+ [#1171]: https://github.com/kmuto/review/issues/1171
42
+ [#1175]: https://github.com/kmuto/review/pull/1175
43
+ [#1177]: https://github.com/kmuto/review/pull/1177
44
+ [#1181]: https://github.com/kmuto/review/issues/1181
45
+ [#1182]: https://github.com/kmuto/review/pull/1182
46
+ [#1183]: https://github.com/kmuto/review/issues/1183
47
+ [#1188]: https://github.com/kmuto/review/pull/1188
48
+ [#1189]: https://github.com/kmuto/review/pull/1189
49
+ [#1190]: https://github.com/kmuto/review/pull/1190
50
+ [#1191]: https://github.com/kmuto/review/pull/1191
51
+ [#1195]: https://github.com/kmuto/review/issues/1195
52
+ [#1198]: https://github.com/kmuto/review/pull/1198
53
+ [#1199]: https://github.com/kmuto/review/pull/1199
54
+ [#1201]: https://github.com/kmuto/review/pull/1201
55
+ [#1202]: https://github.com/kmuto/review/pull/1202
56
+ [#1203]: https://github.com/kmuto/review/pull/1203
57
+ [#1204]: https://github.com/kmuto/review/pull/1204
58
+ [#1206]: https://github.com/kmuto/review/issues/1206
59
+ [#1208]: https://github.com/kmuto/review/pull/1208
60
+ [#1210]: https://github.com/kmuto/review/issues/1210
61
+
1
62
  # Version 3.0.0 preview 4
2
63
  ## New Features
3
64
  * new command `review-update` is added, which updates the setting of the project files to the new version ([#1144])
@@ -13,10 +74,6 @@
13
74
  * PDFMaker: support hiddenfolio parameter with review-jlreq.cls ([#1147])
14
75
  * EPUBMaker/WEBMaker: when imgmath function is enabled, font size is passed to each `//texequation` ([#1146])
15
76
 
16
- ## Docs
17
-
18
- ## Contributors
19
-
20
77
  [#1144]: https://github.com/kmuto/review/issues/1144
21
78
  [#1146]: https://github.com/kmuto/review/issues/1146
22
79
  [#1147]: https://github.com/kmuto/review/issues/1147
data/README.md CHANGED
@@ -101,7 +101,8 @@ Exception:
101
101
  * doc/*, samples/*: MIT License. See [LICENSE](https://github.com/kmuto/review/blob/master/doc/LICENSE) file.
102
102
  * jumoline.sty, vendor/jumoline: The LaTeX Project Public License. See [LPPL](https://github.com/kmuto/review/blob/master/vendor/jumoline/lppl.txt) file.
103
103
  * plistings.sty, vendor/plistings: MIT License. See [LICENSE](https://github.com/kmuto/review/blob/master/vendor/plistings/LICENSE) file.
104
- * gentombow09j.sty, vendor/gentombow: BSD License. See [LICENSE](https://github.com/kmuto/review/blob/master/vendor/gentombow/LICENSE) file.
104
+ * gentombow.sty, vendor/gentombow: BSD License. See [LICENSE](https://github.com/kmuto/review/blob/master/vendor/gentombow/LICENSE) file.
105
+ - jsbook.sty, vendor/jsclasses: BSD License. See [LICENSE](https://github.com/kmuto/review/blob/master/vendor/jsclasses/LICENSE) file.
105
106
 
106
107
  ## Copyright
107
108
 
@@ -65,14 +65,14 @@ aut: ["青木峰郎", "武藤健志", "高橋征義", "角征典"]
65
65
  # a-trl, trl: 翻訳者
66
66
 
67
67
  # 刊行日(省略した場合は実行時の日付)
68
- # date: 2016-04-20
68
+ # date: 2018-11-11
69
69
  # 発行年月。YYYY-MM-DD形式による配列指定。省略した場合はdateを使用する
70
70
  # 複数指定する場合は次のように記述する
71
71
  # [["初版第1刷の日付", "初版第2刷の日付"], ["第2版第1刷の日付"]]
72
72
  # 日付の後ろを空白文字で区切り、任意の文字列を置くことも可能。
73
- # history: [["2016-04-20 v1.0.0版発行"]]
73
+ # history: [["2016-04-20 v1.0.0版発行", "2018-11-11 v3.0.0版発行"]]
74
74
  # 権利表記(配列で複数指定可)
75
- # rights: (C) 2016 Re:VIEW Developers
75
+ # rights: (C) 2016-2018 Re:VIEW Developers
76
76
  # description: 説明
77
77
  # subject: 短い説明用タグ(配列で複数指定可)
78
78
  # type: 書籍のカテゴリーなど(配列で複数指定可)
@@ -97,10 +97,10 @@ debug: null
97
97
  stylesheet: ["sample.css"]
98
98
 
99
99
  # ePUBのバージョン (2か3)
100
- # epubversion: 2
100
+ # epubversion: 3
101
101
  #
102
102
  # HTMLのバージョン (4か5。epubversionを3にしたときには5にする)
103
- # htmlversion: 4
103
+ # htmlversion: 5
104
104
 
105
105
  # 目次として抽出する見出しレベル
106
106
  toclevel: 3
@@ -110,16 +110,6 @@ toclevel: 3
110
110
  # 本文でセクション番号を表示する見出しレベル
111
111
  secnolevel: 2
112
112
 
113
- # 以下のsecnolevelはまだ未実装。
114
- # 前付でセクション番号を表示する見出しレベル(未実装)
115
- # pre_secnolevel: 0
116
- #
117
- # 後付(付録)でセクション番号を表示する見出しレベル(未実装)
118
- # post_secnolevel: 1
119
- #
120
- # 部番号を表示する見出しレベル(未実装)
121
- # part_secnolevel: 1
122
-
123
113
  # 本文中に目次ページを作成するか。省略した場合はnull (作成しない)
124
114
  # toc: true
125
115
 
@@ -186,14 +176,51 @@ secnolevel: 2
186
176
  # @<w>命令で使用する単語ファイルのパス
187
177
  # words_file: words.csv
188
178
 
189
- # 1ページの行数文字数と1kbごとのページ数を用紙サイズで指定する(A5 or B5)。
179
+ # review-vol向けのヒント情報
180
+ # 1ページの行数文字数と1kbごとのページ数を用紙サイズで指定する(A5 or B5)
190
181
  # page_metric: A5
191
182
  #
192
183
  # あるいは、配列で指定することもできる
193
- # 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数、1kバイト毎のページ数
184
+ # 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数、1kバイトごとのページ数
194
185
  # page_metric: [40,80,40,80,2]
195
186
 
196
- # ページ送りの送り方向、page-progression-directionの値("ltr"|"rtl"|"default")
187
+ # EPUBおよびWeb生成における数式の画像化指定
188
+ # TeXの数式を画像化するか。省略した場合はnull (作成しない)
189
+ # imgmath: true
190
+
191
+ # imgmathがtrueの場合の設定
192
+ # 以下のパラメータを有効にするときには、
193
+ # imgmath_options:
194
+ # パラメータ: 値
195
+ # パラメータ: 値
196
+ # ...
197
+ # という構成にする必要がある(インデントさせる)
198
+ # imgmath_options:
199
+ # 使用する画像拡張子。通常は「png」か「svg」(svgの場合は、pdfcrop_pixelize_cmdの-pngも-svgにする)
200
+ # format: png
201
+ # 変換手法。pdfcrop または dvipng
202
+ # converter: pdfcrop
203
+ # プリアンブルの内容を上書きするファイルを指定する(デフォルトはupLaTeX+jsarticle.clsを前提とした、lib/review/makerhelper.rbのdefault_imgmath_preambleメソッドの内容)
204
+ # preamble_file: null
205
+ # 基準のフォントサイズ
206
+ # fontsize: 10
207
+ # 基準の行間
208
+ # lineheight: 12
209
+ # converterにpdfcropを指定したときのpdfcropコマンドのコマンドライン。プレースホルダは
210
+ # %i: 入力ファイル、%o: 出力ファイル
211
+ # pdfcrop_cmd: "pdfcrop --hires %i %o"
212
+ # PDFから画像化するコマンドのコマンドライン。プレースホルダは
213
+ # %i: 入力ファイル、%o: 出力ファイル、%O: 出力ファイルから拡張子を除いたもの
214
+ # %p: 対象ページ番号
215
+ # pdfcrop_pixelize_cmd: "pdftocairo -png -r 90 -f %p -l %p -singlefile %i %O"
216
+ # pdfcrop_pixelize_cmdが複数ページの処理に対応していない場合に単ページ化するか
217
+ # extract_singlepage: null
218
+ # extract_singlepageがtrueの場合に単ページ化するコマンドのコマンドライン
219
+ # pdfextract_cmd: "pdfjam -q --outfile %o %i %p"
220
+ # converterにdvipngを指定したときのdvipngコマンドのコマンドライン
221
+ # dvipng_cmd: "dvipng -T tight -z 9 -p %p -l %p -o %o %i"
222
+
223
+ # EPUBにおけるページ送りの送り方向、page-progression-directionの値("ltr"|"rtl"|"default")
197
224
  # direction: "ltr"
198
225
 
199
226
  # EPUBのOPFへの固有の追加ルール
@@ -285,8 +312,9 @@ epubmaker:
285
312
  # texstyle: ["reviewmacro"]
286
313
  #
287
314
  # LaTeX用のdocumentclassを指定する
288
- # review-jsbook.clsのオプションについてはsty/README.mdを参照
289
- # texdocumentclass: ["review-jsbook", "cameraready=print,paper=a5"]
315
+ # オプションについてはsty/README.mdを参照
316
+ # デフォルトは印刷用。電子配布版を作るには media=ebook とする
317
+ # texdocumentclass: ["review-jsbook", "media=print,paper=a5"]
290
318
  #
291
319
  # LaTeX用のコマンドを指定する
292
320
  # texcommand: "uplatex"
@@ -1,7 +1,7 @@
1
1
  # simple sample of config.yml
2
2
  review_version: 3.0
3
3
 
4
- debug: true
4
+ # debug: true
5
5
 
6
6
  ## inherited configuratons
7
7
 
@@ -20,9 +20,9 @@ aut: ["Masayoshi Takahashi"]
20
20
  # edt: null
21
21
  pbl: "Re:VIEW Publishing inc."
22
22
  prt: "Re:VIEW Printing inc."
23
- date: 2016-05-03
24
- history: [["2012-01-30"],["2016-04-20","2016-05-03"]]
25
- rights: (C) 2016 Re:VIEW Commiters, some rights reserved.
23
+ date: 2018-11-11
24
+ history: [["2012-01-30"],["2016-04-20","2016-05-03"],["2018-11-11"]]
25
+ rights: (C) 2016-2018 Re:VIEW Commiters, some rights reserved.
26
26
  description: sample config.yml file for Re:VIEW book
27
27
  urnid: urn:uid:http://reviewml.org/review-sample-book
28
28
  # isbn: null
@@ -68,10 +68,11 @@ epubmaker:
68
68
 
69
69
  ## for LaTeX
70
70
 
71
- texstyle: reviewmacro
72
- texdocumentclass: ["jsbook", "uplatex,oneside"]
71
+ texstyle: ["reviewmacro"]
72
+ texdocumentclass: ["review-jsbook", "media=print,paper=a5,cover=false"]
73
73
 
74
74
  ## for PDFMaker
75
75
 
76
76
  pdfmaker:
77
77
  colophon: true
78
+ # coverimage: cover-a5.ai
data/doc/format_idg.ja.md CHANGED
@@ -40,7 +40,7 @@ Re:VIEW フォーマットから、Adobe 社の DTP ソフトウェア「InDesig
40
40
  `@<dtp>{ 〜 }` で「`<? dtp 〜 ?>`」という XML インストラクションを埋め込みます。処理系に渡す任意の文字列を指定できますが、次のような文字列を特殊文字指定できます。
41
41
 
42
42
  * maru : 番号リストの各段落先頭で使い、このリスト段落の番号は丸数字であることを示す
43
- * return 改行記号文字
43
+ * return : 改行記号文字
44
44
  * autopagenumber : 現ページ番号
45
45
  * nextpageunmber : 次ページ番号
46
46
  * previouspagenumber : 前ページ番号
@@ -91,7 +91,7 @@ Re:VIEW フォーマットから、Adobe 社の DTP ソフトウェア「InDesig
91
91
 
92
92
  ## 表セル幅の指定
93
93
 
94
- `//tsize[|latex|1列目の幅,2列目の幅,...]` で、続く `//table` の表の列幅を指定します(単位mm)。これを利用するときには、`review compile --target=idgxml` を実行する際、オプション`--table=表幅` を付ける必要があります(表幅の単位は mm)。列幅指定の個数が実際の列数に満たない場合、残りの列は均等分割したものとなります。列幅の合計が表幅を超えると警告が表示されます。
94
+ `//tsize[|idgxml|1列目の幅,2列目の幅,...]` で、続く `//table` の表の列幅を指定します(単位mm)。これを利用するときには、`review compile --target=idgxml` を実行する際、オプション`--table=表幅` を付ける必要があります(表幅の単位は mm)。列幅指定の個数が実際の列数に満たない場合、残りの列は均等分割したものとなります。列幅の合計が表幅を超えると警告が表示されます。
95
95
 
96
96
  ## 表セルの結合やスタイル指定
97
97
  `@<dtp>{table 表オプション}` を各セルに入れることで、そのセルの挙動を制御します。
@@ -102,3 +102,7 @@ Re:VIEW フォーマットから、Adobe 社の DTP ソフトウェア「InDesig
102
102
  * `rowspan=行数` : 下方向に結合
103
103
  * `type=名前` : セルの種類の指定
104
104
  * `align=位置` : セル内の内容の位置。通常の用途では left|center|right のいずれか
105
+
106
+ 実際には、スクリプトで判断して後処理することを想定しています。
107
+
108
+ * 例: https://github.com/kmuto/reviewindesignbook/blob/master/book-IDGXML/book-IDGXML-02modifyTable.jsx
data/doc/pdfmaker.ja.md CHANGED
@@ -7,16 +7,107 @@ Re:VIEW の review-pdfmaker は、フリーソフトウェアの簡易 DTP シ
7
7
  * https://texwiki.texjp.org/?TeX入手法
8
8
 
9
9
  ## Re:VIEW バージョンによる変化についての注意
10
- * Re:VIEW 3.0 より、使用するデフォルトのクラスファイルを jsbook.cls から review-jsbook.cls に変更しました。以下の「review-jsbook.cls について」を参照してください。
10
+ * Re:VIEW 3.0 より、使用するデフォルトのクラスファイルを jsbook.cls から review-jsbook.cls に変更しました。また、別のクラスファイルとして review-jlreq.cls も提供しています。以下の「新しいレイアウトファイルおよび review-jsbook.cls について」を参照してください。
11
11
  * Re:VIEW 2.0 より、LaTeX コンパイラのデフォルトが pLaTeX から upLaTeX になりました。以下の「upLaTeX について」を参照してください。
12
12
  * Re:VIEW 2.0 より、image タグに `scale` オプションを使って倍率数値を定義していた場合の挙動が変わりました。以下の「scale オプションの挙動について」を参照してください。
13
13
  * Re:VIEW 2.0 より、config.yml 等の設定ファイルで使われる `prt` のデフォルトが「発行所」ではなく「印刷所」になりました。「発行所」には `pbl` のほうをお使いください。
14
14
 
15
- ## review-jsbook.cls について
15
+ ## 新しいレイアウトファイルおよび review-jsbook.cls について
16
16
 
17
- ★TBD
17
+ Re:VIEW 3.0 より、デフォルトのクラスファイルを jsbook.cls から review-jsbook.cls に切り替えました。
18
18
 
19
- `texdocumentclass` で明示的な設定をしていない場合は、config.yml の `review_version` の値に基づいて切り替えられ、2.0 の場合は従来の jsbook.cls が使われるようになっています。
19
+ `texdocumentclass` で明示的な設定をしていない場合は、config.yml の `review_version` の値に基づいて切り替えられます。`review_version` が 2.0 の場合は、互換性保持のために従来のレイアウトファイルおよび jsbook.cls が使われるようになっています。
20
+
21
+ ### レイアウトファイル `layout.tex.erb` の変更
22
+
23
+ レイアウトファイル `layout.tex.erb` は Re:VIEW 2 バージョンのものから一新され、互換性はなくなりました。
24
+
25
+ これまでは `layout.tex.erb` の中で config.yml の値などの判定を Ruby の埋め込みコードで処理していましたが、config.yml の値はまず TeX のマクロに文字列として格納され、そのマクロをクラスファイルやスタイルファイルで参照して使用します。これにより、(TeX の知識はより必要になりますが)upLaTeX 以外の別のコンパイラを使用したり、独自のクラスファイルやスタイルファイルを作ったりすることが容易になります。
26
+
27
+ config.yml から TeX マクロへの転換は、Re:VIEW プログラムの `templates/latex/config.erb` で実装されています。この結果、新しい `layout.tex.erb` における Ruby の埋め込みコードは以下のプリアンブルの箇所のみとなります。
28
+
29
+ ```
30
+ \documentclass[<%= @documentclassoption %>]{<%= @documentclass %>}
31
+ <%= latex_config %>
32
+ <%- if @config['texstyle'] -%>
33
+ <%- [@config['texstyle']].flatten.each do |x| -%>
34
+ \usepackage{<%= x %>}
35
+ <%- end -%>
36
+ <%- end -%>
37
+
38
+ \begin{document}
39
+
40
+ ```
41
+
42
+ 新しい `layout.tex.erb` では、以下のようなマクロを定義あるいは変更することで書籍を構成します。
43
+
44
+ * `\reviewbegindocumenthook` : ドキュメント開始直後のフック
45
+ * `\reviewcoverpagecont` : 表紙
46
+ * `\reviewfrontmatterhook` : 前付の前のフック
47
+ * `\reviewtitlepagecont` : 大扉
48
+ * `\revieworiginaltitlepagecont` : 翻訳書における原書大扉
49
+ * `\reviewcreditfilecont` : クレジット情報
50
+ * `\reviewprefacefiles` : 前付(PREDEF)
51
+ * `\reviewtableofcontents` : 目次
52
+ * `\reviewmainmatterhook` : 本文の前のフック
53
+ * `\reviewchapterfiles` : 本文(CHAPS)
54
+ * `\reviewappendixhook` : 付録の前のフック
55
+ * `\reviewappendixfiles` : 付録(APPENDIX)
56
+ * `\reviewbackmatterhook` : 後付の前のフック
57
+ * `\reviewpostdeffiles` : 後付(POSTDEF)
58
+ * `\reviewprintindex` : 索引
59
+ * `\reviewprofilepagecont` : 著者紹介
60
+ * `\reviewadvfilepagecont` : 広告
61
+ * `\reviewcolophonpagecont` : 奥付
62
+ * `\reviewbackcovercont` : 裏表紙
63
+ * `\reviewenddocumenthook` : ドキュメント終了直前のフック
64
+
65
+ 過去のバージョンのように全面的に Ruby の埋め込みコードで各種の処理をしたいときには、任意の `layouts/layout.tex.erb` を使用し続けることも可能です。
66
+
67
+ ### review-jsbook.cls の構成
68
+
69
+ `review-init` コマンドで新たなドキュメントフォルダを作成すると sty フォルダに以下のファイルが展開されます。
70
+
71
+ * `review-jsbook.cls` : 紙面表現の基本的な設計を提供するクラスファイルです。
72
+ * `jsbook.cls` : jsbook オリジナルのコピーです。TeX 配布物でのバージョン違いの差異を避けるため、Re:VIEW 本体でスナップショットを保持しています。
73
+ * `plistings.sty` : プログラムコードのハイライト表現を行う支援パッケージです。
74
+ * `jumoline.sty` : 下線を表現する支援パッケージです。
75
+ * `gentombow.sty` : トンボを表現する支援パッケージです。
76
+ * `reviewmacro.sty` : 以下のスタイルファイルを取り込むスタイルファイルです。このファイルを config.yml の texstyle パラメータで指定すれば、すべてのスタイルファイルが取り込まれます。
77
+ * `review-base.sty` : Re:VIEW固有のマクロ名と TeX のマクロとを結び付けるスタイルファイルです。また、`layout.tex.erb` の各マクロの実体を定義します。
78
+ * `review-style.sty` : 基本的な見映えに加えて見た目の調整を定義するスタイルファイルです。review-jsbook.cls が提供するこのファイルは、従来のバージョンとの互換性を持たせたもので、華やかさを追求したものではありません。
79
+ * `review-custom.sty` : このファイルは空の内容で、ユーザーが任意でマクロを追加したり既存のマクロを上書きしたりすることを想定したスタイルファイルです。
80
+
81
+ review-jsbook.cls は従来の jsbook.cls を包み、以下の機能を提供します。
82
+
83
+ * ドキュメントクラスオプションでほとんどの紙面設計を設定できます。
84
+ * クラスオプション `media=print` (デフォルト)で印刷用に適した紙面、`media=ebook` で電子PDF媒体に適した紙面を作成します。印刷用ではデジタルトンボおよび紙面上トンボを配置し、表紙は付けません。電子用ではトンボなしの仕上がりサイズで、表紙を付けます。明示的に表紙の有無を指定することも可能です(`cover=trueまたはfalse`)。
85
+ * クラスオプション `paper=紙サイズ` で用紙サイズを指定できます。
86
+ * クラスオプション `fontsize=基本文字サイズ`、`baselineskip=基本行送り`、`line_length=1行の字詰め`、`number_of_lines=行数`、`head_space=天`、`guter=ノド` による基本版面設計が可能です。
87
+ * クラスオプション `startpage=ページ番号` で大扉のページ開始番号を指定できます。
88
+ * クラスオプション `serial_pagination=trueまたはfalse` でページ番号を大扉からアラビア数字で通すことができます。
89
+ * クラスオプション `hiddenfolio=プリセット` でノドに隠しノンブルを入れることができます(プリセットは `nikko-pc` など)。
90
+
91
+ texdocumentclass パラメータに何も指定をしなければ、以下のようになります。
92
+
93
+ * 印刷用(`media=print`)。トンボあり
94
+ * 表紙なし
95
+ * 用紙はA4(`paper=a4`)
96
+ * 表紙なし(`cover=false`)
97
+ * 基本版面の基本文字サイズは 10pt、ほかは jsbook を継承
98
+ * 隠しノンブルなし
99
+
100
+ その他の詳細な設定については、sty フォルダにある README.md を参照してください。
101
+
102
+ 既存のドキュメントフォルダを Re:VIEW 3.0 (およびより新しいバージョン)に更新するには、ドキュメントフォルダ内で review-update コマンドを実行します。これで、スタイルファイルのコピーや、config.yml 等の既存のパラメータを解析して妥当なオプション指定に移行するといった処理が行われます。
103
+
104
+ ### review-jlreq.cls の構成
105
+
106
+ Re:VIEW 3.0 から review-jlreq.cls という別のクラスファイルも用意しています。review-jlreq.cls は「日本語組版処理の要件」( https://www.w3.org/TR/jlreq/ja/ ) に基づく紙面設計を採用している jlreq.cls を包んだクラスファイルです。
107
+
108
+ `review-init --latex-template=review-jlreq` コマンドで、このクラスファイルを使うように sty フォルダへファイルが展開されます。
109
+
110
+ その他の詳細な設定については、sty フォルダにある README.md を参照してください。
20
111
 
21
112
  ## Re:VIEW 2.0 以前の情報
22
113