Themes
Für Themes, welche auf der zentralen CMS-Instanz der FAU eingesetzt werden sollen, müssen verbindliche technische, organisatorische und redaktionelle Rahmenbedingungen erfüllt sein. Themes, welche diese Bedingungen nicht einhalten, können nicht auf der zentralen CMS-Instanz eingesetzt werden.
Die vollständigen und jeweils maßgeblichen Vorgaben stehen im GitHub-Repository:
- RRZE-WordPress-Theme.md
- RRZE-WordPress-Theme-LLM-Shortcut.md
- RRZE-WordPress-Plugin.md
- RRZE-WordPress-Entwicklungsumgebung.md
Grundlegende Anforderungen
- Für das jeweilige Theme muss stets ein fachkompetenter Ansprechpartner vorhanden sein, der im Falle von Problemen oder Fehlern zeitnah reagiert.
- Das Theme muss als Mindestanforderung kompatibel zur jeweils aktuellen WordPress- und PHP-Version sein.
- Neue Themes für das CMS-Angebot des RRZE müssen Block Editor Themes sein. Classic Themes sollen nicht mehr neu verwendet werden; Ausnahmen sind nur als ausdrücklich abgestimmte Übergangs- oder Kompatibilitätslösung möglich.
- Themes dürfen keine Funktionen übernehmen, die in die Plugin-Domain gehören. Funktionale Erweiterungen, Datenverarbeitung, externe Dienste, komplexe Workflows, Custom Post Types, Rollenlogik oder vergleichbare Fachlogik gehören in Plugins.
- Themes dürfen keine eigenen Pagebuilder enthalten, voraussetzen oder integrieren. Der WordPress Block Editor ist die verbindliche Grundlage.
- Themes dürfen keine eigenen Plugin-Installer, Marketplace-Installer, Update-Installer oder vergleichbare Mechanismen zum Nachladen von Plugins oder ausführbarem Code mitbringen.
- Alle Ausgaben, die durch das Theme erzeugt werden, müssen nach WCAG 2.2 in der Konformitätsstufe AA barrierefrei sein. Bei Formularen und anderen Eingabeworkflows ist WCAG 2.2 AAA ein gewünschtes Qualitätsziel, aber keine zwingende Mindestanforderung.
- Die Bereitstellung des Themes muss über die WordPress Directory, einem öffentlichen GitHub-Repository oder einem öffentlichen GitLab-Repository erfolgen. Eine manuelle Aktualisierung über zugesandte ZIP-Dateien kann nicht akzeptiert werden.
- Die programmiertechnische Fehlerfreiheit ist zu gewährleisten. Das Theme muss mit Theme Check geprüft werden; produktiv darf es keine Warnings oder Fatal Errors erzeugen.
- Themes müssen in einer geeigneten WordPress-Testumgebung mit aktivem Debug-Logging entwickelt und geprüft werden. Für RRZE-CMS-Themes ist Multisite-Verhalten zu berücksichtigen.
- JavaScript- und CSS-Dateien dürfen nur dort geladen werden, wo sie benötigt werden. Produktionsdateien müssen minifiziert sein; Source Maps gehören nicht in produktive Auslieferungen.
- JavaScript-Bibliotheken, CSS-Bibliotheken, Schriften, Icons und vergleichbare Laufzeitressourcen sind lokal mit dem Theme auszuliefern oder aus WordPress Core zu verwenden. Öffentliche CDNs sind standardmäßig nicht zulässig.
- Für nicht triviale CSS-Entwicklung soll ein Präprozessor wie SASS/SCSS mit geeignetem Buildprozess verwendet werden. Vendor-Präfixe sollen über Werkzeuge wie Autoprefixer erzeugt werden.
- Das Theme muss grundsätzlich ohne zusätzliche Plugins lauffähig sein. Wenn ein Theme die Bereitstellung bestimmter Plugins benötigt, müssen diese Abhängigkeiten dokumentiert und begründet werden.
- Einschränkungen der WordPress-Standardfunktionen, etwa im Site Editor oder bei „Zusätzliches CSS“, müssen über unterstützte WordPress-Mechanismen wie
theme.json,functions.phpoder geeignete Filter umgesetzt, begründet und dokumentiert werden. - Wenn ein Theme eigene Blöcke, Block-Variationen, Block-Styles oder Patterns bereitstellt, gelten die Block-Anforderungen der vollständigen Theme-Spezifikation und der Plugin-Spezifikation entsprechend.
README.md,readme.txt,style.css,package.jsonsowie Versions- und Kompatibilitätsangaben müssen konsistent gepflegt werden. DieREADME.mdmuss auf die maßgebliche Benutzerdokumentation verweisen.- Werden durch ein Theme externe Ressourcen abgerufen oder angezeigt, sind Datenschutz, Consent, Barrierefreiheit und Dokumentation zu berücksichtigen. Automatisierte externe Abrufe müssen die FAU-Crawler-Regeln und deren User-Agent-Vorgaben einhalten.
Betriebsbedingungen auf der CMS-Instanz der FAU
Bei einem Einsatz auf der zentralen CMS-Instanz der FAU herrschen folgende Arbeitsbedingungen:
- Im Falle eines anstehenden WordPress-Updates hat dieses stets Priorität gegenüber dem Funktionieren von Plugins und Themes. Bei einem WordPress-Update erfolgt keine vorherige Abstimmung mit Theme- oder Plugin-Entwicklern, ob das Update durchgeführt werden kann. Stattdessen erwarten wir von allen Theme- oder Plugin-Entwicklern, dass sich diese über die anstehenden Updates über die herkömmlichen Publikationskanäle von WordPress informiert halten und bereits vor den Veröffentlichung von neuen Versionen die jeweiligen Themes und Plugins daraufhin ertüchtigten.
- Plugins und Themes, die nach einem WordPress-Update nicht mehr funktionieren oder Fehler liefern, können ohne Vorwarnung deaktiviert werden.
- Plugins und Themes, die länger als ein Jahr nicht mehr aktualisiert wurden oder bei denen der Entwickler nicht mehr erreichbar ist, können jederzeit und ohne Vorwarnung deaktiviert werden.
- Bei der Verwendung von Namenspaces dürfen die folgenden Präfixe nur nach Rücksprache mit dem RRZE verwendet werden:
rrze-,utn-,fau-undcms-.