索引マークアップの追加
索引を作成するには、文書全体にわたって索引エレメントを挿入します。索引エレメントに追加するコンテンツは、索引のコンテンツになります。indexterm エレメント内に入力するテキストコンテンツは、画面上にカラーで表示されるため、文書のコンテンツと簡単に見分けがつきます。
indexterm エレメントには、常に primary エレメントが含まれている必要があります。さらに、secondary エレメントと tertiary エレメントを追加することもできます。indexterm に含まれるこの 3 つのエレメントの後に、1 つの see エレメントまたは 1 つ以上の seealso エレメントを続けることができます。
|
|
出力時に indexterm エレメントが抑制されるので、Arbortext Editor は、このエレメントを、ID を持つ次の目に見えるエレメント (段落またはセクション見出しなど) と関連付けます。PDF または HTML 出力では、関連付けられたエレメントに強制改ページが含まれていると、隠された indexterm にリンク付けされている索引エントリが、indexterm エレメントがあるページではなく、関連付けられたエレメントがあるページにジャンプします。
これを避けるためには、強制改ページを含まない最も近くの目に見えるエレメントの前に、indexterm エレメントを置きます。
|
• primary エレメント - 必須。このエレメントのテキストは、メインの索引項目として表示されます。primary エントリのタグ構造は次のとおりです。
<indexterm><primary>メインの索引エントリ</primary></indexterm>
最終的に出力された索引では次のような形式になります。
main index entry, page number
• secondary エレメント - 任意。secondary 項目のテキストはメインの索引エントリ下のサブエントリとして表示されます。secondary エントリのタグ構造は次のとおりです。
<indexterm><primary>メインの索引エントリ</primary>
<secondary>二次索引エントリ</secondary></indexterm>
最終的に出力された索引では次のような形式になります。
main index entry
secondary index entry, page number
• tertiary エレメント - 任意。secondary エレメントの後に続かなくてはなりません。tertiary エレメントのテキストは、第 2 レベルのサブエントリとして表示されます。tertiary エントリのタグ構造は次のとおりです。
<indexterm><primary>メインの索引エントリ</primary>
<secondary>二次索引エントリ</secondary>
<tertiary>三次検索エントリ</tertiary></indexterm>
最終的に出力された索引では次のような形式になります。
main index entry
secondary index entry
tertiary index entry, page number
• See 参照 - 情報を含まない索引エントリからメイン文書への参照が作成される索引エントリにユーザーを導きます。See 参照は、indexterm エレメント内に存在する最下位レベルのエレメントからのみ作成できます。see 参照のタグ構造は次のとおりです。
<indexterm><primary>メインの索引エントリ</primary>
<see>代理のメイン索引エントリ</see></indexterm>
最終的に出力された索引では次のような形式になります。
main index entry, see alternate main index entry
• See also 参照 - 索引エントリから追加情報を含んでいる別のエントリにユーザーを導きます。see also 参照のタグ構造は次のとおりです。
<indexterm><primary>メインの索引エントリ</primary>
<seealso>追加のメイン索引エントリ</seealso></indexterm>
最終的に出力された索引では次のような形式になります。
main index entry, page number
see also additional main index entry
