Skip to content
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/preview/thwildau-thesis/0.1.0/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright © 2026 Carl Heinrich Bellgardt

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
271 changes: 271 additions & 0 deletions packages/preview/thwildau-thesis/0.1.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,271 @@
# TH Wildau Typst Thesis Template

## Overview

A Typst template for creating academic theses and internship reports at TH Wildau. It provides structured layouts, consistent styling, and utilities for common academic elements.

---

## Configuration

The template is configured centrally via `conf.with(...)`. Required fields are validated at compile time and will produce errors if missing.

### Required fields

* `title`
* `student`
* `supervisor`

### Optional fields

* `internship`
* `bibliography`
* `language`

---

## Auto-generated Pages

The template automatically generates several standard pages:

* Title page (can be replaced by custom content or a PDF)
* Bibliographic description (multi-language)
* Reading guide
* Declaration of authorship
* Company confirmation
* Appendix support

---

## Multi-language Support

Static UI text is translated using `/utils/translations.json`.
The system is easily extendable without programming knowledge. Missing translations will result in compile errors.

---

## Tables

The template provides predefined table styles:

* `tables.x-header`
* `tables.xy-header`

Tables are automatically included in a list of tables.

---

## Figures and Code

* Native Typst figures are supported
* Automatic list of figures
* Inline and block code supported

---

## Info Cards

Info cards allow highlighting important content such as notes or definitions.
Their appearance can be customized.

---

## Units

Units can be defined and reused centrally:

* Define via `define_unit`
* Use via `unit`

---

## Abbreviations

Abbreviations can be defined and referenced:

* Define via `define_abbreviation`
* Use via `abbreviation`
* Automatic list of abbreviations

---

## TODO System

* Inline TODOs via `todo[...]`
* Optional annotations
* Automatic TODO list
* Visual highlighting in the document

---

## Bibliography

The template integrates Typst’s bibliography system and allows configurable citation styles.

---

## Example

```typst
#import "@preview/thwildau-thesis:0.1.0": *

#show: conf.with(
title: "My Thesis",
student: (
name: "Max Mustermann",
matrnr: "12345678",
),
supervisor: (
name: "Dr. Example",
),
)
```

---

## Notes

Designed for minimal Typst knowledge with a strong focus on automation and consistency.

---

## Contributing

Contributions and feature requests are welcome.

---

# TH Wildau Typst-Vorlage für Abschlussarbeiten

## Überblick

Eine Typst-Vorlage zur Erstellung von Abschlussarbeiten und Praxisberichten an der TH Wildau. Sie bietet strukturierte Layouts, einheitliches Styling und Hilfsfunktionen für typische wissenschaftliche Inhalte.

---

## Konfiguration

Die Vorlage wird zentral über `conf.with(...)` konfiguriert. Pflichtfelder werden zur Compile-Zeit geprüft und erzeugen Fehler, falls sie fehlen.

### Pflichtfelder

* `title`
* `student`
* `supervisor`

### Optionale Felder

* `internship`
* `bibliography`
* `language`

---

## Automatisch erzeugte Seiten

Die Vorlage erzeugt automatisch mehrere Standardseiten:

* Titelseite (kann durch eigenes PDF ersetzt werden)
* Bibliographische Beschreibung (mehrsprachig)
* Lesehinweise
* Selbstständigkeitserklärung
* Firmenbestätigung
* Anhang

---

## Mehrsprachigkeit

Statische Texte werden über `/utils/translations.json` übersetzt.
Das System ist einfach ohne Programmierkenntnisse erweiterbar. Fehlende Übersetzungen führen zu Compilerfehlern.

---

## Tabellen

Die Vorlage bietet vordefinierte Tabellenstile:

* `tables.x-header`
* `tables.xy-header`

Tabellen werden automatisch in ein Tabellenverzeichnis aufgenommen.

---

## Abbildungen und Code

* Typst-Abbildungen werden unterstützt
* Automatisches Abbildungsverzeichnis
* Inline- und Block-Code möglich

---

## Info-Karten

Info-Karten ermöglichen die Hervorhebung wichtiger Inhalte wie Hinweise oder Definitionen.
Das Erscheinungsbild ist anpassbar.

---

## Einheiten

Einheiten können zentral definiert und wiederverwendet werden:

* Definition über `define_unit`
* Verwendung über `unit`

---

## Abkürzungen

Abkürzungen können definiert und referenziert werden:

* Definition über `define_abbreviation`
* Verwendung über `abbreviation`
* Automatisches Abkürzungsverzeichnis

---

## TODO-System

* Inline-TODOs über `todo[...]`
* Optionale Hinweise
* Automatisches TODO-Verzeichnis
* Visuelle Hervorhebung im Dokument

---

## Literaturverzeichnis

Die Vorlage integriert das Typst-Bibliographiesystem und ermöglicht konfigurierbare Zitierstile.

---

## Beispiel

```typst
#import "@preview/thwildau-thesis:0.1.0": *

#show: conf.with(
title: "Meine Arbeit",
student: (
name: "Max Mustermann",
matrnr: "12345678",
),
supervisor: (
name: "Dr. Beispiel",
),
)
```

---

## Hinweise

Für geringe Typst-Vorkenntnisse konzipiert, mit Fokus auf Automatisierung und Konsistenz.

---

## Mitwirken

Beiträge und Feature-Wünsche sind willkommen.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please check that you are allowed to distribute this logo? And if so, can you specify under which terms it is shared and can be used, for example in your README?

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions packages/preview/thwildau-thesis/0.1.0/components/abbreviation.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#let abbr-state = state("abbreviations", (:))

#let define-abbreviation(abbreviation, description) = {
// TODO: duplicates error handling
let id = str("abbr-" + abbreviation)
// Store full info in state
context {
abbr-state.update(abbr-state.get() + (str(id): (abbreviation, description)))
}
// Create link to later entry
show link: set text(fill: black)
link(label(id))[#emph[#abbreviation]]
}

#let abbreviation(abbreviation) = {
// TODO: make this work with either symbol or name. Error handling
let id = str("abbr-" + abbreviation)
show link: set text(fill: black)

link(label(id))[#emph[#abbreviation]]
}
33 changes: 33 additions & 0 deletions packages/preview/thwildau-thesis/0.1.0/components/infocard.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
#import "th_color.typ": th-color

#let infocard(
heading,
description,
color-dark: th-color.paleblue,
color-light: th-color.lightblue2
) = {
figure(
{
set block(
width: 100%,
inset: 10pt,
stroke: 1pt + color-dark
)
show block: (it) => align(left, it)
block(
text(strong(heading), fill: color-light),
fill: color-dark,
radius: (top: 5pt),
below: 0pt,
)
block(
text(description),
fill: color-light,
radius: (bottom: 5pt),
above: 0pt
)
},
kind: "infocard",
supplement: none
)
}
45 changes: 45 additions & 0 deletions packages/preview/thwildau-thesis/0.1.0/components/tables.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
#import "th_color.typ": th-color

#let frame() = (x, y) => (
left: none,
right: none,
top: 0pt,
bottom: .5pt + gray,
)

#let x-header(doc) = {
// default styling for tables
set table(
fill: (x, y) => if y == 0 { th-color.paleblue } else if calc.even(y) { color.white } else { th-color.lightblue },
stroke: frame(),
)
show table.cell: it => {
if it.y == 0 {
set text(white)
strong(it)
} else {
it
}
}
doc
}

#let xy-header(doc) = {
// default styling for tables
set table(
fill: (x, y) => if x == 0 or y == 0 { th-color.paleblue } else if calc.even(y) { color.white } else {
th-color.lightblue
},
// TODO: the border is 1px to long at the left-bottom corner
stroke: frame(),
)
show table.cell: it => {
if it.x == 0 or it.y == 0 {
set text(white)
strong(it)
} else {
it
}
}
doc
}
10 changes: 10 additions & 0 deletions packages/preview/thwildau-thesis/0.1.0/components/th-color.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#let th-color = (
"blue": rgb("#005bae"),
"paleblue": rgb("#3E6E9F"),
"lightblue": rgb("#D8E8F5"),
"lightblue2": rgb("#EFF4FB"),
"orange": rgb("#f2871a"),
"paleorange": rgb("#FCDCAA"),
"green": rgb("#99c23c"),
"magenta": rgb("#d80976"),
)
Loading
Loading