Kurzhilfen werden beschrieben, indem der Kontext-ID, die im
Benutzerschnittstellencode deklariert wurde, eine Beschreibung und
eine Liste von Links zu verwandten Themen im Onlinehilfetext
zugeordnet werden.
Diese Zuordnungen werden innerhalb einer XML-Datei vorgenommen.
Sie können beliebig viele XML-Dateien mit Kurzhilfenzuordnungen für
Plug-ins erstellen.
Die Beschreibung und die Links für eine Kontext-ID
werden in Elementen
<context>
der XML-Datei angegeben. Jedes Kontextelement kann ein
optionales Element <description>
enthalten, mit dem das Benutzerschnittstellenobjekt beschrieben wird,
sowie beliebig viele Elemente <topic>, die die Links zur
Onlinedokumentation angeben.
<contexts> <context id="panic_button"> <description>This is the panic button.</description> <topic href="tasks/pushing_the_panic_button.htm" label="Pushing the panic button"/> <topic href="reference/panic_button.htm" label="Panic Button Reference"/> </context> ... </contexts>
Sobald die Kontexte in der/den XML-Datei(en) beschrieben wurden, können Sie im Plug-in-Manifest auf die Kontextdateien verweisen. Bitte beachten Sie, dass im vorstehenden Beispiel keine vollständig qualifizierte Kontext-ID verwendet wird. Dies ist zulässig, sofern die Kontextdatei im Manifest des Plug-ins ergänzt wird, das die Kontext-ID definiert hat. Anders ausgedrückt wird die Kontext-ID in die ID des Plug-ins aufgelöst, das die XML-Datei ergänzt.
Zur Ergänzung von Kontextdateien verwendet ein Plug-in den Erweiterungspunkt org.eclipse.help.contexts.
<extension point="org.eclipse.help.contexts"> <contexts name="myInfopops.xml" /> </extension>
Sie können auch in anderen Plug-ins auf Kontextdateien verweisen, indem Sie das Attribut plugin aufnehmen. Hierdurch können Sie die gesamte Dokumentation (einschließlich der Kurzhilfen) in einem gemeinsamen Plug-in zusammenfassen und dann aus dem Plug-in für den Benutzerschnittstellencode oder einem anderen zugehörigen Plug-in auf dieses Plug-in verweisen.
<extension point="org.eclipse.help.contexts"> <contexts name="myInfopops.xml" plugin="com.example.helpExample" /> </extension>
Wie Sie sehen, können Sie bei der Verwaltung von Kurzhilfen in einer oder mehreren Dateien, die in einem oder mehreren Plug-ins enthalten sind, äußerst flexibel agieren. Wichtig ist in erster Linie, dass die Kontext-IDs in den Dateien korrekt aufgelöst werden. Wenn Sie keine vollständig qualifizierte Kontext-ID angeben, müssen Sie die XML-Dateien für den Kontext in dem Plug-in ergänzen, das die Kontext-IDs deklariert hat. Bei Verwendung von vollständig qualifizierten Kontext-IDs in der XML-Datei für den Kontext können Sie frei wählen, wo sich die XML-Dateien befinden sollen und welches Plug-in die Kontexte ergänzt.
Eine weitere Flexibilitätsstufe ergibt sich dadurch, dass Kurzhilfen für dieselbe Kontext-ID aus unterschiedlichen Plug-ins ergänzt werden können. Dies ist beispielsweise dann hilfreich, wenn es Plug-ins für verschiedene Dokumentationsgruppen gibt, die in der Konfiguration eines Benutzers installiert werden können, jedoch nicht installiert werden müssen. Auf diese Weise kann jedes Dokumentations-Plug-in seine Kontexte unabhängig deklarieren. Für den Endbenutzer wird der gemischte Kurzhilfeninhalt aller Plug-ins angezeigt, die Kontexte für die ID des Widgets ergänzen.
Bitte beachten Sie, dass die vollständig qualifizierte Kontext-ID für das Widget verwendet werden muss, da keines der Dokumentations-Plug-ins die Kontext-ID deklariert hat. Wenn mehrere Plug-ins Kurzhilfen für dieselbe Kontext-ID bereitstellen, wird zunächst der Inhalt angezeigt, der in dem Plug-in definiert ist, das den Kontext deklarierte (das Plug-in für die Benutzerschnittstelle). Die Reihenfolge, in der zusätzliche Beschreibungen und Links angehängt werden, kann nicht garantiert werden.