¿Por qué utilizar XHTML?
El sistema de ayuda proporciona la capacidad de generar contenido de ayuda dinámico anotando la codificación XHTML con códigos especiales para filtrar, incluir y especificar anclas para extensiones. Estas características no están disponibles al utilizar HTML.
Cómo contribuir a XHTML
La contribución a los documentos de ayuda XHTML se realiza en gran parte igual que en el caso de HTML, excepto por el hecho de que hay algunas diferencias importantes que permiten soportar el contenido dinámico y la búsqueda. A continuación se listan estas modificaciones necesarias:
Debe enlazar el participante de búsqueda XHTML al plug-in de doc.
La implementación de ayuda de Eclipse utiliza Lucene para indexar los documentos correspondientes y acelerar la búsqueda. Para indexar un documento, Lucene debe poder leer el formato. Eclipse ya proporciona un participante de búsqueda para indexar documentos XHTML, de modo que simplemente debe indicar al sistema de ayuda que lo utilice para los documentos. Añada la extensión siguiente al manifiesto de plug-in:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Si utiliza el contenido dinámico, debe enlazar el generador de contenido dinámico XHTML al plug-in de doc.
Si desea generar contenido dinámico utilizando las anotaciones XML, debe indicar al sistema de ayuda que debe procesar los documentos. Esto se hace enlazando el generador de contenido dinámico XHTML al plug-in.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Si desea utilizar inclusiones en el XHTML, el formato del atributo
path
es el siguiente: (se explica a continuación)
<id_de_plug-in>/<vía_de_acceso_al_archivo_xhtml>/<nombre_de_archivo_xhtml>/<id_de_elemento>
Dónde los campos son:
org.eclipse.help
)
/mi_carpeta/mi_subcarpeta/
)
mi_archivo.xhtml
)
id
a ese elemento (p.ej.
my.element.id
)
Por ejemplo, si desea incluir el párrafo (elemento <p>
) con el id mi_copyright
del
archivo /copyrights/copyright.xhtml
del plug-in my.product.plugin
, debe especificar lo
siguiente:
my.product.plugin/copyrights/copyright.xhtml/mi_copyright