Adobe FrameMaker (2019 release)
Klicken Sie hier, um diese Seite mit vollem Kontext anzuzeigen
Erfahren Sie, was strukturiertes Authoring ist und wie die Inhaltsregeln für strukturiertes Authoring in FrameMaker definiert werden.
In einem Arbeitsablauf mit unstrukturiertem Authoring können Sie Dokumente mit relativ frei gestaltetem Text erstellen. Beispielsweise können Überschriften gefolgt von Absätzen oder Grafiken mit Beschriftungen oder alternativem Text erstellt werden. Im Falle von strukturiertem Authoring erzwingen die Inhaltsregeln eine einheitliche Struktur in ähnlichen Informationseinheiten. Beispielsweise können folgende Inhaltsregeln durchgesetzt werden:
Ein Thema muss immer mit einem Titel beginnen.
Nach einer Überschrift muss ein Absatz folgen.
Eine Tabelle muss eine Kopfzeile aufweisen.
Eine Grafik muss eine Beschriftung aufweisen.
Diese Inhaltsregeln werden in der DTD (Document Type Definition) oder einem XML-Schema definiert. Die Einhaltung dieser Inhaltsregeln wird automatisch anhand der DTD oder dem Schema überprüft.
Nehmen Sie als Beispiel die Struktur einer Anschrift. In den Inhaltsregeln kann in diesem Fall festgelegt sein, dass die Adresse einen Mitarbeiternamen, eine Hausnummer, Straße, Stadt und Postleitzahl enthalten muss. Beim unstrukturierten Authoring kann eine Adresse ohne Hausnummer nur bei der Bearbeitung oder beim Review festgestellt werden. Beim strukturierten Authoring wird die Struktur validiert und automatisch auf Vollständigkeit überprüft. Einheitliche Struktur und Reihenfolge werden daher erzwungen und sind gewährleistet.
Sie können eine strukturierte Anwendung erstellen, die durchsetzt, dass eine Liste mit Auszeichnungspunkten mindestens zwei Elemente enthalten muss. Oder jedes Bild eine Beschriftung aufweisen muss.
FrameMaker zeigt visuelle Hinweise an, wenn die Struktur eines Dokuments beschädigt ist.
Das Erzwingen einer Struktur führt zu verbesserter Konsistenz des Inhalts über mehrere Dokumente in einem Dokumentsatz hinweg.
Die Benutzeroberfläche von FrameMaker bietet Funktionen für die Wiederverwendbarkeit von Inhalten, z. B. DITAVAL, „Filter nach Attribut“ oder Beziehungstabellen, damit Benutzer Inhalte problemlos wiederverwenden können.
Neben Inhalten wie Text und Bildern können Sie einem strukturierten Dokument auch Metadaten zuordnen, z. B. den Autor des Dokuments. Außerdem können Sie Attribute verwenden, um Metadaten bestimmten Elementen in einem Dokument zuzuordnen. Mithilfe der Funktion „Filter nach Attribut“ können Sie in FrameMaker Attributwerte festlegen und anschließend den Inhalt eines strukturierten Dokuments auf der Grundlage dieser Attribute filtern.
Die Autoren konzentrieren sich auf den Inhalt. Formatierung und das Erscheinungsbild der Endausgabe werden vom Arbeitsablauf für die Veröffentlichung gesteuert. Dabei kann beispielsweise für die Druckausgabe eine andere Schrift verwendet werden als online.
FrameMaker unterstützt jedoch die Formatierung in strukturierten Anwendungen. Das heißt, dass in der FrameMaker-Umgebung für strukturiertes Authoring formatierte Inhalte angezeigt werden. So erhalten Benutzer visuelle Hinweise zur Formatierung eines Dokuments.
Da bei strukturierten Dokumenten Formatierung und Inhalt voneinander getrennt sind, können Lokalisierungsaufwand und -kosten durch den Einsatz von Lokalisierungstechnologien erheblich verringert werden.
Mithilfe von FrameMaker können Sie strukturierte Dokumente im SGML- und im XML-Format (einschließlich XHTML 1.0) importieren und exportieren. Nachdem Sie eine strukturierte Datei importiert haben, ist diese keine SGML- oder XML-Datei mehr, sondern ein strukturiertes FrameMaker-Dokument. Wenn das Dokument wieder sein ursprüngliches Format erhalten soll, speichern Sie es als SGML- oder XML-Datei.
Standard Generalized Markup Language (SGML) ist der internationale Standard für alle Textauszeichnungssprachen für Datenaustausch und -speicherung.
SGML ist keine verfahrensorientierte, sondern eine beschreibende Textauszeichnungssprache. Das heißt, dass das Dokument von unterschiedlichen Systemen verarbeitet werden kann. Jedes System führt unterschiedliche Verarbeitungsanweisungen in den jeweiligen Abschnitten aus. SGML-Dokumente können von einem zum anderen System (sowohl Hardware als auch Software) weitergegeben werden, ohne dass Daten verloren gehen.
SGML war die erste Sprache, welche die Document Type Definition (DTD) eingeführt hat, wodurch das Dokument durch seine Komponenten und Struktur formal definiert wird. Dokumente des gleichen Typs können überprüft und auf gleiche Weise verarbeitet werden.
Ein Dokument, das der DTD-Struktur entspricht, wird als gültig bezeichnet.
Extensible Markup Language (XML) ist ein allgemeines Format für die Darstellung von strukturierten Informationen, insbesondere für das Web. Wie HTML und SGML verlangt XML die Verwendung von Elementen und Struktur.
XML unterscheidet sich HTML insofern als es erweiterbar ist. Sie können nicht nur Tags definieren, sondern auch ihre Reihenfolge, die Beziehungen zwischen ihnen und die Art der Verarbeitung und Darstellung. Bezüglich Markup weist XML Tags oder Elemente auf, die ähnlich wie HTML Markup sind, jedoch von Ihnen definiert werden.
Verwenden Sie XML, um eine Struktur zu definieren und zu implementieren, die für Ihren Inhalt geeignet ist. Ein XML-Dokument, das der DTD-Struktur entspricht, wird als gültig bezeichnet. Ein XML-Dokument, das mit den Standard-XML-Spezifikationen übereinstimmende Tags verwendet, wird als wohlgeformt bezeichnet.
Extensible Hypertext Markup Language (XHTML) ist eine auf XML basierende Erweiterung von HTML, die für die Arbeit mit XML-basierten Anwendungen entwickelt wurde. Sie kann mit Standard-XML-Werkzeugen angezeigt, bearbeitet und geprüft werden. Die Verwendung von XHTML ist eine einfache Art der Migrierung von HTML zu XML, wobei die Kompatibilität in beide Richtungen gewahrt wird.
Durch HTML wird die Formatierung und durch XML der Inhalt selbst beschrieben. Die in einem Browser gerenderten HTML-Dokumente können von Personen gelesen werden. XML kann von Maschinen und Personen gelesen werden.
Während Textverarbeitung und DTP stil- und absatzbasiert aufgebaut sind, bildet XML die Grundlage für strukturiertes Authoring. Bei XML wird der Inhalt anhand von Elementen beschrieben, die in einer hierarchischen Baumstruktur angeordnet sind.
In Textverarbeitungs-Umgebungen (wie im unstrukturierten FrameMaker-Format) ergibt sich die Beziehung zwischen den verschiedenen Komponenten des Dokuments aus der Formatierung auf der Seite. In der Dokumentdatei werden diese Beziehungen jedoch nicht erfasst, da sich das Textverarbeitungsdokument aus einer Reihe von Absätzen zusammensetzt. Beispielsweise wird im unstrukturierten FrameMaker-Format die Unterordnung von Haupttextabsatz und der vorausgehenden Überschrift1 nicht erfasst. Beim strukturierten Authoring hingegen werden die hierarchischen Beziehungen zwischen den Komponenten des Dokuments erfasst.
Zwei der für technische Dokumentation verfügbaren standardmäßigen strukturierten Anwendungen sind DITA und DocBook.
DITA (Darwin Information Typing Architecture) bietet eine standardmäßige DTD und einen Satz von Regeln speziell zum Schreiben von Onlinedokumentation wie Software-Hilfedateien. Es wird eine Tag-Struktur definiert, die für Authoring, Erstellen und Liefern technischer Dokumentation geeignet ist. Die Typen von Tags in DITA umfassen <topic>, <title>, <shortdesc>, <prolog>, <body> und <concept>. Im Folgenden sind einige typische DITA-Funktionen aufgeführt:
DITA ist themenorientiert. Jedes Thema (Topic) ist eine modulare Satzkonstruktion, die in verschiedenen Kontexten wieder verwendet werden kann.
Da DITA Inhalt von Kontext trennt, sind mehrere Informationsarchitekturen in DITA möglich. DITA kann auch erweitert werden, um die Definition von Informationstypen zu ermöglichen.
DITA ist themenbasiert. Es sind drei grundlegende Thementypen möglich, diese Thementypen können jedoch den individuellen Anforderungen entsprechend angepasst werden.
DITA verwendet eine ditamap, die Links zu den XML-Dateien im Dokumentationssatz enthält. Jede XML-Datei kann ein Thema oder eine Themensammlung darstellen.
Für DITA sind verschiedene Ausgabeformate möglich, beispielsweise PDF, HTML usw. Die Ausgabeformate müssen jedoch entwickelt werden.
DITA eignet sich besser für umfangreichere Dokumentationssätze.
DocBook ist ebenfalls ein offener Standard, der für technische Artikel und Dokumentation entwickelt wurde. DocBook enthält eine DTD zum Schreiben von technischen Büchern und Artikeln in einem entsprechenden Format. DocBook-Tags umfassen <article>, <section>, <title>, <articleinfo> und <pubdate>.
Im Folgenden sind einige typische DocBook-Funktionen aufgeführt:
DocBook ist mehr buch- oder abschnittsorientiert.
DocBook hat normalerweise eine hierarchische Struktur und kann nur für wirkliche Single-Source-Dokumente entwickelt werden. Der Inhalt ist unabhängig vom Kontext.
DocBook weist einen festen und umfangreichen Satz von Elementen und Attributen auf.
DocBook bietet eine XML-Include-Datei, die alle anderen Dateien enthält.
DocBook-Ausgaben können im Format PDF, HTML und HTMLHelp erfolgen. Mit etwas Entwicklungsaufwand können diese auf andere Ausgabeformate erweitert werden.
DocBook ist einfach einzurichten und eignet sich besser für kleine bis mittelgroße Dokumentationssätze.