DTU Note Template

A professional Typst template package for Danish Technical University (DTU) students and staff, designed to follow the official DTU Design Guide 2018.

Features

Official DTU Branding: Uses official DTU colors and design elements
Multiple Document Types: Support for notes and assignments
Professional Typography: Neo Sans font (with Arial fallback) following DTU guidelines
Styled Content Boxes: Definitions, theorems, examples, important notes, and highlights
Header/Footer: Professional headers and footers with DTU branding
Mathematical Styling: Proper equation numbering and formatting
CLI Integration: Designed to work with dtu-notes Rust CLI

Installation

Manual Installation

Download the latest release
Extract to your local Typst packages directory:
- Windows: %APPDATA%/typst/packages/local/dtu-template/0.1.0/
- macOS: ~/Library/Application Support/typst/packages/local/dtu-template/0.1.0/
- Linux: ~/.local/share/typst/packages/local/dtu-template/0.1.0/

Usage

Notes Template

#import "@local/dtu-template:0.4.0": dtu-note

#show: dtu-note.with(
  course: "02101",
  course-name: "Introduction to Programming",
  title: "Lecture 5: Data Structures",
  date: datetime(year: 2024, month: 3, day: 15),
  author: "Your Name",
  semester: "Spring 2024"
)

= Introduction
This is your content...

== Subsection
More content here...

Note: For enhanced workflow with automatic course name resolution and project management, consider using the dtu-notes CLI tool.

Assignment Template

#import "@local/dtu-template:0.1.0": dtu-assignment

#show: dtu-assignment.with(
  course: "02102",
  course-name: "Algorithms and Data Structures",
  title: "Assignment 3",
  due-date: datetime(year: 2024, month: 4, day: 1),
  author: "Your Name",
  semester: "Spring 2024"
)

= Problem 1
Solve the following...

Tip: The dtu-notes CLI can automatically generate templates with course information.

Content Boxes

The template provides several styled content boxes:

#import "@local/dtu-template:0.4.0": definition, theorem, example, important, note-box, dtu-highlight

#definition("Algorithm", [
  A step-by-step procedure for solving a problem.
])

#theorem(name: "Fundamental Theorem", [
  Every integer greater than 1 is either prime or composite.
])

#example([
  Here's how to implement a binary search...
])

#important([
  Remember to handle edge cases!
])

#note-box([
  This is a helpful note for later reference.
])

#dtu-highlight([
  Key concept that will be important for the exam.
])

Available Templates

`dtu-note`

Perfect for lecture notes, study materials, and academic documentation.

Parameters:

course: Course code (e.g., "02101")
course-name: Full course name (optional, can be auto-filled from course code)
title: Document title
date: Date of the document
author: Your name
semester: Academic semester

`dtu-assignment`

Designed for homework, projects, and assignments.

Parameters:

course: Course code
course-name: Full course name (optional)
title: Assignment title
due-date: Assignment due date
author: Student name
semester: Academic semester

DTU Colors

The template includes all official DTU colors:

Primary Colors: DTU Red (#990000), White, Black
Secondary Colors: Blue (#2F3EEA), Green (#1FD082), Dark Blue (#030F4F), Yellow (#F6D04D), Orange (#FC7634), Salmon (#F7BBB1), Gray (#DADADA), Coral (#E83F48), Dark Green (#008835), Purple (#79238E)

CLI Integration and Configuration

This template is designed to work seamlessly with the dtu-notes Rust CLI tool. The integration is configured through the .noter.config.toml file, which defines how the templates interact with the CLI system.

Configuration File Structure

The example.noter.config.toml file in the examples/ directory demonstrates a comprehensive configuration for the DTU Notes CLI integration. Here's what each section controls:

Metadata Section

[metadata]
name = "dtu-templates"
version = "0.4.0"
description = "Official DTU academic templates for notes and assignments"
repository = "https://github.com/HollowNumber/dtu-template"
author = "DTU Notes Team"
license = "MIT"

This section identifies the template package and provides basic information about its source and licensing.

Template Definitions

[[templates]]
name = "lecture-note"
display_name = "Lecture Notes"
description = "Standard template for taking lecture notes with DTU branding"
file = "lecture.typ"
function = "lecture-template"
supports_variants = true
course_types = ["all"]
default_sections = [
    "Key Concepts",
    "Mathematical Framework",
    "Examples",
    "Important Points",
    "Questions & Follow-up"
]

Each [[templates]] block defines an available template type with:

name: Internal identifier used in CLI commands
display_name: User-friendly name shown in help messages
file: Typst template file within the package
function: Typst function name to call when generating documents
supports_variants: Whether specialized variants exist for different course types
course_types: Which types of courses can use this template ("all" or specific types)
default_sections: Sections automatically created in new documents

Template Variants

[[variants]]
template = "assignment"
name = "math-assignment"
display_name = "Mathematical Assignment"
course_types = ["math", "statistics", "engineering"]
file = "src/variants/math-assignment.typ"
function = "math-assignment-template"
additional_sections = [
    "Mathematical Proofs",
    "Theoretical Analysis",
    "Formula Derivations"
]

Variants provide specialized versions of templates for specific course types:

template: References the base template name
course_types: Course patterns that trigger this variant
additional_sections: Extra sections added to the base template's default sections
override_sections: Completely replaces default sections if specified

Course Type Mapping

[course_mapping]
"01xxx" = "math"                    # Math courses (01005, 01006, etc.)
"02xxx" = "programming"             # Computer Science (02101, 02102, etc.)
"25xxx" = "physics"                 # Physics courses
"22xxx" = "electronics"             # Electronics and electrical engineering

This section maps DTU course code patterns to course types, enabling automatic variant selection. For example, any course starting with "02" (like 02101, 02102) will be classified as "programming" and use programming-specific template variants.

Engine Configuration

[engine]
[engine.features]
supports_conditionals = true
supports_custom_sections = true
supports_dynamic_content = true
supports_expressions = false
supported_formats = ["typst"]

The engine section controls template processing capabilities:

features: What template capabilities are enabled (conditionals, custom sections, etc.)
compatibility: Version requirements and platform support
processing: File encoding, line endings, and text processing settings
variables: Template variable substitution configuration
validation: Template checking and error reporting rules
rendering: Performance settings like caching and timeouts

Built-in Variables

The configuration defines several built-in variables always available in templates:

author: User's name from configuration
date: Current date
course_id: Course identifier (e.g., "02101")
course_name: Full course name
title: Document title
semester: Current semester string
year: Current year

Using the Configuration

When you use the DTU Notes CLI with this template package:

The CLI reads the .noter.config.toml file to understand available templates
Based on your course code, it automatically selects appropriate template variants
It provides the defined built-in variables to the Typst templates
It creates documents with the default sections specified for each template type

This integration provides a seamless experience where the CLI handles course-specific customization automatically while you focus on content creation.

Examples

Check the examples/ directory for complete document samples:

Basic note template usage
Assignment with multiple problems
Advanced formatting examples
Complete CLI configuration file (example.noter.config.toml)

Requirements

Typst 0.11.0 or later
DTU logo file (included in package)

Contributing

Contributions are welcome! Please feel free to:

Report bugs or request features via GitHub Issues
Submit pull requests for improvements
Enhance template functionality and styling
Improve documentation

Development

To work on this template:

git clone https://github.com/HollowNumber/dtu-note-template.git
cd dtu-note-template

Development Pipeline with Just

This project uses Just for task automation.

Quick Setup

Run the setup script to install dependencies automatically:

# Windows PowerShell
.\setup.ps1

Manual Setup

Install Typst (if not already installed):

# Download from: https://github.com/typst/typst/releases

Install Just:

# Windows (Chocolatey)
choco install just

# Windows (Scoop)
scoop install just

# Manual installation:
# Download from: https://github.com/casey/just/releases

Common Development Tasks

# List all available commands
just --list

# Run all tests and checks
just check

# Compile all example documents
just examples

# Start development workflow (compile + watch for changes)
just dev

# Install template locally for testing
just install-local

# Run CI simulation
just ci

# Prepare for release
just pre-release

Development Workflow

Setup: just setup - Prepares development environment
Development: just dev - Starts watch mode with automatic recompilation
Testing: just test - Runs comprehensive tests
Quality: just lint - Checks code quality and consistency
Package: just package - Creates release package

File Structure for Development

dtu-note-template/
├── justfile              # Development automation
├── 0.1.0/               # Typst package
│   ├── typst.toml       # Package config
│   ├── src/lib.typ      # Main template
│   └── src/misc/        # Assets
├── examples/            # Example documents
├── test-output/         # Generated during testing
└── .github/workflows/   # CI/CD automation

Test your changes locally by symlinking to your local packages directory or using the --root flag with Typst.

License

This project is licensed under the MIT License. See LICENSE for details.

Disclaimer

This is an unofficial template. While it follows DTU's official design guidelines, it is not endorsed by DTU. The DTU logo is used under educational fair use.

Acknowledgments

Danish Technical University for the design guidelines
The Typst team for the excellent typesetting system
Contributors who helped improve this template

Technical University of Denmark Developed by students, for students

Name		Name	Last commit message	Last commit date
Latest commit History 21 Commits
.github		.github
examples		examples
src		src
.gitignore		.gitignore
.noter.config.toml		.noter.config.toml
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
ENHANCEMENT_GUIDE.md		ENHANCEMENT_GUIDE.md
LICENSE		LICENSE
README.md		README.md
justfile		justfile
typst.toml		typst.toml

License

HollowNumber/dtu-note-template

Folders and files

Latest commit

History

Repository files navigation

DTU Note Template

Features

Installation

Manual Installation

Usage

Notes Template

Assignment Template

Content Boxes

Available Templates

dtu-note

dtu-assignment

DTU Colors

CLI Integration and Configuration

Configuration File Structure

Metadata Section

Template Definitions

Template Variants

Course Type Mapping

Engine Configuration

Built-in Variables

Using the Configuration

Examples

Requirements

Contributing

Development

Development Pipeline with Just

Quick Setup

Manual Setup

Common Development Tasks

Development Workflow

File Structure for Development

License

Disclaimer

Acknowledgments

About

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases 6

Packages 0

Languages

`dtu-note`

`dtu-assignment`

Packages