From 7af59c1c6146e88163d096bafd026a0026aeb75d Mon Sep 17 00:00:00 2001 From: lezius Date: Fri, 20 Feb 2026 08:28:40 +0100 Subject: [PATCH] =?UTF-8?q?Dokumentation=20=C3=BCberarbeitet?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/dateien.md | 11 ++++++----- doc/konfiguration.md | 12 +++++++----- doc/verarbeitung.md | 2 +- 3 files changed, 14 insertions(+), 11 deletions(-) diff --git a/doc/dateien.md b/doc/dateien.md index cf7477b..32507de 100644 --- a/doc/dateien.md +++ b/doc/dateien.md @@ -17,20 +17,21 @@ Wählen Sie nun zumindest das aktuelle Schuljahr aus. Wählen Sie weitere ein bi - in diesem Abschlussjahrgang ein/e SchülerIn ein Schuljahr wiederholt hat (=> insgesamt drei Schuljahre exportieren). -Starten Sie den Export. Die dabei erzeugten Dateien 'SchuelerLeistungsdaten.dat' und 'SchuelerLernabschnittsdaten.dat' werden später benötigt. +Starten Sie den Export. Die dabei erzeugten Dateien `SchuelerLeistungsdaten.dat` und `SchuelerLernabschnittsdaten.dat` werden später benötigt. ## 2. Epochenunterricht (epoche.csv) Beim oben beschriebenen Schild Export werden leider diejenigen Fächer eines Schülers nicht gekennzeichnet, die nur im ersten Halbjahr unterrichtet und deren Note automatisch ins zweite Halbjahr übertragen wird (so genannter Epochenuterricht). -Um die Fächer dennoch auf den Konferenzfolien sinnvollerweise als Epochenunterricht zu kennzeichnen, können sie in einer Datei 'epoche.csv' aufgelistet werden. Die Bereitstellung dieser Datei ist optional. +Um die Fächer dennoch auf den Konferenzfolien sinnvollerweise als Epochenunterricht zu kennzeichnen, können sie in einer Datei `epoche.csv` aufgelistet werden. Die Bereitstellung dieser Datei ist optional. Hier eine selbsterklärende Beispieldatei in den Beispieldaten (vgl. Datei [epoche.csv](../beispielinput/epoche.csv)): -''' +``` Klasse|Fächer 09A|GE -''' +``` + +Listen Sie hier zeilenweise alle Klassen und die zugehörige Fachbezeichnung mit Epochenunterricht auf. Hat eine Klasse mehrere Fächer in Epochenunterricht, so listen Sie alle Fächer in einer Zeile durch Komma getrennt auf (Beispiel: `09A|GE,EK,BI`). -Listen Sie hier zeilenweise alle Klassen und die zugehörige Fachbezeichnung mit Epochenunterricht auf. Hat eine Klasse mehrere Fächer in Epochenunterricht, so listen Sie alle Fächer in einer Zeile durch Komma getrennt auf (Beispiel: '09A|GE,EK,BI'). diff --git a/doc/konfiguration.md b/doc/konfiguration.md index da5a6f6..015efde 100644 --- a/doc/konfiguration.md +++ b/doc/konfiguration.md @@ -1,10 +1,10 @@ # Konfiguration der Verarbeitung (config.ini) -Für die Verarbeitung stehen Ihnen einige Parameter zur Verfügung, die in der Datei 'config.ini' festgelegt werden. +Für die Verarbeitung stehen Ihnen einige Parameter zur Verfügung, die in der Datei `config.ini` festgelegt werden. Sie finden hier ein selbsterklärendes Beispiel (vgl. Datei [config.ini](../beispielinput/config.ini) aus den Beispieldaten): -''' +``` [Allgemein] schuljahr = 2025 halbjahr = 2 @@ -15,12 +15,14 @@ jahrgang_einführung = EF jahrgang_abitur = Q2 als_eine_Klasse = EF ignoriere_Jahrgänge = -''' +``` Im allgemeinen oberen Teil werden Schuljahr (z.B. 2025 für 2025/2026) und Halbjahr (1 oder 2) eingestellt. Im unteren Teil werden a) die Jahrgänge bezeichnet, die zur Oberstufe gehören, b) die die Einführungsphase und c) das letzte Jahr der Qualifikationsphase bilden. Haben Sie keine Oberstufe, können Sie die Angaben einfach so belassen. (Bitte nicht löschen, das führt zu Fehlermeldungen!). -Haben Sie einen Jahrgang (oftmals EF), in der zwar Klassen gebildet werden (EFa, EFb usw.), auf der Konferenz aber der Jahrgang nicht klassenweise sondern als Jahrgang gezeigt werden soll, können Sie dies bei 'als_eine_Klasse' festlegen. -Sollen Jahrgänge ignoriert werden, listen Sie diese durch Komma getrennt unter 'ignoriere_Jahrgänge' auf. +Haben Sie einen Jahrgang (oftmals EF), in der zwar Klassen gebildet werden (EFa, EFb usw.), auf der Konferenz aber der Jahrgang nicht klassenweise sondern als Jahrgang gezeigt werden soll, können Sie dies bei `als_eine_Klasse` festlegen. + +Sollen Jahrgänge ignoriert werden, listen Sie diese durch Komma getrennt unter `ignoriere_Jahrgänge` auf. + diff --git a/doc/verarbeitung.md b/doc/verarbeitung.md index 1fa3ded..ab668f4 100644 --- a/doc/verarbeitung.md +++ b/doc/verarbeitung.md @@ -41,5 +41,5 @@ Erzeuge PDF-Notenübersichten für die SI... Fertig! ``` -Die Ausgabedateien werden in den Ordnern 'output/html/' und '/output/pdf/' erzeugt bzw. aktualisiert. +Die Ausgabedateien werden in den Ordnern `output/html/` und `/output/pdf/` erzeugt bzw. aktualisiert.