4. Texinfoファイルを終える

Texinfoファイルの終りには，索引を作成するコマンドと，(おそらく)完全なも のと概要の目次を生成するコマンドを含めるべきです．最後に，処理する最終行 に印を付ける@byeコマンドを含んでいる必要があります．

例えば，以下のようにします．

@node Index
@unnumbered Index

@printindex cp

@shortcontents
@contents

@bye

4.1 索引メニューと索引の印刷

索引を印刷するということは，マニュアルやInfoファイルの一部としてそれを含 めることを意味します．これは，@cindexやその他の索引項目を生成す るコマンドをTexinfoファイルで使用しているだけでは，自動的に発生しません． それらは索引のため生データを蓄積します．索引を生成するため， @printindexコマンドをドキュメントの索引を書きたい場所に含める必 要があります．また，印刷されたマニュアルを作成する過程でソートされた索引 ファイルを生成する際，生データをソートするためにtexindexと呼ばれ るプログラム(see section 19. 書式化とハードコピーの出力)を実行する必要もあります．ソートされた索引 ファイルは索引の印刷で実際に使用されます．

Texinfoは，前もって定義された六つの個別の形態の索引を提供していて，それ ぞれ以下の表で示す二文字の省略を用いています．しかし，索引を統合したり (see section 12.4 索引の統合)，独自の索引を定義(see section 12.5 新しい索引の定義)しても かまいません．

以下は前もって定義されている索引，その省略，そしてそれに対応する索引項目 コマンドです．

`cp'

概念の索引(@cindex)

`fn'

関数の索引(@findex)

`vr'

変数の索引(@index)

`ky'

キーの索引(@kindex)

`pg'

プログラムの索引(@pindex)

`tp'

データ型の索引(@tindex)

@printindexコマンドは二文字の索引の省略を引数として，対応するソー トされた索引ファイルを読み込み，索引内に適切に書式化します．

@printindexコマンドは索引に対する章の見出しを生成しません．した がって，章の見出しを提供し索引を目次に含めるため，適切なセクションや章コ マンド(通常@unnumbered)の前に@printindexコマンドを書くべ きです．@unnumberedコマンドを@node行に前置してください．

例えば，以下のようにします．

@node Variable Index
@unnumbered Variable Index

@printindex vr

@node Concept Index
@unnumbered Concept Index

@printindex cp

見つけ易くするため，概念の索引を最後に配置することを推奨します．また，読 者が見る場所を一つだけにするため，可能な限り索引を一つにすることを推奨し ます(see section 12.4 索引の統合)．

4.2 目次の生成

@chapter，@section，そしてその他の構造化コマンドは，目次 を作成する情報を供給していますが，実際の表をマニュアルに表示しません．こ うするため，@contentsと/または@summarycontentsコマンドを 使用する必要があります．

@contents

印刷されたマニュアルに目次を生成し，それは，全ての章，セクション，サブセ クションなど，付録や番号付けされない章まで含みます．@headingと同 列のコマンドで生成された見出しは目次に現れません．

@shortcontents

@summarycontents

(@summarycontentsは@shortcontentsと同義語です．)

章，付録，そして番号付けされない章のみをリストアップした，短い，または， 概要の目次を生成します．セクション，サブセクション，そしてサブサブセクショ ンは削除されます．長いマニュアルのみ，完全な目次への追加として短い目次が 必要です．

どちらの目次コマンドも単独行に書くべきです．目次コマンドは，自動的に章の ような見出しを最初の目次ページのトップに生成するので，その前に @unnumberedのようなセクションコマンドを含めないでください．

Infoファイルは目次の代わりにメニューを使用するので，Indo書式化コマンドは， 目次コマンドを無視します．しかし，makeinfoで標準出力に出力を書い ていない限り，目次は(makeinfo --no-headersで生成される)プレーンテ キスト出力には含まれます．

HTML出力を生成する際にmakeinfoで短い目次を書いているとき，短い目 次のリンクは，ドキュメントのテキストではなく，完全な目次の対応する項目を 指し示します．完全な目次のリンクは，ドキュメントの主なテキストを指し示し ます．

目次コマンドは，ファイルの最後の索引(前のセクションを参照してください) の後の@bye(次のセクションを参照してください)の直前，または，ファ イルの最初の@end titlepage(see section 3.4.1 @titlepage)の後に配置すること が可能です．前者の利点は，行われた処理を参照するため，目次出力が常に更新 されることです．後者の利点は，目次が適切な場所に印刷されることで，DVIファ イルをdviselectで再配列したり，紙を並べ変える必要が無くなりま す．

著者として，目次コマンドを好きなところに書くことが可能です．しかし，単に マニュアルを印刷するだけのユーザは，たとえ著者が目次コマンドをドキュメン トの最後に書いている場合でも，(ここで書かれているような，ほとんどの既存 のTexinfoドキュメントのように)目次をタイトルページの後に書きたいと思うか もしれません．これは，@setcontentsaftertitlepageと/または， @setshortcontentsaftertitlepageで指定することが可能です．最初の ものは，@end titlepageの後に主な目次のみ印刷します．二番目のもの は，短い目次と主な目次の両方を印刷します．どちらの場合でも，それに続く @contentsや@shortcontentsは(@end titlepageがない 場合は)無視されます(@end titlepage．

@set...contentsaftertitlepageを，ドキュメントの最初の方(例え ば@setfilenameの直後)に含める必要があります．ソースファイルの変 更無しでこれを指定するためtexi2dvi (see section 19.3 texi2dviでの書式化)の使用を推奨します．例えば，以下のようにします．

texi2dvi --texinfo=@setcontentsaftertitlepage foo.texi

4.3 ファイルの終りの@bye

@byeコマンドはTexinfoの処理を終了します．@bye以降を読み 込むフォーマッタは存在しません．@byeは単独行にすべきです．

お望みなら，@bye行に注釈を続けてもかまいません．これらの注釈は書 式化されず，Infoや印刷されたマニュアルに現れません．それは，@bye 後のテキストが@ignore...@end ignoreにあるかのように なります．また，@bye行にEmacsに対するローカルな変数リストを続け てもかまいません．詳細は，See section Using Local Variables and the Compile Command.