Initialer Commit

doc/erzeugung.md

@@ -0,0 +1,41 @@
+# Erzeugung des PDF-Ausgabedokuments
+
+Zu diesem Zeitpunkt sollte die Konfiguration abgeschlossen sein. Das PDF-Zieldokument kann nun erzeugt werden. Dazu muss das Python-Skript ``lehrerpdf.py``gestartet werden.
+
+
+### Voraussetzungen
+
+Hierzu 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. Die beiden Python-Module ``xhtml2pdf`` und ``markdown`` müssen installiert sein.
+
+```python
+pip3 install xhtml2pdf
+pip3 install markdown
+```
+
+
+### Starten des Skripts
+
+Nun kann das Skript gestartet werden:
+
+```
+python3 lehrerpdf.py
+```
+
+Auf der Konsole werden die Verarbeitungsschritte dokumentiert und auch evtl. Fehler bei der Verarbeitung angezeigt:
+
+```
+Verarbeite das Verzeichnis: data/
+Verarbeite Datei: data/klasse-5a.csv
+Verarbeite Datei: data/klasse-6b.csv
+Verarbeite Datei: data/kurs-if-9.csv
+Verarbeite Datei: data/kurs-if-ef.csv
+Erzeuge PDF-Datei: rm2.pdf
+Fertig!
+```
+
+Die Ausgabedatei, dessen Namen das Zielgerät angibt (im obigen Beispiel ``rm2.pdf``
+ für das Ziel Gerät reMarkable 2), wird dabei im Verzeichnis der Eingabedateien abgelegt.