Le pagine di aiuto sono organizzate in categorie che in genere riflettono un particolare problema. Ad esempio, un plugin di orientamento Java potrebbe definire una categoria denominata "Java" che risulta appropriata per le pagine di aiuto che aiutano l'utente con gli strumenti Java. Altri plugin possono fare riferimento alle categorie definite da un unico plugin mediante l'attributo categoria della pagina di aiuto. Le pagine di aiuto senza categorie, oppure quelle con percorsi di categoria non validi, confluiranno in una categoria "Altro".
Le pagine di aiuto possono opzionalmente specificare un elemento secondario descrittivo che contenga un breve testo sulla pagina di aiuto.
<!ELEMENT extension (category | cheatsheet | taskEditor | taskExplorer)>
<!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 elemento di categoria nel punto di estensione cheatsheetContent crea una nuova categoria nel menu della pagina di aiuto. Il menu della pagina di aiuto è disponibile nel menu ? del workbench. Se viene specificata una nuova categoria, le pagine di aiuto possono essere indirizzate a quella categoria ed essere visualizzate nella finestra di dialogo di selezione della pagina di aiuto.
<!ELEMENT cheatsheet (description?)>
<!ATTLIST cheatsheet
id CDATA #REQUIRED
name CDATA #REQUIRED
category CDATA #IMPLIED
contentFile CDATA #IMPLIED
listener CDATA #IMPLIED
composite (true | false) "false">
Un elemento della pagina di aiuto viene inserito nel punto di estensione cheatsheetContent se esiste una pagina di aiuto da fornire al workbench. Un elemento della pagina di aiuto deve specificare un id, un nome convertibile da visualizzare nelle opzioni selezionate, un id di categoria per specificare la categoria in cui viene inserita questa pagina di aiuto e un file del contenuto. Il file del contenuto della pagina di aiuto è un file XML che descrive gli avanzamenti e le azioni della pagina di aiuto.
org.eclipse.ui.cheatsheets.CheatSheetListener
.<!ELEMENT description (#PCDATA)>
una breve descrizione della pagina di aiuto
<!ELEMENT taskEditor EMPTY>
<!ATTLIST taskEditor
id CDATA #REQUIRED
class CDATA #REQUIRED
icon CDATA #REQUIRED>
Questo punto di estensione è provvisorio, in quando si basa sulla classe TaskEditor dell'API, a sua volta provvisoria. Il punto di estensione taskEditor consente di visualizzare un UI personalizzato nel riquadro dell'editor di una pagina di aiuto mista. Qualsiasi attività in una pagina di aiuto mista, il cui tipo corrisponde all'ID di questa estensione, utilizzerà la classe definita in questo punto di estensione per creare l'area dell'editor.
<!ELEMENT taskExplorer EMPTY>
<!ATTLIST taskExplorer
id CDATA #REQUIRED
class CDATA #IMPLIED
icon CDATA #IMPLIED
name CDATA #REQUIRED>
Questo punto di estensione è provvisorio, in quando si basa sulla classe TaskExplorer dell'API, a sua volta provvisoria. Questo punto di estensione consente di aggiungere un'utilità di esplorazione attività che verrà utilizzata per aprire una pagina di aiuto mista.
<extension point=
"org.eclipse.ui.cheatsheets.cheatSheetContent"
>
<category name=
"Example category"
id=
"com.example.category"
>
</category>
<cheatsheet name=
"Example cheat sheet"
category=
"com.example.category"
id=
"com.example.cheatSheet"
contentFile=
"ExampleCheatSheet.xml"
>
<descrizione>
This is a descriptive bit of text for my cheat sheet description.</description>
</cheatsheet>
</extension>
Copyright (c) 2004, 2006 IBM Corporation e altri.
Tutti i diritti riservati. Questo programma e il materiale di accompagnamento sono
disponibili secondo i termini della Eclipse Public License v1.0 che sono distribuiti con il prodotto, e disponibili all'indirizzo
http://www.eclipse.org/legal/epl-v10.html