<idx>

索引エントリ

ヘルプ・ボリューム索引に表示するエントリを定義します。

形式

<idx>text<¥idx> 

または

<idx|text|

または

<idx>text<sort>sort key<¥idx> 

text

キーワード索引に表示されるテキスト文字列です。

sort key

索引をソートするときに使用する任意のテキスト文字列です。キーワード索引の text が表示される場所に影響を与えます。sort key 文字列はキーワード索引には表示されません。

一般的なヘルプ・ダイアログ・ボックスの [索引] ボタンを選択すると、[索引検索] ダイアログ・ボックスが表示されます。索引エントリをヘルプ・トピックに追加すると、ユーザが索引の語句を検索して目的のヘルプを見つけるのに役立ちます。

開始タグと終了タグ <idx>、</idx>、または略式マークアップ <idx|...|> が使用できます。

<sort> 要素は索引エントリをソートする順序を変更します。特に、<idx> 要素で使用すると、sort key 文字列で示された場所にキーワードが表示されます。終了タグは必須ではありません。

例

• 次のマークアップは、一部の索引エントリの定義を略式で記述してます。索引エントリはソース・テキストを読みやすくするためにインデントしています。

  A portable personal computer has a full-sized keyboard, built-in 
  disk drives and a detachable LCD screen.
  		<idx|keyboard|
   		<idx|disk drive|
   		<idx|screen, LCD|
   		<idx|personal computer, portable|
   		<idx|portable, personal computer|
   
  

• 次の例では索引に「+」が表示されますが、エントリのアルファベット順リストで「plus」が表示される場所に表示されます。

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