Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Editor/IDE

Prof. von Hanxleden would recommend Emacs as a very flexible and powerful Latex editor. 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.

Using Git

Table of Contents

Table of Contents

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. That is, you should have your advisor 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'Git repositorys Git installation, as a separate repository that your advisor will create for you. The main purpose is to prevent loss of data. It , but it also facilitates access for fellow group members if needed, and to allow on-line publication.. If you haven't used Git yet, there's a few excellent introductions to be found on the internet, for example:

The main tex file for a thesis should be <name of directory>repository>.tex. See (see also Git/Structure for the canonical naming scheme). E.g. Eg, the bachelor thesis of user xyz can be found in a repository named xyz-bt in the Thesss Theses project of our  Gitorious systemour Bitbutcket 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 directory>repository>-talk.tex; eg (e.g. xyz-bt-talk.tex). In case your thesis should be made available on-line, the same names should be used, ege.g., xyz.pdf.

See also the notes on preparing a paper, eg e.g. regarding which files should be kept in revision management (ie, should be checked into 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:

  • On all platforms, including Mac, texmaker is a fine editor.
  • Atom and Sublime have plug-ins that provide LaTeX syntax highlighting and an integrated compilation workflow.
  • Kile is a LaTeX IDE which runs on KDE and is powerful and reasonably easy to understand and to use

The ToDo

...

Notes Package

When writing your thesis, you will often want to make a note of something you need to add or change. The todonotes package makes this easy. It lets you add placeholder graphics and notes in or next to the text. To include the package, add the following line to your document:

 \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:

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 entnehmenYou can find a short manual over here.

The Bibliography

Proper bibliographies in LaTeX are built using bibtex, which allows you to store information about publications in so-called bib files with identifiers that you can use to reference them from your main LaTeX document. In a desperate attempt to keep everything neat and tidy, we have a central bib Git repository which contains bib files we use and occasionally add to:

  • cau-rt.bib: The main database which contains publications we reference, but have not written ourselves.
  • pub-rts.bib: The database containing our own publications.
  • rts-arbeiten.bib: The database containing the theses produced by our students. Yes, we actually do reference those from time to time.

The recommended workflow is to clone that repository locally and tell bibtex that it can find bibliography databases there (google for BIBINPUTS). If you belong to our group's staff, feel free to add to the databases if you're missing a reference. If you are a student, the recommendation is that you collect the items you would add in a separate bib file in your thesis directory and merge those into cau-rt.bib at the end of your tenure.

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

...