Fork me on GitHub

phpMyFAQ: the FAQ system

[ documentation ]

(G�ltig f�r die Version: 1.3.0 und sp�ter)

  1. Einf�hrung
    1. Lizenz
    2. Support
    3. Copyright
  2. Installation
    1. Anforderungen
    2. Vorbereitungen
    3. Installationsskript
    4. Die ersten Schritte
    5. Hinweise
  3. Upgrade
    1. Upgrade von phpMyFAQ 1.1.x
    2. Upgrade von phpMyFAQ 1.2.x
    3. Template-Anpassung an phpMyFAQ 1.3.x
    4. Upgrade von phpMyFAQ 1.3.x
  4. Verwaltung
    1. Benutzerverwaltung
    2. Beitragsverwaltung
    3. Kategorieverwaltung
    4. Newsverwaltung
    5. Offene Fragen l�schen
    6. Bewertungsstatistik
    7. Cookies
    8. Sessions ansehen
    9. Adminlog ansehen
    10. Passwort �ndern
    11. Konfiguration �ndern
    12. Backup
    13. FAQ exportieren
    14. Logout
  5. Designanpassung, Templates und Stylesheets
    1. Die Datei template/index.html
    2. Die Datei template/style.css
    3. Weitere Templates
  6. Zum Schluss

1. Einf�hrung

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.

nach oben


1.a. Lizenz

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.

nach oben


1.b. Support

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.

nach oben


1.c. Copyright

© 2001 - 2003 by Bastian P�ttner and Thorsten Rinne under the Mozilla Public License.
Alle Rechte vorbehalten.

nach oben


2.Installation

2.a. Anforderungen phpMyFAQ

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.1.0 (Achtung: Die phpMyFAQ 1.3.x funktioniert nicht unter PHP 4.0.x)
  • MySQL ab Version 3.23.23
  • 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. 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.

nach oben


2.b. Vorbereitungen

Sie erhalten die phpMyFAQ von uns per E-Mail in einer gezippten Datei. Bitte entpacken Sie dieses Paket 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/.
Wichtig:
Es sind zwingend Schreibrechte f�r Skripte in Ihrem Verzeichnis erforderlich, um die Dateien data.php und config.php w�hrend der Installation neu zu schreiben. Dies ist der Fall, wenn bei Ihnen PHP als CGI oder als Webserver-Modul und aktivierten Safe-Mode l�uft.

nach oben


2.c. Installationsskript

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. 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. Anschlie�en klicken Sie auf den Button Installieren und die SQL-Tabellen der FAQ werden installiert.

nach oben


2.d. Die ersten Schritte

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 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.

nach oben


2.e. Hinweise

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.

nach oben


3. Upgrade

Ein Update auf die phpMyFAQ 1.3.0 ist von folgenden Versionen m�glich:

  • phpMyFAQ 1.1.x
  • phpMyFAQ 1.2.x

nach oben


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:

  • im Ordner inc/ die data.php und die config.php

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.

nach oben


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:

  • Im Ordner inc/ die Dateien data.php und config.php
  • Ihr Layout im Ordner template/

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.

nach oben


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:

  • template/artikel.html
  • 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.

  • template/index.html
  • 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.

  • template/style.css
  • 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.

  • template/writecomment.html
  • 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.

nach oben


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:

  • Im Ordner inc/ die Dateien data.php und config.php
  • Ihr Layout im Ordner template/

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!

nach oben


4. Verwaltung

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:

  • Startseite
  • Benutzerverwaltung
  • Beitrag erstellen
  • Beitr�ge genehmigen
  • Beitr�ge editieren
  • Kategorieverwaltung
  • News hinzuf�gen
  • News editieren
  • Offene Fragen l�schen
  • Bewertungsstatistik
  • Cookies
  • Sessions ansehen
  • Adminlog ansehen
  • Passwort �ndern
  • Konfiguration �ndern
  • Backup
  • FAQ exportieren
  • Logout

nach oben


4.a. Benutzerverwaltung

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.

nach oben


4.b. Beitragsverwaltung

  • 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 eingeschr�nkt m�glich, normale HTML-Formatierungen zu verwenden. Die g�ngigsten sind:
      • <b>...</b> - Fett
      • <i>...</i> - Kursiv
      • <u>...</u> - Unterstrichen
      • <a href="http://www.url.de">...</a> - Link auf http://www.url.de

      Alle weiteren HTML-Tags werden aus Sicherheitsgr�nden herausgefiltert. Mehr M�glichkeiten haben Sie mit dem BB-Code.

      Falls Sie in der Konfiguration BB-Code-Unterst�tzung aktiviert haben, so d�rfen Sie kein HTML mehr nutzen, sondern k�nnen die BB-Codes verwenden. Die BB-Codes sind hier im Einzeln aufgelistet und erkl�rt:

      • [b]...[/b] - Fett
      • [i]...[/i] - Kursiv
      • [u]...[/u] - Unterstrichen
      • [ul]...[/ul] - Liste, einzelne Listenpunkte mit [li]Listenpunkt[/li] innerhalb von [ul]
      • [center]...[/center] - Zentrieren
      • [code]...[/code] - Vorformatierter Text f�r Codebeispiele, etc.
      • [php]...[/php] - Vorformatierter Text f�r PHP-Codebeispiele mit Syntax-Highlighting
      • [img]...[/img] - Grafik oder Bild einf�gen mit der Adresse http://www.url.de/bild.jpg
      • [url]www.phpmyfaq.de[/url] - Link auf http://www.phpmyfaq.de, dabei �ffnet sich ein neues Browserfenster
      • [url=http://www.phpmyfaq.de]benannter Link[/url] - benannter Link auf phpMyFAQ, dabei �ffnet sich ein neues Browserfenster
      • Desweiteren werden URLs auch automatisch in Links umgewandelt

      Sobald Sie BB-Codes aktiviert haben, erscheint auch eine Hilfeseite im �ffentlichen Bereich der FAQ. BB-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.
    • Sprache

    • 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.
    • 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 �nderungen 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 den Artikel erscheint die selbe Maske wie unter "Beitrag erstellen", nat�rlich mit den Daten des zu bearbeitenden Artikels.

nach oben


4.c. Kategorieverwaltung

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.

nach oben


4.d. Newsverwaltung

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.

nach oben


4.e. Offene Fragen 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.

nach oben


4.f. Bewertungsstatistik

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.

nach oben


4.g. Cookies

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.

nach oben


4.h. Sessions ansehen

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.

nach oben


4.i. Adminlog ansehen

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.

nach oben


4.j. Passwort �ndern

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.

nach oben


4.k. Konfiguration �ndern

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.

nach oben


4.l. Backup

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.
  • XMl-Backup
    Sie k�nnen alle FAQ-Artikel auch in eine XML-Datei schreiben lassen. Nutzen Sie hierf�r diesen Link, die Daten werden dann von der phpMyFAQ in eine XML-Datei geschrieben. Sie finden die Datei dann im Ordner xml/phpmyfaq.xml. Ein Import-Tool f�r die XML-Daten ist in Arbeit.

nach oben


4.m. FAQ exportieren

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:

  • xml/news.xml f�r die News
  • xml/topten.xml f�r die Top 10
  • xml/latest.xml f�r die neusten Artikel

nach oben


4.n. Logout

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.

nach oben


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.

nach oben


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.

nach oben


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.

nach oben


5.c. Weitere Templates

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.

nach oben


6. Schluss

Vielen Dank, dass Sie die phpMyFAQ benutzen! :-)

Autoren der FAQ-Dokumentation: Thorsten Rinne, Bastian P�ttner
Letzte Aktualisierung: Donnerstag, 5. Juni 2003

Wir suchen noch Autoren f�r eine �bersetzung dieser Dokumentation ins Englische und weitere �bersetzungen der FAQ.

Dank an:
Stephan Hochhaus f�r die englische Dokumentation,
Matthias Sommerfeld f�r Hilfe bei der englischen �bersetzung,

  • Volodymyr Ganopolskyy f�r die russische �bersetzung,
    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,
    Hanne Parusel f�r die Header-Grafik,
    Kai-Uwe W�rner f�r Beta-Tests,
    Siegfried Meffert f�r Ideen beim Datenbank-Design,
    den Mitgliedern der IG4 und nat�rlich allen, die unsere FAQ auf Ihren Seiten nutzen!

    © 2001-2003 Thorsten Rinne und Bastian P�ttner

    nach oben