Samengestelde hulpbladen

Samengestelde hulpbladen bieden hulp bij complexe problemen door ze in een reeks kleinere taken te verdelen. U kunt een samengesteld hulpblad registreren via het extensiepunt org.eclipse.ui.cheatsheets.cheatSheetContent.

Contentbestandsindeling

De content van het samengestelde hulpblad is in een afzonderlijk bestand gedefinieerd, dat in overeenstemming is met de specificatie van het contentbestand voor het samengestelde hulpblad. Het contentbestand is een XML-bestand en bestaat uit een reeks taken die in een boomstructuur over groepen zijn verdeeld.

<compositeCheatsheet> is het hoofdelement van een samengesteld hulpblad. Het element bevat één hoofdtak die van het type <task> of <taskGroup> kan zijn. <taskGroup>-elementen kunnen een of meer onderliggende elementen bevatten die eveneens van het type <task> of <taskGroup> kunnen zijn. Een <task>-element heeft geen subtaken.

Taken en taakgroepen kunnen de elementen <intro> en <onCompletion> bevatten. In het eerste element staat de tekst die wordt afgebeeld voordat de taak is gestart, in het tweede element staat de tekst die wordt afgebeeld nadat de taak is voltooid. Zowel het element <intro> als het element <onCompletion> kunnen formuliermarkup bevatten. In het onderstaande voorbeeld wordt tekst vet afgebeeld door de tags <b> en </b>.

Taken kunnen verder <param>-elementen bevatten. Een hulpbladtaak kan de volgende parameters bevatten: "id" geeft het ID van een geregistreerd hulpblad aan, "path" geeft het relatieve pad of de relatieve URL van het contentbestand voor het hulpblad aan en de booleaanse parameter "skipIntro" geeft aan of het hulpblad bij de eerste stap moet beginnen in plaats van bij de inleiding. "id" en "path" kunnen niet samen worden gebruikt.

Het knooppunt <dependency> van taak "B" naar taak "A" geeft aan dat taak A moet worden voltooid voordat taak B kan worden gestart.

Parameters voor een hulpbladtaak

Als in een taak kind = "cheatsheet" is gedefinieerd, wordt er een hulpblad geopend als de taak wordt gestart. Er zijn drie mogelijke parameters voor een hulpbladtaak.

Parameternaam  Beschrijving
id Het ID van een hulpblad dat is geregistreerd met behulp van het extensiepunt org.eclipse.ui.cheatsheets.cheatSheetContent. Hiermee wordt aangegeven welk hulpblad aan deze taak gekoppeld wordt. U moet ofwel de parameter 'id' (ID) ofwel de parameter 'path' (pad) opgeven, maar niet beide.
path De URL van het contentbestand voor een hulpblad. Dit kan een absolute URL zijn of een relatief pad naar het contentbestand voor het samengestelde hulpblad. Als zowel het ID als het pad worden opgegeven, wordt het pad gebruikt om het contentbestand op te zoeken. De parameter 'id' wordt dan genegeerd.
showIntro Een booleaanse parameter met de standaardwaarde 'true'. Als het hulpblad wordt gestart met de waarde "false", wordt in plaats van de inleiding de eerste stap afgebeeld.

Voorbeeld van een samengesteld hulpblad

Hieronder ziet u hoe u een samengesteld hulpblad kunt maken aan de hand van bestaande hulpbladen. Daarnaast ziet u hoe u taakgroepen kunt samenstellen en taken als niet-verplicht kunt instellen.

<?xml version="1.0" encoding="UTF-8"?>
<compositeCheatsheet name="Voorbeeld van samengesteld hulpblad">
    <taskGroup name= "Voorbeeld van samengesteld hulpblad">
         <intro> Dit is een voorbeeld van een <b>samengesteld hulpblad</b> dat is opgebouwd uit bestaande hulpbladen.
                 <br/><br/>U kunt een taak waaraan u wilt werken selecteren door op de volgende hyperlinks te klikken of door een taak in de structuur te selecteren.
  </intro>
         <onCompletion>Gefeliciteerd. U hebt alle taken voltooid.</onCompletion>
         <task kind="cheatsheet" name= "Vertakkingen maken en samenvoegen met CVS" skip="true">
              <param name = "id" value = "org.eclipse.platform.cvs_1" />
              <intro>Dit hulpblad is bedoeld voor gebruikers van CVS. Als u CVS niet gebruikt of geen vertakkingen wilt maken of samenvoegen, kunt u deze taak overslaan.
  </intro>
               <onCompletion>Gefeliciteerd. U hebt geleerd om vertakkingen te maken en samen te voegen.</onCompletion>
             </task>
         <taskGroup name= "Java-projecten maken" kind = "sequence">
             <intro> Eerst leert u hoe u een eenvoudig Java-project maakt, vervolgens maakt u
             een Java-project dat gebruikmaakt van SWT.
             <br/><br/>Deze taakgroep is een serie, hetgeen inhoudt dat de subtaak
             "Zelfstandige SWT-toepassing" pas kan worden gestart (door erop te klikken)
             als de taak "Java-project maken" is voltooid.
  </intro>
              <onCompletion>Gefeliciteerd. U hebt beide Java-toepassingen gemaakt.</onCompletion>
         <task kind="cheatsheet" name= "Een Java-project maken" id = "createJavaProject">
             <param name="id" value = "org.eclipse.jdt.helloworld"/>
                 <param name="showIntro" value = "false"/>
                 <intro>In dit hulpblad wordt beschreven hoe u een eenvoudige toepassing met de naam 'Hallo wereld' maakt.
                        Vanuit dit hulpblad kunt u wizards starten om een nieuw project en een nieuwe klasse te maken.
  </intro>
             <onCompletion>U hebt de toepassing "Hallo wereld" gemaakt.</onCompletion>
             </task>
             <task kind="cheatsheet" name= "Zelfstandige SWT-toepassing">
                  <intro>Eclipse-plugins die de gebruikersinterface uitbreiden, zijn gebaseerd op SWT (Standard Widget Toolkit).
                        In deze taak kunt u meer te weten komen over SWT.
  </intro>
                  <param name = "id" value = "org.eclipse.jdt.helloworld.swt" />
                  <onCompletion>Gefeliciteerd. U hebt een SWT-toepassing gemaakt.</onCompletion>
             </task>
    </taskGroup>
    </taskGroup>
</compositeCheatsheet>

Samengestelde hulpbladen uitbreiden - proef in Eclipse 3.2

Samengestelde hulpbladen kunnen worden uitgebreid. In Eclipse 3.2 is deze uitbreidbaarheid nog niet definitie en daarom kunnen de klassen worden gewijzigd voordat ze API worden. U kunt de ondersteuning voor samengestelde hulpbladen uitbreiden met het extensiepunt org.eclipse.ui.cheatsheets.cheatSheetContent. Dit heeft twee nieuwe elementen, taskEditor en taskExplorer, waarmee u taakeditors en taakverkenners kunt aanleveren.

Als u een taakeditor aanlevert, definieert u een nieuw taaktype dat in de taakdetails wordt afgebeeld. Voor het aanleveren van een taakeditor moet u een concrete subklasse van TaskEditor implementeren en vervolgens het element taskEditor aan plugin.xml toevoegen.

U kunt de taakverkenner ook configureren met een extensiepunt, een structuurverkenner, die bij het Eclipse-platform is geleverd. De verkenner voor een samengesteld hulpblad wordt standaard als boomstructuur geopend. U kunt dit gedrag echter wijzigen via een kenmerk van het element <compositeCheatSheet>. Als er meerdere verkenners zijn geregistreerd, bevat het viewmenu een optie waarmee u tussen verkenners kunt schakelen. Voor het aanleveren van een taakverkenner moet u een concrete subklasse van TaskExplorer implementeren en vervolgens het element taskExplorer aan plugin.xml toevoegen.

Verwante onderwerpen

Werken met hulpbladen
Werken met samengestelde hulpbladen
Hulpbladen maken
Richtlijnen voor auteurs
Specificatie van contentbestand voor samengesteld hulpblad
Extensiepunt org.eclipse.ui.cheatsheets.cheatSheetContent