HI Report

Dieses Repository beinhaltet die Typst-Vorlage für die Dokumentation der Benutzerstudie des Moduls Haptische Benutzerschnittstellen.

Überblick

Dieses Repository enthält die folgenden Verzeichnisse:

/fonts

Enthält alle notwendigen Fonts des Dokuments:

• Adobe Source Sans
• Adobe Source Serif

/src

Enthält die Dateien zum Erzeugen des Reports:

• help.typ ist der Quellcode des Hinweis-Dokuments
• main.typ ist die Hauptdatei. Diese enthält Blindtexte, welche sie mit ihren Inhalten überschreiben sollen
• references.bib kann durch ihre BibTeX-Einträge ergänzt werden
• thm-documentation.typ ist das Typst-Template, welches normalerweise nicht von ihnen angepasst werden muss

/out

Enthält die erzeugten PDFs. Dieser Ordner ist Teil des Repositories, um ihnen die Hinweise (help.pdf) und einen Beispielreport (main.pdf) in PDF-Form anzuzeigen.

Nutzung

Sie haben drei Möglichkeiten diese Vorlage zu verwenden:

1. Installieren Sie VSCodium (oder VSCode) und die Extension Tinymist Typst. Diese beinhaltet das Syntax-Highlighting, einen Vorschau-Modus und kann PDFs generieren.
2. Just-Podman-Toolchain: Generieren Sie die PDF per Kommandozeile. Sofern Sie just und Podman installiert haben, können Sie mit just build die PDF im out/-Verzeichnis generieren.
3. Nutzen Sie den Online-Editor auf Typst.app. Dieser Weg ist ungetestet, erlaubt aber eine einfache Kollaboration.