Dokumentation aktualisiert

This commit is contained in:
2025-10-13 23:25:00 +02:00
parent ef0571c61b
commit 21e7b4eb1c
5 changed files with 18 additions and 20 deletions

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``.
@@ -9,7 +9,7 @@ Im Verzeichnis des Skripts finden Sie die Datei ``config.dist`` (vgl. Verzeichni
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:

View File

@@ -43,7 +43,7 @@ Die Ausgabedatei, dessen Namen das Zielgerät angibt (im obigen Beispiel ``rm2.p
### 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:

View File

@@ -3,15 +3,15 @@
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:
- 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

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.
- 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.
- Abschließend kann die Anzahl der Checklisten für diese Lerngruppe festgelegt werden.