キーワード・インデックス

org.eclipse.help.index

3.2

コントリビュートされたヘルプ目次用のキーワード・インデックスを登録するには次のようにします。

<!ELEMENT extension (index*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

file CDATA #REQUIRED>


インデックス拡張ポイントの使用例を以下に示します。

(ファイル 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> にあるファイルが使用されます。プラグインのルート・ディレクトリーは、最後に検索されます。

この拡張ポイントにコードは必要ありません。 plugin.xml ファイルに記された適切なマニフェスト・ファイルを指定するだけです。

Eclipse プラットフォームに提供されているヘルプ・システム UI のデフォルト実装では、index 拡張ポイントが完全にサポートされます。