Heh yeah that's true, Koen. Most people, including me, find writing docs a little annoying, that's why we don't have too many planned features for 1.0 - the main effort will be on documentation. Agavi might be nice, cool, even the best framework ever (let's hope it is), but that is irrelevant if there is no comprehensive documentation that gets people excited AND started.
As I said before, I'll definitely shoot you a mail once we have the documentation system up and running (should be in a couple of weeks) Cheers, David Am 31.01.2007 um 11:13 schrieb Van Daele, Koen: > I could also write down some of the things I run into, but that > also based on a partial understanding of agavi. So I'd also prefer > it if someone checks the facts. There are probably a lot of > features of agavi that I still don't know about. > > I think that might be the difficulty: It's difficult to learn a > framework and write docs for it without having docs to learn it. > And if the docs are there, you don't need to write them anymore. > Kind of a chicken-and-egg thing... > > Koen > >> -----Oorspronkelijk bericht----- >> Van: [EMAIL PROTECTED] >> [mailto:[EMAIL PROTECTED] Namens Felix Gilcher >> Verzonden: woensdag 31 januari 2007 10:55 >> Aan: Agavi Dev Mailing List >> Onderwerp: Re: [Agavi-Dev] small hint for the people writing >> the agavi manual >> >> -----BEGIN PGP SIGNED MESSAGE----- >> Hash: SHA1 >> >> D'oh, I knew there was a reason. As a long-time Textmate user >> I didn't even consider anyone was using something >> different... I'll have a look at that editor. As for >> contributing: I'm actually writing the stuff down as I write >> my app, more or less as a help for me and my co-developers so >> that they don't have to go through the whole thing as well, >> so this is pretty rough and may be outright false in some >> places. I'd prefer to send in patches for the time being and >> let the original developer of the code/the doc team/anyone >> else double check it before merging it into the repository. >> If you'd prefer that I commit directly (preferably to my own >> branch) that's no problem either. However I don't have the >> time to make this a regular commitment. >> >> I'll try to join you on irc, is there any time that you are >> usually online? >> >> regards >> >> felix >> >> On Jan 31, 2007, at 8:00 AM, David Zülke wrote: >> >>> Hi Felix, >>> >>> I believe we all use the XMLMind XML Editor (http://www.xmlmind.com/ >>> xmleditor) to write the documentation. It does it that way. >>> >>> I'm glad to hear you're willing to contribute >> documentation. Our full >>> efforts on documenting things will start after the final >> 0.11 release. >>> We will then also build the new website and integrate the manuals >>> properly, and build a system like >> http://www.djangobook.com/ for the >>> documentation process to ensure maximum quality. >>> >>> That said, if you'd like to contribute, could you maybe >> join us on IRC >>> so we can talk about it a bit. That would be really helpful in >>> coordinating efforts. I can then also get you an SVN account etc. >>> >>> Thanks a lot for your help! >>> >>> >>> David >>> >>> P.S: font sizes are normal for me here on Safari 2, OS 10.4!? >>> >>> >>> Am 31.01.2007 um 00:33 schrieb Felix Gilcher: >>> >>>> -----BEGIN PGP SIGNED MESSAGE----- >>>> Hash: SHA1 >>>> >>>> Hi, >>>> >>>> today I was looking into the docbook source of the agavi >> manual (I'm >>>> trying to write down what I pieced together about validation) and >>>> found something which I though was quite interesting. As >> the docbook- >>>> format is XML it won't accept examples which contain >> xml/html tags or >>>> entities, so the person(s) writing the docs is/are going to great >>>> length escaping them properly: >>>> >>>> <programlisting>/* Loads /app/modules/Dogs/models/Dog >>>> [Model].class.php and initializes it with a name and a breed. */ >>>> $myDog = $this->getContext()->getModel('Dog', 'Dogs', array >>>> ('name'=>'Nelli', 'breed'=>'Novascotian retriever')); >>>> >>>> /* class SinglesBar implements AgaviISingletonModel */ >>>> $bar1 = $this->getContext()->getModel('SinglesBar'); //loads >>>> and initializes the model. >>>> $bar2 = $this->getContext()->getModel('SinglesBar'); >> //returns >>>> the same instance of SinglesBar as the line above.</programlisting> >>>> >>>> However, this is way too much work, especially in the >> examples about >>>> the xml configuration files. There is an easier way: just wrap a <! >>>> [CDATA[ ]]> marker around the example and no tags/entities will be >>>> parsed or interpreted. >>>> >>>> <programlisting><![CDATA[/* Loads /app/modules/Dogs/models/Dog >>>> [Model].class.php and initializes it with a name and a breed. */ >>>> $myDog = $this->getContext()->getModel('Dog', 'Dogs', array >>>> ('name'=>'Nelli', 'breed'=>'Novascotian retriever')); >>>> >>>> /* class SinglesBar implements AgaviISingletonModel */ >>>> $bar1 = $this->getContext()->getModel('SinglesBar'); //loads and >>>> initializes the model. >>>> $bar2 = $this->getContext()->getModel('SinglesBar'); //returns the >>>> same instance of SinglesBar as the line above.]]></programlisting> >>>> >>>> Less typing, easier to read in the source. If you were >> aware of this >>>> already and have a compelling reason to do otherwise >> please tell me >>>> so that I can adapt the parts I'm writing accordingly. >>>> >>>> One other note: The stylesheet makes for an unreadable >> small default >>>> fontsize on ff/safari on OSX. >>>> >>>> regards >>>> >>>> felix >>>> >>>> - -- >>>> If it ain't broken, fix it 'till it is. >>>> (usenet quote) >>>> >>>> >>>> -----BEGIN PGP SIGNATURE----- >>>> Version: GnuPG v1.4.3 (Darwin) >>>> >>>> iD8DBQFFv9XSGLZ/2ixjPUARAmTKAJ4tPjD7kxtM5rz/wuOjIPYsMyVfzwCgrI7j >>>> YL0sPziV6j5ZpiMjN2GX6mk= >>>> =P96T >>>> -----END PGP SIGNATURE----- >>>> >>>> _______________________________________________ >>>> Agavi Dev Mailing List >>>> [email protected] >>>> http://lists.agavi.org/mailman/listinfo/dev >>>> >>> >>> >>> _______________________________________________ >>> Agavi Dev Mailing List >>> [email protected] >>> http://lists.agavi.org/mailman/listinfo/dev >> >> >> >> - -- >> Mit Sinn für Humor ist es leichter, >> das Unpassende zu übersehen, >> das Unübliche zu verstehen, >> das Unangenehme zu tolerieren, >> mit dem Unerwarteten fertig zu werden >> und das Unerträgliche zu überstehen. >> (Billy Graham) >> >> >> >> >> -----BEGIN PGP SIGNATURE----- >> Version: GnuPG v1.4.3 (Darwin) >> >> iD8DBQFFwGdwGLZ/2ixjPUARApT5AJsEMGCfBVaOLsiUQaloM9kjwgksvQCeLgFT >> 2lUngwCRY2h2v8i6wa4iGx4= >> =LaGN >> -----END PGP SIGNATURE----- >> >> _______________________________________________ >> Agavi Dev Mailing List >> [email protected] >> http://lists.agavi.org/mailman/listinfo/dev >> > > _______________________________________________ > Agavi Dev Mailing List > [email protected] > http://lists.agavi.org/mailman/listinfo/dev > _______________________________________________ Agavi Dev Mailing List [email protected] http://lists.agavi.org/mailman/listinfo/dev
