GettingStarted

Getting Started

After downloading the template, you should have a directory that looks like this

% ls -l
total 24
-rw-r--r-- 1 dang dang 1850 Sep 19 12:09 Build.py
-rw-r--r-- 1 dang dang  676 Sep 20 13:26 Dissertation.md
-rw-r--r-- 1 dang dang 1268 Sep 20 13:14 README.md
drwxr-xr-x 2 dang dang 4096 Sep 14 16:03 Supporting
drwxr-xr-x 5 dang dang 4096 Sep 20 13:38 Template
-rw-r--r-- 1 dang dang  298 Sep 14 16:03 example-bib.bib

Getting the Front Page right.

The first thing we need to do is edit Dissertation.md

This file contains all the Header information for the report. You Will need to modify this to get your name, Student Id etc correct. Hopefully the contents are self-explanatory.

# ----- THINGS THAT YOU NEED TO CHANGE ----
author:  "Your Name"
sid: 424242
title: "Project Title"

# Keywords associated with your project
keywords: Comma, Seperated, Keywords

degreetitle:  'BSc: Ethical Hacking and cybersecurity'

#Hide the Declaration and Ethics Form
draft: False

#Ethics form,  REPLACE THIS WITH YOUR ONE
PDF-ethics: Supporting/ethics-certificate.pdf

#Origianlity Statement:  REPLACE THIS WITH YOURS
PDF-declaration: Supporting/submission-declaration.pdf

#Finally the Bibtex file for your references.
bibliography: example-bib.bib

#Font to use
fontfamily: helvet

# -------- LEAVE THE THINGS BELOW HERE ALONE ----

Building the Document

Each time we want to build the document, and turn it into a PDF For this we can use the script Build.py

% python Build.py 

A PDF (by default Disso.pdf) is then generated.

Adding More Material

TODO

ABSTRACTS and other Front Matter

TODO: Adding an Abstract