A plataforma utiliza seu próprio servidor de documentação para fornecer as páginas reais da Web para a documentação de seu plug-in. Um servidor personalizado permite que a plataforma trate do conteúdo HTML em um navegador de uma forma independente para fornecer suporte reconhecido pelo plug-in. A principal diferença para você como desenvolvedor de plug-in é que tem um pouco mais de flexibilidade na maneira em que estrutura seus arquivos e especifica seus links.
A documentação pode ser enviada em um arquivo zip, evitando problemas que possam ocorrer quando há um grande número de arquivos. No nosso plug-in de exemplo, criamos um subdiretório chamado html. Como alternativa, poderíamos ter colocado nossos arquivos html em um arquivo zip chamado doc.zip. Esse arquivo zip deve retratar a estrutura do arquivo sob o diretório de plug-in. No nosso caso ele deve conter o subdiretório html e todo o conteúdo de html.
Quando estiver resolvendo nomes de arquivos, o servidor de ajuda verifica o arquivo doc.zip para ver se há documentos antes que ele próprio apareça no diretório de plug-in. Quando utilizado como link, o argumento em um href é suposto relacionar-se ao plug-in atual. Considere o seguinte link:
<topic label="Ref1" href="html/ref/ref1.html"/>
O plug-in de ajuda procurará este arquivo da seguinte forma:
É possível utilizar um link completo para referir-se a qualquer conteúdo na Web.
<topic label="Ref1" href="http://www.example.com/myReference.html"/>
O sistema de ajuda da plataforma utiliza o mesmo esquema de pesquisa do diretório de idioma nacional utilizado pelo restante da plataforma para procurar arquivos traduzidos. (Consulte Arquivos específicos do locale para obter uma explicação dessa estrutura de diretórios). Se estiver utilizando um arquivo doc.zip, deverá produzir um arquivo doc.zip para cada locale e colocá-lo dentro do diretório de locale correto. (A estrutura de diretórios de locale nl não deverá ser replicada no arquivo zip).
O argumento href também pode referir-se ao conteúdo de outro plug-in. Isso é feito utilizando-se uma notação especial de referência cruzada do plug-in que é resolvida pelo servidor de ajuda:
<topic label="Ref1" href="../"another_plugin_id"/ref/ref1.html"/>
Por exemplo, você pode estabelecer um link a este capítulo do guia do programador utilizando o seguinte tópico:
<topic label="Capítulo de Ajuda no Documento da Plataforma" href="../org.eclipse.platform.doc.isv/guide/help.html"/>
Nota: Ao fazer referência ao conteúdo de outro plug-in, certifique-se de utilizar o ID do plug-in, conforme indicado em seu arquivo plugin.xml e não seu nome de diretório. Na prática, isso é quase a mesma coisa, mas é importante verificar se você está utilizando o ID e não o nome do diretório.