From 49eda03c74123baee283a4539cb01318e74938b2 Mon Sep 17 00:00:00 2001 From: orangerot Date: Sun, 31 Aug 2025 01:11:19 +0200 Subject: [PATCH] style: uniform naming convention with directories, files and variables --- README.md | 52 +++-------- muendliche-nachpruefung/README.md | 91 +++++++++++++++++++ .../bachelor.typ | 0 .../fsmi-logo.svg | 0 lib.typ => muendliche-nachpruefung/lib.typ | 2 +- .../muendliche-nachpruefung.typ | 4 +- .../README.md | 10 +- .../fsmi-logo.svg | 0 .../lib.typ | 2 +- .../muendliche-pruefung.typ | 4 +- 10 files changed, 116 insertions(+), 49 deletions(-) create mode 100644 muendliche-nachpruefung/README.md rename bachelor.typ => muendliche-nachpruefung/bachelor.typ (100%) rename fsmi-logo.svg => muendliche-nachpruefung/fsmi-logo.svg (100%) rename lib.typ => muendliche-nachpruefung/lib.typ (99%) rename nachprufung.typ => muendliche-nachpruefung/muendliche-nachpruefung.typ (95%) rename {mundl-prufung => muendliche-pruefung}/README.md (94%) rename {mundl-prufung => muendliche-pruefung}/fsmi-logo.svg (100%) rename {mundl-prufung => muendliche-pruefung}/lib.typ (99%) rename mundl-prufung/prufung.typ => muendliche-pruefung/muendliche-pruefung.typ (96%) diff --git a/README.md b/README.md index 98c27d0..a464a5b 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,20 @@ -# Vorlage mündliche 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 inspiriert 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. diff --git a/muendliche-nachpruefung/README.md b/muendliche-nachpruefung/README.md new file mode 100644 index 0000000..a56cbcb --- /dev/null +++ b/muendliche-nachpruefung/README.md @@ -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. + diff --git a/bachelor.typ b/muendliche-nachpruefung/bachelor.typ similarity index 100% rename from bachelor.typ rename to muendliche-nachpruefung/bachelor.typ diff --git a/fsmi-logo.svg b/muendliche-nachpruefung/fsmi-logo.svg similarity index 100% rename from fsmi-logo.svg rename to muendliche-nachpruefung/fsmi-logo.svg diff --git a/lib.typ b/muendliche-nachpruefung/lib.typ similarity index 99% rename from lib.typ rename to muendliche-nachpruefung/lib.typ index fd2220a..cf3e8fc 100644 --- a/lib.typ +++ b/muendliche-nachpruefung/lib.typ @@ -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) diff --git a/nachprufung.typ b/muendliche-nachpruefung/muendliche-nachpruefung.typ similarity index 95% rename from nachprufung.typ rename to muendliche-nachpruefung/muendliche-nachpruefung.typ index 9691e46..888e89a 100644 --- a/nachprufung.typ +++ b/muendliche-nachpruefung/muendliche-nachpruefung.typ @@ -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) diff --git a/mundl-prufung/README.md b/muendliche-pruefung/README.md similarity index 94% rename from mundl-prufung/README.md rename to muendliche-pruefung/README.md index bc8fd83..6fb0f55 100644 --- a/mundl-prufung/README.md +++ b/muendliche-pruefung/README.md @@ -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 diff --git a/mundl-prufung/fsmi-logo.svg b/muendliche-pruefung/fsmi-logo.svg similarity index 100% rename from mundl-prufung/fsmi-logo.svg rename to muendliche-pruefung/fsmi-logo.svg diff --git a/mundl-prufung/lib.typ b/muendliche-pruefung/lib.typ similarity index 99% rename from mundl-prufung/lib.typ rename to muendliche-pruefung/lib.typ index 7349c76..b95d165 100644 --- a/mundl-prufung/lib.typ +++ b/muendliche-pruefung/lib.typ @@ -5,7 +5,7 @@ "none": "" ) -#let prufung( +#let oral-exam( study: "", // Studiengang lecture: "", // Fach kind: kind.none, // Prüfungsart (Wahlpflicht, Vertiefungsfach, Ergänzungsfach) diff --git a/mundl-prufung/prufung.typ b/muendliche-pruefung/muendliche-pruefung.typ similarity index 96% rename from mundl-prufung/prufung.typ rename to muendliche-pruefung/muendliche-pruefung.typ index a661177..ef2ea4d 100644 --- a/mundl-prufung/prufung.typ +++ b/muendliche-pruefung/muendliche-pruefung.typ @@ -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)