Miért érdemes XHTML-t használni?
A súgórendszer lehetővé teszi dinamikus súgótartalom előállítását, ha a XHTML leírónyelvet feljegyezésekkel látja: speciális címkéket ad a szűrőhöz, a tartalmazásokhoz, és horgonyokat ad meg a kiterjesztésekhez. Ezek a szolgáltatások HTML esetén nem állnak rendelkezésre.
XHTML közreadása
Az XHTML súgódokumentumok közreadása hasonlóképp működik, mint HTML esetén néhány fontos különbség kivételével, amelyeknek a dinamikus tartalom és a keresés támogatása érdekében meg kell lennie. A szükséges módosítások az alábbiak:
Az XHTML keresési segédeket a doc bedolgozóhoz kell kötni.
Az eclipse súgómegvalósítás Lucene terméket használ a dokumentumok indexelésére a keresés felgyorsítása érdekében. A dokumentum indexelése érdekében a Lucene-nek tudnia kell olvasnia a formátumot. Az Eclipse már biztosít egy keresési segédet az XHTML dokumentumok indexelése érdekében, így egyszerűen csak meg kell mondani a súgórendszernek, hogy ezt használja a dokumentumokhoz. Adja hozzá a következő kiterjesztést a bedolgozó leírófájlhoz:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Dinamikus tartalom használata esetén az XHTML dinamikus tartalom-előállítót a doc bedolgozóhoz kell kötni.
Ha XML feljegyzésekkel kíván dinamikus tartalmat előállítani, akkor meg kell mondani a rendszernek, hogy fel kell dolgoznia a dokumentumokat. Ez az XHTML dinamikus tartalom-előállító bedolgozóhoz kötésével történik.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Ha tartalmazásokat kíván használni az XHTML-ben,
akkor a path
attribútum formátuma a következő: (magyarázata alább látható)
<bedolgozó_azonosító>/<xhtml_fájl_elérési_útja>/<xhtml_fájlnév>/<elem_azonosító>
A mezők helye:
org.eclipse.help
)
/my_folder/my_sub_folder/
)
saját_fájl.xhtml
)
id
attribútum elemhez adásával állítható be (például
my.element.id
)
Ha például my_copyright
azonosítóval kíván felvenni egy
bekezdést (<p>
elem) a my.product.plugin
bedolgozó /copyrights/copyright.xhtml
fájljából, akkor a
következőt kell megadni:
my.product.plugin/copyrights/copyright.xhtml/my_copyright