Strukturiertes Authoring

Einführung

In einem Workflow mit unstrukturiertem Authoring können Sie Dokumente mit relativ frei gestaltetem Text erstellen. Sie können beispielsweise können Überschriften gefolgt von Absätzen oder Grafiken mit Beschriftungen erstellen. Beim strukturierten Authoring erzwingen Inhaltsregeln eine einheitliche Struktur in ähnlichen Informationseinheiten. Beispielsweise können folgende Inhaltsregeln durchgesetzt werden:

• Ein Thema muss immer mit einem Titel beginnen.

• Auf einen Titel muss ein Absatz folgen.

• Eine Tabelle muss eine Kopfzeile aufweisen.

• Eine Grafik muss eine Beschriftung aufweisen.

Diese Inhaltsregeln werden entweder in einer DTD-Datei (Document Type Definition) oder einem XML-Schema definiert. Die Einhaltung dieser Inhaltsregeln wird anhand der DTD oder dem XML-Schema automatisch überprüft.

Nehmen Sie als Beispiel die Struktur einer Anschrift. In den Inhaltsregeln kann in diesem Fall festgelegt sein, dass eine Adresse einen Mitarbeiternamen, eine Hausnummer, eine Straße, einen Ort und eine 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.

Vorteile

Einheitliche Strukturierung der Informationen

Sie können eine strukturierte Anwendung erstellen, um sicherzustellen, dass eine Liste mit Auszeichnungspunkten mindestens zwei Elemente enthalten muss. Oder jedes Bild eine Beschriftung aufweisen muss.

Automatische Prüfung der Informationsstruktur

FrameMaker zeigt visuelle Hinweise an, wenn die Struktur eines Dokuments beschädigt ist.

Figure 1. Hier fehlt das Titelelement in einem DITA-Thema

Konsistenz des Inhalts

Das Erzwingen einer Struktur führt zu verbesserter Konsistenz des Inhalts über mehrere Dokumente in einem Dokumentsatz hinweg.

Unterstützung für die Wiederverwendbarkeit von Inhalten

FrameMaker bietet auf der Benutzeroberfläche basierende Funktionen für die Wiederverwendung von Inhalten, z. B. DITAVAL, „Filter nach Attribut“ oder Beziehungstabellen, damit Benutzer Inhalte problemlos wiederverwenden können.

Unterstützung von Metadaten zum Hinzufügen von Informationen zu Dokumenten

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 anhand dieser Attribute filtern.

Trennung von Inhalt und Formatierung

Die Autoren konzentrieren sich auf den Inhalt. Der Veröffentlichungs-Workflow steuert die Formatierung und das Erscheinungsbild der endgültigen Ausgabe. 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.

Figure 2. XML-Ansicht

Figure 3. WYSIWYG-Ansicht

Reduzierung des Lokalisierungsaufwands

Da bei strukturierten Dokumenten Formatierung und Inhalt voneinander getrennt sind, können Lokalisierungsaufwand und -kosten durch den Einsatz von Lokalisierungstechnologien erheblich verringert werden.

SGML, XML und XHTML

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.

SGML

SFML (Standard Generalized Markup Language) 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 ein und dasselbe Dokument von unterschiedlichen Systemen verarbeitet werden kann. Jedes System führt unterschiedliche Verarbeitungsanweisungen in den jeweiligen Abschnitten aus.

SGML war die erste Sprache, in der die DTD (Document Type Definition) eingeführt wurde, mit der ein Dokument anhand seiner 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.

XML

XML (Extensible Markup Language) 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 Elemente definieren, sondern auch ihre Reihenfolge, die Beziehungen zwischen ihnen und die Art der Verarbeitung und Darstellung.

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 Elemente verwendet, die den Standard-XML-Spezifikationen entsprechen, wird als wohlgeformt bezeichnet.

XHTML 1.0

XHTML (Extensible Hypertext Markup Language) 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.

XML und XHTML 1.0 im Vergleich

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 eines Textabsatzstils und des vorausgehenden Stils „Überschrift1“ nicht erfasst. Beim strukturierten Authoring hingegen werden die hierarchischen Beziehungen zwischen den Komponenten des Dokuments erfasst.

DITA und DocBook

Zwei der in Adobe FrameMaker für die technische Dokumentation verfügbaren standardmäßigen strukturierten Anwendungen sind DITA und DocBook.

DITA

DITA (Darwin Information Typing Architecture) ist ein XML-Datenmodell für die Erstellung und Veröffentlichung. Es handelt sich um einen offenen Standard, der vom OASIS DITA Technical Committee definiert und gepflegt wird. DITA bietet eine Reihe von Elementen und Attributen sowie eine vordefinierte Struktur, die speziell für die technische Dokumentation entwickelt wurde.

DITA 1.3 enthält fünf spezielle Thementypen:

• Aufgabe

• Konzept

• Referenz

• Glossareintrag

• Fehlerbehebung

Typische Elemente in DITA sind z. B. <title>, <shortdesc>, <prolog>, <body>, <p>, <fig>, <image>, <table> und <related-links>.

Im Folgenden sind einige typische DITA-Funktionen aufgeführt:

• DITA ist themenorientiert. Jedes Thema (Topic) ist ein Stück Inhalt, das 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. DITA stellt drei grundlegende Thementypen bereit, ermöglicht jedoch die Anpassung dieser Thementypen entsprechend individuellen Anforderungen.

• DITA verwendet eine DITA Map, die Links zu den XML-Dateien im Dokumentationssatz enthält. Jede XML-Datei kann ein Thema oder eine Themensammlung darstellen.

• FrameMaker kann DITA in PDF, Responsive HTML5, mobilen Apps für iOS und Android, EPUB, Kindle, Microsoft HTML Help (CHM) und einfacher HTML-Ausgabe veröffentlichen.

DocBook

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.

Zu den typischen Elementen in DocBook gehören beispielsweise <article>, <section>, <title>, <articleinfo> und <pubdate>.

Im Folgenden sind einige typische DocBook-Funktionen aufgeführt:

• DocBook ist buch- oder kapitelorientiert.

• 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 HTML Help erfolgen. Mit etwas Entwicklungsaufwand können diese auf andere Ausgabeformate erweitert werden.