索引の作成

ヘルプ・ボリュームの索引は本の索引と似ています。設計者にとって、トピックの索引エントリを作成することは大切です。それによって、ユーザがキーワードや概念で検索できます。詳細な索引が作成されていると、ユーザはすばやく正確にトピックを見つけられます。

索引エントリをマークするには

索引に入れたいトピックの中で、<idx> 要素を次のように使用します。

   <idx>keyword<¥idx>  

略式では、

   <idx|keyword|

エントリをソートするには、<sort> 副要素を次のように使用します。

   <idx>keyword<sort>sortkey<¥idx> 

keyword は索引に表示したいテキストで、sortkey はソート時に使用されるテキストです。

<idx> 要素はトピック内のどこでも使用できます。keyword とオプションの sortkey のどちらもトピックには表示されません。

例

次の例は、2 つのキーワード索引エントリを持つトピックの最初の部分です。

<s1 id=getting-started>Getting Started with Helpview
<idx>starting Helpview<¥idx>
<idx> Helpview, starting<¥idx>

Welcome ...
.
.
.

次の例は、キーワード索引の「プラス」という語が入るべき位置に + (プラス文字) を挿入します。

<idx>+<sort>plus<¥idx>