From 00fd8dc1cfb9c1b2c547f1921794906d96981604 Mon Sep 17 00:00:00 2001 From: ProgrammGamer Date: Fri, 30 Jan 2026 16:36:41 +0100 Subject: [PATCH] update README --- .github/copilot-instructions.production.md | 37 +++++++++++++++++ README.md | 48 ++++++++++++++++++++++ 2 files changed, 85 insertions(+) create mode 100644 .github/copilot-instructions.production.md diff --git a/.github/copilot-instructions.production.md b/.github/copilot-instructions.production.md new file mode 100644 index 0000000..fff5999 --- /dev/null +++ b/.github/copilot-instructions.production.md @@ -0,0 +1,37 @@ +# Copilot Instructions for Workshop-Wahlen (Production) + +## Project Overview + +This WordPress plugin manages workshop elections for Konfi-Castle events. It provides an admin backend (elections, workshops, participants, teamers, assignments) and a participant frontend. + +## Architecture & Components +- **Main file:** `konficastle-workshopwahl.php` – Initializes hooks, loads assets, admin menus. +- **Backend:** + - `includes/` with modules for elections, workshops, participants, teamers, assignments, data management, force assignment + - Core assignment logic: `includes/zuteilungslogik.php` +- **Frontend:** + - Shortcodes: `[konficastle_workshopwahl wahl=ID]`, `[konficastle_workshop_ergebnis wahl=ID]` +- **Database:** Tables are created via `install.php`, prefix: `kc_` + +## Key Patterns & Workflows +- **Admin tabs:** Navigation via `kc_admin_tabs()` +- **Naming:** Functions and tables use `kc_` prefix +- **Force assignments:** Manual assignments take precedence +- **Test data:** Only user ID 1 can generate via admin (`admin-data.php`) +- **CSV export:** Possible via admin assignments +- **Teamer password:** Managed via admin, hash in WP options + +## Examples & Entry Points +- **Admin menu:** `konficastle-workshopwahl.php`, `includes/admin-wahlen.php` +- **Assignment logic:** `includes/zuteilungslogik.php` +- **Frontend form:** `includes/frontend-form.php` + +## Notes for AI Agents +- Always use `$wpdb->prefix` for DB tables +- Backend logic is modular, each entity has its own file +- No complex JS logic in frontend, validation is server-side +- For changes to assignment logic: use test scenarios via test data admin page + +--- + +See README.md for further details. \ No newline at end of file diff --git a/README.md b/README.md index 78379fd..157bba0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,50 @@ # Workshop-Wahlen +## Überblick + +Dieses WordPress-Plugin ermöglicht die Verwaltung und Durchführung von Workshop-Wahlen für Konfi-Castle-Events. Es bietet ein vollständiges Backend für Admins (Wahlen, Workshops, Teilnehmer, Teamer, Zuteilungen) und ein Frontend-Formular für Teilnehmer. + +## Architektur & Hauptkomponenten + +- **Haupt-Plugin-Datei:** `konficastle-workshopwahl.php` – Registriert Hooks, lädt Assets, initialisiert Admin-Menüs. +- **Backend-Module (im `includes/`-Verzeichnis):** + - `admin-wahlen.php`, `admin-workshops.php`, `admin-teilnehmer.php`, `admin-teamer.php`, `admin-zuteilungen.php`, `admin-data.php`, `force-zuteilung.php`: Jeweils eigene Admin-Seiten für die Verwaltung der zugehörigen Entitäten. + - `zuteilungslogik.php`: Kernlogik für die automatische Zuteilung von Teilnehmern zu Workshops (inkl. Force-Zuteilungen und Kapazitätsprüfung). +- **Frontend:** + - `frontend-form.php`: Shortcode `[konficastle_workshopwahl wahl=ID]` für das Teilnehmer-Formular. + - `frontend-ergebnis.php`: Shortcode `[konficastle_workshop_ergebnis wahl=ID]` für Ergebnisanzeige. +- **Styles & Assets:** + - `assets/`: Enthält CSS für Admin und Frontend. + +## Datenbank & Installation + +- Tabellen werden über `install.php` beim Aktivieren angelegt (z.B. `kc_wahlen`, `kc_workshops`, `kc_teilnehmer`, `kc_zuteilung`, ...). +- Tabellenpräfix wird dynamisch über `$wpdb->prefix` verwendet. + +## Entwickler-Workflows + +- **Testdaten:** Über die Admin-Seite "Datenverwaltung" (`admin-data.php`) können Testdaten generiert werden (nur User ID 1). +- **CSV-Export:** Zuteilungen können über die Admin-Seite exportiert werden (`admin-zuteilungen.php`). +- **Zuteilungslogik:** Anpassungen an der Kernlogik erfolgen in `zuteilungslogik.php`. +- **Shortcodes:** + - `[konficastle_workshopwahl wahl=ID]` – Teilnehmer-Frontend + - `[konficastle_workshop_ergebnis wahl=ID]` – Ergebnisanzeige + +## Besondere Konventionen & Hinweise + +- **Namensschema:** Alle Plugin-Funktionen und Tabellen sind mit `kc_` (Konfi-Castle) prefixiert. +- **Admin-Tabs:** Navigation zwischen Admin-Seiten über `kc_admin_tabs()`. +- **Force-Zuteilungen:** Manuelle Zuweisungen haben Vorrang vor automatischer Logik. +- **Teamer-Passwort:** Verwaltung über eigene Admin-Seite, Passwort-Hash in WP-Optionen. +- **Frontend-Validierung:** Erfolgt serverseitig, keine komplexe JS-Logik im Frontend. + +## Einstiegspunkte & Beispiele + +- **Admin-Menüstruktur:** Siehe `konficastle-workshopwahl.php` und `includes/admin-wahlen.php`. +- **Zuteilungslogik:** Siehe `includes/zuteilungslogik.php` (Funktionen wie `kc_run_zuteilung`). +- **Frontend-Formular:** Siehe `includes/frontend-form.php` (Shortcode-Handler). + +--- + +Für Detailfragen zu Datenbankstruktur, Shortcodes oder Zuteilungslogik siehe die jeweiligen Dateien im `includes/`-Verzeichnis. +