<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT index EMPTY>
<!ATTLIST index
file CDATA #REQUIRED>
Marcação de Configuração para arquivo de í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 de índice
O elemento de índice representa uma instância de índice. O índice consiste em entradas, cada uma correspondendo a uma palavra-chave específica. Todos os índices contribuídos são mesclados em um índice principal que o Sistema de Ajuda fornece ao usuário. Quando o índice é construído, as entradas são anexadas em ordem alfabética.
O elemento de entrada
O elemento de entrada representa uma palavra-chave do índice. Cada entrada pode conter vários links para tópicos da ajuda associados à palavra-chave. A entrada também pode ser um contêiner para outras entradas (subentradas) para formar a hierarquia de palavras-chave. É permitido que a entrada seja um contêiner para subentradas e tenha tópicos simultaneamente.
O elemento de tópico
O elemento de tópico fornece referência ao conteúdo da ajuda relacionado à palavra-chave. O atributo href é relativo ao plug-in ao qual pertence o arquivo de manifesto. Se você precisar acessar um arquivo em outro plug-in, poderá utilizar a sintaxe:
<topic label="topic in another plug-in" href="../other.plugin.id/concepts/some_other_file.html" />
O atributo de título é utilizado para nomear o link para o conteúdo da ajuda quando vários tópicos estão associados a uma única palavra-chave. Se o atributo não for especificado, o título virá de um TOC que possui o link. Se o link não pertencer a nenhum TOC, o atributo de título deverá ser especificado, senão o título se tornará indefinido.
(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.
Direitos Autorais (c) 2006 Intel Corporation e terceiros.
Todos os direitos reservados. Este programa e os materiais que o acompanham são disponibilizados
sob os termos da Eclipse Public License v1.0 que acompanha esta
distribuição e estão disponíveis no endereço http://www.eclipse.org/legal/epl-v10.html