StEP00368: Update des CKEditors auf v5
Ziel
Update des CKEditors auf v5
Beschreibung
Der Build-Prozess für den CKEditor 4 ist Stud.IP ist kompliziert und für die meisten Entwickler*innen nicht ersichtlich. Mit dem Umstieg auf den CKEditor 5 steht ein optimierter Build-Prozess im Fokus, welcher sich in den vorhandenen Build-Prozess von Stud.IP integrieren lässt. Alte undurchsichtige Konstrukte sollen durch neue Strukturen ersetzt werden. Alle bisher genutzen Funktionen des WYSIWYG Editors bleiben erhalten und die API bleibt unverändert. Im Zuge der Modernisierung wir die Oberfläche des WYSIWYG Editors an das Look & Feel von Stud.IP angepasst. Mit dem Update auf CKE 5 und der Modernisierung der Strukturen bieten sich zusätzlich neue Möglichkeiten. So könnten Plugins den Editor um eigene Erweiterungen ergänzen, Plugins für den CKE5 zur Verbesserung der a11y könnten eingebunden werden und es kann die vue Component des CKE5 verwendet werden. Für die Entwicklung neuer Nutzungskonzepte und Oberflächen sind der Inline Editor und der Document Editor des CKE 5 besonders interessant. Ein weiterer Aspekt ist die Zukunftssicherheit. Der CKE 4 wird offiziell nur noch bis Ende 2023 unterstützt und bietet keinen Support für vue3.
Maßnahmen
- Entfernen des CKEditor 4 aus dem System
- CKEditor 4 aus dem Build-Prozess entfernen
- Einbindung des CKEditor 5 per npm
- Alle bisherigen Funktionen mit dem CKE 5 zur Verfügung stellen ** Stud.IP Anforderungen an den CKEditor per config Datei ** CKE 5 Plugins, Stud.IP spezifische Funktionen und Layout
- ggf. Plugins für CKE 5 schreiben um Stud.IP spezifische Funktionen zu ermöglichen
- Theme für den CKEditor um Stud.IP Farben und Icons zu verwenden
- Anpassung der Dialoge des CKEditors an Stud.IP Layout
Kurzbezeichnung des Integrationsaufwandes
-
gering
eigenständiges Modul
Durchführung
Die notwendigen Änderungen am Code werden durch den ELAN e.V. vertreten durch Till und Ron ausgeführt. Code-Review übernimmt Marcus.
Links
- Forum
- Branch
- MR
- Testsystem: https://vm817.rz.uni-osnabrueck.de/step368/