Dokumentation für phpMyFAQ 1.6.x

antisemitismus.net / klick-nach-rechts.de / nahost-politik.de / zionismus.info

[ phpMyFAQ 1.6.x Dokumentation ]

Einleitung
1. Lizenz
2. Support
3. Copyright
4. Spenden
Installation
Upgrade
Verwaltung
phpMyFAQ 1.6.x individualisieren
Und noch etwas

1. Einleitung

phpMyFAQ ist ein mehrsprachiges, komplett datenbankgestütztes FAQ-System. Es unterstützt verschiedene Datenbank-Engines zur Datenhaltung. Um diese Daten auszulesen, wird PHP 4.1.0 (oder höher) benötigt. phpMyFAQ bietet auch ein mehrsprachiges Content Management-System mit einem WYSIWYG Editor und einer Bilderverwaltung, eine flexible Mehrbenutzer-Unterstützung mit LDAP Support, eine wikiähnliche Änderungskontrolle, ein News-System, Benutzer-Verfolgung, Sprachmodule, alternative Inhalte senden, Vorlagen, extensiver XML-Support, PDF-Support, ein Backupsystem, eine dynamische Seitenübersicht, eingebauter Spamschutz, und ein einfach zu handhabendes Installationssystem.

Dieses Dokument soll Sie bei der Installation und Verwaltung von phpMyFaq unterstützen.

1.a. Lizenz

phpMyFAQ ist unter der Mozilla Public License Version 1.1 (MPL) veröffentlicht. Diese Lizenz garantiert Ihnen eine freie Benutzung von phpMyFAQ, Zugang zum Quellcode und das Recht phpMyFAQ zu modifizieren und zu verteilen.

Die einzige Einschränkung betrifft das Copyright, welches ausschliesslicht bei Thorsten Rinne und dem phpMyFAQ Team verbleibt. Jede veränderte phpMyFAQ Version fällt ebenfalls unter die Bedingungen der MPL. Alle übrigen Programme, welche möglicherweise nur auf bestimmte Funktionen von phpMyFAQ zugreifen, sind von diesen Einschränkungen nicht betroffen und können unter jeder Art von Lizenz veröffentlicht werden.

Eine kommerzielle Nutzung oder eine kommerzielle Verbreitung von phpMyFAQ, z.B auf CD-Roms, ist erlaubt, solange obige Bedingungen erfüllt werden.

Wir haben uns für die MPL als Lizenzmodell für phpMyFAQ entschieden, da wir glauben, dass diese einerseits einen guten Kompromiss zwischen Schutz der Offenheit und Freiheit darstellt sowie andererseits die Interaktion mit anderer Software, ungeachtet dessen Lizenzmodells, ermöglicht. Verglichen mit anderen Lizenzmodellen ist der Text der MPL kurz gehalten und auch für Neulinge einfach verständlich.

Diese Dokumentation ist unter einer Creative Commons License lizenziert.

1.b. Support

Besuchen Sie unsere Supportforen unter forum.phpmyfaq.de beim Auftauchen jeglicher Probleme anlässlich der Benutzung von phpMyFAQ . Es besteht kein telefonischer oder Emailsupport. Bitte unterlassen Sie es, uns anzurufen oder direkt anzuschreiben.

Das phpMyFAQ Team bietet die folgenden Dienstleistungen gegen Bezahlung an:

Individuelle Anpassungen
Support

Sind Sie interessiert? Wenn ja, schauen Sie auf unserer Supportseite vorbei.

1.c. Copyright

© 2001-2006 by Thorsten Rinne und phpMyFAQ Team unter der Mozilla Public License. Alle Rechte vorbehalten.

1.d. Spenden

Wenn Sie phpMyFAQ nützlich finden und dem Autor Ihre Wertschätzung ausdrücken wollen, so schauen Sie doch einmal auf Thorsten's amazon.de Wunschliste vorbei. Wir akzeptieren auch online Spenden mittels PayPal. Klicken Sie dazu auf untenstehenden Knopf.

2.Installation

2.a. Voraussetzungen für den Betrieb von phpMyFAQ

phpMyFAQ adressiert ein Datenbanksystem mittels PHP. Um die FAQ zu installieren benötigen Sie einen Webserver, welcher über folgende Voraussetzungen verfügt:

PHP
- ab Version 4.1.0 (empfohlen: PHP 4.4.2 oder PHP 5.1.2)
- register_globals = off (empfohlen)
- safe_mode = off
Webserver (Apache 1.3.x/2.0.x oder lighttpd oder IIS)
Datenbankserver
- MySQL 3.23.23+, 4.0.x, 4.1.x, 5.0.x, 5.1.x (empfohlen: 4.1.x)
- MySQL 4.1.x, 5.0.x, 5.1.x mit der PHP5 MySQLi Erweiterung (empfohlen: 5.0.x)
- PostgreSQL 7.2.x, 7.3.x, 7.4.x, 8.0.x, 8.1.x (empfohlen: 8.1.x)
- Sybase
- Microsoft SQL Server 2000, 2005
- IBM DB2 Universal Database 8.2.x, 9.0.x, IBM Cloudscape, und Apache Derby
- SQLite mit PHP5
- MaxDB 7.5 oder neuer (experimentell)
korrekt gesetzt: Zugangsberechtigungen, Owner, Gruppe

phpMyFAQ kann nur erfolgreich betrieben werden, wenn die PHP Direktive safe_mode auf off eingestellt ist. Weitere Randbedingungen betreffen die Direktiven open_basedir und disable_functions, welche in der zentralen php.ini oder httpd.conf gesetzt werden können.

Sofern PHP als Apache-Modul läuft, so müssen sie vor der Installation in der Lage sein einen chown (change owner) auf die Dateien anzuwenden. Die Dateien und Ordner müssen dem Apache User gehören.

Im Zweifelsfall können selbst feststellen, welche PHP-Version auf Ihrem Webserver installiert ist, indem Sie eine einfache Textdatei mit Namen info.php erstellen, die folgenden Inhalt hat:

<?php phpinfo(); ?>

Laden sie diese Datei auf Ihren Webspace hoch und rufen sie diese anschliessend mittels ihrem Browser auf.

Das Installationsscript überprüft ebenfalls, welche PHP Version auf ihrem Server installiert ist. Sollten die minimalen Voraussetzungen nicht erfüllt sein, so können Sie den Installationsprozess nicht beginnen.

Sollten sie PHP 3.0.x , PHP 4.0.x oder PHP 6.0.0-dev installiert haben, so können Sie phpMyFAQ nicht verwenden.

phpMyFAQ verwendet einen WYSIWYG Online-Editor. Dieser stützt sich auf eine nicht standardisierte JavaScript Eigenschaft, welche in Mozilla Firefox 0.7+ (alle Plattformen), Mozilla 1.3+ (alle Plattformen) und Internet Explorer 5.5+ für Windows implementiert ist. Somit funktioniert dieser Editor nur in einer dieser Browserversionen. Opera, Safari und Konqueror werden bis jetzt nicht unterstützt, sollten dies jedoch in zukünftigen Versionen werden.

2.b. Vorbereitungen

Entpacken sie bitte das heruntergeladene Archiv auf Ihre Festplatte.

Kopieren Sie alle ausgepackten Dateien in ein eigenes Verzeichnis auf ihrem Webserver, z.B. mittels FTP. Keine schlechte Idee ist vermutlich der Ordner /faq.

Wichtig:
In diesem Ordner werden Schreibrechte benötigt, um die Dateien data.php und config.php während der Installation zu konfigurieren. Dies ist der Fall wenn ihr PHP als CGI oder als mod_php mit der Option disabled safe-mode läuft. Das Installationsscript wird stoppen, sollte ihr Webserver nicht entsprechend konfiguriert sein.

Es kann hilfreich sein, dass der gesamte phpMyFAQ Ordner auf chmod 777 gesetzt wird um Probleme bei der Installation zu vermeiden. Sollten sie über eine sehr restriktive mod_php Installation verfügen, so sollten sie die Berechtigungen chmod 777 auch nach einer erfolgreichen Installation für die folgenden Dateien und Ordner beibehalten:

die Dateien data.php und config.php im Ordner inc/
der Ordner attachments/
der Ordner data/
der Ordner images/
der Ordner pdf/
der Ordner xml/

Alle übrigen Ordner sollten zu ihrer eigenen Sicherheit nicht über volle Schreibrechte für jedermann verfügen (z.B. chmod 755).

2.c. Installations-Skript

Öffnen sie ihren Browser und geben sie folgende URL ein:

http://www.beispiel.com/faq/install/installer.php

Ersetzen sie www.beispiel.com durch ihren eigenen Domain-Namen. Geben Sie nun auf der Installationsseite die Adresse ihres Datenbankservers ein (z.B. db.provider.com oder häufig auch localhost), ihren Datenbank-Benutzernamen sowie das dazugehörige Passwort und natürlich den Datenbanknamen. Die Datenbank muss vor dem Ausführen des Installationsskripts vorhanden sein. Sie können das Feld prefix leer lassen. Wenn sie vorhaben, mehrere FAQs in derselben Datenbank zu speichern, so müssen Sie ein Tabellenprefix verwenden (z.B. sport für eine Sport-FAQ, wetter für eine Wetter-FAQ, etc.). Beachten sie bitte, dass nur Buchstaben und der Tiefstrich "_" für ein prefix verwendet werden können.

Wenn ihr PHP mit der LDAP Erweiterung kompiliert wurde, so können sie ihre LDAP Informationen im Formular hinzufügen.

Wenn Sie mehrere FAQs erstellen wollen, so müssen sie diese in verschiedenen, unabhängigen Ordnern installieren (z.B. /faq1, /faq2, /faq3 etc.). Zudem können sie die gewünschte Standardsprache für Ihre FAQ definieren (Standard ist Englisch). Ebenfalls sollten sie ihren Namen, Mailadresse und - sehr wichtig- ihr Passwort für die spätere Verwaltung der FAQ angeben. Das Passwort muss zweimal eingegeben werden und muss mindestens 6 Zeichen lang sein. Klicken Sie danach auf den Button "install", um die Tabellen in ihrer Datenbank zu erstellen und zu initialisieren.

2.d. Erste Schritte

Um die FAQ aufzurufen geben sie folgende URL in die Adresszeile ihres Browsers ein:

http://www.beispiel.com/faq/index.php

Ihre FAQ wird sich leer und im Standardlayout präsentieren. Sie können das Aussehen von phpMyFAQ durch die Verwendung von Vorlagen verändern. Eine Beschreibung, wie dies bewerkstelligt werden kann finden sie weiter unten.

Um die FAQ zu konfigurieren gehen sie zu folgender URL:

http://www.beispiel.com/faq/admin/index.php

Geben Sie als Benutzernamen admin und das anlässlich der Installation definierte Passwort für das erste Login in den Verwaltungsbereich ein.

Variabeln, die nicht häufig ändern, können in der datei inc/constants.php angepasst werden. Folgende Angaben können sie ändern:

die Zeitzone Ihres Servers (Standard: 0:00 Stunden
die Timeoutdauer in der Verwaltungsseite (Standard: 30 Minuten)
der Startwert der Lösungs-ID (Standard: 1000)
der Wert für den Erhöhungsschritt der Lösungs-ID (Standard: 1)
die Anzahl der Einträge in den Top10 (Standard: 10)
die Anzahl der neuesten Einträge (Standard: 5)

2.e. Hinweise betreffend der Suchfunktion

Die boolesche Volltextsuche funktioniert nur mit MySQL und wenn bereits Einträge vorhanden sind (mind. 5 oder mehr). Der gesuchte Begriff darf nicht in mehr als 50% der Einträge vorhanden sein, sonst wird er automatisch von der Suche ausgeschlossen. Dies ist kein Fehler sondern eine gewollte Eigenschaft von MySQL. Beachten sie, dass sie MySQL 4.1 benötigen um eine boolesche Volltextsuche für Sprachen wie Arabisch, Chinesisch, Hebräisch, Koreanisch oder Japanisch durchzuführen.

2.f. Alternative Inhalte senden (automatic content negotiation)

phpMyFAQ wird vom Webserver nach Möglichkeit in der Standardsprache des Browsers ausgegeben. Um die Standardsprache in ihrem Browser festzulegen müssen sie eine Variable festlegen, die dem Webserver übergeben wird. Dies hängt vom verwendeten Browser ab.

Mozilla Firefox

Extras -> Einstellungen -> Erweitert -> Sprachen bearbeiten...

Mozilla/Netscape 4.x und neuere Versionen

Edit -> Preferences -> Navigator -> Languages

Safari
Safari benutzt die MacOS X Betriebssystemeinstellungen um die Standardsprache festzulegen
```
System preferences -> International -> Language
```

Opera
Meiste Windows-Versionen:

File -> Preferences -> Languages

Linux/*BSD Versionen 5.x und 6.x:

File -> Preferences -> Document -> Languages

Internet Explorer
Windows:

Tools or View or Extras -> Internet Options -> (General) Languages

MacOS:

Edit -> Preferences -> Web Browser -> Language/Fonts

2.g. PHP Einstellungen

Wenn Sie schreibenden Zugriff auf die php.ini Datei haben, so überprüfen sie bitte, ob die Variable file_upload = On gesetzt ist; andernfalls funktioniert der Datei-Upload für die Attachments nicht.

2.h. Aktivierung der mod_rewrite Unterstützung

Apache Webserver

Wenn Sie die Suchmaschinenoptimierung aktivieren wollen, so bennenen sie die Datei _.htaccess, welche sich im Wurzelverzeichnis ihrer FAQ befindet, nach .htaccess um. Anschliessend muss die mod_rewrite Unterstützung in der Konfigurationsseite des Verwaltungsbereiches aktiviert werden.

IIS Webserver

Wenn Sie die Suchmaschinenoptimierung aktivieren wollen, so bennenen sie die Datei _httpd.ini, welche sich im Wurzelverzeichnis ihrer FAQ befindet, nach httpd.ini um. Anschliessend muss die mod_rewrite Unterstützung in der Konfigurationsseite des Verwaltungsbereiches aktiviert werden.

lighttpd Webserver

Wenn Sie die Suchmaschinenoptimierung aktivieren wollen, so kopieren sie die rewrite Regeln in der Datei _lighttpd.conf in ihre lighttpd.conf. Anschliessend muss die mod_rewrite Unterstützung in der Konfigurationsseite des Verwaltungsbereiches aktiviert werden.

2.i. LDAP Unterstützung aktivieren

Wenn sie während der Installation die korrekten LDAP Informationen angegeben haben, so müssen sie LDAP in der Konfigurationsseite des Verwaltungsbereiches aktivieren. Danach liest phpMyFAQ den kompletten Benutzernamen sowie die Emailadresse aus LDAP und füllt diese Informationen automatisch in die Eingabeformulare der öffentlich zugänglichen FAQ ein.

2.j. PDF-Export

Nicht alle (X)HTML Tags werden vom PDF-Export unterstützt. Zur Zeit werden folgende Tags in den PDF-Dateien unterstützt:

fetter, schräggestellter und unterstrichener Text
Bilder
grundlegende Unterstützung von Tabellen
Listen <li>
<pre> wird mit Courier Schrift angezeigt
Unterstützung von <br>, <br /> und <p>
Unterstützung von <hr> und <hr />
Unterstützung von <sub> und </sub>

2.k. Firefox und IE7 Suchplugins

phpMyFAQ 1.6.x bietet Suchplugins für die Browser Mozilla Firefox und Microsoft Internet Explorer 7. Diese Plugins können im Verwaltungsbereich erstellt werden und jeder Besucher der öffentlich zugänglichen Seite von phpMyFaq kann diese danach installieren. Mit einem installierten Suchplugin können sie mit der in Mozilla Firefox or Microsoft Internet Explorer 7 oben rechts vorhandenen Suchbox die phpMyFAQ Installation durchsuchen. Für weitergehende Informationen betreffend Mozilla Firefox bitten wir sie die Homepage der Mozilla Foundation zu besuchen.

2.l. Statische Lösungs ID (solution ID)

Seit der Version 1.6.0, verwendet phpMyFAQ eine statische Lösungs ID, welche sich nie ändert. Diese ID wird neben der Frage eines FAQ-Eintrages angezeigt. Sie mögen sich fragen, wozu dies gut sein soll? Wenn sie z.B. einen Datensatz mit der ID 1042 haben, so ist es jetzt möglich, im Suchfeld der Volltextsuche nur die ID Nummer einzugeben und der entsprechende Datensatz wird umgehend angezeigt. Standardmässig beginnt die Nummerierung bei der ID 1000. Sie können diesen Wert jedoch beliebig in der Datei inc/constants.php ändern. Sie können dort auch den Erhöhungswert (Standard: 1) anpassen.

2.m. Spamschutz

Die folgenden Überprüfungen werden von phpMyFAQ 1.6.0 und neuer in den öffentlich zugänglichen Formularen vorgenommen:

Unerwünschte IP/Netzwerkadresse
Verbotene Wörter
Captcha Code

Eine unerwünschte IP/Netzwerkadresse kann in der Konfigurationsseite des Verwaltungsbereiches hinzugefügt oder entfernt werden. Wenn Sie verbotene Wörter aufnehmen wollen, so müssen sie diese in der Datei inc/blockedwords.txt speichern. Fügen sie bitte nur ein Wort pro Zeile ein.

3. Upgrade

Ein Upgrade auf phpMyFAQ 1.6.x ist von nachstehenden Versionen aus möglich:

phpMyFAQ 1.3.x
phpMyFAQ 1.4.x
phpMyFAQ 1.5.x

Haben sie eine ältere Version von phpMyFAQ installiert, so empfehlen wir Ihnen eine komplette Neuinstallation.

3.a. Upgrade von phpMyFAQ 1.3.x

Ein Upgrade von der Version 1.3.x nach 1.6.x ist ein wahrlich bedeutendes Upgrade. Bitte erstellen sie vor dem Upgrade eine Komplettsicherung! Nichtsdestotrotz ist das Update von phpMyFAQ 1.3.x zum aktuellen Release ziemlich einfach. Als erstes müssen sie alle Dateien löschen ausser:

die Dateien data.php und config.php im Ordner inc/
den Ordner attachments/
den Ordner data/
den Ordner images/
den Ordner pdf/
den Ordner xml/

Laden sie nun die Dateien der aktuellen Version auf ihren Webspace hoch und geben sie danach folgende URL in ihrem Browser ein:

http://www.beispiel.com/faq/install/update.php

Wählen sie die Version der aktuell installierten phpMyFAQ aus und klicken sie auf den Updateknopf, sodass ihre installierte Version automatisch aktualisiert wird. Möglicherweise verlieren sie die angefügten Bilder oder Dateien. Diese müssen sie mittels dem neuen Bildverwaltungstool wieder einfügen. Zusätzlich müssen sie ihre Kategorieren neu ordnen.

Nun müssen sie den BBCode von phpMyFAQ 1.3.x nach XHTML umwandeln, da phpMyFAQ den BBCode nicht mehr unterstützt. Dies geschieht durch ein Umwandlungsskript. Öffnen sie nachstehende URL in ihrem Browser:

http://www.beispiel.com/faq/install/bbcode2xhtml.php

Diese Umwandlung dauert möglicherweise mehrere Sekunden, da alle Einträge von BBCode nach XHTML geändert werden müssen.

Hinweis: Sie können nicht von MySQL auf eine andere Datenbank updaten.

3.b. Upgrade von phpMyFAQ 1.4.x

Das Update von Version 1.4.x ist ziemlich einfach. Laden sie alle Dateien des aktuellen phpMyFAQ Paketes auf ihren Webspace hoch mit Ausnahme:

der Dateien data.php und config.php im Ordner inc/
aller Dateien im Ordner template/ ausgenommen der Datei artikel.tpl.

Öffnen sie folgende URL in ihrem Browser:

http://www.beispiel.com/faq/install/update.php

Wählen sie die Version der aktuell installierten phpMyFAQ aus und klicken sie auf den Updateknopf, sodass ihre installierte Version automatisch aktualisiert wird.

Hinweis: Sie können nicht von MySQL auf eine andere Datenbank updaten. Sie müssen die RSS Links vom XHTML Header in die auf der Version 1.4.x basierenden Vorlagen hinzufügen. Ebenfalls müssen sie noch weitere Dinge in den Vorlagen hinzufügen. Lesen sie dazu bitte den Quelltext der neuen Vorlagen.

3.c. Upgrade von phpMyFAQ 1.5.x

Das Update von Version 1.5.x ist ziemlich einfach. Laden sie alle Dateien des aktuellen phpMyFAQ Paketes auf ihren Webspace hoch mit Ausnahme:

der Dateien data.php und config.php im Ordner inc/
aller Dateien im Ordner template/ ausgenommen der Datei artikel.tpl.

Öffnen sie folgende URL in ihrem Browser:

http://www.beispiel.com/faq/install/update.php

Wählen sie die Version der aktuell installierten phpMyFAQ aus und klicken sie auf den Updateknopf, sodass ihre installierte Version automatisch aktualisiert wird.

Wenn sie ein Update einer älteren als der Version 1.5.4 von phpMyFAQ vornehmen, so müssen sie folgende Zeilen in der Datei template/search.tpl hinzufügen:

{msgFirefoxPluginTitle}
{msgMSIEPluginTitle}

Wenn das Suchplugin für Firefox oder IE7 erstellt ist, so wird der Installationslink automatisch auf der Suchseite angezeigt.

Sie müssen ebenfalls folgenden Code in der index.tpl von

<form action="{writeSendAdress}" method="post">
<label for="suchbegriff">{searchBox}</label>
<input alt="search..." class="inputfield" type="text" name="suchbegriff" id="suchbegriff" size="18" /><br />
<input type="submit" name="submit" value="Go" class="submit" />
</form>

nach

<form action="{writeSendAdress}" method="get">
<label for="suchbegriff">{searchBox}</label>
<input alt="search..." class="inputfield" type="text" name="search" id="suchbegriff" size="18" /><br />
<input type="submit" name="submit" value="Go" class="submit" />
<input type="hidden" name="action" value="search" />
</form>

ändern.

Sie finden alle bis Version 1.6.x geänderten Dateien in der Datei docs/CHANGEDFILES.txt.

3.d. Upgrade von phpMyFAQ 1.6.x

Das Update von Version 1.6.x ist ziemlich einfach. Laden sie alle Dateien des aktuellen phpMyFAQ Paketes auf ihren Webspace hoch mit Ausnahme:

der Dateien data.php und config.php im Ordner inc/
aller Dateien im Ordner template/

Öffnen sie folgende URL in ihrem Browser:

http://www.beispiel.com/faq/install/update.php

Wählen sie die Version der aktuell installierten phpMyFAQ aus und klicken sie auf den Updateknopf, sodass ihre installierte Version autmatisch aktualisiert wird.

Wenn sie von einer älteren als Version als phpMyFAQ 1.6.1 updaten, so müssen sie nachstehenden String in die Datei template/search.tpl hinzufügen.

{msgMSIEPluginTitle}

Sie müssen ebenfalls folgenden Code in der index.tpl von

<form action="{writeSendAdress}" method="post">
<label for="suchbegriff">{searchBox}</label>
<input alt="search..." class="inputfield" type="text" name="suchbegriff" id="suchbegriff" size="18" /><br />
<input type="submit" name="submit" value="Go" class="submit" />
</form>

nach

<form action="{writeSendAdress}" method="get">
<label for="suchbegriff">{searchBox}</label>
<input alt="search..." class="inputfield" type="text" name="search" id="suchbegriff" size="18" /><br />
<input type="submit" name="submit" value="Go" class="submit" />
<input type="hidden" name="action" value="search" />
</form>

ändern.

Sie finden alle bis Version 1.6.x geänderten Dateien in der Datei docs/CHANGEDFILES.txt.

3.e. Anpassung der Vorlagen für phpMyFAQ 1.6.x

Die Vorlagen der Version 1.3.x sind nicht kompatibel mit phpMyFAQ 1.6.x. Bitte verwenden sie die Standard XHTML Vorlagen aus dem aktuellen Paket. Wenn sie für die Integration von phpMyFAQ in ihre bestehende Webseite Hilfe benötigen, so wenden sie sich an uns.

3.f. Migration

Voraussetzungen:

Eine Applikation, welche fähig ist csv Dateien zu exportieren
Vorkonfiguriertes phpMyAdmin, um die csv Dateien zu importieren
Eine neuere Backupkopie ihrer Datenbank

Wenn sie bestehende Daten in die phpMyFAQ migrieren wollen, dann empfehlen wir ihnen folgende Vorgehensschritte:

Notieren sie ihre Kategorien, um diese später leichter aufzufinden (oder drucken sie diese mit phpMyAdmin aus); sie finden diese Daten in der Tabelle xx_faqcategories. Wenn sie bis jetzt noch keine Kategorien erstellt hatten, so ist jetzt der Moment gekommen, diese zu erstellen, denn sie werden diese in weniger als einer Minute benötigen...
Starten sie ihre Kalkulationssoftware (z.B. OpenOffice, Excel, etc.)

Erstellen sie ein neues Blatt mit folgenden Spaltentiteln:

für phpMyFaq bis und mit 1.6.0:
id lang active keywords thema content author email comment datum

ab phpMyFaq 1.6.1:
id lang solution_id revision_id active keywords thema content author email comment datum

Sofern sie noch keine Daten in der phpMyFAQ Datenbank haben wird das "id" Feld von 1 an zählen. Andernfalls schauen in der Tabelle xx_faqdata nach um die höchste "id" herauszufinden von der an gezählt werden muss. Das feld "lang" enthält die bevorzugte Sprache der Datensätze. In meinem Fall finden sie dort "de" weil meine bevorzugte Sprache Deutsch ist. In die Spalte solution_id wird die Nummer der statischen Lösungs ID eingetragen. Bei einer leeren FAQ beginnt diese bei der Zahl 1000. Andernfalls suchen sie bitte in iherer Datenbank nach der höchsten ID von der an gezählt werden soll. Bei revision_id handelt es sich um die Version der des FAQ Eintrages, welcher neuerdings wikiähnlich verwaltet wird. Bei zu importierenden Daten ist dieser Wert auf "1" zu setzen. Setzen sie "active" auf "yes" (natürlich ohne Anführungszeichen), sonst werden die Daten in der FAQ später nicht angezeigt. Sie können "keywords" jetzt noch leer lassen, aber beachten sie, dass sie diese benötigen, wenn sie später nach Schlüsselwörtern suchen wollen. "thema" entspricht dem Topic, d.h. in anderen Worten der Frage. "content" enthält die Antwort zur gestellten Frage. "author" und "email" sollten selbsterklärend sein. "comment" kann den Wert "y" oder "n" enthalten. Ich bevorzuge "n", damit die Benutzer keine Kommentare abgeben können; der Entscheid liegt jedoch bei ihnen. Seien sie vorsichtig mit "datum" ,da dieser Wert sehr stark vom Format abhängt. Ein Beispiel würde so aussehen: 20050401090000, in anderen Worten: 4 Ziffern für das Jahr (2005), 2 Ziffern für den Monat (04), 2 Ziffern für den Tag (01), 2 Ziffern für die Stunden (09), 2 Ziffern für die Minuten (00) und 2 Ziffern für die Sekunden (00). Ihre Tabelle könnte nun so aussehen:

id lang [solution_id revision_id] active keywords thema content author email comment datum
1 de [1000 1] yes FAQ Gibt es eine bessere Lösung als phpMyFAQ? Nein! Hans Muster hans@muster.com n 20050401090101

Beachten sie bitte, dass Felder, die Zahlen enthalten, das Format "Zahl" mit 0 Dezimalstellen haben müssen. PhpMyAdmin könnte sonst falsche Werte enthalten. Nun sind sie bereit für den csv Export. Machen sie sich einen Gefallen und unterlassen sie alle Leerzeichen im Dateinamen, UNIX(e) könnten möglicherweise den Dateinamen nicht korrekt lesen.

Öffnen sie ihre phpMyAdmin URL und gehen sie zu ihrer phpMyFAQ Datenbank (auch wenn sie bisher leer war). Klicken sie unten auf der Seite auf den Link "import text file", wählen sie ihre csv Datei aus und klicken sie auf den "submit" Button.

Das wars. Sollten Sie auf grobe Probleme stossen, so ist jetzt der Moment gekommen die vorher angefertigte Sicherung wieder einzuspielen. Editieren sie anschliessend die importierten Datensätze und teilen sie diese den Kategorieren zu.

4. Verwaltung

Die Verwaltung von phpMyFAQ ist komplett browserbasiert. Der Verwaltungsbereich befindet sich unter der URL:

http://www.beispiel.com/faq/admin/index.php

Sofern sie ihr Passwort vergessen haben, können sie es zurücksetzen. Ein zufallsgeneriertes Passwort wird ihnen per Email zugestellt. Bitten ändern sie dieses nach erfolgreichem Login.

Nach Eingabe ihres Benutzernamens und Passwortes werden sie am System angemeldet. Auf der Startseite sehen sie das Verwaltungsmenu auf der Linken, etwas Besucherstatistik, Einträge und Kommentare auf der Rechten. Am Ende der Hauptseite sehen sie einen Knopf für Versionsinformationen. Wenn sie auf diesen Knopf klicken so wird die installierte phpMyFAQ Version die neueste Versionsnummer von der Seite www.phpmyfaq.de abfragen. In diesem Abfrageprozess werden keinerlei Daten gespeichert!

Das Menu enthält folgende Bereiche:

Startseite
Benutzerverwaltung
Kategorieverwaltung
Beitrag erstellen
Beiträge genehmigen
Beiträge editieren
News editieren
Offene Fragen bearbeiten
Bewertungsstatistik
Cookies
Sessions ansehen
Adminlog ansehen
Passwort ändern
Konfiguration ändern
Backup
FAQ exportieren
Suchplugins
Logout

4.a. Benutzerverwaltung

phpMyFAQ bietet im Verwaltungsbereichein ein flexibles Berechtigungsmanagement für verschiedene Benutzer. Es ist damit möglich, verschiedenste Rechte an Benutzer zu vergeben, welche sehr detailliert und spezifisch sind. Somit ist es beispielsweise möglich, dass ein bestimmter Benutzer Einträge verändern aber nicht löschen kann. Es ist sehr wichtig sich zu überlegen, welche Berechtigungen ein Benutzer tatsächlich benötigt. Ein Eintrag könnte nämlich auch durch Löschen des gesamten Textes im Editiermodus komplett entfernt werden (auch ohne Löschrechte). Die mögliche Anzahl an Benutzeraccounts wird von phpMyFAQ nicht beschränkt.

In der Hauptansicht der Beunutzerverwaltung sehen sie eine Übersicht aller aktiven Benutzerprofile, wobei eine Kombination von Einsen und Nullen die Berechtigungen des jeweiligen Benutzers darstellen. Die "1" bedeutet, dass der User über die entsprechende Berechtigung verfügt, die "0" hingegen, dass eine bestimmte Aktion nicht ausgeführt werden kann. Die Reihenfolge entspricht der Auflistung der Berechtigungen anlässlich des Erstellens oder Editierens eines Benutzerkontos.

Beachten Sie, dass neu erstellte Benutzerkontos über keinerlei Berechtigungen verfügen; diese müssen durch Editieren des Kontos hinzugefügt werden. Der admin Benutzer kann weder gelöscht noch kann dessen Name geändert werden.

4.b. Kategorieverwaltung

phpMyFAQ ermöglicht es ihnen verschiedene Kategorieren und verschachtelte Unterkategorieren für ihre FAQ zu erstellen. Sie können die Kategorien auch in einer anderen Reihenfolge anordnen. Es ist auch möglich, die Kategorien in verschiedenen Sprachen zu erstellen. Der besseren Übersicht halber sollten sie jeder Kategorie eine kurze Beschreibung hinzufügen.

4.c. Beitrag erstellen / Beiträge genehmigen / Beiträge editieren

Beiträge können direkt im Verwaltungsbereich erstellt werden. Diese werden standardmässig NICHT automatisch publiziert. Im Folgenden wird die Bedeutung der einzelnen Felder und Menueinträge erläutert:

Beitrag erstellen

Kategorie
Von diesem Feld hängt ab, wo in der FAQ Hierarchie der Eintrag sichtbar sein wird. Sie können eine odere mehrere Kategorien markieren, in welche das Beitragsthema passt. Wenn sie mehrere Kategorieren wählen wollen, so müssen sie diese zusammen mit der STRG Taste markieren.
Überschrift
Dies entspricht der Frage oder Titelzeile des Eintrages.
Text:
Der Text kann z.B. die Antwort auf eine Frage oder die Lösung zu einem Problem sein. Der Artikelinhalt kann mit dem enthaltenen WYSYWYG Editor (What You See Is What You Get) bearbeitet werden. Dazu muss JavaScript in ihrem Browser aktiviert sein. Mit dem vorhandenen Bildermanager können sie im Artikel beliebig Bilder oder Grafiken einfügen. Der Editor kennt die folgenden Tastaturkombinationen:
- CTRL-A - alles markieren
- CTRL-B - fett
- CTRL-I - schräg
- CTRL-U - unterstrichen
- CTRL-S - durchgestrichen
- CTRL-L - Ausrichtung links
- CTRL-E - einmitten
- CTRL-R - Ausrichtung rechts
- CTRL-J - Blocksatz
- CTRL-1 .. CTRL-6 - Titel (<h1> .. <h6>)
- CTRL-0 (zero) - von Word eingefügten Inhalt "bereinigen"
Attachment
Erst beim Editieren eines bestehenden Artikels können Attachments hochgeladen und dem Artikel hinzugefügt werden (z.B. zip-files, PDF-Dateien etc.)
Keywords
Keywords oder Schlüsselwörter sind für die Suche durch die Datenbank relevant. Es können alternative Suchbegriffe, welche eng mit dem Text verbunden sind und dort jedoch nicht direkt vorkommen, eingegeben werden, sodass der Artikel auch bei der Suche nach diesem Wort im Suchergebnis angezeigt wird. Es können auch nicht direkt mit dem Eintrag verbundene Begriffe eingegeben werden, sodass beispielsweise ein häufig falsch geschriebenes Wort doch zum gesuchten Eintrag führt.
Verfasser
Es kann ein Verfasser des Eintrages/Artikels angegeben werden.
E-Mailadresse
Dieser Eintrag ist wohl selbsterklärend.
Sprache
Sie können die Sprache, in welcher der Eintrag verfasst wurde, definieren. Standardmässig wird die in der Konfiguration eingestellte Standardsprache ausgewählt. Mehrsprachige Einträge können folgendermassen erstellt werden: Schreiben sie einen Artikel auf Deutsch (oder natürlich in einer anderen Sprache) und speichern sie diesen. Wählen sie nun im Menu den Eintrag Beiträge editieren und suchen sie ihren Artikel aus. Ändern sie nun die Überschrift, den Text und die Schlüsselwörter und passen sie die Sprache an (z.B. Französisch). Speichern sie den Beitrag erneut. Sie sehen nun beim weiteren Editieren beide Einträge in der Liste mit derselben ID, jedoch in verschiedenen Sprachen.
Eindeutige ID
Jeder Beitrag erhält automatisch eine sogenannte eindeutige ID (solution ID). Jeder Beitrag kann direkt durch Eingabe dieser ID im Suchfenster angezeigt werden.
Aktiviert?
Wenn ein Beitrag als "active" markiert ist, so ist dieser auf der öffentlichen Seite der FAQ sichtbar und wird auch bei der Suche miteinbezogen. Vorgeschlagene Einträge sind standardmässig deaktiviert um Missbrauch zu verhindern. Diese müssen vom Admin bewusst freigeschaltet werden.
Kommentare zulassen?
Wenn sie nicht wollen, dass die Besucher der FAQ öffentliche Kommentare zu den Artikeln abgeben können, so können sie diese Möglichkeit hier deaktiveren.
Geändert?
Wie in einem Wiki unterstützt phpMyFAQ 1.6.x für jeden Eintrag mehrere Versionen. Neue Versionen werden nicht automatisch erstellt, können jedoch durch Aktivieren des Radiobuttons Neue Revision erstellt werden. Die Vorversion des Eintrages wird in der Datenbank archiviert und die neue Version wird im öffentlichen Frontend angezeigt. Alte Versionen können wieder angezeigt werden wenn sie eine solche auswählen und als neue Version wieder speichern. Um mehrere Versionen zu sehen, müssen die Benutzerberechtigungen entsprechend eingestellt werden.
Datum
Datum der letzten Änderung des Artikels.
Geändert?
Dieses Feld kann Kommentare/Bemerkungen zu den vorgenommenen Änderungen im Beitrag enthalten. Das ist besonders nützlich wenn mehrere Administratoren die FAQ betreuen und somit rasch einen Überblick über die Entwicklung des Artikels benötigen. Die in diesem Feld eingegebenen Informationen bleiben im öffentlichen Frontend unsichtbar.
Changelog
Der Changelog zeigt vorangegangene Änderungen an inklusive User und Änderungsdatum.

Beiträge genehmigen
Alle Datenbankeinträge, die nicht aktiv sind (und somit auf der öffentlichen Seite der FAQ nicht angezeigt werden) werden hier aufgelistet. Von FAQ Besuchern vorgeschlagene Einträge werden ebenfalls hier angezeigt. Klicken sie auf diese Einträge, um sie zu bearbeiten. Ändern sie den Status auf "active", sodass der Artikel angezeigt wird. Sie können hier auch Einträge löschen (mit Sicherheitsabfrage).

Beiträge editieren
Alle vorhandenen Einträge werden hier angezeigt. Durch Anklicken eines Eintrages öffnet sich dasselbe Formular wie beim Erstellen eines neuen Beitrages, diesmal jedoch mit allen Angaben des gewählten Eintrages.

Sie können alle Einträge bearbeiten oder löschen. Beachten sie bitte, dass alte Versionen eines Beitrages nicht gelöscht werden.

4.d. News editieren

phpMyFAQ bietet die Möglichkeit, News auf der Startseite anzuzeigen. Hier können neue News erstellt, bestehende editiert oder gelöscht werden.

4.e. Offene Fragen bearbeiten

phpMyFAQ lässt Besuchern die Möglichkeit aktiv an der FAQ teilzuhaben, indem sie Fragen unterbreiten können. Jeder Besucher kann die offenen Fragen ansehen und möglicherweise auch beantworten. In diesem Teil des Verwaltungsbereiches können sie diese offenen Fragen "loswerden" oder übernehmen, selbst beantworten und somit der FAQ hinzufügen.

4.f. Bewertungsstatistik

Unterhalb von jedem FAQ Beitrag können die Besucher dessen Qualität mit Noten von 1 bis 5 bewerten (weobei 1 die schlechteste und 5 die beste Note darstellt). In der Statistik wird die durchschnittliche Benotung sowie die Anzahl der Benotungen für jeden bewerteten Artikel angezeigt. Um eine rasche Übersicht zu bieten werden Einträge mit einer schlechten Durchschnittsbewertung von 2 oder tiefer rot angezeigt. Eine Durchschnittsnote von 4 und höher erscheint in grün.

4.g. Cookies

phpMyFAQ kann die Logininformationen für den Verwaltungsbereich in einem Cookie abspeichern. Wenngleich dies sehr bequem ist, so ist dies natürlich ein potenzielles Sicherheitsrisiko. Benutzen sie Cookies nur, wenn sie sicher sind, dass keine anderen Personen denselben Computer benutzen.

4.h. Sessions ansehen

Diese Funktion erlaubt ihnen, sich einen Überblick über ihre Besucher zu machen. Jeder Besucher erhält eine ID wenn er die Startseite der FAQ besucht und dies für die ganze Dauer des Besuches. Mit diesen Angaben lässt sich feststellen, wie Ihre FAQ von den Besuchern genutzt wird und notwendige Anpassungen in Kategorieren, Beiträgen oder Schlüsselwörtern können durchgeführtn werden. Es besteht auch eine Suchfunktion mit welcher sie eine bestimmte IP, die Anzahl der minimalen Aktionen sowie das Besuchsdatum suchen können.

4.i. Adminlog ansehen

Der Adminlog zeigt alle von einem User im Verwaltungsbereich von phpMyFAQ vorgenommenen Aktionen auf. Sollten sie den Verdacht auf einen Eindringling haben, so können sie dies hier sicher feststellen.

4.j. Passwort ändern

Hier können sie ihr Passwort ändern. Es ist möglich, einem Benutzer dieses Recht zu verwehren, was sinnvoll bei Gruppenkonti ist. Um das Passwort ändern zu können, muss der Benutzer über die Berechtigung "Passwort ändern" verfügen.

4.k. Konfiguration bearbeiten

Hier können sie generelle Einstellungen von phpMyFAQ bearbeiten. Wollen sie mehrere Email Adressen eingeben, so müssen sie diese durch ein Komma trennen (",").

4.l. Backup

Mit der Backupfunktion können sie eine Kopie der gesamten Datenbank in eine einzelne Datei erstellen. Dies ermöglicht ihnen die FAQ nach einem Absturz wiederherzustellen oder auf einen anderen Server zu verschieben. Es ist empfehlenswert, regelmässig Backups ihrer FAQ zu erstellen.

backup data
Das Backup von allen Daten enthält alle Beiträge, Benutzer, Kommentare etc.
backup Logs
Die Besuchersessions und das Adminlog werden gespeichert. Diese Daten sind für den Betrieb von phpMyFAQ nicht notwendig und dienen nur statistischen Zwecken.

4.m. FAQ exportieren

Sie können den Inhalt ihrer FAQ in vier Formate exportieren:

als XML Datei
als XHTML Datei
als PDF Datei mit Inhaltsverzeichnis
als DocBook XML Datei

4.n. Suchplugins

Sie können den Titel und eine Beschreibung für ein Suchplugin (Firefox oder IE7) für ihre phpMyFAQ erfassen. Wenn sie den Titel oder die Beschreibung ändern wollen, dann erstellen sie das Plugin einfach neu.

Wenn sie ihr eigenes Favicon in der Firefox Suchbox anzeigen lassen wollen, so müssen sie die PNG Datei pmfsearch.png im Ordner images/ ersetzen. Andernfalls wird das phpMyFAQ Logo angezeigt.

4.o. Logout

Der Klick auf Logout beendet die laufende Session im Verwaltungsbereich. Sie sollten ein Logout vornehmen bevor sie ihren Browser schliessen um möglichen Exploits zuvorzukommen.

5. phpMyFAQ 1.6.x individualisieren

Code und Layout sind in phpMyFAQ 1.6.x beinahe komplett getrennt. Das Layout basiert auf verschiedenen Vorlagen, die sie nach eigenem Bedarf anpassen können. Die wichtigsten Vorlagendateien befinden sich im Ordner template/. Alle Originalvorlagen sind gültige XHTML 1.0 Transitional Dateien und wir benutzen keine Tabellen für das Layout.

Hinweis: Das Layout des Verwaltungsbereiches kann durch Änderungen der CSS Datei admin.css vorgenommen werden.

5.a. Die Datei template/index.tpl

Das Standardlayout von phpMyFAQ ist in der Datei index.tpl gespeichert. Dies ist eine normale HTML Datei, welche einige Variablen in geschwungenen Klammern als Platzhalter für Inhalte enthält.

Beispiel:

<span class="useronline">{userOnline}</span>

Der Templateparser der FAQ tauscht den Platzhalter {userOnline} gegen die aktuelle Anzahl an Besuchern der FAQ aus.

Sie können die Standardvorlage bei Bedarf ändern. Erstellen sie bitte eine Kopie der Originaldatei, sollte etwas schief laufen. Theoretisch können sie jeden Editor zum Verändern der Vorlagendateien benutzen. Tests mit Dreamweaver waren beispielsweise erfolgreich. Die Verwendung von Microsoft Frontpage, Adobe GoLive oder NetObjects Fusion kann die Vorlage zerstören, da diese Editoren den Quelltext verändern.

5.b. Die Datei template/style.css

Alle Formatierungen wie z.B. Schriftarten und Ähnliches kann in der CSS-Datei style.css geändert werden. Die Farben sind in der Datei colors.css definiert. Mehr Informationen zu CSS kann auf der offziellen W3C Webseite gefunden werden.

5.c. Mehr Vorlagen

Sie benötigen eine anderes Vorlagendesign oder mehr XHTML/CSS Eigenschaften? Schreiben sie uns ein Email und wir sprechen darüber.

6. Und noch etwas

Besten Dank für die Benutzung von phpMyFAQ! :-)

Autor: Thorsten Rinne
Co-Autoren: Stephan Hochhaus, Markus Gläser
Deutsche Übersetzung der engl. Dokumentation: Gian Antonio (Nino) Bolis
Last Change: 2006-05-01

© 2001-2006 phpMyFAQ Team

Diese Dokumentation untersteht einer Creative Commons Lizenz.

Spenden Sie mit PayPal - schnell, kostenlos und sicher!

haGalil^.com ist kostenlos! Trotzdem: haGalil kostet Geld!

Die bei haGalil onLine und den angeschlossenen Domains veröffentlichten Texte spiegeln Meinungen und Kenntnisstand der jeweiligen Autoren. Sie geben nicht unbedingt die Meinung der Herausgeber bzw. der Gesamtredaktion wieder.
	[Impressum] Kontakt: hagalil@hagalil.com haGalil - Postfach 900504 - D-81505 München 1995-2014 © haGalil onLine^®bzw. den angeg. Rechteinhabern Munich - Tel Aviv - All Rights Reserved