Skip to content

GettingStarted

Jump to bottom
Dan Goldsmith edited this page Sep 20, 2018 · 7 revisions
Clone this wiki locally

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 (or updated).

Adding More Material

So far we have the skeleton of a report, with Title Page, Tables of Contents and References. We will need some text in the report, to do this we need to:

  1. Create a new file that contains the text[^footfile]
  2. Update the Build.py file so the script knows about this file
  3. Write Stuff
  4. Rebuild the Document
  5. .....
  6. Profit

[^footfile] You dont "need" to create a new file, and can use one big file to hold all the text. Personally, I prefer having one file per section / chapter to help me organise things.

Worked Example: Adding an Introduction section

Create a new file called Introduction.md and add the following text

# Introduction

This is the introduction section

## What my project is 

Here is Discuss my Project

## What I have found out

Here I talk about my results

## Summary

Here I summarise the project

Worked Example: Updating the Build script

We need to update the Build script so it knows to include our file

Modify the SOURCE_FILES variable in Build.py

#ENTER ALL THE SOURCE FILES THAT YOU HAVE IN THE DISSERTAION HERE.
SOURCE_FILES = ["Introduction.md"]

Build the new version of the document

Re-run the Build script


## Rinse and Repeat

That is it for adding new content. Remember: 
 
  - Git add
  - Git commit
  - Git push


# TODO
## I dont want to use Markdown

 - Sucks to be you.  
 - We cant convert the header, but I think we can convert the Template parts of the document
   - CHECK THIS
 
## ABSTRACTS and other Front Matter

TODO: Adding an Abstract