Contenuto della pagina di aiuto

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Questo punto di estensione viene utilizzato per registrare i contributi del contenuto della pagina di aiuto. Le pagine di aiuto vengono visualizzate come opzioni del menu ? o nella vista della pagina di aiuto e vengono in genere utilizzate per aiutare l'utente attraverso una serie di attività complesse per realizzare un obiettivo globale.

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)*>

<!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>

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.



<!ELEMENT description (#PCDATA)>

una breve descrizione della pagina di aiuto



Di seguito è riportato un utilizzo esemplificativo del punto di estensione cheatSheetContent:

<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"

>

<description>

This is a descriptive bit of text for my cheat sheet description.

</description>

</cheatsheet>

</extension>

Per ulteriori dettagli fare riferimento alle specifiche per il pacchetto API org.eclipse.ui.intro.cheatsheets.

Non esistono pagine di aiuto incorporate.