Hledám spolupracovníka pro psaní dokumentace

David Grudl

Dokumentace se začíná pomalu rodit a docela by se mi hodila pomoc. Hledám dobrovolníka, který by popsal některé ze známějších součástí, jako Nette\Forms, Nette\Web\HttpRequest, Nette\Web\HttpResponse nebo Instalace, …

Text je tvořen v Texy syntaxi, asi v takovéto podobě. Měl by být rozdělen do menších kapitol a začínat obecným úvodem a postupně se dostávat až k podrobnostem, jako tomu je třeba v dokumentaci Zendu. Zatím je potřeba celý popis psát jako jednu dlouhou stránku, rozdělení pak provedu podle nadpisů s úrovní ====.

Od této chvíle máte zcela volný přístup do wiki systému. Věřím, že se to osvědčí.

Díky!

ViliamKopecky

Já bych si nějaké téma vzal…?

David Grudl

Ber dokud jsou!

LM

Díky, že experimentujete s Nette Wiki. Váš experiment fungoval a byl posléze odstraněn.

Pokusil sem se o HttpResponse, pokud najdete chybu či to shledáte celé chybným, tak mě laskavě popravte. : )

David Grudl

LM napsal(a):

Pokusil sem se o HttpResponse, pokud najdete chybu či to shledáte celé chybným, tak mě laskavě popravte. : )

Díky! Dobrá práce.

Honza Marek

Vzal jsem si na paškál Nette\Web\Session. Takže zas prosím o kontrolu.

David Grudl

Honza M. napsal(a):

Vzal jsem si na paškál Nette\Web\Session. Takže zas prosím o kontrolu.

Taky super a děkuju!

Našel jsem téma docela zajímavého Quick Start a právě se ho chystám napsat a později natočit i screencast. Jen to (samo)chválení frameworku mi moc přes pysky něšlo, takže se budu tvářit, že to tam napsal někdo jinej ;)

Jo, ještě na stránku https://editor.texy.info/ jsem dal takovou miniaplikaci pro psaní textů – má to okamžitý náhled a autosave. Možná by se to dalo používat přímo ve wiki editoru zde.

Jan Tvrdík

Jo, ještě na stránku https://editor.texy.info/ jsem dal takovou miniaplikaci pro psaní textů – má to okamžitý náhled a autosave. Možná by se to dalo používat přímo ve wiki editoru zde.

Kdyby tam byla Texyla, jako je to třeba tady na fóru, tak by to bylo ještě lepší.

Jinak ve wiki mi ještě chybí diskuze.

Editoval Jan Tvrdík (11. 9. 2008 13:29)

Jan Tvrdík

Konkrétně v Quick Start máš 2× „Během pár minut“ a celé ty dva odstavce vypadají společně divně:

Tento návod vás seznámí s tvorbou aplikací podle tohoto vzoru. Během pár minut si postavíme jednoduchou blogovací aplikaci s podporou AJAX.

Cílem tohoto návodu bude vytvořit aplikaci pro prohlížení databázových tabulek. Během pár minut postavíme aplikaci s plnou podporou AJAXu a získáme užitečnou znovupoužitelná komponentu.

Pozn.: Přesně na tohle by se hodila ta diskuze.

Honza Marek

BTW chystám novou verzi Texyly, která by měla být mnohem taková lepší a přizpůsobitelnější. Zatím jde ale stáhnout jen ze SVN. Zkusím dopsat nějakou základní dokumentaci a Texylu vydat.

Při psaní dokumentace mi chyběly tlačítka na nadpisy a php kód, který v Texyle jsou :-)

David Grudl

Jan Tvrdík

Jojo :-) Jak vidno, změnil jsem téma tutoriálu (blogy za 15 minut dnes dělá každý, ne?)

romansklenar

David Grudl napsal(a):

Jo, ještě na stránku https://editor.texy.info/ jsem dal takovou miniaplikaci pro psaní textů – má to okamžitý náhled a autosave. Možná by se to dalo používat přímo ve wiki editoru zde.

Obsah z Nette\Forms to už nepřevede

Too long text

David Grudl

Zvednu limit

romansklenar

Super, takže napsáno Nette\Security\Permission a můžeš provést korektůru. Fííha, už zbývá jen oddechové téma Nette\Web\HttpRequest a dokumentace je kompletní :)

Tak snad to pomůže i ostatním ;)

PS: ta dokumentace je fakt žrout času, už se nedivím že se ti do toho moc nechtělo ;) pro člověka co to ovládá je to zabití několika hodin.
Jestli to nějak jde, můžeš klidně smazat revizi 33 a 32, jsou obě ode mě, jsou tam jen změněna odsazení v kódech mezery ↔ tabulátory a pak jsem ty úpravy vzal stejně zpět.

Editoval romansklenar (12. 9. 2008 2:10)

David Grudl

romansklenar napsal(a):

Super, takže napsáno Nette\Security\Permission a můžeš provést korektůru.

Tak to je naprosto špičková práce, gratuluju!

Taky jsem nezahálel :-) Quick start už má osm dílů. Je to vůbec ještě quick start? ;)

ps. ve fóru funguje syntaxe: [[Nette\Debug]] vytvoří odkaz na Nette\Debug, [[Laděnka | Nette\Debug]] vytvoří Laděnka.

piler

Zda sa to len mne, alebo je ten kod dokumentacie zobrazeny malym pismom? Mozno by sa zislo pridat o pixel viac.

Mas3r

Já mam 1680×1050 na 15" displayi a písmo mi přijde spíše větší :) Určitě neměnit

piler

Mas3r napsal(a):

Já mam 1680×1050 na 15" displayi a písmo mi přijde spíše větší :) Určitě neměnit

Mas pravdu, vo FF je to OK. Mensie je to len cez Google Chrome.

LM

Na wiki se začíná objevovat spam… https://doc.nette.org/cs/quickstart?…, vrátil jsem to k předchozí revizi.

David Grudl

Abych zabránil spamu, dal jsem na wiki přihlašování – funguje tam stejné user/pass jako zde na fóru. Také editační lištu jsem přesunul nahoru, aby byla lépe dostupná. A připravuju ještě nějaké další funkce ;)

Každopádně bylo potřeba restrukturalizovat databázi – i když jsem se poctivě snažil zachovat vaše kredity, tak se omlouvám, jestli se mi to někde nepovedlo.

Honza Marek

Davide, v Nette\Debug ti někam zmizely obrázky.

Jan Tvrdík

V Coding standard píšeš:

Use an indent of 4 spaces, with no tabs.

Od revize 7 ale Nette používá tabulátory místo mezer.

EDIT: Starých informací je tam celkem dost (např. NObject místo Nette\Object, NClass jsem ani nikdy neviděl)

Editoval Jan Tvrdík (15. 9. 2008 22:41)

phx

OT: odobne uprednostnuji tab, protoze si to kazdy muze nastavit dle priorit ve svem editoru (tab=mezera o velikosti 2 nebo 4 atd… jak kdo chce). S mezerama se tezko hybe.

piler

Ked pristupujem na https://nette.org/ z UK, tak ma to automaticky presmeruje na https://nette.org/en/ a po kliknuti na dokumentaciu sa zobrazi len prazdna stranka.

romansklenar

piler napsal(a):

Ked pristupujem na https://nette.org/ z UK, tak ma to automaticky presmeruje na https://nette.org/en/ a po kliknuti na dokumentaciu sa zobrazi len prazdna stranka.

Pokud někdo vzpomíná na konferenci php frameworku podzim 2007 tak tam David zmiňuje když dělá ukázky Nette na webu texy.info, že se automaticky detekuje jazyk podle preferovaných jazyků nastavených v prohlížeči (hlavička accept-language) a to je přesně ono :) tak si nastav jiné pořadí preferovaných jazyků v prohlížeči.

Konkrétně je to metoda detectLanguage() třídy HttpRequest jmenného prostoru Nette\Web.

Pokud zbyde čas pokusím se napsat k ní dokumentaci

piler

romansklenar napsal(a):

Pokud někdo vzpomíná na konferenci php frameworku podzim 2007 tak tam David zmiňuje když dělá ukázky Nette na webu texy.info, že se automaticky detekuje jazyk podle preferovaných jazyků nastavených v prohlížeči (hlavička accept-language) a to je přesně ono :) tak si nastav jiné pořadí preferovaných jazyků v prohlížeči.

Konkrétně je to metoda detectLanguage() třídy HttpRequest jmenného prostoru Nette\Web.

Pokud zbyde čas pokusím se napsat k ní dokumentaci

No, ja som tym len chcel dat najavo, ze sa nezobrazuje dokumentacia v EN jazyku, resp. sa nezobrazi stranka.

David Grudl

piler napsal(a):

No, ja som tym len chcel dat najavo, ze sa nezobrazuje dokumentacia v EN jazyku, resp. sa nezobrazi stranka.

Díky za report, už by to mělo fungovat.

Nasadil jsem weby o víkendu na nové jádro, takže tam možná nějaké chybky budou, neváhejte reportovat.

A.

David Grudl napsal(a):
Nasadil jsem weby o víkendu na nové jádro, takže tam možná nějaké chybky budou, neváhejte reportovat.

Chybi prepinatko jazyku, pokud neberu to rucni v url.

phx

Na druhou stranu kdyz neni stranka v en tak by se mohla zobrazit alepon ta ceska a nebo by tam ten odkaz nemel byt.

romansklenar

Tak jsem se k tomu dokopal a ve volné chvíli jsem napsal dokumentaci k Nette\Web\HttpRequest.

Editoval romansklenar (18. 9. 2008 22:22)

Jan Tvrdík

romansklenar napsal(a):

Tak jsem se k tomu dokopal a ve volné chvíli jsem napsal dokumentaci k Nette\Web\Html.

Nemyslel jsi spíš Nette\Web\HttpRequest?

romansklenar

Upss, jasně překlep, opraveno

Honza Marek

Maličko jsem rozepsal Nette\Templates. Psal jsem to lehce unaven, tak to třeba bude udělaný špatně :-)

Jan Tvrdík

Část dokumentace je psána pro PHP 5.3 a část pro PHP 5.2. Co je správně?

David Grudl

Jan Tvrdík napsal(a):

Část dokumentace je psána pro PHP 5.3 a část pro PHP 5.2. Co je správně?

Vzhledem k tomu, že oddělovačem jmenných prostorů v PHP 5.3 bude zpětné lomítko (a zítra třeba otazník, nevím), tak sjednocení dokumentace bych zatím nechal plavat.

LM

Mě celkem překvapuje že o tom furt diskutujou, ještě minulý týden se hlasovalo a bylo rozhodnuto že konflikt funkce jmeného prostoru vs statická metoda se bude řešit:

use class Nette\Template\Filters;
use namespace Nette\Template\Filters;

a teď nahodí diskuzi z IRC a změní to na \ což je šílený… měli nechat ten smajlík aspoň by to bylo veselejší use Nette:)Environment

Editoval LM (25. 10. 2008 22:51)

ViliamKopecky

a teď nahodí diskuzi z IRC a změní to na \ což je šílený… měli nechat ten smajlík aspoň by to bylo veselejší use Nette:)Environment

Navrhovali by smajlík? Ten by byl skvělej. :)

LM

enoice napsal(a):

Navrhovali by smajlík? Ten by byl skvělej. :)

Smajlík by ukázal jaká je PHP sranda: self::$transact->registerTransaction('rmdir', new FileTransaction:)Rmdir);

ViliamKopecky

LM napsal(a):

enoice napsal(a):

Navrhovali by smajlík? Ten by byl skvělej. :)

Smajlík by ukázal jaká je PHP sranda: self::$transact->registerTransaction('rmdir', new FileTransaction:)Rmdir);

přesně tak );

romansklenar

Pokusil jsem se slepit něco málo k Nette\Application\Presenter. Většinou jsou to mnou nashromažděné úryvky odsaď z fóra, jakákoliv korekce vítána :)

romansklenar

Přepsal jsem Nette\Application\Presenter, zkusil jsem napsat i Nette\Application a pomocí fóra taky něco málo k Nette\Application\Route + dopsat nějaké menší úryvky a postřehy ze školení. Je toho dost (celý seznam úprav), ke konci už mi to hlava nebrala, tak je možné, že se tam někde objeví i nějaká chybka, takže se je nestyďte opravit.

EDIT:

Davide mohl bys nějak vhodně upravit docbar pokud to uznáš za vhodné?

Mám na mysli tu část okolo Nette\Application:

- [Nette\Application]
  - [Začínáme | Nette\Application]
  - [AppForm | Nette\Application\AppForm]
  - [Application | Nette\Application\Application]

na:

- [Nette\Application]
  - [Application | Nette\Application]
  - [AppForm | Nette\Application\AppForm]

pokud tam nemusí být to „Začínáme“.

Editoval romansklenar (8. 11. 2008 23:17)

Honza Marek

Super. Ještě pár takových školení a budou lidi schopný sepsat dokumentaci :-)

romansklenar

Já bych ji i sepsal, sice ne ze dne na den, ale hodil by se k ruce vždy někdo na korekturu. Jsou totiž věci, které ještě nemám úplně ošahané, takže by se mohla vyskytnout chybička (myslím v kódu ukázky) a pokud by někdo začínající s Nette na tohle narazil, pak by ho to mohlo i odradit framework používat. Taky vím, že moc neumím psát takové ty „intro texty“ a omáčku kolem toho aby to bylo čtivé jako např. Nette\Web\Html.

Snažím se protlačit do firmy, kde pracuji, Nette, zatím to je na dobré cestě, možná se brzo začne psát první aplikace, ale do budoucna to bez kvalitní dokumentace nepůjde, jelikož by se neměli možnost noví lidi naučit pracovat s frameworkem. Takže se dokumentování stejně nevyhnu :)

David Grudl

romansklenar napsal(a):

Přepsal jsem Nette\Application\Presenter, zkusil jsem napsat i Nette\Application a pomocí fóra taky něco málo k Nette\Application\Route

Odvádíš špičkovou práci, mockrát díky!

Zrušil jsem ze stránky docbar zámek, takže ji můžeš klidně editovat a přidávat do ní nové položky. Jen v případě sekcí je nutné, aby první položka měla stejný cíl, jako sekce samotná (jen třeba s textem „Začínáme“ nebo „Úvod“). Díky tomu se po kliknutí seznam rozbalí a je zvýrazněna první položka. Úvodní stránku je třeba vytvořit, stačí titulek a direktiva docbar, obsah je pak možné dopsat v budoucnu.

David Grudl

Aktualizoval jsem na fóru, webu a api dokumentaci oddělovač jmených prostorů. Je to sice hnus velebnosti, ale zdá se, že lomítku\už\nic\nezabrání.

romansklenar

Taky si musím někde ponaříkat: Je to hnus no… ti lidi co to phpčko vyvýjí mi tím zkazili natěšení na novou verzi… další motání lomítka a plus ty podivné zápisy ve stylu:

throw new ::InvalidStateException("Component is not attached to '$type'.");
// vs.
throw new \InvalidStateException("Temporary directory '$dir' is not writable.");

no fuj, nelíbí se mi to

ViliamKopecky

romansklenar napsal(a):

Taky si musím někde ponaříkat: Je to hnus no… ti lidi co to phpčko vyvýjí mi tím zkazili natěšení na novou verzi… další motání lomítka a plus ty podivné zápisy ve stylu:
throw new ::InvalidStateException("Component is not attached to '$type'.");
// vs.
throw new \InvalidStateException("Temporary directory '$dir' is not writable.");
no fuj, nelíbí se mi to

A než se tomu zase popřizpůsobují IDEčka…

LM

Našel jsem pár chybek třeba v https://doc.nette.org/…n/components mezi třídou a metodou měla zůstat :: , třeba je tam: Nette\Component\lookup($type).

Ještě k těm prostorům, nemělo by např místo: class Application extends Nette\Object být class Application extends \Nette\Object, protože se nezměnil jen separátor… teď se třídy dohledávají relativně k deklaraci namespace.

Editoval LM (10. 11. 2008 18:01)

romansklenar

A naopak zase u Nette\Security::Permission chybí ten skvělý oddělovač jmenných prostorů.

BTW: @Honza M. jsou ty středníky nutné? Mě osobně se zdá, že do těch odrázkových a číslovaných seznamů se moc nehodí – myslím tím jakože není potřeba tam konec odrážky odělovat, je to viditelné. Nebo to má nějaký typografický význam?

Editoval romansklenar (10. 11. 2008 17:57)

Honza Marek

Jestli jsou nutné nevím, ale dělá se to třeba v časopisech. Možná by tam mohly přijít čárky, ty by nevypadaly tak webově nezvykle. Vždycky jsem je přidával jen pokud jsem upravoval něco jiného, protože jsem na to zvyklý… Typografický význam to má nepochybně :-)