索引の書き方 <indexterm>

索引に掲載する語句を指定するには、indexterm要素を使います。DITA Open Toolkit Ver1.4.3では、出力タイプがPDF、HTML Help、JavaHelp、EclipseHelpのときに索引が生成されます。

indexterm要素のコンテンツは、索引の生成とHTMLの検索性を向上するために使われ、本文中には表示されません。索引の指定に関する要素には、indexterm要素の他にindex-see, index-see-also, index-sort-as要素などがあります。indexterm要素とこれらの要素を組み合わせることにより、高度な索引の指定が可能です。

制約事項:

DITAおよびDITA Open Toolkitの索引機能には以下の特徴があります。

国際化されている
日本語のロケールを指定することにより、記号、数字、アルファベット、ひらがな(カタカナと漢字を含む)といった分類で語句をソートし、索引を作成できます。
階層構造を持った索引を作成できる
マルチ・レベルの階層構造を持った索引を作成できます。
関連語句の参照を指定できる
ある語句に関連する語句を指定し、索引に表示できます。
代替語句の参照を指定できる
ある語句の代替語句を指定し、索引に表示できます。

DITAでは、トピックに対して索引を設定します。Wordなどの文書では本文中の任意の箇所に索引語を設定するのに対し、DITAではトピックごとに、そのトピックに含まれる重要な語句を索引語として設定します。トピックに索引語を指定するには、body要素の直前にprolog要素を挿入し、prolog→metadata→keywords→indextermという構造でindexterm要素を挿入します(下図参照)。



トピックにindexterm要素を挿入する

ヒント: 本文中にindexterm要素を挿入することもできますが、推奨しません。理由は、索引に掲載する語句の情報は、トピックに付随するメタデータと考えた方が、トピック指向の考え方にマッチするためです。