Skip to content

Latest commit

 

History

History
109 lines (77 loc) · 4.46 KB

README.md

File metadata and controls

109 lines (77 loc) · 4.46 KB
Raw

Thesis template for Aarhus University

This folder has a template project to use for writing your thesis using LaTeX.

As soon as the project date has been set as described in the date section below, the project should work out of the box in both Overleaf and natively on linux using mktex with texlive-full installed.

Usage

Just clone the project, fill out the title, subtitle, etc in main.tex and start typing. Alternatively, you can just download the au-thesis.cls file and use that in your project.

Multiple authors and co-supervisor

Currently the project doesn't support multiple authors or projects without a co-supervisor without editing the .cls file. If you fix this, please upload it and delete this heading.

Specifics

This sections details a few configuration elements that might be of interest.

Structure

The project is structured as follows:

  • appendices: .tex files for all appendices. Must be included in main.tex
  • chapters: .tex files for all chapters - can be replaced by a folder for long chapters. Must be included in the main.tex file.
  • figures: Figures used directly in main. Will most likely just be the seal. See section on figures.
  • frontmatter: .tex files for frontmatter (i.e. introduction, acknowledgements, etc.)
  • au-thesis.cls: The latex class for formatting - Also holds the definition of the custom title page.
  • listofacronyms.tex: The .tex file containing acronym definitions
  • main.tex: The main file for the overall structure of the document
  • README.md: This file
  • references.bib: The bibtex file for the project.

Date

The date of the project is saves as a datetime variable called date. The day, month, and year must be set in the main.tex before the document compiles.

Figures

This template is currently setup to automatically look for figures in a figures folder located in the same directory as the .tex file that contains the \includegraphics command. If you wish not to use this setup, comment out the following lines from the au-thesis.cls file:

``` latex
% save the meaning of \includegraphics
\LetLtxMacro\latexincludegraphics\includegraphics
% redefine \includegraphics to refer to the subfolder Figures
\renewcommand{\includegraphics}[2][ ]{\latexincludegraphics[#1]{figures/#2}}
```

Title page

The title page of the project is customized in the final section of the au-thesis.cls file, using the titling package. This package works by defining pre- and post- hooks for each title element (i.e. author, date, etc.) as well as hooks a-d for the sections in-between. All title page elements should be set using the corresponding commands in the main.tex file, but if one wishes to alter the layout, read the documentation for the titling package and edit the au-thesis.cls file accordingly.

Acronyms

The template includes the acronym package to generate a list of acronyms, and ensure that the full term is used once followed by the acronym in parentheses on the first occurrence. The acronyms are defined in the file listofacronyms.tex.

Example

``` latex
\section{List of acronyms}
    \begin{acronym}[test]
        \acro{na}[NA]{Normal Abbreviation}
        \acroindefinite{na}{an}{a}
    \end{acronym}

\section{Sample}
    \Ac{na} is an example of a capitalized abbreviation, while \ac{na} wouldn't have been
    capitalized if it had included the long form. All commands that insert text have a capitalized 
    version. \Iac{na} has the corrent indefinate article, while \acp{na} makes it plural.

    There are many more commands, so see the documentation if you're missing something.
```

Example render

The above would render approximately the following:

List of acronyms

NA Normal Abbreviation

Sample

Normal Abbreviation (NA) is an example of a capitalized abbreviation, while NA wouldn’t have been capitalized if it had included the long form. All commands that insert text have a capitalized version. An NA has the corrent indefinate article, while NAs makes it plural.
There are many more commands, so see the documentation if you’re missing something.

Hyperref

au-thesis.cls automatically sets the pdf parameters like title and author based on the commands in the main file using hyperref, and disables the red boxes around hyperlinks.