Benutzerhandbuch

Benutzerhandbuch
Gästebuch Software - YellaBook v1.0
http://www.yellabook.de
Stand: 01.08.2012
© by YellaBook.de - Alle Rechte vorbehalten.
Inhalt
1 Funktionen …................................................................................................................ 3
2 Systemanforderungen …............................................................................................... 4
3 Installation …................................................................................................................. 4
4 Einbinden des Gästebuchs …....................................................................................... 5
5 Einstellungen …............................................................................................................. 6
6 Mehrsprachigkeit …....................................................................................................... 7
7 Sicherungen ….............................................................................................................. 8
8 Anpassen des Designs ….............................................................................................. 8
© by YellaBook.de - Alle Rechte vorbehalten.
1
Funktionen
Allgemeine Funktionen
Mehrsprachigkeit (verwendete Sprache einstellbar)
Unterstützt bis zu 100.000 Einträge
ansprechendes Design
funktioniert auch ohne JavaScript
flexible und unkomplizierte Einbindung via Link, iframe oder PHP-Include
Design über Stylesheet und Templates anpassbar
XHTML- und CSS Validität
funktioniert ohne Datenbank
Listenansicht
einstellbare Anzeige von Gästebucheinträgen pro Seite
Seiten-Navigation
Anzeige von Smileys
E-Mail-Adressen durch zeitliche Kontrolle vor Bots geschützt
Verfassen neuer Einträge
Verwendung von Smileys
konfigurierbare Zeichenlänge für Eingabefelder
2-fach Spamschutz durch zeitliche Kontrolle und verstecktem Feld
keine lästigen Captchas
Vorschau-Funktion
auf Wunsch mit Benachrichtigungs-E-Mail bei Neueintrag
sofortige Anzeige von Neueinträgen oder erst nach Freischaltung
Admin-Bereich
geschützter Adminbereich
Freischalten / Löschen von Einträgen
Kommentieren von Einträgen
Konfiguration des Gästebuchs (z. B. Sprachauswahl, Benachrichtiungs-E-Mail, etc.)
Backup-Funktion
© by YellaBook.de - Alle Rechte vorbehalten.
2
Systemanforderungen
Für eine erfolgreiche Gästebuch-Installation müssen folgende Voraussetzungen erfüllt
sein:
PHP5
FTP-Zugang zum Server
Sie müssen die Befugnis dazu haben, Datei-Rechte anzupassen
Wenn Sie per E-Mail über Neueinträge informiert werden möchten, muss der Server
das Versenden von E-Mails über die PHP-Funktion „mail()“ unterstützen.
3
Installation
1. Laden Sie sich das Gästebuch-Skript herunter.
2. Laden Sie die entpackten Dateien via FTP in den Root-Ordner des Servers
3. Folgende Dateien/Ordner benötigen die Rechte 777:
◦ guestbook/data/
◦ guestbook/data/data.txt
◦ guestbook/data/config.php
© by YellaBook.de - Alle Rechte vorbehalten.
4
Einbinden des Gästebuchs
Sie können das Gästebuch über per Link, iframe oder PHP-Include auf Ihrer Seite
einbinden.
Einbinden per Link
Am einfachsten ist die Einbindung des Gästebuchs per Link. Fügen Sie dazu einfach
folgenden Code an die gewünschte Stelle Ihrer Website ein und passen Sie ggf. die
Bezeichnung „Gästebuch“ an:
<a href="guestbook.php">Gästebuch</a>
Einbinden per iframe
Sie können das Gästebuch auf Ihrer Website auch via iframe einbinden. Der Vorteil: das
Gästebuch erscheint im Rahmen Ihrer Website und nicht als eigenständige Seite. Die
Navigation Ihrer Website wird weiterhin angezeigt. Fügen Sie dazu einfach diesen Code in
Ihre Website ein:
<iframe src="guestbook.php" width="700" name="guestbook" id="guestbook"
style="border: none;">
<p><a href="guestbook.php">Gästebuch</a></p>
</iframe>
Sie können die Breite des iframes anpassen, indem Sie den Wert „700“ bei width=“700“
verändern.
Einbinden per PHP-include
Wenn Ihre Website mit PHP umgesetzt wurde und Sie Kenntnisse in PHP besitzen,
können Sie das Gästebuch auch per PHP-include einbinden. Nutzen Sie dazu folgenden
Code:
require_once('guestbook.php');
Binden Sie das Gästebuch mit dieser Variante ein, müssen Stylesheet und ggf. der
Zeichensatz Ihrer Website angepasst werden. Das Gästebuch ist in UTF-8 umgesetzt.
Sollten Sonderzeichen fehlerhaft angezeigt werden, liegt es daran, dass der Zeichensatz
Ihrer Website nicht UTF-8 Ist. Das Stylesheet finden Sie hier: guestbook/style.css.
Informationen zum Anpassen des Styesheets finden Sie im Kapitel 8.
© by YellaBook.de - Alle Rechte vorbehalten.
5
Einstellungen
Um das Gästebuch zu konfigurieren, müssen Sie sich im Admin-Bereich anmelden. Sie
erreichen diesen, indem Sie in Ihrem Browser folgenden Link aufrufen (ersetzen Sie
„ihredomain.de“ mit Ihrer eigenen Domain): http://ihredomain.de/guestbook/
Die Standard-Zugangsdaten lauten:
Benutzername: gbadmin
Passwort: gbpass
Gästebuch-Einstellungen
Die Einstellungen des Gästebuchs können Sie unter „Einstellungen“ vornehmen.
Ändern Sie bitte als erstes den Standard-Benutzernamen und das Passwort für den
Admin-Bereich!
Möchten Sie bei neuen Einträgen per E-Mail informiert werden, geben Sie Ihre E-MailAdresse an und aktivieren Sie den Punkt „E-Mail bei Neueintrag senden“. Beachten Sie
bitte den Hinweis unter Kapitel 2 „Systemanforderungen“.
Unter „Sprache“ können Sie die Sprache Ihres Gästebuchs auswählen. Wenn Sie – wie
in Kapitel 6 beschrieben – eine neue Sprache hinzufügen, wird diese hier automatisch mit
gelistet.
Bei „Einträge pro Seite“ können Sie angeben, wie viele Einträge in der Listen-Ansicht pro
Seite erscheinen sollen.
Sie können festlegen, ob neue Einträge sofort angezeigt werden sollen oder erst nach
Ihrer Freigabe. Dies gibt Ihnen die Möglichkeit, Einträge vor der Freischaltung zu prüfen.
In den Einstellungen haben Sie außerdem die Möglichkeit, für jedes Feld die maximale
Zeichenanzahl festzulegen.
Die Einstellungen werden übernommen, sobald Sie den Speicher-Button betätigt haben.
Einträge freigeben, löschen und kommentieren
Klicken Sie links auf „Einträge“, um alle vorhandenen Einträge einzusehen. Auch hier
können Sie sich über die Seiten-Navigation zu einer bestimmten Seite navigieren.
Damit ein Eintrag in Ihrem Gästebuch angezeigt wird, muss die Box bei „Eintrag
anzeigen“ in dem Eintrag aktiviert werden. Wollen Sie einen Eintrag ausblenden,
deaktivieren Sie die Box einfach.
Sie können einen Eintrag löschen, indem Sie auf den Löschen-Button klicken.
Möchten Sie einen Kommentar zu einem Eintrag verfassen, schreiben Sie den Text in das
entsprechende Textfeld unter dem Eintrag. Auch hier können Sie Smileys einfügen.
Um die Änderung für einen Eintrag zu übernehmen, klicken Sie auf den entsprechenden
Speicher-Button.
© by YellaBook.de - Alle Rechte vorbehalten.
6
Mehrsprachigkeit
Das Gästebuch unterstützt Mehrsprachigkeit in dem Sinne, dass Sie in den Einstellungen
festlegen können, in welcher Sprache das Gästebuch erscheint. Das Wechseln zwischen
den Sprachen für die Seitenbesucher ist nicht vorgesehen.
Die Sprach-Dateien befinden sich im Ordner guestbook/lang/. Hier befinden sich
standardmäßig die Sprachdateien für Englisch und Deutsch. Sie können die vorhandenen
Texte ändern, indem Sie die Datei in einem Texteditor öffnen und nach dem Ändern
abspeichern.
Als Texteditor empfehlen wir Ihnen die kostenlosen Programme Notepad bzw.
Notepad++. Von der Verwendung des systemeigenen Editors von Windows raten wir
ab.
Um eine neue Sprache einzufügen, kopieren Sie einfach eine bestehende Sprach-Datei
und benennen Sie diese in die entsprechende Sprache um. Verwenden Sie für den
Dateinamen bitte nur Kleinbuchstaben ohne Sonderzeichen und Leerzeichen!
Bearbeiten Sie die Datei anschließend in einem Texteditor (siehe oben), um die Texte
auszutauschen.
Hinweis:
Wenn die Texte Sonderzeichen enthalten, achten Sie darauf, dass die Datei im UTF-8
Zeichensatz erstellt und gespeichert wird!
Beispiel zum Ändern eines Textes
Sie möchten den Text „Ins Gästebuch eintragen“ in „Eintragen“ ändern.
1. Öffnen Sie die Datei guestbook/lang/german.php in einem Texteditor.
2. Suchen Sie die Zeile, die den entsprechenden Text beinhaltet:
<text name="create_new_entry">Ins Gästebuch eintragen</text>
3. Ändern Sie nur den Text „Ins Gästebuch eintragen“ zwischen > und <!
4. Die Zeile sollte nun wie folgt aussehen:
<text name="create_new_entry">Eintragen</text>
5. Speichern Sie die Datei.
© by YellaBook.de - Alle Rechte vorbehalten.
7
Sicherungen
Die Datei mit den Gästebuch-Einträgen befindet sich im Ordner guestbook/data/data.txt.
Sie können diese sichern, indem Sie die Datei über FTP herunterladen oder über die
Backup-Funktion im Admin-Bereich.
Die Backup-Funktion finden Sie in der linken Navigation im Admin-Bereich, nachdem Sie
sich dort angemeldet haben. Klicken Sie auf der Seite „Backup“ einfach auf den Link
„Backup herunterladen“ und speichern Sie die Datei auf Ihrem Rechner.
Wenn Sie eine Sicherung wieder herstellen wollen, überschreiben Sie die Datei
guestbook/data/data.txt einfach via FTP. Achten Sie darauf, dass die Datei volle Rechte
(777) besitzt!
8
Anpassen des Designs
Sie können das Design des Gästebuchs anhand eines Stylesheets und HTML-TemplateDateien bearbeiten. Um das Design anzupassen sind Grundkenntnisse in CSS und HTML
notwendig.
Stylesheet
Das Stylesheet befindet sich hier: guestbook/style.css. Wenn Sie das Gästebuch mit
einem iframe oder per Link einbinden, wird das Stylesheet automatisch eingebunden und
verwendet. Beim Einbinden über PHP-include müssen Sie Ihr eigenes Stylesheet um
die Angaben in der Datei ergänzen oder die Datei zusätzlich in Ihrer Website
einbinden.
Beispiele für Anpassungen im Stylesheet
Suchen Sie im Stylesheet nach dem linken Ausdruck und ersetzen Sie den
entsprechenden Wert im rechten Ausdruck!
maximale Breite des Gästebuchs von 650px auf 750px ändern:
body{
-->
max-width: 650px;
…
body{
max-width: 750px;
...
© by YellaBook.de - Alle Rechte vorbehalten.
Farbe des Kopfes der Einträge ändern von #DEF1FE (hellblau) zu #FFD896 (orange)
.gb_entry_header{
background: #DEF1FE;
...
-->
.gb_entry_header{
background: #FFD896;
...
Templates
Möchten Sie nicht nur den Style, sondern die HTML-Struktur des Gästebuchs anpassen,
müssen Sie die HTML-Templates bearbeiten. Diese finden Sie unter
guestbook/templates/.
Die Datei body.html beinhaltet das HTML-Gerüst des Gästebuchs mit dem HTMLHeader und dem Body. Dieser Inhalt wird nicht ausgegeben, wenn Sie das Gästebuch
via PHP-include einbinden!
Folgende Punkte müssen beim Bearbeiten der HTML-Templates berücksichtigt werden,
damit das Gästebuch weiterhin funktioniert:
Texte im Format ###PLATZHALTER### sind Platzhalter und dürfen nicht geändert
werden
◦ Komplett klein geschriebene Platzhalter sind Platzhalter für Texte aus den
Sprach-Dateien
◦ Komplett groß geschriebene Platzhalter sind Platzhalter für entsprechende
Werte / Inhalte
IDs dürfen in Templates nicht geändert werden, da sie für JavaScript-Funktionen
benötigt werden.
Klassen dürfen beliebig geändert bzw. gelöscht werden.
© by YellaBook.de - Alle Rechte vorbehalten.