From 03d9ac57990d0409eb92d08e193232ff1466d3b7 Mon Sep 17 00:00:00 2001 From: Longman E <el7g15@soton.ac.uk> Date: Fri, 11 Jan 2019 19:10:42 +0000 Subject: [PATCH] Write Intro chapter and add a couple of references --- ECS.bib | 22 ++++++++++++++- Introduction.tex | 70 +++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 90 insertions(+), 2 deletions(-) diff --git a/ECS.bib b/ECS.bib index 5a19acf..380fa73 100644 --- a/ECS.bib +++ b/ECS.bib @@ -1,6 +1,6 @@ %% ---------------------------------------------------------------- %% ECS.bib -%% ---------------------------------------------------------------- +%% ---------------------------------------------------------------- @MISC{Gunn:2001:pdflatex, author = {S.R. Gunn}, @@ -8,3 +8,23 @@ year = {2001}, url = {http://www.ecs.soton.ac.uk/~srg/softwaretools/document/} } +@MISC{Lovell:2011:updated, + author = {C. J. Lovell}, + title = {Updated templates}, + year = {2011} +} +@MISC{Gunn:2011:updated2, + author = {S.R. Gunn and C. J. Lovell}, + title = {Updated templates reference 2}, + year = {2011} +} +@electronic{GNUdesc + author = {{Free Software Foundation, Inc.}}, + title = {GNU Make} + url = {https://www.gnu.org/software/make/} +} +@electronic{Docstrip + author = {Frank MitÂtelÂbach, + title = {docstrip – Remove comments from file} + url = {https://ctan.org/pkg/docstrip?lang=en} +} diff --git a/Introduction.tex b/Introduction.tex index 38c68ef..e173a15 100644 --- a/Introduction.tex +++ b/Introduction.tex @@ -1,6 +1,6 @@ %% ---------------------------------------------------------------- %% Introduction.tex -%% ---------------------------------------------------------------- +%% ---------------------------------------------------------------- \chapter{Introduction} \label{Chapter:Introduction} You probably found all the files from \cite{Gunn:2001:pdflatex}. @@ -49,3 +49,71 @@ Nam egestas felis euismod erat tincidunt ornare. Nulla hendrerit tempor purus ac Pellentesque sodales lobortis feugiat. Vivamus volutpat mauris id odio aliquam maximus sed sit amet nibh. Fusce odio tortor, aliquam et mauris facilisis, interdum placerat tortor. Suspendisse dapibus, massa eget cursus congue, mi lectus luctus nisl, vitae sagittis ligula ante sit amet enim. Donec quis sapien vel ex vestibulum porta. Vivamus mattis sodales turpis, id interdum justo ullamcorper a. Aenean ornare urna turpis, id fermentum eros commodo aliquet. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Donec cursus pretium ex at mollis. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed at diam quam. Etiam a sollicitudin dui. Nulla facilisi. Phasellus condimentum tincidunt ipsum. Sed dignissim neque a porttitor finibus. Maecenas pretium dictum lorem vitae viverra. Donec vitae massa nisi. Praesent sed sollicitudin urna. Suspendisse vitae cursus tortor. In egestas quis dolor ac porttitor. Pellentesque suscipit leo nisi, a semper nunc interdum quis. Aenean massa magna, aliquam imperdiet lorem vitae, vestibulum dignissim nunc. Nunc molestie eleifend dui et porta. Sed auctor eu nunc vel faucibus. Integer et finibus metus, pharetra egestas velit. Sed nec magna semper, rutrum diam vitae, accumsan sapien. Donec congue viverra luctus. +\section{Prerequisistes} +You should have installed a TeX distribution (MiKTeX or TexLive). How to do so can be found by searching the internet. + +Following a medium install of texlive some extra packages are required to be able to use this template. +These packages are: +\begin{itemize} + \item droid + %TODO: finish package requirements +\end{itemize} + +The particular packages required following MiKTeX are unknown as it was not tested with this. +%TODO: Test with MiKTeX +\section{Getting Started}\label{start} +You probably have downloaded the templates as a zip file. +This zip file should be extracted to the tex-mf folder that is probably in the same place as where your tex distribution was installed. +For TeXLive this defaults to `C:\textbackslash texlive` on Windows. It can be found by running `kpsewhich -var-value=TEXMFHOME`. +The structure of this folder should results as so is as so: +\begin{lstlisting} ++-texmf + +-bibtex + | +-bib + | | +-ecsdocs + | +-bst + | +-ecsdocs + +-doc + | +-latex + | +-ecsdocs + +-templates + | +-latex + | +-ecsdocs + +-tex + +-latex + +-ecsdocs +\end{lstlisting} + +The `templates\textgreater latex\textgreater ecsdocs` folder contains the files to get you started. +The base file is `Thesis.tex` for a thesis and `Progress.tex` for a progress report. + +The base files have dependancies for the sections and the figures. +These files are: `Definitions.tex`, `Introduction.tex`, `Conclusion.tex`, `AppendixA.tex`, `figure.eps`, `ECS.bib`. +These files are designed as a starting point for the structure of your thesis. + +To start using the templates, copy the base file and the dependancies into your working directory. +You are then free to edit them. + +\section{Common Changes} +\subsection{University Structure Changes} +The template assumes that you are in the \groupname, \deptname, \facname at the \univname. +This can be easily changed at the top of your latex file by redefinition of the variables. + +These commands are: +\begin{lstlisting} +\university {\texorpdfstring{\href{http://www.soton.ac.uk} + {University of Southampton}} + {University of Southampton}} +\UNIVERSITY {\MakeUppercase{\univname}} +\department {} +\DEPARTMENT {\MakeUppercase{\deptname}} +\group {} +\GROUP {\MakeUppercase{\groupname}} +\faculty {} +\FACULTY {\MakeUppercase{\facname}} +\end{lstlisting} +The all caps command version must be run after changing the normal case command for it to change the default. The university example here also has a link embedded. + +More detail can be found in the class docs file. Found in `doc\textgreater latex\textgreater ecsdocs` of the texmf directory discussed in Section~\ref{start}. + +The other common commands already exist in the top level template file. -- GitLab