Hilfesystem
Das Hilfesystem-Plug-in org.eclipse.help definiert zwei
Erweiterungspunkte (contexts (= Kontexte) und
toc (= Inhaltsverzeichnis)), an denen einzelne Plug-ins
Ergänzungen für die Onlinehilfefunktion und die kontextbezogene Hilfe
zu ihren Komponenten hinzufügen können.
Ein typisches Plug-in, das Dokumentation bereitstellt, würde diese Erweiterungspunkte verwenden.
Andere Erweiterungspunkte dienen zur Erweiterung des Leistungsspektrums des Hilfesystems.
Für erweiterte Anwendungen gibt es zusätzlich einen
Erweiterungspunkt support (= Unterstützung), an dem eine Benutzerschnittstelle
für das Hilfesystem hinzugefügt werden kann.
Erweiterungspunkte
Das Hilfesystem kann an den folgenden Erweiterungspunkten erweitert
werden:
Benutzervorgaben
Die folgenden Benutzereinstellungen können mit dem Hilfesystem verwendet werden:
-
log_level: Gibt an, welche Art von Information in das Hilfeprotokoll geschrieben wird. Verwenden Sie einen der folgenden drei Werte:
- 0: Nur Protokollfehler
- 1: Protokollfehler und Warnungen
- 2: Protokollfehler, Warnungen und Informationsmeldungen (Debug-Meldungen)
- banner: Die Hilfeansicht unterstützt das Branding vn Applikationen. Wenn Sie ein Firmenlogo oder beliebige andere Elemente auf der Hilfeansicht anzeigen möchten, geben Sie Ihre HTML-Seite als /pluginId/path/to/banner.html an. Derzeit ist der Standardbanner /org.eclipse.help.webapp/banner.html. Wenn Sie diesen Namen auf eine leere Zeichenfolge setzen, wird kein Banner angezeigt.
- banner_height: Die Höhe des Bannerbereichs. Derzeit ist der Standardwert 45.
- help_home: Die beim Öffnen der Hilfe im Inhaltsbereich anzuzeigende Seite. Geben Sie Ihre HTML-Seite als /pluginId/path/to/home.html an.
Die Standardausgangsposition ist derzeit /org.eclipse.help/doc/help_home.html.
- linksView: Wird zur Steuerung der Sichtbarkeit der Anzeige der dazugehörigen Links auf "true" oder "false" gesetzt.
- baseTOCS: Geordnete Liste an Hilfe-Inhaltsverzeichnissen (Büchern), wie diese in einem Bücherregal aussehen würden. Alle anderen Inhaltsverzeichnisse basieren auf diesen Büchern. Nicht vorhandene Inhaltsverzeichnisse in dieser Liste werden ignoriert. Verwenden Sie die Position jedes Inhaltsverzeichnisse als /pluginId/path/to/toc.xml.