12 KiB
A thesis LaTeX-template
This LaTeX-template might be used to write a scientific elaboration or a bachelor or master thesis at the Computer Science department at FernUniversität in Hagen. It is based on the fabulous ClassicThesis style template of Andre Miedé and the adaption of Prof. Dr. Michael von R"uden.
Table of contents
Configuration
The LaTeX template can be modified and configured easily using a very limited number of files, namely classicthesis-config.tex, fernuni-hagen-thesis-config.tex, and thesis.tex. Only use these three files to modify your LaTeX thesis. Please DO NOT modify the actual LaTeX code for your thesis (as this becomes quite complex and consumes a lot of time). Please finde a brief description of the various configuration options below:
thesis.tex
The thesis.tex file contains the basic structure and all the chapter-files that contain the actual content of your thesis. Thus, you have to modify this file in order to configure some basic stuff like the language of your thesis. The subsequent section "Adding content" explains how to add content.
Two-sided vs. one-sided
The default output of the LaTeX thesis template is a single-sided style that also has to be printed that way. In case you want to print two-sided, you have to add the twoside option in the \documentclass definition at line 35:
\documentclass[ openright,titlepage,numbers=noenddot,headinclude,twoside,%
footinclude=true,cleardoublepage=empty,abstractoff,%
BCOR=5mm,paper=a4,fontsize=11pt,%
ngerman,american,%lockflag%
]{scrreprt}
You may also adapt the paper size (paper=a4) and the font size (fontsize=11) if necessary.
Bibliographies
By default all bibliographies that can be referenced in the thesis are put into the bibliography.bib file in the root directory of the LaTeX sources. However, if you want to use additional bibliography files, you may add them to the bibliograph section (starting at line 47) in thesis.tex
%*************************************************************************
% Bibliographies
%*************************************************************************
\addbibresource{bibliography.bib}
.... ADD YOUR FILES HERE ...
Language
The default language of your thesis is German. If you want to switch to English, you have to modify the language selection from ngerman to american at line 63.
\selectlanguage{american} % ngerman, american
While this thesis template supports umlauts, i.e. ÄÖÜäöüß, in the main text of the thesis, there are some issues regarding umlauts on the title page (configured in the personal data at fernuni-hagen-thesis-config.tex). Please see the umlauts section for further details and possible solutions.
Table of content, figures, tables, listings, and acronyms
By default, the thesis templates prints a lot of table of content, i.e. for figures, tables, listings, and aconyms. You may want to remove such tables if you only have a very limited number, i.e. less then 3-5, of figures, tables, listings, and acronyms. Simply comment the related line in thesis.tex starting at line 81.
%\cleardoublepage\include{frontbackmatter/Figures}
%\cleardoublepage\include{frontbackmatter/Tables}
%\cleardoublepage\include{frontbackmatter/Listings}
%\cleardoublepage\include{frontbackmatter/Acronyms}
fernini-hagen-thesis-config.tex
The fernuni-hagen-thesis-config.tex-file allows to configure the usual stuff needed for a thesis. Namely, you can configure the title of your thesis, your name, the names of your supervisors, dates, etc. Thus, you MUST touch this file and configure it accordingly.
Personal data
This is where you have to place all the personal stuff of your thesis, starting at line 7.
Umlauts
This thesis templates supports German umlauts in the main text. However, if you need umlauts on the title page, say in your title, your name, and your professor's name, you have to use the native LaTeX way of writing umlauts. Please see the following table:
| Umlaut | LaTeX way |
|---|---|
| Ä | {\"A} |
| Ö | {\"Ö} |
| Ü | {\"Ü} |
| ä | {\"a} |
| ö | {\"o} |
| ü | {\"u} |
| ß | {\ss} |
To write the Title "TOR - Schießen mit Füßen" you have to write "TOR - Schie{\ss}en mit F{"u}{\ss}en".
classicthesis-config.tex
The classicthesis-config.tex-file allows you to configure stuff that comes with the classic-thesis style, like LaTeX packages used by classic thesis. This is quite advanced stuff already. Thus, you should touch this file only if you know what you are doing. Usually, you can leave the file as it is.
Usage
In the following, we explain how to actually use, i.e. add content and compile, the thesis template to create a nice and shiny PDF file that will please your supervisor.
Writing abstracts
Every thesis has to have two abstracts; one in German and one in English. Thus, there are two abstract files included in the thesis.tex-file. Boths files, called AbstractDE.tex for the German abstract and AbstractEN.tex for the English abstract, are located in the ./frontbackmatter/ directory.
You have to modify both these files and place your abstract text in AbstractDE.tex and AbstractEN.tex respectively.
Adding content
By default, the thesis template, i.e. the thesis.tex-file, contains (includes) some default content files for chapters and appendix from the ./chapters/examples/-directory (starting a line 94). You have to remove those includes and include your own files. Please note that it is best practice to put all your content in seperate files.
\cleardoublepage
\part{Thesis}\label{pt:thesis}
%\include{chapters/examples/chapter01}
%\include{chapters/examples/chapter02}
%\include{chapters/examples/chapter03}
... PUT YOUR INCLUDES FOR CHAPTERS HERE ...
%*************************************************************************
% Backmatter
%*************************************************************************
\appendix
%\renewcommand{\thechapter}{\alph{chapter}}
\cleardoublepage
\part{Appendix}
%\include{chapters/examples/appendix01}
%\include{chapters/examples/appendix02}
... PUT YOUR INCLUDES FOR APPENDIX HERE ...
You may also want to have a look at the part(...) section at line 93 and 103. You may want to change the titles of the part(...)-sections. Alternatively, you remove the part(...) section and the corresponding cleardoublepage the line before.
Changing the Citation Style
By default, this template uses the IEEE Numeric style for citations. The IEEE citation style includes in-text citations, numbered in square brackets, which refer to the full citation listed in the reference list at the end of the paper. The reference list is organized numerically, not alphabetically. For examples, see the IEEE Editorial Style Manual.
However, if you prefer to uses the IEEE Alphabetic style for citations you can do so. To this end, you have to change lines 90 and 91 of classicthesis-config.tex:
%style=numeric-comp,%
style=alphabetic,%
Compiling the LaTeX source code
You may compile the fernuni-hagen-thesis template using the pdflatex and the bibtex command. In addition, the thesis template repository contains a Makefile that allows you to compile the thesis template using the make tool available on most Unix and Linux systems. Simply type:
$ make
to compile the LaTeX code into a PDF-file. Moreover, you may use
$ make clean
to remove all temporary files, which are produced during the compilation process. Finally,
$ make bz2
generates a bz2-package file, which contains all the source files of your LaTeX code. In case you need to create a PDF-version with embedded fonts you may use
$ make publish
Using Docker
The h_da thesis template ships with two Dockerfiles that create Docker container used to compile the LaTeX code. One container - build by the Dockerfile.ci Docker file - is used by the CI to compile the thesis template and check its integrity at every commit. The other one - created by the Dockerfile.local Docker file - might be used to build the Docker container that allows to compile the LaTeX code on your local machine without the need to install any LaTeX files.
On order to build the Docker image you have to type the following command:
$ docker build --tag mbredel/thesis-template --file Dockerfile.local .
Creating the image requires a working (and hopefully fast) Internet connection. It may take several minutes to download the required base-images as well as all needed dependencies. You only have to create the image once. Once the image is created, you can run the Docker container by running the following command
$ docker run --volume $(pwd):/thesis-template/ mbredel/thesis-template && docker rm $(docker ps -lq)
inside the root directory containing the LaTeX code. The command mounts the current directory into the Docker container, runs the "publish" make target, and thus compiles the LaTeX code into a PDF file. Finally, the command removes the container again, as it is not needed anymore. You may re-compile the LaTeX code by re-running the "docker run ..." command again.
For more information on Docker, please take a look at the Docker documentation.
Known issues
- The LaTeX template is tested using TeXLive which is available for Linux and Windows.
- The LaTeX template only supports bachelor theses (by default)
- The thesis only supports German and (American) English
License
The h_da computer science department LaTeX thesis template is licenced under GPL v3.0
Acknowledgements
- Many thanks to Sebastian Jung for his hints on the local Docker approach for compiling the LaTeX code.