\chapter{Rebuilding the Templates}\label{rebuilding}
\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.
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|
Quick modifications will need to be done on the \verb|uosdocs.cls| file in the \verb|tex/latex/uosdocs| folder. Modification of all the templates or major modifications should be made to the original \verb|source/docstrip/uosdocs/uosdocs.dtx|
\section{The Build Process}
\section{The Build Process}
To change the templates you should understand how the templates are made.
To change the templates you should understand how the templates are made.
...
@@ -8,15 +8,15 @@ The templates are built using the docstrip package.
...
@@ -8,15 +8,15 @@ The templates are built using the docstrip package.
"The package prepares a \LaTeX kernel or package source file for actual use, by removing the documentation and meta-data" \citep{Docstrip}
"The package prepares a \LaTeX kernel or package source file for actual use, by removing the documentation and meta-data" \citep{Docstrip}
It also creates a document containing some documentation for the created files.
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.ins| it creates all the class files plus the example templates.
The docstrip utility comes as a latex package so when the main file (.dtx) is run with the command \verb|$(LATEX) uosdocs.ins| it creates all the class files plus the example templates.
When this tool is run it creates lots of auxiliary files.
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}.
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.
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}
\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.
The source file \verb|uosdocs.dtx| results in the several different class (\verb|.cls|) files as well as the template (\verb|.tex|) files.
"The installer is the \verb|ecsdocs.ins| file. An installer file
"The installer is the \verb|uosdocs.ins| file. An installer file
extracts the code from a \verb|.dtx| file, uses \verb|DocStrip| to
extracts the code from a \verb|.dtx| file, uses \verb|DocStrip| to
strip off the comments and documentation, and outputs the \verb|.cls| files."\citep{}
strip off the comments and documentation, and outputs the \verb|.cls| files."\citep{}
It also creates the figure files and the chapter files.
It also creates the figure files and the chapter files.
@@ -8,31 +8,31 @@ The structure of this folder should look like this.
...
@@ -8,31 +8,31 @@ The structure of this folder should look like this.
+-texmf
+-texmf
+-bibtex
+-bibtex
| +-bib
| +-bib
| | +-ecsdocs
| | +-uosdocs
| +-bst
| +-bst
| +-ecsdocs
| +-uosdocs
+-doc
+-doc
| +-latex
| +-latex
| +-ecsdocs
| +-uosdocs
+-templates
+-templates
| +-latex
| +-latex
| +-ecsdocs
| +-uosdocs
+-tex
+-tex
| +-latex
| +-latex
| +-ecsdocs
| +-uosdocs
+-source
+-source
+-docstrip
+-docstrip
+-ecsdocs
+-uosdocs
\end{lstlisting}
\end{lstlisting}
On some \LaTeX{} systems, the directory look-up tables will need to be refreshed after making additions or deletions to the system files.
On some \LaTeX{} systems, the directory look-up tables will need to be refreshed after making additions or deletions to the system files.
For TeXlive systems this is accomplished via executing \verb|texhash| as root.
For TeXlive systems this is accomplished via executing \verb|texhash| as root.
MikTeX users can run \verb|initexmf -u| to accomplish the same thing.
MikTeX users can run \verb|initexmf -u| to accomplish the same thing.
The \verb|templates/latex/ecsdocs| folder contains the files to get you started.
The \verb|templates/latex/uosdocs| folder contains the files to get you started.
The base file is \verb|Thesis.tex| for a thesis and \verb|Progress.tex| for a progress report.
The base file is \verb|Thesis.tex| for a thesis and \verb|Progress.tex| for a progress report.
The base files have dependancies for the sections and the figures.
The base files have dependancies for the sections and the figures.
These files are: \verb|Definitions.tex|, \verb|Introduction.tex|, \verb|Conclusion.tex|, \verb|AppendixA.tex|, \verb|figure.eps|, \verb|ECS.bib|. To start using the templates, copy the base file and the dependancies into your working directory.
These files are: \verb|Definitions.tex|, \verb|Introduction.tex|, \verb|Conclusion.tex|, \verb|AppendixA.tex|, \verb|figure.eps|, \verb|UOS.bib|(in the bibtex base folder). To start using the templates, copy the base file and the dependancies into your working directory.
These files are designed as a starting point for the structure of your thesis.
These files are designed as a starting point for the structure of your thesis.
If you are familiar with \LaTeX{}, go and explore the template and use it. Maybe start with putting your info in the section \emph{THESIS/DOC INFORMATION} block of the \verb|Thesis.tex| or \verb|Progress.tex| file. You can then modify the rest of this file to your unique specifications based on your degree/university. If you are new to \LaTeX{} then read about the file structure below.
If you are familiar with \LaTeX{}, go and explore the template and use it. Maybe start with putting your info in the section \emph{THESIS/DOC INFORMATION} block of the \verb|Thesis.tex| or \verb|Progress.tex| file. You can then modify the rest of this file to your unique specifications based on your degree/university. If you are new to \LaTeX{} then read about the file structure below.
...
@@ -90,7 +90,7 @@ These commands are:
...
@@ -90,7 +90,7 @@ These commands are:
\end{lstlisting}
\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.
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 \verb|doc\latex\ecsdocs|
More detail can be found in the class docs file. Found in \verb|doc\latex\uosdocs|
of the texmf directory discussed in Section~\ref{start}.
of the texmf directory discussed in Section~\ref{start}.
The other common commands already exist in the top level template file.
The other common commands already exist in the top level template file.
