review-retrovert 0.3.1 → 0.9.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/retrovert.yml +61 -0
- data/.gitignore +2 -2
- data/.ruby-version +1 -0
- data/Dockerfile +1 -1
- data/Gemfile +1 -0
- data/Gemfile.lock +82 -17
- data/README.md +6 -3
- data/lib/review/retrovert/cli.rb +4 -0
- data/lib/review/retrovert/converter.rb +375 -9
- data/lib/review/retrovert/version.rb +1 -1
- data/lib/review/retrovert/yamlconfig.rb +13 -1
- data/review-retrovert.gemspec +2 -2
- data/testdata/mybook/.gitignore +7 -0
- data/testdata/mybook/README.md +43 -0
- data/testdata/mybook/Rakefile +16 -0
- data/testdata/mybook/catalog.yml +33 -0
- data/testdata/mybook/config-starter.yml +139 -0
- data/testdata/mybook/config.yml +375 -0
- data/testdata/mybook/contents/00-preface.re +83 -0
- data/testdata/mybook/contents/01-install.re +272 -0
- data/testdata/mybook/contents/02-tutorial.re +1008 -0
- data/testdata/mybook/contents/03-syntax.re +2613 -0
- data/testdata/mybook/contents/04-customize.re +728 -0
- data/testdata/mybook/contents/05-faq.re +328 -0
- data/testdata/mybook/contents/06-bestpractice.re +971 -0
- data/testdata/mybook/contents/91-compare.re +18 -0
- data/testdata/mybook/contents/92-filelist.re +119 -0
- data/testdata/mybook/contents/93-background.re +267 -0
- data/testdata/mybook/contents/99-postface.re +38 -0
- data/testdata/mybook/css/normalize.css +349 -0
- data/testdata/mybook/css/webstyle.css +514 -0
- data/testdata/mybook/images/03-syntax/favicon-16x16.png +0 -0
- data/testdata/mybook/images/03-syntax/figure_heretop.png +0 -0
- data/testdata/mybook/images/03-syntax/tw-icon1.jpg +0 -0
- data/testdata/mybook/images/03-syntax/tw-icon2.jpg +0 -0
- data/testdata/mybook/images/03-syntax/tw-icon3.jpg +0 -0
- data/testdata/mybook/images/03-syntax/tw-icon4.jpg +0 -0
- data/testdata/mybook/images/04-customize/caption_pagebreak.png +0 -0
- data/testdata/mybook/images/04-customize/chaptitlepage_sample.png +0 -0
- data/testdata/mybook/images/05-faq/codeblock_rpadding1.png +0 -0
- data/testdata/mybook/images/05-faq/codeblock_rpadding2.png +0 -0
- data/testdata/mybook/images/06-bestpractice/figure_heretop.png +0 -0
- data/testdata/mybook/images/06-bestpractice/font_beramono.png +0 -0
- data/testdata/mybook/images/06-bestpractice/heading_design1.png +0 -0
- data/testdata/mybook/images/06-bestpractice/heading_design2.png +0 -0
- data/testdata/mybook/images/06-bestpractice/margin_book.png +0 -0
- data/testdata/mybook/images/06-bestpractice/multiline-title.png +0 -0
- data/testdata/mybook/images/06-bestpractice/preface_numbered.png +0 -0
- data/testdata/mybook/images/06-bestpractice/program_border.png +0 -0
- data/testdata/mybook/images/06-bestpractice/sechead_design_4.png +0 -0
- data/testdata/mybook/images/06-bestpractice/titlepage-samples.png +0 -0
- data/testdata/mybook/images/93-background/bug913.png +0 -0
- data/testdata/mybook/images/93-background/slide2.png +0 -0
- data/testdata/mybook/images/cover_a5.pdf +0 -0
- data/testdata/mybook/images/cover_b5.pdf +0 -0
- data/testdata/mybook/images/tw-icon.jpg +0 -0
- data/testdata/mybook/layouts/layout.epub.erb +29 -0
- data/testdata/mybook/layouts/layout.html5.erb +106 -0
- data/testdata/mybook/layouts/layout.tex.erb +546 -0
- data/testdata/mybook/lib/hooks/beforetexcompile.rb +55 -0
- data/testdata/mybook/lib/ruby/review-builder.rb +503 -0
- data/testdata/mybook/lib/ruby/review-cli.rb +58 -0
- data/testdata/mybook/lib/ruby/review-compiler.rb +523 -0
- data/testdata/mybook/lib/ruby/review-epubmaker.rb +606 -0
- data/testdata/mybook/lib/ruby/review-htmlbuilder.rb +661 -0
- data/testdata/mybook/lib/ruby/review-latexbuilder.rb +782 -0
- data/testdata/mybook/lib/ruby/review-maker.rb +235 -0
- data/testdata/mybook/lib/ruby/review-monkeypatch.rb +91 -0
- data/testdata/mybook/lib/ruby/review-pdfmaker.rb +468 -0
- data/testdata/mybook/lib/ruby/review-textbuilder.rb +36 -0
- data/testdata/mybook/lib/ruby/review-tocparser.rb +285 -0
- data/testdata/mybook/lib/ruby/review-webmaker.rb +433 -0
- data/testdata/mybook/lib/tasks/mytasks.rake +31 -0
- data/testdata/mybook/lib/tasks/review.rake +142 -0
- data/testdata/mybook/lib/tasks/review.rake.orig +72 -0
- data/testdata/mybook/lib/tasks/starter.rake +326 -0
- data/testdata/mybook/locale.yml +6 -0
- data/testdata/mybook/review-ext.rb +206 -0
- data/testdata/mybook/sty/jumoline.sty +310 -0
- data/testdata/mybook/sty/mycolophon.sty +81 -0
- data/testdata/mybook/sty/mystyle.sty +8 -0
- data/testdata/mybook/sty/mytextsize.sty +61 -0
- data/testdata/mybook/sty/mytitlepage.sty +103 -0
- data/testdata/mybook/sty/reviewmacro.sty +60 -0
- data/testdata/mybook/sty/starter-codeblock.sty +332 -0
- data/testdata/mybook/sty/starter-color.sty +79 -0
- data/testdata/mybook/sty/starter-font.sty +112 -0
- data/testdata/mybook/sty/starter-heading.sty +514 -0
- data/testdata/mybook/sty/starter-note.sty +127 -0
- data/testdata/mybook/sty/starter-section.sty +262 -0
- data/testdata/mybook/sty/starter-toc.sty +72 -0
- data/testdata/mybook/sty/starter.sty +554 -0
- data/testdata/mybook/style.css +597 -0
- metadata +100 -10
- data/.travis.yml +0 -6
@@ -99,6 +99,18 @@ module ReVIEW
|
|
99
99
|
}
|
100
100
|
end
|
101
101
|
|
102
|
+
def rewrite_yml_array_(yamlfile, key, val)
|
103
|
+
content = File.read(yamlfile)
|
104
|
+
content.gsub!(/^(\s*)#{key}:\s*\[.*?\]/m, '\1' + "#{key}: #{val}")
|
105
|
+
File.write(yamlfile, content)
|
106
|
+
end
|
107
|
+
|
108
|
+
def rewrite_yml_array(key, val)
|
109
|
+
config_files.each { |current_file|
|
110
|
+
rewrite_yml_array_(File.join(@basedir, current_file), key, val)
|
111
|
+
}
|
112
|
+
end
|
113
|
+
|
102
114
|
def rewrite_retrovert_yml()
|
103
115
|
@retrovert_configs.each { |current_file|
|
104
116
|
yamlfile = File.expand_path(current_file, @basedir)
|
@@ -127,4 +139,4 @@ module ReVIEW
|
|
127
139
|
|
128
140
|
end
|
129
141
|
end
|
130
|
-
end
|
142
|
+
end
|
data/review-retrovert.gemspec
CHANGED
@@ -28,6 +28,6 @@ Gem::Specification.new do |spec|
|
|
28
28
|
spec.require_paths = ["lib"]
|
29
29
|
|
30
30
|
spec.add_dependency "thor"
|
31
|
-
spec.
|
32
|
-
|
31
|
+
spec.add_development_dependency "aruba"
|
32
|
+
spec.add_runtime_dependency "review", ['>= 3.2.0']
|
33
33
|
end
|
@@ -0,0 +1,43 @@
|
|
1
|
+
# README
|
2
|
+
|
3
|
+
これは Re:VIEW Starter で生成された、Re:VIEW 用プロジェクトです。
|
4
|
+
|
5
|
+
|
6
|
+
## ユーザーズガイド
|
7
|
+
|
8
|
+
以下のサイトで「ユーザーズガイド」のPDFファイルをダウンロードできます。
|
9
|
+
|
10
|
+
- https://kauplan.org/reviewstarter/
|
11
|
+
|
12
|
+
|
13
|
+
## コンパイル方法
|
14
|
+
|
15
|
+
Docker を使う場合:
|
16
|
+
|
17
|
+
```terminal
|
18
|
+
$ docker pull kauplan/review2.5 # 3GB 以上ダウンロードするので注意
|
19
|
+
$ unzip mybook.zip
|
20
|
+
$ cd mybook/
|
21
|
+
$ docker run --rm -v $PWD:/work -w /work kauplan/review2.5 rake pdf
|
22
|
+
$ ## または rake docker:pdf でもOK
|
23
|
+
$ ls mybook.pdf
|
24
|
+
```
|
25
|
+
|
26
|
+
Docker を使わない場合 (Ruby と Re:VIEW と LaTeX が必要):
|
27
|
+
|
28
|
+
```terminal
|
29
|
+
$ gem install review --version 2.5 # 最初に1回だけ行う(2回目からは不要)
|
30
|
+
$ review version # Re:VIEWのバージョンを確認
|
31
|
+
2.5.0 # (3系は未サポートなので注意!!)
|
32
|
+
$ unzip mybook.zip
|
33
|
+
$ cd mybook/
|
34
|
+
$ rake pdf
|
35
|
+
$ ls mybook.pdf
|
36
|
+
```
|
37
|
+
|
38
|
+
これで「mybook.pdf」が生成されます。
|
39
|
+
|
40
|
+
|
41
|
+
## 問い合わせ
|
42
|
+
|
43
|
+
Twitter でハッシュタグ「#reviewstarter」つきでツイートしてください。
|
@@ -0,0 +1,16 @@
|
|
1
|
+
##
|
2
|
+
## Don't change this file!!
|
3
|
+
## Instead, edit 'lib/tasks/mytasks.rake' file.
|
4
|
+
##
|
5
|
+
|
6
|
+
Dir.glob('lib/tasks/*.rake').each do |file|
|
7
|
+
load(file)
|
8
|
+
end
|
9
|
+
|
10
|
+
desc "+ list tasks"
|
11
|
+
task :help do
|
12
|
+
sh "rake -T"
|
13
|
+
end
|
14
|
+
|
15
|
+
task(:default).clear
|
16
|
+
task :default => (ENV['RAKE_DEFAULT'] || :help)
|
@@ -0,0 +1,33 @@
|
|
1
|
+
PREDEF:
|
2
|
+
- 00-preface.re
|
3
|
+
|
4
|
+
CHAPS:
|
5
|
+
- 01-install.re
|
6
|
+
- 02-tutorial.re
|
7
|
+
- 03-syntax.re
|
8
|
+
- 04-customize.re
|
9
|
+
- 05-faq.re
|
10
|
+
- 06-bestpractice.re
|
11
|
+
|
12
|
+
APPENDIX:
|
13
|
+
- 91-compare.re
|
14
|
+
- 92-filelist.re
|
15
|
+
- 93-background.re
|
16
|
+
|
17
|
+
POSTDEF:
|
18
|
+
- 99-postface.re
|
19
|
+
|
20
|
+
##
|
21
|
+
## ■Tips
|
22
|
+
## 第I部、第II部、…のように「部」を使うには、「CHAPS:」を次のようにする。
|
23
|
+
##
|
24
|
+
## CHAPS:
|
25
|
+
## - 部タイトル:
|
26
|
+
## - chap01.re
|
27
|
+
## - chap02.re
|
28
|
+
## - 部タイトル:
|
29
|
+
## - chap03.re
|
30
|
+
## - chap04.re
|
31
|
+
##
|
32
|
+
## 「部タイトル」の最後に半角の「:」をつけることに注意。
|
33
|
+
##
|
@@ -0,0 +1,139 @@
|
|
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
|
+
## フォントサイズ
|
22
|
+
## ・A5なら「9pt」、B5なら「10pt」を推奨
|
23
|
+
## ・初心者向け入門書なら大きめにして、A5「10pt」、B5「11pt」を推奨
|
24
|
+
fontsize: 9pt # 9pt or 10pt
|
25
|
+
|
26
|
+
## 本文幅
|
27
|
+
## ・A5 9ptなら「38zw」か「39zw」、A5 10ptなら「35zw」を推奨
|
28
|
+
## ・B5 10ptなら「44zw」か「45zw」、B5 11ptなら「41zw」を推奨
|
29
|
+
textwidth: 38zw # 全角の文字数で指定
|
30
|
+
|
31
|
+
## 本文のフォント(注:実験的)
|
32
|
+
## (Notoフォントが前提なので、Docker環境が必要。MacTeXでは使わないこと)
|
33
|
+
fontfamily_ja: mincho # (日本語) mincho: 明朝体, gothic: ゴシック体
|
34
|
+
fontfamily_en: roman # (英数字) roman: ローマン体, sansserif: サンセリフ体
|
35
|
+
fontweight_ja: normal # (日本語) normal: 通常, light: 細字
|
36
|
+
fontweight_en: normal # (英数字) normal: 通常, light: 細字
|
37
|
+
|
38
|
+
## 章 (Chapter) タイトルの装飾
|
39
|
+
## (none: なし、underline: 下線、boldlines: 上下に太線)
|
40
|
+
chapter_decoration: boldlines
|
41
|
+
|
42
|
+
## 章 (Chapter) タイトルの左寄せ/右寄せ/中央揃え
|
43
|
+
## (left: 左寄せ、right: 右寄せ、center: 中央揃え)
|
44
|
+
chapter_align: center
|
45
|
+
|
46
|
+
## 章 (Chapter) タイトルを1行にする(章番号とタイトルとの間で改行しない)
|
47
|
+
chapter_oneline: false
|
48
|
+
|
49
|
+
## 節 (Section) ごとに改ページするか
|
50
|
+
## (ただし各章の最初の節は改ページしない)
|
51
|
+
section_newpage: false
|
52
|
+
|
53
|
+
## ページ先頭なら節や項のタイトルの前にスペースを入れない
|
54
|
+
## (obsolete: 現在は常にtrue扱い)
|
55
|
+
section_notopmargin: true
|
56
|
+
|
57
|
+
## 節 (Section) タイトルの装飾
|
58
|
+
## (none: なし、underline: 下線、grayback: 灰色の背景色、leftline: 左に縦線, numbox: 節番号を黒背景に)
|
59
|
+
## (節タイトルが長くて二行になる場合は「leftline」または「numbox」がお勧め)
|
60
|
+
section_decoration: grayback
|
61
|
+
|
62
|
+
## 項 (Subsection) タイトルの装飾
|
63
|
+
## (none: なし、symbol: 先頭にクローバー)
|
64
|
+
subsection_decoration: symbol
|
65
|
+
|
66
|
+
## プログラムやターミナルのキャプションを小さくするか?
|
67
|
+
caption_small: false
|
68
|
+
|
69
|
+
## キャプションの見映えをよくするか?
|
70
|
+
caption_pretty: true
|
71
|
+
|
72
|
+
## キャプション直後での改ページを防ぐために、最低限必要とする高さ
|
73
|
+
## (もしキャプション直後での改ページが発生するなら値を増やす。
|
74
|
+
## もし十分なスペースがあるのに改ページされるなら値を減らす。)
|
75
|
+
caption_needspace: 4.6zh # 全角文字4.6個分の高さ(実験で得た境界値)
|
76
|
+
|
77
|
+
## プログラム(//list)のフォントサイズ
|
78
|
+
program_fontsize: normal # 'normal' or 'small'
|
79
|
+
|
80
|
+
## ターミナル(//cmd, //terminal)のフォントサイズ
|
81
|
+
terminal_fontsize: normal # 'normal' or 'small'
|
82
|
+
|
83
|
+
## プログラム用(//list)の等幅フォント。
|
84
|
+
## * lmodern … LaTeXのデフォルト。1とl、0とOが見分けにくい。太字が目立たない。
|
85
|
+
## * lmodern-lighttt … lmodernを細字にしたもの。太字が目立つ。
|
86
|
+
## * courier … 文字が細いので太字が目立つ。1とl、0とOが見分けにくい。文字幅が広い。
|
87
|
+
## * beramono … 1とl、0とOが見分けやすい。「'」と「`」が見分けにくい。
|
88
|
+
## * inconsolata … 1とl、0とOが見分けやすい。文字幅が少し狭い。
|
89
|
+
## * inconsolata-narrow … inconsolataの文字幅をさらに狭めたもの。英数字と日本語の文字幅が約1:2。
|
90
|
+
program_ttfont: beramono
|
91
|
+
|
92
|
+
## ターミナル用(//terminal、//cmd)の等幅フォント。
|
93
|
+
## 使用できるフォント名はプログラム用と同じ。
|
94
|
+
## ただしinconsolataとinconsolata-narrow、lmodernとlmodern-lightttは互いに排他的。
|
95
|
+
## たとえばプログラム用でinconsolataを使いつつターミナル用でinconsolata-narrowを
|
96
|
+
## 使う、といったことはできない(どちらもinconsolata-narrowになる)。
|
97
|
+
terminal_ttfont: inconsolata
|
98
|
+
|
99
|
+
## プログラム(//list)の表示幅をほんの少しだけ広げる。
|
100
|
+
## 折返し記号が右端まで届かず、あともう1文字入りそうなときに使う。
|
101
|
+
## 詳細は https://twitter.com/_kauplan/status/1162167825407963137
|
102
|
+
program_widen: 0.0mm # 0.3mmとか
|
103
|
+
|
104
|
+
## ターミナル(//terminal, //cmd)の表示幅をほんの少しだけ広げる。
|
105
|
+
## 折返し記号が右端まで届かず、あともう1文字入りそうなときに使う。
|
106
|
+
## 詳細は https://twitter.com/_kauplan/status/1162167825407963137
|
107
|
+
terminal_widen: 0.0mm # 0.3mmとか
|
108
|
+
|
109
|
+
## プログラム(//list)を枠で囲むか?
|
110
|
+
program_border: true
|
111
|
+
|
112
|
+
## ターミナル(//terminal, //cmd)を枠で囲むか?
|
113
|
+
terminal_border: false
|
114
|
+
|
115
|
+
## 文章中の「@<code>{...}」の背景色を薄いグレーにするか?
|
116
|
+
inlinecode_gray: false
|
117
|
+
|
118
|
+
## 奥付 (Colophon) に「powered by Re:VIEW Starter」と入れるか?
|
119
|
+
colophon_poweredby: true
|
120
|
+
|
121
|
+
## 画像が現在位置に入りきらず次ページに送られたとき、後続のテキストを現在位置に
|
122
|
+
## 流し込むかどうか。流し込まないと現在位置に大きなスペースができてしまう。
|
123
|
+
## またLaTeXの位置指定(t:top, b:bottom, p:page)も指定可能。
|
124
|
+
#image_position: H # 現在位置にスペースが空く(要float.sty)
|
125
|
+
image_position: h # 現在位置に後続テキストを流し込む
|
126
|
+
|
127
|
+
## (obsolete、現在では常にtrue扱い)
|
128
|
+
## 十分なスペースがあるのに節や項のタイトル直前で改ページされるのを避ける。
|
129
|
+
## (LaTeXのデフォルトでは、ページ最下部の段落が最初の1行だけになるのを嫌う。
|
130
|
+
## そのため、節(Section)のタイトル直後が1行だけで改ページされるくらいなら
|
131
|
+
## 節タイトルの直前で改ページすることをLaTeXは選ぶ。
|
132
|
+
## このせいで、十分な空きがあるのに節タイトル前で改ページされることがある。)
|
133
|
+
page_clubline: true # trueなら改ページを避ける
|
134
|
+
|
135
|
+
## リンクのURLを脚注に埋め込む(PDFでのみ)。
|
136
|
+
linkurl_footnote: true # trueならリンクのURLを脚注に埋め込む(お勧め)
|
137
|
+
|
138
|
+
## @<secref>{}において、親の節のタイトルを含めるか?
|
139
|
+
secref_parenttitle: false # trueなら親の節のタイトルを含める
|
@@ -0,0 +1,375 @@
|
|
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"]
|
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
|
+
# 以下はオプション
|
40
|
+
# 以下はオプション(autと同じように配列書式で複数指定可能)。
|
41
|
+
# 読みの指定はaut:の例を参照。
|
42
|
+
# a-が付いているものはcreator側、
|
43
|
+
# 付いていないものはcontributor側(二次協力者)に入る
|
44
|
+
# a-adp, adp: 異なるメディア向けに作り直した者
|
45
|
+
# a-ann, ann: 注釈記述者
|
46
|
+
# a-arr, arr: アレンジした者
|
47
|
+
# a-art, art: グラフィックデザインおよび芸術家
|
48
|
+
# a-asn, asn: 関連・かつての所有者・関係者
|
49
|
+
# a-aqt, aqt: 大きく引用された人物
|
50
|
+
# a-aft, aft: 後書き・奥付の責任者
|
51
|
+
# a-aui, aui: 序論・序文・前書きの責任者
|
52
|
+
# a-ant, ant: 目録責任者
|
53
|
+
# a-bkp, bkp: メディア制作責任者
|
54
|
+
# a-clb, clb: 限定参加または補足者
|
55
|
+
# a-cmm, cmm: 解釈・分析・考察者
|
56
|
+
# a-csl, csl: 監修者
|
57
|
+
# a-dsr, dsr: デザイナ
|
58
|
+
# a-edt, edt: 編集者
|
59
|
+
# a-ill, ill: イラストレータ
|
60
|
+
# a-lyr, lyr: 歌詞作成者
|
61
|
+
# a-mdc, mdc: メタデータセットの一次的責任者
|
62
|
+
# a-mus, mus: 音楽家
|
63
|
+
# a-nrt, nrt: 語り手
|
64
|
+
# a-oth, oth: その他
|
65
|
+
# a-pht, pht: 撮影責任者
|
66
|
+
# a-pbl, pbl: 出版社(発行所)
|
67
|
+
# a-prt, prt: 印刷所
|
68
|
+
prt: ○○印刷所
|
69
|
+
# a-red, red: 項目の枠組起草者
|
70
|
+
# a-rev, rev: 評論者
|
71
|
+
# a-spn, spn: 援助者
|
72
|
+
# a-ths, ths: 監督者
|
73
|
+
# a-trc, trc: 筆記・タイプ作業者
|
74
|
+
# a-trl, trl: 翻訳者
|
75
|
+
|
76
|
+
# 刊行日(省略した場合は実行時の日付)
|
77
|
+
date: 2020-02-29
|
78
|
+
# 発行年月。YYYY-MM-DD形式による配列指定。省略した場合はdateを使用する
|
79
|
+
# 複数指定する場合は次のように記述する
|
80
|
+
# [["初版第1刷の日付", "初版第2刷の日付"], ["第2版第1刷の日付"]]
|
81
|
+
# 日付の後ろを空白文字で区切り、任意の文字列を置くことも可能。
|
82
|
+
history: [["2020-02-29 ver 1.0"]]
|
83
|
+
# [experimental] 新刊を頒布したイベント名(例:「技術書典6(2019年春)新刊」)
|
84
|
+
pubevent_name: 技術書典8(2020年春)新刊
|
85
|
+
# 権利表記(配列で複数指定可)
|
86
|
+
rights: (C) 2020 カウプラン機関極東支部
|
87
|
+
# description: 説明
|
88
|
+
# subject: 短い説明用タグ(配列で複数指定可)
|
89
|
+
# type: 書籍のカテゴリーなど(配列で複数指定可)
|
90
|
+
# format: メディアタイプおよび特徴(配列で複数指定可)
|
91
|
+
# source: 出版物生成の重要なリソース情報(配列で複数指定可)
|
92
|
+
# relation: 補助的リソース(配列で複数指定可)
|
93
|
+
# coverage: 内容の範囲や領域(配列で複数指定可)
|
94
|
+
|
95
|
+
# デバッグフラグ。nullでないときには一時ファイルをカレントディレクトリに作成し、削除もしない
|
96
|
+
debug: true
|
97
|
+
|
98
|
+
# 固有IDに使用するドメイン。指定しない場合には、時刻に基づくランダムUUIDが入る
|
99
|
+
# urnid: urn:uid:http://example.com/book-title/
|
100
|
+
#
|
101
|
+
# ISBN。省略した場合はurnidが入る
|
102
|
+
# isbn: null
|
103
|
+
#
|
104
|
+
# HTMLファイルの拡張子(省略した場合はhtml)
|
105
|
+
# htmlext: html
|
106
|
+
#
|
107
|
+
# CSSファイル(配列で複数指定可)
|
108
|
+
stylesheet: ["style.css"]
|
109
|
+
|
110
|
+
# ePUBのバージョン (2か3)
|
111
|
+
# epubversion: 2
|
112
|
+
#
|
113
|
+
# HTMLのバージョン (4か5。epubversionを3にしたときには5にする)
|
114
|
+
# htmlversion: 4
|
115
|
+
|
116
|
+
# 目次として抽出する見出しレベル
|
117
|
+
toclevel: 3 # (部と)章と節と項(小節)を目次に載せる
|
118
|
+
|
119
|
+
# 採番の設定。採番させたくない見出しには「==[nonum]」のようにnonum指定をする
|
120
|
+
#
|
121
|
+
# 本文でセクション番号を表示する見出しレベル
|
122
|
+
secnolevel: 2 # 章 (Chapter) と節 (Section) にだけ番号をつける
|
123
|
+
#secnolevel: 3 # 項 (Subsection) にも番号をつける
|
124
|
+
|
125
|
+
# 以下のsecnolevelはまだ未実装。
|
126
|
+
# 前付でセクション番号を表示する見出しレベル(未実装)
|
127
|
+
# pre_secnolevel: 0
|
128
|
+
#
|
129
|
+
# 後付(付録)でセクション番号を表示する見出しレベル(未実装)
|
130
|
+
# post_secnolevel: 1
|
131
|
+
#
|
132
|
+
# 部番号を表示する見出しレベル(未実装)
|
133
|
+
# part_secnolevel: 1
|
134
|
+
|
135
|
+
# 本文中に目次ページを作成するか。省略した場合はnull (作成しない)
|
136
|
+
toc: true
|
137
|
+
|
138
|
+
# EPUB2標準の目次(NCX)以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
|
139
|
+
# ePUB3においてはこの設定によらず必ず作成される
|
140
|
+
# mytoc: true
|
141
|
+
|
142
|
+
# 表紙にするHTMLファイル。ファイル名を指定すると表紙として入る
|
143
|
+
# cover: null
|
144
|
+
#
|
145
|
+
# 表紙に配置し、書籍の影絵にも利用する画像ファイル。省略した場合はnull (画像を使わない)。画像ディレクトリ内に置いてもディレクトリ名は不要(例: cover.jpg)
|
146
|
+
#coverimage: cover.jpg
|
147
|
+
#
|
148
|
+
# 表紙の後に大扉ページを作成するか。省略した場合はtrue (作成する)
|
149
|
+
titlepage: true
|
150
|
+
#
|
151
|
+
# 自動生成される大扉ページを上書きするファイル。ファイル名を指定すると大扉として入る (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
|
152
|
+
# titlefile: null
|
153
|
+
#
|
154
|
+
# 原書大扉ページにするHTMLファイル。ファイル名を指定すると原書大扉として入る (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
|
155
|
+
# originaltitlefile: null
|
156
|
+
#
|
157
|
+
# 権利表記ページファイル。ファイル名を指定すると権利表記として入る (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
|
158
|
+
# creditfile: null
|
159
|
+
|
160
|
+
# 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
|
161
|
+
# colophon: null
|
162
|
+
|
163
|
+
# 裏表紙データファイル (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
|
164
|
+
# backcover: null
|
165
|
+
|
166
|
+
# プロフィールページファイル (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)。ファイル名を指定すると著者紹介として入る
|
167
|
+
# profile: null
|
168
|
+
# プロフィールページの目次上の見出し
|
169
|
+
# profiletitle: 著者紹介
|
170
|
+
|
171
|
+
# 広告ファイル。ファイル名を指定すると広告として入る (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
|
172
|
+
# advfile: null
|
173
|
+
|
174
|
+
# 取り込む画像が格納されているディレクトリ。省略した場合は以下
|
175
|
+
# imagedir: images
|
176
|
+
|
177
|
+
# 取り込むフォントが格納されているディレクトリ。省略した場合は以下
|
178
|
+
# fontdir: fonts
|
179
|
+
|
180
|
+
# imagedir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
|
181
|
+
# image_ext: ["png", "gif", "jpg", "jpeg", "svg", "ttf", "woff", "otf"]
|
182
|
+
|
183
|
+
# fontdir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
|
184
|
+
# font_ext: ["ttf", "woff", "otf"]
|
185
|
+
|
186
|
+
# ソースコードハイライトを利用する (rouge,pygmentsには外部gemが必要)
|
187
|
+
# highlight:
|
188
|
+
# html: "rouge"
|
189
|
+
# latex: "listings"
|
190
|
+
|
191
|
+
# カタログファイル名を指定する
|
192
|
+
# catalogfile: catalog.yml
|
193
|
+
|
194
|
+
# reファイルを格納するディレクトリ。デフォルト値は null。
|
195
|
+
# 値にたとえば「contents」を指定すると、reファイルはすべて「contents」
|
196
|
+
# ディレクトリに置かなければならず、カレントディレクトリには一切置いては
|
197
|
+
# ならない。
|
198
|
+
# contentdir: null
|
199
|
+
contentdir: contents
|
200
|
+
|
201
|
+
# 1ページの行数文字数と1kbごとのページ数を用紙サイズで指定する(A5 or B5)。
|
202
|
+
# page_metric: A5
|
203
|
+
#
|
204
|
+
# あるいは、配列で指定することもできる
|
205
|
+
# 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数、1kバイト毎のページ数
|
206
|
+
# page_metric: [40,80,40,80,2]
|
207
|
+
|
208
|
+
# ページ送りの送り方向、page-progression-directionの値("ltr"|"rtl"|"default")
|
209
|
+
# direction: "ltr"
|
210
|
+
|
211
|
+
# EPUBのOPFへの固有の追加ルール
|
212
|
+
# <package>要素に追加する名前空間
|
213
|
+
# opf_prefix: {ebpaj: "http://www.ebpaj.jp/"}
|
214
|
+
# 追加する<meta>要素のプロパティとその値
|
215
|
+
# opf_meta: {"ebpaj:guide-version": "1.1.3"}
|
216
|
+
|
217
|
+
# 以下のパラメータを有効にするときには、
|
218
|
+
# epubmaker:
|
219
|
+
# パラメータ: 値
|
220
|
+
# パラメータ: 値
|
221
|
+
# ...
|
222
|
+
# という構成にする必要がある(インデントさせる)
|
223
|
+
|
224
|
+
epubmaker:
|
225
|
+
# HTMLファイルの拡張子
|
226
|
+
htmlext: xhtml
|
227
|
+
#
|
228
|
+
# 目次を要素の階層表現にしない。省略した場合(null)は階層化する。
|
229
|
+
# 特に部扉が入るなどの理由で、構成によっては階層化目次でepubcheckに
|
230
|
+
# パスしない目次ができるが、そのようなときにはこれをtrueにする
|
231
|
+
# flattoc: null
|
232
|
+
#
|
233
|
+
# 目次のインデントレベルをスペース文字で表現する(flattocがtrueのときのみ)
|
234
|
+
# flattocindent: true
|
235
|
+
#
|
236
|
+
# NCX目次の見出しレベルごとの飾り(配列で設定)。EPUB3ではNCXは作られない
|
237
|
+
# ncxindent:
|
238
|
+
#-
|
239
|
+
#- -
|
240
|
+
# フックは、各段階で介入したいときのプログラムを指定する。自動で適切な引数が渡される
|
241
|
+
# プログラムには実行権限が必要
|
242
|
+
# ファイル変換処理の前に実行するプログラム。スタイルシートのコンパイルをしたいときなどに利用する。
|
243
|
+
# 渡される引数1=作業用展開ディレクトリ
|
244
|
+
# hook_beforeprocess: null
|
245
|
+
#
|
246
|
+
# 前付の作成後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
|
247
|
+
# 渡される引数1=作業用展開ディレクトリ
|
248
|
+
# hook_afterfrontmatter: null
|
249
|
+
#
|
250
|
+
# 本文の変換後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
|
251
|
+
# 渡される引数1=作業用展開ディレクトリ
|
252
|
+
# hook_afterbody: null
|
253
|
+
#
|
254
|
+
# 後付の作成後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
|
255
|
+
# 渡される引数1=作業用展開ディレクトリ
|
256
|
+
# hook_afterbackmatter: null
|
257
|
+
#
|
258
|
+
# 画像およびフォントをコピーした後に実行するプログラム。別の画像やフォントを追加したいときなどに利用する。
|
259
|
+
# 渡される引数1=作業用展開ディレクトリ
|
260
|
+
# hook_aftercopyimage: null
|
261
|
+
#
|
262
|
+
# ePUB zipアーカイブ直前に実行するプログラム。メタ情報などを加工したいときなどに利用する。
|
263
|
+
# 渡される引数1=ePUB準備ディレクトリ
|
264
|
+
# hook_prepack: null
|
265
|
+
#
|
266
|
+
# 変換したHTMLファイルおよびCSSを解析して厳密に使用している画像ファイルだけを取り込むか。デフォルトはnull(imagesディレクトリすべてを取り込む)
|
267
|
+
# なお、フォント、カバー、広告についてはこの設定によらずディレクトリ内のものがすべて取り込まれる
|
268
|
+
# verify_target_images: null
|
269
|
+
#
|
270
|
+
# verify_target_imagesがtrueの状態において、解析で発見されなくても強制的に取り込むファイルの相対パスの配列
|
271
|
+
# force_include_images: []
|
272
|
+
#
|
273
|
+
# 画像ファイルの縦x横の最大ピクセル数許容値
|
274
|
+
# image_maxpixels: 4000000
|
275
|
+
#
|
276
|
+
# Re:VIEWファイル名を使わず、前付にpre01,pre02...、本文にchap01,chap02l...、後付にpost01,post02...という名前付けルールにするか
|
277
|
+
# rename_for_legacy: null
|
278
|
+
#
|
279
|
+
# ePUBアーカイブの非圧縮実行
|
280
|
+
# zip_stage1: "zip -0Xq"
|
281
|
+
#
|
282
|
+
# ePUBアーカイブの圧縮実行
|
283
|
+
# zip_stage2: "zip -Xr9Dq"
|
284
|
+
#
|
285
|
+
# ePUBアーカイブに追加するパス(デフォルトはmimetype、META-INF、OEBPS)
|
286
|
+
# zip_addpath: null
|
287
|
+
#
|
288
|
+
# EPUBで表紙をコンテンツに含めるか。デフォルトでは作成されない。yesにするとiBooks等でも最初に表紙が表示されるようになる
|
289
|
+
# cover_linear: null
|
290
|
+
#
|
291
|
+
# @<href>タグでの外部リンクを禁止し、地の文にする(falseで禁止する)
|
292
|
+
# externallink: true
|
293
|
+
#
|
294
|
+
# epubmaker:階層を使うものはここまで
|
295
|
+
|
296
|
+
# LaTeX用のスタイルファイル(styディレクトリ以下に置くこと)
|
297
|
+
texstyle: [reviewmacro, starter, mystyle, mytitlepage, mycolophon]
|
298
|
+
#
|
299
|
+
# LaTeX用のdocumentclassを指定する
|
300
|
+
# texdocumentclass: ["jsbook", "uplatex,oneside"]
|
301
|
+
# 用紙サイズとフォントサイズは config-starter.yml で指定するので、'a5j' や '9pt' などは指定しないこと
|
302
|
+
texdocumentclass: ["jsbook",
|
303
|
+
#"dvipdfmx,uplatex,papersize,twoside,openright" # 右起こし
|
304
|
+
#"dvipdfmx,uplatex,papersize,twoside,openany" # 両起こし
|
305
|
+
#"dvipdfmx,uplatex,papersize,oneside,openany" # 両起こし(タブレット向け)
|
306
|
+
"dvipdfmx,uplatex,papersize,twoside,openright"
|
307
|
+
]
|
308
|
+
#
|
309
|
+
# LaTeX用のコマンドを指定する
|
310
|
+
texcommand: uplatex
|
311
|
+
#
|
312
|
+
# LaTeXのコマンドに渡すオプションを指定する
|
313
|
+
# texoptions: null
|
314
|
+
texoptions: "-halt-on-error -file-line-error" # エラー時にインタラクティブモードにしない、エラー箇所はファイル名つきで表示
|
315
|
+
#
|
316
|
+
# LaTeX用のdvi変換コマンドを指定する(dvipdfmx)
|
317
|
+
dvicommand: dvipdfmx
|
318
|
+
#
|
319
|
+
# LaTeX用のdvi変換コマンドのオプションを指定する
|
320
|
+
dvioptions: "-d 5 -z 3" # -z 9 だと画像を最大圧縮する(ただし時間がかかる)
|
321
|
+
|
322
|
+
# 以下のパラメータを有効にするときには、
|
323
|
+
# pdfmaker:
|
324
|
+
# パラメータ: 値
|
325
|
+
# パラメータ: 値
|
326
|
+
# ...
|
327
|
+
# という構成にする必要がある(インデントさせる)
|
328
|
+
#
|
329
|
+
pdfmaker:
|
330
|
+
#
|
331
|
+
# TeXコンパイル前に実行するプログラム。変換後のTeXソースを調整したいときに使用する。
|
332
|
+
# 渡される引数1=作業用展開ディレクトリ、引数2=呼び出しを実行したディレクトリ
|
333
|
+
# hook_beforetexcompile: null
|
334
|
+
hook_beforetexcompile: [lib/hooks/beforetexcompile.rb]
|
335
|
+
#
|
336
|
+
# TeXコンパイル後に実行するプログラム。索引作業をして再度コンパイルしたいときなどに使用する。
|
337
|
+
# 渡される引数1=作業用展開ディレクトリ、引数2=呼び出しを実行したディレクトリ
|
338
|
+
# hook_aftertexcompile: null
|
339
|
+
#
|
340
|
+
# PDF(book.pdf)作成後に実行するプログラム。PDFに加工を施したいときに使用する。
|
341
|
+
# 渡される引数1=作業用展開ディレクトリ、引数2=呼び出しを実行したディレクトリ
|
342
|
+
# hook_afterdvipdf: null
|
343
|
+
#
|
344
|
+
# 画像のscale=X.Xという指定を画像拡大縮小率からページ最大幅の相対倍率に変換します。
|
345
|
+
# image_scale2width: true
|
346
|
+
#
|
347
|
+
# 奥付を作成するか。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
|
348
|
+
colophon: true
|
349
|
+
#
|
350
|
+
# 表紙に配置し、書籍の影絵にも利用する画像ファイル。同人誌の印刷では一般的に、表紙は本文と別ファイルにするので、ここはnullにする。
|
351
|
+
#coverimage: null
|
352
|
+
### Starterでは、表紙をPDFで用意してください。電子用PDFでのみ挿入されます。
|
353
|
+
### ・デフォルトでは印刷用PDFファイルが生成させるので挿入されません。
|
354
|
+
### ・config-starter.ymlで「target: ebook」を設定するか、または
|
355
|
+
### 環境変数「STARTER_TARGET=ebook」を設定すると電子用になり、
|
356
|
+
### 表紙PDFが挿入されます。
|
357
|
+
### ・表紙用PDFファイルは images/ フォルダ直下に置いてください。
|
358
|
+
coverpdf_files: [cover_a5.pdf] # PDFファイル名(複数指定可)(PNGやJPGはダメ)
|
359
|
+
backcoverpdf_files: [] # 裏表紙のPDFファイル名(複数指定可)(PNGやJPGはダメ)
|
360
|
+
coverpdf_option: "offset=-2.3mm 2.3mm" # 必要に応じて微調整すること
|
361
|
+
#
|
362
|
+
# pdfmaker:階層を使うものはここまで
|
363
|
+
|
364
|
+
## @<chapref>{} や @<hd>{} で、章(Chapter)や節(Section)へのリンクを作成
|
365
|
+
## (Re:VIEW の機能だがドキュメントには未記載?)
|
366
|
+
chapterlink: true
|
367
|
+
|
368
|
+
|
369
|
+
## Webページ用の設定
|
370
|
+
webmaker:
|
371
|
+
htmlext: html # HTMLファイルの拡張子
|
372
|
+
htmlversion: 5 # HTMLのバージョン
|
373
|
+
stylesheet: # 「css」フォルダ内のCSSファイル
|
374
|
+
- normalize.css
|
375
|
+
- webstyle.css
|