StartseiteDITA-Beziehungstabellen

DITA-Beziehungstabellen

Lernen Sie die Konzepte verwandter Themen in einem strukturierten Dokument kennen und erfahren Sie, wie eine Beziehungstabelle verwendet wird, um Links für die verwandten Themen in FrameMaker zu erstellen.

In einem Satz von DITA-Topics gibt es oft Themen, die miteinander verwandt sind. In diesem Fall ist es möglicherweise empfehlenswert, einen Satz von Verknüpfungen zu verwandten Themen (siehe auch) einzufügen. Dadurch erhalten Ihre Leser Informationen zu weiteren Referenzen, falls erforderlich.

Beispiel: Sie behandeln die Optionen zum Speichern unter in FrameMaker als separate Themen:

In diesem Fall ist es möglicherweise empfehlenswert, am Ende jedes dieser Themen Verknüpfungen zu verwandten Themen zu den anderen drei Themen einzufügen.

DITA Maps verwenden

Mit Beziehungstabellen in FrameMaker können Sie Verknüpfungen zu verwandten Themen in DITA-Topics erstellen. Sie verwenden Beziehungstabellen in DITA Maps. Dies bedeutet, dass Sie eine DITA Map erstellen und dann die Themen in Ihrem Themensatz in die DITA Map aufnehmen müssen. Dann fügen Sie der Map die Beziehungstabellen hinzu. In den Beziehungstabellen definieren Sie die in der DITA Map enthaltenen verwandten Themen.

Hinzuzufügende DITA-Typen

Sie können einer Beziehungstabelle folgende DITA-Topic-Typen hinzufügen:

  • Thema

  • Aufgabe

  • Konzept

  • Referenz

Verwandte Themen zu einer Zeile einer Beziehungstabelle hinzufügen

Um anzugeben, dass zwei oder mehr Themen in einer DITA Map verwandt sind, müssen Sie diese einer einzelnen Zeile in einer Beziehungstabelle hinzufügen. Informationen zu den Schritten zum Erstellen einer Beziehungstabelle finden Sie unter Erstellen einer Beziehungstabelle.

Um beispielsweise festzulegen, dass die Themen „Speichern unter“, „Speichern als PDF“, „Als Review-PDF speichern“ und „Als XML speichern“ verwandte Themen sind, gehen Sie wie folgt vor:

Beziehungstabelle in der Dokumentansicht

Hinweis: Eine Beziehungstabelle in FrameMaker wird bei Anzeige in der Dokumentansicht gleich dargestellt wie eine FrameMaker-Tabelle, die Sie als Teil Ihrer Inhalte einschließen.

Sie können einer Beziehungstabelle eine beliebige Anzahl von Zeilen hinzufügen. FrameMaker behandelt alle Themen in einer Zeile als verwandte Themen.

Sie können einer DITA Map eine beliebige Anzahl von Beziehungstabellen hinzufügen. Dies kann beispielsweise dem Gruppieren von Sätzen verwandter Themen dienen.

Reihenfolge verwandter Themen in einer Zeile einer Beziehungstabelle festlegen

Die Reihenfolge verwandter Themen in einer Tabellenzeile definiert die Reihenfolge, in der die Themen im Abschnitt „Verknüpfungen zu verwandten Themen“ der DITA Map-Ausgabe angezeigt werden.

Im folgenden Beispiel wird der Abschnitt Verknüpfungen zu verwandten Themen des Themas „Als PDF speichern“ wie folgt angezeigt:

  • Speichern unter

  • Als Review-PDF speichern

  • Als XML speichern

Beziehungstabelle in der Dokumentansicht
Beziehungstabelle in der Dokumentansicht von FrameMaker

Dies bedeutet, dass die Reihenfolge im Abschnitt „Verknüpfungen zu verwandten Themen“ anders angezeigt wird, wenn Sie die Reihenfolge der Themen in der Tabelle ändern.

Erstellen einer Beziehungstabelle

Erfahren Sie, wie Sie in FrameMaker eine Beziehungstabelle erstellen, und sehen Sie sich einen Beispiel-Workflow für eine Beziehungstabelle an.

  1. Platzieren Sie in der Strukturansicht einer DITA Map die Einfügemarke am Ende des Topics und auf derselben Ebene wie die Topicref-Elemente.

  2. Drücken Sie zum Anzeigen des Smart-Katalogs die Kombination Strg+1, und wählen Sie „reltable“.

    Das Dialogfeld Tabelle einfügen wird angezeigt.

  3. Geben Sie die Anzahl der Spalten und Zeilen an.

    Die Anzahl der Spalten hängt von der Anzahl der verwandten Themen ab, die gruppiert werden sollen.

    Die Anzahl der Zeilen hängt von der Anzahl der Gruppen verwandter Themen ab, die erstellt werden sollen.

    Hinweis: Sie können auch mehrere Beziehungstabellen für mehrere Gruppen verwandter Themen erstellen.
  4. Klicken Sie auf Einfügen.

    Der DITA Map wird eine Beziehungstabelle hinzugefügt.

  5. Um die Beziehungstabelle in einer Tabellenansicht anzuzeigen, wechseln Sie zur Dokumentansicht.

    Obwohl Sie in der Strukturansicht einer Beziehungstabelle Topics hinzufügen können, bietet die Tabellenansicht eine praktischere Art und Weise, mit der Beziehungstabelle zu arbeiten.

    Standardbeziehungstabelle (mit 4 Spalten und 1 Standardzeile)
    Standardbeziehungstabelle (mit 4 Spalten und 1 Standardzeile) in FrameMaker

    Sie geben in jeder Zelle des Beziehungstabellenkopfs den DITA-Topic-Typ der verwandten Themen an, die in die Standardzellen der Spalte aufgenommen werden sollen.

    Mit FrameMaker können Sie einer Beziehungstabelle folgende DITA-Topic-Typen hinzufügen:

    • Thema

    • Aufgabe

    • Konzept

    • Referenz

    Hinweis: Standardmäßig unterstützt FrameMaker den Topic-Typ. Wenn Sie also vorhaben, nur Thementypen in der Tabelle aufzunehmen, brauchen Sie das Attribut „type“ nicht festzulegen.
  6. Hinzufügen eines bestimmten DITA-Topic-Typs zu einer Spalte in der Tabelle:

    1. Platzieren Sie die Einfügemarke in der Tabellenkopfzelle.

    2. Öffnen Sie das Dialogfeld Attribute (Elemente > Attribute bearbeiten).

    3. Legen Sie das Attribut @Typ auf den DITA-Topic-Typ fest:

      Topic-Typ – Attributwert: Topic

      Aufgabentyp – Attributwert: Aufgabe

      Konzepttyp – Attributwert: Konzept

      Referenztyp – Attributwert: Referenz

      Important: Bei den Attributwerten muss wird Groß- und Kleinschreibung unterschieden.

      Wenn Sie den Attributtyp wie oben beschrieben festlegen, wird der Spaltentitel aktualisiert:

      Aktualisierte Typattribute

  7. In jeder Zelle einer Reihe in der Beziehungstabelle fügen Sie eine Topic-Referenz der verwandten Themen hinzu. Dies bedeutet, dass ein Satz verwandter Themen in die Zellen einer Reihe der Tabelle aufgenommen werden muss.

    Hinzufügen von Topic-Referenzen verwandter Themen in den Standardzellen der Tabelle

    1. Platzieren Sie im Katalog Elemente (Element > Elementkatalog) die Einfügemarke in eine Zelle einer Spalte, und doppelklicken Sie das Topicref-Element, um es der Zelle hinzuzufügen.

      Das Dialogfeld „Element einfügen“ wird angezeigt.

      Sie können zum Einfügen des <topicref>-Elements auf den Smart-Katalog verwenden.

      Drücken Sie Strg+1, um den Smart-Katalog anzuzeigen. Wählen Sie das <topicref>-Element aus und fügen Sie es hinzu.

    2. Geben Sie im Feld HRef den Pfad zu einer Topic-Datei ein und klicken Sie auf OK.

      Alternativ dazu können Sie über die Schaltfläche Durchsuchen zum Topic navigieren und es auswählen.

      Die Topic-Referenz wird der Tabellenzeile hinzugefügt.

      Tip: Wenn Sie eine Topic-Referenz einer Tabellenzelle nicht hinzufügen können, prüfen Sie den im Spaltenkopf angegebenen Thementyp.
    3. Fügen Sie jeder Zelle der Tabellenzeile eine Topic-Referenz (zu einem verwandten Thema) hinzu.

Wenn die Tabelle mehrere Zeilen enthielt, können Sie jeder Zeile mehrere Gruppen von verwandten Themen (Referenzen) hinzufügen.

Beispiel-Workflow für Beziehungstabellen

Um die Ausgabe nach dem Erstellen einer Beziehungstabelle in einer DITA Map zu testen, können Sie die Option „Als PDF speichern“ FrameMaker verwenden.

  1. Vergewissern Sie sich, dass die DITA Map ausgewählt ist.

  2. Wählen Sie Datei > Als PDF speichern.

  3. Klicken Sie im Dialogfeld „PDF-Einstellungen“ auf Festlegen.

Die PDF-Ausgabe der DITA Map zeigt die Abschnitte Zugehörige Verknüpfungen für die Topics, die Sie in die Zellen der Beziehungstabellen in der DITA Map aufnehmen

Important: Die Funktion „Als PDF speichern“ wird in diesem Abschnitt beispielhaft verwendet. Sie können die DITA Map in den Ausgabeformaten veröffentlichen, die in der Multikanal-Publishing-Funktion von FrameMaker verfügbar sind.

Die Themen werden in derselben Reihenfolge veröffentlicht, wie Sie diese in den Zellen der Tabellenzeile festgelegt haben.

Außerdem enthalten die angezeigten verwandten Themen das aktuelle Thema nicht. Im nachstehenden Beispiel einer Beziehungstabelle...

Beziehungstabelle in der Dokumentansicht
Beziehungstabelle in der Dokumentansicht in FrameMaker

... wird im Abschnitt „Verknüpfungen zu verwandten Themen“ des Themas „Speichern unter“ Folgendes angezeigt:

  • Als PDF speichern

  • Als Review-PDF speichern

  • Als XML speichern

Das (aktuelle) Thema Speichern unter wird nicht angezeigt.