2008/11/11 Stephane Bauland <[EMAIL PROTECTED]>: > Toma wrote: >> Ive always been a proponent of more docs and have always tried to make >> docs. Im down with it. >> >> The 0th step is creating a roadmap of what needs more documentation, >> what needs documentation revision, and how to organize all the >> documentation. > I'm agree, the good way is to have a roadmap in trac, sure. >> And instead of a 'team' as such, we could create a >> system where you just add a short blurb about a certain function then >> that gets added to a database... unless thats already possible? >> >> It would be good to keep it all on a wiki type setup, > Imho, using something like docbook or another documentation's > format will be better, using this, it'll be more easy to provide > documentation in differents formats.
Attached is an example of what can be done using AsciiDoc (http://www.methods.co.nz/asciidoc/index.html). The source file is a plain text file (the extension is .txt), and can generate docbook (see the pdf output using asciidoc + xsltproc + docbook-xsl-stylesheets + fop 0.95) of html (see the html output). It is easy to learn and to maintain. Moreover, a plain text file can be easily versioned through Subversion. I personally use asciidoc more and more for my professional and personal documentation needs, just wanted to let you give an eye to this solution. P.S. The sample doc given here does not mean (yet) that I can involve a lot of time to documentation... Maybe in a few more months. regards, Lionel >> preferably on >> trac.enlightenment.org (at least for the roadmap) or on >> wiki.enlightenment.org ... there is already LOADS of info on >> wiki.e.org, but it might need some more organization. >> > Yes, wiki have to be organized and updated :) >> Toma >> >> >> >> 2008/11/11 Amitav Mohanty <[EMAIL PROTECTED]>: >> >>> Hi >>> >>> I posted about this about a week ago. I am partly taking up that task. >>> However, I will need a few more days to begin my work. >>> >>> Stephane Bauland wrote: >>> >>>> Hi all, >>>> >>>> This morning i was reading a guay in #e, asking for some documentation >>>> around E itself. Maybe it could be great to create a "team" for >>>> documentation right now. And to provide a user documentation manual for >>>> the release ? Cause their's not enought documentation about e, or the >>>> one existing are a little bit outdated. >>>> >>>> That's just my opinion, i let you react :) >>>> >>>> >>>> >>> ------------------------------------------------------------------------- >>> This SF.Net email is sponsored by the Moblin Your Move Developer's challenge >>> Build the coolest Linux based applications with Moblin SDK & win great >>> prizes >>> Grand prize is a trip for two to an Open Source event anywhere in the world >>> http://moblin-contest.org/redirect.php?banner_id=100&url=/ >>> _______________________________________________ >>> enlightenment-devel mailing list >>> enlightenment-devel@lists.sourceforge.net >>> https://lists.sourceforge.net/lists/listinfo/enlightenment-devel >>> >>> >> >> > > > -- > Stephane 'rookmoot' Bauland. > > > ------------------------------------------------------------------------- > This SF.Net email is sponsored by the Moblin Your Move Developer's challenge > Build the coolest Linux based applications with Moblin SDK & win great prizes > Grand prize is a trip for two to an Open Source event anywhere in the world > http://moblin-contest.org/redirect.php?banner_id=100&url=/ > _______________________________________________ > enlightenment-devel mailing list > enlightenment-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/enlightenment-devel >
efl_developer_guide.pdf
Description: Adobe PDF document
------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
