StartseiteDITA-Topics

DITA-Topics

Lernen Sie die DITA-Topics in FrameMaker kennen.

DITA verwendet einen themenbasierten Ansatz für das Authoring. Ein Topic in DITA ist die kleinste Infomationseinheit. Gemäß den DITA-Spezifikationen sollte ein Topic kurz genug sein, damit es einfach lesbar ist, und zugleich lange genug, damit es selbst sinntragend ist.

Zur Abdeckung getrennter Inhalte wie etwa Konzepte, Aufgaben und Referenz legt der DITA-Standard unterschiedliche Informationstypen fest. Jeder Informationstyp definiert strukturierte Elemente, die zur Unterstützung bei der Erstellung des jeweiligen Inhalts vorgesehen sind. Beispielsweise definiert der Aufgabentyp Elemente wie <context>, <example>, <steps> und <result>.

Erstellen eines DITA-Topics

Erfahren Sie, wie Sie ein DITA-Topic in FrameMaker erstellen und verwalten.

  1. Wechseln Sie im Menü „Datei“ zu Neu > DITA.

    Das Untermenü „DITA“ zeigt die Typen von DITA-Topics und DITA-Maps an, die Sie erstellen können.

    FrameMaker unterstützt die folgenden Typen von DITA-Topics:

    topic

    Verwenden Sie für spezifische Inhalte die Typen „task“, „concept“, „reference“, „glossentry“ und „glossgroup“.

    Weitere Informationen finden Sie in den Spezifikationen zu DITA-Topics.

    task

    Für aufgabenbezogene Inhalte, wie etwa Anleitungen oder Prozeduren.

    Weitere Informationen finden Sie in den Spezifikationen zu Task-Topics.

    concept

    Für Inhalte des Typs „Was ist...?“. Dieser Typ deckt Konzepte in Zusammenhang mit einer Funktion ab.

    Weitere Informationen finden Sie in den Spezifikationen zu Konzept-Topics.

    reference

    Für Referenzinhalte. Beispiel: Produktspezifikationen, API-Referenz und Geräte- oder Stücklisten.

    Weitere Informationen finden Sie in den Spezifikationen zu Referenz-Topics.

    glossentry

    Für einen einzelnen Glossarbegriff und die zugehörige Definition.

    Weitere Informationen finden Sie in den Spezifikationen zu Glossareintrags-Topics.

    glossgroup

    Für eine Gruppe von <glossentry>-Elementen.

    <glossgroup> kann auch andere <glossgroup>-Elemente enthalten, sodass eine hierarchische Glossarstruktur erstellt werden kann.

    Weitere Informationen finden Sie in den Spezifikationen zu Glossargruppen-Topics.

    ditabase

    Ein Container-Element auf oberster Ebene, das die nachstehend beschriebenen Thementypen umfassen kann.

    Weitere Informationen finden Sie in den Spezifikationen zu DITA-Container.

  2. Wählen Sie einen Thementyp aus.

  3. Wählen Sie zum Anzeigen der hierarchischen Struktur des erstellten Topics die Option Struktur > Strukturansicht.

  4. Ein DITA-Topic ist ein strukturiertes Dokument. Dies bedeutet, dass Sie in FrameMaker in derselben Weise mit der DITA-Topic-Struktur arbeiten, wie Sie mit den strukturierten Dokumenten in anderen strukturierten Anwendungen arbeiten.

    Ausführliche Informationen zum Erstellen von Inhalten in einem strukturierten Thema finden Sie unter frm_structauth_sa.html#WS053b9687b4c35b124e2fd7a146eb68148c-8000.

Verknüpfungen zu verwandten Inhalten hinzufügen

Erfahren Sie, wie Sie über das Dialogfeld „DITA-Verknüpfung“ in FrameMaker Verknüpfungen zu verwandten Inhalten hinzufügen können.

Dialogfeld „DITA-Verknüpfung“

Verwenden Sie das Dialogfeld DITA-Verknüpfung, um direkte und indirekte Verknüpfungen zu DITA-Inhalten einzufügen.

Dialogfeld „DITA-Verknüpfung“
Verwenden des Dialogfelds „DITA-Verknüpfung“ zum Einfügen von direkten und indirekten Verknüpfungen zu DITA-Inhalten

Verwenden Sie das Dialogfeld „DITA-Verknüpfung“ für Folgendes:

A (DITA-Element):

Wählen Sie das zu verwendende Verknüpfungselement.

Standardmäßig lautet das Element <link>.

Weitere Informationen finden Sie in den Spezifikationen zu link.

B (Ziel > Datei):

Aktivieren Sie diese Option, um eine Verknüpfung mithilfe von direkten Referenzen zu erstellen.

Siehe DITA-Verknüpfung erstellen.

C (Ziel > Schlüssel):

Aktivieren Sie diese Option, um eine Verknüpfung mithilfe von indirekten Referenzen zu erstellen, und wählen Sie in der Dropdown-Liste Schlüsseleinstellungen einen Schlüssel.

Siehe DITA-Verknüpfung erstellen.

D (Ziel > Beide):

Aktivieren Sie diese Option, um eine Verknüpfung mithilfe von direkten oder indirekten Referenzen zu erstellen.

E (Datei-/Schlüsseleinstellungen):

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. In diesem Dialogfeld finden Sie die Optionen zum Schlüsselraum erstellen und zum Festlegen des Standardschlüsselraums für das aktuelle Thema.

F (Filter-Text):

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.

G (Anzeige mit):

Hier können Sie das Element wählen, das die wörtliche Bezeichnung oder die wörtliche Textzeile für eine Verknüpfung bereitstellt.

Standardmäßig lautet das Element <linktext>.

Weitere Informationen finden Sie in den Spezifikationen zu linktext.

H (Anzeigen mit):

Hier können Sie das Element wählen, das die wörtliche Bezeichnung oder die wörtliche Textzeile für eine Verknüpfung bereitstellt.

Standardmäßig lautet das Element <linktext>.

Weitere Informationen finden Sie in den Spezifikationen zu linktext.

H (Text)

Hier können Sie den anzuzeigenden Verknüpfungstext als wörtlichen Text angeben.

I (Format)

Wählen Sie Format und in der Dropdown-Liste eine Verknüpfungsformat:

DITA-Standardformat

Zeigt den Titel des Referenz-Topic an.

See_Title_and_Page

Zeigt Weitere Informationen finden Sie unter <Thementitel> auf <Seitenzahl> an.

Title_and_Page

Zeigt <Thementitel> auf <Seite> an.

J (externe Verknüpfung)

Fügt eine Verknüpfung zu einer externen Ressource (nicht DITA) ein. Geben Sie im Dialogfeld Externe DITA-Verknüpfung die Quelle für die externe Verknüpfung an – Verweisen Sie auf das Feld „Schlüssel“ oder „Verknüpfungsziel (href)“.

Optional können Sie einen Verknüpfungstext angeben. Andernfalls wird die im Feld „Verknüpfungsziel (href)“ eingegebene Verknüpfung als Verknüpfungstext verwendet. Sie können eine externe Verknüpfung auch über das Hauptmenü Einfügen > Externe Referenz oder das Kontextmenü einfügen.

DITA-Verknüpfung erstellen

  1. Wenn Sie in das <related-links>-Element die erste Verknüpfung einfügen, platzieren Sie die Einfügemarke rechts des <related-links>-Elements.

    Einfügemarke rechts des <related-links>-Elements platzieren
    Platzieren der Einfügemarke rechts neben dem related-links-Element

  2. Fügen Sie aus dem Fenster „Elemente“ (Ansicht > Fenster > Elementkatalog) das Element <link> ein.

    Das Dialogfeld „DITA-Verknüpfung“ wird angezeigt.

  3. Wählen Sie das zu verwendende DITA-Verknüpfungselement.

  4. Wählen Sie ein Verknüpfungsziel.

    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.

    Wählen Sie zum Erstellen einer direkten Verknüpfung das DITA-Topic (.xml-Datei), zu dem Sie die Verknüpfung erstellen möchten:

    1. Aktivieren Sie die Option Datei für das Ziel und wählen Sie die Datei, die das Referenz-Topic enthält.

      Sie können ein Referenz-Topic aus dem aktuellen Thema oder einem beliebigen derzeit geöffneten Thema auswählen oder mithilfe der Schaltfläche „Durchsuchen“ ein nicht geöffnetes Thema auswählen.

    2. Wählen Sie in der Liste „Element“ das zu referenzierende Thema aus.

    Zum Hinzufügen einer indirekten Verknüpfung müssen Sie DITA-Schlüsselreferenzen verwenden. Weitere Informationen zu Schlüsselreferenzen finden Sie unter Zum Verwalten von DITA-Schlüsselreferenzen Schlüsselräume verwenden.

    1. Wählen Sie die Option Schlüssel für das Ziel und klicken Sie auf Schlüsselraummanager.

    2. Wählen Sie im Dialogfeld DITA-Schlüsselraummanager den Schlüssel in der Liste der definierten Schlüssel aus, und klicken Sie aufOK.

  5. Wählen Sie in der Dropdown-Liste Anzeigen mit das im Verknüpfungstext anzuzeigende Element.

  6. Geben Sie den Text bzw. das anzuzeigende Format an, der in der Verknüpfung angezeigt werden soll.

  7. Klicken Sie auf Einfügen.