Treść ściągawki

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Ten punkt rozszerzenia umożliwia rejestrowanie treści ściągawek. Ściągawki są dostępne jako pozycje w menu pomocy lub opcje wyświetlane w widoku ściągawek. Mają zwykle za zadanie pomóc użytkownikowi w przejściu serii złożonych czynności i osiągnięciu założonego celu.

Ściągawki dzielą się na kategorie, które odzwierciedlają zwykle określony zakres problemów. Przykładowo moduł dodatkowy związany z językiem Java może definiować kategorię "Java", która jest odpowiednia dla ściągawek pomocnych podczas korzystania z narzędzi Java. Do kategorii zdefiniowanych przez jeden moduł dodatkowy mogą odwoływać się inne moduły za pomocą atrybutu kategorii elementu ściągawki. Ściągawki, które nie są przypisane do żadnej kategorii, a także ściągawki z niepoprawnymi ścieżkami kategorii są umieszczane w kategorii "Inne".

Ściągawki mogą opcjonalnie określać podelement opisu, którego treść powinna zawierać zwięzły tekst z opisem danej ściągawki.

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

Element kategorii w punkcie rozszerzenia cheatsheetContent powoduje utworzenie nowej kategorii w menu ściągawki. Menu ściągawki jest dostępne w menu pomocy środowiska roboczego. W razie podania nowej kategorii można skierować do niej ściągawki - będą one wtedy wyświetlane w tej kategorii w oknie dialogowym wyboru ściągawki.



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED>

Element ściągawki jest umieszczany w punkcie rozszerzenia cheatsheetContent, jeśli istnieje ściągawka, którą można dodać do środowiska roboczego. Element ten musi określać identyfikator, możliwą do przetłumaczenia nazwę wyświetlaną w ramach opcji wyboru, identyfikator kategorii określający kategorię, do której ma być dołączona dana ściągawka, oraz plik treści. Plik treści ściągawki to plik XML, który opisuje kroki i akcje zawarte w ściągawce.



<!ELEMENT description (#PCDATA)>

Krótki opis ściągawki.



Oto przykładowe użycie punktu rozszerzenia cheatSheetContent:

<extension point=

"org.eclipse.ui.cheatsheets.cheatSheetContent"

>

<category name=

"Przykładowa kategoria"

id=

"com.example.category"

>

</category>

<cheatsheet name=

"Przykładowa ściągawka"

category=

"com.example.category"

id=

"com.example.cheatSheet"

contentFile=

"ExampleCheatSheet.xml"

>

<description>

To jest opis mojej ściągawki.

</description>

</cheatsheet>

</extension>

Aby uzyskać więcej szczegółowych informacji, należy zapoznać się ze specyfikacją pakietu API org.eclipse.ui.cheatsheets.

Brak wbudowanych ściągawek.