diff --git a/ECS.bib b/ECS.bib index 380fa737851cf082bf6b054e70788483143d047c..99113bf97d4c98be637dcbc1af6a600c361cda0b 100644 --- a/ECS.bib +++ b/ECS.bib @@ -18,13 +18,13 @@ title = {Updated templates reference 2}, year = {2011} } -@electronic{GNUdesc +@electronic{GNUdesc, author = {{Free Software Foundation, Inc.}}, - title = {GNU Make} + title = {GNU Make}, url = {https://www.gnu.org/software/make/} } -@electronic{Docstrip - author = {Frank MitÂtelÂbach, - title = {docstrip – Remove comments from file} +@electronic{Docstrip, + author = {Frank MitÂtelÂbach}, + title = {docstrip – Remove comments from file}, url = {https://ctan.org/pkg/docstrip?lang=en} } diff --git a/Rebuilding.tex b/Rebuilding.tex index 300eb37c1828b0f21a9949528d116c4431654339..86642ba5a59fb81692588dc67f929b2fad88a187 100644 --- a/Rebuilding.tex +++ b/Rebuilding.tex @@ -1,10 +1,24 @@ -\chapter{Rebuilding the Templates}To change the templates you should understand how the templates are made. -The templates are built using the docstrip package. -"The packÂage preÂpares a \LaTeX kerÂnel or packÂage source file for acÂtual use, by reÂmovÂing the docÂuÂmenÂtaÂtion and meta-data" \citep{Docstrip} -It also creates a document containing some documentation for the created files. - -The docstrip utility comes as a latex package so when the main file (.dtx) is run with the command `latex ecsdocs.dtx` it creates all the class files plus the example templates. -When this tool is run it creates lots of auxiliary files. -To help with managing these auxiliary files GNU Make is used. - -"GNU Make is a tool which controls the generation of executables and other non-source files of a program from the program's source files."\citep{GNUdesc} +\chapter{Rebuilding the Templates}\label{rebuilding} +In most cases this template style and layout will be suitable. If it is not, it may only require a small change to bring the template in line with your institution's recommendations. +Quick modifications will need to be done on the \verb|ecsdocs.cls| file in the \verb|tex/latex/ecsdocs| folder. Modification of all the templates or major modifications should be made to the original \verb|source/docstrip/ecsdocs/ecsdocs.dtx| + +\section{The Build Process} +To change the templates you should understand how the templates are made. +The templates are built using the docstrip package. +"The packÂage preÂpares a \LaTeX kerÂnel or packÂage source file for acÂtual use, by reÂmovÂing the docÂuÂmenÂtaÂtion and meta-data" \citep{Docstrip} +It also creates a document containing some documentation for the created files. + +The docstrip utility comes as a latex package so when the main file (.dtx) is run with the command \verb|latex ecsdocs.dtx| it creates all the class files plus the example templates. +When this tool is run it creates lots of auxiliary files. +To help with managing these auxiliary files GNU Make is used. "GNU Make is a tool which controls the generation of executables and other non-source files of a program from the program's source files."\citep{GNUdesc}. + +The make command can be run in several different configurations. \verb|make all| creates all of the class, template, bibliography and figure files from the source files. \verb|make install| moves all of the created files into the users texmf directory ready for use. + +\section{The Source File} +The source file \verb|ecsdocs.dtx| results in the several different class (\verb|.cls|) files as well as the template (\verb|.tex|) files. +It also creates the figure files and the chapter files. +Whilst this creates a mess of files all in one folder the \verb|make install| command is designed to clean them up into a folder structure described in Listing~\ref{folder_struct}. +The dtx file is designed to ensure continuity across different classes: names, font, department page styling and other formats. +It largely self documents into the folder labelled \verb|doc|. + +As the work done in rebuilding this was for the purpose of improving the PhD Thesis and Progress report templates the others have not been tested.