Oracle Help for Javaのファイル形式 | ![]() 前へ |
![]() 次へ |
索引ファイルでは、索引のナビゲータに対して、索引の内容およびレイアウトを指定します。このファイルはXMLを使用し、JavaHelp 1.0の仕様で規定されている索引ファイルの形式に従います。OHJでは、<indexentry>
タグが追加されています。
索引ファイルの簡単な例を示します。
<?xml version='1.0' ?> <index version="1.0"> <indexitem target="Add_Icon" text="Add Icon"> <indexitem target="addtosheet" text="adding an icon to a sheet /> <indexitem target="addtoworkbook" text="adding an icon to a workbook" /> </indexitem> <indexitem target="Sheet_Background" text="adding a background to a sheet" /> <indexitem text="adding a new sheet to a workbook"> <indexentry target="New_Sheet_command" text="New Sheet command /> <indexentry target="Add_new_sheet" text="To add a new sheet to a workbook" /> </indexitem> <indexitem target="Add_item_to_sheet" text="adding an item to a sheet" /> </index>
この例では、次のキーワード・リストが生成されます。
Add Icon adding an icon to a sheet adding an icon to a workbook adding a background to a sheet adding a new sheet to a workbook adding an item to a sheet
「adding a new sheet to a workbook」という項目を選択すると、次のトピック・リストが表示されます。
New Sheet command To add a new sheet to a workbook
このトピック・リストは、索引ペイン上部のキーワード・リスト内にインデントして表示されるトピック(「adding an icon to a sheet」および「adding an icon to a workbook」)とは別に、索引ペインの下部(トピック・リスト)に表示されます。
索引エントリを持たず、ターゲットが直接関連付けられているキーワード(「adding an item to a sheet」など)の場合、トピック・リストにもキーワード・リストと同じテキストが表示されます。OHJのキーワード表示のユーザー・インタフェースを考慮すると、<indexitem>
タグ内ではtargetを使用せず、かわりに<indexentry>
タグを使用して<indexitem>
に関連付けるトピックを指定する方が使用しやすくなります(そのキーワードのターゲットが1つのみの場合も同様です)。
つまり、
<indexitem text="sheet backgrounds"> <indexentry target="Sheet_Background" text="adding a background to a sheet" /> </indexitem>
とすると、次のように指定するより使用しやすくなります。
<indexitem target="Sheet_Background" text="adding a background to a sheet" />
索引ファイルのタグは、次のとおりです。
タグ | 説明 |
---|---|
<index> |
[origin:JH] 索引の定義。<indexitem> タグおよび<indexentry> タグを含めることができます。 |
<indexitem> |
[origin:JH] キーワード・リストに表示される索引項目の定義。エントリ1をエントリ2の中にネストした場合、エントリ1はエントリ2の下位階層に含まれ、索引ではエントリ2の下にインデントして表示されます。特定の索引項目に、複数のトピックを関連付ける必要がある場合、これらのトピックは<indexitem> タグに含まれる索引エントリとしてリストする必要があります。このタグでは、エントリを選択した際に表示されるコンテンツのIDを指定するtarget 属性を使用します。IDは、マップ・ファイルで(URLに関連付けて)定義します。OHJで現在サポートされているキーワードは、2レベルまでです。2レベルを超えてネストされたエントリがあると、索引表示は正常に表示されません。 |
<indexentry> |
[origin:OHJ] キーワード・リストで親の索引項目が選択された際に、トピック・リストに表示される索引エントリの定義。このタグでは、エントリを選択した際に表示されるトピックのIDを指定するtarget 属性を使用します。IDは、マップ・ファイルで(URLに関連付けて)定義します。このタグは、JavaHelpではサポートされていません。 |
![]() 前へ |
![]() 次へ |