docs from temp branch

2025-05-28 10:17:25 +02:00
parent 6248c90838
commit d66727e531
288 changed files with 203 additions and 5158 deletions
--- a/docs/components/README.md
+++ b/docs/components/README.md
@@ -1,12 +1,77 @@
-# 📁 `components` – Übersicht
+<!-- /docs/components/README.md -->

+# 🧩 `components/` – Übersicht über alle UI-Komponenten

-## 📄 Enthaltene Dateien
-
-| Datei | Beschreibung |
-|-------|--------------|
-| [`TestScript.md`](./TestScript.md) | *(Beschreibung ergänzen)* |
+Dieses Verzeichnis enthält die gesamten React-Komponenten der TALAS-Kartenanwendung.  
+Sie sind thematisch gegliedert in Teilbereiche für Kontextmenüs, POIs, Polylinien, Modale und die zentrale `MapComponent`.

 ---

-🔼 [Zurück zu `components`](../README.md)
+## 📁 Strukturübersicht
+
+```bash
+components/
+├── contextmenu/                  # Komponenten für rechte Maustaste & Kontextaktionen
+│   ├── CoordinatePopup.js
+│   └── useMapContextMenu.js
+
+├── gisPolylines/                 # Polylinien (Kabelstrecken)
+│   ├── PolylineContextMenu.js
+│   └── icons/
+│       ├── CircleIcon.js
+│       ├── EndIcon.js
+│       ├── StartIcon.js
+│       └── SupportPointIcons.js
+
+├── icons/devices/overlapping/   # Zusätzliche Overlap-Icons für Geräte
+│   └── PlusRoundIcon.js
+
+├── mainComponent/               # Hauptkomponenten für Karteninitialisierung
+│   ├── MapComponent.js
+│   └── hooks/
+│       └── useInitializeMap.js
+
+├── pois/                        # POI-spezifische Modale
+│   ├── AddPOIModal.js
+│   └── PoiUpdateModal.js
+
+├── uiWidgets/                   # UI-Widgets
+│   ├── CoordinateInput.js
+│   ├── VersionInfoModal.js
+│   ├── TestScript.js
+│   └── mapLayersControlPanel/
+│       ├── EditModeToggle.js
+│       └── MapLayersControlPanel.js
+```
+
+---
+
+## 🔎 Beschreibung der Hauptbereiche
+
+### `contextmenu/`
+
+Rechtsklick-Menüs für Marker, POIs, Polylinien. Steuert Anzeige & Verhalten.
+
+### `gisPolylines/`
+
+Komponenten für das Zeichnen, Bearbeiten und Interagieren mit Linien/Strecken.
+
+### `mainComponent/`
+
+Zentrale Leaflet-Map-Logik & Initialisierung via `MapComponent` und `useInitializeMap`.
+
+### `pois/`
+
+Modale für das Hinzufügen und Bearbeiten von POIs (Points of Interest).
+
+### `uiWidgets/`
+
+Komponenten wie Eingabefelder für Koordinaten-Suche, Infoboxen und Control Panel für Geräte Layers .
+
+---
+
+## ✅ Besonderheiten
+
+- Verwendet **Tailwind CSS** für Styling
+- Integration mit Redux, Leaflet, OverlappingMarkerSpiderfier
+- Vollständig modular & testbar aufgebaut
--- a/docs/components/TestScript.md
+++ b/docs/components/TestScript.md
@@ -42,8 +42,3 @@ Dieses Skript durchsucht die geladene `setupPolylines.js`-Datei (per `raw-loader
 - Wird automatisch beim Mount (via `useEffect`) ausgeführt
 - `return null` → keine sichtbare Ausgabe

---
-
---
-
-🔙 [Zurück zu `components`](README.md)
--- a/docs/components/contextmenu/CoordinatePopup.md
+++ b/docs/components/contextmenu/CoordinatePopup.md
@@ -29,9 +29,4 @@ Zeigt ein modales Fenster mit Koordinateninformationen an, z. B. aus einem Kon
 - Nutzt `navigator.clipboard.writeText` oder Fallback mit `document.execCommand("copy")`
 - Stoppt Event-Bubbling, um Klick außerhalb zu erkennen

-
---
-
---
-
-🔙 [Zurück zu `contextmenu`](README.md)
+🔙 [Zurück zur Übersicht](./README.md)
--- a/docs/components/contextmenu/README.md
+++ b/docs/components/contextmenu/README.md
@@ -1,13 +1,43 @@
-# 📁 `contextmenu` – Übersicht
+<!-- /docs/components/contextmenu/README.md  temp branch  damit develop zurücksetzt-->

+# 🖱️ `contextmenu/` – Kontextmenü-Komponenten

-## 📄 Enthaltene Dateien
-
-| Datei | Beschreibung |
-|-------|--------------|
-| [`CoordinatePopup.md`](./CoordinatePopup.md) | *(Beschreibung ergänzen)* |
-| [`useMapContextMenu.md`](./useMapContextMenu.md) | *(Beschreibung ergänzen)* |
+Dieses Verzeichnis enthält Komponenten und Hooks zur Anzeige und Steuerung von Kontextmenüs in der Leaflet-Kartenanwendung. Sie dienen der Interaktion mit POIs, Koordinaten und Layer-Objekten per Rechtsklick.

 ---

-🔼 [Zurück zu `components`](../README.md)
+## 📂 Enthaltene Dateien
+
+| Datei                                            | Beschreibung                                                           |
+| ------------------------------------------------ | ---------------------------------------------------------------------- |
+| [`CoordinatePopup.js`](./CoordinatePopup.md)     | Zeigt ein kleines Kontextfenster mit Koordinaten und Copy-Funktion     |
+| [`useMapContextMenu.js`](./useMapContextMenu.md) | Hook zur Initialisierung und Verwaltung des Kontextmenüs auf der Karte |
+
+---
+
+## 🔄 Verwendung
+
+Diese Komponenten sind typischerweise eingebunden in:
+
+- [`MapComponent.js`](../mainComponent/MapComponent.md)
+- [`PolylineContextMenu.js`](../gisPolylines/PolylineContextMenu.md)
+- Marker- und Linienfunktionen aus `setupDevices`, `setupPolylines`
+
+---
+
+## 🎯 Ziel
+
+Ermöglicht einfache Benutzerinteraktion mit:
+
+- Geräten
+- Koordinaten
+- POIs
+- Streckenabschnitten
+
+---
+
+## 📚 Weitere Dokumentation
+
+Alle Markdown-Dateien für Komponenten befinden sich im `/docs/components/contextmenu/` Verzeichnis.
+
+🔙 [Zurück zu `components`](../README.md)
--- a/docs/components/contextmenu/useMapContextMenu.md
+++ b/docs/components/contextmenu/useMapContextMenu.md
@@ -28,9 +28,3 @@ addItemsToMapContextMenu(map, menuItemAdded, setMenuItemAdded, setShowCoordinate
 - Modularer Aufbau: `openPopupWithCoordinates` wird extern übergeben

  🔙 [Zurück zu contextmenu ](./README.md)
-
---
-
---
-
-🔙 [Zurück zu `contextmenu`](README.md)
--- a/docs/components/gisPolylines/PolylineContextMenu.md
+++ b/docs/components/gisPolylines/PolylineContextMenu.md
@@ -31,4 +31,4 @@ Wird dynamisch positioniert anhand der Klickkoordinaten (`position.x`, `position

 ## Verwendung

-Eingebettet z. B. in `setupPolylines.js` oder `PolylineLayerManager`, um rechte Mausklicks auf Linien zu behandeln.
+Eingebettet z. B. in `setupPolylines.js` oder `PolylineLayerManager`, um rechte Mausklicks auf Linien zu behandeln.
--- a/docs/components/gisPolylines/README.md
+++ b/docs/components/gisPolylines/README.md
@@ -1,12 +0,0 @@
-# 📁 `gisPolylines` – Übersicht
-
-
-## 📄 Enthaltene Dateien
-
-| Datei | Beschreibung |
-|-------|--------------|
-| [`PolylineContextMenu.md`](./PolylineContextMenu.md) | *(Beschreibung ergänzen)* |
-
---
-
-🔼 [Zurück zu `components`](../README.md)
--- a/docs/components/gisPolylines/icons/CircleIcon.md
+++ b/docs/components/gisPolylines/icons/CircleIcon.md
@@ -12,4 +12,5 @@ Ein einfacher, grauer runder Marker als Stützpunkt in einer Polyline.

 ## Verwendung

-Wird in Polylinien als Zwischenpunkt gesetzt. Inaktiv, aber sichtbar.
+Wird in Polylinien als Zwischenpunkt gesetzt. Inaktiv, aber sichtbar.
+
--- a/docs/components/gisPolylines/icons/EndIcon.md
+++ b/docs/components/gisPolylines/icons/EndIcon.md
@@ -12,4 +12,4 @@ Ein Viereck zur Markierung des Endpunkts einer Polyline.

 ## Verwendung

-Wird am letzten Punkt einer Linie gesetzt, z. B. `lineData.coordinates[line.length - 1]`
+Wird am letzten Punkt einer Linie gesetzt, z. B. `lineData.coordinates[line.length - 1]`
--- a/docs/components/gisPolylines/icons/README.md
+++ b/docs/components/gisPolylines/icons/README.md
@@ -1,15 +0,0 @@
-# 📁 `icons` – Übersicht
-
-
-## 📄 Enthaltene Dateien
-
-| Datei | Beschreibung |
-|-------|--------------|
-| [`CircleIcon.md`](./CircleIcon.md) | *(Beschreibung ergänzen)* |
-| [`EndIcon.md`](./EndIcon.md) | *(Beschreibung ergänzen)* |
-| [`StartIcon.md`](./StartIcon.md) | *(Beschreibung ergänzen)* |
-| [`SupportPointIcons.md`](./SupportPointIcons.md) | *(Beschreibung ergänzen)* |
-
---
-
-🔼 [Zurück zu `components`](../README.md)
--- a/docs/components/gisPolylines/icons/StartIcon.md
+++ b/docs/components/gisPolylines/icons/StartIcon.md
@@ -12,4 +12,4 @@ Ein SVG-Dreieck zur Markierung des Startpunkts einer Polyline.

 ## Verwendung

-Wird am ersten Punkt einer Polyline platziert.
+Wird am ersten Punkt einer Polyline platziert.
--- a/docs/components/gisPolylines/icons/SupportPointIcons.md
+++ b/docs/components/gisPolylines/icons/SupportPointIcons.md
@@ -17,4 +17,4 @@ Definiert zwei Icons für interaktive Stützpunkte in einer Polyline:
 ## Verwendung

 - Hinzufügen/Entfernen von Zwischenpunkten in der Bearbeitungsansicht (editMode)
- Marker erscheinen z. B. bei Maus-Hover oder per Kontextmenü
+- Marker erscheinen z. B. bei Maus-Hover oder per Kontextmenü
--- a/docs/components/icons/devices/overlapping/PlusRoundIcon.md
+++ b/docs/components/icons/devices/overlapping/PlusRoundIcon.md
@@ -23,4 +23,4 @@ Wird für zusätzliche UI-Markierungen auf Geräten oder überlappenden Icons ve
 ## Hinweis

 - Die Bilddatei `/img/plus_round.png` muss vorhanden sein
- Kann bei Bedarf dynamisch durch ein anderes Icon ersetzt werden
+- Kann bei Bedarf dynamisch durch ein anderes Icon ersetzt werden
--- a/docs/components/icons/devices/overlapping/README.md
+++ b/docs/components/icons/devices/overlapping/README.md
@@ -1,12 +0,0 @@
-# 📁 `overlapping` – Übersicht
-
-
-## 📄 Enthaltene Dateien
-
-| Datei | Beschreibung |
-|-------|--------------|
-| [`PlusRoundIcon.md`](./PlusRoundIcon.md) | *(Beschreibung ergänzen)* |
-
---
-
-🔼 [Zurück zu `components`](../README.md)
--- a/docs/components/mainComponent/MapComponent.md
+++ b/docs/components/mainComponent/MapComponent.md
@@ -68,4 +68,4 @@ Verwendet umfangreiche Redux-Slices zur Steuerung von:

 ---

-📄 Pfad: `/components/mainComponent/MapComponent.js`
+📄 Pfad: `/components/mainComponent/MapComponent.js`
--- a/docs/components/mainComponent/README.md
+++ b/docs/components/mainComponent/README.md
@@ -1,12 +0,0 @@
-# 📁 `mainComponent` – Übersicht
-
-
-## 📄 Enthaltene Dateien
-
-| Datei | Beschreibung |
-|-------|--------------|
-| [`MapComponent.md`](./MapComponent.md) | *(Beschreibung ergänzen)* |
-
---
-
-🔼 [Zurück zu `components`](../README.md)
--- a/docs/components/mainComponent/hooks/README.md
+++ b/docs/components/mainComponent/hooks/README.md
@@ -1,12 +0,0 @@
-# 📁 `hooks` – Übersicht
-
-
-## 📄 Enthaltene Dateien
-
-| Datei | Beschreibung |
-|-------|--------------|
-| [`useInitializeMap.md`](./useInitializeMap.md) | *(Beschreibung ergänzen)* |
-
---
-
-🔼 [Zurück zu `components`](../README.md)
--- a/docs/components/mainComponent/hooks/useInitializeMap.md
+++ b/docs/components/mainComponent/hooks/useInitializeMap.md
@@ -50,4 +50,4 @@ useInitializeMap(

 ## 📁 Quelle

-Wrappt `initializeMap()` aus `/utils/initializeMap.js`
+Wrappt `initializeMap()` aus `/utils/initializeMap.js`
--- a/docs/components/pois/AddPOIModal.md
+++ b/docs/components/pois/AddPOIModal.md
@@ -24,4 +24,5 @@ Die Koordinaten (`latlng`) werden automatisch übernommen.
 ## Redux

 - `fetchPoiTypThunk`, `fetchPoiIconsDataThunk`
- `addPoiThunk`, `resetAddPoiStatus`
+- `addPoiThunk`, `resetAddPoiStatus`
+
--- a/docs/components/pois/PoiUpdateModal.md
+++ b/docs/components/pois/PoiUpdateModal.md
@@ -26,4 +26,4 @@ Ein Dialog zur Aktualisierung oder Löschung bestehender POIs.
 ## Technisches

 - Dynamische Gerätegruppenfilterung basierend auf `mapLayersVisibility`
- Formfelder mit `react-select` für bessere UX
+- Formfelder mit `react-select` für bessere UX
--- a/docs/components/pois/README.md
+++ b/docs/components/pois/README.md
@@ -1,13 +0,0 @@
-# 📁 `pois` – Übersicht
-
-
-## 📄 Enthaltene Dateien
-
-| Datei | Beschreibung |
-|-------|--------------|
-| [`AddPOIModal.md`](./AddPOIModal.md) | *(Beschreibung ergänzen)* |
-| [`PoiUpdateModal.md`](./PoiUpdateModal.md) | *(Beschreibung ergänzen)* |
-
---
-
-🔼 [Zurück zu `components`](../README.md)
--- a/docs/components/uiWidgets/CoordinateInput.md
+++ b/docs/components/uiWidgets/CoordinateInput.md
@@ -98,4 +98,4 @@ Beispiel in einer Map-Komponente:

 - `MapComponent.js` – kann die übergebenen Koordinaten zur Zentrierung oder Marker-Erstellung nutzen

---
+---
--- a/docs/components/uiWidgets/README.md
+++ b/docs/components/uiWidgets/README.md
@@ -1,13 +0,0 @@
-# 📁 `uiWidgets` – Übersicht
-
-
-## 📄 Enthaltene Dateien
-
-| Datei | Beschreibung |
-|-------|--------------|
-| [`CoordinateInput.md`](./CoordinateInput.md) | *(Beschreibung ergänzen)* |
-| [`VersionInfoModal.md`](./VersionInfoModal.md) | *(Beschreibung ergänzen)* |
-
---
-
-🔼 [Zurück zu `components`](../README.md)
--- a/docs/components/uiWidgets/VersionInfoModal.md
+++ b/docs/components/uiWidgets/VersionInfoModal.md
@@ -89,4 +89,4 @@ Die Komponente informiert Nutzer über:
 - Option für dynamische Anzeige von Changelog-Link
 - Automatischer Import von Version via `process.env.NEXT_PUBLIC_APP_VERSION`

---
+---
--- a/docs/components/uiWidgets/mapLayersControlPanel/EditModeToggle.md
+++ b/docs/components/uiWidgets/mapLayersControlPanel/EditModeToggle.md
@@ -82,4 +82,4 @@ const [editMode, setEditMode] = useState(() => localStorage.getItem("editMode")
 - `MapLayersControlPanel.js`: liest `localStorage.editMode` und deaktiviert Layer-Checkboxen im aktiven Modus
 - `PoiUpdateModal`, `AddPOIModal`: nutzen den Bearbeitungsmodus für UI-Freigabe

---
+---
--- a/docs/components/uiWidgets/mapLayersControlPanel/MapLayersControlPanel.md
+++ b/docs/components/uiWidgets/mapLayersControlPanel/MapLayersControlPanel.md
@@ -147,4 +147,4 @@ Das `MapLayersControlPanel` ermöglicht Nutzern:
 - `redux/slices/database/polylines/polylineLayerVisibleSlice.js`
 - `redux/slices/database/pois/poiLayerVisibleSlice.js`

---
+---
--- a/docs/components/uiWidgets/mapLayersControlPanel/README.md
+++ b/docs/components/uiWidgets/mapLayersControlPanel/README.md
@@ -1,13 +0,0 @@
-# 📁 `mapLayersControlPanel` – Übersicht
-
-
-## 📄 Enthaltene Dateien
-
-| Datei | Beschreibung |
-|-------|--------------|
-| [`EditModeToggle.md`](./EditModeToggle.md) | *(Beschreibung ergänzen)* |
-| [`MapLayersControlPanel.md`](./MapLayersControlPanel.md) | *(Beschreibung ergänzen)* |
-
---
-
-🔼 [Zurück zu `components`](../README.md)