Next: , Up: 5


5.1 相互参照コマンドの書式

相互参照コマンドの書式は以下のようになります。@xref の部分は相互参照コマンドの種類により異なります。

     @xref{node-name, cross-reference-name, topic, info-file-name, printed-manual-name}, details.

引数で必要とするのは参照先のノード名 (node-name) のみで、他は省略できます。details はそれがどのような相互参照なのかを説明するもので、省略時はコンマごと `, details' を省略します。

引数はコンマで区切られるので、フォーマッタがセパレータと誤認しないよう、引数にコンマを含めるのは避けるようにしてください。また、@pxref コマンド1 を除き、相互参照はその終わりを識別するため、最後(波括弧の外)にピリオドを必要とします。

例.

     @xref{node-name}, details.
     
     @xref{node-name, , topic}.

波括弧内の引数はコンマで区切り以下の順で記述します。コンマの前後の空白は無視されます。

  1. node-name

    参照する先のノード名。省略不可。HTML, Info では指定したノードが参照先となり、印刷物ではこれにより参照先のページ番号が得られます。

  2. cross-reference-name

    HTML, Info での相互参照名。相互参照名をノード名 (node-name) と異なるものとしたいとき指定します。省略時はノード名となります。

  3. topic

    印刷物での相互参照名。相互参照名をノード名 (node-name) と異なるものとしたいとき指定します。省略時はノード名となります。

  4. info-file-name

    参照先の Info ファイル名。参照先が別の Info ファイルであるとき指定します。拡張子は必要ありません。

  5. printed-manual-name

    参照先の印刷物。参照先が別の印刷物であるとき指定します。この引数を指定すると、斜体で表示されます。


Footnotes

[1] See 括弧内で使用する相互参照.