Was aber, wenn man Code in einem Textverarbeitungsprogramm wie Microsoft Word dokumentiert?

Den Quelltext als einfarbige, schwarze Bleiwüste in das Dokument zu kopieren, Screenshots der Entwicklungsumgebung einzufügen, oder den Code gar von Hand einzufärben, sind sicherlich nicht die besten Lösungen.

Abhilfe schafft die Freeware Highlight Code Converter von André Simon (für Windows und verschiedene Linux-Distributionen), die eine Vielzahl von Programmier- und Auszeichnungssprachen mit beliebig anpassbaren Farbschemata kennzeichnet, und das formatierte Ergebnis unter anderem als HTML, RTF oder LaTeX ausgibt.

Für die Arbeit mit Word ist vor allem die Ausgabe als RTF (Rich Text Format) hilfreich, einem von Microsoft entwickelten Dateiformat für Texte, das Word von Haus aus unterstützt. Aktiviert man die Option, den Quelltext mit Formatvorlagen zu versehen (Registerkarte Format-Optionen, Kontrollkästchen Zeichenvorlagen), kann man auch noch nachträglich in Word das Farbschema der Syntaxhervorhebung an seine Wünsche anpassen.

In diesem Paket vereint der Hersteller Adobe alle Programme, die man zum Erstellen Technischer Dokumentation braucht, sofern man kein ausgewachsenes Redaktionssystem wie Cosmia, SCHEMA ST4, TCToolbox oder TIM-RS einsetzt.

Mit FrameMaker kann der Redakteur umfangreiche Handbücher bearbeiten, die Acrobat als PDF speichert. RoboHelp erzeugt Online-Hilfen. Photoshop dient zur Grafikbearbeitung, Captivate zeichnet Software-Demos auf und macht E-Learning-Anwendungen möglich.

Diese Funktionsvielfalt hat natürlich ihren Preis: knapp 2.260 Euro für die Vollversion der Suite.

Seit einigen Tagen stellt Adobe auf seiner Website eine 30-Tage-Testversion zum Download bereit (5 GB; Registrierung erforderlich).

[Via CAP-Studio]

Bibliographie-Informationen über Autor, Buchtitel usw. werden dabei in XML-Elementen in den Word-Dateien abgelegt. Word-Dokumente setzen seit der Version 2007 das Format Office Open XML ein – erkennbar an der Dateiendung .docx.

Das eigentliche Literaturverzeichnis wird von einem XSLT-Skript für den jeweils gewählten Bibliographiestil erstellt; Microsoft nennt diese Funktion auch Literaturverzeichnis-Formatvorlage.

Alle verfügbaren Stil-Skripte und damit Vorlagen liegen im Ordner %program files%\Microsoft Office\Office12\Bibliography\Style.

Die mitgelieferten Skripte sind sehr komplex und eignen sich nicht, um sie mit Grundkenntnissen in XML und XSLT auf die Zitierregeln der eigenen Hochschule oder Organisation anzupassen.

Diesen Missstand beseitigt BibWord von Yves Dhondt, ein einfach anpassbares XSLT-Skript für Word 2007 samt umfangreicher Konfigurationsanleitung (auf Englisch), das kostenlos von Microsofts Open-Source-Plattform CodePlex heruntergeladen werden kann.

Wem das zuviel Aufwand ist, der kann mit der Shareware Zitierstil-Creator eigene Zitierstile auf einer grafischen Benutzeroberfläche zusammenklicken.

Unter Dateien gibt es eine Literaturverzeichnis-Vorlage für die Zitier- und Bibliographie-Regeln des Studiengangs Technische Redaktion an der Hochschule Karlsruhe nach Prof. Drewer, die auf BibWord aufbaut.