Contenu de l'aide-mémoire

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Ce point d'extension sert à enregistrer les contributions de contenu de l'aide-mémoire. Les aide-mémoire sont des choix offerts dans le menu Aide ou dans la vue correspondante et servent généralement à réaliser des tâches complexes en vue d'un objectif final.

Les aide-mémoire sont organisés en catégories reflétant généralement un domaine de problème particulier. Par exemple, un plug-in orienté Java peut définir une catégorie nommée "Java" et appropriée pour des aide-mémoire destinés aux outils Java. Les catégories définies par un plug-in peuvent être référencées par d'autres plug-ins grâce à l'attribut category d'un élément d'aide-mémoire. Les aide-mémoire non classés et ceux dont les chemins de catégories sont incorrects seront placés dans la catégorie "Autre".

Parfois, les aide-mémoire peuvent fournir un sous-élément de description dont le corps contient un texte court sur l'aide-mémoire.

<!ELEMENT extension (category | cheatsheet)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT category EMPTY>

<!ATTLIST category

id             CDATA #REQUIRED

name           CDATA #REQUIRED

parentCategory CDATA #IMPLIED>

Un élément de catégorie dans le point d'extension cheatsheetContent crée une nouvelle catégorie dans le menu d'aide-mémoire. Celui-ci est disponible depuis le menu Aide du plan de travail. Si une nouvelle catégorie est indiquée, les aide-mémoire peuvent y être destinés et apparaîtront en dessous dans la boîte de dialogue de sélection d'aide-mémoire.



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED>

Un élément d'aide-mémoire est placé dans le point d'extension cheatsheetContent si un aide-mémoire doit être contribué au plan de travail. L'élément d'aide-mémoire doit comporter un ID, un nom traduisible devant apparaître dans les options de sélection, un ID de catégorie pour préciser la catégorie à laquelle l'aide-mémoire sera intégré et un fichier de contenu. Ce dernier est un fichier XML décrivant les étapes et les actions de l'aide-mémoire.



<!ELEMENT description (#PCDATA)>

une brève description de l'aide-mémoire



L'exemple ci-dessous illustre le point d'extension cheatSheetContent :

<extension point=

"org.eclipse.ui.cheatsheets.cheatSheetContent"

>

<category name=

"Catégorie exemple"

id=

"com.example.category"

>

</category>

<cheatsheet name=

"Aide-mémoire exemple"

category=

"com.example.category"

id=

"com.example.cheatSheet"

contentFile=

"ExampleCheatSheet.xml"

>

<description>

Texte descriptif pour mon aide-mémoire.

</description>

</cheatsheet>

</extension>

Pour en savoir plus, voir la spécification pour le package d'API org.eclipse.ui.cheatsheets.

Il n'y a pas d'aide-mémoire intégrés.