Beitrag zum Tagungsband - CAP Studio Dokumentations

Onlinehilfe aus FrameMaker-Dokumenten – was kommt nach WebWorks Publisher?
1/5
Onlinehilfe aus FrameMaker-Dokumenten – was
kommt nach WebWorks Publisher?
tekom-Tagung 19.-21.11.2003, Wiesbaden
Expertenforum Onlinehilfe
Dipl.-Ing. (Univ.) Michael Müller-Hillebrand, Erlangen
Inhalt
Single-Source oder Cross-Media Publishing mit FrameMaker
Prinzipielle Schwächen der Prozesse mit WebWorks Publisher
Vorteile beim Arbeiten mit FrameMaker 7 (Strukturiert)
Medienerstellung mit DocFrame
Praktische Erfahrungen
Rückfragen?
Wer heute aus den gleichen FrameMaker-Quelldokumenten sowohl druckfähige
Handbücher als auch Onlinehilfen erstellt (also Single-source oder Cross-Media
Publishing betreibt), verwendet dazu in der Regel WebWorks Publisher. Diese
proprietäre Lösung hat einige typische Schwachpunkte, die mit XML-basiertem
Publishing vermieden werden können. Mit Adobe FrameMaker 7 ist die Hürde der
Lizenzkosten für »strukturiertes Schreiben« und XML-Publishing gefallen, es bleibt aber
die Frage nach den Kosten für eine strukturierte Lösung und die Prozesse zur Erstellung
von Onlinehilfen.
Single-Source oder Cross-Media Publishing mit FrameMaker
FrameMaker ist wie kein anderes Layout-Programm auf das Publizieren aus einer Quelle
für verschiedene Zielformate geeignet. Die immer noch und auch in der absehbaren
Zukunft benötigten druckbaren Versionen von Dokumenten werden heutzutage fast
ausschließlich über den Zwischenschritt mit PDF-Dateien erstellt. Ob es nur um die
Vorbereitung für den anschließenden herkömmlichen Druck oder um interaktive
Versionen für die Veröffentlichung im Internet oder auf einer CD-ROM geht: Kein
anderes Produkt bringt eine derartig umfassende PDF-Unterstützung mit und bietet eine
so hohe Produktionssicherheit wie FrameMaker.
Für diesen Komfort muss der Anwender mit Einschränkungen bei den seit nahezu zehn
Jahre nicht weiter entwickelten Layoutmöglichkeiten des Programms leben. Aber was
nützte das schönste Layout, wenn die wiederholte Produktion von Medien zum teuren
Zeit-Poker mit unsicherem Ausgang führt…
CD
Onlinehilfe aus FrameMaker-Dokumenten – was kommt nach WebWorks Publisher?
2/5
Online-Medien
Bei der Erstellung von Online-Medien gibt es verschiedene Alternativen:
•
Sichern als HTML
•
WebWorks Publisher Standard Edition
•
Strukturierter FrameMaker mit XML-Ausgabe
•
MIF2Go <http://www.omsys.com>
•
WebWorks Publisher Professional <http://www.webworks.com>
•
RoboHelp for FrameMaker <http://www.ehelp.com/products/mustang/>
Für die ersten drei Optionen müssen keine weiteren Lizenzen gekauft werden, sie sind
in dieser Hinsicht »umsonst«, verlangen allerdings einen unterschiedlich hohen
Konfigurationsaufwand und sind natürlich auch unterschiedlich leistungsfähig.
Rein historisch wurde in vielen Fällen nicht mit FrameMaker+SGML gearbeitet und die
Ansprüche der Anwender (und Medien-Nutzer) gingen über das hinaus, was »Sichern als
HTML« oder WebWorks Publisher Standard Edition zu leisten vermochten; das heißt,
die kostenlosen Lösungen reichten nicht aus. Das Vorhandensein der Standard Edition
verschaffte der Professional Edition den entscheidenden Vorteil in der Gunst der Käufer
gegenüber MIF2Go.
WebWorks Publisher Professional Edition (WWP) ist der Industriestandard, wenn es um
die Konvertierung von FrameMaker-Dokumenten in Online-Formate geht. Ob das
neueste Produkt von eHelp daran viel ändern kann, muss man abwarten.
Print
FrameMaker
Online-Hilfe
MIF-Datei
HTML Help
Workshop
WebWorks
Publisher
Abb. 1: Single-source Publishing-Prozess mit FrameMaker und WebWorks Publisher
CD
Onlinehilfe aus FrameMaker-Dokumenten – was kommt nach WebWorks Publisher?
3/5
Prinzipielle Schwächen der Prozesse mit WebWorks Publisher
Der WWP-Konvertierungsprozess wird durch die in den Dokumenten vorhandenen
Absätze gesteuert. Jedem Absatzformat wird während der Konfiguration ein Makro
zugeordnet (»mapping«), dass die Verarbeitung der Absatzinhalte steuert.
Daraus folgt: Makros, die keinem tatsächlich vorkommenden Absatzformat zugeordnet
sind, werden nicht ausgeführt. Und natürlich auch: Absatzformate, die keinem Makro
zugeordnet sind, verursachen Konvertierungsfehler, die sich im einfachsten Fall nur
durch eigenartige Schriftarten, -größen und Einzüge bemerkbar machen, genauso gut
aber auch den Aufbau von Listen oder das Seitenlayout zerstören können.
Technische Qualität von Dokumenten
Die Qualität der Konvertierung hängt direkt von der »technischen Qualität« der
Ausgangsdokumente ab. Und wenn die Dokumentation einmal einen gewissen Umfang
angenommen hat, die Anzahl der beteiligten Redakteure weiter wächst (rein
mengenmäßig oder durch Fluktuation) nehmen die Varianten in den Dokumenten fast
zwangsläufig zu.
Die herkömmlichen Qualitätssicherungsprozesse im redaktionellen Umfeld kümmern
sich stark um die inhaltliche Qualität der Werke, aber die Verwendung falscher
Absatzformate kann eben nicht anhand eines Ausdrucks oder in einer PDF-Datei erkannt
werden.
Was bei 200 Seiten dann nur lästig ist, wird bei 1000 oder mehr Seiten »mission critical«,
wenn nach der Übersetzung der Dokumente in elf Sprachen, dann binnen eines Tages in
12000 Seiten ggf. technische Korrekturen durchgeführt werden müssen, um eine saubere
Konvertierung zu ermöglichen.
Textersetzungsmaschine
Zwar wird WWP auch für die Konvertierung nach XML beworben, das Ergebnis ist aber
weit entfernt von dem, was z.B. für das Einspielen in Content Management-System oder
den Datenaustausch benötigt wird. Zudem bietet das Produkt auch keine Möglichkeiten
zur Validierung, d.h. ob eine HTML- oder XML-Ausgabe überhaupt standardkonform
(oder auch nur korrekt formatiert) ist, liegt vollständig in den Händen der Person, die
einen solchen Konverter konfiguriert. WWP ist eine – zugegebenermaßen ziemlich
leistungsfähige – »programmierbare Textersetzungsmaschine«.
Vorteile beim Arbeiten mit FrameMaker 7 (Strukturiert)
Die technische Qualität von Dokumenten kann durch strukturiertes Arbeiten mit
FrameMaker 7 (Strukturiert), d.h. arbeiten auf Basis einer EDD (Element Definition
Document) gewährleistet werden, da dadurch die Formatierung automatisch erfolgt und
auch nur die vorgesehenen Kombinationen von Elementen zu gültigen Dokumenten
führen. Und die Gültigkeit ganzer Bücher lässt sich einfach prüfen.
Zudem können die Inhalte der so erfassten Dokumente jetzt auch als XML-Dateien
gespeichert werden, und zwar nicht nur »well-formed« sondern »valid«, basierend auf
CD
Onlinehilfe aus FrameMaker-Dokumenten – was kommt nach WebWorks Publisher?
4/5
einer entsprechend der EDD entwickelten DTD (Document Type Definition). Und damit
öffnet sich der Horizont für eine Vielzahl von neuen Möglichkeiten rund um den XMLStandard, von denen die Dokumenttransformation mit XSL-Stylesheets nur eine ist;
wenngleich die, die uns hier am meisten interessiert.
Und nicht zuletzt ermöglicht das Zusammenfassen der bislang getrennten Produktlinien
FrameMaker und FrameMaker+SGML in einer Version auch Anwendern, die bislang
ausschließlich ohne EDD gearbeitet haben, den Zugang zu strukturierten Lösungen ohne
ein weiteres Update kaufen zu müssen.
Medienerstellung mit DocFrame
Die Entwicklung einer strukturierten Anwendung für FrameMaker ist normalerweise mit
nicht unerheblichen Anfangskosten verbunden, da DTD und EDD sowie die
Umsetzungsregeln zusätzlich zum formalen Layout entwickelt werden müssen, wobei die
Projektkosten ohne weiteres fünf- oder sechsstellig werden können und Monate ins Land
gehen, bevor produktiv geschrieben werden kann. Natürlich ist auch die Transformation
in die gewünschten Online-Medien zu lösen.
Scriptorium Publishing bietet seit Januar 2003 eine derartige strukturierte Anwendung
als Brachenlösung für die Erstellung von Benutzerhandbüchern und Onlinehilfen an, und
erspart dem Anwender damit diese Anfangskosten.
Was bietet DocFrame und was fehlt
DocFrame enthält alle Komponenten, die FrameMaker für eine strukturierte Anwendung
benötigt und darüber hinaus auch bereits vorgefertigte XSL-Transformationsregeln für
die Konvertierung nach HTML und für die Konvertierung nach MS HTML Help, dem
meistverwendeten Onlinehilfeformat auf Windows-Plattformen.
•
DTD für Bedienungsanleitungen (»UserGuide«)
•
Template mit Absatz-, Zeichen-, usw. -Formaten, dass auch ohne XML-Kenntnisse
angepasst werden kann
•
EDD, welche die Formate des Template zur Formatierung verwendet
•
Lese- und Schreibregeln für den XML-Import und -Export
•
XSL-Stylesheets zur Erstellung von HTML und MS HTML Help (CHM)
•
Dokumentation in englisch
Aber selbst mit diesem technisch vollständigen Paket bleiben konkret noch einige Dinge
zu tun. Bitte schätzen Sie selbst ab, wie wenig aufwendig die folgenden Aufgaben
gegenüber dem Neuerstellen der obigen Komponenten sind.
•
Die Einstellung für die generierten Verzeichnisse des Template müssen ggf. noch an
den deutschen FrameMaker angepasst werden
•
Sie müssen das Template an Ihr gewünschtes Layout anpassen
•
Sie müssen das HTML/CHM-Layout an Ihre Vorstellungen anpassen
CD
Onlinehilfe aus FrameMaker-Dokumenten – was kommt nach WebWorks Publisher?
•
5/5
Es wäre schön, wenn die Erstellung der Onlinemedien nicht aus mehreren Schritten
unter Einbeziehung von Kommandozeilenaufrufen bestehen würde
•
Es wäre ggf. schön, wenn es Dokumentation und Support auch auf deutsch gäbe
All diese Punkte sind aus Sicht von Scriptorium Publishing Aufgaben, die ein im deutschen
Sprachraum befindlicher Vertriebspartner (»Value Added Reseller«) am besten lösen
kann. Für Informationen dazu besuchen Sie bitte <http://docframe.de>
Zusammen mit den Integrationstools ergibt sich dann ein Produktionsprozess, der dem
eigentlichen Ziel des Single-source Publishing ohne Umwege entspricht.
Print
FrameMaker (Strukt.)
Sichern als XML
XML-Datei
(W3C Standard)
Online-Hilfe
HTML Help
Workshop
XSL-Transformation
(z.B. Open Source)
Abb. 2: Single-source Publishing-Prozess mit FrameMaker/DocFrame und XSLT
Die wesentlichen Unterschiede zur Lösung mit WWP sind:
•
Die technische Qualität der Dokumente ist gegeben.
•
Die Verarbeitung erfolgt mit Standard-Formaten und -Tools, d.h. die Prozesse sind
auch unabhängig von FrameMaker einsetzbar (z.B. mit anderen XML-Editoren).
•
Die Tools sind oft günstiger und das Know-how ist breit verfügbar.
Praktische Erfahrungen
Der Redaktionsschluss des Tagungsbands ermöglicht es leider nicht, hier schon über
praktische Erfahrungen zu berichten, dies wird allerdings Bestandteil des Vortrags sein.
Rückfragen?
Für Rückfragen erreichen Sie den Autor unter <[email protected]>
CD