style: uniform naming convention with directories, files and variables

1 files changed, 91 insertions, 0 deletions

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.
+