format.rdoc in review-1.2.0

- old
+ new

@@ -1,8 +1,8 @@
-= ReVIEW フォーマット
+= Re:VIEW フォーマット
 
-ReVIEW フォーマットの文法について解説します。ReVIEW
+Re:VIEW フォーマットの文法について解説します。Re:VIEW
 フォーマットは ASCII の EWB を基本としながら、一部に
 RD や各種 Wiki の文法をとりいれて簡素化しています。
 
 == 段落
 
@@ -224,10 +224,25 @@
 //image で指定した識別子を用いて「@<img>{unixhistory}」と
 記述します。//image と @<img> でつづりが違うので注意してください。
 
 なお、後述しますが、インラインで図を出力するには@<icon>を使用します。
 
+図として貼り込む画像ファイルは、次の順序で探索され、最初に発見されたものが利用されます。
+
+1. <imgdir>/<builder>/<chapid>/<id>.<ext>
+2. <imgdir>/<builder>/<chapid>-<id>.<ext>
+3. <imgdir>/<builder>/<id>.<ext>
+4. <imgdir>/<chapid>/<id>.<ext>
+5. <imgdir>/<chapid>-<id>.<ext>
+6. <imgdir>/<id>.<ext>
+
+* <imgdir> はデフォルトでは images ディレクトリです。
+* <builder> は利用しているビルダ名 (ターゲット名) で、たとえば --target=html としているのであれば、images/html ディレクトリとなります。
+* <chapid> は re ファイルの名前に相当します。たとえば ch01.re という名前であれば「ch01」です。
+* <id> は //image[〜] の最初に入れた「〜」のことです (つまり、ID に日本語や空白交じりの文字を使ってしまうと、後で画像ファイル名の名付けに苦労することになります!)。
+* <ext> は Re:VIEW が自動で判別する拡張子です。ビルダによってサポートおよび優先する拡張子は異なります。
+
 == 番号が振られていない図
 
 //indepimage[ファイル名][キャプション] で番号が振られていない画像ファイルを生成します。キャプションは省略できます。
 
 例:
@@ -315,11 +330,13 @@
 
 footnotetextオプションを使うには、YAMLファイルのparamsに「--footnotetext」を追加します。
 
 これでPDFのコラムや表のなかでも脚注が使えるようになります。
 
-ただし、通常の脚注(footnote)ではなく、footnotemarkとfootnotetextを使うため、本文と脚注が別ページに分かれる可能性があるなど、いろいろな制約があります。
+ただし、通常の脚注(footnote)ではなく、footnotemarkとfootnotetextを使うため、
+本文と脚注が別ページに分かれる可能性があるなど、いろいろな制約があります。
+なお、採番が別々になるためfootnoteとfootnotemark/footnotetextを両立させることはできません。
 
 == 参考文献の定義
 
 参考文献は同一ディレクトリ内の bib.re に定義します。
 //bibpaper[cite][キャプション]{..コメント..}
@@ -391,11 +408,11 @@
 
   @<comment>{あとで書く}
 
 == 生データ行
 
-ReVIEW のタグ範囲を越えて何か特別な行を挿入したい場合、//raw を使います。
+Re:VIEW のタグ範囲を越えて何か特別な行を挿入したい場合、//raw を使います。
 
 例:
 
   //raw[|html|<div class="special">\nここは特別な行です。\n</div>]
 
@@ -417,11 +434,11 @@
 //raw およびこの後に紹介する @<raw> インラインタグは、誤った内容を入れると
 構造化文書を容易に破壊し得ることに注意してください。
 
 == その他の文法
 
-ReVIEW は任意のブロックを追加可能なので、本によって専用ブロックを
+Re:VIEW は任意のブロックを追加可能なので、本によって専用ブロックを
 使う場合があります。これまでに使った例を以下に示します。
 
 //prototype:: 関数プロトタイプ。『ふつうのLinuxプログラミング』で使用。
 //type:: 関数の型宣言。『ふつうのHaskellプログラミング』で使用。
 
@@ -566,10 +583,10 @@
   @<href>{chap1.html#point1, ドキュメント内ポイント}
   //label[point1]
 
 == 国際化(i18n)
 
-ReVIEWが出力する文字列(「第◯章」「図」「表」など）を、指定した言語に
+Re:VIEWが出力する文字列(「第◯章」「図」「表」など）を、指定した言語に
 合わせて出力することができます。デフォルトは日本語です。
 
 CHAPS などと同じディレクトリに locale.yaml というファイルを用意して、
 以下のように記述します（日本語の場合）。
 