Áttekintő-tartalom

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Ez a kiterjesztési pont bejegyzi az áttekintőtartalom-közreadásokat. Az áttekintők lehetőségként jelennek meg a "Súgó" menüben vagy az áttekintő nézetben, és jellemzően átsegítik a felhasználókat összetett feladatok sorozatán egy átfogó cél elérése érdekében.

Az áttekintők kategóriákba vannak szervezve, amelyek általában egy adott problématartományt tükröznek. A Java-orientált bedolgozó például megadhat egy "Java" nevű kategóriát, amely azon áttekintőhöz megfelelő, amely segítséget nyújt a felhasználó számára a Java eszközökkel kapcsolatban. A bedolgozó által megadott kategóriákra más bedolgozók az cheatsheet elem category attribútuma segítségével hivatkozhatnak. A nem kategorizált és az érvénytelen kategória elérési úttal rendelkező áttekintők az "Egyéb" kategóriába kerülnek.

Az áttekintők egy leírásrészelemet is megadhatnak, amelynek törzse az áttekintővel kapcsolatos rövid szöveget tartalmaz.

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

A cheatsheetContent kiterjesztési pontban lévő category elem egy új kategóriát hoz létre az áttekintő menüben. Az áttekintő menü a munkaterület súgó menüjéből érhető el. Egy új kategória megadásakor az áttekintők az adott kategóriára irányíthatók, és az áttekintő-kiválasztási párbeszédablakban alatta fognak megjelenni.



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED>

Ha egy áttekintőt kell hozzáadni a munkaterülethez, akkor a cheatsheet elem bekerül a cheatsheetContent kiterjesztési pontba. A cheat sheet elemnek meg kell adnia egy azonosítót, a kijelölés lehetőségekben megjelenő lefordítható nevet, egy kategóriaazonosítót annak megadásához, hogy az áttekintő mely kategóriába kerül be, és egy tartalomfájlt. Az áttekintő-tartalomfájl egy XML fájl, amely leírja az áttekintő lépéseit és tevékenységeit.



<!ELEMENT description (#PCDATA)>

az áttekintő rövid leírása



Az alábbiakban a cheatSheetContent kiterjesztési pont használati példája található:

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

Ez a szöveg leíró bitje a saját áttekintőleíráshoz.

</description>

</cheatsheet>

</extension>

További információkért tekintse meg az org.eclipse.ui.cheatsheets API csomagot.

Nincsenek beépített áttekintők.