La plateforme utilise son propre serveur de documentation pour fournir mes âges Web alimentant la documentation de votre plug-in. Un serveur personnalisé permet à la plateforme de gérer indépendamment le contenu HTML dans un navigateur et d'offrir une prise en charge des plug-in. En tant que développeur de plug-in, la principale différence est que vous disposez d'un peu plus de souplesse de structuration de vos fichiers et de spécification de vos liens.
La documentation peut être fournie sous forme de fichier zip, ce qui évite les problème de taille de fichiers. Dans notre exemple de plug-in, nous avons créé un sous-répertoire appelé doc. Nous aurions pu également placer nos fichiers html dans un fichier zip appelé doc.zip. Ce fichier zip doit respecter la structure de fichiers utilisée dans le répertoire du plug-in. Dans notre cas, il doit contenir le sous-répertoire doc et tout le contenu figurant sous doc.
Lors de la résolution de noms de fichiers, le serveur d'aide recherche les documents dans le fichier doc.zip avant de le faire dans le répertoire du plug-in. utilisé comme lien, l'argument dans href est censé être relatif au plug-in actuel. Observez le lien suivant :
<topic label="Ref1" href="doc/ref/ref1.html"/>
Le plug-in d'aide recherchera ce fichier comme suit :
Un lien qualifié complet peut être utilisé pour faire référence à un contenu sur le Web.
<topic label="Ref1" href="http://www.example.com/myReference.html"/>
Le système d'aide de la plateforme utilise le schéma de recherche du répertoire de langue nationale employé par le reste de la plateforme pour localiser des fichiers traduits. Consultez la section Fichiers spécifique à des environnements locaux pour en savoir plus sur cette structure de répertoire. Si vous utilisez un fichier doc.zip, vous devez en créer un pour chaque environnement local et le placer dans le répertoire correspondant. Vous ne devez pas copier la structure de répertoires d'environnements locaux nl dans le fichier zip.
L'argument href peut également faire référence à un contenu provenant d'un autre plug-in. Cette opération est effectuée à l'aide d'une notation de référence croisée résolue par le serveur d'aide :
<topic label="Ref1" href="../"autre_id_plugin"/ref/ref1.html"/>
Par exemple, vous pouvez établir un lien à ce chapitre grâce à la section suivante :
<topic label="Chapitre d'aide dans la documentation de la plateforme" href="../org.eclipse.platform.doc.isv/guide/help.html"/>
Remarque : Lorsque vous faites référence au contenu provenant d'un autre plug-in, assurez-vous d'utiliser l'ID du plug-in tel que déclaré dans le fichier plugin.xml , et non le nom du répertoire. Même s'ils sont souvent identiques dans la pratique, il est important de vérifier que vous employez bien l'ID.