This is a template I built for all of my papers in university. It is tailored to fit my specific requirements and can be easily adapted. It does not utilize any custom documentclass, but uses plain LaTeX only.
All you really need to compile the document is one of the implementations of LaTeX.
I recommend using texlive
.
Texlive can be installed like this:
- Arch based:
pacman -S texlive-core
orpacman -S texlive-most
- Debian based:
apt-get install texlive-full
The document can easily be compiled using pdflatex
.
To get the glossary as well makeglossaries
has to be run as well inbetween two runs of pdflatex
.
pdflatex main.tex
makeglossaries main
pdflatex main.tex
This simple procedure can also be found in the compile.sh
script.
The template should be used like this:
Put all content in .tex
files in the ./sections
folder.
Include them in the main.tex
file like so:
\input{sections/name_of_file.tex}
To keep things tidy my suggestion is to have each section in it's own file.
Figures and images are to be put into the template and included like so:
\begin{figure}[h]
\centering
\includegraphics[width=\textwidth]{figures/figure_01.jpg}
\caption{Here is where a caption would be}\label{fig:untargeted}
\end{figure}
You can specify a width in the [width=\textwidth]
brackets. Replace \textwidth
with 10cm
for example.
You can set a caption for the image using \caption{}
and you can also reference the image by setting a \label{}
and reference it by using \ref{}
.
The Template uses the APA-reference style for quotations.
Bibliography entries are to be added in the bibliography file (bibliography/bibliography.bib
) using regular BibTeX
-Syntax.
@article{turing1937computable,
title={On computable numbers, with an application to the Entscheidungsproblem},
author={Turing, Alan Mathison},
journal={Proceedings of the London mathematical society},
volume={2},
number={1},
pages={230--265},
year={1937},
publisher={Wiley Online Library}
}
To cite a source from the file there are multiple options.
To get a citation with the (name, year)
format, use \cite{nameOfSource}
.
It is possible to also specify a pagenumber using \cite[p.~58]
which will result in (name, year, p. 58)
.
For a inline ciatation of format Name (Year)
or Name et al (Year)
use \citeA{nameOfSource}
.
Further information on the apacite
package can be found in the documentation.
When citing sources in a \caption{}
the citation needs to be protected with \protect
.
Example: \caption{Theoretical constructs from \protect\citeA{Jones01}}
.
Definitions that go into the glossary are specified in glossary/glossary.tex
.
A new glossary entry is specified as follows.
\newglossaryentry{cpu}
{
name={Central Processing Unit},
description={Is what makes computer go bleep bloop}
}