Editeur d'aide contextuelle

L'aide contextuelle est un mécanisme permettant d'établir un lien entre une partie de l'interface utilisateur et une rubrique d'aide particulière. Lorsque l'utilisateur active la partie de l'interface utilisateur associée, la page d'aide s'affiche dans la zone d'aide dynamique. L'interface utilisateur et les pages d'aide sont associées l'une à l'autre de deux manières : un fichier XML statique ou un fournisseur de contexte dynamique. Pour associer des pages de façon statique, vous devez d'abord créer un fichier xml d'aide contextuelle. L'éditeur de l'aide contextuelle aide à la création de ces pages.

La page Définition de l'éditeur fournit un affichage graphique du fichier xml, divisé en deux colonnes. La colonne de gauche s'intitule Aide contextuelle et affiche les éléments xml sous forme d'arborescence avec des actions pour les ajouter, les déplacer et les supprimer. L'autre colonne fournit des informations plus détaillées sur l'élément sélectionné dans la colonne de gauche et permet de modifier les détails.

La page Source de l'éditeur fournit un affichage textuel du fichier xml. Le fichier xml peut être édité directement ; les modifications, si elles sont valides, se refléteront dans la page Définition graphique.

Ajout de nouveaux contextes d'aide

Editeur de contexte d'aide avec des zones remplies

Pour ajouter un nouveau contexte, cliquez sur le bouton Ajouter un contexte. Cette action ajoute une nouvelle entrée de contexte au fichier xml, qui s'affichera dans l'arborescence de la page Définition. Le nouveau contexte sera sélectionné lorsque vous ouvrirez une section de détails dans la colonne de droite de l'éditeur. Dans cette section, vous pouvez fournir des informations plus détaillées concernant le contexte, notamment :

Ajout de rubriques et de commandes d'aide

L'ajout d'un contexte au fichier fournira une aide dynamique contenant une description de base à afficher pour l'utilisateur. En général, on inclut des liens supplémentaires vers les rubriques connexes du système d'aide. Pour ce faire, vous devez ajouter des rubriques et des commandes au fichier xml.

Editeur de contexte d'aide avec des zones de détails complétées

En cliquant sur le bouton Ajouter une rubrique, vous ajouterez une nouvelle entrée de rubrique au fichier xml sous l'un des contextes d'aide. Une rubrique s'affichera pour l'utilisateur, sous la forme d'un lien. Une fois qu'une nouvelle rubrique a été créée, vous pouvez la sélectionner pour ouvrir la section Détails de la rubrique dans la colonne de droite de la page Définition. Dans la section de détails, vous pouvez modifier l'intitulé qui s'affichera pour l'utilisateur, ainsi que l'emplacement du fichier qui sera lié. Dans la plupart des cas, le fichier lié sera une page html dans le système d'aide. Vous pouvez utiliser le bouton Parcourir... pour rechercher un fichier à lier.

En plus des rubriques, vous pouvez également ajouter une commande. Pour l'utilisateur, une commande a la même apparence qu'une rubrique. Toutefois, l'activation du lien entraîne l'exécution d'une commande de code au lieu de l'ouverture d'un fichier. Les commandes peuvent être utilisées pour ouvrir des pages de préférences et exécuter d'autres actions.

Commande d'ajout de l'éditeur de contexte d'aide

Cliquez sur le bouton Ajouter une commande pour ajouter une nouvelle commande. Vous pouvez éditer les détails des commandes, de la même façon que vous modifiez les rubriques.

Commandes Supprimer, Haut, Bas

Trois boutons supplémentaires de la page Définition permettent de manipuler l'ordre des éléments dans la liste de contexte ou de supprimer des éléments.

Contexte d'aide avec des boutons de manipulation

Ces boutons sont :

Enregistrement du fichier d'aide contextuelle

Pour qu'Eclipse reconnaisse le fichier xml d'aide contextuelle comme étant une source pour le système d'aide dynamique, ce fichier doit être enregistré via le point d'extension org.eclipse.help.contexts. L'éditeur fournit un moyen d'enregistrer ce fichier automatiquement. Dans le coin supérieur droit de l'éditeur se trouve un lien intitulé "Enregistrer ce fichier d'aide contextuelle". Cliquez dessus pour ajouter l'entrée correcte au fichier plugin.xml.