Verwenden von Adobe FrameMaker
Klicken Sie hier, um diese Seite mit vollem Kontext anzuzeigen
Erfahren Sie, was DITA Maps sind und wie Sie in FrameMaker mit ihnen arbeiten.
Mit einer DITA Map können Sie DITA-Topics in einer hierarchischen Struktur organisieren. Sie können dann eine Ausgabe für Ihre organisierten Inhalte erstellen und dabei verschiedene Ausgabeformate verwenden.
Ausführliche Informationen zum Generieren einer DITA-Ausgabe finden Sie unter DITA-Veröffentlichung.
Sie können DITA Maps auch zum Erstellen von Schlüsselräumen verwenden, die Sie für indirekte Verweise verwenden können.
Weitere Informationen finden Sie unter Zum Verwalten von DITA-Schlüsselreferenzen Schlüsselräume verwenden.
Weitere Informationen finden Sie in den Spezifikationen zu DITA Maps.
Erfahren Sie, wie Sie in FrameMaker eine DITA Map erstellen können.
Wählen Sie .
Wählen Sie alternativ . Wechseln Sie im Dialogfeld Neue XML-Datei zur DITA-Registerkarte und wählen „Map“.
Standardmäßig wird im Ressourcenmanager eine DITA Map geöffnet.
Sie können den Ressourcenmanager für Folgendes verwenden:
Einfügen von Themen in die DITA Map
Speichern Sie die DITA Map
Wechseln Sie zur Dokumentansicht, um die DITA Map-Inhalte anzuzeigen.
Sie können die verfügbaren FrameMaker-Werkzeuge wie Strukturansicht und das Fenster Elemente zum Arbeiten mit einer Dita Map verwenden.
Sie können in eine DITA Map auch Beziehungstabellen aufnehmen.
Ausführliche Informationen finden Sie unter DITA-Beziehungstabellen.
Erfahren Sie, wie Sie topicref-Elemente in eine DITA Map einfügen können.
Sie können einer DITA Map Themen hinzufügen, indem Sie <topicref>-Elemente im Elementkatalog verwenden. <> Sie können Topics auch mithilfe von Untergeordnetes Element einfügen im Ressourcenmanager hinzufügen.
FrameMaker unterstützt die folgenden <topicref>-Elemente, die Sie in einer DITA Map hinzufügen können:
Identifiziert Themen wie <dita>, <topic>, <concept>, <task>, <reference>, <glossaryentry> und <glossarygroup>. Ein <topicref>-Element kann auch andere <topicref>-Elemente enthalten, sodass eine hierarchische Struktur erstellt wird.
Weitere Informationen finden Sie in den Spezifikationen zu <topicref>-Elementen.
Ein praktisches Element mit auf „ditamap“ festgelegtem Formatattribut, das dem <topicref>-Element entspricht.
Weitere Informationen finden Sie in den Spezifikationen zu <mapref>-Elementen.
Eine Reihe von <topicref>-Elementen, die in DITA Maps und anderen <topicset>-Elementen wiederverwendet werden können.<>
Weitere Informationen finden Sie in den Spezifikationen zu <topicset>-Elementen.
Ein zweckgebundenes Element, das zum Definieren von Schlüsseln verwendet wird, und dies ohne die anderen Effekte, die bei Verwendung eines <topicref>-Elements auftreten: Keine Inhalte werden in die Ausgabe einbezogen, kein Titel wird in das Inhaltsverzeichnis einbezogen und keine Verknüpfungs- oder andere Beziehungen werden definiert.<>
Weitere Informationen finden Sie in den Spezifikationen zu <keydef>-Elementen.
Verweist auf ein <topicset>-Element.<>
Weitere Informationen finden Sie in den Spezifikationen zu <topicsetref>-Elementen.
Führen Sie zum Einfügen eines <topicref>-Elements in eine DITA Map folgende Schritte aus:
Platzieren Sie die Einfügemarke auf der Stammebene des <map>-Elements in der Strukturansicht.
Wählen Sie .
Wenn Sie topicref, mapref, topicset oder keydef auswählen, wird das Dialogfeld Element einfügen angezeigt:
Zum Verwenden der eingefügten Topicref als Schlüsselreferenz müssen Sie einen Schlüsselnamen eingeben.
Ausführliche Informationen finden Sie unter Zum Verwalten von DITA-Schlüsselreferenzen Schlüsselräume verwenden.
Geben Sie im Feld HRef den Speicherort des zu referenzierenden Topics ein. Oder klicken Sie auf Durchsuchen, um zum Topic zu navigieren und dieses auszuwählen. Das Thema wird als direkte Referenz hinzugefügt.
Wenn Sie für das aktuelle Topic einen Schlüsselraum definiert haben, können Sie auch in der Dropdown-Liste KeyRef eine Schlüsselreferenz auswählen. Das Thema wird als indirekte Referenz hinzugefügt.
Ausführliche Informationen zu Schlüsselreferenzen und indirekten Referenzen finden Sie unter Zum Verwalten von DITA-Schlüsselreferenzen Schlüsselräume verwenden.
Erfahren Sie, wie Sie mithilfe von FrameMaker DITA-Map-Inhalte anzeigen und die Vorschau von topicref-Elementen ein- oder ausblenden können.
Nachdem Sie mindestens ein topicref-Element in eine DITA Map eingefügt haben, haben Sie die Möglichkeit, die Inhalte der referenzierten Themen in der Dokumentansicht anzuzeigen.
Sie können die referenzierten DITA-Topics auch als einzelne Dokumente in FrameMaker öffnen.
Um die Inhalte zu einem einzelnen Referenzelement in einer Vorschau anzuzeigen, wählen Sie in der Strukturansicht das <topicref>-Element aus.
Um die Inhalte aller Referenzelemente anzuzeigen, klicken Sie auf eine beliebige Stelle im Thema, stellen Sie dabei jedoch sicher, dass kein Element ausgewählt ist. Sie werden aufgefordert, Inhalte aller Topicrefs anzuzeigen. Sie können außerdem referenzierte Karten des untergeordneten Elements anzeigen.
Für eine Vorschau des Inhalts wählen Sie .
Um die Vorschau auszublenden, wählen Sie .
Wenn eine DITA Map Verweise auf untergeordnete Karten enthält, blenden Die Optionen „Einblenden“ und „Ausblenden“ in DITA Map die Themen ein oder aus, die in den Karten des untergeordneten Elements referenziert werden.
In der Dokumentansicht zeigt FrameMaker > an. Dies dient als Hinweis darauf, dass ein Thema in der DITA Map ein Thema der höchsten Ebene ist. >> gibt ein Thema der zweiten Ebene an und >>> gibt an, dass es sich um ein Thema der Ebene 3 (und darüberhinaus) in der DITA-Map handelt.
Wenn eine DITA Map Referenzen zu mindestens einem Thema enthält, können Sie alle referenzierten Themen in FrameMaker öffnen.
Vergewissern Sie sich, dass DITA Map ausgewählt ist.
Drücken Sie die Umschalttaste und wählen Sie .
Wählen Sie alternativ in der DITA Map .
Um alle Topic-Referenzen zu schließen, drücken Sie die Umschalttaste und wählen Sie .
Erfahren Sie, wie Sie eine DITA Map in FrameMaker speichern.
Mithilfe der Funktionalität DITA Map speichern unter in FrameMaker () können Sie die DITA Map in verschiedenen Ausgaben speichern. Wenn Sie eine DITA Map als Buch speichern, können Sie die hierarchischen Funktionen des FrameMaker-Buchs nutzen, wie etwa Ordner und Gruppen. Sie können die FrameMaker-Buchfunktionen nutzen, wie etwa Seitennummerierung und Inhaltsverzeichnis.
In der folgenden Liste von Ausgaben werden spezifische Funktionen bereitgestellt:
Eine einzelne, eigenständige FrameMaker-Dokumentdatei (.fm). Das Dokument enthält alle Inhalte aus der DITA Map. Beispielsweise die Topic-Referenzen. Die Topic-Referenzen sind im Dokument eingebettet. Dies bedeutet, dass Änderungen an den Themendateien nicht im zusammengesetzten Dokument übernommen werden. Wenn Sie dieses Dokument für einen anderen Autor freigeben, benötigt dieser Autor die referenzierten Themendokumente nicht. Sie können jedoch an Ihrem zusammengesetzten Dokument weiterarbeiten und dabei die Strukturierungswerkzeuge in FrameMaker verwenden.
Die DITA Map wird als eine .book-Datei gespeichert, die jede referenzierte Themendatei als Dokument innerhalb des Buchs enthält.
Die DITA Map wird als .book-Datei gespeichert. Jede referenzierte Topic-Datei wird in eine .fm-Datei konvertiert.
Wenn Sie eine DITA Map als zusammengesetztes Dokument oder Buch mit FrameMaker-Komponenten speichern, können Sie die DITAVAL-Funktion für die bedingte Ausgabe verwenden. Wenn Sie im Dialogfeld Dokument speichern die Option Aufforderung für DitaVal-Datei aktivieren, werden Sie zur Angabe einer DITAVAL-Datei aufgefordert, die Sie für die bedingte Ausgabe der Inhalte in die ausgewählten Ausgabeformate verwenden können. Ausführliche Informationen zu DITAVAL finden Sie unter DITAVAL.
Lernen Sie die DITA-Referenzierung in FrameMaker kennen und erfahren Sie, wie Sie Referenzinhalte einrichten und DITA-Referenzen aktualisieren.
DITA-Referenzen (auch bekannt als DITA-Adressen) bietet die Möglichkeit, Referenzen oder Verknüpfungen zwischen DITA-Elementen und zwischen DITA-Elementen und Nicht-DITA-Ressourcen herzustellen.
Sie verweisen mithilfe von DITA-Inhaltsreferenzen auf DITA-Inhalte. Sie erstellen Verknüpfungen zu DITA- oder Nicht-DITA-Ressourcen, indem Sie DITA-Querverweise zu einzelnen Quellinhalten verwenden. Sie können DITA-Verknüpfungen auch zumVerknüpfungen zu verwandten Inhalten hinzufügen verwenden.
Die DITA-Spezifikationen definieren zwei Typen von Referenzen:
Referenzen werden durch einen direkten Verweis auf das Ziel erstellt. Wenn Sie in FrameMaker beispielsweise eine Conref mithilfe einer direkten Referenzierung erstellen, navigieren Sie zu einem DITA-Topic (.xml-Datei) und wählen es aus. Auf ähnliche Weise können Sie direkt auf das DITA-Topic (.xml-Datei) verweisen, um eine DITA-Verknüpfung oder einen DITA-Querverweis zu erstellen. Direkte Referenzen erfordern, dass Autoren die Datei, die den zu referenzierenden oder verknüpfenden Inhalt enthält, explizit auswählen. Dies kann mühsam und verwirrend sein, wenn Sie einen umfangreichen Satz von verwandten Inhalten haben. Direkte Referenzen sollten bevorzugt werden, wenn Sie keinen großen Satz an zu referenzierenden oder verknüpfenden Dokumenten haben.
Weitere Informationen finden Sie in den Spezifikationen zu URI-basierte (direkte) Adresse.
Referenzen werden global auf der DITA Map-Ebene mithilfe von Schlüsseln erstellt. Beispiel: Wenn Sie in FrameMaker eine Conref mithilfe einer indirekten Referenz erstellen, verweisen Sie nicht direkt auf das DITA-Topic. Stattdessen verweisen Sie auf einen Schlüssel, der durch Zum Verwalten von DITA-Schlüsselreferenzen Schlüsselräume verwenden definiert wird. Indirekte Referenzen erfordern, dass Autoren beim Erstellen von Referenzen oder Verknüpfungen benutzerdefinierte Schlüssel auswählen. Beim Einrichten der Schlüsselräume sollte zum Benennen von Schlüsseln eine gut definierte Nomenklatur verwendet werden. Indirekte Referenzen werden empfohlen, wenn Sie einen umfangreichen Satz an verwandten Inhalten erstellen.
Weitere Informationen finden Sie in den Spezifikationen zu Schlüsselbasierte Adresse.
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. Ausführliche Informationen finden Sie unter Zum Verwalten von DITA-Schlüsselreferenzen Schlüsselräume verwenden.
Um ein Element wiederverwendbar zu machen, müssen Sie dem Element eine eindeutige Kennung zuweisen. Ausführliche Informationen finden Sie unter Attribut „DITA-ID“. FrameMaker verwendet diese eindeutige Kennung zum Differenzieren von <conref>-Elementen. Beispiel: Wenn Sie das Quellelement aktualisieren, verwendet FrameMaker die eindeutige Kennung, um die Elemente in den zu aktualisierenden Container-Themen zu identifizieren.
Das Attribut „DITA-ID“ bietet eine Methode zum eindeutigen Identifizieren von zu referenzierenden Inhalten (Themen oder Elemente).
In einem DITA-Topic können Sie einem Element eine eindeutige ID zuweisen, um das Element zu verwenden, wenn Sie von einem anderen Thema aus Conrefs (DITA-Inhaltsreferenzen) oder Querverweise (Querverweise) zu diesem Element erstellen. Standardmäßig weist FrameMaker dem Thema beim Erstellen eines DITA-Topics eine eindeutige ID zu.
Weitere Informationen finden Sie in den Spezifikationen zu ID-Attribut.
Wählen Sie in der Strukturansicht ein Element im Quell-Topic aus.
Wählen Sie .
Alternativ dazu klicken Sie mit der rechten Maustaste auf das Element und wählen im Popup-Menü den Eintrag ID zu Element zuweisen.
Um zu prüfen, ob einem Element eine ID zugewiesen ist, klicken Sie in der Strukturansicht auf das Pfeilsymbol rechts neben dem Element.
Wenn Sie einem Element, dem zuvor bereits eine ID zugewiesen wurde, eine eindeutige ID zuweisen, werden Sie dazu aufgefordert, die vorhandene ID zu ersetzen.
Wählen Sie eine Instanz des Elements aus, für das Sie IDs zuweisen möchten.
Wählen Sie , um das Dialogfeld ID zuweisen zu öffnen.
Standardmäßig ist in der Dropdown-Liste das Element aktiviert, das vor der Auswahl von ID für Elemente zuweisen ausgewählt war.
Wählen Sie Spezialisierungen einschließen, um den Spezialisierungen des ausgewählten Elements IDs zuzuweisen. In einer DITA Map wählen Sie Topicrefs in DITA Map verarbeiten aus, um allen Instanzen ausgewählter Elemente in den Themen der DITA Map IDs zuzuweisen.
Sind mehrere Dateien geöffnet, wählen Sie Alle geöffneten Dateien, um allen Instanzen des ausgewählten Elements in allen geöffneten Dateien IDs zuzuweisen.
Klicken Sie auf Zuweisen.
In einem DITA-Topic können Sie Inhalte direkt referenzieren, indem Sie die DITA-Topic-Datei (.xml) angeben. Beispiel: Um im Abschnitt „Verknüpfungen zu verwandten Themen“ Verknüpfungen hinzuzufügen, können Sie von einem DITA-Topic die zu referenzierenden Themendateien wählen (siehe Verknüpfungen zu verwandten Inhalten hinzufügen).
DITA stellt jedoch auch die Spezifikationen zur Verwendung von Schlüsseln zum indirekten Referenzieren von Inhalten bereit. Weitere Informationen finden Sie in den Spezifikationen zu Schlüsselbasierte Adresse.
Durch die Verwendung von Schlüsseln wird die Referenzierung der Inhalte indirekter. Beim Arbeiten mit Schlüsseln referenziert der Autor die Themendateien nicht direkt. Dem Autor wird ein Schlüsselraum bereitgestellt, eine Sammlung von zu referenzierenden benutzerdefinierten Schlüsseln. Der Schlüsselraum referenziert intern eine beliebige Anzahl von Themen. Für den Autor sind demnach nur die Schlüssel in den bereitgestellten Schlüsselräumen von Interesse. Da Schlüssel außerdem benutzerdefiniert sind, können sie mit einem geeigneten Namen versehen werden, sodass der Autor sie leicht wiedererkennen kann.
Die http://docs.oasis-open.org/dita/v1.2/os/spec/langref/keydef.htmlkeydef-Elemente werden zum Erstellen von Keymaps verwendet, da diese Elemente standardmäßig nicht in der DITA-Ausgabe generiert werden.
Ein Schlüsselraum wird unter Verwendung einer DITA Map erstellt. Um eine DITA Map zur Verwendung als Schlüsselraum zu erstellen, müssen Sie der DITA Map <keydef>-Elemente hinzufügen.
Fügen Sie der DITA Map <keydef>-Elemente hinzu. <> Ausführliche Informationen finden Sie unter topicref-Elemente in eine DITA Map einfügen.
Das Attribut „Schlüssel“ wird zur Identifizierung eines spezifischen <keydef>-Elements in einem Schlüsselraum verwendet. Da das Attribut @Schlüssel für ein <keydef>-Element obligatorisch ist, können Sie den Attributwert im Dialogfeld Attribute für neue Elemente oder im Feld Schlüsselname des Dialogfelds Element einfügen festlegen.
Ein Autor, der den Schlüsselraum verwendet, verweist dann nur auf die Schlüsselnamen und nicht direkt auf die damit verknüpften DITA-Topics. Aus diesem Grund sollten Sie Schlüsselwerte angeben, die klare Hinweise auf die referenzierenden (zugrundeliegenden) Themeninhalte geben.
Speichern Sie die DITA Map.
Um eine Schlüsselreferenz in Ihrem DITA-Topic verwenden zu können, müssen Sie die Container-Schlüsselräume in die FrameMaker-Authoring-Umgebung laden.
Öffnen Sie das Dialogfeld „DITA-Schlüsselraummanager“ ().
Wählen Sie in der Dropdownliste Schlüsselraum eine DITA Map aus, die als Schlüsselraum definiert ist. Ausführliche Informationen finden Sie unter Schlüsselraum erstellen.
Standardmäßig wird immer der erste Schlüssel in der Liste ausgewählt. DITA Maps, die in der aktuellen Sitzung geöffnet sind, werden in der Dropdown-Liste Schlüsselräume angezeigt. Sie können nach einem Schlüsselraum suchen, indem Sie die ersten Zeichen des Schlüssels eingeben.
Wenn die erforderliche DITA Map in der Liste nicht verfügbar ist, klicken Sie auf Schlüsselraum laden und wählen Sie die DITA-Map-Datei aus. Die im Schlüsselraum definierten Schlüsselreferenzen werden in der Liste „Definierte Schlüssel“ angezeigt.
Wenn Sie nach dem Laden des Schlüsselraums in die aktuelle Umgebung Änderungen am Schlüsselraum (DITA Map) vornehmen, klicken Sie auf Aktualisieren, um die Änderungen an den Schlüsselreferenzen anzuzeigen.
Klicken Sie auf OK, um den ausgewählten Schlüsselraum auf alle geöffneten DITA Maps anzuwenden.
Um einen anderen Schlüsselraum für ein bestimmtes Dokument auszuwählen, verwenden Sie den festgelegten Schlüsselraummanager. Zum Festlegen des Schlüsselraums können Sie eine Reihe verschiedener Pfade verwenden, z. B. DITA-Querverweise, DITA-Verknüpfungen, und eingefügte Conrefs.
Sie können mithilfe einer der folgenden Methoden Referenzen in DITA-Topics oder DITA Maps erstellen:
Conrefs (siehe DITA-Inhaltsreferenzen)
Querverweise (sieheQuerverweise)
Topicrefs (siehe topicref-Elemente in eine DITA Map einfügen)
Wenn Sie den referenzierten Inhalt aktualisieren, werden die Referenzen im aktuellen Thema nicht sofort aktualisiert. Beispiel: Wenn eine DITA Map ein bestimmtes Thema referenziert und der Titel des Themas geändert wird, wird der aktualisierte Titel nicht sofort in der DITA Map angezeigt.
Verwenden Sie zum Aktualisieren von Referenzen in einem ausgewählten Thema oder einer ausgewählten Map das Dialogfeld „DITA-Verweise aktualisieren“:
Wählen Sie .
Das Dialogfeld „DITA-Verweise Aktualisieren“ wird angezeigt:
Prüfen Sie zum Aktualisieren der Referenzen im aktuellen Topic oder der aktuellen Map die spezifischen Optionen und klicken Sie auf OK.
Sie können ein Dokument durchsuchen oder mehrere Dateien in einem Ordner rekursiv nach Verknüpfungen wie conref, topicref, link oder xref durchsuchen. Im Dialogfeld Referenzen suchen wird standardmäßig die ID des aktuellen Topics und Elements angezeigt, sofern ausgewählt. In der Regel wählen Sie das Element, das an einer anderen Stelle referenziert wird, und rufen dann diese Option auf.
Wählen Sie . Um die Referenzen des aktuellen Elements zu finden, klicken Sie mit der rechten Maustaste auf das Element und wählen Referenzen suchen. Die Element-ID wird automatisch eingefügt.
Geben Sie bei Bedarf im Dialogfeld Referenzen suchen die ID des Elements ein.
Optional können Sie den Schlüsselram für das aktuelle Dokument auswählen, um die Suche auf einen Schlüsselraum einzugrenzen.
Legen Sie den Suchbereich fest. Wenn Sie einen Ordner auswählen, können Sie rekursiv nach Referenzen zu dem Element in allen Dateien des Ordners suchen.
Klicken Sie auf Suchen.