Universe

Create project in app

These unofficial templates enable you to write Typst documents in the TU Darmstadt corporate design.

Disclaimer

Please ask your supervisor if you are allowed to use Typst and one of these templates for your thesis or other documents. Note that these templates are not checked by TU Darmstadt for correctness. Thus, these templates don’t guarantee completeness or correctness. For notes about publishing on TUbama see Publishing.

Implemented Templates

The templates copy the corresponding LaTeX templates found here: tuda_latex_templates. Note that there may be visual differences between the original LaTeX template and the Typst version. Feel free to open an issue here if you find one!

For missing features, ideas or other problems, feel free to open an issue as well. Contributions are also welcome.

Template Preview Example Scope
tudapub An exemplary tudapub front cover example_tudapub.pdf
example_tudapub.typ
Master and Bachelor theses
tudaexercise An exemplary tudaexercise sheet Example File Exercises
not-tudabeamer-2023 An exemplary tudabeamer title slide Example File Presentations

Usage

To create a new Typst project based on one of these templates locally:

# for tudapub
typst init @preview/athena-tu-darmstadt-thesis
cd athena-tu-darmstadt-thesis

# for tudaexercise
typst init @preview/athena-tu-darmstadt-exercise
cd athena-tu-darmstadt-exercise

# for not-tudabeamer-2023
typst init @preview/not-tudabeamer-2023
cd not-tudabeamer-2023

You can also create a project on the Typst web app based on these templatess.

Manual Installation For a manual setup create a folder for your writing project and clone this template into the `templates` folder:
mkdir my_thesis && cd my_thesis
mkdir templates && cd templates
git clone https://github.com/tuda-typst/tuda-typst-templates

Logo and Font Setup

Download the TUDa logo from download.hrz.tu-darmstadt.de/protected/ULB/tuda_logo.pdf and put it into the assets/logos folder. Since Typst 0.14.0, you can use the logo PDF file directly. If you use an earier version of Typst, see below for instructions on how to convert the logo to an SVG file.

Converting the Logo to SVG Now execute the following script in the `assets/logos` folder to convert it into an svg:
cd assets/logos
./convert_logo.sh

Note: This script uses the pdf2svg command, which might not be available to you. In this case we recommend a online converter such as PDF24 Tools. There is also a tool to install images as local Typst packages.

Also download the required fonts Roboto and XCharter:

cd assets/fonts
./download_fonts.sh

Optionally, you can install all fonts in the folders in fonts on your system. Alternatively, you can also use Typst’s --font-path option or install them in a folder and add the folder to the TYPST_FONT_PATHS environment variable.

Note: wget might not be available to you. You may replace the command with something like curl <url> -o <filename> -L

Creating a `main.typ` File after Manual Template Installation. Create a simple `main.typ` in the root folder (e.g., `my_thesis`) of your new project:
#import "templates/tuda-typst-templates/tudapub/template/lib.typ": *

#show: tudapub.with(
  title: [
    My Thesis
  ],
  author: "My Name",
  accentcolor: "3d"
)

= My First Chapter
Some Text

Compiling Your Typst File

typst watch main.typ --font-path assets/fonts/

This will watch your file and recompile it to a PDF when the file is saved. For writing, you can use VS Code with Tinymist. Alternatively, use the Typst web app. Note that you’ll have to upload your logos and fonts manually.

Note that we add --font-path to ensure that the correct fonts are used. Due to a bug, Typst sometimes uses the font Roboto condensed instead of Roboto. To be on the safe side, double-check the embedded fonts in the pdf: There should be no Roboto condensed. Removing Roboto condensed from your system prevents this issue.

Publishing on TUbama

For publishing your compiled document (e.g. thesis) on TUbama, the document has to comply with the pdf/A standard. Therefore, set the PDF standard for compiling for the final submission:

typst compile main.typ --font-path assets/fonts/ --pdf-standard a-2b

In case this should not yield a PDF which is accepted by TUbama, you can use a converter to convert from the Typst output to PDF/A, but check that there are no losses during the conversion.

Contributing

See CONTRIBUTING.md