- - - By CrazyStat - - -

CMSimple_XH (1.6.X) Dokumentation



(Version 1.0.7 vom 13.11.2017)

Sie sind hier: Startseite > Architektur > Plugins > Grundsätzliches und Anforderungen

5.4.1 • • Grundsätzliches und (System-)Anforderungen

Alle CMSimple_XH Plugins müssen mindestens eine der beiden Markupsprachen unterstützen:

  • H für HTML 4.01 Transitional
  • X für XHTML 1.0 Transitional
  • XH für Plugins die für beide Markupsprachen valide sind.

Seit der CMSimple_XH Version 1.2 müssen alle Plugins utf-8 (utf-8 ohne BOM) codiert sein.

Grundlegende Anmerkungen für Plugins die nicht mit der CMSimple_XH Installation ausgeliefert werden:
Mit dem Plugin sollte immer eine Plugin Dokumentation enthalten sein, in der folgendes mindestens beschrieben ist:

  • welche Ordner (Verzeichnisse) vollständig in den Ordner plugins/ in der CMSimple_XH-Installation kopiert werden müssen.
  • Welche Dateien und Ordner beschreibbar sein müssen.
  • Wenn Plugins bestimmte Ordner und Dateien außerhalb des plugins/ Ordners benötigen, ist deren Verzeichnis und Dateien mit den entsprechenden Zugriffsrechten anzugeben.
  • Welcher Dateityp, bzw. Markup Sprache unterstützt wird (html, xhtml oder beide).
  • Konfiguration des Plugins
  • Einbindung des Plugins in die CMSimple_XH Installation und deren Nutzung auf bzw. in den Seiten.

Falls diese Informationen nicht der Dokumentation entnommen werden können, sind sie beim Plugin Entwickler zu erfragen.
Mehr über die Kennzeichnung von CMSimple_XH Templates und Plugins erfahren Sie hier:
http://www.cmsimple-xh.org/wiki/doku.php/de:code_conventions

Bei der Einbindung von Plugins ist zu beachten, dass einige Plugins nach ihrer erfolgreichen Installation von selbst vom CMS erkannt werden (es wird automatisch ein kanonischer Link im Kopfbereich des HTML-Quellcodes eingefügt), allerdings benötigen die meisten Plugins einen Aufruf einer Funktion mit bestimmten Parametern. Weiterführende Informationen sind der jeweiligen Plugin Dokumentation zu entnehmen.
Diese Informationen sollten beispielsweise in einer Datei "readme.txt" im Plugin-Wurzelverzeichnis, in einer Datei "help_de.htm" im Unterverzeichnis "help/", oder auf der Website des Herstellers zur Verfügung stehen.
Viele Plugin Entwickler verzichten allerdings auf eine detaillierte Beschreibung der Konfigurations-Möglichkeiten und regeln das über Tooltipps, die sich hinter einem kleinen blauen Fragezeichen-Symbol in der Plugin Konfiguration verbergen.

Grundsätzliche Installationshinweise für ein neues Plugin
Die Installation eines neuen Plugins wird sich in der Regel an folgenden Punkten orientieren:

  • Anhand der vorgefundenen Dokumentation …
    • wird die Kompatibilität mit CMSimple_XH geprüft.
    • Entspricht das Plugin den XH-Standards und ist es utf8 codiert?
    • werden der Installationsort und die Zugriffsrechte auf Ordner und Dateien genannt?
    • Ist die Konfiguration des Plugins und dessen Einbindung in die Seiten beschrieben?
  • Das Plugin von der Website des Entwicklers, bzw. Anbieters auf den eigenen PC herunterladen und entpacken.
  • Gegebenenfalls eine lokale Vorkonfiguration des Plugins durchführen und anschließend in das vorgesehene Verzeichnis der CMSimple_XH Installation auf dem Webserver hochladen.
  • In den Adminbereich von CMSimple_XH einloggen und im Menü "Plugins" das entsprechende Plugin auswählen.
  • Anhand der Plugin Dokumentation die Konfiguration des Plugins durchführen.
  • Anhand der Plugin Dokumentation die Plugin Funktionalitäten (in die Seite(n)) einbinden.
  • Test der gesamten CMSimple_XH Installation, ob das Plugin den Beschreibungen des Entwicklers und den eigenen Erwartungen entspricht und auch die restliche CMS Installation fehlerfrei funktioniert.

Beachte:
Aus Gründen der Übersichtlichkeit und Sicherheit sollten nur die Plugins installiert werden und bleiben, die wirklich gebraucht werden!
Plugins die nur zum testen installiert worden sind, sollten danach wieder deinstalliert werden.
Weiterhin wird empfohlen beim Plugin-Entwickler regelmäßig nach Updates und bekannten Problemen zu suchen und auch ggf. gezielt nachzufragen, damit die betreute CMSimple_XH Installation immer auf dem aktuellen Stand ist.
Der reguläre Plugin-Aufruf {{{PLUGIN:name_of_the_function(parameters);}}} kann seit CMSimple_XH 1.6 in der verkürzten Version {{{name_of_the_function(parameters);}}} aufgerufen werden. Seit CMSimple_XH 1.6.5 kann in der verkürzten Version auch das Semikolon  entfallen und die runden Klammern sind optionale Angaben.

Weiterführende Informationen zu den Code Konventionen befinden sich im Kapitel 5.8 (Konventionen für valides (X)HTML).