Einleitung

Dies ist die Dokumentation für michfrm.net Wunschbox. Sie enthält alle Informationen die man zur Benutzung wissen sollte. Diese Dokumentation wurde zuletzt für Version 0.2 aktualisiert.

System

Zum ordnungsgemäßen Betrieb des Skripts werden folgende Komponenten in der genannten Version benötigt:

Webserver (Apache empfohlen)
PHP ab Version 5 (5.2.x empfohlen)
MySQL Datenbank ab Version 4 (5.x empfohlen)

Installation

Ab Version 0.2 gibt es einen Assistenten für die Installation, daher wird hier nicht näher darauf eingegangen. Version 0.1 erstellt bei einer korrekten config.php automatisch die nötige Tabelle.

Manuelle Installation

Sollte es Probleme mit dem Setup geben ist auch eine manuelle Installation möglich. Dafür muss eine config.php mit folgendem Inhalt angelegt werden:

<?php
$config = array (
  'db_host' => 'Hostname',
  'db_user' => 'Benutzername',
  'db_pass' => 'Passwort',
  'db_name' => 'Datenbankname',
  'db_prefix' => 'Tabellenpräfix'
);
>

Erklärung der einzelnen Werte:

db_host
Hostname des Datenbankservers
db_user
Benutzername für den Zugriff auf den Datenbankserver
db_pass
Passwort für den Zugriff auf den Datenbankserver
db_name
Name der Datenbank
db_prefix (ab Version 0.2)
Präfix für die Datenbanktabellen
table_name (nur Version 0.1)
Name der Datenbanktabelle
acp_pass (nur Version 0.1)
Passwort für die Verwaltungsoberfläche

Im Ordner setup befindet sich die Datei shemal.sql. Diese enthält den SQL-Code der für die Erstellung der Tabellen notwendig ist. Vor dem Import in die Datenbank mit einem Tool wie phpMyAdmin muss jedes Vorkommen von {:PREFIX} durch den Tabellenpräfix ersetzt werden.

Als nächstes muss noch ein Administrator-Account erstellt werden. Dies kann mit dem Passwort-Reset-Tool erledigt werden. Laden Sie es auf Ihren Webserver hoch, rufen Sie es auf und folgen Sie den Anweisungen. Damit ist die manuelle Installation abgeschlossen.

Update

Ein direktes Update von Version 0.1 auf Version 0.2 ist nicht möglich. Löschen Sie alle Dateien der alten Version und laden Sie die der neuen hoch. Bei der Installation können Sie alle Datensätze der alten in die neue Tabelle kopieren.

Administration

Die Administration erreichen Sie über die acp.php im Wunschbox-Ordner. Die Administrationsoberfläche benötigt für den Login und alle weiteren Funktionen aktiviertes Javascript. In der Übersicht können Sie ungelesene und gelesene Wünsche verwalten.

Alle neuen Wünsche werden als ungelesen markiert, bis diese mit einem Klick auf "gelesen" als gelesen markiert werden. Über den gelben Button können Wünsche markiert werden und über das rote Kreuz komplett gelöscht werden.

Benutzer

In der Navigation rechts oben können Sie zur Benutzerverwaltung wechseln. Sie benötigen lediglich für Personen, die die Verwaltungsoberfläche betreten sollen, einen Benutzeraccount. Wünsche eintragen können alle Gäste.

Erstellen

Über die Box "Benutzer erstellen" können Sie neue Benutzerkonten anlegen. Dazu geben Sie einen Benutzernamen, das Passwort zum Login und ggf. den Administrator-Status an. Mit einem Klick auf "Speichern" wird der Benutzer angelegt und die Liste neu geladen.

Bearbeiten

Es ist momentan nicht möglich, nachträglich den Benutzernamen zu ändern. Sie können jedoch das Passwort ändern, indem Sie in der Benutzerverwaltung in der Zeile des Benutzerkontos auf "Passwort ändern" klicken oder Ihr eigenes direkt über die Listenansicht.

Löschen

Über den Link "Löschen" können Sie einen Benutzer sofort aus der Datenbank löschen. Angemeldete Benutzer die gelöscht werden sollen wird jegliche weitere Anfrage verweigert.

Administratoren

Hat ein Benutzer das Administrator-Recht kann er selbst Benutzer verwalten. Der erste Administrator kann weder gelöscht noch entmachtet werden.

Sie können einen Benutzer zum Administrator ernennen indem Sie in der Spalte Administrator ein Häkchen machen. Bei Veränderung der Checkbox wird der neue Status automatisch in der Datenbank gespeichert.

Passwort-Reset-Tool

Falls der erste Administrator sein Passwort vergessen sollte, kann dies mit dem Passwort-Reset-Tool zurück gesetzt werden. Außerdem können mit dem Skript alle vorhandenen Administratoren gelöscht sowie neue Administratoren erstellt werden.

Front-End

Das Front-End ist über die Datei index.php erreichbar, kann jedoch nach belieben umbenannt werden, solange sie nicht verschoben wird. Über das Front-End können Gäste neue Wünsche in die Datenbank eintragen.

Das Front-End ist über Templates beliebig veränderbar. Alle Templates für Wunschboxen müssen mit "wunschbox_" beginnen. Das Standard-Template heißt wunschbox_default.php und befindet sich im Ordner tpl. Über den Parameter tpl kann auch ein anderes Template ausgewählt werden.

Beispiel (anzeige des Templates alternativ.php):
http://example.com/wunschbox/index.php?tpl=alternativ

Widgets

Widgets sind kleine Javascripts die in Webseiten eingebunden werden können um zusätzliche Funktionen zu ermöglichen. Bei der Wunschbox lädt das Widget einen IFrame in welchem die Wunschbox angezeigt wird.

Einbindung

Die Einbindung eines Widgets ist sehr einfach. Kopieren Sie dieses Codestück an die Stelle, an der die Wunschbox später angezeigt werden soll. Sie können die Größe der Box über die widget.php einstellen. Standardmäßig nutzt die Wunschbox die volle mögliche Breite und eine Höhe von 300 Pixel. In späteren Versionen ist eine Einstellmöglichkeit über das ACP bzw. das Template geplant.

<script type="text/javascript"
    src="http://example.com/wunschbox/widget.php">
</script>

Über den Parameter tpl können Sie eine andere Template-Datei zur Anzeige auswählen. Alle Templates für Widgets müssen mit "widget_" beginnen.

Um beispielsweise die Datei widget_alternativ.php anuzeigen, benutzen Sie diesen Code:

<script type="text/javascript"
    src="http://example.com/wunschbox/widget.php?tpl=alternativ">
</script>

Anpassung

Ähnlich der Templates des Front-Ends lassen sich auch Widgets über Templates anpassen. Das Standard-Widget heißt widget_iframe.php und befindet sich auch im Ordner tpl. Die Widgets müssen vollständige HTML-Seiten enthalten.

Bekannte Probleme

Die Administration funktioniert nicht mit dem Internet Explorer (getestet mit Version 6 und 7). Da der IE nur unverständliche Fehlermeldungen ausgibt ist eine Korrektur dieses Problems von meiner Seite nicht zu erwarten. Ich empfehle daher einen standardkonformen Webbrowser wie Mozilla Firefox oder Opera.

Support

Für weitere Fragen besuchen Sie bitte die Webseite der Wunschbox auf scripts.michfrm.net