Willkommen > GBook > Installation
CMSimple-Plugins by QualiFIRE

Installation

1. Woher bekomme ich das Gästebuch?

Das Gästebuch Plugin GBook gibt es auf meiner Website als Download. Die aktuelle Version ist 0.8 beta. Das Gästebuch wird kontinuierlich weiterentwickelt. Es lohnt sich also immer mal wieder vorbeizuschauen, was es Neues gibt.

2. Was muss ich vor der Installation machen?

  1. In jedem Fall muss natürlich CMSimple installiert werden. Wer das noch nicht hat, kann es einfach und schnell von www.cmsimple.de oder www.cmsimple.org sowie www.cmsimple.com downloaden. Das normale CMSimple ist ausreichend.

  2. Als Weiteres muss der Plugin-Loader von Michael Svarrer oder der Plugin-Loader von CMSimple installiert werden. Ohne einen von Beiden läuft das Gästebuch auf keinen Fall.
    Der Plugin-Loader von Michael Svarrer ist verfügbar unter cmsimple.de/cmsimple/index.php?Plugins_%26amp%3B_Downloads und kann dort downgeloaded werden. Eine Beschreibung ist in der Zipdatei enthalten.
    Alternativ kann der Plugin-Loader von CMSimple 3.0 verwendet werden. Dazu muss von www.cmsimple.org/?Downloads:Old_versions die Version 3.0 (und nur diese) downgeloaded werden und die Datei index.php im Verzeichnis plugins in das Verzeichnis plugins entpackt werden.

3. Wie kann ich das Gästebuch installieren?

Die Zip-Datei im Bereich Download downloaden und in das Verzeichnis .cmsimpleplugins entpacken. Beim Entpacken ist darauf zu achten, dass die Unterverzeichnisse in der Zip-Datei erhalten bleiben. Nach dem Entpacken muss das so aussehen:

 +-plugins
| +-gbook
| +-config
| +-content
| +-css
| +-help
| +-images
| +-languages


Danach kann CMSimple gestartet und in den Admin-/Login-Bereich gewechselt werden. In der Liste der Plugins muss nun der Eintrag GBook vorhanden sein. Sonst ist was schief gegangen (Verzeichnisse kontrollieren).

4. Wie kann ich das Gästebuch verwenden?

4.1 Installation und Einbau

Für das Gästebuch sollte in CMSimple eine eigene Seite erstellt werden. Dies kann eine Hauptseite, erzeugt mit <H1>, oder Unterseiten, erzeugt mit <H2> oder <H3>, sein.
In eine eigene CMSimple-Seite wird das Gästbuch dann durch die Angabe
#CMSimple $output.= GBlist();#

oder

#CMSimple $output.= GBlist(cFilename);#

eingebunden. Der Text kann direkt hier aus der Beschreibung kopiert werden. Allerdings muss darauf geachtet werden, dass die Zeile im HTML-Quellcode nochmals kontrolliert wird und eventuelle Anweisungen gelöscht werden. Das Ergebnis sollte genau wie oben dargestellt aussehen. Steht hingegen

#CMSimple $output.= GBlist();#
sollten alle Anweisungen vollständig herausgelöscht werden, da diese zu Fehlern führen.

Die Angabe eines Dateinamens cFilename ist optional. Der Dateiname sollte keine Sprachangabe und keine Dateiendung haben, beides wird automatisch angehängt. Gibt man also als cFilename den String 'MyGuestbook' an, so wird eine Datei namens 'MyGuestbook_de.txt' bei Verwendung von Deutsch als Sprache angelegt. Die Aufteilung in verschiedene Sprachen kann durch die Option common_guestbook abgeschaltet werden. Ist diese Einstellung auf True gesetzt, wird kein Sprachenkürzel angehängt und alle Sprachen verwenden das selbe Gästebuch.

Wird kein Dateiname angegeben, setzt das GBook Plugin automatisch den String 'Guestbook' als Teil des Dateinamens ein.

Achtung:
Vergessen Sie nicht das Standard-Gästebuch von CMSimple in den Einstellungen zu deaktivieren. Andernfalls wird die Datendatei des Gästebuchs weiterhin mit Spam gefüllt (aber nicht mehr sichtbar).

4.2 Aufruf außerhalb der Menüstruktur

Soll das Gästebuch in gleicher Form eingebunden werden, wie das Standard-Gästebuch von CMSimple, also nicht in der normalen Menüstruktur, sondern als ein separater Aufruf, so muss folgendes getan werden:

Zunächst muss wie unter 4.1 beschrieben eine eigene Seite für das Gästebuch angelegt werden. Um das Gästebuch aber in der normalen Menüanzeige zu verbergen ist die zustzliche Anweisung hide notwendig. Somit sollte folgendes auf der Seite stehen:

#CMSimple hide #
#CMSimple $output.= GBlist(); #

Als nächstes muss im Template (Vorlagedatei) der vorhandene Gästebuch-Link eingebaut werden. Dazu muss der vorhanden Aufruf


ersetzt werden durch

Gästebuch

Dabei ist der Pfad, der für den Aufruf verwendet wird natürlich an die eigene Menüstruktur angepasst werden. In dem obigen Beispiel ist das Gästebuch im Hauptbereich Kontakt und dem Untermenü Gästebuch angelegt worden. Nun wird nicht mehr das Standard-Gästebuch von CMSimple aufgerufen, sondern das neue Gästebuch mit dem GBook-Plugin.

4.3 Aufruf im Mitgliederbereich (Memberpages)

Soll das Gästebuch in einen geschützen, nur für Mitglieder zugänglichen, Bereich eingebunden werden, so muss folgendes getan werden:

Zunächst muss wie unter 4.1 beschrieben eine eigene Seite für das Gästebuch angelegt werden. Um das Gästebuch aber in der normalen Menüanzeige zu verbergen (es soll ja nur für Mitglieder sichtbar sein) ist die zusätzliche Anweisung hide notwendig:

#CMSimple hide #

Als nächstes muss die entsprechende Anweisung für das Plugin Memberpages und GBook erfolgen. Diese müssen beide in einer #CMSimple ... # Anweisung aufgerufen werden:

#CMSimple $output.=memberspage("Keine_Berechtigung","0"); $output .= GBlist(); #

Somit wird zunächst die Berechtigung geprüft und anschließend, falls diese vorhanden ist, das Gästebuch angezeigt.

5. Kann ich mehrere Sprachen unterstützen?

GBook unterstützt die Verwendung mehrerer Sprachen. Es sind kein gesonderten Einstellungen notwendig. Gbook erkennt selbst welche Sprache verwendet wird und bietet das Gästebuch in der jeweils gewählten Sprache an. Die aktuell verwendete Sprache wird von CMSimple herangezogen.

Derzeit enthält das Plugin die nachfolgenden Sprachen:

Dänisch, vielen Dank an Per Kongebro
Deutsch
Englisch
Finnisch, vielen Dank an Ahti Kurki
Französisch, vielen Dank an Gerd Xhonneux
Italienisch, vielen Dank an Sandro Cavalieri Foschini
Niederländisch, vielen Dank an Gerd Xhonneux
Norwegisch, vielen Dank an Tobias Michel
Portugiesisch, vielen Dank an JoaoVr
Slowakisch, vielen Dank an Martin Sereday
Ungarisch, vielen Dank an Zsolt Kádas

Wenn die gewünschte Sprache nicht in der oben aufgeführten Liste dabei ist, so kann ganz einfach eine weitere Sprache hinzugefügt werden. Einfach eine bestehende Sprachendatei (z.B. de.php) kopieren, umbenennen in den entsprechenden Ländercode und die darin enthaltenen Texte übersetzen.

An dieser Stelle möchte ich "Vielen Dank" sagen zu allen, die mir ihre Übersetzungen zugesandt haben!

Wenn eine neue Sprachendatei erstellt wurde, würde ich mich sehr freuen diese zu erhalten. Ich werde sie in die nächste Version aufnehmen, der Autor wird namentlich genannt!


6. Konfiguration

Das Plugin GBook kann durch eine Vielzahl von Einstellungen individuell in Funktionalität und Erscheinungsbild angepasst werden.

Folgende Einstellungen können verändert werden:

date format:
time format:
captcha:
ask for email:
ask for website:
ask for title:
mandatory title:
mandatory email:
remove html:
items per page:
num of pages:
info mail:
thank mail:
thank sendfrom:
new entries:
spam words: alt, bitte nicht mehr verwenden
show creator:
show narrowlink:
show email:
show website:
show ip addr:
store ip addr:
use smileys:
blocked words:
blocked IPs:
blocked domains:
blocked countries:
common guestbook:
quarantine time:

date format: Diese Angabe wird verwendet für die Formatierung des Datum, an dem die Mitteilung eingetragen wurde. Die Formatierungsanweisung entspricht den Möglichkeiten des Befehls Date() aus PHP.

time format: Diese Angabe wird verwendet für die Formatierung der Zeit, zu der die Mitteilung erstellt wurde.

captcha: Der Captcha Kode ist ein fünfstellige Buchstaben- und Zahlenkombination, die von Benutzer eingegeben werden muss, wenn die Einstellung = True ist. Stimmt der Kode nicht mit dem ursprünglichen überein, wird der Gästebucheintrag nicht gespreichert. Diese Einstellung verhindert zuverlässig Spam-Einträge. Zulässige Eingabewerte sind True oder False.

ask for email: Damit wird festgelegt, ob ein Eingabefeld für die E-Mail Adresse des Besuchers angezeigt wird oder nicht. Zulässige Eingabewerte sind True oder False.

ask for website: Mit dieser Option wird festgelegt, ob ein Eingabefeld zur Eingabe der Homepage-Adresse des Besuchers angezeigt wird oder nicht. Zulässige Eingabewerte sind True oder False.

ask for title: Diese Option legt fest, ob ein Eingabefeld für die Eingabe eines Titels (Überschrift) für den Gästebucheintrag angezeigt wird oder nicht. Zulässige Eingabewerte sind True oder False.

mandatory title: Diese Option legt fest, ob die Eingabe eines Titels zwingend erforderlich ist oder nicht. Die Option darf nur dann auf True gesetzt werden, wenn auch die Option ask for title auf True gesetzt ist.

remove html: Diese Angabe legt fest, ob HTML-Kode, der möglicherweise in der Mitteilung enthalten ist, entfernt werden soll oder nicht. Zulässige Eingabewerte sind True oder False. In der Regel ist das Entfernen von HTML-Kode empfehlenswert, da damit böswillige Veränderungen, wie Umleiten auf Viren-Server etc. bekämpft werden kann.

items per page: Mit dieser Einstellung wird angegeben, wieviele Einträge pro Seite angezeigt werden sollen. Wird diese Anzahl überschritten, werden die Einträge auf eine oder mehrere Seiten verteilt.

num of pages: Diese Einstellung gibt an, wie viele Seiten-Verweise jeweils links und rechts der aktuellen Seitenzahl in der unteren Navigationszeile angezeigt werden sollen.

info mail: Dieses Feld enthält die E-Mail Adresse an die eine Benachrichtigung per E-Mail versandt wird, wenn ein neuer Eintrag im Gästebuch erstellt wurde. In diesem Feld können auch mehrere E-Mail Adressen, getrennt durch Kommata, aufgeführt werden. Die Benachrichtigung wird dann an jede der E-Mail Adressen versandt.

thank mail: Diese Option legt fest, ob der Besucher, der soeben einen Eintrag imGästebuch erstellt hat, eine Dankes-E-Mail erhält oder nicht. Zulässige Eingabewerte sind True oder False. Der Text dazu ist unter dem Bereich Sprache abgespeichert.

thank sendfrom: Dieses Feld enthält die E-Mail Adresse, unter der die Dank E-Mail versandt wird.

new entries: Hiermit kann das Erstellen von neuen Gästebucheinträgen ein- und ausgeschaltet werden. Zulässige Eingabewerte sind True oder False. Diese Option kann im Fall von Wartungsarbeiten oder akuten Problemen beim Erstellen neuer Beiträge eingesetzt werden. Normalerweise steht diese Option auf True.

spam words: Diese Option wird ab der Version 0.8 nicht mehr verwendet. Bitte stattdessen blocked words verwenden.

show creator: Am Ende des Gästebuchs wird ein Link auf den Autor angezeigt. Wenn dieser Eintrag nicht angezeigt werden soll, muss diese Option auf False gesetzt werden. Das Abschalten dieser Anzeige sollte nach Rücksprache mit dem Autor erfolgen. Zulässige Eingabewerte sind True oder False.

show narrowlink: Diese Option erlaubt das Ein- und Ausschalten der Links für "< Zurück" und "Weiter >". Zulässige Eingabewerte sind True oder False.

show email: Diese Option erlaubt die Anzeige der E-Mail Adressen der Gästebuch-Besucher ein- und auszuschalten. Zulässige Eingabewerte sind True oder False. Die Option hat keinen Einfluss darauf, ob die E-Mail Adresse abgefragt und gespeichert wird (siehe ask_for_email). Sie dient nur zur Einstellung der Anzeige.

show website: Diese Option erlaubt die Anzeige der Homepage Adressen der Gästebuch-Besucher ein- und auszuschalten. Zulässige Eingabewerte sind True oder False. Die Option hat keinen Einfluss darauf, ob die Homepage Adresse abgefragt und gespeichert wird (siehe ask_for_website). Sie dient nur zur Einstellung der Anzeige.

show ip addr: Diese Option erlaubt die Anzeige der IP Adressen der Gästebuch-Besucher ein- und auszuschalten. Zulässige Eingabewerte sind True oder False. Die Option hat keinen Einfluss darauf, ob die IP Adresse gespeichert wird (siehe store_ip_addr). Sie dient nur zur Einstellung der Anzeige.

store ip addr: Mit dieser Option kann festgelegt werden, ob die IP Addresse des Besuchers ermittelt und gespeichert werden soll. Zulässige Eingabewerte sind True oder False.

use smileys: Mit dieser Option kann die Untersützung von Smileys ein- und ausgeschaltet werden. Wird die Option eingeschaltet, so wird rechts oberhalb des Mitteilungsfelds ein Zeile der möglichen Smileys angezeigt. Klickt man eines davon an, wird automatisch der Smiley-Code in den Text eingefügt. Zulässige Eingabewerte sind True oder False.
Hinweise:
Die Smileys werden in der Mitteilung in der bekannten Notation, wie z.B. :-) oder 8-), dargestellt. Intern werden die Smileys aber in Code-Form abgespeichert. So wird aus :-) intern der Code :smile: oder aus 8o der Code :eek:. Somit können auch Smileys verwendet werden, bei denen Zeichen zum Einsatz kommen, die sonst als Steuerzeichen interprätiert werden.
Die Erkennung und Darstellung von Smileys in den Mitteilungen ist immer aktiv. Das heißt, wenn z.B. das Kürzel :-) einmal verwendet wurde und als :smile: in der Datendatei abgespeichert wurde, dann wird für den Besucher des Gästebuchs immer das Smiley angezeigt.

Liste der unterstützen Smileys:

Icon Benutzereingabe Interne Speicherung
smile :-) :) :smile:
happy :-)) :happy:
biggrin :-D :D :biggrin:
wink ;-) :wink:
cool 8-) :cool:
tongue :P :tongue:
rolleyes :rolleyes: :rolleyes:
eek 8o :eek:
confused ?( :confused:
frown :-( :( :frown:
crying ;-( :crying:
mad X( :mad:
evil :-> :evil:

blocked words: Hier können mehrere Begriffe aufgezählt werden, die vom Gästebuch Plugin GBook als Spam identifiziert werden sollen. Enthält ein Beitrag Wörter, die in den Bereich Blocked Words fallen, so wird dieser Beitrag nicht gespeichert und eine entsprechende Mitteilung angezeigt.
Diese Einstellung wird beim Erstellen neuer Beiträge und beim Import alter Gästebücher verwendet. Es sind Reguläre Ausdrücke erlaubt.

blocked IPs: Mit dieser Option kann festgelegt werden, ob die IP Addresse des Besuchers vor dem Speichern überprüft werden. Liegt die IP Adresse in einem der angegebenen Bereiche, so wird die Speicherung der Mitteilung abgelehnt. Es sind mehrere Angaben, getrennt durch das Zeichen | zulässig. Die Angabe kann als einzelne IP-Adresse, z.B. 127.0.0.1 (=localhost), oder als Adressbereich, z.B. 192.18.0.1-192.168.0.255, vorgenommen werden.

blocked domains: Mit dieser Option kann festgelegt werden, ob der Domain-Name oder Teile des Domain-Namens überprüft werden soll. Wird bei der Überprüfung eine Übereinstimmung festgestellt, so wird die Speicherung der Mitteilung abgelehnt. Es sind mehrere Angaben, getrennt durch das Zeichen | zulässig. Es sind Reguläre Ausdrücke erlaubt.

blocked countries: Durch diese Option kann festgelegt werden, ob das Land des Besuchers vor dem Speichern überprüft werden. Liegt eine Übereinstimmung vor, so wird die Speicherung der Mitteilung abgelehnt. Es sind mehrere Angaben, getrennt durch das Zeichen | zulässig. Es sind Reguläre Ausdrücke erlaubt.

Hinweis:
Wenn diese Option einen Suchstring enthält, dann muss auch das Paket IPFILES installiert sein. Dazu muss die Datei ipfiles.zip im Unterverzeichnis include extrahiert werden. Diese Datei muss zusätzlich heruntergeladen werden, sie ist nicht in der Zip-Datei von GBook enthalten.

common guestbook: Mit dieser Option kann festgelegt werden, ob für alle Sprachen ein gemeinsames Gästebuch verwendet werden soll. Zulässige Eingabewerte sind True oder False.

quarantine time: Mit dieser Option kann festgelegt werden, ob ein neuer Eintrag sofort oder erst nach einer bestimmten Zeit angezeigt werden soll. Die Angabe der Quarantänezeit ist in Stunden. Bis zum Ablauf der Zeit wird der Text $plugin_tx['gbook']['txt_quarantine_notice'] angezeigt. In dieser Zeit hat der Webmaster die Möglichkeit den Eintrag zu prüfen. Nach Ablauf der Zeit wird der Eintrag angezeigt. Durch Eingabe des Wertes 0 (null) wird diese Option abgeschaltet.

7. Anpassung des Layouts

Das Layout, also die Darstellung des Gästebuchs wird im Wesentlichen durch die Einstellungen in der Datei stylesheet.css im Ordner css geregelt. Dort sind sämtliche Farben und Fontgrößen festgelegt. Es sind vier verschiedene Farbdefinitionen bereits enthalten: Blau, Gelb, Grau und Grün. Diese können einfach durch Umbenennen der Datei von z. B. stylesheet.green.css in stylesheet.css verwendet werden.

Entsprechend zu diesen Farbdefinitionen sind auch passende Smileys im Lieferumfang von GBook enthalten. Die verschiedenfarbigen Smileys sind im Ordner images in den Unterordnern blue, green und yellow gespeichert. Diese müssen in den Ordner images kopiert werden. Wird beispielsweise das Stylesheet Gelb verwendet, so müssen alle Smileys aus dem Ordner yellow in den eine Stufe höher liegenden Ordner images kopiert werden.

Die Stylesheet-Datei kann selbstverständlich auch selbst angepasst werden. Die einzelnen Einträge bedeuten:
Klasse Beschreibung
td.gbtitle Formatierung der Titelzeile
td.gblightline Formatierung einer hellen = geraden Zeile im Gästebuch, also die Zeilen 2, 4, 6, 8, ...
td.gbdarkline Formatierung einer dunklen = ungeraden Zeile im Gästebuch, also die Zeilen 1, 3, 5, 7, ...
span.gbdatetime Formatierung von Datum und Uhrzeit
div.gbname Formatierung des Besucher-Namens
span.gbmessage Formatierung der Mitteilung
input.gbcaptcha Formatierung des Captcha-Codes
input.gbtextbox Formatierung aller einzeiligen Eingabefelder
input.gbmsgbox Formatierung des Mitteilungsfeldes

8. Wie kann ich ein bestehendes Gästebuch importieren?

Ab der Version 0.6 des GBook Plugins unter dem Abschnitt "GBook-Daten" die Funktion verfügbar. Sie ermöglich den Import des CMSimple Standard-Gästebuchs in das GBook Plugin. Somit gehen keine Einträge verloren obwohl auf ein anderes Gästebuch gewechselt wird.

Zum Importieren eines CMSimple Gästebuch zuerst die Schaltfläche drücken. Auf der nächsten Seite stehen mehrere Optionen zur Verfügung, die entscheidenden Einfluss auf die Qualität und den Erfolg des Imports haben. Das Standard-Gästebuch wird direkt als HTML-Text abgespeichert. Daher ist es recht schwierig herauszufinden, welcher Bereich in diesem Text beispielsweise der Autor oder das Datum eines Beitrags ist.

Es stehen folgende Optionen zur Verfügung:

Save-Options: Die Standard-Einstellung ist Append to GBook file . Damit werden alle Beiträge aus dem alten Gästebuch beim Import automatisch an das neue GBook Gästebuch angehängt. Enthält das GBook Gästebuch aber etwa nur Testeinträge, die sowieso gelöscht werden sollten, empfiehlt sich die Einstellung Overwrite existing GBook file . Damit wird die vorhandene GBook Gästebuch-Datei mit den Einträgen aus dem CMSimple-Standard-Gästebuch überschrieben, eventuell vorhandene Einträge in der GBook Gästebuchdatei gehen verloren.

Conversion Options: Die Option Use server name as username setzt als Author den Namen des Servers ein. Diese Option kann z.B. verwendet werden, falls die Erkennung des Authors nicht zuverlässig funktioniert, oder wenn der Author nicht direkt angezeigt werden soll.

Die Option Use Spam filter ermöglicht das automatische Ausfiltern von Spameinträgen beim Import. Die im Feld 'Blocked Words' enthaltenen Texte werden mit der Mitteilung eines jeden Gästebucheintrags verglichen. Trifft einer der Suchbegriffe davon zu, wird der Eintrag übergangen und nicht importiert.

Die Option Scan Format definiert in welchem Format die Datums- und Zeitangabe gespeichert wurde. Diese Einstellung kann nicht automatisch ermittelt werden und muss deshalb manuell eingetragen werden.
Mögliche Werte sind z.B.:
%s, %d. %d. - wenn das Datum im Format März, 13. 2006 angegeben ist
%d.%d.%d - wenn das Datum im Format 24.03.2006 angegeben ist

Die Option Parameter order legt fest, in welcher Reihenfolge die Werte für Tag, Monat, Jahr, Stunde, Minute und Sekunde angegeben sind. Die Zahl 1 steht für den Tag, 2 für den Monat, 3 für das Jahr, 4 für die Stunden, 5 für die Minuten und 6 für die Sekunden.

Mit der Option Value for Posted kann der vordefinierte String für das Feld 'Posted' geändert werden. Das ist z.B. erforderlich beim Einsatz von CMSimple Plus, da dabei im Quellcode noch der Text ' am ' an das Feld 'posted' angehängt wird.

Other Options: Der Debug Mode erlaubt die zusätzliche Ausgabe weiterer Informationen zum Import. Diese können inbesondere bei Fehlern oder nicht korrekt erkannten Daten sehr hilfreich sein.

Info: Die hier angezeigten Felder Used Date Format und Used GBook language file dienen zur Info und können nicht geändert werden.

Wenn alle Einstellungen vorgenommen wurden und der Import gestartet werden, bitte auf die Schaltfläche klicken.
Falls nicht, weil z.B. der Import später erst gemacht werden soll, einfach auf klicken um zum GBook Gästebuch Editor zurückzukehren.

Als letztes muss der Import durch Drücken der Schaltfläche abgeschlossen werden. Der Inhalt des neuen Gästebuchs wird im Textfeld angezeigt und kann gegebenenfalls noch nachbearbeitet werden.

9. Wofür ist die Funktion Reorg?

Im Bereich Administration ist ab der Version 0.7 die Funktion verfügbar. Sie erlaubt eine Reorganisation der Gästebuch-Datei. Dabei werden zwei Fälle bereinigt:
  • Das mehrfach vorkommende Zeichen /// wird entfernt
  • Einfache Smileys, wie etwa :-) werden gewandelt in die interne Darstellung, also z.B. :smile:
Die Funktion Reorg korrigiert immer nur die Gästebuchdatei der jeweils aktuellen Sprache. Ist man also gerade im englischen Bereich der Website, so wird auch nur das englische Gästebuch reorganisiert. Um anschließend das deutsche Gästebuch zu bearbeiten, muss man sich also abmelden, in den deutschen Bereich wechseln und dort nochmals im Bereich Administration - GBook - die Funktion Reorg ausführen.

Es wird empfohlen vor der Ausführung der Funktion eine Sicherung der Gästebuchdatei durchzuführen!

powered by cmsimple.dk - template by Jens Bröcher Webdesign