Next: , Previous: Cross Reference Commands, Up: Cross References


8.2 相互参照の部品

相互参照のコマンドは一つの引数のみを要求し,それは参照するノード名です. しかし,相互参照コマンドは四つの追加の引数を含むことができます.これらの 引数を使用することで,Infoに対する相互参照名,トピックの記述や印刷物での セクションのタイトル,異なるInfoファイルの名前,そして異なる印刷されたマ ニュアルの名前を提供することが可能になります.

簡単な相互参照の例は以下のようになります.

     @xref{Node name}.

これは,以下を生成します.

     *Note Node name::.

そして,以下を生成します.

See Section nnn [Node name], page ppp.

完全な五つの部分を持つ相互参照は以下のようになります.

     @xref{Node name, Cross Reference Name, Particular Topic,
     info-file-name, A Printed Manual}, for details.

これは,以下を生成します.

     *Note Cross Reference Name: (info-file-name)Node name,
     for details.

Infoではこうなります.

See section “Particular Topic” in A Printed Manual, for details.

印刷された本ではこうなります.

相互参照に対する五つの利用可能な引数は,以下の通りです.

  1. ノードやアンカー名です(必須).これは,相互参照がたどっていく場所です.印 刷されたドキュメントでは,ノードの場所は同じドキュメント内を参照するため だけのページ参照を提供します.
  2. 相互参照名がノード名と異なっている場合のInfo参照に対する相互参照名です. この引数を含める場合,それは相互参照の最初の部分になります.通常省略され ます.
  3. トピックの記述やセクション名です.これはよくセクションのタイトルになりま す.これは印刷されたマニュアルでの参照名として使用されます.省略された場 合,ノード名が使用されます.
  4. 参照先が現在のファイルと異なる場合,参照先があるInfoファイル名です.Info リーダは自動的に追加するので,ファイル名の‘.info’接尾子は不要です.
  5. 異なるTexinfoファイルで印刷されたマニュアル名です.

完全な五つの引数を持つ相互参照のテンプレートは,以下のようになります.

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

一つ,二つ,三つ,四つ,そして五つの引数を持つ相互参照は,@xref の記述に続けて,別々に記述されます.

相互参照では,@node行と正確に同じ方法で,同じように大文字小文字 を使用して,ノード名を書いてください.そうしない場合,フォーマッタは参照 を見つけることができません.

段落で相互参照を書くこともできますが,InfoとTeXが,それぞれの様々なコ マンドの出力をどのようにして書式化するのかに注意してください.それは, @xrefを文の最初に書く.@pxrefをカッコ内でのみ書くなどで す.