Índice de Palavras-Chave

org.eclipse.help.index

3.2

Para registar um índice de palavras-chave para o conteúdo contribuído de ajuda.

<!ELEMENT extension (index*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

file CDATA #REQUIRED>


De seguida é apresentado um exemplo de utilização do ponto de extensão do índice.

(no ficheiro plugin.xml)

 

<extension point=

"org.eclipse.help.index"

>

<index file=

"index.xml"

/>

</extension>

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

Internacionalização Os ficheiros XML de índice podem ser traduzidos e a cópia resultante (com palavras-chave traduzíveis) deve ser colocada no directório nl/<idioma>/<país> ou nl/<idioma>. O <idioma> e o <país> representam idiomas de duas letras e códigos de países utilizados nos códigos de locale. Por exemplo, as traduções de Chinês Tradicional devem ser colocadas no directório nl/zh/TW. O directório nl/<idioma>/<país> possui uma prioridade mais elevada do que nl/<idioma>. Se não for encontrado nenhum ficheiro no directório nl/<idioma>/<país>, será utilizado o ficheiro que reside em nl/<idioma>. O directório raiz de um plug-in será último a ser pesquisado.

Não é necessário nenhum código para utilizar este ponto de extensão. É apenas necessário facultar os ficheiros manifest adequados, mencionados no ficheiro plugin.xml.

A implementação predefinida da UI do sistema de ajuda, facultada com a plataforma Eclipse, suporta totalmente o ponto de extensão index.