doc.tex 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
  1. \documentclass[fontsize=12pt, paper=a4, headinclude, twoside=false, parskip=half-, pagesize=auto, numbers=noenddot, open=right, toc=listof, toc=bibliography]{scrreprt}
  2. %\overfullrule=20mm
  3. % PDF-Kompression
  4. \pdfminorversion=5
  5. \pdfobjcompresslevel=1
  6. \pdfsuppresswarningpagegroup=1
  7. % Allgemeines
  8. \usepackage[automark]{scrlayer-scrpage} % Kopf- und Fußzeilen
  9. \usepackage{amsmath,marvosym,amssymb} % Mathesachen
  10. \usepackage[T1]{fontenc} % Ligaturen, richtige Umlaute im PDF
  11. \usepackage[utf8]{inputenc}% UTF8-Kodierung für Umlaute usw
  12. % Schriften
  13. \usepackage{mathpazo} % Palatino für Mathemodus
  14. %\usepackage{mathpazo,tgpagella} % auch sehr schöne Schriften
  15. \usepackage{setspace} % Zeilenabstand
  16. \onehalfspacing % 1,5 Zeilen
  17. % Schriften-Größen
  18. \setkomafont{chapter}{\Huge\rmfamily} % Überschrift der Ebene
  19. \setkomafont{section}{\Large\rmfamily}
  20. \setkomafont{subsection}{\large\rmfamily}
  21. \setkomafont{subsubsection}{\large\rmfamily}
  22. \setkomafont{chapterentry}{\large\rmfamily} % Überschrift der Ebene in Inhaltsverzeichnis
  23. \setkomafont{descriptionlabel}{\bfseries\rmfamily} % für description-Umgebungen
  24. \setkomafont{captionlabel}{\small\bfseries}
  25. \setkomafont{caption}{\small}
  26. % Sprache: English
  27. \usepackage[english]{babel} % Silbentrennung
  28. % _todo notes
  29. \usepackage[english]{todonotes}
  30. \newcommand{\TODO}[1]{\todo[inline]{TODO: #1}}
  31. \newcommand{\Thema}{Placing Nodes Moderately Well While Showing What Is Happening}
  32. \newcommand{\appname}{NodeShuffler}
  33. \usepackage[hyphens]{url} % ermögliche Links (URLs) und erlaube sie am zeilenende umzubrechen
  34. \usepackage[english,pdfauthor={Eren B. Yilmaz and Kolja S. Strohm}, pdftitle={\Thema}, breaklinks=true]{hyperref}
  35. \usepackage[final]{microtype} % mikrotypographische Optimierungen
  36. % Tabellen
  37. \usepackage{multirow} % Tabellen-Zellen über mehrere Zeilen
  38. \usepackage{multicol} % mehrere Spalten auf eine Seite
  39. \usepackage{tabularx} % für Tabellen mit vorgegeben Größen
  40. \usepackage{longtable} % Tabellen über mehrere Seiten
  41. \usepackage{array}
  42. \usepackage{cite} % citations in the form [2-4]
  43. \usepackage{svg} % Svg-Grafiken
  44. % Bilder
  45. \usepackage{graphicx} % Bilder
  46. \usepackage[autostyle=true]{csquotes} % enquote command
  47. \graphicspath{{img/}} % Lege den Standardpfad mit Bilder fest
  48. \DeclareGraphicsExtensions{.pdf,.png,.jpg} % bevorzuge pdf-Dateien vor den anderen
  49. \usepackage{subcaption} % mehrere Abbildungen nebeneinander/übereinander
  50. \usepackage[all]{hypcap} % Beim Klicken auf Links zum Bild und nicht zu Caption gehen
  51. \usepackage{tablefootnote}
  52. % Bildunterschrift
  53. \setcapindent{0em} % kein Einrücken der Caption von Figures und Tabellen
  54. \setcapwidth{0.9\textwidth} % Breite der Caption nur 90% der Textbreite, damit sie sich vom restlichen Text abhebt
  55. \setlength{\abovecaptionskip}{0.2cm} % Abstand der zwischen Bild- und Bildunterschrift
  56. \usepackage{enumitem} % Referenzen auf Item in enumerate-Blocks
  57. \usepackage[normalem]{ulem} % durchgestichener text mit \sout
  58. % A checklist for the current progress
  59. \usepackage{pifont}
  60. \usepackage{tikz}
  61. \usetikzlibrary{shapes.geometric}
  62. \newcommand{\cmark}{\ding{51}}%
  63. \newcommand{\xmark}{\ding{55}}%
  64. \newcommand\partialsquare{%
  65. \begin{tikzpicture}[baseline=0]
  66. \draw (0,0) rectangle (0.3,0.3);
  67. \fill (0.05,0.05) rectangle (0.25,0.25);
  68. \end{tikzpicture}%
  69. }
  70. \newcommand{\planned}{$\square$}
  71. \newcommand{\done}{\rlap{$\square$}{\raisebox{2pt}{\large\hspace{1pt}\cmark}}\hspace{-2.5pt}}
  72. \newcommand{\progress}{\partialsquare}
  73. % \toprule and other commands
  74. \usepackage{booktabs}
  75. % custom hyphenations
  76. \usepackage{hyphenat}
  77. \input{custom_hyphenations}
  78. %\usepackage{testhyphens} % check hyphenation with \begin{checkhyphens}
  79. % Quellcode
  80. % für Formatierung in Quelltexten, hier im Anhang
  81. \usepackage{listings}
  82. % same code font as in eclipse
  83. \usepackage{inconsolata}
  84. \usepackage{color, colortbl} % Farben
  85. \colorlet{punct}{red!60!black}
  86. \definecolor{background}{HTML}{EEEEEE}
  87. \definecolor{delim}{RGB}{20,105,176}
  88. \colorlet{numb}{magenta!60!black}
  89. % Default fixed font does not support bold face
  90. \DeclareFixedFont{\ttb}{T1}{txtt}{bx}{n}{8} % for bold
  91. \DeclareFixedFont{\ttm}{T1}{txtt}{m}{n}{8} % for normal
  92. % Custom colors
  93. \definecolor{deepblue}{rgb}{0,0,0.6}
  94. \definecolor{deepred}{rgb}{0.8,0,0}
  95. \definecolor{deepgreen}{rgb}{0,0.4,0}
  96. \definecolor{grau}{gray}{0.3}
  97. \definecolor{member}{rgb}{0.27,0.37,0.75}
  98. \definecolor{reserved}{rgb}{0.5,0.,0.333}
  99. \newcommand{\code}[1]{\lstinline[basicstyle=\ttfamily]|#1|}
  100. \newcommand{\member}[1]{\lstinline[basicstyle=\ttfamily\color{member}]|#1|}
  101. \newcommand{\reserved}[1]{\lstinline[basicstyle=\ttfamily\color{reserved}]|#1|}
  102. % python style code
  103. \lstset{
  104. extendedchars=true,
  105. basicstyle=\scriptsize,
  106. %basicstyle=\footnotesize\ttfamily,
  107. tabsize=2,
  108. keywordstyle=\textbf,
  109. commentstyle=\color{grau},
  110. numbers=left,
  111. numberstyle=\tiny,
  112. % für schönen Zeilenumbruch
  113. breakautoindent = true,
  114. breakindent = 2em,
  115. breaklines = true,
  116. postbreak = ,
  117. prebreak = \raisebox{-.8ex}[0ex][0ex]{\Righttorque},
  118. showstringspaces=false,
  119. emphstyle=\ttb,
  120. stringstyle=\color{deepgreen},
  121. frame=tb}
  122. \lstdefinelanguage{json}{
  123. basicstyle=\normalfont\ttfamily,
  124. numberstyle=\scriptsize,
  125. stepnumber=1,
  126. numbersep=8pt,
  127. showstringspaces=false,
  128. literate=
  129. *{:}{{{\color{punct}{:}}}}{1}
  130. {,}{{{\color{punct}{,}}}}{1}
  131. {\{}{{{\color{delim}{\{}}}}{1}
  132. {\}}{{{\color{delim}{\}}}}}{1}
  133. {[}{{{\color{delim}{[}}}}{1}
  134. {]}{{{\color{delim}{]}}}}{1},
  135. }
  136. \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
  137. % \usepackage{scrhack} % Vermeidung einer Warnung
  138. %\newcommand{\svgfigure}[3]{
  139. %\begin{figure}[htp]
  140. % \centering
  141. % \includesvg{#1}
  142. % \caption{#2}\label{#3}
  143. %\end{figure}
  144. %}
  145. %\newcommand{\svgfigurewidth}[5]{
  146. %\begin{figure}[htp]
  147. % \centering
  148. % \fontsize{8}{10}\selectfont
  149. % \includesvg[width = #5]{#1}
  150. % \caption[#2]{#3}\label{#4}
  151. %\end{figure}
  152. %}
  153. %
  154. %\newcommand{\svgfigurefullwidth}[4]{
  155. %\begin{figure}[htp]
  156. % \centering
  157. % \includesvg[width = \textwidth]{#1}
  158. % \caption[#2]{#3}\label{#4}
  159. %\end{figure}
  160. %}
  161. %
  162. %\newcommand{\graphicsfigure}[3]{
  163. %\begin{figure}[htp]
  164. % \centering
  165. % \includegraphics[width=\linewidth]{#1}
  166. % \caption{#2}\label{#3}
  167. %\end{figure}
  168. %}
  169. % um den kram kürzer zu schreiben
  170. \newcommand{\norm}[1]{\lvert #1 \rvert} % Betrag
  171. %\usepackage{showframe} % overfull hboxes deutlich sichtbar machen
  172. %% draft note
  173. %\usepackage{everypage}
  174. %\usepackage{datetime}
  175. %\AddEverypageHook{%
  176. %\begin{picture}
  177. % (0,0)%
  178. % \put(140,30){\fbox{\textbf{Draft of~\today~\currenttime}}}
  179. % %
  180. %\end{picture}\hfill
  181. %}
  182. \begin{document} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  183. \pagenumbering{Roman} % Seitenummerierung mit großen römischen Zahlen
  184. \pagestyle{empty} % keine Kopf- oder Fußzeilen auf den ersten Seiten
  185. % Titelseite
  186. \clearscrheadings\clearscrplain
  187. \begin{center}
  188. \begin{Large}
  189. Christian-Albrechts-Universität zu Kiel
  190. \\
  191. \vspace{20mm}
  192. \appname: \Thema
  193. \end{Large}\\
  194. \vspace{8mm}
  195. Project documentation\\
  196. \vspace{2.4 cm}
  197. Eren Bora Yilmaz (1036085)\\
  198. Kolja Samuel Strohm (1036051)\\
  199. Summer term 2018\\
  200. \vspace{8mm}
  201. \includegraphics[height=10cm]{img/logo}
  202. \end{center}
  203. \clearpage%\null\clearpage
  204. \pagestyle{scrheadings} %Seitenstil festlegen, damit die folgenden Einträge auch wirksam sind
  205. \cfoot*{\pagemark} %center, Fuß
  206. \chead{} %center, Kopf
  207. \ofoot{} %Außen, Fuß
  208. \ohead{\headmark} %Außen, Kopf
  209. \tableofcontents % erstelle hier das Inhaltsverzeichnis
  210. \listoffigures % erstelle hier das Abbildungsverzeichnis
  211. \listoftables % erstelle hier das Tabellenverzeichnis
  212. % \addchap{Symbolverzeichnis}\label{s.sym} % vergebe für das Symbolverzeichnis keine Kapitelnummer
  213. % \section*{Allgemeine Symbole}\label{s.sym.alg}
  214. % \begin{flushleft}
  215. % \begin{tabularx}{\textwidth}{l|X}
  216. % Symbol & Bedeutung\\\hline
  217. % $a$ & der Skalar $a$ \\
  218. % $\vec{x}$ & der Vektor $\vec{x}$\\
  219. % $\mat{A}$ & die Matrix $\mat{A}$\\
  220. % \end{tabularx}
  221. % \end{flushleft}
  222. % richtiger Inhalt
  223. \chapter{Introduction}\label{ch:introduction}
  224. \pagenumbering{arabic} % ab jetzt die normale arabische Nummerierung
  225. \input{chapter/1introduction}
  226. \chapter{Architecture}\label{ch:architecture}
  227. \input{chapter/2architecture}
  228. \chapter{UI and visuals}\label{ch:ui}
  229. \input{chapter/3ui}
  230. \chapter{Retrospection}
  231. \input{chapter/4retrospection}
  232. \appendix
  233. \chapter{Appendix}\label{ch:appendix}
  234. \input{chapter/appendix}
  235. \bibliographystyle{ieeetran}
  236. \bibliography{doc}
  237. \end{document}