Dieser Abschnitt enthält Themen, die sich mit der Installation, Konfiguration und Anpassung der Hilfefunktion für die Zusammenarbeit mit unterschiedlichen Umgebungen und Produkten beschäftigen.
Die Hilfefunktion kann in drei Modi ausgeführt werden, nämlich im Modus für die Workbench (normal), im Modus für das Infocenter und im eigenständigen Modus. Der Modus für die Workbench dient zur Bereitstellung der Hilfetexte, die in das Produkt integriert sind (normalerweise über ein Menü "Hilfe"). Dieser Modus bietet außerdem eine Kontexthilfe und die Sicht "Hilfe", die bei den anderen beiden Modi nicht verfügbar sind. Der eigenständige Modus verfolgt dieselbe Zielsetzung wie der Modus für die Workbench, ist jedoch für Produkte gedacht, die nicht auf Eclipse basieren (die Hilfe ist weniger integriert). Der Modus für das Infocenter wird verwendet, um den Inhalt der Hilfe über das Internet für viele Benutzer bereitzustellen. Details erhalten Sie nach Auswahl der oben angegebenen Links.
Die Hilfefunktion ist eine optionale Komponente von Rich Client Platform (RCP). Dies bedeutet, dass sie nicht Bestandteil der Mindestversion von RCP ist, sondern hinzugefügt werden kann, um den Hilfetext in der RCP-Anwendung bereitzustellen.
Für die Hilfe gibt es Benutzervorgaben, mit denen Produkte die Hilfefunktion an ihre jeweiligen Anforderungen anpassen können. Beispielsweise können das Branding und die Darstellung angepasst, Funktionalitäten aktiviert oder inaktiviert werden usw.
Bei Produkten, die viele Hilfedokumente bereitstellen, kann die Indexierungsphase, die bei der erstmaligen Suche stattfindet, lange dauern. Um diese Verzögerung zu vermeiden, können Sie Ihren Hilfeinhalt vorab indexieren und den vorgefertigten Index zusammen mit der Dokumentation bereitstellen. Auf diese Weise können Sie einen Kompromiss zwischen Leistung (Vermeidung der Indexierungsphase) und Speicherplatz (für den Index) erzielen.