Files
LehrerPDF/doc/allgemein.md

38 lines
2.0 KiB
Markdown

# Konfiguration der Ausgabe (allgemeiner Teil)
Neben der Festlegungen für jede Lerngruppe sind einige allgemeine Festlegungen zu treffen, die am einfachsten zu Beginn der Datei ``input.ini`` beschrieben werden (vgl. Markierung ``Allgemein`` im Beispiel):
```
[Allgemein]
# Bezeichnung des Schuljahrs (Startjahr angeben - Beispiel: 2025 für 2025/26)
schuljahr = 2025
# Halbjahr: 1, 2
halbjahr = 1
# Kalenderwochen des Halbjahres für die Übersichtsseite
kw_start = 35
kw_ende = 6
kw_ferien = 42,43,52,1
# Startseite: Binde den Stundenplan aus der angegebenen Datei ein (leer: kein Stundenplan)
stundenplandatei = stundenplan.md
# Trenner der Spalten in den CSV-Eingabedateien
csvtrenner = ;
# Ausgabegerät: rm2, paperpro, a4
device = rm2
```
Die Parameter sind zwar selbsterklärend, werden hier aber dennoch einmal kurz erläutert:
- Als Schuljahr ist das Jahr einzutragen, in dem das Schuljahr beginnt.
- Für das Halbjahr ist eine 1 oder 2 einzutragen.
- Für die Übersichtsseite des Habjahrs sind die Kalenderwoche des Beginns und die Kalenderwoche des Endes anzugeben. (Es liegt in der Natur der Sache, dass die beiden Zahlen nicht aufsteigend sein müssen, wenn ein Halbjahr zwei Kalenderjahre umfasst. Das Skript berücksichtigt dies automatisch.)
- Auf Wunsch können die Ferienwochen aus der Übersicht entfernt werden. Die entsprechenden Kalenderwochen müssen hier (nur mit Komma und ohne Leerzeichen getrennt) angegeben werden.
- Soll die Startseite des Zieldokuments einen Stundenplan enthalten, so ist dieser im Eingabeverzeichnis als Markdown Dokument anzugeben (vgl. auch nächster Abschnitt). Der Dateiname wird hier festgelegt. Fehlt der Dateiname, so wird der Stundenplan automatisch weggelassen.
- Für die CSV Dateien kann hier das Symbol zum Trennen der Spalte (voreingestellt Semikolon) bei Bedarf angepasst werden.
- Zum Schluss kommt die wichtigste Festlegung, das Zielgerät. Hier kann aktuell zwischen ``rm2`` (reMarkable 2), ``paperpro`` (reMarkable Paper Pro) und ``a4`` (DIN A4) gewählt werden.