Classic AAU Report

Unofficial Typst template for project reports at Aalborg University (AAU).
This is based on the LaTeX template https://github.com/jkjaer/aauLatexTemplates.

The template is generic to any field of study, but defaults to Computer Science.

Usage

Click "Create project in app".

Or via the CLI

typst init @preview/classic-aau-report

NOTE:
The template tries to use the Palatino Linotype font, which is not available in Typst.
It is available here (direct download)

To use it in the web-app, put the .ttf files anywhere in the project tree.

To use it locally specify the --font-path flag (or see the docs).

Confugiration

The project function takes the following (optional) arguments:

• meta: Metadata about the project

  • project-group: The project group name
  • participants: A list of participants
  • supervisors: A list of supervisors
  • field-of-study: The field of study
  • project-type: The type of project

• en: English project info

  • title: The title of the project
  • theme: The theme of the project
  • abstract: The English abstract of the project
  • department: The department name
  • department-url: The department URL

• dk: Danish project info (can be omitted entirely)

  • title: The Danish title of the project
  • theme: The theme of the project in Danish
  • abstract: The Danish abstract of the project
  • department: The department name in Danish
  • department-url: The Danish department URL

• is-draft: A boolean indicating whether or not to include the frontmatter

• margins: A margin specification according to the docs

• clear-double-page: Whether or not to clear to the next odd page on chapters

• font: The font to use

The defaults are as follows:

meta: (
  project-group: "No group name provided",
  participants: (),
  supervisors: (),
  field-of-study: none,
  project-type: "Semester Project"
),
en: (
  title: "Untitled",
  theme: none,
  abstract: none,
  department: "Department of Computer Science",
  department-url: "https://www.cs.aau.dk",
),
dk: (
  title: "Uden titel",
  theme: none,
  abstract: none,
  department: "Institut for Datalogi",
  department-url: "https://www.dat.aau.dk",
),
is-draft: false,
margins: (inside: 2.8cm, outside: 4.1cm),
clear-double-page: true,
font: "Palatino Linotype",

Furthermore, the template exports the show rules

• mainmatter: Sets the page numbering to arabic and chapter numbering to none
• chapters: Sets the chapter numbering Chapter followed by a number.
• backmatter: Sets the chapter numbering back to none
• appendix: Sets the chapter numbering to Appendix followed by a letter.

All of the above show rules take the optional parameter skip-double,
which only skips to the next page (as opposed to next odd) on chapters, when set to false.

To use it in an existing project, add the following show rule.

#import "@preview/classic-aau-report:0.3.1": project, mainmatter, chapters, backmatter, appendix

// Any of the below can be omitted, the defaults are either empty values or CS specific
#show: project.with(
  meta: (
    project-group: "CS-xx-DAT-y-zz",
    participants: (
      "Alice",
      "Bob",
      "Chad",
    ),
    supervisors: "John McClane"
  ),
  en: (
    title: "An Awesome Project",
    theme: "Writing a project in Typst",
    abstract: [],
  ),
  // omit the `dk` option completely to remove the Danish titlepage
  dk: (
    title: "Et Fantastisk Projekt",
    theme: "Et projekt i Typst",
    abstract: lorem(50),
  ),
  is-draft: true
)

#show: mainmatter
// OR: #show: mainmatter.with(skip-double: false)
#include "chapters/introduction.typ"

#show: chapters
#include "chapters/problem-analysis.typ"

#show: backmatter
#include "chapters/conclusion.typ"
#bibliography("references.bib", title: "References")

#show: appendix
#include "appendices/some-appendix.typ"

Customizing

If you wish to customize the template further (for local use), clone the source and install the package locally.

git clone https://github.com/Tinggaard/classic-aau-report
cd classic-aau-report
# make your edits
just install

This will make the package available via the @local namespace (@local/classic-aau-report:0.3.1)