Create short-report example

build

@@ -59,10 +59,15 @@ task_setup() {
 
 task_render() {
 	_render-latex-pdf "report/report.tex";
+	_render-latex-pdf "short-report/short-report.tex";
 }
 
 # $1 - Location of top-level LaTeX file
 _render-latex-pdf() {
+	if [[ ! -f "$1" ]]; then
+		task_end 1 "Error: Couldn't find '$1'";
+	fi
+	
 	task_begin "Entering directory";
 	latex_filename="$(basename "$1")";
 	latex_directory="$(dirname "$1")";
@@ -98,6 +103,8 @@ _render-latex-pdf() {
 	pdflatex --output-directory=. "${latex_filename}";
 	set +e;
 	task_end $? "Error: Failed to build report";
+	
+	cd -;
 }
 
 

short-report/chapters/1-introduction.tex

@@ -0,0 +1,7 @@
+\chapter{Introduction}
+
+% \comments{This is a comment}
+
+Example section 1 \citep{McGooganEtAl2017}
+
+TODO: Replace this with actual content \citep{Dixon2012,Mulholland2013,Walsh2010}

short-report/chapters/2-example.tex

@@ -0,0 +1,9 @@
+\chapter{Example Section}
+\label{section:aims-and-objectives}
+
+\section{Section}
+Example
+
+\subsection{Subsection}
+
+More text here

short-report/chapters/7-appendix.tex

@@ -0,0 +1,12 @@
+\begin{appendices}
+
+
+\chapter{Appendix A: Example Appendix}
+\label{chapter:appendix-a}
+
+\begin{lstlisting}
+Some code
+\end{lstlisting}
+
+
+\end{appendices}

short-report/short-report.bib

@@ -0,0 +1,319 @@
+ARTICLE{Canny1986, 
+	author={J. Canny}, 
+	journal={IEEE Transactions on Pattern Analysis and Machine Intelligence}, 
+	title={A Computational Approach to Edge Detection}, 
+	year={1986}, 
+	volume={8}, 
+	number={6}, 
+	pages={679-698}, 
+}
+
+Book{Stroustrup2013,
+	author = {Bjarne Stroustrup},
+	title = {The C++ Programming Language},
+	publisher = {Addison-Wesley},
+	year = {2013},
+	edition = {4th},
+}
+
+inproceedings{Kazhdan2006,
+	author = {Kazhdan, Michael and Bolitho, Matthew and Hoppe, Hugues},
+	title = {Poisson Surface Reconstruction},
+	booktitle = {Proceedings of the Fourth Eurographics Symposium on Geometry Processing},
+	series = {SGP '06},
+	year = {2006},
+	location = {Cagliari, Sardinia, Italy},
+	pages = {61--70},
+	publisher = {Eurographics Association},
+} 
+
+Misc{Vulkan2016,
+	author = {{The Khronos Vulkan Working Group}},
+	title = {Vulkan 1.0.31 - A Specification},
+	howpublished = {Available online: \url{https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html}} [Accessed 15/10/2016]},
+	year = {2016},
+}
+
+Misc{Hull2016HarvardRef,
+	author = {{University of Hull}},
+	title = {Harvard Referencing},
+	howpublished = {Available online: \url{http://www2.hull.ac.uk/lli/referencing/harvard.html}} [Accessed 15/10/2016]},
+	year = {2016},
+}
+
+@Misc{Atom2018,
+	author = {{Github, Inc.}},
+	year = {2018},
+	title = {Atom},
+	howpublished = {Available online; \url{https://atom.io/} [Accessed 2/05/2018]}
+}
+
+@Misc{Bison2015,
+	author = {{Free Software Foundation, Inc.}},
+	year = {2015},
+	title = {GNU Bison Manual},
+	howpublished = {Available online: \url{https://www.gnu.org/software/bison/manual/} [Accessed 19/04/2018]}
+}
+
+@Misc{BroMonitor2018,
+	author = {{Bro Project Team}},
+	year = {2018},
+	title = {The Bro Network Security Monitor},
+	howpublished = {Available online: \url{https://www.bro.org/} [Accessed 17/01/2018]}
+}
+
+@Misc{ByronJ2017,
+	author = {{Byron, J.}},
+	year = {2017},
+	title = {MIDI Tutorial - learn.sparkfun.com},
+	howpublished = {Available online: \url{https://learn.sparkfun.com/tutorials/midi-tutorial/all} [Accessed 18/01/2018]}
+}
+
+@article{Cole1988,
+	author = { W. A. Macdonald and B. L. Cole },
+	title = {Evaluating the role of colour in a flight information cockpit display},
+	journal = {Ergonomics},
+	volume = {31},
+	number = {1},
+	pages = {13-37},
+	year  = {1988},
+	publisher = {Taylor & Francis},
+	doi = {10.1080/00140138808966646},
+	note ={PMID: 3359985},
+	URL = {https://doi.org/10.1080/00140138808966646},
+	eprint = {https://doi.org/10.1080/00140138808966646}
+}
+
+@Misc{DaveMarshall2001,
+	author = {Dave Marshall},
+	title = {MIDI Messages},
+	year = {2001},
+	howpublished = {Available online: \url{https://users.cs.cf.ac.uk/Dave.Marshall/Multimedia/node158.html} [Accessed 18/01/2018]}
+}
+
+@Book{DickGrune2008,
+	author = {Dick Grune and Ceriel J.H. Jacobs},
+	title = {Parsing Techniques},
+	publisher = {Springer US},
+	year = {2008},
+	edition = {2nd},
+	isbn = {9781441919014}
+}
+
+@mastersthesis{Dixon2012,
+	author = {{Dixon, J. W. D.}},
+	title = {Sound Based Network Analysis Tool},
+	school = {University of Hull},
+	year = {2012},
+	howpublished = {Available online: \url{https://hydra.hull.ac.uk/assets/hull:6391a/content} [Accessed 10/13/2017]}
+}
+
+@Book{DragonBook2006,
+	author = {Aho, Alfred V. and Lam, Monica S. and Sethi, Ravi and Ullman, Jeffrey D.},
+	title = {Compilers: Principles, Techniques, and Tools},
+	edition = {2nd},
+	year = {2006},
+	isbn = {0321486811},
+	publisher = {Addison-Wesley Longman Publishing Co., Inc.},
+} 
+
+@Misc{FluidSynth2017,
+	author = "Tom Moebert and Contributors",
+	title = {FluidSynth | Software synthesizer based on the SoundFont 2 specifications},
+	year = {2017},
+	howpublished = {Available online: \url{http://www.fluidsynth.org/} [Accessed 13/10/2017]}
+}
+
+@manual{grep,
+	title = {{GREP(1) - User Commands}},
+	author = "Free Software Foundation, Inc.",
+	edition = {3.1},
+	year = {2017}
+}
+
+@manual{iftop,
+	title = {{IFTOP(8) - System Manager's Manual}},
+	author = {Paul Warren},
+	edition = {1.0pre4},
+	year = {2014}
+}
+
+@Misc{IpsumDump2017,
+	author = {Eddie Kohler},
+	year = {2017},
+	title = {Ipsumdump and Ipaggcreate},
+	howpublished = {Available online: \url{https://web.archive.org/web/20170909151053/http://www.read.seas.harvard.edu/~kohler/ipsumdump/} [Accessed 17/01/2018]}
+}
+
+@Misc{Naudio2018,
+	author = "Mark Heath and Contributors",
+	year = {2018},
+	title = {naudio/NAudio: Audio and MIDI library for .NET},
+	howpublished = {Available online: \url{https://github.com/naudio/NAudio} [Accessed 17/01/2018]}
+}
+
+@Misc{Kampe2012,
+	author = {{Mark Kampe}},
+	year = {2012},
+	title = {Guidelines for Command Line Interface Design},
+	howpublished = {Available online: \url{http://www.cs.pomona.edu/classes/cs181f/supp/cli.html} [Accessed 27/04/2018]}
+}
+
+@manual{man,
+	title = {{MAN(1) - Manual pager utils}},
+	author = "Colin Watson and Contributors",
+	edition = {2.7.6.1},
+	year = {2016}
+}
+
+@Misc{ManagedMidi2018,
+	author = {{Atsushi Eno}},
+	title = {atsushieno/managed-midi: Cross-platform MIDI processing library for mono and .NET},
+	year = {2018},
+	howpublished = {Available online: \url{https://github.com/atsushieno/managed-midi/} [Accessed 17/01/2018]}
+}
+
+@Misc{McGooganEtAl2017,
+	author = "McGoogan, Cara and Titcomb, J. and Krol, C.",
+	year = {2017},
+	title = {What is WannaCry and how does ransomware work?},
+	howpublished = {Available online: \url{http://www.telegraph.co.uk/technology/0/ransomware-does-work/} [Accessed 13/10/2017]}
+}
+
+@Misc{MidiAssociation2017,
+	author = {{The MIDI Association}},
+	year = {2017},
+	title = {About MIDI-Part 3:MIDI Messages},
+	howpublished = {Available online: \url{https://www.midi.org/articles/about-midi-part-3-midi-messages} [Accessed 07/05/2018]}
+}
+
+@Misc{MidiAssociationSummary2017,
+	author = {{The MIDI Association}},
+	year = {2017},
+	title = {Summary of MIDI Messages},
+	howpublished = {Available online: \url{https://www.midi.org/specifications/item/table-1-summary-of-midi-message} [Accessed 07/05/2018]}
+}
+
+@Misc{MidiToolkit2007,
+	author = {{Leslie Sanford}},
+	year = {2007},
+	title = {C\# MIDI Toolkit - CodeProject},
+	howpublished = {Available online: \url{https://www.codeproject.com/Articles/6228/C-MIDI-Toolkit} [Accessed 17/01/2018]}
+}
+
+@dissertation{Mulholland2013,
+	author = {{Mulholland, D. C.}},
+	year = {2013},
+	title = {Sound Based Network Intrusion Detection.},
+	school = {The University of Hull},
+	howpublished = {Available online: \url{https://hydra.hull.ac.uk/assets/hull:7736a/content} [Accessed 13/10/2017]}
+}
+
+@Misc{PacketNet2018,
+	author = "Chris Morgan and Contributors",
+	year = {2017},
+	title = {antmicro/Packet.Net: Forked from \url{http://sourceforge.net/projects/packetnet/}},
+	howpublished = {Available online: \url{https://github.com/antmicro/Packet.Net} [Accessed 17/01/2018]}
+}
+
+@Misc{Pygame2018,
+	author = {{Pygame contributors}},
+	year = {2018},
+	title = {{Pygame Front Page — Pygame v1.9.2 documentation}},
+	howpublished = {Available online: \url{http://www.pygame.org/docs/} [Accessed 14/01/2018]}
+}
+
+@Misc{Roos2008,
+	author = {{Roos, D.}},
+	year = {2008},
+	title = {How MIDI Works},
+	howpublished = {Available online: \url{http://entertainment.howstuffworks.com/midi1.htm} [Accessed 13/10/2017]}
+}
+
+@Misc{SharpPcap2018,
+	author = "Chris Morgan and Contributors",
+	year = {2017},
+	title = {chmorgan/sharppcap: Official repository - Fully managed, cross platform (Windows, Mac, Linux) .NET library for capturing packets},
+	howpublished = {Available online: \url{https://github.com/chmorgan/sharppcap} [Accessed 17/01/2018]}
+}
+
+@Misc{Snort2018,
+	author = {{The Snort Project}},
+	year = {2018},
+	title = {{Snort - Network Intrusion Detection \& Prevention System}},
+	howpublished = {Available online: \url{https://www.snort.org/} [Accessed 17/01/2018]}
+}
+
+@manual{tcpdump,
+	title = {{TCPDUMP(8) - System Manager's Manual}},
+	author = {tcpdump.org},
+	edition = {4.9.2},
+	year = {2017}
+}
+
+% The url is here is causing an error because of the tilde
+% TODO: Ask Brian about it
+@Misc{TheodoreNorvell1999,
+	author = {Theodore Norvell},
+	year = {1999},
+	title = {Parsing Expressions by Recursive Descent},
+	howpublished = {Available online: \url{https://www.engr.mun.ca/~theo/Misc/exp_parsing.htm} [Accessed 19/04/2018]}
+}
+
+@Misc{TiMidity2004,
+	author = {{Masanao Izumo et al.}},
+	year = {2004},
+	title = {TiMidity++},
+	howpublished = {Available online: \url{http://timidity.sourceforge.net/} [Accessed 17/01/2018]}
+}
+
+@Misc{TonalSoft2005,
+	author = {{Tonalsoft Inc.}},
+	year = {2005},
+	title = {Midi Note-on Message, Midi Note-off Message},
+	howpublished = {Available online: \url{http://www.tonalsoft.com/pub/pitch-bend/pitch.2005-08-31.17-00.aspx} [Accessed 18/01/2018]}
+}
+
+@Misc{USCERT2016,
+	author = {{US-CERT}},
+	year = {2016},
+	title = {OpenSSL 'Heartbleed' vulnerability (CVE-2014-0160)},
+	howpublished = {Available online: \url{https://www.us-cert.gov/ncas/alerts/TA14-098A} [Accessed 13/10/2017]}
+}
+
+@dissertation{VictorvanderHelm2016,
+	author = {{Victor van der Helm}},
+	year = {2016},
+	title = {Sound Based Network Intrusion System},
+	school = {The University of Hull}
+}
+
+@Misc{VisualStudioCode2018,
+	author = {{Microsoft Corporation}},
+	year = {2018},
+	title = {Visual Studio Code - Code Editing. Redefined},
+	howpublished = {Available online: \url{https://code.visualstudio.com/} [Accessed 02/05/2018]}
+}
+
+@dissertation{Walsh2010,
+	author = {{Walsh, S. K.}},
+	year = {2010},
+	title = {Sound Based Network Intrusion Detection},
+	school = {The University of Hull},
+	howpublished = {Available online: \url{https://hydra.hull.ac.uk/assets/hull:2817a/content} [Accessed
+13/10/2017]}
+}
+
+@Misc{Wireshark2018,
+	author = {{Wireshark Foundation}},
+	year = {2018},
+	title = {Wireshark · Go Deep.},
+	howpublished = {Available online: \url{https://www.wireshark.org/} [Accessed 18/01/2018]}
+}
+
+@Misc{WiresharkUsersGuide2014,
+	author = {{Wireshark Foundation}},
+	year = {2014},
+	title = {Wireshark User’s Guide},
+	howpublished = {Available online: \url{https://www.wireshark.org/download/docs/user-guide-a4.pdf} [Accessed 18/01/2018]}
+}

short-report/short-report.tex

@@ -0,0 +1,51 @@
+\documentclass[a4paper,headings=small,11pt,oneside,bibliography=totoc]{scrreprt}
+% \addtokomafont{disposition}{\sffamily}
+\renewcommand\familydefault{\sfdefault}
+\usepackage[utf8x]{inputenc}
+\usepackage[english]{babel}
+\usepackage{amssymb}
+\usepackage{amsthm}
+\usepackage{amsmath}
+\usepackage[dvipsnames]{xcolor}
+\usepackage{graphicx}
+\usepackage{pdfpages}
+\usepackage{microtype}
+\usepackage{palatino}
+\usepackage[round,colon]{natbib}
+\usepackage[hidelinks]{hyperref}
+\usepackage[titletoc]{appendix}
+\pagestyle{headings}
+\usepackage{parskip}
+\usepackage{listings}
+% From http://tex.stackexchange.com/questions/121601/ddg#121618
+\lstset{
+	basicstyle=\small\ttfamily,
+	columns=flexible,
+	breaklines=true
+}
+
+\newcommand{\comments}[1]{\textcolor{OliveGreen}{[\emph{#1}]}}
+
+
+\begin{document}
+
+\begin{center}
+  \Large\textbf{Report Title}\\
+  \large\textit{Name}\\
+  \small Word Count: XYZW
+\end{center}
+
+\begingroup
+\renewcommand{\cleardoublepage}{}
+\renewcommand{\clearpage}{}
+\tableofcontents
+\endgroup
+
+\input{chapters/1-introduction}
+\input{chapters/2-example}
+\input{chapters/7-appendix}
+
+\bibliographystyle{hull}
+\bibliography{short-report}
+
+\end{document}

short-report/title_page/page.tex

@@ -0,0 +1,33 @@
+\makeatletter
+\begin{titlepage}
+
+\vspace*{-5em}
+~~
+
+\vfill
+
+\begin{center}
+{\huge \textbf{\@title}}\\
+\vspace*{1em}
+{\LARGE \textbf{\reporttype{}}}\\
+\vspace*{2em}
+{\Large Submitted for the \degreetitle{} in}\\
+\vspace*{0.5em}
+{\Large \progname{}}\\
+\vspace*{2em}
+{\Large \today}\\
+\vspace*{2em}
+{\Large by}\\
+\vspace*{2em}
+{\Large \textbf{\@author}}\\
+\vspace*{3em}
+{\large Word Count: \wordcount{}}
+\end{center}
+
+\vfill
+\begin{center}
+	\includegraphics[height=0.075\textheight]{title_page/UoH_Logo.pdf}
+\end{center}
+
+\end{titlepage}
+\makeatother