Initialer Commit

doc/lerngruppe.md

@@ -0,0 +1,46 @@
+# Konfiguration der Ausgabe (für jede Lerngruppe)
+
+In der Datei ``input.ini`` im Eingabeverzeichnis wird für neben einigen allgemeinen Festlegungen für jede Lerngruppe die gewünschte Ausgabe konfiguriert. Dabei wird die ID aus dem Dateinamen als Bereichsmarkierung (vgl. ``klasse-5a`` im Beispiel) benötigt.
+
+```python
+[klasse-5a]
+
+# Bezeichnung der Lerngruppe
+bezeichnung = Mathe 5a
+
+# Kurzbezeichnung der Lerngruppe
+kurzbezeichnung = Mathe 5a
+
+# Anzahl Arbeiten oder Klausuren: 0, 1, 2, ... (0=keine Arbeiten/Klausuren)
+schriftlich_anzahl = 3
+
+# Bezeichnung Arbeit oder Klausur o.ä.
+schriftlich_bez = Arbeit
+
+# Anzahl der Quartale bei der SoMi-Erfassung: 1 (gemeinsames) oder 2 (getrennte)
+somi_quartale = 2
+
+# Anzahl der Zeilen pro Schüler in einem SoMi-Bogen: 1, 2, ...
+somi_zeilen = 2
+
+# Spalte für Halbjahresnote im 2. Hj. in Übersicht einblenden: ja, nein
+halbjahresnote = ja
+
+# Anzahl der Zeilen pro Schüler in einem HA-Bogen: 0, 1, 2, ... (0=kein HA-Bogen)
+ha_zeilen = 1
+
+# Anzahl der Seiten mit Checkliste: 1, 2, ...
+checkliste_seiten = 2
+```
+
+Die Parameter sind zwar selbsterklärend, werden hier aber dennoch einmal kurz erläutert:
+
+- Die Bezeichnung der Lerngruppe wird als Überschrift überall dort verwendet, wo genügend Platz zur Verfügung steht.
+- Ist nur wenig Platz vorhanden (z.B. im Stundenplan oder in der Navigationsleiste), kommt die Kurzbeschreibung der Lerngruppe zum Einsatz.
+- Die Anzahl der schriftlichen Lernerfolgskontrollen gibt an, wie viele Korrekturbögen erzeugt werden. Die Anzahl 0 sorgt dafür, dass diese automatisch weggelassen werden.
+- Die Bezeichnung der Lernerfolgskontrolle passt sich dem Sprachgebrauch an, z.B. Arbeit oder Kursarbeit oder Klausur.
+- Bei der Erfassung von Notizen zur Sonstigen Mitarbeit (SoMi) wird angegeben, ob eine durchlaufende Liste für beide Quartale oder zwei getrennte Listen für die beiden Quartale generiert werden sollen.
+- Zudem können eine oder mehrere Zeilen pro SchülerIn erzeugt werden.
+- In der Notenübersicht des zweiten Halbjahres kann optional eine Spalte für die Note des ersten Halbjahres angelegt werden.
+- Bei der Erfassung von Hausaufgaben bzw. deren Nichterledigung können eine oder mehrere Zeilen pro SchülerIn angelegt werden. Die Anzahl 0 sorgt dafür, dass Hausaufgabenlisten ganz weggelassen werden.
+- Abschließend kann die Anzahl der Checklisten für diese Lerngruppe festgelegt werden. Hier empfiehlt es sich lieber zu viele Listen zu konfigurieren, da das Einfügen zusätzlicher Seiten die Verweise (Links) im PDF Zieldokument unbrauchbar macht.