Para quê utilizar o XHTML?
O sistema de ajuda faculta a capacidade de produzir conteúdos de ajuda dinâmicos ao anotar a marcação do XHTML com identificadores especiais para filtrar, inclusões e especificar âncoras para as extensões. Estas funções não estão disponíveis ao utilizar o HTML.
Como contribuir com o XHTML
Os documentos de ajuda do XHTML contribuem da mesma forma que o HTML, excepto há algumas diferenças importantes que deverão existir para suportar o conteúdo dinâmico e a pesquisa. Estas modificações requeridas estão enumeradas abaixo:
Tem de associar o participante de procura do XHTML ao seu plug-in doc.
A implementação de ajuda do eclipse utiliza Lucene para indexar os seus documentos para acelerar a pesquisa. Para indexar um documento, Lucene deverá conseguir ler o formato. O Eclipse faculta um participante de pesquisa para indexar documentos XHTML, sendo apenas necessário indica ao sistema de ajuda para o utilizar nos documentos. Adicione a seguinte extensão ao manifesto de plug-in:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Se estiver a utilizar um conteúdo dinâmico, tem de associar o produtor de conteúdo dinâmico do XHTML ao plug-in doc.
Se pretender produzir conteúdos dinâmicos através da utilização das anotações do XML, é necessário indicar ao sistema de ajuda que deverá processar os documentos. Este procedimento é feito ao associar o produtor de conteúdo dinâmico do XHTML ao plug-in.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Se desejar utilizar as inclusões no
XHTML, o formato do atributo path
é da seguinte forma: (explicado abaixo)
<plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>
Onde estão os ficheiros:
org.eclipse.help
)
/my_folder/my_sub_folder/
)
my_file.xhtml
)
id
para esse elemento (por exemplo my.element.id
)
Por exemplo, se desejar incluir o parágrafo (elemento <p>
)
com o id my_copyright
do ficheiro
/copyrights/copyright.xhtml
no plug-in
my.product.plugin
, deverá especificar o seguinte:
my.product.plugin/copyrights/copyright.xhtml/my_copyright