University of Bielefeld Faculty of Technology Joern Clausen  

Homepage
Education
Development
Documents
Links
Contact
Weblog

Technical Reports der TechFak - Admin Guide

Die Technische Fakultät gibt seit vielen Jahren Technical Reports heraus. Traditionell werden solche Reports in der Informatik mit dem Schriftsatzprogramm LaTeX erstellt, aber auch andere Software wie Word, Star-/Openoffice u.ä. kommt zum Einsatz. Einerseits sollen alle Reports ein halbwegs einheitliches Layout haben, andererseits sollen die Autoren in der Wahl ihres Textprogramms nicht eingeschränkt werden.

Zum einheitlichen Layout gehört ein Titelblatt, auf dem Logo und Siegel der Universität Bielefeld erscheinen. Im Impressum werden als Herausgeber die Professoren der Technischen Fakultät (bzw. der Abteilung Informationstechnik) genannt. Abgeschlossen wird ein Report durch eine Liste der bisher veröffentlichten Reports.

Das Impressum muss nach personellen Veränderungen angepaßt werden, die Liste der bisher erschienen Reports muß nach jeder Veröffentlichung auf den aktuellen Stand gebracht werden. Da keine personellen Ressourcen zur Verfügung stehen, diese Dinge, angepaßt an die verschiedenen Textverarbeitungssysteme, auf einem aktuellen Stand zu halten und bei Bedarf zügig an die Autoren der Reports zu verteilen, kam nur eine zentralisierte Lösung in Frage. Titelblatt und Abschlußliste werden zentral erstellt und an den Autor geschickt. Dieser kann daraus in Kombination mit seinem Text einem vollständigen Report erstellen. Dazu benötigt er lediglich ein frei erhältliches (Open Source) Werkzeug, das auf den Rechnern der Technischen Fakultät installiert ist.

Arbeitsschritte des Report-Betreuers

Die Liste aller Reports wird als eine XML-Datei gepflegt. Wird ein neuer Report erstellt, werden die relevanten Daten (Titel, Autor(en), Report-Nummer) in diese Datei eingetragen. Dieser Vorgang dauert lediglich wenige Augenblicke. Ein einzelner Eintrag hat folgende Form:

          
  <report id="2002-01" issued="2002">
    <title>Persistent Objects with O2DBI</title>
    <authors>
      <author>Jörn Clausen</author>
    </authors>
  </report>
        

Durch ein XSLT-Skript wird daraus eine LaTeX-Datei erstellt. Diese enthät einerseits das Titelblatt mit den genannten Daten, andererseits die oben beschriebene Liste aller vorhergehenden Reports. Sollte die Liste bereits weitere Arbeiten enthalten, wird sie unmittelbar vor dem aktuellen Report abgeschnitten, so daß sie keine Arbeiten "in der Zukunft" enthält. Durch ein weiteres XSLT-Skript kann man eine HTML-Datei erzeugen, die eine Liste aller bisher erschienen Reports enthält.

Anschliessend kann man mit LaTeX und dem Programm dvips eine PostScript-Datei (PDF-Version) erzeugen. Die (relativ) statischen Informationen (ISSN-Nummer, Liste der Professoren) befindet sich in einer Stil-Datei, die auch das eigentliche Layout der Titelseite und der Report-Liste festlegt. Die PostScript-Datei wird anschliessend in zwei Teile geteilt: Die beiden ersten Seiten (PDF-Version), also das Titelblatt, und die restlichen Seiten (PDF-Version).

Der gesamte Ablauf wird durch ein sog. "Makefile" gesteuert. Nachdem der Betreuer die XML-Datei erweitert hat, muß er lediglich den Befehl

          make 2002-01.ps        
eingeben. Dadurch werden alle oben beschriebenen Arbeitsabläufe automatisch angestossen. Nach wenigen Augenblicken liegen die Dateien 2002-01.ps , 2002-01.ps-front und 2002-01.ps-back vor, die an den Autor weitergereicht werden können.

Arbeitsschritte des Report-Autors

Nachdem der Autor seinen Report mit einem Textprogramm seiner Wahl erstellt hat, bittet er den Report-Betreuer um Zuweisung einer Report-Nummer. Dabei übermittelt er den Titel und die Liste der Autoren. Nachdem der Betreuer die oben geschilderten Arbeitsschritte durchgeführt hat, erhält der Autor zwei PostScript-Dateien zurück. Diese kann er z.B. mit Hilfe des frei erhältlichen Programms Ghostscript gemeinsam mit seinem Report zu einer PDF-Datei verknüpfen. Einzige Voraussetzung ist, daß sein Report ebenfalls als PostScript-Datei vorliegt. Dieses Format läßt sich in der Regel mit jedem beliebigen Textprogramm erstellen.

Der Befehl, um die drei Dateien (Titel, Report, Liste) zu einer gemeinsamen PDF-Datei zu kombinieren lautet

        cat 2002-01.ps-front otwodbi.ps 2002-01.ps-back | ps2pdf -sPAPERSIZE=a4 - > otwodbi.pdf      
Die dabei enstehende Datei otwodbi.pdf enthält den vollständigen Report, der gedruckt oder z.B. per Web veröffentlicht werden kann. Natürlich können die drei Einzelteile auch mit anderen Programmen zusammengesetzt werden, z.B. kommerzieller Software der Firma Adobe.

Wie an diesem Beispiel zu erkennen ist, kann der Inhalt stilistisch vom Titel abweichen. Dies ist mit den zur Verfügung stehenden Ressourcen kaum anders zu regeln, bzw. besteht auch garnicht der Wunsch, dies zu tun.


Jörn Clausen
created: 2004-08-17 / last modified: 2004-08-17