Koostemuistilistat

Koostemuistilistat ohjaavat monimutkaisten ongelmien ratkaisussa osittamalla ongelman joukoksi pienempiä tehtäviä. Koostemuistilistat rekisteröidään  laajennuspisteen org.eclipse.ui.cheatsheets.cheatSheetContent avulla.

Sisältötiedoston muoto

Koostemuistilistan sisältö määritetään erillisessä tiedostossa, joka noudattaa  koostemuistilistan sisältötiedoston määritystä. Sisältötiedosto on  XML-tiedosto, joka koostuu  joukosta rakenteeksi järjestettyjä tehtäviä.

<compositeCheatsheet> on koostemuistilistan juurielementti. Siinä on yksi juuritehtävä, joka voi olla <task> tai <taskGroup>. <taskGroup>-elementeissä voi olla useita alitehtäviä, joista kukin voi olla <task> tai <taskGroup>. Jos se on <task>, sillä ei ole alitehtäviä.

Tehtävissä ja tehtäväryhmissä voi olla <intro>-elementtejä, joissa on tekstiä, joka näkyy ennen tehtävän aloitusta, ja <onCompletion>-elementtejä, joissa on tekstiä, joka tulee näkyviin, kun tehtävä on valmis. Sekä <intro>- että <onCompletion>-elementeissä voi olla muotoon liittyviä tekstimerkintöjä. Seuraavassa esimerkissä tunnisteet <b> ja </b> lihavoivat tekstin.

Tehtävissä voi olla myös <param>-elementtejä. Muistilistan tehtävässä voi olla mikä tahansa seuraavista parametreista: "id" on rekisteröidyn muistilistan tunnus, "path" on muistilistan sisältötiedoston suhteellinen polku tai URL-osoite ja "skipIntro" on  totuusarvoparametri, jonka arvo true saa  muistilistan alkamaan ensimmäisestä vaiheesta eikä johdannosta. Joko parametri "id" tai "path" on määritettävä, mutta ei molempia.

<dependency>-solmu tehtävästä "B" tehtävään "A" kuvaa edellytystä, että tehtävä A on toteutettu, ennen kuin tehtävän B voi aloittaa.

Muistilistojen tehtäväparametrit

Jos tehtävässä on merkintä kind = "cheatsheet", tehtävää aloitettaessa avataan muistilista. Muistilistatehtävillä on kolme mahdollista parametria.

Parametrin nimi  Kuvaus
id Laajennuspisteen org.eclipse.ui.cheatsheets.cheatSheetContent avulla rekisteröity muistilistan tunnus. Id-parametrin avulla tunnistetaan se muistilista, joka liitetään kyseiseen tehtävään. Joko id- tai path-parametri on määritettävä, mutta ei molempia.
path Muistilistan sisältötiedoston URL-osoite. Path-parametri voi olla tarkka tai koostemuistilistan sisältötiedostoon nähden suhteellinen URL-osoite. Jos sekä id- että path-parametri on määritetty, sisältötiedosto haetaan path-parametrin perusteella ja id-parametri ohitetaan.
showIntro Boolean-tyyppinen parametri, jonka oletusarvo on true. Jos arvoksi määritetään "false", muistilistassa näkyy aloitettaessa esittelyn sijaan suoraan ensimmäinen vaihe.

Esimerkki koostemuistilistasta

Seuraava tiedosto on esimerkki siitä, kuinka koostemuistilista luodaan aiemmin luoduista muistilistoista. Se näyttää, kuinka luodaan tehtäväryhmiä ja tehdään tehtävistä ohitettavia.

<?xml version="1.0" encoding="UTF-8"?>
<compositeCheatsheet name="Koostemuistilistaesimerkki">
    <taskGroup name= "Koostemuistilistaesimerkki">
         <intro> Tämä on esimerkki <b>koostemuistilistasta</b>, joka on koottu aiemmin luoduista muistilistoista.
                 <br/><br/>Voit valita käytettävän tehtävän seuraamalla hyperlinkkejä tai valitsemalla tehtävän rakenteesta.
</intro>  
         <onCompletion>Olet suorittanut kaikki tehtävät.</onCompletion>           
         <task kind="cheatsheet" name= "Haaroitus ja yhdistäminen CVS:n avulla" skip="true">
              <param name = "id" value = "org.eclipse.platform.cvs_1" />
              <intro>Tämä muistilista on tarkoitettu CVS-käyttäjille. Jos et käytä CVS:ää tai aio käyttää haaroitusta tai yhdistämistä, voit ohittaa tämän tehtävän.
</intro>
               <onCompletion>Nyt osaat haaroittaa ja yhdistää.</onCompletion> 
             </task>
         <taskGroup name= "Java-projektien luonti" kind = "sequence">
             <intro> Aluksi opit luomaan yksinkertaisen Java-projektin, sitten luot SWT:tä käyttävän Java-projektin.
             <br/><br/>Tämä tehtäväryhmä on sarja, mikä tarkoittaa, että jos napsautat alitehtävää "Itsenäinen SWT-sovellus", tehtävää ei voi aloittaa,
ennen kuin "Java-projektin luonti" on valmis.
</intro>
              <onCompletion>Olet koonnut molemmat Java-sovellukset.</onCompletion>
         <task kind="cheatsheet" name= "Create a java project" id = "createJavaProject">
             <param name="id" value = "org.eclipse.jdt.helloworld"/>
                 <param name="showIntro" value = "false"/>
                 <intro>Tämä muistilista sisältää yksinkertaisen Hello world -sovelluksen luonnin vaiheet.
                        Muistilista voi luoda uuden projektin ja uuden luokan aloittamalla ohjattuja toimintoja.
</intro>
             <onCompletion>Congratulations you have succeeded in creating a hello world application</onCompletion>
             </task>
             <task kind="cheatsheet" name= "Itsenäinen SWT-sovellus">
                  <intro>Eclipse plugins which contribute to the user interface use The Standard Widget Toolkit (SWT). 
                        This task guide can be used to learn more about SWT. 
</intro>
                  <param name = "id" value = "org.eclipse.jdt.helloworld.swt" />
                  <onCompletion>Olet luonut SWT-sovelluksen.</onCompletion>
             </task>      
    </taskGroup>
    </taskGroup>
</compositeCheatsheet>

Koostemuistilistan laajennettavuus - ehdollinen Eclipsen versiossa 3.2

Koostemuistilistoja voi laajentaa, mutta Eclipsen versiossa 3.2 laajennettavuus on ehdollista, koska luokat voivat muuttua, ennen kuin niistä tulee ohjelmointirajapinta. Koostemuistilistojen tukea voi laajentaa laajennuspisteen org.eclipse.ui.cheatsheets.cheatSheetContent avulla, jossa on kaksi uutta elementtiä, taskEditor ja taskExplorer. Niiden avulla voit lisätä tehtävien muokkausohjelmia ja tehtävien selausnäkymiä.

Tehtävien muokkausohjelman lisäys määrittää uudenlaisen tehtävän, joka näkyy tehtävän tietojen osiossa. Voit lisätä tehtävien muokkausohjelman toteuttamalla konkreettisen aliluokan  TaskEditor ja  lisäämällä sitten taskEditor-elementin plugin.xml-tiedostoon.

Tehtävien selausnäkymän esitystapa on muokattavissa laajennuspisteen,  rakenteen selausnäkymän,  avulla, joka sisältyy Eclipse-käyttöympäristöön. Oletusarvon mukaan koostemuistilistan selausnäkymä on ensimmäisellä avauskerralla rakennenäkymä. Oletusarvoa voi muuttaa <compositeCheatSheet>-elementin määritteen avulla. Jos rekisteröityjä selausnäkymiä on useita, näkymävalikko sisältää valikkovaihtoehdon, jonka avulla voit vaihtaa selausnäkymää. Voit lisätä tehtävien selausnäkymän toteuttamalla konkreettisen aliluokan  TaskExplorer ja  lisäämällä sitten taskExplorer-elementin plugin.xml-tiedostoon.

Aiheeseen liittyviä linkkejä

Muistilistojen käyttö
Koostemuistilistojen käyttö
Muistilistojen luonti
Muistilistojen laatimisohjeet
Koostemuistilistan sisältötiedoston XML-muoto
org.eclipse.ui.cheatsheets.cheatSheetContent-laajennuspiste