XML-First für die Technische Dokumentation

Marcus Bollenbach Trainer und Berater, Computrain

Beim Verfassen und Publizieren von Texten gibt es – insbesondere bei der Technischen Dokumentation – neben der wesentlichen inhaltlichen noch eine weitere zeitintensive Komponente, die Autoren berücksichtigen müssen: Die spezifischen Layoutanforderungen für die unterschiedlichen Medien, in denen die Inhalte veröffentlicht werden, müssen nicht selten über umfangreiches manuelles Formatieren durchgeführt werden. Um hier Zeit und Kosten über einen möglichst automatisierten Workflow zu sparen, werden die beiden Arbeitsschritte – das Erfassen des Inhalts und seine Formatierung – entkoppelt.

Verlage setzen zunehmend darauf, den Inhalt zunächst in einer medienunabhängigen, strukturierten (XML-)Datei zu erfassen und ihn dann in einem zweiten Schritt an das Layout der jeweiligen Ausgabeform anzupassen. Voraussetzung für eine automatisierte Formatierung sind die in den XML-Dateien eingebetteten Metadaten – ein wesentlicher Schritt in Richtung „intelligenter Content“. Unerlässlich für ein kostengünstiges Publishing ist darüber hinaus, dass sich einzelne Komponenten des Contents automatisiert immer wieder neu zusammenstellen und kombinieren lassen.

Konzentration auf den Content

Autoren sollen sich also zunächst auf die inhaltliche Ebene ihrer Texte konzentrieren. Notwendig dazu sind Lösungen, die Autoren dabei unterstützen, möglichst komfortabel ihre Texte zu erstellen und gleichzeitig – im Gegensatz zu der „klassischen“ Schreibarbeit mittels Textverarbeitungsprogramm und DTP – strukturierte Inhalte als XML-Dokumente zu produzieren. Zur Verfügung stehen hier eine Reihe XML-Editoren, die je nach Bearbeitungssituation oder Vorliebe des Bearbeiters eingesetzt werden.

Eine mögliche Lösung ist beispielsweise der Adobe FrameMaker XML Author 12, der eine Untermenge von FrameMaker 12 darstellt. Die Software ist ausgelegt auf Erstellung von XML/DITA-Inhalten und bindet FrameMaker mit seinen umfangreichen Strukturfunktionalitäten in die nachliegenden Prozesse und Workflows ein. Damit bietet sich der XML Author auch als Editor in CMS-basierten Dokumentationsprozessen an, zu denen das Programm neben den Schnittstellen für SharePoint, EMC Documentum oder dem Adobe Experience Manager (ehemals Adobe CQ) auch eine direkte Integration der Dropbox bietet. Weitere CMS-Systeme sind über Drittanbieter-Module verfügbar, die es auch für den grossen FrameMaker gibt.

Verschiedene Ansichten – Übersicht über das Dokument

Um die speziellen Bearbeitungssituationen von Autoren zu berücksichtigen, sind mehrere Ansichten möglich. So bietet die WYSIWYG-Ansicht die klassische und redaktionelle Ansicht des Inhalts, die auch der Druck- bzw. PDF-Ausgabe entspricht. Die Autoren-Ansicht stellt noch gewisse Formatierungen dar, hebt aber ansonsten Dinge wie Spalten- oder Seitenbegrenzungen auf. Diese Ansicht erlaubt eine ähnliche Handhabung und Darstellung wie z.B. bei Online-Inhalten oder Hilfesystemen. Außerdem werden in dieser Ansicht verschiedene Formatierungsmöglichkeiten eingeschränkt, so dass Autoren sich auf die inhaltliche Bearbeitung konzentrieren können.

art6_bild1
Bild 1: XML-View mit XPath-Assistent und Pretty Printing

Zu guter Letzt bietet der XML View eine native XML-Ansicht des Inhaltes. Pretty Printing sorgt für eine übersichtliche Darstellung der Inhalte. Mit Hilfe der XPath 2.0-Funktion lassen sich die aktuelle Datei oder ganze Verzeichnisse durchsuchen. Ein Assistent unterstützt dabei die Erstellung von XPath-Ausdrücken. Mittels XSLT 2.0 lassen sich die XML-Inhalte im XML-View auch zur Laufzeit transformieren. Ansonsten lassen sich XSL-Transformationen in Öffnen- und Schließen-Prozesse einbinden. Im Lieferumfang sind die XSL-Prozessoren Xalan (Version 2.7.1) und Saxon (Version 9.3.0.5) enthalten, weitere können bei Bedarf eingebunden werden.

Kontextabhängige Bearbeitung von Inhalt und Struktur

Die Arbeit an den XML-Dokumenten wird durch eine Reihe von Funktionen unterstützt: So lassen sich neue DITA-Dokumente durch die vordefinierten DITA-Templates erstellen. Die Bearbeitung von XML-Inhalten wird darüber hinaus durch Smart-Kataloge erleichtert, die das kontextabhängige Einfügen, Eingliedern und Ändern von Elementen sowie das Einfügen und Bearbeiten von Attributen mittels Tastenkürzeln ermöglichen. Eine neue, anpassbare Palette für das Einfügen von Standardelementen wie Listen, Absätzen, Tabellen in DITA-Umgebungen unterstützt Autoren bei der Bearbeitung. Diese Palette lässt sich aber auch auf eigene Strukturumgebungen anpassen.

art6_bild2
Bild 2: WYSIWYG-Ansicht mit Smart-Katalog, Werkzeugleiste zum schnellen Einfügen von Elementen und dem Pod für geöffnete Dokumente

Darüber hinaus fügt XML Author, sofern definiert, festgelegte Elementabfolgen ein, die ein Grundgerüst für den Aufbau des Dokumentes vorgeben. Der Autor erhält zudem Unterstützung, wie die definierte Struktur befüllt werden soll. Sogenannte Banner-Texte informieren hier über den vorgesehenen Elementinhalt. Mit der zuschaltbaren Tag-Ansicht werden die Elementgrenzen der jeweiligen Elemente in der WYSIWYG- und Author-Ansicht angezeigt und erlauben, wie in der Strukturansicht, das Ein- und Ausblenden sowie das Verschieben von Elementen. Mit dem Attribute-Editor werden gepflegte Attributwerte übersichtlich angezeigt und lassen sich einfach ändern. Neben der Unterstützung von DITAval bietet der XML Author auch eine Möglichkeit, die strukturierten Inhalte nach Attributen zu filtern. Dadurch lassen sich z.B. Varianten von Produkten verwalten und Inhalte bedarfsgerecht ein- oder ausblenden.

Bei der Übernahme bereits bestehender Inhalte, z.B. aus Word-Dateien, wandelt die Einfüge-Funktion unter Verwendung von vordefinierten CSS-Dateien die formatierten Inhalte in DITA-strukturierte Inhalte. In den Word-Inhalt kopierte Grafiken werden dabei automatisch in referenzierte Grafiken umgewandelt, die extern abgelegt werden. Wird als Zielstruktur nicht DITA verwendet, kann der CSS-Prozess auch an die eigene Struktur angepasst werden. Formeln sind ein weiteres Thema in technischen Dokumenten: Sie werden mittels des MathML-Plugins in grafischer Form erstellt und auch nativ in den XML-Datenstrom eingebunden. Eine weitere Funktion erlaubt die Einbindung von QR-Code.

Der PDF-Kommentarworkflow, der die Rückübernahme von Kommentaren aus einem PDF in den XML Author ermöglichen, wurde optimiert. Er wurde dahin gehend verbessert, dass die Quell-Dokumente, die dem Kommentar-Prozess zu Grunde liegen, nach der PDF-Ausgabe und Weitergabe der PDFs weiter bearbeitet werden können. Damit das funktioniert, müssen allerdings alle Elemente in den XML-Dokumenten ein befülltes ID-Attribut aufweisen. Der XML Author bietet zu diesem Zweck ein Werkzeug, das allen Elementen eine eindeutige ID zuweisen kann.

Funktionen für einen reibungslosen Arbeitsablauf

Neben Funktionen für die Texterstellung und Strukturbearbeitung kann die Arbeit von Autoren auch erleichtert werden, wenn einmal getroffene Arbeitseinstellungen nicht immer wieder neu eingestellt werden müssen. Dazu gehört, dass die letzte Sitzung mit demProgramm wiederherstellt werden kann. Schließt man den XML Author, wenn mehrere Dateien geöffnet sind, so werden diese zuvor gespeichert. Beim nächsten Start des Programms können über die Funktion „Letzte Sitzung wieder herstellen“ alle zuletzt geöffneten Dateien wieder angezeigt werden, einschließlich der Eigenschaften wie die angezeigte Seite oder Zoom-Faktoren in den einzelnen Dateien. Die Handhabung vieler geöffneter Dateien wird zudem in der Weise unterstützt, dass bei der Anzeige auf dem Bildschirm eine Sortierung nach Namen oder Pfad möglich ist sowie eine Filterung nach noch zu speichernden Dateien. Auch erlaubt eine Suchfunktion den gezielten Zugriff auf geöffnete Dateien.

Vor allem für die Teamarbeit interessant ist zudem die Rückübernahme von Kommentaren aus einem PDF. Die Quell-Dokumente, die dem Kommentar-Prozess zu Grunde liegen, können nach der PDF-Ausgabe und Weitergabe weiter bearbeitet werden. Damit das funktioniert, müssen allerdings alle Elemente in den XML-Dokumenten ein befülltes ID-Attribut aufweisen. Der XML Author bietet zu diesem Zweck ein Werkzeug, das allen Elementen eine eindeutige ID zuweisen kann.

Fazit

XML-basierte Prozesse professionell zu handhaben, gelingt mit den geeigneten XML-Editoren und Werkzeugen. Autoren und Themenexperten, die die Dokumente erstellen, sind hier angewiesen auf Tools wie XML Author, die umfangreichen XML-Funktionalitäten in Verbindung mit der standardmäßigen WYSIWYG-Darstellung zur Verfügung stellen.

www.adobe.com

Marcus Bollenbach Trainer und Berater, Computrain. Adobe Systems ist der weltweit führende Anbieter für Lösungen im Bereich digitales Marketing und digitale Medien. Mit den Werkzeugen und Diensten von Adobe können Kunden digitale Inhalte entwickeln und sie auf allen Medien und über alle Geräte hinweg bereitstellen. Adobe ermöglicht es seinen Kunden, Inhalte für alle Bildschirmgrößen zu entwic keln, sie zu verwalten und die daraus gewonnenen Erkenntnisse zu nutzen.