(Opens in a new window - öffnet in einem neuen Fenster)
Kurz-Dokumentation Plugin "PagedataVars"
Version PagedataVars 1.0 - released 12/2015
Das Plugin PagedataVars stellt seitenbezogene Variablen zur Verfügung, hauptsächlich zur Nutzung im Template.
Anwendungsbeispiele: Seitenspezifisches Kopfbild oder seitenspezifische Newsboxen im Template.
Die Beschriftungen der Felder und die Hilfetexte können in der Sprachdatei an den jeweiligen Einsatzfall angepasst werden.
PagedataVars ist gedacht für die Konfiguration durch einen versierten Programmierer oder einen erfahrenen CMSimple Anwender.
Einmal eingerichtet und sinnvoll konfiguriert, ist das Plugin über einen zusätzlichen Tab über dem Editor auch von wenig erfahrenen Anwendern einfach zu nutzen.
Zielgruppe sind also Webdesigner und Agenturen, die mittels CMSimple Internetseiten für Kunden erstellen und einrichten, die von diesen dann selbst gepflegt und verwaltet werden. Erfahrene Anwender schaffen das aber auch selbst ;-)
1. Systemvoraussetzungen
Voraussetzung ist eine funktionierende Installation von CMSimple 4.2 oder höher.
Empfohlen wird die aktuelle Version von CMSimple.
2. Installation
- zip-Datei herunterladen und mit einem geeigneten Programm entpacken
- Laden Sie die komplette Ordner-Struktur des Verzeichnisses "plugins" in das Verzeichnis "plugins" Ihrer CMSimple Installation hoch.
- Vergeben mit Ihrem ftp-Programm die erforderlichen Lese- und Schreibrechte für Ordner und Dateien.
3. Datei- und Ordnerrechte
Damit das Programm funktioniert und arbeiten kann (bzw. administrierbar ist), müssen für bestimmte Dateien und Ordner bestimmte Schreib- und Leserechte vergeben werden.
Dateien: chmod 666
- ./plugins/pagedata_vars/languages/alle Dateien
- ./plugins/pagedata_vars/css/stylesheet.css
Ordner: chmod 777
- ./plugins/pagedata_vars/languages/
- ./userfiles/plugins/pagedata_vars/pagedata_var01/
- ./userfiles/plugins/pagedata_vars/pagedata_var02/
- ./userfiles/plugins/pagedata_vars/pagedata_var03/
- ./userfiles/plugins/pagedata_vars/pagedata_var04/
- ./userfiles/plugins/pagedata_vars/pagedata_var05/
- ./userfiles/plugins/pagedata_vars/pagedata_var06/
4. Die Variablen
PagedataVars stellt für jede Seite die Variablen $pagedata_var01 bis $pagedata_var06 zur Verfügung, sobald sie in der Plugin Konfiguration aktiviert werden. Diese Variablen sind im Template nutzbar.
Die Variablen können auch wie folgt aufgerufen werden: $pd_current['pagedata_var01']
5. Aktivierung der Variablen
Die Variablen können einzeln aktiviert werden, maximal 6 Variablen stehen zur Verfügung. Die Aktivierung erfolgt in der Plugin Konfiguration:
- Leeres Feld - Variable ist deaktiviert
- pdv_folder - Eine Selectbox bietet alle Dateien, die im Ordner dieser Variablen abgelegt sind, zur Auswahl an
- pdv_input - Die Variable ist über ein Eingabefeld befüllbar
- pdv_textarea - Die Variable ist über eine Textarea befüllbar
Wenn in der Plugin Konfiguration der Editor aktiviert wird, werden alle Textareas mit einem Editor ausgestattet, der dem in der CMS Konfiguration für den Inhaltsbereich definierten Editor entspricht.
Die Ordner für die Selectboxen liegen im userfiles Ordner, so können die Dateien mit dem CMSimple Filebrowser hochgeladen und verwaltet werden, Beispiel: ./userfiles/plugins/pagedata_vars/pagedata_var01/ für die Variable $pagedata_var01.
Sonderfall: Werden in ein Feld durch Kommata getrennte Werte eingegeben, wird das Feld selbst ausgewertet, ein Array erzeugt und eine Selectbox aus den Array Elementen erstellt. Das Trennzeichen (Komma) kann in der Plugin Konfiguration geändert werden.
ACHTUNG! Nach den Kommata dürfen keine Leerzeichen eingegeben werden! Nach dem letzten Element wird kein Komma gesetzt.
6. Subsites und Zweitsprachen
Das Plugin erkennt selbst, ob im Verzeichnis einer Subsite oder Zweitsprache der Datenpfad zu den Datenordnern angelegt ist.
Wenn nicht, arbeitet das Plugin automatisch mit den Datenordnern im userfiles-Verzeichnis der Hauptinstallation.
7. Hilfetexte und Beschriftung der Eingabefelder
Die Beschriftung der Felder und die Hilfetexte können in der Sprachdatei des Plugins angepasst werden.
8. Nutzung des Plugins
Der Anwender kann das Plugin einfach über einen zusätzlichen Tab oberhalb des Editors nutzen. Zuvor sollte das Plugin durch einen erfahrenen Programmierer oder einen erfahrenen CMSimple Anwender für den vorgesehenen Verwendungszweck eingerichtet werden.
9. Anwendungsbeispiele
Die Funktion pdvars() wertet die Plugin Konfiguration und die Variable aus:
<?php echo pdvars('Nummer der Variablen','Fallback'); ?>
- Nummer der Variablen: 01 ... 06
- Fallback: Standard Wert der Variablen für den Fall, dass die Variable nicht belegt (leer) ist (kann weggelassen werden).
Experten können die Variablen $pagedata_var01 bis $pagedata_var06 natürlich auch ohne diese Funktion verarbeiten. Sie haben für die jeweilige Seite immer den im Tab oberhalb des Editors ablesbaren Wert.
9.1. Beispiel: seitenspezifisches Bild im Template
Hier gibt es ein Codebeispiel für ein seitenspezifisches Bild im Template, z. B. geeignet für ein seitenspezifischen Headerbild:
<img src="<?php echo pdvars('01','standard.jpg'); ?>" alt="Header Image">
Das Beispiel nutzt die Variable $pagedata_var01 im src Attribut. Wenn diese Variable auf einer Seite nicht definiert (nicht belegt, leer) ist, wird die standard.jpg angezeigt.
Das Verzeichnis für die Headerbilder ist das Verzeichnis der Variablen im in der Plugin Konfiguration definierten Pfad.
Ist kein seitenspezifisches Bild definiert, wird das Bild standard.jpg aus dem der Variablen zugeordneten Verzeichnis geladen (Fallback).
9.2. Beispiel: seitenspezifische Newsbox im Template
Hier gibt es ein Codebeispiel für eine seitenspezifische Newsbox im Template:
<?php echo newsbox(pdvars('02','News01')); ?>
Das Beispiel nutzt die Variable $pagedata_var02. Wenn diese Variable auf einer Seite nicht definiert (nicht belegt, leer) ist, wird die versteckte Seite News01 angezeigt.
In der Plugin Konfiguration wird die Möglichkeit einer durch Kommata getrennten Liste genutzt, um dem Anwender die zur Verfügung stehenden Newsbox Seiten in einer Selectbox zur Auswahl anzubieten. Bitte beachten: keine Leerstelle nach einem Komma.
Ist auf einer Seite keine Newsbox definiert, wird die versteckte Seite News01 angezeigt (Fallback).