review 2.0.0.beta1 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (150) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +66 -1
  3. data/.rubocop_todo.yml +617 -0
  4. data/.travis.yml +16 -1
  5. data/ChangeLog +48 -0
  6. data/Dockerfile +22 -0
  7. data/Gemfile +0 -1
  8. data/README.md +97 -0
  9. data/Rakefile +10 -11
  10. data/appveyor.yml +9 -0
  11. data/bin/review +46 -0
  12. data/bin/review-check +8 -21
  13. data/bin/review-compile +26 -43
  14. data/bin/review-index +9 -22
  15. data/bin/review-init +21 -25
  16. data/bin/review-preproc +9 -13
  17. data/bin/review-validate +1 -1
  18. data/bin/review-vol +3 -17
  19. data/bin/review-webmaker +15 -0
  20. data/doc/NEWS.ja.md +534 -0
  21. data/doc/NEWS.md +538 -0
  22. data/doc/catalog.ja.md +10 -18
  23. data/doc/catalog.md +5 -9
  24. data/doc/config.yml.sample +319 -0
  25. data/doc/customize_epub.ja.md +42 -0
  26. data/doc/format.ja.md +320 -288
  27. data/doc/format.md +277 -170
  28. data/doc/format_idg.ja.md +82 -175
  29. data/doc/pdfmaker.ja.md +61 -0
  30. data/doc/pdfmaker.md +65 -0
  31. data/doc/quickstart.ja.md +88 -98
  32. data/doc/quickstart.md +72 -110
  33. data/doc/sample.css +41 -0
  34. data/doc/writing_vertical.ja.md +55 -0
  35. data/doc/writing_vertical.md +5 -0
  36. data/lib/epubmaker/content.rb +3 -3
  37. data/lib/epubmaker/epubcommon.rb +173 -145
  38. data/lib/epubmaker/epubv2.rb +24 -77
  39. data/lib/epubmaker/epubv3.rb +72 -73
  40. data/lib/epubmaker/producer.rb +54 -30
  41. data/lib/lineinput.rb +48 -0
  42. data/lib/review/book.rb +0 -1
  43. data/lib/review/book/base.rb +47 -27
  44. data/lib/review/book/chapter.rb +48 -19
  45. data/lib/review/book/compilable.rb +10 -14
  46. data/lib/review/book/index.rb +10 -19
  47. data/lib/review/book/page_metric.rb +0 -10
  48. data/lib/review/book/part.rb +17 -3
  49. data/lib/review/builder.rb +84 -68
  50. data/lib/review/catalog.rb +5 -1
  51. data/lib/review/compiler.rb +327 -4657
  52. data/lib/review/configure.rb +84 -10
  53. data/lib/review/converter.rb +28 -0
  54. data/lib/review/epubbuilder.rb +1 -1
  55. data/lib/review/epubmaker.rb +142 -158
  56. data/lib/review/ewbbuilder.rb +5 -5
  57. data/lib/review/exception.rb +1 -1
  58. data/lib/review/extentions.rb +1 -1
  59. data/lib/review/extentions/hash.rb +15 -0
  60. data/lib/review/extentions/string.rb +2 -1
  61. data/lib/review/htmlbuilder.rb +364 -348
  62. data/lib/review/htmltoc.rb +44 -0
  63. data/lib/review/htmlutils.rb +12 -6
  64. data/lib/review/i18n.rb +78 -6
  65. data/lib/review/i18n.yml +7 -4
  66. data/lib/review/idgxmlbuilder.rb +226 -267
  67. data/lib/review/latexbuilder.rb +281 -274
  68. data/lib/review/latexutils.rb +56 -49
  69. data/lib/review/makerhelper.rb +8 -4
  70. data/lib/review/markdownbuilder.rb +80 -124
  71. data/lib/review/pdfmaker.rb +197 -138
  72. data/lib/review/preprocessor.rb +16 -67
  73. data/lib/review/template.rb +24 -0
  74. data/lib/review/textbuilder.rb +1 -1
  75. data/lib/review/textutils.rb +18 -24
  76. data/lib/review/tocparser.rb +51 -106
  77. data/lib/review/tocprinter.rb +61 -117
  78. data/lib/review/topbuilder.rb +119 -126
  79. data/lib/review/unfold.rb +2 -2
  80. data/lib/review/version.rb +1 -1
  81. data/lib/review/webmaker.rb +302 -0
  82. data/lib/review/webtocprinter.rb +48 -0
  83. data/lib/review/yamlloader.rb +47 -0
  84. data/review.gemspec +3 -3
  85. data/templates/html/layout-html5.html.erb +17 -0
  86. data/templates/html/layout-xhtml1.html.erb +20 -0
  87. data/{lib/review → templates/latex}/layout.tex.erb +107 -115
  88. data/templates/ncx/epubv2.ncx.erb +11 -0
  89. data/templates/opf/epubv2.opf.erb +21 -0
  90. data/templates/opf/epubv3.opf.erb +18 -0
  91. data/templates/web/html/layout-html5.html.erb +56 -0
  92. data/templates/web/html/layout-xhtml1.html.erb +20 -0
  93. data/templates/xml/container.xml.erb +6 -0
  94. data/test/assets/test.xml.erb +3 -0
  95. data/test/assets/test_template.tex +28 -71
  96. data/test/assets/test_template_backmatter.tex +1 -9
  97. data/test/sample-book/src/Rakefile +12 -3
  98. data/{doc/sample.yml → test/sample-book/src/config-epub2.yml} +92 -147
  99. data/test/sample-book/src/config.yml +40 -154
  100. data/test/sample-book/src/style-web.css +45 -0
  101. data/test/sample-book/src/style.css +23 -1
  102. data/test/test.re +1 -1
  103. data/test/test_book.rb +15 -17
  104. data/test/test_book_chapter.rb +2 -80
  105. data/test/test_book_part.rb +1 -1
  106. data/test/test_builder.rb +28 -6
  107. data/test/test_catalog.rb +17 -0
  108. data/test/test_compiler.rb +14 -59
  109. data/test/test_configure.rb +94 -0
  110. data/test/test_converter.rb +21 -0
  111. data/test/test_epub3maker.rb +155 -3
  112. data/test/test_epubmaker.rb +245 -30
  113. data/test/test_epubmaker_cmd.rb +2 -2
  114. data/test/test_extentions_hash.rb +60 -0
  115. data/test/test_helper.rb +4 -47
  116. data/test/test_htmlbuilder.rb +282 -175
  117. data/test/test_htmltoc.rb +33 -0
  118. data/test/test_i18n.rb +134 -70
  119. data/test/test_idgxmlbuilder.rb +58 -39
  120. data/test/test_latexbuilder.rb +132 -14
  121. data/test/test_lineinput.rb +5 -26
  122. data/test/test_makerhelper.rb +6 -4
  123. data/test/test_markdownbuilder.rb +23 -5
  124. data/test/test_pdfmaker.rb +86 -20
  125. data/test/test_pdfmaker_cmd.rb +1 -3
  126. data/test/test_review_ext.rb +1 -1
  127. data/test/test_template.rb +27 -0
  128. data/test/test_textutils.rb +36 -0
  129. data/test/test_tocparser.rb +25 -0
  130. data/test/test_topbuilder.rb +34 -2
  131. data/test/test_yamlloader.rb +188 -0
  132. metadata +71 -29
  133. data/README.rdoc +0 -81
  134. data/bin/review-epubmaker-legacy +0 -1024
  135. data/doc/ruby-uuid/README +0 -11
  136. data/doc/ruby-uuid/README.ja +0 -34
  137. data/lib/review/compiler/literals_1_8.kpeg +0 -19
  138. data/lib/review/compiler/literals_1_8.rb +0 -432
  139. data/lib/review/compiler/literals_1_9.kpeg +0 -22
  140. data/lib/review/compiler/literals_1_9.rb +0 -435
  141. data/lib/review/extentions/array.rb +0 -25
  142. data/lib/review/htmllayout.rb +0 -41
  143. data/lib/review/inaobuilder.rb +0 -357
  144. data/lib/review/location.rb +0 -24
  145. data/lib/review/node.rb +0 -267
  146. data/lib/review/review.kpeg +0 -724
  147. data/lib/uuid.rb +0 -312
  148. data/rubocop-todo.yml +0 -456
  149. data/test/test_inaobuilder.rb +0 -247
  150. data/test/test_uuid.rb +0 -157
data/templates/web/html/layout-xhtml1.html.erb ADDED
@@ -0,0 +1,20 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xmlns:ops="http://www.idpf.org/2007/ops" xml:lang="<%= @language %>">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
6
+ <meta http-equiv="Content-Style-Type" content="text/css"/>
7
+ <% if @stylesheets.present? %>
8
+ <% @stylesheets.each do |style| %>
9
+ <link rel="stylesheet" type="text/css" href="<%= style %>" />
10
+ <% end %>
11
+ <% end%>
12
+ <meta name="generator" content="Re:VIEW"/>
13
+ <title><%= @title %></title>
14
+ </head>
15
+ <body<%= @body_ext %>>
16
+ <% if @error_messages %><%= @error_messages %><% end %>
17
+ <% if @warning_messages %><%= @warning_messages %><% end %>
18
+ <%= @body %>
19
+ </body>
20
+ </html>
data/templates/xml/container.xml.erb ADDED
@@ -0,0 +1,6 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <container xmlns="urn:oasis:names:tc:opendocument:xmlns:container" version="1.0">
3
+ <rootfiles>
4
+ <rootfile full-path="<%= @opf_path %>" media-type="application/oebps-package+xml" />
5
+ </rootfiles>
6
+ </container>
data/test/assets/test.xml.erb ADDED
@@ -0,0 +1,3 @@
1
+ <test>
2
+ <name><%= @name %></name>
3
+ </test>
data/test/assets/test_template.tex CHANGED
@@ -1,5 +1,5 @@
1
- \documentclass[oneside]{jsbook}
2
- \usepackage[deluxe]{otf}
1
+ \documentclass[uplatex,oneside]{jsbook}
2
+ \usepackage[deluxe,uplatex]{otf}
3
3
  \usepackage[dvipdfmx]{color}
4
4
  \usepackage[dvipdfmx]{graphicx}
5
5
  \usepackage{framed}
@@ -27,24 +27,14 @@
27
27
  \usepackage[top=10zw,bottom=12zw,left=10zw,right=10zw]{geometry}
28
28
  %\usepackage[top=5zw,bottom=5zw,left=1zw,right=1zw]{geometry}
29
29
 
30
-
31
30
  \newcommand{\parasep}{\vspace*{3zh}}
32
31
  \setlength{\footskip}{30pt}
33
32
 
34
- %% Bookmarkの文字化け対策（日本語向け）
35
- \ifnum 46273=\euc"B4C1 % 46273 == 0xB4C1 == 漢(EUC-JP)
36
- \usepackage{atbegshi}%
37
- \AtBeginShipoutFirst{\special{pdf:tounicode EUC-UCS2}}%
38
- %%\AtBeginDvi{\special{pdf:tounicode EUC-UCS2}}%
39
- \else
40
- \usepackage{atbegshi}%
41
- \AtBeginShipoutFirst{\special{pdf:tounicode 90ms-RKSJ-UCS2}}%
42
- %%\AtBeginDvi{\special{pdf:tounicode 90ms-RKSJ-UCS2}}%
43
- \fi
44
-
45
- \usepackage[dvipdfm,bookmarks=true,bookmarksnumbered=true,colorlinks=true,%
33
+ \usepackage[dvipdfmx,bookmarks=true,bookmarksnumbered=true,colorlinks=true,%
46
34
  pdftitle={Re:VIEW Sample Book},%
47
35
  pdfauthor={}]{hyperref}
36
+ % uplatexでのBookmarkの文字化け対策（日本語向け）
37
+ \usepackage[dvipdfmx]{pxjahyper}
48
38
 
49
39
 
50
40
 
@@ -84,8 +74,8 @@
84
74
 
85
75
  \newenvironment{reviewcolumn}{%
86
76
  \begin{framed}
87
- }{%
88
- \end{framed}
77
+ }{%
78
+ \end{framed}
89
79
  \vspace{2zw}}
90
80
 
91
81
  \newcommand{\reviewcolumnhead}[2]{%
@@ -94,6 +84,9 @@
94
84
  \newcommand{\reviewtablecaption}[1]{%
95
85
  \caption{#1}}
96
86
 
87
+ \newcommand{\reviewimgtablecaption}[1]{%
88
+ \caption{#1}\vspace{-3mm}}
89
+
97
90
  \newcommand{\reviewbackslash}[0]{%
98
91
  \textbackslash{}}
99
92
 
@@ -112,39 +105,26 @@
112
105
  \newcommand{\reviewboxcaption}[1]{%
113
106
  \medskip{\small\noindent #1}\vspace*{-1.3zw}}
114
107
 
115
- \newcommand{\reviewimageref}[2]{%
116
- 図 #1}
117
- \newcommand{\reviewtableref}[2]{%
118
- 表 #1}
119
- \newcommand{\reviewlistref}[1]{%
120
- リスト #1}
121
- \newcommand{\reviewbibref}[2]{%
122
- #1}
123
- \newcommand{\reviewcolumnref}[2]{%
124
- コラム #1}
125
- \newcommand{\reviewsecref}[2]{%
126
- #1}
108
+ \newcommand{\reviewimageref}[2]{図 #1}
109
+ \newcommand{\reviewtableref}[2]{表 #1}
110
+ \newcommand{\reviewlistref}[1]{リスト #1}
111
+ \newcommand{\reviewbibref}[2]{#1}
112
+ \newcommand{\reviewcolumnref}[2]{コラム #1}
113
+ \newcommand{\reviewsecref}[2]{#1}
127
114
 
128
115
  \newcommand{\reviewminicolumntitle}[1]{%
129
116
  {\large ■メモ: #1}\\}
130
117
 
131
118
 
132
-
133
119
  \newenvironment{reviewminicolumn}{%
134
120
  \vspace{1.5zw}\begin{screen}}{%
135
121
  \end{screen}\vspace{2zw}}
136
122
 
137
- \newcommand{\reviewkw}[1]{%
138
- \textbf{\textgt{#1}}}
139
-
140
- \newcommand{\reviewami}[1]{%
141
- \mask{#1}{A}}
142
-
143
- \newcommand{\reviewem}[1]{%
144
- \textbf{#1}}
145
-
146
- \newcommand{\reviewstrong}[1]{%
147
- \textbf{#1}}
123
+ \newcommand{\reviewkw}[1]{\textbf{\textgt{#1}}}
124
+ \newcommand{\reviewami}[1]{\mask{#1}{A}}
125
+ \newcommand{\reviewem}[1]{\textbf{#1}}
126
+ \newcommand{\reviewstrong}[1]{\textbf{#1}}
127
+ \newcommand{\reviewunderline}{\Underline}
148
128
 
149
129
  %% @<del> is ignored in LaTeX with default style
150
130
  \newcommand{\reviewstrike}[1]{#1}
@@ -155,19 +135,11 @@
155
135
  %%%% for jumoline.sty:
156
136
  %%\renewcommand{\reviewstrike}[1]{\Middleline{#1}}
157
137
 
158
- \newcommand{\reviewth}[1]{%
159
- \textgt{#1}}
160
-
161
- \newcommand{\reviewtitlefont}[0]{%
162
- \usefont{T1}{phv}{b}{n}\gtfamily}
163
-
164
- \newcommand{\reviewmainfont}[0]{%
165
- }
166
-
167
- \newcommand{\reviewcolophon}[0]{%
168
- \clearpage}
169
- \newcommand{\reviewappendix}[0]{%
170
- \appendix}
138
+ \newcommand{\reviewth}[1]{\textgt{#1}}
139
+ \newcommand{\reviewtitlefont}[0]{\usefont{T1}{phv}{b}{n}\gtfamily}
140
+ \newcommand{\reviewmainfont}[0]{}
141
+ \newcommand{\reviewcolophon}[0]{\clearpage}
142
+ \newcommand{\reviewappendix}[0]{\appendix}
171
143
 
172
144
  \makeatletter
173
145
  %% maxwidth is the original width if it is less than linewidth
@@ -182,17 +154,13 @@
182
154
  \makeatother
183
155
 
184
156
 
185
-
186
157
  \usepackage[T1]{fontenc}
187
158
 
188
159
  \begin{document}
189
160
 
190
161
  \reviewmainfont
191
162
 
192
-
193
-
194
163
  \begin{titlepage}
195
-
196
164
  \thispagestyle{empty}
197
165
  \begin{center}%
198
166
  \mbox{} \vskip5zw
@@ -205,28 +173,22 @@
205
173
 
206
174
  \end{tabular}\par}%
207
175
  \vfill
208
- {\large 2011-01-01 version\hspace{2zw} 発行\par}%
176
+ {\large 2011-01-01 版\hspace{2zw} 発行\par}%
209
177
  \vskip4zw\mbox{}
210
178
  \end{center}%
211
179
  \end{titlepage}
212
180
 
213
-
214
-
215
181
  \renewcommand{\chaptermark}[1]{{}}
216
182
  \frontmatter
217
183
 
218
184
  %%% originaltitle
219
185
 
220
-
221
186
  %%% credit
222
187
 
223
-
224
-
225
188
  %% preface
226
189
 
227
190
 
228
191
 
229
-
230
192
  \renewcommand{\chaptermark}[1]{\markboth{\prechaptername\thechapter\postchaptername~#1}{}}
231
193
  \mainmatter
232
194
 
@@ -235,21 +197,16 @@
235
197
 
236
198
 
237
199
  %% backmatter begins
238
-
239
-
200
+ \backmatter
240
201
 
241
202
 
242
203
 
243
204
  %%% profile
244
205
 
245
-
246
206
  %%% advfile
247
207
 
248
-
249
208
  %%% colophon
250
209
 
251
-
252
210
  %%% backcover
253
211
 
254
-
255
212
  \end{document}
data/test/assets/test_template_backmatter.tex CHANGED
@@ -1,32 +1,24 @@
1
-
2
-
1
+ \backmatter
3
2
 
4
3
 
5
4
 
6
5
  %%% profile
7
-
8
6
  \thispagestyle{empty}\chapter*{Profile}
9
7
  some profile
10
8
 
11
9
 
12
-
13
10
  %%% advfile
14
-
15
11
  \thispagestyle{empty}\chapter*{Ad}
16
12
  some ad content
17
13
 
18
14
 
19
-
20
15
  %%% colophon
21
16
 
22
-
23
17
  %%% backcover
24
-
25
18
  \clearpage
26
19
  \thispagestyle{empty}\AddToShipoutPictureBG{%
27
20
  \AtPageLowerLeft{\includegraphics[width=\paperwidth,height=\paperheight]{images/backcover.png}}
28
21
  }
29
22
  \null
30
23
 
31
-
32
24
  \end{document}
data/test/sample-book/src/Rakefile CHANGED
@@ -5,16 +5,17 @@ BOOK = "book"
5
5
  BOOK_PDF = BOOK+".pdf"
6
6
  BOOK_EPUB = BOOK+".epub"
7
7
  CONFIG_FILE = "config.yml"
8
+ WEBROOT = "webroot"
8
9
 
9
10
  def build(mode, chapter)
10
11
  sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css #{chapter} > tmp"
11
12
  mode_ext = {"html" => "html", "latex" => "tex",
12
- "idgxml" => "xml", "inao" => "inao"}
13
+ "idgxml" => "xml"}
13
14
  FileUtils.mv "tmp", chapter.gsub(/re\z/, mode_ext[mode])
14
15
  end
15
16
 
16
17
  def build_all(mode)
17
- sh "review-compile --all --target=#{mode} --footnotetext --stylesheet=style.css"
18
+ sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css"
18
19
  end
19
20
 
20
21
  task :default => :html_all
@@ -39,6 +40,9 @@ task :all => [:pdf, :epub]
39
40
  desc 'generate PDF file'
40
41
  task :pdf => BOOK_PDF
41
42
 
43
+ desc 'generate stagic HTML file for web'
44
+ task :web => WEBROOT
45
+
42
46
  desc 'generate EPUB file'
43
47
  task :epub => BOOK_EPUB
44
48
 
@@ -54,4 +58,9 @@ file BOOK_EPUB => SRC do
54
58
  sh "review-epubmaker #{CONFIG_FILE}"
55
59
  end
56
60
 
57
- CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK+"-pdf", BOOK+"-epub"])
61
+ file WEBROOT => SRC do
62
+ FileUtils.rm_rf [WEBROOT]
63
+ sh "review-webmaker #{CONFIG_FILE}"
64
+ end
65
+
66
+ CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK+"-pdf", BOOK+"-epub", WEBROOT])
data/{doc/sample.yml → test/sample-book/src/config-epub2.yml} RENAMED
@@ -5,101 +5,92 @@
5
5
  # このファイルはUTF-8エンコーディングで記述してください。
6
6
 
7
7
  # ブック名(ファイル名になるもの。ASCII範囲の文字を使用)
8
- bookname: review-sample
9
-
8
+ bookname: book
9
+ # 記述言語。省略した場合はja
10
+ language: ja
10
11
  # 書名
11
- booktitle: Re:VIEW EPUBサンプル
12
-
13
- # 著者名。「, 」で区切って複数指定できる
14
- aut: ["Minero Aoki", "Kenshi Muto", "Masayoshi Takahashi", "Masanori Kado"]
12
+ booktitle: Re:VIEWサンプル書籍
13
+ # 固有IDに使用するドメイン。省略した場合は時刻に基づくランダムUUIDが入る
14
+ urnid: urn:uid:http://tatsu-zine.com/books/review-sample-book/1.0.0/
15
+ # ISBN。省略した場合はurnidが入る
16
+ # isbn: null
17
+ # 著者名。["高橋征義", "John Doe"] のように配列を使うことで複数指定可
18
+ aut: 高橋征義
19
+ # 出版社。配列書式で複数指定可能
20
+ prt: 達人出版会
21
+ # 編集者。配列書式で複数指定可能
22
+ edt: 高橋征義
23
+ # 刊行日。YYYY-MM-DD形式。省略した場合は本日の日付
24
+ date: 2011-08-03
25
+ # 発行年月。YYYY-MM-DD形式による配列指定。省略した場合はdateを使用する
26
+ # 複数指定する場合は次のように記述する
27
+ # [["初版第第1刷の日付", "初版第第2刷の日付"], ["第2版第1刷の日付"]]
28
+ # 日付の後ろを空白文字で区切り、任意の文字列を置くことも可能。
29
+ history: [["2011-08-03 v1.0.0版発行"]]
30
+ # 権利表記
31
+ rights: (C) 2011 Masayoshi Takahashi
15
32
 
16
- # 以下はオプション
17
33
  # 以下はオプション(autと同じように配列書式で複数指定可能)。
18
- # a-が付いているものはcreator側、
19
- # 付いていないものはcontributor側(二次協力者)に入る
20
- # a-adp, adp: 異なるメディア向けに作り直した者
21
- # a-ann, ann: 注釈記述者
22
- # a-arr, arr: アレンジした者
23
- # a-art, art: グラフィックデザインおよび芸術家
24
- # a-asn, asn: 関連・かつての所有者・関係者
25
- # a-aqt, aqt: 大きく引用された人物
26
- # a-aft, aft: 後書き・奥付の責任者
27
- # a-aui, aui: 序論・序文・前書きの責任者
28
- # a-ant, ant: 目録責任者
29
- # a-bkp, bkp: メディア制作責任者
30
- # a-clb, clb: 限定参加または補足者
31
- # a-cmm, cmm: 解釈・分析・考察者
32
- # a-dsr, dsr: デザイナ
33
- # a-edt, edt: 編集者
34
- # a-ill, ill: イラストレータ
35
- # a-lyr, lyr: 歌詞作成者
36
- # a-mdc, mdc: メタデータセットの一次的責任者
37
- # a-mus, mus: 音楽家
38
- # a-nrt, nrt: 語り手
39
- # a-oth, oth: その他
40
- # a-pht, pht: 撮影責任者
41
- # a-prt, prt: 出版社
42
- # a-red, red: 項目の枠組起草者
43
- # a-rev, rev: 評論者
44
- # a-spn, spn: 援助者
45
- # a-ths, ths: 監督者
46
- # a-trc, trc: 筆記・タイプ作業者
47
- # a-trl, trl: 翻訳者
48
-
49
- # rights: 権利表記(配列で複数指定可)
50
- # date: 刊行日(省略した場合は実行時の日付)
51
- # description: 説明
52
- # subject: 短い説明用タグ(配列で複数指定可)
53
- # type: 書籍のカテゴリーなど(配列で複数指定可)
54
- # format: メディアタイプおよび特徴(配列で複数指定可)
55
- # source: 出版物生成の重要なリソース情報(配列で複数指定可)
56
- # relation: 補助的リソース(配列で複数指定可)
57
- # coverage: 内容の範囲や領域(配列で複数指定可)
58
-
59
-
60
- # デバッグフラグ。nullでないときには一時ファイルをカレントディレクトリに作成し、削除もしない
61
- debug: null
34
+ # adp: 異なるメディア向けに作り直した者
35
+ # ann: 注釈記述者
36
+ # arr: アレンジした者
37
+ # art: グラフィックデザインおよび芸術家
38
+ # asn: 関連・かつての所有者・関係者
39
+ # aqt: 大きく引用された人物
40
+ # aft: 後書き・奥付の責任者
41
+ # aui: 序論・序文・前書きの責任者
42
+ # ant: 目録責任者
43
+ # bkp: メディア制作責任者
44
+ # clb: 限定参加または補足者
45
+ # cmm: 解釈・分析・考察者
46
+ # dsr: デザイナ
47
+ # edt: 編集者
48
+ # ill: イラストレータ
49
+ # lyr: 歌詞作成者
50
+ # mdc: メタデータセットの一次的責任者
51
+ # mus: 音楽家
52
+ # nrt: 語り手
53
+ # oth: その他
54
+ # pht: 撮影責任者
55
+ # red: 項目の枠組起草者
56
+ # rev: 評論者
57
+ # spn: 援助者
58
+ # ths: 監督者
59
+ # trc: 筆記・タイプ作業者
60
+ # trl: 翻訳者
61
+ # description: ブックの説明
62
+ # subject: 短い説明用タグ
63
+ # type: 書籍のカテゴリーなど
64
+ # format: メディアタイプおよび特徴
65
+ # source: 出版物生成の重要なリソース情報
66
+ # relation: 補助的リソース
67
+ # coverage: 内容の範囲や領域
62
68
 
63
69
  # htmlext: HTMLファイルの拡張子(省略した場合はhtml)
64
- #
65
- # CSSファイル(配列で複数指定可)
66
- # stylesheet: ["stylesheet.css"]
70
+ # CSSファイル(配列で複数指定可、yamlファイルおよびRe:VIEWファイルを置いたディレクトリにあること)
71
+ stylesheet: ["style.css"]
67
72
 
68
- # ePUBのバージョン (2か3)
69
- # epubversion: 2
73
+ # ePUBのバージョン (2か3) 省略した場合は2
74
+ epubversion: 2
70
75
  # HTMLのバージョン (4か5。epubversionを3にしたときには5にする)
71
- # htmlversion: 4
72
-
73
- # 目次として抽出する見出しレベル
74
- toclevel: 3
76
+ htmlversion: 4
75
77
 
76
- # 採番の設定。採番させたくない見出しには「==[nonum]」のようにnonum指定をする
77
- #
78
- # 本文でセクション番号を表示する見出しレベル
79
- secnolevel: 2
80
-
81
- # 付録の連番のスタイル。null(アラビア数字1〜。デフォルト)、alpha(英字A〜)、roman(ローマ数字I〜)
82
- # appendix_format: null
83
-
84
- # 以下のsecnolevelはまだ未実装。
85
- # 前付でセクション番号を表示する見出しレベル(未実装)
86
- # pre_secnolevel: 0
87
- # 後付(付録)でセクション番号を表示する見出しレベル(未実装)
88
- # post_secnolevel: 1
89
- # 部番号を表示する見出しレベル(未実装)
90
- # part_secnolevel: 1
91
-
92
- # 本文中に目次ページを作成するか。省略した場合はnull (作成しない)
78
+ # 目次を作成するか。省略した場合はnull（作成しない）
93
79
  # toc: true
94
80
 
95
- # EPUB2標準の目次(NCX)以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
81
+ # 目次として抽出する見出しレベル。省略した場合は2
82
+ toclevel: 2
83
+ # 本文でセクション番号を表示する見出しレベル。省略した場合は2
84
+ # 採番させたくない見出しには「==[nonum]」のようにnonum指定をする
85
+ secnolevel: 3
86
+ # EPUB2標準の目次以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
96
87
  # ePUB3においてはこの設定によらず必ず作成される
97
88
  # mytoc: true
98
89
 
99
90
  # 表紙にするHTMLファイル。ファイル名を指定すると表紙として入る
100
- # cover: null
101
- # 表紙に配置し、書籍の影絵にも利用する画像ファイル。省略した場合はnull (画像を使わない)。画像ディレクトリ内に置いてもディレクトリ名は不要(例: cover.jpg)
102
- # coverimage: null
91
+ # cover: _cover.html
92
+ # 表紙に配置し、書籍の影絵にも利用する画像ファイル。省略した場合はnull (画像を使わない)
93
+ coverimage: cover.jpg
103
94
  # 表紙の後に大扉ページを作成するか。省略した場合はnull (作成しない)
104
95
  # titlepage: null
105
96
  # 自動生成される大扉ページを上書きするファイル。ファイル名を指定すると大扉として入る
@@ -108,45 +99,16 @@ secnolevel: 2
108
99
  # originaltitlefile: null
109
100
  # 権利表記ページファイル。ファイル名を指定すると権利表記として入る
110
101
  # creditfile: null
111
-
112
- # 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
113
- # colophon: true
114
-
115
- # 裏表紙ファイル (画像はcoversまたはimagesに配置する)。ファイル名を指定すると裏表紙として入る
116
- # backcover: null
117
-
118
102
  # プロフィールページファイル。ファイル名を指定すると著者紹介として入る
119
103
  # profile: null
120
104
  # プロフィールページの目次上の見出し
121
105
  # profiletitle: 著者紹介
122
-
123
106
  # 広告ファイル。ファイル名を指定すると広告として入る
124
107
  # advfile: null
125
-
126
- # 取り込む画像が格納されているディレクトリ。省略した場合は以下
127
- # imagedir: images
128
-
129
- # 取り込むフォントが格納されているディレクトリ。省略した場合は以下
130
- # fontdir: fonts
131
-
132
- # imagedir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
133
- # image_ext: ["png", "gif", "jpg", "jpeg", "svg", "ttf", "woff", "otf"]
134
-
135
- # fontdir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
136
- # font_ext: ["ttf", "woff", "otf"]
137
-
138
- # review-compileに渡すパラメータ
139
- params: --stylesheet=sample.css
140
- # Pygmentsカラーリングを利用する (pygments外部gemが必要)
141
- # pygments: true
142
-
143
- # カタログファイル名を指定する
144
- # catalogfile: catalog.yml
145
- # 1ページの行数文字数と1kbごとのページ数を用紙サイズで指定する(A5 or B5)。
146
- # page_metric: A5
147
- # あるいは、配列で指定することもできる
148
- # 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数、1kバイト毎のページ数
149
- # page_metric: [40,80,40,80,2]
108
+ # 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
109
+ colophon: true
110
+ # 裏表紙ファイル (画像はcoversまたはimagesに配置する)。ファイル名を指定すると裏表紙として入る
111
+ # backcover: null
150
112
 
151
113
  # 以下のパラメータを有効にするときには、
152
114
  # epubmaker:
@@ -199,40 +161,23 @@ params: --stylesheet=sample.css
199
161
  # zip_stage2: "zip -Xr9Dq"
200
162
  # ePUBアーカイブに追加するパス(デフォルトはmimetype、META-INF、OEBPS)
201
163
  # zip_addpath: null
202
- # EPUBで表紙をコンテンツに含めるか。デフォルトでは作成されない。yesにするとiBooks等でも最初に表紙が表示されるようになる
203
- # cover_linear: null
204
164
  #
205
165
  # epubmaker:階層を使うものはここまで
206
166
 
207
- # LaTeX用のスタイルファイル(styディレクトリ以下に置くこと)
208
- # texstyle: samplemacro
209
- # LaTeX用のdocumentclassを指定する
210
- # texdocumentclass: ["jsarticle", "b5paper,oneside"]
211
- # LaTeX用のコマンドを指定する(platex or lualatex)
212
- # texcommand: "platex"
213
- # LaTeX用のオプションを指定する(default: "-kanji=#{kanji}")
214
- # texoptions: "-kanji=utf-8"
215
- # LaTeX用のdvi変換コマンドを指定する(dvipdfmx)
216
- # dvicommand: "dvipdfmx"
217
- # LaTeX用のdvi変換コマンドのオプションを指定する
218
- # dvioptions: "-d 5"
167
+ # ハイライトを有効にするか。pygments.gemが必要
168
+ # pygments: null
219
169
 
220
- # 以下のパラメータを有効にするときには、
221
- # pdfmaker:
222
- # パラメータ: 値
223
- # パラメータ: 値
224
- # ...
225
- # という構成にする必要がある(インデントさせる)
226
- #
227
- # pdfmaker:
228
- # TeXコンパイル前に実行するプログラム。変換後のTeXソースを調整したいときに使用する。
229
- # 渡される引数1=作業用展開ディレクトリ、引数2=呼び出しを実行したディレクトリ
230
- # hook_beforetexcompile: null
231
- # TeXコンパイル後に実行するプログラム。索引作業をして再度コンパイルしたいときなどに使用する。
232
- # 渡される引数1=作業用展開ディレクトリ、引数2=呼び出しを実行したディレクトリ
233
- # hook_aftertexcompile: null
234
- # PDF(book.pdf)作成後に実行するプログラム。PDFに加工を施したいときに使用する。
235
- # 渡される引数1=作業用展開ディレクトリ、引数2=呼び出しを実行したディレクトリ
236
- # hook_afterdvipdf: null
237
- #
238
- # pdfmaker:階層を使うものはここまで
170
+ # 取り込む画像が格納されているディレクトリ。省略した場合は以下
171
+ # imagedir: images
172
+
173
+ # 取り込むフォントが格納されているディレクトリ。省略した場合は以下
174
+ # fontdir: fonts
175
+
176
+ # imagedir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
177
+ # image_ext: ["png", "gif", "jpg", "jpeg", "svg", "ttf", "woff", "otf"]
178
+
179
+ # fontdir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
180
+ # font_ext: ["ttf", "woff", "otf"]
181
+
182
+ texstyle: reviewmacro
183
+ debug: true