tekom-Jahrestagung 2012 - ActiveDoc

User Assistance
Online-Hilfen, z. B. Microsoft Help, besteht die Hilfe aus Strukturelementen
(wie dem Inhaltsverzeichnis, Index, Suchindex und der Seitennavigation),
und dem Inhalt (HTML- und Bild-Dateien) selbst. Die
Strukturelemente werden im XML-Format spezifiziert. Die Datei toc.
xml zum Beispiel spezifiziert das Inhaltsverzeichnis, das einzelne Inhaltsseiten
referenziert.
Abb. 3: Inhaltsverzeichnis-Beispiel im Eclipse Help Format
Der Inhalt (HTML- und Bild-Dateien) kann in einem eigenen Verzeichnis
(wie im Beispiel in Abbildung 2) oder in der Datei doc.zip zusammengefasst
abgelegt werden. Struktur-XML-Dateien und Inhaltsdateien
müssen, um im Eclipse Help Viewer angezeigt zu werden, noch durch
die Dateien plugin.xml und MF/manifest ergänzt werden. Alle Dateien
zusammen ergeben dann ein Eclipse Hilfe Plugin [4].
Inhalt einbinden
Das fertige Eclipse Hilfe Plugin muss nur noch in das Verzeichnis „help/
plugins“ kopiert werden und wird nach einem Neustart des Eclipse
Help Viewers auch im Inhaltsverzeichnis gelistet.
Fazit
Der Eclipse Help Viewer ist mit seinen vielseitigen Einsatzmöglichkeiten
als Open-Source-Projekt plattformübergreifend der ideale Begleiter,
um Kunden ein zuverlässiges und dennoch flexibles Hilfesystem
anzubieten.
Weiterführende Informationen
[1] Eclipse Help Viewer (http://helpaddons.sf.net/)
[2] Information Center (http://help.eclipse.org/helios/index.jsp?topic=/
org.eclipse.platform.doc.isv/guide/ua_help_setup_infocenter.htm)
[3] Writing Documentation and Help for Eclipse Projects and Plug-ins
(http://www.keycontent.org/tiki-index.php?page=Eclipse Help System)
[4] Building a help plug-in (http://help.eclipse.org)
Rückfragen gerne an: harald.hermann@advantest.com
tekom-Jahrestagung 2012
513