Table of Contents

• Use LaTeX and the KCSS Style
• Use Git
• Editor/IDE
• The ToDo Package
• The Bibliography
  • Work Within the RTSYS Domain
  • Work Outside the RTSYS Domain
  • Accessing the Git-Repository of the BibTeX Files
• Publishing the thesis on-line
• Source Code

Use LaTeX and the KCSS Style

Before you do anything else for your thesis work, you should get the technical issues for writing your thesis out of the way. Ie, you should create a git repository for your thesis, familiarize yourself with LaTeX and the KCSS style, and adapt/fill in the KCSS thesis template for your needs. This way, you can fill your thesis with contents as you work along on your thesis topic, instead of keeping notes in various ways and having to consolidate it all later.

Use Git

Our shared repositories are managed with Git. The files associated with the thesis should be kept in the group's Git installation, as a separate repository that your advisor will create for you. The main purpose is to prevent loss of data, but it also facilitates access for fellow group members if needed, and to allow on-line publication. See also Using Git.

The main tex file for a thesis should be <name of repository>.tex (see also Git/Structure for the canonical naming scheme). E.g., the bachelor thesis of user xyz can be found in a repository named xyz-bt in the Theses project of our Stash system, in a file named xyz-bt.tex. If there is a talk to "defend" the thesis (Bachelor-Kolloquium, Disputation), the talk should also be included in this repository, and should be named <name of repository>-talk.tex (e.g. xyz-bt-talk.tex). In case your thesis should be made available on-line, the same names should be used, e.g., xyz.pdf.

See also the notes on preparing a paper, e.g. regarding which files should be kept in Git and which shouldn't.

Editor/IDE

Prof. von Hanxleden would recommend Emacs as a very flexible and powerful editor for LaTeX (and everything else). But probably you belong to a post-Emacs generation, so here are some alternatives: Hauke (haf) recommends Texlipse as an easy-to use and also powerful Eclipse plug-in. Christoph Daniel (cds) recommends using Kile, a KDE LaTeX editor that is fast, powerful, and reasonably easy to understand and to use. On Mac, TeXShop is a fine editor that looks a bitt dated on first glance, but works very well.

The ToDo Package

Es kommt häufig vor dass man sich während des Schreibens Anmerkungen zum Text machen oder Dinge später hinzufügen möchte. Damit dies einfacher zu verwalten ist, steht ein extra ToDo-Paket zur Verfügung. Mit diesem Paket lassen sich Platzhalter für Grafiken, Anmerkungen zum Text in verschiedenen Farben oder einfache ToDo-Kommentare mit Referenz zum Text schnell und unkompliziert realisieren. Eingebunden wird das Paket wie folgt.

 \usepackage{todonotes}

Eine kurze, detaillierte Anleitung kann man hier nachlesen:

 http://www.tex.ac.uk/tex-archive/macros/latex/contrib/todonotes/todonotes.pdf

The Bibliography

Zur Erstellung einer Bibliographie mit LaTeX ist das Beispiel-Dokument zu Rate zu ziehen. Die dort benutzte BibTeX-Datenbank cau-rt.bib wird Lehrstuhl-weit von Mitarbeitern und Studenten gemeinsam benutzt um Literatur-Daten zu sammeln und zu publizieren. Alle Literaturdaten, die in studentischen Arbeiten anfallen, müssen also in dieser Datei verwaltet werden. Wichtig: Bitte vermeiden Sie bibtex-Warnungen beim Hinzufügen von neuen Einträgen! Weitere Hinweise zur Beachtung finden sich hier

Das Erstellen eines deutschsprachigen Literaturverzeichnisses ist mit Hilfe des Paketes bibgerm und dem bibliographystyle gerplain möglich.

 \usepackage[ngerman]{babel}
 \usepackage{bibgerm}
  .
  .
  .
 \bibliographystyle{gerplain}

Links zu BibTeX:

•  BibTeX-Tutorial (Link ist tot)
•  Tame the BeaST - The B to X of BibTEX (Nicolas Markey)
•  Eine Auflistung von BibTEX Styles

Work Within the RTSYS Domain

Beim Arbeiten im Lehrstuhl-Netzwerk werden keine zusätzlichen Maßnahmen notwendig; der LaTeX-Zugriff auf die BibTeX-Datenbank ist automatisch über das Netzwerk gewährleistet. Für verändernde Zugriffe auf die Datenbank muss mit dem Versionsmanagement earbeitet werden.

Work Outside the RTSYS Domain

Beim Arbeiten außerhalb des Lehrstuhl-Netzes wird es notwendig, die Datenbank dem lokal installierten LaTeX-System zur Verfügung zu stellen. Eventuell muss die dazugehörige kpse-Datenbank reinitialisiert werden.

Accessing the Git-Repository of the BibTeX Files

Für Zugriff auf das Git-Repository der BibTeX-Datenbank ist folgender Befehl zu verwenden

git clone git@…:resources/bib.git

Nach dem Auschecken des Moduls bib steht die Datei cau-rt.bib zur Verfügung. Hinweise zur genauen Syntax sind dem Kopf der Datei und den Beschreibungen der BibTeX-Sprache zu entnehmen.

Publishing the thesis on-line

If your advisor has agreed that your thesis should be made available on-line, and you have signed your consent, then you can publish this as follows. Say your thesis is xyz-bt.pdf. ("bt" for Bachelor theses, "mt" for Master theses, "diss" for dissertations.) To upload this, use the command

scp xyz-bt.pdf biblio@…:/home/biblio/public_html/downloads/theses

If you don't have the right permissions to do this, ask your advisor or the System Administrator to publish this for you.

Then, check that your thesis is indeed available under the URL

 http://rtsys.informatik.uni-kiel.de/~biblio/downloads/theses/xyz-bt.pdf

Note: The name of this file should follow the canonical naming scheme used in subversion (Subversion/Structure ), even if your thesis is for some reason not in the subversion system.

Source Code

Von Ihnen im Laufe der Arbeit entwickelte Software (oder Hardware-Beschreibungen) sind Teil Ihrer Arbeit. Dies bedeutet: es sollte eine Übersicht über die Software in geeigneter Form gegeben werden, z.B. in Form von Klassendiagrammen mit Erläuterungen. Hinweise zum Einbinden von Code in LaTeX finden sich in dem Beispieldokument (s.o.).