lezius/LehrerPDF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Dokumentation aktualisiert

Browse Source
This commit is contained in:
Dr. Wolfgang Lezius
2025-10-13 23:25:00 +02:00
parent ef0571c61b
commit 21e7b4eb1c
5 changed files with 18 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -18,22 +18,22 @@ eine gemeinsame PDF-Datei generiert, die für jede Lerngruppe
- eine Geburtstagsliste und - eine Geburtstagsliste und
- ein Blatt zur Planung des Halbjahres - ein Blatt zur Planung des Halbjahres
für ein Halbjahr umfasst. Zusätzlich kann optional als Startseite der Stundenplan eingebunden werden. für ein Halbjahr umfasst. Zusätzlich kann optional als Startseite ein Stundenplan eingebunden werden.
Diese PDF-Datei kann anschließend mit einem Tablet und einem Eingabestift mit Inhalt gefüllt werden. Alle Bestandteile sind untereinander verlinkt, so dass zwischen der Bearbeitung der diversen Tabellen der Lerngruppe sowie zwischen den Lerngruppen gewechselt werden kann. Diese PDF-Datei kann anschließend mit einem Tablet und einem Eingabestift mit Inhalt gefüllt werden. Alle Bestandteile sind untereinander verlinkt, so dass sehr einfach zwischen der Bearbeitung der diversen Tabellen der Lerngruppe sowie zwischen den Lerngruppen gewechselt werden kann.
### Unterstützte Geräte ### Unterstützte Geräte
Die PDF-Ausgabe ist für die folgenden Geräte optimiert worden. Verlinkt ist zur Illustration für jedes Gerät eine aus (fiktiven) Beispieldaten erzeugte PDF-Ausgabe. Die PDF-Ausgabe ist für die folgenden Tablet Geräte optimiert worden. Verlinkt ist zur Illustration für jedes Gerät eine aus (fiktiven) Beispieldaten erzeugte PDF-Ausgabe.
#### a) reMarkable #### a) reMarkable
Für alle reMarkable Geräte werden PDF Dokumente generiert, die exakt der Bildschirmgröße entsprechen. Damit entfällt das Zoomen bei der Bearbeitung. Für alle drei aktuellen reMarkable Tablets werden PDF Dokumente generiert, die exakt der Bildschirmgröße entsprechen. Damit entfällt das Zoomen bei der Bearbeitung.
Alle drei reMarkable Geräte blenden bei der Bearbeitung eines Dokuments eine Toolbar mit den gängigen Bearbeitungswerkzeugen ein. Diese Toolbar verdeckt dann aber einen Teil des Dokuments. Als Option kann deshalb ein linker oder rechter Rand für die Toolbar freigelassen werden. Alle drei Geräte blenden am linken oder rechten Bildschirmrand bei der Bearbeitung eines Dokuments eine Toolbar mit den gängigen Bearbeitungswerkzeugen ein. Diese Toolbar verdeckt dann aber einen Teil des Dokuments. Als Option kann deshalb ein linker oder rechter Rand für die Toolbar freigelassen werden.
Bei den beiden großen Geräten rm2 und Paper Pro ist in den folgenden Beispieldokumenten ein linker Rand gelassen worden, beim kompakten Gerät Paper Pro Move nicht. Bei den beiden großen Geräten rm2 und Paper Pro ist in den folgenden Beispieldokumenten ein Rand gelassen worden, beim kompakten Gerät Paper Pro Move nicht.
- [reMarkable 2](./src/data/rm2.pdf) - [reMarkable 2](./src/data/rm2.pdf)
- [reMarkable Paper Pro](./src/data/paperpro.pdf) - [reMarkable Paper Pro](./src/data/paperpro.pdf)
@@ -41,7 +41,7 @@ Bei den beiden großen Geräten rm2 und Paper Pro ist in den folgenden Beispield
#### b) Apple iPad #### b) Apple iPad
Für alle iPads werden PDF Dokumente erzeugt, die der Bildschirmgröße entsprechen. Da zur Bearbeitung eine App verwendet wird (z.B. die eingebaute Vorschau App oder kommerzielle PDF Editor Apps), hängt der Komfort bei der Bearbeitung dieser Vollbilddokumente sehr von der jeweiligen App ab. Da auch die Menüführung in jeder App anders aufgebaut ist, wird auf die Option eines zusätzlichen Rands verzichtet. Für alle aktuellen iPads werden PDF Dokumente erzeugt, die der Bildschirmgröße entsprechen. Da zur Bearbeitung eine App verwendet wird (z.B. die eingebaute Vorschau App oder eine der vielen angebotenen PDF Editor Apps), hängt der Komfort bei der Bearbeitung dieser Vollbilddokumente sehr von der jeweiligen App ab. Da auch die Menüführung in jeder App anders aufgebaut ist, wird hier auf die Option eines Rands verzichtet.
- iPad [7.-9.](./src/data/ipad789.pdf) und [10.-11.](./src/data/ipad1011.pdf) Gen. - iPad [7.-9.](./src/data/ipad789.pdf) und [10.-11.](./src/data/ipad1011.pdf) Gen.
- iPad Mini [2.-5.](./src/data/mini2345.pdf) und [6.-7.](./src/data/mini67.pdf) Gen. - iPad Mini [2.-5.](./src/data/mini2345.pdf) und [6.-7.](./src/data/mini67.pdf) Gen.
@@ -52,18 +52,16 @@ Für alle iPads werden PDF Dokumente erzeugt, die der Bildschirmgröße entsprec
Für alle übrigen Geräte stehen Ausgaben in den Formaten DIN A6, A5 und A4 zur Verfügung. Sie müssen dann auf dem jeweiligen Gerät passend skaliert werden. Vorteil von A6, A5 und A4 ist der einfache Ausdruck. Für alle übrigen Geräte stehen Ausgaben in den Formaten DIN A6, A5 und A4 zur Verfügung. Sie müssen dann auf dem jeweiligen Gerät passend skaliert werden. Vorteil von A6, A5 und A4 ist der einfache Ausdruck.
- [DIN A6](src/data/a6.pdf) - [DIN A6](src/data/a6.pdf), [DIN A5](src/data/a5.pdf), [DIN A4](src/data/a4.pdf)
- [DIN A5](src/data/a5.pdf)
- [DIN A4](src/data/a4.pdf)
### Dokumentation der Verarbeitung ### Dokumentation der Verarbeitung
Die Verarbeitung gliedert sich in zwei Schritte: Die Verarbeitung gliedert sich in zwei Schritte:
- Schritt 1: [Konfiguration durch den Benutzer](./doc/konfiguration.md) - Schritt 1: [Konfiguration der gewünschten Ausgabe](./doc/konfiguration.md)
- Schritt 2: [Erzeugung des Zieldokuments](./doc/erzeugung.md) - Schritt 2: [Start des Skripts](./doc/erzeugung.md) (Erzeugung des Zieldokuments)
### Lizenz ### Lizenz

4
doc/config.md
View File

@@ -1,4 +1,4 @@
# Konfiguration des Eingabeverzeichnisses (config.ini) # Konfiguration Eingabeverzeichnis (config.ini)
Im Verzeichnis des Skripts finden Sie die Datei ``config.dist`` (vgl. Verzeichnis [src/](../src/)). Sie stellt ein Beispiel dar und dient als Ausgangspunkt für das Anlegen der Datei ``config.ini``. Im Verzeichnis des Skripts finden Sie die Datei ``config.dist`` (vgl. Verzeichnis [src/](../src/)). Sie stellt ein Beispiel dar und dient als Ausgangspunkt für das Anlegen der Datei ``config.ini``.
@@ -9,7 +9,7 @@ Im Verzeichnis des Skripts finden Sie die Datei ``config.dist`` (vgl. Verzeichni
pfad = /Users/wolfgang/Documents/daten/ pfad = /Users/wolfgang/Documents/daten/
``` ```
Legen Sie eine Kopie der Datei ``config.dist`` unter dem Namen ``config.ini`` an und ändern Sie den Pfad. Das angegebenen Eingabeverzeichnis wird fortan als Eingabe berücksichtigt. Legen Sie eine Kopie der Datei ``config.dist`` unter dem Namen ``config.ini`` an und ändern Sie den Pfad. Das angegebenen Eingabeverzeichnis wird fortan als Eingabeverzeichnis verwendet.
Sie können wahlweise einen relativen Pfad oder einen absoluten Pfad angeben. Bitte beachten Sie, dass unter Windows die Backslashs \ zum Trennen der Verzeichnisse jeweils doppelt angegeben werden müssen: Sie können wahlweise einen relativen Pfad oder einen absoluten Pfad angeben. Bitte beachten Sie, dass unter Windows die Backslashs \ zum Trennen der Verzeichnisse jeweils doppelt angegeben werden müssen:

2
doc/erzeugung.md
View File

@@ -43,7 +43,7 @@ Die Ausgabedatei, dessen Namen das Zielgerät angibt (im obigen Beispiel ``rm2.p
### Option: Angabe des Eingabeverzeichnisses ### Option: Angabe des Eingabeverzeichnisses
Optional kann an dieser Stelle das Eingabeverzeichnis festgelegt werden. Optional kann an dieser Stelle mit der Option ``-d`` das Eingabeverzeichnis festgelegt werden.
Beispiel: Beispiel:

8
doc/konfiguration.md
View File

@@ -3,15 +3,15 @@
Die Konfiguration gliedert sich in zwei Teile. Die Konfiguration gliedert sich in zwei Teile.
### 1. Konfiguration des Eingabeverzeichnisses ### 1. Konfiguration Eingabeverzeichnis
Das Python-Skript verarbeitet mehrere Dateien (vgl. nächster Abschnitt), die in einem gemeinsamen Verzeichnis enthalten sein müssen. Um den Pfad des Verzeichnisses festzulegen gibt es zwei Möglichkeiten: Das Python-Skript verarbeitet mehrere Dateien (vgl. nächster Abschnitt), die in einem gemeinsamen Verzeichnis enthalten sein müssen. Um den Pfad des Verzeichnisses festzulegen gibt es zwei Möglichkeiten:
- Beim Aufruf des Skripts auf der Kommandozeile (vgl. Abschnitt [Erzeugung des Zieldokuments](erzeugung.md)) wird das Verzeichnis als Option angegeben. 1. Beim Aufruf des Skripts auf der Kommandozeile (vgl. Abschnitt [Erzeugung des Zieldokuments](erzeugung.md)) wird das Verzeichnis als Option angegeben.
- Im Verzeichnis des Skrips wird eine Datei [config.ini](config.md) hinterlegt, die den Pfad enthält. 2. Im Verzeichnis des Skrips wird eine Datei [config.ini](config.md) hinterlegt, die den Pfad enthält.
Trifft keine der beiden Möglichkeiten zu, wird das im Skript-Verzeichnis enthaltene Unterverzeichnis ``data/`` als Eingabe verwendet. Dieses Verzeichnis enthält (fiktive) Beispieldateien, die als Ausgangspunkt zum Experimentieren mit dem Tool gedacht sind. Treffen beide Möglichkeiten zu, so hat die erste Vorrang. Trifft keine der beiden Möglichkeiten zu, wird das im Skript-Verzeichnis enthaltene Unterverzeichnis ``data/`` als Eingabe verwendet. Dieses Verzeichnis enthält (fiktive) Beispieldateien, die als Ausgangspunkt zum Experimentieren mit dem Skript gedacht sind.
### 2. Konfiguration der PDF-Ausgabe ### 2. Konfiguration der PDF-Ausgabe

2
doc/lerngruppe.md
View File

@@ -47,4 +47,4 @@ Die Parameter sind zwar selbsterklärend, werden hier aber dennoch einmal kurz e
- Zudem können eine oder mehrere Zeilen pro SchülerIn erzeugt werden. - 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. - 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. - 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. - Abschließend kann die Anzahl der Checklisten für diese Lerngruppe festgelegt werden.