La piattaforma utilizza il proprio server della documentazione per fornire le pagine Web reali per la documentazione del plug-in. Un server personalizzato consente alla piattaforma di gestire il contenuto HTML in un modo indipendente dal browser e di fornire un supporto di plug-in effettivo. La differenza principale tra l'utente e uno sviluppatore di plug-in consiste nel fatto che l'utente dispone di una maggiore flessibilità nel modo di strutturare i file e di specificare i collegamenti.
La documentazione può essere distribuita in un file zip, evitando così i problemi che possono verificarsi quando il numero di file è particolarmente elevato. Nel plug-in di esempio è stata creata una sottodirectory denominata doc. In alternativa, sarebbe stato possibile sistemare i file html in un file zip denominato doc.zip. Questo file zip deve ricreare la struttura file presente nella directory dei plug-in. Nel nostro caso, deve contenere la sottodirectory doc e tutto il contenuto all'interno di doc.
Quando risolve i nomi file, il server della Guida ricerca i documenti nel file doc.zip prima di ricercarli nella stessa directory dei plug-in. Quando è utilizzato come collegamento, l'argomento in un href viene interpretato come relativo al plug-in corrente. Si consideri il seguente collegamento:
<topic label="Ref1" href="doc/ref/ref1.html"/>
Il plug-in della Guida ricercherà il file in questione nel modo indicato di seguito:
Un collegamento completo può essere utilizzato per fare riferimento a qualsiasi contenuto presente sul Web.
<topic label="Ref1" href="http://www.example.com/myReference.html"/>
Il sistema della Guida della piattaforma utilizza lo stesso schema di ricerca della directory delle lingue nazionali impiegato dal resto della piattaforma per l'individuazione dei file tradotti. (Vedere File specifici delle impostazioni internazionali per maggiori dettagli sulla struttura di questa directory). Se si sta utilizzando un file doc.zip, è necessario generare un file doc.zip per ogni gruppo di impostazioni internazionali e posizionarlo all'interno della directory delle impostazioni internazionali corretta. (Non replicare la struttura della directory delle impostazioni internazionali nl nel file zip.)
L'argomento href può fare riferimento anche al contenuto di un altro plug-in. Se si desidera effettuare questa operazione, occorre utilizzare una speciale notazione di riferimenti plug-in incrociati che viene risolta dal server della Guida:
<topic label="Ref1" href="../"another_plugin_id"/ref/ref1.html"/>
Ad esempio, è possibile creare un collegamento a questo capitolo della guida alla programmazione mediante il seguente argomento:
<topic label="Help Chapter in Platform Doc" href="../org.eclipse.platform.doc.isv/guide/help.html"/>
Nota: quando si fa riferimento al contenuto di un altro plug-in, assicurarsi di utilizzare l'ID del plug-in, dichiarato nel relativo file plugin.xml , non il nome della directory. Sebbene spesso coincidano, è importante verificare che si sta utilizzando l'ID e non il nome della directory.