Miksi XHTML-merkintöjä kannattaa käyttää?
Ohjejärjestelmän avulla voi tuottaa dynaamista ohjesisältöä tekemällä XHTML-merkintöihin huomautuksia erityistunnisteilla. Niiden avulla voi suodattaa sisältöä, tehdä siihen sisällytyksiä ja määrittää ankkureita laajennuksille. Nämä tuoteominaisuudet eivät ole käytettävissä HTML-merkintöjen yhteydessä.
Miten lisään XHTML-ohjeen?
XHTML-ohjeet lisätään pitkälti samoin kuin HTML-ohjeet, lukuun ottamatta muutamaa tärkeää eroa, joiden olemassaolo on välttämätöntä dynaamisen sisällön ja hakutoimintojen tuen kannalta. Seuraavassa on luettelo kyseisistä pakollisista muutoksista:
XHTML-haun osapuoli on sidottava asiakirjalisäosaan.
Eclipse-ohjeen toteutus nopeuttaa hakutoimintoja luomalla asiakirjahakemiston Lucene-ohjelman avulla. Jotta Lucene voisi sijoittaa asiakirjan hakemistoon, sen täytyy pystyä lukemaan kyseistä muotoa. Eclipse-ympäristössä on valmiina haun osapuoli XHTML-asiakirjojen luettelointia varten, joten riittää, että määrität ohjejärjestelmän käyttämään sitä asiakirjojesi luettelointiin. Lisää seuraava laajennus lisäosan manifest-tiedostoon:
<extension
point="org.eclipse.help.base.luceneSearchParticipants">
<binding participantId="org.eclipse.help.base.xhtml"/>
</extension>
Jos käytät dynaamista sisältöä, dynaamisen XHTML-sisällön tuottaja on sidottava asiakirjalisäosaan.
Jos haluat tuottaa dynaamista sisältöä XML-huomautusten avulla, ohjejärjestelmää on käskettävä käsittelemään asiakirjoja kyseisen sisällöntuottajan avulla. Tätä varten dynaamisen XHTML-sisällön tuottaja tulee sitoa lisäosaan.
<extension
point="org.eclipse.help.contentProducer">
<binding producerId="org.eclipse.help.dynamic"/>
</extension>
Jos haluat käyttää sisällytyksiä XHTML-merkinnöissä, path-määritteen muoto on seuraavanlainen: (selitys jäljempänä)
<plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>
Kenttien selitykset:
org.eclipse.help)
/my_folder/my_sub_folder/)
my_file.xhtml)
id-määrite (esim. my.element.id)
Jos esimerkiksi haluaisit sisällyttää kappaleen (<p>-elementti), jonka tunnus on my_copyright, tiedostosta /copyrights/copyright.xhtml lisäosaan my.product.plugin, määrittäisit seuraavaa:
my.product.plugin/copyrights/copyright.xhtml/my_copyright