Vorgaben an Blöcke

Vorgaben an Blöcke

Neben den Anforderungen an Plugins müssen WordPress-Blöcke, welche auf der zentralen CMS Instanz des RRZE eingesetzt werden sollen zusätzliche Rahmenbedingungen erfüllen:

  1. Alle Blöcke für Plugins sollen entweder in der Kategorie „RRZE, „FAU“ oder der Abkürzung einer anderen Hochschule eingruppiert werden.
    • Bei einer Entwicklung im Auftrag und in Abnahme durch das RRZE oder durch dem RRZE -Webteam selbst wird die Kategorie „RRZE“ verwendet. Für Entwickler ausserhalb des RRZE ist eine vorherige Abstimmung mit dem RRZE Webteam erforderlich um Blöcke in diese Kategorie einzugruppieren.
    • Blöcke, die von anderen Teams in der FAU für FAU-weit zu nutzenden Plugins verwendet werden, sollen in der Kategorie „FAU“ eingruppiert werden.
    • Blöcke, die für den Einsatz von anderen Hochschulen (z.B. UTN) entwickelt werden, verwenden als Kategorie die Abkürzung der Hochschule, sofern dies nicht anders vereinbart wurde.
  2. Bei Updates müssen Blöcke die Deprecation API von WordPress berücksichtigen. Für statische Blöcke tritt dieser Fall immer dann ein, wenn sich Werte der block.json oder Speicherfunktion (save.js) ändern. Bei dynamischen Blöcken tritt dieser Fall immer dann ein, wenn sich Werte der block.json ändern. Nähere Informationen finden Sie im WordPress Entwicklerhandbuch im Abschnitt Deprecation
  3. Block-Einstellungen befinden sich entweder in der Block-Toolbar oder bei komplexen Einstellungsoptionen in der Settings-Sidebar. Eine Einstellung sollte dann in die Block-Toolbar wandern, wenn Sie für das befüllen und schnelle konfigurieren eines Blockes zwingend notwendig bzw. sinnvoll ist.
  4. Der Slug des Blocks sollte idealerweise das Schema Kategoriename oder Pluginname/Block-Name nutzen. Bei RRZE-Blöcken z.B. rrze/block-name, bzw. bei FAU-Blöcken fau/block-name. Falls ein Plugin mehrere Blöcke ausliefert, kann statt dem Kategorienamen der Produktname an erster Stelle genutzt werden. Zum Beispiel: plugin-name/block-name.
  5. Neuentwickelte Blöcke sollten dem WordPress-Schema für Blöcke folgen. Detaillierte Informationen über die dafür empfohlene Dateistruktur finden Sie im Entwicklerhandbuch unter „File-Structure of a Block“
  6. Das UI und die Bedienung des Blocks sollte so gestaltet werden, dass eine externe Dokumentation nicht notwendig ist. Zusatzinformationen sollten an geeigneter Stelle in der Settings-Sidebar hinterlegt werden.
  7. Blöcke werden standardmäßig in englischer Sprache (EN-US) ausgeliefert. Für den Einsatz auf dem CMS-Dienst des RRZE ist zusätzlich eine Sprachversion in Deutsch und Deutsch (Formal) notwendig.
  8. Blöcke müssen mit der jeweils aktuellen WordPress-Version fehlerfrei funktionieren und sollten keine Fehler in der Browserkonsole werfen. Fehler sind zeitnah zu beheben (vgl. Anforderungen an Plugins).
  9. CSS und Stylinganpassungen sollten in der Bearbeitungsansicht immer so gekapselt sein, dass nur der eigene Block von den Styling-Anweisungen betroffen ist.
  10. Inline-Styles sollten für das Frontend vermieden werden.

Als generelle Empfehlung können Sie sich am offiziellen Blockeditor Handbuch orientieren.