Initial commit

.gitignore

+/Documentation/out/
+/Documentation/latexdiff-base/
+/Documentation/gitDescription.tmp
\ No newline at end of file

.gitlab-ci.yml

+# GitLab CI configuration to build PDFs from LaTeX sources and Diffs of these.
+# (c) Farhad Mehta 2021
+
+image: registry.gitlab.com/islandoftex/images/texlive:TL2020-2020-04-12-04-19
+# This image corresponds to the initial TeX Live 2020 snapshot without any subsequent updates
+
+before_script:
+  - tlmgr --version
+  - git --version
+  - latex --version
+  - latexmk --version
+  # Note: it seems that `latexdiff --version` returns SIG(127) as an error code. Therefore use `|| true` to ignore this.
+  - latexdiff --version || true
+  # Check the current output from git-describe that may be added to the document
+  - git describe --exclude "latexdiff-base" --always --long --dirty --broken
+
+stages:
+  - build
+  - diff
+
+build_doc:
+  stage: build
+  # when: manual
+  script:
+    - cd Documentation
+    - make doc
+    - cd ..
+  artifacts:
+    paths:
+      - Documentation/out
+
+build_doc_diff:
+  stage: diff
+  needs: ["build_doc"]
+  script:
+    - cd Documentation
+    - make doc_diff
+    - cd ..
+  artifacts:
+    paths:
+      - Documentation/out
+
+build_proposal:
+  stage: build
+  # when: manual
+  script:
+    - cd Documentation
+    - make proposal
+    - cd ..
+  artifacts:
+    paths:
+      - Documentation/out
+
+# The following job duplicates the functionality of the previous ones, just in case one in confident that everyhting works and would like to build everyting in one job to save time and resources  
+build_proposal_doc_diff:
+  stage: build
+  when: manual
+  script:
+    - cd Documentation
+    - make proposal
+    - make doc
+    - make doc_diff
+    - cd ..
+  artifacts:
+    paths:
+      - Documentation/out

.project

+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>latex-documentation-template</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.texlipse.builder.TexlipseBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.texlipse.builder.TexlipseNature</nature>
+	</natures>
+</projectDescription>

.texlipse

+#TeXlipse project settings
+#Thu Jul 01 20:16:21 CEST 2021
+outputDir=Documentation/out/
+markDer=true
+mainTexFile=main.tex
+bibrefDir=
+builderNum=2
+outputFile=main.pdf
+makeIndSty=
+srcDir=Documentation/src/
+markTmpDer=true
+tempDir=Documentation/out
+outputFormat=pdf
+langSpell=

.vscode/settings.json

+{
+    "latex-workshop.latex.outDir": "../out",
+    "spellright.language": [
+        "en_GB"
+    ],
+    "spellright.documentTypes": [
+        "markdown",
+        "latex",
+        "plaintext"
+    ],
+    "spellright.groupDictionaries": false,
+    "spellright.notificationClass": "information",
+    "spellright.latexSpellParameters": [
+
+
+        "author",
+        "title",
+        "subtitle",
+        "date",
+        "chapter",
+        "section\\*?",
+        "subsection\\*?",
+        "subsubsection\\*?",
+        "part",
+        "paragraph",
+        "subparagraph",
+        "text(rm|sf|tt|md|bf|up|it|sl|sc|normal)",
+        "underline",
+        "emph",
+        "item",
+        "footnote(text)?",
+        "caption(of)?",
+        "multicolumn",
+        "href",
+        "hyperref",
+        "institute",
+        "frametitle",
+        "framesubtitle",
+        "begin\\{frame\\}",
+        "instructions"
+    ]
+}
\ No newline at end of file

.vscode/spellright.dict

+hyperref
+amsrefs
+TeXclipse
+latexdiff

Documentation/makefile

+# Make configuration to build PDFs from LaTeX sources and Diffs of these.
+# (c) Farhad Mehta 2020
+
+# Tested with the initial TeX Live 2020 snapshot without any subsequent updates
+
+gitDescription:
+	git describe --exclude "latexdiff-base" --always --long --dirty --broken > gitDescription.tmp
+
+doc: gitDescription
+	# Note: pdflatex does not work well when the out and aux directories are different
+	latexmk -outdir=../out -cd -interaction=batchmode -pdf src/main.tex
+
+proposal: gitDescription
+	# Note: pdflatex does not work well when the out and aux directories are different
+	latexmk -outdir=../out -cd -interaction=batchmode -pdf src/project-proposal-standalone.tex
+
+gitDiffDescription:
+	# Note the double $ are needed to escape the $ within a makefile.
+	# Use only one $ when running the following command in the shell.
+	printf "%s (diff with %s)" $$(git describe --exclude "latexdiff-base" --always --long --dirty --broken) $$(git describe  --exclude "latexdiff-base" --always --long latexdiff-base) > gitDescription.tmp
+
+doc_diff: gitDiffDescription
+	rm -rf latexdiff-base
+	mkdir latexdiff-base
+	git archive --format=tar latexdiff-base | (cd latexdiff-base && tar xf -)
+	# Note: Change to the base directory before running latexdiff. Otherwise the .sty files cannot be found.
+	# Note: In the makefile, each command is executed in a sub-process shell. Therefore, one needs to chain `cd` using `&&` or `;` into one command.
+	# Note: The `-` prefix instructs make to ignore the exit code of the command. The exit code of the following command is ignored since latexdiff and pdflatex do not work well together. Pdflatex generates an error, but is still able to generate the document. 
+	-cd latexdiff-base/src && \
+		latexdiff -V --flatten main.tex  ../../src/main.tex > diff.tex && \
+		latexmk -outdir=../../out -cd -interaction=batchmode -pdf -f diff.tex
+
+all: proposal doc doc_diff
+
+clean:
+	rm -rf out
+	rm -rf latexdiff-base
+	rm gitDescription.tmp
+

Documentation/src/01_product-documentation/01_vision.tex

+\chapter{Vision}
+
+\instructions{
+    Describe the vision for the product on 1 page as covered in the SEP1 module.
+}
\ No newline at end of file

Documentation/src/01_product-documentation/02_domain-analysis.tex

+\chapter{Domain Analysis}
+
+\instructions{
+    Describe the problem domain using a domain model as covered in the SEP1 module.
+}
\ No newline at end of file

Documentation/src/01_product-documentation/03_requirements.tex

+\chapter{Requirements}
+
+\instructions{
+    Describe the functional and non-functional requirements as covered in the SEP1 module.
+}
+
+
+\section {Functional Requirements}
+
+
+\section {Non-Functional Requirements}
\ No newline at end of file

Documentation/src/01_product-documentation/04_architecture.tex

+\chapter{Architecture}
+
+\todo{KaTh}
\ No newline at end of file

Documentation/src/02_project-documentation/01_project-proposal.tex

+
+
+\paragraph{Project name:} XXX
+
+\instructions{ \noindent A short abbreviated name for the proposed project. Should be one word with at most 20 characters in UpperCamelCase. Examples: BorrowApp, TimeTracker. }
+
+\subsubsection*{Team Members}
+
+\begin{compactenum}
+    \item FirstName LastName (\href{mailto:firstName.lastName@ost.ch}{firstName.lastName@ost.ch})
+    \item FirstName LastName (\href{mailto:firstName.lastName@ost.ch}{firstName.lastName@ost.ch})
+    \item FirstName LastName (\href{mailto:firstName.lastName@ost.ch}{firstName.lastName@ost.ch})
+    \item FirstName LastName (\href{mailto:firstName.lastName@ost.ch}{firstName.lastName@ost.ch})
+    \item FirstName LastName (\href{mailto:firstName.lastName@ost.ch}{firstName.lastName@ost.ch})
+    \item FirstName LastName (\href{mailto:firstName.lastName@ost.ch}{firstName.lastName@ost.ch})
+\end{compactenum}
+
+\subsubsection*{Availabilities}
+
+% Table generated using https://www.tablesgenerator.com
+
+\begin{flushleft}
+    \begin{tabular}{|c|c|c|c|c|c|}
+        \hline
+        Time slot   & Mon & Tue & Wed & Thu & Fri \\ \hline
+        08h00-09h00 & X   & X   & X   & X   & X   \\ \hline
+        09h00-10h00 & X   & X   & X   & X   & X   \\ \hline
+        10h00-11h00 & X   & X   & X   & X   & X   \\ \hline
+        11h00-12h00 & X   & X   & X   & X   & X   \\ \hline
+        \rowcolor[HTML]{EFEFEF}
+        12h00-13h00 & X   & X   & X   & X   & X   \\ \hline
+        13h00-14h00 & X   & X   & X   & X   & X   \\ \hline
+        14h00-15h00 & X   & X   & X   & X   & X   \\ \hline
+        15h00-16h00 & X   & X   & X   & X   & X   \\ \hline
+        16h00-17h00 & X   & X   & X   & X   & X   \\ \hline
+        \rowcolor[HTML]{EFEFEF}
+        17h00-18h00 & X   & X   & X   & X   & X   \\ \hline
+        \rowcolor[HTML]{EFEFEF}
+        18h00-19h00 & X   & X   & X   & X   & X   \\ \hline
+    \end{tabular}
+
+\end{flushleft}
+
+
+\instructions{
+
+    \noindent Please mark ALL time slots during which every team member can attend review meetings.
+
+    \begin{flushleft}
+        \begin{tabular}{|c|l|}
+            \hline
+            X   & Slot available                  \\ \hline
+            (X) & Slot available, but not optimal \\ \hline
+        \end{tabular}
+    \end{flushleft}
+
+    The more slots that are available, the more likely it is that you will get an optimal slot and coach assignment. You are required to have a minimum of 5 slots available during regular working hours (08h-12h, 13h-17h) to be eligible to form a team.
+}
+
+
+
+\subsubsection*{Project Idea}
+
+\instructions{ \noindent A short (1-2 paragraph) description of what you plan to implement, the problem it solves, for whom, and your motivation for choosing it. }
+
+\subsubsection*{Proposed Realisation}
+
+\instructions{ \noindent A short (1 paragraph) description of the technologies, languages and frameworks that you plan to use to realise your project. Your choices at this point are not binding, but need to be plausible. }
+

Documentation/src/02_project-documentation/02_project-plan.tex

+\chapter{Project Plan}

Documentation/src/02_project-documentation/03_time-tracking-report.tex

+\chapter{Time Tracking Report}
\ No newline at end of file

Documentation/src/02_project-documentation/04_project-summary.tex

+\chapter{Project Summary}
\ No newline at end of file

Documentation/src/02_project-documentation/05_personal-reports.tex

+\chapter{Personal Reports}
\ No newline at end of file

Documentation/src/bibliography.bib

+
+
+@book{larman_applyingUmlAndPatterns_2004,
+  added-at = {2013-02-28T11:13:35.000+0100},
+  address = {Upper Saddle River, NJ, USA},
+  author = {Larman, Craig},
+  isbn = {0131489062},
+  publisher = {Prentice Hall PTR},
+  title = {Applying UML and Patterns: An Introduction to Object-Oriented Analysis and Design and Iterative Development (3rd Edition)},
+  year = 2004
+}

Documentation/src/custom.tex

+% File containing the commands and definitions
+% that are used throughout this project.
+
+% Set input encoding
+\usepackage[utf8]{inputenc}
+
+% For creating coloured text and backgrounds
+\usepackage[table,xcdraw]{xcolor}
+
+% For creating compact lists
+\usepackage{paralist}
+
+% To get the current date and time
+\usepackage{datetime2}
+
+% For including graphics
+\usepackage{graphicx}
+
+% Custom commands
+
+\newcommand{\todo}[1]{TODO: {#1}}
+
+% The following command indicates that its content consists of instructions
+% Even if it does not do anything, it is still a good idea to keep instructions within the `instruction` tag to separate them from the rest of the text. One could then typeset them differently, or choose to remove them form the document by redefining the command definition 
+\newcommand{\instructions}[1]{#1}
+
+% Uncomment the following command to remove all instructions
+% \newcommand{\instructions}[1]{}
+
+% Uncomment the following to make instructions appear in coloured boxes
+% Note: The changes within `\instruciton` are not visible in latexdiff when they are typeset in this way
+% \usepackage{tcolorbox}
+% \newcommand{\instructions}[1]{
+%     \begin{tcolorbox}[sharp corners, colback=green!30, colframe=green!80!blue, title=Instructions]
+%         #1
+%     \end{tcolorbox}
+% }
+
+% Uncomment the following to make instructions appear in colour.
+% Note: The changes within `\instruciton` are not visible in latexdiff when they are typeset in this way
+% \newcommand{\instructions}[1]{ { \color{blue} #1 } }
+
+% Get a git version description roughly using the idea in  
+% https://blog.wxm.be/2013/08/20/automated-git-commit-number-in-latex.html
+% Note that the file that is included needs to be generated before the document is built.
+% Refer to the makefile for further details.
+\IfFileExists{../gitDescription.tmp}
+{\newcommand{\gitDescription}{\input{../gitDescription.tmp}}}
+{\newcommand{\gitDescription}{Not available}}
+
+% Note: Importing hyperref must be done towards the end since it
+% redefines many macros
+%
+% Note:
+%  The following packages must be imported *before* hyperref:
+%  
+%  The following packages must be imported *after* hyperref:
+%    amsrefs, geometry
+\usepackage{hyperref}
+
+\usepackage{geometry}
+
+% options for package geometry (influences writable area on page)
+% \geometry{a4paper, top=2cm, bottom=2cm}

Documentation/src/instructions.tex

+\chapter*{Instructions for using this template}
+
+\begin{enumerate}
+    \item The main aim of this document template is to allow you to start working on your project documentation as quickly as possible.
+    \item In addition to recommending a rough structure for your project documentation, this template also contains instructions related to the content and execution your project. Instructional text is typeset within the \LaTeX\ \texttt{instructions} command defined in \texttt{custom.tex}. Make sure that your final submission does not contain any instructional texts.
+    \item The basic defaults that \LaTeX provides have been used whenever possible in order to keep the template as simple as possible for beginners. One can do better. \LaTeX also provides additional features such as glossaries, abbreviation lists and indexes that you may find useful. Feel free to customise the typesetting and content of this document as per your requirements, tastes and wishes as you progress with the project.
+    \item Here is an example of a bibliography reference: \cite{larman_applyingUmlAndPatterns_2004}
+\end{enumerate}
+