Anker

Sie können sich einen Anker als den funktional entsprechenden Erweiterungspunkt für Dokumente der Benutzerhilfe vorstellen. Genauso wie Komponenten Erweiterungspunkte verwenden, damit andere Komponenten ihre Funktionalität erweitern können, sind Dokumente in der Lage, durch die Verwendung von Ankern die Erweiterung des Inhalts der Benutzerhilfe durch andere Komponenten zu ermöglichen.

Angenommen, die Dokumentation der Komponente A stellt eine Liste der unterstützten Dateiformate bereit. Falls die Komponente B die Unterstützung der Komponente A um einige Formate erweitert, können Sie einen Anker in der Liste der Komponente A platzieren und die Liste aus B erweitern. Beispiel:

   <p>Die folgende Liste enthält die unterstützten Formate:</p>
   <ul>
      <li>Portable Network Graphics (.png)</li>
      <li>Joint Photographic Experts Group (.jpeg)</li>
      <li>Graphical Interchange Format (.gif)</li>
      
      <!-- Hier werden zusätzliche Formate eingefügt -->
      <anchor id="image_format_list"/>
   </ul>

Die Komponente B kann dann den Anker ergänzen, um weitere Formate zur Liste hinzuzufügen.

Inhalt an einem Anker ergänzen

Die Vorgehensweise richtet sich nach dem Typ des Dokuments. Im Allgemeinen definieren Sie eine Erweiterung, die auf eine XML-Datei zeigt, in der der hinzuzufügende Inhalt enthalten ist. Durch Auswahl der Links im folgenden Abschnitt erfahren Sie, wie Sie hierzu im verwendeten Dokumenttyp vorgehen müssen.

Einsatzmöglichkeiten für Anker

Die folgende Liste enthält die Dokumenttypen, in denen Elemente "include" verwendet werden können. Das Format des Elements path in der Angabe "include" ist vom Typ des Dokuments abhängig, aus dem Inhalt eingefügt wird. Im obigen Beispiel ist erkennbar, dass XHTML-Hilfedokumente das Format <plugin-id>/<dateipfad>/<element-id> haben. Das Format für den jeweiligen Dokumenttyp wird nach Auswahl der folgenden Links angezeigt.