Dynamischer Inhalt

Dynamischer Inhalt - Beschreibung

Bei verschiedenen Komponenten der Benutzerhilfe können Sie dynamischen Inhalt bereitstellen. Dies bedeutet, dass sich der Inhalt je nach Kontext oder Umgebung des Benutzers ändern kann. Es kann beispielsweise sinnvoll sein, ein Hilfedokument oder eine Startseite nur dann anzeigen zu lassen, wenn der Benutzer eine bestimmte Funktion aktiviert hat.

Für die Erstellung von dynamischem Inhalt stehen Ihnen zwei Basismethoden zur Verfügung. Zum einen können Sie Tags und Attribute (Anmerkungen) zur XML-Markup-Formatierung hinzufügen, die das System anweisen, Abschnitte oder Dokumente (inklusive Abschnitte aus anderen Dokumenten) zu filtern, oder Sie können Anker angeben, mit deren Hilfe andere Komponenten Ihre Dokumentation erweitern können.

Die zweite Methode besteht darin, dass Sie eine eigene Dokumenterstellungsfunktion schreiben, indem Sie Java-Code integrieren, der den Inhalt neu schreibt oder vorhandene statische Dokumente während des Betriebs verarbeitet. Diese beiden Methoden werden im Folgenden vorgestellt.

XML-Anmerkungen

Die einfachste Möglichkeit für die Erstellung von dynamischem Inhalt besteht in der Verwendung von Anmerkungen in der XML-Markup-Formatierung. Sie müssen lediglich einige spezielle Attribute und Tags zur XML-Markup-Formatierung hinzufügen. Dann verarbeitet das System die Anweisungen. Mit dieser Markup-Formatierung können Sie Folgendes erreichen:

Weitere Informationen zu den einzelnen Aspekten der Markup-Formatierung erhalten Sie nach Auswahl der obigen Links oder bei einer Suche in den Themen des Inhaltsverzeichnisses.

Dies wird im unten dargestellten XML-Fragment veranschaulicht:


<p>
Dies ist ein statischer Abschnitt.
</p>

<!-- Dieses Tag wird durch das Tag ersetzt, auf das verwiesen wird. -->
<include path="my.plugin.id/path/my_other_document.xhtml/element_id"/>

<ul>
   <li>
      Dies ist ein Eintrag in einer statischen Liste.
   </li>
   <li filter="os=win32">
      Diese Angabe wird nur bei der Ausführung unter Windows angezeigt.
   </li>
   <li filter="plugin!=org.eclipse.help">
      Diese Angabe wird nur dann angezeigt, wenn das Plug-in "org.eclipse.help" NICHT installiert ist.
   </li>
</ul>

<!-- Position, an der andere Inhalt hinzufügen können -->
<anchor id="my.anchor.id"/>

Inhaltserstellungsfunktionen

Eine Inhaltserstellungsfunktion ist ein Mechanismus, mit dem Java-Code integriert werden kann, der den Dokumentinhalt während der Verarbeitung erstellt. Inhaltserstellungsfunktionen sind leistungsfähiger als XML-Anmerkungen, aber ihre Verwendung ist komplexer.

Inhaltserstellungsfunktionen werden in den folgenden Bereichen der Benutzerhilfe unterstützt: