RRZE-Webteam / rrze-faudir

Plugin zur Darstellung des Personen- und Einrichtungsverzeichnis der FAU in Websites
GNU General Public License v3.0
0 stars 0 forks source link

Ausgabetemplates für Shortcodes und Block Editor #35

Open xwolfde opened 2 months ago

xwolfde commented 2 months ago

Für die Ausgabe von Profilen über Shortcodes sollen die erstellten HTML-Bestandteile in Datei-Templates abgelegt werden.

Hierzu wird ein Verzeichnis templates im Repo angelegt, welches je gewünschtem Ausgabeformat eine Datei enthält. Der Dateiname sollte hierbei dem Namen des Ausgabeformats entsprechen, welches welches als Argument format="" im Shortcode bzw. in dem Auswahlfeld eines Blocks verwendet wird.

Die Syntax der Templates und die Template-Erzeugung basiert auf die Class Template, die bereits in anderen Plugins zum Einsatz kommt.

Beispiele hierfür sind im Plugin RRZE-Lectures zu sehen:

Tenplate-und Parser-Class:

Templates:

Für die Ausgabe und Darstellung mittels Blöcken im Block Editor kann alternativ auch ein anderer Ansatz gewählt werden. Beispielsweise entsprechend der Nutzung im Elements Block Plugin. Vgl. Ausgabe eines CTA: https://github.com/RRZE-Webteam/rrze-elements-blocks/tree/main/src/cta

Primäre Intention ist es, dass die spätere Modifikation der Ausgaben auch tiefgreifende ohne Änderung des Codes angepasst werden kann. Der HTML-Ausgabe-Code soll daher soweit möglich nicht hardcodiert in PHP- oder JS-Code enthalten sein.