Merge branch '15-create-documentation-boilerplate' into 'master'

Resolve "Create Documentation boilerplate"

Closes #15

See merge request marcel.schwarz/2020ss-qbc-geofence-timetracking!6

documentation/.gitignore

@@ -0,0 +1,277 @@
+documentation.pdf
+
+
+# Created by https://www.gitignore.io/api/latex
+# Edit at https://www.gitignore.io/?templates=latex
+
+### LaTeX ###
+## Core latex/pdflatex auxiliary files:
+*.aux
+*.lof
+*.log
+*.lot
+*.fls
+*.out
+*.toc
+*.fmt
+*.fot
+*.cb
+*.cb2
+.*.lb
+
+## Intermediate documents:
+*.dvi
+*.xdv
+*-converted-to.*
+# these rules might exclude image files for figures etc.
+# *.ps
+# *.eps
+# *.pdf
+
+## Generated if empty string is given at "Please type another file name for output:"
+.pdf
+
+## Bibliography auxiliary files (bibtex/biblatex/biber):
+*.bbl
+*.bcf
+*.blg
+*-blx.aux
+*-blx.bib
+*.run.xml
+
+## Build tool auxiliary files:
+*.fdb_latexmk
+*.synctex
+*.synctex(busy)
+*.synctex.gz
+*.synctex.gz(busy)
+*.pdfsync
+
+## Build tool directories for auxiliary files
+# latexrun
+latex.out/
+
+## Auxiliary and intermediate files from other packages:
+# algorithms
+*.alg
+*.loa
+
+# achemso
+acs-*.bib
+
+# amsthm
+*.thm
+
+# beamer
+*.nav
+*.pre
+*.snm
+*.vrb
+
+# changes
+*.soc
+
+# comment
+*.cut
+
+# cprotect
+*.cpt
+
+# elsarticle (documentclass of Elsevier journals)
+*.spl
+
+# endnotes
+*.ent
+
+# fixme
+*.lox
+
+# feynmf/feynmp
+*.mf
+*.mp
+*.t[1-9]
+*.t[1-9][0-9]
+*.tfm
+
+#(r)(e)ledmac/(r)(e)ledpar
+*.end
+*.?end
+*.[1-9]
+*.[1-9][0-9]
+*.[1-9][0-9][0-9]
+*.[1-9]R
+*.[1-9][0-9]R
+*.[1-9][0-9][0-9]R
+*.eledsec[1-9]
+*.eledsec[1-9]R
+*.eledsec[1-9][0-9]
+*.eledsec[1-9][0-9]R
+*.eledsec[1-9][0-9][0-9]
+*.eledsec[1-9][0-9][0-9]R
+
+# glossaries
+*.acn
+*.acr
+*.glg
+*.glo
+*.gls
+*.glsdefs
+
+# uncomment this for glossaries-extra (will ignore makeindex's style files!)
+# *.ist
+
+# gnuplottex
+*-gnuplottex-*
+
+# gregoriotex
+*.gaux
+*.gtex
+
+# htlatex
+*.4ct
+*.4tc
+*.idv
+*.lg
+*.trc
+*.xref
+
+# hyperref
+*.brf
+
+# knitr
+*-concordance.tex
+# TODO Comment the next line if you want to keep your tikz graphics files
+*.tikz
+*-tikzDictionary
+
+# listings
+*.lol
+
+# luatexja-ruby
+*.ltjruby
+
+# makeidx
+*.idx
+*.ilg
+*.ind
+
+# minitoc
+*.maf
+*.mlf
+*.mlt
+*.mtc[0-9]*
+*.slf[0-9]*
+*.slt[0-9]*
+*.stc[0-9]*
+
+# minted
+_minted*
+*.pyg
+
+# morewrites
+*.mw
+
+# nomencl
+*.nlg
+*.nlo
+*.nls
+
+# pax
+*.pax
+
+# pdfpcnotes
+*.pdfpc
+
+# sagetex
+*.sagetex.sage
+*.sagetex.py
+*.sagetex.scmd
+
+# scrwfile
+*.wrt
+
+# sympy
+*.sout
+*.sympy
+sympy-plots-for-*.tex/
+
+# pdfcomment
+*.upa
+*.upb
+
+# pythontex
+*.pytxcode
+pythontex-files-*/
+
+# tcolorbox
+*.listing
+
+# thmtools
+*.loe
+
+# TikZ & PGF
+*.dpth
+*.md5
+*.auxlock
+
+# todonotes
+*.tdo
+
+# vhistory
+*.hst
+*.ver
+
+# easy-todo
+*.lod
+
+# xcolor
+*.xcp
+
+# xmpincl
+*.xmpi
+
+# xindy
+*.xdy
+
+# xypic precompiled matrices
+*.xyc
+
+# endfloat
+*.ttt
+*.fff
+
+# Latexian
+TSWLatexianTemp*
+
+## Editors:
+# WinEdt
+*.bak
+*.sav
+
+# Texpad
+.texpadtmp
+
+# LyX
+*.lyx~
+
+# Kile
+*.backup
+
+# KBibTeX
+*~[0-9]*
+
+# auto folder when using emacs and auctex
+./auto/*
+*.el
+
+# expex forward references with \gathertags
+*-tags.tex
+
+# standalone packages
+*.sta
+
+### LaTeX Patch ###
+# glossaries
+*.glstex
+
+# End of https://www.gitignore.io/api/latex

documentation/documentation.tex

@@ -0,0 +1,70 @@
+\documentclass[a4paper, 11pt]{scrreprt}
+\usepackage[utf8]{inputenc}
+\usepackage[german]{babel}
+\usepackage[T1]{fontenc}
+\usepackage{amsmath}
+\usepackage{amsfonts}
+\usepackage{amssymb}
+\usepackage{graphicx}
+\usepackage{lmodern}
+\usepackage{enumitem}
+\usepackage[left=2cm,right=2cm,top=2cm,bottom=2cm]{geometry}
+\PassOptionsToPackage{hyphens}{url}
+\usepackage{hyperref}
+\usepackage{longtable}
+\usepackage{subcaption}
+\usepackage{scrlayer-scrpage}
+\usepackage{pdfpages}
+\usepackage{verbatim}
+\usepackage{ifsym}
+
+%Figures
+\usepackage{float}
+\usepackage[export]{adjustbox}
+\usepackage{wrapfig}
+\newcommand*{\source}[1]{\par\raggedleft\footnotesize Quelle:~#1} %source command fuer bildunterschriften
+
+\usepackage{setspace}
+\setstretch{1.2} %Zeilenabstand
+\setlength\parindent{0pt} %keine Paragrapheneinrueckung
+
+%Schriftart Arial (kommt von Linux dort heisst sie Helvetica)
+\usepackage{helvet}
+\renewcommand*{\familydefault}{\sfdefault}
+
+%Anfuehrungszeichen
+\usepackage[autostyle=true,german=quotes]{csquotes}
+\MakeOuterQuote{"}
+
+%Todos
+\usepackage{todonotes}
+%\missingfigure[figwidth=6cm]{Testing a long text string}
+
+%Tiefe des Inhaltsverzeichnisses
+\setcounter{tocdepth}{1}
+
+% Metadaten
+\author{Simon Kellner, Marcel Schwarz, Tobias Wieck, Tim Zieger}
+\title{Ubiquitous Computing \\ Projektarbeit \\ GeoTime}
+
+\begin{document}
+
+\include{parts/titlepage}
+
+\include{parts/abstract}
+
+\tableofcontents
+
+\listoffigures
+
+\include{parts/einleitung}
+
+\include{parts/projektidee}
+
+\include{parts/design}
+
+\include{parts/dev-setup}
+
+\include{parts/projektbericht}
+
+\end{document}          

documentation/parts/abstract.tex

@@ -0,0 +1,20 @@
+\begin{abstract}
+	{\huge Checkliste Lieferobjekte}
+	
+	\begin{itemize}
+		\item Ein Journal (z.B. Excel in Dropbox, Office 365, Google), in dem jedes Projektmitglied Tages- und Themenspezifisch seine geleisteten Arbeiten mit Aufwandsangabe listet. Z.b. "Hans 12.4 3 Std Backend Coding"- Das Journal muss zeitnah geführt werden und verfügbar sein. Ein unvollständiges Zeitjournal führt zur Abwertung in der Benotung.
+		\item Projektdokumentation (*: ca. 15-25 Seiten, je nach Bilderdichte)
+			\begin{itemize}
+				\item Source Code und alle erstellten Dokumente
+				\item Erläuterung des Designs (*)
+				\item Einrichtung der Entwicklungsumgebung (*) \\
+					(falls anwendbar, Standarddinge wie Eclipse, Android SDK müssen nicht detailliert erwähnt werden): 
+					\begin{itemize}
+						\item Welche Frameworks wurden für die Entwicklung benutzt und was gab es bei der Konfiguration / Installation dieser Tools zu beachten?
+						\item Wie wurden die Zielanwendungen erzeugt und z.B. auf ein Zielgerät	oder Server übertragen und dort aktiviert?
+					\end{itemize}
+				\item Projektbericht: Wie sind Sie vorgegangen, was wollten Sie	erreichen, was haben Sie gelernt, was gab es für Probleme, was haben Sie erreicht, wer hat was gemacht?
+			\end{itemize}
+		\item Datei mit der Präsentation
+	\end{itemize}
+\end{abstract}

documentation/parts/design.tex

@@ -0,0 +1 @@
+\chapter{Erläuterung des Designs}

documentation/parts/dev-setup.tex

@@ -0,0 +1,5 @@
+\chapter{Einrichtung der Entwicklungsumgebungen}
+
+	\section{Frameworks}
+
+	\section{Erzeugung der Binaries}

documentation/parts/einleitung.tex

@@ -0,0 +1 @@
+\chapter{Einleitung}

documentation/parts/projektbericht.tex

@@ -0,0 +1 @@
+\chapter{Projektbericht}

documentation/parts/projektidee.tex

@@ -0,0 +1 @@
+\chapter{Projektidee}

documentation/parts/titlepage.tex

@@ -0,0 +1,24 @@
+\begin{titlepage}
+	\centering
+	\leftline{\includegraphics[width=0.35\linewidth]{img/hft_logo}} \par
+	\textcolor{lightgray}{\rule{\linewidth}{1pt}}
+	\vspace{1cm}\\
+	{\scshape\LARGE Studiengang Informatik \\ Ubiquitous Computing \\ Sommersemester 2020 \par}
+	\vspace{2cm}
+	{\Huge\bfseries GeoTime \par}
+	{\LARGE Timetracking auf Standortbasis \par}
+	\vfill
+	{\Large \textsc{von}}
+	\vfill
+	\begin{tabular}{l r}
+		Simon Kellner & 72kesi1bif@hft-stuttgart.de\\
+		Marcel Schwarz & 72scma1bif@hft-stuttgart.de\\
+		Tobias Wieck & 72wito1bif@hft-stuttgart.de\\
+		Tim Zieger & 72ziti1bif@hft-stuttgart.de\\
+	\end{tabular}
+	\vfill
+	Betreuender Professor \\
+	Prof. Dr. Stefan \textsc{Knauth}
+	\vfill
+	{\large \today\par}
+\end{titlepage}