kitCommands

kitCommands

Ein kitCommand verbindet ihr Content Management System mit dem #kitFramework und führt je nach Bedarf einen einfachen Befehl oder ein komplexes Anwendungsprogramm aus. kitCommands können in jedem #WYSIWYG Abschnitt einer Seite, in einem #Template oder auch innerhalb von Erweiterungen oder Add-ons ausgeführt werden.

Es wird eine spezielle Textauszeichung (Markup) verwendet, die das kitCommand kennzeichnet. Unmittelbar vor der Ausgabe der Seite, des Templates oder der Erweiterung in dem sich ein kitCommand Markup befindet, wird dieses herausgefiltert, der dazugehörige Code ausgeführt und das Ergebnis an Stelle des kitCommand eingefügt.

Das Markup für ein kitCommand:

  • beginnt immer mit zwei aufeinanderfolgenden Tilden ~~,
  • gefolgt von einem Leerzeichen,
  • danach dem Bezeichner für das kitCommand (Groß- oder Kleinschreibung spielt keine Rolle)
  • optional, jeweils durch ein Leerzeichen getrennt, einer oder mehrere Parameter
  • zum Abschluß des Markup wieder ein Leerzeichen und
  • zwei aufeinanderfolgende Tilden ~~.

Ein kitCommand in einem WYSIWYG Abschnitt eintragenBeispiel:

~~ help ~~

Dieses Markup führt das kitCommand Help aus, das Ihnen die allgemeine Hilfe zu den kitCommands anzeigt. Die allgemeine Hilfe erläutert Ihnen den generellen Gebrauch von kitCommands und beschreibt Parameter, die für jedes kitCommand zur Verfügung stehen, u.a. Parameter zum Setzen von kanonischen Links, zum Laden einer jQuery Bibliothek oder zum Verwenden eines bestimmten Templates. kitCommands lassen sich sehr flexibel und vielseitig einsetzen.

Parameter werden jeweils mit einem Leerzeichen Abstand angegeben und werden grundsätzlich von einer öffnenden und einer schließenden eckigen Klammer [] gefolgt, die einen oder mehrere Werte enthalten kann:

~~ Event action[list] ~~

Bei dem Namen des Parameter spielt eine Groß- oder Kleinschreibung keine Rolle, bei den übergebenen Werten kann die Groß- oder Kleinschreibung jedoch relevant sein - dies ist von den Vorgaben für das jeweilige kitCommand abhängig. Im obigen Beispiel wird dem kitCommand Event der Parameter action mit dem Wert list übergeben: action[list].

Error: Can't execute the kitCommand: xyz ...Welche Parameter für das jeweilige kitCommand zur Verfügung stehen erfahren Sie über die Hilfedatei des kitCommands, die Sie jederzeit durch Einfügen des Parameter help[] aufrufen können:

~~ Event help[] ~~

Wenn der Aufruf für ein kitCommand den help[] Parameter enthält, wird das kitCommand grundsätzlich nicht ausgeführt sondern in jedem Fall die Hilfedatei angezeigt - es spielt also keine Rolle, ob der kitCommand Markup weitere Parameter enthält, diese werden ignoriert.

kitCommand mit dem Parameter debug[]Falls bei der Ausführung eines kitCommand ein Fehler auftritt, erhalten Sie eine kurze Mitteilung (siehe Screenshot), die Ihnen allerdings nicht allzuviel über die Ursachen verrät (die Besucher der Website sollen lediglich sehen, dass ein Fehler aufgetreten ist, jedoch keine technischen Informationen erhalten). Zur Fehlersuche können und sollten Sie dem kitCommand den Parameter debug[] übergeben. Das kitCommand wird Ihnen daraufhin eine genauere Beschreibung des Fehlers liefern (siehe Screenshot) die vor allem für den Programmierer wichtige Hinweise enthält.

In dem Artikel Liste und Kurzbeschreibung der verfügbaren kitCommands erhalten Sie einen Überblick, welche kitCommands bereits für das kitFramework verfügbar sind.

Aktuelle Veröffentlichungen zu dem Thema kitCommands

Mit imageTweak eine FlexSlider Galerie erstellen

Mit imageTweak eine FlexSlider Galerie erstellen

Die Ergänzung von imageTweak mit einer Funktion zum Erstellen von Bildergalerien wurde lange gewünscht. Mit dem FlexSlider hält die erste Galerie Einzug in imageTweak.

Liste und Kurzbeschreibung der verfügbaren kitCommands

Liste und Kurzbeschreibung der verfügbaren kitCommands

In diesem Artikel geben wir Ihnen einen Überblick über die im kitFramework verfügbaren kitCommands und stellen sie Ihnen kurz vor.