csdfsdf
This commit is contained in:
87
docs/ANLEITUNG.md
Normal file
87
docs/ANLEITUNG.md
Normal file
@@ -0,0 +1,87 @@
|
||||
# Anleitung
|
||||
|
||||
Nutzungs- und Hilfedatei fuer `desktop.kusche.berlin`.
|
||||
|
||||
Diese Datei ist fuer spaetere Endnutzerhilfe, interne Einfuehrung und als Basis fuer einen Hilfebereich gedacht.
|
||||
|
||||
## Einstieg
|
||||
|
||||
Der Desktop besteht aus mehreren Hauptbereichen:
|
||||
|
||||
- `Desktop`
|
||||
Arbeitsflaeche mit Icons, Fenstern und Infobereich.
|
||||
|
||||
- `Startmenue`
|
||||
Zugang zu Benutzerfunktionen und installierten Programmen.
|
||||
|
||||
- `Infobereich`
|
||||
Rechter Seitenbereich fuer eingeblendete Informationskarten.
|
||||
|
||||
- `Widget-Bereich`
|
||||
Bereich bei Uhr und Systemleiste fuer kleine Mini-Funktionen.
|
||||
|
||||
## Startmenue verwenden
|
||||
|
||||
Das Startmenue ist in drei Bereiche gegliedert:
|
||||
|
||||
1. `User Setting Bereich`
|
||||
Hier befinden sich Benutzername, User-Icon, Einstellungen sowie Anmelden oder Abmelden.
|
||||
2. `Funktion-Bereich`
|
||||
Hier werden die Funktionsgruppen ausgewaehlt. Aktuell ist `Programme` die erste Gruppe.
|
||||
3. `Auswahlbereich`
|
||||
Hier erscheinen die Inhalte der aktuell gewaehlten Funktionsgruppe, zum Beispiel installierte Apps.
|
||||
|
||||
## Programme oeffnen
|
||||
|
||||
- Desktop-Icons koennen direkt geoeffnet werden.
|
||||
- Im Startmenue lassen sich Programme ueber den `Auswahlbereich` starten.
|
||||
- Fenster koennen verschoben, minimiert, maximiert und geschlossen werden.
|
||||
|
||||
## Einstellungen oeffnen
|
||||
|
||||
Die Einstellungen werden aktuell ueber die App `User Self Management` bereitgestellt.
|
||||
|
||||
Dort koennen derzeit insbesondere verwaltet werden:
|
||||
|
||||
- `Desktop Type` beziehungsweise Skin-Auswahl
|
||||
- persoenliche Benutzerdaten
|
||||
- sichtbare Apps
|
||||
- Inhalte des `Infobereichs`
|
||||
|
||||
## Benutzerdaten
|
||||
|
||||
Aktuell gelten folgende Regeln:
|
||||
|
||||
- Standardfelder wie Name, E-Mail, Telefon, Titel und Ort koennen fuer LDAP vorbereitet oder synchronisiert werden.
|
||||
- `Geburtsdatum` bleibt derzeit lokal gespeichert.
|
||||
- nicht jedes Profilfeld wird automatisch in LDAP geschrieben.
|
||||
|
||||
## Desktop Type und Skins
|
||||
|
||||
Das System unterstuetzt derzeit:
|
||||
|
||||
- `Apple`
|
||||
- `Windows`
|
||||
- `Linux`
|
||||
|
||||
Der ausgewaehlte Desktop Type beeinflusst Darstellung und Interaktionsdetails, waehrend die gemeinsame Shell-Logik erhalten bleibt.
|
||||
|
||||
## Infobereich
|
||||
|
||||
Der `Infobereich` ist der rechte Desktopbereich.
|
||||
|
||||
- Inhalte koennen benutzerbezogen ein- oder ausgeblendet werden.
|
||||
- Aenderungen sollen gespeichert bleiben.
|
||||
- Der `Infobereich` ist nicht identisch mit dem `Widget-Bereich`.
|
||||
|
||||
## Begriffsregel
|
||||
|
||||
Fuer sprachliche Konsistenz gilt:
|
||||
|
||||
- rechte Desktopseite: `Infobereich`
|
||||
- Mini-Apps an Uhr/Systemleiste: `Widget-Bereich`
|
||||
- linke Startmenuespalte: `User Setting Bereich`
|
||||
- mittlere Startmenuespalte: `Funktion-Bereich`
|
||||
- rechte Startmenuespalte: `Auswahlbereich`
|
||||
|
||||
Die verbindliche zentrale Fassung der Begriffe steht in [CONTENT.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/CONTENT.md).
|
||||
129
docs/CONTENT.md
Normal file
129
docs/CONTENT.md
Normal file
@@ -0,0 +1,129 @@
|
||||
# Content
|
||||
|
||||
Zentrale Inhaltsbasis fuer `desktop.kusche.berlin`.
|
||||
|
||||
Diese Datei dient als gemeinsame Quelle fuer:
|
||||
|
||||
- Begriffe und offizielle Benennungen im System
|
||||
- Funktionsbeschreibung des aktuellen Systems
|
||||
- spaetere Inhalte fuer einen Hilfe-Bereich
|
||||
- zentrale Zusammenfassung der dezentralen `README.md`-Dateien
|
||||
|
||||
## Zweck
|
||||
|
||||
`CONTENT.md` beschreibt das System fachlich und sprachlich.
|
||||
|
||||
Nicht hier hinein gehoeren:
|
||||
|
||||
- technische Detailanweisungen fuer Entwickler
|
||||
- Go- und NoGo-Regeln fuer Umsetzung
|
||||
- nur ordnerspezifische Detailerklaerungen ohne Relevanz fuer das Gesamtsystem
|
||||
|
||||
Diese Inhalte liegen in:
|
||||
|
||||
- [ANLEITUNG.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/ANLEITUNG.md)
|
||||
- [WEITERENTWICKLUNG.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/WEITERENTWICKLUNG.md)
|
||||
|
||||
## Offizielle Begriffe
|
||||
|
||||
Diese Benennungen gelten projektweit und sollen in UI, Doku und Weiterentwicklung konsistent verwendet werden.
|
||||
|
||||
### Oberflaechenbereiche
|
||||
|
||||
- `Desktop`
|
||||
Die eigentliche Arbeitsflaeche mit Icons, Fenstern, Taskbar und Infobereich.
|
||||
|
||||
- `Infobereich`
|
||||
Der rechte Bereich auf dem Desktop mit eingeblendeten Informationskarten oder kleinen Bereichsmodulen.
|
||||
|
||||
- `Widget-Bereich`
|
||||
Der Bereich bei der Uhr bzw. Systemleiste fuer kleine Widgets oder Mini-Apps.
|
||||
|
||||
- `Setup-Bereich`
|
||||
Der zentrale Einstellungsbereich fuer Benutzer, Desktop-Typ, Apps und Bereichsauswahl. Aktuell umgesetzt ueber `User Self Management`.
|
||||
|
||||
### Menue-Bereiche
|
||||
|
||||
- `User Setting Bereich`
|
||||
Linke Menuespalte mit User-Icon, Benutzername, Einstieg in Einstellungen und Session-Aktion.
|
||||
|
||||
- `Funktion-Bereich`
|
||||
Mittlere Menuespalte mit Funktionsgruppen wie `Programme`.
|
||||
|
||||
- `Auswahlbereich`
|
||||
Rechte Menuespalte mit den Inhalten der aktuell gewaehlten Funktionsgruppe.
|
||||
|
||||
### Systemobjekte
|
||||
|
||||
- `App`
|
||||
Ein bereitgestelltes System-Tool oder Modul. Eine App kann als Desktop-App, Menue-App, Systembar-Eintrag oder Quelle fuer Widgets/Funktionen auftreten.
|
||||
|
||||
- `Widget`
|
||||
Eine kleine Funktion oder Mini-Anzeige. Widgets sind nicht automatisch identisch mit Apps. Eine App kann Widgets bereitstellen, muss es aber nicht.
|
||||
|
||||
- `Desktop Type`
|
||||
Benutzerseitige Auswahl des Desktop-/Skin-Typs. Aktuell vorgesehen: `Apple`, `Windows`, `Linux`.
|
||||
|
||||
- `Skin`
|
||||
Technische und visuelle Auspraegung eines Desktop-Typs, inklusive Layout, Interaktionsdetails und Asset-Zuordnung.
|
||||
|
||||
## Aktueller Systemumfang
|
||||
|
||||
Stand dieser Datei:
|
||||
|
||||
- gemeinsame Desktop-Shell mit den Skins `Apple`, `Windows` und `Linux`
|
||||
- frei verschiebbare Desktop-Icons
|
||||
- Icon-Positionen lokal gespeichert, pro Benutzer und pro Skin
|
||||
- automatische Schriftfarbanpassung fuer Desktop-Icons anhand des Hintergrunds
|
||||
- Fensterverwaltung mit Oeffnen, Fokussieren, Minimieren, Maximieren und Verschieben
|
||||
- konsistentes Standard-Design fuer Fensterinhalte, sofern eine App kein eigenes UI mitbringt
|
||||
- Startmenue mit `User Setting Bereich`, `Funktion-Bereich` und `Auswahlbereich`
|
||||
- rechter `Infobereich` mit benutzerbezogener Sichtbarkeit
|
||||
- `User Self Management` als Setup-App
|
||||
- lokale Benutzereinstellungen fuer Desktop-Skin, App-Auswahl, Infobereich und Profildaten
|
||||
- LDAP-Synchronisierung fuer Standardfelder wie Name, E-Mail, Telefon, Titel und Ort
|
||||
- `Geburtsdatum` aktuell bewusst nur lokal gespeichert
|
||||
- Keycloak bleibt das Auth-System
|
||||
|
||||
## Zentrale Inhaltszusammenfassung aus bestehenden README-Dateien
|
||||
|
||||
### Globales Projekt
|
||||
|
||||
Aus [README.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/README.md):
|
||||
|
||||
- `public/` ist der Web-Root fuer die Desktop-Shell
|
||||
- `src/Desktop/` enthaelt zentrale Desktop-Mechaniken
|
||||
- `partials/desktop/` enthaelt Shell-Templates
|
||||
- `modules/` bleibt Zielort fuer klassische Module
|
||||
- `temp/nexus-module-import/` ist Rohbasis fuer importierte Nexus-Module
|
||||
- Keycloak bleibt das Auth-System
|
||||
|
||||
### Module
|
||||
|
||||
Aus [modules/README.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/modules/README.md):
|
||||
|
||||
- klassische Module bleiben unter `modules/<modul>/`
|
||||
- Businesslogik wird nicht in den Desktop-Core verschoben
|
||||
|
||||
### Skins
|
||||
|
||||
Aus [skins/README.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/skins/README.md):
|
||||
|
||||
- `skins/<skin>/profile.php` enthaelt Skin-Metadaten
|
||||
- `skins/<skin>/vendor/` enthaelt Rohquellen und Quellpacks
|
||||
- `public/assets/desktop/skins/<skin>/` enthaelt auslieferbare CSS/JS-Dateien
|
||||
- `public/assets/desktop/skin-icons/<skin>/` enthaelt verwendete Web-Icons
|
||||
|
||||
## Hilfe-Bereich Vorbereitung
|
||||
|
||||
Fuer einen spaeteren Hilfebereich sollen Inhalte aus dieser Datei in Themenblcke uebernommen werden:
|
||||
|
||||
- `Begriffe`
|
||||
- `Desktop bedienen`
|
||||
- `Menue verstehen`
|
||||
- `Fenster verwenden`
|
||||
- `Infobereich konfigurieren`
|
||||
- `Apps und Desktop Type verwalten`
|
||||
- `Benutzerdaten und Synchronisierung`
|
||||
|
||||
Die Inhalte sollen spaeter moeglichst nicht neu erfunden, sondern aus den zentral gepflegten Dateien abgeleitet werden.
|
||||
@@ -1,18 +1,39 @@
|
||||
# desktop.kusche.berlin
|
||||
|
||||
V1-Scaffold fuer die neue Desktop-Oberflaeche von Kusche.Berlin.
|
||||
Zentraler Dokumentationsindex fuer das Projekt.
|
||||
|
||||
## Struktur
|
||||
## Zentrale Dateien
|
||||
|
||||
- [CONTENT.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/CONTENT.md)
|
||||
Zentrale Inhaltsbasis mit offiziellen Begriffen, Systemumfang und spaeterer Hilfe-Basis.
|
||||
|
||||
- [ANLEITUNG.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/ANLEITUNG.md)
|
||||
Nutzungs- und Hilfedatei fuer Bedienung, Orientierung und spaetere Hilfebereiche.
|
||||
|
||||
- [WEITERENTWICKLUNG.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/WEITERENTWICKLUNG.md)
|
||||
Regeln fuer Weiterentwicklung, Doku-Pflege, Go's und NoGo's.
|
||||
|
||||
## Technische Projektstruktur
|
||||
|
||||
- `public/` Web-Root mit Desktop-Shell auf `/`
|
||||
- `api/desktop.php` JSON-Payload fuer die Shell
|
||||
- `src/Desktop/` zentrale Desktop-Mechaniken
|
||||
- `partials/desktop/` Shell-Template
|
||||
- `modules/` Zielort fuer klassische Module
|
||||
- `temp/nexus-module-import/` Rohbasis fuer importierte Nexus-Module
|
||||
|
||||
## Hinweise
|
||||
## Fachliche Hinweise
|
||||
|
||||
- `Old-Nexus/` wird nicht technisch eingebunden.
|
||||
- Skins `Windows`, `Apple`, `Linux` laufen auf einer gemeinsamen Shell.
|
||||
- Keycloak bleibt das Auth-System; der Theme-Handoff ist in `docs/keycloak-theme-handoff.md` beschrieben.
|
||||
- Keycloak bleibt das Auth-System.
|
||||
- der Theme-Handoff ist in [keycloak-theme-handoff.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/keycloak-theme-handoff.md) beschrieben.
|
||||
|
||||
## Dokumentationsregel
|
||||
|
||||
Wichtige Informationen duerfen nicht nur in Unterordnern oder Einzeldateien stehen.
|
||||
|
||||
Es gilt:
|
||||
|
||||
- wichtige Inhalte aus Unterordner-`README.md`-Dateien werden zentral in `docs/CONTENT.md` gespiegelt
|
||||
- Nutzungswissen wird in `docs/ANLEITUNG.md` gepflegt
|
||||
- Entwicklungsregeln werden in `docs/WEITERENTWICKLUNG.md` gepflegt
|
||||
|
||||
71
docs/WEITERENTWICKLUNG.md
Normal file
71
docs/WEITERENTWICKLUNG.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# Weiterentwicklung
|
||||
|
||||
Zentrale Arbeits- und Regeldatei fuer die Weiterentwicklung von `desktop.kusche.berlin`.
|
||||
|
||||
Diese Datei enthaelt:
|
||||
|
||||
- Go's und NoGo's
|
||||
- Dokumentationsregeln
|
||||
- Architektur- und Pflegehinweise
|
||||
|
||||
## Dokumentationspflicht
|
||||
|
||||
Die Projektdokumentation wird zentral und dezentral gleichzeitig gepflegt.
|
||||
|
||||
Verbindlich ist:
|
||||
|
||||
- zentrale Inhalte und Begriffe muessen in [CONTENT.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/CONTENT.md) gepflegt werden
|
||||
- Nutzungs- und Hilfetexte muessen in [ANLEITUNG.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/ANLEITUNG.md) gepflegt werden
|
||||
- Entwicklungsregeln muessen in dieser Datei gepflegt werden
|
||||
- vorhandene `README.md`-Dateien in Unterordnern muessen weiter gepflegt werden
|
||||
- wichtige Informationen aus den einzelnen `README.md`-Dateien muessen auch zentral gehalten werden
|
||||
- bei neuen wichtigen Unterordnern ist zu pruefen, ob eine eigene `README.md` noetig ist
|
||||
|
||||
## Go's
|
||||
|
||||
- Desktop-Mechaniken zentral halten, nicht pro App duplizieren
|
||||
- Fensterverhalten konsistent halten
|
||||
- gemeinsame Standards fuer Fensterinhalte nutzen, sofern eine App kein bewusst eigenes UI benoetigt
|
||||
- Begriffe in UI und Doku konsistent nach `CONTENT.md` verwenden
|
||||
- Apps als bereitgestellte Systemfunktionen denken, nicht nur als sichtbare Fenster
|
||||
- Unterschiede zwischen `App`, `Infobereich` und `Widget-Bereich` sauber trennen
|
||||
- lokale Persistenz und spaetere Backend-Synchronisierung getrennt vorbereiten
|
||||
- `README.md`-Dateien in Teilbereichen aktuell halten
|
||||
- zentrale Doku bei jeder relevanten Struktur- oder Begriffsanpassung mitpflegen
|
||||
|
||||
## NoGo's
|
||||
|
||||
- keine stillen Umbenennungen von Bereichen ohne Aktualisierung der zentralen Doku
|
||||
- keine Rueckbauten bestehender Desktop-Mechaniken ohne ausdrueckliche Entscheidung
|
||||
- keine Vermischung von Modul-Businesslogik mit globalem Desktop-Core
|
||||
- keine Skin-Sonderlogik direkt in einzelnen Apps, wenn sie global loesbar ist
|
||||
- keine nur lokalen README-Informationen ohne zentrale Uebernahme der wichtigen Punkte
|
||||
- keine Hilfeinhalte nur in Chatverlaeufen oder Ad-hoc-Notizen belassen
|
||||
- keine produktive Architekturabhaengigkeit zu `Old-Nexus/` oder vergleichbaren Altbestaenden
|
||||
|
||||
## Architekturregeln
|
||||
|
||||
- `modules/<modul>/` bleibt Ort fuer klassische Module
|
||||
- globale Desktop-Mechaniken liegen im gemeinsamen Kern
|
||||
- Skins definieren Darstellung und Interaktionsdetails, nicht die Fachlogik
|
||||
- Hilfe- und Inhaltsdateien sollen spaeter maschinenlesbar oder zumindest klar strukturierbar in einen Hilfebereich ueberfuehrt werden koennen
|
||||
|
||||
## Pflegeprozess
|
||||
|
||||
Bei jeder groesseren Aenderung ist zu pruefen:
|
||||
|
||||
1. Wurden offizielle Begriffe geaendert oder erweitert
|
||||
2. Wurde der Systemumfang sichtbar erweitert
|
||||
3. Braucht ein Unterordner eine gepflegte `README.md`
|
||||
4. Muessen zentrale Dateien angepasst werden
|
||||
5. Ist der Inhalt spaeter fuer einen Hilfebereich relevant
|
||||
|
||||
## Aktuell wichtige Projektregeln
|
||||
|
||||
- `UMSETZUNGSSTATUS.md` nur dann als erledigt markieren, wenn es ausdruecklich freigegeben wurde
|
||||
- Fokus liegt aktuell auf Desktop-UI und Apps
|
||||
- Login und Keycloak sind vorerst akzeptiert und nicht der aktuelle Hauptschwerpunkt
|
||||
- Desktop-Icons sind frei verschiebbar und werden pro Benutzer und Skin lokal gespeichert
|
||||
- die Schriftfarbe von Desktop-Icons passt sich automatisch an den Hintergrund an
|
||||
- Benutzerdaten sollen spaeter sauber in LDAP oder Keycloak geschrieben werden
|
||||
- Standard-Fensterinhalte sollen ein gemeinsames Design nutzen
|
||||
Reference in New Issue
Block a user