Platforma využívá k poskytování aktuálních webových stránek pro dokumentaci vašeho modulu plug-in vlastní dokumentační server. Uživatelský server umožňuje platformě manipulovat s obsahem HTML způsobem nezávislým na prohlížeči a poskytovat podporu s ohledem na modul plug-in. Hlavní rozdíl pro vás jako vývojáře modulu plug-in je v tom, že máte poněkud více volnosti ve způsobu, jakým strukturujete své soubory a specifikujete odkazy.
Dokumentační modul plug-in lze spouštět ze souboru JAR nebo jej lze při instalaci rozbalit do adresáře modulu plug-in. Archivní soubor JAR modulu plug-in se do adresáře modulu plug-in nerozbalí, pokud jako hodnota atributu unpack
prvku
plugin
v manifestu funkce zadáno true. V takovém modulu plug-in je dokumentace komprimována do souboru jar modulu plug-in společně s ostatními soubory modulů plug-in.
V rozbalujících se modulech plug-in může být dokumentace dodána jako soubor zip, čímž se vyhnete problémům, které mohou nastat v případě přítomnosti velkého počtu souborů v adresáři modulu plug-in. U našeho příkladu modulu plug-in jsme vytvořili podadresář nazvaný html. Alternativně bychom mohli umístit naše soubory html do souboru zip nazvaného doc.zip. Tento soubor zip musí napodobovat strukturu souborů v adresáři modulu plug-in. V našem případě musí obsahovat podadresář html a veškerý obsah uvnitř html.
Povšimněte si, že pro moduly plug-in spouštěné ze souboru JAR již dokumentace nemusí být v souboru doc.zip a dále, že takovéto nastavení souboru doc.zip do nevyužitého souboru jar modulu plug-in není systémem nápovědy podporováno.
Po vyřešení názvů souborů v rozbalovaném modulu plug-in server ještě před prohledáním samotného adresáře modulu plug-in hledá dokumenty nápovědy v souboru doc.zip. Při použití jako odkazu se argument v href považuje jako relativní k aktuálnímu modulu plug-in. Zvažte následující odkaz:
<topic label="Ref1" href="html/ref/ref1.html"/>
Modul plug-in nápovědy bude pro tento soubor vypadat takto:
K odkazu na libovolný obsah na webové stránce lze použít plně kvalifikované propojení.
<topic label="Ref1" href="http://www.example.com/myReference.html"/>
Systém nápovědy platformy používá stejné schéma vyhledání adresáře národního jazyka používané zbytkem platformy k nalezení přeložených souborů. (Viz Soubory v místním jazyce, kde najdete vysvětlení této struktury adresářů.) Pokud používáte soubor doc.zip, měli byste vytvořit soubor doc.zip pro každé národní prostředí a umístit jej do správného adresáře národního prostředí. (Neměli byste replikovat strukturu adresáře národního prostředí nl uvnitř souboru doc.zip.)
Kromě adresářů specifických pro národní prostředí systém nápovědy při vyhledávání prostředků nápovědy kontroluje adresáře grafického rozhraní a operačního systému. Vyhledávání se provádí až do vyhledání v tomto pořadí: podadresáře ws, os, nl, poté kořen modulu plug-in. Dokumenty a ostatní prostředky, např. obrázky, které se pro různé systémy odlišují, by měly být umístěny do adresáře ws nebo os pro příslušnou platformu.
Argument href může také odkazovat na obsah jiného modulu plug-in. Toho se dosáhne pomocí speciální notace křížového odkazování na moduly plug-in, kterou server nápovědy vyřeší:
<topic label="Ref1" href="../"another_plugin_id"/ref/ref1.html"/>
Například byste mohli provést propojení na tuto kapitolu průvodce programátora pomocí následujícího tématu:
<topic label="Help Chapter in Platform Doc" href="../org.eclipse.platform.doc.isv/guide/help.html"/>
Poznámka: Při odkazování na obsah z jiného modulu plug-in se ujistěte, že používáte id modulu plug-in tak, jak je deklarováno v jeho souboru plugin.xml, a nikoliv jeho název adresáře. Ačkoliv v praxi jsou to často stejná slova, je důležité zkontrolovat, že používáte id a nikoliv název adresáře.
Informace značení se často umísťují do modulu plug-in, který definuje produkt ve smyslu výkladu v Definování produktu. Na prostředky nápovědy v modulu plug-in produktu lze odkazovat z tabulky obsahu nebo témat s použitím speciálního identifikátoru "PRODUCT_PLUGIN" pro ID modulu plug-in. Například,
href="../PRODUCT_PLUGIN/book.css"
odkazuje na seznam stylů v modulu plug-in a aktuálně spuštěný produkt.