Permalink
9b3a823 Feb 12, 2018
4 contributors

Users who have contributed to this file

@kmuto @takahashim @znz @snoozer05
217 lines (139 sloc) 9.7 KB

Re:VIEWクイックスタートガイド

Re:VIEW は、EWB や RD あるいは Wiki に似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。

平易な文法ながらも、コンピュータ関係のドキュメント作成のための多くの機能を備えており、テキスト、LaTeX、HTML、XML といった形式に変換できます。独自のカスタマイズも簡単です。

Re:VIEW は GNU Lesser General Public License Version 2.1 に基づいて配布されており、自由に利用、改変、再配布できます。このライセンスは、Re:VIEW を使ってあなたが作成しようとする文書とは無関係であり、あなたの文書はこのライセンスに強制されることはありません。Re:VIEW のツールセットあるいは Re:VIEW を組み込んだシステムを配布あるいは販売しようとしているときには、ライセンスファイル COPYING をよく確認してください。

このドキュメントでは、Re:VIEW のセットアップから変換の例までを簡単に説明します。

このドキュメントは、Re:VIEW 2.0 に基づいています。

セットアップ

Re:VIEW は Ruby 言語で記述されており、Linux/Unix 互換システムで動作します。Mac OS X および Windows Cygwin でも動作可能です。Ruby gem あるいは Git のいずれかを使ってダウンロード・展開します。

なお、Re:VIEW フォーマット自体は文字で表現されたタグが付いている以外は単なるテキストファイルなので、エディタ、OS については UTF-8 文字エンコーディングさえ使用できれば制限はありません。

RubyGems を使う場合

機能セットがまとまった区切りごとに、定期的に Re:VIEW の開発チームが Re:VIEW の gem を更新しています。

次のように Re:VIEW の gem をインストールします。

$ gem install review

Ruby gem の bin ディレクトリにパスを通すようにしておいてください。

インストール後、最新の gem に追従するには次のようにします。

$ gem update review

Gemfile を使っている場合は、以下の行を Gemfile に追加して、bundleコマンドを実行します。

gem 'review'

Gitを使う場合

Re:VIEW は GitHub で開発されており、バージョン管理ツールの Git を使って最新の Re:VIEW コードを入手できます。Git は分岐が容易なので、独自のカスタマイズを施すのにも向いています。

初めて取得するときには、次のようにします (コピーを作っています)。

$ git clone https://github.com/kmuto/review.git

review というディレクトリに展開されるので、review/bin にパスを通すようにしておいてください。

最新の開発に追従するには次のようにします。

$ git pull

Re:VIEW ドキュメントの作成

雛型の作成

review-init コマンドを使って、雛型となる作業フォルダを作成できます。

$ review-init ドキュメント名

これで指定のドキュメント名のフォルダが用意され、中に次のようなファイルが置かれます。

  • ドキュメント名を冠した「.re」拡張子を持つファイル(Re:VIEW フォーマットテキストファイル)
  • config.yml : 設定ファイル
  • catalog.yml : カタログファイル(目次構成)
  • Rakefile : rake コマンドのルールファイル
  • images : 画像の配置フォルダ
  • layouts : レイアウトファイルの配置フォルダ
  • style.css : サンプルスタイルシート
  • sty : スタイルファイル配置フォルダ(TeX 用)

review-init コマンドによらず、独自に作業フォルダを作成してもかまいません。

Re:VIEW テキストの作成と変換

デフォルトの re 拡張子のファイルは、「=」とあるだけのほぼ空っぽのファイルです。次に Re:VIEW フォーマットで記述を追加した簡単な例を示します。

= はじめてのRe:VIEW

//lead{
「Hello, Re:VIEW.」
//}

== Re:VIEWとは

@<b>{Re:VIEW}は、EWBやRDあるいはWikiに似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。

平易な文法ながらも、コンピュータ関係のドキュメント作成のための多くの機能を備えており、次のような形式に変換できます。

 * テキスト(指示タグ付き)
 * LaTeX
 * HTML
 * XML

現在入手手段としては次の3つがあります。

 1. Ruby gem
 2. Git
 3. Download from GitHub

ホームページは@<tt>{https://reviewml.org/}です。

テキストファイルの文字エンコーディングには、UTF-8 を使用してください。

PDF 化と EPUB 化、プレインテキスト化

review-pdfmaker コマンドで PDF ブックの作成、review-epubmaker コマンドで EPUB ファイルの作成、review-textmaker コマンドでプレインテキストの作成ができます。

PDF を作成するには、TeXLive2012 以上の環境が必要です。EPUB を作成するには、rubyzip gem あるいは zip コマンドが必要です(MathML も使いたいときには、 MathML ライブラリも必要です)。

いずれのコマンドも、必要な設定情報を記した YAML 形式ファイルを引数に指定して実行します。review-init コマンドで作成した環境には、デフォルトで config.yml として用意されているので、これを利用します。

$ review-pdfmaker config.yml     ←PDFの作成
$ review-epubmaker config.yml    ←EPUBの作成
$ review-textmaker config.yml    ←テキストの作成(装飾情報あり)
$ review-textmaker -n config.yml ←テキストの作成(装飾情報なし)

rake コマンドを利用できるなら、次のように実行することもできます。

$ rake pdf  ←PDFの作成
$ rake epub ←EPUBの作成
$ rake text  ←テキストの作成(装飾情報あり)
$ rake plaintext ←テキストの作成(装飾情報なし)

config.yml のサンプルについては以下を参照してください。

章を増やす、カスタマイズする

作成した PDF あるいは EPUB を見ると、先に作成した RE:VIEW フォーマットテキストファイルが「第1章」となっていることがわかります。

章を増やすには、同様に .re 拡張子の Re:VIEW フォーマットテキストファイルを用意し、catalog.yml にそれを登録します。

PREDEF:

CHAPS:
  - 1章のファイル
  - 2章のファイル
   ……

APPENDIX:

POSTDEF:

catalog.yml の PREDEF は前付、CHAPS は章、APPENDIX は付録、POSTDEF は後付です。詳細は catalog.ja.md を参照してください。

情報

Re:VIEW フォーマットについての詳細は、 format.ja.md を参照してください。

Re:VIEW の使用実例については、https://github.com/reviewml/review-samples にもまとめています。

ファイル単位の変換

通常の用途では review-pdfmaker や review-epubmaker で事足りるはずですが、それ以外の形式に変換したり、PDF や EPUB の変換にあたってどのような変換が行われているのかを確認したりしたいときには、review-compile コマンドを使用します。

たとえば sample.re ファイルを変換するには次のようになります。

$ review-compile --target text sample.re > sample.txt    ←テキストにする
$ review-compile --target html sample.re > sample.html   ←HTMLにする
$ review-compile --target latex sample.re > sample.tex   ←LaTeXにする
$ review-compile --target idgxml sample.re > sample.xml  ←XMLにする
$ review-compile --target markdown sample.re > sample.md ←Markdownにする

review-compile を含め、ほとんどのコマンドは --help オプションを付けるとオプションについてのヘルプが表示されます。

プリプロセッサ、ボリューム表示

#@mapfile#@maprange#@mapoutput のタグを使って、指定のファイルの内容あるいはコマンドの実行結果を挿入できます。挿入・更新を行うには、プリプロセッサとなる review-preproc コマンドを使います。

$ review-preproc ファイル > 結果ファイル ←標準出力をリダイレクト

## または
$ review-preproc --replace ファイル ←ファイルを更新したもので上書き

各章の分量などを表示するには、review-vol コマンドを使います。

$ review-vol

より細かな見出し一覧などを出したいときには、review-index コマンドを使うのもよいでしょう。

$ review-index --level 掘り下げる見出しレベル数 -a

クレジット

Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2016年4月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。

バグ・パッチの報告、開発者用メーリングリストなどについての情報は、

を参照してください。