<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT index EMPTY>
<!ATTLIST index
file CDATA #REQUIRED>
インデックス・ファイルの構成マークアップ:
<!ELEMENT index (entry)* >
<!ELEMENT entry (entry | topic)* >
<!ATTLIST entry keyword CDATA #REQUIRED >
<!ELEMENT topic EMPTY >
<!ATTLIST topic href CDATA #REQUIRED >
<!ATTLIST topic title CDATA #IMPLIED >
インデックス要素
インデックス要素はインデックスのインスタンスを表します。インデックスはエントリーで構成され、それぞれのエントリーは特定のキーワードに対応しています。すべてのコントリビュートされたインデックスは、ヘルプ・システムがユーザーに提供する 1 つのマスター・インデックスにマージされます。インデックスがビルドされると、エントリーはアルファベット順に追加されます。
エントリー要素
エントリー要素はインデックスのキーワードを表します。それぞれのエントリーは、キーワードに関連付けされたヘルプ・トピックへのリンクをいくつか含んでいます。エントリーはまた、別のエントリー (サブエントリー) のコンテナーになって、キーワードの階層を形成することもできます。エントリーは、サブエントリーのコンテナーになり、同時にトピックを持つことができます。
トピック要素
トピック要素は、キーワードに関係するヘルプ目次への参照を提供します。 href 属性は、マニフェスト・ファイルが属するプラグインに対する相対参照となります。他のプラグインのファイルにアクセスするには、次の構文を使用します。
<topic label="topic in another plug-in" href="../other.plugin.id/concepts/some_other_file.html" />
title 属性は、複数のトピックが単一のキーワードに関連付けられているとき、ヘルプ目次へのリンクに名前をつけるために使用されます。属性が指定されない場合は、タイトルはリンクを所有する TOC からきます。リンクがどの TOC にも属していない場合は、title 属性を指定する必要があり、指定しないとタイトルは未定義になってしまいます。
(ファイル plugin.xml)
<extension point=
"org.eclipse.help.index"
>
<index file=
"index.xml"
/>
</extension>
(ファイル index.xml)
<index>
<entry keyword="Vehicle">
<topic href="inventory_of_wheel.html"/>
<entry keyword="Car">
<topic href="car.html"/>
</entry>
<entry keyword="Ship">
<topic href="ship.html"/>
</entry>
<entry keyword="Airplane">
<topic href="airplane.html" title="History of aviation"/>
<topic href="jet.html" title="Jet engine"/>
</entry>
</entry>
<entry keyword="Engine">
<entry keyword="Horse">
<topic href="horse.html"/>
</entry>
<entry keyword="Steamer">
<topic href="steamer.html"/>
</entry>
<entry keyword="Wankel engine">
<topic href="wankel.html"/>
</entry>
<entry keyword="Jet engine">
<topic href="jet.html"/>
</entry>
</entry>
<entry keyword="Electricity">
<topic href="electricity.html"/>
</entry>
</index>
国際化対応 インデックス XML ファイルは変換可能であり、結果のファイルは (変換済みキーワードと共に) nl/<language>/<country> または nl/<language> ディレクトリーに置くことができます。<language> と <country> は、ロケール・コードで使用する 2 文字の言語および国別コードを表します。例えば、中国語 (繁体字) 変換は、nl/zh/TW ディレクトリーに置く必要があります。nl/<language>/<country> ディレクトリーは、 nl/<language> より優先順位が高くなります。nl/<language>/<country> にファイルが見つからない場合のみ、 nl/<language> にあるファイルが使用されます。プラグインのルート・ディレクトリーは、最後に検索されます。
Copyright (c) 2006 Intel Corporation and others.
All rights reserved.
This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html