Browse Source

Create example report

master
Starbeamrainbowlabs 3 years ago
commit
f94675723f
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
  1. 282
      .gitignore
  2. 3
      .gitmodules
  3. 106
      build
  4. 1
      lantern-build-engine
  5. 7
      report/chapters/1-introduction.tex
  6. 9
      report/chapters/2-example.tex
  7. 12
      report/chapters/7-appendix.tex
  8. 1559
      report/hull.bst
  9. 319
      report/report.bib
  10. BIN
      report/report.pdf
  11. 62
      report/report.tex
  12. BIN
      report/title_page/UoH_Logo.pdf
  13. 33
      report/title_page/page.tex

282
.gitignore vendored

@ -0,0 +1,282 @@ @@ -0,0 +1,282 @@
# Created by https://www.gitignore.io/api/latex
# Edit at https://www.gitignore.io/?templates=latex
### LaTeX ###
## Core latex/pdflatex auxiliary files:
*.aux
*.lof
*.log
*.lot
*.fls
*.out
*.toc
*.fmt
*.fot
*.cb
*.cb2
.*.lb
## Intermediate documents:
*.dvi
*.xdv
*-converted-to.*
# these rules might exclude image files for figures etc.
# *.ps
# *.eps
# *.pdf
## Generated if empty string is given at "Please type another file name for output:"
.pdf
## Bibliography auxiliary files (bibtex/biblatex/biber):
*.bbl
*.bcf
*.blg
*-blx.aux
*-blx.bib
*.run.xml
## Build tool auxiliary files:
*.fdb_latexmk
*.synctex
*.synctex(busy)
*.synctex.gz
*.synctex.gz(busy)
*.pdfsync
## Build tool directories for auxiliary files
# latexrun
latex.out/
## Auxiliary and intermediate files from other packages:
# algorithms
*.alg
*.loa
# achemso
acs-*.bib
# amsthm
*.thm
# beamer
*.nav
*.pre
*.snm
*.vrb
# changes
*.soc
# comment
*.cut
# cprotect
*.cpt
# elsarticle (documentclass of Elsevier journals)
*.spl
# endnotes
*.ent
# fixme
*.lox
# feynmf/feynmp
*.mf
*.mp
*.t[1-9]
*.t[1-9][0-9]
*.tfm
#(r)(e)ledmac/(r)(e)ledpar
*.end
*.?end
*.[1-9]
*.[1-9][0-9]
*.[1-9][0-9][0-9]
*.[1-9]R
*.[1-9][0-9]R
*.[1-9][0-9][0-9]R
*.eledsec[1-9]
*.eledsec[1-9]R
*.eledsec[1-9][0-9]
*.eledsec[1-9][0-9]R
*.eledsec[1-9][0-9][0-9]
*.eledsec[1-9][0-9][0-9]R
# glossaries
*.acn
*.acr
*.glg
*.glo
*.gls
*.glsdefs
# gnuplottex
*-gnuplottex-*
# gregoriotex
*.gaux
*.gtex
# htlatex
*.4ct
*.4tc
*.idv
*.lg
*.trc
*.xref
# hyperref
*.brf
# knitr
*-concordance.tex
# TODO Comment the next line if you want to keep your tikz graphics files
*.tikz
*-tikzDictionary
# listings
*.lol
# luatexja-ruby
*.ltjruby
# makeidx
*.idx
*.ilg
*.ind
*.ist
# minitoc
*.maf
*.mlf
*.mlt
*.mtc[0-9]*
*.slf[0-9]*
*.slt[0-9]*
*.stc[0-9]*
# minted
_minted*
*.pyg
# morewrites
*.mw
# nomencl
*.nlg
*.nlo
*.nls
# pax
*.pax
# pdfpcnotes
*.pdfpc
# sagetex
*.sagetex.sage
*.sagetex.py
*.sagetex.scmd
# scrwfile
*.wrt
# sympy
*.sout
*.sympy
sympy-plots-for-*.tex/
# pdfcomment
*.upa
*.upb
# pythontex
*.pytxcode
pythontex-files-*/
# tcolorbox
*.listing
# thmtools
*.loe
# TikZ & PGF
*.dpth
*.md5
*.auxlock
# todonotes
*.tdo
# vhistory
*.hst
*.ver
# easy-todo
*.lod
# xcolor
*.xcp
# xmpincl
*.xmpi
# xindy
*.xdy
# xypic precompiled matrices
*.xyc
# endfloat
*.ttt
*.fff
# Latexian
TSWLatexianTemp*
## Editors:
# WinEdt
*.bak
*.sav
# Texpad
.texpadtmp
# LyX
*.lyx~
# Kile
*.backup
# KBibTeX
*~[0-9]*
# auto folder when using emacs and auctex
./auto/*
*.el
# expex forward references with \gathertags
*-tags.tex
# standalone packages
*.sta
### LaTeX Patch ###
# glossaries
*.glstex
# End of https://www.gitignore.io/api/latex
# Created by https://www.gitignore.io/api/libreoffice
# Edit at https://www.gitignore.io/?templates=libreoffice
### LibreOffice ###
# LibreOffice locks
.~lock.*#
# End of https://www.gitignore.io/api/libreoffice

3
.gitmodules vendored

@ -0,0 +1,3 @@ @@ -0,0 +1,3 @@
[submodule "lantern-build-engine"]
path = lantern-build-engine
url = https://gitlab.com/sbrl/lantern-build-engine.git

106
build

@ -0,0 +1,106 @@ @@ -0,0 +1,106 @@
#!/usr/bin/env bash
# Make sure the current directory is the location of this script to simplify matters
cd "$(dirname $(readlink -f $0))";
################
### Settings ###
################
# The name of this project
project_name="Example latext templates";
# The path to the lantern build engine git submodule
lantern_path="./lantern-build-engine";
###
# Custom Settings
###
# Put any custom settings here.
###############################################################################
# Check out the lantern git submodule if needed
if [ ! -f "${lantern_path}/lantern.sh" ]; then git submodule update --init "${lantern_path}"; fi
source "${lantern_path}/lantern.sh";
if [[ "$#" -lt 1 ]]; then
echo -e "${FBLE}${project_name}${RS} build script";
echo -e " by Starbeamrainbowlabs";
echo -e "${LC}Powered by the lantern build engine, v${version}${RS}";
echo -e "";
echo -e "${CSECTION}Usage${RS}";
echo -e " ./build ${CTOKEN}{action}${RS} ${CTOKEN}{action}${RS} ${CTOKEN}{action}${RS} ...";
echo -e "";
echo -e "${CSECTION}Available actions${RS}";
echo -e " ${CACTION}setup${RS} - Perform initial setup";
echo -e " ${CACTION}render${RS} - Render the LaTeX exmaples";
echo -e "";
exit 1;
fi
###############################################################################
task_setup() {
task_begin "Setting up";
check_command git true;
check_command pdflatex true;
check_command bibtex true;
subtask_begin "Initialising submodules";
git submodule update --init;
subtask_end $?;
task_end 0;
}
task_render() {
_render-latex-pdf "report/report.tex";
}
# $1 - Location of top-level LaTeX file
_render-latex-pdf() {
task_begin "Entering directory";
latex_filename="$(basename "$1")";
latex_directory="$(dirname "$1")";
execute cd "${latex_directory}";
execute echo "${PWD}";
task_end $? "Failed to enter directory (does it exist?)";
task_begin "Cleaning up";
find -iname "*.aux" -delete; # Ref: https://tex.stackexchange.com/q/381057
find -iname "*.bbl" -delete;
find -iname "*.blg" -delete;
find -iname "*.out" -delete;
task_end $? "Error: Failed to clean up after last build";
# task_begin "Rendering images";
# # FUTURE: Do this in paralell?
# for svg_filename in $(find "images/" -type f -iname "*.svg"); do
# execute inkscape -e ${svg_filename%%.svg}.png ${svg_filename};
# exit_code=$?;
# [[ "${exit_code}" -eq 0 ]] || break;
# done
# task_end "${exit_code}";
task_begin "Building Report";
set -e;
pdflatex --output-directory=. "${latex_filename}";
bibtex "${latex_filename%.*}";
pdflatex --output-directory=. "${latex_filename}";
pdflatex --output-directory=. "${latex_filename}";
bibtex "${latex_filename%.*}";
pdflatex --output-directory=. "${latex_filename}";
pdflatex --output-directory=. "${latex_filename}";
set +e;
task_end $? "Error: Failed to build report";
}
###############################################################################
tasks_run $@;

1
lantern-build-engine

@ -0,0 +1 @@ @@ -0,0 +1 @@
Subproject commit 617fcdb5b9df7f57ccb6639a87be68238f99b9ed

7
report/chapters/1-introduction.tex

@ -0,0 +1,7 @@ @@ -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}

9
report/chapters/2-example.tex

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

12
report/chapters/7-appendix.tex

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

1559
report/hull.bst

File diff suppressed because it is too large Load Diff

319
report/report.bib

@ -0,0 +1,319 @@ @@ -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]}
}

BIN
report/report.pdf

Binary file not shown.

62
report/report.tex

@ -0,0 +1,62 @@ @@ -0,0 +1,62 @@
\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}]}}
\newcommand{\reporttype}{Final Report}
% % Fill out the following information to customize your title page
\title{Report Title}
\author{Name}
% % Uncomment one of the following lines according to your degree title
\newcommand{\degreetitle}{BSc}
%\newcommand{\degreetitle}{BSc Ordinary}
%\newcommand{\degreetitle}{MEng}
% % Fill your degree programme name here
\newcommand{\progname}{Degree Program}
% % Fill in your word count here
\newcommand{\wordcount}{XYZW}
\begin{document}
\input{title_page/page}
\clearpage
\tableofcontents
\input{chapters/1-introduction}
\input{chapters/2-example}
\input{chapters/7-appendix}
\bibliographystyle{hull}
\bibliography{report}
\end{document}

BIN
report/title_page/UoH_Logo.pdf

Binary file not shown.

33
report/title_page/page.tex

@ -0,0 +1,33 @@ @@ -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
Loading…
Cancel
Save