21 Sprachen, 63 PDF-Dateien, 84 Onlinehilfen

21 Sprachen, 63 PDF-Dateien, 84 Onlinehilfen — ist das schon ein Fall für ein Redaktionssystem, lässt sich das ohne Datenbank verwalten? Ein Projektbericht.

Herausforderung

Für eine Software-Familie auf gemeinsamer Plattform werden PDF-Handbücher und CHM-Onlinehilfen benötigt. Es gibt vier Produktvarianten, die alle eine Onlinehilfe (mit ~200…400 Topics) und drei davon ein PDF-Handbuch (mit ~100…200 Seiten) benötigen.

Eine Abteilung bei Bosch Sicherheitssysteme GmbH nutzt seit Jahren strukturierten FrameMaker und verwendet für Übersetzungen und HTML-Konvertierungen das XML-Format. Die Dokumente folgen einer selbst entwickelten Struktur und sind so optimal auf das Produktprogramm und die benötigten Dokumentationstypen abgestimmt.

Es ist eine eingespielte Lösung, wenn da nicht die vielen administrativen Tätigkeiten für die Publikation der Medien wären, die zudem 21-fach pro Sprache anfallen:

  • Öffnen der XML-Datei
  • Hinzufügen von Titel, Inhaltsverzeichnis und Nachspann zum FrameMaker-Buch
  • Einrichten der Kapitel- und Seitennummerierungen
  • Aktualisieren der Verzeichnisse
  • Erstellen der Varianten für jede Produktvariante
  • Erstellen der PDF-Dateien für alle Varianten

Bevor Sie weiterlesen: Schätzen Sie einmal, wieviel Zeit Sie dafür benötigen würden, ohne Layout-Korrekturen pro Sprache.

Variantensteuerung

Die Arbeit mit einem Master-Buch für alle vier Produkte ermöglicht dem Redakteur eine ganzheitliche Sicht auf die Produktfamilie, so dass zum Beispiel bei Änderungen für ein Produkt die Auswirkungen auf die anderen Produkte sofort ins Auge fallen.

Naheliegend war der Einsatz von Attributen zur Unterscheidung sowohl der Zielmedien (bestimmte Teile erscheinen nur in der Onlinehilfe, andere nur im PDF-Handbuch) und der Produktvarianten.

Zur Visualisierung dieser Einstellungen für den bearbeitenden Redakteur und zum Wegfiltern der für eine Produktvariante irrelevanten Dokumentteile wird das FrameMaker-Plug-in ABCM verwendet. Dieses ermöglicht eine freie Konfiguration auf Basis der Attributwerte und speichert auf Wunsch das so gefilterte Buch in einem neuen Ordner. Jetzt könnte bei Bedarf eine Korrektur des automatisch erstellten Layouts stattfinden.

Ein Vorteil bei der Arbeit mit einem Master-Buch und fallweiser Attribut-Auszeichnung besteht darin, dass der Redakteur sich mit diesen Metadaten nur dann beschäftigen muss, wenn tatsächlich Angaben gemacht werden müssen; alle nicht mit entsprechenden Attributwerten ausgezeichneten Texte und Bilder sind automatisch für alle Medien und Produkte relevant.

Vollständiges »XML-Roundtripping«

Der Begriff »XML-Roundtripping« bezieht sich bei FrameMaker bislang auf die Textinhalte, nicht aber auf die Einrichtung von Büchern und generierten Verzeichnissen. Diese Aspekte gehören auch nicht in die XML-Daten und sind beispielsweise für die Produktion der Onlinehilfe völlig entbehrlich. Daraus resultierte der — wenn für jede Sprache, hier 21-fach, auszuführen — relativ hohe Aufwand für die Einrichtung der Bücher.

In diesem Projekt wurden die immer wieder durchzuführenden Tätigkeiten durch Programmierung automatisiert, so dass der Redakteur nach dem Öffnen einer XML-Datei ein aktualisiertes, druckfertiges Buch vorliegen hat. Die Teilaufgaben waren:

  • Erstellen des Inhaltsverzeichnisses als XML-strukturiertes Verzeichnis mit Querverweisen zu den Überschriften
  • Anlegen der Index-Datei und Markieren als generierbare Datei
  • Alphabetisches Sortieren des Glossars
  • Einrichten des Seitenumbruchs
  • Einstellen der Seiten- und Kapitelnummerierungen
  • Aktualisierung von Dokumentvariablen auf der Basis bestimmter Attribute
  • Aktualisieren des Index und automatisches Zuweisen der Vorgabeseiten

So wurde ein auf das Buch bezogenes vollständiges »XML-Roundtripping« erreicht. Ein Buch kann im XML-Format gespeichert und wieder geöffnet werden, ohne dass der Autor zusätzliche Schritte unternehmen muss.

Stapel-Produktion von PDF-Dateien

Da in 21 Sprachen jeweils drei PDF-Dateien zu erstellen waren, war der Wunsch nach einer Stapelverarbeitung zur Produktion der PDF-Dateien groß. Durch die Verwendung von validem XML als Austauschformat mit den Übersetzern war die technische Qualität der Dokumente gewährleistet, eine wichtige Voraussetzung für automatische Prozesse.

Produktion von PDF-Dateien in einem Schritt

If you can see this, then you might need a Flash Player upgrade or you need to install Flash Player if it's missing. Get Flash Player from Adobe.

Auftragsdialog zur Steuerung der Stapelverarbeitung

Durch FrameScript- und XSL-Programmierung wurden im Rahmen des Projekts die folgenden Schritte zusammengefasst, wobei der Anwender zu Beginn nur die XML-Datei einer Sprache auswählt:

  1. Öffnen der XML-Dateien aller Sprachen, aus denen jeweils ein aktualisiertes, druckfertiges FrameMaker-Buch wird,
    hier: 21 XML-Dateien → 21 FM-Bücher
  2. Öffnen der FM-Bücher und automatisches Feststellen, ob Produktvarianten erstellt werden müssen; wenn dies der Fall ist, werden mit Hilfe von ABCM die produktspezifisch gefilterten Bücher in Unterordnern angelegt,
    hier: 21 FM-Bücher → 63 FM-Bücher
  3. Öffnen der FM-Bücher und Erstellen der PDF-Versionen,
    hier: 63 FM-Bücher → 63 PDF-Dateien

Die resultierenden Bücher sind im Schnitt ca. 130 Seiten stark und FrameMaker 9 benötigt für alle Produktionsschritte von den 21 XML-Dateien bis zu den 63 PDF-Dateien ca. 4,5 Stunden, ungefähr gleich verteilt auf die einzelnen Schritte. Der Redakteur startet diesen Prozess (auf einem zweiten Rechner) und kann sich dann anderen Aufgaben widmen.

Stapel-Produktion der Onlinehilfen

Da die Quelldaten komplett als valides XML vorliegen, wird FrameMaker hier eigentlich nicht benötigt, denn die Konvertierung nach HTML erfolgt mit Hilfe des Open-Source-Transformators Saxon. Da FrameMaker die Schaltstelle für alle Schritte sein sollte und zudem noch weitere Aufgaben (wie die Kompilierung zu CHM-Hilfen) automatisiert werden sollten, entstand eine FrameScript-Lösung, die nach Auswahl der XML-Datei einer Sprache eine Windows-CMD-Datei erstellt, die wiederum:

  1. Produktionsverzeichnisse für die HTML-Dateien anlegt
  2. Grafiken und Zubehördateien (CSS, JavaScript) umkopiert
  3. die XSL-Transformation mit Saxon startet,
    hier: 21 XML-Dateien → 21 × 4 × ~300 HTML-Dateien
  4. HTML-Dateien kompiliert,
    hier: ~25.200 HTML-Dateien → 84 CHM-Dateien

Produktion von CHM-Dateien in einem Schritt

If you can see this, then you might need a Flash Player upgrade or you need to install Flash Player if it's missing. Get Flash Player from Adobe.

Bestandteil des Projekts war auch eine XSL-Programmierung, die gemäß einer Konfigurationsdatei die Daten mehrfach für alle geforderten Produktvarianten verarbeitet.

Auftragsdialog zur Steuerung der Stapelverarbeitung

Für diese Aktionen benötigt der Rechner insgesamt ca. eine Stunde, wovon mindestens 55 Minuten auf die Kompilierung der 84 CHM-Dateien entfallen.

Ohne Redaktionssystem

In gewisser Weise ersetzt die vereinbarte Verzeichnisstruktur hier das Redaktionssystem. Wobei die Versionierung in den Händen der Redakteure liegt. Auch die in verschiedenen Geschäftsbereichen recht unterschiedlichen Workflows rund um die Lebensdauer eines Produkts und dessen Dokumentation werden nicht durch ein System sondern individuell angepasst gehandhabt. Diese Flexibilität und das Arbeiten mit Master-Büchern wird durch die klar geregelte redaktionelle Zuständigkeit ermöglicht: Jedes Produkt wird von einem Redakteur betreut, auf ein Master-Buch greift immer nur eine Person zu. (Umgekehrt betreut jeder Redakteur natürlich mehrere Produkte.)

Die Lösung wird von derzeit von 21 Redakteuren an acht Standorten für große und kleine Sicherheitstechnik-Produkte genutzt. Sie ist weder in der Zahl der Sprachen (derzeit werden 31 Sprachen unterstützt) noch in der Zahl der Varianten begrenzt, die oben genannten Zahlen stehen beispielhaft für ein jüngst publiziertes Projekt.

ITL Institut für technische Literatur AG

Haben Sie ähnliche redaktionelle und prozesstechnische Herausforderungen, wenden Sie sich an direkt mich oder an die itl AG, Dieter Gust, in dessen Auftrag ich dieses Projekt durchführte. Die Optimierung XML-strukturierter Prozesse auf Basis von FrameScript und XSLT ist unsere Spezialität (mit oder ohne Redaktionssystem).

– Michael Müller-Hillebrand, im Juli 2009

Eingesetzte Tools

  • Adobe FrameMaker: WYSIWYG XML-Editor und -Publisher
  • West Street Consulting ABCM (Attribute-Based Condition Management): Variantensteuerung auf Basis von Attributen
  • Elmsoft FrameScript/ElmScript: FrameMaker-API-Programmierung
  • Saxonica Saxon B: XSLT-2.0-konformer Transformator
  • Technology Lighthouse PTFB (Push That Freakin’ Button!)

Ein Kommentar zu 21 Sprachen, 63 PDF-Dateien, 84 Onlinehilfen

  1. Pingback: FrameScript / ElmScript » Stress vermeiden

Kommentare sind geschlossen.