Rebuilding.tex 2.53 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
\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.

11
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.
12
13
14
15
16
17
18
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.
19
20
21
"The installer is the \verb|ecsdocs.ins| file. An installer file
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{}
22
23
24
25
26
27
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.