Die ersten Schritte sind die schwersten

Praxis-Tutorial: Eclipse RCP Usability

Auf den Inhalt kommt es an

Der Inhalt, der hinter den einzelnen Punkten (im Beispiel Overview und First Steps) steht, sollte durch ein neues Plug-in hinzugefügt werden. Dazu wird ein leeres Resource-Plug-in angelegt. In diesem Plug-in werden nur die für den Inhalt nötigen Konfigurations- und Datendateien hinterlegt, Programmierung ist nicht nötig. Dies erleichtert es natürlich, die Umsetzung durch Teammitglieder aus dem Bereich Dokumentation und Support durchführen zu lassen. Beim Anlegen des Plug-in-Projekts muss darauf geachtet werden, dass keine Optionen ausgewählt sind, die für eine Programmierung oder für das Life-Cycle-Management (z. B. Activator-Klasse) relevant sind. Die Plug-in-ID wird entsprechend der oben genannten Konvention gewählt, für das Beispiel also com.bredexsw.examples.mailbase.welcome.

Welcome Pages werden als Extension Point durch einen Wizard unterstützt. Dazu muss in der Konfiguration durch Editieren der MANIFEST.MF das Plug-in als Singleton definiert werden (im Editor im Tab Overview). Danach gehen wir den leichten Weg und benutzen den vorhandenen Wizard, um die restliche Konfiguration zu erstellen. Dazu muss beim Zufügen einer Extension durch den Extensions Wizard eine Universal Welcome Contribution ausgewählt werden (Abb. 2).

Abb. 2: Erzeugen einer Welcome Contribution

Der Wizard legt eine rudimentäre Infrastruktur für die Inhalte an. Es werden die Konfigurationsdateien für die Verknüpfungen und für Cascading Style Sheets erzeugt. Für die im Wizard voreingestellten Werte (Directory intro, Target Page Overview) wird folgende Struktur erstellt:

  • <plug-in root>
    • intro
    • sample.xml
    • css
      • sample.css
      • graphics
        • … icons etc.

Leider wird vom Wizard der Export des Plug-ins nicht mit angepasst, daher muss noch das intro-Verzeichnis zu den benötigten Artefakten hinzugefügt werden (im Tab Build). Wenn dieses Plug-in beim Start der Anwendung mit angegeben wird, ist jetzt ein Beispieltext für die Sparte Overview vorhanden (die Launch Configuration base_welcome_content zeigt dies an). Die Datei sample.xml enthält die Informationen, die auf den Inhalt der Welcome Pages verweisen (Listing 3).

Listing 3
Die RCP-Mail-Anwendung ist ...

Wichtig sind die Verweise auf die Cascading Style Sheets im Attribut style und die Einordnung in den gesamten Kontext über das Attribut path. Die CSS benutzen die generierte sample.css. Der Wert overview/@ gliedert diese Contribution in die Kategorie Overview ein. Sobald man eine Navigation über mehrere Unterseiten vorsieht, kann dieser Parameter als Verweis in der Navigation benutzt werden. Die in content-group hinterlegten Informationen sind exemplarisch für eine mehr oder weniger aufwändige HTML-Darstellung zu sehen. Die simple Anzeige eines kurzen Textes und ein Verweis auf eine HTML-Seite werden über das link-Target erreicht. Die Erstellung von ansprechenden HTML-Daten überlassen wir Ihrer Dokumentationsgruppe als Übung.

Kommentare

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.