review 1.1.0 → 1.2.0

data/doc/format_idg.rdoc

@@ -1,6 +1,6 @@
-= ReVIEW フォーマット InDesign XML 形式拡張
+= Re:VIEW フォーマット InDesign XML 形式拡張
 
-ReVIEW フォーマットから、Adobe 社の DTP ソフトウェア「InDesign」
+Re:VIEW フォーマットから、Adobe 社の DTP ソフトウェア「InDesign」
 で読み込んで利用しやすい XML 形式に変換できます (通常の XML とほぼ同じ
 ですが、文書構造ではなく見た目を指向した形態になっています)。
 現時点では idgxmlbuilder.rb と topbuilder.rb のみが拡張に対応しています。
@@ -107,7 +107,7 @@ XMLとしては<label id='〜' />と<labelref idref='〜' />というタグに
 という特別な書式を代わりに使います。
 
 == ロー指定
-現時点で ReVIEW はブロックの入れ子処理ができないため、ロー指定で XML
+現時点で Re:VIEW はブロックの入れ子処理ができないため、ロー指定で XML
 エレメントを指定しなければならないこともあります。
 
 インラインの@<raw>{ 〜 }の他に、単一行の//raw[〜]、ブロック版の //rawblock{ 〜 //} でも、フォーマット処理をせずにそのままの文字列が出力できます。

data/doc/libepubmaker/config.yaml

@@ -0,0 +1,163 @@
+# review-epubmaker-ng向けYAMLファイルのサンプル
+# 
+# このファイルはUTF-8エンコーディングで記述してください
+# YAMLにおける空は、「nil」ではなく「null」であることに注意してください
+
+# ブック名(ファイル名になるもの。ASCII範囲の文字を使用)
+bookname: sample
+# 記述言語
+language: ja
+# 書名
+title: "Re:VIEW EPUBのサンプル"
+
+# 固有IDに使用するドメイン。指定しない場合には、時刻に基づくランダムUUIDが入る
+# urnid: urn:uid:http://example.com/some-book-title/1.0.2/
+
+# ISBN。省略した場合はランダム生成したUUIDが入る
+# isbn: null
+
+# 著者名。「, 」で区切って複数指定できる
+aut: ["Minero Aoki", "Kenshi Muto", "Masayoshi Takahashi", "Masanori Kado"]
+
+# 以下はオプション(autと同じように配列書式で複数指定可能)。
+# a-が付いているものはcreator側、
+# 付いていないものはcontributor側(二次協力者)に入る
+# a-adp, adp: 異なるメディア向けに作り直した者
+# a-ann, ann: 注釈記述者
+# a-arr, arr: アレンジした者
+# a-art, art: グラフィックデザインおよび芸術家
+# a-asn, asn: 関連・かつての所有者・関係者
+# a-aqt, aqt: 大きく引用された人物
+# a-aft, aft: 後書き・奥付の責任者
+# a-aui, aui: 序論・序文・前書きの責任者
+# a-ant, ant: 目録責任者
+# a-bkp, bkp: メディア制作責任者
+# a-clb, clb: 限定参加または補足者
+# a-cmm, cmm: 解釈・分析・考察者
+# a-dsr, dsr: デザイナ
+# a-edt, edt: 編集者
+# a-ill, ill: イラストレータ
+# a-lyr, lyr: 歌詞作成者
+# a-mdc, mdc: メタデータセットの一次的責任者
+# a-mus, mus: 音楽家
+# a-nrt, nrt: 語り手
+# a-oth, oth: その他
+# a-pht, pht: 撮影責任者
+# a-prt, prt: 出版社
+# a-red, red: 項目の枠組起草者
+# a-rev, rev: 評論者
+# a-spn, spn: 援助者
+# a-ths, ths: 監督者
+# a-trc, trc: 筆記・タイプ作業者
+# a-trl, trl: 翻訳者
+
+# rights: 権利表記(配列で複数指定可)
+# date: 刊行日(省略した場合は実行時の日付)
+# description: 説明
+# subject: 短い説明用タグ(配列で複数指定可)
+# type: 書籍のカテゴリーなど(配列で複数指定可)
+# format: メディアタイプおよび特徴(配列で複数指定可)
+# source: 出版物生成の重要なリソース情報(配列で複数指定可)
+# relation: 補助的リソース(配列で複数指定可)
+# coverage: 内容の範囲や領域(配列で複数指定可)
+
+# htmlext: HTMLファイルの拡張子(省略した場合はhtml)
+# cover: カバーページのファイル名(省略した場合はbookname.xhtmlになる)
+#
+# coverimage: カバー用画像
+#
+# CSSファイル(配列で複数指定可)
+stylesheet: ["stylesheet.css"]
+
+# ePUBのバージョン (2か3)
+# epubversion: 2
+# HTMLのバージョン (4か5。epubversionを3にしたときには5にする)
+# htmlversion: 4
+
+# 目次として抽出する見出しレベル
+# toclevel: 2
+# 目次を要素の階層表現にしない。省略した場合(null)は階層化する。
+# 構成によっては、階層化目次ではepubcheckにパスしない目次ができるが、
+# そのようなときにはこれをtrueにする
+# flattoc: null
+# 目次のインデントレベルをスペース文字で表現する(flattocがtrueのときのみ)
+# flattocindent: true
+# 本文でセクション番号を表示する見出しレベル
+# secnolevel: 2
+# 前付でセクション番号を表示する見出しレベル
+# pre_secnolevel: 0
+# 後付でセクション番号を表示する見出しレベル
+# post_secnolevel: 0
+# 部番号を表示する見出しレベル
+# part_secnolevel: 1
+
+# NCX目次の見出しレベルごとの飾り(配列で設定)
+#ncxindent:
+#- 
+#- - 
+
+# EPUB2標準の目次以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
+# ePUB3においてはこの設定によらず必ず作成する
+# mytoc: true
+
+# 表紙の後に権利表記ページを作成するか。デフォルトでは作成されない。ファイル名を指定するとそのファイルが使われる(data配列にも指定しておく必要がある)
+# titlepage: title.xhtml
+
+# 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.xhtmlとしてコピーされる(data配列にも指定しておく必要がある)
+# colophon: true
+# pubhistory: 奥付履歴
+
+# プロフィールページファイル。ファイル名を指定すると著者紹介として入る
+# profile: null
+# プロフィールページの目次上の見出し
+# profiletitle: 著者紹介
+
+# フックは、各段階で介入したいときのプログラムを指定する。自動で適切な引数が渡される
+# プログラムには実行権限が必要
+
+# ファイル変換処理の前に実行するプログラム。スタイルシートのコンパイルをしたいときなどに利用する。
+# 渡される引数1=作業用展開ディレクトリ
+# hook_beforeprocess: null
+
+# 前付の変換後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
+# 渡される引数1=作業用展開ディレクトリ
+# hook_afterfrontmatter: null
+
+# 本文の変換後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
+# 渡される引数1=作業用展開ディレクトリ
+# hook_afterbody: null
+
+# 後付の変換後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
+# 渡される引数1=作業用展開ディレクトリ
+# hook_afterbackmatter: null
+
+# 画像およびフォントをコピーした後に実行するプログラム。別の画像やフォントを追加したいときなどに利用する。
+# 渡される引数1=作業用展開ディレクトリ
+# hook_aftercopyimage: null
+
+# ePUB zipアーカイブ直前に実行するプログラム。メタ情報などを加工したいときなどに利用する。
+# 渡される引数1=ePUB準備ディレクトリ
+# hook_prepack: null
+
+# ハイライトを有効にするか。pygments.gemが必要
+# pygments: null
+
+# 取り込む画像が格納されているディレクトリ。省略した場合は以下
+# imagedir: images
+
+# 取り込むフォントが格納されているディレクトリ。省略した場合は以下
+# fontdir: fonts
+
+# imagedir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
+# image_ext: ["png", "gif", "jpg", "jpeg", "svg", "ttf", "woff", "otf"]
+
+# fontdir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
+# font_ext: ["ttf", "woff", "otf"]
+
+# Re:VIEWファイル名を使わず、前付にpre01,pre02...、本文にchap01,chap02l...、後付にpost01,post02...という名前付けルールにするか
+# rename_for_legacy: null
+
+# ePUBアーカイブの非圧縮実行
+# zip_stage1: "zip -0Xq"
+# ePUBアーカイブの圧縮実行
+# zip_stage2: "zip -Xr9Dq"

data/doc/quickstart.rdoc

@@ -1,24 +1,24 @@
-= ReVIEWクイックスタートガイド
+= Re:VIEWクイックスタートガイド
 
-ReVIEW は、EWB や RD あるいは Wiki に似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。
+Re:VIEW は、EWB や RD あるいは Wiki に似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。
 
 平易な文法ながらも、コンピュータ関係のドキュメント作成のための多くの機能を備えており、テキスト、LaTeX、HTML、XML といった形式に変換できます。独自のカスタマイズも簡単です。
 
-ReVIEW は GNU Lesser General Public License Version 2.1 に基づいて配布されており、自由に利用、改変、再配布できます。このライセンスは、ReVIEW を使ってあなたが作成しようとする文書とは無関係であり、あなたの文書はこのライセンスに強制されることはありません。ReVIEW のツールセットあるいは ReVIEW を組み込んだシステムを配布あるいは販売しようとしているときには、ライセンスファイル COPYING をよく確認してください。
+Re:VIEW は GNU Lesser General Public License Version 2.1 に基づいて配布されており、自由に利用、改変、再配布できます。このライセンスは、Re:VIEW を使ってあなたが作成しようとする文書とは無関係であり、あなたの文書はこのライセンスに強制されることはありません。Re:VIEW のツールセットあるいは Re:VIEW を組み込んだシステムを配布あるいは販売しようとしているときには、ライセンスファイル COPYING をよく確認してください。
 
-このドキュメントでは、ReVIEW のセットアップから変換の例までを簡単に説明します。
+このドキュメントでは、Re:VIEW のセットアップから変換の例までを簡単に説明します。
 
 == セットアップ
 
-ReVIEW は Ruby 言語で記述されており、Linux/Unix 互換システムで動作します。Mac OS X および Windows Cygwin でも動作可能です。Ruby gem、Git、Subversion のいずれかを使ってダウンロード・展開します。
+Re:VIEW は Ruby 言語で記述されており、Linux/Unix 互換システムで動作します。Mac OS X および Windows Cygwin でも動作可能です。Ruby gem、Git、Subversion のいずれかを使ってダウンロード・展開します。
 
-なお、ReVIEW フォーマット自体は文字で表現されたタグが付いている以外は単なるテキストファイルなので、エディタ、OS についてはまったく制限はありません。
+なお、Re:VIEW フォーマット自体は文字で表現されたタグが付いている以外は単なるテキストファイルなので、エディタ、OS についてはまったく制限はありません。
 
 === Ruby gemを使う場合
 
-機能セットがまとまった区切りごとに、ReVIEW の開発チームが ReVIEW の gem を更新しています。
+機能セットがまとまった区切りごとに、Re:VIEW の開発チームが Re:VIEW の gem を更新しています。
 
-次のように ReVIEW の gem をインストールします。
+次のように Re:VIEW の gem をインストールします。
 
   gem install review
 
@@ -30,7 +30,7 @@ Ruby gem の bin ディレクトリにパスを通すようにしておいてく
 
 === Gitを使う場合
 
-ReVIEW は GitHub で開発されており、バージョン管理ツールの Git を使って最新の ReVIEW コードを入手できます。Git は分岐が容易なので、独自のカスタマイズを施すのにも向いています。
+Re:VIEW は GitHub で開発されており、バージョン管理ツールの Git を使って最新の Re:VIEW コードを入手できます。Git は分岐が容易なので、独自のカスタマイズを施すのにも向いています。
 
 初めて取得するときには、次のようにします (コピーを作っています)。
 
@@ -56,19 +56,19 @@ review というディレクトリに展開されるので、review/bin にパ
 
   svn up
 
-= ReVIEW テキストの作成と変換
+= Re:VIEW テキストの作成と変換
 
-セットアップを終えたら、ReVIEW フォーマットのテキストを作り、変換できるようになります。次に ReVIEW フォーマットテキストの簡単な例を示します。これを sample.re といった名前で保存します (拡張子も自由ですが、.re 拡張子を推奨します)。
+セットアップを終えたら、Re:VIEW フォーマットのテキストを作り、変換できるようになります。次に Re:VIEW フォーマットテキストの簡単な例を示します。これを sample.re といった名前で保存します (拡張子も自由ですが、.re 拡張子を推奨します)。
 
-  = はじめてのReVIEW
+  = はじめてのRe:VIEW
   
   //lead{
-  「Hello, ReVIEW.」
+  「Hello, Re:VIEW.」
   //}
   
-  == ReVIEWとは
+  == Re:VIEWとは
   
-  @<b>{ReVIEW}は、EWBやRDあるいはWikiに似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。
+  @<b>{Re:VIEW}は、EWBやRDあるいはWikiに似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。
   
   平易な文法ながらも、コンピュータ関係のドキュメント作成のための多くの機能を備えており、次のような形式に変換できます。
   
@@ -85,13 +85,13 @@ review というディレクトリに展開されるので、review/bin にパ
   
   ホームページは@<tt>{https://github.com/kmuto/review/wiki/}です。
 
-テキストファイルの文字エンコーディングには、UTF-8 を使うことをお勧めします。ReVIEW は日本語文字エンコーディングとして UTF-8、EUC-JP、Shift-JIS、JIS を扱うことができ、入力ファイルについては自動判別、出力ファイルについても選択可能 (デフォルトは UTF-8) ですが、入力・出力のいずれにおいても、使用可能な文字についての制限が少ない UTF-8 が最適です。
+テキストファイルの文字エンコーディングには、UTF-8 を使うことをお勧めします。Re:VIEW は日本語文字エンコーディングとして UTF-8、EUC-JP、Shift-JIS、JIS を扱うことができ、入力ファイルについては自動判別、出力ファイルについても選択可能 (デフォルトは UTF-8) ですが、入力・出力のいずれにおいても、使用可能な文字についての制限が少ない UTF-8 が最適です。
 
-次に、章構成ファイルの CHAPS ファイルを同じディレクトリに用意します。このファイルには、ReVIEW フォーマットファイルの名前を格納します。
+次に、章構成ファイルの CHAPS ファイルを同じディレクトリに用意します。このファイルには、Re:VIEW フォーマットファイルの名前を格納します。
 
   sample.re
 
-CHAPS ファイルの1行目に書いたものが第1章、2行目に書いたものが第2章、……と構成されます (CHAPS に似たものとして、前付けを列挙する PREDEF ファイル、後付けを列挙する POSTDEF ファイルがあります)。
+CHAPS ファイルの1行目に書いたものが第1章、2行目に書いたものが第2章、……と構成されます (CHAPS に似たものとして、前付けを列挙する PREDEF ファイル、後付けを列挙する POSTDEF ファイルがあります。これらを「カタログファイル」と呼びます)。
 
 sample.re から目的の形式に変換するには、review-compile コマンドを使います。
 
@@ -112,17 +112,17 @@ sample.re を HTML に変換すると、次のようになります。
   <head>
     <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
     <meta http-equiv="Content-Style-Type" content="text/css" />
-    <meta name="generator" content="ReVIEW" />
-    <title>はじめてのReVIEW</title>
+    <meta name="generator" content="Re:VIEW" />
+    <title>はじめてのRe:VIEW</title>
   </head>
   <body>
-  <h1><a id="h1" />第1章　はじめてのReVIEW</h1>
+  <h1><a id="h1" />第1章　はじめてのRe:VIEW</h1>
   <div class="lead">
-  <p>「Hello, ReVIEW.」</p>
+  <p>「Hello, Re:VIEW.」</p>
   </div>
   
-  <h2><a id="h1-1" />1.1　ReVIEWとは</h2>
-  <p><b>ReVIEW</b>は、EWBやRDあるいはWikiに似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。</p>
+  <h2><a id="h1-1" />1.1　Re:VIEWとは</h2>
+  <p><b>Re:VIEW</b>は、EWBやRDあるいはWikiに似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。</p>
   <p>平易な文法ながらも、コンピュータ関係のドキュメント作成のための多くの機能を備えており、次のような形式に変換できます。</p>
   <ul>
   <li>テキスト（指示タグ付き）</li>
@@ -140,13 +140,13 @@ sample.re を HTML に変換すると、次のようになります。
   </body>
   </html>
 
-ReVIEW フォーマットについての詳細は、 {format.rdoc}[https://github.com/kmuto/review/blob/master/doc/format.rdoc] を参照してください。
+Re:VIEW フォーマットについての詳細は、 {format.rdoc}[https://github.com/kmuto/review/blob/master/doc/format.rdoc] を参照してください。
 
 review-compile を含め、ほとんどのコマンドは --help オプションを付けるとオプションについてのヘルプが表示されます。review-compile には多数のオプションがあるので確認してください。
 
 なお、--target で毎回指定するのは面倒なので、review-compile に対するシンボリックリンクを作成しておくとよいでしょう。「review2...」のコマンド名で呼び出せるようになります。
 
-  cd ReVIEWのインストールされたパス/bin
+  cd Re:VIEWのインストールされたパス/bin
   ln -s review-compile review2text
   ln -s review-compile review2html
   ln -s review-compile review2latex
@@ -181,7 +181,7 @@ PDF を作成するには、pTeXLive2009 以上の環境が必要です。EPUB
 
 == クレジット
 
-ReVIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2010年12月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
+Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2014年3月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
 
 バグ・パッチの報告、開発者用メーリングリストなどについての情報は、
 https://github.com/kmuto/review/wiki

data/doc/sample.yaml

@@ -1,5 +1,5 @@
 # review-epubmaker向けの設定ファイルの例。
-# yamlファイルをReVIEWファイルのある場所に置き、
+# yamlファイルをRe:VIEWファイルのある場所に置き、
 # 「review-epubmaker yamlファイル」を実行すると、<bookname>.epubファイルが
 # 生成されます。
 # このファイルはUTF-8エンコーディングで記述してください。
@@ -7,14 +7,15 @@
 # ブック名(ファイル名になるもの。ASCII範囲の文字を使用)
 bookname: review-sample
 # 書名
-booktitle: ReVIEW EPUBサンプル
+booktitle: Re:VIEW EPUBサンプル
 # 著者
-aut: 吟遊詩人
+aut: 執筆者
 # 以下はオプション
 # prt: 出版社
 # asn: Associated name
 # ant: Bibliographic antecedent
 # clb: 貢献者
+# csl: 監修者
 # edt: 編集者
 # dsr: デザイナ
 # ill: イラストレータ
@@ -30,12 +31,14 @@ aut: 吟遊詩人
 #
 # 固有IDに使用するドメイン。指定しない場合には、時刻に基づくランダムUUIDが入る
 # urnid: urn:uid:http://example.com/some-book-title/1.0.2/
-# CSSファイル (yamlファイルおよびReVIEWファイルを置いたディレクトリにあること)
+# CSSファイル (yamlファイルおよびRe:VIEWファイルを置いたディレクトリにあること)
 stylesheet: stylesheet.css
 # LaTeX用のスタイルファイル(styディレクトリ以下に置くこと)
 # texstyle: samplemacro
 # LaTeX用のdocumentclassを指定する
 # texdocumentclass: ["jsarticle", "b5paper,oneside"]
+# LaTeX用のコマンドを指定する(platex or lualatex)
+# texcommand: "platex"
 # 目次として抽出するレベル
 toclevel: 3
 # セクション番号を表示するレベル
@@ -52,11 +55,13 @@ toc: true
 mytoc: null
 # 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
 colophon: null
-# XHTML生成後に実行するプログラム。$1:HTMLの生成されたディレクトリ $2:ReVIEWファイルのあるディレクトリ $3:起動時指定のyamlファイル名
+# XHTML生成後に実行するプログラム。$1:HTMLの生成されたディレクトリ $2:Re:VIEWファイルのあるディレクトリ $3:起動時指定のyamlファイル名
 # posthook: hook.sh
 # EPUBで表紙をコンテンツに含めるか。デフォルトでは作成されない。yesにするとiBooks等でも最初に表紙が表示されるようになる
 cover_linear: null
 # review-compileに渡すパラメータ
 params: --stylesheet=sample.css
+# Pygmentsカラーリングを利用する (pygments外部gemが必要)
+# pygments: true
 # デバッグフラグ。nullでないときには一時ファイルをカレントディレクトリに作成し、削除もしない
 debug: null

data/lib/epubmaker.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # = epubmaker.rb -- EPUB production set.
 #
-# Copyright (c) 2010-2012 Kenshi Muto
+# Copyright (c) 2010-2013 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -9,16 +9,13 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 # == Quick usage
-# (If you put xhtml files on current directory and put figures in
-# images subdirectory)
-#
 #  require 'epubmaker'
 #  epub = EPUBMaker::Producer.new
 #  params = epub.load("config.yaml")
 #  epub.contents.push(EPUBMaker::Content.new({"file" => "ch01.xhtml"}))
 #  epub.contents.push(EPUBMaker::Content.new({"file" => "ch02.xhtml"}))
 #   ...
-#  epub.importImageInfo("images")
+#  epub.import_imageinfo("images")
 #  epub.produce
 
 require 'epubmaker/producer'

data/lib/epubmaker/content.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # = content.rb -- Content object for EPUBMaker.
 #
-# Copyright (c) 2010 Kenshi Muto
+# Copyright (c) 2010-2014 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -11,11 +11,12 @@
 
 module EPUBMaker
 
-  # EPUBMaker::Content describes a content data for EPUBMaker. EPUBMaker#contents takes an array of Content.
+  # EPUBMaker::Content represents a content data for EPUBMaker.
+  # EPUBMaker#contents takes an array of Content.
   class Content
     # ID
     attr_accessor :id
-    # File path (can accept #<anchor> suffix also)
+    # File path (will accept #<anchor> suffix also)
     attr_accessor :file
     # MIME type
     attr_accessor :media
@@ -61,9 +62,10 @@ module EPUBMaker
 
     private
 
-    # Complement other parameters from file parameter.
+    # Complement other parameters by using file parameter.
     def complement
-      @id = @file.gsub(/[\\\/\.]/, '-') if @id.nil?
+      @id = @file.gsub(/[\\\/\. ]/, '-') if @id.nil?
+      @id = "rv-#{@id}" if @id =~ /\A[^a-z]/i
       @media = @file.sub(/.+\./, '').downcase if !@file.nil? && @media.nil?
 
       @media = "application/xhtml+xml" if @media == "xhtml" || @media == "xml" || @media == "html"
@@ -71,8 +73,9 @@ module EPUBMaker
       @media = "image/jpeg" if @media == "jpg" || @media == "jpeg" || @media == "image/jpg"
       @media = "image/png" if @media == "png"
       @media = "image/gif" if @media == "gif"
-      @media = "image/svg" if @media == "svg"
       @media = "image/svg+xml" if @media == "svg" || @media == "image/svg"
+      @media = "application/vnd.ms-opentype" if @media == "ttf" || @media == "otf"
+      @media = "application/font-woff" if @media == "woff"
 
       if @id.nil? || @file.nil? || @media.nil?
         raise "Type error: #{id}, #{file}, #{media}, #{title}, #{notoc}"

data/lib/epubmaker/epubv2.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # = epubv2.rb -- EPUB version 2 producer.
 #
-# Copyright (c) 2010-2012 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2013 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -13,19 +13,19 @@ require 'epubmaker/producer'
 require 'cgi'
 
 module EPUBMaker
-  
+
   # EPUBv2 is EPUB version 2 producer.
   class EPUBv2
     # Construct object with parameter hash +params+ and message resource hash +res+.
     def initialize(producer)
       @producer = producer
     end
-    
+
     # Return mimetype content.
     def mimetype
-      return "application/epub+zip"
+      "application/epub+zip"
     end
-    
+
     # Return opf file content.
     def opf
       s = <<EOT
@@ -33,6 +33,23 @@ module EPUBMaker
 <package version="2.0" xmlns="http://www.idpf.org/2007/opf" unique-identifier="BookId">
   <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
 EOT
+
+      s << opf_metainfo
+      s << opf_coverimage
+
+      s << %Q[  </metadata>\n]
+
+      s << opf_manifest
+      s << opf_tocx
+      s << opf_guide
+
+      s << %Q[</package>\n]
+
+      s
+    end
+
+    def opf_metainfo
+      s = ""
       %w[title language date type format source description relation coverage subject rights].each do |item|
         next if @producer.params[item].nil?
         if @producer.params[item].instance_of?(Array)
@@ -41,22 +58,23 @@ EOT
           s << %Q[    <dc:#{item}>#{CGI.escapeHTML(@producer.params[item].to_s)}</dc:#{item}>\n]
         end
       end
-      
+
       # ID
       if @producer.params["isbn"].nil?
         s << %Q[    <dc:identifier id="BookId">#{@producer.params["urnid"]}</dc:identifier>\n]
       else
         s << %Q[    <dc:identifier id="BookId" opf:scheme="ISBN">#{@producer.params["isbn"]}</dc:identifier>\n]
       end
-      
-      # creator
+
+      # creator (should be array)
       %w[aut a-adp a-ann a-arr a-art a-asn a-aqt a-aft a-aui a-ant a-bkp a-clb a-cmm a-dsr a-edt a-ill a-lyr a-mdc a-mus a-nrt a-oth a-pht a-prt a-red a-rev a-spn a-ths a-trc a-trl].each do |role|
         next if @producer.params[role].nil?
         @producer.params[role].each do |v|
           s << %Q[    <dc:creator opf:role="#{role.sub('a-', '')}">#{CGI.escapeHTML(v)}</dc:creator>\n]
         end
       end
-      # contributor
+
+      # contributor (should be array)
       %w[adp ann arr art asn aqt aft aui ant bkp clb cmm dsr edt ill lyr mdc mus nrt oth pht prt red rev spn ths trc trl].each do |role|
         next if @producer.params[role].nil?
         @producer.params[role].each do |v|
@@ -66,56 +84,70 @@ EOT
           end
         end
       end
-      
+
+      s
+    end
+
+    def opf_coverimage
+      s = ""
       if @producer.params["coverimage"]
+        file = nil
         @producer.contents.each do |item|
           if item.media =~ /\Aimage/ && item.file =~ /#{@producer.params["coverimage"]}\Z/
-              s << %Q[    <meta name="cover" content="#{item.id}"/>\n]
+            s << %Q[    <meta name="cover" content="#{item.id}"/>\n]
+            file = item.file
             break
           end
         end
+        raise "coverimage #{@producer.params["coverimage"]} not found. Abort." if file.nil?
       end
-      
-      s << %Q[  </metadata>\n]
-      
-      # manifest
+      s
+    end
+
+    def opf_manifest
+      s = ""
       s << <<EOT
   <manifest>
     <item id="ncx" href="#{@producer.params["bookname"]}.ncx" media-type="application/x-dtbncx+xml"/>
     <item id="#{@producer.params["bookname"]}" href="#{@producer.params["cover"]}" media-type="application/xhtml+xml"/>
 EOT
 
-      s << %Q[    <item id="toc" href="#{@producer.params["tocfile"]}" media-type="application/xhtml+xml"/>\n] unless @producer.params["mytoc"].nil?
-      
+      s << %Q[    <item id="toc" href="#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}" media-type="application/xhtml+xml"/>\n] unless @producer.params["mytoc"].nil?
+
       @producer.contents.each do |item|
         next if item.file =~ /#/ # skip subgroup
         s << %Q[    <item id="#{item.id}" href="#{item.file}" media-type="#{item.media}"/>\n]
       end
       s << %Q[  </manifest>\n]
-      
-      # tocx
+      s
+    end
+
+    def opf_tocx
+      s = ""
       s << %Q[  <spine toc="ncx">\n]
       s << %Q[    <itemref idref="#{@producer.params["bookname"]}" linear="no"/>\n]
       s << %Q[    <itemref idref="toc" />\n] unless @producer.params["mytoc"].nil?
-      
+
       @producer.contents.each do |item|
         next if item.media !~ /xhtml\+xml/ # skip non XHTML
         s << %Q[    <itemref idref="#{item.id}"/>\n] if item.notoc.nil?
       end
       s << %Q[  </spine>\n]
-      
-      # guide
+      s
+    end
+
+    def opf_guide
+      s = ""
       s << %Q[  <guide>\n]
       s << %Q[    <reference type="cover" title="#{@producer.res.v("covertitle")}" href="#{@producer.params["cover"]}"/>\n]
-      s << %Q[    <reference type="title-page" title="#{@producer.res.v("titlepagetitle")}" href="#{@producer.params["titlepage"]}"/>\n] unless @producer.params["titlepage"].nil?
-      s << %Q[    <reference type="toc" title="#{@producer.res.v("toctitle")}" href="#{@producer.params["tocfile"]}"/>\n] unless @producer.params["mytoc"].nil?
-      s << %Q[    <reference type="colophon" title="#{@producer.res.v("colophontitle")}" href="colophon.#{@producer.params["htmlext"]}"/>\n] unless @producer.params["colophon"].nil? # FIXME: path
+      s << %Q[    <reference type="title-page" title="#{@producer.res.v("titlepagetitle")}" href="titlepage.#{@producer.params["htmlext"]}"/>\n] unless @producer.params["titlepage"].nil?
+      s << %Q[    <reference type="toc" title="#{@producer.res.v("toctitle")}" href="#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}"/>\n] unless @producer.params["mytoc"].nil?
+      s << %Q[    <reference type="colophon" title="#{@producer.res.v("colophontitle")}" href="colophon.#{@producer.params["htmlext"]}"/>\n] unless @producer.params["colophon"].nil?
       s << %Q[  </guide>\n]
-      s << %Q[</package>\n]
-      return s
+      s
     end
 
-    # Return ncx content. +indentarray+ defines prefix string for each level.
+    # Return ncx content. +indentarray+ has prefix marks for each level.
     def ncx(indentarray)
       s = <<EOT
 <?xml version="1.0" encoding="UTF-8"?>
@@ -125,20 +157,41 @@ EOT
     <meta name="dtb:totalPageCount" content="0"/>
     <meta name="dtb:maxPageNumber" content="0"/>
 EOT
+      s << ncx_isbn
+
+      s << <<EOT
+  </head>
+EOT
+      s << ncx_doctitle
+      s << ncx_navmap(indentarray)
+
+      s << <<EOT
+</ncx>
+EOT
+      s
+    end
+
+    def ncx_isbn
       if @producer.params["isbn"].nil?
-        s << %Q[    <meta name="dtb:uid" content="#{@producer.params["urnid"]}"/>\n]
+        %Q[    <meta name="dtb:uid" content="#{@producer.params["urnid"]}"/>\n]
       else
-        s << %Q[    <meta name="dtb:uid" content="#{@producer.params["isbn"]}"/>\n]
+        %Q[    <meta name="dtb:uid" content="#{@producer.params["isbn"]}"/>\n]
       end
-      
-      s << <<EOT
-  </head>
+    end
+
+    def ncx_doctitle
+      <<EOT
   <docTitle>
     <text>#{CGI.escapeHTML(@producer.params["title"])}</text>
   </docTitle>
   <docAuthor>
     <text>#{@producer.params["aut"].nil? ? "" : CGI.escapeHTML(@producer.params["aut"].join(", "))}</text>
   </docAuthor>
+EOT
+    end
+
+    def ncx_navmap(indentarray)
+      s = <<EOT
   <navMap>
     <navPoint id="top" playOrder="1">
       <navLabel>
@@ -149,19 +202,19 @@ EOT
 EOT
 
       nav_count = 2
-      
+
       unless @producer.params["mytoc"].nil?
         s << <<EOT
     <navPoint id="toc" playOrder="#{nav_count}">
       <navLabel>
         <text>#{@producer.res.v("toctitle")}</text>
       </navLabel>
-      <content src="#{@producer.params["tocfile"]}"/>
+      <content src="#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}"/>
     </navPoint>
 EOT
         nav_count += 1
       end
-      
+
       @producer.contents.each do |item|
         next if item.title.nil?
         indent = indentarray.nil? ? [""] : indentarray
@@ -177,14 +230,13 @@ EOT
 EOT
         nav_count += 1
       end
-      
+
       s << <<EOT
   </navMap>
-</ncx>
 EOT
-      return s
+      s
     end
-    
+
     # Return container content.
     def container
       s = <<EOT
@@ -195,9 +247,9 @@ EOT
   </rootfiles>
 </container>
 EOT
-      return s
+      s
     end
-    
+
     # Return cover content.
     def cover
       s = common_header
@@ -224,13 +276,13 @@ EOT
     <img src="#{file}" alt="#{CGI.escapeHTML(@producer.params["title"])}" class="max"/>
   </div>
 EOT
-   end
-      
+      end
+
       s << <<EOT
 </body>
 </html>
 EOT
-      return s
+      s
     end
 
     # Return title (copying) content.
@@ -249,7 +301,7 @@ EOT
     <br />
     <br />
   </p>
-  <h2 class="tp-author">#{CGI.escapeHTML(@producer.params["aut"])}</h2>
+  <h2 class="tp-author">#{CGI.escapeHTML(@producer.params["aut"].join(", "))}</h2>
 EOT
       end
 
@@ -261,7 +313,7 @@ EOT
     <br />
     <br />
   </p>
-  <h3 class="tp-publisher">#{CGI.escapeHTML(@producer.params["prt"])}</h3>
+  <h3 class="tp-publisher">#{CGI.escapeHTML(@producer.params["prt"].join(", "))}</h3>
 EOT
       end
 
@@ -269,7 +321,8 @@ EOT
 </body>
 </html>
 EOT
-      return s
+
+      s
     end
 
     # Return colophon content.
@@ -280,26 +333,65 @@ EOT
 </head>
 <body>
   <div class="colophon">
+EOT
+
+      if @producer.params["subtitle"].nil?
+        s << <<EOT
     <p class="title">#{CGI.escapeHTML(@producer.params["title"])}</p>
 EOT
+      else
+        s << <<EOT
+    <p class="title">#{CGI.escapeHTML(@producer.params["title"])}<br /><span class="subtitle">#{CGI.escapeHTML(@producer.params["subtitle"])}</span></p>
+EOT
+      end
 
-      if @producer.params["pubhistory"]
-        s << %Q[    <div class="pubhistory">\n      <p>#{@producer.params["pubhistory"].gsub(/\n/, "<br />")}</p>\n    </div>\n] # FIXME: should be array?
+      if @producer.params["date"] || @producer.params["history"]
+        s << %Q[    <div class="pubhistory">\n]
+        if @producer.params["history"]
+          @producer.params["history"].each_with_index do |items, edit|
+            items.each_with_index do |item, rev|
+              editstr = (edit == 0) ? "初版" : "第#{edit + 1}版" # FIXME:i18n
+              revstr = "第#{rev + 1}刷"
+              s << %Q[      <p>#{date_to_s(item)}　#{editstr}#{revstr}　発行</p>\n] # FIXME:i18n
+            end
+          end
+        else
+          s << %Q[      <p>#{date_to_s(@producer.params["date"])}　発行</p>\n] #FIXME:i18n
+        end
+        s << %Q[    </div>\n]
       end
-      
+
       s << %Q[    <table class="colophon">\n]
-      s << %Q[      <tr><th>#{@producer.res.v("c-aut")}</th><td>#{CGI.escapeHTML(@producer.params["aut"])}</td></tr>\n] if @producer.params["aut"]
-      s << %Q[      <tr><th>#{@producer.res.v("c-dsr")}</th><td>#{CGI.escapeHTML(@producer.params["dsr"])}</td></tr>\n] if @producer.params["dsr"]
-      s << %Q[      <tr><th>#{@producer.res.v("c-ill")}</th><td>#{CGI.escapeHTML(@producer.params["ill"])}</td></tr>\n] if @producer.params["ill"]
-      s << %Q[      <tr><th>#{@producer.res.v("c-edt")}</th><td>#{CGI.escapeHTML(@producer.params["edt"])}</td></tr>\n] if @producer.params["edt"]
-      s << %Q[      <tr><th>#{@producer.res.v("c-prt")}</th><td>#{CGI.escapeHTML(@producer.params["prt"])}</td></tr>\n] if @producer.params["prt"]
+      s << %Q[      <tr><th>#{@producer.res.v("c-aut")}</th><td>#{CGI.escapeHTML(@producer.params["aut"].join(", "))}</td></tr>\n] unless @producer.params["aut"].nil?
+      s << %Q[      <tr><th>#{@producer.res.v("c-csl")}</th><td>#{CGI.escapeHTML(@producer.params["csl"].join(", "))}</td></tr>\n] unless @producer.params["csl"].nil?
+      s << %Q[      <tr><th>#{@producer.res.v("c-trl")}</th><td>#{CGI.escapeHTML(@producer.params["trl"].join(", "))}</td></tr>\n] unless @producer.params["trl"].nil?
+      s << %Q[      <tr><th>#{@producer.res.v("c-dsr")}</th><td>#{CGI.escapeHTML(@producer.params["dsr"].join(", "))}</td></tr>\n] unless @producer.params["dsr"].nil?
+      s << %Q[      <tr><th>#{@producer.res.v("c-ill")}</th><td>#{CGI.escapeHTML(@producer.params["ill"].join(", "))}</td></tr>\n] unless @producer.params["ill"].nil?
+      s << %Q[      <tr><th>#{@producer.res.v("c-edt")}</th><td>#{CGI.escapeHTML(@producer.params["edt"].join(", "))}</td></tr>\n] unless @producer.params["edt"].nil?
+      s << %Q[      <tr><th>#{@producer.res.v("c-prt")}</th><td>#{CGI.escapeHTML(@producer.params["prt"].join(", "))}</td></tr>\n] unless @producer.params["prt"].nil?
+      s << %Q[      <tr><th>#{@producer.res.v("c-pht")}</th><td>#{CGI.escapeHTML(@producer.params["pht"].join(", "))}</td></tr>\n] unless @producer.params["pht"].nil?
+      if @producer.params["isbn"].to_s =~ /\A\d{10}\Z/ || @producer.params["isbn"].to_s =~ /\A\d{13}\Z/
+        isbn = nil
+        str = @producer.params["isbn"].to_s
+        if str.size == 10
+          isbn = "#{str[0..0]}-#{str[1..5]}-#{str[6..8]}-#{str[9..9]}"
+        else
+          isbn = "#{str[0..2]}-#{str[3..3]}-#{str[4..8]}-#{str[9..11]}-#{str[12..12]}"
+        end
+        s << %Q[      <tr><th>ISBN</th><td>#{isbn}</td></tr>\n]
+      end
       s << <<EOT
     </table>
   </div>
 </body>
 </html>
 EOT
-      return s
+      s
+    end
+
+    def date_to_s(date)
+      ymd = date.to_s.split('-')
+      "#{ymd[0]}年#{ymd[1].sub(/\A0/, '')}月#{ymd[2].sub(/\A0/, '')}日" # FIXME:i18n
     end
 
     # Return own toc content.
@@ -310,68 +402,109 @@ EOT
 </head>
 <body>
   <h1 class="toc-title">#{@producer.res.v("toctitle")}</h1>
-  <ul class="toc-h1">
 EOT
 
-      # FIXME: indent
-      current = 1
-      init_item = true
+      if @producer.params["flattoc"].nil?
+        s << hierarchy_ncx("ul")
+      else
+        s << flat_ncx("ul", @producer.params["flattocindent"])
+      end
+
+      s << <<EOT
+</body>
+</html>
+EOT
+      s
+    end
+
+    def hierarchy_ncx(type)
+      require 'rexml/document'
+      level = 1
+      find_jump = nil
+
+      # check part existance
+      @producer.contents.each do |item|
+        if item.notoc.nil? && item.level == 0
+          level = 0
+        end
+      end
+
+      doc = REXML::Document.new(%Q[<#{type} class="toc-h#{level}"><li /></#{type}>])
+
+      e = doc.root.elements[1] # first <li/>
       @producer.contents.each do |item|
         next if !item.notoc.nil? || item.level.nil? || item.file.nil? || item.title.nil? || item.level > @producer.params["toclevel"].to_i
-        if item.level > current
-          s << %Q[\n<ul class="toc-h#{item.level}">\n]
-          current = item.level
-        elsif item.level < current
-          (current - 1).downto(item.level) do |n|
-            s << %Q[</li>\n</ul>\n]
+
+        if item.level == level
+          e2 = e.parent.add_element("li")
+          e = e2
+        elsif item.level > level
+          find_jump = true if (item.level - level) > 1
+          # deeper
+          (level + 1).upto(item.level) do |n|
+            e2 = e.add_element(type, {"class" => "toc-h#{n}"})
+            e3 = e2.add_element("li")
+            e = e3
           end
-          s << %Q[</li>\n]
-          current = item.level
-        elsif init_item
-          # noop
-        else
-          s << %Q[</li>\n]
+          level = item.level
+        elsif item.level < level
+          # shallower
+          (level - 1).downto(item.level) do |n|
+            e = e.parent.parent
+          end
+          e2 = e.parent.add_element("li")
+          e = e2
+          level = item.level
         end
-        s << %Q[<li><a href="#{item.file}">#{item.title}</a>]
-        init_item = false
-      end
-      
-      (current - 1).downto(1) do |n|
-        s << %Q[</li>\n</ul>\n]
+        e2 = e.add_element("a", {"href" => item.file})
+        e2.add_text(REXML::Text.new(item.title, true))
       end
-      if !init_item
-      s << %Q[</li>\n]
+
+      warn "found level jumping in table of contents. consider to use 'flattoc: true' for strict ePUB validator." unless find_jump.nil?
+
+      doc.to_s.gsub("<li/>", "").gsub("</li>", "</li>\n").gsub("href='", "href=\"").gsub(" class='", " class=\"").gsub("'>", "\">").gsub("<#{type} ", "\n" + '\&') # ugly
+    end
+
+    def flat_ncx(type, indent=nil)
+      s = %Q[<#{type} class="toc-h1">\n]
+      @producer.contents.each do |item|
+        next if !item.notoc.nil? || item.level.nil? || item.file.nil? || item.title.nil? || item.level > @producer.params["toclevel"].to_i
+        is = indent == true ? "　" * item.level : ""
+        s << %Q[<li><a href="#{item.file}">#{is}#{item.title}</a></li>\n]
       end
-      s << <<EOT
-  </ul>
-</body>
-</html>
-EOT
-      return s
+      s << %Q[</#{type}>\n]
+
+      s
     end
 
     # Produce EPUB file +epubfile+.
     # +basedir+ points the directory has contents.
     # +tmpdir+ defines temporary directory.
     def produce(epubfile, basedir, tmpdir)
+      produce_write_common(basedir, tmpdir)
+
+      File.open("#{tmpdir}/OEBPS/#{@producer.params["bookname"]}.ncx", "w") {|f| @producer.ncx(f, @producer.params["ncxindent"]) }
+      File.open("#{tmpdir}/OEBPS/#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}", "w") {|f| @producer.mytoc(f) } unless @producer.params["mytoc"].nil?
+
+      @producer.call_hook(@producer.params["hook_prepack"], tmpdir)
+      export_zip(tmpdir, epubfile)
+    end
+
+    def produce_write_common(basedir, tmpdir)
       File.open("#{tmpdir}/mimetype", "w") {|f| @producer.mimetype(f) }
-      
+
       Dir.mkdir("#{tmpdir}/META-INF") unless File.exist?("#{tmpdir}/META-INF")
       File.open("#{tmpdir}/META-INF/container.xml", "w") {|f| @producer.container(f) }
-      
+
       Dir.mkdir("#{tmpdir}/OEBPS") unless File.exist?("#{tmpdir}/OEBPS")
       File.open("#{tmpdir}/OEBPS/#{@producer.params["bookname"]}.opf", "w") {|f| @producer.opf(f) }
-      File.open("#{tmpdir}/OEBPS/#{@producer.params["bookname"]}.ncx", "w") {|f| @producer.ncx(f, @producer.params["ncxindent"]) }
-      File.open("#{tmpdir}/OEBPS/#{@producer.params["tocfile"]}", "w") {|f| @producer.mytoc(f) } unless @producer.params["mytoc"].nil?
-      
+
       if File.exist?("#{basedir}/#{@producer.params["cover"]}")
         FileUtils.cp("#{basedir}/#{@producer.params["cover"]}", "#{tmpdir}/OEBPS")
       else
         File.open("#{tmpdir}/OEBPS/#{@producer.params["cover"]}", "w") {|f| @producer.cover(f) }
       end
-      
-      # FIXME:colophon and titlepage should be included in @producer.contents.
-      
+
       @producer.contents.each do |item|
         next if item.file =~ /#/ # skip subgroup
         fname = "#{basedir}/#{item.file}"
@@ -379,19 +512,11 @@ EOT
         FileUtils.mkdir_p(File.dirname("#{tmpdir}/OEBPS/#{item.file}")) unless File.exist?(File.dirname("#{tmpdir}/OEBPS/#{item.file}"))
         FileUtils.cp(fname, "#{tmpdir}/OEBPS/#{item.file}")
       end
+    end
 
-      fork {
-        Dir.chdir(tmpdir) {|d|
-          exec("zip", "-0X", "#{epubfile}", "mimetype")
-        }
-      }
-      Process.waitall
-      fork {
-        Dir.chdir(tmpdir) {|d|
-          exec("zip", "-Xr9D", "#{epubfile}", "META-INF", "OEBPS")
-        }
-      }
-      Process.waitall
+    def export_zip(tmpdir, epubfile)
+      Dir.chdir(tmpdir) {|d| system("#{@producer.params["zip_stage1"]} #{epubfile} mimetype") }
+      Dir.chdir(tmpdir) {|d| system("#{@producer.params["zip_stage2"]} #{epubfile} META-INF OEBPS") }
     end
 
     private
@@ -411,8 +536,7 @@ EOT
       @producer.params["stylesheet"].each do |file|
         s << %Q[  <link rel="stylesheet" type="text/css" href="#{file}"/>\n]
       end
-      return s
+      s
     end
   end
-  
 end