Die Vorteile, frühzeitig über Benutzerfreundlichkeit nachzudenken, sind zahlreich: Zum einen trägt sie zum wichtigen ersten Eindruck einer Software bei. Ein weiterer Vorteil ist die Kundenzufriedenheit, wenn das Produkt auch ohne die 1 000 Seiten Dokumentation verständlich ist. Auch finanzielle Gründe spielen eine Rolle, denn es ist aufwändiger, Benutzerfreundlichkeit später hinzuzufügen, als sie von Anfang an einzuplanen. Man spart zudem Geld in der Gewährleistung und im Support, weil der Kunde nicht ständig wegen Kleinigkeiten nachfragen muss. Dabei ist es nicht schwierig, eine Benutzerhilfe in sein Produkt einzubauen. Dieser Artikel beschäftigt sich mit zwei Eclipse-Konstrukten: "Welcome Pages" und "Cheat Sheets". Deren Implementierung ist kein Ersatz für ein wohlüberlegtes Bedienkonzept, kann aber die notwendige Hilfestellung bieten, um dem Benutzer den Einstieg zu erleichtern.
Die Beispielanwendung
Unser wichtigstes Anliegen in diesem Artikel ist es zu zeigen, wie einfach die Grundlagen für Benutzerhilfen zu schaffen sind, und auf die kleinen Fallen hinzuweisen, die bei der Umsetzung lauern. Als Basis für unsere Beispiele dient eine altbekannte RCP-Anwendung: das Mail-Plug-in. Diese Anwendung lässt sich innerhalb der IDE durch FILE | NEW>PROJECT… erstellen. Um eine identische Basis für alle Beispiele zu haben, sollte man sich alle Projekte aus dem bereitgestellten Archiv (siehe Kasten) in einen Workspace installieren. Die generierte RCP-Mail-Anwendung steht im Projekt base bereit.Wir gehen auch davon aus, dass Plug-ins und RCP-Anwendungen für Sie kein Neuland sind, daher wird hier weitgehend auf Schritt-für-Schritt-Erklärungen verzichtet. Alle Umsetzungen sind unsere "Best Practices", d. h. sie wurden bereits in Produkten eingesetzt und funktionieren problemlos. Sie haben allerdings beileibe keinen Anspruch auf Vollständigkeit oder Ausschließlichkeit. Für sehr komplexe Systeme sind sie sicher nicht hinreichend, aber sie bilden einen guten Ausgangspunkt.
Aufbau der Beispielanwendung
Die Eclipse-Projekte für die verschiedenen Stufen der Beispielanwendung können als Zip-Archiv heruntergeladen [1] und in einen Workspace installiert werden (per FILE | IMPORT…).
Projekte
Die eigentliche Anwendung steht jeweils in den Projekten, die mit base beginnen. Sie unterscheiden sich nur durch geänderte Konfigurationen (plugin.xml, MANIFEST.MF). Zur besseren Unterscheidung in den Launch-Configurations und beim Erstellen einen Anwendung ist jeweils die Major-Version um eins erhöht.
- base
- base_welcome
- base_welcome_branded In welcome_pages sind die Konfigurationen und Inhalte der Beispielseiten hinterlegt.
- welcome_pages Die Projekte cheatsheet… enthalten die Konfigurationen und Inhalte der Cheat Sheets.
- cheatsheet
- cheatsheet_commands Inhalt von configurations sind Launch-Configurations (s. u.).
- configurations
Launch Configurations
Zum leichten Ausprobieren der verschiedenen Ausbaustufen sind Lauch Configurations beigefügt. Sie stehen im Projekt configurations im Verzeichnis launch-configs. Abweichend von der Benennung im Text ist der Name der Launch Configuration jeweils aus der unterstützten Plattform und dem "eigentlichen" Namen zusammengesetzt. So heißt base beispielsweise tatsächlich u. a. galileo_osx_cocoa_base. Probieren Sie einfach aus, was für Ihre Plattform vorhanden ist, und passen Sie ggf. die Konfigurationen an.
Walk-Through
Ein Walk-Through (d. h. Schritt für Schritt und reich bebildert) zum Einbau von Bedienhilfen ist (auf Englisch) unter [2] verfügbar. Dort wird eine RCP-Anwendung "aus dem richtigen Leben" um entsprechende Konstrukte erweitert.
Welcome Pages
Bei vielen Anwendungen gibt es wichtige Informationen, die ein Benutzer sehen sollte, bevor er beginnt zu arbeiten. Selbst kurze PDF-Einleitungen sind aber kein beliebtes Lesematerial. Man braucht idealerweise eine Informationsquelle, die direkt in die Anwendung eingebaut ist, um dem Anwender wichtige Informationen und Neuigkeiten mitzuteilen. Die Welcome Pages erfüllen diesen Bedarf, da sie beim Neustart der Anwendung erscheinen. Das HTML-Format wirkt freundlich und bietet anhand von Grafiken und kurzen Texten eine Stelle, um den Benutzer über Neuigkeiten, erste Schritte, Webressourcen, Beispiele und Migration zu informieren. Beim Schreiben der HTML-Seiten sollte man beachten, dass man die Dokumentation nicht einfach wiedergibt, sondern sich auf das Wesentliche konzentriert. Sinnvolle Verlinkungen zwischen Seiten machen auch die Welcome Pages benutzerfreundlicher.Die Welcome Pages können komplett ohne Programmierung erstellt werden. Zu ihrer Nutzung müssen jedoch einige Plug-ins bereitgestellt werden. Dies kann entweder dadurch erreicht werden, dass sie explizit in die Anwendung installiert werden oder dadurch, dass sie in den Abhängigkeiten der Anwendung aufgelistet sind und daher beim Bauen aus Eclipse heraus mit installiert werden. In unseren Beispielen haben wir aus Gründen der leichteren Nachvollziehbarkeit jeweils alle benötigten Plug-ins deklariert.
Um Welcome Pages wie in der Eclipse-IDE zu erhalten, werden zwei Plug-ins benötigt. Dabei stellt org.eclipse.ui.intro die benötigten Extension Points bereit, org.eclipse.ui.intro.universal die Standardimplementierung, wie sie auch in der IDE Anwendung findet.
Die Welcome Pages werden mit ein paar Deklarationen in der plugin.xml-Datei eingebunden. Dazu muss der Extension Point org.eclipse.ui.intro benutzt werden:
<extension point="org.eclipse.ui.intro"><introProductBindingintroId="org.eclipse.ui.intro.universal"productId="com.bredexsw.examples.mailbase.product"></introProductBinding></extension>
