diff --git a/Build-Example.py b/Build-Example.py index 524eff4..ba6b520 100644 --- a/Build-Example.py +++ b/Build-Example.py @@ -12,15 +12,19 @@ OUTPUT_FILE = "Disso.pdf" #ENTER ALL THE SOURCE FILES THAT YOU HAVE IN THE DISSERTAION HERE. SOURCE_FILES = ["Example/Intro.md", "Example/Use.md"] -# --------------- END OF STUFF THAT YOU NEED TO CHANGE ------------------------- - +#Are you using the Submodule Approach +SUBMODULE = True +#Is it the Default Path +SUBMODULE_PATH="markdown_dissertation" +# --------------- END OF STUFF THAT YOU NEED TO CHANGE ------------------------- def buildCommand(): """Build the list that we send to pandoc""" - HEADER_FILE = "Dissertation.md" + STU_HEADER_FILE = "Dissertation.md" + HEADER_FILE = "Header.md" FOOTER_FILE = "References.md" #Needed otherwise refs come on the same page PANDOC_OPTS = ["--filter=pandoc-citeproc", @@ -30,6 +34,7 @@ def buildCommand(): #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 diff --git a/Dissertation.md b/Dissertation.md index 96bbdea..e1b92c8 100644 --- a/Dissertation.md +++ b/Dissertation.md @@ -1,7 +1,29 @@ --- -author: Your Name +# ----- 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 ---- +--- + +--- documentclass: Template/Classes/CUPhDThesis classoption: - a4paper @@ -16,10 +38,6 @@ toc-depth: 2 lof: true lot: false -keywords: Comma, Seperated, Keywords - - -fontfamily: helvet header-includes: - \renewcommand{\familydefault}{\sfdefault} - \renewcommand{\chaptername}{} @@ -29,22 +47,13 @@ header-includes: dept: 'Faculty of Enginnering and Computing' university: 'Coventry University' crest: 'Template/Figs/CULogo.pdf' -degreetitle: 'BSc: Ethical Hacking and cybersecurity' - -#Ethics form, REPLACE THIS WITH YOUR ONE -PDF-ethics: Supporting/ethics-certificate.pdf - -#Choice of ither a printied and scanned Originality form -#PDF-declaration: Supporting/submission-declaration.pdf - -#OR Nates, awesome Markdown one -TEX-declaration: Supporting/OriginallityStatement.tex - -bibliography: example-bib.bib #Bibliograpy Style csl: Template/harvard-coventry-university.csl +#OR Nates, awesome Markdown one +#TEX-declaration: Supporting/OriginallityStatement.tex + #If we are using biblatex instead biblatexoptions: backend=biber, style=authoryear, sorting=nty, natbib=true biblio-title: "References" diff --git a/Example/Intro.md b/Example/Intro.md index 4f1d93c..dcd9d8f 100644 --- a/Example/Intro.md +++ b/Example/Intro.md @@ -13,6 +13,11 @@ This template lets you write awesome looking Dissertations in Markdown. ### Getting the Template TODO: Instructions on Submodules etc here. +First we want to download the Template, which can be found at . There are two options here: + + 1. Clone my Repository + 1. Make use of Submodules to do it + ### Other Requirements You will also need a copy of: diff --git a/Example/Writing.md b/Example/Writing.md new file mode 100644 index 0000000..81182b2 --- /dev/null +++ b/Example/Writing.md @@ -0,0 +1,3 @@ +# Quick Markdown Primer + +Pandoc diff --git a/Header.md b/Header.md new file mode 100644 index 0000000..9b4719a --- /dev/null +++ b/Header.md @@ -0,0 +1,35 @@ +--- +documentclass: Template/Classes/CUPhDThesis +classoption: + - a4paper + - 10pt + - numbered + - print + - index + - oneside + +toc: true +toc-depth: 2 +lof: true +lot: false + +header-includes: + - \renewcommand{\familydefault}{\sfdefault} + - \renewcommand{\chaptername}{} + - \renewcommand{\thechapter}{} + + +dept: 'Faculty of Enginnering and Computing' +university: 'Coventry University' +crest: 'Template/Figs/CULogo.pdf' + +#Bibliograpy Style +csl: Template/harvard-coventry-university.csl + +#OR Nates, awesome Markdown one +#TEX-declaration: Supporting/OriginallityStatement.tex + +#If we are using biblatex instead +biblatexoptions: backend=biber, style=authoryear, sorting=nty, natbib=true +biblio-title: "References" +---