Ściągawki złożone

Ściągawki złożone ułatwiają wykonywanie złożonych czynności, które zostają rozłożone na poszczególne etapy. Do rejestrowania ściągawek złożonych służy punkt rozszerzenia org.eclipse.ui.cheatsheets.cheatSheetContent.

Format pliku treści

Treść ściągawki złożonej definiuje się w osobnym pliku zgodnym ze specyfikacją plików treści ściągawek złożonych. Plik treści to plik XML zawierający zbiór czynności połączonych w grupy umieszczone w strukturze drzewa.

Elementem głównym ściągawki złożonej jest element <compositeCheatsheet>. Zawiera on jedną czynność główną (<task> lub <taskGroup>). W poszczególnych elementach <taskGroup> może występować jeden lub więcej elementów potomnych typu <task> lub <taskGroup>. Element <task> nie zawiera czynności potomnych.

W ramach czynności i grup czynności mogą występować elementy <intro>, które zawierają tekst wyświetlany przed rozpoczęciem wykonywania czynności, a także elementy <onCompletion>, które zawierają tekst wyświetlany po zakończeniu wykonywania czynności. Zarówno elementy <intro>, jak i <onCompletion> mogą zawierać znaczniki tekstu formularza (na poniższym przykładzie wykorzystano do pogrubienia tekstu znaczniki <b> i </b>).

Oprócz tego w ramach czynności mogą występować elementy <param>. Czynność umieszczona w ściągawce może zawierać parametry "id" (identyfikator zarejestrowanej ściągawki), path(ścieżka względna lub adres URL pliku treści ściągawki) i skipIntro (parametr boolowski, który w przypadku wartości true powoduje rozpoczęcie wyświetlania ściągawki od pierwszej czynności, a nie od wprowadzenia). Konieczne jest podanie parametru id LUB path (a nie obu parametrów jednocześnie).

Węzeł zależności (<dependency>) łączący czynność B z czynnością A oznacza, że czynność A musi zostać wykonana przed rozpoczęciem wykonywania czynności B.

Parametry czynności w ściągawce

Jeśli parametr rodzaju czynności (kind) ma wartość cheatsheet, przed rozpoczęciem wykonywania tej czynności zostanie otwarta ściągawka. Zadanie w ściągawce może mieć trzy parametry.

Nazwa parametru Opis
id Identyfikator ściągawki zarejestrowanej za pomocą punktu rozszerzenia org.eclipse.ui.cheatsheets.cheatSheetContent. Wskazuje ściągawkę, która ma zostać powiązana z daną czynnością. Należy podać identyfikator LUB ścieżkę.
path Adres URL pliku treści ściągawki. Może to być bezwzględny adres URL lub adres względny wobec pliku treści ściągawki złożonej. Jeśli podane zostaną jednocześnie identyfikator i ścieżka, do znalezienia pliku treści wykorzystana zostanie tylko ścieżka (identyfikator zostanie zignorowany).
showIntro Parametr boolowski o wartości domyślnej true. W przypadku wartości false po otwarciu ściągawki zostanie najpierw wyświetlona pierwsza czynność, z pominięciem wprowadzenia.

Przykład ściągawki złożonej

Poniżej przedstawiono przykładowy plik ilustrujący sposób tworzenia ściągawki złożonej na podstawie istniejących ściągawek. Na tym przykładzie zilustrowano sposób tworzenia grup czynności oraz opcjonalnego pomijania poszczególnych czynności.

<?xml version="1.0" encoding="UTF-8"?>
<compositeCheatsheet name="Przykładowa ściągawka złożona">
    <taskGroup name= "Przykładowa ściągawka złożona">
         <intro> Jest to przykładowa <b>ściągawka złożona</b>, którą utworzono na podstawie dotychczasowych ściągawek.
                 <br/><br/>Wykonywaną czynność można wybrać za pomocą hiperłączy lub
                 poprzez wybranie jej w ramach drzewa.
  </intro>
         <onCompletion>Gratulacje! Wszystkie czynności zostały wykonane.</onCompletion>
         <task kind="cheatsheet" name= "Rozgałęzianie i scalanie za pomocą systemu CVS" skip="true">
              <param name = "id" value = "org.eclipse.platform.cvs_1" />
              <intro>Ściągawka ta jest przeznaczona dla użytkowników systemu CVS. Jeśli nie korzystasz z systemu CVS lub
              nie zamierzasz dokonywać rozgałęziania i scalania, czynność tę można pominąć.
  </intro>
               <onCompletion>Gratulacje! Wiesz już, jak dokonywać rozgałęziania i scalania.</onCompletion>
         </task>
         <taskGroup name= "Tworzenie projektów w języku Java" kind = "sequence">
             <intro> Najpierw omówimy sposób tworzenia prostego projektu w języku Java, a następnie utworzymy
             projekt, w którym zostanie wykorzystany pakiet narzędzi SWT.
             <br/><br/>Przedstawiona została grupa zadań typu sequence. Oznacza to, że
             kliknięcie czynności podrzędnej "Autonomiczna aplikacja SWT" nie spowoduje rozpoczęcia tej czynności
             do momentu zakończenia czynności "Tworzenie projektu w języku Java".
  </intro>
              <onCompletion>Gratulacje! Utworzone zostały obie aplikacje w języku Java.</onCompletion>
         <task kind="cheatsheet" name= "Tworzenie projektu w języku Java" id = "createJavaProject">
                 <param name="id" value = "org.eclipse.jdt.helloworld"/>
                 <param name="showIntro" value = "false"/>
                 <intro>W tej ściągawce opisano kolejne etapy procesu tworzenia prostej aplikacji powitalnej.
                        Za pomocą ściągawki można uruchamiać kreatory służące do tworzenia nowego projektu lub nowej klasy.
  </intro>
             <onCompletion>Gratulacje! Aplikacja powitalna została pomyślnie utworzona.</onCompletion>
             </task>
             <task kind="cheatsheet" name= "Autonomiczna aplikacja SWT">
                  <intro>Wtyczki platformy Eclipse wnoszące elementy do interfejsu użytkownika korzystają z pakietu narzędzi SWT (Standard Widget Toolkit). Podane wskazówki pozwalają uzyskać więcej informacji na temat pakietu SWT.
  </intro>
                 <param name = "id" value = "org.eclipse.jdt.helloworld.swt" />
                  <onCompletion>Gratulacje! Aplikacja SWT została utworzona pomyślnie.</onCompletion>
             </task>      
         </taskGroup>
    </taskGroup>
</compositeCheatsheet>

Rozszerzalność ściągawek złożonych (obsługa tymczasowa na platformie Eclipse 3.2)

Ściągawki złożone są rozszerzalne, jednak na platformie Eclipse 3.2 rozszerzalność ta ma charakter tymczasowy, ponieważ klasy mogą ulec zmianie przed przekształceniem ich w interfejs API. Obsługę ściągawek złożonych można rozszerzać za pomocą punktu rozszerzenia org.eclipse.ui.cheatsheets.cheatSheetContent, który zawiera dwa nowe elementy (taskEditor i taskExplorer) umożliwiające wnoszenie edytorów czynności i eksploratorów czynności.

Wniesienie edytora czynności pozwala zdefiniować nowy rodzaj czynności wyświetlany w sekcji szczegółów czynności. Aby wnieść edytor czynności, należy zaimplementować konkretną podklasę elementu TaskEditor, a następnie dodać element taskEditor do pliku plugin.xml.

Odzwierciedlenie eksploratora czynności można także konfigurować za pomocą punktu rozszerzenia. Eksplorator drzew jest dostarczany wraz z platformą Eclipse. Domyślnie przy pierwszym otwarciu ściągawki złożonej w eksploratorze wyświetlany jest widok drzewa. Atrybut elementu <compositeCheatSheet> umożliwia zmianę wartości domyślnej. Jeśli zarejestrowano kilka eksploratorów, menu widoku zawiera element pozwalający przełączać eksploratory. Aby wnieść eksplorator czynności, należy zaimplementować konkretną podklasę elementu TaskExplorer, a następnie dodać element taskExplorer do pliku plugin.xml.

Odsyłacze do stron pokrewnych

Praca ze ściągawkami
Praca ze ściągawkami złożonymi
Tworzenie ściągawek
Wytyczne dotyczące tworzenia ściągawek
Specyfikacja formatu plików treści ściągawek złożonych
Punkt rozszerzenia org.eclipse.ui.cheatsheets.cheatSheetContent