Índice de Palavras-chave

org.eclipse.help.index

3.2

Para registrar um índice de palavras-chave para conteúdo contribuído da ajuda.

<!ELEMENT extension (index*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

file CDATA #REQUIRED>


Segue um exemplo do uso do ponto de extensão de índice.

(no arquivo plugin.xml)

 

<extension point=

"org.eclipse.help.index"

>

<index file=

"index.xml"

/>

</extension>

(no arquivo 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="História da Aviação"/>
            <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 arquivos XML de índice podem ser traduzidos e a cópia resultante (com palavras-chave traduzidas) deverá ser colocada no diretório nl/<language>/<country> ou nl/<language>. <language> e <country> significam os códigos de duas letras para idioma e país conforme utilizados nos códigos de idiomas. Por exemplo, traduções do chinês tradicional devem ser colocadas no diretório nl/zh/TW. O diretório nl/<language>/<country> tem prioridade mais alta que nl/<language>. Apenas se nenhum arquivo for encontrado no nl/<language>/<country>, o arquivo que reside no nl/<language> será utilizado. O diretório raiz de um plugin será procurado por último.

Nenhum código é necessário para utilizar esse ponto de extensão. É necessário apenas fornecer os arquivos manifest adequados, mencionados no arquivo plugin.xml.

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