Système d'aide
Le plug-in du système d'aide, org.eclipse.help, définit deux
points d'extension ("contexts" et "toc") qui
permettent aux plug-in individuels de contribuer à l'aide
contextuelle et à l'aide en ligne de leurs composants.
Un plug-in classique fournissant une documentation utilise ces points d'extension.
D'autres points d'extension servent à étendre les capacités du système d'aide.
Pour les applications plus avancées, il existe également un point d'extension ("support") pour la connexion à l'interface utilisateur du système d'aide.
Points d'extension
Les points d'extension ci-dessous peuvent être utilisés pour étendre le système d'aide.
Préférences
Les paramètres suivants peuvent être utilisés avec le système
d'aide :
-
log_level indique le genre d'informations écrites dans le
journal d'aide. Employez l'une de ces trois valeurs :
- 0 : erreurs uniquement.
- 1 : erreurs et avertissements.
- 2 : erreurs, avertissements et messages d'informations
(débogage).
- banner lorsque la vue d'aide permet l'affichage de marques.
Si vous voulez faire apparaître le logo d'une entreprise ou tout
autre chose en haut de la vue d'aide, dénommez votre page html /pluginId/path/to/banner.html. La
bannière par défaut est /org.eclipse.help.webapp/banner.html. Si vous
remplacez ce nom par une chaîne vide, aucune bannière ne s'affichera.
- banner_height correspond à la hauteur de la bannière. La
valeur par défaut est 45.
- help_home correspond à la page à afficher dans la zone de
contenu à l'ouverture de l'aide. Dénommez votre page html
/pluginId/path/to/home.html. La page d'accueil par défaut est /org.eclipse.help/doc/help_home.html.
- linksView possède la valeur true ou false pour contrôler
la visibilité de la vue de liens relatifs.
- baseTOCS est une liste triée de sections (livres) de la
table des matières de l'aide telles qu'elles apparaîtraient sur une étagère.
Toutes les autres TDM respecteront ces livres. Les tables ne
figurant pas dans cette liste seront ignorées. Utilisez l'emplacement
de chaque TDM comme /pluginId/path/to/toc.xml.