A platform a saját dokumentációs kiszolgálót használja a bedolgozó dokumentációhoz az aktuális weboldalak biztosítása érdekében. Egy egyéni kiszolgáló segítségével a platform böngészőfüggetlen módon tudja kezelni a HTML tartalmat, és bedolgozó-tudatos támogatást biztosít. A fő különbség, hogy bedolgozófejlesztő egy kicsit nagyobb rugalmasságot biztosít a fájlrendszer strukturálásában és a hivatkozások megadásában.
Egy dokumentáció bedolgozó képes jar fájlból vagy a telepítés során egy
bedolgozó könyvtárba kicsomagolva is futni. A bedolgozó archív jar nincs
kiterjesztve a bedolgozókönyvtárra, ha a bedolgozó
elem
unpack
attribútumának értéke igaz a szolgáltatás
leírófájlban. Az ilyen bedolgozóban a dokumentáció tömörítésre kerül
a bedolgozó jar fájljában, a többi bedolgozófájllal együtt.
A kicsomagoltan futó bedolgozókkal kapcsolatos azon problémák elkerülése érdekében, amelyek akkor merülnek fel, ha nagyszámú fájl van jelen a bedolgozó könyvtárban, a dokumentáció biztosítható egy zip fájlban. A példa bedolgozóban létrehoztunk egy html nevű alkönyvtárat. Ennek alternatívájaként a html fájlokat berakhatjuk egy doc.zip nevű zip fájlba. Ennek a zip fájlnak utánoznia kell a bedolgozókönyvtár alatti fájlstruktúrát. A mi esetünkben tartalmaznia kell a html alkönyvtárat és az összes html alatt lévő tartalmat.
Ne feledje, hogy a jar fájlokból futó bedolgozók esetén nincs szükség arra, hogy a doc.zip további dokumentációt tartalmazzon, és a doc.zip ilyen beállítását egy nem csomagolt bedolgozó jar fájlban nem támogatja a súgórendszer.
A fájlnevek feloldásakor egy kicsomagoltan futó bedolgozóban a súgókiszolgáló a doc.zip fájlba néz be a dokumentumokért, mielőtt belenézne magába a bedolgozókönyvtárba. Ha hivatkozásként használja, akkor a href-ben lévő argumentumról feltételeztük, hogy az aktuális bedolgozóhoz viszonyítva vannak megadva. Tekintse meg az alábbi hivatkozást:
<topic label="Ref1" href="html/ref/ref1.html"/>
A súgóbedolgozó az alábbi módon keresi meg a fájlt:
Egy teljes képzésű hivatkozás használható a weben lévő tetszőleges tartalomra hivatkozáshoz.
<topic label="Ref1" href="http://www.example.com/myReference.html"/>
A platform súgórendszer a lefordított fájlok megkereséséhez ugyanazt a nemzeti nyelv könyvtár keresési sémát használja, mint a platform többi része. (A könyvtárstruktúra magyarázata a Területi beállítás-specifikus fájlok részben található.) Ha doc.zip fájlt használ, akkor elő kell állítania egy doc.zip fájlt minden helyi beállításhoz és az aktuális területi beállítás könyvtárba kell helyezni. (Az nl területi beállítás könyvtárstruktúra nem replikálható a doc.zip fájlban.)
A területi beállításokra jellemző könyvtárakon kívül a súgórendszer ellenőrzi az ablakkezelési rendszer és az operációs rendszer könyvtárait is a súgóerőforrások keresése közben. A kikeresés a következő sorrendben kerül végrehajtásra: ws, os, nl alkönyvtárak, ezután a bedolgozó gyökere, amíg az erőforrás nem található. Azok a dokumentumok és más erőforrások, mint például képek, az adott platformhoz megfelelő ws vagy az os könyvtárak alá kell kerüljenek.
A href argumentum más bedolgozóból származó tartalomra hivatkozhat. Ez speciális bedolgozók közötti hivatkozás jelöléssel tehető meg, amelyet a súgókiszolgáló felold:
<topic label="Ref1" href="../"another_plugin_id"/ref/ref1.html"/>
A programozó útmutató ezen fejezetére hivatkozhat például az alábbi témakör segítségével:
<topic label="Súgófejezet a platform dokumentumban" href="../org.eclipse.platform.doc.isv/guide/help.html"/>
Megjegyzés: Ha a tartalomra másik bedolgozóból hivatkozik, akkor győződjön meg róla, hogy a bedolgozó azonosítóját használja a plugin.xml fájlban deklarált módon, nem a könyvtárnévben. Mivel ezek a gyakorlatban gyakran megegyeznek, ellenőrizni kell, hogy az azonosítót használja-e, nem a könyvtárnevet.
A márkainformációkat gyakran egy, a terméket megadó bedolgozóban helyezik el, a Termék megadása című dokumentumban elmagyarázott módon. A termék bedolgozóban lévő erőforrásokra a tartalomjegyzékben vagy a témakörök listájában a bedolgozó azonosítójához tartozó "PRODUCT_PLUGIN" speciális azonosító használatával lehet hivatkozni. Például a következő:
href="../PRODUCT_PLUGIN/book.css"
a jelenleg futó termék bedolgozójában található stíluslapra hivatkozik.