Středoškolská odborná činnost 2008/2009
Obor 18 – Informatika
školák Piš a sdílej své sešity, jednoduše, rychle, v pohodě.
Uživatelská příručka
Autoři: Jiří Hon a Lukáš Helebrandt 2008/2009 7. A Mendelovo gymnázium, Opava, příspěvková organizace Komenského 5, Opava, 746 01
Obsah 1 Úvod...................................................................................................................................................3 2 Vytváření zápisků..............................................................................................................................3 3 Nápověda k desktopové aplikaci.......................................................................................................4 3.1 Instalace.....................................................................................................................................4 3.1.1 Pod Linuxem.......................................................................................................................4 3.1.2 Pod Windows......................................................................................................................4 3.2 Ovládání.....................................................................................................................................4 3.2.1 Spuštění..............................................................................................................................4 3.2.2 Import nových sešitů.........................................................................................................4 3.2.3 Nastavení přihlašovacích údajů.........................................................................................5 3.2.4 Upload na server................................................................................................................5 4 Nápověda k serverové aplikaci..........................................................................................................6 4.1 Instalace.....................................................................................................................................6 4.2 Struktura....................................................................................................................................7 4.3 Ovládání.....................................................................................................................................7 5 Úvod do Texy.....................................................................................................................................8 5.1 Odstavce textu............................................................................................................................8 5.2 Titulky........................................................................................................................................8 5.3 Horizontální čáry.......................................................................................................................9 5.4 Vypnutí Texy..............................................................................................................................9 5.5 Citace........................................................................................................................................10 5.6 Odkazy......................................................................................................................................10 5.7 Fráze.........................................................................................................................................10 5.8 Přímé HTML.............................................................................................................................11 5.9 Seznamy....................................................................................................................................11 5.9.1 Číslované seznamy.............................................................................................................11 5.9.2 Vnořené seznamy.............................................................................................................12 5.9.3 Definiční seznam..............................................................................................................12 5.10 Modifikátory...........................................................................................................................12 5.11 Typografie...............................................................................................................................13 5.11.1 Klikatelné webové adresy.................................................................................................14 5.12 Rozdělení velmi dlouhých slov...............................................................................................14 5.13 Tabulky...................................................................................................................................14 5.13.1 Sloučení sloupců..............................................................................................................15 5.13.2 Sloučení řádků................................................................................................................15 6 Seznam použité literatury................................................................................................................16
školák − uživatelská příručka
1
© 2009 jiří hon, lukáš helebrandt
Úvod
Cílem této uživatelské příručky je osvětlit princip fungování aplikace školák pro zapisování a publikaci zápisků a osvojení základního ovládání a instalace desktopové i serverové části. V příručce naleznete i základní popis syntaxe Texy.
2
Vytváření zápisků
Při vytváření zápisků se držte těchto bodů: 1. Zápisky můžete vytvářet v kterémkoliv textovém editoru (OpenOffice Writer, Microsoft Word, Poznámkový blok, aj.). Vyberte si jednoduše ten, na který jste zvyklí. 2. Využívejte Texy syntaxe (více informací v kapitole Úvod do Texy), aby váš text byl přehledný a členěný do nadpisů. 3. Zápisky ukládejte pouze jako textové soubory s koncovkou .txt v kódování UTF-8! Nevíte-li, jak na to, zkušenější uživatelé z vašeho okolí vám jistě rádi poradí. 4. Soubory zápisků nazývejte striktně podle této konvence: RR_MM_DD_libovolny_popisek.txt Kde RR, MM a DD jsou postupně dvojčíselnou reprezentací roku, měsíce a dne, kdy byl zápisek vytvořen. Díky tomu se vám budou soubory ve složce sešitu automaticky řadit podle data. Jiný formát názvu souborů způsobí, že si jej desktopová aplikace nevšimne a nenahraje na server. 5. Nemíchejte zápisky z různých předmětů; pro každý předmět (téma) vytvořte vlastní složku. Názvy složek uvádějte bez háčků a čárek, nejlépe s podtržítky – vyhnete se tak nechtěným problémům. 6. Osvědčila se nám tato struktura složek: • 6.A_07_09/ • Anglictina/ • … • 7.A_08-09/ • Anglictina/ • Dějepis/ • … Pokud jste se drželi všech těchto kroků, máte vše připraveno k bezproblémovému nahrání zápisků na internet.
3
školák − uživatelská příručka
3
© 2009 jiří hon, lukáš helebrandt
Nápověda k desktopové aplikaci
V této kapitole se dozvíte jak instalovat a ovládat aplikaci pro nahrávání zápisků na internet.
3.1
Instalace
Poznámka: Veškeré potřebné soubory najdete ve složce skolak-desktop/. Aplikace byla otestována na operačních systémech Linux a Windows s verzí Pythonu 2.5 (obsažena ve většině aktuálních linuxových instalací) a PyQT 4.4.x.
3.1.1
Pod Linuxem
Python máte téměř jistě obsažen v základní instalaci, pomocí balíčkovacího systému nainstalujte knihovnu PyQT4. Rozbalte přiložené zdrojové kódy, přidejte souboru skolak_upload_sesitu.py práva na spuštění (v konzoli jednoduše chmod +x skolak_upload_sesitu.py) a spusťte: v grafickém prostředí jednoduše poklepáním na skolak_upload_sesitu.py, v konzoli přejděte do adresáře s programem a spusťte pomocí ./skolak_upload_sesitu.py.
3.1.2
Pod Windows
Je potřeba stáhnout a nainstalovat nejprve Python 2.5 (http://www.python.org/ftp/python/2.5.4/ python-2.5.4.msi) a poté PyQT4 (http://www.riverbankcomputing.co.uk/static/Downloads/PyQt4/PyQt-Py2.5-gpl-4.4.3-1.exe). Rozbalte soubory programu do libovolné složky, otevřete ji a spusťte poklepáním na skolak_upload_sesitu.py.
3.2 3.2.1
Ovládání Spuštění
Po spuštění program načte seznam již dříve importovaných sešitů, které vypíše do hlavního okna. Při prvním spuštění je seznam samozřejmě prázdný.
3.2.2
Import nových sešitů
Po kliknutí na Přidat sešit je potřeba vyplnit název sešitu, lépe řečeno identifikátor sešitu již vytvořeného na serverum, a vybrat složku, ve které se sešit (tzn. textové soubory vytvořené podle výše uvedených pravidel) nachází. Kliknutí na OK se název a cesta uloží.
4
školák − uživatelská příručka
© 2009 jiří hon, lukáš helebrandt
Takto přidáme všechny sešity, které budeme chtít na server nahrávat. Při příštím spuštění aplikace za účelem uploadu nových zápisků pak stačí kliknout na Obnovit.
3.2.3
Nastavení přihlašovacích údajů
Pro úspěšnou synchronizaci je potřeba nastavit uživatelské jméno, heslo a adresu serveru. To lze provést po klepnutí na tlačítko Nastavení. Pro testovací účely byl na serveru vytvořen uživatel soc-test s heslem soc-test, identifikátor pokusného sešitu je test, adresa testovacího serveru je http://skolak.php5.cz/api.
3.2.4
Upload na server
Vše je připraveno, nezbývá než kliknout na „Nahrát na server“ a počkat na zprávu o úspěšném provedení požadavku.
5
školák − uživatelská příručka
4
© 2009 jiří hon, lukáš helebrandt
Nápověda k serverové aplikaci
V této kapitole se dozvíte jak instalovat a ovládat serverovou aplikaci pro prohlížení a tisk zápisků z internetu.
4.1
Instalace
Poznámka: Veškeré potřebné soubory najdete ve složce skolak-server/. Prozatím se instalace provádí ručně. Nemáte-li dostatek zkušeností, nepouštějte se do ní – bude pro vás lepší využít už nastaveného serveru. Můžete například požádat správce sítě vaší školy, aby vám školáka nainstaloval – třeba na doméně skolak.adresa-vasi-skoly.cz. Postup krok za krokem: 1. Importujte do databáze soubor skolak-server/pp/models/install.sql.gz – obsahuje SQL pro vytvoření základních tabulek s prefixem skolak_. 2. Nahrajte obsah složky skolak-server/document_root/ do veřejně přístupné složky na vašem serveru – například na php5.cz se jmenuje www_root/. 3. Nahrajte složky skolak-server/app/ a skolak-server/libs/ do kořene webu, který by měl být nepřístupný veřejnosti (o úroveň výš než složka obsahující skolak-server/document_root/. Výsledná struktura na php5.cz vypadá takto: • app/ • obsah složky skolak-server/app/ • libs/ • obsah složky skolak-server/libs/ • log/ • stats/ • tmp/ • wwwroot/ • obsah složky skolak-server/document_root/ 4. Nastavte práva ke složkám app/temp, app/sessions a app/log na 777. 5. Nastavte údaje pro přístup k databázi v souboru app/config.ini. 6. Vytvořte si uživatele v tabulce skolak_users a sešity v tabulce skolak_books. Heslo uživatele hashujte pomocí algoritmu sha256. 7. Nahrajte na web pár svých zápisků pomocí desktopové aplikace. 8. Gratuluji, zvládli jste nastavit svůj server školák.
6
školák − uživatelská příručka
4.2
© 2009 jiří hon, lukáš helebrandt
Struktura
• Úvodní stránka (výběr uživatele) • Výběr sešitu • Prohlížení sešitu • Poslední zápisek • Podle data • Podle nadpisu • O projektu • Nápověda
4.3
Ovládání
Je velice intuitivní a proto jej není nutné podrobněji popisovat. Budete-li se řídit postranní nápovědou na stránkách s výběrem uživatele a sešitu, bez problémů se dostanete až k zápiskům. Je třeba jen osvětlit chování levého a pravého menu při prohlížení sešitu. 1. V levém menu můžete vybírat zápisky pouze podle data, kdy byly napsány. 2. V pravém menu lze zvolit konkrétní nadpis, či skupinu nadpisů, které chcete zobrazit. S nadpisem se zobrazí i text, který je mezi ním a prvním následujícím nadpisem libovolné úrovně. 3. Skrývaní a odkrývání částí menu zajišťuje JavaScript. Máte-li jej vypnutý, bude vždy celý strom úplně rozbalen. 4. Rodičovský prvek je vždy ten, který má u sebe + nebo − (to podle toho, je-li rozbalený, či nikoliv). 5. Vždy, když označíte rodičovský prvek, označí se všechny prvky, které obsahuje. 6. Rodičovské prvky s datem (2008, 2008-2009, Leden, Únor) se chovají odlišně od ostatních. Nemůžou být nikdy označeny, aniž by nebyly označeny všechny prvky, které obsahují.
7
školák − uživatelská příručka
5
© 2009 jiří hon, lukáš helebrandt
Úvod do Texy
Poznámka: Následující text byl převzat ze stránek http://texy.info/cs/syntax a upraven pro potřeby této příručky. Podrobnější popis syntaxe naleznete zde: http://texy.info/cs/syntax-podrobne. TIP: všechny příklady si můžete online vyzkoušet na http://texy.info/cs/try. Nástroj Texy vznikl původně proto, aby nezkušeným uživatelům umožnil snadno editovat obsah webových stránek. Proto je i syntaxe maximálně intuitivní. Záměrem je, aby byl text i v čisté (nezformátované) formě přehledný a jeho formát tušitelný. Dnes Texy výborně slouží i zkušeným znalcům jazyka HTML. Dovoluje volně kombinovat Texy zápis s HTML značkami. Zkušení uživatelé se tedy nemusí učit nový meta-jazyk a plně využít svých znalostí. Texy jim pouze zjednodušuje práci. Prvotní logikou syntaxe je žádnou syntaxi nepoužívat. Jen psát čistý text. Vkládání rozšířených informací, jako třeba CSS třídy nebo odkazy, nenaruší tok textu. A zapíší se způsobem, který snadno pochopí i netechnicky založení uživatelé.
5.1
Odstavce textu
Za odstavec se považuje jeden nebo více bezprostředně za sebou následujících řádků textu. Odstavce jsou od sebe odděleny prázdným řádkem. První odstavec lorem ipsum dolor sit amet. Druhý odstavec, který tvoří jeden řádek. A druhý řádek textu. Texy je spojí. Zalomení řádku v odstavci docílíte vložením jedné mezery vlevo: Kdoví jestli jestli jsou na měsíci vůbec nějaký stopy a proč kope kolem sebe kdo se topí jakej sval to Zemí otáčí
5.2
Titulky
Titulky je možné zapsat hned dvěma způsoby: podtržením nebo předsazením. Každý titulek má svůj stupeň. V případě podtržení o důležitosti titulku rozhoduje podtrhávací znak. Od nejvyšší po nejnižší jsou to tyto: # * = -
8
školák − uživatelská příručka
© 2009 jiří hon, lukáš helebrandt
Hlavní titulek ************** Podtitulek ========== U titulků zapsaných předsazením určuje úroveň počet předsazených znaků, kterými mohou být # nebo =. Platí: čím méně znaků, tím důležitější titulek (minimum jsou dva znaky, maximum sedm). == Hlavní titulek == ### Podtitulek Jak vidíte v případě podtitulku, znaky vpravo je možné vynechat.
5.3
Horizontální čáry
Texy zná tyto způsoby zápisu: -------********
5.4
Vypnutí Texy
Klíčové slovo html nebo text ovlivňuje, jestli obsah bude chápán jako HTML (včetně značek), nebo prostý text. /---html <em>příklad: **this is not strong** \---
/---text <em>příklad: **this is not strong** \---
9
školák − uživatelská příručka
5.5
© 2009 jiří hon, lukáš helebrandt
Citace
Citace jsou odsazené, podobně jako v emailech, znakem >. > This is a blockquote with two paragraphs. > > 640 K should be enough for everyone
5.6
Odkazy
Odkazy se zapisují tak, že odkazující text uzavřete do uvozovek a následujete dvojtečkou a URL. Texy se snaží inteligentně odhadnout konec URL. Můžete mu i pomoci tím, že URI uzavřete do hranatých závorek. Část http:// je nepovinná. Jako odkaz je možné vkládat i emaily. Texy je transformuje do podoby, která by měla zmást spamboty. Look at "homepage":http://texy.info. Do you know "La Trine":http://latrine.dgx.cz? "Write me":
[email protected]
5.7
Fráze
Asi nejpoužívanější syntax v Texy. Téměř ve všech případech se používá zdvojený znak. TIP: Hvězdičku je efektivní psát zkratkou pravý Alt + -. //kurzíva// nebo *kurzíva* **tučné** x^2 + y^3
kurzíva nebo kurzíva tučné x 2 + y3
10
školák − uživatelská příručka
© 2009 jiří hon, lukáš helebrandt
Texy lze i dočasně vypnout – obsah nebude formátován a zobrazí se doslovně: Odstraňte ''
'' a entitu ''&ndash''
Odstraňte
a entitu &ndash
5.8
Přímé HTML
Texy není náhrada za HTML. Nehledá ani alternativní způsoby zápisu HTML. Cílem je zjednodušit psaní obsahu. Pokud se Vám zdá jednodušší zapsat některou strukturu přímo v HTML, můžete tak učinit. HTML značky jsou plně podporované. This <strong class=info>is strong text.
This is not.
5.9
Seznamy
Odrážkové seznamy zapisujeme pomocí * + nebo -. Musí být zapsán hned na začátku řádku a za ním musí následovat mezera. - Red - Green - Blue
5.9.1
Číslované seznamy
Texy zná těchto pět způsobů zápisu (první dva jsou ekvivalentní): 1) Učit se 2) Učit se 3) Učit se a) Dlouhý b) Široký c) Krátkozraký A) DOS B) Windows C) Linux
11
školák − uživatelská příručka
5.9.2
© 2009 jiří hon, lukáš helebrandt
Vnořené seznamy
a) Bird I) Bird - Red - Green II) McHale III) Parish b) McHale c) Parish 1) Bird 2) McHale
5.9.3
Definiční seznam
Koncert Divokej Bill: - termín: 9. 12. 2004 - místo: Hala Vodová, Brno - cena: 260 Kč
Koncert Divokej Bill termín: 9. 12. 2004 místo: Hala Vodová, Brno cena: 260 Kč
5.10 Modifikátory Jsou nejsilnější zbraní Texy. Lze použít tyto druhy modifikátorů: • (titulek) popisek, přidá objektu titulek (nebo alternativní text obrázkům) • [class1 class2 #id] určující třídu a / nebo ID prvku • {class:blue} přímý zápis stylu • {target:_blank} nebo přímý zápis HTML atributů • horizontální zarovnání: • doleva < • doprava > • vycentrovaný <> • do bloku = • vertikální zarovnání (jen u tabulek): • nahoru ^ • na střed – • dolů _ 12
školák − uživatelská příručka
© 2009 jiří hon, lukáš helebrandt
Modifikátory se zapisují spojitě (bez mezer) a musí jim předcházet tečka. Takže třeba .(popis)[left] nastavuje atribut title na popis a třídu na left. Modifikátory se vždy zapisují zcela doprava. Příklad použití modifikátoru na odstavci textu: Vycentrováno modifikátorem
.<>
Obarveno modifikátorem .{color:blue}
Vycentrováno modifikátorem Obarveno modifikátorem
5.11 Typografie Sem patří všechny úpravy a náhrady textu, které upravují jeho vzhled v souladu s typografickými pravidly a podobně: -
"české" 'typografické' uvozovky pomlčka vs. spojovník: 10-15 vs. česko-slovenský pomlčka: automaticky: jedna – dvě, ručně: zápas Česko--Slovensko typografický křížek u rozměrů 10 x 20 šipky <- a -> a <-> ; tři tečky... zachování HTML entit & náhrady(TM) nebo(R) za příslušné (C) entity
„české“ ‚typografické‘ uvozovky pomlčka vs. spojovník: 10–15 vs. česko-slovenský pomlčka: automaticky: jedna – dvě, ručně: zápas Česko–Slovensko typografický křížek u rozměrů 10×20 šipky ← a → a ↔ ; tři tečky… zachování HTML entit & náhrady™ nebo® za příslušné © entity Práce s mezerami: - vkládání nezalomitelných mezer za jednopísmenné předložky (v autě u okna) - nedělitelné mezery u telefonních čísel +420 776 552 046
13
školák − uživatelská příručka
© 2009 jiří hon, lukáš helebrandt
• vkládání nezalomitelných mezer za jednopísmenné předložky (v autě u okna) • nedělitelné mezery u telefonních čísel +420 776 552 046 Poznámka: Nahrazování se obvykle řídí dalšími pravidly, které určují, kdy symbol nahradit a kdy ne. Například šipka -> nemůže být na konci řádku atd. Proto nebuďte překvapeni, když v některých případech Texy náhradu neprovede.
5.11.1 Klikatelné webové adresy Automatický převod webových adres a emailů do klikatelné formy: další informace na www.dgx.cz a také ...
další informace na www.dgx.cz a také …
5.12 Rozdělení velmi dlouhých slov Velmi zajímavá a důležitá funkce Texy. Dlouhá slova mohou narušit vzhled stránky, proto je vhodné prohlížeči naznačit, kde je může zalomit. Texy tyto místa hledá s přihlédnutím k národním zvyklostem → rozděluje slovo podle slabik: nejneobhospodařovávatelnějšími
nejneobhospodařovávatelnějšími Poznámka: Limit délky slova je volitelný.
5.13 Tabulky Příklad jednoduché tabulky, sloupce se oddělují znakem | | První sloupec | Druhý sloupec | Třetí sloupec | Adam | Eva | Franta Výsledkem je: První sloupec
Druhý sloupec
Třetí sloupec
Adam
Eva
Franta
14
školák − uživatelská příručka
© 2009 jiří hon, lukáš helebrandt
Hlavičku tabulky můžeme definovat tímto zápisem: |----------------------------| Jméno | Příjmení | Věk |----------------------------| Jesus | Christ | 33 | Cecílie | Svobodová | 74
Jméno
Příjmení
Věk
Jesus
Christ
33
Cecílie
Svobodová
74
5.13.1 Sloučení sloupců Všimněte si zdvojeného || | Jméno || Věk |----------------------------| Jesus | Christ | 33
Jméno Jesus
Věk
Christ
33
5.13.2 Sloučení řádků Všimněte si znaku ^ symbolizujícího směr nahoru: | Jméno | Příjmení | Věk |----------------------------| Bill || 50 | ^| 52 | Jim | Beam | 70
First Name
Last Name
Age 50
Bill 52 Jim
Beam
70
15
školák − uživatelská příručka
6
© 2009 jiří hon, lukáš helebrandt
Seznam použité literatury
Texy!: Syntaxe (online) [cit. 15. 3. 2009]. Dostupné z URL: http://texy.info/cs/syntax
16