Stikkordregister

org.eclipse.help.index

3.2

Til registrering av nøkkelord (stikkord) for innhold i hjelpen.

<!ELEMENT extension (index*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

file CDATA #REQUIRED>


Nedenfor finner du et eksempel på bruken av utvidelsespunktet index:

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

Internasjonalisering XML-filene for indeks (stikkordregister) kan oversettes, og resultatkopien (med oversatte nøkkelord) bør legges i katalogen nl/<språk>/<land> eller nl/<språk>. <språk> og <land> står for tobokstavskodene for språk og land som brukes i språkmiljøkoder. Oversettelser til tradisjonell kinesisk legges for eksempel i katalogen nl/zh/TW. Katalogen nl/<språk>/<land> har høyere prioritet enn nl/<språk>. Bare hvis det ikke blir funnet en fil i nl/<språk>/<land>, vil filen som ligger i nl/<språk> bli brukt. Rotkatalogen for en plugin-modul blir søkt i sist.

Det er ikke nødvendig med kode for å bruke dette utvidelsespunktet. Alt som trengs er å oppgi de riktige manifestfilene som er nevnt i plugin.xml-filen.

Standardimplementeringen av hjelpefunksjonens brukergrensesnitt som leveres med Eclipse-plattformen, har fullstendig støtte for utvidelsespunktet index.