LaTeX template useful for UCT reports (lab reports or BSc final year project reports) and formal Masters or Doctoral dissertations.
Disclaimer note: these resources are based around what has been used in the Department of Electrical Engineering at UCT; different departments or research units may have their own approaches and expectations of what is required and how to prepare technical documents of this nature. You are thus advised to ensure your work is aligned to what is needed for your context. We are providing this resources as use-at-own-risk contributions (see license details link below).
This template compiles using pdfLaTeX. For the make figures target to also
work, InkScape has to be installed and available on the system path.
The Makefile works in Windows, but it assumes that you're running it from within a bash-like terminal. The easiest way to do this is to use Git Bash. You will also need to install GNU Make, which comes standard with TDM-GCC.
The Bibliography, Figures and
Template folders contain shared resources that both report types
make use of. The two report types are situated in the Article
and Report folders. The Output folder contains the
output generated with all possible option flags.
There are two intended use cases:
- Include the repository as a Git submodule and
\inputthe contents of theTemplatefolder directly. In this case, copy theReportorArticle, as well as theFiguresandBibliographyfolders, to an appropriate place in the parent repository, correct the paths of the\inputcommands and you're all set. - Fork the repository and edit the examples directly.
In both cases it is relatively easy to keep both sides up to date.
The output style is controlled by means of flags defined in the
Template/Flags.tex file of each report type. Set the flags as appropriate.
- To build the report, run
make. - To convert only the figures, run
make figures. This is useful if you're using some other build chain or IDE, such as TeXstudio - To clean up all build products, run
make clean.
There is a special make target all_options, which generates output for all 8
combinations of the option flags for both Article and Report types. The
resulting PDFs are saved in the Output folder.
It is sometimes handy to have a quick reference to all your figures, and where
to find them. The FiguresPreview folder is meant for this purpose. To
update, browse to that folder and run make within a bash-style console.
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
