Összetett áttekintők

Az összetett áttekintők segítséget nyújtanak a bonyolult problémákhoz azáltal, hogy a problémát kisebb feladatok halmazára osztják. Az összetett áttekintők az   org.eclipse.ui.cheatsheets.cheatSheetContent kiterjesztési pont segítségével kerülnek bejegyzésre.

Tartalomfájl formátuma

Az összetett áttekintő tartalom maga egy különálló fájlban van megadva, amely az  összetett áttekintő-tartalomfájl specifikációjának felel meg. A tartalomfájl   egy XML fájl, és fa struktúra alapon csoportokba szervezett feladatok   halmazából áll.

A <compositeCheatsheet> az összetett áttekintő gyökéreleme. Ez egyetlen gyökérfeladattal rendelkezik, amely egy <feladat> vagy <feladatcsoport> lehet. A <feladatcsoport> elemei leszármazottakkal rendelkezhetnek, amelyek mindegyike lehet <feladat> vagy <feladatcsoport>. A <feladat> nem rendelkezik leszármazott feladatokkal.

A feladatok és feladatcsoportok <intro> elemeket - a feladat elindítása előtt megjelenítendő szöveget tartalmazzák - és <onCompletion> elemeket tartalmazhatnak - a feladat végrehajtása után megjelenítendő szöveget tartalmazzák. Az <intro> és <onCompletion> elemek egyaránt tartalmazhatnak űrlapszöveg leírónyelvet. Az alábbi példában a <b> és </b> címkék a szöveget félkövérrel jelenítik meg.

A feladatok <param> elemeket is tartalmazhatnak. Az áttekintő a következő paraméterekkel rendelkezhet: az "id" a bejegyzett áttekintő azonosítója, a "path" az áttekintő tartalomfájl relatív útvonala vagy URL címe, a "skipIntro" pedig   egy logikai paraméter, amely ha igaz, akkor   az áttekintő az első lépésnél indul el a bevezetés helyett. Az "id" vagy "path" megadható, de mindkettő nem.

A "B" feladat "A" feladatra vonatkozó <dependency> csomópontja egy követelményt ábrázol, amely szerint az A feladatnak be kell fejeződnie a B elindításához.

Áttekintőfeladat-paraméterek

Ha a feladat "cheatsheet" típusú, akkor a feladat indításakor egy áttekintő kerül megnyitásra. Az áttekintő-feladathoz három lehetséges paraméter áll rendelkezésre.

Paraméternév  Leírás
id Az org.eclipse.ui.cheatsheets.cheatSheetContent kiterjesztési ponttal bejegyzett áttekintő azonosítója. Ez a feladathoz rendelendő áttekintőt azonosítja. Az id vagy a path paraméter adható meg, mindkettő nem.
path Az áttekintő tartalomfájl URL címe. Ez lehet egy abszolút, vagy az összetett áttekintő tartalomfájljához viszonyított URL. Ha az id és a path egyaránt meg van adva, akkor a rendszer a path paramétert használja a tartalomfájl kikereséséhez és az id paraméter figyelmen kívül marad.
showIntro Egy logikai paraméter, melynek alapértelmezett érték igaz. Ha "hamis", akkor az áttekintő indításkor kezdetben a bevezető helyett az első lépést jeleníti meg.

Példa összetett áttekintőre

Az alábbi fájl meglévő áttekintőkből egy összetett áttekintő létrehozására mutat példát. Megmutatja, hogyan hozhatók létre feladatcsoportok és hogyan tehetők a feladatok kihagyhatóvá.

<?xml version="1.0" encoding="UTF-8"?>
<compositeCheatsheet name="Összetett áttekintőpélda">
    <taskGroup name= "Összetett áttekintőpélda">
         <intro> Ez egy példa meglévő áttekintőkből egy <b>összetett áttekintő</b> létrehozására.
                 <br/><br/>Kiválaszthatja a végrehajtani kívánt feladatot a hiperhivatkozásokat követve vagy
                 a fában kijelölve.
  </intro>  
         <onCompletion>Gratulálunk! Befejezte az összes feladatot.</onCompletion>
         <task kind="cheatsheet" name= "Elágaztatás és összevonás CVS segítségével"
skip="true">
              <param name = "id" value = "org.eclipse.platform.cvs_1" />
              <intro>Ez az áttekintő CVS felhasználók számára készült. Amennyiben nem használ CVS-t, vagy
              nem szándékozik elágaztatni és összevonni, akkor ezt a feladatot átugorhatja.
  </intro>
               <onCompletion>Gratulálunk! Most már tudja hogyan lehet elágaztatni és összevonni.</onCompletion>
             </task>
         <taskGroup name= "Java projektek létrehozása" kind = "sequence">
             <intro> Először megtanulhatja, hogyan hozzon létre egy egyszerű java projektet, majd egy
             SWT-t használó java projektet fog készíteni.
             <br/><br/>Ez a feladatcsoport egy sorozat, ami azt jelenti, hogy ha
             az "Önálló SWT alkalmazás" alfeladatra kattint, akkor a feladat nem indulhat el,
             amíg a "Java projekt létrehozása" be nem fejeződött.
  </intro>
              <onCompletion>Gratulálunk! Felépítette az összes Java alkalmazást.</onCompletion>
         <task kind="áttekintő" name= "Java projekt létrehozása" id = "createJavaProject">
             <param name="azonosító" value = "org.eclipse.jdt.helloworld"/>
                 <param name="showIntro" value = "false"/>
                 <intro>Ez az áttekintő egy egyszerű hello world alkalmazás létrehozásán visz végig.
                        Az áttekintő varázslókat tud indítani új projekt és új osztály létrehozásához.
  </intro>
             <onCompletion>Gratulálunk, sikeresen létrehozta a hello world alkalmazást</onCompletion>
             </task>
             <task kind="áttekintő" name= "Önálló SWT Alkalmazás">
                  <intro>Az Eclipse bedolgozók, amelyek hozzájárulnak a felhasználói felülethez, a Standard Widget Toolkitet (SWT) használják. 
                        A feladatútmutató segítségével megismerhető az SWT. 
  </intro>
                  <param name = "azonosító" value = "org.eclipse.jdt.helloworld.swt" />
                  <onCompletion>Gratulálunk, sikeresen létrehozott egy SWT alkalmazást. </onCompletion>
             </task>      
    </taskGroup>
    </taskGroup>
</compositeCheatsheet>

Összetett áttekintő bővíthetősége - átmeneti az Eclipse 3.2 változatban

Az összetett áttekintők bővíthetők, azonban az Eclipse 3.2 változatban ez a bővíthetőség átmeneti és az osztályok módosulhatnak, mielőtt alkalmazás programozási felületté válnának. Az összetett áttekintő támogatás az org.eclipse.ui.cheatsheets.cheatSheetContent kiterjesztési pont használatával kiterjeszthető, amely két új elemmel - a taskEditor és taskExplorer elemmel - rendelkezik, és ezek lehetővé teszik a feladatszerkesztők és -böngészők általi kiegészítések megadását.

Feladatszerkesztő általi kiegészítés újfajta feladatot ad meg, amely a feladat részletei részben látható. A közreműködéshez a feladatszerkesztő megvalósít egy konkrét   TaskEditor alosztályt, majd   egy taskEditor elemet ad a plugin.xml fájlhoz.

A feladatböngésző ábrázolása szintén beállítható a   a faböngésző  kiterjesztési ponttal, amelyet az Eclipse platformhoz biztosítanak. Alapértelmezésben az összetett áttekintő böngészője első megnyitáskor egy fa, a <compositeCheatSheet> elem egy attribútuma pedig lehetővé teszi az alapértelmezés újradefiniálását. Ha több böngésző van bejegyezve, akkor a nézet menü egy menüpontot fog tartalmazni a böngészők váltásához. A közreműködéshez a feladatböngésző először megvalósít egy konkrét   TaskExplorer alosztályt, majd  hozzáad egy taskExplorer elemet a plugin.xml fájlhoz.

Kapcsolódó hivatkozások

Áttekintők használata
Összetett áttekintők kezelése
Áttekintők létrehozása
Szerzői irányelvek
Összetett áttekintő-tartalomfájl specifikációja
org.eclipse.ui.cheatsheets.cheatSheetContent kiterjesztési pont