Indhold af snydeark

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Dette udvidelsespunkt bruges til at registrere bidrag til indhold af snydeark. Snydeark vises som valgmuligheder på menuen "Hjælp" eller i oversigten Snydeark og anvendes typisk til at hjælpe en bruger gennem en række komplekse opgaver med henblik på at nå et overordnet mål.

Snydeark er opdelt i kategorier, som normalt afspejler et bestemt problemområde. En Java-orienteret plugin kan f.eks. definere en kategori med navnet "Java", som er egnet til snydeark, der kan hjælpe en bruger med et af Java-værktøjerne. Plugins kan bruge kategoriattributten i et snydearkselement til at referere til kategorier, som er defineret af andre plugins. Ikke-kategoriserede snydeark samt snydeark med ugyldige kategoristier ender i kategorien "Andet".

Snydeark kan angive et beskrivelsesunderelement, som indeholder en kort tekst om snydearket.

<!ELEMENT extension (category | cheatsheet | taskEditor | taskExplorer)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

navn  CDATA #IMPLIED>


<!ELEMENT category EMPTY>

<!ATTLIST category

id             CDATA #REQUIRED

name           CDATA #REQUIRED

parentCategory CDATA #IMPLIED>

Et kategorielement i udvidelsespunktet cheatsheetContent opretter en ny kategori i snydearksmenuen. Snydearksmenuen er tilgængelig fra menuen Hjælp på arbejdsbænken. Hvis der angives en ny kategori, bliver snydearkene rettet mod denne kategori og vises under den i dialogboksen til valg af snydeark.



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED

composite   (true | false) "false">

Et snydearkselement anbringes i udvidelsespunktet cheatsheetContent, hvis der er et snydeark, som skal tilføres arbejdsbænken. Et snydearkselement skal definere en id, et oversætteleligt navn, der skal vises i valgindstillingerne, en kategori-id, som skal angive, hvilken kategori dette snydeark skal inkluderes i, samt en indholdsfil. Indholdsfilen for snydeark er en XML-fil, der beskriver de trin og funktioner, som snydearket indeholder.



<!ELEMENT description (#PCDATA)>

En kort beskrivelse af snydearket.



<!ELEMENT taskEditor EMPTY>

<!ATTLIST taskEditor

id    CDATA #REQUIRED

klasse CDATA #REQUIRED

icon  CDATA #REQUIRED>

Dette udvidelsespunkt er midlertidigt, baseret på den midlertidige API-klasse TaskEditor. Udvidelsespunktet taskEditor tillader kunde-UI at blive vist i det sammensatte snydearks editorvindue. Enhver opgave i et sammensat snydeark, hvis type matcher id'en for denne udvidelse anvender den klasse, der er defineret i dette udvidelsespunkt for at oprette editorområdet.



<!ELEMENT taskExplorer EMPTY>

<!ATTLIST taskExplorer

id    CDATA #REQUIRED

class CDATA #IMPLIED

icon  CDATA #IMPLIED

name  CDATA #REQUIRED>

Dette udvidelsespunkt er midlertidigt, baseret på den midlertidige API-klasse TaskExplorer. Dette udvidelsespunktet tillader levering af en opgavestifinder, der anvendes til at åbne sammensatte snydeark.



Her er et eksempel på brug af udvidelsespunktet cheatSheetContent:

<udvidelsespunkt=

"org.eclipse.ui.cheatsheets.cheatSheetContent"

>

<category name=

"Eksempel på kategori"

id=

"com.example.category"

>

</category>

<cheatsheet name=

"Eksempel på snydeark"

category=

"com.example.category"

id=

"com.example.cheatSheet"

contentFile=

"ExampleCheatSheet.xml"

>

<beskrivelse>

Dette er en tekst, der beskriver mit snydeark.

</description>

</cheatsheet>

</extension>

Der er flere oplysninger i specifikationerne til API-pakken org.eclipse.ui.cheatsheets.

Der er ingen indbyggede snydeark.