Tangra Manual -- вече е онлайн, голЕм зор беше

Posted / Публикувана 2009-05-18 in category / в категория: Tangra framework for PHP

tangra.jpgВчера публикувах Manual-а за Tangra Framework-a. Все още е далеч от пълнотата, която искам да постигна, но поне повечето базовите неща са покрити. Идеята ми е да събера малко feedback, че то така човек може да си пише до безкрайност…

Сорсовете са в DocBook XML формат -- след много мъки най-накрая успях да намеря читав XML редактор, който да върши добра работа -- Oxygen XML Editor. Има цялата функционалност от която имам нужда, бърз е и най-важното: не забива постоянно като това лайно XMLSpy. Без колебание си го купих и така се оттървах от първия голЕм зор.

Вторият голем зор беше докато разбера как аджеба "работи" PHP Manual-a -- къде са модифицирали XSLT-то, как оцветяват синтактично PHP кода и т.н. Идеята ми беше да не откривам наново колелото, а да изкопирам тяхната схема на работа. В крайна сметка с много копане и псуване нещата се изясниха.

Третият зор беше докато модифицирам скрипта за синтактично оцветяване -- оригиналният много държеше да има отварящ <?php таг иначе не оцветяваше. Това лесно оправих, но после загубих маса време докато разбера защо, аджеба, вкарва толкова много празни редове преди и след скрипта. Не че беше кой знай каъв проблем, но просто ме дразнеше.

Дотук беше лесното :-)

Четвъртия зор беше в самото започване с писането -- в началото се плува яко upstream, срещу мощно течение. Едва ли не на всеки две изречения трябваше да спирам, защото използвам някакъв термин, който трябва да опиша в glossary-то или в отделна глава/секция. Тръгвам да го описвам и се оказва, че за да го обясня трябва да опиша още два други и така се получаваще верижна реакция…

Петия зор си беше нормален за писането на документация -- аз си знам framework-а и на моменти не мога да преценя доколко подробно да опиша нещата и в каква последователност, така че, да ме разбере някой, който за първи път го хваща. За съжаление решението на този проблем го отложих -- първо ще трябва да се събере feedback, за да мога да преценя къде да се фокусирам. По тази причина умишлено не съм доразписал много секции, въпреки че имам добра идея какво още да напиша в тях.

Шестия зор е изрази в това, че след като пуснах обява в секцията "Help wanted" на sourceforge за "English editor" и тестери -- за 10-ина дни само двам човека отговориха, като единия се покри, а втория е тинейджър, който вятър го вее на бял кон. Като се има впредвид, че sourceforge има няколко стотин хиляди регистрирани потребители -- WTF?!

Седмия зор е, че това писане на manual-а отнема прекалено много време. Мислех, че за две седмици ще съм готов с първия вариант,  а ето че вече повече от месец пиша и едва сега му се вижда края. Първата седмица беше голям кеф -- след няколкомесечното non-stop дране на код, писането на документация ми изглеждаше като разходка по плажа. Втората седмица започна да ми омръзва. Третата и четвъртата вече си беше досадно. С нетърпение чакам да се върна към коденето…

Та така.

Остава да довърша главата за работа с Grids и ще release-вам beta1.

Comments are closed.