style: uniform naming convention with directories, files and variables

This commit is contained in:
orangerot 2025-08-31 01:11:19 +02:00
parent 2c501fd627
commit 0a69a77874
10 changed files with 116 additions and 49 deletions

View file

@ -1,44 +1,20 @@
# Vorlagendliche Nachprüfung (3. Versuch) in Typst
# Protokoll-Vorlagen in Typst
Dieser Fragebogen gibt den KommilitonInnen, die nach Dir die Prüfung ablegen
wollen, einen Einblick in Ablauf und Inhalt der Prüfung. Das erleichtert die
Vorbereitung.
Hier finden sich Vorlagen für Prüfungsprotokolle am KIT für die Fachschaft
Mathematik/Informatik, neu erstellt in dem modernen Textsatzsystm
[Typst](https://typst.app/)
und inspirirt von den
[Vorlagen in LaTeX](https://www.fsmi.org/studium/pruefungen/muendliche-pruefungen/#protokoll-vorlagen).
Für Informationen zu dem Textsatzsystem Typst am besten in die [Dokumentation](https://typst.app/docs/)
schauen.
## Struktur
In den Unterordern finden sich jeweils die Vorlagen für
- **Vorlagen mündliche Nachprüfung (3. Versuch)** `muendliche-nachpruefung/`
- **Vorlagen mündliche Prüfung (Bachelor, Master, Diplom)** `muendliche-pruefung/`
## Nutzung
Es ist der Typst-Compiler nötig. Dieser ist für eine vielzahl an Betriebssystemen
verfügbar.
Die Vorlage enthält zwei Optionen den Fragebogen zu erstellen. Empfohlen ist das
Erstellen mit Template. Dafür müssen lediglich die Argumente in der Datei
`nachprufung.typ` ausgefüllt werden. Um den Fragebogen schlussendlich zu bauen
führt man folgenden Befehl aus:
```sh
typst compile nachprufung.typ
```
Für Personen, welche in die Struktur des Dokuments eintauchen wollen gibt es die
Datei `bachelor.typ`. Diese ist der Inspiration in TeX vom Aufbau ähnlich. Das
befüllen des Fragebogens ist hier etwas schwerer, weil erst die richtige Stelle
im Code gefunden werden muss.
Um die Änderungen direkt beim Speichern zu sehen, kann man folgenden Befehl
nutzen:
```sh
typst watch nachprufung.typ
```
## Hintergrund
Diese Vorlage ist stark Inspiriert von der [Protokollvorlage Nachprüfung
(TeX)](https://legacy.fsmi.org/Pruefungen/Vorlagen/Info/bachelor.tgz) von der
Liste an [Protokollvorlagen](https://www.fsmi.org/studium/pruefungen/muendliche-pruefungen/) der Fachschaft Mathematik/Informatik des KIT.
Bei der Erstellung der Vorlage wurde darauf geachtet, dass die PDF-Ausgabe von
Typst möglichst ähnlich zu der PDF-Ausgabe der Inspiration in TeX ist. Dabei
werden diverse Layoutelemente von Typst verwendet, welche das Layout mit Tabellen in
TeX ersetzen.
Wie die Vorlagen verwendet werden, wird in der `README.md` in den jeweiligen
Unterordern erläutert.

View file

@ -0,0 +1,91 @@
# Vorlage mündliche Nachprüfung (3. Versuch) in Typst
Dieser Fragebogen gibt den KommilitonInnen, die nach Dir die Prüfung ablegen
wollen, einen Einblick in Ablauf und Inhalt der Prüfung. Das erleichtert die
Vorbereitung.
Für Informationen zu dem Textsatzsystem Typst am besten in die
[Dokumentation](https://typst.app/docs/)
schauen.
## Nutzung
Es ist der Typst-Compiler nötig. Dieser ist für eine vielzahl an Betriebssystemen
verfügbar.
Die Vorlage enthält zwei Optionen den Fragebogen zu erstellen. Empfohlen ist das
Erstellen mit Template. Dafür müssen lediglich die Argumente in der Datei
`muendliche-nachpruefung.typ` ausgefüllt werden.
```typst
#import "lib.typ": oral-post-exam
#show: oral-post-exam.with(
lecture: "", // Fach
date: datetime(year: 0, month: 1, day: 1), // Prüfungsdatum
examiner: "", // PrüferIn (Prof)
assistant: "", // BeisitzerIn
did_pass: none, // Bestanden? true || false
exam_duration: duration(minutes: 0), // Prüfungsdauer
attendance: (:
/* Veranstaltung, Jahr, regelmäßig besucht? */
"Vorlesung": (year: "", did_attend: ""),
"Übung": (year: "", did_attend: ""),
"Tutorium": (year: "", did_attend: ""),
),
preparation_time: [
// Wie lange und wie hast alleine bzw. mit anderen vorbereitet?
// Hier ist Platz für deinen Kommentar
],
agreements: [
// Fanden vor der Prüfung Absprachen zu Form oder Inhalt statt? Wurden sie eingehalten?
// Hier ist Platz für deinen Kommentar
],
preparations: [
// Welche Tips zur Vorbereitung kannst Du geben?
// Hier ist Platz für deinen Kommentar
],
examiner_behavior: [
// Wie war der Prüfungsstil des Prüfers / der Prüferin?
// Hier ist Platz für deinen Kommentar
],
examinee_behavior: [
// Kannst Du Ratschläge Verhalten in der Prüfung geben?
// Hier ist Platz für deinen Kommentar
],
)
// Schreibe bitte möglichst viele Fragen und Antworten auf.
// Hier ist Platz für deinen Kommentar
```
Um den Fragebogen schlussendlich zu bauen
führt man folgenden Befehl aus:
```sh
typst compile muendliche-nachpruefung.typ
```
Für Personen, welche in die Struktur des Dokuments eintauchen wollen gibt es die
Datei `bachelor.typ`. Diese ist der Inspiration in TeX vom Aufbau ähnlich. Das
befüllen des Fragebogens ist hier etwas schwerer, weil erst die richtige Stelle
im Code gefunden werden muss.
Um die Änderungen direkt beim Speichern zu sehen, kann man folgenden Befehl
nutzen:
```sh
typst watch muendliche-nachpruefung.typ
```
## Hintergrund
Diese Vorlage ist stark Inspiriert von der
[Protokollvorlage Nachprüfung (TeX)](https://legacy.fsmi.org/Pruefungen/Vorlagen/Info/bachelor.tgz)
von der
Liste an
[Protokollvorlagen](https://www.fsmi.org/studium/pruefungen/muendliche-pruefungen/#protokoll-vorlagen)
der Fachschaft Mathematik/Informatik des KIT.
Bei der Erstellung der Vorlage wurde darauf geachtet, dass die PDF-Ausgabe von
Typst möglichst ähnlich zu der PDF-Ausgabe der Inspiration in TeX ist. Dabei
werden diverse Layoutelemente von Typst verwendet, welche das Layout mit Tabellen in
TeX ersetzen.

View file

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 45 KiB

View file

@ -1,4 +1,4 @@
#let nachprufung(
#let oral-post-exam(
lecture: "", // Fach
date: datetime(year: 0, month: 1, day: 1), // Prüfungsdatum
examiner: "", // PrüferIn (Prof)

View file

@ -1,6 +1,6 @@
#import "lib.typ": nachprufung
#import "lib.typ": oral-post-exam
#show: nachprufung.with(
#show: oral-post-exam.with(
lecture: "", // Fach
date: datetime(year: 0, month: 1, day: 1), // Prüfungsdatum
examiner: "", // PrüferIn (Prof)

View file

@ -13,12 +13,12 @@ Es ist der Typst-Compiler nötig. Dieser ist für eine vielzahl an Betriebssyste
verfügbar.
Zum Erstellen des Dokumentes müssen lediglich die Argumente in der Datei
`nachprufung.typ` ausgefüllt werden.
`muendliche-pruefung.typ` ausgefüllt werden.
```typst
#import "lib.typ": prufung, kind
#import "lib.typ": oral-exam, kind
#show: prufung.with(
#show: oral-exam.with(
study: "", // Studiengang
lecture: "", // Fach
kind: kind.none, // Prüfungsart (Wahlpflicht, Vertiefungsfach, Ergänzungsfach)
@ -64,13 +64,13 @@ Zum Erstellen des Dokumentes müssen lediglich die Argumente in der Datei
Um den Fragebogen schlussendlich zu bauen führt man folgenden Befehl aus:
```sh
typst compile prufung.typ
typst compile muendliche-pruefung.typ
```
Um die Änderungen direkt beim Speichern zu sehen, kann man folgenden Befehl
nutzen:
```sh
typst watch prufung.typ
typst watch muendliche-pruefung.typ
```
## Hintergrund

View file

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 45 KiB

View file

@ -5,7 +5,7 @@
"none": ""
)
#let prufung(
#let oral-exam(
study: "", // Studiengang
lecture: "", // Fach
kind: kind.none, // Prüfungsart (Wahlpflicht, Vertiefungsfach, Ergänzungsfach)

View file

@ -1,6 +1,6 @@
#import "lib.typ": prufung, kind
#import "lib.typ": oral-exam, kind
#show: prufung.with(
#show: oral-exam.with(
study: "", // Studiengang
lecture: "", // Fach
kind: kind.none, // Prüfungsart (Wahlpflicht, Vertiefungsfach, Ergänzungsfach)