Skip to content

LevinTheDoctor/fom-typst-template

Repository files navigation

FOM-Typst-Template

Wissenschaftliche Arbeiten nach dem FOM-Leitfaden – ohne Formatierungsstress.

Dieses Template setzt den Leitfaden zur formalen Gestaltung von Seminar- und Abschlussarbeiten der FOM Hochschule (Stand Januar 2024) mit Typst um – einem modernen, schnellen Satzsystem. Seitenränder, Zitierweise, sämtliche Verzeichnisse und die seit 2024 verpflichtenden KI-Nachweise sind vorkonfiguriert: Du schreibst nur noch.

⚠️ Community-Projekt, kein offizielles Angebot der FOM Hochschule. Verbindlich ist immer der Leitfaden bzw. die Absprache mit dem Erstgutachter.

✨ Funktionen

📐 Layout nach Leitfaden 1.2 DIN A4, Ränder 4/2/4/2 cm, Times New Roman 12 pt (bzw. Arial 11,5 pt), 1,5-zeilig, Blocksatz, Silbentrennung, Fußnoten 10 pt einzeilig
🔢 Seitennummerierung Titelblatt gezählt ohne Nummer, Verzeichnisse römisch ab II, Textteil arabisch ab 1, Eigenständigkeitserklärung ohne Nummer
📚 Zitieren per Funktion #vgl(<quelle>, seite: "12") → „Vgl. Mayer, D., Finanzinvestitionen, 2019, S. 12.“ – wahlweise Chicago (Fußnoten mit Stichwort) oder Harvard (im Text), umschaltbar mit einer Zeile
🗂 Alle Verzeichnisse automatisch Inhalts-, Abbildungs-, Tabellen-, Formel-, Symbol- und Abkürzungsverzeichnis (nur tatsächlich verwendete Abkürzungen)
🤖 KI-Deklaration (Leitfaden 1.6/2.9) #ki-nachweis(...) für lokale Nachweise + fertiges KI-Hilfsmittelverzeichnis
🔗 Zotero & Mendeley BibTeX-Export in literatur/literatur.bib – mit Better BibTeX vollautomatisch; eigene CSL-Stile im exakten FOM-Format
🛠 Cross-Platform-Builds Makefile, Bash-/PowerShell-Skripte, Docker, Dev-Container, GitHub Actions (legt das fertige thesis.pdf bei jedem Push direkt im Repository ab)
📖 Moderne Dokumentation fom-typst.levin-dev.de – Schritt-für-Schritt-Anleitungen für Windows, macOS und Linux (Quellcode in docs-app/ auf main)

🚀 Schnellstart

# 1. Typst installieren
brew install typst                     # macOS
winget install --id Typst.Typst        # Windows
# Linux: https://github.com/typst/typst/releases

# 2. Template holen (oder auf GitHub: "Use this template")
#    Der Standard-Branch ist `minimal`: ein leeres Grundgerüst zum Losschreiben.
git clone https://github.com/LevinTheDoctor/fom-typst-template.git meine-thesis
cd meine-thesis
# Lieber mit Beispielkapiteln starten? git clone -b template …

# 3. Kompilieren
make build          # oder: typst compile --font-path fonts main.typ thesis.pdf
make watch          # Live-Vorschau beim Schreiben

Danach in main.typ Titel, Name, Studiengang und Zitierweise eintragen und in content/ losschreiben. Die vollständige Anleitung liefert die Dokumentations-Webseite: fom-typst.levin-dev.de (Quellcode auf dem Branch main).

📁 Projektstruktur

├── main.typ                  # Einstiegspunkt: alle Angaben zur Arbeit
├── content/                  # deine Kapitel (eine Datei pro Kapitel)
├── literatur/literatur.bib   # Literatur aus Zotero/Mendeley
├── abbildungen/              # eigene Bilder
├── template/
│   ├── fom.typ               # Haupt-Template (fom-arbeit)
│   ├── styles.typ            # zentrale Layout-Konstanten
│   ├── komponenten/          # Titelblatt, Verzeichnisse, Zitieren, KI, …
│   └── csl/                  # FOM-Zitierstile (Chicago & Harvard)
├── fonts/                    # Liberation Serif (Fallback, SIL OFL)
├── scripts/                  # build.sh / build.ps1
└── Makefile · Dockerfile · .devcontainer/ · .github/workflows/

🌿 Branches

Branch Zweck
minimal Leeres Grundgerüst ohne Beispieltexte und Doku-Webseite – Standard-Branch, direkt losschreiben
template Basis-Template mit kompakten Beispielkapiteln, die jede Funktion einmal zeigen – ohne Doku-Webseite
example-thesis Vollständig ausgefüllte Musterarbeit zum Nachschlagen
main Wie template, zusätzlich mit dem Quellcode der Doku-Webseite (docs-app/) – hier findet die Entwicklung statt
git clone https://github.com/LevinTheDoctor/fom-typst-template.git meine-arbeit   # liefert minimal
# oder in einem bestehenden Klon: git switch template (bzw. example-thesis, main)

🧪 Qualitätssicherung

  • make check kompiliert streng: Warnungen gelten als Fehler.
  • Die GitHub Action pdf-bauen.yml baut bei jedem Push, committet das fertige thesis.pdf direkt in den Branch und hängt es zusätzlich als Artefakt an – ideal, um Zwischenstände mit der Betreuung zu teilen.
  • Bekannte (unkritische) Abweichungen vom Leitfaden sind transparent in der Doku-Webseite unter „FAQ & bekannte Abweichungen“ dokumentiert.

🤝 Mitwirken

Fehler gefunden, Leitfaden-Update entdeckt oder eine Verbesserungsidee? Issues und Pull Requests sind ausdrücklich willkommen – siehe CONTRIBUTING.md.

📄 Lizenz

MIT – frei verwendbar für Studium, Lehre und eigene Vorlagen. Die Schriften im Ordner fonts/ stehen unter der SIL Open Font License. Das FOM-Logo (abbildungen/fom-logo.svg) ist markenrechtlich geschützt, nicht Teil der MIT-Lizenz und nur für Arbeiten an der FOM bestimmt.

About

Typst-Template für wissenschaftliche Arbeiten nach dem FOM-Leitfaden (Januar 2024) – Chicago/Harvard-Zitierstile, KI-Hilfsmittelverzeichnis, Zotero/Mendeley-Anbindung, CI

Resources

License

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors