review 2.0.0.beta1 → 2.0.0

data/doc/format_idg.ja.md

@@ -1,203 +1,110 @@
 # Re:VIEW フォーマット InDesign XML 形式拡張
 
-Re:VIEW フォーマットから、Adobe 社の DTP ソフトウェア「InDesign」
-で読み込んで利用しやすい XML 形式に変換できます (通常の XML とほぼ同じ
-ですが、文書構造ではなく見た目を指向した形態になっています)。
-現時点では idgxmlbuilder.rb と topbuilder.rb のみが拡張に対応しています。
-実際には出力された XML を InDesign のスタイルに割り当てるフィルタをさらに
-作成・適用する必要があります。
+Re:VIEW フォーマットから、Adobe 社の DTP ソフトウェア「InDesign」で読み込んで利用しやすい XML 形式に変換できます (通常の XML とほぼ同じですが、文書構造ではなく見た目を指向した形態になっています)。実際には出力された XML を InDesign のスタイルに割り当てるフィルタをさらに作成・適用する必要があります。
 
-## 章・節・項・段
+基本のフォーマットのほかにいくつかの拡張命令を追加しています。
 
-従来の`[column]`のほかに、オプションを追加しています。
+このドキュメントは、Re:VIEW 2.0 に基づいています。
 
-* `[nonum]` : これを指定している章・節・項・段には連番を振りません。
-* `[circle]`: 「・」を先頭に付けた小さな見出し(連番なし)を作成します。
-* `[world]`: Real Worldコラム。
-* `[hood]`: Under the Hoodコラム。
-* `[edition]`: Editionコラム。
-* `[insideout]`: インサイドアウトコラム。
+## 追加したブロック
+これらのブロックは基本的に特定の書籍向けのものであり、将来廃棄する可能性があります。
 
-## 書式ブロック
-
-`//insn[タイトル]{ 〜 //}` または `//box[タイトル]{ 〜 //}` で書式を指定します。
-
-## ノート
-
-`//note{ 〜 //}` または `//note[タイトル]{ 〜 //}` で注意文章を指定します。
-
-## メモ
-
-`//memo{ 〜 //}` または `//memo[タイトル]{ 〜 //}` でメモ文章を指定します。
-
-## ヒント
-
-`//tip{ 〜 //}` または `//tip[タイトル]{ 〜 //}` でヒント(Tip)文章を指定します。
-
-## 参照ブロック
-
-`//info{ 〜 //}` または `//info[タイトル]{ 〜 //}` で参照文章を指定します。
-
-## プランニング
-
-`//planning{ 〜 //}` または `//planning[タイトル]{ 〜 //}` でプランニング文章を指定します。
-
-## ベストプラクティス
-
-`//best{ 〜 //}` または `//best[タイトル]{ 〜 //}` でベストプラクティス文章を
-指定します。
-
-## ここが重要 (キーワード)
-
-`//important[タイトル]{ 〜 //}` で重要項目を指定します。
-
-## セキュリティ
-
-`//security{ 〜 //}` または `//security[タイトル]{ 〜 //}` でセキュリティ文章を
-指定します。
-
-## 警告
-
-`//caution{ 〜 //}` または `//caution[タイトル]{ 〜 //}` で警告文章を指定します。
-
-## エキスパートに訊く
-
-`//expert{ 〜 //}` で「エキスパートに訊く」を指定します (rawで`<expert>〜</expert>`
-を使うほうがよいかもしれません)。
-QとAは`@<b>{Q}：〜` と `@<b>{A}：〜` で示します。
-
-## 注意
-
-`//notice{ 〜 //}` または `//notice[タイトル]{ 〜 //}` で注意を指定します。
-
-## ワンポイント
-
-`//point{ 〜 //}` または `//point[タイトル]{ 〜 //}` でワンポイントを指定します。
-
-## トラブルシューティング
-
-`//shoot{ 〜 //}` または `//shoot[タイトル]{ 〜 //}` でトラブルシューティングを
-指定します。
-
-## 用語解説
-
-`//term{ 〜 //}` で用語解説を指定します(ただし、ブロック指定ができないので
-実質的にはrawで`<term>〜</term>`を通常使うことになるでしょう)。
-
-## リンク
-
-`//link{ 〜 //}` または `//link[タイトル]{ 〜 //}` で他の章やファイルなどへの
-参照内容を指定します。
-
-## 練習問題
-
-`//practice{ 〜 //}` で練習問題を指定します。
-
-## 参考
-
-`//reference{ 〜 //}` で参考情報を指定します。
+* `//insn[タイトル]{ 〜 //}` または `//box[タイトル]{ 〜 //}` : 書式
+* `//planning{ 〜 //}` または `//planning[タイトル]{ 〜 //}` : プランニング
+* `//best{ 〜 //}` または `//best[タイトル]{ 〜 //}` : ベストプラクティス
+* `//security{ 〜 //}` または `//security[タイトル]{ 〜 //}` : セキュリティ
+* `//expert{ 〜 //}`  : エキスパートに訊く
+* `//point{ 〜 //}` または `//point[タイトル]{ 〜 //}` : ワンポイント
+* `//shoot{ 〜 //}` または `//shoot[タイトル]{ 〜 //}` : トラブルシューティング
+* `//term{ 〜 //}` : 用語解説
+* `//link{ 〜 //}` または `//link[タイトル]{ 〜 //}` : 他の章やファイルなどへの参照説明
+* `//practice{ 〜 //}` : 練習問題
+* `//reference{ 〜 //}` : 参考情報
 
 ## 相互参照
 
-`//label[〜]`でラベルを定義し、`@<labelref>{〜}`で参照します。
-XMLとしては`<label id='〜' />`と`<labelref idref='〜' />`というタグに
-置き換えられます。
-実際にどのような相互参照関係にするかは、処理系に依存します。
-想定の用途では、章や節の番号およびタイトルを記憶し、labelrefの出現箇所
-に"「節(あるいは章)番号　タイトル」"という文字列を配置します。
+`//label[〜]` でラベルを定義し、`@<labelref>{〜}` で参照します。XML としては `<label id='〜' />` と `<labelref idref='〜' />` というタグに置き換えられます。
 
-`@<chapref>`の展開形式を、`--chapref="前装飾文字列,中間装飾文字列,後装飾文字列"`
-でコンパイル実行時に指定できます。デフォルトは`",「,」"`です。たとえば
-"`第2章「コンパイラ」`" のように普通は展開されます。
-`"「,　,」"`と指定すると、"`「第2章　コンパイラ」`" に展開されます。
+実際にどのような相互参照関係にするかは、処理プログラムに依存します。想定の用途では、章や節の番号およびタイトルを記憶し、labelref の出現箇所に `「節（あるいは章）番号　タイトル」` という文字列を配置します。
+
+`@<chapref>` の展開形式を、`--chapref="前装飾文字列,中間装飾文字列,後装飾文字列"` でコンパイル実行時に指定できます。デフォルトは`",「,」"`です。たとえば "`第2章「コンパイラ」`" のように普通は展開されます。`"「,　,」"`と指定すると、"`「第2章　コンパイラ」`" に展開されます。
 
 ## 丸数字
 
-`@<maru>{数値}` で丸数字を出力します。
+`@<maru>{数値}` で丸数字を出力します。UTF-8 の丸数字を直接使うほうが適切です。
 
 ## キートップ
 
-`@<keytop>{キー文字}` でキーボードマークを出力します。
+`@<keytop>{キー文字}` でキーボードマークを出力します（実際のフォントとの割り当て処理はフィルタや review-ext.rb で調整します）。
 
 ## 吹き出し
 
-`@<balloon>{〜}` でコード内などでの吹き出しを作成します。吹き出しは右に寄せ
-られ、記入した箇所から吹き出しまで線が引かれます。
-`@<>`オペレータは入れ子ができないため、丸数字を使いたいときには`@maru[数値]`
-という特別な書式を代わりに使います。
-
-## ロー指定
+`@<balloon>{〜}` でコード内などでの吹き出しを作成します。通常、吹き出しは右に寄せられ、記入した箇所から吹き出しまで線が引かれます。
 
-現時点で Re:VIEW はブロックの入れ子処理ができないため、ロー指定で XML
-エレメントを指定しなければならないこともあります。
-
-インラインの`@<raw>{ 〜 }`の他に、単一行の`//raw[〜]`、ブロック版の `//rawblock{ 〜 //}` でも、フォーマット処理をせずにそのままの文字列が出力できます。
+## DTP 命令指定
 
-## キャプションなし表
+`@<dtp>{ 〜 }` で「`<? dtp 〜 ?>`」という XML インストラクションを埋め込みます。処理系に渡す任意の文字列を指定できますが、次のような文字列を特殊文字指定できます。
 
-`//table{ 〜 //}` のように id もキャプションも付けないブロックを利用できます。
-この場合、その表の連番付けを飛ばします。
+* maru : 番号リストの各段落先頭で使い、このリスト段落の番号は丸数字であることを示す
+* return  改行記号文字
+* autopagenumber : 現ページ番号
+* nextpageunmber : 次ページ番号
+* previouspagenumber : 前ページ番号
+* sectionmarker : セクションマーカー
+* bulletcharacter : ビュレット (ナカグロ)
+* copyrightsymbol : 著作権記号
+* degreesymbol : 度記号
+* ellipsischaracter : 省略記号
+* forcedlinebreak : 強制改行
+* discretionarylinebreak : 任意の改行
+* paragraphsymbol : 段落記号
+* registeredtrademark : 登録商標記号
+* sectionsymbol : セクション記号
+* trademarksymbol : 商標記号
+* rightindenttab : 右インデントタブ
+* indentheretab : 「ここまでインデント」タブ
+* zerowidthnonjoiner : 結合なし
+* emdash : EMダッシュ
+* endash : ENダッシュ
+* discretionaryhyphen : 任意ハイフン
+* nonbreakinghyphen : 分散禁止ハイフン
+* endnestedstyle : 先頭文字スタイルの終了文字
+* doubleleftquote : 左二重引用符
+* doublerightquote : 右二重引用符
+* singleleftquote : 左用符
+* singlerightquote : 右引用符
+* singlestraightquote : 半角一重左用符
+* doublestraightquote : 半角二重引用符
+* emspace : EMスペース
+* enspace : ENスペース
+* flushspace : フラッシュスペース
+* hairspace : 極細スペース
+* nonbreakingspace : 分散禁止スペース
+* fixedwidthnonbreakingspace : 分散禁止スペース（固定幅）
+* textvariable : 全角スペース
+* thinspace : 細いスペース
+* figurespace : 数字の間隔
+* punctuationspace : 句読点等の間隔
+* sixthspace : 1/6スペース
+* quarterspace : 1/4スペース
+* thirdspace : 1/3スペース
+* columnbreak : 改段
+* framebreak : 改フレーム
+* pagebreak : 改ページ
+* oddpagebreak : 奇数改ページ
+* evenpagebreak : 偶数改ページ
+* footnotesymbol : 脚注記号
 
 ## 表セル幅の指定
 
-`//tsize[1列目の幅,2列目の幅,...]` で、続く `//table` の表の列幅を指定します
-(単位mm)。これを利用するときには、review2idgxml を実行する際、オプション
-`--table=表幅` を付ける必要があります (表幅の単位は mm)。列幅指定の個数が
-実際の列数に満たない場合、残りの列は均等分割したものとなります。列幅の
-合計が表幅を超えるとエラーになります。
+`//tsize[1列目の幅,2列目の幅,...]` で、続く `//table` の表の列幅を指定します（単位mm）。これを利用するときには、`review compile --target=idgxml` を実行する際、オプション`--table=表幅` を付ける必要があります（表幅の単位は mm）。列幅指定の個数が実際の列数に満たない場合、残りの列は均等分割したものとなります。列幅の合計が表幅を超えると警告が表示されます。
 
-## DTP 命令指定
+## 表セルの結合やスタイル指定
+`@<dtp>{table 表オプション}` を各セルに入れることで、そのセルの挙動を制御します。
 
-`@<dtp>{ 〜 }` で InDesign 向けに「`<? dtp 〜 ?>`」型の XML インストラクション
-を埋め込みます。処理系に渡す任意の文字列を指定できますが、次のような文字列
-を特殊文字指定できます。
+表オプションには次のものがあります。
 
-* maru	番号リストの各段落先頭で使い、このリスト段落の番号は丸数字であることを示す
-* return  改行記号文字
-* autopagenumber	現ページ番号
-* nextpageunmber	次ページ番号
-* previouspagenumber	前ページ番号
-* sectionmarker	セクションマーカー
-* bulletcharacter	ビュレット (ナカグロ)
-* copyrightsymbol	著作権記号
-* degreesymbol	度記号
-* ellipsischaracter	省略記号
-* forcedlinebreak	強制改行
-* discretionarylinebreak	任意の改行
-* paragraphsymbol	段落記号
-* registeredtrademark	登録商標記号
-* sectionsymbol	セクション記号
-* trademarksymbol	商標記号
-* rightindenttab	右インデントタブ
-* indentheretab	「ここまでインデント」タブ
-* zerowidthnonjoiner	結合なし
-* emdash	EMダッシュ
-* endash	ENダッシュ
-* discretionaryhyphen	任意ハイフン
-* nonbreakinghyphen	分散禁止ハイフン
-* endnestedstyle	先頭文字スタイルの終了文字
-* doubleleftquote	左二重引用符
-* doublerightquote	右二重引用符
-* singleleftquote	左用符
-* singlerightquote	右引用符
-* singlestraightquote	半角一重左用符
-* doublestraightquote	半角二重引用符
-* emspace	EMスペース
-* enspace	ENスペース
-* flushspace	フラッシュスペース
-* hairspace	極細スペース
-* nonbreakingspace	分散禁止スペース
-* fixedwidthnonbreakingspace	分散禁止スペース（固定幅）
-* textvariable	全角スペース
-* thinspace	細いスペース
-* figurespace	数字の間隔
-* punctuationspace	句読点等の間隔
-* sixthspace	1/6スペース
-* quarterspace	1/4スペース
-* thirdspace	1/3スペース
-* columnbreak	改段
-* framebreak	改フレーム
-* pagebreak	改ページ
-* oddpagebreak	奇数改ページ
-* evenpagebreak	偶数改ページ
-* footnotesymbol	脚注記号
+* `colspan=列数` : 右方向に結合
+* `rowspan=行数` : 下方向に結合
+* `type=名前` : セルの種類の指定
+* `align=位置` : セル内の内容の位置。通常の用途では left|center|right のいずれか

data/doc/pdfmaker.ja.md

@@ -0,0 +1,61 @@
+# LaTeX と review-pdfmaker について
+Re:VIEW の review-pdfmaker は、フリーソフトウェアの簡易 DTP システム「LaTeX」を呼び出して PDF を作成しています。
+
+そのため、利用にあたっては TeX の環境を別途セットアップしておく必要があります。OS に応じたセットアップについては、以下の TeX Wiki サイトなどを参照してください。
+
+#### TeX Wiki - TeX入手法
+* https://texwiki.texjp.org/?TeX入手法
+
+## Re:VIEW バージョンによる変化についての注意
+* Re:VIEW 2.0 より、LaTeX コンパイラのデフォルトが pLaTeX から upLaTeX になりました。以下の「upLaTeX について」を参照してください。
+* Re:VIEW 2.0 より、image タグに `scale` オプションを使って倍率数値を定義していた場合の挙動が変わりました。以下の「scale オプションの挙動について」を参照してください。
+* Re:VIEW 2.0 より、config.yml 等の設定ファイルで使われる `prt` のデフォルトが「発行所」ではなく「印刷所」になりました。「発行所」には `pbl` のほうをお使いください。
+
+## upLaTeX について
+
+2016年4月リリースの Re:VIEW 2.0 より、LaTeX のコンパイラのデフォルトが、「pLaTeX」から「upLaTeX」に切り替わりました。upLaTeX は pLaTeX の内部文字処理を Unicode 対応にしたもので、丸数字（①②…）のように pLaTeXでは otf パッケージが必要だった文字、あるいは韓国語や中国語との混植などを、直接扱うことができます。
+
+ほとんどの pLaTeX 向けのパッケージはそのまま動作しますが、jsbook クラスや otf パッケージなどでは uplatex オプションが必要です。
+
+LaTeX コンパイラコマンドおよびオプションについて、Re:VIEW の設定のデフォルトは次のとおりです。
+
+```yaml
+texcommand: uplatex
+texoptions: null
+texdocumentclass: ["jsbook", "uplatex,oneside"]
+dvicommand: dvipdfmx
+dvioptions: "-d 5"
+```
+
+## 旧来の pLaTeX を使用するには
+
+既存のドキュメントについて、利用しているマクロやパッケージが upLaTeX でうまく動かない、あるいはこれまでと異なる紙面ができてしまう場合は、pLaTeX に戻したいと思うかもしれません。
+
+Re:VIEW 2.0 よりも前のバージョンと同じコンパイラ設定に戻すには、config.yml に次のように記述します。
+
+```yaml
+texcommand: platex
+texoptions: "-kanji=utf-8"
+texdocumentclass: ["jsbook", "oneside"]
+dvicommand: dvipdfmx
+dvioptions: "-d 5"
+```
+
+レイアウト erb ファイル（デフォルトは lib/review/layout.tex.erb）において、upLaTeX と pLaTeX の区別は内部変数 texcompiler で行えます。変数 texcompiler には、パラメータ texcommand の値からフォルダパスとファイル拡張子を除いたものが入っており、pLaTeX の場合は "platex"、upLaTeX の場合は "uplatex" となります。使用例は次のとおりです。
+
+```
+<% if texcompiler == "uplatex" %>
+\usepackage[deluxe,uplatex]{otf}
+<% else %>
+\usepackage[deluxe]{otf}
+<% end %>
+```
+
+## scale オプションの挙動について
+Re:VIEW 2.0 より、``//image`` タグの第3オプションに ``scale=倍率`` で数値のみで倍率を指定していたときの挙動が変わりました。以前は「画像ファイルに対する倍率」でしたが、「紙面横幅に対する倍率」となります（もともと数値以外の文字も scale の値に含めていた場合には、変化はありません）。
+
+旧来の「画像ファイルに対する倍率」に戻したいときには、config.yml にパラメータ ``image_scale2width: false`` を指定してください（デフォルトは true）。
+
+```yaml
+image_scale2width: false
+```

data/doc/pdfmaker.md

@@ -0,0 +1,65 @@
+# LaTeX and review-pdfmaker
+
+The command `review-pdfmaker` in Re:VIEW use [LaTeX](https://en.wikipedia.org/wiki/LaTeX) to generate a PDF file.
+
+To use the command, you need to set up LaTeX system.
+
+
+## Important Changes about LaTeX in Re:VIEW 2.0
+
+* Default LaTeX compiler is upLaTeX, not pLaTeX.
+* The meaning of `scale` option in `@<image>` command is changed and configurable.
+* `prt` is printer, not publisher. You can use `pbl` for publisher.
+
+## about upLaTeX
+
+In Re:VIEW 2.0 released at April 2016, default LaTeX compiler became upLaTeX from pLaTeX.  The upLaTeX support Unicode and you can use unicode characters such like ①②... and other characters without otf package.
+
+Almost packages in pLaTeX can be supported in upLaTeX, but some package (such as jsbook class and otf package) need `uplatex` option.
+
+Default settings of Re:VIEW is below:
+
+```yaml
+texcommand: uplatex
+texoptions: null
+texdocumentclass: ["jsbook", "uplatex,oneside"]
+dvicommand: dvipdfmx
+dvioptions: "-d 5"
+```
+
+## How to use old pLaTeX
+
+You also use pLaTeX with Re:VIEW 2.0.
+
+To use pLaTeX, You can add these configuration in config.yml.
+
+```yaml
+texcommand: platex
+texoptions: "-kanji=utf-8"
+texdocumentclass: ["jsbook", "oneside"]
+dvicommand: dvipdfmx
+dvioptions: "-d 5"
+```
+
+You can use a variable `@texcompiler` to compare latex command in layout ERB files (lib/review/layout.tex.erb in default).
+The value of `@texcompiler` is `platex` (when using pLaTeX) and `uplatex` (when using upLaTeX).
+The usage is below:
+
+```
+<% if @texcompiler == "uplatex" %>
+\usepackage[deluxe,uplatex]{otf}
+<% else %>
+\usepackage[deluxe]{otf}
+<% end %>
+```
+
+## about `scale` option
+
+In Re:VIEW 2.0, the meaning of `scale=..` in the third option of ``//image`` command.
+The meaning in 1.0 is "scale for image file" (`1.0` is same as original image size), but the one in 2.0 is "scale for paper width" (`1.0` is same as paper widdth.)
+
+If you need the same behavior in Re:VIEW 1.x, you should add ``image_scale2width: false`` in config.yml (default value is `true`).
+
+```yaml
+image_scale2width: false
+```

data/doc/quickstart.ja.md

@@ -8,15 +8,17 @@ Re:VIEW は GNU Lesser General Public License Version 2.1 に基づいて配布
 
 このドキュメントでは、Re:VIEW のセットアップから変換の例までを簡単に説明します。
 
+このドキュメントは、Re:VIEW 2.0 に基づいています。
+
 ## セットアップ
 
-Re:VIEW は 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 のいずれかを使ってダウンロード・展開します。
 
-なお、Re:VIEW フォーマット自体は文字で表現されたタグが付いている以外は単なるテキストファイルなので、エディタ、OS についてはまったく制限はありません。
+なお、Re:VIEW フォーマット自体は文字で表現されたタグが付いている以外は単なるテキストファイルなので、エディタ、OS については UTF-8 文字エンコーディングさえ使用できれば制限はありません。
 
 ### RubyGems を使う場合
 
-機能セットがまとまった区切りごとに、Re:VIEW の開発チームが Re:VIEW の gem を更新しています。
+機能セットがまとまった区切りごとに、定期的に Re:VIEW の開発チームが Re:VIEW の gem を更新しています。
 
 次のように Re:VIEW の gem をインストールします。
 
@@ -32,6 +34,12 @@ Ruby gem の bin ディレクトリにパスを通すようにしておいてく
 $ gem update review
 ```
 
+Gemfile を使っている場合は、以下の行を Gemfile に追加して、`bundle`コマンドを実行します。
+
+```Gemfile
+gem 'review'
+```
+
 ### Gitを使う場合
 
 Re:VIEW は GitHub で開発されており、バージョン管理ツールの Git を使って最新の Re:VIEW コードを入手できます。Git は分岐が容易なので、独自のカスタマイズを施すのにも向いています。
@@ -50,28 +58,31 @@ review というディレクトリに展開されるので、review/bin にパ
 $ git pull
 ```
 
-### Subversionを使う場合
-
-Git の最新コピーは、別のバージョン管理ツールの Subversion 向けにも提供しています (古い環境では Subversion のクライアントしか入っていないことがあります)。
+## Re:VIEW ドキュメントの作成
 
-初めて取得するときには、次のようにします (コピーを作っています)。
+### 雛型の作成
+review-init コマンドを使って、雛型となる作業フォルダを作成できます。
 
-```bash
-$ svn co https://kmuto.jp/svn/review/trunk review
+```
+$ review-init ドキュメント名
 ```
 
-review というディレクトリに展開されるので、review/bin にパスを通すようにしておいてください。
-
-最新の開発に追従するには次のようにします。
+これで指定のドキュメント名のフォルダが用意され、中に次のようなファイルが置かれます。
 
-```
-$ svn up
-```
+ * ドキュメント名を冠した「.re」拡張子を持つファイル（Re:VIEW フォーマットテキストファイル）
+ * config.yml : 設定ファイル
+ * catalog.yml : カタログファイル（目次構成）
+ * Rakefile : rake コマンドのルールファイル
+ * images : 画像の配置フォルダ
+ * layouts : レイアウトファイルの配置フォルダ
+ * style.css : サンプルスタイルシート
+ * sty : スタイルファイル配置フォルダ（TeX 用）
 
-# Re:VIEW テキストの作成と変換
+review-init コマンドによらず、独自に作業フォルダを作成してもかまいません。
 
-セットアップを終えたら、Re:VIEW フォーマットのテキストを作り、変換できるようになります。次に Re:VIEW フォーマットテキストの簡単な例を示します。これを sample.re といった名前で保存します (拡張子も自由ですが、.re 拡張子を推奨します)。
+### Re:VIEW テキストの作成と変換
 
+デフォルトの re 拡張子のファイルは、「`=`」とあるだけのほぼ空っぽのファイルです。次に Re:VIEW フォーマットで記述を追加した簡単な例を示します。
 
 ```review
 = はじめてのRe:VIEW
@@ -95,85 +106,76 @@ $ svn up
 
  1. Ruby gem
  2. Git
- 3. Subversion
+ 3. Download from GitHub
 
-ホームページは@<tt>{https://github.com/kmuto/review/wiki/}です。
+ホームページは@<tt>{https://reviewml.org/}です。
 ```
 
-テキストファイルの文字エンコーディングには、UTF-8 を使うことをお勧めします。Re:VIEW は日本語文字エンコーディングとして UTF-8、EUC-JP、Shift_JIS、JIS を扱うことができ、入力ファイルについては自動判別、出力ファイルについても選択可能 (デフォルトは UTF-8) ですが、入力・出力のいずれにおいても、使用可能な文字についての制限が少ない UTF-8 が最適です。
+テキストファイルの文字エンコーディングには、UTF-8 を使用してください。
 
-次に、章構成ファイルの CHAPS ファイルを同じディレクトリに用意します。このファイルには、Re:VIEW フォーマットファイルの名前を格納します。
+### PDF 化と EPUB 化
 
-* sample.re
+review-pdfmaker コマンドで PDF ブックの作成、review-epubmaker コマンドで EPUB ファイルの作成ができます。
 
-CHAPS ファイルの1行目に書いたものが第1章、2行目に書いたものが第2章、……と構成されます (CHAPS に似たものとして、前付けを列挙する PREDEF ファイル、後付けを列挙する POSTDEF ファイルがあります。これらを「カタログファイル」と呼びます)。
+PDF を作成するには、TeXLive2012 以上の環境が必要です。EPUB を作成するには、rubyzip gem あるいは zip コマンドが必要です（MathML も使いたいときには、 [MathML ライブラリ](http://www.hinet.mydns.jp/?mathml.rb)も必要です）。
 
-sample.re から目的の形式に変換するには、review-compile コマンドを使います。
+いずれのコマンドも、必要な設定情報を記した YAML 形式ファイルを引数に指定して実行します。review-init コマンドで作成した環境には、デフォルトで config.yml として用意されているので、これを利用します。
 
 ```bash
-$ 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にする
-```
-
-上記では各ファイル個別に変換することを想定して、標準出力をリダイレクトする書式を掲載していますが、-a オプションを付ければ、CHAPS、PREDEF、POSTDEF に従ってすべてのファイルを変換できます。
-
-```
-$ review-compile --target html -a ←すべてのファイルをHTMLにする
-```
-
-sample.re を HTML に変換すると、次のようになります。
-
-```html
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xmlns:ops="http://www.idpf.org/2007/ops" xml:lang="ja">
-<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="Re:VIEW" />
-  <title>はじめてのRe:VIEW</title>
-</head>
-<body>
-<h1><a id="h1" />第1章　はじめてのRe:VIEW</h1>
-<div class="lead">
-<p>「Hello, Re:VIEW.」</p>
-</div>
-
-<h2><a id="h1-1" />1.1　Re:VIEWとは</h2>
-<p><b>Re:VIEW</b>は、EWBやRDあるいはWikiに似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。</p>
-<p>平易な文法ながらも、コンピュータ関係のドキュメント作成のための多くの機能を備えており、次のような形式に変換できます。</p>
-<ul>
-<li>テキスト（指示タグ付き）</li>
-<li>LaTeX</li>
-<li>HTML</li>
-<li>XML</li>
-</ul>
-<p>現在入手手段としては次の3つがあります。</p>
-<ol>
-<li>Ruby gem</li>
-<li>Git</li>
-<li>Subversion</li>
-</ol>
-<p>ホームページは<tt>https://github.com/kmuto/review/wiki/</tt>です。</p>
-</body>
-</html>
-```
-
-Re:VIEW フォーマットについての詳細は、 [format.rdoc](https://github.com/kmuto/review/blob/master/doc/format.rdoc) を参照してください。
-
-review-compile を含め、ほとんどのコマンドは `--help` オプションを付けるとオプションについてのヘルプが表示されます。`review-compile` には多数のオプションがあるので確認してください。
-
-なお、`--target` で毎回指定するのは面倒なので、`review-compile` に対するシンボリックリンクを作成しておくとよいでしょう。「review2...」のコマンド名で呼び出せるようになります。
+$ review-pdfmaker config.yml  ←PDFの作成
+$ review-epubmaker config.yml ←EPUBの作成
+```
+
+rake コマンドを利用できるなら、次のように実行することもできます。
 
 ```bash
-$ cd Re:VIEWのインストールされたパス/bin
-$ ln -s review-compile review2text
-$ ln -s review-compile review2html
-$ ln -s review-compile review2latex
-$ ln -s review-compile review2idgxml
+$ rake pdf  ←PDFの作成
+$ rake epub ←EPUBの作成
+```
+
+config.yml のサンプルについては以下を参照してください。
+
+* [config.yml.sample](https://github.com/kmuto/review/blob/master/doc/config.yml.sample)
+
+### 章を増やす、カスタマイズする
+作成した 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](https://github.com/kmuto/review/blob/master/doc/catalog.ja.md) を参照してください。
+
+### 情報
+Re:VIEW フォーマットについての詳細は、 [format.ja.md](https://github.com/kmuto/review/blob/master/doc/format.ja.md) を参照してください。
+
+Re:VIEW の使用実例については、https://github.com/reviewml/review-samples にもまとめています。
+
+## ファイル単位の変換
+通常の用途では review-pdfmaker や review-epubmaker で事足りるはずですが、それ以外の形式に変換したり、PDF や EPUB の変換にあたってどのような変換が行われているのかを確認したりしたいときには、review-compile コマンドを使用します。
+
+たとえば sample.re ファイルを変換するには次のようになります。
+
+```bash
+$ 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` オプションを付けるとオプションについてのヘルプが表示されます。
 
 ## プリプロセッサ、ボリューム表示
 
@@ -198,25 +200,13 @@ $ review-vol
 $ review-index --level 掘り下げる見出しレベル数 -a
 ```
 
-## PDF 化と EPUB 化
-
-review-pdfmaker コマンドで PDF ブックの作成、review-epubmaker コマンドで EPUB ファイルの作成ができます。
-
-PDF を作成するには、TeXLive2012 以上の環境が必要です。EPUB を作成するには、zip コマンドが必要です (MathML も使いたいときには、 [MathML ライブラリ](http://www.hinet.mydns.jp/?mathml.rb)も必要です)。
-
-いずれのコマンドも、必要な設定情報を記した YAML ファイルを引数に指定して実行します。YAML ファイルのサンプルは、 [sample.yml](https://github.com/kmuto/review/blob/master/doc/sample.yml) としてこのドキュメントと同じディレクトリに収録しています。
-
-```bash
-$ review-pdfmaker YAMLファイル  ←PDFの作成
-$ review-epubmaker YAMLファイル ←EPUBの作成
-```
-
 ## クレジット
 
-Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2014年3月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
+Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2016年4月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
 
 バグ・パッチの報告、開発者用メーリングリストなどについての情報は、
 
+* http://reviewml.org/
 * https://github.com/kmuto/review/wiki
 
 を参照してください。