format.rdoc in review-1.1.0

- old
+ new

@@ -257,13 +257,11 @@
 == 表
 
 表は //table[識別子][キャプション]{ 〜 //} です。ヘッダと内容を
 分ける罫線は「------」で書き込んであります。
 
-カラム間は任意個数のタブで区切ります。また、カラム先頭の「.」は削
-除されるので、カラムの先頭文字が「.」の場合は「.」をもう一つ余計に
-付けてください。例えば「.」という内容のカラムは「..」と書きます。
+カラム間は任意個数のタブで区切ります。また、カラム先頭の「.」は削除されるので、カラムの先頭文字が「.」の場合は「.」をもう一つ余計に付けてください。例えば「.」という内容のカラムは「..」と書きます。
 また、空のカラムは「.」と書けます。
 
 例:
 
   //table[envvars][重要な環境変数]{
@@ -309,16 +307,26 @@
   //footnote[site][本書のサポートサイト： http://i.loveruby.net/ja/stdcompiler ]
 
 本文中の「@<fn>{site}」は脚注番号に置換され、「本書のサポート
 サイト……」という文は実際の脚注に変換されます。
 
+注意: PDFで、コラムや表など平文でないところで「@<fn>{～}」を使うには、footnotetextオプションを使う必要があります。
+
+=== footnotetextオプション
+
+footnotetextオプションを使うには、YAMLファイルのparamsに「--footnotetext」を追加します。
+
+これでPDFのコラムや表のなかでも脚注が使えるようになります。
+
+ただし、通常の脚注(footnote)ではなく、footnotemarkとfootnotetextを使うため、本文と脚注が別ページに分かれる可能性があるなど、いろいろな制約があります。
+
 == 参考文献の定義
 
 参考文献は同一ディレクトリ内の bib.re に定義します。
-//bibpaper[site][キャプション]{..コメント..}
+//bibpaper[cite][キャプション]{..コメント..}
 コメントが無い場合も定義可能です。
-//bibpaper[site][キャプション]
+//bibpaper[cite][キャプション]
 
 例:
 
   //bibpaper[lins][Lins, 1991]{
   Refael D. Lins. A shared memory architecture for parallel study of
@@ -357,18 +365,16 @@
 
 == 空白制御
 
 出力される空白を制御するタグとしては、//noindentがあります。
 
-//noindent:: その直後に来る段落冒頭のインデントをなくする(HTMLではnoindentクラスになる)
+//noindent:: その直後に来る段落冒頭のインデントをなくす(HTMLではnoindentクラスになる)
 
 以前あった「//linebreak」(改行)、「//pagebreak」(改ページ)は廃止になります。
 
 == コメント
 
-以前は「//comment」というタグがありましたが、廃止されます。
-
 最終結果に出力されないコメントを記述したい場合は「#@#」を使ってください。
 
 例:
 
   #@# ここで 1 行あける
@@ -377,10 +383,16 @@
 
 例:
 
   #@warn(あとで書く)
 
+最終結果に出力するコメントを記述したい場合は、//commentまたは@<comment>を使った上で、review-compileコマンドに--draftオプションを追加してください。
+
+例:
+
+  @<comment>{あとで書く}
+
 == 生データ行
 
 ReVIEW のタグ範囲を越えて何か特別な行を挿入したい場合、//raw を使います。
 
 例:
@@ -411,12 +423,36 @@
 使う場合があります。これまでに使った例を以下に示します。
 
 //prototype:: 関数プロトタイプ。『ふつうのLinuxプログラミング』で使用。
 //type:: 関数の型宣言。『ふつうのHaskellプログラミング』で使用。
 
-拡張文法はreview-ext.rbというファイルで指定できますが、ここでは詳しく触れません。
+拡張文法はreview-ext.rbというファイルで指定できます。
+例えば、
 
+    # review-ext.rb
+    ReVIEW::Compiler.defblock :foo, 0..1
+ 
+    class ReVIEW::HTMLBuilder
+      def foo(lines, caption = nil)
+        puts lines.join(",")
+      end
+    end
+
+のようにすると、以下のような文法を追加できます。
+
+    //foo{
+    A
+    B
+    C
+    //}
+    
+    # 出力結果
+    A,B,C
+
+詳しいことについては、ここでは触れません。
+
+
 == 段落中で使う文法 (インライン命令)
 
 @<list>{program}:: 「リスト1.5」のような文字列に置換される。
 @<img>{unixhistory}:: 「図1.3」のような文字列に置換される。
 @<table>{ascii}:: 「表1.2」のような文字列に置換される。
@@ -426,16 +462,18 @@
 @<title>{advanced}:: その章の章題に置換される。
 @<chapref>{advanced}:: 『第17章「さらに進んだ話題」』のように、章番号とタイトルを含むテキストに置換される。
 @<bou>{ふさわしい}:: 傍点。
 @<ruby>{直截, ちょくせつ}:: ルビ。
 @<ami>{重点ポイント}:: 文字に対するアミかけ。
-@<b>{どうしても}:: 太字。
-@<em>{どうしても}:: 太字(強調)。
+@<b>{どうしても}:: 太字 (ボールド)。
 @<i>{どうしても}:: イタリック。
+@<strong>{どうしても}:: 強調。
+@<em>{どうしても}:: 強調。
 @<tt>{foo($bar)}:: テキストをテレタイプ文字(等幅フォント)で出力する。
 @<tti>{FooClass}:: テキストをテレタイプ文字(等幅フォント)のイタリックで出力する。
 @<ttb>{BarClass}:: テキストをテレタイプ文字(等幅フォント)の太字で出力する。
+@<u>{下線}:: 下線。
 @<br>{}::  段落中改行。
 @<m>{a + \alpha}:: TeXインライン式。
 @<icon>{samplephoto}:: インライン画像。
 @<uchar>{2460}:: Unicode文字の出力。引数は16進数で指定する。
 @<href>{http://www.google.com/}:: リンク。URLで指定できる
@@ -502,9 +540,17 @@
 他の章を参照したい場合は、先頭に章のidを指定してください。  
 
 例:
 
   @<hd>{preface|はじめに|まずわ}
+
+参照先にラベルが設定されている場合は、ラベルで参照します。
+
+  =={hajimeni} はじめに
+  :
+  === まずわ
+  :
+  @<hd>{hajimeni|まずわ}
 
 == リンク
 
 Web ハイパーリンクを記述するには、リンクに @<href>、アンカーに //label
 を使います。リンクの書式は @<href>{URL, 文字表現} で、「, 文字表現」を