JSON-Struktur

Im EGOCMS wird es schon Standardanleitungen geben, die jeder Kunde sehen und verwenden kann. Aber da manche Kunde andere CMS-Features haben als andere Kunden, haben sie auch die Möglichkeit, ihre eigenen Anleitungen zu erstellen. Um das tun zu können, müssen Kunden zuerst eine JSON-Datei in den Pfad ‚var/lib/admin‘ einfügen. Diese Datei können sie dann beliebig befüllen, jedoch sollten sie sich an folgendes Schema halten:

In „items“ werden alle Anleitungen definiert. Diese benötigen Infos wie den Titel, der in „title“ geschrieben wird. Bevorzugterweise hält man den Titel kurz, da die Anleitung mit ihrem Titel im Hilfemenü aufgelistet wird.
Um etwas mehr Struktur und Ordnung unter den Anleitungen zu bringen, kann man diese in Gruppen einteilen, die mit „group“ definiert.
Mit „licence“ kann eine Lizenz angegeben werden, die das CMS eines Kunden haben muss, um die Anleitung sehen zu können. Das soll verhindern, dass der Benutzer eine Anleitung sieht, die ein Feature verwendet, welches das CMS selbst noch gar nicht besitzt.
In „steps“ werden nun alle Schritte aufgezählt, die die Anleitung haben soll.
Unter „content“ kann der Inhalt in Textform wiedergegeben werden.
Mit „media“ kann ein weiteres Medium in den Inhalt eingefügt werden. In „type“ gibt man an, ob es ein Bild oder ein Video sein soll und in „url“ steht der Pfad zum Bild/Video. Dieser muss ein für alle zugänglicher Pfad sein, da man das Bild/Video sonst sehen kann. In „title“ schreibt man den Titel des Bildes/Videos rein, der angezeigt wird, wenn das Bild/Video nicht geladen werden kann. In „media“ kann man mehrere Bilder und/oder Videos einbauen und ist optional.
Eine „node“ wird in der Anleitung als „Zeige es mir“-Button dargestellt und ist auch optional. Um auf ein Element zeigen zu können, muss dieses entweder mit einer „id“ oder einem „selector“ definiert werden. Die meisten Elemente im CMS besitzen einen Selector, der „data-interactive-id“ heißt. Der Name dieser Id folgt dem Schema von „input-[Name des Elements]“. Zuletzt kann in „action“ die Aktion definiert werden, die durchgeführt werden soll. Derzeit mögliche Aktionen sind:
- „focus“: es wird auf ein Element fokussiert,
- „click“: es wird auf ein Element geklickt.