La plataforma utiliza un servidor de documentación propio para proporcionar las páginas Web reales de la documentación del conector. Un servidor personalizado permite a la plataforma manejar el contenido HTML de manera independiente del navegador y proporcionar soporte de detección de conectores. La diferencia principal que ello supone para el usuario, en calidad de desarrollador de conectores, es que dispone de algo más de flexibilidad a la hora de estructurar los archivos y especificar los enlaces.
La documentación se puede entregar en un archivo zip, para evitar los problemas que podrían derivarse de la presencia de demasiados archivos. En nuestro conector de ejemplo, hemos creado un subdirectorio llamado html. Otra posibilidad sería la de haber colocado los archivos html en un archivo zip llamado doc.zip. Este archivo zip debe imitar la estructura de archivos del directorio de conectores. En nuestro caso, debe contener el subdirectorio html y todo el contenido que hay más abajo de html.
Al resolver los nombres de los archivos, el servidor de la ayuda busca los documentos en el archivo doc.zip, antes de buscarlos en el directorio propio de los conectores. Cuando se emplea como enlace, el argumento de un atributo href se toma como relativo al conector actual. Supongamos el siguiente enlace:
<topic label="Ref1" href="html/ref/ref1.html"/>
El conector de la ayuda buscará este archivo de la manera siguiente:
Se puede usar un enlace totalmente calificado para hacer referencia a cualquier contenido de la Web.
<topic label="Ref1" href="http://www.example.com/myReference.html"/>
El sistema de ayuda de la plataforma emplea el mismo esquema de búsqueda de directorio de idioma nacional que el que se emplea en el resto de la plataforma para localizar los archivos traducidos. (En Archivos específicos del entorno local hallará una descripción de esta estructura de directorios). Si está utilizando un archivo doc.zip, deberá producir un archivo doc.zip para cada entorno local y colocarlo dentro del directorio del entorno local correcto. (No hay que replicar la estructura del directorio de entorno local nl dentro del archivo zip).
El argumento href también puede hacer referencia al contenido de otro conector. Para ello se utiliza una notación especial de referencias cruzadas de conectores cuya resolución realiza el servidor de la ayuda:
<topic label="Ref1" href="../"id_de_otro_conector"/ref/ref1.html"/>
Por ejemplo, para enlazarse con el presente capítulo del manual del programador, se utilizaría el siguiente elemento topic:
<topic label="Capítulo de Ayuda de Doc de Plataforma" href="../org.eclipse.platform.doc.isv/guide/help.html"/>
Nota: cuando se hace referencia al contenido de otro conector, hay que asegurarse de utilizar el id del conector, tal como está declarado en el correspondiente archivo plugin.xml, no el nombre del directorio. Si bien en la práctica suelen coincidir, es importante que compruebe que está utilizando el id, no el nombre del directorio.