Inhoud van hulpblad

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Dit extensiepunt wordt gebruikt om de bijdragen voor de inhoud van hulpbladen te registreren. Deze hulpbladen verschijnen als keuzemogelijkheden in het "Help"-menu of binnen de view Hulpblad en worden gewoonlijk gebruikt om de gebruiker bij te staan bij een serie ingewikkelde taken om een bepaald doel te bereiken.

De hulpbladen zijn ondergebracht in categorieën die gewoonlijk zijn gericht op een bepaald probleemgebied. In een Java-georiënteerde plugin kan bijvoorbeeld een categorie met de naam "Java" zijn gedefinieerd die geschikt is voor de hulpbladen die de gebruiker kunnen helpen bij het gebruiken van een van de Java-tools. Plugins kunnen met het categoriekenmerk van een hulpblad-element verwijzen naar categorieën die in een andere plugin zijn gedefinieerd. Ongecategoriseerde hulpbladen en hulpbladen met een ongeldig categoriepad komen in de categorie "Overig" terecht.

Hulpbladen kunnen optioneel een subelement met een beschrijving bevatten. Het corpus moet dan een korte tekst over het hulpblad bevatten.

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

Het element category in het extensiepunt cheatsheetContent maakt een nieuwe categorie in het hulpbladmenu. Het hulpbladmenu is beschikbaar via het menu Help in de workbench. Als een nieuwe categorie is opgegeven, kunnen de hulpbbladen worden gericht op de betreffende categorie en verschijnen deze hieronder in het selectiedialoogvenster van het hulpblad.



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED

composite   (true | false) "false">

Het element cheatsheet in het extensiepunt cheatsheetContent levert een hulpblad voor de workbench aan. Voor het hulpblad moeten worden opgegeven: een ID, een vertaalbare naam die in de selectie-opties wordt afgebeeld, een categorie-ID dat bepaalt in welke categorie dit hulpblad wordt geplaatst en een contentbestand. Het bestand met de inhoud voor het hulpblad is een XML-bestand dat de stappen en acties beschrijft die in het hulpblad staan.



<!ELEMENT description (#PCDATA)>

een korte beschrijving van het hulpblad



<!ELEMENT taskEditor EMPTY>

<!ATTLIST taskEditor

id    CDATA #REQUIRED

class CDATA #REQUIRED

icon  CDATA #REQUIRED>

Dit extensiepunt is provisorisch en is gebaseerd op de provisorische API-klasse TaskEditor. Middels het extensiepunt taskEditor kunnen aangepaste gebruikersinterface-items worden toegevoegd aan het editorgedeelte van een samengesteld hulpblad. Als een taak in het samengestelde hulpblad hetzelfde ID heeft als deze extensie, wordt voor het maken van het editorgebied de klasse gebruikt die in dit extensiepunt is gedefinieerd.



<!ELEMENT taskExplorer EMPTY>

<!ATTLIST taskExplorer

id    CDATA #REQUIRED

class CDATA #IMPLIED

icon  CDATA #IMPLIED

name  CDATA #REQUIRED>

Dit extensiepunt is provisorisch en is gebaseerd op de provisorische API-klasse TaskExplorer. Middels dit extensiepunt kan een taakverkenner worden toegevoegd, die beschikbaar is bij het openen van een samengesteld hulpblad.



Dit is een voorbeeld van de extensie cheatSheetContent:

<extension point=

"org.eclipse.ui.cheatsheets.cheatSheetContent"

>

<category name=

"Voorbeeldcategorie"

id=

"com.example.category"

>

</category>

<cheatsheet name=

"Voorbeeldhulpblad"

category=

"com.example.category"

id=

"com.example.cheatSheet"

contentFile=

"ExampleCheatSheet.xml"

>

<description>

Een beschrijvende tekst over het hulpblad.

</description>

</cheatsheet>

</extension>

Raadpleeg de specificatie van het API-pakket org.eclipse.ui.cheatsheets voor meer details.

Er zijn geen standaard ingebouwde hulpbladen.