Files
Schild2Halbjahr/doc/verarbeitung.md

78 lines
3.1 KiB
Markdown

# Anstoßen der Verarbeitung
## a) Zusammenstellen des Eingabeverzeichnisses 'input/'
Das Pythonskript sucht im Ordner `schild2halbjahr/` nach einem Verzeichnis `input/`. Ist dies nicht vorhanden, wird das Verzeichnis `beispielinput/` für die Verarbeitung verwendet.
Legen Sie also - sofern noch nicht vorhanden - das Unterverzeichnis `input/` an und fügen Sie dort die beiden bereits exportierten Dateien `SchuelerLeistungsdaten.dat` und `SchuelerLernabschnittsdaten.dat` ein bzw. erstellen Sie dort die beiden Dateien `epoche.csv` (optional) und `config.ini`. Kopieren Sie bei Bedarf diese beiden Dateien aus dem Beispiel-Verzeichnis `beispielinput/` und passen Sie diese entsprechend an.
## b) Voraussetzungen
Um das Skript zu starten sind einige Voraussetzungen zu erfüllen:
1. Auf dem eingesetzten Rechner muss [Python](https://www.python.org) auf der Kommandozeile installiert sein. (Das vorliegende Skript wurde unter Python 3.13 entwickelt und getestet. Es sollte aber auch mit älteren Python Versionen lauffähig sein.) Da Python plattformunabhängig ist, ist auch das vorliegende Projekt plattformunabhängig.
2. Das Python-Modul `xhtml2pdf` muss installiert sein.
```python
pip3 install xhtml2pdf
```
## c) Starten des Skripts
Nun kann das Skript auf der Kommandozeile gestartet werden. Dazu muss es aus dem Skriptverzeichnis heraus gestartet werden.
```
python3 konferenz.py
```
Auf der Konsole werden die Verarbeitungsschritte dokumentiert und auch evtl. Fehler bei der Verarbeitung angezeigt:
```
Eingabeverzeichnis input/ existiert nicht, verarbeite beispielinput/ ...
Lese die Daten ein...
Erzeuge HTML-Folien...
Erzeuge PDF-Ausdruck in Farbe...
Erzeuge PDF-Ausdruck in SW...
Erzeuge PDF-Notenübersichten für die SI...
Fertig!
```
Die Ausgabedateien werden in den Ordnern `output/html/` und `/output/pdf/` erzeugt bzw. aktualisiert.
## d) Anpassung des HTML-Folienlayouts
Wenn Sie über einige Basiskenntnisse zu Cascading Stylesheets (CSS) verfügen, können Sie das Layout und die Einfärbung der HTML-Folien und PDF-Ausdrucke nach eigenen Wünschen anpassen.
### HTML-Folien
Hier wird das Framework [reveal.js](https://revealjs.com) eingesetzt, das eine Basisformatierung der Darstellung vornimmt.
Feinheiten werden in der Datei [mystyle.css](../output/html/templates/mystyle.css) im Verzeichnis [output/html/templates/](../output/html/templates/) konfiguriert.
*Tipp:* Bevor Sie die Datei verändert, legen Sie unbedingt eine Backupkopie an.
### PDF Ausdrucke
Im Verzeichnis [src/modules/pdf/](../src/modules/pdf/) liegen drei CSS Dateien:
- [pdf.css](./src/modules/pdf/pdf.css) nimmt Basisformatierungen für Farb- und SW-Ausdruck vor.
- [pdf-color.css](./src/modules/pdf/pdf-color.css) nimmt spezielle Formatierungen für den Farb-Ausdruck vor.
- [pdf-sw.css](./src/modules/pdf/sw-color.css) nimmt spezielle Formatierungen für den Schwarzweiß-Ausdruck vor.
### PDF Tabelle
Im Verzeichnis [src/modules/pdf/](../src/modules/pdf/) liegt eine CSS Datei:
- [pdf-tabelle.css](./src/modules/pdf/pdf-tabelle.css)
Sie formatiert die Tabellendarstellung für alle Sek. I Klassen mit allen SchülerInnen auf einer Seite.