Lathundsinnehåll

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Den här utökningspunkten används för att registrera lathundsinnehåll. Lathundar visas som val från menyn "Hjälp" eller från lathundsvyn och används i allmänhet för att vägleda en användare genom en serie komplexa uppgifter för att uppnå ett övergripande mål.

Lathundar är organiserade i kategorier som vanligtvis återspeglar vissa problemområden. Till exempel kan i ett Java-orienterat insticksprogram definieras en kategori med namnet "Java" som lämpar sig för lathundar som ska vägleda en användare med något av Java-verktygen. Kategorierna som definieras i ett insticksprogram kan refereras till från andra insticksprogram med hjälp av kategoriattribut för ett lathundselement. Lathundar som saknar kategori och lathundar med ogiltiga kategorisökvägar hamnar i kategorin "Övriga".

Lathundar kan som så önskas omfatta ett underelement med en beskrivning vars innehåll ska utgöras av en kortfattad text om lathunden.

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

Med ett kategorielement i utökningspunkten cheatsheetContent skapas en ny kategori på lathundsmenyn. Lathundsmenyn är tillgänglig från hjälpmenyn i arbetsmiljön. Om en ny kategori anges kan lathundar anges som mål för den kategorin och visas under den i dialogrutan för val av lathund.



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED

composite   (true | false) "false">

Ett lathundselement infogas i utökningspunkten cheatsheetContent om det finns en lathund som kan läggas till i arbetsmiljön. Ett lathundselement måste ha ett ID, ett översättningsbart namn som visas i valalternativen, ett kategori-ID som anger vilken kategori lathunden ska tillhöra och en innehållsfil. Lathundens innehållsfil är en XML-fil med en beskrivning av de steg och åtgärder som lathunden har.



<!ELEMENT description (#PCDATA)>

en kortfattad beskrivning av lathunden.



<!ELEMENT taskEditor EMPTY>

<!ATTLIST taskEditor

id    CDATA #REQUIRED

class CDATA #REQUIRED

icon  CDATA #REQUIRED>

Den här utökningspunkten är tillfällig och baseras på den tillfälliga API-klass-TaskEditor. Med hjälp av utökningspunkten taskEditor kan ett anpassat gränssnitt visas i redigerarrutan i en sammansatt lathund. För uppgifter i en sammansatt lathund vars typ överensstämmer med ID:t för den här utökningen används den klass som definierats i den här utökningspunkten till att skapa redigerarområdet.



<!ELEMENT taskExplorer EMPTY>

<!ATTLIST taskExplorer

id    CDATA #REQUIRED

class CDATA #IMPLIED

icon  CDATA #IMPLIED

name  CDATA #REQUIRED>

Den här utökningspunkten är tillfällig och baseras på den tillfälliga API-klass-TaskExplorer. Den här utökningspunkten gör det möjligt att lägga till en uppgiftsutforskare som används när en sammansatt lathund öppnas.



Här följer ett exempel på användning av utökningspunkten cheatSheetContent:

<extension point=

"org.eclipse.ui.cheatsheets.cheatSheetContent"

>

<category name=

"Exempelkategori"

id=

"com.example.category"

>

</category>

<cheatsheet name=

"Exempellathund"

category=

"com.example.category"

id=

"com.example.cheatSheet"

contentFile=

"ExampleCheatSheet.xml"

>

<description>

Detta är ett beskrivande textstycke för lathundens beskrivning.

</description>

</cheatsheet>

</extension>

Mer information finns i specifikationen för API-paketet org.eclipse.ui.cheatsheets.

Det finns inga inbyggda lathundar.