What is phpMyFAQ ?
Free Download
38 translations[ phpMyFAQ Dokumentace ]
(platné pro verze: 1.3.0 a vyšší)
- Úvod
- Instalace
- Upgrade
- Upgrade phpMyFAQ 1.1.x
- Upgrade phpMyFAQ 1.2.x
- Úpravy šablon pro phpMyFAQ 1.3.x
- Upgrade phpMyFAQ 1.3.x
- Správa
- Správa Uživatelů
- Správa Záznamů
- Správa Kategorií
- Správa Novinek
- Editace nezodpovězených otázek
- Statistiky hodnocení
- Cookies
- Zobrazení Seancí
- Zobrazení Adminlogu
- Změna hesel
- Konfigurace
- Zálohy
- Export FAQ
- Odhlášení
- Modifikace Layoutu, Šablony a Styly
- Ještě jedna věc
phpMyFAQ je vícejazyčný, kompletně databázově řízený FAQ-systém. Zatímco MySQL databáze (podpora dalších databází je ve vývoji) je použita k ukládání dat, PHP 4.1.0 (nebo vyšší) je třeba pro přístup k těmto datům. phpMyFAQ dále nabízí systém pro správu obsahu, multiuživatelskou podporu, systém novinek, sledování uživatelů, jazykové moduly, šablony, podporu XML, podporu PDF, systém zálohování a snadno použitelný instalační skript.
Tento dokument by vám měl pomoci s instalací a správou phpMyFAQ.
phpMyFAQ je vydaný pod Mozilla Public License Version 1.1 (MPL). Tato licence vám zaručuje bezplatné používání phpMyFAQ, přístup ke zdrojovému kódu a právo upravovat a distribuovat phpMyFAQ.
Jediné omezení se týká copyrightu, který stále náleží Bastianu Poettnerovi a Thorstenu Rinne. Každá modifikovaná verze phpMyFAQ bude také spadat pod MPL. Jakýkoliv jiný program, který pouze přistupuje k některým funkcím phpMyFAQ není tímto omezením ovlivněn a může být distribuován pod kterýmkoliv typem licence.
Komerční použití, nebo komerční distribuce phpMyFAQ, např. na CD-ROMu je povoleno pokud jsou splněny výše uvedené podmínky.
Rozhodli jsme se pro použití MPL jakožto modelu licencování phpMyFAQ, protože cítíme, že je to dobrý kompromis mezi otevřeností a volností distribuce na straně jedné a možnost interakce s jiným software bez ohledu na použitý model licencování. V porovnání s ostatními licenčními modely, jeho text je krátký a snadno srozumitelný i pro nováčky.
Pokud se dostanete do nějakých problémů s phpMyFAQ, podívejte se do našeho fóra na www.phpmyfaq.de. Neposkytujeme žádnou podporu telefonem ani e-mailem, prosíme netelefonujte nám.
© 2001 - 2003 Bastian Poettner a Thorsten Rinne pod Mozilla Public License.
Všechna práva vyhrazena.
phpMyFAQ adresuje MySQL databázi pomocí PHP4. Pro instalaci budete potřebovat webserver, který splňuje následující požadavky:
- PHP4 Verze 4.1.0 nebo vyšší (Poznámka: phpMyFAQ 1.3.x nebude fungovat pod PHP 4.0.x)
- MySQL Verze 3.23.23 nebo vyšší
- tuto dokumentaci
Zjistit které verze běží na vašem webserveru můžete vytvořením souboru s názvem info.php a následujícím obsahem:
<?php phpinfo(); ?>
Zkopírujte tento soubor do svého www prostoru a otevřete jej internetovým prohlížečem. Nyní vidíte čísla verzí PHP a MySQL. Instalační skript kontroluje, které verze PHP a MySQL jsou na serveru nainstalovány. Pokud váš webserver nesplňuje požadavky, instalační proces nebude dokončen.
V případě že máte nainstalováno PHP3, nebo PHP 4.0.x, nemůžete phpMyFAQ použít.
Pro zobrazení FAQ stránek budete potřebovat webový prohlížeč třetí generace (např. Netscape 3.01). Formátování kaskádními styly bude viditelné pouze v současných prohlížečích jako Netscape 6, nebo Internet Explorer 5. Pro možnosti tisku musí být povolen JavaScript a je třeba Internet Explorer alespoň ve verzi 5.
phpMyFAQ získáte v komprimovaném archivu .zip. Tento archiv rozbalte na svůj disk. Přehled všech obsažených souborů je vypsán v souboru phpmyfaq.txt.
Layout phpMyFAQ můžete modifikovat s použitím šablon. Popis jak na to najdete níže. S použitím FTP nakopírujte všechny rozbalené soubory do adresáře na vašem webserveru. Dobrou volbou by mohl být adresář faq/.
Důležité:
V tomto adresáři je nutné mít právo zapisovat, aby mohl skript v průběhu instalace nakonfigurovat soubory data.php a config.php.
Otevřte webový prohlížeč a zadejte následující URL:
http://www.vasedomena.cz/faq/install/installer.php
Nahraďte www.vasedomena.cz svým názvem domény. Když se stránka načte, zadejte adresu vašeho MySQL serveru (např. db.provider.com), vaše uživatelské jméno a heslo do MySQL a jméno databáze. Předponu vyplňovat nemusíte. Pokud plánujete použití několika FAQ v jedné databázi, budete muset použít předponu (např. sport pro sport-FAQ, mobil pro mobil-FAQ, atd.). Berte prosím v potaz, že jako předpona mohou být použity pouze písmena a podtržítko: "_". Když chcete používat více FAQ systémů, musíte je nakopírovat nezávisle do jiných adresářů (např. faq1/, faq2/, faq3/ atd.). Klikněte na tlačítko "install" pro inicializaci tabulek ve vaší databázi.
Když jste již úspěšně nainstalovali FAQ, musíte vymazat adresář /install! Veřejnou oblast vašeho FAQ systému nyní můžete navštívit zadáním
http://www.vasedomena.cz/faq/index.php
do adresního řádku vašeho prohlížeče. Váš FAQ bude prázdný a zobrazen ve standartním layoutu. Pro konfiguraci phpMyFAQ naveďte váš prohlížeč na
http://www.vasedomena.cz/faq/admin/index.php
. Pro první přihlášení do administrace použijte login admin a heslo admin. V zájmu vaší vlastní bezpečnosti byste toto heslo měli hned teď změnit.
Ohledně funkce vyhledávání:
Fulltextové vyhledávání funguje jen pokud jsou v databázi nějaké záznamy (5 a víc). Výraz který hledáte by také neměl být ve více než 50% všech záznamů, jinak bude automaticky z hledání vyloučen. Tohle není chyba, spíše vlastnost MySQL.
Nastavení PHP:
Pokud máte možnost editace souboru php.ini, zkontrolujte zda je nastavena proměnná file_upload = On, jinak nebude fungovat upload příloh.
Upgradovat na phpMyFAQ 1.3.0 je možné z následujících verzí:
- phpMyFAQ 1.1.x
- phpMyFAQ 1.2.x
Upgrade z phpMyFAQ 1.1.x je velmi jednoduchá. Pomocí FTP smažte všechny soubory vyjma:
- souborů data.php a config.php v adresáři inc/
Zkopírujte nové soubory do vašeho www prostoru a do prohlížeče zadejte následující URL:
http://www.vasedomena.cz/faq/install/update.php
Vyberte verzi vašeho nainstalovaného phpMyFAQ a klikněte na tlačítko vašeho update-skriptu. Vaše verze bude automaticky zaktualizována. Nezapomeňte po aktualizaci vymazat adresář /install! Pro první přihlášení do sekce správy použijte login admin a heslo admin. Nezapomeňte heslo při nejbližší příležitosti změnit.
Upgrade z phpMyFAQ 1.2.x je velmi jednoduchá. Pomocí FTP smažte všechny soubory vyjma:
- souborů data.php a config.php v adresáři inc/
- vašeho layoutu v adresáři template/
Zkopírujte nové soubory do vašeho www prostoru a do prohlížeče zadejte následující URL:
http://www.vasedomena.cz/faq/install/update.php
Vyberte verzi vašeho nainstalovaného phpMyFAQ a klikněte na tlačítko vašeho update-skriptu. Vaše verze bude automaticky zaktualizována. Nezapomeňte po aktualizaci vymazat adresář /install! Pro první přihlášení do sekce správy použijte login admin a heslo admin. Nezapomeňte heslo při nejbližší příležitosti změnit.
Pro použití vašich dosavadních šablon s phpMyFAQ 1.3.0 je budete muset přizpůsobit. Pro více informací čtěte následující odstavec.
3.c. Úprava Šablon pro phpMyFAQ 1.3.x
phpMyFAQ 1.3.0 obsahuje podporu PDF a podporu vícejazyčných FAQ systémů, šablony z verze 1.2.x proto musí být kvůli těmto novým vlastnostem upraveny. Změněny byly následující šablony:
- template/artikel.html
- template/index.html
- template/style.css
- template/writecomment.html
Pro předejití problémům prosím použijte šablonu obsaženou ve verzi 1.3.0 a přizpůsobte ji vašemu layoutu.
Změňte část JavaScriptu a vyměňte starý kód za nový mezi <script language="JavaScript" type="text/javascript"> a </script>, jinak nebude fungovat tisk.
Budete muset přidat CSS hodnoty pro oblasti <pre>, ty můžete zkopírovat z originálního souboru style.css.
Pro předejití problémům prosím použijte šablonu obsaženou ve verzi 1.3.0 a přizpůsobte ji vašemu layoutu.
Aktualizace phpMyFAQ 1.2.x je velmi jednoduchá. Pomocí FTP smažte všechny soubory vyjma:
- souborů data.php a config.php v adresáři inc/
- vašeho layoutu v adresáři template/
V prohlížeči otevřete následující URL:
http://www.vasedomena.cz/faq/install/update.php
Vyberte verzi vašeho nainstalovaného phpMyFAQ a klikněte na tlačítko vašeho update-skriptu. Vaše verze bude automaticky zaktualizována. Nezapomeňte po aktualizaci vymazat adresář /install!
Správa phpMyFAQ je prováděna kompletně ve webovém rozhraní. Admin sekci naleznete na této URL:
http://www.vasedomena.cz/faq/admin/index.php
Zadáním vašeho uživatelského jména a hesla se můžete přihlásit do systému. Na hlavní stránce můžete vidět admin menu na levé straně a statistiky o návštěvách, záznamech a komentářích na straně pravé. Menu obsahuje následující sekce:
- Správa Uživatelů
- Vytváření záznamů
- Schvalování záznamů
- Editace záznamů
- Správa kategorií
- Přidat Novinky
- Editovat Novinky
- Editovat nezodpovězené
- Statistiky hodnocení
- Cookies
- Zobraz Seance
- Zobraz Adminlog
- Změna Hesla
- Editace Nastavení
- Zálohy
- Odhlášení
- Hlavní Strana
phpMyFAQ nabízí flexibilní správu práv a privilegií různých uživatelů v admin sekci. Uživatelům je možné přiřazovat různá práva. Tato práva jsou navržena velmi detailně, takže můžete jednomu uživateli povolit editovat záznam, ale nikoliv jej smazat. Je velmi důležité zvážit jaká práva by měl mít který konkrétní uživatel. Je možné editovat záznam tak, že vymažete veškerý jeho obsah, což je stejné jako byste jej celý vymazali. V phpMyFAQ není počet uživatelů nijak omezen.
Na hlavní obrazovce Správy Uživatelů vidíte přehlet všech aktivních uživatelských profilů, kde kombinace znaků "1" a "0" reprezentují práva uživatele. Znak "1" symbolizuje, že uživatel tímto oprávněním disponuje, naopak "0" symbolizuje, že uživatel tuto akci nemůže provést. Pořadí je stejné jako ve výpisu oprávnění při vytváření nebo editaci uživatele.
Mějte na paměti, že noví uživatelé nemají vůbec žádná práva, musíte jim je teprve přiřadit editací uživatelského profilu. Uživatele admin nelze smazat, není možné ani změnit jeho jméno.
- vytváření záznamů
Přímo v admin sekci můžete vytvářet záznamy. Vytvořené záznamy NEJSOU standartně zveřejněny. Význam jednotlivých polí je následující:
- Téma
Toto je otázka, nebo nadpis záznamu. - Obsah
Obsah - je odpovědí na otázku, nebo řešením problému. Pro formátování textu je možné použít některé standartní HTML tagy. Některé z nich:
- <b>...</b> - tučně
- <i>...</i> - kurziva
- <u>...</u> - podtržení
- <a href="http://www.url.com">...</a> - odkaz na http://www.url.com
Ostatní HTML tagy jsou z bezpečnostních důvodů filtrovány. Pro formátování můžete také použít BB kód.
Pokud pro váš FAQ zaktivujete podporu BB kódů, nebude již možné používat HTML tagy. BB kódy jsou:
- [b]...[/b] - tučně
- [i]...[/i] - kurziva
- [u]...[/u] - podtržení
- [ul]...[/ul] - vytvoří seznam. Jednotlivé body seznamu můžete vkládat takto: [li]bulletpoint 1[/li] within a [ul] environment
- [center]...[/center] - vycentrování
- [code]...[/code] - preformátovaný text - pro příklady kódu apod.
- [php]...[/php] - preformátovaný text - pro příklady PHP kódu (včetně zvýraznění syntaxe)
- [img]...[/img] - vloží obrázek ze zadané URL jako např. http://www.url.com/picture.jpg
- [url]www.phpmyfaq.de[/url] - odkaz na http://www.phpmyfaq.de, otevře se v novém okně
- [url=http://www.phpmyfaq.de]named link[/url] - named link na phpMyFAQ, otevře se v novém okně
- všechny odkazy jsou automaticky převáděny na funkční linky.
Pokud jsou BB kódy aktivovány, ve veřejné oblasti vašeho FAQ se zobrazí stránka help s instrukcemi. BB-Kódy musí být zadávány výhradně malými písmeny!
- Soubor
Do záznamu lze také přiložit soubor. Na tyto přílohy může být odkazováno ze záznamů. Pokud na přílohu neexistuje žádný odkaz, zůstává neviditelnou. - Jazyk
- Klíčová slova
Klíčová slova jsou důležitá pro vyhledávání v databázi. V případě že jste nějaké specifické slovo neuvedli přímo v záznamu, ale je úzce spjato s tématem, můžete jej vložit jako klíčové slovo, takže se záznam zobrazí mezi výsledky vyhledávání. Je také možné vkládat klíčová slova, která se tématu zcela přesně netýkají tak, aby i špatně zadané vyhledávání vedlo ke správným výsledkům. - Autor
Je možné specifikovat autora vašich záznamů. Právě teď toto pole není zobrazeno, slouží pouze interním účelům. - Kategorie
Na tomto nastavení závisí místo v hierarchii FAQ, kde bude tento záznam zobrazen. - Aktivní?
Pokud je záznam "aktivní", je viditelný ve veřejné sekci a je obsažen ve vyhledávání. Když je "deaktivovaný", nebude viditelný. Navrhované záznamy jsou standartně "deaktivovány" aby bylo zabráněno možnému zneužití. - Datum
Datum poslední změny. - Změněno?
Toto pole je rezervováno pro komentáře jaké změny byly prováděny s tímto záznamem. Pomáhá správcům být v obraze, co se se záznamem dělo v průběhu času. Veškeré informace vložené sem zůstávají neviditelné ve veřejné sekci. - Changelog
Changelog zaznamenává všechny předchozí změny včetně uživatele a datumu změny. - schválení záznamů
Všechny záznamy v databázi které nejsou aktivní (a tím pádem neviditelné pro veřejnost) jsou zobrazeny zde. Obsah navržený návštěvníky zde bude umístěn také. Ke schválení záznamu klikněte na záznam pro editaci. Změňte jej na "aktivní" aby se staly viditelnými. Zde můžete záznamy také mazat. - editace záznamů
Zde jsou zobrazeny všechny dostupné záznamy. Kliknutím na záznam se zobrazí stejné rozhraní jako když zadáváte nový záznam, tentokrát však se všemi daty obsaženými v konkrétním záznamu.
Můžete si zvolit jazyk vašeho záznamu, standartně bude vybrán jazyk prohlížeče. Lze vkládat i vícejazyčné záznamy: Napište záznam v Češtině (nebo jakémkoiv jiném jazyce) a uložte jej. Nyní vyberte edituj záznam a editujte právě vytvořený český záznam. Změňte Téma, Obsah, klíčová slova a změňte jazyk na Angličtinu. Uložte záznam. Nyní když kliknete na edituj záznam, vidíte oba záznamy se stejným ID, ale různými jazyky.
phpMyFAQ vám umožňuje vytvářet různé sekce a podsekce ve vašem FAQ systému. Můžete svoje kategorie také přezkupit do jiného pořadí. Bohužel tato funkce ještě není dokončena.
phpMyFAQ nabízí možnost zobrazovat na hlavní stránce vašeho FAQ novinky. V admin sekci můžete vytvářet nové, editovat stávající, nebo je mazat.
4.e. Editace nezodpovězených (otevřených) dotazů
phpMyFAQ umožňuje návštěvníkům přispívat do FAQ kladením otázek. Každý návštěvník má možnost vidět tyto nezodpovězené (otevřené) dotazy ve veřejné sekci a může na ně odpovídat. Pokud se chcete o otevřené dotazy postarat, můžete tak učinit v této sekci. Můžete také položit otázku, sám na ni odpovědět a zde ji vložit do FAQ.
Pod každým záznamem mají návštěvníci možnost ohodnotit kvalitu článku hodnocením od 1 do 5ti (kde 1 je nejhorší a 5 nejlepší hodnocení). Ve statistikách je zobrazeno průměrné hodnocení u všech hodnocených záznamů. Pro okamžitý rychlý přehled jsou záznamy s průměrným hodnocením 2 a méně vyznačeny červeně a záznamy s průměrem 4 a víc zeleně.
phpMyFAQ může uložit vaše přihlašovací informace do admin sekce jako cookie na vašem počítači. Tato vlastnost může být velmi pohodlná, nicméně je to potenciální bezpečnostní trhlina. Cookies používejte pouze v případě že jste jediným uživatelem vašeho počítače.
Tato funkce vám umožňuje sledovat vaše návštěvníky. Každý návštěvník při vstupu na hlavní stránku obdrží id, které ho identifikuje po celou dobu jeho návštěvy. S pomocí zde získaných informací můžete vysledovat způsob jakým váš FAQ systém návštěvníci používají a učinit odpovídající změny v kategoriích, obsahu nebo klíčových slovech. Je zde také vyhledávací funkce, kterou můžete použít k vyhledání konkrétní IP adresy, minimální počet akcí nebo datum návštěvy.
Adminlog umožňuje sledovat všechny akce provedené uživateli v admin sekci phpMyFAQ. Pokud máte pocit že máte v systému nezvaného hosta, můžete se ujistit prohledáním adminlogu.
Tato sekce umožňuje změnu hesla. Tuto funkci je možné určitým uživatelům znepřístupnit, což má význam u skupinových uživatelských účtů. Ke změně hesla musíte mít pro tohoto uživatele změnu hesla povolenu.
Zde můžete editovat základní nastavení phpMyFAQ. Barvy a layout zde editovat nelze. Mějte prosím na paměti, že nebudete moci používat HTML tagy k formátování záznamů aktivujete-li podporu BB-kódů!
Chcete-li zadat v konfiguraci více e-mail adres, oddělte je čárkou (",").
Použitím funkce zálohy je možné vytvořit kopii databáze do jediného souboru. To umožňuje obnovení vašeho FAQ systému po možné havárii, nebo přesunutí z jednoho serveru na jiný. Doporučujeme dělat zálohy vašeho systému FAQ pravidelně.
- záloha dat
Záloha všech dat obsahuje všechny záznamy, uživatele, komentáře, atd. - záloha LOGů
Bude uložen adminlog a seance návštěv (všehcny LOG soubory). Tyto informace nejsou nutné k fungování phpMyFAQ, slouží pouze ke statistickým účelům. - vytvoř XML soubor
Zde můžete zapsat všechny záznamy do XML souboru. Výsledný soubor naleznete v adresáři xml/phpmyfaq.xml. Nástroj pro importování těchno XML souborů je ve vývoji.
Možná zamýšlíte zobrazovat novinky, TOP 10, nebo nejnovější záznamy na vaší webové stránce. Pro tyto případy můžete využít export některých částí do RSS feedu. RSS je publikační formát webového obsahu. Jeho název je zkratkou Really Simple Syndication (Opravdu Snadné Publikování). RSS je dialektem XML.
Na naší download page naleznete PHP skript, který umí číst RSS feeds, můžete jej použít na svých stránkách. Napřed musíte vytvořit RSS soubory v Exportuj FAQ v admin sekci. Soubory naleznete v adresáři xml/. Vytvoříte tím následující soubory:
- xml/news.xml pro Novinky
- xml/topten.xml pro Top 10
- xml/latest.xml pro nové záznamy
Kliknutím na Odhlášení ukončíte svoji aktuální seanci. Před zavřením okna prohlížeče doporučujeme odhlásit se tímto způsobem, abyste zamezili možnému zneužití.
5. Úpravy Layoutu, Šablony a Styly
Od verze 1.2.0 jsou kód a layout téměř úplně odděleny. Layout je založen na několika šablonách které můžete upravovat dle svých potřeb. Nejdůležitější soubory layoutu phpMyFAQ naleznete v adresáři template/.
Poznámka: Použitím šablon není možné změnit layout admin sekce. Máte-li potřebu změnit něco na vzhledu admin sekce, musíte zeditovat přímo soubor admin.php. Mějte na paměti, že veškeré změny které provedete v souboru admin.php budou ztraceny po aktualizaci phpMyFAQ na vyšší verzi.
5.a. Soubor template/index.html
Standartní layout phpMyFAQ je uložen v souboru index.html. Je to běžný HTML soubor obsahující proměnné ve složených závorkách.
Příklad:
<td width="200" class="little" align="center">{userOnline}</td>
Template-parser zkonvertuje {userOnline} na aktuální počet online návštěvníků.
Šablonu můžete měnit dle vašich přání, ale měli byste si zachovat kopii původního souboru pro případ, že se něco nepovede. Teoreticky můžete k modifikaci šablony použít kterýkoliv dostupný editor. Zkušební použití Dreamweaveru bylo úspěšné. Modifikace provedené v MS Frontpage, Adobe GoLive, nebo NetObjects Fusion mohou šablonu poškodit, protože tyto aplikace mění zdrojový kód.
5.b. Soubor template/style.css
Veškeré formátování jako fonty, barvy a pod. lze upravit v CSS souboru style.css. Více informací naleznete na oficiální stránce W3C.
V případě požadavků z vaší strany můžeme vytvořit více šablon. Navštivte naše fórum pokud máte zájem.
Děkujeme že používáte phpMyFAQ! :-)
Autoři dokumentace: Thorsten Rinne, Bastian Poettner
Překlad: Marty Rudinec
Poslední změna: 10/03/2004
Stále hledáme dobrovolníky pro překlad této dokumentace do dalších jazyků.
Děkujeme:
Stephan Hochhaus za Anglickou dokumentaci,
Matthias Sommerfeld za pomoc s překladem do Angličtiny,
Volodymyr Ganopolskyy za překlad do Ruštiny,
Erwin Leenheer za překlad do Holandštiny a Bugfixing,
Lex za překlad do Francouzštiny,
Krzysztof Kudlacik za překlad do Polštiny,
Rui Barreiros za překlad do Portugalštiny,
Marty Rudinec za překlad do Češtiny,
Hanne Parusel za grafiku záhlaví,
Kai-Uwe Wärner za betatesting,
Siegfried Meffert za nápady týkající se designu databáze,
the members of IG4 a všem kdo používají náš sofrware na svých stránkách!
© 2001-2003 Thorsten Rinne a Bastian Poettner