diff --git a/Build.py b/Build.py new file mode 100644 index 0000000..4782a63 --- /dev/null +++ b/Build.py @@ -0,0 +1,58 @@ +""" +Python script to build a dissertaion based on Markdown / Pandoc + +TODO: Options? +""" + +import subprocess +import os + +# --------------- CHANGE THESE TWO LINES ------------------------- +OUTPUT_FILE = "Disso.pdf" + +#If you Reame the Header file you will need to let the script know. +STU_HEADER_FILE = "Dissertation.md" #Students Header File + +#ENTER ALL THE SOURCE FILES THAT YOU HAVE IN THE DISSERTAION HERE. +SOURCE_FILES = [] + +#Are you using the Recommended Submodule Approach +SUBMODULE = True + +#If you rename the Templates repository, Let the script know. +SUBMODULE_PATH="Template" +# --------------- END OF STUFF THAT YOU NEED TO CHANGE ------------------------- + +def buildCommand(): + """Build the list that we send to pandoc""" + HEADER_FILE = "Header.md" + SUB_HEADER_FILE = "SubHeader.md" + #Needed otherwise refs come on the same page + FOOTER_FILE = "References.md" + # Pandoc Template + LATEX_TEMPLATE = "Template/disso.latex" + + if SUBMODULE: + HEADER_FILE = os.path.join(SUBMODULE_PATH, SUB_HEADER_FILE) + FOOTER_FILE = os.path.join(SUBMODULE_PATH, FOOTER_FILE) + LATEX_TEMPLATE = os.path.join(SUBMODULE_PATH, LATEX_TEMPLATE) + + PANDOC_OPTS = ["--filter=pandoc-citeproc", + "--template={0}".format(LATEX_TEMPLATE), + "--top-level-division=chapter"] + + #Actually Build the list + commandList = ["pandoc"] + commandList.extend(PANDOC_OPTS) #Add the options + commandList.append(STU_HEADER_FILE) #Students Headderfile + commandList.append(HEADER_FILE) #Header File + commandList.extend(SOURCE_FILES) #STUDENT source + commandList.append(FOOTER_FILE) #FOOTER FILE + commandList.append("-o") + commandList.append(OUTPUT_FILE) + subprocess.run(commandList) + + +if __name__ == "__main__": + #Build the damm thing + buildCommand() diff --git a/Dissertation.md b/Dissertation.md new file mode 100644 index 0000000..cd1b508 --- /dev/null +++ b/Dissertation.md @@ -0,0 +1,24 @@ +--- +# ----- THINGS THAT YOU NEED TO CHANGE ---- +author: "Your Name" +title: "Project Title" + +# Keywords associated with your project +keywords: Comma, Seperated, Keywords + +degreetitle: 'BSc: Ethical Hacking and cybersecurity' + +#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 ---- +--- diff --git a/Supporting/Originallity_Statement.md b/Supporting/Originallity_Statement.md new file mode 100644 index 0000000..e762483 --- /dev/null +++ b/Supporting/Originallity_Statement.md @@ -0,0 +1,31 @@ + +# Originality Statement: + +**First Name:** Dave + +**Last Name:** Lister + +**Ethics Application Number:** P66730 + +**1st Supervisor:** Daniel Goldsmith + +**2nd Supervisor:** Christo Panchev + + + +## 300COM / 303COM Declaration of originality: +I Declare that This project is all my own work and has not been copied in part or in whole from any other source except where duly acknowledged. As such, all use of previously published work (from books, journals, magazines, internet etc.) has been acknowledged by citation within the main report to an item in the References or Bibliography lists. I also agree that an electronic copy of this project may be stored and used for the purposes of plagiarism prevention and detection. + +## Statement of copyright: +I acknowledge that the copyright of this project report, and any product developed as part of the project, belong to Coventry University. Support, including funding, is available to commercialise products and services developed by staff and students.  Any revenue that is generated is split with the inventor/s of the product or service.  For further information please see www.coventry.ac.uk/ipr or contact ipr@coventry.ac.uk. + +## Statement of ethical engagement: +I declare that a proposal for this project has been submitted to the Coventry University ethics monitoring website (https://ethics.coventry.ac.uk/) and that the application number is listed below. + +## Signed: + + +## Date: + +28.1.2018 + diff --git a/Supporting/ethics-certificate.pdf b/Supporting/ethics-certificate.pdf new file mode 100644 index 0000000..5ee3cd1 Binary files /dev/null and b/Supporting/ethics-certificate.pdf differ diff --git a/Supporting/submission-declaration.pdf b/Supporting/submission-declaration.pdf new file mode 100644 index 0000000..368f84a Binary files /dev/null and b/Supporting/submission-declaration.pdf differ diff --git a/example-bib.bib b/example-bib.bib new file mode 100644 index 0000000..9ab3241 --- /dev/null +++ b/example-bib.bib @@ -0,0 +1,8 @@ +@inproceedings{goldsmith2010spanish, + title={The Spanish Inquisition Protocol—model based transmission reduction for wireless sensor networks}, + author={Goldsmith, Daniel and Brusey, James}, + booktitle={Sensors, 2010 IEEE}, + pages={2043--2048}, + year={2010}, + organization={IEEE} +}