Erstellen von Cheat Sheets

Aus Eclipse
Wechseln zu: Navigation, Suche

Ein einfaches Cheat Sheet

Die Erstellung eines einfachen Cheat Sheets erleichtert Eclipse mit einem Wizard, der durch die wichtigsten Schritte führt. Im folgenden werden wir ein einfaches Cheat Sheet für das Hello World Plug-In aus dem Beispielworkspace erstellen und es bei Eclipse registrieren.

1. Wir erstellen und einen Unterordner in unserem HelloWorldHelpPlugin, in dem das Cheat Sheet abgelegt werden soll. Den Ordner nennen wir cheatsheets.

Ein neuer Ordner cheatsheets


2. Nun starten wir über den Menüpunkt File->New->Other einen Wizard, um ein neues Cheat Sheet zu erzeugen.

Der Cheat Sheet-Wizard


3. Der nächste Schritt ist die Benennung des Cheat Sheets-Files. Wir nennen es einfach HelloWorldCheatSheet.xml. Wir wählen zunächst ein einfaches Cheat Sheet, wir können auch, für komplexere Vorhaben ein Cheat Sheet definieren, das sich aus mehreren zusammensetzt. Dazu müssten wir hier Composite Cheat Sheet als Option auswählen.

Ein Name für das Cheat Sheet-File


4. Nach einem Klick auf Finish sehen wir nun den Cheat Sheet-Editor, in dem wir die einzelnen Schritte des Cheat Sheets erstellen können. Hier erstellen wir jetzt bspw. als Titel "Say Hello to the world", das intro bekommt "Hier lernen wir, wie wir mit unserer komplexen Menüstruktur Hallo in die Welt rufen können." als Text und das Item nennen wir um in "Sags jetzt!" und geben ihm als body die Anweisung: "Wähle im Menü sample Menu den Punkt Sample Command".

Der Cheat Sheet-Editor


5. Nun ist unser erstes Cheat Sheet schon fast fertig, wir müssen es noch bei Eclipse registrieren, damit es unter Help->Cheat Sheets... erscheint. Dazu klicken wir im Cheat Sheet-Editor auf den Link in der rechten oberen Ecke Register this cheat sheet. Daraufhin öffnet sich der Registrierungs-Assistent. Hier definieren wir die Kategorie, in der wir unser Cheat Sheet sehen wollen. Wir nehmen bspw. HelloWorld als Kategorie.

Registrierung des Cheat Sheets Teil 1


6. Nach einem Klick auf Ok wechseln wir nun wieder in die Extensions-Ansicht des HelloWorldHelpPlugin. Hier sehen wir unsere Cheat Sheet-Extension mit der Kategorie und dem Cheat Sheet. Wir passen noch die jeweiligen ids der Kategorie und des Cheat Sheets an.

Registrierung des Cheat Sheets Teil 2


7. Und schon haben wir unser fertiges simples Cheat Sheet. Wenn man das HilfePlug-In nun testet findet man in der Hilfe das Cheat Sheet.

Das fertige Cheat Sheet

Komplexere Cheat Sheets

Die Eclipse Cheat Sheets bieten aber nicht nur die Möglichkeit, statische Inhalte anzuzeigen, man kann auch aus Cheat Sheets heraus commands antriggern.

Möchte man bspw. in Eclipse bevor der User etwas macht den view bspw. auf den Package Explorer view wechseln, so kann man das in einem <item> definieren. In unserer HelloWorldCheatSheet.xml sähe das bspw. aus, wie folgt:

<?xml version="1.0" encoding="UTF-8"?>
<cheatsheet
      title="Say Hello to the world">
   <intro>
      <description>
         <b>Hier lernen wir, wie wir mit unserer komplexen Menüstruktur Hallo in die Welt rufen können.</b>
      </description>
   </intro>
   <item
         title="Sags jetzt!">
      <description>
         <b>Wähle im Menü sample Menu den Punkt Sample Command</b>
      </description>
   </item>
 
   <!-- Hier erzeugen wir ein neues Item, um den Package Explorer View zu öffnen -->
   <item title="Öffne den Package Explorer View">
     <description>Öffne den <b>Package View Explorer</b></description>
     <command required="false"
       serialization="org.Eclipse.ui.views.showView(org.Eclipse.ui.views.showView.viewId=org.Eclipse.jdt.ui.PackageExplorer)"/>
   </item>
</cheatsheet>


Das Mapping der Elemente erklärt sich selbst, wenn man einen Blick auf das Ergebnis unten wirft. Das Cheat Sheet hat jetzt einen neuen Step bekommen, bei dem der User die Wahl hat, ob er ihn selber ausführen (Klick auf "Click when complete", oder Eclipse erledigen lassen möchte (Klick auf "Click to perform"). Das kann man als Ausrede für ganz "Faule" sehen, manchmal ist so etwas aber durchaus nützlich, wenn die Beschreibung eines steps bspw. so schlecht ist, dass der User das control selbst nicht findet.

Beachte: Bei der Definition eines command-Aufrufs ist unbedingt sicherzustellen, dass das Attribut serialization 
               keine Zeilenumbrüche und Leerzeichen enthält!
Der neue Step Öffne den PackageViewExplorer

Weiterführende Artikel

Integration von Hilfe in Eclipse

Dokumentation und Hilfe