Perché utilizzare XHTML?
Il sistema della guida consente di creare un contenuto della guida dinamica annotando la markup XHTML con tag speciali per filtri e inclusioni e per specificare ancoraggi per le estensioni. Tali funzioni non sono disponibili quando si utilizza HTML.
Modalità di aggiunta di XHTML
I documenti della guida XHTML vengono aggiunti allo stesso modo in cui vengono aggiunti a HTML, tranne per il fatto che esistono importanti differenze da seguire relativamente al supporto del contenuto e dinamico e della ricerca. Tali modifiche sono riportate di seguito:
È necessario collegare il partecipante di ricerca XHTML al plugin della documentazione.
L'implementazione della guida Eclipse utilizza Lucene per indicizzare i documenti in modo da velocizzare le ricerche. Per poter indicizzare un documento, Lucene deve poter leggerne il formato. Eclipse fornisce già un partecipante di ricerca per l'indicizzazione dei documenti XHTML, in modo da dover semplicemente indicare al sistema di utilizzarlo per i propri documenti. Aggiungere la seguente estensione al file manifest del plug-in:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Se si utilizza un contenuto dinamico, è necessario collegare il produttore del contenuto dinamico XHTML al plugin della documentazione.
Se si desidera produrre un contenuto dinamico mediante le annotazioni XML, è necessario indicare al sistema della guida che devono essere elaborati i documenti. Ciò è possibile collegando il produttore del contenuto dinamico XHTML al plugin.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Se si desidera utilizzare le inclusioni in XHTML, il formato dell'attributo path
è il seguente:
<id_plugin>/<percorso_file_xhtml>/<nome_file_xhtml>/<id_elemento>
dove i campi sono:
org.eclipse.help
)
/my_folder/my_sub_folder/
)
my_file.xhtml
)
id
all'elemento (ad esempio, my.element.id
)
Ad esempio, se si desidera includere il paragrafo (<p>
element)
con ID my_copyright
dal file /copyrights/copyright.xhtml
nel plugin my.product.plugin
, è necessario specificare:
my.product.plugin/copyrights/copyright.xhtml/my_copyright