Começámos este exemplo criando os nossos ficheiros de plug-in e documento. Em seguida criámos ficheiros de índice (toc) para descrever a organização do nosso conteúdo. Falta juntar tudo num índice principal e actualizar o nosso plugin.xml para contribuir verdadeiramente com o índice principal.
Começamos por criar toc.xml para contribuir com os três índices criados inicialmente. Ao invés de facultar um tag href para cada tópico, utilizamos o atributo link para remeter para os nossos ficheiros de índice (toc) existentes.
<toc label="Exemplo de Ajuda Online" topic="html/manual.html"> <topic label="Conceitos"> <link toc="toc_Conceitos.xml" /> </topic> <topic label="Tarefas"> <link toc="toc_Tarefas.xml" /> </topic> <topic label="Referência"> <link toc="toc_Ref.xml" /> </topic> </toc>
Depois actualizamos plugin.xml para contribuir com o índice principal:
<extension point="org.eclipse.help.toc"> <toc file="toc.xml" primary="true" /> </extension>
Repare na utilização do atributo primary. Ao definir este atributo como true indicamos que o índice (toc) deve aparecer sempre na navegação, mesmo que não seja referenciado por outro índice (toc). Desta forma, o índice (toc) "principal" aparece sempre na lista de tópicos. Aparece no nível superior da lista de manuais dado que mais nenhum índice (toc) o referencia.
Nota:
Se havia mais ficheiros associados a este índice (toc) mas não presentes na navegação, somente ligados a partir de outros tópicos, para ter esses tópicos disponíveis para o motor de pesquisa teremos de utilizar o atributo extradir no índice (toc).
Por fim, contribuímos com os nossos ficheiros de índice (toc) individuais.
<extension point="org.eclipse.help.toc"> <toc file="toc_Conceitos.xml" /> <toc file="toc_Tarefas.xml" /> <toc file="toc_Referência.xml" /> </extension>
Estes ficheiros de índice (toc) não aparecem no nível superior da lista de manuais porque não definimos o atributo primary. Os ficheiros de índice (toc) que não estejam definidos como primários só aparecem na rede de documentação se para eles remeter algum índice (toc) que seja índice primário ou esteja ligado por um índice primário.
E já está. Se copiar o directório do plug-in para o directório plugins da plataforma, iniciar a plataforma e escolher Ajuda->Índice da Ajuda, verá o seu exemplo a aparecer na lista de manuais. Se fizer clique no "Exemplo de Ajuda Online", verá a estrutura do seu índice (toc):