Hinweise zum Erstellen eines Technischen Berichts

Am 20. Juni 2011 wurde der Berichtsreihe folgende ISSN zugeteilt: ISSN 2192-6247 Die Veröffentlichung Technischer Berichte ist grundsätzlich mit dem Leiter der Arbeitsgruppe abzustimmen und erfolgt durch das Institut in Form von PDF-Dateien im Format A4 oder in gedruckter Form als A5-Heftchen. Der Bericht kann mit einem beliebigen Programm erstellt werden, nur das Titelblatt ist vorgeschrieben.

Die Dateigröße des Berichtes ist auf max. 25 MB begrenzt.

Seitenlayout

Die Berichte müssen im PDF-Format in A4 abgegeben werden, sie sollen allerdings auch noch gut lesbar sein, wenn sie für den Druck auf A5 verkleinert werden. Es gibt zwei Ansätze, wie dies zu erreichen ist.

  • Der Bericht wird in A4 mit einer großen Schrift (12pt) und entsprechend vergrößerten Abbildungen entworfen und so abgegeben. Dieser Weg ist einfach, insbesondere, wenn das Dokument bereits vorhanden ist, liefert aber nicht die bestmögliche Qualität.
  • Der Bericht wird komplett in A5 erstellt und für die Abgabe auf A4 vergrößert. Auf diese Weise wird die bestmögliche Qualität erreicht.

 

Das Deckblatt

Die Gestaltung des Deckblattes ist vom Institut vorgegeben. Es existieren LaTeX-Vorlagen für A4 und A5, die nur noch ausgefüllt werden müssen. Das Deckblatt muß dabei als eigenständiges Dokument übersetzt werden, es ist nicht möglich, den Rest des Berichtes mit in die Datei zu schreiben. Stattdessen werden vor der Abgabe die beiden Teile zu einer PDF-Datei vereinigt.

 

Diese Vorlagen enthalten das vorgeschriebene Deckblatt und eine Titelseite, die nach Belieben des Autors/ der Autorin auch weggelassen oder durch eine vergleichbare ersetzt werden kann. Hier finden Sie die für das Deckblatt erforderliche  Albertina

Vorgehensweise


  1. Zunächst wird eine Nummer für den Bericht im Geschäftszimmer angefordert. Diese Nummer kommt später auf das Deckblatt, und der Bericht wird auch unter dieser Nummer veröffentlicht.

  2. Soll der Bericht in A4 oder A5 erstellt werden? Diese Entscheidung muß einmal getroffen werden und gilt dann für Deckblatt und den Bericht gleichermaßen.

  3. Danach wird das Deckblatt basierend auf den oben angegebenen Vorlagen erstellt und mit LaTeX in eine DVI-Datei übersetzt. Dies gilt auch dann, wenn der eigentliche Bericht in einem anderen Format erstellt wird. Die DVI-Datei wird dann vor dem Zusammenfügen in das Format des Berichtes konvertiert.
  4. Der Bericht wird im selben Papierformat wie das Deckblatt erstellt, wobei die Schriftgröße entsprechend angepaßt sein muß, also bei LaTeX mit

    • \documentclass[a5paper,10pt]{...} bei A5 und
    • \documentclass[a4paper,12pt]{...} bei A4.

  5. Bei anderen Programmen sind Papierformat und Schriftgröße entsprechend einzustellen. Der Bericht wird in einem der Formate DVI, PS oder PDF erstellt.
  6. Für die Veröffentlichung müssen Deckblatt und Bericht zu einer PDF-Datei zusammengefügt werden. Mehr dazu steht weiter unten auf dieser Seite.
  7. Der fertige Bericht wird per E-Mail an Ina Pfannschmidt geschickt. Dabei müssen noch die folgenden Angaben gemacht werden.

    • Nummer des Berichtes
    • Autor/in(en/innen)
    • Titel
  8. Zusammenfassung: bitte in ASCII oder, falls Formeln enthalten sind, in TeX-Notation. Unterstützt wird die Darstellung durch MathJax. Die von MathJax unterstützten LaTeX-Kommandos gibt es hier.

    • Schlüsselwörter
  9. Dem Institut muß das Recht zur elektronischen Verbreitung des Berichtes übertragen werden. Dazu ist eine schriftliche Einverständniserklärung erforderlich (PS, PDF), die unterschrieben im Geschäftszimmer abzugeben ist.

 

Zusammenfügen der fertigen Dateien

Vor der Abgabe werden das Deckblatt und der Bericht zusammengeführt, bei Bedarf auf A4 skaliert und in eine PDF-Datei konvertiert. Der genaue Weg hängt davon ab, in welchem Dateiformat der Bericht vorliegt. 

DVI-Format

Wenn die zweite Seite der Titelvorlage nicht mit in den Bericht aufgenommen werden soll, kann das Deckblatt mit

  • dviselect -i titel.dvi -o deckblatt.dvi 1

 

in die Datei deckblatt.dvi extrahiert werden. Deckblatt und Bericht werden zu einer Datei vereinigt, Dateien im Format A5 werden gleichzeitig auf A4 skaliert.

  • dviconcat -o gesamt.dvi deckblatt.dvi filename.dvi (für A4)
  • dviconcat -m 1440 -o gesamt.dvi deckblatt.dvi filename.dvi (für A5)

 

In einem letzten Schritt wird die DVI-Datei in PDF konvertiert.

  • dvipdf gesamt.dvi gesamt.pdf

PS-Format

Wenn die zweite Seite der Titelvorlage nicht mit in den Bericht aufgenommen werden soll, kann das Deckblatt mit

  • dviselect -i titel.dvi -o deckblatt.dvi 1

in die Datei deckblatt.dvi extrahiert werden. Das Deckblatt wird dann in das PS-Format konvertiert.

  • dvips -Ppdf -ta4 -o deckblatt.ps deckblatt.dvi (für A4)
  • dvips -Ppdf -ta5 -o deckblatt.ps deckblatt.dvi (für A5)

 

Deckblatt und Bericht lassen sich in jetzt in eine Datei zusammenführen.

  • psmerge -o gesamt.ps deckblatt.ps bericht.ps

Handelt es sich um einen Bericht im Format A5, muß er jetzt auf A4 skaliert werden.

  • psresize -Pa5 -pa4 gesamta5.ps gesamta4.ps

 Zuletzt wird die Datei in PDF konvertiert.

  • ps2pdf gesamt.ps

PDF-Format

Wenn die zweite Seite der Titelvorlage nicht mit in den Bericht aufgenommen werden soll, kann das Deckblatt mit

  • dviselect -i titel.dvi -o deckblatt.dvi 1

in die Datei deckblatt.dvi extrahiert werden. Das Deckblatt wird dann in zwei Schritten in das PDF-Format konvertiert.

  •  dvips -ta5 -o deckblatt.ps deckblatt.dvi (für A5)
  • dvips -ta4 -o deckblatt.ps deckblatt.dvi (für A4)
  • ps2pdf deckblatt.ps deckblatt.pdf (beide Formate)

 

Deckblatt und Bericht werden mit dem Programm texexec vereinigt und bei Bedarf auf A4 skaliert. Dazu ist eine relativ neue Version von texexec erforderlich, wie sie zum Beispiel allen aktuellen TeX-Distributionen beiliegt.

  • texexec --batch --silent --pdfarrange --result=gesamt.pdf deckblatt.pdf bericht.pdf

Einbinden des Titelblattes in das Hauptdokument

Das Titelblatt kann man auch direkt in das Dokument einbinden mit

\usepackage{pdfpages}
...
\begin{document}
...
\includepdf[nup=1x1,pages=-]{report-0603-title.pdf}

Gebundene Exemplare

Falls von dem Bericht dennoch gedruckte und gebundene Exemplare erwünscht sind, so ist die Auflage und Kostenübernahme mit dem Leiter der Arbeitsgruppe abzustimmen und die Bestellung wie bisher im Geschäftszimmer abzugeben. Bestellformulare sind dort erhältlich.