DITA-Inhaltsreferenz – Übersicht
Mithilfe der DITA-Inhaltsreferenzen (conref) können Sie den Inhalt von Elementen aus einem DITA-Dokument in ein anderes DITA-Dokument aufnehmen. Wenn Inhalte aus einem anderen Dokument über eine Inhaltsreferenz eingefügt werden, ersetzt der eingefügte Inhalt den im referenzierten Element vorhandenen Inhalt. Eine Ausnahme hierzu ist die Zusammenführung von Attributen aus dem referenzierenden und dem referenzierten Element, die im Komplettdokument bei der Formatierung und bei der Veröffentlichung des Dokuments unterstützt wird.
Inhaltsreferenzen basieren auf Elementen, d.h. das Element auf das Sie verweisen, muss dem Element entsprechen, das die Inhaltsreferenz enthält. Der Inhalt, auf den verwiesen wird, kann im Dokument angezeigt, jedoch nicht bearbeitet werden. Sie müssen die ursprüngliche Quelle des Verweises ändern, um Änderungen vornehmen zu können. In der Arbortext Editor Quellenverwaltung können Sie nach Inhalten suchen, auf die in Ihren Dokumenten verwiesen werden soll. Wenn sich ein gültiges Verweiselement zurzeit nicht im Dokument befindet, wird von der Quellenverwaltung automatisch ein neues, leeres Element als Ziel der Inhaltsreferenz eingefügt.
Inhaltsreferenzen werden über ein Attribut im betreffenden Dokumenttyp definiert. Das Attribut wird in der Dokumenttyp-Konfigurationsdatei (.dcf) definiert. Bei DITA-Dokumenten steht das Attribut conref für die meisten Elemente zur Verfügung, und es wird als Inhaltsreferenz-Attribut verwendet.
Im Inhaltsreferenz-Attribut geben Sie die Zeichenfolge, mit der auf ein Element in einem DITA-Topic verwiesen wird, im folgenden Format an:
[[path/]filename][#topic-id[/element-id]]
[[path/]filename] ist ein optionaler Verweis auf die Datei, die den Verweis enthält. Es kann sich um einen absoluten oder relativen Dateinamen handeln, der auch Pfadkomponenten enthalten kann. Wenn der Dateiname nicht angegeben ist, wird davon ausgegangen, dass sich der Verweis im aktuellen Dokument befindet. Wenn kein absoluter Dateiname angegeben ist, wird die Inhaltsreferenz über den DITA Reference-Pfad aufgelöst.
topic-id/element-id ist ein Navigationspfad von ID-Attributen innerhalb eines Dokuments. topic-id ist die ID des DITA-Themenelements (oder der Spezialisierung dieses Themenelements, z.B. Konzept, Aufgabe oder Verweis), das das Element enthält, auf das verwiesen wird. element-id ist die ID des Elements im Thema, das wieder verwendet werden soll, z.B. ein Absatz oder Listeneintrag. Beide Angaben werden für Inhaltsreferenzen innerhalb von Topics benötigt. Wenn die element-id fehlt, bezieht sich der Verweis auf das gesamte Thema. Wenn beide IDs (topic-id und element-id) fehlen, bezieht sich der Verweis auf das erste Thema in der Datei.
Im Inhaltsreferenz-Attribut geben Sie die Zeichenfolge, mit der auf ein Element in einer DITA-Map verwiesen wird, im folgenden Format an:
[[path/]filename][#mapelement-id]
Für Referenzen auf Elemente in DITA-Maps ist nur die Element-ID notwendig. Wenn die mapelement-id fehlt, wird auf das gesamte Strukturdokument verwiesen. Wenn filename nicht angegeben ist, wird auf ein Element im aktuellen Dokument verwiesen.
Beispiel: Ein DITA-Absatzelement enthält die folgende Inhaltsreferenz:
<p conref=”C:\DITA content\releases.dita#product/version”></p>
Das Attribut conref gibt an, dass der Inhalt des p-Elements vom p-Element mit der ID version eingeschlossen werden soll, wobei es sich um ein Kind-Element des Topic-Elements mit der ID product handelt; dieses befindet sich im Dokument releases.dita. Das referenzierte Dokument releases.dita enthielte die folgenden Elemente: