Next: , Previous: Two Arguments, Up: xref


8.2.3 三つの引数を用いた

三番目の引数は,TeX出力のノード名を置換します.三番目の引数は,印刷物 でのセクション名にするか,セクションで述べられているトピックを述べるべき です.参照を印刷したとき読みやすいように,頭文字を大文字にしたいことも多 いでしょう.構文や意味としてノード名が適切でないときは,三番目の引数を使 用してください.

相互参照のタイトルやトピックや,その他のあらゆるセクションで,カンマの配 置を避けることを覚えておいてください.フォーマッタは,カンマに従い引数の 相互参照を分けます.タイトルやセクションのカンマは,それを二つの引数に分 けます.参照では,タイトルをカンマ無しで“Clouds, Mist, and Fog”のよう に書く必要があります.

また,相互参照を終了するために,カンマやピリオドを@xrefの閉じカッ コの後に書くことを覚えておいてください.以下の例では,文節が終端のカンマ に付きます.

テンプレートは以下のようになります.

     @xref{node-name, cross-reference-name, title-or-topic}.

例えば,以下のようにします.

     @xref{Electrical Effects, Lightning, Thunder and Lightning},
     for details.

以下を生成します.

     *Note Lightning: Electrical Effects, for details.

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

See Section 5.2 [Thunder and Lightning], page 57, for details.

三番目の引数が与えられていて,二番目が空の場合,三番目の引数が両方に与え られます.(二つのカンマが並んで,二番目の引数が空だということを示してい る方法に注意してください.)

     @xref{Electrical Effects, , Thunder and Lightning},
     for details.

以下を生成します.

     *Note Thunder and Lightning: Electrical Effects, for details.

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

See Section 5.2 [Thunder and Lightning], page 57, for details.

実際問題として,ノード名とセクションタイトルが同じ場合は,相互参照を最初 の引数で書き,ノード名とタイトルが異なる場合は,一番目と三番目の引数で書 くことが最善です.

The GNU Awk User's Guideでいくつかの例は以下のようになっています.

     @xref{Sample Program}.
     @xref{Glossary}.
     @xref{Case-sensitivity, ,Case-sensitivity in Matching}.
     @xref{Close Output, , Closing Output Files and Pipes},
       for more information.
     @xref{Regexp, , Regular Expressions as Patterns}.