Hilfe-Plug-in implementieren

Die Hilfefunktionen der Eclipse-Plattform stellen Ihnen unformatierte Erstellungsblöcke zur Verfügung, mit denen Sie Ihre Hilfetexte strukturieren und Dokumentation für die Plattform bereitstellen können. Weder Struktur noch Unterteilung der Dokumentation sind vorgegeben. Sie können die Tools und die Struktur für Ihre Dokumentation auswählen, die am Besten für Ihre Anforderungen geeignet sind.  Mit dem Hilfe-Plug-in können Sie Ihre Dokumentationsstruktur in Form einer Inhaltsverzeichnisdatei (toc) für die Plattform beschreiben.

Die Onlinehilfefunktion Ihres Plug-ins wird unter Verwendung des Erweiterungspunkts org.eclipse.help.toc ergänzt. Sie können die Onlinehilfe entweder als Teil des Code-Plug-ins oder aber separat durch ein eigenes Dokumentations-Plug-in bereitstellen.

Die Auslagerung der Dokumentation in ein separates Plug-in ist in solchen Fällen sinnvoll, in denen Dokumentation und Code von unterschiedlichen Teams erstellt werden oder Sie die Kopplung von Dokumentation und Code reduzieren wollen.

Zu den erweiterten Funktionen der Hilfefunktion gehören die kontextbezogene Hilfe mit Referenzlinks sowie die Möglichkeit, Plattformcode aus der Dokumentation heraus aufzurufen. In einem Hilfebrowser können Sie Ihre Dokumentation anzeigen, drucken und durchsuchen. Ab Version 3.1 bietet die neue Hilfesicht zusätzlich dynamische Hilfe und Suchfunktionalität für Verbundinformationen.

Die Ergänzung einer Hilfefunktion lässt sich am besten durch die Erstellung eines Dokumentations-Plug-ins demonstrieren.