natec – Handbücher der Anwendungen

Anleitungen für alle, die die natec-Anwendungen übernehmen oder vertreten – fachlich und technisch. Die fertigen PDFs liegen in pdf/, die Quellen in handbuecher/.

Handbuch	Datei	Quelle
Übergabe-Übersicht (Einstieg)	pdf/00-Uebergabe-Uebersicht.pdf	handbuecher/00-uebergabe.py
IT-Betrieb & Notfall	pdf/natec-IT-Betrieb-und-Notfall.pdf	handbuecher/it-betrieb.py
Vereo – Finanzen & Buchhaltung	pdf/Vereo-Handbuch-Finanzen-und-Buchhaltung.pdf	handbuecher/finanzen.py
Vereo – Mitgliederversammlung & Abstimmungen	pdf/Vereo-Handbuch-Mitgliederversammlung.pdf	handbuecher/mitgliederversammlung.py
Vereo – Mitgliederverwaltung	pdf/Vereo-Handbuch-Mitgliederverwaltung.pdf	handbuecher/mitgliederverwaltung.py
Persona – Personal & Zeiterfassung	pdf/Persona-Handbuch-Personal-und-Zeiterfassung.pdf	handbuecher/persona.py
Eveni – Veranstaltungen	pdf/Eveni-Handbuch-Veranstaltungen.pdf	handbuecher/eveni.py
Kurea & Entra – Kurzanleitungen	pdf/Kurea-Entra-Kurzanleitungen.pdf	handbuecher/kurea-entra.py

Keine Zugangsdaten in dieses Repository. Die Handbücher sagen nur, wo Zugänge liegen (Passwort-Tresor des Verbands). Leere Felder (Adressen, Ansprechpartner, Satzungsregeln) werden im ausgedruckten Exemplar oder hier im Quelltext ergänzt.

PDFs neu bauen

Voraussetzung: Python 3 und reportlab. Die Schrift (DejaVu Sans) liegt im Repository unter fonts/.

pip install -r requirements.txt
./build.sh                  # alle Handbücher nach pdf/
./build.sh finanzen eveni   # nur einzelne
DOKU_OUT=/tmp/x ./build.sh  # anderes Zielverzeichnis

Nach jedem Push auf main prüft Forgejo Actions, dass sich alle Handbücher fehlerfrei bauen lassen. Die PDFs in pdf/ bitte nach Änderungen lokal neu bauen und mit einchecken – so lassen sie sich direkt im Repository herunterladen.

Ein Handbuch ändern

Jedes Handbuch ist ein Python-Skript mit dem Inhalt; Layout und Bausteine stehen in handbuecher/common.py. Die wichtigsten Bausteine:

Baustein	Wofür
H1('…')	Kapitel (neue Seite, im Inhaltsverzeichnis)
H2('…'), H3('…')	Abschnitt (H2 im Inhaltsverzeichnis), Unterabschnitt
P('…')	Absatz; <b>fett</b>, <i>kursiv</i> erlaubt, & als &amp; schreiben
UL([...]), OL([...])	Aufzählung, nummerierte Schritte
TAB([[kopf...], [zeile...]], [breiten])	Tabelle; Breiten als Anteile, Summe 1.0
BOX('…', 'info' / 'warn' / 'ok')	Hinweis „Gut zu wissen“ / „Achtung“ / „Tipp“
CHECK([...], 'Titel')	Checkliste zum Abhaken
CODE('…')	Befehle (mehrzeilig mit \n)
PATH('A → B')	Menüpfad hervorheben

Am Ende jedes Skripts steht build('Dateiname.pdf', {...}) mit Titel, Untertitel, Stand und Kopf-/Fußzeile.

Bei inhaltlichen Änderungen den Stand (Datum, App-Version) im build(...)-Aufruf mitziehen. Grundlage sind die Dokumentationen der Apps (docs/ in den jeweiligen Repositories) – bei Widersprüchen gilt die App-Dokumentation, dieses Handbuch wird angepasst.