Systemvorlagen

Globale Templates im Keimeno Backend

Globale Templates – im Backend auch als System Templates bezeichnet – sind zentral gepflegte Bausteine für die Ausgabe einer Keimeno-Website. Sie enthalten Template-Code, der von anderen Templates eingebunden oder einer App zugeordnet werden kann. Dadurch lassen sich wiederkehrende Strukturen an einer Stelle verwalten, statt denselben Code mehrfach zu pflegen.

Die Bearbeitung richtet sich an Benutzerinnen und Benutzer mit Kenntnissen in HTML und der in Keimeno verwendeten Template-Syntax. Fehlerhafter Code kann die Darstellung aller Stellen beeinflussen, an denen das Template verwendet wird. Prüfen Sie Änderungen deshalb nach dem Speichern im Frontend.

Organisation nach System und Apps

Keimeno ordnet globale Templates entweder dem Bereich System oder einer freigeschalteten App zu. Die Zuordnung erleichtert die Orientierung und stellt den fachlichen Zusammenhang zum jeweiligen Modul her. In der Übersicht werden Titel, technischer Template-Name, Sprache und die Aktion Bearbeiten angezeigt.

  • System: allgemeine Templates ohne Zuordnung zu einer bestimmten App.
  • App Connection: Templates, die zu einer installierten und für die Auswahl freigegebenen App gehören.
  • Technischer Template-Name: wird beim Anlegen automatisch aus App und Beschreibung gebildet. Der Name wird vereinheitlicht und bei Namenskonflikten automatisch eindeutig ergänzt.

Ein App-Wechsel im Editor kann auch den Speicherort der zugehörigen Template-Dateien anpassen. Die Zuordnung sollte daher nur geändert werden, wenn das Template fachlich tatsächlich in einen anderen Bereich gehört.

Ein globales Template anlegen

  1. Öffnen Sie im Backend die Verwaltung der globalen beziehungsweise System Templates.
  2. Wählen Sie den gewünschten System- oder App-Bereich.
  3. Klicken Sie auf Neu beziehungsweise auf die Schaltfläche mit dem Pluszeichen.
  4. Tragen Sie eine eindeutige und verständliche Beschreibung ein.
  5. Wählen Sie unter App Connection den Bereich System oder eine passende App.
  6. Speichern Sie den neuen Eintrag. Keimeno legt die notwendigen Sprachdatensätze an und erzeugt den technischen Template-Namen automatisch.

Verwenden Sie einen Titel, der die Aufgabe des Templates beschreibt, beispielsweise „Kontaktbox“ oder „Produkt-Hinweis“. Der automatisch erzeugte technische Name bleibt dadurch ebenfalls nachvollziehbar.

Der Bereich „Inhalt“

Im Tab Inhalt bearbeiten Sie Titel, Sprache, App-Verknüpfung und Template-Code. Oberhalb des Editors zeigt Keimeno Informationen zur geladenen Quelle an. Dazu gehören der Quellentyp, der relative Dateipfad, der Datei-Hash und die Dateigröße. Wird keine geeignete Datei gefunden, kann der vorhandene Datenbankinhalt als Fallback dienen.

Der Quelltext wird für jede Sprache im Template-Speicher unterhalb von /file_data/template/theme/ verwaltet. Beim Speichern aktualisiert Keimeno sowohl die interne Zuordnung als auch die für die Ausgabe benötigte Template-Datei.

Mehrsprachige Templates

Wenn die Installation mehrsprachige System Templates verwendet, steht im Editor eine Sprachauswahl bereit. Ein Sprachwechsel lädt den Inhalt des aktuellen Templates in der gewählten Sprache. Mit Inhalt auf alle Sprachen replizieren kann der aktuell geöffnete Inhalt auf die anderen Sprachen übertragen werden.

Auf der Startansicht steht zusätzlich eine globale Replikation zur Verfügung. Sie überträgt die ausgewählte Quellsprache für alle System Templates auf alle anderen Sprachen. Vorhandene Inhalte in den Zielsprachen werden dabei überschrieben. Verwenden Sie diese Funktion nur, wenn die Zielsprachen bewusst vereinheitlicht werden sollen.

KI-Hilfen und Template Builder

Am Quelltexteditor stehen – sofern die KI-Funktionen eingerichtet und verfügbar sind – Hilfen für folgende Aufgaben bereit:

  • HTML-Code formatieren,
  • HTML im Hinblick auf Barrierefreiheit optimieren,
  • strukturierte Daten ergänzen und prüfen,
  • eine eigene Anweisung an die KI senden.

Der Template Builder kann aus einer Vorlage und dem vorhandenen Originalinhalt einen Vorschlag für ein System Template erzeugen. KI-Ergebnisse sollten immer fachlich, technisch und datenschutzrechtlich geprüft werden, bevor sie gespeichert und produktiv eingesetzt werden.

Template-Konfiguration

Neben dem Quelltext stehen abhängig vom gewählten Template weitere Einstellungen zur Verfügung:

  • Template Auswahl aktivieren: kennzeichnet ein nicht als Framework geführtes Template für die Template-Auswahl.
  • Framework Template: kennzeichnet das Template als Framework-Template. Diese Einstellung verändert seine Rolle im System und sollte nur mit Kenntnis der verwendeten Seitenstruktur geändert werden.
  • Admin GUI Framework: bei Framework-Templates kann ein verfügbares GUI-Framework ausgewählt werden.
  • Implementierung: zeigt bei entsprechend hinterlegten Templates die technische Implementierungsbezeichnung an.

Frameworks bilden ein eigenes Funktionsgebiet. Ändern Sie die Framework-Zuordnung nicht allein zur optischen Anpassung eines einzelnen Bausteins.

JavaScript und CSS

Unterhalb des Inhaltseditors besitzt jedes globale Template eigene Editoren für JavaScript (BelowTheFold) und CSS (BelowTheFold). Damit können Verhalten und Darstellung direkt mit dem Template verbunden werden. Beide Bereiche werden separat gespeichert.

  • Verwenden Sie JavaScript nur für Funktionen, die zum betreffenden Template gehören.
  • Begrenzen Sie CSS-Selektoren möglichst auf eine eindeutige Klasse des Templates, damit andere Seitenbereiche nicht unbeabsichtigt beeinflusst werden.
  • Vermeiden Sie doppelte Bibliotheken und bereits global vorhandene Funktionen.

Zugriffsberechtigungen

Im Tab Einstellungen können die angelegten Kundengruppen für das Template ausgewählt werden. Beim Speichern ersetzt Keimeno die bisherige Gruppenzuordnung durch die aktuell markierten Gruppen. Prüfen Sie daher vor dem Speichern, ob alle benötigten Gruppen aktiviert sind.

Der globale Template-Editor selbst wird nur angezeigt, wenn der angemeldete Backend-Benutzer die erforderliche Sprach- beziehungsweise Bearbeitungsberechtigung besitzt. Fehlt diese Berechtigung, zeigt Keimeno einen entsprechenden Hinweis. Darüber hinaus können geschützte, vom System verwaltete Templates von der Löschfunktion ausgenommen sein.

Verwendung und Abhängigkeiten prüfen

Der Tab Verwendung zeigt Templates, in deren Inhalt der technische Name des aktuellen Templates gefunden wurde. Im Inhaltsbereich werden außerdem referenzierte beziehungsweise abgeleitete Untertemplates angezeigt. Diese Ansichten helfen dabei, die Auswirkungen einer Änderung vorab einzuschätzen.

Globale Templates können in Template-Code über eine Include-Anweisung referenziert werden. Die konkrete Schreibweise folgt der Keimeno-Template-Syntax, beispielsweise:

<% include file="technischer.template.name.tpl" %>

Nutzen Sie für eine bestehende Verknüpfung den im Backend angezeigten technischen Namen. Benennen oder verschieben Sie verwendete Templates nicht unüberlegt und kontrollieren Sie vor dem Löschen stets die Verwendung sowie die angezeigten Unterseiten und Ableitungen.

Original Template

Im Tab Original Template können vorhandene .tpl-Dateien der zugeordneten App eingesehen werden. Keimeno durchsucht dabei die sprachbezogenen Template-Verzeichnisse der App und stellt die gefundenen Dateien zur Auswahl. Diese Ansicht dient als Referenz und erleichtert den Vergleich mit der zentral bearbeiteten Version.

Backups anzeigen und wiederherstellen

Wenn der Template-Quelltext gespeichert wird, legt Keimeno eine Sicherung mit Sprache, Zeitpunkt und Bearbeiter an. Im Tab Backup werden die vorhandenen Sicherungen des aktuellen Templates aufgelistet. Eine Sicherung kann zunächst angezeigt und anschließend wiederhergestellt werden.

Nach einer Wiederherstellung lädt Keimeno das Template in der zur Sicherung gehörenden Sprache erneut. Kontrollieren Sie danach trotzdem Inhalt und Frontend-Ausgabe. CSS und JavaScript werden über eigene Formulare gespeichert; verlassen Sie sich bei Änderungen in diesen Bereichen daher nicht ausschließlich auf die Quelltext-Sicherung.

Templates durchsuchen

Die Suche auf der Startansicht durchsucht den HTML- beziehungsweise Template-Inhalt sowie den zugeordneten CSS- und JavaScript-Code. In der Trefferliste werden die Fundstellen nach Quelle zusammengefasst. Das ist besonders hilfreich, um Klassen, Funktionsnamen oder eingebundene Bausteine vor einer Änderung zu finden.

Ein Template löschen

Bei nicht geschützten Templates steht im Editor die Aktion Löschen zur Verfügung. Keimeno fordert vor dem Löschen eine Bestätigung an. Da ein globales Template an mehreren Stellen eingebunden sein kann, sollten Sie zuvor den Tab Verwendung, die Unterseiten und die Suchfunktion prüfen. Entfernen Sie anschließend gegebenenfalls alle Include-Verweise.

Empfohlener Arbeitsablauf

  1. Prüfen Sie die App-Zuordnung und öffnen Sie die richtige Sprache.
  2. Kontrollieren Sie unter Verwendung, welche anderen Templates betroffen sind.
  3. Nehmen Sie eine klar abgegrenzte Änderung am Quelltext, CSS oder JavaScript vor.
  4. Speichern Sie jeden separat bearbeiteten Bereich.
  5. Prüfen Sie die Ausgabe im Frontend in allen betroffenen Seitentypen und Bildschirmgrößen.
  6. Kontrollieren Sie bei mehrsprachigen Websites jede Sprache einzeln oder replizieren Sie Inhalte nur dann, wenn ein identischer Stand gewünscht ist.
  7. Nutzen Sie bei Problemen die angelegte Sicherung, um einen vorherigen Quelltextstand wiederherzustellen.

Wichtige Hinweise

  • Globale Templates können viele Seiten gleichzeitig beeinflussen.
  • Die Sprachreplikation überschreibt bestehende Zielinhalte.
  • Die Verwendungsanzeige basiert auf im Template-Code gefundenen Referenzen. Dynamisch zusammengesetzte Verwendungen sind daher nicht in jedem Fall sichtbar.
  • Speichern Sie HTML beziehungsweise Template-Code, JavaScript und CSS jeweils über das zugehörige Formular.
  • Löschen Sie ein Template erst, wenn keine benötigten Referenzen mehr darauf verweisen.