[ Dokumentation ](Gültig für die Version: 1.3.0 und später)
Die phpMyFAQ ist ein mehrsprachiges, komplett datenbankgestütztes FAQ-System. Als Referenzdatenbank wird derzeit MySQL (weitere Datenbank-Managementsysteme in Vorbereitung) genutzt, als Schnittstelle PHP 4.1.0 und höher. Die phpMyFAQ bietet ein Content Management System, eine umfangreiche Benutzerverwaltung, ein Newssystem, UserTracking, Sprachmodule, Template-System, umfangreiche XML-Unterstützung, PDF-Support, ein Backup-System und ein Installationsskript. Diese Dokumentation hilft Ihnen bei der Installation und Nutzung der phpMyFAQ. Die phpMyFAQ unterliegt der Mozilla Public License Version 1.1, kurz MPL. Diese Lizenz garantiert Ihnen die freie Nutzung von phpMyFAQ, Zugang zum Sourcecode und das Recht, die phpMyFAQ zu modifizieren und weiterzugeben. Die einzigen Einschränkungen bestehen darin, dass Sie das Urheberrecht von Bastian Pöttner und Thorsten Rinne nicht antasten können und dass modifizierte Versionen der phpMyFAQ automatisch unter die MPL fallen. Ein anderes Programm (in der Lizenz als "greater work" bezeichnet), das die phpMyFAQ lediglich über die bekannten Schnittstellen anspricht, bleibt davon unberührt und kann unter jeder beliebigen Lizenz vertrieben werden. Einer kommerziellen Nutzung oder dem kommerziellen Vertrieb der phpMyFAQ, z.B. auf CD-ROM zusammen mit anderer Software, steht bei Einhaltung dieser Bedingungen nichts im Wege. Wir haben uns für die MPL entschieden, weil sie aus unserer Sicht einen guten Kompromiss zwischen dem Schutz der Offenheit und der freien Verfügbarkeit einerseits, und des Zusammenspiels mit fremder Software unter beliebigen Lizenzen andererseits darstellt. Ihr Text ist im Vergleich zu anderen Lizenzen kurz, präzise und auch für Laien verständlich. Falls Sie Probleme mit der phpMyFAQ haben sollten, dann finden Sie unter www.phpmyfaq.de ein Supportforum. Support per Telefon oder E-Mail gibt es nicht, bitte sehen Sie auch davon ab, uns anzurufen. © 2001 - 2003 by Bastian Pöttner and Thorsten Rinne under the Mozilla Public License. Die phpMyFAQ spricht über PHP4 eine MySQL-Datenbank an. Für die Installation benötigen Sie einen Webspace mit folgenden Features:
Welche Version von PHP4 und MySQL Sie haben, können Sie relativ einfach herausfinden. Erstellen Sie eine Datei mit dem Namen info.php mit folgendem Inhalt: <?php phpinfo(); ?> Diese Datei laden Sie per FTP in Ihren Webspace und rufen Sie über Ihren Browser auf. Dort erhalten Sie dann die PHP- und MySQL-Versionsinformationen. Ausserdem überprüft unser Installationskript noch Ihre Versionen von PHP und MySQL; eine Installation ist nur möglich, wenn Sie eine geeignete Version von PHP und MySQL nutzen. Sollten Sie nur PHP3 oder PHP 4.0.x zur Verfügung haben, so können Sie die phpMyFAQ leider nicht nutzen. Die FAQ-Seiten können Sie mit einem Browser ab der dritten Generation (z.B. Netscape 3.01) betrachten, um die Stylesheet-Formatierungen zu sehen, benötigen Sie einen aktuellen Browser (z.B. Netscape 6 oder Internet Explorer 5.0). Desweiteren sollte für die Printfunktion JavaScript aktiviert sein. Die Printfunktion funktioniert im Internet Explorer übrigens erst ab Version 5. Bitte entpacken Sie die heruntergeladene ZIP-Datei auf Ihrer lokalen Festplatte. Eine Übersicht aller Dateien der phpMyFAQ finden Sie in der Datei phpmyfaq.txt. Das Layout der phpMyFAQ können Sie über die Templates verändern, eine Beschreibung hierfür finden Sie weiter unten in der Dokumentation. Kopieren Sie anschließend alle Dateien per FTP in ein Verzeichnis in Ihrem Webspace, z.B. in das Verzeichnis faq/. Starten Sie Ihren Browser und tippen folgende URL ein: http://www.ihredomain.de/faq/install/installer.php www.ihredomain.de ersetzen Sie dabei bitte durch Ihren Domainnamen. Wenn die Seite geladen ist, tragen Sie bitte Ihren MySQL-Server (z.b. db.provider.de), Ihren MySQL-Benutzernamen, Ihr MySQL-Passwort und Ihren MySQL-Datenbanknamen ein. Die Datenbank muss dabei bereits vorhanden sein. Der Tabellenprefix kann leergelassen werden. Falls Sie mehrere FAQs auf einer Datenbank einsetzen wollen, so müssen Sie dort einen geeigneten Prefix eintragen (z.B. sport für eine Sport-FAQ oder wetter für eine Wetter-FAQ). Bitte beachten Sie, dass Sie nur Buchstaben und Unterstriche ("_") für den Prefix nutzen können. Wenn Sie mehrere FAQs auf einer Datenbank nutzen wollen, müssen Sie jede phpMyFAQ-Installation ein ein neues Verzeichnis (z.B. faq1/, faq2/, faq3/ usw.) kopieren. Ausserdem können Sie nun auch Ihre Sprache vorgeben, als Standard ist hier Englisch aktiv. Desweiteren sollten Sie Ihren Namen, Ihre E-Mailadresse und - sehr wichtig - Ihr Passwort eintragen. Das Passwort müssen Sie zweilmal eingeben und es muss mindestens sechs Stellen lang sein. Anschließen klicken Sie auf den Button Installieren und die SQL-Tabellen der FAQ werden installiert. Ist die Installation fehlerfrei verlaufen, ist Ihre Version der phpMyFAQ einsatzbereit. Bitte löschen Sie anschließend den Inhalt des Verzeichnisses /install! Den öffentlichen Bereich der FAQ können Sie über den Aufruf http://www.ihredomain.de/faq/index.php testen, Ihre FAQ ist aber noch leer und erscheint im Standardlayout. Um nun Ihre phpMyFAQ zu konfigurieren und weitere Administratoren einzutragen, rufen Sie den Admin-Bereich über http://www.ihredomain.de/faq/admin/index.php auf. Beim ersten Login kommen Sie über den Benutzernamen admin und den von Ihnen gewählten Passwort in den Admin-Bereich. Zur Suche: Die Volltextsuche der phpMyFAQ funktioniert erst korrekt, wenn einige Datensätze (5 oder mehr) vorhanden sind. Desweiteren darf das zu suchende Wort nicht in mehr als 50% der Datensätze vorkommen, sonst wird es automatisch aus dem Ergebnis herausgenommen. Dieses Verhalten ist kein Bug, sondern ein "Feature" der MySQL-Datenbank. PHP-Einstellungen: Falls Sie Zugriff auf Ihre php.ini haben, so überprüfen Sie bitte, ob die Variable file_upload = On gesetzt ist; ansonsten funktioniert der Datei-Upload für Attachments nicht. Ein Update auf die phpMyFAQ 1.3.0 ist von folgenden Versionen möglich:
3.a. Upgrade von phpMyFAQ 1.1.x Ein Update von phpMyFAQ 1.1.x ist sehr einfach. Löschen Sie per FTP alle Dateien, jedoch nicht folgende Dateien:
Kopieren Sie die neuen Dateien auf Ihren Webspace und laden in Ihrem Browser folgende Adresse: http://www.ihredomain.de/faq/install/update.php Wählen Sie Ihre bisherige phpMyFAQ-Version aus und drücken Sie dann den Button des Update-Skriptes, ihre Version der FAQ wird dann automatisch upgedatet! Bitte löschen Sie anschließend den Inhalt des Verzeichnisses /install! Beim ersten Login nach dem Update kommen Sie über den Benutzernamen admin und das Passwort admin in den Admin-Bereich. Bitte ändern Sie dann als erstes das Passwort für den Benutzer admin, um Einbrüche in den Administrationsbereich zu verhindern. 3.b. Upgrade von phpMyFAQ 1.2.x Ein Update von phpMyFAQ 1.2.x ist sehr einfach. Löschen Sie per FTP alle Dateien, jedoch nicht folgende Dateien:
Laden Sie nun folgende Adresse: http://www.ihredomain.de/faq/install/update.php Wählen Sie Ihre bisherige phpMyFAQ-Version aus und drücken Sie dann den Button des Update-Skriptes, ihre Version der FAQ wird dann automatisch upgedatet! Bitte löschen Sie anschließend den Inhalt des Verzeichnisses /install! Beim ersten Login nach dem Update kommen Sie über den Benutzernamen admin und das Passwort admin in den Admin-Bereich. Bitte ändern Sie dann als erstes das Passwort für den Benutzer admin, um Einbrüche in den Administrationsbereich zu verhindern. Um einige neuen Features der phpMyFAQ 1.3.0 nutzen zu können, müssen Sie einige Templates anpassen. Was Sie dabei beachten müssen, ist im folgenden Kapitel beschrieben. 3.c. Template-Anpassung an phpMyFAQ 1.3.x Aufgrund der PDF-Unterstützung und der Möglichkeit, mehrsprachige FAQs mit der Version 1.3.0 zu nutzen, müssen Sie Ihre Templates der Version 1.2.x ein wenig an die neue Situation anpassen. Folgende Templates haben Sich geändert:
Bitte benutzen Sie das neue Template der Version 1.3.0 und passen Sie dieses an Ihr Layout an, damit es zu keinen Problemen kommt. Hier ändern Sie bitte den JavaScript-Bereich und tauschen den alten Code gegen den neuen Code zwischen <script language="JavaScript" type="text/javascript"> und </script>, da sonst die Druckfunktion nicht funktioniert. Hier müssen Sie noch die CSS-Angaben für <pre>-Bereiche hinzufügen, diese können Sie auch aus der originalen style.css-Datei entnehmen. Bitte benutzen Sie das neue Template der Version 1.3.0 und passen Sie dieses an Ihr Layout an, damit es zu keinen Problemen kommt. 3.d. Upgrade von phpMyFAQ 1.3.x Ein Update von phpMyFAQ 1.3.x ist sehr einfach. Kopieren Sie per FTP alle neuen Dateien aus dem Update-ZIP auf Ihren Server, behalten Sie dabei unbedingt Ihre folgende Dateien:
Laden Sie nun folgende Adresse: http://www.ihredomain.de/faq/install/update.php Wählen Sie Ihre bisherige phpMyFAQ-Version aus und drücken Sie dann den Button des Update-Skriptes, ihre Version der FAQ wird dann automatisch upgedatet! Bitte löschen Sie anschließend den Inhalt des Verzeichnisses /install! Die phpMyFAQ wird komplett über den Webbrowser verwaltet und konfiguriert. Der zentrale Platz hierfür ist der Admin-Bereich. Sie erreichen diesen über http://www.ihredomain.de/faq/admin/index.php Mit der Eingabe des Benutzernamens und des Passwortes werden Sie vom System authentifiziert und werden eingeloggt. Auf der Startseite sehen sie im linken Teil das Admin-Menü und rechts eine kleine Statistik über Visits, Artikel und Kommentare. Im Menü finden Sie folgende Punkte:
phpMyFAQ bietet eine umfassende Rechtevergabe für die verschiedenen Benutzer im Administrationsbereich. Damit ist es möglich verschiedenen realen Personen (dargestellt durch Benutzer in der Benutzerverwaltung) verschiedene Rechte geben. Die Rechte sind fein gegliedert, beispielsweise ist es möglich einem bestimmten Benutzer das Recht zum Ändern eines Beitrages, nicht jedoch zum Löschen eines Beitrages zu geben. Genauso wie es möglich ist die Rechte sehr genau zu verteilen, so ist es auch wichtig genau darüber nachzudenkden welcher Benutzer was darf. Durch das Ändern eines Beitrages ist es beispielsweise auch möglich jeglichen Inhalt zu entfernen was quasi einer Löschung gleichkommt. Die Zahl der eingerichteten Benutzer ist seitens phpMyFAQ nicht begrenzt. In der Hauptansicht der Benutzerverwaltung sieht man die Übersicht über die derzeit eingerichteten Benutzer. Die Spalte der Rechte stellt eine Kombination aus 1 und 0 dar. 1 heißt, daß dieses Recht gegeben ist, 0 heißt, daß der spezifische Benutzer diese Aktion nicht ausführen darf. Die Reihenfolge ist die selbe wie in der Auflistung unter Benutzer hinzufügen bzw. Benutzer editieren. Bitte beachten Sie, daß neu eingerichtete Benutzer keinerlei Rechte haben, diese müssen ihnen erst durch ein späteres Editieren gegeben werden. Außerdem kann der User admin nicht gelöscht werden, auch sein Benutzername kann nicht geändert werden.
Hier können Sie Ihre Sprache auswählen, standardmäßig wird die akzeptierte Sprache des Browsers übernommen. Sie können über die Sprachauswahl einen Artikel mit mehreren Sprachen erstellen, dabei gehen Sie am besten so vor: Sie schreiben z.B. zunächst einen Artikel in Deutsch und speichern diesen ab. Nun gehen Sie über den Punkt Beiträge editieren und editieren Ihren eben gespeicherten deutschen Artikel. Ändern Sie dort dann Thema, Text, Keywords ab und ändern die Sprache dann z.B. auf englisch. Nun klicken Sie auf Speichern und der englische Artikel wird in der Datenbank gespeichert. Im Punkt Beiträge editieren können Sie nun beide Artikel unter der gleichen ID finden. phpMyFAQ bietet die Möglichkeit, die Themengebiete einer FAQ in verschiedene Kategorien und Subkategorien zu gliedern. Sie haben hier auch die Möglichkeit, Ihre Rubriken umzusortieren. Dieses Feature ist leider noch nicht fehlerfrei. phpMyFAQ bietet auf der Startseite der FAQ ein eigenes kleines Redaktionssystem für Neuigkeiten rund um die jeweilige FAQ. In der Newsverwaltung ist es möglich, eben diese Einträge zu editieren bzw. zu löschen. phpMyFAQ bietet den Besuchern die Möglichkeit ihre Fragen zu stellen. Im öffentlichen Bereich sind diese Fragen dann für jeden einsehbar und jeder kann auch seine Antworten dazu geben. Wenn nun eine Frage aus welchen Gründen auch immer nicht mehr in dem Katalog erscheinen soll, gibt es hier die Möglichkeit die Frage zu löschen. Hinter diesem Punkt verbirgt sich die Auswertung des in phpMyFAQ eingebauten Votingsystems. Die Besucher können in Form von Noten von 1-5 ihre Meinung über die Artikel abgeben. In der Statistik kann man nun die Durchschnittsbewertung (rechte Spalte) sowie die Zahl der abgegebenen Stimmen einsehen (zweite Spalte von rechts). Um einen schnellen Überblick zu erhalten sind Durchschnitte kleiner 2 (also schlecht) rot gefärbt, Durchschnitte größer 4 grün. phpMyFAQ bietet die Funktion die Zugangsdaten zum Administrationsbereich in einem Cookie speichern zu lassen. Bitte beachten Sie, dass diese Funktion unter Umständen eine Sicherheitslücke darstellt. Sie sollten diese Funktion nur verwenden, wenn nur Sie Zugang zu den verwendeten Rechner haben. Diese Funktion dient zur Verfolgung der Bewegungen der Besucher ihrer FAQ. Jeder Besucher erhält beim Aufruf der Startseite eine eigene, einmalige Identifikationsnummer, die ihn bei jedem weiteren Schritt identifiziert. Damit ist es möglich die Art der Informationssuche der Interessenten zu analysieren und die Gliederung sowie den Inhalt und die Stichwörter entsprechend anzupassen. Ausserdem gibt es eine Suchfunktion, die möglichen Parameter sind die IP des Besuchers, die Zahl der minimalen Aktionen, sowie der Zeitraum des Besuchs. Diese Funktion dient zur Verfolgung der Aktionen der Administratoren im Administrationsbereich. Diese Funktion ist hilfreich um nach einem vermuteten oder tatsächlich passierten Einbruch oder einer sonstigen Unregelmäßigkeit die Spur des "Einbrechers" zu verfolgen. Hier ist es möglich sein Passwort zu ändern. Bitte beachten Sie, daß es möglich ist den Zugriff auf diese Funktion für bestimmte Benutzer zu verbieten (beispielweise Sammelaccounts, etc.). Die Änderung von Passwörtern anderer Benutzer ist als entsprechend berechtigter Administrator im Punkt Benutzerverwaltung möglich. Hier ist es möglich, allgemeine Einstellungen zu phpMyFAQ zu machen, das Ändern von Layout oder Farben ist in diesem Menü nicht möglich. Bitte beachten Sie auch, dass Sie keinen HTML-Code in Ihren Artikeln verwenden dürfen, wenn Sie BB-Codes aktivieren! Falls Sie mehrere E-Mailadressen in die Konfiguration eintragen möchten, so trennen Sie bitte die einzelnen Adresse mit einem Komma. Mit der Funktion Backup ist es möglich ein Abbild der von der FAQ verwendeten Datenbank in einer Datei abzulegen. Damit ist es möglich nach einem evtl. möglichen "Crash" der Datenbank oder einem Umzug der FAQ die vorher vorhandenen Daten weiter einzuspielen. Es wird empfohlen in regelmäßigen Abständen ein Backup der vorhanden Daten anzulegen.
Eventuell möchten Sie gerne die News, die Top 10 oder die neuesten Artikel Ihrer FAQ auf anderen Bereichen Ihrer Homepage anzeigen lassen. Damit dies klappt, können Sie diese drei Bereiche in RSS-Feeds exportieren. RSS ist ein Web Content Syndication Format. Der Name ist ein Akronym für Really Simple Syndication. RSS ist ein XML-Dialekt. Auf unserer Downloadseite finden Sie ein PHP-Skript, mit dem Sie die drei RSS-Feeds auslesen können und auf Ihrer Homepage einfügen können. Die RSS-Dateien müssen Sie im Punkt FAQ exportieren in Ihrem Adminbereich generieren, Sie finden die RSS-Dateien dann im Verzeichnis xml/ in Ihrer FAQ. Folgende Dateien werden generiert:
Beim Klick auf Logout wird die aktuelle Session beendet. Es wird empfohlen vor dem Schließen des Browserfenster die Session zu beenden um Missbrauch vorzubeugen. 5. Designanpassung, Templates und Stylesheets Ab der Version 1.2.0 sind Programmcode und Layout fast komplett von einander getrennt. Das Layout wird über mehrere Layoutvorlagen, die Sie auch selbst gestalten oder verändern können, zusammengesetzt. Die für das Layout wichtigen Dateien liegen im Verzeichnis template/. Hinweis: Das Design des Adminbereichs kann mit den Templates nicht verändert werden, falls Sie das dennoch wünschen, so müssen Sie selbst per Hand die Datei admin.php bearbeiten. Bitte bedenken Sie aber, dass Ihre Änderungen bei Updates der phpMyFAQ dann wieder überschrieben werden. 5.a. Die Datei template/index.html In der Datei index.html ist das Grundlayout der phpMyFAQ gespeichert. Diese Datei ist eine normale HTML-Datei mit einigen Variablen, die in geschweiften Klammern stehen und als Platzhalter für Inhalte dienen. Beispiel: <td width="200" class="little" align="center">{userOnline}</td> Der Platzhalter {userOnline} wird dabei vom Template-Parser der FAQ in die Anzeige der Benutzer, die gerade online sind, umgewandelt. Sie können nun nach belieben das Layout verändern, zu Ihrer Sicherheit sollten Sie jedoch unsere Original-Templates vorher sichern. Die Bearbeitung der Templates kann mit einem beliebigen Editor geschehen, Tests mit dem Dreamweaver von Macromedia waren auch erfolgreich. Veränderungen mit Microsoft Frontpage, Adobe GoLive und NetObjects Fusion sollten unterlassen werden, da diese den Quellcode zu sehr verändern. 5.b. Die Datei template/style.css In der CSS-Datei style.css können Sie alle Formate wie Schriften, Farben und ähnliches bearbeiten. Eine hervorragende Beschreibung von CSS finden Sie bei SelfHTML. Auf Wunsch können wir Ihnen auch gerne weitere Templates zur Verfügung stellen. Falls daran Interesse besteht, so melden Sie sich doch bitte in unserem Forum. Vielen Dank, dass Sie die phpMyFAQ benutzen! :-)
Autoren der FAQ-Dokumentation: Thorsten Rinne, Bastian Pöttner Dank an: Erwin Leenheer für die niederländische Übersetzung und Bugfixing, Lex für die französische Übersetzung, Krzysztof Kudlacik für die polnische Übersetzung, Rui Barreiros für die portugisische Übersetzung, und natürlich allen, die unsere FAQ auf Ihren Seiten nutzen! © 2001-2003 Thorsten Rinne und Bastian Pöttner |