final chapter 6

.gitignore

@@ -10,3 +10,4 @@
 *.tex~
 *.tcp
 .gitignore~
+*.tex.backup

Dokumentation/Gruppendoku/chapter/1_introduction.tex

@@ -1,13 +1,18 @@
 %introduction
 \renewcommand{\abstractname}{Introduction}
 \begin{abstract}
-The sole purpose of this document is to describe the complete process of the project, which was done in the cooperation of the
-Carmeq GmbH and the Free University of Berlin, with the topic of intermodal passenger transportation.
+	The sole purpose of this document is to describe the complete process of the project, which was done in the cooperation of
+the
+	Carmeq GmbH and the Free University of Berlin, with the topic of intermodal passenger transportation.
 
-\emptyRow
-At the beginning of this course there were 18 students enrolled for this course. They have been divided into 4 teams, which
-worked separately from the beginning.
-\end{abstract}
+	\emptyRow
+	At the beginning of this course there were 18 students enrolled for this course. They have been divided into 4 teams,
+which
+	worked separately from the beginning.
+	This documentation is done by team 1 which did consist of five students, but unfortunately one had to leave the project
+due to	private circumstances.
+
+	Team 1 consists of the following four persons, who are, from left to right, Sebastian, Mareike, Tom and Andreas.
 
-\includegraphics[width=\textwidth]{images/team1.jpg}
-\clearpage
+	\includegraphics[width=\textwidth]{images/team1.jpg}
+\end{abstract}

Dokumentation/Gruppendoku/chapter/5_paper_prototype.tex

@@ -56,4 +56,11 @@ \subsection{implementation}
 these misconceptions. But also semantic failures were offered. All things considered these tests helped us a lot. And the best was
 they didn't take much time.
 
+\section{User stories}\label{sec:US}
+Following will be shown all user stories that were planned during this project.
+You can retrieve more information if you follow the link to our issue tracker (see
+\footnote{\url{https://github.com/nutztherookie/swp_kp2_2012_gruppe1/issues}}). There most of our tasks, which came up during the
+implementation, are covered. There are also some issues which are labeled with the prefix "wishlist", these are suggestions how
+the software could be improved in the future.
 
+\includepdf[pages=-, pagecommand={\thispagestyle{fancy}}]{images/User_Stories.pdf}

Dokumentation/Gruppendoku/chapter/6_prototype.tex

@@ -11,13 +11,7 @@
 Last but not least the focus of section \ref{sec:Andr} will be on the Android application. Here you will find a brief description
 of its functions (see \ref{ssec:AndrDes}), some design thoughts regarding the class diagram and a description of the classes which
 are used by the app (see \ref{ssec:AndrArc}) as well as an installation guide to run the app on your mobile device (see
-\ref{ssec:AndrInst}). 
-
-\emptyRow
-You can retrieve more information if you follow the link to our issue tracker
-(\url{https://github.com/nutztherookie/swp_kp2_2012_gruppe1/issues}) Here most of our task which came up while the implementation
-are covered. There are also some issues which are labeled with the prefix "wishlist", these are suggestions how one could improve
-the service in the future. The whole document with all estimated users stories can be found in appendix \ref{chp:US}.
+\ref{ssec:AndrInst}).
 
 \clearpage
 

Dokumentation/Gruppendoku/chapter/6_webservice.tex

@@ -8,19 +8,19 @@ \subsection{Prolog}\label{ssec:WebProlog}
 With the programming language chosen, a big step had been done, but another big one was not yet done, as we did not know which
 framework we should use with Scala. As every member of the team did not have any experience in working with Scala, we did some
 research and tried what we thought could be a possible option. That way we could gain a little insight into the framework and how
-it works and what it has to offer. At this point in time we tried Play2.0(\url{http://www.playframework.org/}) and
+it works and what it has to offer. At this point in time we tried Play!2(\url{http://www.playframework.org/}) and
 Lift(\url{http://liftweb.net/}). Due to its simplicity in programming and the efficiency of the written code, we decided to use
 Lift.\newline
 With these decisions done, the next step to go was to create a basic website and some basic functionality, as planned for the
 first iteration, in which we did plan on having some time to get friendly with a new framework and a new language.
 Half a week later, with a very busy weekend for every team member, we evaluated if Lift was indeed a good choice and if we are
 confident to be able to create a product as planned in the given time slot.
-Unfortunately we all had the same thoughts about Lift and came to the solution that it would be better if we would use Play2.0 as
+Unfortunately we all had the same thoughts about Lift and came to the solution that it would be better if we would use Play!2 as
 its use is not as complicated as it is with Lift. Lift is very efficient when it comes to written code and its results, but to
 understand what is going on in the framework, so that we could create a good product the way we want it to be, would have needed
 more time for familiarizing. But time was not that abundant, as we had a deadline every two weeks until which we had to have a
 presentable result.
-For that reason we did fall back onto Play2.0 and had to invest more time as planned for the first iteration as we were out of
+For that reason we did fall back onto Play!2 and had to invest more time as planned for the first iteration as we were out of
 plan already without even having anything to use.
 
 \subsection{Description}\label{ssec:WebDesc}
@@ -83,6 +83,24 @@ \subsection{Description}\label{ssec:WebDesc}
 
 \subsection{Architecture}\label{ssec:WebArchitecture}
 
+With using the Play!2 framework, the basic structure of the program is predetermined and modular(see
+\footnote{\url{http://www.playframework.org/documentation/2.0.2/Anatomy}}).
+In the app-folder most of the programming files are to be found, with the exception of .css and .js files.
+Apart from the programming files there are some very import files which are necessary for setting up the software.
+These are the application.conf in the conf-folder, the routes-file in the conf-folder, the Build.scala and the plugins.sbt,
+they are mainly used for configuring the application. Aside from that the routes-file is being used for handling incoming
+requests and therefore it contains the REST-API, as every request has to be declared in this file.
+Another important part in Play!2 is the evolutions-folder, which is contained in the conf-folder. Using evolutions is a pretty
+way to apply necessary changes onto a running system which should not lose any of its data. But the downside is, that Play!2 uses
+ANORM, which is not that capable as simple SQL. Even so Play!2 uses ANORM, you have to use SQL-queries either way, but with the
+restrictions that come along with ANORM, as noted in the database section of this documentation.
+For example ANORM is not able to handle two joins onto the same data table, even so simple SQL allows the separation of these
+two tables, or more complex queries, obviously ANORM needs to be improved quite a bit to be usable without workarounds for the
+really interesting tasks you wish to do.\newline
+
+On the other hand, Play!2 with Scala is a framework that does not need that much orientation to get to the first results, only if
+you want to deep in digger and do more complex work you need to have some time, as the documentation of Play!2 with Scala is not
+yet that big.
 
 \subsection{Installation guide - Webservice}\label{ssec:WebInst}
 

Dokumentation/Gruppendoku/chapter/7_appendix.tex

@@ -41,8 +41,3 @@ \chapter{Images}
 	\caption{class diagram of the TaWusel Android app}
 	\label{img:AndCl}
 \end{figure}
-
-\chapter{User stories}\label{chp:US}
-In this chapter yo will find the document which contains all sprint informations which arose from the project progress.
-
-\includepdf[pages=-, pagecommand={\thispagestyle{fancy}}]{images/User_Stories.pdf}

Dokumentation/Gruppendoku/swp_gruppendoku.tex

@@ -30,221 +30,6 @@
 \usepackage{wrapfig}
 \usepackage{abstract}
 
-%r‰nder anpassen
-\geometry{a4paper, top=28mm, left=27mm, right=26mm, bottom=30mm, headsep=8mm, footskip=12mm}
-
-%farben f¸r den text (listings definieren)
-\definecolor{darkblue}{rgb}{0,0,.5}
-\definecolor{wine}{rgb}{0.53,0.047,0.047}
-\definecolor{lightgray}{rgb}{.2,.2,.2}
-\definecolor{darkgreen}{rgb}{0,.4,0}
-
-\hypersetup{colorlinks, pdfauthor={Tom Bullmann, Andreas N\"u\ss{}lein, Sebastian Schulz, Mareike Ziese},
-	pdftitle={TaWusel},
-	pdfnewwindow=true, linkcolor=black, citecolor=black,
-	filecolor=darkgreen, urlcolor=blue}
-
-%formatierung der listings
-\renewcommand{\lstlistingname}{Code listings}
-\lstset{
-	tabsize=2,
-	%kleine schriftgrˆfle
-	basicstyle=\footnotesize \bfseries\ttfamily,
-	keywordstyle=\color{wine},
-	identifierstyle=\mdseries \color{black},
-	commentstyle=\itshape\mdseries\color{darkgreen},
-	stringstyle=\ttfamily,
-	showstringspaces=false,
-	stringstyle=\color{darkblue},
-	%chars to escape inline = (*this is escaped*)
-	escapeinside={(*@}{@*)},
-	language=Java
-}
-
-\lstset{
-	numbers=left,
-	numberstyle=\scriptsize,
-	stepnumber=1,
-	numbersep=5pt
-}
-
-\lstset{
-	captionpos=t,
-	frame=single,
-	frameround=tttt,
-	breaklines=true,
-	breakatwhitespace=true,
-	showlines=true,
-}
-
-\lstset{
-	emph={logger,
-		properties,
-		dbConnection,
-		instance
-	},
-	emphstyle= {\itshape \color{darkblue}},
-}
-
-
-%variablen
-\newcommand{\code}[1]{{\small\ttfamily #1}}
-\newcommand{\codeCap}[1]{\textsc{\small #1}}
-
-\begin{document}
-
-	%kopf- und fuflzeilen
-	\setlength{\headheight}{28pt}
-	\pagestyle{fancy}
-	\fancyhf{}
-	\lhead{Team 1}
-	\chead{\textbf{SWP: Client project II - Web technologies} \\ Lecturer: Prof. Dr. M\"uller-Birn}
-	\rhead{SS 12 \\ \today}
-	\cfoot{\tiny{Free University of Berlin\\ Department of Mathematics and Computer Science\\
-Institute of Computer Science}}	
-	\rfoot{\smallskip \thepage}
-	\renewcommand{\footrulewidth}{0.4pt} %untere Trennlinie
-
-	%kopf und fuflzeilen f¸r alle seiten (auch inhalt und anhang)
-	\fancypagestyle{plain}{
-    \fancyhf{}
-		\lhead{Team 1}
-		\chead{\textbf{SWP: Client project II - Web technologies} \\ Lecturer: Prof. Dr. M\"uller-Birn}
-		\rhead{SS 12 \\ \today}
-		\cfoot{\tiny{Free University of Berlin\\ Department of Mathematics and Computer Science\\ Institute of Computer
-Science}}	
-		\rfoot{\smallskip \thepage}
-		\renewcommand{\footrulewidth}{0.4pt} %untere Trennlinie	
-	}
-
-	\renewcommand{\chaptermark}[1]{\markboth{\thechapter.\ #1}{}}
-	\newcommand{\emptyRow}{\medskip \noindent}
-
-
-	%rˆmische bezifferung
-	\pagenumbering{Roman}
-	\setcounter{page}{0}
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% VORBEMERKUNGEN & VERZEICHNISSE
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%	
-
-	%deckblatt
-	\input{chapter/0_cover}
-
-	%inhaltsverzeichnis
-	\clearpage
-	\addcontentsline{toc}{chapter}{Table of contents} 
-	\tableofcontents
-
-	%abbildungsverzeichnis
-	\clearpage
-	\addcontentsline{toc}{chapter}{Table of figures}
-	\listoffigures
-
-	%tabellenverzeichnis
-	\clearpage
-	\addcontentsline{toc}{chapter}{List of tables}
-	\listoftables
-
-	%Listingsverzeichnis
-	\clearpage
-	\addcontentsline{toc}{chapter}{Code listings}
-	\renewcommand{\lstlistlistingname}{Code listings}
-	\lstlistoflistings
-
-	\clearpage
-
-	%abstand im inhaltsverzeichnis
-	\addtocontents{toc}{\protect\vspace*{0.6\baselineskip}}
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% HAUPTTEIL
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-	%seiten in arabisch durchnummerieren
-	\clearpage
-	\pagenumbering{arabic}
-	\setcounter{page}{1}
-
-	%einleitung
-	%\chapter{Introduction}\label{chp:Intr}
-	\input{chapter/1_introduction}
-
-	%anforderungsanalyse
-	\chapter{Requirement engineering}\label{chp:ReqE}
-	\input{chapter/2_requirement_engineering}
-
-	%Modellierung
-	\chapter{Modeling}\label{chp:Mod}
-	\input{chapter/3_modeling}	
-
-	%conception
-	\chapter{Conception}\label{chp:Conc}
-	\input{chapter/4_conception}
-
-	%paper prototype
-	\chapter{Paper prototype}\label{chp:PapP}
-	\input{chapter/5_paper_prototype}
-
-	%prototype
-	\chapter{Prototype implementation}\label{chp:Prot}
-	\input{chapter/6_prototype}
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% LITERATURVERZEICHNIS & ANHÆ’NGE 
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-	\clearpage
-
-	%abstand im inhaltsverzeichnis
-	\addtocontents{toc}{\protect\vspace*{0.5\baselineskip}}
-
-	%appendix
-	\clearpage
-	\appendix
-	\input{chapter/7_appendix}
-
-	%literaturverzeichnis
-%	\addcontentsline{toc}{chapter}{Literaturverzeichnis}
-
-	%nicht-zitierte BibTeX-Eintr‰ge anzeigen
-%	\def\btxmastthesis{Ausarbeitung}
-%	\def\btxvolumelong{Auflage}
-%	\def\btxandlong{und}
-%	\bibliographystyle{mygeralpha}
-%	\bibliography{literatur}
-
-\end{document}
-=======
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% GENERELLE EINSTELLUNGEN
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%	
-
-%dokumentenklasse
-\documentclass[a4paper,oneside,12pt,titlepage,chapterprefix]{scrreprt}
-
-%packages
-\usepackage[english]{babel}
-\usepackage[T1]{fontenc}
-\usepackage[utf8]{inputenc}
-\usepackage{lmodern} 
-\usepackage{graphicx}
-\usepackage{setspace}
-\usepackage{fancyhdr}
-\usepackage[header=plain, number=none, toc=true]{glossary}
-\usepackage{url}
-\usepackage{booktabs}
-\usepackage{paralist}
-\usepackage{enumitem}
-\usepackage[bookmarksnumbered=true]{hyperref}
-\usepackage{color}
-\usepackage{listings}
-\usepackage{floatflt}
-\usepackage{geometry}
-\usepackage{pdfpages}
-
 %ränder anpassen
 \geometry{a4paper, top=28mm, left=27mm, right=26mm, bottom=30mm, headsep=8mm, footskip=12mm}
 
@@ -358,17 +143,6 @@
 	\addcontentsline{toc}{chapter}{Table of figures}
 	\listoffigures
 
-	%tabellenverzeichnis
-	\clearpage
-	\addcontentsline{toc}{chapter}{List of tables}
-	\listoftables
-
-	%Listingsverzeichnis
-	\clearpage
-	\addcontentsline{toc}{chapter}{Code listings}
-	\renewcommand{\lstlistlistingname}{Code listings}
-	\lstlistoflistings
-
 	\clearpage
 
 	%abstand im inhaltsverzeichnis
@@ -384,7 +158,6 @@
 	\setcounter{page}{1}
 
 	%einleitung
-	\chapter{Introduction}\label{chp:Intr}
 	\input{chapter/1_introduction}
 
 	%anforderungsanalyse
@@ -400,7 +173,7 @@
 	\input{chapter/4_conception}
 
 	%paper prototype
-	\chapter{Paper prototype}\label{chp:PapP}
+	\chapter{Paper prototype and User Stories}\label{chp:PapP}
 	\input{chapter/5_paper_prototype}
 
 	%prototype
@@ -432,4 +205,4 @@
 %	\bibliography{literatur}
 
 \end{document}
->>>>>>> Stashed changes
+