[ReVIEW Tips] ReVIEW用のファイル一式を作る


ReVIEWは単なる1ページのHTMLを生成するたぐいの文書フォーマットコンバータではなく、書籍のようなまとまったデータを生成するシステムです。そのせいもあって、必要となるファイル群がいろいろとあり、ちょっと始めてみたいという時に取っ付きづらいところがあるのも否めません。

そのため、とっかかりのファイル群を簡単に生成できるためのコマンドが作られました。それがreview-initコマンドです。

review-init コマンドを使う

review-initコマンドは以下のように実行します。

$ review-init 【ディレクトリ名】

例えばsample1というディレクトリ名でReVIEWのファイル群を作るには以下のようにします。

$ review-init sample1

【ディレクトリ名】で指定したディレクトリが作られ、中にファイルがいくつか作られます。

$ ls sample1
CHAPS       PREDEF      config.yml  layouts     sty
POSTDEF     Rakefile    images      sample1.re

既存のReVIEW用フォルダを流用する

それとは別に、すでにできている雛形から作る方法もあります。サンプルの書籍ファイルは以下のサイトなどにあります。

ここから必要なファイルを取得します。gitはちょっと…という方は、右下の方にある「Download Zip」というボタンを押すと、zipで固められたファイルがダウンロードされるので、zipファイルを展開してください。

あとは、中に入っているファイルを適当に書き換えるなり、追加するなりしてお使いください。