Add support for additional variables

Add config file as a definit entrypoint to change existing variables
Add english UPB logo
Clean up file structure (move some files from root to misc)
Add UPB colors and remove codesnippets for RUB CorpID
Clean up existing files (unify whitespaces, etc)
Move background on titlepage to remove white stripe on lower left side

README.md

@@ -5,3 +5,6 @@ This project contains a template for bachelor / master theses, and for seminar p
 git clone --recurse-submodules [your-project-link.git]
 ```
 Using `--recurse-submodules` is necessary because the project includes submodules (bibliographies with security papers and RFC entries).
+
+Normally there should be no need to edit any of the files in the `misc` folder besides `config.tex` and `additional_packages.tex`.
+In `config.tex` you can set every variable that this template supports. Everything else has to be manually changed.

chapters/chap_0.tex

 \begin{abstract}
-How can i improve my scientific writing skills?
+How can I improve my scientific writing skills?
 \begin{itemize}
     \item \url{https://www.nds.ruhr-uni-bochum.de/teaching/theses/writing/}
     \item \url{https://www.uni-paderborn.de/universitaet/kompetenzzentrum-schreiben/}
 \end{itemize}
+
+\vspace*{2em}
+{\small\textbf{Keywords:} \keywords}
 \end{abstract}
 
 \cleardoublepage
@@ -25,26 +28,11 @@ Alle Ausführungen, die wörtlich oder sinngemäß übernommen worden sind, sind
 \hspace*{1.5cm} \textsc{Date} \hspace*{7cm} \textsc{\@author}
 \makeatother
 
-%\cleardoublepage
-%
-%\section*{Erklärung}
-%{\selectlanguage{ngerman}
-%Ich erkläre mich damit einverstanden, dass meine Bachelorarbeit am
-%Lehrstuhl NDS dauerhaft in elektronischer und gedruckter Form aufbewahrt
-%wird und dass die Ergebnisse aus dieser Arbeit unter Einhaltung guter
-%wissenschaftlicher Praxis in der Forschung weiter verwendet werden dürfen.\@}
-%
-%\makeatletter
-%\vspace{2cm}
-%\rule{4cm}{0.1pt} \hfill \rule{7cm}{0.1pt} \\
-%\hspace*{1.5cm} \textsc{Date} \hspace*{7cm} \textsc{\@author}
-%\makeatother
-
 \cleardoublepage
 
-\pagestyle{scrheadings} % reenable headers and footers
+\pagestyle{scrheadings} % re-enable headers and footers
 
-%% generate table of contents
+% generate table of contents
 \tableofcontents
 
 \cleardoublepage

chapters/chap_1.tex

@@ -44,8 +44,3 @@ You already know what are your exact results and contributions. So summarize the
 
 \paragraph{Organization of this Thesis.}
 This thesis is divided into x chapters. In Chapter~\ref{chap:background}, we summarize the background relevant to this thesis. \dots
-
-
-
-
-

chapters/chap_2.tex

@@ -9,7 +9,6 @@ In this specific chapter, describe the background relevant to the thesis, for ex
     \item Tools you are relying on (e.g., how TLS-Attacker works)
 \end{itemize}
 
-
 In the following, we give an overview of duties and responsibilities relevant for students as well as for their supervisors.
 
 \section{Duties and Agreements}

chapters/chap_3.tex

 \chapter{Design} \label{chap:design}
 
 Describe on a high level (on about 5? pages), how your design works, without revealing many implementation details. Implementation details will be provided as a part of the next section.
-
-
-

chapters/chap_6.tex

 \chapter{Conclusions and Future Work} \label{chap:conclusion}
+
 This is \textbf{not only a summary} of your thesis!
 
 You can briefly summarize the results. But then conclude the thesis and write about what we have learned:

chapters/chap_appendix.tex

 \chapter{Java Code} \label{chap:javacode}
-

frontpage.tex

-% Hintergrund-Makro
-\newcommand\BackgroundPic{
-\put(0,0){
-\parbox[b][\paperheight]{\paperwidth}{%
-\vfill
-\centering
-\includegraphics[width=\paperwidth,height=\paperheight]{images/front.png}%
-\vfill
-}}}
-
-\AddToShipoutPicture*{\BackgroundPic}
-\begin{titlepage}
-\makeatletter
-
-\enlargethispage{3cm}
-
-\begin{minipage}[b]{1\linewidth}
-	\sffamily
-	\includegraphics[scale=0.5]{images/upb_logo.pdf}
-  	\vspace*{8cm}
-  	
-	\textbf{\LARGE {\@title}}\\
-  
-	\Large{\@author}\\
-	
-% 	\vspace*{35mm}
-	\vspace{4cm}
-	\normalsize{
-	Master's thesis / Bachelor's thesis / Seminar paper\@~~--~~\@date\@.\\
-	System Security Group.\\}
-	\newline
-	\normalsize{
-	\begin{tabular}{@{}ll@{}}
-	Supervisors: 	& Prof.~Dr-Ing.~Juraj Somorovsky\\
-					& (if applicable, insert further supervisors here)\\
-	\end{tabular}
-	}
-\end{minipage}
-
-
-\makeatother
-\end{titlepage}
-\ClearShipoutPicture

misc/config.tex

+% Set document variables
+\author{Insert your name here}
+\title{Insert title here}
+\def\type{Master's thesis / Bachelor's thesis / Seminar paper}
+\def\primarySupervisor{Prof.~Dr-Ing.~Juraj Somorovsky}
+\def\secondarySupervisors{(if applicable, insert further supervisors here)\\(and here)} % comment if not needed
+% Overwrite/Set date here
+%\day=6 \month=6 \year=2012
+\date{\today}
+
+\def\logo{images/upb_logo_en.pdf} % images/upb_logo_de.pdf
+\def\keywords{SAML, add more}
+\PassOptionsToPackage{ngerman, english}{babel} % last language given is used (here: english)

misc/frontpage.tex

+% Background
+\newcommand\BackgroundPic{
+\put(-10,0){
+\parbox[b][\paperheight]{\paperwidth}{%
+\vfill
+\centering
+\includegraphics[width=1.05\paperwidth,height=\paperheight]{images/front.png}%
+\vfill
+}}}
+
+\AddToShipoutPicture*{\BackgroundPic}
+\begin{titlepage}
+\makeatletter
+
+\enlargethispage{3cm}
+
+\begin{minipage}[b]{1\linewidth}
+    \sffamily
+    \includegraphics[scale=0.5]{\logo}
+    \vspace*{8cm}
+
+    \textbf{\LARGE {\@title}}\\
+
+    \Large{\@author}\\
+
+    \vspace{4cm}
+    \normalsize{
+    \type\@~~---~~\@date\@.\\
+    System Security Group.\\}
+    \newline
+    \normalsize{
+    \begin{tabular}{@{}ll@{}}
+    \ifthenelse{\isundefined{secondarySupervisors}}{%
+        Supervisors:& \begin{tabular}{l}\primarySupervisor\end{tabular}\\
+                    & \begin{tabular}{l}\secondarySupervisors\end{tabular}
+    }{%
+        Supervisor: & \primarySupervisor
+    }
+    \end{tabular}
+    }
+\end{minipage}
+
+
+\makeatother
+\end{titlepage}
+\ClearShipoutPicture

misc/preamble.tex

-\setcounter{tocdepth}{3}  % Inhaltsverzeichnis bis Subsubsection
-\setcounter{secnumdepth}{3} % Nummerierung bis Subsubsection
+\input{misc/config.tex}
 
-% General stuff
-\usepackage[utf8]{inputenc} % CHANGE HERE IF NECESSARY
+\setcounter{tocdepth}{3} % Table of contents includes sections up to: Subsubsection
+\setcounter{secnumdepth}{3} % Sections are numbered up to: Subsubsection
+
+% Load packages
+\usepackage[utf8]{inputenc}
 \usepackage[T1]{fontenc}
-\usepackage[ngerman, english]{babel} % last language given is used (here: english)
+\usepackage{babel}
 \usepackage{lmodern}
-%\usepackage{microtype}
 \usepackage{ifpdf}
 \usepackage{ifthen}
 
-% Set date here 
-%\day=6 \month=6 \year=2012
-
-% Set name and title
-\author{Insert your name here}
-\title{Insert title here}
-\date{\today}
-
-%%%%%% %%%%%%
-
-% Load packages ...
-
 % Corporate Design
-\usepackage{eso-pic}
+\usepackage{eso-pic} % used to set the border on the title page
 \usepackage{color}
-% Comment out if the RUB fonts are installed
-% Link: https://noc.rub.de/~jobsanzl/latex/rubtexfonts-0.4.tar.gz
-%\usepackage{rubfonts2009} 
-\newcommand{\setrubfontnormal}[1]{\fontfamily{rubscala}\fontsize{#1}{1}\selectfont}
-\newcommand{\setrubfontextra}[1]{\fontfamily{rubflama}\fontsize{#1}{1}\selectfont}
-\definecolor{rubgreen}{cmyk}{0.5,0,1,0}
-\definecolor{rubblue}{cmyk}{1,0.5,0,0.6}
+% defining the UPB-colors
+\definecolor{upbblue}{RGB}{0,32,91}
+\definecolor{upbgray}{RGB}{85,85,85}
+\definecolor{upblightgray}{RGB}{230,232,230}
+\definecolor{upbred}{RGB}{215,51,103}
+\definecolor{upbgreen}{RGB}{164,196,36}
+\definecolor{upbcyan}{RGB}{24,176,226}
+\definecolor{upborange}{RGB}{242,149,18}
+\definecolor{upbcassis}{RGB}{169,57,131}
+\definecolor{upblightblue}{RGB}{0,127,185}
 
 % Figures
 \usepackage{graphicx}
@@ -58,6 +50,9 @@
 \usepackage{tikz}
 
 % Protocols and bytefields
+\makeatletter
+\def\input@path{{./misc/}}
+\makeatother
 \usepackage{protocol}
 \usepackage{bytefield}
 
@@ -103,7 +98,7 @@
 \ihead{\headmark}
 \pagestyle{scrheadings}
 
-%% use some standards for mathematical expressions:
+% use some standards for mathematical expressions:
 \newcommand{\red}{{\rm red}}
 \newtheorem{theorem}{Theorem}[section]
 \newtheorem{lemma}[theorem]{Lemma}
@@ -118,22 +113,36 @@
 \usepackage{url}
 \def\UrlBreaks{\do\/\do-}
 
-% \setbibpreamble{{\large Seitenzahlen, auf denen ein Eintrag referenziert wird, werden am Ende eines jeden Eintrags angegeben.}\newline} % Wegen der pagebackref-Option des hyperref-Packets, wird vielen nicht direkt klar was das soll http://projekte.dante.de/DanteFAQ/Verzeichnisse#16
-
-% gray definition boxes, that whay you'll find them in the text
+% gray definition boxes, that way you'll find them in the text
 \usepackage{shadethm}
 \newshadetheorem{sthm}[figure]{Definition}
-\newenvironment{definition}[1][]{
-   \definecolor{shadethmcolor}{rgb}{.9,.9,.9}
-   \begin{sthm}[#1]
- }{\end{sthm}}
+\newenvironment{definition}[1][]{%
+    \definecolor{shadethmcolor}{rgb}{.9,.9,.9}%
+    \begin{sthm}[#1]%
+}{%
+    \end{sthm}%
+}
 
 % apparently some packages used here utilize deprecated KOMA-Script functionalities
 % scrhack ensures, that those packages don't break suddenly and removes the deprecation warnings from the log
 \usepackage{scrhack}
 
 % Hyperlinks and menu for your document
-\usepackage[breaklinks,hyperindex,colorlinks,anchorcolor=black,citecolor=black,filecolor=black,linkcolor=black,menucolor=black,urlcolor=black,pdftex]{hyperref} % pagebackref: Add page number to the references where they can be found
+\usepackage[%
+    breaklinks,%
+    hyperindex,%
+    colorlinks,%
+    anchorcolor=black,%
+    citecolor=black,%
+    filecolor=black,%
+    linkcolor=black,%
+    menucolor=black,%
+    urlcolor=black,%
+    pdftex%
+]{hyperref} % pagebackref: Add page number to the references where they can be found
+
+\input{misc/additonal_packages.tex}
+
 % DO NOT LOAD ANY OF YOUR PACKAGES BEYOND THIS PACKAGE
 
 \makeatletter
@@ -142,8 +151,7 @@
         pdftitle = {\@title},
         pdfauthor = {\@author},
         pdfsubject={\@title},
-   pdfkeywords={SAML, add more}, % CHANGE HERE
-%    unicode={true},
+        pdfkeywords={\keywords},
     }
 }
 \makeatother

thesis.tex

-%%% TEMPLATE-INFO
-%% AUTHOR		: juraj.somorovsky@upb.de (former: johannes.hoffmann@rub.de, vincent.immler@rub.de)
-%% VERSION		: 0.04
-%% Please send comments/feedback/pull requests (and donations ;-)) to author, thanks!
+% TEMPLATE-INFO
+% AUTHOR       : juraj.somorovsky@upb.de (former: johannes.hoffmann@rub.de, vincent.immler@rub.de)
+% VERSION      : 0.04
+% Please send comments/feedback/pull requests (and donations ;-)) to author, thanks!
 
 \RequirePackage{fix-cm,cmap}
 
@@ -22,25 +22,23 @@ BCOR=1cm, % Bindekorrektur: Change this accordingly, also read the KomaScript Gu
 \input{misc/preamble}
 \input{misc/acronyms.tex}
 
-%% here your document starts
+% here your document starts
 \begin{document}
 
-%% switch to roman paginating for the acknowledgements, table of contents etc.
+% switch to roman paginating for the acknowledgements, table of contents etc.
 \pagenumbering{roman} % uncomment this if you like it
 
-%% title page --- made out of expressions defined above
-\input{frontpage}
+% title page --- made out of expressions defined in misc/config.tex
+\input{misc/frontpage}
 
 \input{chapters/chap_0}
 
 \pagenumbering{arabic} % switches to arabic numbers for the rest of the text
 \setcounter{page}{1}
 
-%%
-%% include all your chapters as .tex files,
-%% each file contains sections \section{name of section},
-%% subsections \subsections{...} and so on...
-%%
+% include all your chapters as .tex files,
+% each file contains sections \section{name of section},
+% subsections \subsections{...} and so on...
 
 \input{chapters/chap_1}
 
@@ -53,35 +51,35 @@ BCOR=1cm, % Bindekorrektur: Change this accordingly, also read the KomaScript Gu
 \input{chapters/chap_5}
 
 \input{chapters/chap_6}
-%% include appendix
 
+% include appendix
 \appendix
 
 \pagestyle{scrplain} % turn off headers and footers
 
-%% generate bibliography with bibtex, the bibfile here is "paper.bib"
+% generate bibliography with bibtex, the bibfile here is "paper.bib"
 \flushbottom
 \bibliographystyle{bababbrv-fl}
 \bibliography{literature/literature,cryptobib/crypto.bib,rfcbib/data/rfc.bib}
 
-%% generate list of figures, optional, remove it if you do not like it
+% generate list of figures, optional, remove it if you do not like it
 \listoffigures
 
-\KOMAoptions{open=any} % Plaziert Kapitel auch auf linken Seiten
+\KOMAoptions{open=any} % allows chapters to start on the left hand side
 
-%% generate list of tables, optional, remove it if you do not like it
+% generate list of tables, optional, remove it if you do not like it
 \listoftables
 
-%% generate list of algorithms, optional, remove it if you do not like it
+% generate list of algorithms, optional, remove it if you do not like it
 \clearpage \phantomsection
 \addcontentsline{toc}{chapter}{List of Algorithms}
 \listofalgorithmes
 
-%% generate list of listings, optional, remove it if you do not like it
+% generate list of listings, optional, remove it if you do not like it
 \renewcommand*{\lstlistlistingname}{List of Listings}
 \lstlistoflistings
 
-\KOMAoptions{open=right} % Plaziert Kapitel wieder nur auf rechten Seiten
+\KOMAoptions{open=right} % requires chapters to start on the right hand side
 
 \input{chapters/chap_appendix}