Fork me on GitHub

phpMyFAQ: the FAQ system

[ documentation ]

(obowi�zuje dla wersji: 1.3.0 i nowszych)

  1. Wst�p
    1. Licencja
    2. Wsparcie
    3. Prawa autorskie
  2. Instalacja
    1. Wymagania
    2. Przygotowanie
    3. Skrypt instalacyjny
    4. Pierwsze kroki
    5. Uwagi
  3. Aktualizowanie
    1. Aktualizowanie phpMyFAQ 1.1.x
    2. Aktualizowanie phpMyFAQ 1.2.x
    3. Modyfikacja szablon�w phpMyFAQ 1.3.x
  4. Administracja
    1. Administracja u�ytkownikami
    2. Administracja wpisami
    3. Administracja kategoriami
    4. Administracja nowo�ciami
    5. Edycja pyta� otwartych
    6. Statystyka ocen
    7. Cookies
    8. Przegl�danie sesji
    9. Przegl�danie sesji administratora
    10. Zmiana has�a
    11. Edycja konfiguracji
    12. Kopie zapasowe
    13. Wylogowanie
  5. Zmiany makiety, szablon�w i arkuszy stylu
    1. Plik template/index.html
    2. Plik template/style.css
    3. Inne szablony
  6. I co� jeszcze na koniec

1. Wst�p

phpMyFAQ jest wieloj�zycznym skryptem do tworzenia FAQ wykorzystuj�cym baz� danych. Obecnie do przechowywania danych u�ywany jest MySQL (w przysz�o�ci wykorzystan� zostan� inne bazy danych), za� PHP 4.1.0 (lub nowszy) jest stosowany do uzyskiwania po��cze� z baz� danych. phpMyFAQ jest tak�e systemem do zarz�dzania tre�ci� (CMS) wykorzystuj�cym role u�ytkownik�w z r�nymi poziomami uprawnie�. phpMyFAQ ma wbudowany system informowania o nowo�ciach, �ledzenia zachowania u�ytkownika, r�ne modu�y j�zykowe, szablony, obszerne wsparcie dla XML i PDF, system kopii zapasowych oraz �atwy w u�yciu skrypt instalacyjny.

Poni�sza dokumentacja ma wyja�ni� podstawowe zasady instalacji i administracji phpMyFAQ.

na g�r� strony


1.a. Licencja

phpMyFAQ opublikowany zosta� w ramach Publicznej Licencji Mozilli w wersji 1.1 (MPL). Gwarantuje on darmowe u�ytkowanie phpMyFAQ, dost�p do kodu �r�d�owego oraz prawo do modyfikacji i rozpowszechniania skryptu.

Jedynym ograniczniem jest prawo autorskie, kt�re przys�uguje Bastianowi Poettnerowi i Thorstenowi Rinne. Ka�da zmodyfikowana wersja phpMyFAQ r�wnie� podlega warunkom licencji MPL. Ograniczenia te nie dotycz� innych program�w, kt�re wykorzystuj� tylko niekt�re funkcje phpMyFAQ, zatem mog� one by� rozpowszechniane na dowolnych warunkach licencyjnych.

Komercyjne wykorzystanie lub dystrybucja phpMyFAQ, np. na CD-ROM, jest dozwolone tylko w�wczas, gdy zachowana jest zgodno�� z powy�sz� licencj�.

Zdecydowali�my si� na wykorzystanie licencji MPL, poniewa� uwa�amy, i� jest ona rozs�dnym kompromisem mi�dzy otwarto�ci� kodu i swobodnym rozpowszechnianiem, a oddzia�ywaniem z innym oprogramowaniem niezale�nie od przyj�tego modelu licencjonowania. W por�wnaniu do innych modeli licencjonowania, MPL charakteryzuje si� kr�tkim tekstem, kt�ry jest zrozumia�y nawet dla pocz�tkuj�cych.

na g�r� strony


1.b. Wsparcie

Je�li w trakcie u�ywania phpMyFAQ wyst�pi� jakiekolwiek problemy, zapraszamy do zg�oszenia tego na forum dyskusyjnym www.phpmyfaq.de. Nie oferujemy wsparcia telefonicznego lub za pomoc� poczty elektronicznej.

na g�r� strony


1.c. Prawa autorskie

© 2001 - 2003 Bastian Poettner i Thorsten Rinne w ramach Publicznej Licencji Mozilli.
Wszelkie prawa zastrze�one.

na g�r� strony


2.Instalacja

2.a. Wymagania phpMyFAQ

phpMyFAQ odwo�uje si� do bazy danych MySQL z poziomu PHP4. W celu pomy�lnej instalacji skryptu niezb�dne jest posiadanie serwera z:

  • PHP4 4.1.0 lub nowszym (Uwaga: phpMyFAQ 1.3.x nie b�dzie dzia�a� w PHP ni�szym ni� 4.0.x)
  • MySQL 3.23.23 lub nowsz�
  • niniejsza dokumentacja

Powy�sze wymagania mo�na sprawdzi� uruchamiaj�c na serwerze skrypt info.php z funkcj�:

    <?php phpinfo(); ?>

Ten skrypt nale�y wys�a� na serwer i otworzy� w przegl�darce. Wy�wietlone zostan� w�czas wersje PHP i MySQL, kt�re s� zainstalowane na docelowym serwerze. Ponadto, skrypt instalacyjny phpMyFAQ r�wnie� sprawdza te same dane podczas procesu instalacji. Je�li wskazane wymagania nie b�d� spe�nione, instalacja si� nie uda.

phpMyFAQ nie b�dzie mo�na u�ywa� na serwerze z PHP3 lub PHP 4.0.x.

Do przegl�dania stron FAQ niezb�dne jest posiadanie przegl�darki internetowej trzeciej generacji (np. Netscape 3.01). Formatowanie arkuszy styl�w CSS b�dzie widoczne dopiero dla przegl�darek Netscape 6 lub Internet Explorer 5. Wykorzystanie funkcji wydruku wpis�w z poziomu stron FAQ mo�liwe jest tylko przy w��czeniu w przegl�darce obs�ugi JavaScript. Internet Explorer pozwala na taki wydruk dopiero od wersji 5.

na g�r� strony


2.b. Przygotowanie

phpMyFAQ rozprowadzane jest w formie skompresowanego archiwum ZIP. Pobrane archiwum nale�y rozpakowa� na dysku komputera. Lista wszystkich plik�w archiwum dost�pna jest w phpmyfaq.txt.

Makiet� phpMyFAQ mo�na zmienia� przy pomocy szablon�w. Opis dzia�ania szablon�w znajduje si� poni�ej. Wszystkie rozpakowane z archiwum pliki nale�y pzres�a� na serwer za pomoc� dowolnego narz�dzia FTP. Pliki mo�na przenie�� do dowolnego katalogu na serwerze - sugerujemy jednak utworzenie w tym celu katalogu faq/.
Wa�ne:
W katalogu, do kt�rego skopiowano phpMyFAQ, musisz mie� prawa do zapisu - dotyczy to skrypt�w konfiguracyjnych data.php i config.php. W szczeg�lno�ci dotyczy to sytuacji, gdy PHP pracuje jako CGI lub jako mod_php z w��czonym trybem safe-mode.

na g�r� strony


2.c. Skrypt instalacyjny

Otw�rz w przegl�darce URL:

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

Oczywi�cie, www.twojadomena.com musi by� zast�piona rzeczywist� nazw� domenow�. Po za�adowaniu powy�szej strony nale�y poda� adres serwera MySQL (np. db.dostawcainternetu.com), nazw� u�ytkownika MySQL, jego has�o dost�pu i nazw� bazy danych. Pole prefiksu tabel MySQL mo�na pozostawi� puste. Je�eli zamierzasz korzysta� z wielu egzemplarzy FAQ w jednej bazie danych, to sugerujemy wprowadzenie prefiks�w - np. sport dla FAQ po�wi�conemu sportowi, pogoda dla FAQ o pogodzie itd. Warto pami�ta�, �e prefiks mo�e sk�ada� si� tylko z liter oraz znaku podkre�lenia dolnego "_". U�ywanie wielu egzemplarzy FAQ wymaga niezale�nego zainstalowania phpMyFAQ w r�nych katalogach (np. faq1/, faq2/. faq3/ itd.). Naci�ni�cie przycisku "install" rozpoczyna proces instalacji tabel w wybranej bazie danych.

na g�r� strony


2.d. Pierwsze kroki

Niezw�ocznie po udanej instalacji FAQ nale�y usun�� katalog /install! Dopiero po tej operacji mo�na wej�� do FAQ:

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

FAQ b�dzie puste i w domy�lnej makiecie. W celu konfiguracji phpMyFAQ nale�y wej�� tu

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

Domy�ln� nazw� u�ytkownika (login) jest admin z has�em admin. Po tej autoryzacji nast�puje przej�cie do sekcji administracyjnej. W pierwszej kolejno�ci nale�y zmieni� domy�lne has�o administratora.

na g�r� strony


2.e. uwagi

Funkcje wyszukiwarki:

Przeszukiwanie pe�notekstowe b�dzie dzia�a� dopiero wtedy, gdy w bazie FAQ znajdzie si� przynajmniej 5 wpis�w. Poszukiwane wyra�enie nie powinno znajdowa� si� w wi�cej ni� po�owie wszystkich wpis�w naszego FAQ, poniewa� w takim przypadku nic nie zostanie znalezione. To nie jest b��d, lecz w�a�ciwo�� bazy MySQL.

Ustawienia PHP:

O ile posiadasz dost�p do pliku php.ini, warto sprawdzi� czy zmienna file_upload jest ustawiona na file_upload = On; w przeciwnym wypadku nie b�dzie dzia�a� opcja dodawania za��cznik�w do poszczeg�lnych wpis�w FAQ.

na g�r� strony


3. Aktualizowanie

Aktualizowanie do 1.3.0 jest mo�liwe dla poni�szych wersji phpMyFAQ:

  • phpMyFAQ 1.1.x
  • phpMyFAQ 1.2.x

na g�r� strony


3.a. Aktualizowanie phpMyFAQ 1.1.x

Aktualizowanie phpMyFAQ 1.1.x jest proste. Po po��czeniu FTP nale�y usun�� wszystkie pliki za wyj�tkiem:

  • plik�w data.php i config.php w katalogu inc/

Nast�pnie pliki nowej wersji FAQ nale�y wys�a� na serwer i za pomoc� przegl�darki otworzy� stron�:

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

Otworzy si� formularz, z kt�rego trzeba wybra� wersj� FAQ, kt�ra ma by� aktualizowana, a nast�pnie klin�� przycisk aktualizacji. Nale�y pami�ta� o usuni�ciu katalogu /install niezw�ocznie po udanej aktualizacji! Logowanie do sekcji administracyjnej nale�y przeprowadzi� u�ywaj�c domy�lnego loginu i has�a (admin/admin). W pierwszej kolejno�ci nale�y zmieni� domy�lne has�o administratora.

na g�r� strony


3.b. Aktualizowanie phpMyFAQ 1.2.x

Aktualizowanie phpMyFAQ 1.2.x r�wnie� nie jest k�opotliwe. Nale�y usun�� wszystkie pliki za wyj�tkiem:

  • data.php i config.php w katalogu inc/
  • obecnie u�ywanej makiety w katalogu template/

Nast�pnie pliki nowej wersji FAQ nale�y wys�a� na serwer i wej�� przegl�dark� na stron�:

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

Otworzy si� formularz, z kt�ego nale�y wybra� wersj� FAQ, kt�ra ma by� aktualizowana i nast�pnie klin�� przycisk aktualizacji. Nale�y pami�ta� o usuni�ciu katalogu /install niezw�ocznie po udanej aktualizacji! Logowanie do sekcji administracyjnej nale�y przeprowadzi� u�ywaj�c domy�lnego loginu i has�a (admin/admin). W pierwszej kolejno�ci nale�y zmieni� domy�lne has�o administratora.

W celu dalszego u�ywania w phpMyFAQ 1.3.0 istniej�cych szablon�w, trzeba je nieco dostosowa� do nowszej wersji skryptu. Wyja�nienia znajduj� si� w nast�pnym paragrafie.

na g�r� strony


3.c. Modyfikacja szablon�w dla phpMyFAQ 1.3.x

phpMyFAQ 1.3.0 jest wieloj�zyczne oraz obs�uguje PDF, zatem istniej�ce szablony nale�y zmodyfikowa� tak, by uwzgl�dnia�y obs�ug� tych nowych funkcji. W phpMyFAQ 1.3.0 zmieniono nast�puj�ce szablony:

  • template/artikel.html
  • Sugerujemy u�ywanie nowego szablonu dostarczonego wraz z 1.3.0 - mo�na go dostosowa� do w�asnych potrzeb i unikn�� zb�dnych problem�w.

  • template/index.html
  • Zmieni� si� kod JavaScript - nowy trzeba skopiowac do starego szablonu w miejscu wskazanym tu <script language="JavaScript" type="text/javascript"></script> - bez tej zmiany druk bezpo�rednio ze stron FAQ nie b�dzie mo�liwy.

  • template/style.css
  • Tu trzeba doda� nowe warto�ci dla znacznik�w <pre>.

  • template/writecomment.html
  • Sugerujemy u�ywanie nowego szablonu dostarczonego wraz z 1.3.0 - mo�na go dostosowa� do w�asnych potrzeb i unikn�� zb�dnych problem�w.

na g�r� strony


4. Administracja

Ca�� administracj� phpMyFAQ prowadzi si� przez przegl�dark�. Sekcja administracyjna zlokalizowana jest pod adresem:

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

Wej�cie do tej sekcji jest mo�liwe po podaniu loginu i has�a. Po zalogowaniu si� zostanie wy�wietlona strona z menu administracyjnym po lewej oraz niekt�rymi statystykami, wpisami i komentarzami w cz�ci g��wnej. Menu administracyjne zawiera:

  • Administracja u�ytkownikami
  • Dodaj wpis
  • Akceptuj wpisy
  • Edytuj wpisy
  • Administracja kategoriami
  • Dodaj nowo�ci
  • Edytuj nowo�ci
  • Edytuj pytania otwarte
  • Statystyka
  • Cookies
  • Sesje
  • Sesje Admina
  • Zmie� has�o
  • Edytuj konfiguracj�
  • Kopia zapasowa
  • Wyloguj
  • Pocz�tek

na g�r� strony


4.a. Zarz�dzanie u�ytkownikami

phpMyFAQ posiada mo�liwo�� elastycznego nadawania r�nych poziom�w uprawnie� dla zarejestrowanych u�ytkownik�w. R�nym osobom - zarejestrowanym z r�nymi loginami i has�ami - mo�na przydziela� odmienne uprawnienia. Uprawnienia s� bardzo szczeg�owe: mo�na np. pozwoli� u�ytkownikowi na edycj� wpis�w, ale ju� nie na ich usuwanie. Uprawnienia tego rodzaju nale�y przydziela� rozwa�nie. Przyk�adowo, edycja wpisu mo�e prowadzi� do ca�kowitego usuni�cia jego tre�ci - a to w praktyce jest r�wnowa�ne usuni�ciu danego wpisu. Nie ma ogranicze� liczby zarejestrowanych u�ytkownik�w.

Przegl�d wszystkich zarejestrowanych u�ytkownik�w dost�pny jest na g��wnym ekranie sekcji "Administracja u�ytkownikami". Na tej stronie znajduje si� lista ich profili wraz z cyfrowym oznaczeniem poziomu uprawnie� - warto�� 1 oznacza, �e u�ytkownik ma dane uprawnienie, warto�� 0 przeciwnie: �e nie ma danego uprawnienia. Kolejno�� tych cyfrowych ozncze� odpowiada jednoznacznie ich kolejno�ci na stronie, na kt�rej s� one przypisane do danego u�ytkownika.

Nale�y pami�ta�, i� nowy u�ytkownik z definicji nie ma �adnych uprawnie� - zostaj� mu one przydzielone na stronie edycji jego profilu. U�ytkownik znany jako admin nie mo�e by� usuni�ty, a jego login (admin) nie mo�e by� zmieniony.

na g�r� strony


4.b. Administracja wpisami

  • Dodawanie wpis�w

    Wpisy mo�na dodawa� bezpo�rednio w sekcji administracyjnej. Z definicji nowy wpis NIE jest publikowany - czyli nie jest dost�pny w publicznej cz�ci phpMyFAQ. Formularz dodawania nowego wpisu sk�ada si� z nast�puj�ych p�l:

    • Temat
      To miejsce na wpisanie pytania FAQ lub czo��wki pozosta�ej cz�ci wpisu
    • Tre��
      W tym miejscu mo�na wpisa� odpowied� na zadane w FAQ pytanie lub rozwi�zanie problemu podanego w czo��wce. Dopuszcza si� w tym miejscu zastosowanie paru podstawowych znacznik�w HTML do formatowania wprowadzanego tekstu:
      • <b>...</b> - pogrubienie pisma
      • <i>...</i> - kursywa
      • <u>...</u> - podkre�lenie
      • <a href="http://www.url.com">...</a> - ��cze do http://www.url.com

      Ze wzgl�d�w bezpicze�stwa pozosta�e znaczniki HTML s� usuwane. Tre�� wpis�w mo�na formatowa� znacznikami BB-Code.

      Aktywacja BB-Codes w FAQ wyklucza stosowanie wy�ej wzmiankowanych znacznik�w HTML - w takiej sytuacji mo�na u�ywa� tylko BB-Codes. Oto lista BB-Codes:

      • [b]...[/b] - pogrubienie pisma
      • [i]...[/i] - kursywa
      • [u]...[/u] - podkre�lenie
      • [ul]...[/ul] - lista wyliczeniowa. Pojedyncze sk�adowe takiej listy uzyskuje si� w ten spos�b: [li]punktor 1[/li] wewn�trz znacznika [ul]
      • [code]...[/code] - preformatowany tekst np. dla fragment�w kodu.
      • [php]...[/php] - preformatowany tekst dla kodu php (jego u�ycie spowoduje kolorowanie sk�adni)
      • [img]...[/img] - wstawia grafik� - musi by� wprowadzony w formie pe�nego URLa http://www.url.com/grafika.jpg
      • [url]www.phpmyfaq.de[/url] - ��cze do http://www.phpmyfaq.de otwierane w nowym oknie
      • [url=http://www.phpmyfaq.de]nazwane ��cze[/url] - ��cze z nazw� do phpMyFAQ otwierane w nowym oknie
      • wszystkie adresy URL s� automatycznie przekszta�cane na ��cza.

      Po w��czeniu BB-Codes na publicznej cz�ci phpMyFAQ automatycznie pojawia si� ��cze do strony z pomoc�. BB-Codes musz� by� wpisane ma�ymi literami.

    • Plik
      Do konkretnego wpisu mo�na doda� plikowy za��cznik. Takie za��czniki przechowywane s� w specjalnej �cie�ce, do kt�rej odnosi si� dany wpis. Je�li �aden wpis nie odnosi si� do za��cznika, pozostaje on niewidoczny.
    • J�zyk

    • Mo�na okre�li� j�zyk ka�dego wpisu. Z definicji przyjmuje si�, i� wpis jest w jezyku u�ywanym przez przegl�dark�. Tworzenie wpis�w w r�nych j�zykach wygl�da nast�puj�co.
      Napisz tekst w j�zyku angielskim (lub dowolnym innym), a nast�pnie zapisz go. Nast�pnie wybierz opcj� edytuj wpisy i wtedy wybierz ostatnio wprowadzony wpis w j�zyku angielskim. Zmie� temat, tre��, s�owa kluczowe i sam j�zyk - np. portugalski u�ywany w Brazylii. Zachowaj taki wpis. Wtedy poklikni�ciu opcji edytuj wpisy, obydwa pojawi� si� na li�cie, b�d� posiada� ten sam identyfikator, lecz r�ni� si� b�d� j�zykami.
    • S�owa kluczowe
      S�owa kluczowe brane s� pod uwag� przy przeszukiwaniu bazy danych. W przypadku, gdy dane s�owo nie znajduje si� w samej tre�ci wpisu, lecz oddaje jego charakter, w�wczas warto wpisa� je w pole s��w kluczowych. Wtedy rezulataty przeszukiwania b�d� bardziej adekwatne. Mo�liwa jest tak�e sytuacja inna: mo�na celowo w�r�d s��w kluczowych zamie�ci� s�owa nie powi�zane z tre�ci� danego wpisu. W takiej sytuacji nawet wpisanie przy wyszukiwaniu z�ego terminu zaowocuje poprawnym wynikiem przeszukiwania.
    • Autor
      To pole jest opcjonalne. Nie zostaje wy�wietlane na FAQ i s�u�y tylko celom technicznym.
    • Kategoria
      Po�o�enie danego wpisu w hierarchii ca�ego FAQ zale�y od przypisania do wybranej kategorii.
    • Aktywowa�
      Aktywowanie wpisu wy�wietla go w publicznej cz�ci FAQ i pozwala przeszukiwa�. Deaktywacja wpisu czyni go niewidocznym dla publiczno�ci - dla anonimowego internauty. Wpisy, kt�re s� zaproponowane przez anonimowych internaut�w domy�lnie pozostaj� deaktywowane. Chroni to FAQ przed nadu�yciami
    • Data
      Data ostatniej zmiany.
    • Dokonano zmian?
      Dzi�ki temu polu mo�na �ledzi� jakich zmian dokonano w danym wpisie. Jest to informacja szczeg�lnie cenna, gdy FAQ prowadzone przez wsp�lnie przez kilka os�b. Informacje wpisane do tego pola nie b�d� widoczne w cz�ci publicznej FAQ.
    • Sesje
      W tej cz�ci s� zapisywane wszystkie wcze�niejsze zmiany w cz�ci administracyjnej w��cznie z dodawaniem nowych u�ytkownik�w i zmianami tre�ci.
  • Akceptuj wpisy
    Sekcja zawiera wszystkie nieaktywne wpisy, kt�re pozostaj� niewidoczne w cz�ci publicznej FAQ. Tutaj tak�e zlokalizowane s� wszystkie sugestie i propozycje od internaut�w. W celu akceptacji tych wpis�w nale�y klin�� ��cze, o kt�rym mowa, i edytowa� wybrane wpisy. Gdy zdecydujesz "Zaakceptowa�" wpis - stanie si� on "Aktywny" i b�dzie widoczny w publicznej cz�ci FAQ. Oczywi�cie w tym miejscu mo�na tak�e usun�� wybrany wpis. Przed takim usuni�ciem b�dziesz poproszony o potwierdzenie swojej decyzji.
  • Edytuj wpisy
    Na tej stronie pojawiaj� si� wszystkie wpisy. Klikni�cie na wybranym wpisie otworzy taki sam formularz, jak przy dodawaniu nowego wpisu.

na g�r� strony


4.c. Adminstracja kategoriami

W phpMyFAQ mo�na tworzy� kategorie i podkategorie FAQ. Ponadto mo�na zmienia� ich kolejno��. Niestety - jeszcze pracujemy nad t� ostatni� funkcjonalno�ci�.

na g�r� strony


4.d. Adminstracja nowo�ciami

Na startowej stronie phpMyFAQ publikowane s� nowo�ci dotycz�ce samego FAQ. Sekcja administracyjna s�u�y do dodawania nowych wiadomo�ci, edycji lub usuwania istniej�cych.

na g�r� strony


4.e. Edycja pyta� otwartych

Anonimowi internauci mog� za po�rednictwem phpMyFAQ zadawa� pytania. Takie pytania otwarte publikowane s� w publicznej cz�ci FAQ. Internauci mog� dawa� odpowiedzi na pytania otwarte. Z poziomu sekcji administracyjnej mo�na odrzuca� zadane pytania otwarte, a tak�e przypisa� im odpowiedzi w celu publikacji w FAQ.

na g�r� strony


4.f. Statystyka ocen

Pod ka�dym wpisem w FAQ znajduje si� narz�dzie do oceniania. Ka�dy wpis mo�e by� oceniony w skali od 1 do 5 - gdzie 1 to ocena najni�sza, a 5 najwy�sza. Dla ka�dego ocenionego wpisu wy�wietlona zostaje jego ocena �rednia oraz ilo�� wszystkich oddanych g�os�w. W sekcji administracyjnej wy�wietlany jest skr�cony przegl�d takich ocen - wpisy z punktacj� poni�ej 2 oznaczone s� czerwonym kolorem, natomiast kolor zielony wskazuje �rednie oceny od 4 w g�r�.

na g�r� strony


4.g. Cookies

Przy ka�dym zalogowaniu do phpMyFAQ w komputerze loguj�cego si� zapisywane jest cookie. To do�� wygodne narz�dzie, ale zawsze stanowi ono potencjaln� dziur� w bezpiecze�stwie. Cookies nale�y zatem stosowa� tylko na tym komputerze, do kt�rego tylko my mamy dost�p.

na g�r� strony


4.h. Sesje

Dzi�ki tej funkcji mo�na obserwowa� zachowanie go�ci. Ka�demu odwiedzaj�cemu przypisywany jest identyfikator, kt�ry towarzyszy w ci�gu przegl�dania stron FAQ. Na podstawie tych u�ytecznych informacji mo�na dostosowa� tre�� i struktur� FAQ do potrzeb odwiedzaj�cych go internaut�w. W tej cz�ci mo�na tak�e przeszuka� zgromadzone sesje w celu odnalezienia okre�lonych adres�w IP, minimalnych liczb okre�lonych dzia�a� lub daty wizyt.

na g�r� strony


4.i. Sesje Admina

Tutaj zbierane s� informacje o zachowaniach u�ytkownik�w, kt�rzy zalogowali si� do sekcji administracyjnej phpMyFAQ. Gdy podejrzewasz, �e do systemu dosta� si� potencjalny w�amywacz - tu mo�na si� o tym upewni�.

na g�r� strony


4.j. Zmie� has�o

Nazwa sekcji wyja�nia jej charakter. W tej cz�ci administratora mo�na uniemo�liwi� zarejestrowanemu u�ytkownikowi zmian� has�a. Mo�e to by� u�yteczne przy wielu zarejestrowanych w systemie osobach.

na g�r� strony


4.k. Edytuj konfiguracj�

Ta cz�� phpMyFAQ s�u�y do zmiany og�lnej konfiguracji. Nie mo�na tu zmienia� kolorystyki i makiety. Nale�y pami�ta�, �e nie wolno u�ywa� znacznik�w HTML, gdy aktywowana jest opcja BB-Codes.

Je�li trzeba wprowadzi� wiele adres�w email, nale�y oddziela� je przecinkami (",").

na g�r� strony


4.l. Kopia zapasowa

Za pomoc� tej funkcji mo�na utworzy� kopi� zapasow� ca�ego FAQ w jednym pliku. Dzi�ki temu odtworzenie FAQ w sytuacji kryzysowej nie stanowi problemu. W ten spos�b mo�na tak�e odtwarza� system przy porzenosinach na nowy serwer. Sugerujemy regularne tworzenie kopii zapasowych.

  • Kopia zapasowa danych
    Ten rodzaj kopii zawiera wszystkie wpisy, u�ytkownik�w, komentarze itd.
  • Kopia zapasowa LOG�w
    Zawiera sesje i sesje admina (czyli wszystkie pliki LOG). Oczywi�cie ponowne uruchomienie FAQ nie wymaga uprzedniego posiadania tego rodzaju kopii. S�u�� one celom statystycznym
  • utw�rz plik XML
    W pliku XML mo�na zapisa� wszystkie wpisy FAQ. Wygenerowany plik XML trafi do katalogu xml/phpmyfaq.xml. Trwaj� prace programistyczne nad narz�dziem do importowania tak przygotowanego materia�u do systemu.

na g�r� strony


4.m. Wyloguj

Klikni�cie na Wyloguj usuwa bie��c� sesj�, czyli wylogowuje u�ytkownika. Rekomendujemy takie wylogowanie z oczywistych wzgl�d�w bezpiecze�stwa.

na g�r� strony


5. Zmiany makiety, szablon�w i arkuszy styl�w

Pocz�wszy od wersji 1.2.0 kod skryptu i wygl�d s� niemal zupe�nie oddzielone. Makieta opiera si� na kilku szablonach - mo�na je zmienia� i dostosowa� do wygl�du istniej�cego serwisu WWW. Najwa�niejsze pliki szablon�w znajduj� si� w katalogu template/.

Uwaga: szablony nie dotycz� wygl�du sekcji administracyjnej. Je�eli chcesz zmienia� wygl�d cz�ci administracyjnej, musisz zmodyfikowa� plik admin.php. Nale�y pami�ta�, �e taki zmieniony wygl�d strony administratora zostanie usuni�ty przy pierwszej aktualizacji phpMyFAQ.

na g�r� strony


5.a. Plik template/index.html

Domy�lna makieta phpMyFAQ zawiera si� w pliku index.html. Jest to normalny plik HTML zawieraj�cy zmienne uj�te w nawiasy klamrowe - w miejsce zmiennych wpisywana jest tre�� FAQ.

Przyk�ad:

    <td width="200" class="little" align="center">{userOnline}</td>

W trakcie analizy pliku template/index.html zmienna {userOnline} zostaje zast�piona aktualn� liczb� internaut�w przegl�daj�cych w danej chwili strony FAQ.

Szablony mo�na swobodnie zmienia�, cho� sugerujemy zachowanie kopii oryginalnych szablon�w na wszelki wypadek. Teoretycznie szablony mo�na zmienia� pos�uguj�c sie dowolnym edytorem - testy przeprowadzone z u�yciem Dreamweaver'a przebieg�y pomy�lnie. Jednak Microsoft Frontpage, Adobe GoLive lub NetObjects Fusion mog� uszkodzi� szablony.

na g�r� strony


5.b. Plik template/style.css

Kr�j pisma, czcionki, kolorystyka i temu podobne mo�na zmienia� z poziomu arkusza styl�w kaskadowych style.css. Kompendium informacji o CSS znajduje si� na oficjalnej stronie W3C.

na g�r� strony


5.c. Inne szablony

Je�li takie b�dzie �yczenie wi�kszo�ci, mo�emy przygotowa� wi�ksz� liczb� szablon�w. Zapraszamy do odwiedzenia naszego forum dyskusyjnego w celu zg�oszenia zapotrzebowania na nowe szablony.

na g�r� strony


6. I co� jeszcze na koniec

Dzi�kujemy za pobranie i u�ywanie phpMyFAQ! :-)

Autorzy niniejszej dokumentacji: Thorsten Rinne, Bastian Poettner
Ostatnia zmiana: 06.05.2003

Poszukujemy ochotnik�w, kt�rzy zechc� wykona� kolejne przek�ady dokumentacji.

Podzi�kowania:
Stephan Hochhaus za angloj�zyczn� dokumentacj�,
Matthias Sommerfeld za pomoc przy t�umaczeniu na angielski,
Volodymyr Ganopolskyy za dokumentacj� rosyjskoj�zyczn�,
Erwin Leenheer za przek�ad dokumentacji na holenderski,
Hanne Parusel za grafik� phpMyFAQ,
Kai-Uwe W�rner za testowanie wersji beta,
Siegfried Meffert za pomys�y struktury bazy danych,
zespo�owi IG4 i wszystkim innym stosuj�cym nasze oprogramowanie na swoich stronach WWW

© 2001-2003 Thorsten Rinne und Bastian Poettner

na g�r� strony