NodeShuffler/doc/doc.tex

\documentclass[fontsize=12pt, paper=a4, headinclude, twoside=false, parskip=half-, pagesize=auto, numbers=noenddot, open=right, toc=listof, toc=bibliography]{scrreprt}
%\overfullrule=20mm
% PDF-Kompression
\pdfminorversion=5
\pdfobjcompresslevel=1
\pdfsuppresswarningpagegroup=1
% Allgemeines
\usepackage[automark]{scrlayer-scrpage} % Kopf- und Fußzeilen
\usepackage{amsmath,marvosym,amssymb} % Mathesachen
\usepackage[T1]{fontenc} % Ligaturen, richtige Umlaute im PDF
\usepackage[utf8]{inputenc}% UTF8-Kodierung für Umlaute usw
% Schriften
\usepackage{mathpazo} % Palatino für Mathemodus
%\usepackage{mathpazo,tgpagella} % auch sehr schöne Schriften
\usepackage{setspace} % Zeilenabstand
\onehalfspacing % 1,5 Zeilen
% Schriften-Größen
\setkomafont{chapter}{\Huge\rmfamily} % Überschrift der Ebene
\setkomafont{section}{\Large\rmfamily}
\setkomafont{subsection}{\large\rmfamily}
\setkomafont{subsubsection}{\large\rmfamily}
\setkomafont{chapterentry}{\large\rmfamily} % Überschrift der Ebene in Inhaltsverzeichnis
\setkomafont{descriptionlabel}{\bfseries\rmfamily} % für description-Umgebungen
\setkomafont{captionlabel}{\small\bfseries}
\setkomafont{caption}{\small}
% Sprache: English
\usepackage[english]{babel} % Silbentrennung

% _todo notes
\usepackage[english]{todonotes}
\newcommand{\TODO}[1]{\todo[inline]{TODO: #1}}
\newcommand{\Thema}{Placing Nodes Moderately Well While Showing What Is Happening}
\newcommand{\appname}{NodeShuffler}
\usepackage[hyphens]{url} % ermögliche Links (URLs) und erlaube sie am zeilenende umzubrechen
\usepackage[english,pdfauthor={Eren B. Yilmaz and Kolja S. Strohm}, pdftitle={\Thema}, breaklinks=true]{hyperref}
\usepackage[final]{microtype} % mikrotypographische Optimierungen
% Tabellen
\usepackage{multirow} % Tabellen-Zellen über mehrere Zeilen
\usepackage{multicol} % mehrere Spalten auf eine Seite
\usepackage{tabularx} % für Tabellen mit vorgegeben Größen
\usepackage{longtable} % Tabellen über mehrere Seiten
\usepackage{array}
\usepackage{cite} % citations in the form [2-4]
\usepackage{svg} % Svg-Grafiken

% Bilder
\usepackage{graphicx} % Bilder
\usepackage[autostyle=true]{csquotes} % enquote command
\graphicspath{{img/}} % Lege den Standardpfad mit Bilder fest
\DeclareGraphicsExtensions{.pdf,.png,.jpg} % bevorzuge pdf-Dateien vor den anderen
\usepackage{subcaption}  % mehrere Abbildungen nebeneinander/übereinander
\usepackage[all]{hypcap} % Beim Klicken auf Links zum Bild und nicht zu Caption gehen
\usepackage{tablefootnote}
% Bildunterschrift
\setcapindent{0em} % kein Einrücken der Caption von Figures und Tabellen
\setcapwidth{0.9\textwidth} % Breite der Caption nur 90% der Textbreite, damit sie sich vom restlichen Text abhebt
\setlength{\abovecaptionskip}{0.2cm} % Abstand der zwischen Bild- und Bildunterschrift
\usepackage{enumitem} % Referenzen auf Item in enumerate-Blocks

% A checklist for the current progress
\usepackage{pifont}
\usepackage{tikz}
\usetikzlibrary{shapes.geometric}
\newcommand{\cmark}{\ding{51}}%
\newcommand{\xmark}{\ding{55}}%
\newcommand\partialsquare{%
\begin{tikzpicture}[baseline=0]
\draw (0,0)  rectangle (0.3,0.3);
\fill (0.05,0.05)  rectangle (0.25,0.25);
\end{tikzpicture}%
}
\newcommand{\planned}{$\square$}
\newcommand{\done}{\rlap{$\square$}{\raisebox{2pt}{\large\hspace{1pt}\cmark}}\hspace{-2.5pt}}
\newcommand{\progress}{\partialsquare}

% \toprule and other commands
\usepackage{booktabs}

% custom hyphenations
\usepackage{hyphenat}
\input{custom_hyphenations}
%\usepackage{testhyphens} % check hyphenation with \begin{checkhyphens}

% Quellcode
% für Formatierung in Quelltexten, hier im Anhang
\usepackage{listings}

% same code font as in eclipse
\usepackage{inconsolata}
\usepackage{color, colortbl} % Farben

\colorlet{punct}{red!60!black}
\definecolor{background}{HTML}{EEEEEE}
\definecolor{delim}{RGB}{20,105,176}
\colorlet{numb}{magenta!60!black}

% Default fixed font does not support bold face
\DeclareFixedFont{\ttb}{T1}{txtt}{bx}{n}{8} % for bold
\DeclareFixedFont{\ttm}{T1}{txtt}{m}{n}{8}  % for normal
% Custom colors
\definecolor{deepblue}{rgb}{0,0,0.6}
\definecolor{deepred}{rgb}{0.8,0,0}
\definecolor{deepgreen}{rgb}{0,0.4,0}
\definecolor{grau}{gray}{0.3}
\definecolor{member}{rgb}{0.27,0.37,0.75}
\definecolor{reserved}{rgb}{0.5,0.,0.333}

\newcommand{\code}[1]{\lstinline[basicstyle=\ttfamily]|#1|}
\newcommand{\member}[1]{\lstinline[basicstyle=\ttfamily\color{member}]|#1|}
\newcommand{\reserved}[1]{\lstinline[basicstyle=\ttfamily\color{reserved}]|#1|}

% python style code
\lstset{
extendedchars=true,
basicstyle=\scriptsize,
%basicstyle=\footnotesize\ttfamily,
tabsize=2,
keywordstyle=\textbf,
commentstyle=\color{grau},
numbers=left,
numberstyle=\tiny,
% für schönen Zeilenumbruch
breakautoindent = true,
breakindent = 2em,
breaklines = true,
postbreak = ,
prebreak = \raisebox{-.8ex}[0ex][0ex]{\Righttorque},
showstringspaces=false,
emphstyle=\ttb,
stringstyle=\color{deepgreen},
frame=tb}

\lstdefinelanguage{json}{
    basicstyle=\normalfont\ttfamily,
    numberstyle=\scriptsize,
    stepnumber=1,
    numbersep=8pt,
    showstringspaces=false,
    literate=
     *{:}{{{\color{punct}{:}}}}{1}
      {,}{{{\color{punct}{,}}}}{1}
      {\{}{{{\color{delim}{\{}}}}{1}
      {\}}{{{\color{delim}{\}}}}}{1}
      {[}{{{\color{delim}{[}}}}{1}
      {]}{{{\color{delim}{]}}}}{1},
}
% linksbündige Fußboten
\deffootnote{1.5em}{1em}{\makebox[1.5em][l]{\thefootnotemark}}

\typearea{14} % typearea berechnet einen sinnvollen Satzspiegel (das heißt die Seitenränder usw.) siehe auch http://www.ctan.org/pkg/typearea. Diese Berechnung befindet sich am Schluss, damit die Einstellungen von oben berücksichtigt werden

% \usepackage{scrhack} % Vermeidung einer Warnung

%\newcommand{\svgfigure}[3]{
%\begin{figure}[htp]
%    \centering
%    \includesvg{#1}
%    \caption{#2}\label{#3}
%\end{figure}
%}

\newcommand{\svgfigurewidth}[5]{
\begin{figure}[htp]
    \centering
    \fontsize{8}{10}\selectfont
    \includesvg[width = #5]{#1}
    \caption[#2]{#3}\label{#4}
\end{figure}
}

\newcommand{\svgfigurefullwidth}[4]{
\begin{figure}[htp]
    \centering
    \includesvg[width = \textwidth]{#1}
    \caption[#2]{#3}\label{#4}
\end{figure}
}

\newcommand{\graphicsfigure}[3]{
\begin{figure}[htp]
    \centering
    \includegraphics[width=\linewidth]{#1}
    \caption{#2}\label{#3}
\end{figure}
}

% um den kram kürzer zu schreiben
\newcommand{\ssrl}[1]{\multicolumn{1}{|c|}{#1}}
\newcommand{\ssr}[1]{\multicolumn{1}{c|}{#1}}
\newcommand{\norm}[1]{\lvert #1 \rvert}

%\usepackage{showframe} % overfull hboxes deutlich sichtbar machen

% draft note
\usepackage{everypage}
\usepackage{datetime}
\AddEverypageHook{%
\begin{picture}
    (0,0)%
    \put(140,30){\fbox{\textbf{Draft of~\today~\currenttime}}}
    %
\end{picture}\hfill
}

\begin{document} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    \pagenumbering{Roman} % Seitenummerierung mit großen römischen Zahlen
    \pagestyle{empty} % keine Kopf- oder Fußzeilen auf den ersten Seiten

    % Titelseite
    \clearscrheadings\clearscrplain
    \begin{center}
        \begin{Large}
            Christian-Albrechts-Universität zu Kiel
            \\

            \vspace{20mm}
            \appname: \Thema
        \end{Large}\\
        \vspace{8mm}
        Project documentation\\
        \vspace{2.4 cm}
        Eren Bora Yilmaz (1036085)\\
        Kolja Samuel Strohm (1036051)\\
        Summer term 2018\\
        \vspace{8mm}
	    \includegraphics[width=10cm]{img/logo}
    \end{center}
    \clearpage\null\clearpage

    \pagestyle{scrheadings} %Seitenstil festlegen, damit die folgenden Einträge auch wirksam sind
    \cfoot*{\pagemark} %center, Fuß
    \chead{} %center, Kopf
    \ofoot{} %Außen, Fuß
    \ohead{\headmark} %Außen, Kopf

    \tableofcontents % erstelle hier das Inhaltsverzeichnis
    \listoffigures % erstelle hier das Abbildungsverzeichnis
    \listoftables % erstelle hier das Tabellenverzeichnis

    %    \addchap{Symbolverzeichnis}\label{s.sym} % vergebe für das Symbolverzeichnis keine Kapitelnummer
    %    \section*{Allgemeine Symbole}\label{s.sym.alg}
    %    \begin{flushleft}
    %        \begin{tabularx}{\textwidth}{l|X}
    %            Symbol & Bedeutung\\\hline
    %            $a$ & der Skalar $a$ \\
    %            $\vec{x}$ & der Vektor $\vec{x}$\\
    %            $\mat{A}$ & die Matrix $\mat{A}$\\
    %        \end{tabularx}
    %    \end{flushleft}

    % richtiger Inhalt
    \chapter{Introduction}\label{ch:introduction}
    \pagenumbering{arabic} % ab jetzt die normale arabische Nummerierung
    \input{chapter/1introduction}

    \chapter{Architecture}\label{ch:architecture}
    \input{chapter/2architecture}

    \chapter{UI and visuals}\label{ch:ui}
    \input{chapter/3ui}

    \chapter{Current Progress}\label{ch:progress}
    \input{chapter/4progress}

    \chapter{Retrospection}
    \input{chapter/5retrospection}

    \chapter{Contributors}
    \input{chapter/6contributors}

    \appendix
    \chapter{Appendix}\label{ch:appendix}
    \input{chapter/appendix}

    \bibliographystyle{ieeetran}
    \bibliography{doc}
\end{document}