review-retrovert 0.9.10 → 0.10.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 (136) hide show
  1. checksums.yaml +4 -4
  2. data/.editorconfig +1 -1
  3. data/.gitignore +0 -1
  4. data/.pinact.yaml +12 -0
  5. data/.ruby-version +1 -1
  6. data/Dockerfile +2 -1
  7. data/Dockerfile.local +13 -0
  8. data/Gemfile.lock +62 -35
  9. data/Makefile +7 -0
  10. data/README.md +2 -1
  11. data/Rakefile +9 -0
  12. data/aqua.yaml +20 -0
  13. data/hooks/post_push +14 -1
  14. data/lib/review/retrovert/cli.rb +10 -2
  15. data/lib/review/retrovert/converter.rb +106 -20
  16. data/lib/review/retrovert/reviewdef.rb +29 -0
  17. data/lib/review/retrovert/sty/review-utbook.cls +7 -0
  18. data/lib/review/retrovert/version.rb +1 -1
  19. data/lib/review/retrovert/yamlconfig.rb +38 -1
  20. data/review-retrovert.gemspec +18 -4
  21. data/zizmor.yml +5 -0
  22. metadata +54 -121
  23. data/.github/FUNDING.yml +0 -4
  24. data/.github/workflows/release.yml +0 -26
  25. data/.github/workflows/retrovert.yml +0 -76
  26. data/testdata/mybook/.gitignore +0 -9
  27. data/testdata/mybook/.textlintrc +0 -11
  28. data/testdata/mybook/README.md +0 -43
  29. data/testdata/mybook/Rakefile +0 -24
  30. data/testdata/mybook/catalog.yml +0 -60
  31. data/testdata/mybook/config-noretrovert.yml +0 -404
  32. data/testdata/mybook/config-retrovert.yml +0 -16
  33. data/testdata/mybook/config-starter.yml +0 -264
  34. data/testdata/mybook/config.yml +0 -404
  35. data/testdata/mybook/contents/00-preface.re +0 -129
  36. data/testdata/mybook/contents/01-install.re +0 -305
  37. data/testdata/mybook/contents/02-tutorial.re +0 -1228
  38. data/testdata/mybook/contents/03-syntax.re +0 -4610
  39. data/testdata/mybook/contents/04-customize.re +0 -1064
  40. data/testdata/mybook/contents/05-faq.re +0 -606
  41. data/testdata/mybook/contents/06-bestpractice.re +0 -1343
  42. data/testdata/mybook/contents/91-compare.re +0 -418
  43. data/testdata/mybook/contents/92-filelist.re +0 -125
  44. data/testdata/mybook/contents/93-background.re +0 -267
  45. data/testdata/mybook/contents/99-postface.re +0 -39
  46. data/testdata/mybook/contents/r0-inner.re +0 -2
  47. data/testdata/mybook/contents/r0-root.re +0 -31
  48. data/testdata/mybook/contents/table.csv +0 -4
  49. data/testdata/mybook/contents/test.txt +0 -1
  50. data/testdata/mybook/css/normalize.css +0 -349
  51. data/testdata/mybook/css/webstyle.css +0 -692
  52. data/testdata/mybook/data/terms.txt +0 -3
  53. data/testdata/mybook/data/words.txt +0 -15
  54. data/testdata/mybook/images/03-syntax/favicon-16x16.png +0 -0
  55. data/testdata/mybook/images/03-syntax/figure_heretop.png +0 -0
  56. data/testdata/mybook/images/03-syntax/index-page.png +0 -0
  57. data/testdata/mybook/images/03-syntax/order-detail.png +0 -0
  58. data/testdata/mybook/images/03-syntax/tw-icon1.jpg +0 -0
  59. data/testdata/mybook/images/03-syntax/tw-icon2.jpg +0 -0
  60. data/testdata/mybook/images/03-syntax/tw-icon3.jpg +0 -0
  61. data/testdata/mybook/images/03-syntax/tw-icon4.jpg +0 -0
  62. data/testdata/mybook/images/04-customize/caption_pagebreak.png +0 -0
  63. data/testdata/mybook/images/04-customize/chaptitlepage_sample.png +0 -0
  64. data/testdata/mybook/images/04-customize/section_decoration_samples.png +0 -0
  65. data/testdata/mybook/images/05-faq/codeblock_rpadding1.png +0 -0
  66. data/testdata/mybook/images/05-faq/codeblock_rpadding2.png +0 -0
  67. data/testdata/mybook/images/05-faq/dummy-image.png +0 -0
  68. data/testdata/mybook/images/06-bestpractice/figure_heretop.png +0 -0
  69. data/testdata/mybook/images/06-bestpractice/font_beramono.png +0 -0
  70. data/testdata/mybook/images/06-bestpractice/heading_design1.png +0 -0
  71. data/testdata/mybook/images/06-bestpractice/heading_design2.png +0 -0
  72. data/testdata/mybook/images/06-bestpractice/margin_book.png +0 -0
  73. data/testdata/mybook/images/06-bestpractice/multiline-title.png +0 -0
  74. data/testdata/mybook/images/06-bestpractice/preface_numbered.png +0 -0
  75. data/testdata/mybook/images/06-bestpractice/program_border.png +0 -0
  76. data/testdata/mybook/images/06-bestpractice/sechead_design_4.png +0 -0
  77. data/testdata/mybook/images/06-bestpractice/section_title_wlines.png +0 -0
  78. data/testdata/mybook/images/06-bestpractice/titlepage-samples.png +0 -0
  79. data/testdata/mybook/images/93-background/bug913.png +0 -0
  80. data/testdata/mybook/images/93-background/slide2.png +0 -0
  81. data/testdata/mybook/images/avatar-b.png +0 -0
  82. data/testdata/mybook/images/avatar-g.png +0 -0
  83. data/testdata/mybook/images/avatar-r.png +0 -0
  84. data/testdata/mybook/images/caution-icon.png +0 -0
  85. data/testdata/mybook/images/cover_a5.pdf +0 -0
  86. data/testdata/mybook/images/cover_b5.pdf +0 -0
  87. data/testdata/mybook/images/info-icon.png +0 -0
  88. data/testdata/mybook/images/tw-icon.jpg +0 -0
  89. data/testdata/mybook/images/warning-icon.png +0 -0
  90. data/testdata/mybook/layouts/layout.epub.erb +0 -29
  91. data/testdata/mybook/layouts/layout.html5.erb +0 -108
  92. data/testdata/mybook/layouts/layout.tex.erb +0 -432
  93. data/testdata/mybook/layouts/layout.tex.erb.orig +0 -386
  94. data/testdata/mybook/lib/hooks/beforetexcompile.rb +0 -55
  95. data/testdata/mybook/lib/ruby/review-book.rb +0 -64
  96. data/testdata/mybook/lib/ruby/review-builder.rb +0 -1342
  97. data/testdata/mybook/lib/ruby/review-cli.rb +0 -58
  98. data/testdata/mybook/lib/ruby/review-compiler.rb +0 -1176
  99. data/testdata/mybook/lib/ruby/review-epubbuilder.rb +0 -33
  100. data/testdata/mybook/lib/ruby/review-epubmaker.rb +0 -609
  101. data/testdata/mybook/lib/ruby/review-htmlbuilder.rb +0 -949
  102. data/testdata/mybook/lib/ruby/review-latexbuilder.rb +0 -1065
  103. data/testdata/mybook/lib/ruby/review-maker.rb +0 -346
  104. data/testdata/mybook/lib/ruby/review-markdownbuilder.rb +0 -945
  105. data/testdata/mybook/lib/ruby/review-markdownmaker.rb +0 -91
  106. data/testdata/mybook/lib/ruby/review-monkeypatch.rb +0 -93
  107. data/testdata/mybook/lib/ruby/review-pdfmaker.rb +0 -546
  108. data/testdata/mybook/lib/ruby/review-textbuilder.rb +0 -36
  109. data/testdata/mybook/lib/ruby/review-tocparser.rb +0 -285
  110. data/testdata/mybook/lib/ruby/review-webmaker.rb +0 -448
  111. data/testdata/mybook/lib/tasks/mytasks.rake +0 -31
  112. data/testdata/mybook/lib/tasks/review.rake +0 -156
  113. data/testdata/mybook/lib/tasks/review.rake.orig +0 -72
  114. data/testdata/mybook/lib/tasks/starter.rake +0 -470
  115. data/testdata/mybook/locale.yml +0 -6
  116. data/testdata/mybook/review-ext.rb +0 -206
  117. data/testdata/mybook/sty/indexstyle.ist +0 -25
  118. data/testdata/mybook/sty/jumoline.sty +0 -310
  119. data/testdata/mybook/sty/mycolophon.sty +0 -81
  120. data/testdata/mybook/sty/mystyle.sty +0 -8
  121. data/testdata/mybook/sty/mytextsize.sty +0 -90
  122. data/testdata/mybook/sty/mytitlepage.sty +0 -126
  123. data/testdata/mybook/sty/review-base.sty +0 -276
  124. data/testdata/mybook/sty/reviewmacro.sty +0 -60
  125. data/testdata/mybook/sty/starter-codeblock.sty +0 -463
  126. data/testdata/mybook/sty/starter-color.sty +0 -134
  127. data/testdata/mybook/sty/starter-font.sty +0 -112
  128. data/testdata/mybook/sty/starter-heading.sty +0 -561
  129. data/testdata/mybook/sty/starter-misc.sty +0 -894
  130. data/testdata/mybook/sty/starter-note.sty +0 -180
  131. data/testdata/mybook/sty/starter-section.sty +0 -262
  132. data/testdata/mybook/sty/starter-talklist.sty +0 -105
  133. data/testdata/mybook/sty/starter-toc.sty +0 -72
  134. data/testdata/mybook/sty/starter-util.sty +0 -35
  135. data/testdata/mybook/sty/starter.sty +0 -36
  136. data/testdata/mybook/style.css +0 -597
@@ -1,264 +0,0 @@
1
- # coding: utf-8
2
-
3
- ## Starter独自設定
4
- starter:
5
-
6
- ## 出力のターゲット。環境変数 $STARTER_TARGET で上書き可能。
7
- ## * pbook: 印刷用のモノクロPDFを出力。printing bookの略。
8
- ## * ebook: 電子用のカラーPDFを出力。electric bookの略。
9
- ## * tablet: タブレット用のカラーPDFを出力。
10
- target: pbook
11
-
12
- ## ドラフトモード。trueなら画像を読み込むかわりに枠を表示する。
13
- ## 図やスクリーンショットが多くてコンパイルに時間がかかるときに便利。
14
- draft: false
15
-
16
- ## 用紙サイズ
17
- ## ・A5 … コロコロコミック、ボンボン、LaLa DXの大きさ
18
- ## ・B5 … 少年ジャンプ、ジャポニカ学習帳の大きさ
19
- pagesize: A5 # A5 or B5
20
-
21
- ## 上下左右の塗り足し幅(印刷用PDFのみ)
22
- ## (参考:https://www.eikou.com/making/basis#nuritashi )
23
- bleedsize: # 通常は指定しなくてよい
24
- #bleedsize: 3mm # 背景色を使うなら、上下左右に3mmの塗り足しが必要
25
- bleedcolor: # 通常は無指定、確認時のみ使用(red/blue/green/yellow/gray)
26
-
27
- ## フォントサイズ
28
- ## ・A5なら「9pt」、B5なら「10pt」を推奨
29
- ## ・初心者向け入門書なら大きめにして、A5「10pt」、B5「11pt」を推奨
30
- fontsize: 9pt # 9pt or 10pt
31
-
32
- ## 本文幅
33
- ## ・A5 9ptなら「38zw」か「39zw」、A5 10ptなら「35zw」を推奨
34
- ## ・B5 10ptなら「44zw」か「45zw」、B5 11ptなら「41zw」を推奨
35
- textwidth: 38zw # 全角の文字数で指定
36
-
37
- ## 本文のフォント(注:実験的)
38
- ## (Notoフォントが前提なので、Docker環境が必要。MacTeXでは使わないこと)
39
- fontfamily_ja: mincho # (日本語) mincho: 明朝体, gothic: ゴシック体
40
- fontfamily_en: roman # (英数字) roman: ローマン体, sansserif: サンセリフ体
41
- fontweight_ja: normal # (日本語) normal: 通常, light: 細字
42
- fontweight_en: normal # (英数字) normal: 通常, light: 細字
43
-
44
- ## 表紙や大扉(タイトルページ)や奥付のページのPDFファイルを指定
45
- ## ・PDFファイルは `images/` フォルダに置くこと。
46
- ## ・PDFは1ファイルにつき1ページであること。もし複数ページのPDFを指定する場合は
47
- ## 取り込むページ番号を `cover.pdf<2>` のように指定すること(実験的機能)。
48
- ## ・ファイル名の後ろに `*` をつけると、上下左右の塗り足し部分が除かれる。
49
- ## ・必要なら配列を使って複数ファイルを指定可能(例: [a.pdf, b.pdf])。
50
- frontcover_pdffile: cover_a5.pdf # 表表紙(電子用のみ、印刷用にはつかない)
51
- #frontcover_pdffile: cover.pdf<2>* # (ページ番号を指定し、塗り足しを除く場合)
52
- backcover_pdffile: null # 裏表紙(電子用のみ、印刷用にはつかない)
53
- titlepage_pdffile: null # 大扉(印刷用・電子用どちらにもつく)
54
- colophon_pdffile: null # 奥付(印刷用・電子用どちらにもつく)
55
- includepdf_option: null # PDFの位置調整が必要な場合
56
- #includepdf_option: "offset=-2.3mm 2.3mm" # 位置調整の指定例
57
-
58
- ## ノンブル(1枚目からの通し番号)の設定
59
- ## (注:印刷用PDFのときのみ有効、電子用PDFではノンブルはつかない)
60
- nombre: on # on ならノンブルをつける
61
- nombre_sidemargin: 0.5mm # ページ左右からのマージン幅
62
- nombre_bottommargin: 2.0mm # ページ下からのマージン高
63
- nombre_fontcolor: gray # 'gray' or 'black'
64
- nombre_fontsize: 6pt # フォントサイズ(6〜8pt)
65
- nombre_startnumber: 1 # ノンブルの開始番号(3から始める流儀もある)
66
-
67
- ## 部 (Part) の開始番号(上・下巻に分割する場合に必要)
68
- part_startnumber: 1 # 5 なら「第5部」から始まる
69
-
70
- ## 章 (Chapter) の開始番号
71
- chapter_startnumber: 1 # 0 なら「第0章」から始まる
72
-
73
- ## 章 (Chapter) タイトルの装飾
74
- ## (none: なし、underline: 下線、boldlines: 上下に太線)
75
- chapter_decoration: boldlines
76
-
77
- ## 章 (Chapter) タイトルの左寄せ/右寄せ/中央揃え
78
- ## (left: 左寄せ、right: 右寄せ、center: 中央揃え)
79
- chapter_align: center
80
-
81
- ## 章 (Chapter) タイトルを1行にする(章番号とタイトルとの間で改行しない)
82
- chapter_oneline: false
83
-
84
- ## 節 (Section) ごとに改ページするか
85
- ## (ただし各章の最初の節は改ページしない)
86
- section_newpage: false
87
-
88
- ## ページ先頭なら節や項のタイトルの前にスペースを入れない
89
- ## (obsolete: 現在は常にtrue扱い)
90
- section_notopmargin: true
91
-
92
- ## 節 (Section) タイトルの装飾
93
- ## (none: なし、underline: 下線、grayback: 灰色の背景色、
94
- ## leftline: 左に縦線、numbox: 節番号を黒背景に、circle: 円)
95
- ## (節タイトルが長くて二行になる場合は「leftline」「numbox」「circle」がお勧め)
96
- section_decoration: grayback
97
-
98
- ## 項 (Subsection) タイトルの装飾
99
- ## (none: なし、symbol: 先頭にクローバー)
100
- subsection_decoration: symbol
101
-
102
- ## プログラムやターミナルのキャプションを小さくするか?
103
- caption_small: false
104
-
105
- ## キャプションの見映えをよくするか?
106
- caption_pretty: true
107
-
108
- ## キャプション直後での改ページを防ぐために、最低限必要とする高さ
109
- ## (もしキャプション直後での改ページが発生するなら値を増やす。
110
- ## もし十分なスペースがあるのに改ページされるなら値を減らす。)
111
- caption_needspace: 4.0zh # 全角文字4個分の高さ(実験で得た境界値)
112
-
113
- ## プログラム用(//list)の等幅フォント。
114
- ## * lmodern … LaTeXのデフォルト。1とl、0とOが見分けにくい。太字が目立たない。
115
- ## * lmodern-lighttt … lmodernを細字にしたもの。太字が目立つ。
116
- ## * courier … 文字が細いので太字が目立つ。1とl、0とOが見分けにくい。文字幅が広い。
117
- ## * beramono … 1とl、0とOが見分けやすい。「'」と「`」が見分けにくい。
118
- ## * inconsolata … 1とl、0とOが見分けやすい。文字幅が少し狭い。
119
- ## * inconsolata-narrow … inconsolataの文字幅をさらに狭めたもの。英数字と日本語の文字幅が約1:2。
120
- program_ttfont: beramono
121
-
122
- ## ターミナル用(//terminal、//cmd)の等幅フォント。
123
- ## 使用できるフォント名はプログラム用と同じ。
124
- ## ただしinconsolataとinconsolata-narrow、lmodernとlmodern-lightttは互いに排他的。
125
- ## たとえばプログラム用でinconsolataを使いつつターミナル用でinconsolata-narrowを
126
- ## 使う、といったことはできない(どちらもinconsolata-narrowになる)。
127
- terminal_ttfont: inconsolata
128
-
129
- ## プログラム(//list)の表示幅をほんの少しだけ広げる。
130
- ## 折返し記号が右端まで届かず、あともう1文字入りそうなときに使う。
131
- ## 詳細は https://twitter.com/_kauplan/status/1162167825407963137
132
- program_widen: 0.0mm # 0.3mmとか
133
-
134
- ## ターミナル(//terminal, //cmd)の表示幅をほんの少しだけ広げる。
135
- ## 折返し記号が右端まで届かず、あともう1文字入りそうなときに使う。
136
- ## 詳細は https://twitter.com/_kauplan/status/1162167825407963137
137
- terminal_widen: 0.0mm # 0.3mmとか
138
-
139
- ## プログラム(//list)のデフォルトオプション
140
- ## (注:YAMLでは `on, off, ~` は `true, false, null` と同じ)
141
- program_default_options:
142
- fold: on # on なら長い行を右端で折り返す
143
- foldmark: on # on なら折り返し記号をつける
144
- eolmark: off # on なら行末に改行記号をつける
145
- lineno: ~ # 1 なら行番号をつける
146
- linenowidth: ~ # 行番号の幅を半角文字数で指定する
147
- indent: ~ # インデント幅(指定するとインデント記号がつく)
148
- fontsize: ~ # null, or small/x-small/xx-smal
149
- lang: ~ # デフォルトのプログラミング言語名
150
- #file: ~ # (使用しない)
151
- encoding: utf-8 # ファイルの文字コード
152
- widecharfit: off # on なら全角1文字を半角2文字幅に
153
- charspace: ~ # 文字の間隔を空ける/詰める(例:-0.03em)
154
-
155
- ## ターミナル(//terminal)のデフォルトオプション
156
- ## (注:YAMLでは `on, off, ~` は `true, false, null` と同じ)
157
- terminal_default_options:
158
- fold: on # on なら長い行を右端で折り返す
159
- foldmark: on # on なら折り返し記号をつける
160
- eolmark: off # on なら行末に改行記号をつける
161
- lineno: ~ # 1 なら行番号をつける
162
- linenowidth: ~ # 行番号の幅を半角文字数で指定する
163
- indent: ~ # インデント幅(指定するとインデント記号がつく)
164
- fontsize: ~ # null, or small/x-small/xx-smal
165
- lang: ~ # デフォルトのプログラミング言語名
166
- #file: ~ # (使用しない)
167
- encoding: utf-8 # ファイルの文字コード
168
- widecharfit: off # on なら全角1文字を半角2文字幅に
169
- charspace: ~ # 文字の間隔を空ける/詰める(例:-0.03em)
170
-
171
- ## プログラム(//list)を枠で囲むか?
172
- program_border: true
173
-
174
- ## ターミナル(//terminal, //cmd)を枠で囲むか?
175
- terminal_border: false
176
-
177
-
178
- ## 出力結果(//output)の設定
179
- output_ttfont: beramono
180
- output_widen: 0.0mm # 0.3mmとか
181
- output_border: true # 枠線で囲むか?
182
- output_default_options:
183
- fold: on # on なら長い行を右端で折り返す
184
- foldmark: on # on なら折り返し記号をつける
185
- eolmark: off # on なら行末に改行記号をつける
186
- lineno: ~ # 1 なら行番号をつける
187
- linenowidth: ~ # 行番号の幅を半角文字数で指定する
188
- indent: ~ # インデント幅(指定するとインデント記号がつく)
189
- fontsize: ~ # null, or small/x-small/xx-smal
190
- lang: ~ # デフォルトのプログラミング言語名
191
- #file: ~ # (使用しない)
192
- encoding: utf-8 # ファイルの文字コード
193
- widecharfit: on # on なら全角1文字を半角2文字幅に
194
- charspace: ~ # 文字の間隔を空ける/詰める(例:-0.03em)
195
-
196
-
197
- ## 文章中の「@<code>{...}」の背景色を薄いグレーにするか?
198
- inlinecode_gray: false
199
-
200
- ## 奥付 (Colophon) に「powered by Re:VIEW Starter」と入れるか?
201
- colophon_poweredby: true
202
-
203
- ## 画像が現在位置に入りきらず次ページに送られたとき、後続のテキストを現在位置に
204
- ## 流し込むかどうか。流し込まないと現在位置に大きなスペースができてしまう。
205
- ## またLaTeXの位置指定(t:top, b:bottom, p:page)も指定可能。
206
- #image_position: H # 現在位置にスペースが空く(要float.sty)
207
- image_position: h # 現在位置に後続テキストを流し込む
208
-
209
- ## (obsolete、現在では常にtrue扱い)
210
- ## 十分なスペースがあるのに節や項のタイトル直前で改ページされるのを避ける。
211
- ## (LaTeXのデフォルトでは、ページ最下部の段落が最初の1行だけになるのを嫌う。
212
- ## そのため、節(Section)のタイトル直後が1行だけで改ページされるくらいなら
213
- ## 節タイトルの直前で改ページすることをLaTeXは選ぶ。
214
- ## このせいで、十分な空きがあるのに節タイトル前で改ページされることがある。)
215
- page_clubline: true # trueなら改ページを避ける
216
-
217
- ## リンクのURLを脚注に埋め込む(PDFでのみ)。
218
- linkurl_footnote: true # trueならリンクのURLを脚注に埋め込む(お勧め)
219
-
220
- ## @<secref>{}において、親の節のタイトルを含めるか?
221
- secref_parenttitle: false # trueなら親の節のタイトルを含める
222
-
223
- ## PDF中のテキストをマウスで選択したとき、折り返し記号やインデント記号を選択対象から外すか?
224
- ## ・trueだとコンパイル時間が大幅に増えるので、デフォルトではfalse。
225
- ## ・環境変数「$STARTER_EXCLUDE_MOUSESELECT=on」でもtrueにできる。
226
- ## ・AcrobatReaderでは機能するが、macOS Preview.appでは機能しない。
227
- exclude_mouseselect: false
228
-
229
-
230
- ## 説明リスト(`//desclist`)のデフォルトオプション
231
- ## (注:YAMLでは `on` は `true` と同じ、`off` は `false` と同じ)
232
- desclist_default_options:
233
- indent: 3zw # 説明文の左側の空き幅
234
- space: 1zw # キーや用語の直後の空き幅
235
- bold: off # on ならキーや用語を太字に
236
- compact: off # on ならキーや用語の直後で改行しない
237
- listmargin: 0.5zw # 説明リスト上下の空きの高さ
238
- itemmargin: 0mm # 説明項目間の空きの高さ
239
- classname: # HTMLタグに含めるクラス名
240
-
241
- ## 会話形式(`//talklist`)のデフォルトオプション
242
- ## (注:YAMLでは `on` は `true` と同じ、`off` は `false` と同じ)
243
- talklist_default_options:
244
- indent: 6zw # 本文左端から会話部分までの幅
245
- separator: ":" # 名前と会話文との区切り文字列
246
- imagewidth: 4zw # 画像幅
247
- imageheight: # 画像高さ(通常は無指定でよい)
248
- imageborder: off # on なら画像に枠線をつける
249
- needvspace: 4zw # 必要な空きがなければ改ページ
250
- itemmargin: 1mm # 会話項目間の空き
251
- listmargin: 0.5zw # 会話リストの最初と最後の空き
252
- itemstart: "「" # 会話文の先頭につける文字列
253
- itemend: "」" # 会話文の最後につける文字列
254
- classname: # HTMLタグに含めるクラス名
255
-
256
- ## 大量の会話形式をより簡単に入力するための設定
257
- ## (例:`//t[b1]` が `//talk[avatar-b][]` の短縮形となる)
258
- talk_shortcuts:
259
- ## アイコン画像を使う場合
260
- "b1": {image: "avatar-b"}
261
- "g1": {image: "avatar-g"}
262
- ## アイコン画像を使わない場合
263
- #"b1": {name: "アリス"}
264
- #"g1": {name: "ボブ"}
@@ -1,404 +0,0 @@
1
- # review-epubmaker向けの設定ファイルの例。
2
- # yamlファイルをRe:VIEWファイルのある場所に置き、
3
- # 「review-epubmaker yamlファイル」を実行すると、<bookname>.epubファイルが
4
- # 生成されます。
5
- # このファイルはUTF-8エンコーディングで記述してください。
6
-
7
- # この設定ファイルでサポートするRe:VIEWのバージョン番号。
8
- # major versionが違うときにはエラーを出す。
9
- review_version: 2.0
10
-
11
- # ほかの設定ファイルの継承を指定できる。同じパラメータに異なる値がある場合は、
12
- # 呼び出し元の値が優先される。
13
- # A.yml、B.ymlのパラメータを継承する例。A.ymlとB.ymlに同じパラメータがある
14
- # 場合、B.ymlの値が優先される。さらに今このファイルに同じパラメータがあるなら、
15
- # その値がB.ymlよりも優先される。
16
- # 同様にA.yml、B.yml内でさらにinherit:パラメータを使うこともできる。
17
- # inherit: ["A.yml", "B.yml"]
18
- inherit: ["config-starter.yml", "config-retrovert.yml"]
19
-
20
- # ブック名(ファイル名になるもの。ASCII範囲の文字を使用)
21
- bookname: mybook
22
- # 記述言語。省略した場合はja
23
- language: ja
24
-
25
- # 書名
26
- # 読みを入れる例 booktitle: {name: "Re:VIEW EPUBサンプル", file-as: "リビューイーパブサンプル"}
27
- # (タイトルやサブタイトルが長い場合は、好みの箇所に改行を入れてください。)
28
- booktitle: |-
29
- はじめてのXXX入門
30
- subtitle: |-
31
- 概念と基本操作を2時間でマスター!
32
-
33
- # 著者名。「, 」で区切って複数指定できる
34
- # 読みを入れる例 aut: [{name: "青木峰郎", file-as: "アオキミネロウ"}, {name: "武藤健志", file-as: "ムトウケンシ"}, {name: "高橋征義", file-as: "タカハシマサヨシ"}, {name: "角征典", file-as: "カドマサノリ"}]
35
- aut:
36
- - name: カウプラン機関極東支部
37
- file-as: カウプランキカンキョクトウシブ
38
-
39
- # (Starter拡張) 奥付に載せるデータ。現在はPDFのみ対応。
40
- additional:
41
- # 技書博では発行責任者とその連絡先が必須になった。
42
- # 詳しくはこのページを参照:
43
- # https://esa-pages.io/p/sharing/13039/posts/115/7fbe936149a836eac678.html#奥付の記載
44
- - key: 発行者 # サークル名ではなく個人名(ペンネーム可)
45
- value:
46
- - key: 連絡先 # メールアドレス推奨
47
- value:
48
- ### 連絡先の例:
49
- #value:
50
- # - xxxxx@example.com # メールアドレス
51
- # - https://www.example.com/ # WebサイトURL
52
- # - "@xxxxx" # Twitterアカウント(先頭に '@' をつけること)
53
-
54
- # 以下はオプション
55
- # 以下はオプション(autと同じように配列書式で複数指定可能)。
56
- # 読みの指定はaut:の例を参照。
57
- # a-が付いているものはcreator側、
58
- # 付いていないものはcontributor側(二次協力者)に入る
59
- # a-adp, adp: 異なるメディア向けに作り直した者
60
- # a-ann, ann: 注釈記述者
61
- # a-arr, arr: アレンジした者
62
- # a-art, art: グラフィックデザインおよび芸術家
63
- # a-asn, asn: 関連・かつての所有者・関係者
64
- # a-aqt, aqt: 大きく引用された人物
65
- # a-aft, aft: 後書き・奥付の責任者
66
- # a-aui, aui: 序論・序文・前書きの責任者
67
- # a-ant, ant: 目録責任者
68
- # a-bkp, bkp: メディア制作責任者
69
- # a-clb, clb: 限定参加または補足者
70
- # a-cmm, cmm: 解釈・分析・考察者
71
- # a-csl, csl: 監修者
72
- # a-dsr, dsr: デザイナ
73
- # a-edt, edt: 編集者
74
- # a-ill, ill: イラストレータ
75
- # a-lyr, lyr: 歌詞作成者
76
- # a-mdc, mdc: メタデータセットの一次的責任者
77
- # a-mus, mus: 音楽家
78
- # a-nrt, nrt: 語り手
79
- # a-oth, oth: その他
80
- # a-pht, pht: 撮影責任者
81
- # a-pbl, pbl: 出版社(発行所)
82
- # a-prt, prt: 印刷所
83
- prt: ○○印刷所
84
- # a-red, red: 項目の枠組起草者
85
- # a-rev, rev: 評論者
86
- # a-spn, spn: 援助者
87
- # a-ths, ths: 監督者
88
- # a-trc, trc: 筆記・タイプ作業者
89
- # a-trl, trl: 翻訳者
90
-
91
- # 刊行日(省略した場合は実行時の日付)
92
- date: 2021-07-10
93
- # 発行年月。YYYY-MM-DD形式による配列指定。省略した場合はdateを使用する
94
- # 複数指定する場合は次のように記述する
95
- # [["初版第1刷の日付", "初版第2刷の日付"], ["第2版第1刷の日付"]]
96
- # 日付の後ろを空白文字で区切り、任意の文字列を置くことも可能。
97
- history:
98
- - # 初版
99
- - 2021-07-10 ver 1.0 (技術書典11)
100
- # [experimental] 新刊を頒布したイベント名(例:「技術書典6(2019年春)新刊」)
101
- pubevent_name: 技術書典11(2021年夏)新刊
102
- # 権利表記(配列で複数指定可)
103
- rights: (C) 2021 カウプラン機関極東支部
104
- # description: 説明
105
- # subject: 短い説明用タグ(配列で複数指定可)
106
- # type: 書籍のカテゴリーなど(配列で複数指定可)
107
- # format: メディアタイプおよび特徴(配列で複数指定可)
108
- # source: 出版物生成の重要なリソース情報(配列で複数指定可)
109
- # relation: 補助的リソース(配列で複数指定可)
110
- # coverage: 内容の範囲や領域(配列で複数指定可)
111
-
112
- # デバッグフラグ。nullでないときには一時ファイルをカレントディレクトリに作成し、削除もしない
113
- debug: true
114
-
115
- # 固有IDに使用するドメイン。指定しない場合には、時刻に基づくランダムUUIDが入る
116
- # urnid: urn:uid:http://example.com/book-title/
117
- #
118
- # ISBN。省略した場合はurnidが入る
119
- # isbn: null
120
- #
121
- # HTMLファイルの拡張子(省略した場合はhtml)
122
- # htmlext: html
123
- #
124
- # CSSファイル(配列で複数指定可)
125
- stylesheet: ["style.css"]
126
-
127
- # ePUBのバージョン (2か3)
128
- # epubversion: 2
129
- #
130
- # HTMLのバージョン (4か5。epubversionを3にしたときには5にする)
131
- # htmlversion: 4
132
-
133
- # 目次として抽出する見出しレベル
134
- toclevel: 3 # (部と)章と節と項(小節)を目次に載せる
135
-
136
- # 採番の設定。採番させたくない見出しには「==[nonum]」のようにnonum指定をする
137
- #
138
- # 本文でセクション番号を表示する見出しレベル
139
- secnolevel: 2 # 章 (Chapter) と節 (Section) にだけ番号をつける
140
- #secnolevel: 3 # 項 (Subsection) にも番号をつける
141
-
142
- # 以下のsecnolevelはまだ未実装。
143
- # 前付でセクション番号を表示する見出しレベル(未実装)
144
- # pre_secnolevel: 0
145
- #
146
- # 後付(付録)でセクション番号を表示する見出しレベル(未実装)
147
- # post_secnolevel: 1
148
- #
149
- # 部番号を表示する見出しレベル(未実装)
150
- # part_secnolevel: 1
151
-
152
- # 本文中に目次ページを作成するか。省略した場合はnull (作成しない)
153
- toc: true
154
-
155
- # EPUB2標準の目次(NCX)以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
156
- # ePUB3においてはこの設定によらず必ず作成される
157
- # mytoc: true
158
-
159
- # 表紙にするHTMLファイル。ファイル名を指定すると表紙として入る
160
- # cover: null
161
- #
162
- # 表紙に配置し、書籍の影絵にも利用する画像ファイル。省略した場合はnull (画像を使わない)。画像ディレクトリ内に置いてもディレクトリ名は不要(例: cover.jpg)
163
- #coverimage: cover.jpg
164
- #
165
- # 表紙の後に大扉ページを作成するか。省略した場合はtrue (作成する)
166
- titlepage: true
167
- #
168
- # 自動生成される大扉ページを上書きするファイル。ファイル名を指定すると大扉として入る (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
169
- # titlefile: null
170
- #
171
- # 原書大扉ページにするHTMLファイル。ファイル名を指定すると原書大扉として入る (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
172
- # originaltitlefile: null
173
- #
174
- # 権利表記ページファイル。ファイル名を指定すると権利表記として入る (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
175
- # creditfile: null
176
-
177
- # 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
178
- # colophon: null
179
-
180
- # 裏表紙データファイル (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
181
- # backcover: null
182
-
183
- # プロフィールページファイル (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)。ファイル名を指定すると著者紹介として入る
184
- # profile: null
185
- # プロフィールページの目次上の見出し
186
- # profiletitle: 著者紹介
187
-
188
- # 広告ファイル。ファイル名を指定すると広告として入る (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
189
- # advfile: null
190
-
191
- # 取り込む画像が格納されているディレクトリ。省略した場合は以下
192
- # imagedir: images
193
-
194
- # 取り込むフォントが格納されているディレクトリ。省略した場合は以下
195
- # fontdir: fonts
196
-
197
- # imagedir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
198
- # image_ext: ["png", "gif", "jpg", "jpeg", "svg", "ttf", "woff", "otf"]
199
-
200
- # fontdir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
201
- # font_ext: ["ttf", "woff", "otf"]
202
-
203
- # ソースコードハイライトを利用する (rouge,pygmentsには外部gemが必要)
204
- # highlight:
205
- # html: "rouge"
206
- # latex: "listings"
207
-
208
- # カタログファイル名を指定する
209
- # catalogfile: catalog.yml
210
-
211
- # reファイルを格納するディレクトリ。デフォルト値は null。
212
- # 値にたとえば「contents」を指定すると、reファイルはすべて「contents」
213
- # ディレクトリに置かなければならず、カレントディレクトリには一切置いては
214
- # ならない。
215
- # contentdir: null
216
- contentdir: contents
217
-
218
- # @<w>命令で使用する単語ファイルのパス。文字コードは必ずUTF-8。
219
- # CSV形式 (*.csv) とタブ区切りテキスト (*.txt または *.tsv) が利用可能。
220
- words_file: data/words.txt # [f1.csv, f2.txt] のように複数指定も可能
221
-
222
- # 1ページの行数文字数と1kbごとのページ数を用紙サイズで指定する(A5 or B5)。
223
- # page_metric: A5
224
- #
225
- # あるいは、配列で指定することもできる
226
- # 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数、1kバイト毎のページ数
227
- # page_metric: [40,80,40,80,2]
228
-
229
- # ページ送りの送り方向、page-progression-directionの値("ltr"|"rtl"|"default")
230
- # direction: "ltr"
231
-
232
- # EPUBのOPFへの固有の追加ルール
233
- # <package>要素に追加する名前空間
234
- # opf_prefix: {ebpaj: "http://www.ebpaj.jp/"}
235
- # 追加する<meta>要素のプロパティとその値
236
- # opf_meta: {"ebpaj:guide-version": "1.1.3"}
237
-
238
- # 以下のパラメータを有効にするときには、
239
- # epubmaker:
240
- # パラメータ: 値
241
- # パラメータ: 値
242
- # ...
243
- # という構成にする必要がある(インデントさせる)
244
-
245
- epubmaker:
246
- # HTMLファイルの拡張子
247
- htmlext: xhtml
248
- #
249
- # 目次を要素の階層表現にしない。省略した場合(null)は階層化する。
250
- # 特に部扉が入るなどの理由で、構成によっては階層化目次でepubcheckに
251
- # パスしない目次ができるが、そのようなときにはこれをtrueにする
252
- # flattoc: null
253
- #
254
- # 目次のインデントレベルをスペース文字で表現する(flattocがtrueのときのみ)
255
- # flattocindent: true
256
- #
257
- # NCX目次の見出しレベルごとの飾り(配列で設定)。EPUB3ではNCXは作られない
258
- # ncxindent:
259
- #-
260
- #- -
261
- # フックは、各段階で介入したいときのプログラムを指定する。自動で適切な引数が渡される
262
- # プログラムには実行権限が必要
263
- # ファイル変換処理の前に実行するプログラム。スタイルシートのコンパイルをしたいときなどに利用する。
264
- # 渡される引数1=作業用展開ディレクトリ
265
- # hook_beforeprocess: null
266
- #
267
- # 前付の作成後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
268
- # 渡される引数1=作業用展開ディレクトリ
269
- # hook_afterfrontmatter: null
270
- #
271
- # 本文の変換後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
272
- # 渡される引数1=作業用展開ディレクトリ
273
- # hook_afterbody: null
274
- #
275
- # 後付の作成後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
276
- # 渡される引数1=作業用展開ディレクトリ
277
- # hook_afterbackmatter: null
278
- #
279
- # 画像およびフォントをコピーした後に実行するプログラム。別の画像やフォントを追加したいときなどに利用する。
280
- # 渡される引数1=作業用展開ディレクトリ
281
- # hook_aftercopyimage: null
282
- #
283
- # ePUB zipアーカイブ直前に実行するプログラム。メタ情報などを加工したいときなどに利用する。
284
- # 渡される引数1=ePUB準備ディレクトリ
285
- # hook_prepack: null
286
- #
287
- # 変換したHTMLファイルおよびCSSを解析して厳密に使用している画像ファイルだけを取り込むか。デフォルトはnull(imagesディレクトリすべてを取り込む)
288
- # なお、フォント、カバー、広告についてはこの設定によらずディレクトリ内のものがすべて取り込まれる
289
- # verify_target_images: null
290
- #
291
- # verify_target_imagesがtrueの状態において、解析で発見されなくても強制的に取り込むファイルの相対パスの配列
292
- # force_include_images: []
293
- #
294
- # 画像ファイルの縦x横の最大ピクセル数許容値
295
- # image_maxpixels: 4000000
296
- #
297
- # Re:VIEWファイル名を使わず、前付にpre01,pre02...、本文にchap01,chap02l...、後付にpost01,post02...という名前付けルールにするか
298
- # rename_for_legacy: null
299
- #
300
- # ePUBアーカイブの非圧縮実行
301
- # zip_stage1: "zip -0Xq"
302
- #
303
- # ePUBアーカイブの圧縮実行
304
- # zip_stage2: "zip -Xr9Dq"
305
- #
306
- # ePUBアーカイブに追加するパス(デフォルトはmimetype、META-INF、OEBPS)
307
- # zip_addpath: null
308
- #
309
- # EPUBで表紙をコンテンツに含めるか。デフォルトでは作成されない。yesにするとiBooks等でも最初に表紙が表示されるようになる
310
- # cover_linear: null
311
- #
312
- # @<href>タグでの外部リンクを禁止し、地の文にする(falseで禁止する)
313
- # externallink: true
314
- #
315
- # epubmaker:階層を使うものはここまで
316
-
317
- # LaTeX用のスタイルファイル(styディレクトリ以下に置くこと)
318
- texstyle: [reviewmacro, starter, mytitlepage, mycolophon, mystyle]
319
- #
320
- # LaTeX用のdocumentclassを指定する
321
- # texdocumentclass: ["jsbook", "uplatex,oneside"]
322
- # 用紙サイズとフォントサイズは config-starter.yml で指定するので、'a5j' や '9pt' などは指定しないこと
323
- texdocumentclass: ["jsbook",
324
- #"dvipdfmx,uplatex,papersize,twoside,openright" # 右起こし
325
- #"dvipdfmx,uplatex,papersize,twoside,openany" # 両起こし
326
- #"dvipdfmx,uplatex,papersize,oneside,openany" # 両起こし(タブレット向け)
327
- "dvipdfmx,uplatex,papersize,twoside,openright"
328
- ]
329
- #
330
- # LaTeX用のコマンドを指定する
331
- texcommand: uplatex
332
- #
333
- # LaTeXのコマンドに渡すオプションを指定する
334
- # texoptions: null
335
- texoptions: "-halt-on-error -file-line-error" # エラー時にインタラクティブモードにしない、エラー箇所はファイル名つきで表示
336
- #
337
- # LaTeX用のdvi変換コマンドを指定する(dvipdfmx)
338
- dvicommand: dvipdfmx
339
- #
340
- # LaTeX用のdvi変換コマンドのオプションを指定する
341
- dvioptions: "-q -d 5 -z 3" # -z 9 だと画像を最大圧縮する(ただし時間がかかる)
342
-
343
- # 以下のパラメータを有効にするときには、
344
- # pdfmaker:
345
- # パラメータ: 値
346
- # パラメータ: 値
347
- # ...
348
- # という構成にする必要がある(インデントさせる)
349
- #
350
- pdfmaker:
351
- #
352
- # TeXコンパイル前に実行するプログラム。変換後のTeXソースを調整したいときに使用する。
353
- # 渡される引数1=作業用展開ディレクトリ、引数2=呼び出しを実行したディレクトリ
354
- # hook_beforetexcompile: null
355
- hook_beforetexcompile: [lib/hooks/beforetexcompile.rb]
356
- #
357
- # TeXコンパイル後に実行するプログラム。索引作業をして再度コンパイルしたいときなどに使用する。
358
- # 渡される引数1=作業用展開ディレクトリ、引数2=呼び出しを実行したディレクトリ
359
- # hook_aftertexcompile: null
360
- #
361
- # PDF(book.pdf)作成後に実行するプログラム。PDFに加工を施したいときに使用する。
362
- # 渡される引数1=作業用展開ディレクトリ、引数2=呼び出しを実行したディレクトリ
363
- # hook_afterdvipdf: null
364
- #
365
- # 画像のscale=X.Xという指定を画像拡大縮小率からページ最大幅の相対倍率に変換します。
366
- # image_scale2width: true
367
- #
368
- # 索引
369
- makeindex: # true なら本の巻末に索引をつける
370
- # 索引作成コマンドの設定
371
- makeindex_command: upmendex # 索引を生成するコマンド(デフォルト値:mendex)
372
- makeindex_options: "-q -g" # 索引見出しを「あ か さ た な は …」にする
373
- #makeindex_options: "-q" # 索引見出しを「あ い う え お か …」にする
374
- #makeindex_options: "-f -r -I utf8" # (参考:Re:VIEWでのデフォルト値)
375
- makeindex_sty: sty/indexstyle.ist # スタイルファイル
376
- makeindex_dic: data/terms.txt # 用語の読み仮名が書かれたファイル
377
- makeindex_mecab: false # 読み仮名を形態素解析で自動取得するか?
378
- makeindex_mecab_opts: "-Oyomi" # 形態素解析エンジン「MeCab」のオプション
379
- #
380
- # 奥付を作成するか。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
381
- colophon: true
382
- #
383
- # 表紙に配置し、書籍の影絵にも利用する画像ファイル。同人誌の印刷では一般的に、表紙は本文と別ファイルにするので、ここはnullにする。
384
- #coverimage: null
385
- #
386
- ### 【注意】次の設定項目は config-starter.yml に移動し、項目名も変わりました。
387
- ### ・coverpdf_files: => frontcover_pdffile:
388
- ### ・backcoverpdf_files: => backcover_pdffile:
389
- ### ・coverpdf_option: => includepdf_option:
390
- #
391
- # pdfmaker:階層を使うものはここまで
392
-
393
- ## @<chapref>{} や @<hd>{} で、章(Chapter)や節(Section)へのリンクを作成
394
- ## (Re:VIEW の機能だがドキュメントには未記載?)
395
- chapterlink: true
396
-
397
-
398
- ## Webページ用の設定
399
- webmaker:
400
- htmlext: html # HTMLファイルの拡張子
401
- htmlversion: 5 # HTMLのバージョン
402
- stylesheet: # 「css」フォルダ内のCSSファイル
403
- - normalize.css
404
- - webstyle.css