doc: update usage in READMEs with new file names and arguments

This commit is contained in:
orangerot 2025-09-09 11:32:49 +02:00
parent d9a420ed31
commit c6e566775d
4 changed files with 118 additions and 9 deletions

View file

@ -10,6 +10,7 @@ und inspiriert von den
In den Unterordern finden sich jeweils die Vorlagen für
- **Mündliche Prüfungen Mathematik** `muendliche-pruefung-mathematik/`
- **Vorlagen mündliche Nachprüfung (3. Versuch)** `muendliche-nachpruefung/`
- **Vorlagen mündliche Prüfung (Bachelor, Master, Diplom)** `muendliche-pruefung/`

View file

@ -15,7 +15,7 @@ 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.
`main.typ` ausgefüllt werden.
```typst
#import "lib.typ": oral-post-exam
@ -61,13 +61,13 @@ Erstellen mit Template. Dafür müssen lediglich die Argumente in der Datei
Um den Fragebogen schlussendlich zu bauen
führt man folgenden Befehl aus:
```sh
typst compile muendliche-nachpruefung.typ
typst compile main.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.
Datei `muendliche-nachpruefung.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:

View file

@ -0,0 +1,103 @@
# Mündliche Prüfungen Mathematik
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.
Zum Erstellen des Dokumentes müssen lediglich die Argumente in der Datei
`main.typ` ausgefüllt werden.
```typst
#import "lib.typ": oral-exam, KIND
#show: oral-exam.with(
study: "", // Studiengang
lecture: "", // Fach
kind: KIND.NONE, // Prüfungsart KIND.{DIPLOM, STAATSEXAM, STUDIENBEGLEITEND, BACHELOR, MASTER}
date: datetime(year: 0, month: 1, day: 1), // Prüfungsdatum
examiner: "", // PrüferIn (Prof)
grade_received: 0.0, // Note
grade_reasonable: "", // War die Note angemessen?
exam_duration: duration(minutes: 0), // Prüfungsdauer
checked_knowledge_gaps: none, // Wurde Unwissen abgeprüft?
attendance: (
// Titel der Vorlesung, Dozent, Wann gehört, SWS, ECTS, LP
(lecture: "", lecturer: "", year: "", sws: "", ects: "", lp: ""),
(lecture: "", lecturer: "", year: "", sws: "", ects: "", lp: ""),
(lecture: "", lecturer: "", year: "", sws: "", ects: "", lp: ""),
(lecture: "", lecturer: "", year: "", sws: "", ects: "", lp: ""),
(lecture: "", lecturer: "", year: "", sws: "", ects: "", lp: ""),
),
attendance_worth: [
// Wie regelmäßig hast du die Lehrveranstaltungen besucht? Hat sich der
// Besuch/Nichtbesuch in der Prüfung positiv/negativ ausgewirkt?
],
literature: [
// Welche Literatur hast du benutzt (Bücher, Skripten, Vorlesungsmitschriften)?
],
preparation_time: [
// Hast du dich alleine/zu mehreren auf die Prüfung vorbereitet? Wie lange?
// Hat es etwas gebracht?
],
agreements: [
// Fanden vor der Prüfung Absprachen statt (Form, Inhalt, ...)?
// Wenn ja, welche? Wurden sie eingehalten?
],
preparations: [
// Welche Tipps zur Vorbereitung kannst du geben?
// (wichtige/unwichtige Teile des Stoffs, gute Literatur, Lernstil)
],
examiner_behavior: [
// Was kannst du zum Prüfungsstil des/der Prüfenden sagen?
// (Prüfungsatmosphäre, (un)klare Fragestellungen, Fragen nach Einzelheiten
// oder eher gröÿere Zusammenhänge, gezielte Zwischenfragen oder lässt
// er/sie dich erzählen, Weiterhelfen bei Unsicherheiten ...)
],
examiner_recommendation: (none, [
// Kannst du die Prüfenden weiterempfehlen?
]),
examinee_behavior: [
// Welche Ratschläge für das Verhalten in der Prüfung kannst du geben?
],
)
// 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 main.typ
```
Für Personen, welche in die Struktur des Dokuments eintauchen wollen gibt es die
Datei `muendliche-pruefung.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-pruefung.typ
```
## Hintergrund
Diese Vorlage ist stark Inspiriert von der [Protokollvorlage mündliche Prüfung
(TeX)](https://legacy.fsmi.org/Pruefungen/Vorlagen/Info/muendlich-neu.tar.gz)
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

@ -13,15 +13,15 @@ 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
`muendliche-pruefung.typ` ausgefüllt werden.
`main.typ` ausgefüllt werden.
```typst
#import "lib.typ": oral-exam, kind
#import "lib.typ": oral-exam, KIND
#show: oral-exam.with(
study: "", // Studiengang
lecture: "", // Fach
kind: kind.none, // Prüfungsart (Wahlpflicht, Vertiefungsfach, Ergänzungsfach)
kind: KIND.NONE, // Prüfungsart KIND.{WAHLPFLICHT, VERTIEFUNGSFACH, ERGUENZUNGSFACH}
date: datetime(year: 0, month: 1, day: 1), // Prüfungsdatum
examiner: "", // PrüferIn (Prof)
assistant: "", // BeisitzerIn
@ -64,9 +64,14 @@ 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 muendliche-pruefung.typ
typst compile main.typ
```
Für Personen, welche in die Struktur des Dokuments eintauchen wollen gibt es die
Datei `muendliche-pruefung.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