XHTML-Hilfedokumente ergänzen

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:

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:

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