Obsah Cheat sheet

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Tento bod rozšíření se používá k registraci příspěvků obsahu Cheat sheet. Pohledy Cheat sheet se zobrazují jako volby v nabídce "Nápověda" nebo z pohledu Cheat sheet a jsou zpravidla používány jako pomoc uživatele v sériích složitých úloh nutných ke splnění celkového cíle.

Cheat sheet jsou uspořádány do kategorií, které obvykle odrážejí doménu konkrétního problému. Například modul plug-in orientovaný na prostředí Java může definovat kategorii nazvanou "Java", která je příslušná pro Cheat sheet, které by měly pomoci uživateli s kterýmkoliv z nástrojů Java. Kategorie definované jedním modulem plug-in mohou být odkazovány ostatními moduly plug-in pomocí atributu kategorie prvku cheatsheet. Cheat sheet nezařazené do kategorií a také Cheat sheet s neplatnou cestou kategorie skončí v kategorii "Ostatní".

Cheat sheet mohou volitelně určit popisný dílčí prvek, jehož tělo by mělo obsahovat krátký text ohledně pohledu Cheat sheet.

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

Prvek kategorie v bodu rozšíření cheatsheetContent vytváří novou kategorii v nabídce Cheat sheet. Nabídka Cheat sheet je dostupná z nabídky nápovědy v pracovní ploše. Pokud je uvedena nová kategorie, pohledy Cheat sheet mohou být zaměřeny na tuto kategorii a budou se v rámci ní zobrazovat v dialogovém okně výběru Cheat sheet.



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED>

Prvek cheatsheet je vložen do bodu rozšíření cheatsheetContent, pokud existuje cheat sheet, kterým se má přispět do pracovní plochy. Prvek cheat sheet musí specifikovat ID, přeložitelný název, který se zobrazí v možnostech výběru, ID kategorie pro určení, do které kategorie bude tento cheat sheet zahrnut, a soubor s obsahem. Soubor s obsahem Cheat sheet soubor XML, který popisuje kroky a akce, které tento cheat sheet má.



<!ELEMENT description (#PCDATA)>

Krátký popis Cheat sheet



Zde je příklad užití bodu rozšíření 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>

Jedná se o popisný úsek textu pro popis mého Cheat sheet.

</description>

</cheatsheet>

</extension>

Další podrobnosti viz specifikace pro balíček rozhraní API org.eclipse.ui.cheatsheets.

Neexistují žádné vestavěné pohledy Cheat sheet.