【書籍制作ワークフロー】ReVIEW 入門 #09 – config.yml について

catch-ebbok1

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

config.yml - ePUB 生成向けの設定ファイル

ReVIEWからePUBを生成するにあたって、様々な設定を定義するのがconfig.ymlというファイルです。ePUBのファイル名はもちろんのこと、奥付に表示される著者情報や表紙に使用するHTMLや画像ファイルなど一通りの事をここでまとめて定義するというわけです。

書名・言語

パラメータ 説明
bookname jquery_css3_cookbook ePUB のファイル名。ASCII範囲の文字を使用します。
booktitle jQuery x CSS3 Cookbook 書籍名
urnid http://wakamsha.net/books/jc_cookbook/1.0.0/ 固有IDとして使用するドメイン等(URN形式)。指定しない場合には、時刻に基づくランダムUUIDが入ります。
isbn ISBN-13:000-0000000000 ISBN(国際標準図書番号)。nil の場合はePUBのBookIdはISBNではなくurnidが使われます。

バージョン

パラメータ 説明
epubversion 3 生成するePUBのバージョンを指定します。2もしくは3が指定可能です。
htmlversion 5 生成するHTMLのバージョンを指定します。4もしくは5が指定可能です。

なお、ePUBのバージョンを2にした時のHTMLバージョンは標準で4ですが、ePUBを3に指定するとHTMLは必ず5になります。

目次・採番

パラメータ 説明
toclevel 1 目次の抽出レベルを指定します。最低値は
secnolevel 1 本文(CHAPS)の見出し採番レベルを指定します。最低値は0です。

目次や採番は『見出しレベル』を管理するわけですが、見出しレベルは部 = 0章 = 1節 = 2、…となっています。目次にはtoclevelで指定した見出しレベルまでのモノが掲載されます。

目次

パラメータ 説明
toc true 目次を出力するかどうかを指定します(bool)。
mytoc false ReVIEWデフォルトではなく、オリジナルの目次を生成するかどうかを指定します(bool)。

メタ情報

主に奥付に表示されるような著者名や出版社名といったものを定義します。

パラメータ 説明
aut 著者
prt 出版社
prt_url 出版社のURL
clb 貢献者
edt 編集者
rights 権利表記(コピーライト)
description 書籍の説明
asn Associated name
ant Bibliographic antecedent
dsr デザイナー
ill イラストレータ
pht 撮影者
trl 翻訳者

この他にも沢山のパラメータがありますが、まだまだ開発段階だからか、機能していないものも多くあるようです。

刊行日

パラメータ 説明
date YYYY-MM-DD 最新版の刊行日
pubhistory YYYY年MM月DD日 v1.0.0版発行 版履歴。特に構造化はされておらず、自由記述したものがそのまま出力されます。

pubhistoryに関しては、次期バージョン(?)でhistoryというパラメータが新しく追加されており、こちらはYYYY-MM-DD形式で版ごとに子配列として刷ごとの日付を格納するという構造になっていることから、今後はこちらに移行するものと思われます。

ReVIEW 変換

パラメータ 説明
coverfile _cover.html カバーページのbody要素内に挿入する内容を記述したファイル名
coverimage cover.png 表示画像用ファイルを指定します。
stylesheet main.css CSSファイルを指定します。
mytoc true 目次を生成するかどうかを指定します。
colophon true 奥付を生成するかどうかを指定します。

おわりに

最後にreview-initコマンドで自動生成されるconfig.ymlを掲載します。

config.yml
# review-epubmaker向けの設定ファイルの例。
# yamlファイルをReVIEWファイルのある場所に置き、
# 「review-epubmaker yamlファイル」を実行すると、<bookname>.epubファイルが
# 生成されます。
# このファイルはUTF-8エンコーディングで記述してください。

# ブック名(ファイル名になるもの。ASCII範囲の文字を使用)
bookname: book
# 書名
booktitle: ReVIEWサンプル書籍
# 著者
aut: 高橋征義
prt: 達人出版会
prt_url:  http://github.com/takahashim/review-sample-book/
edt: 高橋征義
date: 2011-08-03
rights: |
  (C) 2011 Masayoshi Takahashi
description: 
# 以下はオプション
# prt: 出版社
# asn: Associated name
# ant: Bibliographic antecedent
# clb: 貢献者
# edt: 編集者
# dsr: デザイナ
# ill: イラストレータ
# pht: 撮影者
# trl: 翻訳者
# date: 刊行日
# rights: 権利表記
# description: ブックの説明
#
# coverfile: カバーページのbody要素内に挿入する内容を記述したファイル名
coverfile: _cover.html
# coverimage: 表紙用画像ファイル
coverimage: cover.jpg
# 固有IDに使用するドメイン
urnid: http://tatsu-zine.com/books/review-sample-book/1.0.0/
# CSSファイル (yamlファイルおよびReVIEWファイルを置いたディレクトリにあること
stylesheet: main.css
# 目次として抽出するレベル
toclevel: 2
# セクション番号を表示するレベル
secnolevel: 3
# review-compileに渡すパラメータ
params: --stylesheet=main.css
# 目次生成用?
mytoc: true
# 奥付生成用
colophon: true
texstyle: reviewmacro
pubhistory: |
  2011年08月03日 v1.0.0版発行
debug: true