<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT index EMPTY>
<!ATTLIST index
file CDATA #REQUIRED>
Marcação da configuração para o ficheiro índice:
<!ELEMENT index (entry)* >
<!ELEMENT entry (entry | topic)* >
<!ATTLIST entry keyword CDATA #REQUIRED >
<!ELEMENT topic EMPTY >
<!ATTLIST topic href CDATA #REQUIRED >
<!ATTLIST topic title CDATA #IMPLIED >
O elemento index
O elemento index representa uma instância do índice. O índice consiste em entradas e cada uma delas corresponde a uma determinada palavra-chave. Todos os índices contribuídos são intercalados num índice principal que o Sistema de ajuda faculta ao utilizador. Quando o índice é construído, as entradas são anexadas por ordem alfabética.
O elemento entry
O elemento entry representa uma palavra-chave do índice. Cada entrada pode conter várias ligações aos tópicos de ajuda que estão associados à palavra-chave. A entrada pode também ser um contentor para outras entradas (sub-entradas) de modo a formar uma hierarquia de palavras-chave. A entrada pode ser um contentor para sub-entradas e ter tópicos simultaneamente.
O elemento topic
O elemento topic faculta uma referência ao conteúdo de ajuda relacionado com a palavra-chave. O atributo href está relacionado com o plug-in ao qual o ficheiro manifesto pertence. Se necessitar de aceder um ficheiro noutro plug-in, pode utilizar a sintaxe
<topic label="tópico noutro plug-in" href="../other.plugin.id/concepts/some_other_file.html"/>
O atributo título é utilizado para denominar a ligação para o conteúdo de ajuda, quando vários tópicos são associados a uma única palavra-chave. Caso o atributo não seja especificado, o título advém de um TOC que possui a ligação. Se a ligação não pertencer a nenhum TOC, o atributo título tem de ser especificado. caso contrário, o título torna-se indefinido.
(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.
Copyright (c) 2006 Intel Corporation e outros.
Todos os direitos reservados. Este programa e os materiais que o acompanham estão disponíveis sob os termos da Eclipse Public License v1.0, que acompanha esta distribuição e estão disponíveis em http://www.eclipse.org/legal/epl-v10.html