Erfahren Sie, was Inhaltsreferenzen in einem strukturierten Dokument sind und wie sie verwendet werden können, um einen Verweis auf Inhalte in einem anderen DITA-Topic zu erstellen.
Eine Inhaltsreferenz (conref) wird zum Erstellen einer Referenz auf Inhalte (Elemente) eines DITA-Topic oder einer DITA Map in einem anderen DITA-Topic verwendet. Mit einer Conref können Sie Inhalte (Elemente) in verschiedenen DITA-Topics wiederverwenden. Eine Conref basiert auf dem Attribut „DITA-ID“, das dem Element zugewiesen ist. Dies bedeutet Folgendes: Wenn sich die Position eines Elements im Topic ändert, bleibt die Referenz intakt, solange die ID intakt bleibt.
Sie können eine direkte Referenzierung verwenden, um direkt auf das DITA-Thema (.xml-Datei) zu verweisen, welches die Zielthemen oder -elemente enthält Alternativ dazu können Sie indirekte Referenzen dazu verwenden, auf in Schlüsselräumen definierte Schlüssel zu verweisen. Weitere Informationen finden Sie unter DITA-Referenzen.
Sie können Conrefs für fast jedes beliebige Element im DITA-Elementkatalog erstellen. Sie erstellen Conrefs zu einem DITA-Thema
, um ein ganzes Thema wiederverwendbar zu machen. Sie können auch eine Conref für ein <keyword>
- oder <ph>
-Element erstellen, um einen Begriff oder ein Wort wiederzuverwenden. <>
Die einzige Voraussetzung für das Erstellen einer Conref lautet, dass das Element das Attribut „DITA-ID“ definieren muss.
Erfahren Sie, wie Sie in FrameMaker ein Topic für die Verwendung von Conrefs einrichten.
Um in Ihren DITA-Themen eine Conref zu erstellen, müssen Sie zunächst ein DITA-Thema (direkte Referenz) oder eine DITA-Zuordnung (indirekte Referenz) erstellen, welches/welche die Inhalte (die Elemente) enthält, die Sie wiederverwenden möchten. Beispiel: Angenommen, Sie möchten eine Tabelle, eine sortierte Liste und ein Bild in verschiedenen Themen wiederverwenden. Sie müssen diese Elemente dem Quellthema hinzufügen. Wenn Sie indirekte Referenzen verwenden, wird das Thema dann der DITA Map hinzugefügt. Um ein Element darüber hinaus wiederverwendbar zu machen, müssen Sie dem Element eine eindeutige Kennung zuweisen. Ausführliche Informationen dazu, wie DITA-Inhalte wiederverwendbar gemacht werden, finden Sie unter Referenzinhalte einrichten.
Erfahren Sie, wie Sie das Dialogfeld „DITA-Conref“ verwenden, um DITA-Inhalten in FrameMaker direkte und indirekte Conrefs hinzuzufügen.
Verwenden Sie das Dialogfeld „DITA-Conref“ zum Hinzufügen direkter und indirekter Conrefs zu DITA-Inhalten.
Wählen sie
.Aktivieren Sie diese Option, um eine Conref mithilfe von DITA-Referenzen einzufügen. Weitere Informationen finden Sie unter Conref erstellen.
Aktivieren Sie diese Option, um eine Conref mithilfe von DITA-Referenzen einzufügen. Weitere Informationen finden Sie unter DITA-Verknüpfung erstellen.
Aktivieren Sie diese Option, um eine Verknüpfung mithilfe von direkten oder indirekten Referenzen zu erstellen.
Wenn das Ziel auf Datei gesetzt ist, wählen Sie ein DITA-Topic aus der Liste der derzeit geöffneten Topics für direkte Referenzen aus. Sie können auch nach einem Thema suchen, das zurzeit nicht geöffnet ist.
Wenn das Ziel auf Schlüssel gesetzt ist, wählen Sie einen Schlüssel als indirekte Referenz aus. Sie können auch das Dialogfeld DITA-Schlüsselraummanager öffnen. Dieses Dialogfeld verwenden Sie zum Schlüsselraum erstellen und zum Festlegen des Standardschlüsselraums für das aktuelle Topic.
Suchen Sie das erforderliche Thema oder den Schlüssel, mit dem Sie eine Verknüpfung herstellen möchten. Die intelligente Suchfunktion filtert die Elemente, während Sie mit der Eingabe in das Filtertextfeld starten. Sie können Inhalte auf Grundlage des Element-Tags, der ID oder Textes (Inhalt) filtern.
Nachdem Sie das erforderliche Thema gefunden haben, können Sie ein Element auswählen, um es als Verknüpfung aufzunehmen. Das Verknüpfungselement definiert eine Beziehung zu einem anderen Thema.
Hier können Sie ein Element als das letzte Element in einem Bereich von mit Conref zu referenzierenden Elementen auswählen. Ausführliche Informationen finden Sie unter Conref zu einem Bereich von Elementen erstellen.
Erfahren Sie, wie Sie in FrameMaker mit Conrefs arbeiten und Conrefs erstellen sowie aktualisieren.
Sie können im Dialogfeld „DITA-Conref“ eine Conref in einem DITA-Topic oder einer Map erstellen.
In diesem Abschnitt werden die folgenden Themen abgedeckt:
Um eine Conref für ein DITA-Thema zu erstellen, oder in Ihrem aktuellen Thema oder Ihrer Zuordnung zu erstellen, müssen Sie zuerst Referenzinhalte einrichten in den Zielthemen oder Zuordnungen durchführen
Danach erstellen Sie eine direkte oder indirekte Referenz auf den Ziel-DITA-Inhalt.
Platzieren Sie die Einfügemarke an der Position, an der die Conref in einem Thema oder einer Map eingefügt werden soll.
Um eine Conref an einer Stelle im Thema einzufügen, müssen Sie die Einfügemarke an der entsprechenden Stelle des Conref-Elements platzieren:
Ein <li>
-Conref-Element (Listenelement) muss in einer <ol>
- oder <ul>
-Liste platziert werden.
Eine <row>
einer Tabelle muss in einer <table>
oder <simpletable>
platziert werden.
Im Fall von <entry>
einer Tabelle können Sie die Einfügemarke nicht in der <row>
der Tabelle platzieren. Sie müssen den vorhandenen <entry>
auswählen, der ersetzt werden soll.
Wählen Sie
.Das Dialogfeld „DITA-Conref“ wird angezeigt.
Sie haben die Option, eine Verknüpfung als einen direkten oder indirekten Verweis auf die Zielinhalte hinzuzufügen. Ausführliche Informationen finden Sie unter DITA-Referenzen.
Erstellen einer direkten Referenz auf die Zielinhalte:
Aktivieren Sie die Option Datei für das Ziel und wählen Sie die Datei, die das Referenz-Topic enthält.
Nachdem Sie ein DITA-Thema ausgewählt haben, zeigt die Liste „Elemente“ die Elemente an, denen eindeutige Kennungen zugewiesen sind.
Die Elemente im DITA-Topic des ausgewählten Elements, denen eine eindeutige Kennung zugewiesen ist, werden in der Liste „Elemente“ angezeigt. Wenn einem Element keine eindeutige ID zugewiesen ist, ist das Element eine eindeutige ID zuweisen möglich.
Wählen Sie ein Element zum Einfügen als Conref im aktuellen Thema aus.
In der Liste werden darüber hinaus auch die ID und die Inhalte (im Fall von Textelementen) der Elemente angezeigt.
Wenn Sie im Quellthema Änderungen an einem <conref>-Element vornehmen, müssen Sie das Quellthema speichern und das Container-Thema aktualisieren, um die Aktualisierungen sehen zu können.<>
Erstellen einer indirekten Referenz zum Zielinhalt:
Wählen Sie die Option Schlüssel für das Ziel und klicken Sie auf Schlüsselraummanager.
Wählen sie im Dialogfeld DITA-Schlüsselraummanager den Schlüssel in der Liste der definierten Schlüssel aus, und klicken Sie auf OK.
Ausführliche Informationen zum Hinzufügen von Schlüsselreferenzen finden Sie unter Zum Verwalten von DITA-Schlüsselreferenzen Schlüsselräume verwenden.
Nachdem Sie den Schlüssel ausgewählt haben, zeigt die Liste „Element-Tags“ die im Schlüsselraum enthaltenen DITA-Topic-Typen an. Weitere Informationen finden Sie unter Schlüsselraum erstellen.
Wählen Sie ein Element-Tag aus.
Die Elemente im DITA-Topic des ausgewählten Elements, denen eine eindeutige Kennung zugewiesen ist, werden in der Liste „Elemente“ angezeigt. Wenn einem Element keine eindeutige ID zugewiesen ist, ist das Element eine eindeutige ID zuweisen möglich.
Wählen Sie ein Element zum Einfügen als Conref aus und klicken Sie auf OK.
Klicken Sie auf Einfügen.
Sie können eine Conref zu einem Bereich von Elementen erstellen. Beispiel: Angenommen, Sie haben eine Reihe von Absatzelementen (<p>
), die Sie mit Conref als Bereich referenzieren möchten. Sie können eine Conref zu allen <p>
-Elementen erstellen.
Führen Sie zum Auswählen des ersten Elements im Bereich die Schritte im Abschnitt Conref erstellen aus, klicken Sie jedoch nicht auf<Einfügen>
.
Wählen Sie in der Dropdown-Liste Conref-Endelement das letzte Element des Bereichs aus, das in die Conref eingeschlossen werden soll.
Klicken Sie auf Einfügen.
Wenn Sie ein wiederverwendbares Element aktualisieren, nachdem Sie es in einem anderen Thema referenziert haben, müssen Sie die Conrefs im Thema aktualisieren, um die Aktualisierungen sehen zu können.
Aktualisieren der Conrefs in einem Thema:
Wählen Sie
.Das Dialogfeld „DITA-Verweise Aktualisieren“ wird angezeigt.
Aktivieren Sie Alle Conrefs in Datei aktualisieren.
Alle Conrefs im aktuellen Thema werden aktualisiert.