読者です 読者をやめる 読者になる 読者になる

書籍執筆支援システム「ReVIEW」に触ってみた話(&リンク集)

Re:VIEW

なんと表現したらいいのか、最初は「電子書籍組版ツール」という感じで考えていましたが、開発者の青木さんの過去日記で「書籍執筆支援システム」とあったのでそのように呼んでみました「ReVIEW」の話。

概要

まず、ReVIEWとは何か、というと・・

ReVIEW は、EWB や RD あるいは Wiki に似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。
平易な文法ながらも、コンピュータ関係のドキュメント作成のための多くの機能を備えており、テキスト、LaTeX、HTML、XML といった形式に変換できます。独自のカスタマイズも簡単です。

とのこと。(引用元

大元のページとしてはどこを見ればいいのかって、まあひとまずは、こちらの公式レポジトリでしょうか。

その上で、基本的な説明を読むには、以下が良いのかなと。

その他、開発者の方々による関連記事(順不同)

MLもありますね。

とまあ、基礎的な概要的なところはそのような感じですが、それはそれとしつつ、すでに幾度となく言及されているようですが、とりあえず「ReVIEW」という語はググラビリティが著しくよくないので(関係ないものが引っかかりすぎる・笑)*1、検索自体にもそれなりに時間がかかりながら、ひとしきりのセットアップというのをやってみました。

セットアップ, .reファイルのtext, html化

導入にあたり、まずは上にも挙げましたクイックスタートガイドを見ながら・・

セットアップと、.reファイルから.txt、.htmlを作るところまではそこそこすんなり。
ただ、以下のような説明があったのですが、

なお、–target で毎回指定するのは面倒なので、review-compile に対するシンボリックリンクを作成しておくとよいでしょう。「review2…」のコマンド名で呼び出せるようになります。

cd ReVIEWのインストールされたパス/bin  
ln -s review-compile review2text  
ln -s review-compile review2html  
ln -s review-compile review2latex  
ln -s review-compile review2idgxml  

ん〜、これはちょっと、分からなかったですね。シンボリックリンク自体はよく使っているのですが。ターミナルで試したんだけど、何がどうなればいいのか、ちょっと分からなかったので、これは継続課題ということで。

ちなみにセットアップでは、最初Gitからコピーしたんだけどその後いろいろやって今はRuby gemからインストールしたのを使用しています。

また、上記のガイドと合わせて参考にしたのは以下で、

山田さんという方が9回にわたってReVIEW入門記事を書かれていますが、これのとくに前半4回ぐらいを参考にしました。
ただこちらの場合、最初のインストールの仕方など、ところどころ上記のスタートガイドと異なるところもあるので、ママすべて活用、という感じでもなかったのですが。

ePub化とPDF化

さて上記の問題、ePubとPDFをどう作るか、ということですが、これについては公式のクイックスタートガイドではちらっと触れられている程度なのですが、

review-pdfmaker コマンドで PDF ブックの作成、review-epubmaker コマンドで EPUB ファイルの作成ができます。
PDF を作成するには、pTeXLive2009 以上の環境が必要です。EPUB を作成するには、zip コマンドが必要です (MathML も使いたいときには、 MathML ライブラリも必要です)。
いずれのコマンドも、必要な設定情報を記した YAML ファイルを引数に指定して実行します。YAML ファイルのサンプルは、 sample.yaml としてこのドキュメントと同じディレクトリに収録しています。

review-pdfmaker YAMLファイル  ←PDFの作成
review-epubmaker YAMLファイル ←EPUBの作成

先の山田さんの記事だと詳しく触れられています。

ただ、上にもちょっと書きましたが、公式ガイドとのちょっとしたズレはありまして、たとえば山田さんの書いているとおりにやろうとすると、Ruby 2.1.0が必要だ、と言われるのですが、公式ガイドのとおりに進めようとすると、Ruby 2.0.0じゃないとダメだと言われたりして。これにはちょっとハマりましたね。僕の進め方が悪いのかもしれませんが・・

ということで、基本的にはその両方を参考にしつつ落とし所を探っていく、という感じでやりました。

あらためて、ePubの方から行くと、サンプルデータ(zip)というのがあるので、それを取ってきます。

で、そのファイルの中の「src」ディレクトリの中に入って、以下のコマンドをターミナルに打つと・・

$ review-epubmaker config.yml

srcディレクトリの中に、book-epubというディレクトリと、book.epubというepubファイルが生成されます。これは思ったよりサクッといきました。

PDF化

なかなか難儀したのは、このPDF化です。基本的には、山田さんのこちらの記事が参考になりましたが、

その上で、とりあえずPDF化に必要なことを結論だけ言うと、

「MacTeX」というのをミラーサイトからダウンロードして、インストール時にその中の一部である「TeXLive-2013」だけ入れる。

ということに尽きました。(僕の場合)

目的としては、pLaTeXというのを入れたい、ということらしいですが、そのためにやること(僕がやったこと)は上記、ということですね。

それから、MacTeXのインストールにおいては、以下が大変参考になりました。ありがとうございます。

ちなみに、上記直近3件のリンクいずれにおいても、GhostscriptとImagemagickを別途(Homebrewなど)ないしMacTeXからインストールするように、と書いてあったので、Homebrewから入れるだけ入れましたが、なくてもPDF化自体はできるのかも? さほど重いデータでもなかったので入れておきましたが、ReVIEWとの関わりはよくわかっていません。

さてふたたびMacTeXですが、そこら中に書いてありますが、まあ4GぐらいあるのでDLが大変、というのがもう最初のハマりどころで。
とくに公式サイトから落とそうとしたら何十分もかかりそうだったのですが、上記奥村先生のサイトから、ミラーサイトを辿って落としたら十数分ぐらいで済みました。
ミラーサイトの原理というのはよく分かってないのですが。
#奥村先生のサイトによれば「本家」からのDLでも結局自動的にミラーサイトからのDLになると書いてあるし・・

ダウンロード後、そのまますべてインストールするのではなく(してもいいんだとは思いますが)、必要なものだけ、というカスタマイズの仕方についても上記直近3件のリンクがわかりやすいです。
一番新しい情報を載せてるのは奥村先生のサイトなのかな?(他はTeXLive2012の話になってるけど先生のだけ2013前提なので)

さてそのような試行錯誤の後、たしか一旦マシンを再起動したと思うんですが、それで以下のコマンドをePub同様「src」ディレクトリの中で打ちますと・・

$ review-pdfmaker config.yml

はい。ようやくbook.pdfというpdfファイルができました。このとき、これもePub同様に「book-pdf」というディレクトリができるのですが、ちょっと不思議だったのはこのディレクトリ内にも同じ「book.pdf」が生成されてるんですよね。
これって普通? なんでしょうか。それとも何か設定や操作が間違ってるのでしょうか・・わかりませんが。

ともあれ、src内にもともと入っていたサンプルデータの内容および書式を参照しながらデータを作れば、そこからPDFでもePubでも作れる、という状態にまではここにおいてようやく至ることができた、という感じでした。

リンク集

以下、それら作業に際して参考にした上記以外のリンクを置いておきます。(たぶん自分でも後で使う・・)

ひとまず、こんなところでしょうか。
リンク集はできればアップデートしていきたいので、GitHubあたりにUPしてもいいのかな・・

*1:この記事を書いた後に開催された開発者カンファレンスの後の懇親会でコロンを入れる「Re:VIEW」に改名されたようです