University of Reading Computer Science Report Template and Guide. This is a report template as well as has instructions on writing various types of reports: e.g. science and lab, software engining and algorithms.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% %%
%% Dr Varun Ojha %%
%% Lecturer, Department of Computer Science %%
%% University of Reading, UK %%
%% %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%% SETTING STARTS - DO NOT CHANGE Unless your TeX setting require so %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%----------------------------------------------------------------------------------
% DO NOT Change this. It is the required setting A4 page, 11pt, onside print, book style
%%----------------------------------------------------------------------------------
\documentclass[a4paper,11pt,oneside]{book}
%%-------------------------------------
%% Page margin settings - % half inch margin all sides (recommended)
%%-------------------------------------
\usepackage[margin=1.2in]{geometry}
%%-------------------------------------
%% Font settings - % CM San or Ariel (recommended)
%%-------------------------------------
% Switch the following two line off: to revert back to default LaTex font (NOT recommended)
\usepackage{amsfonts}
\renewcommand*\familydefault{\sfdefault}
%%-------------------------------------
%% Math/Definition/Theorem/Algorithm packages settings
%%-------------------------------------
\usepackage[cmex10]{amsmath}
\usepackage{amssymb}
\usepackage{amsthm}
\newtheorem{mydef}{Definition}
\newtheorem{mytherm}{Theorem}
%%-------------------------------------
%% Algorithms/Code Listing environment settings -
%% Please do not change these settings
%%-------------------------------------
\usepackage{algorithm}
\usepackage{algpseudocode}
\renewcommand{\algorithmicrequire}{\textbf{Input:}}
\renewcommand{\algorithmicensure}{\textbf{Output:}}
\usepackage[utf8]{inputenc}
\usepackage{listings}
\usepackage{xcolor}
\definecolor{codegreen}{rgb}{0,0.6,0.1}
\definecolor{codegray}{rgb}{0.5,0.5,0.5}
\definecolor{codeblue}{rgb}{0.10,0.00,1.00}
\definecolor{codepurple}{rgb}{0.58,0,0.82}
\definecolor{backcolour}{rgb}{1.0,1.0,1.0}
\lstdefinestyle{mystyle}{
backgroundcolor=\color{backcolour},
commentstyle=\color{codegreen},
keywordstyle=\color{codeblue},
numberstyle=\tiny\color{codegray},
stringstyle=\color{codepurple},
basicstyle=\ttfamily\footnotesize,
breakatwhitespace=false,
breaklines=true,
captionpos=b,
keepspaces=true,
numbers=left,
numbersep=5pt,
showspaces=false,
showstringspaces=false,
showtabs=false,
tabsize=2,
frame=none
}
\lstset{style=mystyle}
%%-------------------------------------
%% Graphics/Figures environment settings
%%-------------------------------------
\usepackage{graphicx}
\usepackage{subfigure}
\usepackage{caption}
\usepackage{lipsum}
%%-------------------------------------
%% Table environment settings
%%-------------------------------------
\usepackage{multirow}
\usepackage{rotating}
\usepackage{makecell}
\usepackage{booktabs}
%\usepackage{longtable,booktabs}
%%-------------------------------------
%% List of Abbreviations settings
%%-------------------------------------
\usepackage{enumitem}
\newlist{abbrv}{itemize}{1}
\setlist[abbrv,1]{label=,labelwidth=1in,align=parleft,itemsep=0.1\baselineskip,leftmargin=!}
%%-------------------------------------
%% Bibliography/References settings - Harvard Style was used in this report
%%-------------------------------------
\usepackage[hidelinks]{hyperref}
\usepackage[comma,authoryear]{natbib}
\renewcommand{\bibname}{References} % DO NOT remove or switch of
%%-------------------------------------
%% Appendix settings
%%-------------------------------------
\usepackage[toc]{appendix}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%% SETTING ENDS %%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}
\captionsetup[figure]{margin=1.5cm,font=small,name={Figure},labelsep=colon}
\captionsetup[table]{margin=1.5cm,font=small,name={Table},labelsep=colon}
\setlipsumdefault{1}
\frontmatter
\begin{titlepage}
\begin{center}
\includegraphics[width=3cm]{figures/uorlogo.png}\\[0.5cm]
{\LARGE University of Reading\\[0.5cm]
Department of Computer Science}\\[2cm]
%{\color{blue} \rule{\textwidth}{1pt}}
% -------------------------------
% You need to edit some details here
% -------------------------------
\linespread{1.2}\huge {
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%TODO: 1 TITLE of Your PROJECT
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% chnage the following line
Computer Science Undergraduate Report Template and Report Writing Guide
}
\linespread{1}~\\[2cm]
%{\color{blue} \rule{\textwidth}{1pt}}
{\Large
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%TODO: 2 YOUR NAME
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% chnage the following line
FirstName(s) LastName
% change end
}\\[1cm]
{\large
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%TODO: 3 YOUR NAME Supervisor's name(s)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% change the following line
\emph{Supervisor:} Supervisor's Name}\\[1cm] % if applicable
% PLEASE DO NOT CHANGE THIS TEXT %
\large A report submitted in partial fulfilment of the requirements of\\the University of Reading for the degree of\\ Bachelor of Science in \textit{Computer Science}\\[0.3cm]
\vfill
\today % Please update this date you can use \date{April 2020} for fixed date
\end{center}
\end{titlepage}
% -------------------------------------------------------------------
% Declaration
% -------------------------------------------------------------------
\newpage
\thispagestyle{empty}
\chapter*{\Large Declaration}
% PLEASE CHANGE THIS TEXT EXCEPT YOUR NAME%
% -------------------------------
%TODO: PLEASE ONLY UPDATE HERE -- PLEASE WRITE YOUR NAME %
% -------------------------------
I,
%%%%%%%%%%%%%%%%%%%%%%%
Firstname(s) Lastname, % Mandatory part
%%%%%%%%%%%%%%%%%%%%%%%
of the Department of Computer Science, University of Reading, confirm that this is my own work and figures, tables, equations, code snippets, artworks, and illustrations in this report are original and have not been taken from any other person's work, except where the works of others have been explicitly acknowledged, quoted, and referenced. I understand that if failing to do so will be considered a case of plagiarism. Plagiarism is a form of academic misconduct and will be penalised accordingly. \\
%% Please delete as appropriate.
\noindent
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%TODO 1 Consent for example copy - we will use
I give consent to a copy of my report being shared with future students as an exemplar. \\
\noindent
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%TODO 2 Consent to let the report to use use by library for public use
I give consent for my work to be made available more widely to members of UoR and public with interest in teaching, learning and research.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
~\\[1cm]
\begin{flushright}
%------------------------------
% change the following line
%TODO: PLEASE UPDATE Your Name -------------------------------%
Firstname(s) Lastname % Please change it to your name
\today
\end{flushright}
% -------------------------------------------------------------------
% Abstract and Acknowledgement
% -------------------------------------------------------------------
\input{chapters/abstract.tex}
% -------------------------------------------------------------------
% Acknowledgement
% -------------------------------------------------------------------
\input{chapters/acknowledgments.tex}
% -------------------------------------------------------------------
% Contents, list of figures, list of tables
% -------------------------------------------------------------------
\tableofcontents
\listoffigures
\listoftables
\input{glossaries} % Enter your list of Abbreviation and Symbols in this file
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% %%
%% Main chapters and sections of your project %%
%% Everything from here on needs updates in your own words and works %%
%% %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\mainmatter
% Read for preparation of document in LaTex
% Lamport, L. (1986), LATEX: A Document Preparation System, Addison-Wesley.
\input{chapters/introduction.tex}
\input{chapters/literature.tex}% https://guides.library.bloomu.edu/litreview
\input{chapters/methodology.tex}
\input{chapters/results.tex}
\input{chapters/discussion.tex}
\input{chapters/conclusions.tex}
\input{chapters/reflection.tex}
% -------------------------------------------------------------------
% Bibliography/References - Harvard Style was used in this report
% -------------------------------------------------------------------
\bibliographystyle{agsm} % Harvard Style
\bibliography{references} % Patashnik, O. (1988), BibTEXing. Documentation for general BibTEX users.
% -------------------------------------------------------------------
% Appendices
% -------------------------------------------------------------------
\begin{appendices}
\input{chapters/appendix_A.tex}
\input{chapters/appendix_B.tex}
\end{appendices}
\end{document}