Erfahren Sie, wie Sie mit strukturierten Anwendungen beginnen, und lernen Sie die Bedeutung von Formatierungen in strukturierten Anwendungen kennen.
Im unstrukturierten FrameMaker-Format benötigen Sie zur Einrichtung einer Authoring-Umgebung nur eine Vorlagendatei. Die Vorlagendatei bestimmt die Formate und Stile und eine Stilfibel definiert die ordnungsgemäße Verwendung der Vorlage. Im strukturierten FrameMaker-Format benötigen Sie mehr als nur eine strukturierte Vorlage.
Um eine grundlegende strukturierte Authoring-Umgebung in FrameMaker einzurichten, benötigen Sie ein EDD oder eine DTD. Sie können benutzerdefinierte EDDs und DTDs erstellen oder die standardmäßigen EDDs und DTDs verwenden. Zusätzlich müssen Sie die Elementdefinitionen mit den Formatierungsinformationen verknüpfen. Für das Verknüpfen von Elementen mit der Formatierung im EDD haben Sie drei Möglichkeiten:
Sie können die Formatierung anhand der verschiedenen Tags (Absatzstile, Zeichenstile usw.) in einer Vorlage zuweisen. Wenn Sie bereits über eine Formatierungsvorlage verfügen, können Sie die darin enthaltenen Informationen wiederverwenden.
Sie können im EDD benannte Formatdefinitionen erstellen. Mit den Formatänderungslisten können Sie einen Teil der Formatangaben festlegen und den Rest aus einigen grundlegenden Absatzstilen übernehmen. Sie können die Formatänderungslisten für zugehörige Elemente wiederverwenden.
Sie können Formatierungen festlegen, indem Sie diese in die Definition der einzelnen Elemente eintragen.
Wenn Sie das EDD und die Formatierung erstellt haben, kombinieren Sie die beiden Komponenten zu einer einzelnen, strukturierten Vorlage. Um die strukturierte Vorlage zu erstellen, öffnen Sie die Formatierungsvorlage, und importieren Sie die Elementdefinitionen () aus dem EDD. Die resultierende Datei ist Ihre strukturierte Vorlage.
Außer dem EDD und der strukturierten Vorlage benötigen Sie Folgendes:
Die Lese-/Schreibregeln bestimmen die Umsetzung der FrameMaker-Struktur zu XML und umgekehrt. Sie sind insbesondere bei der Verwaltung der Tabellenumsetzung und anderer komplexer Formatierungen nützlich.
Die strukturierte Anwendung listet alle Komponentendateien in Ihrer Strukturimplementierung auf und stellt Konfigurierungsdaten bereit. Mit der strukturierten Anwendung können Sie zum Beispiel festlegen, ob und wie Tags für bedingten Text exportiert werden.
Für alle strukturierten Anwendungen in FrameMaker ist eine strukturierte Vorlage erforderlich. Strukturierte FrameMaker-Vorlagen enthalten Definitionen aller Elemente, die sich im Dokument sowie im Seitenlayout und der Formatierung des Dokuments verwenden lassen.
Strukturierte Vorlagen sind wie unstrukturierte Vorlagen, der wichtigste Unterschied ist jedoch der Katalog Elemente.
Der Katalog Elemente zeigt die im EDD definierten Elementdefinitionen an. Zum Erstellen eines strukturierten Dokuments müssen Sie zuerst die Definitionen von entweder einem EDD oder einer DTD importieren. Die Elementdefinitionen in einem EDD oder einer DTD werden im Katalog Elemente ausgefüllt. Sie verwenden den Katalog Elemente zum Einfügen gültiger Werte in Ihrem Dokument, und zum Erstellen einer Struktur, die den Regeln im EDD entspricht.
Der Begriff Inhaltsanalyse beschreibt einen Vorgang, bei dem Sie untersuchen, wie vorhandene Dokumente konzipiert sind und auf welchen Strukturen sie basieren. Bei Ihrer Analyse legen Sie zuerst eine Liste der Dokumente an, die in Ihrem Betrieb erstellt werden. Dazu können Benutzer- und Referenzhandbücher, Weißbücher, Lehrgänge, Schulungsunterlagen und Onlinehilfen gehören. Erstellen Sie für jeden Dokumenttyp eine Liste der wichtigsten Komponenten. Führen Sie für jede Komponente an, ob sie obligatorisch oder optional ist und wie oft sie im Dokument vorkommt. Die folgende Tabelle zeigt die oberste Ebene einer Buchanalyse:
Komponente |
Anforderung |
Häufigkeit |
|---|---|---|
Titelblatt |
Obligatorisch |
1 |
Inhaltsverzeichnis |
Obligatorisch |
1 |
Vorwort |
Optional |
0 oder 1 |
Kapitel |
Obligatorisch |
2 oder mehr |
Anhang |
Optional |
0 oder mehr |
Glossar |
Optional |
0 oder 1 |
Index |
Obligatorisch |
1 |
Bei den Hauptkomponenten wie den Lektionen in Schulungsunterlagen oder den Kapiteln von Büchern arbeiten Sie die Dokumenthierarchie Schritt für Schritt nach unten bis zu den kleinsten Strukturen ab.
Sie müssen eine Inhaltsanalyse für jeden Dokumenttyp durchführen, den Sie in der strukturierten Umgebung erstellen. Nach der Entwicklung eines Inhaltsmodells für die verschiedenen Dokumente können Sie das Modell weiterbearbeiten und Namen wiederverwenden. Beispiel: ein Hilfemodul besteht aus Themen und die Kapitel in einem Buch bestehen ebenfalls aus Themen. Wenn Sie ein Themenelement erstellen, das sowohl für gedruckte Materialien als auch online verwendet werden kann, benötigen Sie weniger Elemente in Ihrer Strukturdefinition und können möglicherweise Informationen in beiden Ausgabeformaten doppelt nutzen.
Gedrucktes Thema |
Onlinethema |
Kombiniertes Thema |
|---|---|---|
Thema |
Thema |
Thema |
Titel |
Titel |
Titel |
Para- |
Para- |
Para- |
Schritte |
Schritte |
Schritte |
Kann Absatz, Liste, Tabelle, Grafik, Anmerkung enthalten |
Kann Absatz, Liste, Tabelle enthalten |
Kann Absatz, Liste, Tabelle, Grafik, Anmerkung enthalten |
VerwandteThemen |
VerwandteThemen |
Normalerweise sind Dokumente nicht völlig konsistent. Sie müssen festlegen, ob Sie eine lockere Struktur, die viele Abweichungen zulässt, oder eine strenge Struktur erstellen, die nur wenige Abweichungen akzeptiert. Beide Ansätze sind nachteilig, wenn sie zu extrem umgesetzt werden:
Sehr lockere Strukturen sind hochkomplex und oft schwer zu pflegen, da viele Variationsmöglichkeiten zugelassen werden.
Zu strenge Strukturen können benötigte Elementkombinationen verhindern.
Es ist nicht immer einfach, die richtige Balance zwischen beiden Extremen zu finden. Sie könnten zum Beispiel nur solche Abweichungen zulassen, aus denen ein zusätzlicher Vorteil erwächst.
Nach Abschluss der Analyse können Sie entscheiden, ob Sie vorhandene Strukturen übernehmen oder eigene Strukturen erstellen möchten. Es stehen zahlreiche XML-Implementierungen zur Verfügung; DocBook und DITA (Darwin Information Typing Architecture) zum Beispiel sind Spezifikationen, die bei technischen Dokumentationen Anwendung finden. Standardstrukturen gibt es auch für militärische Dokumente, Wartungshandbücher für Flugzeuge usw. Die folgende Tabelle zeigt einige Faktoren, von denen es abhängt, ob Sie eine Standardspezifikation übernehmen oder eigene Strukturen erstellen sollten.
Standard |
Eigene Struktur |
|---|---|
Sie müssen Inhalte übermitteln, die einem gebräuchlichen Standard entsprechen. Zum Beispiel müssen viele Auftragnehmer der US Army Unterlagen beibringen, die einem veröffentlichen Standard entsprechen. |
Sie möchten eine Struktur erstellen, die Ihrer Inhaltsanalyse genau entspricht. |
Ihre Anforderungen entsprechen weitgehend einer vorhandenen Struktur. Sie müssen nur wenige Änderungen an der Standardstruktur vornehmen. |
Laut Ihrer Inhaltsanalyse stimmen die Informationen mit den vorhandenen Strukturen nicht genau überein. |
Sie möchten nicht viel Zeit für die Erstellung einer Struktur aufbringen und sind bereit, den Aufbau Ihrer Materialien zu ändern, um ihn in die vorhandene Struktur einzupassen. |
Die Struktur muss mit dem Inhalt genau übereinstimmen. Eine längere Implementierungsdauer ist ein akzeptabler Preis dafür, dass das Ergebnis genau Ihren Vorstellungen entspricht |
Ihnen fehlen das Fachwissen oder die Ressourcen zur Erstellung eigener Strukturen. |
Ihnen stehen genügend feste oder freie Mitarbeiter zur Verfügung, die sich um die Strukturerstellung kümmern können. |
Die grundlegenden Bausteine von strukturierten Dokumenten sind Elemente. Elemente stellen Einheiten des Dokumentinhalts dar (Text, Grafiken usw.) und bilden zusammen die Struktur des Dokuments. Elemente können entweder einfach oder komplex sein.
Ein einfaches Element in XML enthält nur Text. Ein komplexes Element kann Attribute aufweisen und kann:
leer sein
andere Elemente enthalten
nur Text enthalten
sowohl Elemente als auch Text enthalten
Elemente können Werte mit einem bestimmten Bereich von gültigen Werten enthalten.
Alle strukturierten Dokumente in FrameMaker verwenden Elemente. Jedes Element hat einen Namen, beispielsweise <section>, <title> oder <p>. Die verfügbaren Elemente werden durch die Elementdefinitionen des Dokuments festgelegt.
Attribute enthalten zusätzliche Informationen zu einem Element. Beispielsweise kann der DTD-Designer eines Handbuchs durch das Attribut „Version“ für das Buchelement ermöglichen, dass der Benutzer den Überarbeitungsstatus eines Buchs angibt. In FrameMaker sind die Attribute für ein Element Teil der Definition des Elements. In XML oder SGML können die Attribute eines Elements getrennt in einer Attributdefinitionslisten-Deklaration (ATTLIST) in der DTD vorkommen.
Attribute können einen Standardwert oder einen festen Wert aufweisen. Attribute können ebenfalls entweder obligatorisch oder optional sein. Bei einem Themenelement kann die Themen-ID beispielsweise ein obligatorisches Attribut für Themen mit Querverweisen sein. Außerdem können Wertebereiche für Attribute vorhanden sein oder die zulässigen Werte für ein Attribut aufgezählt werden.
Die folgenden sieben Regeln steuern, wie Elemente bezüglich Reihenfolge, Anzahl von Vorkommen und Gruppe verwendet werden.
Gibt an, dass untergeordnete Elemente in einer beliebigen Reihenfolge auftreten können und mindestens einmal auftreten müssen.
Gibt an, dass eines der untergeordneten Elemente auftreten kann.
Gibt die Reihenfolge an, in der die untergeordneten Elemente angezeigt werden.
Gibt an, wie oft ein untergeordnetes Element mindestens auftreten kann.
Gibt an, wie oft ein untergeordnetes Element höchstens auftreten kann.
Elemente können unter einer Gruppendeklaration gruppiert werden.
Attribute können unter einer attributeGroup-Deklaration gruppiert werden.
Ein XML-Schema definiert die zulässigen Bausteine eines XML-Dokuments. Anders als das EDD enthalten DTDs und Schemadateien keine Formatierungsdaten.
In XML-Schemas wird Folgendes definiert:
Liste der Elemente, die im Dokument vorhanden sein können
Attribute, die in einem Dokument für ein Element vorhanden sein können
Elementhierarchie – gibt an, welche Elemente als untergeordnete Elemente vorhanden sein können
Reihenfolge der untergeordneten Elemente
Anzahl der untergeordneten Elemente
Datentypen für Elemente sowie Attribute
Standardwerte und feste Werte für Elemente und Attribute
Durch XML-Namespaces kann das gleiche Dokument XML-Elemente und Attribute aus verschiedenen Ausdrücken enthalten, ohne dass Konflikte bei der Namensgebung auftreten.
Sie können ein XML-Dokument importieren, das auf eine Schemadatei verweist, und Sie können eine Schemadatei in der strukturierten Anwendung angeben, die für die Validierung eines Dokuments beim Export in XML verwendet wird.
Um eine Schemadatei anzugeben, die für das Exportieren von XML verwendet wird, müssen Sie die Datei structapps.fm ändern. Das Element „Schema“, das dem Element <XMLApplication> untergeordnet ist, gibt den Pfad der Schemadatei für den Export an.