Sammansatta lathundar

Sammansatta lathundar ger hjälp med att lösa komplicerade problem genom att problemen delas upp i mindre uppgifter. Sammansatta lathundar registreras med utökningspunkten   org.eclipse.ui.cheatsheets.cheatSheetContent.

Innehållsfilsformat

Själva innehållet i den sammansatta lathunden definieras i en separat fil som överensstämmer med   innehållsfilsspecifikationen för den sammansatta lathunden. Innehållsfilen är en XML-fil och består av en uppsättning uppgifter som är sorterade i grupper i en trädstruktur.

<compositeCheatsheet> är rotelementet för en sammansatt lathund. Det har en enda rotuppgift som kan vara ett <task>- eller <taskGroup>-element. <taskGroup>-element kan ha ett eller flera underordnade element som vart och ett kan vara ett <task>- eller <taskGroup>-element. Ett <task>-element har inte underordnade uppgifter.

Uppgifter och uppgiftsgrupper kan innehålla <intro>-element som innehåller den text som ska visas innan uppgiften har startats och <onCompletion>-element som innehåller den text som ska visas när uppgiften slutförts. Både <intro>- och <onCompletion>-elementen kan innehålla formulärtextmärkord. I exemplet nedan används märkorden <b> och </b> till att göra text fetstilt.

Uppgifter kan även innehålla <param>-element. En lathundsuppgift kan ha följande parametrar: "id" - ID:t för en registrerad lathund, "path" - den relativa sökvägen eller URL-adressen för innehållsfilen för en lathund och "skipIntro" - en boolesk parameter som när den har värdet true gör att lathunden startar vid det första steget och inte vid introduktionen. Antingen "id" eller "path" måste anges, men inte båda.

En <dependency>-nod från uppgiften "B" till uppgiften "A" representerar ett krav om att uppgift A ska ha slutförts innan uppgift B kan startas.

Parametrar för lathundsuppgifter

Om en uppgift har kind = "cheatsheet" öppnas en lathund när uppgiften startas. Det finns tre möjliga parametrar för lathundsuppgifter.

Parameternamn  Beskrivning
ID ID:t för en lathund som har registrerats med hjälp av utökningspunkten org.eclipse.ui.cheatsheets.cheatSheetContent. Det identifierar den lathund som associeras med uppgiften. Antingen ID:t eller sökvägsparametern (men inte båda) ska anges.
path URL-adressen för en innehållsfil till en lathund Det kan vara en URL-adress som är absolut eller en som är relativ till innehållsfilen för den sammansatta lathunden. Om både ID:t och sökvägen är specificerade används sökvägen till att söka efter innehållsfilen och ID-parametern ignoreras.
showIntro En boolesk parameter med standardvärdet true. Om värdet "false" anges visas det första steget och inte introduktionen när lathunden startas.

Exempel på en sammansatt lathund

Filen nedan är ett exempel på hur du skapar en sammansatt lathund från befintliga lathundar. Där visas hur du skapar uppgiftsgrupper och anger att det ska gå att hoppa över uppgifter.

<?xml version="1.0" encoding="UTF-8"?>
<compositeCheatsheet name="Exempel på sammansatt lathund">
    <taskGroup name= "Exempel på sammansatt lathund">
         <intro> Det här är ett exempel på en <b>sammansatt lathund</b> som skapats från befintliga lathundar.
                 <br/><br/>Du kan välja en uppgift som du vill arbeta med antingen genom att följa hyperlänkar eller genom att
                 välja en uppgift i trädet.
                </intro>  
         <onCompletion>Grattis! Du har slutfört alla uppgifter.</onCompletion>
         <task kind="cheatsheet" name= "Förgrena och sammanfoga med hjälp av CVS" skip="true">
              <param name = "id" value = "org.eclipse.platform.cvs_1" />
              <intro>Den här lathunden är avsedd för CVS-avändare. Om du inte använder CVS eller
              inte har för avsikt att förgrena eller sammanfoga kan du hoppa över den här uppgiften.
                </intro>
               <onCompletion>Grattis! Du vet nu hur du förgrenar och sammanfogar.</onCompletion>
         </task>
         <taskGroup name= "Skapa Java-projekt" kind = "sequence">
             <intro> Först får du information om hur du skapar ett enkelt Java-projekt och sedan om hur du skapar
             ett Java-projekt där SWT används.
             <br/><br/>Den här uppgiftsgruppen är en sekvens som innebär att
             om du klickar på underuppgiften "Fristående SWT-tillämpning" kommer inte uppgiften att starta
             förrän "Skapa ett Java-projekt" har slutförts.
                </intro>
              <onCompletion>Grattis! Du har skapat båda Java-tillämpningarna.</onCompletion>
             <task kind="cheatsheet" name= "Skapa ett Java-projekt" id = "createJavaProject">
                 <param name="id" value = "org.eclipse.jdt.helloworld"/>
                 <param name="showIntro" value = "false"/>
                 <intro>I den här lathunden visas processen med att skapa en enkel Hello World-tillämpning.
                        Från lathunden kan guider för att skapa ett nytt projekt och en ny klass startas.
                </intro>
                 <onCompletion>Grattis! Du har skapat en Hello World-tillämpning</onCompletion>
             </task>
             <task kind="cheatsheet" name= "Fristående SWT-tillämpning">
                 <intro>För Eclipse-insticksprogram som används till att lägga till i användargränssnittet används Standard Widget Toolkit (SWT).
                    Du kan läsa i uppgiftshjälpen om du vill få mer information om SWT.
                  </intro>
                 <param name = "id" value = "org.eclipse.jdt.helloworld.swt" />
                  <onCompletion>Grattis! Du har skapat en SWT-tillämpning.</onCompletion>
             </task>
         </taskGroup>
    </taskGroup>
</compositeCheatsheet>

Utökningsmöjligheter för sammansatta lathundar - provisoriskt i Eclipse 3.2

Sammansatta lathundar är utökningsbara. I Eclipse 3.2 är dock de här utökningsmöjligheterna provisoriska och klasserna bör ändras innan de blir API. Funktioner för sammansatta lathundar kan utökas med hjälp av utökningspunkten org.eclipse.ui.cheatsheets.cheatSheetContent som har två nya element, taskEditor och taskExplorer, som gör det möjligt att lägga till uppgiftsredigerare och uppgiftsutforskare.

När du lägger till en uppgiftsredigerare definieras en ny typ av uppgift som visas i avsnittet med uppgiftsinformation. Om du vill lägga till en uppgiftsredigerare implementerar du den konkreta underklassen TaskEditor och sedan lägger du till ett taskEditor-element i plugin.xml.

Representationen av uppgiftsutforskaren kan också konfigureras med hjälp av en utökningspunkt. En trädutforskare ingår i Eclipse-plattformen. Som standard är utforskaren för en sammansatt lathund ett träd när den först öppnas. Med ett attribut för <compositeCheatSheet>-elementet kan den standardinställningen åsidosättas. Om fler än en utforskare har registrerats visas ett menyalternativ för växling mellan utforskare på vymenyn. Om du vill lägga till en uppgiftsutforskare implementerar du den konkreta underklassen TaskExplorer och sedan lägger du till ett taskExplorer-element i plugin.xml.

Relaterade länkar

Arbeta med lathundar
Arbeta med sammansatta lathundar
Skapa lathundar
Sammanställa riktlinjer
Innehållsfilsspecifikation för sammansatt lathund
org.eclipse.ui.cheatsheets.cheatSheetContent extension point