次: Node Line Tips, 前: Node Names, 上: node
@node
行の書き方
@node
行の最も簡単な書き方は,@node
を行の最初に書き,その
後にノード名を以下のように書く方法です.
@node node-name
GNU Emacsを使用している場合,ポインタ名を挿入するために,Texinfoモードで
ノードの更新コマンドが提供されています.また,ポインタをTexinfoファイル
の外に置き,makeinfo
でノードポインタを作成するInfoファイルに挿入
することも可能です.(See Texinfo Mode. またmakeinfo Pointer Creationを参照してください.)
代わりに,`Next',`Previous',そして`Up'ポインタを独自に挿入することも可 能です.こうする場合,TexinfoモードでキーボードコマンドのC-c C-c n を使用すると便利だと思います.このコマンドは,`@node'と,適切な順 番でポインタ名をリストアップしたコメント行を挿入します.コメント行は,引 数がどのポインタに対するものかを,追跡記録するのに役立ちます.このコメン ト行は,Texinfoに精通していない場合,特に便利です.
`Next',`Previous',そして`Up'ポインタがある,完全に書かれたノード行のテ ンプレートは以下のようになります.
@node node-name, next, previous, up
希望があれば,初稿では@node
行を完全に無視することが可能で,その
後でtexinfo-insert-node-lines
コマンドを@node
行を作成する
ために使用してください.しかし,この方法はお勧めしません.その部分を書く
と同時にそれ自身のノードに名前を付ける方が良く,そうすることで相互参照を
作成しやすくなります.相互参照が多数あることは,良いInfoファイルの特徴と
して特に重要です.
@node
行を挿入した後,すぐに@-コマンドを章やセクションに対し書き,
名前を挿入するべきです.次に(これが肝心!),いくつかの索引項目を書いてく
ださい.通常,少なくとも二つ書き,索引でノードを参照する方法として,四つ
または五つあることもよくあります.これで,人々がノードをより容易に見つけ
られるようになります.