TU BRAUNSCHWEIG
| Carl Friedrich Gauß Faculty | Department of Computer Science
Informatikzentrum

DO's and DONT's for your theses

AuthorRobert Hartung
KeywordsIBR Thesis Theses Bachelorthesis Masterthesis

DO's

Zitieren

Zitiert wird in LaTeX mit dem Befehl \cite. Dieser setzt je nach Einstellung eine Referenz an die aktuelle Stelle. Üblicherweise nennt man die Autoren im Text um eine Arbeiten zu zitieren:

Wolf und Kulau~\cite{bibref} haben in eine neue Methode vorgestellt.

Die Tilde (~) sorgt dabei dafür, dass die Referenz direkt am vorangegangen Wort platziert wird.

Bei mehr als drei Autoren verwendet man üblicherweise nur den ersten Autor zusammen mit dem Kürzel "et al.". In LaTeX kann man hierfür den Befehl \citet verwenden:

\citet{bibref} betrachten den Energieverbrauch von Systemen unter kosmischer Sonneneintrahlung.

Für \citet{} benötigt man zusätzlich noch natbib:

\usepackage[numbers]{natbib}
...
\begin{document}
...
\bibliographystyle{plainnat}
\bibliography{literature}

In unseren LaTeX Vorlagen nutzen wir hingehen das moderne biblatex Paket:

\usepackage[clearlang=true, language=english, safeinputenc, natbib=true, citestyle=numeric, bibstyle=numeric, defernumbers=true, maxbibnames=10, maxcitenames=1]{biblatex}
\addbibresource{literature.bib} % achtung: mit .bib
...
\begin{document}
...
\printbibliography

Verweise von Abschnitten, Grafiken und Tabellen

Um den Textfluss zu erleichtert, ist es sinnvoll auf andere Abschnitte oder Bestandteile einer Arbeit zu verweisen. Um im Text auf andere Abschnitte zu Verweisen benötigt man ein sogenanntes Label. Dieses setzt man direkt nach der Überschrift:

\section{Einleitung}\label{sec:einleitung}

Danach kann man entweder mit \ref{sec:einleitung} auf die Kapitelnummer verweisen, oder aber direkt mit \autoref{} aus dem Paket hyperref referenzieren. Dieser Befehl funktioniert auch für Tabellen und Grafiken und setzt der Kapitel- oder Abbildungsnummer automatisch den richtigen Typ voran:

\autoref{table:tabelle}

führt somit zu

Tabelle 1.2

Vorraussetzung hierfür ist die Verwendung des babel Pakets mit korrekter Option:

\usepackage[ngerman]{babel}

Während dem Schreiben werden alle Referenzen mit einem roten Rand dargestellt. Für die Abgabe daher unbedingt die Option hidelinks verwenden, um diese auszublenden:

\usepackage[hidelinks]{hyperref}

RFCs referenzieren

Zum Referenzieren von RFC Standards gibt es eine Export-Funktion unter https://datatracker.ietf.org/doc/.

Abbildungen

Abbildungen werden wie folgt eingebunden und sollten immer ein Label und eine Unterschrift bekommen:

\begin{figure}
  \centering
  \includegraphics[width=\linewidth]{pfad/zur/abbildung}
  \caption{Schematische Darstellung des Systems}
  \label{fig:system_aufbau}
\end{figure}

Beschriftungen

Die x und y Achsen sollten sinnvoll mit mit Einheiten beschriftet werden.

Skalierung

Abbildungen sollten so skaliert werden, dass alle relevanten Details sichtbar sind. Zudem sollte eine Legende vorhanden sein, falls mehrere Linien o.ä. zu sehen. Überschüssiger Freiraum sollte entfernt werden. Zudem sollten Grafiken möglichst groß dargestellt werden.

Bei Abbildungen sollte unbedingt

\linewidth beschreibt im Gegensatz zu \textwidth die Breite im aktuellen Element. Dies ist hilfreich, falls mehr als eine Spalte verwendet wird und ist daher bevorzugt zu verwenden.

Auf die Endung kann verzichetet werden

Worttrennung

Manchmal ist es notwendig Worte manuell zu trennen, da diese sonst über den Seitenrand hinausragen.

hyphenation

Kurze Überschriften

Bei zu langen Überschriften passt der pagehead nicht mehr. Daher sollten hierfür kurze Überschriften für Kapitel verwendet werden.

\chapter{Langform}
\chaptermark{Kurzform}

Abkürzungen

Das acronym Paket ermöglicht es automatisch Abkürzungen zu definieren. Möchte man keine Liste (wie beispielsweise im Exposé) so gibt es die nolist Option:

\usepackage[nolist]{acronym}

DONT's

Keine Überschriften ohne Text

Besonders neue Kapitel sollten kurz eingeleitet werden, sei es nur durch wenige Sätze.

Keine unreferenzierten Abbildungen

Weder Tabellen noch Grafiken sollten unreferenziert sein. Es sollte mindestens eine Referenz und eine Beschreibung der Inhalte vorhanden sein.


last changed 2019-07-02, 14:18 by Robert Hartung
printemailtop