Nyckelordsindex

org.eclipse.help.index

3.2

För registrering av ett nyckelordsindex för tillagt hjälpinnehåll.

<!ELEMENT extension (index*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

file CDATA #REQUIRED>


Följande är ett exempel på hur indexutökningspunkten används.

(i filen plugin.xml)

 

<extension point=

"org.eclipse.help.index"

>

<index file=

"index.xml"

/>

</extension>

(i filen 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>

Internationalisering XML-filerna för indexet kan översättas och de resulterande kopiorna (med översatta nyckelord) placeras i katalogen nl/<språk>/<land> eller nl/<språk>.<språk> och <land> står för de språk- och landskoder med två tecken som används i språkmiljökoder. Till exempel placeras översättningar till traditionell kinesiska i katalogen nl/zh/TW. Katalogen nl/<språk>/<land> har högre prioritet än nl/<språk>.Endast om ingen fil återfinns i nl/<språk>/<land> används den fil som finns i nl/<språk>.Rotkatalogen för ett insticksprogram genomsöks sist.

Ingen kod behöver användas för den här utökningspunkten. Allt som behövs är att tillhandahålla lämpliga manifestfiler som omnämns i filen plugin.xml.

Standardimplementeringen av hjälpsystemets användargränssnitt som tillhandahålls med Eclipse-plattformen stödjer fullständigt utökningspunkten för index.