Suchen

Von Word nach XML in vier Schritten

Alles beginnt mit ein paar Seiten in Word, einem kleinen, überschaubaren Handbuch. Doch innerhalb weniger Jahre wächst der Umfang dieses Handbuchs auf mehrere Hundert Seiten, es kommen Produktvarianten und neue Produkte hinzu. Viele technische Redaktionen entscheiden sich ab diesem Zeitpunkt, von Word auf XML-basierte Dokumentation umzusteigen. Dabei kommt oft strukturierter FrameMaker als Bearbeitungsprogramm zum Einsatz. Doch wie wandeln Sie Word-Dokumente mit Hunderten von Seiten schnell und sicher in XML-basierte Dokumente für strukturierten FrameMaker um?

Schritt 1: Word-Formatvorlagen verwenden

Gute Technische Dokumentation in Word arbeitet mit Formatvorlagen. Gerade bei gewachsenen Dokumentationen sind jedoch schnell unterschiedlichste Formate im Umlauf, sodass man leicht den Überblick verliert. Zudem zeigen sich oft auch persönliche „Handschriften" der einzelnen Technischen Redakteure. Während der eine zum Beispiel Zwischenüberschriften verwendet, nutzt der andere Hervorhebungen. Hier helfen ein Redaktionsleitfaden sowie das Vier-Augen-Prinzip beim Korrekturlesen. Wenn alle Dokumente einheitlich formatiert sind, ist es einfacher, den Weg nach XML zu gehen.

Schritt 2: Word-Dokumente in FrameMaker überführen

Zunächst müssen in einer FrameMaker-Vorlage ebenfalls Formatvorlagen angelegt werden. Denn was für Word gilt, gilt auch für FrameMaker: Formatvorlagen sind wichtig für eine gute Dokumentation und notwendig für den Weg nach XML. Um ein Formate-Chaos zu vermeiden, bietet es sich an, die Formate in Word und FrameMaker gleich zu benennen. In diese vorbereitete FrameMaker-Vorlage importieren Sie die Inhalte aus Word. So werden aus den Word-Dokumenten unstrukturierte FrameMaker-Dokumente, die komplett formatiert sind.

Schritt 3: Aus Formaten werden XML-Elemente

Bevor die Dokumente in XML gewandelt werden können, muss die XML-Struktur feststehen. Für diesen Schritt ist fundiertes Wissen im Bereich XML und DTDs notwendig: Verwenden Sie DITA, DocBook, PI-Mod oder eine angepasste DTD? 

Über die FrameMaker-Konvertierungstabelle ordnen Sie den Formaten entsprechende XML-Elemente zu. Die Konvertierungstabelle ist ein FrameMaker-eigenes Werkzeug, um strukturierte Dokumente zu erzeugen. Aus dem Format „Überschrift 1" wird zum Beispiel das Element . Etwas kniffliger wird es bei der Verschachtelung von Elementen, zum Beispiel bei Listen mit untergeordneten Listen. Über die richtige Reihenfolge beim Zusammenstellen der Elemente kann man aber auch solche Verschachtelungen abdecken. Auf diese Weise ermöglicht es die FrameMaker-Konvertierungstabelle, Dokumente allein auf Basis von Formaten in XML umzuwandeln.

Schritt 4: Die Konvertierung nach XML

Nun ist das Ziel fast erreicht: Mit der Konvertierungstabelle erhalten Sie mit wenigen Klicks ein XML-Dokument. Jetzt zahlt sich die professionelle Vorbereitung aus. Denn im Idealfall ist das ursprüngliche Word-Dokument so gut formatiert, dass kaum Nacharbeiten notwendig sind. Aufwändiger ist die Handhabung von Querverweisen oder Referenzen auf Grafiken. Die in diesem Fall notwendigen manuellen Nacharbeiten können bei Bedarf durch ein XSLT-Skript automatisiert werden. Auf diese Weise können Sie schnell und sicher Dokumente nach XML speichern.

Redaktionsalltag mit Konvertierungsprozess

Der Grundstein für einen reibungslosen Konvertierungsprozess ist gelegt, wenn Ihre Dokumente alle sauber formatiert sind. Hilfreich ist es, wenn Sie im Unternehmen vorbereitete Word-Vorlagen verwenden. So ist es zum Beispiel möglich, bestimmte Formate zu sperren und nur die gewünschten Formate freizugeben. Dies ist praktisch, wenn Sie Word-Dokumente aus anderen Abteilungen als Input erhalten und damit in FrameMaker weiterarbeiten möchten. Die Abteilungen können Informationen wie gewohnt in Word erfassen.

Beispiel: Die Entwicklungsabteilung beschreibt Änderungsanforderungen wie gewohnt in Word. Die Technische Redaktion wendet auf diese Dokumente die Konvertierungstabelle an und konvertiert die Dokumente mit wenigen Klicks oder sogar automatisiert in XML.

Damit eignet sich dieses Verfahren sowohl für die einmalige Konvertierung vieler Dokumente als auch für häufig wiederkehrende Konvertierungsarbeiten.

Kommentar schreiben


« Zurück zur Übersicht
  • facebook
  • linkedin
  • xing