Kompozitní pohledy Cheat sheet

Kompozitní pohledy Cheat sheet provádějí komplexními problémy tím, že daný problém rozloží na sadu menších úloh. Kompozitní pohledy Cheat sheet jsou registrovány pomocí   bodu rozšíření org.eclipse.ui.cheatsheets.cheatSheetContent.

Formát souboru s obsahem

Samotný obsah kompozitního pohledu Cheat sheet je definován v samostatném souboru, který odpovídá   specifikaci souboru s obsahem kompozitního pohledu Cheat sheet. Soubor s obsahem je  soubor XML a skládá se z  množiny úloh uspořádaných do skupin ve stromové struktuře.

Kořenovým prvkem kompozitního pohledu Cheat sheet je <compositeCheatsheet>. Ten bude obsahovat jedinou kořenovou úlohu, kterou může být <task> nebo <taskGroup>. Prvky <taskGroup> mohou obsahovat jeden nebo více podřízených prvků, z nichž každý může být <task> nebo <taskGroup>. <task> nemá podřízené úlohy.

Úlohy a skupiny úloh mohou obsahovat prvky <intro>, které obsahují text k zobrazení před spuštěním úlohy, a prvky <onCompletion>, které obsahují text k zobrazení po dokončení úlohy. Prvky <intro> i <onCompletion> mohou obsahovat markup textu formuláře. V níže uvedeném příkladu jsou použity značky <b> a </b> k zobrazení textu tučně.

Úlohy mohou rovněž obsahovat prvky <param>. Úloha druhu Cheat sheet může mít libovolný z následujících parametrů: "id" je ID registrovaného pohledu Cheat sheet, "path" je relativní cesta nebo adresa URL souboru s obsahem Cheat sheet a "skipIntro" je  logický parametr. Pokud je jeho hodnota nastavena na true,  pohled Cheat sheet bude zahájen prvním krokem namísto úvodu. Je třeba zadat buď "id", nebo "path", avšak ne obojí.

Uzel <dependency> z úlohy "B" do úlohy "A" představuje požadavek, aby úloha A byla dokončena před zahájením úlohy B.

Parametry úlohy pohledu Cheat sheet

Je-li úloha kind = "cheatsheet", bude po spuštění této úlohy otevřen pohled Cheat sheet. Existují tři možné parametry úlohy pohledu Cheat sheet.

Název parametru  Popis
id ID pohledu Cheat sheet, které bylo registrováno pomocí bodu rozšíření org.eclipse.ui.cheatsheets.cheatSheetContent. Identifikuje pohled Cheat sheet, který bude asociován s touto úlohou. Mělo by být zadáno buď ID, nebo parametr path (avšak ne obojí).
path Adresa URL souboru s obsahem pohledu Cheat sheet. Adresa URL může být absolutní nebo relativní vzhledem k souboru s obsahem pro kompozitní pohled Cheat sheet. Je-li zadáno jak ID, tak parametr path, bude k vyhledání souboru s obsahem použit parametr path. Parametr ID bude ignorován.
showIntro Logický parametr s výchozí hodnotou true. Pokud je hodnota nastavena na "false", po svém spuštění pohled Cheat sheet na počátku zobrazí první krok namísto úvodu.

Příklad kompozitního pohledu Cheat sheet

Níže uvedený soubor je příkladem vytvoření kompozitního pohled Cheat Sheet ze stávajících pohledů Cheat Sheet. Zobrazuje, jak vytvářet skupiny úloh a umožnit přeskakování úloh.

<?xml version="1.0" encoding="UTF-8"?>
<compositeCheatsheet name="Příklad kompozitního pohledu Cheat sheet">
    <taskGroup name= "Příklad kompozitního pohledu Cheat sheet">
         <intro> Toto je příklad <b>kompozitního pohledu Cheat sheet</b> sestaveného ze stávajících pohledů Cheat sheet.
                 <br/><br/>Úlohu, na které budete pracovat, můžete vybrat buď pomocí hypertextových odkazů, nebo pomocí
                 výběru úlohy ze stromu.
</intro>
         <onCompletion>Blahopřání. Dokončili jste všechny úlohy.</onCompletion>
         <task kind="cheatsheet" name= "Větvení a slučování pomocí CVS" skip="true">
              <param name = "id" value = "org.eclipse.platform.cvs_1" />
              <intro>Tento pohled Cheat sheet je určen pro uživatele CVS. Pokud CVS nepoužíváte nebo
              nemáte v úmyslu větvit a slučovat, můžete tuto úlohu přeskočit.
</intro>
               <onCompletion>Blahopřání. Nyní víte, jak větvit a slučovat.</onCompletion>
         </task>
         <taskGroup name= "Vytváření projektů Java" kind = "sequence">
             <intro> Nejdříve se naučíte vytvořit jednoduchý projekt Java a potom vytvoříte
             projekt Java, který bude používat SWT.
             <br/><br/>Tato skupina úloh je sekvence. To znamená, že
             pokud klepnete na dílčí úlohu "Samostatná aplikace SWT", danou úlohu nebude možné zahájit,
             dokud nedokončíte úlohu "Vytvořit projekt Java".
</intro>
              <onCompletion>Blahopřání. Sestavili jste obě aplikace Java.</onCompletion>
             <task kind="cheatsheet" name= "Vytvořit projekt Java" id = "createJavaProject">
                 <param name="id" value = "org.eclipse.jdt.helloworld"/>
                 <param name="showIntro" value = "false"/>
                 <intro>Tento pohled Cheat sheet vás provede procesem vytváření jednoduché aplikace Ahoj světe.
                        Pohled Cheat sheet může spustit průvodce pro vytvoření nového projektu a nové třídy.
</intro>
                 <onCompletion>Blahopřání. Vytvoření aplikace Ahoj světe proběhlo úspěšně.</onCompletion>
             </task>
             <task kind="cheatsheet" name= "Samostatná aplikace SWT">
                 <intro>Moduly plug-in platformy Eclipse, které přispívají do uživatelského rozhraní, používají Standard Widget Toolkit (SWT).
                    Tento průvodce úlohou můžete použít, chcete-li se dozvědět více o SWT.
</intro>
                 <param name = "id" value = "org.eclipse.jdt.helloworld.swt" />
                  <onCompletion>Blahopřání. Vytvoření aplikace SWT proběhlo úspěšně.</onCompletion>
             </task>      
         </taskGroup>
    </taskGroup>
</compositeCheatsheet>

Rozšiřitelnost kompozitního pohledu Cheat Sheet - provizorní v Eclipse 3.2

Kompozitní pohledy Cheat sheet jsou rozšiřitelné, nicméně ve verzi Eclipse 3.2 je tato rozšiřitelnost provizorní a třídy se mohou změnit dříve, než se stanou rozhraním API. Podporu kompozitního pohledu Cheat sheet lze rozšířit pomocí bodu rozšíření org.eclipse.ui.cheatsheets.cheatSheetContent. Ten má dva nové prvky, taskEditor a taskExplorer, které umožňují přidávat editory úloh a průzkumníky úloh.

Přidání editoru úloh definuje nový druh úlohy, který se zobrazí v sekci Podrobnosti úlohy. Chcete-li přidat editor úloh, implementujte konkrétní podtřídu   TaskEditor a potom  přidejte prvek taskEditor do souboru plugin.xml.

Reprezentaci průzkumníku úloh lze rovněž konfigurovat pomocí bodu rozšíření,  průzkumník stromu  je součástí platformy Eclipse. Ve výchozím nastavení je průzkumníkem pro kompozitní pohled Cheat Sheet při prvním otevření strom, atribut na prvku <compositeCheatSheet> umožní toto výchozí nastavení potlačit. Je-li registrován více než jeden průzkumník, bude nabídka Zobrazit obsahovat položku pro přepínání mezi průzkumníky. Chcete-li přidat průzkumník úloh, nejdříve implementujte konkrétní podtřídu   TaskExplorer a potom  přidejte prvek taskExplorer do souboru plugin.xml.

Související odkazy

Práce s pohledy Cheat sheet
Práce s kompozitními pohledy Cheat Sheet
Vytváření pohledů Cheat sheet
Pokyny pro redakční práce
Specifikace souboru s obsahem kompozitního pohledu Cheat sheet
Bod rozšíření org.eclipse.ui.cheatsheets.cheatSheetContent