adding univeristy latex files

1_front_matter/contents.tex

@@ -0,0 +1,39 @@
+% line spacing
+\begin{onehalfspace}
+
+\newpage
+
+\renewcommand{\contentsname}{Table of Contents} % rename the table of content
+\clearpage
+\phantomsection % declare an empty section/chapter to LaTeX for hyperlinks
+\addcontentsline{toc}{chapter}{Table of Contents} % add an entry to the table of content
+\setcounter{tocdepth}{2} % set depth of ToC, 0 = cha, 1 = sec, etc.
+\tableofcontents % the actual table of content command
+
+
+\clearpage
+\phantomsection
+\addcontentsline{toc}{chapter}{List of Figures}
+\listoffigures % the list of figure command
+
+\clearpage
+\phantomsection
+\addcontentsline{toc}{chapter}{List of Tables}
+\listoftables % the list of table command
+
+\clearpage
+\phantomsection
+\addcontentsline{toc}{chapter}{List of Equations}
+\listofmyequations % a custom list of equation command
+
+\clearpage
+\phantomsection
+\addcontentsline{toc}{chapter}{List of Algorithms}
+\listofmyalgorithms % a custom list of algorithm command
+
+\clearpage
+\phantomsection
+\addcontentsline{toc}{chapter}{\lstlistlistingname}
+\lstlistoflistings % the list of code listings
+
+\end{onehalfspace}

1_front_matter/preamble.tex

@@ -0,0 +1,22 @@
+% remove the header on page
+\thispagestyle{plain}
+
+\phantomsection % declare an empty section/chapter to LaTeX for hyperlinks
+\section*{Abstract} % Unnumbered section
+\addcontentsline{toc}{chapter}{Abstract} % Add entry to table of content, as chapter
+Here is a summary of the work presented in this dissertation.
+
+\phantomsection
+\section*{Declaration}
+\addcontentsline{toc}{chapter}{Declaration}
+I, \docAuthor\ confirm that this work submitted for assessment is my own and is expressed in my own words. Any uses made within it of the works of other authors in any form (e.g., ideas, equations, figures, text, tables, programs) are properly acknowledged at any point of their use. A list of the references employed is included.
+
+Signed:
+
+Date:
+
+\phantomsection
+\section*{Acknowledgements}
+\addcontentsline{toc}{chapter}{Acknowledgements}
+I thank this and that person for their help.
+

1_front_matter/titlepage.tex

@@ -0,0 +1,44 @@
+\begin{titlepage}
+
+\begin{center}
+	% Title (and subtitle)
+	~\\[1cm]
+	{\huge \titleColor \textbf{\docTitle}}\\
+	~\\[1.5cm]
+	
+	% Author(s)
+	{\huge \docAuthor}\\[1cm]
+	{\Large BSc (Hons) Computer Science}\\[0.3cm]
+	{\Large Final Year Dissertation}\\[1cm]
+	{\large \textit{Supervised by} {\Large \docSupervisor}}
+	~\\[2cm]
+	
+	% Organisation
+	\begin{figure}[h]
+		\begin{center}
+		\includegraphics[]{1_front_matter/hwcoa_bw.jpg}
+		\end{center}
+	\end{figure}	
+	~\\[0cm]
+	\begin{large}
+		\textsc{Heriot-Watt University}\\
+		School of Mathematical and Computer Sciences\\
+		Department of Computer Science
+	\end{large}
+	~\\[1cm]
+	
+	% Date
+	{\Large \docDate}\\
+	~\\[1.5cm]
+	
+	% Copyright
+	\begin{minipage}{0.7\textwidth}
+	\singlespacing
+	\begin{footnotesize}
+	The copyright in this dissertation is owned by the author. Any quotation from the dissertation or use of any of the information contained in it must acknowledge it as the source of the quotation or information.
+	\end{footnotesize}
+	\end{minipage}
+	
+\end{center}
+
+\end{titlepage}

2_main_body/background.tex

@@ -0,0 +1,21 @@
+\chapter{Background}
+\label{cha:back}
+
+Some text to explain what's to come. In \cref{sec:back_A} we explore concept A, then we continue with concept B in \cref{sec:back_B}
+
+\section{Concept A}
+\label{sec:back_A}
+
+Doe introduces the context of Y \cite{doe2017exploring}. Smith et al. discuss the implementation of X \cite{smith2018implementing}. We implement W, as describe by Alice \cite{alice2016handbook}.
+
+\section{Concept B}
+\label{sec:back_B}
+
+More references.
+
+\section{Conclusion}
+\label{sec:back_concl}
+
+Here we conclude the background, recap concepts explored and key notions for rest of document.
+
+In next chapter, \cref{cha:dev}, we do some implementation for concept A. \cref{cha:eval} will detail our evaluation of concept B.

2_main_body/code/gcd.py

@@ -0,0 +1,10 @@
+import library
+
+# GCD of a and b
+def my_gcd(a, b):
+    t = b
+    while not b == 0:
+        t = b
+        b = a % b
+        a = t
+    return a

2_main_body/conclusion.tex

@@ -0,0 +1,21 @@
+\chapter{Conclusion}
+\label{cha:concl}
+
+This is the conclusion of this dissertation. We re-contextualise the motivation for the project (\cref{sec:concl_motiv}), list our contributions \cref{sec:concl_contrib}, and finally discuss the limitation of the project and suggest future work \cref{sec:concl_limit}.
+
+\section{Motivation and Goals}
+\label{sec:concl_motiv}
+
+Here we will summarise briefly what were the motivations for the project, and the main objectives we tried to achieve.
+
+\section{Contributions}
+\label{sec:concl_contrib}
+
+Here we will summarise the main contributions and achievements of this project, in relation to the initial objectives, and in contrast with similar work found in the background chapter (\cref{cha:back}).
+
+We will also summarise some of the methodology used to achieve goals and tackle problems.
+
+\section{Limitations and Future Work}
+\label{sec:concl_limit}
+
+Here we will highlight the main limitations of the project, and suggest possible corrections, extensions, or uses for our work in future projects.

2_main_body/development.tex

@@ -0,0 +1,86 @@
+\chapter{Development}
+\label{cha:dev}
+
+Here be some development specifications. We follow the steps for concept A, as highlighted in \cref{cha:back}, \cref{sec:back_A}. In \cref{sec:dev_bck} we discuss the back-end, while \cref{sec:dev_frt} will focus on front-end development.
+
+\section{Back-end}
+\label{sec:dev_bck}
+
+Server stuff here. See \cref{eq:my_equation} and \cref{eq:aligned,eq:my_other_equation} that explains the maths behind application.
+
+\begin{equation}~\label{eq:my_equation}
+    B = \sum_{\ratioA \in A} \ratioA \times \epsilon
+\end{equation}
+\myequations{My Equation for B}
+
+\begin{align}
+	X & = a^{\epsilon} \nonumber \\
+	Z & = \frac{\sqrt{A \times B}}{\sum_{\gamma \in \Gamma} \gamma} \label{eq:aligned}
+\end{align}
+\myequations{System for X Z}
+
+\begin{equation}~\label{eq:my_other_equation}
+    x(r) =
+        \begin{dcases*}
+		a^2 + \sqrt{3} b & if $r$ is even \\
+		a^2 + \frac{\sqrt{3}}{2} b & if $r$ is odd
+		\end{dcases*}
+\end{equation}
+\myequations{Equation for x}
+
+The algorithm for X (\cref{alg:euclid}) has such and such advantages. The Pyhton implementation is shown in \cref{lst:gcd}.
+
+\begin{algorithm}
+\caption{Euclidean Algorithm}\label{alg:euclid}\myalgorithms{Euclidean Algorithms}
+\begin{algorithmic}[1]
+\Function{Euclid}{$a,b$}\Comment{Finding the GCD of $a$ and $b$}
+\While{$b \neq 0$}
+    \State $t \gets b$
+    \State $b \gets a \mod b$
+    \State $a \gets t$
+\EndWhile
+\State \textbf{return} $a$
+\EndFunction
+\end{algorithmic}
+\end{algorithm}
+
+\lstinputlisting[language=Python, caption=Python example of GCD, label={lst:gcd}]{2_main_body/code/gcd.py}
+
+\section{Front-end}
+\label{sec:dev_frt}
+
+Interface specs here. See the mockup for interface in \cref{fig:mockup_front-end}\footnote{Complete details in \cref{app:screen}, page \pageref{app:screen}}.
+
+In \cref{fig:flowchart_a} we detail the data flow for process A and while process B is shown in \cref{fig:flowchart_b}.
+
+\begin{figure}[ht]
+    \centering
+    \includegraphics[width=.7\textwidth]{2_main_body/images/mockup.png}
+    \caption[Front-end mockup]{Front-end mockup. With an added description to help the reader (won't appear in list of figures).}
+    \label{fig:mockup_front-end}
+\end{figure}
+
+\begin{figure}[ht]
+    \centering
+    \hspace{1cm}
+    \begin{subfigure}{.35\textwidth}
+        \centering
+        \includegraphics[width=\columnwidth]{2_main_body/images/flowchartA.png}
+        \caption{Flowchart A.}~\label{fig:flowchart_a}
+    \end{subfigure}
+    \hfill
+    \begin{subfigure}{.35\textwidth}
+      \centering
+        \includegraphics[width=\columnwidth]{2_main_body/images/flowchartB.png}
+        \caption{Flowchart B.}~\label{fig:flowchart_b}
+    \end{subfigure}
+    \hspace{1cm}
+    \caption[Flowcharts]{Flowchart for some processes.}~\label{fig:flowcharts}
+\end{figure}
+
+\section{Conclusion}
+\label{sec:dev_concl}
+
+This chapter has detailed our system implementation. In particular, we have divided the processes into the back-end (\cref{sec:dev_bck}) and the front-end (\cref{sec:dev_frt}).
+
+In the next chapter, \cref{cha:eval}, we evaluate our system.

2_main_body/evaluation.tex

@@ -0,0 +1,35 @@
+\chapter{Evaluation}
+\label{cha:eval}
+
+In this chapter, we evaluate the system developed in \cref{cha:dev} with two tests, first Test 1 \cref{sec:eval_1} and then Test 2 \cref{sec:eval_2}. We then explore concept B with users in \cref{sec:eval_user}, as laid out in the Background (\cref{cha:back}, \cref{sec:back_B}). 
+
+\section{Test 1}
+\label{sec:eval_1}
+
+\section{Test 2}
+\label{sec:eval_2}
+
+\section{User Study}
+\label{sec:eval_user}
+
+\Cref{tab:properties table} listed the many properties highlighted by users.
+
+\begin{table}[h]
+    \centering
+    \begin{tabular}{ l || c c | r }
+        \textbf{A} & b & c & 1 \\ \hline
+        \textbf{X} & lorem & ipsum & 2 \\
+        \textbf{S} & lor & \textit{em ispum} & 3.2 
+    \end{tabular}
+    \caption{Table of some properties}
+    \label{tab:properties table}
+\end{table}
+
+\section{Conclusion}
+\label{sec:eval_concl}
+
+In this chapter we have carried the evaluations. Tests 1 and 2 (\cref{sec:eval_2,sec:eval_1}) have proved this and that, but highlighted this limitations due to that aspect of the algorithm.
+
+Presented to users, the interface was said to be such and such.
+
+This chapter concludes the work carried out during the project. In the next chapter, \cref{cha:concl}, we present the conclusion of this dissertation.

2_main_body/introduction.tex

@@ -0,0 +1,37 @@
+\chapter{Introduction}
+\label{cha:intro}
+
+\section{Motivation}
+\label{sec:intro_motiv}
+
+The specific subject of this dissertation is X. But the big problem it has is Y, specifically theses details.
+
+\section{Aim and Objectives}
+\label{sec:intro_aim}
+
+So in this dissertation we aim to address this aspects of Y. In particular we want to achieve the following objectives:
+\begin{itemize}
+    \item Something;
+    \item [*] Another thing with different bullet;
+    \item The last thing.
+\end{itemize}
+
+\section{Methodology}
+\label{sec:intro_method}
+
+Here are briefly the main problems, and what approach we used to tackle them.
+
+\section{Contributions}
+\label{sec:intro_contrib}
+
+In order, what this dissertation contributes:
+\begin{enumerate}
+    \item First item.
+    \item Second item.
+    \item Third item.
+\end{enumerate}
+
+\section{Organisation}
+\label{sec:intro_orga}
+
+Here is how this dissertation is organised. After motivating and introducing our work (this chapter), we investigate the literature to present the state-of-the-art in \cref{cha:back}. We then present our great solution in \cref{cha:dev}, before evaluating it in \cref{cha:eval}. Finally we conclude in \cref{cha:concl}, highlighting limitations, and possible future work.

3_back_matter/appendices.tex

@@ -0,0 +1,9 @@
+\newpage
+\begin{appendices}
+
+    \crefalias{chapter}{appendixchapter} % for appendix refs
+    
+    \input{3_back_matter/appendices/uml}
+    \input{3_back_matter/appendices/screen}
+    
+\end{appendices}

3_back_matter/appendices/screen.tex

@@ -0,0 +1,10 @@
+\chapter{Screenshots of my application}
+\label{app:screen}
+
+The screenshots.
+\begin{figure}[ht]
+    \centering
+    \includegraphics[width=\textwidth]{3_back_matter/appendices/images/mockup.png}
+    \caption{Mockup of front-end.}
+    \label{fig:mockup_front-end_append}
+\end{figure}

3_back_matter/appendices/uml.tex

@@ -0,0 +1,5 @@
+\chapter{UML Diagrams}
+\label{app:uml}
+Some text introducing the diagrams.
+
+The diagrams.

3_back_matter/references.bib

@@ -0,0 +1,20 @@
+@article{smith2018implementing,
+    title={Implementing X in Z context},
+    author={Smith, John J and Doe, Jane},
+    year={2018},
+    journal={Communications of this association}
+}
+
+@inproceedings{doe2017exploring,
+    title={Exploring Y},
+    author={Doe, Jane},
+    year={2017},
+    booktitle={Proceedings of that conference}
+}
+
+@book{alice2016handbook,
+    title={Handbook of this method},
+    author={Alice, Bob},
+    year={2016},
+    publisher={Great Publisher}
+}

3_back_matter/references.tex

@@ -0,0 +1,6 @@
+\newpage
+\renewcommand{\bibname}{References}
+\phantomsection
+\addcontentsline{toc}{chapter}{References}
+\bibliography{3_back_matter/references}
+\bibliographystyle{plain}

_setup/doc_setup.tex

@@ -0,0 +1,94 @@
+
+% load packages
+\input{_setup/packages}
+
+% set up macros
+\input{_setup/macros}
+
+% set line spacing
+\doublespacing
+
+% set headings format
+\titleformat{\chapter}{\singlespacing\normalfont\huge\bfseries\titleColor}{\chaptertitlename\ \thechapter}{1em}{}
+\titleformat{\section}{\singlespacing\normalfont\Large\bfseries\titleColor}{\thesection.}{1em}{}
+\titleformat{\subsection}{\singlespacing\normalfont\large\bfseries}{\thesubsection.}{1em}{}
+\titleformat{\subsubsection}{\singlespacing\normalfont\normalsize\bfseries}{\thesubsubsection.}{1em}{}
+\titlespacing*{\chapter}{0pt}{10pt}{10pt}
+
+% set paragraph indent
+\setlength{\parindent}{18pt} 
+
+% set text color
+\textColor 
+
+% set hyperlinks + pdf metadata
+\hypersetup{
+	pdftitle={\docTitle},
+	pdfauthor={\docAuthor},
+	pdfkeywords={dissertation template},
+	colorlinks=true,%
+	citecolor=[HTML]{152845},%
+	linkcolor=[HTML]{152845},%
+	urlcolor=[HTML]{1976D2}
+}
+
+% styling the code listings
+\definecolor{codegreen}{rgb}{0,0.6,0}
+\definecolor{codegray}{rgb}{0.5,0.5,0.5}
+\definecolor{codepurple}{rgb}{0.58,0,0.82}
+\definecolor{backcolour}{rgb}{0.95,0.95,0.92}
+
+\lstdefinestyle{mystyle}{
+    backgroundcolor=\color{backcolour},   
+    commentstyle=\color{codegreen},
+    keywordstyle=\color{magenta},
+    numberstyle=\tiny\color{codegray},
+    stringstyle=\color{codepurple},
+    basicstyle=\ttfamily\singlespacing,
+    breakatwhitespace=false,         
+    breaklines=true,                 
+    captionpos=b,                    
+    keepspaces=true,                 
+    numbers=left,                    
+    numbersep=5pt,                  
+    showspaces=false,                
+    showstringspaces=false,
+    showtabs=false,                  
+    tabsize=2
+}
+\lstset{style=mystyle}
+
+% reset names for code listing
+\renewcommand{\lstlistingname}{Code}
+\renewcommand{\lstlistlistingname}{List of \lstlistingname s}
+
+% set cref for listing
+\crefname{lstlisting}{\lstlistingname}{\lstlistingname s}
+\Crefname{lstlisting}{\lstlistingname}{\lstlistingname s}
+
+% set custom list of equations
+\newcommand{\listequationsname}{List of Equations}
+\newlistof{myequations}{equ}{\listequationsname}
+\newcommand{\myequations}[1]{%
+	\addcontentsline{equ}{myequations}{\protect\numberline{\theequation}#1}
+}
+\setlength{\cftmyequationsnumwidth}{2.5em}% Width of equation number in List of Equations
+
+% set custom list of algorithms
+\newcommand{\listalgorithmssname}{List of Algorithms}
+\newlistof{myalgorithms}{alg}{\listalgorithmssname}
+\newcommand{\myalgorithms}[1]{%
+	\addcontentsline{alg}{myalgorithms}{\protect\numberline{\thealgorithm}#1}
+}
+\setlength{\cftmyequationsnumwidth}{2.5em}% Width of algorithm number in List of Algorithms
+
+% set appendices refs with cleveref
+\crefname{appendixchapter}{Appendix}{Appendices}
+\Crefname{appendixchapter}{Appendix}{Appendices}
+
+% set custom headers/footers
+\pagestyle{fancy}
+\fancyhf{}
+\rhead{\secTextColor \docAuthor}
+\lhead{\secTextColor \docTitle}
+\cfoot{\thepage}

_setup/macros.tex

@@ -0,0 +1,14 @@
+% document details
+\def\docTitle{Dissertation Template}
+\def\docAuthor{Author \textsc{Student}}
+\def\docSupervisor{Prof. \textsc{Supervisor}}
+\def\docDate{October 2020}
+
+% colors
+\def\textColor{\color[HTML]{050505}}
+\def\secTextColor{\color[HTML]{505050}}
+\def\titleColor{\color[HTML]{356EC4}}
+
+% math symbols
+\newcommand{\myMatrix}{\ensuremath{M}}
+\newcommand{\ratioA}{\ensuremath{\alpha}}

_setup/packages.tex

@@ -0,0 +1,40 @@
+% encoding
+\usepackage[utf8]{inputenc}
+% for dummy text
+\usepackage{lipsum}
+% setting page margins
+\usepackage[a4paper, top=1in, bottom=1in, left=1in, right=1in, headheight=127mm]{geometry}
+% to customise line spacing and paragraph indent
+\usepackage{setspace}
+% to customise headings formats
+\usepackage{titlesec}
+% for colors
+\usepackage[table,dvipsnames]{xcolor}
+% for hyperlinks
+\usepackage{hyperref}
+% to order references numbers in text
+\usepackage[nocompress]{cite}
+% to include figures
+\usepackage{graphicx}
+% formatting captions
+\usepackage[font={color=black!90},labelfont={bf},width=.85\textwidth]{caption}
+% for subfigures
+\usepackage{subcaption}
+% for more equations tools
+\usepackage{amsmath,mathtools}
+% for easier cross-references
+\usepackage[capitalise,nameinlink,noabbrev]{cleveref}
+% for algorithms
+\usepackage{algorithm}
+\usepackage{algorithmicx}
+\usepackage{algpseudocode}
+% for code listing
+\usepackage{listings}
+% for custom list of contents, e.g. equations or algorithms
+\usepackage[titles]{tocloft}
+% for appendices
+\usepackage[titletoc]{appendix}
+% for custom headers/footers
+\usepackage{fancyhdr}
+% vertical space between paragraphs
+\usepackage{parskip}

main.tex

@@ -0,0 +1,26 @@
+\documentclass[a4paper, english, 11pt, titlepage]{report}
+
+\input{_setup/doc_setup}
+
+\begin{document}
+% FRONT MATTER
+\input{1_front_matter/titlepage}
+\newpage
+\pagenumbering{roman}
+\input{1_front_matter/preamble}
+\input{1_front_matter/contents}
+	
+% MAIN BODY
+\newpage
+\pagenumbering{arabic}
+\input{2_main_body/introduction}
+\input{2_main_body/background}
+\input{2_main_body/development}
+\input{2_main_body/evaluation}
+\input{2_main_body/conclusion}
+
+% BACK MATTER
+\input{3_back_matter/references}
+\input{3_back_matter/appendices}
+
+\end{document}