次: , 前: Predefined Indices, 上: Indices


12.3 索引の項目の定義

索引を作成するデータは,Texinfoソースファイル中に散らばってる多くの個別 の索引コマンドからきます.それぞれのコマンドは,一つの項目を特定の索引に 加わるよう伝えます.書式化後,索引は現在のページ番号や参照するノード名を 与えます.

索引項目は,行の最初に索引コマンドを書き,残りの行に項目と続けることから 成り立ちます.

例えば,このセクションは,概念索引のため五つの項目が続いています.

     @cindex Defining indexing entries
     @cindex Index entries
     @cindex Entries for an index
     @cindex Specifying index entries
     @cindex Creating index entries

それぞれの前もって定義された索引は,それ自身の索引コマンドがあります — それは,概念索引に対する@cindex,関数索引に対する@findex などです.

概念の索引項目は,テキストから成り立ちます.索引を書く最も良い方法は,簡 潔且つ明確な項目を選択することです.こうすることが可能な場合,項目が大文 字化されておらず,文の内部に現れるものを書く方が,索引は見栄えが良くなり ます.(常に大文字で書かれる固有名前や頭字語を大文字化してください.)これ は,我々がほとんどのGNUマニュアルの索引で使用する慣習している事実です.

簡潔且つ明確な項目を作成する方法を知らない場合,より長い明確なものを作成 してください — 簡潔で紛らわしいものを作成しないでください.項目の多く が数単語の場合,異なる慣習(それぞれの項目の最初の単語を大文字にする)を使 用した方が索引は良く見えます.しかし,CやLispの関数名やシェルコマンドの ような大文字小文字を識別する名前を大文字化してはいけません.それはスペル エラーとなります.

どちらを慣習として使用した場合でも,それを慣習として使用してください!

概念の索引以外の索引の項目は,プログラム言語やプログラム名のシンボル名で す.これらの名前は通常大文字小文字を識別するので,それらが要求する大文字 または小文字を使用してください.

デフォルトで,概念の索引の項目は小さなローマンフォントで印刷され,他の索 引の項目は@codeフォントで印刷されます.項目の一部の印刷方法を, ファイル名に対する@fileや,強調に対する@emphのような (see Marking Text),通常のTexinfoコマンドで変更してもかまいません. 前もって定義されている六つの索引コマンドは以下のものがあります.

@cindex concept
conceptに対して概念の索引の項目を作成します.
@findex function
functionに対して関数の索引の項目を作成します.
@vindex variable
variableに対して変数の索引の項目を作成します.
@kindex keystroke
keystrokeに対してキー索引の項目を作成します.
@pindex program
programに対してプログラムの索引の項目を作成します.
@tindex data type
data typeに対してデータ型の索引の項目を作成します.
注意:索引項目にコロンを使用しないでください.Infoでは,コロンは ノード名と項目名を分離するので,項目自身のコロンでInfoは混乱します.メ ニュー項目の構造の詳細は,See The Parts of a Menu.

それらの標準的な目的のために,前もって定義されている索引を実際に使用する ことを要求されているわけではありません.例えば,Cプリプロセッサマクロの 索引を望む場合を考えます.それらに対し@findexコマンドを書くこと で,それらを実際の関数に属する関数索引に書くことが可能です.そして,番号 付けされていない章として“関数の索引”を印刷するとき,タイトルに`関数と マクロの索引'を与えることで読者に対しも全く矛盾しません.または,マクロ を@tindexコマンドでデータ型に書き,それに適した索引タイトルを与 えると読者は理解できるでしょう.(See Printing Indices & Menus.)