Some obsolete docs moved from google code to be reviewed.
authorTomas Mudrunka <tomas@mudrunka.cz>
Fri, 13 Mar 2015 16:22:00 +0000 (17:22 +0100)
committerTomas Mudrunka <tomas@mudrunka.cz>
Fri, 13 Mar 2015 16:22:00 +0000 (17:22 +0100)
HELP.wiki [new file with mode: 0644]

diff --git a/HELP.wiki b/HELP.wiki
new file mode 100644 (file)
index 0000000..4f1af54
--- /dev/null
+++ b/HELP.wiki
@@ -0,0 +1,88 @@
+#summary About/Help; O aplikaci & Jak používat JuKe!Box?
+<wiki:toc />
+
+= English =
+== Copyright ==
+You can find license document on the page called [License].
+
+== Not jet! ==
+
+= Česky =
+== Autorská práva ==
+Licenční ustanovení týkající se tohoto programu naleznete na stránce [License].
+
+Pokud je pomocí tohoto webu (myšleno aplikace jukebox) zpřístupněn materiál, jehož stažením se vy nebo poskytovatel dopouštíte porušení autorských práv, tento obsah nestahujete!
+Instalací nebo používáním aplikace potvrzujete, že jste s právy srozuměni a že je akceptujete. V opačném případě aplikaci nepoužívejte ani neinstalujte.
+
+== Základy Ovládání ==
+Na úvodní stránce vidíte výpis souborů a adresářů (označeny "DIR").
+Kliknutím na jméno souboru zahájíte stahování.
+Kliknutím na jméno adresáře vstoupíte do adresáře.
+Pokud zobrazený adresář obsahuje soubor index.html nebo index.txt, bude tento zobrazen nad výpisem.
+Vedle každého adresáře nebo hudebního souboru najdete písmenka, pomocí kterých můžete spustit příslušnou akci.
+
+
+=== Tady je krátký přehled významu jednotlivých písmenek ===
+{{{
+P - Přehrát (je nutné stáhnout playlist.m3u a otevřít v přehrávači hudby - např. Winamp, to se dá po nastavení prohlížeče dělat automaticky...)
+  - U složek tato volba přehraje všechny zvukové soubory, které složka obsahuje
+R - To samé jako P, ale přehraje se i hudba v podsložkách (POZOR! raději nepoštět na velké adresáře!!!)
+D - Otevře nadřazenou složku pro daný soubor (pouze u vyhledávání)
+F - Spustí přehrávání v prohlížeči (vyžaduje flash), otevřete odkaz v novém okně, pokud si chcete dál prohlížet knihovnu...
+S - Zastaví přehrávání v prohlížeči
+}}}
+== Vyhledávání ==
+
+Před prvním vyhledáváním je potřeba vytvořit cache a nastavit ji práva pr zápis.
+Potom je soubor s cache třeba obnovovat (na stránce vyhledávání se zadá heslo pro obnovení/vytvoření db a stiskne se "refresh cache").
+Na Linuxu se může dát obnovování cache do cronu jako skript používající příkaz find, databáze tak bude udržována stále aktuální.
+Při vyhledávání je možné použít regulární výrazy (mezery budou nahrazeny řetězcem {{{'(.*)'}}} !!!).
+Kromě vyhledávání hudby v lokálním archivu skript také umožňuje vyhledávání hudby a textů písní na www.
+Je limitován počet souborů, u kterých se při vyhledávání zobrazuje velikost. (To by vylučovalo funkci cache - cachovat velikost se mi ale nechce).
+Kromě vyhledávání lze z databáze také vygenerovat (pseudo)náhodný playlist.
+
+== Nastavení automatického přehrávání v oblíbeném přehrávači ==
+http://img181.imageshack.us/img181/9925/autoplayzo6.png
+
+== Přihlašování ==
+
+Pokud je povolen přihašovací modul, budete při prvním otevření stránky vyzváni k zadání příslušných údajů.
+Odhlášení provedete kliknutím na odkaz "LOGOUT" v horním menu.
+
+== Instalace ==
+
+Instalace se provádí nakopírováním souborů do adresáře přístupného webovému servru,
+upravením nastavení ve zdrojovém souboru a přihlašovacím modulu (http_auth.php).
+Pro zakázání přihlašovacího modulu smažte první řádek kódu (obsahuje http_auth.php).
+a správným nastavením přístupových práv daným souborům.
+Také doporučuji nastavit php open base dir pro pojisteni pred directory traversingem do nadrazenych adresaru...
+
+=== Přehled vlastností v hlavním souboru ===
+{{{
+$title =                Nadpis stránky
+$music_dir =            Relativní cesta k adresáři s hudbout
+$music_dir_url =        URL pro přístup k hudbě z venku
+$cache_passwd =         Heslo pro obnovení vyhledávací cache
+$access_limit =                Maximální počet souborů zpracovaných bez použití cache (při vyhledávání)
+$default_random_count = Výchozí počet v náhodném playlistu        
+$sort =                 Povolit abecedni razeni? 0=ne, 1=jen playlisty, 2=playlisty i listingy, 3=vse i vyhledavani
+                       - Razeni je potreba pouzivat s rozvahou s ohledem na zatez CPU a RAM (coz muze byt omezeno nastavenim serveru/php)
+                       - Razeni vyhledavaci databaze muze byt narocnejsi zvlaste u rozsahlejsich hudebnich knihoven
+                         - V takovem pripade je vhodne ho zakazat, nebo pouzit k razeni shellove skripty
+
+$playlist_name =        Jméno generovaného playlistu
+$m3u_exts =             Přípony souborů, které se zobrazí v playlistu a ve vyhledávání
+
+$indexlist =            Pole se jmény souborů, které se mají případně zobrazit před výpisem složky
+$bonus_dir =            Adresář s pomocnými soubory
+$search_cache =         Cesta k vyhledávací cache
+$flash_player =         Cesta k swf souboru webového přehrávače
+$css_file =             Cesta k CSS stylu
+}}}
+
+== Něco nefunguje ==
+
+  * Skript - potřebujete webserver s podporou PHP
+  * Vyhledávání - skript nemá práva pro zápis/čtení databáze, nebo databáze ještě nebyla vytvořená...
+  * Přehrávání v prohlížeči - není přítomný swf soubor přehrávače, prohlížeč nepodporuje flash, nebo inline framy...
+  * Něco jiného - RTFM && UTFS && UTFG...
This page took 0.103849 seconds and 4 git commands to generate.