Aide-mémoire composites

Les aide-mémoire composites fournissent un message décisionnel relatif à des incidents complexes en fractionnant l'incident en un ensemble de tâches. Les aide-mémoire composites sont enregistrés à l'aide du point d'extension org.eclipse.ui.cheatsheets.cheatSheetContent.

Format du fichier de contenu

Le contenu de l'aide-mémoire composite proprement dit est défini dans un fichier séparé respectant la spécification du format du fichier de contenu de l'aide-mémoire. Le fichier de contenu est  un fichier XML comprenant un ensemble de tâches organisées en groupes dans une structure arborescente.

<compositeCheatsheet> est l'élément principal d'un aide-mémoire composite. Il comporte une seule tâche racine pouvant être un élément <task> ou <taskGroup>. Les éléments <taskGroup> sont susceptibles d'avoir un ou plusieurs enfants, qui, à leur tour peuvent représenter un élément <task> ou <taskGroup>. Un élément <task> ne possède pas de tâches enfant.

Les tâches et les groupes de tâches peuvent comprendre des éléments <intro> qui contiennent le texte à afficher avant le démarrage de la tâche. Ils sont également constitués d'éléments <onCompletion> contenant le texte à afficher une fois la tâche terminée. Les deux éléments <intro> et <onCompletion> peuvent contenir un marquage de texte de format. Dans l'exemple ci-dessous, les balises <b> et </b> servent à mettre le texte en gras.

Les tâches peuvent également comprendre des éléments <param>. Une tâche aide-mémoire peut comporter les paramètres suivants : "id" (où l'ID est un aide-mémoire enregistré), "path" (où path est le chemin relatif ou l'URL du fichier de contenu de l'aide-mémoire) et "skipIntro" (où skip intro est un paramètre booléen qui, s'il a la valeur true entraîne  le démarrage de l'aide-mémoire à la première étape au lieu de l'introduction). Vous devez indiquer "id" ou "path", mais pas les deux.

Un noeud <dependency> de la tâche "B" vers la tâche "A" représente une condition selon laquelle la tâche A est terminée avant que la tâche B ne puisse démarrer.

Paramètres des tâches de l'aide-mémoire

Si une tâche possède le type = "cheatsheet", un aide-mémoire s'ouvre lorsque la tâche démarre. Trois paramètres sont disponibles pour une tâche d'aide-mémoire.

Nom du paramètre  Description
id L'ID d'un aide-mémoire ayant été enregistré à l'aide du point d'extension org.eclipse.ui.cheatsheets.cheatSheetContent. Il permet d'identifier l'aide-mémoire qui sera associé à cette tâche. L'ID ou le paramètre de chemin (l'un ou l'autre) doit être indiqué.
path Adresse URL d'un fichier de contenu de l'aide-mémoire. Il peut s'agir d'une adresse URL absolue ou d'un fichier de contenu de l'aide-mémoire composite. Si l'ID et le chemin sont indiqués, le chemin sera utilisé pour localiser le fichier de contenu et le paramètre id sera ignoré.
showIntro Paramètre booléen sans la valeur par défaut de true. Si la valeur est "false", l'aide-mémoire, lorsqu'il est démarré, affichera la première étape au lieu de l'introduction.

Exemple d'aide-mémoire composite

Le fichier ci-dessous illustre comment créer un aide-mémoire composite à partir d'aide-mémoire existants. Il indique également comment créer des groupes de tâches et ignorer certaines tâches.

<?xml version="1.0" encoding="UTF-8" ?>
<compositeCheatsheet name="Exemple d'aide-mémoire composite">
    <taskGroup name= "Exemple d'aide-mémoire composite">
         <intro> Voici un exemple d'<b>aide-mémoire composite</b> créé à partir d'aide-mémoire existants.
                 <br/><br/>Vous pouvez sélectionner une tâche à entreprendre en suivant les hyperliens ou en
                 sélectionnant une tâche dans l'arborescence. 
         </intro>  
         <onCompletion>Félicitations. Vous avez effectué toutes les tâches.</onCompletion>             
         <task kind="cheatsheet" name= "Branchement et fusion avec CVS" skip="true">
              <param name = "id" value = "org.eclipse.platform.cvs_1" />
              <intro>Cet aide-mémoire s'adresse aux utilisateurs de CVS. Si vous n'utilisez pas CVS ou n'avez
              pas l'intention de réaliser un branchement ou une fusion, vous pouvez ignorer cette tâche.
              </intro>
               <onCompletion>Félicitations. Vous savez à présent effectuer un branchement et une fusion.</onCompletion>                  
         </task>
         <taskGroup name= "Création de projets Java" kind = "sequence">
             <intro> Vous allez tout d'abord apprendre à créer un projet Java simple, puis vous allez créer 
             un projet Java qui utilise SWT. 
             <br/><br/>Ce groupe de tâches est une séquence qui signifie que
             si vous cliquez sur la sous-tâche "Application SWT autonome", il ne laissera pas cette tâche démarrer 
             tant que vous n'aurez pas accompli la tâche "Créer un projet Java".
             </intro>
              <onCompletion>Félicitations. Vous avez généré les deux applications Java.</onCompletion>
             <task kind="cheatsheet" name= "Créer un projet java" id = "createJavaProject">
                 <param name="id" value = "org.eclipse.jdt.helloworld"/>
                 <param name="showIntro" value = "false"/>
                 <intro>Cet aide-mémoire vous guide à travers le processus de création d'une application hello world simple. 
                        L'aide-mémoire peut lancer des assistants permettant de créer un projet et une classe. 
                 </intro>
                 <onCompletion>Félicitations. Vous avez créé une application hello world</onCompletion>
             </task>
             <task kind="cheatsheet" name= "Application SWT autonome">
                 <intro>Les plug-ins Eclipse qui contribuent à l'interface utilisateur utilisent les outils SWT (Standard Widget Toolkit). 
                    Le présent guide peut vous permettre d'en savoir plus sur SWT. 
                 </intro>
                 <param name = "id" value = "org.eclipse.jdt.helloworld.swt" />
                  <onCompletion>Félicitations. Vous avez créé une application SWT.</onCompletion>           
             </task>      
         </taskGroup>
    </taskGroup>
</compositeCheatsheet>

Extensibilité de l'aide-mémoire composite - Provisoire dans Eclipse 3.2

Les aide-mémoire composites sont extensibles. Toutefois, dans Eclipse 3.2, cette caractéristique est provisoire et les classes peuvent changer avant qu'elles ne deviennent des API. La prise en charge des aide-mémoire composites peut être étendue à l'aide du point d'extension org.eclipse.ui.cheatsheets.cheatSheetContent qui comporte deux nouveaux éléments : taskEditor et taskExplorer. Ces éléments permettent la contribution d'éditeurs et d'explorateurs de tâches.

La contribution d'un éditeur de tâche définit un nouveau type de tâche qui s'affiche dans la section des détails des tâches. Pour ajouter un éditeur de tâche, implémentez une sous-classe concrète de TaskEditor, puis ajoutez un élément taskEditor au fichier plugin.xml.

La représentation de l'explorateur de tâches est également configurable à l'aide d'un point d'extension. Un  explorateur d'arborescence est inclus dans la plateforme Eclipse. Par défaut, l'explorateur d'un aide-mémoire composite lorsqu'il est ouvert pour la première fois est une arborescence. Un attribut dans l'élément <compositeCheatSheet> autorisera le remplacement de ce paramètre par défaut. Si plusieurs explorateurs sont enregistrés, le menu de la vue contiendra une option de menu permettant de basculer entre les explorateurs. Pour ajouter un explorateur de tâches, implémentez tout d'abord une sous-classe concrète de TaskExplorer, puis ajoutez un élément taskExplorer au fichier plugin.xml.

Liens connexes

Utilisation des aide-mémoire
Utilisation des aide-mémoire composites
Création d'aide-mémoire
Création d'instructions
Spécification de format du fichier de contenu de l'aide-mémoire
Point d'extension org.eclipse.ui.cheatsheets.cheatSheetContent