[ documentation ]
(Gültig für die Version: 1.1.0, 1.1.1, 1.1.2, 1.1.3, 1.1.4, 1.1.4a, 1.1.5)
- Einführung
- Installation
- Upgrade
- Verwaltung
- Benutzerverwaltung
- Beitragsverwaltung
- Kategorieverwaltung
- Newsverwaltung
- Offene Fragen löschen
- Bewertungsstatistik
- Cookies
- Sessions ansehen
- Adminlog ansehen
- Passwort ändern
- Konfiguration ändern
- Backup
- Logout
- Zum Thema Design und Stylesheets
- Zum Schluss
Die phpMyFAQ ist ein komplett datenbankgestütztes FAQ-System. Als Referenzdatenbank wird mySQL genutzt, als Schnittstelle PHP4. Die phpMyFAQ bietet ein Content Management System, Benutzerverwaltung, ein Newssystem, UserTracking, Sprachmodule und ein Installationsskript.
Diese Dokumentation hilft Ihnen bei der Installation und Nutzung der phpMyFAQ.
Hinweis:
Diese Lizenz ist entspricht keiner GNU Lizenz, wie sie von der Free Software Foundation veröffentlicht werden. Ihre Bedingungen unterscheiden sich wesentlich von den Bedingungen der GNU Lizenzen.
Die Lizenz finden Sie in der Datei lizenz.html in diesem Ordner.
Falls Sie Probleme mit der phpMyFAQ haben sollten, dann finden Sie unter www.phpmyfaq.de eine FAQ zur phpMyFAQ sowie ein Supportforum.
Die phpMyFAQ spricht über PHP4 eine mySQL-Datenbank an. Für die Installation benötigen Sie einen Webspace mit folgenden Features:
- PHP4 ab Version 4.0.1 (Achtung: Die phpMyFAQ 1.1.4 funktioniert nicht unter PHP 4.2.x)
- mySQL ab Version 3.22.29
- diese Anleitung
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.
Sollten Sie nur PHP3 oder PHP4 unter 4.0.1 zur Verfügung haben, so können Sie die vorherige Version 1.0.2 der phpMyFAQ nutzen, diese ist kompatibel zu PHP3 ab Version 3.0.12
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 Browser der vierten Generation (z.B. Netscape Navigator 4.01 oder Internet Explorer 4.0). Desweiteren sollte für die Printfunktion JavaScript aktiviert sein. Die Printfunktion funktioniert im Internet Explorer übrigens erst ab Version 5.
Sie erhalten die phpMyFAQ von uns per E-Mail in einer gezippten Datei. Bitte entpacken Sie dieses Paket auf Ihrer lokalen Festplatte.
Die Grafik header.png im Verzeichnis /images können Sie selbstverständlich durch eine von Ihnen gestaltete Grafik austauschen. Kopieren Sie anschließend alle Dateien per FTP in ein Verzeichnis in Ihrem Webspace, z.B. in das Verzeichnis faq/.
Wichtig:
Es ist zwingend Schreibrecht im Installationsverzeichnis erforderlich, um die Dateien data.php und config.php zu schreiben.
Starten Sie Ihren Browser und tippen folgende URL ein:
http://www.ihredomain.de/faq/install/install_db.php
ihredomain 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. 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. 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 das Layout zu konfigurieren und weitere Administratoren einzutragen, rufen Sie den Admin-Bereich über
http://www.ihredomain.de/faq/admin.php
auf. Beim ersten Login kommen Sie über den Benutzernamen admin und das Passwort admin in den Admin-Bereich.
Ein Update von den Beta-Versionen (alle Versionen vor 1.0) ist nicht möglich, ein Update von Version 1.0.x ist nur manuell möglich, davon raten wir aber eher ab. Hierzu können Sie uns aber gerne kontaktieren.
3.a. Upgrade von phpMyFAQ 1.1.0 oder 1.1.1
Kopieren Sie alle neuen Daten über die alten Dateien in das Verzeichnis Ihrer phpMyFAQ-Version. Starten Sie Ihren Browser und laden folgende Adresse:
http://www.ihredomain.de/faq/install/update.php
Drücken Sie den Button des Update-Skriptes, ihre Version der FAQ wird dann automatisch upgedatet! Bitte löschen Sie anschließend den Inhalt des Verzeichnisses /install! Desweiteren müssen Sie die Datei style.php im Verzeichnis /style löschen und anschließend im Adminbereich die CSS-Datei in der Konfiguration von style.php auf style.css ändern.
3.b. Upgrade von phpMyFAQ 1.1.2, 1.1.3 oder 1.1.4
Für das Update von 1.1.2, 1.1.3 oder 1.1.4 auf 1.1.5 kopieren Sie einfach die Dateien des Patches in Ihr phpMyFAQ-Verzeichnis. Beim Update von 1.1.2, 1.1.3 oder 1.1.4 auf 1.1.5 müssen Sie die Datei style.php im Verzeichnis /style löschen und anschließend im Adminbereich die CSS-Datei in der Konfiguration von style.php auf style.css ändern.
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.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, Pageviews, Artikel und Kommentare. Im Menü finden Sie folgende Punkte:
- Benutzerverwaltung
- Beitrag erstellen
- Beiträge genehmigen
- Beiträge editieren
- Kategorien hinzufügen
- Kategorien editieren
- News hinzufügen
- News editieren
- Offene Fragen löschen
- Bewertungsstatistik
- Cookies
- Sessions ansehen
- Adminlog ansehen
- Passwort ändern
- Konfiguration ändern
- Backup
- Logout
- Startseite
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.
- Beitrag erstellen
Hiermit ist es möglich Beiträge direkt im Administrationsbereich zu erstellen. Erstelle Beiträge sind standardmäßig nach dem Erstellen erstmal nicht veröffentlicht. Die Bedeutung der Felder ist die folgende:
- Thema
Das Thema ist die Fragestellung bzw. die Überschrift des jeweiligen Beitrages. - Text
Der Text ist die Antwort auf die Fragestellung bzw. die Lösung des jeweiligen Problems. Es ist möglich normale HTML-Formatierungen zu verwenden. Die gängigsten sind:
- <b>...</b> - Fett
- <i>...</i> - Kursiv
- <u>...</u> - Unterstrichen
- <pre>...</pre> - Vorformatierter Text für Codebeispiele, etc.
- <a href="http://www.url.de">...</a> - Link auf http://www.url.de
Falls Sie in der Konfiguration UBB-Code-Unterstützung aktiviert haben, so dürfen Sie kein HTML mehr nutzen, sondern können die UBB-Codes verwenden. Die UBB-Codes sind hier im Einzeln aufgelistet und erklärt:
- [b]...[/b] - Fett
- [i]...[/i] - Kursiv
- [code]...[code] - Vorformatierter Text für Codebeispiele, etc.
- [img]...[/img] - Grafik oder Bild einfügen mit der Adresse http://www.url.de/bild.jpg
- [url]http://www.url.de[/url] - Link auf http://www.url.de, dabei öffnet sich ein neues Browserfenster
Sobald Sie UBB-Codes aktiviert haben, erscheint auch eine Hilfeseite im öffentlichen Bereich der FAQ. UBB-Codes müssen klein geschrieben werden!
- Attachment
Damit ist es möglich an die Artikel Dateien anzuhängen. Diese liegen in einem speziellen Pfad und können im Artikel referenziert werden. Nicht referenzierte Attechments werden nicht sichtbar. - Keywords
Keywords sind Stichwörter, die bei der Suche ebenfalls durchsucht werden. Sollte ein Wort nicht im Artikel vorkommen, obwohl er themenverwandt ist, so kann man ihn unter Keywords eintragen und dieser Artikel wird bei einer Suche trotzdem gefunden. Es ist außerdem möglich streng genommen nicht themenverwandte Stichwörter anzugeben, damit auch falsch verwendete Suchwörter zum Ziel führen. - Autor
Hier ist es möglich einen Hinweis auf den Autor anzubringen, diese Angabe wird derzeit allerdings nicht angezeigt, sondern dient lediglich zur internen Verwaltung. - Kategorie
Die Kategorie stellen den Bereich der FAQ dar, in dem der Artikel erscheint. - Aktiv
Wenn ein Artikel "aktiviert" ist, so ist er im öffentlichen Bereich sichtbar und wird auch in der Suche gefunden. Ist er "deaktiviert", so ist er im öffentlichen Bereich nicht sichtbar. Von Besuchern vorgeschlagene Artikel sowie im Adminbereich neu erstellte Artikel sind standardmäßig deaktiviert um Mißbrauch vorzubeugen. - Datum
Datum stellt den Zeitpunkt der letzten Änderung dar. - Geändert?
Geändert ist eine Art Kommentarfeld. Bei einer Änderung eines Artikel sollten hier die Änderungen angegeben werden, damit ist es anderen Administratoren möglich die Ändernungen und damit die Entstehungsgeschichte des Artikels nachzuvollziehen. Diese Kommentare erscheinen nicht im öffentlichen Bereich der FAQ. - Changelog
Im Changelog werden eben diese Kommentare im Feld Geändert aufgelistet, jeweils mit Datum der Änderung und der Nennung des Benutzernamens. - Beiträge genehmigen
Hier werden alle Beiträge gelistet, die in der Datenbank eingetragen sind, aber nicht aktiv (also öffentlich) sind. Hier erscheinen beispielsweise die von Besuchern vorgeschlagenen Artikel. Um sie zu genehmigen verwenden Sie den Link "Editieren" und setzen den Artikel dort auf "Aktiv", dort gibt es ebenfalls die Möglichkeit den Artikel zu löschen (mit Rückfrage!). - Beiträge editieren
Hier werden alle in der Datenbank befindlichen Beiträge gelistet. Nach einem Klick auf "Editieren" erscheint die selbe Maske wie unter "Beitrag erstellen".
phpMyFAQ bietet die Möglichkeit, die Themengebiete einer FAQ in verschiedene Kategorien und Subkategorien zu gliedern.
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 Stastik 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, daß 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. Außerdem 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 passieren 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 Eintragen einer nicht vorhandenen Sprachdatei führt dazu, daß die FAQ mit der deutschen Sprachdatei dargestellt wird. Bitte beachten Sie auch, dass Sie keinen HTML-Code in Ihren Artikeln verwenden dürfen, wenn Sie UBB-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.
- Daten-Sicherung erstellen
Eine Sicherung der Daten bedeutet alle Einträge, sowie Benutzerkonten, Kommentare, etc. - LOG-Sicherung erstellen
Eine Sicherung der Logs bedeutet, daß die Sessions der Besucher sowie das Adminlog gesichert werden. Diese Informationen sind für den Betrieb der FAQ nicht essentiell, sondern lediglich für statistische Zwecke gedacht.
Beim Klick auf Logout wird die aktuelle Session beendet. Es wird empfohlen vor dem Schließen des Browserfenster die Session zu beenden um Mißbrauch vorzubeugen.
5. Zum Thema Design und Stylesheets
Die Grundfarben der phpMyFAQ können Sie im Adminbereich im Bereich Konfiguration ändern. Die Schriftarten und -größen müssen Sie in der CSS-Datei der phpMyFAQ im Verzeichnis style/ per Hand ändern. Hilfe im Umgang mit CSS finden Sie bei selfHTML.
Autoren der FAQ-Dokumentation: Thorsten Rinne, Bastian Pöttner
Letzte Aktualisierung: Sonntag, 23. Juni 2002
Wir suchen noch Autoren für eine Übersetzung dieser Dokumentation ins Englische.
Dank an:
Kai-Uwe Wärner für den Code der Volltextsuche,
Siegfried Meffert für Betatests und Datenbankdesign,
den Mitgliedern der IG4 und der netGerman GmbH i.G.
und natürlich allen, die unsere FAQ auf Ihren Seiten nutzen!
© 2001-2002 Thorsten Rinne und Bastian Pöttner
Fatal error: Call to undefined function HTML_FOOTER() in /kunden/117702_86830/phpmyfaq/docs/dokumentation.1.1.de.php on line 336