Por que Utilizar o XHTML?
O sistema de ajuda permite produzir conteúdo dinâmico de ajuda, anotando a marcação XHTML com tags especiais em filtrar, inclusões e especificar âncoras para extensões. Esses recursos não estão disponíveis ao utilizar o HTML.
Como Contribuir com o XHTML
Os documentos de ajuda XHTML recebem muita contribuição, da mesma forma que o HTML, exceto o fato que há algumas diferenças importantes que devem existir para suportar conteúdo dinâmico e procura. Essas modificações requeridas estão listadas a seguir:
Você deve vincular o participante de procura XHTML ao plug-in do documento.
A implementação de ajuda do Eclipse utiliza o Lucene para indexar documentos a fim de agilizar a procura. Para indexar um documento, o Lucene deve conseguir ler o formato. O Eclipse já fornece um participante de procura para indexação de documentos XHTML, portanto bastante informar ao sistema de ajuda para utilizá-lo com seus documentos. Inclua a seguinte extensão no manifesto de plug-ins:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Se estiver utilizando conteúdo dinâmico, você deve vincular o produtor do conteúdo dinâmico XHTML ao plug-in do documento.
Se deseja produzir conteúdo dinâmico utilizando as anotações XML, você precisa informar ao sistema de ajuda que ele deve processar seus documentos. Isso é feito vinculando o produtor do conteúdo dinâmico XHTML ao plug-in.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Se você deseja utilizar inclusões no XHTML,
o formato do atributo path
será o seguinte: (explicado a seguir)
<plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>
Em que os campos são:
org.eclipse.help
)
/my_folder/my_sub_folder/
)
my_file.xhtml
)
id
a esse elemento (por exemplo, my.element.id
)
Por exemplo, se você deseja incluir o parágrafo (elemento <p>
)
com o id my_copyright
do arquivo /copyrights/copyright.xhtml
no plug-in my.product.plugin
, você deve especificar o seguinte:
my.product.plugin/copyrights/copyright.xhtml/my_copyright