Gründe für die Verwendung von XHTML
Die Hilfefunktion bietet die Möglichkeit, dynamischen Inhalt für die Hilfe bereitzustellen, indem Sie die XHTML-Markup-Formatierung durch besondere Tags für Filter und Elemente include mit Anmerkungen versehen und Anker für Erweiterungen angeben. Bei der Verwendung von HTML sind diese Funktionalitäten nicht verfügbar.
XHTML ergänzen
XHTML-Hilfedokumente werden größtenteils wie HTML-Dateien ergänzt, mit der Ausnahme einiger weniger, aber wichtiger Unterschiede, die für die Unterstützung von dynamischem Inhalt und Suchvorgängen erforderlich sind. Diese erforderlichen Änderungen sind im Folgenden aufgeführt:
Sie müssen den XHTML-Suchteilnehmer an das Dokumentations-Plug-in binden.
Die Eclipse-Implementierung der Hilfe verwendet Lucene, um ihre Dokumente zur Beschleunigung von Suchvorgängen zu indexieren. Damit Lucene ein Dokument indexieren kann, muss es das Format lesen können. Eclipse stellt bereits einen Suchteilnehmer für die Indexierung von XHTML-Dokumenten bereit. Daher müssen Sie die Hilfefunktion lediglich anweisen, ihn für die Dokumente zu verwenden. Fügen Sie die folgende Erweiterung zu Ihrem Plug-in-Manifest hinzu:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Bei Verwendung von dynamischem Inhalt müssen Sie den Produzenten des dynamischen XHTML-Inhalts an das Dokumentations-Plug-in binden.
Falls Sie dynamischen Inhalt unter Verwendung von XML-Anmerkungen erstellen wollen, müssen Sie die Hilfefunktion anweisen, Ihre Dokumente zu verarbeiten. Hierzu binden Sie den Produzenten für dynamischen XHTML-Inhalt an Ihr Plug-in.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
XHTML-Format für Elemente "include"
Wenn Sie in Ihrer XHTML-Datei Elemente include verwenden wollen, hat
das Attribut path
das folgende Format (Erläuterung siehe unten):
<plugin-id>/<pfad_der_xhtml-datei>/<dateiname_xhtml>/<element-id>
Hierbei haben die Felder die folgende Bedeutung:
org.eclipse.help
)
/eigener_ordner/eigener_unterordner/
)
eigene_datei.xhtml
)
id
zu diesem Element festgelegt (z. B.
mein.element.id
).
Beispiel: Wenn Sie den Absatz (Element <p>
) mit der
ID eigenes_copyright
aus der Datei /copyrights/copyright.xhtml
im Plug-in mein.produkt.plugin
aufnehmen wollen, geben Sie Folgendes an:
mein.produkt.plugin/copyrights/copyright.xhtml/eigenes_copyright